Computer >> Hướng Dẫn Máy Tính >  >> Lập Trình >> Ruby

Nâng Cao Chất Lượng Code Ruby Với RubyCritic: Phân Tích Trực Quan & Cải Thiện Liên Tục

RubyCritic cung cấp báo cáo trực quan làm nổi bật code smells (mùi code), cấu trúc code, độ dễ test, và test coverage trong ứng dụng Ruby.

Nó đang phát triển tích cực, với công cụ phân tích code mới thường được giới thiệu như tính năng mới. Việc theo dõi release RubyCritic rất đáng giá.

Bài viết này sẽ chạm đến một số lợi ích của RubyCritic, dependencies (phụ thuộc) của nó, và cách đọc báo cáo code.

Hãy bắt đầu!

Tại Sao Chọn RubyCritic Cho Ứng Dụng Ruby on Rails?

Bạn nên cân nhắc dùng RubyCritic nếu muốn một nơi duy nhất review cải tiến code cho dự án. Bao gồm RubyCritic trong quy trình phát triển chắc chắn giảm thời gian team dev dành cho technical debt (nợ kỹ thuật). Hầu hết technical debt sẽ được lập bản đồ tại development time.

Một số lợi ích RubyCritic mang lại cho dự án và quy trình phát triển:

  • Thông tin thống nhất ở một nơi
  • Báo cáo trực quan
  • Cài đặt dễ dàng
  • Zero configuration (không cần cấu hình)
  • Cho phép tùy chỉnh
  • Có thể mở rộng — bạn có thể tự làm open-source integration
  • Badge generator 🎉

Để hiểu RubyCritic hoạt động như thế nào, hãy xem internal dependencies nó dùng để tạo báo cáo.

Internal Dependencies Trong RubyCritic

Khi thêm RubyCritic vào dự án, một số dependencies cũng được include.

Hãy làm nổi bật dependencies tạo ra phép màu: gem Reek, Flay, và Flog. Dependencies này cho phép RubyCritic chỉ cho bạn thông tin giá trị về code. Hiểu cách chúng hoạt động cũng làm RubyCritic dễ dùng hơn.

Reek: Phát Hiện Code Smells Trong Ruby

Reek là gem phát hiện code smells trong Ruby. Mùi xấu trong code không phải xác định code sai, mà phân tích xem code có thể viết tốt hơn không.

Phân tích Reek xác định nếu có cách triển khai khác. Nó không gợi ý cách, vì hầu hết code smells liên quan đến business logic và kinh nghiệm developer với ngôn ngữ.

Ví dụ, bạn có thể dễ dàng viết lại if statement dùng metaprogramming. Cách sửa, tuy nhiên, tùy developer theo context dự án. Trong trường hợp này, không thư viện nào chỉ ra giải pháp tốt nhất.

Reek phát hiện danh sách smells rộng. Nó kiểm tra và xác định smells có thể trong:

  • Classes
  • Attributes
  • Methods
  • Parameters
  • Modules
  • Iterators
  • Triển khai polymorphism

Bằng cách tìm smells, bạn có thể bước làm code dễ đọc và maintain hơn.

Reek cho phép custom configuration để:

  • Disable detector theo type
  • Exclude thư mục khỏi scan
  • Dùng filters để silence warnings

Bạn thậm chí có thể định nghĩa code cụ thể để suppress trong scan, tính năng hữu ích khi code chưa final hoặc refactored, hoặc legacy code.

Hãy xem mẫu Reek hoạt động. Trong code này, exception chỉ định nghĩa là e.


Dễ tưởng tượng e là exception, nhưng nếu có exception khác? Xác định đúng là cách tốt nhất maintain code tốt.

Reek sẽ xác định e là UncommunicativeVariableName và hiện warning.


Flay: Kiểm Tra Trùng Lặp Code Ruby

Flay xác định sự tương đồng cấu trúc code Ruby, bao gồm:

  • Phát hiện code duplication trong dự án
  • Kiểm tra khác biệt ở mọi cấp độ code
  • Tạo score đo lường code tốt như thế nào (score càng thấp, code càng tốt)

Nếu Flay báo similarity trong code, đó là chỉ số cao cần refactor. Đừng bỏ qua! Duplicate code là cửa ngõ bug. Nếu sửa ở chỗ này quên chỗ kia, bug thêm.

Chúng ta kiểm tra Flay hoạt động bằng chạy trên source code của nó:


Flay xác định similarity giữa hai cái này:


Lưu ý spelling code không chính xác giống nhau, nhưng functionality giống và có thể refactor tránh duplication. Đó là phép màu Flay!

Flog: Kiểm Tra Độ Phức Tạp Code Ruby

Flog kiểm tra code khó test đến mức nào. Nó set complexity score cho mỗi dòng code và cộng score cho mỗi method và class.

Score càng cao, code càng cần refactor vì chỉ ra implementation phức tạp.

Hãy xem Flog hoạt động! Thay đổi nhỏ làm score biến động.



Lưu ý phần đầu code, có check or tăng score 0.4 điểm.



Dependencies Khác Của RubyCritic

RubyCritic cũng dùng runtime dependencies khác, như:

  • byebug - nâng cao debugging Ruby app. Cho phép chạy chương trình line by line, thêm breakpoint, evaluate và track value runtime. Nếu vẫn dùng puts debug, đến lúc làm quen tính năng và lệnh Byebug.
  • rubocop - linter Ruby giúp tuân theo style guide cộng đồng Ruby, hoặc áp dụng style riêng. Rất hữu ích set standard trong team và tránh conflict vô lý về space/tab.
  • SimpleCov - tool check code coverage Ruby app. Cấu hình chạy alongside test. Cung cấp metrics coverage để xác định cần chú ý đâu và đầu tư thời gian tạo test case tốt hơn.

Đi sâu vào danh sách dependencies RubyCritic.

Dùng RubyCritic Cho Ứng Dụng Ruby on Rails

RubyCritic có documentation tốt giúp bắt đầu không cần nhiều config. Do đó, chúng ta tập trung dùng resource để phân tích báo cáo.

RubyCritic cung cấp báo cáo 'Code', 'Smells', và 'Coverage'. Chúng ta xem từng tính năng.

Overview Trong RubyCritic

Trang 'Overview' hiển thị total score dự án trên biểu đồ donut, cùng rating (A tốt nhất, F tệ nhất). Section 'Summary' hiện chi tiết mỗi rating, bao gồm số file, churns (thay đổi commit), smells tìm thấy.

Nâng Cao Chất Lượng Code Ruby Với RubyCritic: Phân Tích Trực Quan & Cải Thiện Liên Tục

Trong section 'Churn vs Complexity' ở đây, đã có thể xác định class phức tạp nhất, nên là điểm chú ý đầu tiên.

Để hiểu biểu đồ này, đáng giá recap code churn. Code thay đổi thường xuyên có thể cảnh báo gì sai — logic hoặc business domain. Cách nào, nhìn 'Churn vs Complexity' giúp thấy pain points trên dự án.

Code Report

Báo cáo 'Code' hiển thị score mỗi class, bao gồm indicator cho churn, complexity, duplication, smells.

Bạn có thể sort list theo bất kỳ cột nào để xem highest ranking factors và giải quyết vấn đề critical trước.

Nâng Cao Chất Lượng Code Ruby Với RubyCritic: Phân Tích Trực Quan & Cải Thiện Liên Tục

Ngoài ra, list có filter cho phép search nhanh theo tên class.

Click tên class mở trang chi tiết với code class và metrics:

  • Code line
  • Quantity methods
  • Calculated churn
  • Complexity by method
  • Complexity score (total per class)
  • Amount of duplicates found
  • Number of smells

Dòng code nơi issue tìm thấy sẽ được highlight (dựa trên info từ Reek).

Nếu Flog xác định issue, bạn thấy score. Cũng thấy nếu Flay report phát hiện duplicate code.

Nâng Cao Chất Lượng Code Ruby Với RubyCritic: Phân Tích Trực Quan & Cải Thiện Liên Tục

Smells Report

Trang 'Smells' hiển thị smell type, vị trí chính xác smell xuất hiện, và fix status.

Như đề cập, smells detected by Reek, sort và filter cũng có trên trang này.

Click tên class mở trang code chi tiết. Bạn cũng thấy classes grouped by smell type (thiếu ở trang 'Code', chỉ hiển thị số smells).

Nâng Cao Chất Lượng Code Ruby Với RubyCritic: Phân Tích Trực Quan & Cải Thiện Liên Tục

Coverage Report

Cuối cùng, bạn thấy class classifications và phần trăm coverage mỗi class trong báo cáo 'Coverage'. Khác với list ở 'Code' và 'Smells', list 'Coverage' không cho sort và filter.

Bạn chỉ thấy phần trăm code coverage — không info thêm.

Nâng Cao Chất Lượng Code Ruby Với RubyCritic: Phân Tích Trực Quan & Cải Thiện Liên Tục

Tích hợp SimpleCov report có thể thêm giá trị và usefulness trang này. Nhưng dù sao, 'Coverage' report giúp nếu cần báo cáo đơn giản kiểm tra test coverage dự án.

Kết Luận

Trong bài, chúng ta nhìn nhanh lợi ích RubyCritic trước khi đi sâu internal dependencies: Reek, Flay, Flog. Sau đó chạy qua cách đọc và phân tích báo cáo RubyCritic.

Bước tiếp, tìm ra cách dùng RubyCritic trong pipeline.

Chúc bạn refactor code vui vẻ!

P.S. Nếu bạn muốn đọc các bài Ruby Magic ngay khi chúng xuất bản, hãy đăng ký bản tin Ruby Magic của chúng tôi và không bao giờ bỏ lỡ bất kỳ bài viết nào!

Nâng Cao Chất Lượng Code Ruby Với RubyCritic: Phân Tích Trực Quan & Cải Thiện Liên Tục

Brena Monteiro

Tác giả khách Brena là Tech Lead đam mê hướng dẫn dev mới và kinh nghiệm phát triển, lãnh đạo team hiệu suất cao. Cô có kinh nghiệm xây dựng API scalable và tích hợp giữa cloud services, 열 tình về evolutionary architecture, và là Extended Reality (XR) Apprentice.

Tất cả bài viết của Brena Monteiro