metric_fu 4.6.0 → 4.7.0

data/.metrics

@@ -22,6 +22,12 @@
 #     cane.no_doc = 'y'
 #     cane.no_readme = 'y'
 #   end
+# 
+#   config.configure_metric(:churn) do |churn|
+#     churn.enabled = true
+#     churn.ignore_files = 'HISTORY.md, TODO.md'
+#     churn.start_date = '6 months ago'
+#   end
 #
 #   Or, to configure a group of metrics...
 #   config.configure_metrics.each do |metric|

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
-bundler_args: --without coverage
+bundler_args: --without local_development yard metrics guard --path vendor/bundle
 script: bundle exec rspec
+cache: bundler
 gemfile:
   - gemfiles/Gemfile.travis
 # before_install: some_command
@@ -11,7 +12,7 @@ rvm:
   - 1.9.3
   # - 1.9.2 # code_metric 0.1.0 requires ruby 1.9.3 or greater
   - jruby-19mode # JRuby in 1.9 mode
-  - rbx-19mode
-# matrix:
-#   allow_failures:
-#     - rvm: rbx-19mode
+  - rbx
+matrix:
+  allow_failures:
+    - rvm: rbx

data/CONTRIBUTING.md

@@ -8,11 +8,11 @@ How to contribute:
 
 ## Code
 
-1. Clone the repo: `git clone git://github.com/metricfu/metric_fu.git && cd metric_fu`
+1. Fork and clone the repo: `git clone git://github.com/yourghname/metric_fu.git && cd metric_fu` 
 2. Install the gem dependencies: `bundle install`
 3. Make the changes you want and back them up with tests.
-  * Run the tests (`bundle exec rake`)
-  * Run metric_fu on itself (`bundle exec rake metrics:all`)
+  * Run the tests (`bundle exec rspec`)
+  * Run metric_fu on itself (`bundle exec ruby -Ilib bin/metric_fu`)
 4. Update the HISTORY.md file with your changes and give yourself credit
 5. Commit and create a pull request with details as to what has been changed and why
   * Use well-described, small (atomic) commits.
@@ -29,6 +29,18 @@ How I handle pull requests:
     * by force pushing to it
   * I can make any changes myself and manually merge the code in.
 
+### Commit Messages
+
+* [A Note About Git Commit Messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+* [http://stopwritingramblingcommitmessages.com/](http://stopwritingramblingcommitmessages.com/)
+* [ThoughtBot style guide](https://github.com/thoughtbot/guides/tree/master/style#git)
+
+### About Pull Requests (PR's)
+
+* [All Your Open Source Code Are Belong To Us](http://www.benjaminfleischer.com/2013/07/30/all-your-open-source-code-are-belong-to-us/)
+* [Using Pull Requests](https://help.github.com/articles/using-pull-requests)
+* [Github pull requests made easy](http://www.element84.com/github-pull-requests-made-easy.html)
+
 ## Documentation
 
 * If relevant, you may update [the metric_fu website](https://github.com/metricfu/metricfu.github.com) in a separate pull request to that repo

data/Gemfile

@@ -1,16 +1,11 @@
 source 'https://rubygems.org'
 
 
-group :test, :coverage do
-  # https://github.com/kina/simplecov-rcov-text
-  gem 'simplecov-rcov-text'
-end
-
-group :test do
-  gem 'test-construct'
-  gem 'json'
+group :test, :local_development  do
   gem 'pry'
   gem 'pry-nav'
+  # https://github.com/kina/simplecov-rcov-text
+  gem 'simplecov-rcov-text', group: :metrics
 end
 
 gemspec :path => File.expand_path('..', __FILE__)

data/Gemfile.devtools

@@ -2,8 +2,8 @@
 
 group :development do
   gem 'rake',  '~> 10.1.0'
-  gem 'rspec', '~> 2.14.1'
-  gem 'yard',  '~> 0.8.7'
+  gem 'rspec', '~> 3.0.0.beta1'
+  gem 'yard',  '~> 0.8.7', group: :yard
 end
 
 group :yard do
@@ -13,7 +13,7 @@ end
 group :guard do
   gem 'guard',         '~> 1.8.1'
   gem 'guard-bundler', '~> 1.0.0'
-  gem 'guard-rspec',   '~> 3.0.2'
+  gem 'guard-rspec'#,   '~> 3.0.2'
   # gem 'guard-rubocop', '~> 0.2.0'
 
   # file system change event handling

data/HISTORY.md

@@ -4,12 +4,32 @@ Each change should fall into categories that would affect whether the release is
 
 As such, a _Feature_ would map to either major or minor. A _bug fix_ to a patch.  And _misc_ is either minor or patch, the difference being kind of fuzzy for the purposes of history.  Adding tests would be patch level.
 
-### Master
+### Master [changes](https://github.com/metricfu/metric_fu/compare/v4.7.0...master)
 
+* Breaking Changes
 * Features
 * Fixes
 * Misc
 
+### [4.7.0 / 2013-12-31](https://github.com/metricfu/metric_fu/compare/v4.6.0...v4.7.0)
+
+* Features
+  * Move to using churn library and allowing all churn options to be passed through to churn library. (Dan Mayer, #182)
+  * Create template for syntax highlighting in report.  (Benjamin Fleischer, #179)
+  * Gem deps now derirved from gemspec via regex (from Gemnasium). Related to #184.
+    `--debug-info` will now show the version of the activated gem, if available.  (Benjamin Fleischer, #189)
+* Fixes
+  * Force gemspec to use utf-8 encoding when importing the AUTHORS file. (Paul Swagerty, #183)
+  * Ensure gemspec doesn't crash when reading in AUTHORS file. (saltracer, #184)
+  * Fix bad parsing of reek output. (Greg Allen, #185)
+* Misc
+  * Spelling correction. (mdb, #177)
+  * Clean up README indentation. (simi, #187)
+  * Tests run faster. (Benjamin Fleischer, #181)
+  * Simplify load paths. (Benjamin Fleicher, #139)
+  * Update to RSpec 3.0.0.beta1. (Benjamin Fleischer)
+  * Update to new release of TestConstruct. (Benjamin Fleischer)
+
 ### MetricFu [4.6.0 / 2013-11-20](https://github.com/metricfu/metric_fu/compare/v4.5.2...v4.6.0)
 
 * Features
@@ -121,6 +141,8 @@ add all contriubtors
 
 ### MetricFu 4.4.0 / 2013-08-15
 
+* Breaking Changes
+  * Removed configuration methods / MetricFu module methods: add_graph, add_metric, configure_graph, configure_metric, configure_graph_engine, graph_engine, metrics, formatters, graphs, graph_engines, rails?, code_dirs, base_directory, scratch_directory, output_directory, data_directory, file_globs_to_ignore, metric_fu_root_directory, template_directory, template_class, link_prefix, darwin_txmt_protocol_no_thanks, syntax_highlighting
 * Features
   * Metrics now configure themselves in a subclass of MetricFu::Metric ( Benjamin Fleischer / Robin Curry #91, #111)
   * Metrics can be configured individually via Metric.configuration.configure_metric(:some_metric) or Metric.configuration.configure_metrics {|metric| }.  See .metrics file for examples ( Benjamin Fleischer / Robin Curry #91, #111)
@@ -141,7 +163,6 @@ add all contriubtors
   * Exposed RubyParser patch ( Benjamin Fleischer / Robin Curry #91, #111)
   * Separated out io / filesystem /templating concerns into their own classes or modules. Thus, we removed all the metaprogrammatically defined methods and instance variables.( Benjamin Fleischer / Robin Curry #91, #111, #112, #115)
   * Generator subclasses can now be found by metric name. MetricFu::Generator.get_generator(:flog) (Benjamin Fleischer, #126)
-  * Breaking change related to the above: removed configuration methods / MetricFu module methods: add_graph, add_metric, configure_graph, configure_metric, configure_graph_engine, graph_engine, metrics, formatters, graphs, graph_engines, rails?, code_dirs, base_directory, scratch_directory, output_directory, data_directory, file_globs_to_ignore, metric_fu_root_directory, template_directory, template_class, link_prefix, darwin_txmt_protocol_no_thanks, syntax_highlighting
 
 ### MetricFu 4.3.1 / 2013-08-02
 

data/README.md

@@ -12,10 +12,14 @@ If you have trouble installing the gem
 - try adding metric_fu to your Gemfile and bundling.
 - file a ticket on the issues page.
 
-MetricFu is cryptographically signed. To be sure the gem you install hasn't been tampered with:
+MetricFu is [cryptographically signed](http://guides.rubygems.org/security/).
+To be sure the gem you install hasn't been tampered with:
 - Add my public key (if you haven't already) as a trusted certificate `gem cert --add <(curl -Ls https://raw.github.com/metricfu/metric_fu/master/certs/bf4.pem)`
-- `gem install metric_fu -P HighSecurity`
-- This may cause installation to fail if non-signed dependent gems are also being installed.
+- `gem install metric_fu -P MediumSecurity`
+
+The MediumSecurity trust profile will verify signed gems, but allow the installation of unsigned dependencies.
+
+This is necessary because not all of MetricFu’s dependencies are signed, so we cannot use HighSecurity.
 
 ## Usage
 
@@ -55,26 +59,26 @@ These reports are generated in metric_fu's output directory (```tmp/metric_fu/ou
 using a relative path:
 
 ```sh
-  metric_fu --out custom_directory    # outputs to tmp/metric_fu/custom_directory
+metric_fu --out custom_directory    # outputs to tmp/metric_fu/custom_directory
 ```
 
 or a full path:
 
 ```sh
-  metric_fu --out /home/metrics      # outputs to /home/metrics
+metric_fu --out /home/metrics      # outputs to /home/metrics
 ```
 
 You can specify a different formatter at the command line by referencing a built-in formatter or providing the fully-qualified name of a custom formatter.
 
 
 ```sh
-  metric_fu --format yaml --out custom_report.yml
+metric_fu --format yaml --out custom_report.yml
 ```
 
 or
 
 ```sh
-  metric_fu --format MyCustomFormatter
+metric_fu --format MyCustomFormatter
 ```
 
 ### Custom Formatters
@@ -85,16 +89,16 @@ To create a custom formatter, you simply need to create a class
 that takes an options hash and responds to one or more notifications:
 
 ```ruby
- class MyCustomFormatter
-   def initialize(opts={}); end    # metric_fu will pass in an output param if provided.
-
-   # Should include one or more of...
-   def start; end           # Sent before metric_fu starts metric measurements.
-   def start_metric(metric); end   # Sent before individual metric is measured.
-   def finish_metric(metric); end   # Sent after individual metric measurement is complete.
-   def finish; end           # Sent after metric_fu has completed all measurements.
-   def display_results; end     # Used to open results in browser, etc.
- end
+class MyCustomFormatter
+  def initialize(opts={}); end    # metric_fu will pass in an output param if provided.
+
+  # Should include one or more of...
+  def start; end           # Sent before metric_fu starts metric measurements.
+  def start_metric(metric); end   # Sent before individual metric is measured.
+  def finish_metric(metric); end   # Sent after individual metric measurement is complete.
+  def finish; end           # Sent after metric_fu has completed all measurements.
+  def display_results; end     # Used to open results in browser, etc.
+end
 ```
 
 See [lib/metric_fu/formatter/](lib/metric_fu/formatter/) for examples.
@@ -116,13 +120,13 @@ require './lib/my_custom_formatter.rb'
 in your .metrics file add the below to run pre-generated metrics
 
 ```ruby
-    MetricFu::Configuration.run do |config|
-      config.configure_metric(:rcov) do |rcov|
-        rcov.enabled = true
-        rcov.external = File.expand_path("coverage/rcov/rcov.txt", Dir.pwd)
-        rcov.activate
-      end
-    end
+MetricFu::Configuration.run do |config|
+  config.configure_metric(:rcov) do |rcov|
+    rcov.enabled = true
+    rcov.external = File.expand_path("coverage/rcov/rcov.txt", Dir.pwd)
+    rcov.activate
+  end
+end
 ```
 
 If you want metric_fu to actually run rcov itself (1.8 only), don't specify an external file to read from
@@ -132,7 +136,7 @@ If you want metric_fu to actually run rcov itself (1.8 only), don't specify an e
 To generate the same metrics metric_fu has been generating run from the root of your project before running metric_fu
 
 ```sh
-    RAILS_ENV=test rcov $(ruby -e "puts Dir['{spec,test}/**/*_{spec,test}.rb'].join(' ')") --sort coverage --no-html --text-coverage --no-color --profile --exclude-only '.*' --include-file "\Aapp,\Alib" -Ispec > coverage/rcov/rcov.txt
+RAILS_ENV=test rcov $(ruby -e "puts Dir['{spec,test}/**/*_{spec,test}.rb'].join(' ')") --sort coverage --no-html --text-coverage --no-color --profile --exclude-only '.*' --include-file "\Aapp,\Alib" -Ispec > coverage/rcov/rcov.txt
 ```
 
 #### Simplecov metrics with Ruby 1.9 and 2.0
@@ -140,24 +144,24 @@ To generate the same metrics metric_fu has been generating run from the root of
 Add to your Gemfile or otherwise install
 
 ```ruby
-    gem 'simplecov'
-    # https://github.com/kina/simplecov-rcov-text
-    gem 'simplecov-rcov-text'
+gem 'simplecov'
+# https://github.com/kina/simplecov-rcov-text
+gem 'simplecov-rcov-text'
 ```
 
 Modify your [spec_helper](https://github.com/metricfu/metric_fu/blob/master/spec/spec_helper.rb) as per the SimpleCov docs and run your tests before running metric_fu
 
 ```ruby
-    #in your spec_helper
-    require 'simplecov'
-    require 'simplecov-rcov-text'
-    SimpleCov.formatter = SimpleCov::Formatter::RcovTextFormatter
-    # or
-    SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-      SimpleCov::Formatter::HTMLFormatter,
-      SimpleCov::Formatter::RcovTextFormatter
-      ]
-    SimpleCov.start
+#in your spec_helper
+require 'simplecov'
+require 'simplecov-rcov-text'
+SimpleCov.formatter = SimpleCov::Formatter::RcovTextFormatter
+# or
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  SimpleCov::Formatter::RcovTextFormatter
+  ]
+SimpleCov.start
 ```
 
 ## Compatibility

data/checksum/metric_fu-4.6.0.gem.sha512

@@ -0,0 +1 @@
+b9488463cdbac040cc3f4fdff3ec18385b3129876464ae14de2078c1742a1be7951ba40b7f2efba54809cb8e7766fc53ff63c2672ffd25452ddca2f9a9387ac4

data/gemfiles/Gemfile.travis

@@ -4,6 +4,13 @@ source 'https://rubygems.org'
 # export BUNDLE_GEMFILE=$PWD/gemfiles/Gemfile.travis
 # when done, unset BUNDLE_GEMFILE
 # for 1.9.2 support because of https://github.com/railsbp/rails_best_practices/blob/master/rails_best_practices.gemspec
+
+platforms :rbx do
+  gem 'racc'
+  gem 'rubysl', '~> 2.0'
+  gem 'psych'
+end
+
 gem 'activesupport', '~> 3.2'
 
 eval_gemfile File.expand_path('../../Gemfile', __FILE__)

data/lib/metric_fu/cli/helper.rb

@@ -1,5 +1,6 @@
 require 'metric_fu'
 require 'metric_fu/cli/parser'
+MetricFu.lib_require { 'run' }
 # see https://github.com/grosser/pru/blob/master/bin/pru
 module MetricFu
   module Cli
@@ -21,7 +22,7 @@ module MetricFu
         MetricFu::VERSION
       end
       def shutdown
-        out "\nShuting down. Bye"
+        out "\nShutting down. Bye"
         MetricFu::Cli.immediate_shutdown!
       end
       def banner

data/lib/metric_fu/configuration.rb

@@ -12,8 +12,6 @@ module MetricFu
   end
 
   def self.configure
-    Dir.glob(File.join(MetricFu.metrics_dir, '**/init.rb')).each{|init_file|require(init_file)}
-    Dir.glob(File.join(MetricFu.reporting_dir, '**/init.rb')).each{|init_file|require(init_file)}
     configuration.tap do |config|
       config.configure_metrics
     end

data/lib/metric_fu/formatter/html.rb

@@ -1,3 +1,5 @@
+MetricFu.formatter_require { 'yaml' }
+MetricFu.metrics_require { 'graph' }
 module MetricFu
   module Formatter
     class HTML

data/lib/metric_fu/formatter/syntax.rb

@@ -0,0 +1,47 @@
+require 'coderay'
+MetricFu.lib_require { 'utility' }
+# CodeRay options
+# used to analyze source code, because object Tokens is a list of tokens with specified types.
+# :tab_width – tabulation width in spaces. Default: 8
+# :css – how to include the styles (:class и :style). Default: :class)
+#
+# :wrap – wrap result in html tag :page, :div, :span or not to wrap (nil)
+#
+# :line_numbers – how render line numbers (:table, :inline, :list or nil)
+#
+# :line_number_start – first line number
+#
+# :bold_every – make every n-th line number bold. Default: 10
+module MetricFu
+  module Formatter
+    class Syntax
+
+      def initialize
+        @options = { :css => :class, :style => :alpha }
+        @line_number_options = {:line_numbers => :inline, :line_number_start => 0 }
+      end
+
+      def highlight(ruby_text, line_number)
+        tokens = tokenize(ruby_text)
+        tokens.div(highlight_options(line_number))
+      end
+
+      def highlight_options(line_number)
+        line_number = line_number.to_i
+        if line_number > 0
+          @options.merge(@line_number_options.merge(:line_number_start => line_number))
+        else
+          @options
+        end
+      end
+
+      private
+
+      def tokenize(ruby_text)
+        ascii_text = MetricFu::Utility.clean_ascii_text(ruby_text)
+        tokens = CodeRay.scan(ascii_text, :ruby)
+      end
+
+    end
+  end
+end

data/lib/metric_fu/gem_version.rb

@@ -1,13 +1,26 @@
+# coding: utf-8
 require 'rubygems'
 module MetricFu
   class GemVersion
+    # regexp from https://github.com/gemnasium/gemnasium-parser/blob/807d7ccc/lib/gemnasium/parser/patterns.rb#L11
+    #   under MIT License
+    GEM_NAME = /[a-zA-Z0-9\-_\.]+/
+    QUOTED_GEM_NAME = /(?:(?<gq>["'])(?<name>#{GEM_NAME})\k<gq>|%q<(?<name>#{GEM_NAME})>)/
+    MATCHER = /(?:=|!=|>|<|>=|<=|~>)/
+    VERSION = /[0-9]+(?:\.[a-zA-Z0-9]+)*/
+    REQUIREMENT = /[ \t]*(?:#{MATCHER}[ \t]*)?#{VERSION}[ \t]*/
+    REQUIREMENT_LIST = /(?<qr1>["'])(?<req1>#{REQUIREMENT})\k<qr1>(?:[ \t]*,[ \t]*(?<qr2>["'])(?<req2>#{REQUIREMENT})\k<qr2>)?/
+    REQUIREMENTS = /(?:#{REQUIREMENT_LIST}|\[[ \t]*#{REQUIREMENT_LIST}[ \t]*\])/
+    COMMENT = /(#[^\n]*)?/
+    ADD_DEPENDENCY_CALL = /^[ \t]*\w+\.add(?<type>_runtime|_development)?_dependency\(?[ \t]*#{QUOTED_GEM_NAME}(?:[ \t]*,[ \t]*#{REQUIREMENTS})?[ \t]*\)?[ \t]*#{COMMENT}$/
+
 
     def initialize
-      @gem_spec = Gem::Specification.load(gemspec)
+      @gem_spec = File.open(gemspec, 'rb') {|f| f.readlines }
     end
 
     def gemspec
-      gemspec = File.join(MetricFu.root_dir, 'metric_fu.gemspec')
+      File.join(MetricFu.root_dir, 'metric_fu.gemspec')
     end
 
     def new_dependency(name, version)
@@ -15,11 +28,15 @@ module MetricFu
     end
 
     def gem_runtime_dependencies
-      @gem_runtime_dependencies ||= begin
-                                      @gem_spec.dependencies.select{|gem| gem.type == :runtime}.each do |gem_dep|
-                                        gem_dep.name = gem_dep.name.downcase.sub('metric_fu-','')
-                                      end << new_dependency('rcov', ['~> 0.8'])
-                                    end
+      @gem_runtime_dependencies ||=
+        begin
+          @gem_spec.grep(/add_dependency|add_runtime/).map do |line|
+            match = line.match(ADD_DEPENDENCY_CALL)
+            name = match['name'].downcase.sub('metric_fu-', '')
+            version = [match['req1'], match['req2']].compact
+            new_dependency(name, version)
+          end.compact << new_dependency('rcov', ['~> 0.8'])
+        end
     end
 
     def for(name)
@@ -44,12 +61,28 @@ module MetricFu
       RESOLVER.gem_runtime_dependencies.dup
     end
 
+    def self.activated_gems
+      Gem::Specification.stubs.select(&:activated?)
+    end
+
+    def self.activated_version(name)
+      activated_gems.find do |gem|
+        return gem.version.version if gem.name == name
+      end
+    end
+
+    def self.dependency_summary(gem_dep)
+      name = gem_dep.name
+      version = activated_version(gem_dep.name) || gem_dep.requirements_list
+      {
+        'name' => name,
+        'version' => version,
+      }
+    end
+
     def self.dependencies_summary
       dependencies.map do |gem_dep|
-        {
-          'name' => gem_dep.name,
-          'version' => gem_dep.requirements_list,
-        }
+        dependency_summary(gem_dep)
       end
     end