quality 32.1.1 → 33.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97fb1d516d0fa1f9ac832b8e0f182c657859aacd
-  data.tar.gz: c7f2a0b8dba7bf0e542c673d0c4d2f74516505e2
+  metadata.gz: 10dac3c7d14e1b7bd6b80d0be27a38a866bd530f
+  data.tar.gz: ff3db34f37978b984cbc11a8e2926e560772c308
 SHA512:
-  metadata.gz: 55cd00ea83680403565c7c502bb6ef292bd57d68f8e0c6ec8662cc71c367a5fa3d89b35f3029910608422bd784e2acf2f5ad44bb6a1c1456913907a762acd72f
-  data.tar.gz: d65a2514278daa066bb463c56831b9a63b89729650d4f70d575d9efde0a07287ebbd01ba69b70afdaccc127030827f35657afae616bd5684985cf606cd8a1aa1
+  metadata.gz: 259852863887d7f1c648b5a0a39e1298fa14815eef88fe2af0cdece1570ac135c3ef7da09f65d654d487cbb0dd671bd18fedd679c50218b8c6679b2ea6e72f17
+  data.tar.gz: 30f27ce1ae72211730beff23b102af4d659c05b888a4eb3719eb6a015fe8457ef540181d40708b38784534d04d62a4d998576b82abd6746a20b981991896ea10

data/README.md

@@ -41,8 +41,8 @@ See [DOCKER.md](DOCKER.md) for info.
 ## How to use - as part of a Ruby-based Rakefile
 
 ```bash
-pip install 'pycodestyle<2.4.0' flake8
-brew install cmake icu4c shellcheck scalastyle # OS X
+pip install flake8
+brew install cmake icu4c shellcheck scalastyle # macOS
 gem install quality
 ```
 

data/lib/quality/runner.rb

@@ -4,6 +4,7 @@ require 'active_support/inflector'
 require 'forwardable'
 require_relative 'which'
 require_relative 'directory_of_classes'
+require_relative 'tool'
 
 # Quality is a tool that runs quality checks on Ruby code using cane,
 # reek, flog, flay and rubocop and makes sure your numbers don't get
@@ -18,8 +19,6 @@ module Quality
   # Knows how to run different quality tools based on a configuration
   # already determined.
   class Runner
-    TOOL_CLASSES.symbols_and_classes.each { |_symbol, clazz| include clazz }
-
     extend ::Forwardable
 
     def initialize(config, gem_spec: Gem::Specification,
@@ -36,18 +35,18 @@ module Quality
     end
 
     def run_quality
-      tools.each do |tool_name, tool_exe|
-        run_quality_with_tool(tool_name, tool_exe)
+      tools.each do |tool_name, tool_exe, clazz|
+        run_quality_with_tool(tool_name, tool_exe, clazz)
       end
     end
 
-    def run_quality_with_tool(tool_name, tool_exe)
+    def run_quality_with_tool(tool_name, tool_exe, clazz)
       suppressed = @config.skip_tools.include? tool_name
       installed = @gem_spec.find_all_by_name(tool_name).any? ||
                   !@which.which(tool_exe).nil?
 
       if installed && !suppressed
-        method("quality_#{tool_name}".to_sym).call
+        clazz.new(self).method("quality_#{tool_name}".to_sym).call
       elsif !installed
         puts "#{tool_name} not installed"
       end
@@ -73,23 +72,25 @@ module Quality
     def count_existing_violations(filename)
       existing_violations = @count_io.read(filename).to_i
       raise("Problem with file #{filename}") if existing_violations < 0
+
       existing_violations
     end
 
-    def command_name(ancestor, name)
-      if ancestor.respond_to? :command_name
-        ancestor.command_name
+    def command_name(clazz, name)
+      if clazz.respond_to? :command_name
+        clazz.command_name
       else
         name
       end
     end
 
     def tools
-      self.class.ancestors.map do |ancestor|
-        ancestor_name = ancestor.to_s
-        next unless ancestor_name.start_with?('Quality::Tools::')
-        name = ancestor.to_s.split('::').last.underscore
-        [name, command_name(ancestor, name)]
+      TOOL_CLASSES.symbols_and_classes.map do |_symbol, clazz|
+        clazz_name = clazz.to_s
+        raise unless clazz_name.start_with?('Quality::Tools::')
+
+        name = clazz_name.split('::').last.underscore
+        [name, command_name(clazz, name), clazz]
       end.compact
     end
 

data/lib/quality/tool.rb

@@ -0,0 +1,27 @@
+module Quality
+  module Tools
+    # represents a code quality tool which can be run on source files
+    class Tool
+      extend ::Forwardable
+
+      def initialize(runner)
+        @runner = runner
+      end
+
+      def_delegators(:@runner,
+                     :source_and_doc_files_glob,
+                     :source_files_exclude_glob,
+                     :ratchet_quality_cmd,
+                     :js_files,
+                     :python_files,
+                     :ruby_files,
+                     :exclude_files,
+                     :markdown_files,
+                     :punchlist_regexp,
+                     :scalastyle_config,
+                     :scalastyle_exclude,
+                     :scala_files,
+                     :shell_files)
+    end
+  end
+end

data/lib/quality/tools/bigfiles.rb

@@ -3,9 +3,7 @@
 module Quality
   module Tools
     # Adds 'bigfiles' tool support to quality gem
-    module Bigfiles
-      private
-
+    class Bigfiles < Tool
       def bigfiles_args
         args = ['--glob', "'#{source_and_doc_files_glob}'"]
         unless source_files_exclude_glob == '{}'

data/lib/quality/tools/brakeman.rb

@@ -3,9 +3,7 @@
 module Quality
   module Tools
     # Adds 'rubocop' tool support to quality gem
-    module Brakeman
-      private
-
+    class Brakeman < Tool
       def quality_brakeman
         ratchet_quality_cmd('brakeman',
                             args: '-q --summary -f csv 2>/dev/null',

data/lib/quality/tools/bundle_audit.rb

@@ -3,13 +3,11 @@
 module Quality
   module Tools
     # Adds 'bundler_audit' tool support to quality gem
-    module BundleAudit
+    class BundleAudit < Tool
       def self.command_name
         'bundle-audit'
       end
 
-      private
-
       def quality_bundle_audit
         ratchet_quality_cmd('bundle-audit',
                             args: '',

data/lib/quality/tools/cane.rb

@@ -3,9 +3,7 @@
 module Quality
   module Tools
     # Adds 'cane' tool support to quality gem
-    module Cane
-      private
-
+    class Cane < Tool
       def cane_exclude_args
         [
           "--abc-exclude '#{source_files_exclude_glob}'",

data/lib/quality/tools/eslint.rb

@@ -3,9 +3,7 @@
 module Quality
   module Tools
     # Adds 'bigfiles' tool support to quality gem
-    module Eslint
-      private
-
+    class Eslint < Tool
       def eslint_args
         '-f unix ' + js_files.join(' ')
       end

data/lib/quality/tools/flake8.rb

@@ -3,9 +3,7 @@
 module Quality
   module Tools
     # Adds 'flake8' tool support to quality gem
-    module Flake8
-      private
-
+    class Flake8 < Tool
       def flake8_args
         python_files.join(' ')
       end

data/lib/quality/tools/flay.rb

@@ -3,9 +3,7 @@
 module Quality
   module Tools
     # Adds 'flay' tool support to quality gem
-    module Flay
-      private
-
+    class Flay < Tool
       def flay_args
         "--mass 75 --timeout 99999 #{ruby_files.join(' ')}"
       end

data/lib/quality/tools/flog.rb

@@ -3,13 +3,7 @@
 module Quality
   module Tools
     # Adds 'flog' tool support to quality gem
-    module Flog
-      def self.included(base)
-        base.extend ClassMethods
-      end
-
-      private
-
+    class Flog < Tool
       def quality_flog
         args = "--all --continue --methods-only #{ruby_files.join(' ')}"
         ratchet_quality_cmd('flog', args: args, emacs_format: true) do |line|
@@ -17,19 +11,16 @@ module Quality
         end
       end
 
-      # See Flog.included
-      module ClassMethods
-        def count_violations_in_flog_output(line, threshold = 50)
-          return 0 if line =~ /^ *([0-9.]*): flog total$/
+      def self.count_violations_in_flog_output(line, threshold = 50)
+        return 0 if line =~ /^ *([0-9.]*): flog total$/
 
-          return 0 unless line =~ /^ *([0-9.]*): (.*) .*.rb:[0-9]*$/
+        return 0 unless line =~ /^ *([0-9.]*): (.*) .*.rb:[0-9]*$/
 
-          score = Regexp.last_match[1].to_i
+        score = Regexp.last_match[1].to_i
 
-          return 1 if score > threshold
+        return 1 if score > threshold
 
-          0
-        end
+        0
       end
     end
   end

data/lib/quality/tools/jscs.rb

@@ -3,9 +3,7 @@
 module Quality
   module Tools
     # Adds 'bigfiles' tool support to quality gem
-    module Jscs
-      private
-
+    class Jscs < Tool
       def jscs_args
         '-r unix ' + js_files.join(' ')
       end

data/lib/quality/tools/mdl.rb

@@ -3,9 +3,7 @@
 module Quality
   module Tools
     # Adds 'bigfiles' tool support to quality gem
-    module Mdl
-      private
-
+    class Mdl < Tool
       def mdl_args
         markdown_files.join(' ')
       end

data/lib/quality/tools/punchlist.rb

@@ -3,9 +3,7 @@
 module Quality
   module Tools
     # Adds 'punchlist' tool support to quality gem
-    module Punchlist
-      private
-
+    class Punchlist < Tool
       def punchlist_args
         glob = "--glob '#{source_and_doc_files_glob}'"
         regexp = " --regexp '#{punchlist_regexp}'" if punchlist_regexp

data/lib/quality/tools/pycodestyle.rb

@@ -3,9 +3,7 @@
 module Quality
   module Tools
     # Adds 'pycodestyle' tool support to quality gem
-    module Pycodestyle
-      private
-
+    class Pycodestyle < Tool
       def pycodestyle_args
         python_files.join(' ')
       end

data/lib/quality/tools/rails_best_practices.rb

@@ -3,13 +3,7 @@
 module Quality
   module Tools
     # Adds 'rubocop' tool support to quality gem
-    module RailsBestPractices
-      def self.included(base)
-        base.extend ClassMethods
-      end
-
-      private
-
+    class RailsBestPractices < Tool
       def quality_rails_best_practices
         ratchet_quality_cmd('rails_best_practices',
                             gives_error_code_on_violations: true) do |line|
@@ -18,13 +12,11 @@ module Quality
       end
 
       # See Rubocop.included
-      module ClassMethods
-        def count_rails_best_practices_violations(line)
-          if line =~ /.*:[0-9]* - /
-            1
-          else
-            0
-          end
+      def self.count_rails_best_practices_violations(line)
+        if line =~ /.*:[0-9]* - /
+          1
+        else
+          0
         end
       end
     end

data/lib/quality/tools/reek.rb

@@ -3,13 +3,7 @@
 module Quality
   module Tools
     # Adds 'reek' tool support to quality gem
-    module Reek
-      def self.included(base)
-        base.extend ClassMethods
-      end
-
-      private
-
+    class Reek < Tool
       def quality_reek
         args = "--single-line #{ruby_files.join(' ')}"
         ratchet_quality_cmd('reek',
@@ -20,14 +14,11 @@ module Quality
         end
       end
 
-      # See Reek.included
-      module ClassMethods
-        def count_reek_violations(line)
-          if line =~ /^  .* (.*)$/
-            1
-          else
-            0
-          end
+      def self.count_reek_violations(line)
+        if line =~ /^  .* (.*)$/
+          1
+        else
+          0
         end
       end
     end

data/lib/quality/tools/rubocop.rb

@@ -3,13 +3,7 @@
 module Quality
   module Tools
     # Adds 'rubocop' tool support to quality gem
-    module Rubocop
-      def self.included(base)
-        base.extend ClassMethods
-      end
-
-      private
-
+    class Rubocop < Tool
       def rubocop_args
         [
           '--force-exclusion',
@@ -27,17 +21,14 @@ module Quality
         end
       end
 
-      # See Rubocop.included
-      module ClassMethods
-        def count_rubocop_violations(line)
-          if line =~ /^.* file[s|] inspected, (.*) offence[s|] detected$/
-            0
-          elsif line =~ /^warning: .*/
-            # don't count internal rubocop errors/warnings
-            0
-          else
-            1
-          end
+      def self.count_rubocop_violations(line)
+        if line =~ /^.* file[s|] inspected, (.*) offence[s|] detected$/
+          0
+        elsif line =~ /^warning: .*/
+          # don't count internal rubocop errors/warnings
+          0
+        else
+          1
         end
       end
     end

data/lib/quality/tools/scalastyle.rb

@@ -3,9 +3,7 @@
 module Quality
   module Tools
     # Adds 'scalastyle' tool support to quality gem
-    module Scalastyle
-      private
-
+    class Scalastyle < Tool
       def scalastyle_args
         c = " -c '#{scalastyle_config}' " if scalastyle_config
         x = " -x '#{scalastyle_exclude}' " if scalastyle_exclude

data/lib/quality/tools/shellcheck.rb

@@ -3,9 +3,7 @@
 module Quality
   module Tools
     # Adds 'ShellCheck' tool support to quality gem
-    module Shellcheck
-      private
-
+    class Shellcheck < Tool
       def shellcheck_args
         "-fgcc -sbash #{shell_files.join(' ')}"
       end

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 = '32.1.1'.freeze
+  VERSION = '33.0.0'.freeze
 end

data/quality.gemspec

@@ -48,7 +48,7 @@ Gem::Specification.new do |s|
   #
   # https://github.com/bbatsov/rubocop#installation
   s.add_runtime_dependency('mdl')
-  s.add_runtime_dependency('rubocop', '~> 0.58.2')
+  s.add_runtime_dependency('rubocop', '~> 0.60.0')
   # 1.19.0 was a RuboCop 0.51.0 compatibility release
   s.add_runtime_dependency('bigfiles', ['>= 0.1'])
   s.add_runtime_dependency('brakeman')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quality
 version: !ruby/object:Gem::Version
-  version: 32.1.1
+  version: 33.0.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-19 00:00:00.000000000 Z
+date: 2018-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -148,14 +148,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.58.2
+        version: 0.60.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.58.2
+        version: 0.60.0
 - !ruby/object:Gem::Dependency
   name: bigfiles
   requirement: !ruby/object:Gem::Requirement
@@ -392,6 +392,7 @@ files:
 - lib/quality/rake/task.rb
 - lib/quality/ruby_spawn.rb
 - lib/quality/runner.rb
+- lib/quality/tool.rb
 - lib/quality/tools/bigfiles.rb
 - lib/quality/tools/brakeman.rb
 - lib/quality/tools/bundle_audit.rb