metric_fu 4.3.1 → 4.4.0

data/lib/metric_fu/metrics/rails_best_practices/init.rb

@@ -1,7 +1,31 @@
-MetricFu::Configuration.run do |config|
-  if config.rails?
-    config.add_metric(:rails_best_practices)
-    config.add_graph(:rails_best_practices)
-    config.configure_metric(:rails_best_practices, {})
+module MetricFu
+  class MetricRailsBestPractices < Metric
+
+    def name
+      :rails_best_practices
+    end
+
+    def default_run_options
+      {}
+    end
+
+    def has_graph?
+      true
+    end
+
+    def enable
+      if MetricFu.configuration.supports_ripper?
+        super if MetricFu.configuration.rails?
+      else
+        MetricFu.configuration.mf_debug("Rails Best Practices is only available in MRI 1.9. It requires ripper")
+      end
+    end
+
+    def activate
+      activate_library('rails_best_practices')
+      activate_library('metric_fu/sexp_ext')
+      super
+    end
+
   end
 end

data/lib/metric_fu/metrics/rails_best_practices/rails_best_practices.rb

@@ -1,36 +1,29 @@
 module MetricFu
-  class RailsBestPractices < Generator
+  class RailsBestPracticesGenerator < Generator
+
+    def self.metric
+      :rails_best_practices
+    end
+
     def emit
-      command = %Q(mf-rails_best_practices --without-color .)
-      mf_debug "** #{command}"
-      @output = `#{command}`
+      mf_debug "** Rails Best Practices"
+      path = '.'
+      analyzer = ::RailsBestPractices::Analyzer.new(path, { 'silent' => true })
+      analyzer.analyze
+      @output = analyzer.errors
     end
 
     def analyze
-      @matches = @output.chomp.split("\n").map{|m| m.split(" - ") }
-      total = @matches.pop
-      cleanup_color_switches(total.first)
-
-      2.times { @matches.pop } # ignore wiki link
-      @matches.reject! {|array| array.empty? }
-      @matches.map! do |match|
-        file, line = match[0].split(':')
-        problem = match[1]
-
-        cleanup_color_switches(file)
-        cleanup_color_switches(problem)
-
-        file.gsub!(/^\.\//, '')
-
-        {:file => file, :line => line, :problem => problem}
+      @problems = @output.collect do |problem|
+        {
+          :file    => problem.filename,
+          :line    => problem.line_number,
+          :problem => problem.message,
+          :url     => problem.url
+        }
       end
-      @rails_best_practices_results = {:total => total, :problems => @matches}
-    end
-
-    def cleanup_color_switches(str)
-      return if str.nil?
-      str.gsub!(%r{^\e\[3[1|2]m}, '')
-      str.gsub!(%r{\e\[0m$}, '')
+      total = ["Found #{@problems.count} errors."]
+      @rails_best_practices_results = {:total => total, :problems => @problems}
     end
 
     def to_h

data/lib/metric_fu/metrics/rails_best_practices/template_awesome/rails_best_practices.html.erb

@@ -19,7 +19,7 @@
   <% @rails_best_practices[:problems].each do |problem| %>
     <tr class='<%= cycle("light", "dark", count) %>'>
       <td><%= link_to_filename(problem[:file], problem[:line]) %></td>
-      <td><%= problem[:problem] %></td>
+      <td><a href =<%= problem[:url] %>><%= problem[:problem] %></a></td>
     </tr>
     <% count += 1 %>
   <% end %>

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

@@ -1,20 +1,45 @@
-MetricFu::Configuration.run do |config|
-  config.add_metric(:rcov)
-  config.add_graph(:rcov)
-    rcov_opts = [
-      "--sort coverage",
-      "--no-html",
-      "--text-coverage",
-      "--no-color",
-      "--profile",
-      "--exclude-only '.*'",
-      '--include-file "\Aapp,\Alib"'
-    ]
-    rcov_opts << "-Ispec" if File.exist?("spec")
-  config.configure_metric(:rcov,
+module MetricFu
+  class MetricRcov < Metric
+
+    def name
+      :rcov
+    end
+
+    def default_run_options
       { :environment => 'test',
                     :test_files =>  Dir['{spec,test}/**/*_{spec,test}.rb'],
                     :rcov_opts => rcov_opts,
                     :external => nil
-                  })
+                  }
+    end
+
+    def has_graph?
+      true
+    end
+
+    def enable
+      MetricFu.configuration.mf_debug("rcov is not available. See README")
+    end
+
+    def activate
+      super
+    end
+
+    private
+
+    def rcov_opts
+      rcov_opts = [
+        "--sort coverage",
+        "--no-html",
+        "--text-coverage",
+        "--no-color",
+        "--profile",
+        "--exclude-only '.*'",
+        '--include-file "\Aapp,\Alib"'
+      ]
+      rcov_opts << "-Ispec" if File.exist?("spec")
+      rcov_opts
+    end
+
+  end
 end

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

@@ -1,10 +1,15 @@
 require 'enumerator'
+require 'fileutils'
 
 module MetricFu
 
-  class Rcov < Generator
+  class RcovGenerator < Generator
     NEW_FILE_MARKER = /^={80}$/.freeze
 
+    def self.metric
+      :rcov
+    end
+
     class Line
       attr_accessor :content, :was_run
 
@@ -20,7 +25,7 @@ module MetricFu
 
     def emit
       if run_rcov?
-        mf_debug "** Running the specs/tests in the [#{MetricFu.rcov[:environment]}] environment"
+        mf_debug "** Running the specs/tests in the [#{options[:environment]}] environment"
         mf_debug "** #{command}"
         `#{command}`
       end
@@ -35,17 +40,17 @@ module MetricFu
     end
 
     def default_command
-      FileUtils.rm_rf(MetricFu::Rcov.metric_directory, :verbose => false)
-      Dir.mkdir(MetricFu::Rcov.metric_directory)
-      output = ">> #{MetricFu::Rcov.metric_directory}/rcov.txt"
-      test_files = FileList[*MetricFu.rcov[:test_files]].join(' ')
-      rcov_opts = MetricFu.rcov[:rcov_opts].join(' ')
-      %Q(RAILS_ENV=#{MetricFu.rcov[:environment]} rcov #{test_files} #{rcov_opts} #{output})
+      FileUtils.rm_rf(MetricFu::RcovGenerator.metric_directory, :verbose => false)
+      Dir.mkdir(MetricFu::RcovGenerator.metric_directory)
+      output = ">> #{MetricFu::RcovGenerator.metric_directory}/rcov.txt"
+      test_files = FileList[*options[:test_files]].join(' ')
+      rcov_opts = options[:rcov_opts].join(' ')
+      %Q(RAILS_ENV=#{options[:environment]} rcov #{test_files} #{rcov_opts} #{output})
     end
 
 
     def analyze
-      output_file = MetricFu.rcov[:external] ? MetricFu.rcov[:external] : MetricFu::Rcov.metric_directory + '/rcov.txt'
+      output_file = options[:external] ? options[:external] : MetricFu::RcovGenerator.metric_directory + '/rcov.txt'
       output = File.open(output_file).read
       output = output.split(NEW_FILE_MARKER)
 
@@ -132,7 +137,7 @@ module MetricFu
     end
 
     def run_rcov?
-      !(MetricFu.rcov[:external])
+      !(options[:external])
     end
 
   end

data/lib/metric_fu/metrics/reek/init.rb

@@ -1,7 +1,26 @@
-MetricFu::Configuration.run do |config|
-  config.add_metric(:reek)
-  config.add_graph(:reek)
-  config.configure_metric(:reek,
-      { :dirs_to_reek => MetricFu.code_dirs,
-                    :config_file_pattern => nil})
+module MetricFu
+  class MetricReek < Metric
+
+    def name
+      :reek
+    end
+
+    def default_run_options
+      { :dirs_to_reek => MetricFu::Io::FileSystem.directory('code_dirs'),
+                    :config_file_pattern => nil}
+    end
+
+    def has_graph?
+      true
+    end
+
+    def enable
+      super
+    end
+
+    def activate
+      super
+    end
+
+  end
 end

data/lib/metric_fu/metrics/reek/reek.rb

@@ -1,42 +1,25 @@
 module MetricFu
 
-  class Reek < Generator
+  class ReekGenerator < Generator
     REEK_REGEX = /^(\S+) (.*) \((.*)\)$/
 
-    def emit
-      files_to_reek = MetricFu.reek[:dirs_to_reek].map{|dir| Dir[File.join(dir, "**/*.rb")] }
-      files = remove_excluded_files(files_to_reek.flatten)
-      config_file_param = MetricFu.reek[:config_file_pattern] ? "--config #{MetricFu.reek[:config_file_pattern]}" : ''
-      command = %Q(mf-reek #{config_file_param} #{files.join(" ")})
-      mf_debug "** #{command}"
-      @output = `#{command}`
-      @output = massage_for_reek_12 if reek_12?
+    def self.metric
+      :reek
     end
 
-    def reek_12?
-      return false if @output.length == 0
-      (@output =~ /^"/) != 0
+    def emit
+      files = files_to_analyze
+      if files.empty?
+        mf_log "Skipping Reek, no files found to analyze"
+        @output = ""
+      else
+        command = %Q(mf-reek #{cli_options(files)})
+        mf_debug "** #{command}"
+        @output = `#{command}`
+        @output = massage_for_reek_12 if reek_12?
+      end
     end
 
-    def massage_for_reek_12
-      section_break = ''
-      @output.split("\n").map do |line|
-        case line
-        when /^  /
-          "#{line.gsub(/^  /, '')}\n"
-        else
-          parts = line.split(" -- ")
-          if parts[1].nil?
-            "#{line}\n"
-          else
-            warnings = parts[1].gsub(/ \(.*\):/, ':')
-            result = "#{section_break}\"#{parts[0]}\" -- #{warnings}\n"
-            section_break = "\n"
-            result
-          end
-        end
-      end.join
-    end
 
     def analyze
       @matches = @output.chomp.split("\n\n").map{|m| m.split("\n") }
@@ -80,5 +63,43 @@ module MetricFu
       end
     end
 
+    def reek_12?
+      return false if @output.length == 0
+      (@output =~ /^"/) != 0
+    end
+
+    def massage_for_reek_12
+      section_break = ''
+      @output.split("\n").map do |line|
+        case line
+        when /^  /
+          "#{line.gsub(/^  /, '')}\n"
+        else
+          parts = line.split(" -- ")
+          if parts[1].nil?
+            "#{line}\n"
+          else
+            warnings = parts[1].gsub(/ \(.*\):/, ':')
+            result = "#{section_break}\"#{parts[0]}\" -- #{warnings}\n"
+            section_break = "\n"
+            result
+          end
+        end
+      end.join
+    end
+
+    private
+
+    def files_to_analyze
+      dirs_to_reek = options[:dirs_to_reek]
+      files_to_reek = dirs_to_reek.map{|dir| Dir[File.join(dir, "**","*.rb")] }.flatten
+      remove_excluded_files(files_to_reek)
+    end
+
+    def cli_options(files)
+      config_file_param = options[:config_file_pattern] ? "--config #{options[:config_file_pattern]}" : ''
+      cli_options = "#{config_file_param} #{files.join(' ')}"
+    end
+
   end
 end

data/lib/metric_fu/metrics/reek/template_awesome/reek.html.erb

@@ -1,6 +1,6 @@
 <h3>Reek Results</h3>
 
-<p><a href="http://reek.rubyforge.org/">Reek</a> detects common code smells in ruby code.</p>
+<p><a href="http://github.com/troessner/reek">Reek</a> detects common code smells in ruby code.</p>
 
 <% graph_name = 'reek' %>
 <% if MetricFu.configuration.graph_engine == :gchart %>

data/lib/metric_fu/metrics/roodi/init.rb

@@ -1,7 +1,26 @@
-MetricFu::Configuration.run do |config|
-  config.add_metric(:roodi)
-  config.add_graph(:roodi)
-  config.configure_metric(:roodi,
-      { :dirs_to_roodi => MetricFu.code_dirs,
-                    :roodi_config => "#{MetricFu.root_dir}/config/roodi_config.yml"})
+module MetricFu
+  class MetricRoodi < Metric
+
+    def name
+      :roodi
+    end
+
+    def default_run_options
+      { :dirs_to_roodi => MetricFu::Io::FileSystem.directory('code_dirs'),
+                    :roodi_config => "#{MetricFu::Io::FileSystem.directory('root_directory')}/config/roodi_config.yml"}
+    end
+
+    def has_graph?
+      true
+    end
+
+    def enable
+      super
+    end
+
+    def activate
+      super
+    end
+
+  end
 end

data/lib/metric_fu/metrics/roodi/roodi.rb

@@ -1,10 +1,14 @@
 module MetricFu
-  class Roodi < Generator
+  class RoodiGenerator < Generator
+
+    def self.metric
+      :roodi
+    end
 
     def emit
-      files_to_analyze = MetricFu.roodi[:dirs_to_roodi].map{|dir| Dir[File.join(dir, "**/*.rb")] }
+      files_to_analyze = options[:dirs_to_roodi].map{|dir| Dir[File.join(dir, "**/*.rb")] }
       files = remove_excluded_files(files_to_analyze.flatten)
-      config = MetricFu.roodi[:roodi_config] ? "-config=#{MetricFu.roodi[:roodi_config]}" : ""
+      config = options[:roodi_config] ? "-config=#{options[:roodi_config]}" : ""
       command = %Q(mf-roodi #{config} #{files.join(" ")})
       mf_debug "** #{command}"
       @output = `#{command}`

data/lib/metric_fu/metrics/saikuro/init.rb

@@ -1,11 +1,27 @@
-MetricFu::Configuration.run do |config|
-  config.add_metric(:saikuro)
-  config.configure_metric(:saikuro,
-      { :output_directory => "#{MetricFu.scratch_directory}/saikuro",
-                    :input_directory =>MetricFu.code_dirs,
+module MetricFu
+  class MetricSaikuro < Metric
+
+    def name
+      :saikuro
+    end
+
+    def default_run_options
+      { :output_directory => "#{MetricFu::Io::FileSystem.directory('scratch_directory')}/saikuro",
+                    :input_directory =>MetricFu::Io::FileSystem.directory('code_dirs'),
                     :cyclo => "",
                     :filter_cyclo => "0",
                     :warn_cyclo => "5",
                     :error_cyclo => "7",
-                    :formater => "text"})
+                    :formater => "text"}
+    end
+
+    def has_graph?
+      false
+    end
+
+    def enable
+      super
+    end
+
+  end
 end