RubyGems - khall-metric_fu - Versions diffs - 1.0.2.1 - Mend

khall-metric_fu 1.0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (47) hide show

data/HISTORY +119 -0
data/MIT-LICENSE +22 -0
data/Manifest.txt +25 -0
data/README +1 -0
data/Rakefile +46 -0
data/TODO +14 -0
data/lib/base/base_template.rb +134 -0
data/lib/base/configuration.rb +187 -0
data/lib/base/generator.rb +147 -0
data/lib/base/md5_tracker.rb +52 -0
data/lib/base/report.rb +100 -0
data/lib/generators/churn.rb +86 -0
data/lib/generators/flay.rb +29 -0
data/lib/generators/flog.rb +127 -0
data/lib/generators/rcov.rb +77 -0
data/lib/generators/reek.rb +32 -0
data/lib/generators/roodi.rb +24 -0
data/lib/generators/saikuro.rb +212 -0
data/lib/generators/stats.rb +43 -0
data/lib/metric_fu.rb +20 -0
data/lib/templates/standard/churn.html.erb +30 -0
data/lib/templates/standard/default.css +64 -0
data/lib/templates/standard/flay.html.erb +33 -0
data/lib/templates/standard/flog.html.erb +52 -0
data/lib/templates/standard/index.html.erb +38 -0
data/lib/templates/standard/rcov.html.erb +42 -0
data/lib/templates/standard/reek.html.erb +41 -0
data/lib/templates/standard/roodi.html.erb +28 -0
data/lib/templates/standard/saikuro.html.erb +83 -0
data/lib/templates/standard/standard_template.rb +26 -0
data/lib/templates/standard/stats.html.erb +54 -0
data/spec/base/base_template_spec.rb +140 -0
data/spec/base/configuration_spec.rb +303 -0
data/spec/base/generator_spec.rb +159 -0
data/spec/base/md5_tracker_spec.rb +57 -0
data/spec/base/report_spec.rb +139 -0
data/spec/generators/churn_spec.rb +152 -0
data/spec/generators/flay_spec.rb +101 -0
data/spec/generators/flog_spec.rb +200 -0
data/spec/generators/reek_spec.rb +59 -0
data/spec/generators/saikuro_spec.rb +53 -0
data/spec/generators/stats_spec.rb +74 -0
data/spec/spec_helper.rb +28 -0
data/tasks/metric_fu.rake +15 -0
data/tasks/railroad.rake +39 -0
data/vendor/saikuro/saikuro.rb +1214 -0
metadata +163 -0

data/lib/templates/standard/standard_template.rb ADDED Viewed

@@ -0,0 +1,26 @@
+class StandardTemplate < MetricFu::Template
+  def write
+    report.each_pair do |section, contents|
+      if template_exists?(section)
+        create_instance_var(section, contents)
+        html = erbify(section)
+        fn = output_filename(section)
+        MetricFu.report.save_output(html, MetricFu.output_directory, fn)
+      end
+    end
+    # Instance variables we need should already be created from above
+    if template_exists?('index')
+      html = erbify('index')
+      fn = output_filename('index')
+      MetricFu.report.save_output(html, MetricFu.output_directory, fn)
+    end
+  end
+  def this_directory
+    File.dirname(__FILE__)
+  end
+end

data/lib/templates/standard/stats.html.erb ADDED Viewed

@@ -0,0 +1,54 @@
+<html>
+<head>
+	<title>Rake Stats Results</title>
+	<style>
+	<%= inline_css("default.css") %>
+	</style>
+</head>
+<body>
+	<h1>Rake Stats  Results</h1>
+	<p>Rails rake stats results.</p>
+	<table>
+    <tr>
+      <th>Lines of Code</th>
+      <th>Lines of Test</th>
+      <th>Code to test ratio</th>
+    </tr>
+    <tr>
+      <td><%= @stats[:codeLOC] %></td>
+      <td><%= @stats[:testLOC] %></td>
+      <td>1:<%= @stats[:code_to_test_ratio] %></td>
+    </tr>
+  </table>
+	<table>
+    <tr>
+      <th>Name</th>
+      <th>Lines</th>
+      <th>LOC</th>
+      <th>Classes</th>
+      <th>Methods</th>
+      <th>Methods per class</th>
+      <th>LOC per method</th>
+    </tr>
+    <% count = 0 %>
+    <% @stats[:lines].each do |line| %>
+      <tr>
+        <td><%= line[:name] %></td>
+        <td><%= line[:lines] %></td>
+        <td><%= line[:loc] %></td>
+        <td><%= line[:classes] %></td>
+        <td><%= line[:methods] %></td>
+        <td><%= line[:methods_per_class] %></td>
+        <td><%= line[:loc_per_method] %></td>
+      </tr>
+      <% count += 1 %>
+		<% end %>
+  </table>
+	<p>Generated on <%= Time.now.localtime %></p>
+</body>
+</html>

data/spec/base/base_template_spec.rb ADDED Viewed

@@ -0,0 +1,140 @@
+require File.dirname(__FILE__) + "/../spec_helper.rb"
+require 'erb'
+describe MetricFu::Template do
+  before(:each) do
+    @template =  Template.new
+  end
+  describe "#erbify" do
+    it 'should evaluate a erb doc' do
+      section = 'section'
+      File.stub!(:read).and_return('foo')
+      erb = mock('erb')
+      erb.should_receive(:result)
+      ERB.should_receive(:new).with('foo').and_return(erb)
+      @template.should_receive(:template).and_return('foo')
+      @template.send(:erbify, section)
+    end
+  end
+  describe "#template_exists? " do
+    before(:each) do
+      @section = mock('section')
+      @template.should_receive(:template).
+                with(@section).and_return(@section)
+    end
+    describe 'if the template exists' do
+      it 'should return true' do
+        File.should_receive(:exist?).with(@section).and_return(true)
+        result = @template.send(:template_exists?, @section)
+        result.should be_true
+      end
+    end
+    describe 'if the template does not exist' do
+      it 'should return false' do
+        File.should_receive(:exist?).with(@section).and_return(false)
+        result = @template.send(:template_exists?, @section)
+        result.should be_false
+      end
+    end
+  end
+  describe "#create_instance_var" do
+    it 'should set an instance variable with the passed contents' do
+      section = 'section'
+      contents = 'contents'
+      @template.send(:create_instance_var, section, contents)
+      @template.instance_variable_get(:@section).should == contents
+    end
+  end
+  describe "#template" do
+    it 'should generate the filename of the template file' do
+      section = mock('section')
+      section.should_receive(:to_s).and_return('section')
+      @template.should_receive(:this_directory).and_return('dir')
+      result = @template.send(:template, section)
+      result.should == "dir/section.html.erb"
+    end
+  end
+  describe "#output_filename" do
+    it 'should generate the filename of the output file' do
+      section = mock('section')
+      section.should_receive(:to_s).and_return('section')
+      result = @template.send(:output_filename, section)
+      result.should == "section.html"
+    end
+  end
+  describe "#inline_css" do
+    it 'should return the contents of a css file' do
+      css = 'mycss.css'
+      @template.should_receive(:this_directory).and_return('dir')
+      io = mock('io', :read => "css contents")
+      @template.should_receive(:open).and_yield(io)
+      result = @template.send(:inline_css, css)
+      result.should == 'css contents'
+    end
+  end
+  describe "#link_to_filename " do
+    describe "when on OS X" do
+      before(:each) do
+        config = mock("configuration")
+        config.should_receive(:platform).and_return('universal-darwin-9.0')
+        MetricFu.stub!(:configuration).and_return(config)
+        File.should_receive(:expand_path).and_return('filename')
+      end
+      it 'should return a textmate protocol link' do
+        name = "filename"
+        result = @template.send(:link_to_filename, name)
+        result.should eql("<a href='txmt://open/?url=file://" \
+                         + "filename&line='>filename:</a>")
+      end
+    end
+    describe "when on other platforms"  do
+      before(:each) do
+        config = mock("configuration")
+        config.should_receive(:platform).and_return('other')
+        MetricFu.stub!(:configuration).and_return(config)
+        File.should_receive(:expand_path).and_return('filename')
+      end
+      it 'should return a file protocol link' do
+        name = "filename"
+        result = @template.send(:link_to_filename, name)
+        result.should == "<a href='file://filename'>filename:</a>"
+      end
+    end
+  end
+  describe "#cycle" do
+    it 'should return the first_value passed if iteration passed is even' do
+      first_val = "first"
+      second_val = "second"
+      iter = 2
+      result = @template.send(:cycle, first_val, second_val, iter)
+      result.should == first_val
+    end
+    it 'should return the second_value passed if iteration passed is odd' do
+      first_val = "first"
+      second_val = "second"
+      iter = 1
+      result = @template.send(:cycle, first_val, second_val, iter)
+      result.should == second_val
+    end
+  end
+end

data/spec/base/configuration_spec.rb ADDED Viewed

@@ -0,0 +1,303 @@
+require File.dirname(__FILE__) + "/../spec_helper.rb"
+describe MetricFu::Configuration do
+  def get_new_config
+    @config = Configuration.new
+  end
+  def base_directory
+    @config.instance_variable_get(:@base_directory)
+  end
+  def output_directory
+    @config.instance_variable_get(:@output_directory)
+  end
+  def scratch_directory
+    @config.instance_variable_get(:@scratch_directory)
+  end
+  def template_directory
+    @config.instance_variable_get(:@template_directory)
+  end
+  def template_class
+    @config.instance_variable_get(:@template_class)
+  end
+  def metric_fu_root
+    @config.instance_variable_get(:@metric_fu_root_directory)
+  end
+  describe '#warn_about_deprecated_config_options' do
+    def get_new_config_and_raise_runtime_error
+      lambda { get_new_config  }.should raise_error
+    end
+    describe 'when ::MetricFu::CHURN_OPTIONS is present' do
+      before(:each) { ::MetricFu::CHURN_OPTIONS = 'option' }
+      after(:each)  { ::MetricFu.send(:remove_const, 'CHURN_OPTIONS') }
+      it 'should raise a RuntimeError with "Use config.churn '+
+      'instead of MetricFu::CHURN_OPTIONS"' do
+        get_new_config_and_raise_runtime_error
+      end
+    end
+    describe 'when ::MetricFu::DIRECTORIES_TO_FLOG is present' do
+      before(:each) { ::MetricFu::DIRECTORIES_TO_FLOG = 'option' }
+      after(:each)  { ::MetricFu.send(:remove_const,'DIRECTORIES_TO_FLOG')}
+      it 'should raise a RuntimeError with "Use config.flog '+
+      '[:dirs_to_flog] instead of MetricFu::DIRECTORIES_TO_FLOG' do
+        get_new_config_and_raise_runtime_error
+      end
+    end
+    describe 'when ::MetricFu::SAIKURO_OPTIONS is present' do
+      before(:each) { ::MetricFu::SAIKURO_OPTIONS = 'option' }
+      after(:each)  { ::MetricFu.send(:remove_const,'SAIKURO_OPTIONS')}
+      it 'should raise a RuntimeError with "Use config.saikuro '+
+      'instead of MetricFu::SAIKURO_OPTIONS' do
+        get_new_config_and_raise_runtime_error
+      end
+    end
+    describe 'when SAIKURO_OPTIONS is present' do
+      before(:each) { SAIKURO_OPTIONS = 'option' }
+      after(:each)  { Object.send(:remove_const,'SAIKURO_OPTIONS')}
+      it 'should raise a RuntimeError with "Use config.saikuro '+
+      'instead of SAIKURO_OPTIONS' do
+        get_new_config_and_raise_runtime_error
+      end
+    end
+  end
+  describe "#reset" do
+    before(:each) { get_new_config }
+    describe 'when there is a CC_BUILD_ARTIFACTS environment variable' do
+      before(:each) { ENV['CC_BUILD_ARTIFACTS'] = 'foo' }
+      it 'should return the CC_BUILD_ARTIFACTS environment variable' do
+        get_new_config
+        base_directory.should == ENV['CC_BUILD_ARTIFACTS']
+      end
+    end
+    describe 'when there is no CC_BUILD_ARTIFACTS environment variable' do
+      before(:each) { ENV['CC_BUILD_ARTIFACTS'] = nil  }
+      it 'should return "tmp/metric_fu"' do
+        get_new_config
+        base_directory.should == "tmp/metric_fu"
+      end
+    end
+    it 'should set @metric_fu_root_directory to the base of the '+
+    'metric_fu application' do
+      app_root = File.join(File.dirname(__FILE__), '..', '..')
+      app_root_absolute_path = File.expand_path(app_root)
+      metric_fu_absolute_path = File.expand_path(metric_fu_root)
+      metric_fu_absolute_path.should == app_root_absolute_path
+    end
+    it 'should set @template_directory to the lib/templates relative '+
+    'to @metric_fu_root_directory' do
+      template_dir = File.join(File.dirname(__FILE__),
+                               '..', '..', 'lib','templates')
+      template_dir_abs_path = File.expand_path(template_dir)
+      calc_template_dir_abs_path = File.expand_path(template_directory)
+      calc_template_dir_abs_path.should == template_dir_abs_path
+    end
+    it 'should set @scratch_directory to scratch relative '+
+    'to @base_directory' do
+      scratch_dir = File.join(base_directory, 'scratch')
+      scratch_directory.should == scratch_dir
+    end
+    it 'should set @output_directory to output relative '+
+    'to @base_directory' do
+      output_dir = File.join(base_directory, 'output')
+      output_directory.should == output_dir
+    end
+    it 'should set @template_class to StandardTemplate' do
+      template_class.should == StandardTemplate
+    end
+    it 'should set @flay to {:dirs_to_flay => @code_dirs}' do
+      @config.instance_variable_get(:@flay).
+              should == {:dirs_to_flay => ['lib']}
+    end
+    it 'should set @flog to {:dirs_to_flog => @code_dirs}' do
+      @config.instance_variable_get(:@flog).
+              should == {:dirs_to_flog => ['lib']}
+    end
+    it 'should set @reek to {:dirs_to_reek => @code_dirs}' do
+      @config.instance_variable_get(:@reek).
+              should == {:dirs_to_reek => ['lib']}
+    end
+    it 'should set @roodi to {:dirs_to_roodi => @code_dirs}' do
+      @config.instance_variable_get(:@roodi).
+              should == {:dirs_to_roodi => ['lib']}
+    end
+    it 'should set @churn to {}' do
+      @config.instance_variable_get(:@churn).
+              should == {}
+    end
+    it 'should set @stats to {}' do
+      @config.instance_variable_get(:@stats).
+              should == {}
+    end
+    it 'should set @rcov to { :test_files => ["test/**/*_test.rb",
+                                              "spec/**/*_spec.rb"]
+                              :rcov_opts  => ["--sort coverage",
+                                              "--no-html",
+                                              "--text-coverage",
+                                              "--no-color",
+                                              "--profile",
+                                              "--rails",
+                                              "--exclude /gems/,/Library/,/usr/,spec"]}' do
+      @config.instance_variable_get(:@rcov).
+              should ==  { :test_files => ['test/**/*_test.rb',
+                                           'spec/**/*_spec.rb'],
+                           :rcov_opts => ["--sort coverage",
+                                         "--no-html",
+                                         "--text-coverage",
+                                         "--no-color",
+                                         "--profile",
+                                         "--rails",
+                                         "--exclude /gems/,/Library/,/usr/,spec"]}
+    end
+    it 'should set @saikuro to { :output_directory => @scratch_directory + "/saikuro",
+                                 :input_directory => @code_dirs,
+                                 :cyclo => "",
+                                 :filter_cyclo => "0",
+                                 :warn_cyclo => "5",
+                                 :error_cyclo => "7",
+                                 :formater => "text" }' do
+      @config.instance_variable_get(:@saikuro).
+              should ==  { :output_directory => 'tmp/metric_fu/scratch/saikuro',
+                    :input_directory => ['lib'],
+                    :cyclo => "",
+                    :filter_cyclo => "0",
+                    :warn_cyclo => "5",
+                    :error_cyclo => "7",
+                    :formater => "text"}
+    end
+    describe 'if #rails? is true ' do
+      before(:each) do
+        @config.stub!(:rails?).and_return(true)
+      end
+      describe '#set_metrics ' do
+        it 'should set the @metrics instance var to AVAILABLE_METRICS + '\
+           +'[:stats]' do
+          @config.instance_variable_get(:@metrics).
+                  should == MetricFu::AVAILABLE_METRICS << [:stats]
+        end
+      end
+      describe '#set_code_dirs ' do
+        it 'should set the @code_dirs instance var to ["app", "lib"]' do
+          # This is hard to spec properly because the @code_dirs variable
+          # is set during the reset process.
+          #@config.instance_variable_get(:@code_dirs).
+          #        should == ['app','lib']
+        end
+      end
+    end
+    describe 'if #rails? is false ' do
+      before(:each) do
+        @config.stub!(:rails?).and_return(false)
+      end
+      describe '#set_metrics ' do
+        it 'should set the @metrics instance var to AVAILABLE_METRICS' do
+          @config.instance_variable_get(:@metrics).
+                  should == MetricFu::AVAILABLE_METRICS
+        end
+      end
+      describe '#set_code_dirs ' do
+        it 'should set the @code_dirs instance var to ["lib"]' do
+          @config.instance_variable_get(:@code_dirs).should == ['lib']
+        end
+      end
+    end
+  end
+  describe '#add_attr_accessors_to_self' do
+    before(:each) { get_new_config }
+    MetricFu::AVAILABLE_METRICS.each do |metric|
+      it "should have a reader for #{metric}" do
+        @config.respond_to?(metric).should be_true
+      end
+      it "should have a writer for #{metric}=" do
+        @config.respond_to?((metric.to_s + '=').to_sym).should be_true
+      end
+    end
+  end
+  describe '#add_class_methods_to_metric_fu' do
+    before(:each) { get_new_config }
+    MetricFu::AVAILABLE_METRICS.each do |metric|
+      it "should add a #{metric} class method to the MetricFu module " do
+        MetricFu.respond_to?(metric).should be_true
+      end
+    end
+  end
+  describe '#platform' do
+    before(:each) { get_new_config }
+    it 'should return the value of the PLATFORM constant' do
+      this_platform = PLATFORM
+      @config.platform.should == this_platform
+    end
+  end
+  describe '#is_cruise_control_rb? ' do
+    before(:each) { get_new_config }
+    describe "when the CC_BUILD_ARTIFACTS env var is not nil" do
+      before(:each) { ENV['CC_BUILD_ARTIFACTS'] = 'is set' }
+      it 'should return true'  do
+        @config.is_cruise_control_rb?.should be_true
+      end
+    end
+    describe "when the CC_BUILD_ARTIFACTS env var is nil" do
+      before(:each) { ENV['CC_BUILD_ARTIFACTS'] = nil }
+      it 'should return false' do
+        @config.is_cruise_control_rb?.should be_false
+      end
+    end
+  end
+end

data/spec/base/generator_spec.rb ADDED Viewed

@@ -0,0 +1,159 @@
+require File.dirname(__FILE__) + "/../spec_helper.rb"
+describe MetricFu::Generator do
+  MetricFu::Configuration.run do |config|
+  end
+  class ConcreteClass < MetricFu::Generator
+    def emit
+    end
+    def analyze
+    end
+    def to_h
+    end
+  end
+  before(:each) do
+    @concrete_class = ConcreteClass.new
+  end
+  describe "ConcreteClass#class_name" do
+    it "should be 'concreteclass'" do
+      ConcreteClass.class_name.should == 'concreteclass'
+    end
+  end
+  describe "ConcreteClass#metric_directory" do
+    it "should be 'tmp/metric_fu/scratch/concreteclass'" do
+      ConcreteClass.metric_directory.
+                    should == "tmp/metric_fu/scratch/concreteclass"
+    end
+  end
+  describe "#create_metric_dir_if_missing " do
+    describe "when the metric_dir exists " do
+      it 'should not call mkdir_p on FileUtils' do
+        File.stub!(:directory?).and_return(true)
+        FileUtils.should_not_receive(:mkdir_p)
+        @concrete_class.create_metric_dir_if_missing
+      end
+    end
+    describe "when the metric_dir does not exist " do
+      it 'should call mkdir_p on FileUtils' do
+        File.stub!(:directory?).and_return(false)
+        FileUtils.should_receive(:mkdir_p)
+        @concrete_class.create_metric_dir_if_missing
+      end
+    end
+  end
+  describe "#create_output_dir_if_missing" do
+    describe "when the output_dir exists " do
+      it 'should not call mkdir_p on FileUtils' do
+        File.stub!(:directory?).and_return(true)
+        FileUtils.should_not_receive(:mkdir_p)
+        @concrete_class.create_output_dir_if_missing
+      end
+    end
+    describe "when the output_dir does not exist " do
+      it 'should call mkdir_p on FileUtils' do
+        File.stub!(:directory?).and_return(false)
+        FileUtils.should_receive(:mkdir_p)
+        @concrete_class.create_output_dir_if_missing
+      end
+    end
+  end
+  describe '#metric_directory' do
+    it 'should return the results of ConcreteClass#metric_directory' do
+      ConcreteClass.stub!(:metric_directory).and_return('foo')
+      @concrete_class.metric_directory.should == 'foo'
+    end
+  end
+  describe 'ConcreteClass#generate_report' do
+    it 'should create a new instance of ConcreteClass' do
+      ConcreteClass.should_receive(:new).and_return(@concrete_class)
+      @concrete_class.should_receive(:generate_report).and_return(true)
+      ConcreteClass.generate_report
+    end
+    it 'should call #generate_report on the new ConcreteClass' do
+      ConcreteClass.should_receive(:new).and_return(@concrete_class)
+      @concrete_class.should_receive(:generate_report).and_return(true)
+      ConcreteClass.generate_report
+    end
+  end
+  describe '@concrete_class should have hook methods for '\
+           +'[before|after]_[emit|analyze|to_h]' do
+    %w[emit analyze].each do |meth|
+      it "should respond to #before_#{meth}" do
+        @concrete_class.respond_to?("before_#{meth}".to_sym).should be_true
+      end
+      it "should respond to #after_#{meth}" do
+        @concrete_class.respond_to?("after_#{meth}".to_sym).should be_true
+      end
+    end
+    it "should respond to #before_to_h" do
+      @concrete_class.respond_to?("before_to_h".to_sym).should be_true
+    end
+  end
+  describe "#generate_report" do
+    it 'should  raise an error when calling #emit' do
+      @abstract_class = MetricFu::Generator.new
+      lambda { @abstract_class.generate_report }.should  raise_error
+    end
+    it 'should call #analyze' do
+      @abstract_class = MetricFu::Generator.new
+      lambda { @abstract_class.generate_report }.should  raise_error
+    end
+    it 'should call #to_h' do
+      @abstract_class = MetricFu::Generator.new
+      lambda { @abstract_class.generate_report }.should  raise_error
+    end
+  end
+  describe "#generate_report (in a concrete class)" do
+    %w[emit analyze].each do |meth|
+      it "should call #before_#{meth}" do
+        @concrete_class.should_receive("before_#{meth}")
+        @concrete_class.generate_report
+      end
+      it "should call ##{meth}" do
+        @concrete_class.should_receive("#{meth}")
+        @concrete_class.generate_report
+      end
+      it "should call #after_#{meth}" do
+        @concrete_class.should_receive("after_#{meth}")
+        @concrete_class.generate_report
+      end
+    end
+    it "should call #before_to_h" do
+      @concrete_class.should_receive("before_to_h")
+      @concrete_class.generate_report
+    end
+    it "should call #to_h" do
+      @concrete_class.should_receive(:to_h)
+      @concrete_class.generate_report
+    end
+  end
+end