cane 2.4.0 → 2.5.0

data/HISTORY.md

@@ -1,5 +1,10 @@
 # Cane History
 
+## 2.5.0 - 17 November 2012 (628cc1e9)
+
+* Feature: `--doc-exclude` option to exclude globs from documentation checks.
+* Feature: `--style-exclude` supports globbing.
+
 ## 2.4.0 - 21 October 2012 (46949e77)
 
 * Feature: Rake task can load configuration from a `.cane` file.

data/README.md

@@ -44,16 +44,19 @@ Customize behaviour with a wealth of options:
 
             --style-glob GLOB            Glob to run style checks over (default: {app,lib,spec}/**/*.rb)
             --style-measure VALUE        Max line length (default: 80)
-            --style-exclude FILE         Exclude file from style checking
+            --style-exclude GLOB         Exclude file or glob from style checking
             --no-style                   Disable style checking
 
             --doc-glob GLOB              Glob to run doc checks over (default: {app,lib}/**/*.rb)
+            --doc-exclude GLOB           Exclude file or glob from documentation checking
+            --no-readme                  Disable readme checking
             --no-doc                     Disable documentation checking
 
-            --gte FILE,THRESHOLD         If FILE contains a number, verify it is >= to THRESHOLD
+            --gte FILE,THRESHOLD         Check the number in FILE is >= to THRESHOLD (a number or another file name)
 
         -f, --all FILE                   Apply all checks to given file
             --max-violations VALUE       Max allowed violations (default: 0)
+            --json                       Output as JSON
             --parallel                   Use all processors. Slower on small projects, faster on large.
 
         -v, --version                    Show version

data/cane.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |gem|
   gem.homepage      = "http://github.com/square/cane"
 
   gem.executables   = []
+  gem.required_ruby_version = '>= 1.9.0'
   gem.files         = Dir.glob("{spec,lib}/**/*.rb") + %w(
                         README.md
                         HISTORY.md

data/lib/cane/doc_check.rb

@@ -14,12 +14,17 @@ module Cane
     def self.name; "documentation checking"; end
     def self.options
       {
-        doc_glob:  ['Glob to run doc checks over',
-                       default:  '{app,lib}/**/*.rb',
-                       variable: 'GLOB',
-                       clobber:  :no_doc],
-        no_readme: ['Disable readme checking', cast: ->(x) { !x }],
-        no_doc:    ['Disable documentation checking', cast: ->(x) { !x }]
+        doc_glob:    ['Glob to run doc checks over',
+                        default:  '{app,lib}/**/*.rb',
+                        variable: 'GLOB',
+                        clobber:  :no_doc],
+        doc_exclude: ['Exclude file or glob from documentation checking',
+                        variable: 'GLOB',
+                        type: Array,
+                        default: [],
+                        clobber: :no_doc],
+        no_readme:   ['Disable readme checking', cast: ->(x) { !x }],
+        no_doc:      ['Disable documentation checking', cast: ->(x) { !x }]
       }
     end
 
@@ -68,7 +73,7 @@ module Cane
     end
 
     def file_names
-      Dir[opts.fetch(:doc_glob)]
+      Dir[opts.fetch(:doc_glob)].reject { |file| excluded?(file) }
     end
 
     def class_definition?(line)
@@ -83,6 +88,16 @@ module Cane
       line.match(/class\s+([^\s;]+)/)[1]
     end
 
+    def exclusions
+      @exclusions ||= opts.fetch(:doc_exclude, []).flatten.map do |i|
+        Dir[i]
+      end.flatten.to_set
+    end
+
+    def excluded?(file)
+      exclusions.include?(file)
+    end
+
     def worker
       Cane.task_runner(opts)
     end

data/lib/cane/style_check.rb

@@ -23,8 +23,8 @@ module Cane
                            default: 80,
                            cast:    :to_i,
                            clobber: :no_style],
-        style_exclude: ['Exclude file from style checking',
-                         variable: 'FILE',
+        style_exclude: ['Exclude file or glob from style checking',
+                         variable: 'GLOB',
                          type: Array,
                          default: [],
                          clobber: :no_style],
@@ -72,7 +72,9 @@ module Cane
     end
 
     def exclusions
-      @exclusions ||= opts.fetch(:style_exclude, []).flatten.to_set
+      @exclusions ||= opts.fetch(:style_exclude, []).flatten.map do |i|
+        Dir[i]
+      end.flatten.to_set
     end
 
     def excluded?(file)

data/lib/cane/version.rb

@@ -1,3 +1,3 @@
 module Cane
-  VERSION = '2.4.0'
+  VERSION = '2.5.0'
 end

data/spec/doc_check_spec.rb

@@ -71,4 +71,30 @@ class Doc; end
       "Missing documentation", "No README found"
     ]
   end
+
+  it 'skips declared exclusions' do
+    file_name = make_file <<-FILE.gsub /^\s{6}/, ''
+      class NeedsDocumentation
+      end
+    FILE
+
+    violations = check(file_name,
+      doc_exclude: [file_name]
+    ).violations
+
+    violations.length.should == 0
+  end
+
+  it 'skips declared glob-based exclusions' do
+    file_name = make_file <<-FILE.gsub /^\s{6}/, ''
+      class NeedsDocumentation
+      end
+    FILE
+
+    violations = check(file_name,
+      doc_exclude: ["#{File.dirname(file_name)}/*"]
+    ).violations
+
+    violations.length.should == 0
+  end
 end

data/spec/parser_spec.rb

@@ -63,11 +63,13 @@ describe Cane::CLI::Parser do
   it 'supports exclusions' do
     options = [
       "--abc-exclude", "Harness#complex_method",
+      "--doc-exclude", 'myfile',
       "--style-exclude", 'myfile'
     ].join(' ')
 
     _, result = run(options)
     result[:abc_exclude].should == [['Harness#complex_method']]
+    result[:doc_exclude].should == [['myfile']]
     result[:style_exclude].should == [['myfile']]
   end
 

data/spec/style_check_spec.rb

@@ -33,6 +33,17 @@ describe Cane::StyleCheck do
     violations.length.should == 0
   end
 
+  it 'skips declared glob-based exclusions' do
+    file_name = make_file(ruby_with_style_issue)
+
+    violations = check(file_name,
+      style_measure: 80,
+      style_exclude: ["#{File.dirname(file_name)}/*"]
+    ).violations
+
+    violations.length.should == 0
+  end
+
   it 'does not include trailing new lines in the character count' do
     file_name = make_file('#' * 80 + "\n" + '#' * 80)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cane
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-21 00:00:00.000000000 Z
+date: 2012-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2156715960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,15 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2156715960
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2156715440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -37,15 +32,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
+  version_requirements: *2156715440
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2156715000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -53,15 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2156715000
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2156714520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -69,15 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2156714520
 - !ruby/object:Gem::Dependency
   name: rspec-fire
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2156714100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -85,12 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2156714100
 description: Fails your build if code quality thresholds are not met
 email:
 - xavier@squareup.com
@@ -145,7 +120,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -154,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Fails your build if code quality thresholds are not met. Provides complexity