quality 4.0.2 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc9ac9a66a049701f688e34860794a3b50eead97
-  data.tar.gz: 981585327da8999e4b97d155825ea206a7b7b895
+  metadata.gz: 3cfeb910fecf24038686535a2e904d6703149134
+  data.tar.gz: 9c2dc4563465bddb667151c887c9037c3659d522
 SHA512:
-  metadata.gz: 154994861e087e231e8366b322e83298a79625a802ffa9cb631a8666a8a48521f87109f7dda86105c6f42aa03b4cc283d1d4cc75bba0b96772ada877fcff825f
-  data.tar.gz: 1a21d689dc0277680d2bd96f75ab28b099a2eaad245caee143f9d88632d71e36b4b1fc50e701043bf462e00e59a87bb4f3a61005370114bc3d848f44fc4a14b8
+  metadata.gz: 6ffc41976904af90fd21b40aa104814e83e2672f7514d85dfc225a0e5a5ef11ca224b2f7e9422f97435095cb07f61a040652cb64dc0ef71e9722b2e42758b785
+  data.tar.gz: c66f3f646781f5aa60996e4f3f6c776331a7340ce2fd894eef7c7af0fe9c0712eff076ae97b89e0c11ea460e0c200f1bcd7154c95d17f7ca12100429803f2b27

data/README.md

@@ -94,7 +94,7 @@ See [this post for more information](http://blog.apiology.cc/2014/06/scalable-qu
 
 ## Maturity
 
-Quality is rapidly evolving, but uses [semantic versioning](http://semver.org/)--any incompatible changes will come out as major number updates.
+Quality uses [semantic versioning](http://semver.org/)--any incompatible changes will come out as major number updates.
 
 ## Supported Ruby Versions
 
@@ -117,6 +117,8 @@ Quality makes use of the following other gems, which do the actual checking:
 * [flog](https://github.com/seattlerb/flog)
 * [flay](https://github.com/seattlerb/flay)
 * [rubocop](https://github.com/bbatsov/rubocop)
+* [bigfiles](https://github.com/apiology/bigfiles)
+* [punchlist](https://github.com/apiology/punchlist)
 
 ### Learn More
 

data/lib/quality/quality_checker.rb

@@ -1,23 +1,25 @@
 require_relative 'command_output_processor'
 require_relative 'process_runner'
 
+# XXX: Should add *.gemspec to glob
 module Quality
   # Runs a quality-checking, command, checks it agaist the existing
   # number of violations for that command, and decreases that number
   # if possible, or outputs data if the number of violations increased.
   class QualityChecker
-    def initialize(cmd, command_options, output_dir, verbose, dependencies = {})
-      @count_file = dependencies[:count_file] || File
-      @count_io = dependencies[:count_io] || IO
-      @command_output_processor_class =
-        dependencies[:command_output_processor_class] ||
-        Quality::CommandOutputProcessor
+    def initialize(cmd, command_options, output_dir, verbose,
+                   count_file: File,
+                   count_io: IO,
+                   command_output_processor_class:
+                     Quality::CommandOutputProcessor,
+                   count_dir: Dir,
+                   process_runner_class: ProcessRunner)
+      @count_file, @count_io, @command_output_processor_class, @count_dir =
+        count_file, count_io, command_output_processor_class, count_dir
       @cmd, @command_options, @verbose = cmd, command_options, verbose
-      @count_dir = dependencies[:count_dir] || Dir
       @count_dir.mkdir(output_dir) unless @count_file.exists?(output_dir)
       @filename = File.join(output_dir, "#{cmd}_high_water_mark")
-      @process_runner_class =
-        dependencies[:process_runner_class] || ProcessRunner
+      @process_runner_class = process_runner_class
     end
 
     def execute(&count_violations_on_line)

data/lib/quality/rake/config.rb

@@ -0,0 +1,73 @@
+# XXX: This should be moved out of rake directory
+module Quality
+  # Configuration for running quality tool
+  class Config
+    # Name of quality task.
+    # Defaults to :quality.
+    attr_accessor :quality_name
+
+    # Name of ratchet task.
+    # Defaults to :ratchet.
+    attr_accessor :ratchet_name
+
+    # Array of strings describing tools to be skipped--e.g., ["cane"]
+    #
+    # Defaults to []
+    attr_accessor :skip_tools
+
+    # Log command executation
+    #
+    # Defaults to false
+    attr_accessor :verbose
+
+    # Array of directory names which contain ruby files to analyze.
+    #
+    # Defaults to %w(app lib test spec feature), which translates to *.rb in
+    # the base directory, as well as those directories.
+    attr_writer :ruby_dirs
+
+    # Array of directory names which contain any type of source
+    # files to analyze.
+    #
+    # Defaults to the same as ruby_dirs
+    attr_writer :source_dirs
+
+    # Relative path to output directory where *_high_water_mark
+    # files will be read/written
+    #
+    # Defaults to .
+    attr_accessor :output_dir
+
+    def ruby_dirs
+      @ruby_dirs ||= %w(app lib test spec feature)
+    end
+
+    def source_dirs
+      @source_dirs ||= ruby_dirs.clone
+    end
+
+    def source_files_glob(dirs = source_dirs,
+                          extensions = 'rb,swift,cpp,c,java,py')
+      File.join("{#{dirs.join(',')}}", '**', "*.{#{extensions}}")
+    end
+
+    def ruby_files_glob
+      source_files_glob(ruby_dirs, 'rb')
+    end
+
+    def ruby_files
+      @globber.glob('{*.rb,Rakefile}')
+        .concat(@globber.glob(ruby_files_glob)).join(' ')
+    end
+
+    def initialize(quality_name: 'quality',
+                   ratchet_name: 'ratchet',
+                   globber: fail)
+      @quality_name, @ratchet_name = quality_name, ratchet_name
+      @skip_tools = []
+      @output_dir = 'metrics'
+      @verbose = false
+      @globber = globber
+    end
+  end
+end

data/lib/quality/rake/task.rb

@@ -5,6 +5,7 @@ require 'rake/tasklib'
 require 'rbconfig'
 require_relative '../runner'
 require_relative '../quality_checker'
+require_relative 'config'
 
 module Quality
   #
@@ -25,42 +26,6 @@ module Quality
     #
     #   rake quality
     class Task < ::Rake::TaskLib
-      # Name of quality task.
-      # Defaults to :quality.
-      attr_accessor :quality_name
-
-      # Name of ratchet task.
-      # Defaults to :ratchet.
-      attr_accessor :ratchet_name
-
-      # Array of strings describing tools to be skipped--e.g., ["cane"]
-      #
-      # Defaults to []
-      attr_accessor :skip_tools
-
-      # Log command executation
-      #
-      # Defaults to false
-      attr_accessor :verbose
-
-      # Array of directory names which contain ruby files to analyze.
-      #
-      # Defaults to %w(app lib test spec feature), which translates to *.rb in
-      # the base directory, as well as those directories.
-      attr_writer :ruby_dirs
-
-      # Array of directory names which contain any type of source
-      # files to analyze.
-      #
-      # Defaults to the same as ruby_dirs
-      attr_writer :source_dirs
-
-      # Relative path to output directory where *_high_water_mark
-      # files will be read/written
-      #
-      # Defaults to .
-      attr_accessor :output_dir
-
       # Defines a new task, using the name +name+.
       def initialize(dsl: ::Rake::Task,
                      cmd_runner: Kernel,
@@ -68,59 +33,35 @@ module Quality
                      count_io: IO,
                      globber: Dir,
                      gem_spec: Gem::Specification,
-                     configuration_writer: File,
                      quality_checker_class:
-                       Quality::QualityChecker,
-                     quality_name: 'quality',
-                     ratchet_name: 'ratchet')
+                       Quality::QualityChecker)
         @dsl, @cmd_runner = dsl, cmd_runner
         @globber = globber
-        @quality_name, @ratchet_name = quality_name, ratchet_name
-
-        @skip_tools = []
-
-        @verbose = false
-
-        @output_dir = 'metrics'
-
-        yield self if block_given?
-
-        @runner = Quality::Runner.new(self,
+        @config = Quality::Config.new(globber: globber)
+        yield @config if block_given?
+        @runner = Quality::Runner.new(@config,
                                       gem_spec: gem_spec,
                                       quality_checker_class:
                                         quality_checker_class,
                                       count_io: count_io,
-                                      count_file: count_file)
+                                      count_file: count_file,
+                                      globber: globber)
         define
       end
 
-      attr_reader :globber
-
-      def ruby_dirs
-        @ruby_dirs ||= %w(app lib test spec feature)
-      end
-
-      def source_dirs
-        @source_dirs ||= ruby_dirs.clone
-      end
+      attr_reader :globber, :config
 
-      def source_files_glob(dirs = source_dirs,
-                            extensions = 'rb,swift,cpp,c,java,py')
-        File.join("{#{dirs.join(',')}}", '**', "*.{#{extensions}}")
-      end
+      private
 
-      def ruby_files_glob
-        source_files_glob(ruby_dirs, 'rb')
+      def quality_name
+        config.quality_name
       end
 
-      def ruby_files
-        @globber.glob('{*.rb,Rakefile}')
-          .concat(@globber.glob(ruby_files_glob)).join(' ')
+      def ratchet_name
+        config.ratchet_name
       end
 
-      private
-
-      def define # :nodoc:
+      def define
         desc 'Verify quality has increased or stayed ' \
              'the same' unless ::Rake.application.last_comment
         @dsl.define_task(quality_name) { @runner.run_quality }

data/lib/quality/runner.rb

@@ -4,6 +4,9 @@ require_relative 'tools/flog'
 require_relative 'tools/reek'
 require_relative 'tools/rubocop'
 require_relative 'tools/bigfiles'
+require_relative 'tools/punchlist'
+
+# XXX: This name is too similar to process_runner
 
 module Quality
   # Knows how to run different quality tools based on a configuration
@@ -15,17 +18,20 @@ module Quality
     include Tools::Reek
     include Tools::Rubocop
     include Tools::BigFiles
+    include Tools::Punchlist
 
     def initialize(config,
                    gem_spec: Gem::Specification,
                    quality_checker_class: Quality::QualityChecker,
                    count_io: IO,
-                   count_file: File)
+                   count_file: File,
+                   globber: Dir)
       @config = config
       @gem_spec = gem_spec
       @quality_checker_class = quality_checker_class
       @count_io = count_io
       @count_file = count_file
+      @globber = globber
     end
 
     def run_quality
@@ -43,12 +49,10 @@ module Quality
       end
     end
 
-    def globber
-      @config.globber
-    end
-
     def run_ratchet
-      globber.glob("#{@config.output_dir}/*_high_water_mark").each do |filename|
+      # XXX: a lot of things know about globbing--isn't this config's job?
+      @globber.glob("#{@config.output_dir}/*_high_water_mark")
+        .each do |filename|
         run_ratchet_on_file(filename)
       end
     end

data/lib/quality/tools/punchlist.rb

@@ -0,0 +1,15 @@
+module Quality
+  module Tools
+    # Adds 'punchlist' tool support to quality gem
+    module Punchlist
+      private
+
+      def quality_punchlist
+        ratchet_quality_cmd('punchlist',
+                            args: "--glob '#{source_files_glob}'") do |_line|
+          1
+        end
+      end
+    end
+  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 = '4.0.2'
+  VERSION = '5.0.0'
 end

data/quality.gemspec

@@ -37,6 +37,7 @@ your numbers don't get any worse over time.
   s.add_runtime_dependency(%q(flay), ['>= 2.4', '!= 2.6.0'])
   s.add_runtime_dependency(%q(rubocop))
   s.add_runtime_dependency(%q(bigfiles))
+  s.add_runtime_dependency(%q(punchlist))
 
   # need above this version to support Ruby 2.0 syntax
   s.add_runtime_dependency(%q(ruby_parser), ['>= 3.2.2'])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quality
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 5.0.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-07 00:00:00.000000000 Z
+date: 2015-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cane
@@ -100,6 +100,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: punchlist
+  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
@@ -201,12 +215,14 @@ files:
 - lib/quality/command_output_processor.rb
 - lib/quality/process_runner.rb
 - lib/quality/quality_checker.rb
+- lib/quality/rake/config.rb
 - lib/quality/rake/task.rb
 - lib/quality/runner.rb
 - lib/quality/tools/bigfiles.rb
 - lib/quality/tools/cane.rb
 - lib/quality/tools/flay.rb
 - lib/quality/tools/flog.rb
+- lib/quality/tools/punchlist.rb
 - lib/quality/tools/reek.rb
 - lib/quality/tools/rubocop.rb
 - lib/quality/version.rb