metric_fu 4.10.0 → 4.11.0

data/spec/fixtures/rcov_output.txt

@@ -0,0 +1,135 @@
+Profiling enabled.
+.............................................................................................................................................................................................
+
+
+Top 10 slowest examples:
+0.2707830 MetricFu::RoodiGrapher responding to #get_metrics should push 13 to roodi_count
+0.1994550 MetricFu::RcovGrapher responding to #get_metrics should update labels with the date
+0.1985800 MetricFu::ReekGrapher responding to #get_metrics should set a hash of code smells to reek_count
+0.1919860 MetricFu::ReekGrapher responding to #get_metrics should update labels with the date
+0.1907400 MetricFu::RoodiGrapher responding to #get_metrics should update labels with the date
+0.1883000 MetricFu::FlogGrapher responding to #get_metrics should update labels with the date
+0.1882650 MetricFu::FlayGrapher responding to #get_metrics should push 476 to flay_score
+0.1868780 MetricFu::FlogGrapher responding to #get_metrics should push to top_five_percent_average
+0.1847730 MetricFu::FlogGrapher responding to #get_metrics should push 9.9 to flog_average
+0.1844090 MetricFu::FlayGrapher responding to #get_metrics should update labels with the date
+
+Finished in 2.517686 seconds
+
+189 examples, 0 failures
+================================================================================
+ ./lib/metric_fu/metrics/hotspots/analysis/record.rb
+================================================================================
+   module MetricFu
+     class Record
+--
+       attr_reader :data
+--
+       def initialize(data, columns)
+         @data = data
+--     end
+--
+       def method_missing(name, *args, &block)
+         key = name.to_s
+         if key == 'fetch'
+           @data.send(name, *args, &block)
+         elsif @data.has_key?(key)
+           @data[key]
+--       else
+!!         super(name, *args, &block)
+--       end
+--     end
+--
+       def []=(key, value)
+          @data[key]=value
+--     end
+--
+       def [](key)
+         @data[key]
+--     end
+--
+       def has_key?(key)
+         @data.has_key?(key)
+--     end
+--
+--   end
+-- end
+
+================================================================================
+ ./lib/metric_fu/metrics/hotspots/analysis/table.rb
+================================================================================
+   %w(record).each do |path|
+     MetricFu.metrics_require   { "hotspots/analysis/#{path}" }
+-- end
+--
+   module MetricFu
+     class Table
+       include Enumerable
+--
+       def initialize(opts = {})
+         @rows = []
+         @columns = opts.fetch(:column_names)
+--
+         @make_index = opts.fetch(:make_index) {true}
+         @metric_index = {}
+--     end
+--
+       def <<(row)
+         record = nil
+         if row.is_a?(MetricFu::Record)
+           record = row
+--       else
+           record = MetricFu::Record.new(row, @columns)
+--       end
+         @rows << record
+         updated_key_index(record) if @make_index
+--     end
+--
+       def concat(records)
+!!       records.each do |record|
+!!         self << record
+--       end
+!!       self
+--     end
+--
+       def each
+         @rows.each do |row|
+           yield row
+--       end
+--     end
+--
+       def size
+         length
+--     end
+--
+       def length
+         @rows.length
+--     end
+--
+       def [](index)
+         @rows[index]
+--     end
+--
+       def column(column_name)
+         arr = []
+         @rows.each do |row|
+           arr << row[column_name]
+--       end
+         arr
+--     end
+--
+       def group_by_metric
+         @metric_index.to_a
+--     end
+--
+       private
+--
+       def updated_key_index(record)
+         if record.has_key?('metric')
+           @metric_index[record.metric] ||= MetricFu::Table.new(:column_names => @columns, :make_index => false)
+           @metric_index[record.metric] << record
+--       end
+--     end
+--
+--   end
+-- end

data/spec/metric_fu/configuration_spec.rb

@@ -1,49 +1,9 @@
 require "spec_helper"
+require 'shared/configured'
 
 describe MetricFu::Configuration do
 
-  def get_new_config
-    ENV['CC_BUILD_ARTIFACTS'] = nil
-    @config = MetricFu.configuration
-    @config.reset
-    MetricFu.configuration.configure_metric(:rcov) do |rcov|
-      rcov.enabled = true
-    end
-    MetricFu.configure
-    allow(MetricFu::Io::FileSystem).to receive(:create_directories) # no need to create directories for the tests
-    @config
-  end
-
-  def directory(name)
-    MetricFu::Io::FileSystem.directory(name)
-  end
-
-  def base_directory
-    directory('base_directory')
-  end
-
-  def output_directory
-    directory('output_directory')
-  end
-
-  def scratch_directory
-    directory('scratch_directory')
-  end
-
-  def template_directory
-    directory('template_directory')
-  end
-
-  def template_class
-    MetricFu::Formatter::Templates.option('template_class')
-  end
-
-  def metric_fu_root
-    directory('root_directory')
-  end
-  def load_metric(metric)
-    load File.join(MetricFu.metrics_dir, metric, 'init.rb')
-  end
+it_behaves_like 'configured' do
 
   describe '#is_cruise_control_rb? ' do
 
@@ -109,15 +69,7 @@ describe MetricFu::Configuration do
         app_root_absolute_path = File.expand_path(app_root)
         metric_fu_absolute_path = File.expand_path(metric_fu_root)
         expect(metric_fu_absolute_path).to eq(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)
-        expect(calc_template_dir_abs_path).to eq(template_dir_abs_path)
+        expect(MetricFu.root.to_s).to      eq(app_root_absolute_path)
       end
 
       it 'should set @scratch_directory to scratch relative '+
@@ -132,185 +84,8 @@ describe MetricFu::Configuration do
         expect(output_directory).to eq(output_dir)
       end
 
-      it 'should set @template_class to AwesomeTemplate by default' do
-        expect(template_class).to eq(AwesomeTemplate)
-      end
-
-      describe 'when a templates configuration is given' do
-
-        before do
-          class DummyTemplate;end
-
-          @config.templates_configuration do |config|
-            config.template_class = DummyTemplate
-            config.link_prefix = 'http:/'
-            config.syntax_highlighting = false
-            config.darwin_txmt_protocol_no_thanks = false
-          end
-        end
-
-        it 'should set given template_class' do
-          expect(template_class).to eq(DummyTemplate)
-        end
-
-        it 'should set given link_prefix' do
-          expect(MetricFu::Formatter::Templates.option('link_prefix')).to eq('http:/')
-        end
-
-        it 'should set given darwin_txmt_protocol_no_thanks' do
-          expect(MetricFu::Formatter::Templates.option('darwin_txmt_protocol_no_thanks')).to be_falsey
-        end
-
-        it 'should set given syntax_highlighting' do
-          expect(MetricFu::Formatter::Templates.option('syntax_highlighting')).to be_falsey
-        end
-
-      end
-
-      it 'should set @flay to {:dirs_to_flay => @code_dirs}' do
-        load_metric 'flay'
-        expect(MetricFu::Metric.get_metric(:flay).run_options).to eq(
-                {:dirs_to_flay => ['lib'], :filetypes=>["rb"], :minimum_score=>nil}
-        )
-      end
-
-      it 'should set @reek to {:dirs_to_reek => @code_dirs}' do
-        load_metric 'reek'
-        expect(MetricFu::Metric.get_metric(:reek).run_options).to eq(
-                {:config_file_pattern=>nil, :dirs_to_reek => ['lib']}
-        )
-      end
-
-      it 'should set @roodi to {:dirs_to_roodi => @code_dirs}' do
-        load_metric 'roodi'
-        expect(MetricFu::Metric.get_metric(:roodi).run_options).to eq(
-                { :dirs_to_roodi => directory('code_dirs'),
-                    :roodi_config => "#{directory('root_directory')}/config/roodi_config.yml"}
-                )
-      end
-
-      it 'should set @churn to {}' do
-        load_metric 'churn'
-        expect(MetricFu::Metric.get_metric(:churn).run_options).to eq(
-                { :start_date => %q("1 year ago"), :minimum_churn_count => 10, :ignore_files=>[], :data_directory=> MetricFu::Io::FileSystem.scratch_directory('churn')}
-        )
-      end
-
-
-      it 'should set @rcov to ' +
-                            %q(:test_files =>  Dir['{spec,test}/**/*_{spec,test}.rb'],
-                            :rcov_opts => [
-                              "--sort coverage",
-                              "--no-html",
-                              "--text-coverage",
-                              "--no-color",
-                              "--profile",
-                              "--exclude-only '.*'",
-                              '--include-file "\Aapp,\Alib"',
-                              "-Ispec"
-                            ]) do
-        load_metric 'rcov'
-        expect(MetricFu::Metric.get_metric(:rcov).run_options).to eq(
-                { :environment => 'test',
-                            :external => nil,
-                            :test_files =>  Dir['{spec,test}/**/*_{spec,test}.rb'],
-                            :rcov_opts => [
-                              "--sort coverage",
-                              "--no-html",
-                              "--text-coverage",
-                              "--no-color",
-                              "--profile",
-                              "--exclude-only '.*'",
-                              '--include-file "\Aapp,\Alib"',
-                              "-Ispec"
-                            ],
-                            }
-        )
-      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
-        load_metric 'saikuro'
-        expect(MetricFu::Metric.get_metric(:saikuro).run_options).to eq(
-                { :output_directory => "#{scratch_directory}/saikuro",
-                      :input_directory => ['lib'],
-                      :cyclo => "",
-                      :filter_cyclo => "0",
-                      :warn_cyclo => "5",
-                      :error_cyclo => "7",
-                      :formater => "text"}
-                      )
-      end
-
-      if MetricFu.configuration.mri?
-        it 'should set @flog to {:dirs_to_flog => @code_dirs}' do
-          load_metric 'flog'
-          expect(MetricFu::Metric.get_metric(:flog).run_options).to eq({
-            :all => true,
-           :continue => true,
-           :dirs_to_flog => ["lib"],
-           :quiet => true
-           })
-        end
-        it 'should set @cane to ' +
-                            %q(:dirs_to_cane => @code_dirs, :abc_max => 15, :line_length => 80, :no_doc => 'n', :no_readme => 'y') do
-          load_metric 'cane'
-          expect(MetricFu::Metric.get_metric(:cane).run_options).to eq(
-            {
-              :dirs_to_cane => directory('code_dirs'),
-              :filetypes => ["rb"],
-              :abc_max => 15,
-              :line_length => 80,
-              :no_doc => "n",
-              :no_readme => "n"}
-              )
-        end
-      end
-
-
     end
-    describe 'if #rails? is true ' do
 
-      before(:each) do
-        @config = MetricFu.configuration
-        allow(@config).to receive(:rails?).and_return(true)
-        @config.reset
-        MetricFu.configure
-        %w(rails_best_practices).each do |metric|
-          load_metric metric
-        end
-      end
-
-      describe '#set_graphs ' do
-        it 'should set the graphs to include rails_best_practices' do
-          expect(MetricFu::Metric.get_metric(:rails_best_practices).has_graph?).to be_truthy
-        end
-      end
-
-      it 'should set @rails_best_practices to {}' do
-        load_metric 'rails_best_practices'
-        expect(MetricFu::Metric.get_metric(:rails_best_practices).run_options).to eql({})
-      end
-    end
-
-    describe 'if #rails? is false ' do
-      before(:each) do
-        get_new_config
-        allow(@config).to receive(:rails?).and_return(false)
-        %w(rails_best_practices).each do |metric|
-          load_metric metric
-        end
-      end
-
-      it 'should set the registered code_dirs to ["lib"]' do
-        expect(directory('code_dirs')).to eq(['lib'])
-      end
-    end
   end
 
   describe '#platform' do
@@ -323,41 +98,5 @@ describe MetricFu::Configuration do
     end
   end
 
-  describe '#configure_formatter' do
-    before(:each) { get_new_config }
-
-    context 'given a built-in formatter' do
-      before do
-        @config.configure_formatter('html')
-      end
-
-      it 'adds to the list of formatters' do
-        expect(@config.formatters.first).to be_an_instance_of(MetricFu::Formatter::HTML)
-      end
-    end
-
-    context 'given a custom formatter by class name' do
-      before do
-        stub_const('MyCustomFormatter', Class.new() { def initialize(*); end })
-        @config.configure_formatter('MyCustomFormatter')
-      end
-
-      it 'adds to the list of formatters' do
-        expect(@config.formatters.first).to be_an_instance_of(MyCustomFormatter)
-      end
-    end
-
-    context 'given multiple formatters' do
-      before do
-        stub_const('MyCustomFormatter', Class.new() { def initialize(*); end })
-        @config.configure_formatter('html')
-        @config.configure_formatter('yaml')
-        @config.configure_formatter('MyCustomFormatter')
-      end
-
-      it 'adds each to the list of formatters' do
-        expect(@config.formatters.count).to eq(3)
-      end
-    end
-  end
+end
 end

data/spec/metric_fu/formatter/configuration_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'shared/configured'
+
+describe MetricFu::Configuration, 'for formatters' do
+  it_behaves_like 'configured' do
+
+    describe '#configure_formatter' do
+      before(:each) { get_new_config }
+
+      context 'given a built-in formatter' do
+        before do
+          @config.configure_formatter('html')
+        end
+
+        it 'adds to the list of formatters' do
+          expect(@config.formatters.first).to be_an_instance_of(MetricFu::Formatter::HTML)
+        end
+      end
+
+      context 'given a custom formatter by class name' do
+        before do
+          stub_const('MyCustomFormatter', Class.new() { def initialize(*); end })
+          @config.configure_formatter('MyCustomFormatter')
+        end
+
+        it 'adds to the list of formatters' do
+          expect(@config.formatters.first).to be_an_instance_of(MyCustomFormatter)
+        end
+      end
+
+      context 'given multiple formatters' do
+        before do
+          stub_const('MyCustomFormatter', Class.new() { def initialize(*); end })
+          @config.configure_formatter('html')
+          @config.configure_formatter('yaml')
+          @config.configure_formatter('MyCustomFormatter')
+        end
+
+        it 'adds each to the list of formatters' do
+          expect(@config.formatters.count).to eq(3)
+        end
+      end
+    end
+
+  end
+end