metrical 0.0.7 → 0.1.0

data/.metrics

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-MetricFu::Configuration.run do |config|
-  config.metrics -= [ :rcov ]
-end
+
+# For testing that this file gets loaded
+puts "Metrics config loaded"

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--order rand

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+script: rspec
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 1.8.7
+  - ree

data/Gemfile.lock

@@ -1,45 +1,57 @@
 PATH
   remote: .
   specs:
-    metrical (0.0.7)
-      main (~> 4.6.0)
+    metrical (0.1.0.alpha)
       metric_fu (~> 2.1.1)
-      rake
+      rcov (~> 0.9)
 
 GEM
   remote: http://rubygems.org/
   specs:
     Saikuro (1.1.0)
-    activesupport (3.1.0)
+    activesupport (3.2.1)
+      i18n (~> 0.6)
       multi_json (~> 1.0)
     arrayfields (4.7.4)
     chronic (0.3.0)
-    churn (0.0.13)
+    churn (0.0.15)
+      arrayfields (= 4.7.4)
+      chronic (>= 0.2.3)
       chronic (>= 0.2.3)
+      fattr (= 2.2.0)
+      hirb (= 0.5.0)
       hirb
+      jeweler (= 1.6.4)
+      json (= 1.6.1)
       json_pure
       main
-      ruby_parser (~> 2.0.4)
+      main (>= 4.6.0)
+      map (= 4.3.0)
+      ruby_parser (= 2.3.1)
+      ruby_parser (~> 2.3)
+      sexp_processor (= 3.0.7)
       sexp_processor (~> 3.0.3)
     colored (1.2)
+    diff-lcs (1.1.3)
     erubis (2.7.0)
     fattr (2.2.0)
     flay (1.4.3)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
-    flog (2.5.2)
+    flog (2.5.3)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
-    haml (3.1.3)
+    git (1.2.5)
     hirb (0.5.0)
     i18n (0.6.0)
-    json_pure (1.5.4)
-      spruz (~> 0.2.8)
-    main (4.6.0)
-      arrayfields (>= 4.7.4)
-      fattr (>= 2.1.0)
-      map (>= 2.0.0)
-    map (4.5.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.6.1)
+    json_pure (1.6.5)
+    main (4.7.1)
+    map (4.3.0)
     metric_fu (2.1.1)
       Saikuro (>= 1.1.0)
       activesupport (>= 2.0.0)
@@ -52,31 +64,37 @@ GEM
       reek (>= 1.2.6)
       roodi (>= 2.1.0)
       syntax
-    multi_json (1.0.3)
-    rails_best_practices (0.10.1)
+    multi_json (1.0.4)
+    progressbar (0.10.0)
+    rails_best_practices (1.7.2)
       activesupport
       colored
       erubis
-      haml
       i18n
-      ruby-progressbar
-      ruby_parser
-    rake (0.9.2)
-    rcov (0.9.10)
+      progressbar
+      sexp_processor
+    rake (0.9.2.2)
+    rcov (0.9.11)
     reek (1.2.8)
       ruby2ruby (~> 1.2)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
     roodi (2.1.0)
       ruby_parser
-    ruby-progressbar (0.0.10)
-    ruby2ruby (1.3.0)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    ruby2ruby (1.3.1)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
-    ruby_parser (2.0.6)
+    ruby_parser (2.3.1)
       sexp_processor (~> 3.0)
-    sexp_processor (3.0.6)
-    spruz (0.2.13)
+    sexp_processor (3.0.7)
     syntax (1.0.0)
 
 PLATFORMS
@@ -84,3 +102,4 @@ PLATFORMS
 
 DEPENDENCIES
   metrical!
+  rspec (~> 2.8)

data/README.md

@@ -1,5 +1,7 @@
 # Metrical
 
+[![Build Status](https://secure.travis-ci.org/iain/metrical.png)](http://travis-ci.org/iain/metrical)
+
 MetricFu is awesome! Metrical strives to make it a little bit easier to get working.
 
 ## Features
@@ -30,6 +32,10 @@ Run:
 
     metrical
 
+To get help:
+
+    metrical --help
+
 ## Configuration
 
 You can configure MetricFu in a `.metrics` file in the root of your project.
@@ -50,7 +56,7 @@ please drop me a line, or make a github issue.
 
 RCov doesn't work with Ruby 1.9. You should use something like
 [SimpleCov](https://github.com/colszowka/simplecov). Unfortunately, it hasn't been included into
-MetricFu yet. Until then, make sure to remove RCov from MetricFu, as the example above shows.
+MetricFu yet. Until then, Metrical automatically disables RCov under Ruby 1.9.
 
 ### New syntax in Ruby 1.9
 
@@ -75,5 +81,29 @@ If you get a message like `can't activate X, already activated Y`, or something
 open an issue. Please include the entire error message and the output of `gem list` and the version
 of Ruby you are using.
 
+
+## Development
+
+Install dependencies:
+
+    gem install bundler && bundle install
+
+Run the specs:
+
+    rspec
+
+
+## Changelog
+
+Version 0.1.0:
+
+* Finally added tests and added metrical to Travis
+* Add option `--no-open` to stop it from opening in the browser
+* Automatically turn off RCov in Ruby 1.9.x
+* Depend on RCov 0.9, so installation will work under Ruby 1.9
+* Remove other dependencies, it looks like MetricFu has that covered now.
+* Automatically turn off Saikuro on Ruby 1.9.x
+* Add switches for every metric (run `metrical --help` to see them all)
+
 ---
 Copyright 2010-2011, [Iain Hecker](http://iain.nl) - Released under the MIT License.

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:test)
+
+task :default => :test

data/bin/metrical

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
 require "metrical"
-Metrical.run(*ARGV)
+Metrical.run(ARGV.dup)

data/lib/metrical.rb

@@ -1,4 +1,5 @@
 require "metrical/version"
+require "metrical/options"
 
 require 'rubygems'
 require 'json'
@@ -11,16 +12,27 @@ require 'active_support/core_ext'
 module Metrical
   extend self
 
-  def run(*)
+  def run(argv)
+    options = Options.parse(argv)
     load_defaults
     set_new_rcov_defaults
     load_user_configuration
+    disable_metrics(options)
     run_metric_fu
-    open_in_browser
+    open_in_browser if options[:open]
   end
 
   private
 
+  def disable_metrics(options)
+    options[:metrics].each do |metric, chosen|
+      unless chosen
+        MetricFu.configuration.metrics -= [ metric ]
+        MetricFu.configuration.graphs -= [ metric ]
+      end
+    end
+  end
+
   def load_defaults
     MetricFu::Configuration.run {}
   end

data/lib/metrical/options.rb

@@ -0,0 +1,61 @@
+require 'optparse'
+
+module Metrical
+  module Options
+
+    def self.defaults
+
+      defaults = {
+        :open => true,
+        :metrics => Hash.new(true)
+      }
+      defaults[:metrics][:saikuro] = version(ruby) < version("1.9")
+      defaults[:metrics][:rcov]    = version(ruby) < version("1.9")
+      defaults
+    end
+
+    def self.version(version)
+      Gem::Version.new(version)
+    end
+
+    def self.ruby
+      RUBY_VERSION.dup
+    end
+
+    def self.metrics
+      MetricFu.configuration.metrics.sort_by(&:to_s)
+    end
+
+    def self.parse(argv)
+      options = defaults.dup
+
+      opts = OptionParser.new do |opts|
+
+        opts.version = Metrical::VERSION
+
+        metrics.each do |metric|
+
+          opts.on "--[no-]#{metric}", "Enables or disables #{metric.to_s.titleize} (default: #{options[:metrics][metric]})" do |option|
+            options[:metrics][metric] = option
+          end
+
+        end
+
+        opts.on "--[no-]open", "Open report in browser" do |open|
+          options[:open] = open
+        end
+
+      end
+
+      begin
+        opts.parse!(argv)
+      rescue OptionParser::InvalidOption => error
+        puts error.message
+        puts opts
+        exit 1
+      end
+      options
+    end
+
+  end
+end

data/lib/metrical/version.rb

@@ -1,3 +1,3 @@
 module Metrical
-  VERSION = "0.0.7"
+  VERSION = "0.1.0"
 end

data/metrical.gemspec

@@ -19,6 +19,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency "metric_fu", "~> 2.1.1"
-  s.add_runtime_dependency "main", "~> 4.6.0"
-  s.add_runtime_dependency "rake"
+  s.add_runtime_dependency "rcov", "~> 0.9"
+  s.add_development_dependency "rspec", "~> 2.8"
 end

data/spec/options_spec.rb

@@ -0,0 +1,181 @@
+require 'spec_helper'
+
+describe Metrical::Options do
+
+  describe ".defaults" do
+
+    let(:defaults) { Metrical::Options.defaults }
+
+    context "on every Ruby version" do
+
+      it "opens the report in a browser" do
+        defaults[:open].should be_true
+      end
+
+      it "enables Flog" do
+        defaults[:metrics][:flog].should be_true
+      end
+
+      it "enables Flay" do
+        defaults[:metrics][:flay].should be_true
+      end
+
+      it "enables Reek" do
+        defaults[:metrics][:reek].should be_true
+      end
+
+      it "enables Hotspots" do
+        defaults[:metrics][:hotspots].should be_true
+      end
+
+      it "enables Rails Best Practices" do
+        defaults[:metrics][:rails_best_practices].should be_true
+      end
+
+      it "enables Churn" do
+        defaults[:metrics][:churn].should be_true
+      end
+
+    end
+
+    context "on Ruby 1.8.6" do
+
+      before { subject.stub(:ruby).and_return("1.8.6") }
+
+      it "enables Saikuro" do
+        defaults[:metrics][:saikuro].should be_true
+      end
+
+      it "enables RCov" do
+        defaults[:metrics][:rcov].should be_true
+      end
+
+    end
+
+    context "on Ruby 1.8.7" do
+
+      before { subject.stub(:ruby).and_return("1.8.7") }
+
+      it "enables Saikuro" do
+        defaults[:metrics][:saikuro].should be_true
+      end
+
+      it "enables RCov" do
+        defaults[:metrics][:rcov].should be_true
+      end
+
+    end
+
+    context "on Ruby 1.9.2" do
+
+      before { subject.stub(:ruby).and_return("1.9.2") }
+
+      it "enables Saikuro" do
+        defaults[:metrics][:saikuro].should be_false
+      end
+
+      it "disables RCov" do
+        defaults[:metrics][:rcov].should be_false
+      end
+
+    end
+
+    context "on Ruby 1.9.3" do
+
+      before { subject.stub(:ruby).and_return("1.9.3") }
+
+      it "disables Saikuro" do
+        defaults[:metrics][:saikuro].should be_false
+      end
+
+      it "disables RCov" do
+        defaults[:metrics][:rcov].should be_false
+      end
+
+    end
+
+  end
+
+  describe ".parse" do
+
+    it "turns open in browser off" do
+      subject.parse(["--no-open"])[:open].should be_false
+    end
+
+    it "turns open in browser on" do
+      subject.parse(["--open"])[:open].should be_true
+    end
+
+    # MetricFu doesn't include Saikuro on 1.9.2 (it is broken on 1.9 anyway)
+    # https://github.com/jscruggs/metric_fu/blob/master/lib/base/configuration.rb#L12
+    unless RUBY_VERSION == "1.9.2"
+
+      it "turns saikuro off" do
+        subject.parse(["--no-saikuro"])[:metrics][:saikuro].should be_false
+      end
+
+      it "turns saikuro on" do
+        subject.parse(["--saikuro"])[:metrics][:saikuro].should be_true
+      end
+
+    end
+
+    it "turns churn off" do
+      subject.parse(["--no-churn"])[:metrics][:churn].should be_false
+    end
+
+    it "turns churn on" do
+      subject.parse(["--churn"])[:metrics][:churn].should be_true
+    end
+
+    it "turns flay off" do
+      subject.parse(["--no-flay"])[:metrics][:flay].should be_false
+    end
+
+    it "turns flay on" do
+      subject.parse(["--flay"])[:metrics][:flay].should be_true
+    end
+
+    it "turns flog off" do
+      subject.parse(["--no-flog"])[:metrics][:flog].should be_false
+    end
+
+    it "turns flog on" do
+      subject.parse(["--flog"])[:metrics][:flog].should be_true
+    end
+
+    it "turns hotspots off" do
+      subject.parse(["--no-hotspots"])[:metrics][:hotspots].should be_false
+    end
+
+    it "turns hotspots on" do
+      subject.parse(["--hotspots"])[:metrics][:hotspots].should be_true
+    end
+
+    it "turns rcov off" do
+      subject.parse(["--no-rcov"])[:metrics][:rcov].should be_false
+    end
+
+    it "turns rcov on" do
+      subject.parse(["--rcov"])[:metrics][:rcov].should be_true
+    end
+
+    it "turns reek off" do
+      subject.parse(["--no-reek"])[:metrics][:reek].should be_false
+    end
+
+    it "turns reek on" do
+      subject.parse(["--reek"])[:metrics][:reek].should be_true
+    end
+
+    it "turns roodi off" do
+      subject.parse(["--no-roodi"])[:metrics][:roodi].should be_false
+    end
+
+    it "turns roodi on" do
+      subject.parse(["--roodi"])[:metrics][:roodi].should be_true
+    end
+
+  end
+
+end

data/spec/running_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Metrical, "running" do
+
+  before do
+    FileUtils.rm_rf("tmp/metric_fu")
+  end
+
+  it "has a clean start" do
+    File.should_not exist("tmp/metric_fu")
+  end
+
+  it "loads the .metrics file" do
+    out = metrical
+    out.should include "Metrics config loaded"
+  end
+
+  it "creates a report yaml file" do
+    expect { metrical }.to create_file("tmp/metric_fu/report.yml")
+  end
+
+  it "creates a report html file" do
+    expect { metrical }.to create_file("tmp/metric_fu/output/index.html")
+  end
+
+  it "displays help" do
+    out = metrical("bundle exec metrical --help")
+    out.should include "Usage: metrical [options]"
+  end
+
+  it "displays version" do
+    out = metrical("bundle exec metrical --version")
+    out.should == "metrical #{Metrical::VERSION}"
+  end
+
+  it "errors on unknown flags" do
+    expect { metrical "--asdasdasda" }.to raise_error
+  end
+
+  def metrical(command = "--no-open")
+    results = `metrical #{command} 2>&1`
+    $?.to_i.should eq(0), "The command 'metrical #{command}' failed!\n\n#{results}"
+    results.strip
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'bundler/setup'
+require 'metrical'
+require 'rspec'
+
+RSpec::Matchers.define :create_file do |expected|
+
+  match do |block|
+    @before = File.exist?(expected)
+    block.call
+    @after = File.exist?(expected)
+    !@before && @after
+  end
+
+  failure_message_for_should do |block|
+    existed_before_message expected do
+      "The file #{expected.inspect} was not created"
+    end
+  end
+
+  failure_message_for_should_not do |block|
+    existed_before_message expected do
+      "The file #{expected.inspect} was created"
+    end
+  end
+
+  def existed_before_message(expected)
+    if @before
+      "The file #{expected.inspect} existed before, so this test doesn't work"
+    else
+      yield
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metrical
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-11 00:00:00.000000000Z
+date: 2012-02-13 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metric_fu
-  requirement: &2173451920 !ruby/object:Gem::Requirement
+  requirement: &70219138027460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,29 +21,29 @@ dependencies:
         version: 2.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *2173451920
+  version_requirements: *70219138027460
 - !ruby/object:Gem::Dependency
-  name: main
-  requirement: &2173451400 !ruby/object:Gem::Requirement
+  name: rcov
+  requirement: &70219138026940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.6.0
+        version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *2173451400
+  version_requirements: *70219138026940
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &2173450960 !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: &70219138026440 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '2.8'
+  type: :development
   prerelease: false
-  version_requirements: *2173450960
+  version_requirements: *70219138026440
 description: MetricFu is awesome! The only problem is that it's kinda obtrusive. Metrical
   provides a executable so you can run metric fu on any project without making changes
   to the project.
@@ -56,14 +56,20 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .metrics
+- .rspec
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
 - bin/metrical
 - lib/metrical.rb
+- lib/metrical/options.rb
 - lib/metrical/version.rb
 - metrical.gemspec
+- spec/options_spec.rb
+- spec/running_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/iain/metrical
 licenses: []
 post_install_message: 
@@ -84,8 +90,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: metrical
-rubygems_version: 1.8.6
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Run metric_fu without making it a project dependency
-test_files: []
+test_files:
+- spec/options_spec.rb
+- spec/running_spec.rb
+- spec/spec_helper.rb