0.0
No commit activity in last 3 years
No release in over 3 years
Analyzes the code of your Rails app and generates a straightforward HTML report.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.3
~> 5.3.4
~> 1.1.0
>= 0

Runtime

~> 2.4
~> 4.2
 Project Readme

Code Poetry

Gem Version Build Status Code Climate Code Climate

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:

  • Lines of Code
  • Churns
  • Code Complexity [Flog]
  • Duplication [Flay]

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

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request