cane 2.3.0 → 2.4.0

data/HISTORY.md

@@ -1,5 +1,12 @@
 # Cane History
 
+## 2.4.0 - 21 October 2012 (46949e77)
+
+* Feature: Rake task can load configuration from a `.cane` file.
+* Feature: Coverage threshold can be specifed in a file.
+* Feature: Provide `--all` option for working with single files.
+* Bugfix: Allow README file to be lowercase.
+
 ## 2.3.0 - 16 September 2012 (229252ff)
 
 * Feature: `--json` option for machine-readable output.

data/README.md

@@ -24,7 +24,7 @@ a non-zero exit code if any quality checks fail. Also, a report:
       lib/cane.rb:20   Line length >80
       lib/cane.rb:42   Trailing whitespace
 
-    Class definitions require explanatory comments on preceeding line (1):
+    Class definitions require explanatory comments on preceding line (1):
       lib/cane:3  SomeClass
 
 Customize behaviour with a wealth of options:
@@ -52,6 +52,7 @@ Customize behaviour with a wealth of options:
 
             --gte FILE,THRESHOLD         If FILE contains a number, verify it is >= to THRESHOLD
 
+        -f, --all FILE                   Apply all checks to given file
             --max-violations VALUE       Max allowed violations (default: 0)
             --parallel                   Use all processors. Slower on small projects, faster on large.
 
@@ -86,6 +87,9 @@ Command-line arguments will override arguments specified in the `.cane` file.
       warn "cane not available, quality task not provided."
     end
 
+Loading options from a `.cane` file is supported by setting `canefile=` to the
+file name.
+
 Rescuing `LoadError` is a good idea, since `rake -T` failing is totally
 frustrating.
 

data/lib/cane/cli/parser.rb

@@ -28,6 +28,7 @@ module Cane
         Cane.default_checks.each do |check|
           add_check_options(check)
         end
+        add_checks_shortcut
 
         add_cane_options
 
@@ -48,8 +49,12 @@ module Cane
       end
 
       def get_default_options
-        if Cane::File.exists?('./.cane')
-          Cane::File.contents('./.cane').split(/\s+/m)
+        read_options_from_file './.cane'
+      end
+
+      def read_options_from_file(file)
+        if Cane::File.exists?(file)
+          Cane::File.contents(file).split(/\s+/m)
         else
           []
         end
@@ -116,6 +121,17 @@ BANNER
         parser.separator ""
       end
 
+      def add_checks_shortcut
+        description = "Apply all checks to given file"
+        parser.on("-f", "--all FILE", description) do |f|
+          # This is a bit of a hack, but provides a really useful UI for
+          # dealing with single files. Let's see how it evolves.
+          options[:abc_glob] = f
+          options[:style_glob] = f
+          options[:doc_glob] = f
+        end
+      end
+
       def add_version
         parser.on_tail("-v", "--version", "Show version") do
           stdout.puts Cane::VERSION

data/lib/cane/doc_check.rb

@@ -4,11 +4,11 @@ require 'cane/task_runner'
 module Cane
 
   # Creates violations for class definitions that do not have an explantory
-  # comment immediately preceeding.
+  # comment immediately preceding.
   class DocCheck < Struct.new(:opts)
 
     DESCRIPTION =
-      "Class definitions require explanatory comments on preceeding line"
+      "Class definitions require explanatory comments on preceding line"
 
     def self.key; :doc; end
     def self.name; "documentation checking"; end
@@ -54,13 +54,15 @@ module Cane
 
     def missing_file_violations
       result = []
-      unless opts[:no_readme]
-        unless ['', '.txt', '.md'].any? {|x| Cane::File.exists?("README#{x}") }
-          result << {
-            description: 'Missing documentation',
-            label:       'No README found'
-          }
-        end
+      return result if opts[:no_readme]
+
+      filenames = ['README', 'readme']
+      extensions = ['', '.txt', '.md']
+      combinations = filenames.product(extensions)
+
+      if combinations.none? {|n, x| Cane::File.exists?(n + x) }
+        result << { description: 'Missing documentation',
+                    label: 'No README found' }
       end
       result
     end

data/lib/cane/rake_task.rb

@@ -2,6 +2,7 @@ require 'rake'
 require 'rake/tasklib'
 
 require 'cane/cli/options'
+require 'cane/cli/parser'
 
 module Cane
   # Creates a rake task to run cane with given configuration.
@@ -42,6 +43,12 @@ module Cane
       @options[:checks] = @options[:checks] + [check]
     end
 
+    def canefile=(file)
+      canefile = Cane::CLI::Parser.new
+      canefile.parser.parse!(canefile.read_options_from_file(file))
+      options.merge! canefile.options
+    end
+
     def initialize(task_name = nil)
       self.name = task_name || :cane
       @gte = []

data/lib/cane/threshold_check.rb

@@ -9,17 +9,26 @@ module Cane
     def self.key; :threshold; end
     def self.options
       {
-        gte: ["If FILE contains a number, verify it is >= to THRESHOLD",
+        gte: ["Check the number in FILE is >= to THRESHOLD " +
+              "(a number or another file name)",
                 variable: "FILE,THRESHOLD",
                 type:     Array]
       }
     end
 
     def violations
-      thresholds.map do |operator, file, limit|
-        value = value_from_file(file)
+      thresholds.map do |operator, file, threshold|
+        value = normalized_limit(file)
+        limit = normalized_limit(threshold)
 
-        unless value.send(operator, limit.to_f)
+        if !limit.real?
+          {
+            description: 'Quality threshold could not be read',
+            label:       "%s is not a number or a file" % [
+              threshold
+            ]
+          }
+        elsif !value.send(operator, limit)
           {
             description: 'Quality threshold crossed',
             label:       "%s is %s, should be %s %s" % [
@@ -30,6 +39,12 @@ module Cane
       end.compact
     end
 
+    def normalized_limit(limit)
+      Float(limit)
+    rescue ArgumentError
+      value_from_file(limit)
+    end
+
     def value_from_file(file)
       begin
         contents = Cane::File.contents(file).chomp.to_f
@@ -49,6 +64,7 @@ module Cane
     class UnavailableValue
       def >=(_); false end
       def to_s; 'unavailable' end
+      def real?; false; end
     end
   end
 

data/lib/cane/version.rb

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

data/spec/doc_check_spec.rb

@@ -60,6 +60,9 @@ class Doc; end
     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.txt").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.txt").and_return(false)
 
     violations = check("").violations
     violations.length.should == 1

data/spec/parser_spec.rb

@@ -27,6 +27,18 @@ describe Cane::CLI::Parser do
     result[:max_violations].should == 1
   end
 
+  it 'uses positional arguments as shortcut for individual files' do
+    output, result = run("--all mysinglefile")
+    result[:abc_glob].should == 'mysinglefile'
+    result[:style_glob].should == 'mysinglefile'
+    result[:doc_glob].should == 'mysinglefile'
+
+    output, result = run("--all mysinglefile --abc-glob myotherfile")
+    result[:abc_glob].should == 'myotherfile'
+    result[:style_glob].should == 'mysinglefile'
+    result[:doc_glob].should == 'mysinglefile'
+  end
+
   it 'displays a help message' do
     output, result = run("--help")
 

data/spec/rake_task_spec.rb

@@ -32,6 +32,21 @@ describe Cane::RakeTask do
     out.should include("theopt")
   end
 
+  it 'can be configured using a .cane file' do
+    conf = "--gte 90,99"
+
+    task = Cane::RakeTask.new(:canefile_quality) do |cane|
+      cane.canefile = make_file(conf)
+    end
+
+    task.should_receive(:abort)
+    out = capture_stdout do
+      Rake::Task['canefile_quality'].invoke
+    end
+
+    out.should include("Quality threshold crossed")
+  end
+
   after do
     Rake::Task.clear
   end

data/spec/threshold_check_spec.rb

@@ -3,11 +3,48 @@ require 'spec_helper'
 require 'cane/threshold_check'
 
 describe Cane::ThresholdCheck do
-  it 'returns a value of unavailable when file cannot be read' do
-    check = Cane::ThresholdCheck.new(gte: [['bogus_file', 20]])
-    violations = check.violations
-    violations.length.should == 1
-    violations[0][:label].should ==
-      'bogus_file is unavailable, should be >= 20'
+
+  context "checking violations" do
+
+    context "when the current coverage cannot be read" do
+      it 'reports a violation' do
+        check = Cane::ThresholdCheck.new(gte: [['bogus_file', '20']])
+        violations = check.violations
+        violations.length.should == 1
+        violations[0][:label].should ==
+          'bogus_file is unavailable, should be >= 20.0'
+      end
+    end
+
+    context "when the coverage threshold is incorrectly specified" do
+      it 'reports a violation' do
+        check = Cane::ThresholdCheck.new(gte: [['20', 'bogus_file']])
+        violations = check.violations
+        violations.length.should == 1
+        violations[0][:label].should ==
+          'bogus_file is not a number or a file'
+      end
+    end
+
+  end
+
+  context "normalizing a user supplied value to a threshold" do
+    it "normalizes an integer to itself" do
+      subject.normalized_limit(99).should == 99
+    end
+
+    it "normalizes a float to itself" do
+      subject.normalized_limit(99.6).should == 99.6
+    end
+
+    it "normalizes a valid file to its contents" do
+      subject.normalized_limit(make_file('99.5')).should == 99.5
+    end
+
+    it "normalizes an invalid file to an unavailable value" do
+      limit = subject.normalized_limit("/File.does.not.exist")
+      limit.should be_a Cane::ThresholdCheck::UnavailableValue
+    end
   end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cane
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-16 00:00:00.000000000 Z
+date: 2012-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -154,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Fails your build if code quality thresholds are not met. Provides complexity