metric_fu 4.10.0 → 4.11.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDU0ZjAyZDI4ZTQxN2JhZDVlNzc5M2VmNDBiYmNjODNjMTE4ZTczMA==
+    NTlhNTUwYTY3MzMxNmZiZGM4YzM4YjI0YjM2ZmUwMTU4MzA2YTM5NQ==
   data.tar.gz: !binary |-
-    MzI4ZDg2NjA1NzIwZmM5NDFjMzM5NGFhZjFjM2I4NGVjOGUwMGI1ZQ==
+    ZTNjOGQwNjIxOWRhYWYzYzE3ZWE4MTAzYjhlZmI0ZDAzNGU3Mjc3NQ==
 SHA512:
   metadata.gz: !binary |-
-    Y2MyNjBjZGVhZDgxNzk2OTE3MWMwNDU1ZGI3NjMzNjRhYTI2NjI2OGE4MzQy
-    NDI1NzFkNDRkYjU3NzM5NDdjYzI4NDEzNTZmMjA4NWZlYjM2ZWUyZGMzMmJk
-    MWNlZWY4NDk2NDlhMzU3ZWYxYzZlY2E1MmYwZjA4NDRjM2IyZmE=
+    ZTkwMWM3ZjBkMjUwZDQzYzJiMmQ1YzZlZmNmMzMxNDVlNWM4NWRkZTE4MTEy
+    MGM4YjI3YjBkYWQxNGJhZGE5NTFiNDgxMmUwMTU4YzY2OTY5NjYzYjdlYTg4
+    YzFhYTVkZWRiYzU2ZDNiNzk3NWM3ZGNkMDBjYjI1NGZkMDI5OWI=
   data.tar.gz: !binary |-
-    N2JkYzVjNGY0OTI2OThlZDgwYTYzYjk5OGU0Yjg1NjQ3Y2JmYjE2NzRlYjc2
-    ZDMxODUxMGFjMmNmZDQ2OTdhOTVlMTVmMzc5YjEzNjA3MGNhZGM1M2JiODUy
-    NWUyM2RmZDQ2NmY3YjI2MzExZGU3ZmJmMjk2YTVhZDY5NzY4Nzg=
+    ZjkyNGU5YmE2MGRjYmEwODJkMTdlY2JlNjc0OWM5Y2JmZTc5ZGI4YmQ3NzEw
+    MDI0YWE1ZGYxMDVkYWM5MzNhY2VkZDlhYjc1NjkxYjE3ZTRjMGI2NjUyZDZj
+    ZWY1NWI4NmJlNzE5ZGE4NTY5MTdiOTE4NWRmODI4OTVmNGFjNGQ=

data.tar.gz.sig

@@ -1,2 +1,2 @@
-�j���X��0J��k�J��ȮE'
-]&ݩ&
+ҫ�4e�v��b�-��Nt�+>�g��>,�b*�rtz
+���<e�3�F�%z��Aʁp�"f�n2��Y���ٲ�E�#c�����@�H�P����ע���q�_o<���1���#b�����5�'ϟi�~kR�)��7��	�O+�*~���

data/.simplecov

@@ -0,0 +1,42 @@
+# https://github.com/colszowka/simplecov#using-simplecov-for-centralized-config
+# see https://github.com/colszowka/simplecov/blob/master/lib/simplecov/defaults.rb
+if SimpleCov.respond_to?(:profiles)
+  SimpleCov.profiles
+else
+  SimpleCov.adapters
+end.define 'metric_fu' do
+  if defined?(load_profile)
+    load_profile  'test_frameworks'
+  else
+    load_adapter 'test_frameworks'
+  end
+
+  add_group "Cli",             "lib/metric_fu/cli"
+  add_group "Data Structures", "lib/metric_fu/data_structures"
+  add_group "Formatters",      "lib/metric_fu/formatter"
+  add_group "Hotspots",        "lib/metric_fu/metrics/hotspots"
+  add_group "Metrics",         "lib/metric_fu/metrics"
+  add_group "Reporters",       "lib/metric_fu/reporting"
+  add_group "Templates",       "lib/metric_fu/templates"
+
+  add_group "Long files" do |src_file|
+    src_file.lines.count > 100
+  end
+  class MaxLinesFilter < SimpleCov::Filter
+    def matches?(source_file)
+      source_file.lines.count < filter_argument
+    end
+  end
+  add_group "Short files", MaxLinesFilter.new(5)
+
+  # Exclude these paths from analysis
+  add_filter 'bundle'
+  add_filter 'bin'
+  add_filter 'lib/metric_fu/tasks'
+end
+SimpleCov.at_exit do
+  File.open(File.join(SimpleCov.coverage_path, 'coverage_percent.txt'), 'w') do |f|
+    f.write SimpleCov.result.covered_percent
+  end
+  SimpleCov.result.format!
+end

data/.travis.yml

@@ -1,21 +1,22 @@
 language: ruby
-bundler_args: --without local_development yard metrics guard --path vendor/bundle
+bundler_args: --path vendor/bundle
 script: bundle exec rspec
 cache: bundler
 gemfile:
   - gemfiles/Gemfile.travis
 before_install:
   - gem install bundler
-  - bundle config --local without local_development
-# env:
-#   - "rack=1.3.4"
+  - bundle config --local without local_development yard guard
 rvm:
-  - 2.1.0
+  # 2.1, not 2.1.0 until fixed https://github.com/travis-ci/travis-ci/issues/2220
+  - 2.1
   - 2.0.0
   - 1.9.3
   - 1.9.2
   - jruby
-  - rbx-2
+  - "rbx-2"
 matrix:
   allow_failures:
     - rvm: rbx-2
+    - rvm: 2.1
+  fast_finish: true

data/CONTRIBUTING.md

@@ -8,7 +8,7 @@ How to contribute:
 
 ## Code
 
-1. Fork and clone the repo: `git clone git://github.com/yourghname/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 rspec`)

data/DEV.md

@@ -9,14 +9,15 @@ MetricFu.loader.load_user_configuration
 MetricFu.loader.loaded_files
 MetricFu.lib_require { 'utility' }
 MetricFu.lib_dir #=> metric_fu/lib
-MetricFu.lib_require('metrics')  { 'flog/init' }
-MetricFu.metrics_require {'flog/init' }
+MetricFu.lib_require('metrics')  { 'flog/metric' }
+MetricFu.metrics_require {'flog/metric' }
 MetricFu.metrics_dir #=> metric_fu/lib/metrics
 MetricFu.formatter_require { 'html' }
 MetricFu.formatter_dir #=> metric_fu/lib/formatter
 MetricFu.reporting_require { 'result' }
 MetricFu.reporting_dir #=> metric_fu/lib/reporting
 MetricFu.logging_require { 'mf_debugger' }
+MetricFu.lib_require { 'logger' }
 MetricFu.logging_dir   #=> metric_fu/lib/logging
 MetricFu.errors_require { 'analysis_error' }
 MetricFu.errors_dir    #=> metric_fu/lib/errors
@@ -41,7 +42,7 @@ end
 
 ```ruby
 # Given
-template = AwesomeTemplate.new
+template = MetricFu::Templates::MetricsTemplate.new
 
 # Render _report_footer.html.erb partial:
 

data/Gemfile

@@ -1,17 +1,39 @@
+# encoding: utf-8
 source 'https://rubygems.org'
 
-
 group :test, :local_development  do
   gem 'pry'
   gem 'pry-nav'
-  gem 'redcarpet', :platforms => :ruby
 end
 
 gemspec :path => File.expand_path('..', __FILE__)
 
-# group :development, :test do
-#   gem 'devtools', git: 'https://github.com/rom-rb/devtools.git'
-# end
-
 # Added by devtools
-eval_gemfile File.expand_path('Gemfile.devtools', File.dirname(__FILE__))
+group :development do
+  gem 'rake',  '~> 10.1.0'
+  gem 'rspec', '~> 3.0.0.beta2'
+  gem 'yard',  '~> 0.8.7', group: :yard
+end
+
+group :guard do
+  gem 'guard',         '~> 1.8.1'
+  gem 'guard-bundler', '~> 1.0.0'
+  gem 'guard-rspec'
+
+  # file system change event handling
+  gem 'listen',     '~> 1.3.0'
+  gem 'rb-fchange', '~> 0.0.6', require: false
+  gem 'rb-fsevent', '~> 0.9.3', require: false
+  gem 'rb-inotify', '~> 0.9.0', require: false
+
+  # notification handling
+  gem 'libnotify',               '~> 0.8.0', require: false
+  gem 'rb-notifu',               '~> 0.0.4', require: false
+  gem 'terminal-notifier-guard', '~> 1.5.3', require: false
+end
+
+platform :jruby do
+  group :jruby do
+    gem 'jruby-openssl', '~> 0.8.5'
+  end
+end

data/HISTORY.md

@@ -1,16 +1,42 @@
-Changes are below categorized as `Features, Fixes, or Misc`.
+Changes are below categorized as `Breaking changes, Features, Fixes, or Misc`.
 
 Each change should fall into categories that would affect whether the release is major (breaking changes), minor (new behavior), or patch (bug fix). See [semver](http://semver.org/) and [pessimistic versioning](http://docs.rubygems.org/read/chapter/16#page74)
 
-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.
+As such, a _Feature_ would map to either major (breaking change) 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 [changes](https://github.com/metricfu/metric_fu/compare/v4.10.0...master)
+### Master [changes](https://github.com/metricfu/metric_fu/compare/v4.11.0...master)
 
 * Breaking Changes
 * Features
 * Fixes
 * Misc
 
+### [4.11.0](https://github.com/metricfu/metric_fu/compare/v4.10.0...v4.11.0)
+
+* Features
+  * There is now a `MetricFu.logger` with standard available configurations.
+    The old `mf_debug` and `mf_log` main mixin is presevered.  Needs documentation. See #113. (Benjamin Fleischer, a49bfdd182)
+  * Use *launchy* (new dependency) when opening output files. (Nick Veys, #224)
+  * Coverage formatter now behaves like SimpleCov; it ignores certain lines in
+    calculating the precent run. Fixes #153, #222 (Benjamin Fleischer, #226).
+    - Thanks to @crv for the test in #153
+    - Note: JRuby will usually report different Coverage from MRI. This is a known issue.
+    - Note: This technically is a *breaking change* from how RCov works. But wwe don't run RCov anymore. (65bf21723291f)
+* Fixes
+  * Ensure paths with spaces don't cause the open command to fail (Nick Veys, #220)
+  * Read in source files for annotation in BINARY mode to avoid encoding errors. (Benjamin Fleischer, #216)
+  * Start SimpleCov before any MetricFu code is loaded. Coverage isn't tracked on already-loaded code. (Benjamin Fleischer, cca659f7d48d3f6799)
+  * Remove unused/invalid Flay param 'filetypes'. Closes #151. (Benjamin Fleischer, 5973595f51c)
+* Misc
+  * Document ENV variables the may fix encoding exceptions. (Mike Szyndel, #217)
+  * Begin adding shared tests for metrics and configuration.  Test fenced-codeblock matching. (Benjamin Fleischer, #221)
+  * Reorganize the application file layout. Still more to be done. (Benjamin Fleischer, #223)
+  * Rename AwesomeTemplate to MetricFu::Templates::MetricsTemplate.  (Benjamin Fleischer, 55c52afd95d78)
+  * Rename ReekHotspot to MetricFu::ReekHotspot.  Was missing namespace. (Benjamin Fleischer, a3aa70c1a9)
+  * Allow failures for Ruby 2.1, in addition to rbx per issues with rvm.  (Benjamin Fleischer, 3018b22)
+  * `spec/quality_spec.rb` checks for whitespace, tabs, quotes, etc. `rake spec` also checks for warnings. (Benjamin Fleischer, b0c51bb9b17)
+  * When run with COVERAGE=true, will ouptut a file to `coverage/coverage_percent.txt` that can be checked via `rake check_code_coverage`. Borrowed from VCR. (Benjamin Fleischer, 32df3a34c6)
+
 ### [4.10.0 / 2014-04-01](https://github.com/metricfu/metric_fu/compare/v4.9.0...v4.10.0)
 
 * Features

data/README.md

@@ -19,7 +19,7 @@ To be sure the gem you install hasn't been tampered with:
 
 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.
+This is necessary because not all of MetricFu's dependencies are signed, so we cannot use HighSecurity.
 
 ## Usage
 
@@ -228,6 +228,11 @@ SimpleCov.start
 Additionally, the `coverage_file` path must be specified as above
 and must exist.
 
+## Common problems / debugging
+
+- ['ArgumentError; message invalid byte sequence in US-ASCII'](https://github.com/metricfu/metric_fu/issues/215) may be caused by having a default external encoding that is not UTF-8. You can see this in the output of `metric_fu --debug`
+  - OSX: Ensure you have set `LANG=en_US.UTF-8` and `LC_ALL=en_US.UTF-8`.  You can add these to your `~/.profile`.
+
 ## Compatibility
 
 * It is currently testing on MRI (>= 1.9.3), JRuby (19 mode), and Rubinius (19 mode). Ruby 1.8 is no longer supported.

data/Rakefile

@@ -1,22 +1,44 @@
 #!/usr/bin/env rake
-require 'bundler/setup'
+using_git = File.exist?(File.expand_path('../.git/', __FILE__))
+if using_git
+  require 'bundler/setup'
+  require 'bundler/gem_helper'
+  Bundler::GemHelper.install_tasks
+  # require 'appraisal'
+end
+require 'rake'
 
 Dir['./gem_tasks/*.rake'].each do |task|
   import(task)
 end
 
-begin
-  require 'spec/rake/spectask'
-  desc "Run all specs in spec directory"
-  Spec::Rake::SpecTask.new(:spec) do |t|
-    t.spec_files = FileList['spec/**/*_spec.rb']
-  end
-rescue LoadError
-  require 'rspec/core/rake_task'
-  desc "Run all specs in spec directory"
-  RSpec::Core::RakeTask.new(:spec)
+require 'rspec/core/rake_task'
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+
+  t.pattern = "spec/**/_spec.rb"
+  # we require spec_helper so we don't get an RSpec warning about
+  # examples being defined before configuration.
+  t.ruby_opts = "-I./spec -r./spec/capture_warnings -rspec_helper"
+  t.rspec_opts = %w[--format progress] if (ENV['FULL_BUILD'] || !using_git)
 end
 
 require File.expand_path File.join(File.dirname(__FILE__),'lib/metric_fu')
 
+# Borrowed from vcr
+desc "Checks the spec coverage and fails if it is less than 100%"
+task :check_code_coverage do
+  if RUBY_VERSION.to_f < 1.9 || RUBY_ENGINE != 'ruby'
+    puts "Cannot check code coverage--simplecov is not supported on this platform"
+  else
+    percent = Float(File.read("./coverage/coverage_percent.txt"))
+    if percent < 98.0
+      abort "Spec coverage was not high enough: #{percent.round(2)}%"
+    else
+      puts "Nice job! Spec coverage is still above 98%"
+    end
+  end
+end
+
 task :default => :spec

data/checksum/metric_fu-4.10.0.gem.sha512

@@ -1 +1 @@
-8f0981ae30f8af7a51f73cafe23e764e26ac0a51b6fa99892d306079b52194f754b5045821684a22f34feae5772ab7818761f25fe166781c2497eca5b57770f5
+e71e2ed626a7b3ee170116c5e72d846ba36039b0f016eb31ca87c9815534f27d5c85cf9bb42308bb2b3f539d123aa3ffea8fb7692c9a1c6f2b616a3511bf11f1

data/gem_tasks/usage_test.rake

@@ -1,6 +1,3 @@
-require 'redcarpet'
-require 'English'
-require 'tmpdir'
 ROOT_PATH    = File.expand_path("..", File.dirname(__FILE__))
 require File.join(ROOT_PATH, 'spec', 'support', 'usage_test')
 LIB_PATH     = File.join(ROOT_PATH, 'lib')
@@ -20,11 +17,3 @@ task "usage_test" => %w[load_path] do
   usage_test = UsageTest.new
   usage_test.test_files(EXAMPLE_FILES)
 end
-
-class HTMLRenderAndVerifyCodeBlocks < Redcarpet::Render::HTML
-
-  def block_code(code, language)
-    SnippetRunner.new(code, language).test!
-  end
-
-end

data/lib/metric_fu.rb

@@ -8,6 +8,18 @@ module MetricFu
 
   module_function
 
+  def root
+    @app_root ||= Pathname(APP_ROOT)
+  end
+
+  def metric_url
+    'https://github.com/metricfu/metric_fu'
+  end
+
+  def metric_name
+    'MetricFu'
+  end
+
   def run_dir
     @run_dir ||= Dir.pwd
   end

data/lib/metric_fu/configuration.rb

@@ -1,4 +1,4 @@
-MetricFu.logging_require { 'mf_debugger' }
+MetricFu.lib_require { 'logger' }
 module MetricFu
 
   # Even though the below class methods are defined on the MetricFu module
@@ -63,10 +63,6 @@ module MetricFu
       reset
     end
 
-    def mf_debug(msg)
-      MfDebugger.mf_debug msg
-    end
-
     # TODO review if these code is functionally duplicated in the
     # base generator initialize
     attr_reader :formatters

data/lib/metric_fu/environment.rb

@@ -1,16 +1,16 @@
 require 'redcard'
 require 'rbconfig'
-MetricFu.logging_require { 'mf_debugger' }
+MetricFu.lib_require { 'logger' }
 module MetricFu
   module Environment
 
     # TODO: Set log_level here, instead
     def verbose
-      MfDebugger::Logger.debug_on
+      MetricFu.logger.debug_on
     end
 
     def verbose=(toggle)
-      MfDebugger::Logger.debug_on = toggle
+      MetricFu.logger.debug_on = toggle
     end
 
     # Perform a simple check to try and guess if we're running

data/lib/metric_fu/formatter.rb

@@ -21,7 +21,7 @@ module MetricFu
     end
 
     module Templates
-      MetricFu.reporting_require { 'templates/awesome/awesome_template' }
+      MetricFu.lib_require { 'templates/metrics_template' }
 
       module_function
 

data/lib/metric_fu/formatter/html.rb

@@ -1,5 +1,6 @@
+require 'launchy'
 MetricFu.formatter_require { 'yaml' }
-MetricFu.metrics_require { 'graph' }
+MetricFu.reporting_require { 'graphs/graph' }
 module MetricFu
   module Formatter
     class HTML
@@ -44,7 +45,7 @@ module MetricFu
 
       # Instantiates a new template class based on the configuration set
       # in MetricFu::Configuration, or through the MetricFu.config block
-      # in your rake file (defaults to the included AwesomeTemplate),
+      # in your rake file (defaults to the included MetricFu::Templates::MetricsTemplate),
       # assigns the result_hash to the result_hash in the template, and
       # tells the template to to write itself out.
       def save_templatized_result
@@ -71,25 +72,24 @@ module MetricFu
 
       # Checks to discover whether we should try and open the results
       # of the report in the browser on this system.  We only try and open
-      # in the browser if we're on OS X and we're not running in a
-      # CruiseControl.rb environment.  See MetricFu.configuration for more
-      # details about how we make those guesses.
+      # in the browser if we're not running in a CruiseControl.rb environment.
+      # See MetricFu.configuration for more details about how we make those guesses.
       #
       # @return Boolean
       #   Should we open in the browser or not?
       def open_in_browser?
-        MetricFu.configuration.osx? &&
-          ! MetricFu.configuration.is_cruise_control_rb?
+        ! MetricFu.configuration.is_cruise_control_rb?
       end
 
       # Shows 'index.html' from the passed directory in the browser
       # if we're able to open the browser on this platform.
       #
-      # @param dir String
+      # @param dir Pathname
       #   The directory path where the 'index.html' we want to open is
       #   stored
       def show_in_browser(dir)
-        system("open #{dir}/index.html") if open_in_browser?
+        uri = URI.join(URI.escape("file://#{dir}/"), 'index.html')
+        Launchy.open(uri) if open_in_browser?
       end
     end
   end