RubyCritic은 Ruby 애플리케이션의 코드 냄새, 코드 구조, 테스트 용이성 및 테스트 범위를 강조하는 시각적 보고서를 제공합니다.
새로운 코드 분석 도구가 종종 새로운 기능으로 도입되면서 활발한 개발이 진행되고 있습니다. RubyCritic의 릴리스를 추적해 볼 가치가 있습니다.
이 문서에서는 RubyCritic의 일부 이점, 종속성 및 코드 보고서를 읽는 방법을 다룰 것입니다.
가자!
Ruby on Rails 애플리케이션으로 RubyCritic을 선택하는 이유는 무엇입니까?
프로젝트의 코드 개선 사항을 한 곳에서 검토하려면 RubyCritic 사용을 고려해야 합니다. 개발 프로세스에 RubyCritic을 포함시키면 개발 팀이 기술 부채를 처리하는 데 소요되는 시간이 확실히 줄어들 것입니다. 대부분의 기술적 부채는 개발 시점에 파악됩니다.
RubyCritic이 귀하의 프로젝트와 개발 프로세스에 제공할 수 있는 이점은 다음과 같습니다:
- 정보를 한곳에 통합
- 시각적 보고서
- 쉬운 설치
- 제로 구성
- 맞춤설정 허용
- 확장 가능 — 자신만의 오픈 소스 통합을 만들 수 있습니다.
- 배지 생성기 🎉
RubyCritic의 작동 방식을 이해하기 위해 보고서 작성에 사용되는 내부 종속성을 살펴보겠습니다.
RubyCritic의 내부 종속성
프로젝트에 RubyCritic을 추가하면 일부 종속성도 포함됩니다.
마법을 일으키는 종속 요소인 Reek, Flay 및 Flog 보석을 강조해 보겠습니다. 이러한 종속성을 통해 RubyCritic은 코드에 대한 귀중한 정보를 표시할 수 있습니다. 작동 방식을 이해하면 RubyCritic을 더 쉽게 사용할 수 있습니다.
Reek:Ruby에서 코드 냄새 감지
Reek은 Ruby에서 코드 냄새를 감지하는 보석입니다. 코드에서 악취가 나는 것은 잘못된 코드를 식별하는 것이 아니라 코드를 더 잘 작성할 수 있는지 분석하는 것입니다.
Reek의 분석을 통해 다음을 식별합니다. 무언가가 다른 방식으로 구현될 수 있습니다. 방법을 제안하지는 않습니다. , 대부분의 코드 냄새는 비즈니스 논리 및 언어에 대한 개발자의 경험과 연관되어 있기 때문입니다.
예를 들어 if를 쉽게 다시 작성할 수 있습니다. 메타프로그래밍 기술을 사용한 문장. 하지만 이를 수정하는 방법은 프로젝트의 상황에 따라 개발자의 몫입니다. 이 경우 어떤 라이브러리도 최선의 해결책을 제시할 수 없습니다.
Reek은 광범위한 냄새 목록을 감지합니다. 다음에서 발생할 수 있는 냄새를 검사하고 식별합니다.
- 수업
- 속성
- 방법
- 매개변수
- 모듈
- 반복자
- 다형성 구현
냄새를 찾아 코드를 더 읽기 쉽고 유지 관리하기 쉽게 만드는 조치를 취할 수 있습니다.
Reek은 다음과 같은 사용자 정의 구성을 허용합니다:
- 유형별로 탐지기 비활성화
- 디렉토리를 검사에서 제외
- 필터를 사용하여 경고를 무음
스캔에서 표시하지 않도록 특정 코드를 정의할 수도 있는데, 이는 코드가 아직 마무리되지 않았거나 리팩토링되지 않았거나 레거시 코드인 경우에도 매우 유용한 기능입니다.
Reek이 어떻게 작동하는지 샘플을 살펴보겠습니다. 이 코드에서는 예외가 e로 정의되었습니다. .
e이라고 상상하기 쉽습니다. 예외를 의미하지만 다른 예외가 있으면 어떻게 되나요? 이를 올바르게 식별하는 것이 좋은 코드를 유지하는 가장 좋은 방법입니다.
Reek은 e을 식별합니다 UncommunicativeVariableName으로 지정하고 경고를 표시합니다.
Flay:Ruby 코드 중복 확인
Flay는 다음을 포함하여 Ruby 코드의 구조적 유사성을 식별합니다.
- 프로젝트 내 코드 중복 감지
- 모든 코드 수준에서 차이점 확인
- 코드가 얼마나 좋은지 측정하기 위한 점수 생성(점수가 낮을수록 코드가 더 좋아짐)
Flay가 코드의 유사성을 보고하면 리팩토링이 필요하다는 의미입니다. 이것을 무시하지 마십시오! 중복 코드는 버그로 가는 관문입니다. 한 곳에서 뭔가를 고치고 다른 곳을 잊어버리면 더 많은 버그가 나타납니다.
자체 소스 코드에서 Flay를 실행하여 Flay가 어떻게 작동하는지 확인할 수 있습니다:
Flay는 이 둘 사이의 유사점을 식별합니다:
코드의 철자가 정확히 동일하지는 않지만 기능은 중복을 피하기 위해 리팩토링될 수 있습니다. 이것이 바로 Flay의 마법입니다!
Flog:Ruby에서 코드 복잡성 검사
Flog는 코드를 테스트하는 것이 얼마나 어려운지 확인합니다. 각 코드 줄에 대한 복잡성 점수를 설정하고 각 메서드 및 클래스의 점수를 합산합니다.
점수가 높을수록 구현이 매우 복잡하다는 의미이므로 코드를 더 많이 리팩토링해야 합니다.
Flog의 실제 작동 모습을 살펴보겠습니다! 작은 변화로 인해 점수가 달라질 수 있습니다.
코드의 첫 번째 부분에는 or가 있습니다. 점수가 0.4점 증가하는지 확인하세요.
기타 RubyCritic 종속성
RubyCritic은 다음과 같은 다른 런타임 종속성도 사용합니다.
byebug- 이는 Ruby 애플리케이션 디버깅을 향상시킵니다. 이를 통해 프로그램을 한 줄씩 실행하고, 중단점을 추가하고, 런타임 시 값을 평가 및 추적할 수 있습니다. 아직도puts을 사용하고 계시다면 디버깅을 위해서는 Byebug의 기능과 명령어를 알아가는 시간입니다.rubocop- Ruby 커뮤니티에서 사용하는 스타일 가이드를 따르거나 자신만의 코드 스타일을 적용하는 데 도움이 되는 Ruby 코드용 린터입니다. 팀에서 표준을 설정하고 공백과 탭에 대한 어리석은 충돌을 피하는 것은 매우 유용합니다.SimpleCov- Ruby 애플리케이션 코드 적용 범위를 확인하는 도구입니다. 테스트와 함께 실행되도록 구성할 수 있습니다. 더 나은 테스트 사례를 만들기 위해 주의해야 할 사항과 시간을 투자할 부분을 식별할 수 있도록 코드 적용 범위에 대한 측정항목을 제공합니다.
RubyCritic의 종속성 목록을 자세히 살펴보세요.
Ruby on Rails 앱에 RubyCritic 사용
RubyCritic에는 많은 구성 없이 시작하는 데 도움이 되는 유용한 문서가 있습니다. 따라서 우리는 보고서를 분석하는 데 도움이 되는 리소스를 활용하는 데 중점을 둘 것입니다.
RubyCritic은 '코드', '냄새' 및 '범위' 보고서를 제공합니다. 각 기능을 차례로 살펴보겠습니다.
RubyCritic 개요
'개요' 페이지에는 등급(A가 최고 등급, F가 최저 등급)과 함께 도넛 차트로 프로젝트의 총점을 표시합니다. '요약' 섹션에는 파일 수, 이탈(변경 사항 커밋), 발견된 냄새 등 각 등급에 대한 세부 정보가 표시됩니다.
여기 'Churn vs Complexity' 섹션에서는 가장 복잡도가 높은 클래스를 식별하는 것이 이미 가능하며, 이것이 아마도 첫 번째 관심 포인트가 될 것입니다.
이 그래프를 더 잘 이해하려면 코드 변동을 다시 살펴보는 것이 좋습니다. 자주 변경되는 코드는 뭔가 잘못되었다는 경고를 발생시킬 수 있습니다. 예를 들어 논리 또는 비즈니스 도메인에서 발생할 수 있습니다. 어느 쪽이든 '이탈 vs 복잡성'을 살펴보면 프로젝트 전반에 걸쳐 문제점이 어디에 있는지 파악하는 데 도움이 될 수 있습니다.
코드 보고서
'코드' 보고서에는 이탈, 복잡성, 중복 및 냄새에 대한 지표를 포함하여 각 수업에 대한 점수가 표시됩니다.
이 목록을 열별로 정렬하여 가장 높은 순위의 요소를 확인하고 가장 중요한 문제를 먼저 해결할 수 있습니다.
또한 이 목록에는 학급 이름으로 빠르게 검색할 수 있는 필터가 있습니다.
수업 이름을 클릭하면 다음과 같은 수업 코드 및 측정항목이 포함된 세부 페이지가 열립니다.
- 코드 라인
- 수량 방법
- 계산된 이탈
- 방법별 복잡성
- 복잡성 점수(클래스당 총계)
- 발견된 중복 항목의 양
- 냄새 횟수
문제가 발견된 코드 줄은 강조 표시됩니다(Reek gem에서 제공하는 정보에 따라).
Flog가 문제를 식별하면 점수가 표시됩니다. 또한 Flay 보고서에서 중복 코드가 감지되었는지 확인할 수 있습니다.
냄새 보고서
'냄새' 페이지에는 냄새 유형, 냄새가 나타나는 정확한 위치, 수정 상태가 표시됩니다.
앞서 언급했듯이 냄새는 Reek에서 감지되며, 이 페이지에서는 정렬 및 필터링도 가능합니다.
클래스 이름을 클릭하면 코드 세부정보가 포함된 페이지가 열립니다. 냄새 유형별로 그룹화된 클래스도 볼 수 있습니다(냄새 개수만 표시하는 '코드' 페이지에는 없습니다).
취재 보고서
마지막으로 '커버리지' 보고서에서 클래스 분류와 각 클래스에 대한 적용 비율을 확인할 수 있습니다. '코드' 및 '냄새' 보고서의 목록과 달리 '범위'의 목록에서는 정보를 정렬하고 필터링할 수 없습니다.
코드 적용 범위의 비율만 볼 수 있으며 추가 정보는 제공되지 않습니다.
SimpleCov 보고서를 통합하면 이 페이지에 더 많은 가치와 유용성을 추가할 수 있습니다. 그러나 어떤 경우에도 프로젝트의 테스트 커버리지를 조사하기 위해 간단한 보고서가 필요한 경우 '커버리지' 보고서가 도움이 될 수 있습니다.
마무리
이 게시물에서는 내부 종속성인 Reek, Flay 및 Flog를 살펴보기 전에 Ruby 애플리케이션에 대한 RubyCritic의 이점을 간략하게 살펴보았습니다. 그런 다음 RubyCritic의 보고서를 읽고 분석하는 방법을 살펴보았습니다.
다음 단계로 파이프라인에서 RubyCritic을 사용하는 방법을 알아보세요.
코드 리팩토링을 즐기세요!
추신 Ruby Magic 게시물이 보도되는 즉시 읽으려면 Ruby Magic 뉴스레터를 구독하고 단 하나의 게시물도 놓치지 마세요!
브레나 몬테이로
객원 저자인 Brena는 새로운 개발자 멘토링에 열정을 갖고 있으며 고성능 팀을 개발하고 이끄는 데 경험이 있는 기술 책임자입니다. 그녀는 확장 가능한 API 구축 및 클라우드 서비스 간 통합 경험이 있으며 혁신적인 아키텍처에 열정을 갖고 있으며 확장 현실(XR) 견습생입니다.
Brena Monteiro의 모든 기사