quality 0.2.12 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0edeca607b817ca04ce01dedc757dfea9b36879d
-  data.tar.gz: f44e13d9324673f926c2189f24a8344c6c048c3c
+  metadata.gz: 3b529fe70947f211e50846ac7eeca8401e7af353
+  data.tar.gz: ae51331dff7e90e9c860631bde9a3001bbcb4be6
 SHA512:
-  metadata.gz: e9ba54c54300f7c0bb4fbe38835ce94d23122269cd337e49c5e0a3c18d04fa79d8b1db8b444299956a336f840cf8b34fe44bc522d6bf2f58661d320898fde286
-  data.tar.gz: 7fafb512806d0221fe10defa3f1cf166053a8cf1028bafcf8284f4edc5756b80ec0691910dd47c97d65e20f1ba92327b75349c29ab0b5cc366d30db07738d164
+  metadata.gz: 96c466f3f82770eb6b591d0f0ab348f616f2656a74ea1abe06ab844c1d44f90be5fc58d4542792dc24d03d255f64a6d0a9177b6061e72eced6b04ff04c300a41
+  data.tar.gz: c27d3c90ec6234412cfaa4583b057d11c19db6d0e7d25bdc9ed585241d445ebb827d6e732ead3fdfdea38c30c445c9aaa58a616f8bd125f63183847559602289

data/README.md

@@ -24,6 +24,44 @@ Then run:
 $ rake quality
 ```
 
+If you want to ratchet up the quality and force yourself to improve
+code, run:
+
+```bash
+$ rake ratchet
+```
+
+## Configuration options
+
+```ruby
+Quality::Rake::Task.new { |t|
+  # Name of quality task.
+  # Defaults to :quality.
+  t.quality_name = "quality" 
+
+  # Name of ratchet task.
+  # Defaults to :ratchet.
+  t.ratchet_name = "ratchet"
+
+  # Array of strings describing tools to be skipped--e.g., ["cane"]
+  #
+  # Defaults to []
+  t.skip_tools = []
+
+  # Array of directory names which contain ruby files to analyze.
+  #
+  # Defaults to %w{lib test features}, which translates to *.rb in the base directory, as well as lib, test, and features.
+  t.ruby_dirs = %w{lib test features}
+
+  # Relative path to output directory where *_high_water_mark
+  # files will be read/written
+  #
+  # Defaults to .
+  t.output_dir = '.'
+}
+```
+
+
 ## 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.

data/Rakefile

@@ -1,5 +1,6 @@
 require 'rake/clean'
 require "bundler/gem_tasks"
+require 'quality/rake/task'
 
 $:.unshift File.dirname(__FILE__) + '/lib'
 
@@ -17,3 +18,15 @@ Dir['tasks/**/*.rake'].each { |t| load t }
 
 task :default => [:test]
 
+Quality::Rake::Task.new
+
+task :clear_metrics do |t|
+  puts Time.now
+  ret =
+    system("git checkout coverage/.last_run.json *_high_water_mark")
+  if !ret
+    fail
+  end
+end
+
+task :localtest => [:clear_metrics, :test, :quality]

data/lib/quality/rake/task.rb

@@ -31,7 +31,11 @@ module Quality
 
       # Name of quality task.
       # Defaults to :quality.
-      attr_accessor :name
+      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"]
       #
@@ -40,13 +44,45 @@ module Quality
 
       # Array of directory names which contain ruby files to analyze.
       #
-      # Defaults to %w{lib test features}, which translates to *.rb in the base directory, as well as lib, test, and features.
+      # Defaults to %w{lib test features}, which translates to *.rb in
+      # the base directory, as well as lib, test, and features.
       attr_writer :ruby_dirs
 
+      # Relative path to output directory where *_high_water_mark
+      # files will be read/written
+      #
+      # Defaults to .
+      attr_writer :output_dir
+
       # Defines a new task, using the name +name+.
       def initialize(args = {})
-        @name = args[:name]
-        @name = 'quality' if @name.nil?
+        @quality_name = args[:quality_name] || 'quality'
+
+        @ratchet_name = args[:ratchet_name] || 'ratchet'
+
+        # allow unit tests to override the class that Rake DSL
+        # messages are sent to.
+        @dsl = args[:dsl]
+
+        # 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
+
+        # likewise, but for IO.read()/IO.exist? on the count files
+        @count_io = args[:count_io] || IO
+
+        # likewise, but for Dir.glob() on target Ruby files
+        @globber = args[:globber] || Dir
+
+        # 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
@@ -58,6 +94,7 @@ module Quality
         yield self if block_given?
         @config_files ||= 'config/**/*.reek'
         @source_files ||= 'lib/**/*.rb'
+        @output_dir   ||= "."
         define
       end
 
@@ -66,11 +103,16 @@ module Quality
       def define # :nodoc:
         desc 'Verify quality has increased or stayed ' +
           'the same' unless ::Rake.application.last_comment
-        task(name) { run_task }
-        self
+        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
       end
 
-      def run_task
+      def run_quality
         tools = ['cane', 'flog', 'flay', 'reek', 'rubocop']
         tools.each do |tool|
           installed = Gem::Specification.find_all_by_name(tool).any?
@@ -86,11 +128,27 @@ module Quality
         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
+        }
+      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]
 
@@ -109,7 +167,7 @@ module Quality
           full_cmd = "#{full_cmd} #{args}"
         end
 
-        IO.popen(full_cmd) do |f|
+        @popener.popen(full_cmd) do |f|
           while line = f.gets
             if emacs_format
               if line =~ /^ *(\S*.rb:[0-9]*) *(.*)/
@@ -132,9 +190,9 @@ module Quality
             fail "Error detected running #{full_cmd}.  Exit status is #{exit_status}, output is [#{out}]"
           end
         end
-        filename = "#{cmd}_high_water_mark"
-        if File.exist?(filename)
-          existing_violations = IO.read(filename).to_i
+        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
@@ -145,13 +203,15 @@ module Quality
             "Reduce total number of #{cmd} violations to #{existing_violations} or below!"
         elsif violations < existing_violations
           puts "Ratcheting quality up..."
-          File.open(filename, 'w') {|f| f.write(violations.to_s) }
+          @count_file.open(filename, 'w') do |f|
+            f.write(violations.to_s)
+          end
         end
       end
 
       def quality_cane
-        if ! File.exist?(".cane")
-          File.open(".cane", "w") {|f| f.write("-f **/*.rb")}
+        if ! @configuration_writer.exist?(".cane")
+          @configuration_writer.open(".cane", "w") {|f| f.write("-f **/*.rb")}
         end
         ratchet_quality_cmd("cane",
                             gives_error_code_on_violations: true,
@@ -169,7 +229,7 @@ module Quality
       end
 
       def ruby_files
-        Dir.glob('*.rb').concat(Dir.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
@@ -231,18 +291,6 @@ module Quality
         }
       end
 
-      def quality
-        Dir.glob("*_high_water_mark").each { |filename|
-          puts "Processing #{filename}"
-          existing_violations = IO.read(filename).to_i
-          if existing_violations <= 0
-            raise "Problem with file #{filename}"
-          end
-          new_violations = existing_violations - 1
-          File.open(filename, 'w') {|f| f.write(new_violations.to_s) }
-          system("git commit -m 'tighten quality standard' #{filename}")
-        }
-      end
     end
   end
 end

data/lib/quality/version.rb

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

data/quality.gemspec

@@ -42,4 +42,8 @@ your numbers don't get any worse over time.
 
   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>)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quality
 version: !ruby/object:Gem::Version
-  version: 0.2.12
+  version: 1.0.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-29 00:00:00.000000000 Z
+date: 2013-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cane
@@ -136,6 +136,48 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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'
+- !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: "Quality is a tool that runs quality checks on Ruby\ncode using rubocop,
   cane, reek, flog and flay, and makes sure \nyour numbers don't get any worse over
   time.\n"