quality 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b529fe70947f211e50846ac7eeca8401e7af353
-  data.tar.gz: ae51331dff7e90e9c860631bde9a3001bbcb4be6
+  metadata.gz: b5685a2d62cde5dfe205d5a86d1291a6c194bfd5
+  data.tar.gz: ee00ee02ea7878fa1c292b1143b39c1ae4328cd1
 SHA512:
-  metadata.gz: 96c466f3f82770eb6b591d0f0ab348f616f2656a74ea1abe06ab844c1d44f90be5fc58d4542792dc24d03d255f64a6d0a9177b6061e72eced6b04ff04c300a41
-  data.tar.gz: c27d3c90ec6234412cfaa4583b057d11c19db6d0e7d25bdc9ed585241d445ebb827d6e732ead3fdfdea38c30c445c9aaa58a616f8bd125f63183847559602289
+  metadata.gz: 155a536e9accec95840cd873704efeb53aac9ef31f4f92e2da2a60c31af7532944e57c9ea140c04225811befc6f008755dca411cbae7fce355df9ce29303b1b7
+  data.tar.gz: 2fb571730ecfad52008c969ba5b64e0d99f4583f4b49035ed8e01dd8a4afff7eb4b05e884d187ee75a1c619f271c21f52809d99e33c5a933e941963c6f977d9f

data/README.md

@@ -61,13 +61,6 @@ Quality::Rake::Task.new { |t|
 }
 ```
 
-
-## Optional tools
-
-The 'reek' gem is supported, but not by default.  To support it, add the 'reek' gem to your Gemspec.  Once reek supports Ruby 2.0, it will presumably support newer versions of the 'ruby_parser' gem.  Currently it will disable Ruby 2.0 supports in other quality-check gems by forcing them to a lower version.
-
-https://github.com/troessner/reek/issues/165
-
 ## Contributing
 
 * Fork the repo
@@ -82,6 +75,7 @@ Quality makes use of the following other gems, which do the actual checking:
 * cane
 * flog
 * flay
+* rubocop
 
 ### Learn More
 

data/lib/quality/command_output_processor.rb

@@ -0,0 +1,53 @@
+module Quality
+  # Class processes output from a code quality command, tweaking it
+  # for editor output and counting the number of violations found
+  class CommandOutputProcessor
+    attr_accessor :emacs_format
+    attr_accessor :file
+    attr_reader :found_output
+    attr_reader :violations
+
+    def initialize
+      @emacs_format = false
+      @found_output = false
+      @violations = 0
+    end
+
+    def process!(&count_violations_on_line)
+      process_file(file, &count_violations_on_line)
+    end
+
+    private
+
+    def process_file(file, &count_violations_on_line)
+      out = ''
+      while (@current_line = file.gets)
+        out <<
+          process_line(&count_violations_on_line)
+      end
+      out
+    end
+
+    def process_line(&count_violations_on_line)
+      output =
+        if emacs_format
+          preprocess_line_for_emacs
+        else
+          @current_line
+        end
+      @found_output = true
+      @violations += yield @current_line
+      output
+    end
+
+    def preprocess_line_for_emacs
+      if @current_line =~ /^ *(\S*.rb:[0-9]*) *(.*)/
+        $1 + ': ' + $2 + "\n"
+      elsif @current_line =~ /^ *(.*) +(\S*.rb:[0-9]*) *(.*)/
+        $2 + ': ' + $1 + "\n"
+      else
+        @current_line
+      end
+    end
+  end
+end

data/lib/quality/quality_checker.rb

@@ -0,0 +1,108 @@
+require_relative 'command_output_processor'
+
+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, dependencies = {})
+      @popener = dependencies[:popener] || IO
+      @count_file = dependencies[:count_file] || File
+      @count_io = dependencies[:count_io] || IO
+      @command_output_processor_class =
+        dependencies[:command_output_processor_class] ||
+        Quality::CommandOutputProcessor
+      @cmd = cmd
+      @command_options = command_options
+      @filename = File.join(output_dir, "#{cmd}_high_water_mark")
+    end
+
+    def execute(&count_violations_on_line)
+      processor, exit_status = process_command(&count_violations_on_line)
+      @violations = processor.violations
+      check_exit_status(exit_status)
+      ratchet_violations
+    end
+
+    private
+
+    def process_command(&count_violations_on_line)
+      processor = @command_output_processor_class.new
+      processor.emacs_format = @command_options[:emacs_format]
+      exit_status = run_command(processor, &count_violations_on_line)
+      [processor, $?.exitstatus]
+    end
+
+    def run_command(processor, &count_violations_on_line)
+      @popener.popen(full_cmd) do |file|
+        processor.file = file
+        @command_output = processor.process!(&count_violations_on_line)
+      end
+    end
+
+    def check_exit_status(exit_status)
+      unless @command_options[:gives_error_code_on_violations]
+        if exit_status != 0
+          fail("Error detected running #{full_cmd}.  " +
+               "Exit status is #{exit_status}, output is [#{out}]")
+        end
+      end
+    end
+
+    def existing_violations
+      if @count_file.exist?(@filename)
+        @count_io.read(@filename).to_i
+      else
+        9_999_999_999
+      end
+    end
+
+    def ratchet_violations
+      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!")
+      elsif @violations < existing
+        puts 'Ratcheting quality up...'
+        write_violations(@violations)
+      end
+    end
+
+    def report_violations(existing)
+      puts "Existing violations: #{existing}"
+      puts "Found #{@violations} #{@cmd} violations"
+    end
+
+    private
+
+    def full_cmd
+      args = @command_options[:args]
+      args ||= ''
+
+      @found_output = false
+      if args.size > 0
+        "#{get_cmd_with_ruby_hack_prefix} #{args}"
+      else
+        "#{get_cmd_with_ruby_hack_prefix}"
+      end
+    end
+
+    def get_cmd_with_ruby_hack_prefix
+      if defined?(RUBY_ENGINE) && (RUBY_ENGINE == 'jruby')
+        "jruby -S #{@cmd}"
+      elsif RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
+        "#{@cmd}.bat"
+      else
+        @cmd
+      end
+    end
+
+    def write_violations(new_violations)
+      @count_file.open(@filename, 'w') do |file|
+        file.write(new_violations.to_s)
+      end
+    end
+  end
+end

data/lib/quality/rake/task.rb

@@ -3,13 +3,12 @@
 require 'rake'
 require 'rake/tasklib'
 require 'rbconfig'
+require_relative '../quality_checker'
 
 module Quality
 
   #
   # Defines a task library for running quality's various tools
-  # (Classes here will be configured via the Rakefile, and therefore will
-  # possess a :reek:attribute or two.)
   #
   module Rake
 
@@ -26,7 +25,6 @@ module Quality
     # This will create a task that can be run with:
     #
     #   rake quality
-    #
     class Task < ::Rake::TaskLib
 
       # Name of quality task.
@@ -62,14 +60,11 @@ module Quality
 
         # allow unit tests to override the class that Rake DSL
         # messages are sent to.
-        @dsl = args[:dsl]
+        @dsl = args[:dsl] || ::Rake::Task
 
         # likewise, but for system()
         @cmd_runner = args[:cmd_runner] || Kernel
 
-        # likewise, but for IO.popen()
-        @popener = args[:popener] || IO
-
         # likewise, but for File.open() on the count files
         @count_file = args[:count_file] || File
 
@@ -79,149 +74,110 @@ module Quality
         # likewise, but for Dir.glob() on target Ruby files
         @globber = args[:globber] || Dir
 
+        # likewise, but for checking whether a gem is installed
+        @gem_spec = args[:gem_spec] || Gem::Specification
+
         # uses exist?() and open() to write out configuration files
         # for tools if needed (e.g., .cane file)
         @configuration_writer = args[:configuration_writer] || File
 
-        @skip_tools = [] if @skip_tools.nil?
-        @config_files = nil
-        @source_files = nil
-        @ruby_opts = []
-        @reek_opts = ''
-        @fail_on_error = true
-        @sort = nil
+        # Class which actually runs the quality check commands
+        @quality_checker_class =
+          args[:quality_checker_class] || Quality::QualityChecker
+
+        @skip_tools = []
+
+        @output_dir = '.'
 
         yield self if block_given?
-        @config_files ||= 'config/**/*.reek'
-        @source_files ||= 'lib/**/*.rb'
-        @output_dir   ||= "."
+
         define
       end
 
-  private
+      private
 
       def define # :nodoc:
         desc 'Verify quality has increased or stayed ' +
           'the same' unless ::Rake.application.last_comment
-        if @dsl.nil?
-          task(quality_name) { run_quality }
-          task(ratchet_name) { run_ratchet }
-        else
-          @dsl.task(quality_name) { run_quality }
-          @dsl.task(ratchet_name) { run_ratchet }
-        end
+        @dsl.define_task(quality_name) { run_quality }
+        @dsl.define_task(ratchet_name) { run_ratchet }
       end
 
       def run_quality
         tools = ['cane', 'flog', 'flay', 'reek', 'rubocop']
         tools.each do |tool|
-          installed = Gem::Specification.find_all_by_name(tool).any?
-          suppressed = @skip_tools.include? tool
+          run_quality_with_tool(tool)
+        end
+      end
 
-          if !installed
-            puts "#{tool} not installed"
-          elsif suppressed
-            puts "Suppressing use of #{tool}"
-          else
-            method("quality_#{tool}".to_sym).call
-          end
+      def run_quality_with_tool(tool)
+        installed = @gem_spec.find_all_by_name(tool).any?
+        suppressed = @skip_tools.include? tool
+
+        if !installed
+          puts "#{tool} not installed"
+        elsif suppressed
+          puts "Suppressing use of #{tool}"
+        else
+          method("quality_#{tool}".to_sym).call
         end
       end
 
       def run_ratchet
-        @globber.glob("*_high_water_mark").each { |filename|
-          puts "Processing #{filename}"
-          existing_violations = @count_io.read(filename).to_i
-          if existing_violations < 0
-            raise "Problem with file #{filename}"
-          end
-          new_violations = [0, existing_violations - 1].max
-          @count_file.open(filename, 'w') {|f| f.write(new_violations.to_s) }
-          if new_violations != existing_violations
-            @cmd_runner.system("git commit -m 'tighten quality standard' #{filename}")
-          end
-        }
+        @globber.glob('*_high_water_mark').each do |filename|
+          run_ratchet_on_file(filename)
+        end
       end
 
-      def ratchet_quality_cmd(cmd,
-                              options,
-                              &process_output_line)
-
-        gives_error_code_on_violations ||= options[:gives_error_code_on_violations]
-
-        args ||= options[:args]
-        emacs_format ||= options[:emacs_format]
+      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)
+        tighten_standard(filename) if new_violations != existing_violations
+      end
 
-        violations = 0
-        out = ""
-        found_output = false
-        if defined?(RUBY_ENGINE) && (RUBY_ENGINE == 'jruby')
-          full_cmd = "jruby -S #{cmd}"
-        elsif RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
-          full_cmd = "#{cmd}.bat"
-        else
-          full_cmd = cmd
+      def write_violations(filename, new_violations)
+        @count_file.open(filename, 'w') do |file|
+          file.write(new_violations.to_s)
         end
+      end
 
-        if !args.nil?
-          full_cmd = "#{full_cmd} #{args}"
-        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
 
-        @popener.popen(full_cmd) do |f|
-          while line = f.gets
-            if emacs_format
-              if line =~ /^ *(\S*.rb:[0-9]*) *(.*)/
-                out << $1 << ": " << $2 << "\n"
-              elsif line =~ /^ *(.*) +(\S*.rb:[0-9]*) *(.*)/
-                out << $2 << ": " << $1 << "\n"
-              else
-                out << line
-              end
-            else
-              out << line
-            end
-            found_output = true
-            violations += yield line
-          end
-        end
-        exit_status = $?.exitstatus
-        if !gives_error_code_on_violations
-          if exit_status != 0
-            fail "Error detected running #{full_cmd}.  Exit status is #{exit_status}, output is [#{out}]"
-          end
-        end
-        filename = File.join(@output_dir, "#{cmd}_high_water_mark")
-        if @count_file.exist?(filename)
-          existing_violations = @count_io.read(filename).to_i
-        else
-          existing_violations = 9999999999
-        end
-        puts "Existing violations: #{existing_violations}"
-        puts "Found #{violations} #{cmd} violations"
-        if violations > existing_violations
-          fail "Output from #{cmd}\n\n#{out}\n\n" +
-            "Reduce total number of #{cmd} violations to #{existing_violations} or below!"
-        elsif violations < existing_violations
-          puts "Ratcheting quality up..."
-          @count_file.open(filename, 'w') do |f|
-            f.write(violations.to_s)
-          end
-        end
+      def tighten_standard(filename)
+        @cmd_runner
+          .system("git commit -m 'tighten quality standard' #{filename}")
+      end
+
+      def ratchet_quality_cmd(cmd,
+                              command_options,
+                              &count_violations_on_line)
+        quality_checker = @quality_checker_class.new(cmd,
+                                                     command_options,
+                                                     @output_dir)
+        quality_checker.execute(&count_violations_on_line)
       end
 
       def quality_cane
-        if ! @configuration_writer.exist?(".cane")
-          @configuration_writer.open(".cane", "w") {|f| f.write("-f **/*.rb")}
+        unless @configuration_writer.exist?('.cane')
+          @configuration_writer.open('.cane', 'w') do |file|
+            file.write('-f **/*.rb')
+          end
         end
-        ratchet_quality_cmd("cane",
+        ratchet_quality_cmd('cane',
                             gives_error_code_on_violations: true,
-                            emacs_format: true) { |line|
+                            emacs_format: true) do |line|
           if line =~ /\(([0-9]*)\):$/
             $1.to_i
           else
             0
           end
-        }
+        end
       end
 
       def ruby_dirs
@@ -229,68 +185,79 @@ module Quality
       end
 
       def ruby_files
-        @globber.glob('*.rb').concat(@globber.glob(File.join("{#{ruby_dirs.join(',')}}", '**', '*.rb'))).join(' ')
+        @globber.glob('*.rb')
+          .concat(@globber.glob(File.join("{#{ruby_dirs.join(',')}}",
+                                          '**', '*.rb'))).join(' ')
       end
 
       def quality_reek
-        args = "--line-number #{ruby_files}"
-        ratchet_quality_cmd("reek",
+        args = "--single-line #{ruby_files}"
+        ratchet_quality_cmd('reek',
                             args: args,
                             emacs_format: true,
-                            gives_error_code_on_violations: true) { |line|
-          if line =~ /^  .* (.*)$/
-            1
-          else
-            0
-          end
-        }
+                            gives_error_code_on_violations: true) do |line|
+          self.class.count_reek_violations(line)
+        end
+      end
+
+      def self.count_reek_violations(line)
+        if line =~ /^  .* (.*)$/
+          1
+        else
+          0
+        end
       end
 
       def quality_flog
-        threshold = 50
-        ratchet_quality_cmd("flog",
-                            args: "--all --continue --methods-only #{ruby_files}",
-                            emacs_format: true) { |line|
-          if line =~ /^ *([0-9.]*): flog total$/
-            0
-            #$1.to_i
-          elsif line =~ /^ *([0-9.]*): (.*) .*.rb:[0-9]*$/
-            score = $1.to_i
-            if score > threshold
-              1
-            else
-              0
-            end
+        ratchet_quality_cmd('flog',
+                       args: "--all --continue --methods-only #{ruby_files}",
+                       emacs_format: true) do |line|
+          self.class.count_violations_in_flog_output(line)
+        end
+      end
+
+      def self.count_violations_in_flog_output(line, threshold = 50)
+        if line =~ /^ *([0-9.]*): flog total$/
+          0
+        elsif line =~ /^ *([0-9.]*): (.*) .*.rb:[0-9]*$/
+          score = $1.to_i
+          if score > threshold
+            1
           else
             0
           end
-        }
+        else
+          0
+        end
       end
 
       def quality_flay
-        ratchet_quality_cmd("flay",
+        ratchet_quality_cmd('flay',
                             args: "-m 75 -t 99999 #{ruby_files}",
-                            emacs_format: true) { |line|
+                            emacs_format: true) do |line|
           if line =~ /^[0-9]*\).* \(mass = ([0-9]*)\)$/
             $1.to_i
           else
             0
           end
-        }
+        end
       end
 
       def quality_rubocop
-        ratchet_quality_cmd("rubocop",
+        ratchet_quality_cmd('rubocop',
                             gives_error_code_on_violations: true,
-                            args: "--format emacs #{ruby_files}") { |line|
-          if line =~ /^.* file[s|] inspected, (.*) offence[s|] detected$/
-            0
-          else
-            1
-          end
-        }
+                            args: "--format emacs #{ruby_files}") do |line|
+          self.class.count_rubocop_violations(line)
+        end
       end
 
+      def self.count_rubocop_violations(line)
+        if line =~ /^.* file[s|] inspected, (.*) offence[s|] detected$/
+          0
+        else
+          1
+        end
+      end
     end
   end
 end

data/lib/quality/version.rb

@@ -1,3 +1,3 @@
 module Quality
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/quality.gemspec

@@ -29,7 +29,7 @@ your numbers don't get any worse over time.
   s.summary = %q{Code quality tools for Ruby}
 
   s.add_runtime_dependency(%q<cane>, [">= 2.6"])
-  s.add_runtime_dependency(%q<reek>, [">= 1.3.2"])
+  s.add_runtime_dependency(%q<reek>, [">= 1.3.4"])
   s.add_runtime_dependency(%q<flog>, [">= 4.1.1"])
   s.add_runtime_dependency(%q<flay>, [">= 2.4"])
   s.add_runtime_dependency(%q<rubocop>)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quality
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-13 00:00:00.000000000 Z
+date: 2013-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cane
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 1.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 1.3.4
 - !ruby/object:Gem::Dependency
   name: flog
   requirement: !ruby/object:Gem::Requirement
@@ -190,6 +190,8 @@ files:
 - License.txt
 - README.md
 - Rakefile
+- lib/quality/command_output_processor.rb
+- lib/quality/quality_checker.rb
 - lib/quality/rake/task.rb
 - lib/quality/version.rb
 - quality.gemspec