quality 20.1.0 → 20.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48fd511b69278d258fd696ea0c4b4982bc434b34
-  data.tar.gz: ca2ac68857a3ae36ac3a4cb6dcaec43dac938558
+  metadata.gz: 00e2023f6cecd2f6706b0a7260112d8fe713a510
+  data.tar.gz: 5f0d6b1824039886ddc6f08a619a33cd0926df00
 SHA512:
-  metadata.gz: e7e5ffa954d1e5f559544a1162b2456b44ee462b7eecee3bafa7a3a5d2b349565ee7e14a6a1e8d46a591f2b031f754041a5f40898140fbb6d8ca5a8acff32bac
-  data.tar.gz: e5f214a7e572147a99fd44b7343c5c16da3227b091bfe556ff55fe41f568d3a921eb5f75ded8936b3f774ea9dec8e01d10af8c7b5be27801b8e19104e593240f
+  metadata.gz: 8e39a1ea2afb06be8f312dd584c926eac633cfb25e55f00610efd25fafff3bf9a41ce7394c7b7d89c8ea092e0b4f0fcaf98fbb2d69753d6ca604abf4ae7dabe4
+  data.tar.gz: b0af83671b719e431579f93f8630ada3ec021dcc65f7e099c94aac8e56d96fce3e96ea3079609b119cc1e7e7c2c58eb5b2e61ad9f9416195070f14aa5c348fff

data/README.md

@@ -14,7 +14,22 @@ worse over time.
 
 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.
 
-##How to use
+## How to use - using Docker
+
+These basic steps assume you have a working Docker installation.
+
+```
+docker run -v `pwd`:/usr/app apiology/quality
+```
+
+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
+```
+
+
+## How to use - as part of a Ruby-based Rakefile
 
 ```bash
 $ gem install quality

data/lib/quality/config.rb

@@ -77,7 +77,7 @@ module Quality
 
     def initialize(quality_name: 'quality',
                    ratchet_name: 'ratchet',
-                   globber: fail)
+                   globber: raise)
       @quality_name = quality_name
       @ratchet_name = ratchet_name
       @skip_tools = []

data/lib/quality/directory_of_classes.rb

@@ -0,0 +1,44 @@
+require 'active_support'
+require 'active_support/core_ext'
+
+# Represents a source directory full of classe - e.g.,
+# lib/vincelifedaily/checks/*
+class DirectoryOfClasses
+  attr_reader :dir, :module_name
+
+  def initialize(dir: raise, class_suffix: '', module_name: '')
+    @dir = dir
+    @class_suffix = class_suffix
+    @module_name = module_name
+  end
+
+  def filenames
+    Dir.glob("#{dir}/**.rb").sort
+  end
+
+  def basenames
+    filenames.map { |filename| File.basename(filename) }
+  end
+
+  def basenames_without_extension
+    filenames.map { |filename| File.basename(filename, '.*') }
+  end
+
+  def require_classes
+    basenames.each do |basename|
+      path = "#{dir}/#{basename}"
+      require_relative path
+    end
+  end
+
+  def symbols_and_classes
+    @symbols_and_classes ||= filenames.map do |filename|
+      basename = File.basename(filename, '.rb')
+
+      class_name = "#{module_name}::#{basename.camelize}#{@class_suffix}"
+      clazz = class_name.constantize
+      symbol = basename.to_sym
+      [symbol, clazz]
+    end
+  end
+end

data/lib/quality/quality_checker.rb

@@ -55,8 +55,8 @@ 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]
-      fail("Error detected running #{full_cmd}.  " \
-           "Exit status is #{exit_status}") if exit_status != 0
+      raise("Error detected running #{full_cmd}.  " \
+            "Exit status is #{exit_status}") if exit_status.nonzero?
     end
 
     def existing_violations
@@ -71,9 +71,9 @@ module Quality
       existing = existing_violations
       report_violations(existing)
       if @violations > existing
-        fail("Output from #{@cmd}\n\n#{@command_output}\n\n" \
-             "Reduce total number of #{@cmd} violations " \
-             "to #{existing} or below!")
+        raise("Output from #{@cmd}\n\n#{@command_output}\n\n" \
+              "Reduce total number of #{@cmd} violations " \
+              "to #{existing} or below!")
       elsif @violations < existing
         puts 'Ratcheting quality up...'
         write_violations(@violations)
@@ -85,8 +85,6 @@ module Quality
       puts "Found #{@violations} #{@cmd} violations"
     end
 
-    private
-
     def full_cmd
       args = @command_options[:args] || ''
       @found_output = false

data/lib/quality/ruby_spawn.rb

@@ -7,10 +7,10 @@ module Quality
     end
 
     def invocation
-      if @args.size > 0
+      if !@args.empty?
         "#{cmd_with_ruby_hack_prefix} #{@args}"
       else
-        "#{cmd_with_ruby_hack_prefix}"
+        cmd_with_ruby_hack_prefix.to_s
       end
     end
 

data/lib/quality/runner.rb

@@ -1,35 +1,19 @@
 require 'active_support/inflector'
 require 'forwardable'
 require_relative 'which'
-require_relative 'tools/cane'
-require_relative 'tools/flay'
-require_relative 'tools/flog'
-require_relative 'tools/reek'
-require_relative 'tools/rubocop'
-require_relative 'tools/bigfiles'
-require_relative 'tools/pep8'
-require_relative 'tools/punchlist'
-require_relative 'tools/brakeman'
-require_relative 'tools/rails_best_practices'
-require_relative 'tools/eslint'
-require_relative 'tools/jscs'
+require_relative 'directory_of_classes'
 
 module Quality
+  current_dir = File.dirname(File.expand_path(__FILE__))
+  TOOL_CLASSES = DirectoryOfClasses.new(dir: "#{current_dir}/tools",
+                                        module_name: 'Quality::Tools')
+  ALL_TOOLS = TOOL_CLASSES.basenames_without_extension
+  TOOL_CLASSES.require_classes
+
   # Knows how to run different quality tools based on a configuration
   # already determined.
   class Runner
-    include Tools::Cane
-    include Tools::Flay
-    include Tools::Flog
-    include Tools::Reek
-    include Tools::Rubocop
-    include Tools::Bigfiles
-    include Tools::Pep8
-    include Tools::Punchlist
-    include Tools::Brakeman
-    include Tools::RailsBestPractices
-    include Tools::Eslint
-    include Tools::Jscs
+    TOOL_CLASSES.symbols_and_classes.each { |_symbol, clazz| include clazz }
 
     extend ::Forwardable
 
@@ -84,7 +68,7 @@ module Quality
 
     def count_existing_violations(filename)
       existing_violations = @count_io.read(filename).to_i
-      fail("Problem with file #{filename}") if existing_violations < 0
+      raise("Problem with file #{filename}") if existing_violations < 0
       existing_violations
     end
 

data/lib/quality/tools/bigfiles.rb

@@ -6,7 +6,7 @@ module Quality
 
       def bigfiles_args
         args = ['--glob', "'#{source_files_glob}'"]
-        if exclude_files.size > 0
+        if !exclude_files.empty?
           args << ['--exclude-glob', "'#{source_files_exclude_glob}'"]
         end
         args.join(' ')

data/lib/quality/tools/bundler_audit.rb

@@ -0,0 +1,18 @@
+module Quality
+  module Tools
+    # Adds 'bundler_audit' tool support to quality gem
+    module BundlerAudit
+      private
+
+      def quality_bundler_audit
+        ratchet_quality_cmd('bundle-audit', args: '') do |line|
+          if line =~ /^Name: /
+            1
+          else
+            0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/quality/tools/cane.rb

@@ -16,7 +16,7 @@ module Quality
         args = [
           "-f '#{ruby_files_glob}'",
         ]
-        args += cane_exclude_args if exclude_files.size > 0
+        args += cane_exclude_args if !exclude_files.empty?
         args.join(' ')
       end
 

data/lib/quality/tools/flog.rb

@@ -2,6 +2,10 @@ module Quality
   module Tools
     # Adds 'flog' tool support to quality gem
     module Flog
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
       private
 
       def quality_flog
@@ -11,10 +15,6 @@ module Quality
         end
       end
 
-      def self.included(base)
-        base.extend ClassMethods
-      end
-
       # See Flog.included
       module ClassMethods
         def count_violations_in_flog_output(line, threshold = 50)

data/lib/quality/tools/punchlist.rb

@@ -7,7 +7,7 @@ module Quality
       def punchlist_args
         glob = "--glob '#{source_and_doc_files_glob}'"
         regexp = " --regexp '#{punchlist_regexp}'" if punchlist_regexp
-        if exclude_files.size > 0
+        if !exclude_files.empty?
           exclude = " --exclude-glob '#{source_files_exclude_glob}'"
         end
 

data/lib/quality/tools/rails_best_practices.rb

@@ -2,6 +2,10 @@ module Quality
   module Tools
     # Adds 'rubocop' tool support to quality gem
     module RailsBestPractices
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
       private
 
       def quality_rails_best_practices
@@ -11,10 +15,6 @@ module Quality
         end
       end
 
-      def self.included(base)
-        base.extend ClassMethods
-      end
-
       # See Rubocop.included
       module ClassMethods
         def count_rails_best_practices_violations(line)

data/lib/quality/tools/reek.rb

@@ -2,6 +2,10 @@ module Quality
   module Tools
     # Adds 'reek' tool support to quality gem
     module Reek
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
       private
 
       def quality_reek
@@ -14,10 +18,6 @@ module Quality
         end
       end
 
-      def self.included(base)
-        base.extend ClassMethods
-      end
-
       # See Reek.included
       module ClassMethods
         def count_reek_violations(line)

data/lib/quality/tools/rubocop.rb

@@ -2,6 +2,10 @@ module Quality
   module Tools
     # Adds 'rubocop' tool support to quality gem
     module Rubocop
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
       private
 
       def rubocop_args
@@ -16,10 +20,6 @@ module Quality
         end
       end
 
-      def self.included(base)
-        base.extend ClassMethods
-      end
-
       # See Rubocop.included
       module ClassMethods
         def count_rubocop_violations(line)

data/lib/quality/version.rb

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

data/quality.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |s|
   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')
   # 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')
@@ -42,6 +43,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('punchlist', ['>= 1.1'])
   s.add_runtime_dependency('brakeman')
   s.add_runtime_dependency('rails_best_practices')
+  s.add_runtime_dependency('bigdecimal')
 
   # need above 3.2.2 to support Ruby 2.0 syntax
   #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quality
 version: !ruby/object:Gem::Version
-  version: 20.1.0
+  version: 20.1.1
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-19 00:00:00.000000000 Z
+date: 2016-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.1
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: flay
   requirement: !ruby/object:Gem::Requirement
@@ -184,6 +198,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby_parser
   requirement: !ruby/object:Gem::Requirement
@@ -297,10 +325,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE.txt
+- License.txt
 - README.md
 - lib/quality/command_output_processor.rb
 - lib/quality/config.rb
+- lib/quality/directory_of_classes.rb
 - lib/quality/process.rb
 - lib/quality/quality_checker.rb
 - lib/quality/rake/task.rb
@@ -308,6 +337,7 @@ files:
 - lib/quality/runner.rb
 - lib/quality/tools/bigfiles.rb
 - lib/quality/tools/brakeman.rb
+- lib/quality/tools/bundler_audit.rb
 - lib/quality/tools/cane.rb
 - lib/quality/tools/eslint.rb
 - lib/quality/tools/flay.rb