cane 2.5.0 → 2.5.1

data/HISTORY.md

@@ -1,5 +1,12 @@
 # Cane History
 
+## 2.5.1 - 26 January 2013 (93819f19)
+
+* Feature: documentation check supports `.mdown` and `.rdoc` extensions.
+* Feature: expanded threshold regex to support `coverage/.last_run.json` from
+  `SimpleCov`.
+* Compat: Ruby 2.0 compatibility.
+
 ## 2.5.0 - 17 November 2012 (628cc1e9)
 
 * Feature: `--doc-exclude` option to exclude globs from documentation checks.

data/README.md

@@ -112,26 +112,13 @@ recommended).
 
 Any value in a file can be used as a threshold:
 
-    > echo "89" > coverage/covered_percent
-    > cane --gte 'coverage/covered_percent,90'
+    > echo "89" > coverage/.last_run.json
+    > cane --gte 'coverage/.last_run.json,90'
 
     Quality threshold crossed
 
       coverage/covered_percent is 89, should be >= 90
 
-You can use a `SimpleCov` formatter to create the required file:
-
-    class SimpleCov::Formatter::QualityFormatter
-      def format(result)
-        SimpleCov::Formatter::HTMLFormatter.new.format(result)
-        File.open("coverage/covered_percent", "w") do |f|
-          f.puts result.source_files.covered_percent.to_f
-        end
-      end
-    end
-
-    SimpleCov.formatter = SimpleCov::Formatter::QualityFormatter
-
 ## Implementing your own checks
 
 Checks must implement:
@@ -209,7 +196,7 @@ A good README should include at a minimum:
 * Status of the project (spike, active development, stable in production).
 * Compatibility notes (1.8, 1.9, JRuby).
 * Any interesting technical or architectural decisions made on the project
-  (this could be as simple as a to an external design document).
+  (this could be as simple as a link to an external design document).
 
 ## Compatibility
 

data/lib/cane/doc_check.rb

@@ -62,7 +62,7 @@ module Cane
       return result if opts[:no_readme]
 
       filenames = ['README', 'readme']
-      extensions = ['', '.txt', '.md']
+      extensions = ['', '.txt', '.md', '.mdown', '.rdoc']
       combinations = filenames.product(extensions)
 
       if combinations.none? {|n, x| Cane::File.exists?(n + x) }

data/lib/cane/file.rb

@@ -7,7 +7,7 @@ module Cane
   class File
     class << self
       def iterator(path)
-        EncodingAwareIterator.new(open(path).lines)
+        EncodingAwareIterator.new(open(path).each_line)
       end
 
       def contents(path)

data/lib/cane/threshold_check.rb

@@ -47,7 +47,7 @@ module Cane
 
     def value_from_file(file)
       begin
-        contents = Cane::File.contents(file).chomp.to_f
+        contents = Cane::File.contents(file).scan(/\d+\.?\d*/).first.to_f
       rescue Errno::ENOENT
         UnavailableValue.new
       end

data/lib/cane/version.rb

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

data/spec/doc_check_spec.rb

@@ -59,10 +59,14 @@ class Doc; end
     stub_const("Cane::File", file)
     file.should_receive(:exists?).with("README").and_return(false)
     file.should_receive(:exists?).with("README.md").and_return(false)
+    file.should_receive(:exists?).with("README.mdown").and_return(false)
     file.should_receive(:exists?).with("README.txt").and_return(false)
+    file.should_receive(:exists?).with("README.rdoc").and_return(false)
     file.should_receive(:exists?).with("readme").and_return(false)
     file.should_receive(:exists?).with("readme.md").and_return(false)
+    file.should_receive(:exists?).with("readme.mdown").and_return(false)
     file.should_receive(:exists?).with("readme.txt").and_return(false)
+    file.should_receive(:exists?).with("readme.rdoc").and_return(false)
 
     violations = check("").violations
     violations.length.should == 1

data/spec/threshold_check_spec.rb

@@ -4,6 +4,16 @@ require 'cane/threshold_check'
 
 describe Cane::ThresholdCheck do
 
+  let(:simplecov_last_run) do
+    <<-ENDL
+    {
+      "result": {
+        "covered_percent": 93.88
+      }
+    }
+    ENDL
+  end
+
   context "checking violations" do
 
     context "when the current coverage cannot be read" do
@@ -45,6 +55,12 @@ describe Cane::ThresholdCheck do
       limit = subject.normalized_limit("/File.does.not.exist")
       limit.should be_a Cane::ThresholdCheck::UnavailableValue
     end
+
+
+    it 'normalizes a json file to a float' do
+      subject.normalized_limit(make_file(simplecov_last_run)).should == 93.88
+    end
+
   end
 
 end

metadata

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