metric_fu 4.5.2 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46897614ca929038813939aee14aa38e21431508
-  data.tar.gz: cc2c7c8b8e2f56cd7c21f1d9c48075de60ec1697
+  metadata.gz: d03acf0e261d588a802cd44d3f777942d397844b
+  data.tar.gz: 8cb84875a028571b062d807aa91a3f53a2ba2097
 SHA512:
-  metadata.gz: 7da5faf38132acc88c0f438c7a5c280f2c6329667e2d94e91480b9a5990f3fc2a1dac4900769c8ef095a6c74af02271f765aec63401ecb77576724a90aba2706
-  data.tar.gz: 999e1ca52251e8c5398348969b8c6dae0334cb3f432e9cc0225ac17b8c367c1384aa992b090d75e5c85d125b4c2faf579b8dab5dd43d60d8d060e175c84ff1e0
+  metadata.gz: cb45ff86efe04d805e5cd6f5effda3ea34efe76209146b9806a1de16ff2a52132da389c31d3302c2e042dc77f8693ea3a09d2bed3a1a1c47aaa805a9260888d0
+  data.tar.gz: 4fb34d3006988447c3b3568980296f236622a3cee744b72f2843bf31aed81e17b21ded0ec7b6f8293cc112df1a6393b347f7461c76d96beff6a8b2dc34cb337b

data/HISTORY.md

@@ -10,6 +10,15 @@ As such, a _Feature_ would map to either major or minor. A _bug fix_ to a patch.
 * Fixes
 * Misc
 
+### MetricFu [4.6.0 / 2013-11-20](https://github.com/metricfu/metric_fu/compare/v4.5.2...v4.6.0)
+
+* Features
+  * Allow configuration of the generation template, eg link_prefix (Adrien Montfort, #171)
+* Fixes
+  * Return 0% coverage when the file has no lines. (Chirag Viradiya #152, Benjamin Fleischer, Michael Foley)
+  * Return stats code to test ratio of 0.0 when NaN (Benjamin Fleischer, reported by Greg Allen)
+* Misc
+
 ### MetricFu [4.5.2 / 2013-11-07](https://github.com/metricfu/metric_fu/compare/v4.4.4...v4.5.2)
 
 * Misc

data/README.md

@@ -208,3 +208,7 @@ This is the official repository for metric_fu.  The original repository by Jake
 * Historical Homepage: http://metric-fu.rubyforge.org/
 * Jake's Blog: http://jakescruggs.blogspot.com/
 * Jake's Post about stepping down: http://jakescruggs.blogspot.com/2012/08/why-i-abandoned-metricfu.html
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/metricfu/metric_fu/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/checksum/metric_fu-4.5.2.gem.sha512

@@ -0,0 +1 @@
+cecb4dabfef6d7f955f394a9af5a8755cae4269196dfe6f4447f0d465426a8c4bb777572d3dc8404de352c0e64dd74562b6b8e65687ca79bdd247d3fbafe6e69

data/gem_tasks/build.rake

@@ -2,6 +2,7 @@
 require 'rubygems'
 require 'digest/sha2'
 
+# Based on https://github.com/bundler/bundler/blob/ec0621d/lib/bundler/gem_helpers.rb
 GEM_TASKS = Class.new(Rake::TaskLib) do
   include Rake::DSL if defined? Rake::DSL
   attr_reader :base
@@ -53,7 +54,7 @@ GEM_TASKS = Class.new(Rake::TaskLib) do
     raise "Couldn't install gem, run `gem install #{built_gem_path}' for more detailed output" unless out[/Successfully installed/]
     STDOUT.puts "#{name} (#{version}) installed."
   end
-
+  # Based on https://github.com/YorickPeterse/ruby-lint/blob/3e946/task/checksum.rake
   def add_checksum(built_gem_path=nil)
     guard_clean
     built_gem_path ||= build_gem
@@ -184,6 +185,7 @@ GEM_TASKS = Class.new(Rake::TaskLib) do
 
 end.new.install
 
+# Based on https://github.com/YorickPeterse/ruby-lint/blob/3e946e6/task/todo.rake
 desc 'Extracts TODO tags and the likes'
 task :todo do
   regex = %w{NOTE: FIXME: TODO: THINK: @todo}.join('|')

data/lib/metric_fu/calculate.rb

@@ -0,0 +1,11 @@
+module MetricFu
+  module Calculate
+    module_function
+
+    def integer_percent(num, total)
+      return 0 if total.zero?
+      (Float(num) / Float(total) * 100).round
+    end
+
+  end
+end

data/lib/metric_fu/configuration.rb

@@ -56,6 +56,8 @@ module MetricFu
     require_relative 'environment'
     require_relative 'io'
     require_relative 'formatter'
+    require_relative 'templates/configuration'
+
     # TODO: Remove need to include the module
     include MetricFu::Environment
 
@@ -75,7 +77,8 @@ module MetricFu
       #   template/filesystem/metric/graph/environment, etc settings
       #   from the configuration instance
       MetricFu::Io::FileSystem.set_directories
-      MetricFu::Formatter::Templates.configure_template(self)
+      @templates_configuration = MetricFu::Templates::Configuration.new
+      MetricFu::Formatter::Templates.templates_configuration = @templates_configuration
       @formatters = []
     end
 
@@ -135,5 +138,22 @@ module MetricFu
       :bluff
     end
 
+    # This allows us to configure the templates with:
+    #
+    #   MetricFu.run do |config|
+    #     config.templates_configuration do |templates_config|
+    #       templates_config.link_prefix = 'http:/'
+    #     end
+    #   end
+    def templates_configuration
+      yield @templates_configuration
+    end
+
+    # @param option [String, Symbol] the requested template option
+    # @return [String] the configured template option
+    def templates_option(option)
+      @templates_configuration.option(option)
+    end
+
   end
 end

data/lib/metric_fu/formatter.rb

@@ -25,21 +25,16 @@ module MetricFu
 
       module_function
 
-      def options
-        @options ||= {}
+      def templates_configuration=(templates_configuration)
+        @templates_configuration = templates_configuration
       end
+
       def option(name)
-        options.fetch(name) { raise "No such template option: #{name}" }
+        templates_configuration.option(name)
       end
 
-      # TODO: Remove config argument
-      def configure_template(config)
-        @options = {}
-        @options['template_class'] = AwesomeTemplate
-        @options['link_prefix'] = nil
-        @options['darwin_txmt_protocol_no_thanks'] = true
-        # # turning off syntax_highlighting may avoid some UTF-8 issues
-        @options['syntax_highlighting'] = true
+      def templates_configuration
+        @templates_configuration ||= MetricFu::Templates::Configuration.new
       end
 
     end

data/lib/metric_fu/metrics/base_template.rb

@@ -175,15 +175,17 @@ module MetricFu
     def file_url(name, line) # :nodoc:
       return '' unless name
       filename = complete_file_path(name)
-      link_prefix = MetricFu::Formatter::Templates.option('link_prefix')
-      if link_prefix
-        "#{link_prefix}/#{name.gsub(/:.*$/, '')}"
-      elsif render_as_txmt_protocol?
+
+      if render_as_txmt_protocol?
         "txmt://open/?url=file://#{filename}" << (line ? "&line=#{line}" : "")
-      # elsif render_as_mvim_protocol?
-      #   "mvim://open/?url=file://#{filename}" << (line ? "&line=#{line}" : "")
       else
-       "file://#{filename}"
+        link_prefix = MetricFu.configuration.templates_option('link_prefix')
+        if link_prefix == MetricFu::Templates::Configuration::FILE_PREFIX
+          path = filename
+        else
+          path = name.gsub(/:.*$/, '')
+        end
+        "#{link_prefix}/#{path}"
       end
     end
 
@@ -197,15 +199,7 @@ module MetricFu
 
     def render_as_txmt_protocol? # :nodoc:
       if MetricFu.configuration.osx?
-        !MetricFu::Formatter::Templates.option('darwin_txmt_protocol_no_thanks')
-      else
-        false
-      end
-    end
-
-    def render_as_mvim_protocol? # :nodoc:
-      if MetricFu.configuration.osx?
-        !MetricFu::Formatter::Templates.option('darwin_mvim_protocol_no_thanks')
+        !MetricFu.configuration.templates_option('darwin_txmt_protocol_no_thanks')
       else
         false
       end

data/lib/metric_fu/metrics/rcov/rcov.rb

@@ -1,4 +1,5 @@
 MetricFu.lib_require { 'utility' }
+MetricFu.lib_require { 'calculate' }
 
 module MetricFu
 
@@ -118,7 +119,8 @@ module MetricFu
       files.each_pair {|fname, content| files[fname] = content.split("\n") }
       files.each_pair do |fname, content|
         content.map! do |raw_line|
-          Line.new(raw_line[3..-1], !raw_line.match(/^!!/)).to_h
+          covered_line = raw_line.match(/^!!/).nil?
+          Line.new(raw_line[3..-1], covered_line).to_h
         end
         content.reject! {|line| line[:content].to_s == '' }
         files[fname] = {:lines => content}
@@ -126,13 +128,19 @@ module MetricFu
       files
     end
 
+    # TODO: remove multiple side effects
+    #   sets global ivars and
+    #   modifies the param passed in
     def add_coverage_percentage(files)
       files.each_pair do |fname, content|
         lines = content[:lines]
-        @global_total_lines_run += lines_run = lines.find_all {|line| line[:was_run] == true }.length
-        @global_total_lines += total_lines = lines.length
-        percent_run = ((lines_run.to_f / total_lines.to_f) * 100).round
-        files[fname][:percent_run] = percent_run
+        lines_run = lines.count {|line| line[:was_run] }
+        total_lines = lines.length
+        integer_percent = Calculate.integer_percent(lines_run, total_lines)
+
+        files[fname][:percent_run] = integer_percent
+        @global_total_lines_run += lines_run
+        @global_total_lines += total_lines
       end
     end
 

data/lib/metric_fu/metrics/stats/stats.rb

@@ -39,10 +39,16 @@ module MetricFu
 
     def set_global_stats(totals)
       return if totals.nil?
-      totals = totals.split("  ").find_all {|el| ! el.empty? }
-      @stats[:codeLOC] = totals[0].match(/\d.*/)[0].to_i
-      @stats[:testLOC] = totals[1].match(/\d.*/)[0].to_i
-      @stats[:code_to_test_ratio] = totals[2].match(/1\:(\d.*)/)[1].to_f
+      parsed_totals = totals.split("  ").find_all {|el| ! el.empty? }
+      @stats[:codeLOC] = parsed_totals.shift.match(/\d.*/)[0].to_i
+      @stats[:testLOC] = parsed_totals.shift.match(/\d.*/)[0].to_i
+      matched_numbers  = Array(parsed_totals.shift.match(/1\:(\d.*)/))
+      if matched_numbers.size == 2
+        @stats[:code_to_test_ratio] = matched_numbers[1].to_f
+      else
+        mf_log "Unexpected code to test ratio #{matched_numbers.inspect} over directories #{dirs.inspect}"
+        @stats[:code_to_test_ratio] = 0.0
+      end
     end
 
     def set_granular_stats(lines)

data/lib/metric_fu/templates/configuration.rb

@@ -0,0 +1,27 @@
+module MetricFu::Templates
+  class Configuration
+
+    FILE_PREFIX = 'file:/'
+
+    def initialize
+      @options = {}
+      @options[:template_class] = AwesomeTemplate
+      @options[:darwin_txmt_protocol_no_thanks] = true
+      # turning off syntax_highlighting may avoid some UTF-8 issues
+      @options[:syntax_highlighting] = true
+      @options[:link_prefix] = FILE_PREFIX
+    end
+
+    [:template_class, :link_prefix, :syntax_highlighting, :darwin_txmt_protocol_no_thanks].each do |option|
+      define_method("#{option}=") do |arg|
+        @options[option] = arg
+      end
+    end
+
+    def option(name)
+      @options.fetch(name.to_sym) { raise "No such template option: #{name}" }
+    end
+
+  end
+
+end

data/lib/metric_fu/version.rb

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

data/spec/metric_fu/calculate_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+MetricFu.lib_require { 'calculate' }
+
+describe MetricFu::Calculate do
+  describe "returns a percent rounded to the nearest integer" do
+    specify "3 / 10 == 30" do
+      expect(MetricFu::Calculate.integer_percent(3, 10)).to eq(30)
+    end
+    specify "3.0 / 10 == 30" do
+      expect(MetricFu::Calculate.integer_percent(3.0, 10)).to eq(30)
+    end
+    it "raises an ArgumentError on non-numeric input" do
+      expect {
+        MetricFu::Calculate.integer_percent("", 10)
+      }.to raise_error(ArgumentError)
+    end
+    it "returns 0 when the denominator is 0" do
+      expect(MetricFu::Calculate.integer_percent(3,0)).to eq(0)
+    end
+  end
+end

data/spec/metric_fu/configuration_spec.rb

@@ -132,10 +132,41 @@ describe MetricFu::Configuration do
         output_directory.should == output_dir
       end
 
-      it 'should set @template_class to AwesomeTemplate' do
+      it 'should set @template_class to AwesomeTemplate by default' do
         template_class.should == 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_false
+        end
+
+        it 'should set given syntax_highlighting' do
+          expect(MetricFu::Formatter::Templates.option('syntax_highlighting')).to be_false
+        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(

data/spec/metric_fu/metrics/base_template_spec.rb

@@ -90,8 +90,8 @@ describe MetricFu::Template do
         config = double("configuration")
         config.stub(:osx?).and_return(true)
         config.stub(:platform).and_return('universal-darwin-9.0')
-        MetricFu::Formatter::Templates.stub(:option).with('darwin_txmt_protocol_no_thanks').and_return(false)
-        MetricFu::Formatter::Templates.stub(:option).with('link_prefix').and_return(nil)
+        config.stub(:templates_option).with('darwin_txmt_protocol_no_thanks').and_return(false)
+        config.stub(:templates_option).with('link_prefix').and_return(nil)
         MetricFu.stub(:configuration).and_return(config)
       end
 
@@ -121,9 +121,8 @@ describe MetricFu::Template do
           config = double("configuration")
           config.stub(:osx?).and_return(true)
           config.stub(:platform).and_return('universal-darwin-9.0')
-          config.stub(:link_prefix).and_return(nil)
-          MetricFu::Formatter::Templates.stub(:option).with('darwin_txmt_protocol_no_thanks').and_return(true)
-          MetricFu::Formatter::Templates.stub(:option).with('link_prefix').and_return(nil)
+          config.stub(:templates_option).with('darwin_txmt_protocol_no_thanks').and_return(true)
+          config.stub(:templates_option).with('link_prefix').and_return('file:/')
           MetricFu.stub(:configuration).and_return(config)
           @template.should_receive(:complete_file_path).and_return('filename')
         end
@@ -149,7 +148,7 @@ describe MetricFu::Template do
       before(:each) do
         config = double("configuration")
         config.should_receive(:osx?).and_return(false)
-        MetricFu::Formatter::Templates.stub(:option).with('link_prefix').and_return(nil)
+        config.stub(:templates_option).with('link_prefix').and_return('file:/')
         MetricFu.stub(:configuration).and_return(config)
         @template.should_receive(:complete_file_path).and_return('filename')
       end
@@ -163,7 +162,9 @@ describe MetricFu::Template do
     describe "when configured with a link_prefix" do
       before(:each) do
         config = double("configuration")
-          MetricFu::Formatter::Templates.stub(:option).with('link_prefix').and_return('http://example.org/files')
+        config.stub(:templates_option).with('darwin_txmt_protocol_no_thanks').and_return(true)
+        config.stub(:templates_option).with('link_prefix').and_return('http://example.org/files')
+        config.stub(:osx?).and_return(true)
         MetricFu.stub(:configuration).and_return(config)
         @template.should_receive(:complete_file_path).and_return('filename')
       end

data/spec/metric_fu/metrics/stats/stats_spec.rb

@@ -61,6 +61,24 @@ describe StatsGenerator do
       model_data[:methods_per_class].should == 3
       model_data[:loc_per_method].should == 7
     end
+
+    it 'handles code to test ratio is ratio is 1:NaN' do
+      lines =  <<-HERE.gsub(/^\s*/, "")
+      +----------------------+-------+-------+---------+---------+-----+-------+
+      | Name                 | Lines |   LOC | Classes | Methods | M/C | LOC/M |
+      +----------------------+-------+-------+---------+---------+-----+-------+
+      +----------------------+-------+-------+---------+---------+-----+-------+
+        Code LOC: 0     Test LOC: 0     Code to Test Ratio: 1:NaN
+
+      HERE
+      ENV['CC_BUILD_ARTIFACTS'] = nil
+      MetricFu.configure.reset
+      File.stub(:directory?).and_return(true)
+      stats = MetricFu::StatsGenerator.new(MetricFu::Metric.get_metric(:stats).run_options)
+      stats.instance_variable_set('@output', lines)
+      @results = stats.analyze
+      expect(@results[:code_to_test_ratio]).to eq(0.0)
+    end
   end
 
   describe "to_h method" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metric_fu
 version: !ruby/object:Gem::Version
-  version: 4.5.2
+  version: 4.6.0
 platform: ruby
 authors:
 - Jake Scruggs
@@ -42,7 +42,7 @@ cert_chain:
   WONz9vT6h053kHZYMrd4Gs/NdaA4tJSxrhZlXdajAm/0vAOzLIqUHHQk3R0tf7aY
   d/w=
   -----END CERTIFICATE-----
-date: 2013-11-08 00:00:00.000000000 Z
+date: 2013-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flay
@@ -296,10 +296,12 @@ files:
 - checksum/metric_fu-4.4.4.gem.sha512
 - checksum/metric_fu-4.5.0.gem.sha512
 - checksum/metric_fu-4.5.1.gem.sha512
+- checksum/metric_fu-4.5.2.gem.sha512
 - config/roodi_config.yml
 - gem_tasks/build.rake
 - gemfiles/Gemfile.travis
 - lib/metric_fu.rb
+- lib/metric_fu/calculate.rb
 - lib/metric_fu/cli/client.rb
 - lib/metric_fu/cli/helper.rb
 - lib/metric_fu/cli/parser.rb
@@ -407,6 +409,7 @@ files:
 - lib/metric_fu/reporting/templates/javascripts/js-class.js
 - lib/metric_fu/run.rb
 - lib/metric_fu/tasks/metric_fu.rake
+- lib/metric_fu/templates/configuration.rb
 - lib/metric_fu/utility.rb
 - lib/metric_fu/version.rb
 - metric_fu.gemspec
@@ -435,6 +438,7 @@ files:
 - spec/fixtures/saikuro/app/controllers/users_controller.rb_cyclo.html
 - spec/fixtures/saikuro/index_cyclo.html
 - spec/fixtures/saikuro_sfiles/thing.rb_cyclo.html
+- spec/metric_fu/calculate_spec.rb
 - spec/metric_fu/configuration_spec.rb
 - spec/metric_fu/data_structures/line_numbers_spec.rb
 - spec/metric_fu/data_structures/location_spec.rb
@@ -537,6 +541,7 @@ test_files:
 - spec/fixtures/saikuro/app/controllers/users_controller.rb_cyclo.html
 - spec/fixtures/saikuro/index_cyclo.html
 - spec/fixtures/saikuro_sfiles/thing.rb_cyclo.html
+- spec/metric_fu/calculate_spec.rb
 - spec/metric_fu/configuration_spec.rb
 - spec/metric_fu/data_structures/line_numbers_spec.rb
 - spec/metric_fu/data_structures/location_spec.rb