Project

aidir

0.0
No commit activity in last 3 years
No release in over 3 years
aidir - Am I Doing It Right: track and improve your Flog score before merging code to master by getting Flog score differences between current branch and master branch
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.14

Runtime

~> 4.2
 Project Readme

aidir

Am I Doing It Right

Description

aidir gem displays Flog score differences

  • between current git branch and origin/master
  • of every method and file that got a different Flog score
  • in a color-coded table

Install

gem install aidir

Usage

  1. Change some ruby code on a branch other than master
  2. Commit your local changes
  3. Run aidir
$ aidir
  1. Read the results.
  2. Love/hate yourself more
  3. Reward/improve yourself

Colorless example of results

Method scores
Diff from master Current Method
         -9.3 |    17.7 | Foo#improved_method
          3.0 |    23.0 | Foo#worsened_method
File flog total scores
Diff from master Current File
         -6.3 |   234.0 | app/models/foo.rb
File flog/method average scores
Diff from master Current File
         -2.0 |    16.4 | app/models/foo.rb

Score colors

Difference from master:

  • < 0: good, green
  • 0 - 20: smells, yellow
  • 20: bad, red

Per-method score:

  • 0 - 20: good, green
  • 20 - 40: smells, yellow
  • 40: bad, red

Badgers

Code Climate Coverage Status Build Status

Badger