metric_fu 4.11.1 → 4.13.0

data/README.md

@@ -1,9 +1,15 @@
-# MetricFu [![Gem Version](https://badge.fury.io/rb/metric_fu.png)](http://badge.fury.io/rb/metric_fu) [![Build Status](https://travis-ci.org/metricfu/metric_fu.png?branch=master)](http://travis-ci.org/metricfu/metric_fu)
+# MetricFu [![Gem Version](https://badge.fury.io/rb/metric_fu.svg)](http://badge.fury.io/rb/metric_fu) [![Build Status](https://travis-ci.org/metricfu/metric_fu.svg?branch=master)](http://travis-ci.org/metricfu/metric_fu)
 
-[![Code Climate](https://codeclimate.com/github/metricfu/metric_fu.png)](https://codeclimate.com/github/metricfu/metric_fu) [![Inline docs](http://inch-pages.github.io/github/metricfu/metric_fu.png)](http://inch-pages.github.io/github/metricfu/metric_fu) [![Dependency Status](https://gemnasium.com/metricfu/metric_fu.png)](https://gemnasium.com/metricfu/metric_fu)
+[![Join the chat at https://gitter.im/metricfu/metric_fu](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/metricfu/metric_fu?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+[![Code Climate](https://codeclimate.com/github/metricfu/metric_fu.svg)](https://codeclimate.com/github/metricfu/metric_fu) [![Inline docs](http://inch-ci.org/github/metricfu/metric_fu.svg)](http://inch-ci.org/github/metricfu/metric_fu)
 
 [Rdoc](http://rdoc.info/github/metricfu/metric_fu/)
 
+## Maintenance
+
+MetricFu needs maintainers.  If you are up for helping out, please left a note in [issue 280]( https://github.com/metricfu/metric_fu/issues/280).  MetricFu is free and open source code that belongs to everyone.  Benjamin (@bf4) hasn't been working on MetricFu for a while, which is a great opportunity for you to step up!
+
 ## Installation
 
     gem install metric_fu
@@ -47,7 +53,6 @@ See:
 
 ## Documentation
 
-
 MetricFu will attempt to load configuration data from a
 `.metrics` file, if present in your repository root.
 
@@ -87,9 +92,67 @@ MetricFu.configuration.configure_metrics.each do |metric|
 end
 ```
 
-## Formatters
+### Rails Best Practices
+
+```ruby
+MetricFu::Configuration.run do |config|
+  config.configure_metric(:rails_best_practices) do |rbp|
+    rbp.silent = true
+    rbp.exclude = ["config/chef"]
+  end
+end
+```
+
+### Coverage Metrics
+
+```ruby
+MetricFu::Configuration.run do |config|
+  config.configure_metric(:rcov) do |rcov|
+    rcov.coverage_file = MetricFu.run_path.join("coverage/rcov/rcov.txt")
+    rcov.enable
+    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
+
+#### Rcov metrics with Ruby 1.8
+
+To generate the same metrics metric_fu has been generating run from the root of your project before running metric_fu
+
+```shell
+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
+
+Add to your Gemfile or otherwise install
+
+```ruby
+gem 'simplecov'
+```
+
+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 'metric_fu/metrics/rcov/simplecov_formatter'
+SimpleCov.formatter = SimpleCov::Formatter::MetricFu
+# or
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  SimpleCov::Formatter::MetricFu
+  ]
+SimpleCov.start
+```
+
+Additionally, the `coverage_file` path must be specified as above and must exist.
 
-### Built-in Formatters
+### Formatters
+
+#### Built-in Formatters
 
 By default, metric_fu will use the built-in html formatter to generate HTML reports for each metric with pretty graphs.
 
@@ -125,7 +188,7 @@ MetricFu::Configuration.run do |config|
 end
 ```
 
-### Custom Formatters
+#### Custom Formatters
 
 You can customize metric_fu's output format with a custom formatter.
 
@@ -161,7 +224,7 @@ your .metrics configuration file.
 
 For instance, to require a formatter in your app's lib directory `require './lib/my_custom_formatter.rb'`
 
-##  Configure Graph Engine
+###  Configure Graph Engine
 
 By default, MetricFu uses the Bluff (JavaScript) graph engine.
 
@@ -178,56 +241,6 @@ MetricFu.configuration.configure_graph_engine(:highcharts)
 Notice: There was previously a :gchart option.
 It was not properly deprecated in the 4.x series.
 
-### Using Coverage Metrics
-
-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.coverage_file = MetricFu.run_path.join("coverage/rcov/rcov.txt")
-    rcov.enable
-    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
-
-#### Rcov metrics with Ruby 1.8
-
-To generate the same metrics metric_fu has been generating run from the root of your project before running metric_fu
-
-```shell
-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
-
-Add to your Gemfile or otherwise install
-
-```ruby
-gem 'simplecov'
-```
-
-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 'metric_fu/metrics/rcov/simplecov_formatter'
-SimpleCov.formatter = SimpleCov::Formatter::MetricFu
-# or
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-  SimpleCov::Formatter::HTMLFormatter,
-  SimpleCov::Formatter::MetricFu
-  ]
-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`

data/Rakefile

@@ -4,6 +4,7 @@ if using_git
   require 'bundler/setup'
 end
 require 'rake'
+require 'simplecov'
 
 Dir['./gem_tasks/*.rake'].each do |task|
   import(task)
@@ -23,19 +24,4 @@ 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/appveyor.yml

@@ -0,0 +1,34 @@
+version: '{build}'
+image:
+  - Visual Studio 2019
+
+skip_tags: true
+
+environment:
+  matrix:
+    - RUBY_VERSION: 25
+    - RUBY_VERSION: 25-x64
+    - RUBY_VERSION: 26
+    - RUBY_VERSION: 26-x64
+    - RUBY_VERSION: 27
+    - RUBY_VERSION: 27-x64
+
+install:
+  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
+  - gem install bundler
+  - bundle config force_ruby_platform true
+  - bundle install --path=vendor/bundle --retry=3 --jobs=3
+
+cache:
+  - vendor/bundle
+
+build: off
+
+before_test:
+  - ruby -v
+  - gem -v
+  - bundle -v
+
+test_script:
+  - bundle exec rspec
+  - bundle exec ruby -Ilib bin/metric_fu --no-open

data/certs/bf4.pem

@@ -1,22 +1,22 @@
 -----BEGIN CERTIFICATE-----
-MIIDjjCCAnagAwIBAgIBATANBgkqhkiG9w0BAQUFADBGMQwwCgYDVQQDDANkZXYx
-ITAfBgoJkiaJk/IsZAEZFhFiZW5qYW1pbmZsZWlzY2hlcjETMBEGCgmSJomT8ixk
-ARkWA2NvbTAeFw0xMzExMDcyMTQ0MDBaFw0xNDExMDcyMTQ0MDBaMEYxDDAKBgNV
-BAMMA2RldjEhMB8GCgmSJomT8ixkARkWEWJlbmphbWluZmxlaXNjaGVyMRMwEQYK
-CZImiZPyLGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
-ncZFu7VMbliIBhiGj6J5aKXSuHF6gXZuA8gkpgM7dgVzkLhuud6hSYXoC8UZIr+M
-N9hvV/F2F3gLlj2J7aLHr8C0for4KVjc5N/b249vGoH9nIl0qZVE3qI+R7MIdYlO
-ONoeHgiymSKyssCzGFRzv8ZVrpWuUmcB3qixb6d2aiv1kcsZZnLjY4EO5jVW9X92
-d9VMuNdYYtZ0l88prmUM+1fVfaDdY+KGrigeffHUGD0j7pHOZnRCYKwGHG/7Nkg8
-0vEtYVBKSpHIQThBMWXIQu69gIpr6AmQd/kVnhejAdQgvsDz43n9h5iZvrwcedWY
-x2wz+FrUdJzZZhitUFGrnwIDAQABo4GGMIGDMAkGA1UdEwQCMAAwCwYDVR0PBAQD
-AgSwMB0GA1UdDgQWBBTGwGJtyo8nUoRuxbYfcI5bzuHL3zAkBgNVHREEHTAbgRlk
-ZXZAYmVuamFtaW5mbGVpc2NoZXIuY29tMCQGA1UdEgQdMBuBGWRldkBiZW5qYW1p
-bmZsZWlzY2hlci5jb20wDQYJKoZIhvcNAQEFBQADggEBAI/gyzcFn4XvrzXhqKWc
-zLUbOp0349rVIF6f0PlQvf3ZJZS76HKZ2EqSQJwzpcAboypvsRWk0kVmOwvzae4Y
-bB0ac2WuRf7AntS84VkZQmI/1AIxkaQUIQvHJacaw8yJKNggbDBKugHjcrIWWg2V
-vDvyjvJx4sQFpJ84LSDbAVkB92YaP6CUwoeXwrcsvvfrvo9x5AkBECz9KZGD532g
-o78P4WmzIWLgan5GIyNFtGxCsYAug+h0jnC4yujauKqr8hKDLu4K+quCGjX/6LL6
-WONz9vT6h053kHZYMrd4Gs/NdaA4tJSxrhZlXdajAm/0vAOzLIqUHHQk3R0tf7aY
-d/w=
+MIIDmjCCAoKgAwIBAgIBATANBgkqhkiG9w0BAQUFADBJMQ8wDQYDVQQDDAZnaXRo
+dWIxITAfBgoJkiaJk/IsZAEZFhFiZW5qYW1pbmZsZWlzY2hlcjETMBEGCgmSJomT
+8ixkARkWA2NvbTAeFw0xNTAxMjIxMzAyNTNaFw0xNjAxMjIxMzAyNTNaMEkxDzAN
+BgNVBAMMBmdpdGh1YjEhMB8GCgmSJomT8ixkARkWEWJlbmphbWluZmxlaXNjaGVy
+MRMwEQYKCZImiZPyLGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB
+CgKCAQEA7V1VZBU7Aft01XAoK8I8tdClfv3H/NIauiV0jfyNtXtZEWwaZ6ooZNLk
+8kmIUsO2xI7I/B3es6w7le9q9xdEowlYjiR/X/yazNvufu5kpM4f6Ri1AKN8xvPk
+LFlR8aOAd9LptcusYDfE+BjhmAvnLTgMGODcDLJIaJzLJaRywTLUuFv4digpFwCm
+Zps9VheJnL4hkgI5BDn6DVjxHSCMRnccQM/kX9L34lbP9KkHXXEtQgkQYpElHbnd
+MtR753aPeLfOBxSGzsso+6Lhe+fz8huD05mzgWaEZN40e6M7dA9FRSsEzL32ZOad
+0z13MZWj3Yg5srV/cZvzCDCdVvRphwIDAQABo4GMMIGJMAkGA1UdEwQCMAAwCwYD
+VR0PBAQDAgSwMB0GA1UdDgQWBBQvUrPExdvmdz0Vau0dH3hRh1YQfDAnBgNVHREE
+IDAegRxnaXRodWJAYmVuamFtaW5mbGVpc2NoZXIuY29tMCcGA1UdEgQgMB6BHGdp
+dGh1YkBiZW5qYW1pbmZsZWlzY2hlci5jb20wDQYJKoZIhvcNAQEFBQADggEBAEWo
+g1soMaRTT/OfFklTuP+odV0w+2qJSfJhOY5bIebDjqxb9BN7hZJ9L6WXhcXCvl6r
+kuXjpcC05TIv1DoWWaSjGK2ADmEBDNVhaFepYidAYuUQN4+ZjVH/gS9V9OkBcE8h
+3ZwRv+9RkXM0uY1FwuGI6jgbgPeR1AkkfJnhOPohkG+VN5bFo9aK/Stw8Nwhuuiz
+axCPD3cmaJBguufRXSMC852SDiBT7AtI4Gl2Fyr+0M5TzXHKbQ9xRBxwfE1bWDd6
+lEs7ndJ1/vd/Hy0zQ1tIRWyql+ITLhqMi161Pw5flsYpQvPlRLR5pGJ4eD0/JdKE
+ZG9WSFH7QcGLY65mEYc=
 -----END CERTIFICATE-----

data/checksum/metric_fu-4.11.1.gem.sha512

@@ -0,0 +1 @@
+2d38eac5067748ee4417ab7088302a9e6c465e5163712cef9a1998bcb7048bf74c1b5c1facaccd8af042d2362693e4774de5b8c2bc6dbae5613eb91920ec58aa

data/checksum/metric_fu-4.11.2.gem.sha512

@@ -0,0 +1 @@
+c31f9343f44972b7b614d97cf33d457ad11518b408fb5e8e009eff8ee3c88353bd1dab14ac143a313433b7920b96f89d34753a0cd910364a70396ead3dc39980

data/checksum/metric_fu-4.11.3.gem.sha512

@@ -0,0 +1 @@
+2290ac18a8467b1ec187273cd94afdb3c2cb187dcf1c58152b99acf54e4249746512ef55604a8b4dc348ad106b7b25ea4a5f225fd2e9659367d20340407578d5

data/checksum/metric_fu-4.11.4.gem.sha512

@@ -0,0 +1 @@
+9a74861bf6d89f703786e562cdff96eea727aac874e0d9615d4ac8af57b2c97d15e2121de8d978b7097b56bd72b40744c9a27be9d3d12f9ecf75b66ac565e3ef

data/checksum/metric_fu-4.12.0.gem.sha512

@@ -0,0 +1 @@
+5af713f345549aa574af94d5790ec5360d61aa9ff9dce867da339f5a86e1d2d39c23d025434dd98fc04e0912b6a6da64f271663242a5aa75cbf15cac1c9c73e1

data/checksum/metric_fu-4.13.0.gem.sha512

@@ -0,0 +1 @@
+e57d3944216f0d2f9ff06ddabae68cc240510df5a3b346739d866c9dc9e86d5bc7e341efd13f5bc34f5d06bdb90cf455a4491dfc65d2f197bc0ca616ea911f7c

data/config/rubocop.yml

@@ -0,0 +1,269 @@
+# Originally from https://github.com/thoughtbot/hound/blob/master/config/style_guides/ruby.yml
+# also see
+#   https://github.com/bbatsov/rubocop/blob/master/config/enabled.yml
+#   https://github.com/rom-rb/devtools/blob/master/config/rubocop.yml
+#   https://github.com/rom-rb/devtools/blob/master/default/config/rubocop.yml
+AllCops:
+  Exclude:
+    - db/schema.rb
+
+Style/Blocks:
+  Description: 'Allow Jim Weirch-style blocks, i.e. use `{}` for blocks whose return value we use, else `do/end`'
+  StyleGuide: 'http://devblog.avdi.org/2011/07/26/the-procedurefunction-block-convention-in-ruby/'
+  Enabled: false
+
+AccessorMethodName:
+  Enabled: false
+
+ActionFilter:
+  Enabled: false
+
+Alias:
+  Enabled: false
+
+ArrayJoin:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+AsciiIdentifiers:
+  Enabled: false
+
+Attr:
+  Enabled: false
+
+BlockNesting:
+  Enabled: false
+
+CaseEquality:
+  Enabled: false
+
+CharacterLiteral:
+  Enabled: false
+
+ClassAndModuleChildren:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+ClassVars:
+  Enabled: false
+
+CollectionMethods:
+  PreferredMethods:
+    find: detect
+    reduce: inject
+    collect: map
+    find_all: select
+
+ColonMethodCall:
+  Enabled: false
+
+CommentAnnotation:
+  Enabled: false
+
+CyclomaticComplexity:
+  Enabled: false
+
+Delegate:
+  Enabled: false
+
+DeprecatedHashMethods:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+DotPosition:
+  EnforcedStyle: trailing
+
+DoubleNegation:
+  Enabled: false
+
+EachWithObject:
+  Enabled: false
+
+EmptyLiteral:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+EvenOdd:
+  Enabled: false
+
+FileName:
+  Enabled: false
+
+FlipFlop:
+  Enabled: false
+
+FormatString:
+  Enabled: false
+
+GlobalVars:
+  Enabled: false
+
+GuardClause:
+  Enabled: false
+
+IfUnlessModifier:
+  Enabled: false
+
+IfWithSemicolon:
+  Enabled: false
+
+InlineComment:
+  Enabled: false
+
+Lambda:
+  Enabled: false
+
+LambdaCall:
+  Enabled: false
+
+LineEndConcatenation:
+  Enabled: false
+
+LineLength:
+  Max: 80
+
+MethodLength:
+  Enabled: false
+
+ModuleFunction:
+  Enabled: false
+
+NegatedIf:
+  Enabled: false
+
+NegatedWhile:
+  Enabled: false
+
+Next:
+  Enabled: false
+
+NilComparison:
+  Enabled: false
+
+Not:
+  Enabled: false
+
+NumericLiterals:
+  Enabled: false
+
+OneLineConditional:
+  Enabled: false
+
+OpMethod:
+  Enabled: false
+
+ParameterLists:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  Enabled: false
+
+PerlBackrefs:
+  Enabled: false
+
+PredicateName:
+  NamePrefixBlacklist:
+    - is_
+
+Proc:
+  Enabled: false
+
+RaiseArgs:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+SelfAssignment:
+  Enabled: false
+
+SingleLineBlockParams:
+  Enabled: false
+
+SingleLineMethods:
+  Enabled: false
+
+SignalException:
+  Enabled: false
+
+SpecialGlobalVars:
+  Enabled: false
+
+StringLiterals:
+  EnforcedStyle: double_quotes
+
+VariableInterpolation:
+  Enabled: false
+
+TrailingComma:
+  Enabled: false
+
+TrivialAccessors:
+  Enabled: false
+
+VariableInterpolation:
+  Enabled: false
+
+WhenThen:
+  Enabled: false
+
+WhileUntilModifier:
+  Enabled: false
+
+WordArray:
+  Enabled: false
+
+# Lint
+
+AmbiguousOperator:
+  Enabled: false
+
+AmbiguousRegexpLiteral:
+  Enabled: false
+
+AssignmentInCondition:
+  Enabled: false
+
+ConditionPosition:
+  Enabled: false
+
+DeprecatedClassMethods:
+  Enabled: false
+
+ElseLayout:
+  Enabled: false
+
+HandleExceptions:
+  Enabled: false
+
+InvalidCharacterLiteral:
+  Enabled: false
+
+LiteralInCondition:
+  Enabled: false
+
+LiteralInInterpolation:
+  Enabled: false
+
+Loop:
+  Enabled: false
+
+ParenthesesAsGroupedExpression:
+  Enabled: false
+
+RequireParentheses:
+  Enabled: false
+
+UnderscorePrefixedVariableName:
+  Enabled: false
+
+Void:
+  Enabled: false