Code Poetry
The poor men's Code Climate.
Analyzes the code of your Rails app and generates a straightforward HTML report.
Currently it uses the following metrics:
Installation
Add this line to your application's Gemfile:
gem 'code_poetry'
And then execute:
$ bundle
Or install it yourself:
$ gem install code-poetry
Usage
Excecute from your application root:
$ rake metrics
This will generate a HTML report to metrics/index.html
.
Or if you installed the gem globally use:
$ code_poetry
This will display your smells in the command line.
You can also give a path to a file or subdirectory if you only want metrics for those files:
$ code_poetry app/models
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request