metric_abc 0.0.2

data/.gitignore

@@ -0,0 +1 @@
+pkg/*

data/README

@@ -0,0 +1,29 @@
+Metric ABC
+==========
+
+This little tool calculates ABC metric for your Ruby code. Requires Ruby 1.9 but should work more or less with sources compatible with 1.9 and 1.8.
+
+Installation
+============
+
+$ gem install metric_abc
+
+Usage
+=====
+
+    $ metric_abc filename1 [filename2] ...
+
+Understanding output
+====================
+
+Output from metric_abc is in form of:
+
+    /path/to/file.rb#Module1#Module2#ClassName#method_name: SCORE
+
+where SCORE is a number. The higher SCORE is, the more crazy code is. If a method scores above 20, it very likely needs some refactoring because it's complete shit.
+
+TODO:
+=====
+
+- method is not always properly recognized, sometimes it's full of shit like #@const#1#5#@const etc. Need to look at AST to figure out what's wrong
+

data/Rakefile

@@ -0,0 +1,13 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "metric_abc"
+    gemspec.summary = "Quick and *DIRTY* ABC metric for Ruby 1.9 code"
+    gemspec.description = "Calculates ABC metric for Ruby 1.9. Just like Flog but much more dull."
+    gemspec.email = "hubert.lepick@amberbit.com"
+    gemspec.homepage = "http://github.com/hubertlepicki/metric_abc"
+    gemspec.authors = ["Hubert Lepicki"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/bin/metric_abc

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), "..", "lib", 'metric_abc')
+
+if ARGV.empty?
+  puts "USAGE:\nmetric_abc filename [filename] ..."
+end
+
+ARGV.collect do |filename|
+  MetricABC.new(filename).complexity
+end.inject({}) do |merged, current|
+ merged.merge(current) 
+end.sort{|a,b| b[1]<=>a[1]}.each do |function, score|
+ puts "#{function}: #{score}"
+end

data/lib/metric_abc.rb

@@ -0,0 +1,51 @@
+require 'ripper'
+require 'pp' if ENV["DEBUG"]
+
+class MetricABC
+  attr_accessor :ast, :complexity
+
+  def initialize(file_name)
+    File.open(file_name, "r") do |f|
+      @ast = Ripper::SexpBuilder.new(f.read).parse
+    end  
+    return if @ast.empty?
+    @complexity = {}
+    @nesting = [file_name]
+    process_ast(@ast)
+    pp @ast if ENV["DEBUG"]
+  end 
+
+  def process_ast(node)
+    backup_nesting = @nesting.clone
+     
+    if node[0] == :def
+      @nesting << node[1][1]
+      @complexity[@nesting.join("#")] = calculate_abc(node)
+    elsif node[0] == :class || node[0] == :const
+      @nesting << node[1][1][1]
+    end  
+
+    node[1..-1].each { |n| process_ast(n) if n } if node.is_a? Array
+    @nesting = backup_nesting
+  end
+
+  def calculate_abc(method_node)
+    a = calculate_assignments(method_node)
+    b = calculate_branches(method_node)
+    c = calculate_conditions(method_node)
+    abc = Math.sqrt(a**2 + b**2 + c**2).round
+    abc
+  end
+
+  def calculate_assignments(node)
+    node.flatten.select{|n| [:assign, :opassign].include?(n)}.size.to_f
+  end
+
+  def calculate_branches(node)
+    node.flatten.select{|n| [:call, :fcall, :brace_block, :do_block].include?(n)}.size.to_f + 1.0
+  end
+
+  def calculate_conditions(node, sum=0)
+    node.flatten.select{|n| [:==, :===, :"<>", :"<=", :">=", :"=~", :>, :<, :else, :"<=>"].include?(n)}.size.to_f 
+  end
+end

data/metric_abc.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{metric_abc}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Hubert Lepicki"]
+  s.date = %q{2010-08-24}
+  s.default_executable = %q{metric_abc}
+  s.description = %q{Calculates ABC metric for Ruby 1.9. Just like Flog but much more dull.}
+  s.email = %q{hubert.lepick@amberbit.com}
+  s.executables = ["metric_abc"]
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "bin/metric_abc",
+     "lib/metric_abc.rb",
+     "metric_abc.gemspec",
+     "spec/fixtures/example.rb",
+     "spec/fixtures/not_valid.rb",
+     "spec/functional/metric_abc_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/hubertlepicki/metric_abc}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Quick and *DIRTY* ABC metric for Ruby 1.9 code}
+  s.test_files = [
+    "spec/fixtures/example.rb",
+     "spec/fixtures/not_valid.rb",
+     "spec/spec_helper.rb",
+     "spec/functional/metric_abc_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/spec/fixtures/example.rb

@@ -0,0 +1,49 @@
+def outside_function
+  a = 5
+end
+
+module Test
+  class Test2
+    def class_in_module_function
+      a=1
+      b=2
+      a += 1
+      b *= 2
+      5
+      [1,2,3].each do |element|
+        puts element
+      end
+    end
+  end
+end
+class Example
+  attr_accessor :something
+  def simple_function
+    return 0
+  end
+  def medium_function(param1, param2=whatever)
+    a = simple_function()
+    if param1 == nil
+      a = asdfaf()
+    elsif param1 < 4
+    elsif param1 > 3
+    elsif param2 <=2
+    elsif param3() >=3
+    else
+      puts 'test'
+    end
+    a
+  end
+  def complex_function(param1, param2=whatever)
+    while param1 > 0
+      for i=0; i<=7; i++
+        param2.collect{|c| c+2}.inject("+")
+      end
+    end
+    if something == param1 && tewww != asdf || a === Object
+      Array.new(a + b) 
+    end
+  end
+end
+
+

data/spec/fixtures/not_valid.rb

@@ -0,0 +1,3 @@
+class module def Ziom;
+  def hello
+end

data/spec/functional/metric_abc_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe MetricABC, "initialization" do
+
+  it "should read passed file and generate AST for it on initialization" do
+    metric = MetricABC.new(File.join(File.dirname(__FILE__), "..", "fixtures", "example.rb"))
+    metric.ast.should be_instance_of(Array)
+    metric.ast.should_not be_empty
+  end
+
+  it "should throw exception when file is not found" do
+    lambda{ MetricABC.new(File.join(File.dirname(__FILE__), "..", "fixtures", "not_found.rb"))}.should raise_exception
+  end
+
+end
+
+describe MetricABC, "calculating" do
+  before :each do
+    @metric = MetricABC.new(File.join(File.dirname(__FILE__), "..", "fixtures", "example.rb"))
+  end
+
+  it "should have 1 complexity for simple function" do
+    @metric.complexity["Example#simple_function"].should eql(1)
+  end
+
+  it "should recognize top level functions" do
+    @metric.complexity["outside_function"].should_not be_nil
+  end
+
+  it "should recognize modules functions" do
+    @metric.complexity["Test#Test2#class_in_module_function"].should_not be_nil
+  end
+
+  it "should have complexity of 7 for medium method" do
+    @metric.complexity["Example#medium_function"].should eql(7)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "metric_abc"))
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  #config.before(:each) do
+  #end
+
+  #config.after(:each) do
+  #end
+end
+

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: metric_abc
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Hubert Lepicki
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-24 00:00:00 +02:00
+default_executable: metric_abc
+dependencies: []
+
+description: Calculates ABC metric for Ruby 1.9. Just like Flog but much more dull.
+email: hubert.lepick@amberbit.com
+executables: 
+- metric_abc
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- README
+- Rakefile
+- VERSION
+- bin/metric_abc
+- lib/metric_abc.rb
+- metric_abc.gemspec
+- spec/fixtures/example.rb
+- spec/fixtures/not_valid.rb
+- spec/functional/metric_abc_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/hubertlepicki/metric_abc
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Quick and *DIRTY* ABC metric for Ruby 1.9 code
+test_files: 
+- spec/fixtures/example.rb
+- spec/fixtures/not_valid.rb
+- spec/spec_helper.rb
+- spec/functional/metric_abc_spec.rb