quality 1.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fd46a1c5027604b62f85dbe5fe6a29f95242188
-  data.tar.gz: 3f3da1a73252e2c1b28164084dd3f5f3da8abf89
+  metadata.gz: 4a6c78a9d29f78396f6a42f055cd86b36d675c1f
+  data.tar.gz: c5309355b11fa9fd5670e0608a009d50fd0e0965
 SHA512:
-  metadata.gz: e1894369f734937ee0df1adabf61eb3def10bdd59c70e9bb522d16bff23d0c89e61ecb02f7f6456afc23ac6fb7f1743ac87b3a8e0e66aa3bc4f1359ee0b98da0
-  data.tar.gz: 8751ecd3fe496a94f9de979543b724fd171eab819dc404af2aa3f8382acad3628d96abf3f116a9a7d90085a24e15f8f83ad1158a4da42189e80215e451d65979
+  metadata.gz: bfd3d4b9748a3bb76a8de2869e108f1f1a61bf28b69a012c8c6a3b9cb49992b4d291ccc94e8ba6b23e0b8934ed30c115f94dada91840149bcf1af05f85b0adb1
+  data.tar.gz: eadd84bae67d01c0feabd53ed45b957efd4751de7496c4ac44b881bfc8462a58d3e66f65468b9b57531955d20ffaff2ab83e9bc8020bee2cce205bf900d09376

data/README.md

@@ -1,4 +1,6 @@
 [![Build Status](https://travis-ci.org/apiology/quality.png)](https://travis-ci.org/apiology/quality)
+[![Coverage Status](https://coveralls.io/repos/apiology/quality/badge.png?branch=master)](https://coveralls.io/r/apiology/quality?branch=master)
+
 
 # Quality -- code quality ratchet for Ruby
 
@@ -12,7 +14,20 @@ worse over time.
 $ gem install quality
 ```
 
-and add it to your Rakefile like this:
+or in your Gemfile:
+
+```ruby
+group :development do
+  gem 'quality'
+end
+```
+and then:
+
+```bash
+$ bundle install
+```
+
+Once you have the gem, configure your Rakefile like this:
 
 ```ruby
 require 'quality/rake/task'
@@ -52,22 +67,36 @@ Quality::Rake::Task.new { |t|
 
   # Array of directory names which contain ruby files to analyze.
   #
-  # Defaults to %w{lib test spec feature}, which translates to *.rb in the base directory, as well as lib, test, spec, and feature.
-  t.ruby_dirs = %w{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}
 
   # Relative path to output directory where *_high_water_mark
   # files will be read/written
   #
-  # Defaults to .
-  t.output_dir = '.'
+  # Defaults to 'metrics'
+  t.output_dir = 'metrics'
 }
 ```
 
+## Why
+
+See [this post for more information](http://blog.apiology.cc/2014/06/scalable-quality-part-1.html) on the problem the quality gem solves.
+
+## Maturity
+
+Quality is rapidly evolving, but uses [semantic versioning](http://semver.org/)--any incompatible changes will come out as major number updates.
+
+## Supported Ruby Versions
+
+Tested against Ruby 1.9.3 and 2.1.2.  Feel free to submit issues if problems are found elsewhere.
+
 ## Contributing
 
 * Fork the repo
 * Create a feature branch
-* Submit a pull request
+* Submit a github pull request
+
+Many thanks to all contributors, especially [@andyw8](https://github.com/andyw8), who has contributed some great improvements.
 
 ### Dependencies
 
@@ -82,3 +111,7 @@ Quality makes use of the following other gems, which do the actual checking:
 ### Learn More
 
 * Browse the code or install the latest development version from [https://github.com/apiology/quality/tree](https://github.com/apiology/quality/tree)
+
+## License
+
+Licensed under the MIT license.

data/lib/quality/process_runner.rb

@@ -0,0 +1,19 @@
+require 'English'
+
+module Quality
+  # Wrapper around IO.popen that allows exit status to be mocked in tests.
+  class ProcessRunner
+    def initialize(full_cmd,
+                   dependencies = {})
+      @full_cmd = full_cmd
+      @popener = dependencies[:popener] || IO
+    end
+
+    def run
+      @popener.popen(@full_cmd) do |file|
+        yield file
+      end
+      $CHILD_STATUS.exitstatus
+    end
+  end
+end

data/lib/quality/quality_checker.rb

@@ -1,5 +1,5 @@
 require_relative 'command_output_processor'
-require 'English'
+require_relative 'process_runner'
 
 module Quality
   # Runs a quality-checking, command, checks it agaist the existing
@@ -7,7 +7,6 @@ module Quality
   # 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 =
@@ -15,7 +14,11 @@ module Quality
         Quality::CommandOutputProcessor
       @cmd = cmd
       @command_options = command_options
+      @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
     end
 
     def execute(&count_violations_on_line)
@@ -35,11 +38,12 @@ module Quality
     end
 
     def run_command(processor, &count_violations_on_line)
-      @popener.popen(full_cmd) do |file|
+      runner = @process_runner_class.new(full_cmd)
+
+      runner.run do |file|
         processor.file = file
         @command_output = processor.process(&count_violations_on_line)
       end
-      $CHILD_STATUS.exitstatus
     end
 
     def check_exit_status(exit_status)
@@ -102,7 +106,7 @@ module Quality
 
     def write_violations(new_violations)
       @count_file.open(@filename, 'w') do |file|
-        file.write(new_violations.to_s)
+        file.write(new_violations.to_s + "\n")
       end
     end
   end

data/lib/quality/rake/task.rb

@@ -50,8 +50,8 @@ module Quality
 
       # Array of directory names which contain ruby files to analyze.
       #
-      # Defaults to %w(lib test spec feature), which translates to *.rb in
-      # the base directory, as well as lib, test, and feature.
+      # 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
 
       # Relative path to output directory where *_high_water_mark
@@ -66,7 +66,7 @@ module Quality
 
         @skip_tools = []
 
-        @output_dir = '.'
+        @output_dir = 'metrics'
 
         yield self if block_given?
 
@@ -143,12 +143,10 @@ module Quality
         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
+        if installed && !suppressed
           method("quality_#{tool}".to_sym).call
+        elsif !installed
+          puts "#{tool} not installed"
         end
       end
 
@@ -163,12 +161,11 @@ module Quality
         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
 
       def write_violations(filename, new_violations)
         @count_file.open(filename, 'w') do |file|
-          file.write(new_violations.to_s)
+          file.write(new_violations.to_s + "\n")
         end
       end
 
@@ -178,11 +175,6 @@ module Quality
         existing_violations
       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)
@@ -193,7 +185,7 @@ module Quality
       end
 
       def ruby_dirs
-        @ruby_dirs ||= %w(lib test spec feature)
+        @ruby_dirs ||= %w(app lib test spec feature)
       end
 
       def ruby_files_glob

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 = '1.3.1'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quality
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-16 00:00:00.000000000 Z
+date: 2015-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cane
@@ -179,6 +179,7 @@ files:
 - README.md
 - Rakefile
 - lib/quality/command_output_processor.rb
+- lib/quality/process_runner.rb
 - lib/quality/quality_checker.rb
 - lib/quality/rake/task.rb
 - lib/quality/tools/cane.rb
@@ -208,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Code quality tools for Ruby