cane 2.1.0 → 2.2.0

data/HISTORY.md

@@ -1,5 +1,11 @@
 # Cane History
 
+## 2.2.0 - 26 August 2012 (f4198619)
+
+* Gracefully handle ambiguous options like `-abc-max` (#27)
+* Provide the `--parallel` option to use all processors. This will be faster on
+  larger projects, but slower on smaller ones (#28)
+
 ## 2.1.0 - 26 August 2012 (2962d8fb)
 
 * Support for user-defined checks (#30)

data/README.md

@@ -53,6 +53,7 @@ Customize behaviour with a wealth of options:
             --gte FILE,THRESHOLD         If FILE contains a number, verify it is >= to THRESHOLD
 
             --max-violations VALUE       Max allowed violations (default: 0)
+            --parallel                   Use all processors. Slower on small projects, faster on large.
 
         -v, --version                    Show version
         -h, --help                       Show this message

data/cane.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |gem|
   gem.executables  << "cane"
   gem.version       = Cane::VERSION
   gem.has_rdoc      = false
+  gem.add_dependency 'parallel'
   gem.add_development_dependency 'rspec', '~> 2.0'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'simplecov'

data/lib/cane.rb

@@ -1,3 +1,5 @@
+require 'parallel'
+
 require 'cane/violation_formatter'
 
 module Cane
@@ -6,6 +8,24 @@ module Cane
   end
   module_function :run
 
+  def task_runner(opts)
+    if opts[:parallel]
+      Parallel
+    else
+      SimpleTaskRunner
+    end
+  end
+  module_function :task_runner
+
+  # Mirrors the Parallel gem's interface but does not provide any parralleism.
+  # This is faster for smaller tasks since it doesn't incur any overhead for
+  # creating new processes and communicating between them.
+  class SimpleTaskRunner
+    def self.map(enumerable, &block)
+      enumerable.map(&block)
+    end
+  end
+
   # Orchestrates the running of checks per the provided configuration, and
   # hands the result to a formatter for display. This is the core of the
   # application, but for the actual entry point see `Cane::CLI`.

data/lib/cane/abc_check.rb

@@ -35,7 +35,7 @@ module Cane
     def violations
       return [] if opts[:no_abc] == false
 
-      order file_names.map {|file_name|
+      order worker.map(file_names) {|file_name|
         find_violations(file_name)
       }.flatten
     end
@@ -192,5 +192,9 @@ module Cane
     def exclusions
       opts.fetch(:abc_exclude, []).flatten.to_set
     end
+
+    def worker
+      Cane.task_runner(opts)
+    end
   end
 end

data/lib/cane/cli/parser.rb

@@ -39,7 +39,7 @@ module Cane
         parser.parse!(get_default_options + args)
 
         Cane::CLI.default_options.merge(options)
-      rescue OptionParser::InvalidOption
+      rescue OptionParser::InvalidOption, OptionParser::AmbiguousOption
         args = %w(--help)
         ret = false
         retry
@@ -106,6 +106,10 @@ BANNER
         add_option %w(--max-violations VALUE),
           "Max allowed violations", default: 0, cast: :to_i
 
+        add_option %w(--parallel),
+          "Use all processors. Slower on small projects, faster on large.",
+            cast: ->(x) { x }
+
         parser.separator ""
       end
 

data/lib/cane/doc_check.rb

@@ -24,7 +24,7 @@ module Cane
     def violations
       return [] if opts[:no_doc]
 
-      file_names.map {|file_name|
+      worker.map(file_names) {|file_name|
         find_violations(file_name)
       }.flatten
     end
@@ -60,6 +60,10 @@ module Cane
     def extract_class_name(line)
       line.match(/class ([^\s;]+)/)[1]
     end
+
+    def worker
+      Cane.task_runner(opts)
+    end
   end
 
 end

data/lib/cane/style_check.rb

@@ -34,7 +34,7 @@ module Cane
     def violations
       return [] if opts[:no_style]
 
-      file_list.map do |file_path|
+      worker.map(file_list) do |file_path|
         map_lines(file_path) do |line, line_number|
           violations_for_line(line.chomp).map {|message| {
             file:        file_path,
@@ -77,6 +77,10 @@ module Cane
     def excluded?(file)
       exclusions.include?(file)
     end
+
+    def worker
+      Cane.task_runner(opts)
+    end
   end
 
 end

data/lib/cane/version.rb

@@ -1,3 +1,3 @@
 module Cane
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 end

data/spec/cane_spec.rb

@@ -62,6 +62,12 @@ describe 'The cane application' do
     exitstatus.should == 0
   end
 
+  it 'can run tasks in parallel' do
+    # This spec isn't great, but there is no good way to actually observe that
+    # tasks run in parallel and we want to verify the conditional is correct.
+    Cane.task_runner(parallel: true).should == Parallel
+  end
+
   after do
     if Object.const_defined?(class_name)
       Object.send(:remove_const, class_name)

data/spec/parser_spec.rb

@@ -86,4 +86,15 @@ describe Cane::CLI::Parser do
     result[:abc_glob].should == 'myfile'
     result[:style_glob].should == 'myotherfile'
   end
+
+  it 'allows parallel option' do
+    _, result = run("--parallel")
+    result[:parallel].should be
+  end
+
+  it 'handles ambiguous options' do
+    output, result = run("-abc-max")
+    output.should include("Usage:")
+    result.should_not be
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cane
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-26 00:00:00.000000000 Z
+date: 2012-08-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: &2152738700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152738700
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152567380 !ruby/object:Gem::Requirement
+  requirement: &2152737580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +32,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *2152567380
+  version_requirements: *2152737580
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152566600 !ruby/object:Gem::Requirement
+  requirement: &2152736720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152566600
+  version_requirements: *2152736720
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2152565760 !ruby/object:Gem::Requirement
+  requirement: &2152736000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152565760
+  version_requirements: *2152736000
 - !ruby/object:Gem::Dependency
   name: rspec-fire
-  requirement: &2152564960 !ruby/object:Gem::Requirement
+  requirement: &2152751720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152564960
+  version_requirements: *2152751720
 description: Fails your build if code quality thresholds are not met
 email:
 - xavier@squareup.com