quality 3.1.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dff4cb6cb0b90287a909c4bcaacb3ab65bfccee9
-  data.tar.gz: c8e5409dfb6c3dbdbcac2e5ed0f9514db2b8e9fe
+  metadata.gz: 2f2ac78c5cf2ce1a7ffa14ae0620ee589e46ea5d
+  data.tar.gz: 77dbfa0aa0fcb5f7dc6e44bc59dc6b102942fb00
 SHA512:
-  metadata.gz: 840c0c18e0266ed65a2ad45a69368e7ff436d7b9d02774e0a2a3dcd835272c54ccd1f02d72736e0b4faf3a635378a75e5d0d4b5bc917310d32864a6b572df228
-  data.tar.gz: 9537a85f64c028a6adac27cc84525a5eeb1281232e323c8692ab48d31b1033dc46c99c8547c174921d78cc2d08ecbf6c837bbb5a467e17d51bd3b7a620a7ebd5
+  metadata.gz: b7a48e534105dfc33ac3f9eaad04ba799930d608c1e9850b469abf06f0d1f321f30f2594d21e318d09c40ca9970d989c50d6b65e58065831c0963b5f4f372a22
+  data.tar.gz: 95d993d5dc101127934b8aa407d765cdc8dcb133d2db0943a978f7e64ea18a651324efc94557ba546b5957c24e7fc156efe54cd60c9176b58c863b74ac5adc79

data/README.md

@@ -72,8 +72,13 @@ Quality::Rake::Task.new { |t|
 
   # 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.
-  t.ruby_dirs = %w{app lib test spec feature}
+  # Defaults to %w(app lib test spec feature), which translates to *.rb in the base directory, as well as those directories.
+  t.ruby_dirs = %w(app lib test spec feature)
+
+  # Array of directory names which contain any type of source files to analyze.
+  #
+  # Defaults to t.ruby_dirs
+  t.source_dirs.concat(%w(MyProject MyProjectTests))
 
   # Relative path to output directory where *_high_water_mark
   # files will be read/written

data/lib/quality/rake/task.rb

@@ -3,13 +3,8 @@
 require 'rake'
 require 'rake/tasklib'
 require 'rbconfig'
+require_relative '../runner'
 require_relative '../quality_checker'
-require_relative '../tools/cane'
-require_relative '../tools/flay'
-require_relative '../tools/flog'
-require_relative '../tools/reek'
-require_relative '../tools/rubocop'
-require_relative '../tools/bigfiles'
 
 module Quality
   #
@@ -30,13 +25,6 @@ module Quality
     #
     #   rake quality
     class Task < ::Rake::TaskLib
-      include Tools::Cane
-      include Tools::Flay
-      include Tools::Flog
-      include Tools::Reek
-      include Tools::Rubocop
-      include Tools::BigFiles
-
       # Name of quality task.
       # Defaults to :quality.
       attr_accessor :quality_name
@@ -61,11 +49,17 @@ module Quality
       # 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_writer :output_dir
+      attr_accessor :output_dir
 
       # Defines a new task, using the name +name+.
       def initialize(dsl: ::Rake::Task,
@@ -79,10 +73,8 @@ module Quality
                        Quality::QualityChecker,
                      quality_name: 'quality',
                      ratchet_name: 'ratchet')
-        @dsl, @cmd_runner, @count_file = dsl, cmd_runner, count_file
-        @count_io, @globber, @gem_spec = count_io, globber, gem_spec
-        @configuration_writer = configuration_writer
-        @quality_checker_class = quality_checker_class
+        @dsl, @cmd_runner = dsl, cmd_runner
+        @globber = globber
         @quality_name, @ratchet_name = quality_name, ratchet_name
 
         @skip_tools = []
@@ -93,87 +85,29 @@ module Quality
 
         yield self if block_given?
 
+        @runner = Quality::Runner.new(self,
+                                      gem_spec: gem_spec,
+                                      quality_checker_class:
+                                        quality_checker_class,
+                                      count_io: count_io,
+                                      count_file: count_file,
+                                      configuration_writer:
+                                        configuration_writer)
         define
       end
 
-      private
-
-      def define # :nodoc:
-        desc 'Verify quality has increased or stayed ' \
-          'the same' unless ::Rake.application.last_comment
-        @dsl.define_task(quality_name) { run_quality }
-        @dsl.define_task(ratchet_name) { run_ratchet }
-        tools.each do |tool|
-          @dsl.define_task(tool) { run_quality_with_tool(tool) }
-        end
-      end
-
-      def tools
-        self.class.ancestors.map do |ancestor|
-          ancestor_name = ancestor.to_s
-          next unless ancestor_name.start_with?('Quality::Tools::')
-          ancestor_name.split('::').last.downcase
-        end.compact
-      end
-
-      def run_quality
-        tools.each do |tool|
-          run_quality_with_tool(tool)
-        end
-      end
-
-      def run_quality_with_tool(tool)
-        installed = @gem_spec.find_all_by_name(tool).any?
-        suppressed = @skip_tools.include? tool
-
-        if installed && !suppressed
-          method("quality_#{tool}".to_sym).call
-        elsif !installed
-          puts "#{tool} not installed"
-        end
-      end
-
-      def run_ratchet
-        @globber.glob("#{@output_dir}/*_high_water_mark").each do |filename|
-          run_ratchet_on_file(filename)
-        end
-      end
-
-      def run_ratchet_on_file(filename)
-        puts "Processing #{filename}"
-        existing_violations = count_existing_violations(filename)
-        new_violations = [0, existing_violations - 1].max
-        write_violations(filename, new_violations)
-      end
-
-      def write_violations(filename, new_violations)
-        @count_file.open(filename, 'w') do |file|
-          file.write(new_violations.to_s + "\n")
-        end
-      end
-
-      def count_existing_violations(filename)
-        existing_violations = @count_io.read(filename).to_i
-        fail("Problem with file #{filename}") if existing_violations < 0
-        existing_violations
-      end
-
-      def ratchet_quality_cmd(cmd,
-                              command_options,
-                              &count_violations_on_line)
-        quality_checker = @quality_checker_class.new(cmd,
-                                                     command_options,
-                                                     @output_dir,
-                                                     verbose)
-        quality_checker.execute(&count_violations_on_line)
-      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
+
       def source_files_glob(extensions = 'rb,swift,cpp,c,java,py')
-        File.join("{#{ruby_dirs.join(',')}}",
+        File.join("{#{source_dirs.join(',')}}",
                   '**', "*.{#{extensions}}")
       end
 
@@ -182,9 +116,21 @@ module Quality
       end
 
       def ruby_files
-        @globber.glob('*.rb')
+        @globber.glob('{*.rb,Rakefile}')
           .concat(@globber.glob(ruby_files_glob)).join(' ')
       end
+
+      private
+
+      def define # :nodoc:
+        desc 'Verify quality has increased or stayed ' \
+             'the same' unless ::Rake.application.last_comment
+        @dsl.define_task(quality_name) { @runner.run_quality }
+        @dsl.define_task(ratchet_name) { @runner.run_ratchet }
+        @runner.tools.each do |tool|
+          @dsl.define_task(tool) { @runner.run_quality_with_tool(tool) }
+        end
+      end
     end
   end
 end

data/lib/quality/runner.rb

@@ -0,0 +1,105 @@
+require_relative 'tools/cane'
+require_relative 'tools/flay'
+require_relative 'tools/flog'
+require_relative 'tools/reek'
+require_relative 'tools/rubocop'
+require_relative 'tools/bigfiles'
+
+module Quality
+  class Runner
+    include Tools::Cane
+    include Tools::Flay
+    include Tools::Flog
+    include Tools::Reek
+    include Tools::Rubocop
+    include Tools::BigFiles
+
+    def initialize(config,
+                   gem_spec: Gem::Specification,
+                   quality_checker_class: Quality::QualityChecker,
+                   count_io: IO,
+                   count_file: File,
+                   configuration_writer: File)
+      @config = config
+      @gem_spec = gem_spec
+      @quality_checker_class = quality_checker_class
+      @count_io = count_io
+      @count_file = count_file
+      @configuration_writer = configuration_writer
+    end
+
+    def run_quality
+      tools.each { |tool| run_quality_with_tool(tool) }
+    end
+
+    def run_quality_with_tool(tool)
+      installed = @gem_spec.find_all_by_name(tool).any?
+      suppressed = @config.skip_tools.include? tool
+
+      if installed && !suppressed
+        method("quality_#{tool}".to_sym).call
+      elsif !installed
+        puts "#{tool} not installed"
+      end
+    end
+
+    def globber
+      @config.globber
+    end
+
+    def run_ratchet
+      globber.glob("#{@config.output_dir}/*_high_water_mark").each do |filename|
+        run_ratchet_on_file(filename)
+      end
+    end
+
+    def run_ratchet_on_file(filename)
+      puts "Processing #{filename}"
+      existing_violations = count_existing_violations(filename)
+      new_violations = [0, existing_violations - 1].max
+      write_violations(filename, new_violations)
+    end
+
+    def write_violations(filename, new_violations)
+      @count_file.open(filename, 'w') do |file|
+        file.write(new_violations.to_s + "\n")
+      end
+    end
+
+    def count_existing_violations(filename)
+      existing_violations = @count_io.read(filename).to_i
+      fail("Problem with file #{filename}") if existing_violations < 0
+      existing_violations
+    end
+
+    def tools
+      self.class.ancestors.map do |ancestor|
+        ancestor_name = ancestor.to_s
+        next unless ancestor_name.start_with?('Quality::Tools::')
+        ancestor_name.split('::').last.downcase
+      end.compact
+    end
+
+    def ratchet_quality_cmd(cmd,
+                            command_options,
+                            &count_violations_on_line)
+      quality_checker = @quality_checker_class.new(cmd,
+                                                   command_options,
+                                                   @config.output_dir,
+                                                   @config.verbose)
+      quality_checker.execute(&count_violations_on_line)
+    end
+
+    def ruby_files
+      @config.ruby_files
+    end
+
+    def ruby_files_glob
+      @config.ruby_files_glob
+    end
+
+    def source_files_glob
+      @config.source_files_glob
+    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 = '3.1.0'
+  VERSION = '4.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quality
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Vince Broz
@@ -202,6 +202,7 @@ files:
 - lib/quality/process_runner.rb
 - lib/quality/quality_checker.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