metric_fu-metrical 0.1.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+pkg/*
+.rvmrc
+tmp/
+Gemfile.lock

data/.metrics

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+# 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

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in metrical.gemspec
+gemspec

data/README.md

@@ -0,0 +1,121 @@
+## Warning: This gem is not being maintained anymore!
+
+I work exclusively with Ruby 1.9, and most tools included don't (fully) support it.
+If you want to take over the project, fork the project, and open an issue stating your intentions.
+
+---
+
+# 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
+
+### Cleverer defaults
+
+Normally, RCov would work on a black-listing basis. This means that your coverage reports would
+occasionally be flooded with code outside your project. No longer, because the default is now to
+exclude everything and only include your `lib` and `app` directories. It also fixes some issues with
+loading RSpec.
+
+## Usage
+
+You're advised to install it with Bundler, because of dependency issues. Add this to your `Gemfile`:
+
+    gem 'metrical', :require => false
+    
+Then run:
+
+    bundle install
+
+And run it:
+
+    bundle exec metrical
+
+## Configuration
+
+You can configure MetricFu in a `.metrics` file in the root of your project.
+
+    MetricFu::Configuration.run do |config|
+      config.metrics -= [ :rcov ]
+    end
+
+For more information on configuring your metrics, please visit the
+[MetricFu homepage](http://metric-fu.rubyforge.org/).
+
+You can also turn off metrics when running, for instance:
+
+    bundle exec metrical --no-rcov
+
+The metrics you can turn on and off depend on the type of project you are in.
+For instance, Rails projects also have `rails_best_practices` and `stats` as
+options.
+
+Also, Metrical tries to be smart about your Ruby version. Some metrics are not
+available on Ruby 1.9 and are disabled automatically.
+
+To see which metrics are available, run:
+
+    bundle exec metrical --help
+
+And that's all there is too it. If you have any suggestions, ideas or bug fixes,
+please drop me a line, or make a github issue.
+
+## Known issues
+
+### General lack of support of Ruby 1.9
+
+Most tools don't handle Ruby 1.9 new syntax properly. It doesn't look like this is going to change any time soon.
+
+### RCov and Ruby 1.9
+
+RCov doesn't work at all 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, Metrical automatically disables RCov under Ruby 1.9.
+
+### New syntax in Ruby 1.9
+
+Most metrics can't cope with the new syntax in Ruby 1.9. There is nothing I can do about that, or
+the creator of these metrics, because the root lie in the code parser they use. Either don't use the
+new syntax or exclude these metrics in your `.metrics` file.
+
+### Roodi vs. Psych
+
+If you're running Ruby 1.9 with Psych as your default YAML parser (possible in 1.9.2, and the
+default in 1.9.3), you might get an error message. [Read this issue](https://github.com/iain/metrical/issues/15).
+
+### Gem dependency issues
+
+Metrical depends on a lot of other gems. This means that sometimes, when a new version of a gem is released,
+Rubygems will load the wrong version of the gem, that might be incompatible.
+
+If you get a message like `can't activate X, already activated Y`, or something similar, use Bundler.
+
+
+## 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

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

data/bin/metric_fu-metrical

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

data/lib/metrical.rb

@@ -0,0 +1,78 @@
+require "metrical/version"
+require "metrical/options"
+
+require 'rubygems'
+require 'json'
+require 'metric_fu'
+
+# Required for RCOV
+require 'active_support'
+require 'active_support/core_ext'
+
+module Metrical
+  extend self
+
+  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 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
+
+  def set_new_rcov_defaults
+    test_files = Dir['{spec,test}/**/*_{spec,test}.rb']
+    MetricFu::Configuration.run do |config|
+      config.rcov[:test_files] = test_files
+      config.rcov[:rcov_opts] = [
+        "--sort coverage",
+        "--no-html",
+        "--text-coverage",
+        "--no-color",
+        "--profile",
+        "--exclude-only '.*'",
+        '--include-file "\Aapp,\Alib"'
+      ]
+      config.rcov[:rcov_opts] << "-Ispec" if File.exist?("spec")
+    end
+  end
+
+  def load_user_configuration
+    file = File.join(Dir.pwd, '.metrics')
+    load file if File.exist?(file)
+  end
+
+  def run_metric_fu
+    MetricFu.metrics.each {|metric| MetricFu.report.add(metric) }
+    MetricFu.report.save_output(MetricFu.report.to_yaml, MetricFu.base_directory, "report.yml")
+    MetricFu.report.save_output(MetricFu.report.to_yaml, MetricFu.data_directory, "#{Time.now.strftime("%Y%m%d")}.yml")
+    MetricFu.report.save_templatized_report
+
+    MetricFu.graphs.each {|graph| MetricFu.graph.add(graph, MetricFu.graph_engine) }
+    MetricFu.graph.generate
+  end
+
+  def open_in_browser
+    if MetricFu.report.open_in_browser?
+      MetricFu.report.show_in_browser(MetricFu.output_directory)
+    end
+  end
+
+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

@@ -0,0 +1,3 @@
+module Metrical
+  VERSION = "0.1.1"
+end

data/metrical.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "metrical/version"
+
+Gem::Specification.new do |s|
+  s.name        = "metric_fu-metrical"
+  s.version     = Metrical::VERSION
+  s.authors     = ["iain"]
+  s.email       = ["iain@iain.nl"]
+  s.homepage    = "https://github.com/iain/metrical"
+  s.summary     = %q{Run metric_fu without making it a project dependency}
+  s.description = %q{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.}
+
+  s.rubyforge_project = "metrical"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "metric_fu", "> 2.1.3.6"
+  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

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: metric_fu-metrical
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- iain
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-01-08 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: metric_fu
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 103
+        segments: 
+        - 2
+        - 1
+        - 3
+        - 6
+        version: 2.1.3.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 8
+        version: "2.8"
+  type: :development
+  version_requirements: *id003
+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.
+email: 
+- iain@iain.nl
+executables: 
+- metric_fu-metrical
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .metrics
+- .rspec
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- bin/metric_fu-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: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: metrical
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Run metric_fu without making it a project dependency
+test_files: 
+- spec/options_spec.rb
+- spec/running_spec.rb
+- spec/spec_helper.rb