cane 2.6.1 → 2.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1eef945328c09e0abccd91652842a632f639eac0
-  data.tar.gz: 5c154f5d285bea2fd7d5d0549436a16ace066ca8
+  metadata.gz: 4cdf72ffbc2d2703ebc9bced476ff1405f3a8a25
+  data.tar.gz: b52ec92312ffc04e2a2f410705bcbb06bdaebd58
 SHA512:
-  metadata.gz: a4d12974def26b1bfb704167090c2c56a50d5fb134b598821a532fadfb4f75cbce155d017734a2720d06ce851be65bf4a413886ca403a5dde3a2365b3f1fe5bc
-  data.tar.gz: e5a7b0b163105d6eab4e2e92522693552d034503f12e10de7e45268ae80a330ba203e8c77bdb305bfc8fc519a4f29ef71f9f5ee870e974f8c08dc3c7559883a9
+  metadata.gz: a689a6778c6431208400feab3bf99bc19ff9e64b66eadc7550451a8ba32ad1ded12004f191efe4bcb84da10dbc7b9c7336ebd620922b26ada8c049cd85b22f20
+  data.tar.gz: 35a5c4b4c452a092e5e9a63202e850e6144be9c06681648ee0a74da9f713855ddd2493d857bb75bf853f22d659ff0daa1617576f73136775568361d39cded562

data/HISTORY.md

@@ -1,5 +1,11 @@
 # Cane History
 
+## 2.6.2 - 20 April 2014 (8f54b4)
+
+* Bugfix: Commented methods no longer trigger a documentation violation for
+  empty modules.
+* Feature: Ruby 2.1 supported.
+
 ## 2.6.1 - 30 October 2013 (2ea008)
 
 * Feature: Don't require doc for one-line class w/out method.

data/lib/cane/doc_check.rb

@@ -118,7 +118,7 @@ module Cane
     end
 
     def method_definition?(line)
-      line =~ METHOD_REGEX
+      !comment?(line) && line =~ METHOD_REGEX
     end
 
     def class_definition?(line)

data/lib/cane/version.rb

@@ -1,3 +1,3 @@
 module Cane
-  VERSION = '2.6.1'
+  VERSION = '2.6.2'
 end

data/spec/cli_spec.rb

@@ -5,8 +5,8 @@ require 'cane/cli'
 describe Cane::CLI do
   describe '.run' do
 
-    let!(:parser) { fire_replaced_class_double("Cane::CLI::Parser") }
-    let!(:cane)   { fire_replaced_class_double("Cane") }
+    let!(:parser) { class_double("Cane::CLI::Parser").as_stubbed_const }
+    let!(:cane)   { class_double("Cane").as_stubbed_const }
 
     it 'runs Cane with the given arguments' do
       parser.should_receive(:parse).with("--args").and_return(args: true)

data/spec/doc_check_spec.rb

@@ -35,6 +35,10 @@ module NoDocIsFine
     def mixin
     end
   end
+end
+module NoViolationCozComment
+  # def method should ignore this comment
+  # end
 end
     RUBY
 
@@ -100,7 +104,7 @@ class Doc; end
   end
 
   it 'creates a violation for missing README' do
-    file = fire_replaced_class_double("Cane::File")
+    file = class_double("Cane::File").as_stubbed_const
     stub_const("Cane::File", file)
     file.should_receive(:case_insensitive_glob).with("README*").and_return([])
 
@@ -113,7 +117,7 @@ class Doc; end
   end
 
   it 'does not create a violation when readme exists' do
-    file = fire_replaced_class_double("Cane::File")
+    file = class_double("Cane::File").as_stubbed_const
     stub_const("Cane::File", file)
     file
       .should_receive(:case_insensitive_glob)

data/spec/parser_spec.rb

@@ -109,7 +109,7 @@ describe Cane::CLI::Parser do
       --abc-glob myfile
       --style-glob myfile
     EOS
-    file = fire_replaced_class_double("Cane::File")
+    file = class_double("Cane::File").as_stubbed_const
     stub_const("Cane::File", file)
     file.should_receive(:exists?).with('./.cane').and_return(true)
     file.should_receive(:contents).with('./.cane').and_return(defaults)

data/spec/runner_spec.rb

@@ -10,7 +10,7 @@ describe Cane::Runner do
     end
 
     it 'returns JSON output' do
-      formatter = fire_replaced_class_double("Cane::JsonFormatter")
+      formatter = class_double("Cane::JsonFormatter").as_stubbed_const
       formatter.should_receive(:new).and_return("JSON")
       buffer = StringIO.new("")
 

data/spec/threshold_check_spec.rb

@@ -36,7 +36,7 @@ describe Cane::ThresholdCheck do
 
     context 'when coverage threshold is valid' do
       before do
-        file = fire_replaced_class_double("Cane::File")
+        file = class_double("Cane::File").as_stubbed_const
         stub_const("Cane::File", file)
         file.should_receive(:contents).with('x').and_return("8\n")
       end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: cane
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.6.2
 platform: ruby
 authors:
 - Xavier Shay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-31 00:00:00.000000000 Z
+date: 2014-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   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: 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: rspec-fire
   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: Fails your build if code quality thresholds are not met
@@ -88,24 +88,16 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- spec/abc_check_spec.rb
-- spec/cane_spec.rb
-- spec/cli_spec.rb
-- spec/doc_check_spec.rb
-- spec/encoding_aware_iterator_spec.rb
-- spec/file_spec.rb
-- spec/json_formatter_spec.rb
-- spec/parser_spec.rb
-- spec/rake_task_spec.rb
-- spec/runner_spec.rb
-- spec/spec_helper.rb
-- spec/style_check_spec.rb
-- spec/threshold_check_spec.rb
-- spec/violation_formatter_spec.rb
+- HISTORY.md
+- LICENSE
+- README.md
+- bin/cane
+- cane.gemspec
+- lib/cane.rb
 - lib/cane/abc_check.rb
+- lib/cane/cli.rb
 - lib/cane/cli/options.rb
 - lib/cane/cli/parser.rb
-- lib/cane/cli.rb
 - lib/cane/default_checks.rb
 - lib/cane/doc_check.rb
 - lib/cane/encoding_aware_iterator.rb
@@ -118,12 +110,20 @@ files:
 - lib/cane/threshold_check.rb
 - lib/cane/version.rb
 - lib/cane/violation_formatter.rb
-- lib/cane.rb
-- README.md
-- HISTORY.md
-- LICENSE
-- cane.gemspec
-- bin/cane
+- spec/abc_check_spec.rb
+- spec/cane_spec.rb
+- spec/cli_spec.rb
+- spec/doc_check_spec.rb
+- spec/encoding_aware_iterator_spec.rb
+- spec/file_spec.rb
+- spec/json_formatter_spec.rb
+- spec/parser_spec.rb
+- spec/rake_task_spec.rb
+- spec/runner_spec.rb
+- spec/spec_helper.rb
+- spec/style_check_spec.rb
+- spec/threshold_check_spec.rb
+- spec/violation_formatter_spec.rb
 homepage: http://github.com/square/cane
 licenses:
 - Apache 2.0
@@ -134,17 +134,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Fails your build if code quality thresholds are not met. Provides complexity