p8-metric_fu 0.9.0.3 → 0.9.0.4

data/Manifest.txt

@@ -1,6 +1,5 @@
 History.txt
 Manifest.txt
-metric_fu-0.7.gem
 metric_fu.gemspec
 MIT-LICENSE
 Rakefile
@@ -9,11 +8,11 @@ TODO.txt
 lib/metric_fu.rb
 lib/metric_fu/base.rb
 lib/metric_fu/churn.rb
-lib/metric_fu/flay_reporter.rb
-lib/metric_fu/flog_reporter.rb
+lib/metric_fu/flay.rb
+lib/metric_fu/flog.rb
+lib/metric_fu/reek.rb
+lib/metric_fu/roodi.rb
 lib/metric_fu/md5_tracker.rb
-lib/metric_fu/saikuro/saikuro.rb
-lib/metric_fu/saikuro/SAIKURO_README
 lib/tasks/churn.rake
 lib/tasks/coverage.rake
 lib/tasks/flog.rake
@@ -21,5 +20,13 @@ lib/tasks/metric_fu.rake
 lib/tasks/metric_fu.rb
 lib/tasks/saikuro.rake
 lib/tasks/stats.rake
-test/test_helper.rb
-test/test_md5_tracker.rb
+spec/base_spec.rb
+spec/churn_spec.rb
+spec/config_spec.rb
+spec/flay_spec.rb
+spec/flog_spec.rb
+spec/md5_tracker_spec.rb
+spec/reek_spec.rb
+spec/spec_helper.rb
+vendor/saikuro/saikuro.rb
+vendor/saikuro/SAIKURO_README

data/lib/metric_fu/base.rb

@@ -1,31 +1,13 @@
 require 'erb'
 module MetricFu
 
-  TEMPLATE_DIR = File.join(File.dirname(__FILE__), '..', 'templates')
-  BASE_DIRECTORY = ENV['CC_BUILD_ARTIFACTS'] || 'tmp/metric_fu'
-
   class << self
     # The Configuration instance used to configure the Rails environment
     def configuration
       @@configuration ||= Configuration.new
     end
 
-    def churn
-      configuration.churn
-    end
-
-    def coverage
-      configuration.coverage
-    end
-
-    def flay
-      configuration.flay
-    end
-
-    def flog
-      configuration.flog
-    end
-
+    # The metrics configured for this project
     def metrics
       configuration.metrics
     end
@@ -33,18 +15,6 @@ module MetricFu
     def open_in_browser?
       configuration.general[:open_in_browser] && PLATFORM['darwin'] && !run_by_cruise_control?
     end
-    
-    def saikuro
-      configuration.saikuro
-    end
-
-    def reek
-      configuration.reek
-    end    
-
-    def roodi
-      configuration.roodi
-    end
 
     def run_by_cruise_control?
       !!ENV['CC_BUILD_ARTIFACTS']
@@ -78,12 +48,22 @@ module MetricFu
       # Churning requires a subversion or git repo
       metrics << :churn if can_churn?
       metrics.sort{|v1, v2| v1.to_s <=> v2.to_s}
-    end
+    end    
     
   end
   
+  default_metrics.each do |meth|
+    method = <<-EOF
+    def self.#{meth}
+    configuration.#{meth}
+      end
+    EOF
+    class_eval(method)
+  end 
+  
   class Configuration
-    attr_accessor :churn, :coverage, :flay, :flog, :metrics, :reek, :roodi, :saikuro, :general
+    attr_accessor :churn, :coverage, :flay, :flog, :metrics, :reek, :roodi, :saikuro,
+                  :general, :template_dir, :base_directory
     def initialize
       raise "Use config.churn instead of MetricFu::CHURN_OPTIONS" if defined? ::MetricFu::CHURN_OPTIONS
       raise "Use config.flog[:dirs_to_flog] instead of MetricFu::DIRECTORIES_TO_FLOG" if defined? ::MetricFu::DIRECTORIES_TO_FLOG
@@ -106,8 +86,10 @@ module MetricFu
       @flog     = { :dirs_to_flog => MetricFu.code_dirs}
       @reek     = { :dirs_to_reek => MetricFu.code_dirs}
       @roodi    = { :dirs_to_roodi => MetricFu.code_dirs}
-      @metrics          = MetricFu.default_metrics
+      @metrics  = MetricFu.default_metrics
       @saikuro  = {}
+      @template_dir = File.join(File.dirname(__FILE__), '..', 'templates')
+      @base_directory = ENV['CC_BUILD_ARTIFACTS'] || 'tmp/metric_fu'      
     end
     
     def saikuro=(options)
@@ -115,7 +97,48 @@ module MetricFu
       @saikuro = options
     end
   end
-
+  
+  ########################
+  # Template methods
+  module TemplateHelpers
+    
+    def inline_css(css)
+      open(File.join(MetricFu.configuration.template_dir, css)) { |f| f.read }      
+    end
+    
+    def link_to_filename(name, line = nil)
+      if MetricFu.run_by_cruise_control?
+        cc_link_to_filename(name, line)
+      else
+        system_link_to_filename(name, line)
+      end
+    end
+    
+    def cycle(first_value, second_value, iteration)
+      return first_value if iteration % 2 == 0
+      return second_value
+    end      
+    
+    private
+    def cc_link_to_filename(name, line = nil)
+      if MetricFu.configuration.general[:url_prefix]
+        MetricFu.configuration.general[:url_prefix] += '/' unless MetricFu.configuration.general[:url_prefix] =~ /\/$/
+        %{<a href="#{MetricFu.configuration.general[:url_prefix]}#{name}?line=#{line}##{line}">#{name}</a>}
+      else
+        %{"#{name}"} # No link for cruise control without a prefix
+      end
+    end 
+    
+    def system_link_to_filename(name, line = nil)
+      filename = File.expand_path(name)
+      if PLATFORM['darwin']
+        %{<a href="txmt://open/?url=file://#{filename}&line=#{line}">#{name}</a>}
+      else
+        %{<a href="file://#{filename}">#{name}</a>}
+      end
+    end
+  end
+  
   module Base
     
     ######################################################################
@@ -123,12 +146,14 @@ module MetricFu
     #
     class Generator
 
+      include MetricFu::TemplateHelpers
+      
       def initialize(options={})
         @base_dir = self.class.metric_dir
       end
 
       def self.metric_dir
-        File.join(BASE_DIRECTORY, template_name)        
+        File.join(MetricFu.configuration.base_directory, template_name)        
       end
       
       def self.template_name
@@ -160,47 +185,9 @@ module MetricFu
       end
 
       def template_file
-        File.join(MetricFu::TEMPLATE_DIR, "#{template_name}.html.erb")
+        File.join(MetricFu.configuration.template_dir, "#{template_name}.html.erb")
       end      
       
-      ########################
-      # Template methods
-      
-      def inline_css(css)
-	      open(File.join(MetricFu::TEMPLATE_DIR, css)) { |f| f.read }      
-      end
-      
-      def link_to_filename(name, line = nil)
-        if MetricFu.run_by_cruise_control?
-          cc_link_to_filename(name, line)
-        else
-          system_link_to_filename(name, line)
-        end
-      end
-      
-      def cycle(first_value, second_value, iteration)
-        return first_value if iteration % 2 == 0
-        return second_value
-      end      
-      
-      private
-      def cc_link_to_filename(name, line = nil)
-        if MetricFu.configuration.general[:url_prefix]
-          MetricFu.configuration.general[:url_prefix] += '/' unless MetricFu.configuration.general[:url_prefix] =~ /\/$/
-          %{<a href="#{MetricFu.configuration.general[:url_prefix]}#{name}?line=#{line}##{line}">#{name}</a>}
-        else
-          %{"#{name}"} # No link for cruise control without a prefix
-        end
-      end 
-      
-      def system_link_to_filename(name, line = nil)
-        filename = File.expand_path(name)
-        if PLATFORM['darwin']
-          %{<a href="txmt://open/?url=file://#{filename}&line=#{line}">#{name}</a>}
-        else
-          %{<a href="file://#{filename}">#{name}</a>}
-        end
-      end
     end
   end
   

data/lib/metric_fu/churn.rb

@@ -8,7 +8,7 @@ module MetricFu
   class Churn < Base::Generator
 
     def initialize(options={})
-      @base_dir = File.join(MetricFu::BASE_DIRECTORY, template_name)
+      @base_dir = File.join(MetricFu.configuration.base_directory, template_name)
       if MetricFu.uses_git?
         @source_control = Git.new(options[:start_date])
       elsif MetricFu.uses_svn?

data/lib/tasks/coverage.rake

@@ -7,9 +7,9 @@ begin
  
   namespace :metrics do
  
-    COVERAGE_DIR = File.join(MetricFu::BASE_DIRECTORY, 'coverage')
-    COVERAGE_DATA_FILE = File.join(MetricFu::BASE_DIRECTORY, 'coverage.data')
-    SPEC_HTML_FILE = File.join(MetricFu::BASE_DIRECTORY, 'specs.html')
+    COVERAGE_DIR = File.join(MetricFu.configuration.base_directory, 'coverage')
+    COVERAGE_DATA_FILE = File.join(MetricFu.configuration.base_directory, 'coverage.data')
+    SPEC_HTML_FILE = File.join(MetricFu.configuration.base_directory, 'specs.html')
  
     namespace :coverage do
       rcov_output = COVERAGE_DIR
@@ -19,7 +19,7 @@ begin
  
       desc "RCov task to generate report"
       Rcov::RcovTask.new(:do => :clean) do |t|
-        FileUtils.mkdir_p(MetricFu::BASE_DIRECTORY) unless File.directory?(MetricFu::BASE_DIRECTORY)
+        FileUtils.mkdir_p(MetricFu.configuration.base_directory) unless File.directory?(MetricFu.configuration.base_directory)
         t.test_files = FileList[*MetricFu.coverage[:test_files]]
         t.rcov_opts = MetricFu.coverage[:rcov_opts]
         t.output_dir = COVERAGE_DIR
@@ -29,7 +29,7 @@ begin
       # TODO not sure what this improves but it requires the diff-lcs gem
       # http://github.com/indirect/metric_fu/commit/b9c1cf75f09d5b531b388cd01661eb16b5126968#diff-1
       # Spec::Rake::SpecTask.new(:do => :clean) do |t|
-      # FileUtils.mkdir_p(MetricFu::BASE_DIRECTORY) unless File.directory?(MetricFu::BASE_DIRECTORY)
+      # FileUtils.mkdir_p(MetricFu.configuration.base_directory) unless File.directory?(MetricFu.configuration.base_directory)
       # t.ruby_opts = ['-rtest/unit']
       # t.spec_files = FileList['test/**/*_test.rb', 'spec/**/*spec.rb']
       # t.spec_opts = ["--format", "html:#{SPEC_HTML_FILE}", "--diff"]

data/lib/tasks/railroad.rake

@@ -1,6 +1,6 @@
 namespace :metrics do
   
-  RAILROAD_DIR = File.join(MetricFu::BASE_DIRECTORY, 'railroad')
+  RAILROAD_DIR = File.join(MetricFu.configuration.base_directory, 'railroad')
   RAILROAD_FILE = File.join(RAILROAD_DIR, 'index.html')
   
   task :railroad => ['railroad:all'] do
@@ -16,21 +16,21 @@ namespace :metrics do
     desc "Create a railroad models report"
     task :models do
       #mkdir_p(RAILROAD_DIR) unless File.directory?(RAILROAD_DIR)
-      `railroad -M -a -m -l -v | neato -Tpng > #{File.join(MetricFu::BASE_DIRECTORY,'model-diagram.png')}`
+      `railroad -M -a -m -l -v | neato -Tpng > #{File.join(MetricFu.configuration.base_directory,'model-diagram.png')}`
       #`echo "<a href=\"railroad/models.png\">Model diagram</a><br />" >> #{RAILROAD_FILE}`
     end
   
     desc "Create a railroad controllers report"
     task :controllers do
       #mkdir_p(RAILROAD_DIR) unless File.directory?(RAILROAD_DIR)
-      `railroad -C -l -v | neato -Tpng > #{File.join(MetricFu::BASE_DIRECTORY,'controller-diagram.png')}`
+      `railroad -C -l -v | neato -Tpng > #{File.join(MetricFu.configuration.base_directory,'controller-diagram.png')}`
       #`echo "<a href=\"railroad/controllers.png\">Controller diagram</a><br />" >> #{RAILROAD_FILE}`
     end
   
     desc "Create a railroad acts_as_state_machine report"
     task :aasm do
       #mkdir_p(RAILROAD_DIR) unless File.directory?(RAILROAD_DIR)
-      `railroad -A -l -v | neato -Tpng > #{File.join(MetricFu::BASE_DIRECTORY,'aasm-diagram.png')}`
+      `railroad -A -l -v | neato -Tpng > #{File.join(MetricFu.configuration.base_directory,'aasm-diagram.png')}`
       #`echo "<a href=\"railroad/aasm.png\">State machine diagram</a><br />" >> #{RAILROAD_FILE}`
     end
     

data/lib/tasks/saikuro.rake

@@ -4,8 +4,8 @@ namespace :metrics do
 
   desc "A cyclomatic complexity report using Saikuro"
   task :saikuro do
-    SAIKURO_DIR = File.join(MetricFu::BASE_DIRECTORY, 'saikuro')
-    SAIKURO = File.expand_path(File.join(File.dirname(__FILE__), '..', 'metric_fu', 'saikuro', 'saikuro.rb'))
+    SAIKURO_DIR = File.join(MetricFu.configuration.base_directory, 'saikuro')
+    SAIKURO = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'vendor', 'saikuro', 'saikuro.rb'))
 
     raise "SAIKURO_OPTIONS is now MetricFu::SAIKURO_OPTIONS" if defined?(SAIKURO_OPTIONS)
     options = { :output_directory => SAIKURO_DIR,

data/lib/tasks/stats.rake

@@ -1,6 +1,6 @@
 namespace :metrics do
 
-  STATS_DIR = File.join(MetricFu::BASE_DIRECTORY, 'stats')
+  STATS_DIR = File.join(MetricFu.configuration.base_directory, 'stats')
   STATS_FILE = File.join(STATS_DIR, 'index.html')
 
   desc "A stats report"

data/spec/base_spec.rb

@@ -4,13 +4,13 @@ describe MetricFu::Base::Generator do
   describe "save_html" do
     it "should save to a index.html in the base_dir" do
       @generator = MetricFu::Base::Generator.new
-      @generator.should_receive(:open).with("#{MetricFu::BASE_DIRECTORY}/generator/index.html", "w")
+      @generator.should_receive(:open).with("#{MetricFu.configuration.base_directory}/generator/index.html", "w")
       @generator.save_html("<html>")
     end
 
     it "should save to a custom.html to the base_dir if 'custom' is passed as name" do
       @generator = MetricFu::Base::Generator.new
-      @generator.should_receive(:open).with("#{MetricFu::BASE_DIRECTORY}/generator/metric_fu/custom.html", "w")
+      @generator.should_receive(:open).with("#{MetricFu.configuration.base_directory}/generator/metric_fu/custom.html", "w")
       @generator.save_html("<html>", 'metric_fu/custom.html')
     end
   end
@@ -27,7 +27,7 @@ describe MetricFu::Base::Generator do
   describe "generate_html" do
     it "should create a new Generator and call generate_report on it" do
       @generator = MetricFu::Base::Generator.new
-      @generator.should_receive(:open).with("#{MetricFu::BASE_DIRECTORY}/generator/index.html", "w")
+      @generator.should_receive(:open).with("#{MetricFu.configuration.base_directory}/generator/index.html", "w")
       @generator.should_receive(:generate_html).and_return('<html>')
       @generator.generate_report
     end
@@ -50,7 +50,7 @@ describe MetricFu::Base::Generator do
 
   describe "metric_dir" do
     it "should return tmp/metric_fu/{the class name in lowercase}" do
-      MetricFu::Base::Generator.metric_dir.should == "#{MetricFu::BASE_DIRECTORY}/generator"
+      MetricFu::Base::Generator.metric_dir.should == "#{MetricFu.configuration.base_directory}/generator"
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: p8-metric_fu
 version: !ruby/object:Gem::Version 
-  version: 0.9.0.3
+  version: 0.9.0.4
 platform: ruby
 authors: 
 - Jake Scruggs
@@ -98,7 +98,6 @@ files:
 - lib/metric_fu/reek.rb
 - lib/metric_fu/roodi.rb
 - lib/metric_fu/md5_tracker.rb
-- lib/metric_fu/saikuro/saikuro.rb
 - lib/metric_fu.rb
 - lib/tasks/metric_fu.rb
 - lib/tasks/churn.rake
@@ -118,6 +117,7 @@ files:
 - lib/templates/flog_page.html.erb
 - lib/templates/reek.html.erb
 - lib/templates/roodi.html.erb
+- vendor/saikuro/saikuro.rb
 - Manifest.txt
 has_rdoc: true
 homepage: http://metric-fu.rubyforge.org/