quality 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 350f6c6730ee079bb5d55ac825ccbfd41e2fdfd2
-  data.tar.gz: 4c6c2f025cde6d119766c48c945e9edbd18fe032
+  metadata.gz: 3fd46a1c5027604b62f85dbe5fe6a29f95242188
+  data.tar.gz: 3f3da1a73252e2c1b28164084dd3f5f3da8abf89
 SHA512:
-  metadata.gz: c77587613d9841670e38b35623dd180326b3fc12c1a01b671a6ceec66eddc9c9b5fa4a7cabb9eef3b395a5fecc8801b6bba9277e07927ddcc571adccf49bfbf1
-  data.tar.gz: 27690620eda4e95a5cd3f53590b06235ec28e8c7f4ca870f8dc3a2f447203d6a6cd898fff7e8ccd9b874e4b5daada3a318268ed5771c6b8e281138a872af7b43
+  metadata.gz: e1894369f734937ee0df1adabf61eb3def10bdd59c70e9bb522d16bff23d0c89e61ecb02f7f6456afc23ac6fb7f1743ac87b3a8e0e66aa3bc4f1359ee0b98da0
+  data.tar.gz: 8751ecd3fe496a94f9de979543b724fd171eab819dc404af2aa3f8382acad3628d96abf3f116a9a7d90085a24e15f8f83ad1158a4da42189e80215e451d65979

data/README.md

@@ -1,10 +1,12 @@
+[![Build Status](https://travis-ci.org/apiology/quality.png)](https://travis-ci.org/apiology/quality)
+
 # Quality -- code quality ratchet for Ruby
 
 ##Overview
 
 Quality is a tool that runs quality checks on Ruby code using cane,
-reek, flog and flay, and makes sure your numbers don't get any worse
-over time.
+reek, flog, flay and rubocop and makes sure your numbers don't get any
+worse over time.
 
 ```bash
 $ gem install quality
@@ -71,11 +73,11 @@ Quality::Rake::Task.new { |t|
 
 Quality makes use of the following other gems, which do the actual checking:
 
-* reek
-* cane
-* flog
-* flay
-* rubocop
+* [reek](https://github.com/troessner/reek)
+* [cane](https://github.com/square/cane)
+* [flog](https://github.com/seattlerb/flog)
+* [flay](https://github.com/seattlerb/flay)
+* [rubocop](https://github.com/bbatsov/rubocop)
 
 ### Learn More
 

data/Rakefile

@@ -1,15 +1,18 @@
 require 'rake/clean'
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'quality/rake/task'
 
-$:.unshift File.dirname(__FILE__) + '/lib'
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/lib'
 
 PROJECT_NAME = 'quality'
 
-BUILD_DIR = 'build'; directory BUILD_DIR
-PKG_DIR = "#{BUILD_DIR}/pkg"; directory PKG_DIR
+BUILD_DIR = 'build'
+directory BUILD_DIR
 
-GEM_MANIFEST = "Manifest.txt"
+PKG_DIR = "#{BUILD_DIR}/pkg"
+directory PKG_DIR
+
+GEM_MANIFEST = 'Manifest.txt'
 VERSION_FILE = 'lib/quality.rb'
 
 CLOBBER.include("#{BUILD_DIR}/*")
@@ -20,15 +23,12 @@ Quality::Rake::Task.new do |t|
   t.skip_tools = ['reek']
 end
 
-task :clear_metrics do |t|
+task :clear_metrics do |_t|
   puts Time.now
-  ret =
-    system("git checkout coverage/.last_run.json *_high_water_mark")
-  if !ret
-    fail
-  end
+  ret = system('git checkout coverage/.last_run.json *_high_water_mark')
+  fail unless ret
 end
 
-task :localtest => [:clear_metrics, :test, :quality]
+task localtest: [:clear_metrics, :test, :quality]
 
-task :default => [:localtest]
+task default: [:localtest]

data/lib/quality/command_output_processor.rb

@@ -13,7 +13,7 @@ module Quality
       @violations = 0
     end
 
-    def process!(&count_violations_on_line)
+    def process(&count_violations_on_line)
       process_file(file, &count_violations_on_line)
     end
 
@@ -42,9 +42,9 @@ module Quality
 
     def preprocess_line_for_emacs
       if @current_line =~ /^ *(\S*.rb:[0-9]*) *(.*)/
-        $1 + ': ' + $2 + "\n"
+        Regexp.last_match[1] + ': ' + Regexp.last_match[2] + "\n"
       elsif @current_line =~ /^ *(.*) +(\S*.rb:[0-9]*) *(.*)/
-        $2 + ': ' + $1 + "\n"
+        Regexp.last_match[2] + ': ' + Regexp.last_match[1] + "\n"
       else
         @current_line
       end

data/lib/quality/quality_checker.rb

@@ -37,7 +37,7 @@ module Quality
     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)
+        @command_output = processor.process(&count_violations_on_line)
       end
       $CHILD_STATUS.exitstatus
     end
@@ -45,10 +45,9 @@ module Quality
     def check_exit_status(exit_status)
       return if @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
+      fail("Error detected running #{full_cmd}.  " \
+           "Exit status is #{exit_status}, " \
+           "output is [#{out}]") if exit_status != 0
     end
 
     def existing_violations
@@ -85,13 +84,13 @@ module Quality
 
       @found_output = false
       if args.size > 0
-        "#{get_cmd_with_ruby_hack_prefix} #{args}"
+        "#{cmd_with_ruby_hack_prefix} #{args}"
       else
-        "#{get_cmd_with_ruby_hack_prefix}"
+        "#{cmd_with_ruby_hack_prefix}"
       end
     end
 
-    def get_cmd_with_ruby_hack_prefix
+    def cmd_with_ruby_hack_prefix
       if defined?(RUBY_ENGINE) && (RUBY_ENGINE == 'jruby')
         "jruby -S #{@cmd}"
       elsif RbConfig::CONFIG['host_os'] =~ /mswin|mingw/

data/lib/quality/rake/task.rb

@@ -4,6 +4,11 @@ require 'rake'
 require 'rake/tasklib'
 require 'rbconfig'
 require_relative '../quality_checker'
+require_relative '../tools/cane'
+require_relative '../tools/flay'
+require_relative '../tools/flog'
+require_relative '../tools/reek'
+require_relative '../tools/rubocop'
 
 module Quality
   #
@@ -24,6 +29,12 @@ module Quality
     #
     #   rake quality
     class Task < ::Rake::TaskLib
+      include Tools::Cane
+      include Tools::Flay
+      include Tools::Flog
+      include Tools::Reek
+      include Tools::Rubocop
+
       # Name of quality task.
       # Defaults to :quality.
       attr_accessor :quality_name
@@ -51,10 +62,29 @@ module Quality
 
       # Defines a new task, using the name +name+.
       def initialize(args = {})
+        parse_args(args)
+
+        @skip_tools = []
+
+        @output_dir = '.'
+
+        yield self if block_given?
+
+        define
+      end
+
+      def parse_task_name_args(args)
         @quality_name = args[:quality_name] || 'quality'
 
         @ratchet_name = args[:ratchet_name] || 'ratchet'
+      end
+
+      def parse_args(args)
+        parse_task_name_args(args)
+        parse_unit_test_overrides(args)
+      end
 
+      def parse_unit_test_overrides(args)
         # allow unit tests to override the class that Rake DSL
         # messages are sent to.
         @dsl = args[:dsl] || ::Rake::Task
@@ -81,14 +111,6 @@ module Quality
         # 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?
-
-        define
       end
 
       private
@@ -104,7 +126,11 @@ module Quality
       end
 
       def tools
-        %w(cane flog flay reek rubocop)
+        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
@@ -166,100 +192,18 @@ module Quality
         quality_checker.execute(&count_violations_on_line)
       end
 
-      def quality_cane
-        unless @configuration_writer.exist?('.cane')
-          @configuration_writer.open('.cane', 'w') do |file|
-            file.write('-f **/*.rb')
-          end
-        end
-        ratchet_quality_cmd('cane',
-                            gives_error_code_on_violations: true,
-                            emacs_format: true) do |line|
-          if line =~ /\(([0-9]*)\):$/
-            $1.to_i
-          else
-            0
-          end
-        end
-      end
-
       def ruby_dirs
         @ruby_dirs ||= %w(lib test spec feature)
       end
 
-      def ruby_files
-        @globber.glob('*.rb')
-          .concat(@globber.glob(File.join("{#{ruby_dirs.join(',')}}",
-                                          '**', '*.rb'))).join(' ')
-      end
-
-      def quality_reek
-        args = "--single-line #{ruby_files}"
-        ratchet_quality_cmd('reek',
-                            args: args,
-                            emacs_format: true,
-                            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
-        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
+      def ruby_files_glob
+        File.join("{#{ruby_dirs.join(',')}}",
+                  '**', '*.rb')
       end
 
-      def quality_flay
-        ratchet_quality_cmd('flay',
-                            args: "-m 75 -t 99999 #{ruby_files}",
-                            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',
-                            gives_error_code_on_violations: true,
-                            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
+      def ruby_files
+        @globber.glob('*.rb')
+          .concat(@globber.glob(ruby_files_glob)).join(' ')
       end
     end
   end

data/lib/quality/tools/cane.rb

@@ -0,0 +1,28 @@
+module Quality
+  module Tools
+    # Adds 'cane' tool support to quality gem
+    module Cane
+      private
+
+      def write_out_dot_cane
+        @configuration_writer.open('.cane', 'w') do |file|
+          file.write("-f #{ruby_files_glob}")
+        end
+      end
+
+      def quality_cane
+        write_out_dot_cane unless @configuration_writer.exist?('.cane')
+
+        ratchet_quality_cmd('cane',
+                            gives_error_code_on_violations: true,
+                            emacs_format: true) do |line|
+          if line =~ /\(([0-9]*)\):$/
+            Regexp.last_match[1].to_i
+          else
+            0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/quality/tools/flay.rb

@@ -0,0 +1,20 @@
+module Quality
+  module Tools
+    # Adds 'flay' tool support to quality gem
+    module Flay
+      private
+
+      def quality_flay
+        ratchet_quality_cmd('flay',
+                            args: "--mass 75 --timeout 99999 #{ruby_files}",
+                            emacs_format: true) do |line|
+          if line =~ /^[0-9]*\).* \(mass = ([0-9]*)\)$/
+            Regexp.last_match[1].to_i
+          else
+            0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/quality/tools/flog.rb

@@ -0,0 +1,34 @@
+module Quality
+  module Tools
+    # Adds 'flog' tool support to quality gem
+    module Flog
+      private
+
+      def quality_flog
+        args = "--all --continue --methods-only #{ruby_files}"
+        ratchet_quality_cmd('flog', args: args, emacs_format: true) do |line|
+          self.class.count_violations_in_flog_output(line)
+        end
+      end
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      # See Flog.included
+      module ClassMethods
+        def 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]*$/
+
+          score = Regexp.last_match[1].to_i
+
+          return 1 if score > threshold
+
+          0
+        end
+      end
+    end
+  end
+end

data/lib/quality/tools/reek.rb

@@ -0,0 +1,33 @@
+module Quality
+  module Tools
+    # Adds 'reek' tool support to quality gem
+    module Reek
+      private
+
+      def quality_reek
+        args = "--single-line #{ruby_files}"
+        ratchet_quality_cmd('reek',
+                            args: args,
+                            emacs_format: true,
+                            gives_error_code_on_violations: true) do |line|
+          self.class.count_reek_violations(line)
+        end
+      end
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      # See Reek.included
+      module ClassMethods
+        def count_reek_violations(line)
+          if line =~ /^  .* (.*)$/
+            1
+          else
+            0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/quality/tools/rubocop.rb

@@ -0,0 +1,31 @@
+module Quality
+  module Tools
+    # Adds 'rubocop' tool support to quality gem
+    module Rubocop
+      private
+
+      def quality_rubocop
+        ratchet_quality_cmd('rubocop',
+                            gives_error_code_on_violations: true,
+                            args: "--format emacs #{ruby_files}") do |line|
+          self.class.count_rubocop_violations(line)
+        end
+      end
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      # See Rubocop.included
+      module ClassMethods
+        def count_rubocop_violations(line)
+          if line =~ /^.* file[s|] inspected, (.*) offence[s|] detected$/
+            0
+          else
+            1
+          end
+        end
+      end
+    end
+  end
+end

data/lib/quality/version.rb

@@ -1,3 +1,6 @@
+# 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
+# any worse over time.
 module Quality
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
 end

data/quality.gemspec

@@ -1,49 +1,49 @@
 # ; -*-Ruby-*-
 # -*- encoding: utf-8 -*-
-$:.push File.join(File.dirname(__FILE__), "lib")
+$LOAD_PATH.push File.join(File.dirname(__FILE__), 'lib')
 require 'quality/version'
 
 Gem::Specification.new do |s|
-  s.name = %q{quality}
+  s.name = %q(quality)
   s.version = Quality::VERSION
 
   s.authors = ['Vince Broz']
-  #s.default_executable = %q{quality}
-  s.description = %q{Quality is a tool that runs quality checks on Ruby
+  # s.default_executable = %q{quality}
+  s.description = %q(Quality is a tool that runs quality checks on Ruby
 code using rubocop, cane, reek, flog and flay, and makes sure
 your numbers don't get any worse over time.
-}
-  s.email = ["vince@broz.cc"]
-  #s.executables = ["quality"]
-  #s.extra_rdoc_files = ["CHANGELOG", "License.txt"]
-  s.files = Dir["License.txt", "README.md",
-                "Rakefile",
-                #"bin/quality",
-                "{lib}/**/*",
-                "quality.gemspec" ] & `git ls-files -z`.split("\0")
-  #s.rdoc_options = ["--main", "README.md"]
-  s.require_paths = ["lib"]
-  s.homepage = %q{http://github.com/apiology/quality}
-  #s.rubyforge_project = %q{quality}
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Code quality tools for Ruby}
 
-  s.add_runtime_dependency(%q<cane>, [">= 2.6"])
-  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>)
+)
+  s.email = ['vince@broz.cc']
+  # s.executables = ["quality"]
+  # s.extra_rdoc_files = ["CHANGELOG", "License.txt"]
+  s.license = 'MIT'
+  s.files = Dir['License.txt', 'README.md',
+                'Rakefile',
+                # "bin/quality",
+                '{lib}/**/*',
+                'quality.gemspec'] & `git ls-files -z`.split("\0")
+  # s.rdoc_options = ["--main", "README.md"]
+  s.require_paths = ['lib']
+  s.homepage = %q(http://github.com/apiology/quality)
+  # s.rubyforge_project = %q{quality}
+  s.rubygems_version = %q(1.3.6)
+  s.summary = %q(Code quality tools for Ruby)
+
+  s.add_runtime_dependency(%q(cane), ['>= 2.6'])
+  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))
 
   # need above this version to support Ruby 2.0 syntax
-  s.add_runtime_dependency(%q<ruby_parser>, [">= 3.2.2"])
+  s.add_runtime_dependency(%q(ruby_parser), ['>= 3.2.2'])
 
   # cane has an unadvertised dependency on json
-  s.add_runtime_dependency(%q<json>)
+  s.add_runtime_dependency(%q(json))
 
-  s.add_development_dependency(%q<bundler>, [">= 1.1"])
-  s.add_development_dependency(%q<rake>)
-  s.add_development_dependency(%q<simplecov>)
-  s.add_development_dependency(%q<mocha>)
-  # depend on myself, so I can use my own features for development..
-  s.add_development_dependency(%q<quality>)
+  s.add_development_dependency(%q(bundler), ['>= 1.1'])
+  s.add_development_dependency(%q(rake))
+  s.add_development_dependency(%q(simplecov))
+  s.add_development_dependency(%q(mocha))
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quality
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-03 00:00:00.000000000 Z
+date: 2014-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cane
@@ -164,24 +164,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: quality
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: |
+description: |+
   Quality is a tool that runs quality checks on Ruby
   code using rubocop, cane, reek, flog and flay, and makes sure
   your numbers don't get any worse over time.
+
 email:
 - vince@broz.cc
 executables: []
@@ -194,10 +181,16 @@ files:
 - lib/quality/command_output_processor.rb
 - lib/quality/quality_checker.rb
 - lib/quality/rake/task.rb
+- lib/quality/tools/cane.rb
+- lib/quality/tools/flay.rb
+- lib/quality/tools/flog.rb
+- lib/quality/tools/reek.rb
+- lib/quality/tools/rubocop.rb
 - lib/quality/version.rb
 - quality.gemspec
 homepage: http://github.com/apiology/quality
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []