metric_fu 4.11.3 → 4.11.4

data/lib/metric_fu/templates/report.rb

@@ -1,13 +1,11 @@
-MetricFu.lib_require { 'formatter/syntax' }
-MetricFu.lib_require { 'templates/template' }
-
+MetricFu.lib_require { "formatter/syntax" }
+MetricFu.lib_require { "templates/template" }
 
 # Creates an HTML document for a given analyzed file,
 # with scored metrics annotating the relevant line.
 module MetricFu
   module Templates
     class Report < MetricFu::Template
-
       # @param file [String] the analyzed file to annotate
       # @param lines [Hash] of line number [String] keyed to an list [[Array] of metrics for that line. Each metric in the list is a hash containing the keys :type => metric_name, :descrption => metric_score
       # @example file and lines
@@ -16,11 +14,11 @@ module MetricFu
       def initialize(file, lines)
         @file = file
         @lines = lines
-        @data = File.open(file, 'rb') {|f| f.readlines }
+        @data = File.open(file, "rb") { |f| f.readlines }
       end
 
       def render
-        erbify('report')
+        erbify("report")
       end
 
       def convert_ruby_to_html(ruby_text, line_number)
@@ -28,7 +26,7 @@ module MetricFu
       end
 
       def line_for_display(line, line_number)
-        if MetricFu::Formatter::Templates.option('syntax_highlighting')
+        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}"
@@ -38,7 +36,6 @@ module MetricFu
       def template_directory
         File.dirname(__FILE__)
       end
-
     end
   end
 end

data/lib/metric_fu/templates/template.rb

@@ -1,11 +1,10 @@
-require 'erb'
+require "erb"
 module MetricFu
-
   class Template
     attr_accessor :output_directory
 
     def output_directory
-      @output_directory || MetricFu::Io::FileSystem.directory('output_directory')
+      @output_directory || MetricFu::Io::FileSystem.directory("output_directory")
     end
 
     # Renders a partial and add optional instance variables to the template
@@ -18,6 +17,7 @@ module MetricFu
     end
 
     private
+
     # Creates a new erb evaluated result from the passed in section.
     #
     # @param section String
@@ -82,7 +82,7 @@ module MetricFu
     end
 
     def metric_template_path(metric)
-      File.join(MetricFu.metrics_dir, metric, 'report.html.erb')
+      File.join(MetricFu.metrics_dir, metric, "report.html.erb")
     end
 
     # Determines whether a template file exists for a given section
@@ -118,7 +118,7 @@ module MetricFu
     # @return String
     #   The contents of the css file
     def inline_css(css)
-      css_file = File.join(MetricFu.lib_dir,'templates', css)
+      css_file = File.join(MetricFu.lib_dir, "templates", css)
       MetricFu::Utility.binread(css_file)
     end
 
@@ -140,11 +140,11 @@ module MetricFu
     end
 
     def round_to_tenths(decimal)
-      decimal = 0.0 if decimal.to_s.eql?('NaN')
+      decimal = 0.0 if decimal.to_s.eql?("NaN")
       (decimal * 10).round / 10.0
     end
 
-    def link_content(name, line=nil, link_content=nil) # :nodoc:
+    def link_content(name, line = nil, link_content = nil) # :nodoc:
       if link_content
         link_content
       elsif line
@@ -155,49 +155,45 @@ module MetricFu
     end
 
     def display_location(location)
-      class_name, method_name = location.fetch('class_name'), location.fetch('method_name')
+      class_name, method_name = location.fetch("class_name"), location.fetch("method_name")
       str = ""
-      str += link_to_filename(location.fetch('file_name'), location.fetch('line_number'))
+      str += link_to_filename(location.fetch("file_name"), location.fetch("line_number"))
       str += " : " if method_name || class_name
-      if(method_name)
+      if method_name
         str += "#{method_name}"
       else
-        #TODO HOTSPOTS BUG ONLY exists on move over to metric_fu
+        # TODO HOTSPOTS BUG ONLY exists on move over to metric_fu
         if class_name.is_a?(String)
-          str+= "#{class_name}"
+          str += "#{class_name}"
         end
       end
       str
     end
 
     def file_url(name, line) # :nodoc:
-      return '' unless name
+      return "" unless name
       filename = complete_file_path(name)
 
       if render_as_txmt_protocol?
         "txmt://open/?url=file://#{filename}" << (line ? "&line=#{line}" : "")
       else
-        link_prefix = MetricFu.configuration.templates_option('link_prefix')
+        link_prefix = MetricFu.configuration.templates_option("link_prefix")
         if link_prefix == MetricFu::Templates::Configuration::FILE_PREFIX
           path = filename
         else
-          path = name.gsub(/:.*$/, '')
+          path = name.gsub(/:.*$/, "")
         end
         "#{link_prefix}/#{path}"
       end
     end
 
     def complete_file_path(filename)
-      File.expand_path(remove_leading_slash(filename))
-    end
-
-    def remove_leading_slash(filename)
-      filename.gsub(/^\//, '')
+      File.expand_path(filename)
     end
 
     def render_as_txmt_protocol? # :nodoc:
       if MetricFu.configuration.osx?
-        !MetricFu.configuration.templates_option('darwin_txmt_protocol_no_thanks')
+        !MetricFu.configuration.templates_option("darwin_txmt_protocol_no_thanks")
       else
         false
       end
@@ -219,14 +215,14 @@ module MetricFu
     #   iteration is odd.
     def cycle(first_value, second_value, iteration)
       return first_value if iteration % 2 == 0
-      return second_value
+      second_value
     end
 
     # available in the erb template
     # as it's processed in the context of
     # the binding of this class
     def metric_links
-      @metrics.keys.map {|metric| metric_link(metric.to_s) }
+      @metrics.keys.map { |metric| metric_link(metric.to_s) }
     end
 
     def metric_link(metric)
@@ -238,7 +234,7 @@ module MetricFu
     end
 
     def snake_case_to_title_case(string)
-      string.split('_').collect{|word| word[0] = word[0..0].upcase; word}.join(" ")
+      string.split("_").collect { |word| word[0] = word[0..0].upcase; word }.join(" ")
     end
 
     def template_directory

data/lib/metric_fu/utility.rb

@@ -1,5 +1,5 @@
-require 'yaml'
-require 'fileutils'
+require "yaml"
+require "fileutils"
 module MetricFu
   module Utility
     module_function
@@ -10,17 +10,17 @@ module MetricFu
     def clean_ascii_text(text)
       if text.respond_to?(:encode)
         # avoids invalid multi-byte escape error
-        ascii_text = text.encode( 'ASCII', invalid: :replace, undef: :replace, replace: '' )
+        ascii_text = text.encode("ASCII", invalid: :replace, undef: :replace, replace: "")
         # see http://www.ruby-forum.com/topic/183413
-        pattern = Regexp.new('[\x80-\xff]', nil, 'n')
-        ascii_text.gsub(pattern, '')
+        pattern = Regexp.new('[\x80-\xff]', nil, "n")
+        ascii_text.gsub(pattern, "")
       else
         text
       end
     end
 
     def strip_escape_codes(text)
-      text.gsub(ESCAPE_CODES_PATTERN, '')
+      text.gsub(ESCAPE_CODES_PATTERN, "")
     end
 
     def rm_rf(*args)
@@ -45,7 +45,7 @@ module MetricFu
 
     # From episode 029 of Ruby Tapas by Avdi
     # https://rubytapas.dpdcart.com/subscriber/post?id=88
-    def capture_output(stream=STDOUT, &block)
+    def capture_output(stream = STDOUT, &_block)
       old_stdout = stream.clone
       pipe_r, pipe_w = IO.pipe
       pipe_r.sync    = true
@@ -67,6 +67,5 @@ module MetricFu
       pipe_r.close
       return output
     end
-
   end
 end

data/lib/metric_fu/version.rb

@@ -1,3 +1,3 @@
 module MetricFu
-  VERSION = '4.11.3'
+  VERSION = "4.11.4"
 end

data/metric_fu.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require 'metric_fu/version'
+require "metric_fu/version"
 
 Gem::Specification.new do |s|
   s.name        = "metric_fu"
@@ -8,33 +8,33 @@ Gem::Specification.new do |s|
   s.summary     = "A fistful of code metrics, with awesome templates and graphs"
   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, :encoding => Encoding::UTF_8).map(&:strip)
+  author_file   = File.expand_path("AUTHORS", File.dirname(__FILE__))
+  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.cert_chain  = ["certs/bf4.pem"]
   # 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')
+  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'
+  s.rubyforge_project           = "metric_fu"
+  s.license                     = "MIT"
   s.platform                    = Gem::Platform::RUBY
   s.version                     = MetricFu::VERSION
   s.required_ruby_version       = ">= 1.9.0"
   s.required_rubygems_version   = ">= 1.3.6"
 
-    tracked_files = `git ls-files`.split($\)
-    excluded_dirs = %r{\Aetc}
-    files         = tracked_files.reject{|file| file[excluded_dirs] }
-    test_files    = files.grep(%r{^(test|spec|features)/})
-    executables   = files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  tracked_files = `git ls-files`.split($\)
+  excluded_dirs = %r{\Aetc}
+  files         = tracked_files.reject { |file| file[excluded_dirs] }
+  test_files    = files.grep(%r{^(test|spec|features)/})
+  executables   = files.grep(%r{^bin/}).map { |f| File.basename(f) }
   s.files                       = files
   s.test_files                  = test_files
   s.executables                 = executables
-  s.default_executable          = %q{metric_fu}
+  s.default_executable          = "metric_fu"
   s.require_paths               = ["lib"]
 
   s.has_rdoc                    = true
@@ -42,31 +42,30 @@ Gem::Specification.new do |s|
   s.rdoc_options                = ["--main", "README.md"]
 
   # metric dependencies
-  s.add_runtime_dependency 'flay',                  ['>= 2.0.1',  '~> 2.1']
-  s.add_runtime_dependency 'churn',                 ['~> 0.0.35']
-  s.add_runtime_dependency 'flog',                  ['>= 4.1.1',  '~> 4.1']
-  s.add_runtime_dependency 'reek',                  ['>= 1.3.4',  '~> 1.3']
-  s.add_runtime_dependency 'cane',                  ['>= 2.5.2',  '~> 2.5']
-  s.add_runtime_dependency 'rails_best_practices',  ['>= 1.14.3', '~> 1.14']
-  s.add_runtime_dependency 'metric_fu-Saikuro',     ['>= 1.1.3',  '~> 1.1']
-  s.add_runtime_dependency 'roodi',                 ['~> 3.1']
-  s.add_runtime_dependency 'code_metrics',          ['~> 0.1']
+  s.add_runtime_dependency "flay",                  [">= 2.0.1",  "~> 2.1"]
+  s.add_runtime_dependency "churn",                 ["~> 0.0.35"]
+  s.add_runtime_dependency "flog",                  [">= 4.1.1",  "~> 4.1"]
+  s.add_runtime_dependency "reek",                  [">= 1.3.4",  "~> 1.3"]
+  s.add_runtime_dependency "cane",                  [">= 2.5.2",  "~> 2.5"]
+  s.add_runtime_dependency "rails_best_practices",  [">= 1.14.3", "~> 1.14"]
+  s.add_runtime_dependency "metric_fu-Saikuro",     [">= 1.1.3",  "~> 1.1"]
+  s.add_runtime_dependency "roodi",                 ["~> 3.1"]
+  s.add_runtime_dependency "code_metrics",          ["~> 0.1"]
 
   # other dependencies
   # ruby version identification
-  s.add_runtime_dependency 'redcard'
+  s.add_runtime_dependency "redcard"
   # syntax highlighting
-  s.add_runtime_dependency 'coderay'
+  s.add_runtime_dependency "coderay"
   # to_json support
-  s.add_runtime_dependency 'multi_json'
+  s.add_runtime_dependency "multi_json"
   # open browser support
-  s.add_runtime_dependency 'launchy', '~> 2.0'
+  s.add_runtime_dependency "launchy", "~> 2.0"
 
-  s.add_development_dependency   'rspec', '~> 3.1'
+  s.add_development_dependency "rspec", "~> 3.1"
   # temporary filesystem to act on
-  s.add_development_dependency   'test_construct'
+  s.add_development_dependency "test_construct"
   # ensure we have a JSON parser
-  s.add_development_dependency   'json'
-  s.add_development_dependency   'simplecov', '~> 0.9'
-
+  s.add_development_dependency "json"
+  s.add_development_dependency "simplecov", "~> 0.9"
 end

data/spec/cli/helper_spec.rb

@@ -1,19 +1,16 @@
-require 'spec_helper'
-require 'metric_fu/cli/helper'
+require "spec_helper"
+require "metric_fu/cli/helper"
 MetricFu.configuration.configure_metric(:rcov) do |rcov|
   rcov.enabled = true
 end
 MetricFu.configure
 
 describe MetricFu::Cli::Helper do
-
   describe "defaults" do
-
     let(:helper)  { MetricFu::Cli::Helper.new }
     let(:defaults) { helper.process_options }
 
     context "on every Ruby version" do
-
       it "opens the report in a browser" do
         expect(defaults[:open]).to be_truthy
       end
@@ -59,12 +56,11 @@ describe MetricFu::Cli::Helper do
 
     if MetricFu.configuration.mri?
 
-        it "enables Rails Best Practices" do
-          expect(defaults[:rails_best_practices]).to be_truthy
-        end
+      it "enables Rails Best Practices" do
+        expect(defaults[:rails_best_practices]).to be_truthy
+      end
 
     end
-
   end
 
   describe ".parse" do
@@ -122,7 +118,6 @@ describe MetricFu::Cli::Helper do
 
     end
 
-
     it "turns hotspots off" do
       expect(helper.process_options(["--no-hotspots"])[:hotspots]).to be_falsey
     end
@@ -157,16 +152,14 @@ describe MetricFu::Cli::Helper do
 
     context "given a single format" do
       it "sets the format" do
-        expect(helper.process_options(["--format", "json"])[:format]).to eq([['json']])
+        expect(helper.process_options(["--format", "json"])[:format]).to eq([["json"]])
       end
     end
 
     context "given multiple formats" do
       it "sets multiple formats" do
-        expect(helper.process_options(["--format", "json", "--format", "yaml"])[:format]).to eq([['json'], ['yaml']])
+        expect(helper.process_options(["--format", "json", "--format", "yaml"])[:format]).to eq([["json"], ["yaml"]])
       end
     end
-
   end
-
 end

data/spec/dummy/lib/bad_encoding.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 class SomeClass
-  def initialize(a,b,c)
+  def initialize(_a, _b, _c)
     "hey, invalid ASCII\xED"
   end
 end

data/spec/fixtures/coverage-153.rb

@@ -3,9 +3,9 @@ class A
   def m(arg1)
     p "this is my method" # Assume that none of the line covered in this method
     if arg1 > 5
-        p 'more than 5'
+      p "more than 5"
     else
-       p 'not more than 5'
+      p "not more than 5"
     end
   end
 end

data/spec/fixtures/coverage.rb

@@ -1,9 +1,9 @@
 class SomeClass
   def method_1
-    1+1
+    1 + 1
   end
 
-  def method_2 ( value )
+  def method_2(value)
     value * value
   end
 

data/spec/metric_fu/calculate_spec.rb

@@ -1,5 +1,5 @@
-require 'spec_helper'
-MetricFu.lib_require { 'calculate' }
+require "spec_helper"
+MetricFu.lib_require { "calculate" }
 
 describe MetricFu::Calculate do
   describe "returns a percent rounded to the nearest integer" do
@@ -15,7 +15,7 @@ describe MetricFu::Calculate do
       }.to raise_error(ArgumentError)
     end
     it "returns 0 when the denominator is 0" do
-      expect(MetricFu::Calculate.integer_percent(3,0)).to eq(0)
+      expect(MetricFu::Calculate.integer_percent(3, 0)).to eq(0)
     end
   end
 end