metrical 0.0.6 → 0.0.7

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+pkg/*
+.rvmrc
+tmp/

data/.metrics

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+MetricFu::Configuration.run do |config|
+  config.metrics -= [ :rcov ]
+end

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,86 @@
+PATH
+  remote: .
+  specs:
+    metrical (0.0.7)
+      main (~> 4.6.0)
+      metric_fu (~> 2.1.1)
+      rake
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    Saikuro (1.1.0)
+    activesupport (3.1.0)
+      multi_json (~> 1.0)
+    arrayfields (4.7.4)
+    chronic (0.3.0)
+    churn (0.0.13)
+      chronic (>= 0.2.3)
+      hirb
+      json_pure
+      main
+      ruby_parser (~> 2.0.4)
+      sexp_processor (~> 3.0.3)
+    colored (1.2)
+    erubis (2.7.0)
+    fattr (2.2.0)
+    flay (1.4.3)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    flog (2.5.2)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    haml (3.1.3)
+    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)
+    metric_fu (2.1.1)
+      Saikuro (>= 1.1.0)
+      activesupport (>= 2.0.0)
+      chronic (~> 0.3.0)
+      churn (>= 0.0.7)
+      flay (>= 1.2.1)
+      flog (>= 2.3.0)
+      rails_best_practices (>= 0.6.4)
+      rcov (>= 0.8.3.3)
+      reek (>= 1.2.6)
+      roodi (>= 2.1.0)
+      syntax
+    multi_json (1.0.3)
+    rails_best_practices (0.10.1)
+      activesupport
+      colored
+      erubis
+      haml
+      i18n
+      ruby-progressbar
+      ruby_parser
+    rake (0.9.2)
+    rcov (0.9.10)
+    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)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.0.6)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.6)
+    spruz (0.2.13)
+    syntax (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  metrical!

data/README.md

@@ -0,0 +1,79 @@
+# Metrical
+
+MetricFu is awesome! Metrical strives to make it a little bit easier to get working.
+
+## Features
+
+### Metrical doesn't intrude on your project
+
+Metrical makes it easy to run MetricFu without making it a project dependency. Bundler requires
+that everything you need go inside the Gemfile. MetricFu is rather big project with a ton of
+dependencies. Including that inside your Gemfile just clutters it up.
+
+Also, MetricFu wants to be installed inside your Rakefile. With Metrical, you can configure MetricFu
+in a separate file, `.metrics` in the root of your project.
+
+### 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
+
+Install:
+
+    gem install metrical
+
+Run:
+
+    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/).
+
+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
+
+### RCov and Ruby 1.9
+
+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.
+
+### 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. I have no clue what to do about it. Some help on
+this would be greatly appreciated.
+
+### Gem dependency issues
+
+Metrical depends on a lot of other gems. Not all gem authors adhere to guidelines such as
+[SemVer](http://semver.org/). This means that sometimes, when a new version of a gem is released,
+things break. I try to fix the issues I come across inside Metrical, by making a dependency of a
+dependency a fixed dependency of Metrical. It's difficult to do this right.
+
+If you get a message like `can't activate X, already activated Y`, or something similar, you can
+open an issue. Please include the entire error message and the output of `gem list` and the version
+of Ruby you are using.
+
+---
+Copyright 2010-2011, [Iain Hecker](http://iain.nl) - Released under the MIT License.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/metrical

@@ -1,44 +1,4 @@
 #!/usr/bin/env ruby
-require 'rubygems'
-require 'json'
-require 'metric_fu'
 
-# Required for RCOV
-require 'active_support'
-require 'active_support/core_ext'
-
-# Load default configuration
-MetricFu::Configuration.run {}
-
-# RCov fixes (should be okay for everybody)
-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
-
-# Load local metrics settings
-file = File.join(Dir.pwd, '.metrics')
-load file if File.exist?(file)
-
-# 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
-
-if MetricFu.report.open_in_browser?
-  MetricFu.report.show_in_browser(MetricFu.output_directory)
-end
+require "metrical"
+Metrical.run(*ARGV)

data/lib/metrical.rb

@@ -0,0 +1,66 @@
+require "metrical/version"
+
+require 'rubygems'
+require 'json'
+require 'metric_fu'
+
+# Required for RCOV
+require 'active_support'
+require 'active_support/core_ext'
+
+module Metrical
+  extend self
+
+  def run(*)
+    load_defaults
+    set_new_rcov_defaults
+    load_user_configuration
+    run_metric_fu
+    open_in_browser
+  end
+
+  private
+
+  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/version.rb

@@ -0,0 +1,3 @@
+module Metrical
+  VERSION = "0.0.7"
+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        = "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.1"
+  s.add_runtime_dependency "main", "~> 4.6.0"
+  s.add_runtime_dependency "rake"
+end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: metrical
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
-- Iain Hecker
+- iain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-23 00:00:00.000000000Z
+date: 2011-09-11 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metric_fu
-  requirement: &2173559780 !ruby/object:Gem::Requirement
+  requirement: &2173451920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,46 +21,53 @@ dependencies:
         version: 2.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *2173559780
+  version_requirements: *2173451920
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &2173559340 !ruby/object:Gem::Requirement
+  name: main
+  requirement: &2173451400 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *2173559340
+  version_requirements: *2173451400
 - !ruby/object:Gem::Dependency
-  name: main
-  requirement: &2173558720 !ruby/object:Gem::Requirement
+  name: rake
+  requirement: &2173450960 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 4.6.0
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2173558720
+  version_requirements: *2173450960
 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
+email:
+- iain@iain.nl
 executables:
 - metrical
 extensions: []
 extra_rdoc_files: []
 files:
-- README.rdoc
+- .gitignore
+- .metrics
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
 - bin/metrical
-homepage: http://github.com/iain/metrical/
+- lib/metrical.rb
+- lib/metrical/version.rb
+- metrical.gemspec
+homepage: https://github.com/iain/metrical
 licenses: []
 post_install_message: 
-rdoc_options:
-- --main
-- README.rdoc
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -76,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project: metrical
 rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3

data/README.rdoc

@@ -1,31 +0,0 @@
-= Metrical
-
-MetricFu is awesome! Metrical strives to make it a little bit easier to get working.
-
-* Don't make MetricFu or any metrics part of the dependencies of your project;
-  so you don't need to add anything to your Gemfile.
-
-* You can run MetricFu in any project:
-
-    $ gem install metrical
-    $ cd /path/of/your/project
-    $ metrical
-
-* Per project configuration can be done in a simple <tt>.metrics</tt> file in
-  the root directory of your project. In here you can configure MetricFu as
-  you normally would. Example:
-
-    MetricFu::Configuration.run do
-      config.graph_engine = :gchart
-    end
-
-For more information on configuring your metrics, please visit the
-{MetricFu homepage}[http://metric-fu.rubyforge.org/]. Any configuration options you
-see there can be done in the <tt>.metrics</tt> file.
-
-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.
-
----
-
-Copyright 2010, Iain Hecker (iain@iain.nl) - Released under the MIT License.