code_metric_fu 4.14.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1ed526fc057c65f525f4da0ca4fbe912ce55b4d
+  data.tar.gz: 300ab4f5400f9babb33a9254260aec163bcebb96
+SHA512:
+  metadata.gz: 6bda1409f5803ea9b66125d7ab450b8761216ec2d3609aff500d363ea8a36850a09f131489b4d65800a7a64f0a96f75dce0b7ecd9b5f764eb0dd1aacdac8c190
+  data.tar.gz: 5ad355b62d0828c6e63c739d75f206905958d75a6616feae203f91731fb768112ddbe57c92edf0564a1dca60283fa55b650e5f5133d28da2d9b3108aad278dd6

data/.gitignore

@@ -0,0 +1,28 @@
+.DS_Store
+.rvmrc*
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+tags
+.idea
+
+# rvm
+.ruby-version
+.ruby-gemset
+
+.overcommit.yml

data/.metrics

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+#
+# Put configuration code here

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--profile

data/.rubocop.yml

@@ -0,0 +1,15 @@
+inherit_from:
+  - config/rubocop.yml
+  - .rubocop_todo.yml
+
+# Files you want to exclude
+AllCops:
+  Exclude:
+    - bin/*
+    - gem_tasks/*
+    - lib/tasks/*
+    - Gemfile
+    - Rakefile
+    - bundle/**/*
+    - vendor/bundle/**/*
+    - spec/fixtures/line_numbers/*

data/.rubocop_todo.yml

@@ -0,0 +1,69 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-01-27 12:05:28 -0600 using RuboCop version 0.28.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Configuration parameters: AlignWith, SupportedStyles.
+Lint/EndAlignment:
+  Enabled: false
+
+# Offense count: 2
+Lint/EnsureReturn:
+  Enabled: false
+
+# Offense count: 1
+Lint/RescueException:
+  Enabled: false
+
+# Offense count: 10
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+# Offense count: 1
+Lint/UselessAccessModifier:
+  Enabled: false
+
+# Offense count: 27
+Lint/UselessAssignment:
+  Enabled: false
+
+# Offense count: 44
+Metrics/AbcSize:
+  Max: 56
+
+# Offense count: 393
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 709
+
+# Offense count: 3
+Metrics/PerceivedComplexity:
+  Max: 13
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/AndOr:
+  Enabled: false
+
+# Offense count: 2
+Style/EmptyElse:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: NamePrefix, NamePrefixBlacklist.
+Style/PredicateName:
+  Enabled: false
+
+# Offense count: 1
+Style/RescueModifier:
+  Enabled: false
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: AllowAsExpressionSeparator.
+Style/Semicolon:
+  Enabled: false

data/.simplecov

@@ -0,0 +1,74 @@
+# https://github.com/colszowka/simplecov#using-simplecov-for-centralized-config
+# see https://github.com/colszowka/simplecov/blob/master/lib/simplecov/defaults.rb
+# vim: set ft=ruby
+@minimum_coverage = ENV.fetch("COVERAGE_MINIMUM") { 87.8 }.to_f.round(2)
+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 'vendor/bundle'
+  add_filter 'bin'
+  add_filter 'lib/metric_fu/tasks'
+
+  # https://github.com/colszowka/simplecov/blob/v0.9.1/lib/simplecov/defaults.rb#L60
+  # minimum_coverage @minimum_coverage
+end
+
+## RUN SIMPLECOV
+if defined?(@running_tests)
+  @running_tests = false
+else
+  @running_tests = caller.any? {|line| line =~ /exe\/rspec/ }
+end
+if ENV["COVERAGE"] =~ /\Atrue\z/i
+  puts "[COVERAGE] Running with SimpleCov HTML Formatter"
+  formatters = [SimpleCov::Formatter::HTMLFormatter]
+  begin
+    puts '[COVERAGE] Running with SimpleCov HTML Formatter'
+    require 'metric_fu/metrics/rcov/simplecov_formatter'
+    formatters << SimpleCov::Formatter::MetricFu
+    puts '[COVERAGE] Running with SimpleCov MetricFu Formatter'
+  rescue LoadError
+    puts '[COVERAGE] SimpleCov MetricFu formatter could not be loaded'
+  end
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[ *formatters ]
+  SimpleCov.start "metric_fu" if @running_tests
+else
+  SimpleCov.formatters = []
+end
+SimpleCov.at_exit do
+  SimpleCov.result.format!
+  percent = Float(SimpleCov.result.covered_percent)
+  if percent < @minimum_coverage
+    abort "Spec coverage was not high enough: #{percent.round(2)} is < #{@minimum_coverage}%"
+  else
+    puts "Nice job! Spec coverage is still above #{@minimum_coverage}%"
+  end
+end

data/.travis.yml

@@ -0,0 +1,22 @@
+sudo: false
+language: ruby
+bundler_args: --path vendor/bundle --jobs=3 --retry=3
+script: bundle exec rspec
+cache: bundler
+
+before_install:
+  - gem install bundler
+  - bundle config --local without local_development yard guard
+rvm:
+  # 2.1, not 2.1.0 until fixed https://github.com/travis-ci/travis-ci/issues/2220
+  - 2.2
+  - 2.1
+  - 2.0.0
+  - 1.9.2
+  - 1.9.3
+  - jruby
+  - "rbx-2"
+matrix:
+  allow_failures:
+    - rvm: rbx-2
+  fast_finish: true

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+--readme README.md
+lib/metric_fu.rb
+lib/metric_fu/**/*.rb

data/AUTHORS

@@ -0,0 +1,12 @@
+Jake Scruggs
+Sean Soper
+Andre Arko
+Petrik de Heus
+Grant McInnes
+Nick Quaranto
+Édouard Brière
+Carl Youngblood
+Richard Huang
+Dan Mayer
+Benjamin Fleischer
+Robin Curry

data/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+How to contribute:
+
+## Bug reports / Issues
+
+  * Is something broken or not working as expected? Check for an existing issue or [create a new one](https://github.com/metricfu/metric_fu/issues/new)
+  * See [Quick guide to writing good bug reports](https://github.com/metricfu/metric_fu/wiki/Issues:-Quick-guide-to-writing-good-bug-reports)
+  * IMPORTANT: Include the output of `metric_fu --debug-info`
+
+## Code
+
+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`)
+  * 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.
+  * Include links to any relevant github issues.
+  * *Don't* change the VERSION file.
+6. Extra Credit: [Confirm it runs and tests pass on the rubies specified in the travis config](.travis.yml). I will otherwise confirm it runs on these.
+
+How I handle pull requests:
+
+* If the tests pass and the pull request looks good, I will merge it.
+* If the pull request needs to be changed,
+  * you can change it by updating the branch you generated the pull request from
+    * either by adding more commits, or
+    * 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
+* Update the wiki

data/CONTRIBUTORS

@@ -0,0 +1,76 @@
+Benjamin Fleischer
+Jake Scruggs
+Édouard Brière
+Richard Huang
+Grant McInnes
+Petrik
+Dan Mayer
+Robin Curry
+Sean Soper
+Delwyn de Villiers
+Martin Gotink
+Carl Youngblood
+Andre Arko
+Chris Griego
+Sathish
+Michael Stark
+Nick Quaranto
+dan sinclair
+joshuacronemeyer
+jscruggs
+David Chelimsky
+adrien
+Jay Zeschin
+Greg Allen
+Alex Rothenberg
+calveto
+Avdi Grimm
+Kevin Rutherford
+Randy Souza
+GeorgeErickson
+Josef Šimánek
+Andy Gregorowicz
+Tarsoly András
+Benjamin Fleischer / Paul Swagerty
+Nick Veys
+unknown
+Micah Geisel
+Extrovert
+Ben Turner
+Andrew Timberlake
+KAKUTANI Shintaro
+Guilherme Souza
+Przemysław Dąbek
+carlost
+David Barri
+Beau Fabry
+Chris Mason
+Andrew Selder
+iain
+Mark Wilden
+Alessandro Dias
+Lars E. Hoeg
+Eric Wollesen
+Adam Bair
+Jinzhu
+Matthew Van Horn
+Diego Carrion
+saltracer
+benlovell
+ff-cviradiya
+khall
+Stefan Huber
+Todd A. Jacobs
+jayzes
+Hans Hasselberg
+Scyllinice
+Bitdeli Chef
+René Föhring
+Matthew Gordon
+factorylabs
+Mike Ball
+Guilherme Simões
+Paul Elliott
+Joel Nimety
+Chris Ian Fiel
+Mike Szyndel

data/DEV.md

@@ -0,0 +1,76 @@
+## Contracted Interfaces
+
+```ruby
+MetricFu.run_dir #=> Dir.pwd
+MetricFu.run_dir = 'some_path'
+MetricFu.run_path #=> Pathname(Dir.pwd)
+MetricFu.root_dir
+MetricFu.loader.load_user_configuration
+MetricFu.loader.loaded_files
+MetricFu.lib_require { 'utility' }
+MetricFu.lib_dir #=> metric_fu/lib
+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
+MetricFu.data_structures_require { 'line_numbers' }
+MetricFu.data_structures_dir #=> metric_fu/lib/data_structures
+MetricFu.tasks_require { } # Doesn't work as expected. Don't use
+MetricFu.tasks_dir           #=> metric_fu/lib/tasks
+
+MetricFu.configuration #=> MetricFu::Configuration.new
+MetricFu.configuration.configure_metrics # for each metric, yield to block or runs enable, activate
+MetricFu.configuration.configure_metric(:flog) do |metric|
+  metric.run_options #=> metric.default_run_options.merge(metric.configured_run_options)
+  metric.enable
+  metric.enabled = true
+  metric.activate
+  metric.activated = true
+  metric.name #=> :flog
+end
+```
+
+## Templates
+
+```ruby
+# Given
+template = MetricFu::Templates::MetricsTemplate.new
+
+# Render _report_footer.html.erb partial:
+
+template.render_partial('report_footer')
+
+# Render _graph.html.erb partial and set a graph_name instance variable:
+
+template.render_partial 'graph', {:graph_name => 'reek'}
+```
+
+## Testing
+
+`bundle exec rspec`
+
+## Forking
+
+## Issues / Pull Requests
+
+* see [CONTRIBUTING](CONTRIBUTING.md)
+
+## Building
+
+`rake build` or `rake install`
+
+## Releasing
+
+0. Run `rake usage_test` to make sure the examples are still valid
+1. Update lib/metric_fu/version.rb
+2. Update HISTORY.md
+3. Update CONTRIBUTORS and erd per README in etc
+3. `rake release`

data/Gemfile

@@ -0,0 +1,74 @@
+# encoding: utf-8
+source "https://rubygems.org"
+
+if RUBY_VERSION =~ /^2\.2\.[0-1]p?\d*/ || RUBY_VERSION =~ /^2\.1\.\d*p?\d*/
+  gem "activesupport", "~> 4.2"
+  gem "json", "~> 1.7"
+  gem "rubocop", platforms: :mri, groups: [:test, :local_development]
+elsif RUBY_VERSION =~ /^2\.0\..*/
+  gem "activesupport", "~> 4.2"
+  gem "json", "~> 1.7"
+  gem "unparser", "0.2.4"
+  gem "rubocop", platforms: :mri, groups: [:test, :local_development]
+elsif RUBY_VERSION =~ /^1\.9\.3.*/
+  gem "activesupport", "~> 4.2"
+  gem "json", "~> 1.7"
+  gem "unparser", "0.2.4"
+  gem "json_pure", "2.0.1"
+  gem "mime-types", "2.99.3"
+  gem "rest-client", "1.8.0"
+  gem "rubocop", platforms: :mri, groups: [:test, :local_development]
+  gem "addressable", "2.4.0"
+  gem "ffi", "1.9.14" # windows support
+elsif RUBY_VERSION =~ /^1\.9\.2.*/
+  # because of https://github.com/railsbp/rails_best_practices/blob/master/rails_best_practices.gemspec
+  gem "activesupport", "~> 3.2"
+  # because of https://github.com/troessner/reek/issues/334
+  gem "reek", "~> 1.4.0"
+  # rbp -> as -> i18n
+  gem "i18n", "0.6.11"
+  gem "parallel", "= 1.3.3" # 1.3.4 disallows 1.9.2
+  gem "unparser", "0.1.5"
+  gem "json_pure", "2.0.1"
+  gem "mime-types", "2.99.3"
+  gem "rest-client", "1.8.0"
+  gem "json", "~> 1.7"
+  gem "addressable", "2.4.0"
+  gem "rainbow", "2.1.0"
+  gem "ffi", "1.9.14" # windows support
+end
+
+gemspec path: File.expand_path("..", __FILE__)
+
+platform :jruby do
+  group :jruby do
+    gem "jruby-openssl", "~> 0.9.17"
+  end
+end
+
+group :test, :local_development  do
+  gem "pry"
+  gem "pry-nav"
+end
+
+# Added by devtools
+group :development do
+  gem "rake",  "~> 10.1.0"
+  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 "terminal-notifier-guard", "~> 1.5.3", require: false
+end

data/Guardfile

@@ -0,0 +1,30 @@
+guard :bundler do
+  watch("Gemfile")
+  watch("Gemfile.lock")
+  watch(%w{.+.gemspec\z})
+end
+
+guard :rspec, cli: File.read(".rspec").split.push("--fail-fast").join(" "), keep_failed: false do
+  # Run all specs if configuration is modified
+  watch(".rspec")              { "spec" }
+  watch("Guardfile")           { "spec" }
+  watch("Gemfile.lock")        { "spec" }
+  watch("spec/spec_helper.rb") { "spec" }
+
+  # Run all specs if supporting files are modified
+  watch(%r{\Aspec/(?:fixtures|lib|support|shared)/.+\.rb\z}) { "spec" }
+
+  # Run unit specs if associated lib code is modified
+  watch(%r{\Alib/(.+)\.rb\z})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch("lib/#{File.basename(File.expand_path('../', __FILE__))}.rb") { "spec" }
+
+  # Run a spec if it is modified
+  watch(%r{\Aspec/.+_spec\.rb$\z})
+end
+
+# TODO enable once we're ready to handle all the violations :)
+# guard :rubocop, cli: %w[--config config/rubocop.yml] do
+#   watch(%r{.+\.(?:rb|rake)\z})
+#   watch(%r{\Aconfig/rubocop\.yml\z})  { |m| File.dirname(m[0]) }
+#   watch(%r{(?:.+/)?\.rubocop\.yml\z}) { |m| File.dirname(m[0]) }
+# end