Skip to content

Latest commit

 

History

History
71 lines (50 loc) · 2.33 KB

README.textile

File metadata and controls

71 lines (50 loc) · 2.33 KB
Raw

Saikuro Treemap Generator

This gem generates a treemap
showing the complexity of ruby code on which it is run. It uses
Saikuro under the covers to analyze ruby
code complexity.

The size of blocks in the treemap is representative of the size of the
code element represented by that block. The color of the block indicates
complexity of that particular code element. Green is good, red is bad,
blue is somewhere in between.

Small evenly distributed blocks which are green in color is indicative of
good code.

Demo

Click here for a demo
of the CCN for the popular rake tool.

Installation

$ [sudo] gem install saikuro_treemap

Configuration

In your Rakefile, add the following:

require 'saikuro_treemap'

namespace :metrics do
  desc 'generate ccn treemap'
  task :ccn_treemap do
    SaikuroTreemap.generate_treemap :code_dirs => ['lib']
    `open reports/saikuro_treemap.html`
  end
end

Execute

$ rake metrics:ccn_treemap

This would generate the treemap report in “reports/saikuro_treemap.html”.

License

Saikuro Treemap Generator is MIT Licensed

The MIT License

Copyright © 2010 ThoughtWorks, Inc. (http://thoughtworks.com)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.