quality 14.0.0 → 14.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1005c04aae87d441e5a4206c4c4e7771d0e0a354
-  data.tar.gz: ce749018195f340fb7e80b77bbb1b4ea807bc10e
+  metadata.gz: ff756ce9314546a2c59c80a36050ce9c66b4e6fc
+  data.tar.gz: bd98a9ea95e2e15e5e9ada6f7f88d3f33e7bb7ea
 SHA512:
-  metadata.gz: a2807707cd4a03836f3deadd69ba4fcb59bc48ef4bf092744a71385a8a0fe8f2958754a807002463927e737d7a06c93d361237408f4102f27d6dfcc42eb90a90
-  data.tar.gz: 79636bb7472afcc74b819a78ed829b1f7b010429c297b80c77f84bc2a70d9e14a8ce4399d998e1eaaf25a1ee4a69afa1091bd2d0bbf723109202257864d433db
+  metadata.gz: fbcd9d84b68a47dabffa94adf2f2f1ef9e303d2e0c9b4f7c50d6d95881dac53b11fb8c86d1dd09a397b6fc655d4e560d99470c1f936324f23aeaab76a5a3b8eb
+  data.tar.gz: ac1efb5bb1eca658ee7c6f648a977d2a822b37a13de59ae88d2e39598be1a1490596d495b917e0ceda436d030bd5069bd365d26552fa9a252fe416198cbd8c3b

data/README.md

@@ -94,6 +94,9 @@ Quality::Rake::Task.new { |t|
   # extensions--defaults to %w(Rakefile)
   t.extra_ruby_files = ['Rakefile']
 
+  # Exclude the specified list of files--defaults to []
+  t.exclude_files = ['lib/whatever/imported_file.rb', 'lib/vendor/someone_else_fault.rb']
+
   # Extensions for Ruby language files--defaults to 'rb,rake'
   t.ruby_file_extensions = 'rb,rake'
 

data/lib/quality/config.rb

@@ -0,0 +1,48 @@
+# 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
+
+require 'source_finder/source_file_globber'
+
+module Quality
+  # Configuration for running quality tool
+  class Config
+    attr_accessor :skip_tools, :verbose, :quality_name, :ratchet_name,
+                  :output_dir, :punchlist_regexp
+
+    extend Forwardable
+
+    def_delegators(:source_file_globber,
+                   :ruby_dirs=, :ruby_dirs,
+                   :source_dirs=, :source_dirs,
+                   :extra_files=, :extra_files,
+                   :exclude_files=, :exclude_files,
+                   :extra_ruby_files=, :extra_ruby_files,
+                   :ruby_file_extensions=, :ruby_file_extensions,
+                   :source_file_extensions=, :source_file_extensions,
+                   :source_files_glob,
+                   :source_files_exclude_glob,
+                   :ruby_files_glob,
+                   :ruby_files)
+
+    def source_file_globber
+      @source_file_globber ||=
+        SourceFinder::SourceFileGlobber.new(globber: @globber)
+    end
+
+    def all_output_files
+      @globber.glob("#{output_dir}/*_high_water_mark")
+    end
+
+    def initialize(quality_name: 'quality',
+                   ratchet_name: 'ratchet',
+                   globber: fail)
+      @quality_name = quality_name
+      @ratchet_name = ratchet_name
+      @skip_tools = []
+      @output_dir = 'metrics'
+      @verbose = false
+      @globber = globber
+    end
+  end
+end

data/lib/quality/rake/task.rb

@@ -18,7 +18,7 @@ require 'rake/tasklib'
 require 'rbconfig'
 require_relative '../runner'
 require_relative '../quality_checker'
-require_relative 'config'
+require_relative '../config'
 
 module Quality
   #

data/lib/quality/runner.rb

@@ -96,6 +96,6 @@ module Quality
     end
 
     def_delegators :@config, :ruby_files, :ruby_files_glob, :source_files_glob,
-                   :punchlist_regexp
+                   :punchlist_regexp, :source_files_exclude_glob, :exclude_files
   end
 end

data/lib/quality/tools/bigfiles.rb

@@ -4,9 +4,17 @@ module Quality
     module BigFiles
       private
 
+      def bigfiles_args
+        args = ['--glob', "'#{source_files_glob}'"]
+        if exclude_files.size > 0
+          args << ['--exclude-glob', "'#{source_files_exclude_glob}'"]
+        end
+        args.join(' ')
+      end
+
       def quality_bigfiles
         ratchet_quality_cmd('bigfiles',
-                            args: "--glob '#{source_files_glob}'") do |line|
+                            args: bigfiles_args) do |line|
           line.split(':')[0].to_i
         end
       end

data/lib/quality/tools/brakeman.rb

@@ -7,9 +7,10 @@ module Quality
       def quality_brakeman
         ratchet_quality_cmd('brakeman',
                             args: '-q --summary -f csv 2>/dev/null',
-                            gives_error_code_on_no_relevant_code: true) do |line|
+                            gives_error_code_on_no_relevant_code:
+                              true) do |line|
           if line =~ /Security Warnings,([0-9]*) \([0-9]*\)$/
-            $1.to_i
+            Regexp.last_match[1].to_i
           else
             0
           end

data/lib/quality/tools/cane.rb

@@ -4,8 +4,20 @@ module Quality
     module Cane
       private
 
+      def cane_exclude_args
+        [
+          "--abc-exclude '#{source_files_exclude_glob}'",
+          "--style-exclude '#{source_files_exclude_glob}'",
+          "--doc-exclude '#{source_files_exclude_glob}'",
+        ]
+      end
+
       def cane_args
-        "-f '#{ruby_files_glob}'"
+        args = [
+          "-f '#{ruby_files_glob}'",
+        ]
+        args += cane_exclude_args if exclude_files.size > 0
+        args.join(' ')
       end
 
       def quality_cane

data/lib/quality/tools/flay.rb

@@ -4,11 +4,15 @@ module Quality
     module Flay
       private
 
+      def flay_args
+        "--mass 75 --timeout 99999 #{ruby_files.join(' ')}"
+      end
+
       def quality_flay
         ratchet_quality_cmd('flay',
-                            args: "--mass 75 --timeout 99999 #{ruby_files}",
+                            args: flay_args,
                             emacs_format: true) do |line|
-          if line =~ /^[0-9]*\).* \(mass = ([0-9]*)\)$/
+          if line =~ /^[0-9]*\).* \(mass.* = ([0-9]*)\)$/
             Regexp.last_match[1].to_i
           else
             0

data/lib/quality/tools/flog.rb

@@ -5,7 +5,7 @@ module Quality
       private
 
       def quality_flog
-        args = "--all --continue --methods-only #{ruby_files}"
+        args = "--all --continue --methods-only #{ruby_files.join(' ')}"
         ratchet_quality_cmd('flog', args: args, emacs_format: true) do |line|
           self.class.count_violations_in_flog_output(line)
         end

data/lib/quality/tools/punchlist.rb

@@ -7,9 +7,13 @@ module Quality
       def punchlist_args
         glob = "--glob '#{source_files_glob}'"
         regexp = " --regexp '#{punchlist_regexp}'" if punchlist_regexp
+        if exclude_files.size > 0
+          exclude = " --exclude-glob '#{source_files_exclude_glob}'"
+        end
 
         args = glob
         args += regexp if regexp
+        args += exclude if exclude
         args
       end
 

data/lib/quality/tools/reek.rb

@@ -5,7 +5,7 @@ module Quality
       private
 
       def quality_reek
-        args = "--single-line #{ruby_files}"
+        args = "--single-line #{ruby_files.join(' ')}"
         ratchet_quality_cmd('reek',
                             args: args,
                             emacs_format: true,

data/lib/quality/tools/rubocop.rb

@@ -4,10 +4,14 @@ module Quality
     module Rubocop
       private
 
+      def rubocop_args
+        "--format emacs #{ruby_files.join(' ')}"
+      end
+
       def quality_rubocop
         ratchet_quality_cmd('rubocop',
                             gives_error_code_on_violations: true,
-                            args: "--format emacs #{ruby_files}") do |line|
+                            args: rubocop_args) do |line|
           self.class.count_rubocop_violations(line)
         end
       end

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 = '14.0.0'
+  VERSION = '14.1.0'
 end

data/quality.gemspec

@@ -30,14 +30,15 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.6'
   s.summary = 'Code quality tools for Ruby'
 
+  s.add_runtime_dependency('source_finder')
   s.add_runtime_dependency('cane', ['>= 2.6'])
   s.add_runtime_dependency('reek', ['>= 1.3.4'])
   s.add_runtime_dependency('flog', ['>= 4.1.1'])
   # 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')
-  s.add_runtime_dependency('bigfiles')
-  s.add_runtime_dependency('punchlist')
+  s.add_runtime_dependency('bigfiles', ['>= 0.1'])
+  s.add_runtime_dependency('punchlist', ['>= 1.1'])
   s.add_runtime_dependency('brakeman')
 
   # need above 3.2.2 to support Ruby 2.0 syntax

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: quality
 version: !ruby/object:Gem::Version
-  version: 14.0.0
+  version: 14.1.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-02 00:00:00.000000000 Z
+date: 2015-09-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: source_finder
+  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: cane
   requirement: !ruby/object:Gem::Requirement
@@ -92,28 +106,28 @@ dependencies:
     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: punchlist
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: brakeman
   requirement: !ruby/object:Gem::Requirement
@@ -245,9 +259,9 @@ files:
 - README.md
 - Rakefile
 - lib/quality/command_output_processor.rb
+- lib/quality/config.rb
 - lib/quality/process.rb
 - lib/quality/quality_checker.rb
-- lib/quality/rake/config.rb
 - lib/quality/rake/task.rb
 - lib/quality/ruby_spawn.rb
 - lib/quality/runner.rb

data/lib/quality/rake/config.rb

@@ -1,76 +0,0 @@
-# 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
-
-# XXX: This should be moved out of rake directory
-module Quality
-  # Configuration for running quality tool
-  class Config
-    # See README.md for documentation on these configuration parameters.
-
-    attr_accessor :quality_name, :ratchet_name, :skip_tools, :verbose,
-                  :ruby_dirs, :source_dirs, :extra_files, :extra_ruby_files,
-                  :ruby_file_extensions, :source_file_extensions,
-                  :punchlist_regexp, :output_dir
-
-    def ruby_dirs
-      @ruby_dirs ||= %w(src app lib test spec feature)
-    end
-
-    def source_dirs
-      @source_dirs ||= ruby_dirs.clone
-    end
-
-    def extra_files
-      @extra_files ||= extra_ruby_files.clone.concat(%w(Dockerfile))
-    end
-
-    def extra_ruby_files
-      @extra_ruby_files ||= %w(Rakefile)
-    end
-
-    def source_file_extensions
-      @source_file_extensions ||=
-        "#{ruby_file_extensions},swift,cpp,c,java,py,clj,cljs,scala,js," \
-        'yml,sh,json'
-    end
-
-    def source_files_glob(extra_source_files = extra_files,
-                          dirs = source_dirs,
-                          extensions = source_file_extensions)
-      "{#{extra_source_files.join(',')}," \
-        "{*,.*}.{#{extensions}}," +
-        File.join("{#{dirs.join(',')}}",
-                  '**',
-                  "{*,.*}.{#{extensions}}") +
-        '}'
-    end
-
-    def ruby_file_extensions
-      @ruby_file_extensions ||= 'rb,rake,gemspec'
-    end
-
-    def ruby_files_glob
-      source_files_glob(extra_ruby_files, ruby_dirs, ruby_file_extensions)
-    end
-
-    def ruby_files
-      @globber.glob(ruby_files_glob).join(' ')
-    end
-
-    def all_output_files
-      @globber.glob("#{output_dir}/*_high_water_mark")
-    end
-
-    def initialize(quality_name: 'quality',
-                   ratchet_name: 'ratchet',
-                   globber: fail)
-      @quality_name = quality_name
-      @ratchet_name = ratchet_name
-      @skip_tools = []
-      @output_dir = 'metrics'
-      @verbose = false
-      @globber = globber
-    end
-  end
-end