RubyCritic：一款不錯的檢測代碼質量工具

關注代碼質量是高效開發必需要作的一件事，那麼在 Ruby 開發的過程當中，是否有什麼好的代碼質量檢測工具呢？下面由 Ruby 工程師路英瑞介紹一下 RubyCritic——一款還不錯的代碼質量檢測工具。

最近在開發 Cloud Insight API（一款可以優雅監控多種操做系統、數據庫、中間件、雲主機的解決方案） 時，發現一個能夠檢測 Ruby 代碼質量的工具-RubyCritic。

RubyCritic 集成 Reek, Flay 和 Flog 這3個分析代碼的工具，可以對你的 Ruby 代碼進行靜態分析並生成質量報告。

功能介紹

1. 能夠總覽項目,而且能夠對代碼打分(百分制).

2.根據各自的壞味道數量創建文件索引

對不一樣文件按照改動頻率、複雜度、重複度和壞味道4個維度進行綜合評定代碼質量等級。

3.能夠查看具體的類文件中的代碼質量問題

用法

看一下rubycritic(2.7.0)指令:

rubycritic --help

  Usage: rubycritic [options] [paths]}

運行bundle exec ruby critic的效果以下圖：

從上圖也能看出 Rubycritic 分析代碼流程。

其餘用法

平時使用 guard 工具的同窗, 能夠使用guard-rubycritic, 代碼改動時會自動分析你的代碼。有興趣的同窗也能夠將它集成到 Jenkins CI。

擴展功能

在使用 Rubycritic 過程當中, 每次都要手動打開瀏覽器進行查看質量報告，太麻煩了。因而給它添加一個功能:

目前僅支持 Linux 和 Mac OS X 系統:

• 支持 Linux 瀏覽器： Firefox（默認）、Chrome 和 Chromium
• 支持 Mac OS X 瀏覽器： Safari（默認）、Chrome 和 Firefox

運行步驟

修改 Gemfile

gem 'rubycritic', github: 'superiorlu/rubycritic', branch: 'open_with_browser'

運行rubycritic -O chrome便可。

點此閱讀源代碼

總結

本文簡單介紹了 rubycritic 和用法, 可能某些知識點會有所遺漏，不足之處請你們指正。

更新(2016.01.29) 目前 ruby critic 已經更新到了 2.7.0, 已經默認使用瀏覽器打開 html 格式的報告了。 ：)

本文系國內 ITOM 行業領軍企業 OneAPM Ruby Agent （Ruby 應用性能監控神器）工程師路英瑞原創，轉自路英瑞簡書。想閱讀更多技術文章，請訪問 OneAPM 官方技術博客。 本文轉自 OneAPM 官方博客