metric_fu 4.6.0 → 4.7.0

data/lib/metric_fu/templates/report.rb

@@ -0,0 +1,36 @@
+MetricFu.lib_require { 'formatter/syntax' }
+
+module MetricFu
+  module Templates
+    class Report < MetricFu::Template
+
+      def initialize(file, lines)
+        @file = file
+        @lines = lines
+        @data = File.readlines(file)
+      end
+
+      def render(metrics)
+        @metrics = metrics
+        erbify('report')
+      end
+
+      def convert_ruby_to_html(ruby_text, line_number)
+        MetricFu::Formatter::Syntax.new.highlight(ruby_text, line_number)
+      end
+
+      def line_for_display(line, line_number)
+        if MetricFu::Formatter::Templates.option('syntax_highlighting')
+          line_for_display = convert_ruby_to_html(line, line_number)
+        else
+          "<a name='n#{line_number}' href='n#{line_number}'>#{line_number}</a>#{line}"
+       end
+      end
+
+      def template_directory
+        File.dirname(__FILE__)
+      end
+
+    end
+  end
+end

data/lib/metric_fu/utility.rb

@@ -33,5 +33,9 @@ module MetricFu
       YAML.load_file(file)
     end
 
+    def binread(file)
+      File.binread(file)
+    end
+
   end
 end

data/lib/metric_fu/version.rb

@@ -1,3 +1,3 @@
 module MetricFu
-  VERSION = '4.6.0'
+  VERSION = '4.7.0'
 end

data/metric_fu.gemspec

@@ -9,11 +9,15 @@ Gem::Specification.new do |s|
   s.description = "Code metrics from Flog, Flay, Saikuro, Churn, Reek, Roodi, Code Statistics, and Rails Best Practices. (and optionally RCov)"
   s.email       = "github@benjaminfleischer.com"
   author_file   = File.expand_path('AUTHORS', File.dirname(__FILE__))
-  s.authors     = File.readlines(author_file).map(&:strip)
+  s.authors     = File.readlines(author_file, :encoding => Encoding::UTF_8).map(&:strip)
 
   # used with gem i metric_fu -P HighSecurity
   s.cert_chain  = ['certs/bf4.pem']
-  s.signing_key = File.expand_path("~/.ssh/gem-private_key.pem") if $0 =~ /gem\z/
+  # Sign gem when evaluating spec with `gem` command
+  #  unless ENV has set a SKIP_GEM_SIGNING
+  if ($0 =~ /gem\z/) and not ENV.include?('SKIP_GEM_SIGNING')
+    s.signing_key = File.join(Gem.user_home, '.ssh', 'gem-private_key.pem')
+  end
 
   s.rubyforge_project           = 'metric_fu'
   s.license                     = 'MIT'
@@ -56,4 +60,9 @@ Gem::Specification.new do |s|
   # to_json support
   s.add_runtime_dependency 'multi_json'
 
+  # temporary filesystem to act on
+  s.add_development_dependency   'test_construct'
+  # ensure we have a JSON parser
+  s.add_development_dependency   'json'
+
 end

data/spec/cli/helper_spec.rb

@@ -15,52 +15,52 @@ describe MetricFu::Cli::Helper do
     context "on every Ruby version" do
 
       it "opens the report in a browser" do
-        defaults[:open].should be_true
+        expect(defaults[:open]).to be_truthy
       end
 
       it "enables Flay" do
-        defaults[:flay].should be_true
+        expect(defaults[:flay]).to be_truthy
       end
 
       it "enables Reek" do
-        defaults[:reek].should be_true
+        expect(defaults[:reek]).to be_truthy
       end
 
       it "enables Hotspots" do
-        defaults[:hotspots].should be_true
+        expect(defaults[:hotspots]).to be_truthy
       end
 
       it "enables Churn" do
-        defaults[:churn].should be_true
+        expect(defaults[:churn]).to be_truthy
       end
 
       it "enables Saikuro" do
-        defaults[:saikuro].should be_true
+        expect(defaults[:saikuro]).to be_truthy
       end
 
       if MetricFu.configuration.mri?
         it "enables Flog" do
-          !defaults[:flog].should be_true
+          !expect(defaults[:flog]).to be_truthy
         end
 
         it "enables Cane" do
-          defaults[:cane].should be_true
+          expect(defaults[:cane]).to be_truthy
         end
       end
 
       it "enables RCov" do
-        defaults[:rcov].should be_true
+        expect(defaults[:rcov]).to be_truthy
       end
 
       it "runs by default" do
-        defaults[:run].should be_true
+        expect(defaults[:run]).to be_truthy
       end
     end
 
     if MetricFu.configuration.mri?
 
         it "enables Rails Best Practices" do
-          defaults[:rails_best_practices].should be_true
+          expect(defaults[:rails_best_practices]).to be_truthy
         end
 
     end
@@ -71,99 +71,99 @@ describe MetricFu::Cli::Helper do
     let(:helper)  { MetricFu::Cli::Helper.new }
 
     it "turns open in browser off" do
-      helper.process_options(["--no-open"])[:open].should be_false
+      expect(helper.process_options(["--no-open"])[:open]).to be_falsey
     end
 
     it "turns open in browser on" do
-      helper.process_options(["--open"])[:open].should be_true
+      expect(helper.process_options(["--open"])[:open]).to be_truthy
     end
 
     it "turns saikuro off" do
-      helper.process_options(["--no-saikuro"])[:saikuro].should be_false
+      expect(helper.process_options(["--no-saikuro"])[:saikuro]).to be_falsey
     end
 
     it "turns saikuro on" do
-      helper.process_options(["--saikuro"])[:saikuro].should be_true
+      expect(helper.process_options(["--saikuro"])[:saikuro]).to be_truthy
     end
 
     it "turns churn off" do
-      helper.process_options(["--no-churn"])[:churn].should be_false
+      expect(helper.process_options(["--no-churn"])[:churn]).to be_falsey
     end
 
     it "turns churn on" do
-      helper.process_options(["--churn"])[:churn].should be_true
+      expect(helper.process_options(["--churn"])[:churn]).to be_truthy
     end
 
     it "turns flay off" do
-      helper.process_options(["--no-flay"])[:flay].should be_false
+      expect(helper.process_options(["--no-flay"])[:flay]).to be_falsey
     end
 
     it "turns flay on" do
-      helper.process_options(["--flay"])[:flay].should be_true
+      expect(helper.process_options(["--flay"])[:flay]).to be_truthy
     end
 
     if MetricFu.configuration.mri?
 
       it "turns flog off" do
-        helper.process_options(["--no-flog"])[:flog].should be_false
+        expect(helper.process_options(["--no-flog"])[:flog]).to be_falsey
       end
 
       it "turns flog on" do
-        helper.process_options(["--flog"])[:flog].should be_true
+        expect(helper.process_options(["--flog"])[:flog]).to be_truthy
       end
 
       it "turns cane off" do
-        helper.process_options(["--no-cane"])[:cane].should be_false
+        expect(helper.process_options(["--no-cane"])[:cane]).to be_falsey
       end
 
       it "turns cane on" do
-        helper.process_options(["--cane"])[:cane].should be_true
+        expect(helper.process_options(["--cane"])[:cane]).to be_truthy
       end
 
     end
 
 
     it "turns hotspots off" do
-      helper.process_options(["--no-hotspots"])[:hotspots].should be_false
+      expect(helper.process_options(["--no-hotspots"])[:hotspots]).to be_falsey
     end
 
     it "turns hotspots on" do
-      helper.process_options(["--hotspots"])[:hotspots].should be_true
+      expect(helper.process_options(["--hotspots"])[:hotspots]).to be_truthy
     end
 
     it "turns rcov off" do
-      helper.process_options(["--no-rcov"])[:rcov].should be_false
+      expect(helper.process_options(["--no-rcov"])[:rcov]).to be_falsey
     end
 
     it "turns rcov on" do
-      helper.process_options(["--rcov"])[:rcov].should be_true
+      expect(helper.process_options(["--rcov"])[:rcov]).to be_truthy
     end
 
     it "turns reek off" do
-      helper.process_options(["--no-reek"])[:reek].should be_false
+      expect(helper.process_options(["--no-reek"])[:reek]).to be_falsey
     end
 
     it "turns reek on" do
-      helper.process_options(["--reek"])[:reek].should be_true
+      expect(helper.process_options(["--reek"])[:reek]).to be_truthy
     end
 
     it "turns roodi off" do
-      helper.process_options(["--no-roodi"])[:roodi].should be_false
+      expect(helper.process_options(["--no-roodi"])[:roodi]).to be_falsey
     end
 
     it "turns roodi on" do
-      helper.process_options(["--roodi"])[:roodi].should be_true
+      expect(helper.process_options(["--roodi"])[:roodi]).to be_truthy
     end
 
     context 'given a single format' do
       it "sets the format" do
-        helper.process_options(["--format", "json"])[:format].should eq([['json']])
+        expect(helper.process_options(["--format", "json"])[:format]).to eq([['json']])
       end
     end
 
     context 'given multiple formats' do
       it "sets multiple formats" do
-        helper.process_options(["--format", "json", "--format", "yaml"])[:format].should eq([['json'], ['yaml']])
+        expect(helper.process_options(["--format", "json", "--format", "yaml"])[:format]).to eq([['json'], ['yaml']])
       end
     end
 

data/spec/metric_fu/configuration_spec.rb

@@ -10,7 +10,7 @@ describe MetricFu::Configuration do
       rcov.enabled = true
     end
     MetricFu.configure
-    MetricFu::Io::FileSystem.stub(:create_directories) # no need to create directories for the tests
+    allow(MetricFu::Io::FileSystem).to receive(:create_directories) # no need to create directories for the tests
     @config
   end
 
@@ -55,7 +55,7 @@ describe MetricFu::Configuration do
       end
 
       it 'should return true'  do
-        @config.is_cruise_control_rb?.should be_true
+        expect(@config.is_cruise_control_rb?).to be_truthy
       end
 
       after(:each)  do
@@ -69,7 +69,7 @@ describe MetricFu::Configuration do
       before(:each) { ENV['CC_BUILD_ARTIFACTS'] = nil }
 
       it 'should return false' do
-        @config.is_cruise_control_rb?.should be_false
+        expect(@config.is_cruise_control_rb?).to be_falsey
       end
     end
   end
@@ -100,7 +100,7 @@ describe MetricFu::Configuration do
         get_new_config
       end
       it 'should return "tmp/metric_fu"' do
-        base_directory.should == MetricFu.artifact_dir
+        expect(base_directory).to eq(MetricFu.artifact_dir)
       end
 
       it 'should set @metric_fu_root_directory to the base of the '+
@@ -108,7 +108,7 @@ describe MetricFu::Configuration 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
+        expect(metric_fu_absolute_path).to eq(app_root_absolute_path)
       end
 
       it 'should set @template_directory to the lib/templates relative '+
@@ -117,23 +117,23 @@ describe MetricFu::Configuration do
                                  '..', '..', '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
+        expect(calc_template_dir_abs_path).to eq(template_dir_abs_path)
       end
 
       it 'should set @scratch_directory to scratch relative '+
       'to @base_directory' do
         scratch_dir = MetricFu.scratch_dir
-        scratch_directory.should == scratch_dir
+        expect(scratch_directory).to eq(scratch_dir)
       end
 
       it 'should set @output_directory to output relative '+
       'to @base_directory' do
         output_dir = MetricFu.output_dir
-        output_directory.should == output_dir
+        expect(output_directory).to eq(output_dir)
       end
 
       it 'should set @template_class to AwesomeTemplate by default' do
-        template_class.should == AwesomeTemplate
+        expect(template_class).to eq(AwesomeTemplate)
       end
 
       describe 'when a templates configuration is given' do
@@ -158,11 +158,11 @@ describe MetricFu::Configuration do
         end
 
         it 'should set given darwin_txmt_protocol_no_thanks' do
-          expect(MetricFu::Formatter::Templates.option('darwin_txmt_protocol_no_thanks')).to be_false
+          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_false
+          expect(MetricFu::Formatter::Templates.option('syntax_highlighting')).to be_falsey
         end
 
       end
@@ -192,7 +192,7 @@ describe MetricFu::Configuration do
       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}
+                { :start_date => %q("1 year ago"), :minimum_churn_count => 10, :ignore_files=>[], :data_directory=> MetricFu::Io::FileSystem.scratch_directory('churn')}
         )
       end
 
@@ -277,7 +277,7 @@ describe MetricFu::Configuration do
 
       before(:each) do
         @config = MetricFu.configuration
-        @config.stub(:rails?).and_return(true)
+        allow(@config).to receive(:rails?).and_return(true)
         @config.reset
         MetricFu.configure
         %w(rails_best_practices).each do |metric|
@@ -287,7 +287,7 @@ describe MetricFu::Configuration do
 
       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_true
+          expect(MetricFu::Metric.get_metric(:rails_best_practices).has_graph?).to be_truthy
         end
       end
 
@@ -300,14 +300,14 @@ describe MetricFu::Configuration do
     describe 'if #rails? is false ' do
       before(:each) do
         get_new_config
-        @config.stub(:rails?).and_return(false)
+        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
-        directory('code_dirs').should == ['lib']
+        expect(directory('code_dirs')).to eq(['lib'])
       end
     end
   end
@@ -318,7 +318,7 @@ describe MetricFu::Configuration do
 
     it 'should return the value of the PLATFORM constant' do
       this_platform = RUBY_PLATFORM
-      @config.platform.should == this_platform
+      expect(@config.platform).to eq(this_platform)
     end
   end
 
@@ -331,7 +331,7 @@ describe MetricFu::Configuration do
       end
 
       it 'adds to the list of formatters' do
-        @config.formatters.first.should be_an_instance_of(MetricFu::Formatter::HTML)
+        expect(@config.formatters.first).to be_an_instance_of(MetricFu::Formatter::HTML)
       end
     end
 
@@ -342,7 +342,7 @@ describe MetricFu::Configuration do
       end
 
       it 'adds to the list of formatters' do
-        @config.formatters.first.should be_an_instance_of(MyCustomFormatter)
+        expect(@config.formatters.first).to be_an_instance_of(MyCustomFormatter)
       end
     end
 
@@ -355,7 +355,7 @@ describe MetricFu::Configuration do
       end
 
       it 'adds each to the list of formatters' do
-        @config.formatters.count.should eq(3)
+        expect(@config.formatters.count).to eq(3)
       end
     end
   end

data/spec/metric_fu/data_structures/line_numbers_spec.rb

@@ -1,4 +1,5 @@
 require "spec_helper"
+MetricFu.data_structures_require { 'line_numbers' }
 
 describe MetricFu::LineNumbers do
   FIXTURE_DATA = ->(paths) {
@@ -7,55 +8,55 @@ describe MetricFu::LineNumbers do
   describe "in_method?" do
     it "should know if a line is NOT in a method" do
       ln = MetricFu::LineNumbers.new(FIXTURE_DATA["foo.rb"])
-      ln.in_method?(2).should == false
+      expect(ln.in_method?(2)).to eq(false)
     end
 
     it "should know if a line is in an instance method" do
       ln = MetricFu::LineNumbers.new(FIXTURE_DATA["foo.rb"])
-      ln.in_method?(8).should == true
+      expect(ln.in_method?(8)).to eq(true)
     end
 
     it "should know if a line is in an class method" do
       ln = MetricFu::LineNumbers.new(FIXTURE_DATA["foo.rb"])
-      ln.in_method?(3).should == true
+      expect(ln.in_method?(3)).to eq(true)
     end
   end
 
   describe "method_at_line" do
     it "should know the name of an instance method at a particular line" do
       ln = MetricFu::LineNumbers.new(FIXTURE_DATA["foo.rb"])
-      ln.method_at_line(8).should == "Foo#what"
+      expect(ln.method_at_line(8)).to eq("Foo#what")
     end
 
     it "should know the name of a class method at a particular line" do
       ln = MetricFu::LineNumbers.new(FIXTURE_DATA["foo.rb"])
-      ln.method_at_line(3).should == "Foo::awesome"
+      expect(ln.method_at_line(3)).to eq("Foo::awesome")
     end
 
     it "should know the name of a private method at a particular line" do
       ln = MetricFu::LineNumbers.new(FIXTURE_DATA["foo.rb"])
-      ln.method_at_line(28).should == "Foo#whoop"
+      expect(ln.method_at_line(28)).to eq("Foo#whoop")
     end
 
     it "should know the name of a class method defined in a 'class << self block at a particular line" do
       ln = MetricFu::LineNumbers.new(FIXTURE_DATA["foo.rb"])
-      ln.method_at_line(22).should == "Foo::neat"
+      expect(ln.method_at_line(22)).to eq("Foo::neat")
     end
 
     it "should know the name of an instance method at a particular line in a file with two classes" do
       ln = MetricFu::LineNumbers.new(FIXTURE_DATA["two_classes.rb"])
-      ln.method_at_line(3).should == "Foo#stuff"
-      ln.method_at_line(9).should == "Bar#stuff"
+      expect(ln.method_at_line(3)).to eq("Foo#stuff")
+      expect(ln.method_at_line(9)).to eq("Bar#stuff")
     end
 
     it "should work with modules" do
       ln = MetricFu::LineNumbers.new(FIXTURE_DATA["module.rb"])
-      ln.method_at_line(4).should == 'KickAss#get_beat_up?'
+      expect(ln.method_at_line(4)).to eq('KickAss#get_beat_up?')
     end
 
     it "should work with module surrounding class" do
       ln = MetricFu::LineNumbers.new(FIXTURE_DATA["module_surrounds_class.rb"])
-      ln.method_at_line(5).should == "StuffModule::ThingClass#do_it"
+      expect(ln.method_at_line(5)).to eq("StuffModule::ThingClass#do_it")
       # ln.method_at_line(12).should == "StuffModule#blah" #why no work?
     end