quality 27.4.0 → 28.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e7d5c912404289b0414f2f8efa3f28374e1c698
-  data.tar.gz: e26e1eed73d85f7895ba3110e60474053dcd02df
+  metadata.gz: dc0a359931538858f5f3eeb50214dfee9f7e0eac
+  data.tar.gz: 4ba7b7fac56b05ef9d5682d59e2af684a69b42c3
 SHA512:
-  metadata.gz: 44634291db8c0f7b5803a204aef4839c1c495da354f01b3acc9118861d3a5de2f4f02995330e794fe078a7c1d2c9ded10e791e76bed747d88d8aaf7079584558
-  data.tar.gz: d76c732f3b3eddd05abccb43c28b726ed9d084fbbd2e6415adc7fa9c8bf8bce69b30248901c7b6466854ca695fd360b05bf7a505171609a77321af2f6b19fda5
+  metadata.gz: 16a82e84189ee8c2799ab0db5e84e03fb61de5d915ef935a848166bec45470b8b190464b3fbd3564069ceb82c74c4781f92e6526e6e74f5cf59a3e1f1f95a6c4
+  data.tar.gz: dcad53c68e1d0a9cdbc01d5ae82d707a52dbf325803e35d085e41f6cbf4bbc00ad1342420873fcbf73c3e5a6b9fce8d4e856d2330981c86d628a998850b37496

data/README.md

@@ -11,7 +11,9 @@ worse over time.
 
 ## Why
 
-See [this post](http://blog.apiology.cc/2014/06/scalable-quality-part-1.html) or [these slides](https://docs.google.com/presentation/d/1Op4FH34-enm8luEIuAAVLkuAJ-sB4LKaMm57RJzvfeI/edit#slide) for more information on the problem the quality gem solves.
+See [this post](http://blog.apiology.cc/2014/06/scalable-quality-part-1.html)
+or [these slides](https://docs.google.com/presentation/d/1Op4FH34-enm8luEIuAAVLkuAJ-sB4LKaMm57RJzvfeI/edit#slide)
+for more information on the problem the quality gem solves.
 
 ### Tools
 
@@ -34,8 +36,6 @@ Quality makes use of the following other tools, which do the actual checking:
 
 ## How to use - using Docker
 
-These basic steps assume you have a working Docker installation.
-
 ```
 docker run -v `pwd`:/usr/app apiology/quality:latest
 ```
@@ -46,14 +46,17 @@ If you'd like to customize, you can link in your own Rakefile like this:
 docker run -v `pwd`:/usr/app -v `pwd`/Rakefile.quality:/usr/quality/Rakefile apiology/quality:latest
 ```
 
-The default 'latest' tag contains the Ruby tools in a relatively small image.  You can also get additional tools (see `Dockerfile.jumbo` in this directory) by using the tag `jumbo-`(version) (e.g., jumbo-latest, jumbo-x.y.z, etc)
+The default 'latest' tag contains the Ruby tools in a relatively small
+image.  You can also get additional tools (see `Rockerfile` in
+this directory) by using the tag `jumbo-`(version) (e.g.,
+jumbo-latest, jumbo-x.y.z, etc)
 
 ## How to use - as part of a Ruby-based Rakefile
 
 ```bash
-$ pip install pep8 flake8
-$ brew install cmake icu4c shellcheck scalastyle # OS X
-$ gem install quality
+pip install pep8 flake8
+brew install cmake icu4c shellcheck scalastyle # OS X
+gem install quality
 ```
 
 or in your Gemfile:
@@ -63,10 +66,11 @@ group :development do
   gem 'quality'
 end
 ```
+
 and then:
 
 ```bash
-$ bundle install
+bundle install
 ```
 
 Once you have the gem, configure your Rakefile like this:
@@ -77,84 +81,49 @@ require 'quality/rake/task'
 Quality::Rake::Task.new
 ```
 
+If you're using Rails, you must check your environment in your
+Rakefile.
+
+```ruby
+if Rails.env.development?
+  require 'quality/rake/task'
+
+  Quality::Rake::Task.new
+end
+```
+
 Then run:
 
 ```bash
-$ rake quality
+rake quality
 ```
 
 If you want to ratchet up the quality and force yourself to improve
 code, run:
 
 ```bash
-$ rake ratchet
+rake ratchet
 ```
 
 ## Configuration options
 
-```ruby
-Quality::Rake::Task.new do |t|
-  # Name of quality task.
-  # Defaults to :quality.
-  t.quality_name = 'quality'
-
-  # Name of ratchet task.
-  # Defaults to :ratchet.
-  t.ratchet_name = 'ratchet'
-
-  #
-  # Set minimum values to ratchet to.
-  #
-  # Defaults to { bigfiles: 300 }
-  #
-  t.minimum_threshold = { bigfiles: 300 }
-
-  # Array of strings describing tools to be skipped--e.g., ["cane"]
-  #
-  # Defaults to []
-  t.skip_tools = []
-
-  # Log command executation
-  #
-  # Defaults to false
-  t.verbose = false
-
-  # Relative path to output directory where *_high_water_mark
-  # files will be read/written
-  #
-  # Defaults to 'metrics'
-  t.output_dir = 'metrics'
-
-  # Pipe-separated regexp string describing what to look for in
-  # files as 'todo'-like 'punchlist' comments.
-  #
-  # Defaults to 'XXX|TODO|FIXME|OPTIMIZE|HACK|REVIEW|LATER|FIXIT'
-  t.punchlist_regexp = 'XXX|TODO|FIXME|OPTIMIZE|HACK|REVIEW|LATER|FIXIT'
-
-  # Exclude the specified list of files--defaults to ['db/schema.rb']
-  t.exclude_files = ['lib/whatever/imported_file.rb',
-                     'lib/vendor/someone_else_fault.rb']
-
-  # Alternately, express it as a glob:
-
-  # Exclude the specified list of files
-  t.source_files_exclude_glob =
-    '{lib/whatever/imported_file.rb,lib/vendor/**/*.rb}'
-
-  #
-  # For configuration on classifying files as the correct language,
-  # see https://github.com/github/linguist
-  #
-end
-```
+See [CONFIGURATION.md](CONFIGURATION.md)
 
 ## Vendored files
 
-Quality uses GitHub's [linguist](https://github.com/github/linguist) gem to find and classify source files to analyze.  In addition to the `exclude_files` and `source_files_exclude_glob` options in Quality, you can refer to Linguists's documentation on [overrides](https://github.com/github/linguist#overrides) to use the `gitattributes` file to mark files as vendored, at which point Quality will not try to analyze them.
-  
+Quality uses GitHub's [linguist](https://github.com/github/linguist)
+gem to find and classify source files to analyze.  In addition to
+the `exclude_files` and `source_files_exclude_glob`
+options in Quality, you can refer to
+Linguists's documentation on [overrides](https://github.com/github/linguist#overrides)
+to use the `gitattributes` file to mark files as vendored, at which point
+Quality will not try to analyze them.
+
 ## Code coverage
 
-You can pull a similar trick with code coverage using SimpleCov in Ruby--put 'simplecov' in your Gemfile, and add the code below into your test_helper.rb or spec_helper.rb.
+You can pull a similar trick with code coverage using SimpleCov in
+Ruby--put 'simplecov' in your Gemfile, and add the code below into
+your test_helper.rb or spec_helper.rb.
 
 ```
 require 'simplecov'
@@ -164,9 +133,29 @@ SimpleCov.refuse_coverage_drop
 
 After your first run, check in your coverage/.last_run.json.
 
+## Build
+
+On OS X, you may
+see [build](https://github.com/brianmario/charlock_holmes/issues/117)
+failures in charlock_holmes.  To work around, if you are
+using
+[Homebrew](https://github.com/brianmario/charlock_holmes#homebrew):
+
+```sh
+bundle config build.charlock_holmes --with-cxxflags=-std=c++11 --with-icu-dir=/usr/local/opt/icu4c
+```
+
 ## Caveats
 
-Quality uses [semantic versioning](http://semver.org/)--any incompatible changes (including new tools being added) will come out as major number updates.
+Quality uses [semantic versioning](http://semver.org/)--any incompatible changes
+(including new tools being added) will come out as major number
+updates.
+
+This includes RuboCop upgrades - the quality gem locks in a specific
+minor version of RuboCop to avoid your metrics being bumped and
+breaking your build.
+
+Expect your build to break on major upgrades if you use RuboCop.
 
 ## Supported Ruby Versions
 
@@ -178,11 +167,8 @@ Tested against Ruby >=2.2--does not support Ruby 1.9.x or JRuby.
 * Create a feature branch
 * Submit a github pull request
 
-Many thanks to all contributors, especially [@andyw8](https://github.com/andyw8), who has contributed some great improvements.
-
-### Learn More
-
-* Browse the code or install the latest development version from [https://github.com/apiology/quality/tree](https://github.com/apiology/quality/tree)
+Many thanks to all contributors, especially [@andyw8](https://github.com/andyw8),
+who has contributed some great improvements.
 
 ## License
 

data/lib/quality/command_output_processor.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Quality
   # Class processes output from a code quality command, tweaking it
   # for editor output and counting the number of violations found

data/lib/quality/config.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # XXX: I should figure out how to use tagged releases in github.  Example:
 # https://github.com/xsc/lein-ancient/issues/29
 # https://github.com/xsc/lein-ancient/releases

data/lib/quality/directory_of_classes.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'active_support'
 require 'active_support/core_ext'
 

data/lib/quality/linguist_source_file_globber.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'rugged'
 require 'linguist'
 
@@ -118,9 +119,7 @@ module Quality
     end
 
     def real_files_of_type(file_type)
-      real_files_matching do |blob, _filename|
-        blob.language.to_s == file_type
-      end
+      real_files_matching { |blob, _filename| blob.language.to_s == file_type }
     end
 
     def markdown_files

data/lib/quality/process.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'English'
 
 module Quality

data/lib/quality/quality_checker.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'command_output_processor'
 require_relative 'process'
 require_relative 'ruby_spawn'
@@ -60,8 +61,10 @@ module Quality
     def check_exit_status(exit_status)
       return if @command_options[:gives_error_code_on_violations] ||
                 @command_options[:gives_error_code_on_no_relevant_code]
+      return unless exit_status.nonzero?
+
       raise("Error detected running #{full_cmd}.  " \
-            "Exit status is #{exit_status}") if exit_status.nonzero?
+            "Exit status is #{exit_status}")
     end
 
     MAX_VIOLATIONS = 9_999_999_999

data/lib/quality/rake/task.rb

@@ -1,4 +1,3 @@
-#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 # XXX: There's an underlying issue with bundler, and knowing my luck,
@@ -79,8 +78,10 @@ module Quality
       end
 
       def define
-        desc 'Verify quality has increased or stayed ' \
-             'the same' unless ::Rake.application.last_description
+        unless ::Rake.application.last_description
+          desc 'Verify quality has increased or stayed ' \
+               'the same'
+        end
         @dsl.define_task(quality_name) { @runner.run_quality }
         @dsl.define_task(ratchet_name) { @runner.run_ratchet }
         @runner.tools.each do |tool_name, tool_exe|

data/lib/quality/version.rb

@@ -4,5 +4,5 @@
 # reek, flog, flay and rubocop and makes sure your numbers don't get
 # any worse over time.
 module Quality
-  VERSION = '27.4.0'.freeze
+  VERSION = '28.0.0'.freeze
 end

data/quality.gemspec

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 # ; -*-Ruby-*-
 # -*- encoding: utf-8 -*-
+
 $LOAD_PATH.push File.join(File.dirname(__FILE__), 'lib')
 require 'quality/version'
 
@@ -31,20 +32,26 @@ Gem::Specification.new do |s|
   s.summary = 'Code quality tools for Ruby'
 
   s.add_runtime_dependency('activesupport')
-  s.add_runtime_dependency('github-linguist')
+  s.add_runtime_dependency('bundler-audit')
   s.add_runtime_dependency('cane', ['>= 2.6'])
-  s.add_runtime_dependency('reek', ['>= 1.3.4'])
   s.add_runtime_dependency('flog', ['>= 4.1.1'])
-  s.add_runtime_dependency('bundler-audit')
+  s.add_runtime_dependency('github-linguist')
+  s.add_runtime_dependency('reek', ['>= 1.3.4'])
   # flay 2.6.0 contained a command-line-parsing issue
   s.add_runtime_dependency('flay', ['>= 2.4', '!= 2.6.0'])
-  s.add_runtime_dependency('rubocop')
+  #
+  # per version advice here - locks quality gem version with rubocop
+  # version to avoid unexplained metric-changing surprises:
+  #
+  # https://github.com/bbatsov/rubocop#installation
   s.add_runtime_dependency('mdl')
-  s.add_runtime_dependency('rubocop-rspec')
+  s.add_runtime_dependency('rubocop', '~> 0.51.0')
+  # 1.19.0 was a RuboCop 0.51.0 compatibility release
   s.add_runtime_dependency('bigfiles', ['>= 0.1'])
-  s.add_runtime_dependency('punchlist', ['>= 1.1'])
   s.add_runtime_dependency('brakeman')
+  s.add_runtime_dependency('punchlist', ['>= 1.1'])
   s.add_runtime_dependency('rails_best_practices')
+  s.add_runtime_dependency('rubocop-rspec', ['>=1.19.0'])
 
   # need above 3.2.2 to support Ruby 2.0 syntax
   #
@@ -57,8 +64,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency('bundler', ['>= 1.1'])
   # Workaround for
   # https://github.com/bundler/bundler/issues/3401
+  s.add_development_dependency('minitest', ['~> 5'])
+  s.add_development_dependency('mocha')
   s.add_development_dependency('rake', ['!= 10.4.2'])
   s.add_development_dependency('simplecov')
-  s.add_development_dependency('mocha')
-  s.add_development_dependency('minitest', ['~> 5'])
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quality
 version: !ruby/object:Gem::Version
-  version: 27.4.0
+  version: 28.0.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-16 00:00:00.000000000 Z
+date: 2017-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: github-linguist
+  name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,47 +53,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.6'
 - !ruby/object:Gem::Dependency
-  name: reek
+  name: flog
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.4
+        version: 4.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.4
+        version: 4.1.1
 - !ruby/object:Gem::Dependency
-  name: flog
+  name: github-linguist
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler-audit
+  name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.4
 - !ruby/object:Gem::Dependency
   name: flay
   requirement: !ruby/object:Gem::Requirement
@@ -115,7 +115,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.6.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: mdl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -129,47 +129,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mdl
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.51.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.51.0
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: bigfiles
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: bigfiles
+  name: brakeman
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: punchlist
   requirement: !ruby/object:Gem::Requirement
@@ -185,7 +185,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: brakeman
+  name: rails_best_practices
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -199,19 +199,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails_best_practices
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.19.0
 - !ruby/object:Gem::Dependency
   name: ruby_parser
   requirement: !ruby/object:Gem::Requirement
@@ -261,21 +261,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "!="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "!="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: '5'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -289,33 +289,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "!="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "!="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.4.2
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
 description: Quality is a tool that runs quality checks on your code using community
   tools, and makes sure your numbers don't get any worse over time. Just add 'rake
   quality' as part of your Continuous Integration
@@ -325,7 +325,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE.txt
+- License.txt
 - README.md
 - lib/quality/command_output_processor.rb
 - lib/quality/config.rb
@@ -376,7 +376,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Code quality tools for Ruby