metric_fu 4.2.1 → 4.3.0

data/spec/run_spec.rb

@@ -1,45 +1,185 @@
 require 'spec_helper'
-require 'metric_fu/cli/helper'
-
-describe MetricFu, "running" do
+require 'fakefs/safe'
+require 'metric_fu/cli/client'
 
+describe MetricFu do
   let(:helper)  { MetricFu::Cli::Helper.new }
 
-  it "all these tests should not rely on shelling out to the command line" do
-    pending("shelling to bundler is very slow")
+  before(:all) do
+    MetricFu::Configuration.run {|config| config.graph_engine = :bluff}
   end
 
-  xit "loads the .metrics file" do
-    out = metric_fu
-    out.should include "Metrics config loaded"
+  before do
+    setup_fs
   end
 
-  xit "creates a report yaml file" do
-    expect { metric_fu }.to create_file("tmp/metric_fu/report.yml")
-  end
+  context "given configured metrics, when run" do
+    before do
 
-  xit "creates a report html file" do
-    expect { metric_fu }.to create_file("tmp/metric_fu/output/index.html")
-  end
+      # TODO: Should probably use some sort of fake metric
+      # to speed up tests. For now, just configuring with a
+      # limited set, so we can test the basic functionality
+      # without significantly slowing down the specs.
+      MetricFu::Configuration.run do |config|
+        @default_configured_metrics = config.metrics.dup
+        config.metrics = [:churn]
+      end
+
+    end
+
+    it "loads the .metrics file" do
+      # Global only for testing that this file gets loaded
+      $metric_file_loaded = false
+      metric_fu
+      $metric_file_loaded.should be_true
+    end
+
+    it "creates a report yaml file" do
+      expect { metric_fu }.to create_file("#{MetricFu.base_directory}/report.yml")
+    end
+
+    it "creates a data yaml file" do
+      expect { metric_fu }.to create_file("#{MetricFu.data_directory}/#{Time.now.strftime("%Y%m%d")}.yml")
+    end
+
+    it "creates a report html file" do
+      expect { metric_fu }.to create_file("#{MetricFu.output_directory}/index.html")
+    end
+
+    context "with configured formatter" do
+      it "outputs using configured formatter" do
+        expect {
+          MetricFu::Configuration.run do |config|
+            config.add_formatter(:yaml)
+          end
+          metric_fu
+        }.to create_file("#{MetricFu.base_directory}/report.yml")
+      end
+
+      it "doesn't output using formatters not configured" do
+        expect {
+          MetricFu::Configuration.run do |config|
+            config.add_formatter(:yaml)
+          end
+          metric_fu
+        }.to_not create_file("#{MetricFu.output_directory}/index.html")
+      end
+
+    end
+
+    context "with command line formatter" do
+      it "outputs using command line formatter" do
+        expect { metric_fu "--format yaml"}.to create_file("#{MetricFu.base_directory}/report.yml")
+      end
+
+      it "doesn't output using formatters not configured" do
+        expect { metric_fu "--format yaml"}.to_not create_file("#{MetricFu.output_directory}/index.html")
+      end
+
+    end
+
+    context "with configured and command line formatter" do
+
+      before do
+        MetricFu::Configuration.run do |config|
+          config.add_formatter(:html)
+        end
+      end
+
+      it "outputs using command line formatter" do
+        expect { metric_fu "--format yaml"}.to create_file("#{MetricFu.base_directory}/report.yml")
+      end
+
+      it "doesn't output using configured formatter (cli takes precedence)" do
+        expect { metric_fu "--format yaml"}.to_not create_file("#{MetricFu.output_directory}/index.html")
+      end
+
+    end
+
+    context "with configured specified out" do
+      it "outputs using configured out" do
+        expect {
+          MetricFu::Configuration.run do |config|
+            config.add_formatter(:yaml, "customreport.yml")
+          end
+          metric_fu
+        }.to create_file("#{MetricFu.base_directory}/customreport.yml")
+      end
+
+      it "doesn't output using formatters not configured" do
+        expect {
+          MetricFu::Configuration.run do |config|
+            config.add_formatter(:yaml, "customreport.yml")
+          end
+          metric_fu
+        }.to_not create_file("#{MetricFu.base_directory}/report.yml")
+      end
+
+    end
+
+    context "with command line specified formatter + out" do
+      it "outputs to the specified path" do
+        expect { metric_fu "--format yaml --out customreport.yml"}.to create_file("#{MetricFu.base_directory}/customreport.yml")
+      end
+
+      it "doesn't output to default path" do
+        expect { metric_fu "--format yaml --out customreport.yml"}.to_not create_file("#{MetricFu.base_directory}/report.yml")
+      end
+
+    end
+
+    context "with command line specified out only" do
+      it "outputs to the specified path" do
+        expect { metric_fu "--out customdir --no-open"}.to create_file("#{MetricFu.base_directory}/customdir/index.html")
+      end
+
+      it "doesn't output to default path" do
+        expect { metric_fu "--out customdir --no-open"}.to_not create_file("#{MetricFu.output_directory}/index.html")
+      end
+
+    end
+
+
+    after do
+      MetricFu::Configuration.run do |config|
+        config.metrics = @default_configured_metrics
+        config.formatters.clear
+      end
+
+      cleanup_fs
+    end
 
-  xit "displays help" do
-    out = metric_fu("bundle exec metric_fu --help")
-    out.should include helper.banner
-  end
 
-  xit "displays version" do
-    out = metric_fu("bundle exec metric_fu --version")
-    out.should == "#{MetricFu::VERSION}"
   end
 
-  xit "errors on unknown flags" do
-    expect { metric_fu "--asdasdasda" }.to raise_error
+  context "given other options" do
+
+    it "displays help" do
+      out = metric_fu "--help"
+      out.should include helper.banner
+    end
+
+    it "displays version" do
+      out = metric_fu "--version"
+      out.should include "#{MetricFu::VERSION}"
+    end
+
+    it "errors on unknown flags" do
+      out = metric_fu "--asdasdasda"
+      out.should include 'invalid option'
+    end
+
   end
 
-  def metric_fu(command = "--no-open")
-    results = `metric_fu #{command} 2>&1`
-    $?.to_i.should eq(0), "The command 'metric_fu #{command}' failed!\n\n#{results}"
-    results.strip
+  def metric_fu(options = "--no-open")
+    MfDebugger::Logger.capture_output {
+      begin
+        argv = Shellwords.shellwords(options)
+        MetricFu::Cli::Client.new.run(argv)
+      rescue SystemExit
+        # Catch system exit so that it doesn't halt spec.
+      end
+    }
   end
 
 end

data/spec/spec_helper.rb

@@ -13,6 +13,7 @@ require 'construct'
 $:.push File.expand_path("../../lib", __FILE__)
 require 'metric_fu'
 include MetricFu
+def mf_log(msg); mf_debug(msg); end
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.

data/spec/support/matcher_create_file.rb

@@ -1,9 +1,9 @@
 RSpec::Matchers.define :create_file do |expected|
 
   match do |block|
-    @before = File.exist?(expected)
+    @before = exists?(expected)
     block.call
-    @after = File.exist?(expected)
+    @after = exists?(expected)
     !@before && @after
   end
 
@@ -19,6 +19,11 @@ RSpec::Matchers.define :create_file do |expected|
     end
   end
 
+  def exists?(expected)
+    # Allows us to use wildcard checks for existence.
+    !Dir.glob(expected).empty?
+  end
+
   def existed_before_message(expected)
     if @before
       "The file #{expected.inspect} existed before, so this test doesn't work"

data/spec/support/matcher_create_files.rb

@@ -0,0 +1,41 @@
+RSpec::Matchers.define :create_files do |expected|
+
+  match do |block|
+    @before = false
+    @after = true
+    expected.each do |file|
+      @before |= exists?(file)
+    end
+    block.call
+    expected.each do |file|
+      @after &= exists?(file)
+    end
+    !@before && @after
+  end
+
+  failure_message_for_should do |block|
+    existed_before_message expected do
+      "One or more files in [#{expected.inspect}] was not created."
+    end
+  end
+
+  failure_message_for_should_not do |block|
+    existed_before_message expected do
+      "The files in [#{expected.inspect}] were created."
+    end
+  end
+
+  def exists?(expected)
+    # Allows us to use wildcard checks for existence.
+    !Dir.glob(expected).empty?
+  end
+
+  def existed_before_message(expected)
+    if @before
+      "One or more files in  [#{expected.inspect}] existed before, so this test doesn't work"
+    else
+      yield
+    end
+  end
+
+end

data/spec/support/suite.rb

@@ -16,3 +16,35 @@ end
 def resources_path
   "#{MetricFu.root_dir}/spec/resources"
 end
+
+def setup_fs
+  if !MetricFu.configuration.rubinius? # fakefs doesn't seem to work on rubinius...
+    FakeFS.activate!
+    FakeFS::FileSystem.clone('lib')
+    FakeFS::FileSystem.clone('.metrics')
+    FileUtils.mkdir_p(Pathname.pwd.join(MetricFu.base_directory))
+    FileUtils.mkdir_p(Pathname.pwd.join(MetricFu.output_directory))
+  else
+    # Have to use the file system, so let's shift the
+    # output directories so that we don't interfere with
+    # existing historical metric data.
+    MetricFu.stub(:base_directory).and_return("tmp/metric_fu/test")
+    MetricFu.stub(:output_directory).and_return("tmp/metric_fu/test/output")
+    MetricFu.stub(:data_directory).and_return("tmp/metric_fu/test/_data")
+  end
+end
+
+def cleanup_fs
+  if !MetricFu.configuration.rubinius?
+    FakeFS::FileSystem.clear
+    FakeFS.deactivate!
+  else
+    # Not ideal, but workaround for rubinius...
+    FileUtils.rm_rf("#{MetricFu.base_directory}/report.yml")
+    FileUtils.rm_rf(Dir.glob("#{MetricFu.output_directory}/*.html"))
+    FileUtils.rm_rf(Dir.glob("#{MetricFu.output_directory}/*.js"))
+    FileUtils.rm_rf("#{MetricFu.data_directory}/#{Time.now.strftime("%Y%m%d")}.yml")
+    FileUtils.rm_rf(Dir["#{MetricFu.base_directory}/customdir"])
+    FileUtils.rm_rf("#{MetricFu.base_directory}/customreport.yml")
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metric_fu
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 4.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -19,7 +19,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-23 00:00:00.000000000 Z
+date: 2013-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flay
@@ -242,7 +242,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.13.2
 - !ruby/object:Gem::Dependency
-  name: japgolly-Saikuro
+  name: metric_fu-Saikuro
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -348,6 +348,7 @@ executables:
 - mf-rails_best_practices
 - mf-reek
 - mf-roodi
+- mf-saikuro
 - mf-stats
 extensions: []
 extra_rdoc_files:
@@ -375,27 +376,36 @@ files:
 - bin/mf-rails_best_practices
 - bin/mf-reek
 - bin/mf-roodi
+- bin/mf-saikuro
 - bin/mf-stats
 - checksum/.gitkeep
 - checksum/metric_fu-4.2.0.gem.sha512
 - checksum/metric_fu-4.2.1.gem.sha512
+- checksum/metric_fu-4.3.0.gem.sha512
 - config/roodi_config.yml
 - gem_tasks/build.rake
+- gemfiles/Gemfile.travis
 - lib/metric_fu.rb
 - lib/metric_fu/cli/client.rb
 - lib/metric_fu/cli/helper.rb
 - lib/metric_fu/cli/parser.rb
 - lib/metric_fu/configuration.rb
+- lib/metric_fu/constantize.rb
 - lib/metric_fu/data_structures/careful_array.rb
 - lib/metric_fu/data_structures/line_numbers.rb
 - lib/metric_fu/data_structures/location.rb
 - lib/metric_fu/errors/analysis_error.rb
+- lib/metric_fu/formatter.rb
+- lib/metric_fu/formatter/html.rb
+- lib/metric_fu/formatter/yaml.rb
 - lib/metric_fu/initial_requires.rb
+- lib/metric_fu/io.rb
 - lib/metric_fu/load_files.rb
 - lib/metric_fu/logging/mf_debugger.rb
 - lib/metric_fu/metrics/base_template.rb
 - lib/metric_fu/metrics/cane/cane.rb
 - lib/metric_fu/metrics/cane/cane_bluff_grapher.rb
+- lib/metric_fu/metrics/cane/cane_gchart_grapher.rb
 - lib/metric_fu/metrics/cane/cane_grapher.rb
 - lib/metric_fu/metrics/cane/init.rb
 - lib/metric_fu/metrics/cane/template_awesome/cane.html.erb
@@ -474,11 +484,12 @@ files:
 - lib/metric_fu/metrics/stats/stats_grapher.rb
 - lib/metric_fu/metrics/stats/stats_hotspot.rb
 - lib/metric_fu/metrics/stats/template_awesome/stats.html.erb
+- lib/metric_fu/reporter.rb
 - lib/metric_fu/reporting/graphs/engines/bluff.rb
 - lib/metric_fu/reporting/graphs/engines/gchart.rb
 - lib/metric_fu/reporting/graphs/engines/init.rb
 - lib/metric_fu/reporting/graphs/grapher.rb
-- lib/metric_fu/reporting/report.rb
+- lib/metric_fu/reporting/result.rb
 - lib/metric_fu/reporting/templates/awesome/awesome_template.rb
 - lib/metric_fu/reporting/templates/awesome/css/bluff.css
 - lib/metric_fu/reporting/templates/awesome/css/buttons.css
@@ -501,6 +512,9 @@ files:
 - spec/metric_fu/configuration_spec.rb
 - spec/metric_fu/data_structures/line_numbers_spec.rb
 - spec/metric_fu/data_structures/location_spec.rb
+- spec/metric_fu/formatter/html_spec.rb
+- spec/metric_fu/formatter/yaml_spec.rb
+- spec/metric_fu/formatter_spec.rb
 - spec/metric_fu/metrics/base_template_spec.rb
 - spec/metric_fu/metrics/cane/cane_spec.rb
 - spec/metric_fu/metrics/churn/churn_spec.rb
@@ -526,9 +540,10 @@ files:
 - spec/metric_fu/metrics/saikuro/saikuro_spec.rb
 - spec/metric_fu/metrics/stats/stats_grapher_spec.rb
 - spec/metric_fu/metrics/stats/stats_spec.rb
+- spec/metric_fu/reporter_spec.rb
 - spec/metric_fu/reporting/graphs/engines/bluff_spec.rb
 - spec/metric_fu/reporting/graphs/engines/gchart_spec.rb
-- spec/metric_fu/reporting/report_spec.rb
+- spec/metric_fu/reporting/result_spec.rb
 - spec/resources/line_numbers/foo.rb
 - spec/resources/line_numbers/module.rb
 - spec/resources/line_numbers/module_surrounds_class.rb
@@ -542,6 +557,7 @@ files:
 - spec/run_spec.rb
 - spec/spec_helper.rb
 - spec/support/matcher_create_file.rb
+- spec/support/matcher_create_files.rb
 - spec/support/suite.rb
 homepage: https://github.com/metricfu/metric_fu
 licenses:
@@ -575,6 +591,9 @@ test_files:
 - spec/metric_fu/configuration_spec.rb
 - spec/metric_fu/data_structures/line_numbers_spec.rb
 - spec/metric_fu/data_structures/location_spec.rb
+- spec/metric_fu/formatter/html_spec.rb
+- spec/metric_fu/formatter/yaml_spec.rb
+- spec/metric_fu/formatter_spec.rb
 - spec/metric_fu/metrics/base_template_spec.rb
 - spec/metric_fu/metrics/cane/cane_spec.rb
 - spec/metric_fu/metrics/churn/churn_spec.rb
@@ -600,9 +619,10 @@ test_files:
 - spec/metric_fu/metrics/saikuro/saikuro_spec.rb
 - spec/metric_fu/metrics/stats/stats_grapher_spec.rb
 - spec/metric_fu/metrics/stats/stats_spec.rb
+- spec/metric_fu/reporter_spec.rb
 - spec/metric_fu/reporting/graphs/engines/bluff_spec.rb
 - spec/metric_fu/reporting/graphs/engines/gchart_spec.rb
-- spec/metric_fu/reporting/report_spec.rb
+- spec/metric_fu/reporting/result_spec.rb
 - spec/resources/line_numbers/foo.rb
 - spec/resources/line_numbers/module.rb
 - spec/resources/line_numbers/module_surrounds_class.rb
@@ -616,4 +636,5 @@ test_files:
 - spec/run_spec.rb
 - spec/spec_helper.rb
 - spec/support/matcher_create_file.rb
+- spec/support/matcher_create_files.rb
 - spec/support/suite.rb