cane 2.0.0 → 2.1.0

data/HISTORY.md

@@ -1,17 +1,29 @@
 # Cane History
 
+## 2.1.0 - 26 August 2012 (2962d8fb)
+
+* Support for user-defined checks (#30)
+
 ## 2.0.0 - 19 August 2012 (35cae086)
 
 * ABC check labels  `MyClass = Struct.new {}` and `Class.new` correctly (#20)
 * Magic comments (`# encoding: utf-8`) are not recognized as appropriate class documentation (#21)
 * Invalid UTF-8 is handled correctly (#22)
 * Gracefully handle unknown options
-* ABC check output uses a standard format (Foo::Bar#method rather than Foo > Bar > method)
+* ABC check output uses a standard format (`Foo::Bar#method` rather than `Foo > Bar > method`)
 * **BREAKING** Add `--abc-exclude`, `--style-exclude` CLI flags, remove YAML support
 * **BREAKING-INTERNAL** Use hashes rather than explicit violation classes
 * **BREAKING-INTERNAL** Remove translator class, pass CLI args direct to checks
 * **INTERNAL** Wiring in a new check only requires changing one file (#15)
 
+This snippet will convert your YAML exclusions file to the new CLI syntax:
+
+    y = YAML.load(File.read('exclusions.yml'))
+    puts (
+      y.fetch('abc',   []).map {|x| %|--abc-exclude "#{x}"| } +
+      y.fetch('style', []).map {|x| %|--style-exclude "#{x}"| }
+    ).join("\n")
+
 ## 1.4.0 - 2 July 2012 (1afc999d)
 
 * Allow files and methods to be whitelisted (#16)

data/README.md

@@ -32,7 +32,10 @@ Customize behaviour with a wealth of options:
     > cane --help
     Usage: cane [options]
 
-    You can also put these options in a .cane file.
+    Default options are loaded from a .cane file in the current directory.
+
+        -r, --require FILE               Load a Ruby file containing user-defined checks
+        -c, --check CLASS                Use the given user-defined check
 
             --abc-glob GLOB              Glob to run ABC metrics over (default: {app,lib}/**/*.rb)
             --abc-max VALUE              Ignore methods under this complexity (default: 15)
@@ -54,16 +57,15 @@ Customize behaviour with a wealth of options:
         -v, --version                    Show version
         -h, --help                       Show this message
 
-Set default options into a `.cane` file:
+Set default options using a `.cane` file:
 
     > cat .cane
     --no-doc
     --abc-glob **/*.rb
     > cane
 
-It works just like this:
-
-    > cane --no-doc --abc-glob '**/*.rb'
+It works exactly the same as specifying the options on the command-line.
+Command-line arguments will override arguments specified in the `.cane` file.
 
 ## Integrating with Rake
 
@@ -94,7 +96,9 @@ on to an existing application that may already have many violations. By setting
 the maximum to the current number, no immediate changes will be required to
 your existing code base, but you will be protected from things getting worse.
 
-You can also consider defining exclusions for each violation (see below).
+You may also consider beginning with high thresholds and ratcheting them down
+over time, or defining exclusions for specific troublesome violations (not
+recommended).
 
 ## Integrating with SimpleCov
 
@@ -120,12 +124,54 @@ You can use a `SimpleCov` formatter to create the required file:
 
     SimpleCov.formatter = SimpleCov::Formatter::QualityFormatter
 
+## Implementing your own checks
+
+Checks must implement:
+
+* A class level `options` method that returns a hash of available options. This
+  will be included in help output if the check is added before `--help`. If
+  your check does not require any configuration, return an empty hash.
+* A one argument constructor, into which will be passed the options specified
+  for your check.
+* A `violations` method that returns an array of violations.
+
+See existing checks for guidance. Create your check in a new file:
+
+    # unhappy.rb
+    class UnhappyCheck < Struct.new(:opts)
+      def self.options
+        {
+          unhappy_file: ["File to check", default: [nil]]
+        }
+      end
+
+      def violations
+        [
+          description: "Files are unhappy",
+          file:        opts.fetch(:unhappy_file),
+          label:       ":("
+        ]
+      end
+    end
+
+Include your check either using command-line options:
+
+    cane -r unhappy.rb --check UnhappyCheck --unhappy-file myfile
+
+Or in your rake task:
+
+    require 'unhappy'
+
+    Cane::RakeTask.new(:quality) do |c|
+      c.use UnhappyCheck, unhappy_file: 'myfile'
+    end
+
 ## Compatibility
 
 Requires MRI 1.9, since it depends on the `ripper` library to calculate
 complexity metrics. This only applies to the Ruby used to run Cane, not the
 project it is being run against. In other words, you can run Cane against your
-1.8 project.
+1.8 or JRuby project.
 
 ## Support
 

data/cane.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rspec', '~> 2.0'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'rspec-fire'
 end

data/lib/cane.rb

@@ -10,9 +10,9 @@ module Cane
   # hands the result to a formatter for display. This is the core of the
   # application, but for the actual entry point see `Cane::CLI`.
   class Runner
-    def initialize(opts, checks)
-      @opts = opts
-      @checks = checks
+    def initialize(spec)
+      @opts = spec
+      @checks = spec[:checks]
     end
 
     def run

data/lib/cane/cli.rb

@@ -1,16 +1,16 @@
 require 'cane'
 require 'cane/version'
 
-require 'cane/cli/spec'
+require 'cane/cli/parser'
 
 module Cane
   module CLI
     def run(args)
-      opts = Spec.new.parse(args)
-      if opts.is_a?(Hash)
-        Cane.run(opts, Spec::CHECKS)
+      spec = Parser.parse(args)
+      if spec.is_a?(Hash)
+        Cane.run(spec)
       else
-        opts
+        spec
       end
     end
     module_function :run

data/lib/cane/cli/options.rb

@@ -0,0 +1,28 @@
+require 'cane/default_checks'
+
+module Cane
+  module CLI
+    def defaults(check)
+      check.options.each_with_object({}) {|(k, v), h|
+        option_opts = v[1] || {}
+        if option_opts[:type] == Array
+          h[k] = []
+        else
+          h[k] = option_opts[:default]
+        end
+      }
+    end
+    module_function :defaults
+
+    def default_options
+      {
+        max_violations:  0,
+        exclusions_file: nil,
+        checks:          Cane.default_checks
+      }.merge(Cane.default_checks.inject({}) {|a, check|
+        a.merge(defaults(check))
+      })
+    end
+    module_function :default_options
+  end
+end

data/lib/cane/cli/{spec.rb → parser.rb}

@@ -1,38 +1,31 @@
 require 'optparse'
 
-require 'cane/abc_check'
-require 'cane/style_check'
-require 'cane/doc_check'
-require 'cane/threshold_check'
+require 'cane/default_checks'
+require 'cane/cli/options'
+require 'cane/version'
 
 module Cane
   module CLI
 
     # Provides a specification for the command line interface that drives
     # documentation, parsing, and default values.
-    class Spec
-      CHECKS = [AbcCheck, StyleCheck, DocCheck, ThresholdCheck]
-
-      def self.defaults(check)
-        x = check.options.each_with_object({}) {|(k, v), h|
-          h[k] = (v[1] || {})[:default]
-        }
-        x
-      end
-
-      OPTIONS = {
-        max_violations:  0,
-        exclusions_file: nil,
-      }.merge(CHECKS.inject({}) {|a, check| a.merge(defaults(check)) })
+    class Parser
 
       # Exception to indicate that no further processing is required and the
       # program can exit. This is used to handle --help and --version flags.
       class OptionsHandled < RuntimeError; end
 
-      def initialize
+      def self.parse(*args)
+        new.parse(*args)
+      end
+
+      def initialize(stdout = $stdout)
+        @stdout = stdout
+
         add_banner
+        add_user_defined_checks
 
-        CHECKS.each do |check|
+        Cane.default_checks.each do |check|
           add_check_options(check)
         end
 
@@ -45,7 +38,7 @@ module Cane
       def parse(args, ret = true)
         parser.parse!(get_default_options + args)
 
-        OPTIONS.merge(options)
+        Cane::CLI.default_options.merge(options)
       rescue OptionParser::InvalidOption
         args = %w(--help)
         ret = false
@@ -55,8 +48,8 @@ module Cane
       end
 
       def get_default_options
-        if ::File.exists?('./.cane')
-          ::File.read('./.cane').gsub("\n", ' ').split(' ')
+        if Cane::File.exists?('./.cane')
+          Cane::File.contents('./.cane').split(/\s+/m)
         else
           []
         end
@@ -66,11 +59,26 @@ module Cane
         parser.banner = <<-BANNER
 Usage: cane [options]
 
-You can also put these options in a .cane file.
+Default options are loaded from a .cane file in the current directory.
 
 BANNER
       end
 
+      def add_user_defined_checks
+        description = "Load a Ruby file containing user-defined checks"
+        parser.on("-r", "--require FILE", description) do |f|
+          load(f)
+        end
+
+        description = "Use the given user-defined check"
+        parser.on("-c", "--check CLASS", description) do |c|
+          check = Kernel.const_get(c)
+          options[:checks] << check
+          add_check_options(check)
+        end
+        parser.separator ""
+      end
+
       def add_check_options(check)
         check.options.each do |key, data|
           cli_key  = key.to_s.tr('_', '-')
@@ -103,14 +111,14 @@ BANNER
 
       def add_version
         parser.on_tail("-v", "--version", "Show version") do
-          puts Cane::VERSION
+          stdout.puts Cane::VERSION
           raise OptionsHandled
         end
       end
 
       def add_help
         parser.on_tail("-h", "--help", "Show this message") do
-          puts parser
+          stdout.puts parser
           raise OptionsHandled
         end
       end
@@ -131,12 +139,16 @@ BANNER
       end
 
       def options
-        @options ||= {}
+        @options ||= {
+          checks: Cane.default_checks
+        }
       end
 
       def parser
         @parser ||= OptionParser.new
       end
+
+      attr_reader :stdout
     end
 
   end

data/lib/cane/default_checks.rb

@@ -0,0 +1,16 @@
+require 'cane/abc_check'
+require 'cane/style_check'
+require 'cane/doc_check'
+require 'cane/threshold_check'
+
+module Cane
+  def default_checks
+    [
+      AbcCheck,
+      StyleCheck,
+      DocCheck,
+      ThresholdCheck
+    ]
+  end
+  module_function :default_checks
+end

data/lib/cane/doc_check.rb

@@ -31,7 +31,7 @@ module Cane
 
     def find_violations(file_name)
       last_line = ""
-      Cane::File.iterator(file_name).map_with_index do |line, number|
+      Cane::File.iterator(file_name).map.with_index do |line, number|
         result = if class_definition?(line) && !comment?(last_line)
           {
             file:        file_name,

data/lib/cane/encoding_aware_iterator.rb

@@ -1,35 +1,30 @@
 module Cane
 
   # Provides iteration over lines (from a file), correctly handling encoding.
-  class EncodingAwareIterator < Struct.new(:lines)
-    def map_with_index(&block)
-      lines.map.with_index do |line, index|
-        with_encoding_retry(line) do
-          block.call(line, index)
-        end
-      end
+  class EncodingAwareIterator
+    include Enumerable
+
+    def initialize(lines)
+      @lines = lines
     end
 
-    protected
+    def each(&block)
+      return Enumerator.new(self, :each) unless block
 
-    # This is to avoid re-encoding every line, since most are valid. I should
-    # performance test this but haven't (maybe can just re-encode always but my
-    # hunch says no).
-    def with_encoding_retry(line, &block)
-      retried = false
-      begin
-        block.call(line)
-      rescue ArgumentError
-        if retried
-          # I haven't seen input that causes this to occur. Please report it!
-          raise
-        else
+      lines.each do |line|
+        begin
+          line =~ /\s/
+        rescue ArgumentError
           line.encode!('UTF-8', 'UTF-8', invalid: :replace)
-          retried = true
-          retry
         end
+
+        block.call(line)
       end
     end
+
+    protected
+
+    attr_reader :lines
   end
 
 end

data/lib/cane/file.rb

@@ -17,6 +17,10 @@ module Cane
       def open(path)
         ::File.open(path, 'r:utf-8')
       end
+
+      def exists?(path)
+        ::File.exists?(path)
+      end
     end
   end
 end

data/lib/cane/rake_task.rb

@@ -1,7 +1,7 @@
 require 'rake'
 require 'rake/tasklib'
 
-require 'cane/cli/spec'
+require 'cane/cli/options'
 
 module Cane
   # Creates a rake task to run cane with given configuration.
@@ -17,22 +17,36 @@ module Cane
   #   end
   class RakeTask < ::Rake::TaskLib
     attr_accessor :name
-    OPTIONS = Cane::CLI::Spec::OPTIONS
-    OPTIONS.each do |name, value|
-      attr_accessor name
+    attr_reader :options
+
+    Cane::CLI.default_options.keys.each do |name|
+      define_method(name) do
+        options.fetch(name)
+      end
+
+      define_method("#{name}=") do |v|
+        options[name] = v
+      end
     end
 
     # Add a threshold check. If the file exists and it contains a number,
     # compare that number with the given value using the operator.
     def add_threshold(file, operator, value)
       if operator == :>=
-        @gte << [file, value]
+        @options[:gte] << [file, value]
       end
     end
 
+    def use(check, options = {})
+      @options.merge!(options)
+      @options[:checks] = @options[:checks] + [check]
+    end
+
     def initialize(task_name = nil)
       self.name = task_name || :cane
       @gte = []
+      @options = Cane::CLI.default_options
+
       yield self if block_given?
 
       unless ::Rake.application.last_comment
@@ -41,15 +55,7 @@ module Cane
 
       task name do
         require 'cane/cli'
-        abort unless Cane.run(OPTIONS.merge(options), Cane::CLI::Spec::CHECKS)
-      end
-    end
-
-    def options
-      OPTIONS.keys.inject({}) do |opts, setting|
-        value = self.send(setting)
-        opts[setting] = value unless value.nil?
-        opts
+        abort unless Cane.run(options)
       end
     end
   end

data/lib/cane/style_check.rb

@@ -67,7 +67,7 @@ module Cane
     end
 
     def map_lines(file_path, &block)
-      Cane::File.iterator(file_path).map_with_index(&block)
+      Cane::File.iterator(file_path).map.with_index(&block)
     end
 
     def exclusions

data/lib/cane/version.rb

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

data/spec/cane_spec.rb

@@ -2,26 +2,14 @@ require 'spec_helper'
 require "stringio"
 require 'cane/cli'
 
-describe 'Cane' do
-  def capture_stdout &block
-    real_stdout, $stdout = $stdout, StringIO.new
-    yield
-    $stdout.string
-  ensure
-    $stdout = real_stdout
-  end
+require 'cane/rake_task'
 
-  def run(cli_args)
-    result = nil
-    output = capture_stdout do
-      result = Cane::CLI.run(['--no-abc'] + cli_args.split(' '))
-    end
+# Acceptance tests
+describe 'The cane application' do
+  let(:class_name) { "C#{rand(10 ** 10)}" }
 
-    [output, result ? 0 : 1]
-  end
-
-  it 'fails if ABC metric does not meet requirements' do
-    file_name = make_file(<<-RUBY)
+  it 'returns a non-zero exit code and a details of checks that failed' do
+    fn = make_file(<<-RUBY + "  ")
       class Harness
         def complex_method(a)
           if a < 2
@@ -33,126 +21,37 @@ describe 'Cane' do
       end
     RUBY
 
-    _, exitstatus = run("--abc-glob #{file_name} --abc-max 1")
-
-    exitstatus.should == 1
-  end
-
-  it 'fails if style metrics do not meet requirements' do
-    file_name = make_file("whitespace ")
-
-    output, exitstatus = run("--style-glob #{file_name}")
-    output.should include("Lines violated style requirements")
-    exitstatus.should == 1
-  end
-
-  it 'allows measure to be configured' do
-    file_name = make_file("toolong")
-
-    output, exitstatus = run("--style-glob #{file_name} --style-measure 3")
-    exitstatus.should == 1
-    output.should include("Lines violated style requirements")
-  end
-
-  it 'does not include trailing new lines in the character count' do
-    file_name = make_file('#' * 80 + "\n" + '#' * 80)
-
-    output, exitstatus = run("--style-glob #{file_name} --style-measure 80")
-    exitstatus.should == 0
-    output.should == ""
-  end
-
-  it 'allows upper bound of failed checks' do
-    file_name = make_file("whitespace ")
-
-    output, exitstatus = run("--style-glob #{file_name} --max-violations 1")
-    exitstatus.should == 0
-    output.should include("Lines violated style requirements")
-  end
-
-  it 'allows checking of a value in a file' do
-    file_name = make_file("89")
-
-    output, exitstatus = run("--gte #{file_name},90")
-    output.should include("Quality threshold crossed")
-    exitstatus.should == 1
-  end
-
-  it 'allows checking of class documentation' do
-    file_name = make_file("class NoDoc")
-
-    output, exitstatus = run("--doc-glob #{file_name}")
-    exitstatus.should == 1
-    output.should include("Classes are not documented")
-  end
-
-  context 'with a .cane file' do
-    before(:each) do
-      file_name = make_file("class NoDoc")
-      make_dot_cane("--doc-glob #{file_name}")
-    end
-
-    after(:each) do
-      unmake_dot_cane
-    end
-
-    it 'loads options from a .cane file' do
-      output, exitstatus = run('')
-
-      exitstatus.should == 1
-      output.should include("Classes are not documented")
-    end
-  end
-
-  it 'displays a help message' do
-    output, exitstatus = run("--help")
-
-    exitstatus.should == 0
-    output.should include("Usage:")
-  end
-
-  it 'displays version' do
-    output, exitstatus = run("--version")
-
-    exitstatus.should == 0
-    output.should include(Cane::VERSION)
-  end
-
-  it 'uses the last of conflicting arguments' do
-    file_name = make_file("class NoDoc")
-
-    run("--doc-glob #{file_name} --no-doc").should ==
-      run("--no-doc")
-
-    run("--no-doc --doc-glob #{file_name}").should ==
-      run("--doc-glob #{file_name}")
-  end
+    check_file = make_file <<-RUBY
+      class #{class_name} < Struct.new(:opts)
+        def self.options
+          {
+            unhappy_file: ["File to check", default: [nil]]
+          }
+        end
 
-  it 'supports exclusions' do
-    line_with_whitespace = "whitespace "
-    file_name = make_file(<<-RUBY)
-      # #{line_with_whitespace}
-      class Harness
-        def complex_method(a)
-          if a < 2
-            return "low"
-          else
-            return "high"
-          end
+        def violations
+          [
+            description: "Files are unhappy",
+            file:        opts.fetch(:unhappy_file),
+            label:       ":("
+          ]
         end
       end
     RUBY
 
-    options = [
-      "--abc-glob", file_name,
-      "--abc-exclude", "Harness#complex_method",
-      "--abc-max", 1,
-      "--style-glob", file_name,
-      "--style-exclude", file_name
-    ].join(' ')
-
-    _, exitstatus = run(options)
-    exitstatus.should == 0
+    output, exitstatus = run %(
+      --style-glob #{fn}
+      --doc-glob #{fn}
+      --abc-glob #{fn}
+      --abc-max 1
+      -r #{check_file}
+      --check #{class_name}
+      --unhappy-file #{fn}
+    )
+    output.should include("Lines violated style requirements")
+    output.should include("Classes are not documented")
+    output.should include("Methods exceeded maximum allowed ABC complexity")
+    exitstatus.should == 1
   end
 
   it 'handles invalid unicode input' do
@@ -163,10 +62,20 @@ describe 'Cane' do
     exitstatus.should == 0
   end
 
-  it 'handles invalid options by showing help' do
-    out, exitstatus = run("--bogus")
+  after do
+    if Object.const_defined?(class_name)
+      Object.send(:remove_const, class_name)
+    end
+  end
 
-    out.should include("Usage:")
-    exitstatus.should == 1
+  def run(cli_args)
+    result = nil
+    output = capture_stdout do
+      result = Cane::CLI.run(
+        %w(--no-abc --no-style --no-doc) + cli_args.split(/\s+/m)
+      )
+    end
+
+    [output, result ? 0 : 1]
   end
 end

data/spec/cli_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+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") }
+
+    it 'runs Cane with the given arguments' do
+      parser.should_receive(:parse).with("--args").and_return(args: true)
+      cane.should_receive(:run).with(args: true).and_return("tracer")
+
+      described_class.run("--args").should == "tracer"
+    end
+
+    it 'does not run Cane if parser was able to handle input' do
+      parser.should_receive(:parse).with("--args").and_return("tracer")
+
+      described_class.run("--args").should == "tracer"
+    end
+  end
+end

data/spec/encoding_aware_iterator_spec.rb

@@ -8,7 +8,8 @@ require 'cane/encoding_aware_iterator'
 describe Cane::EncodingAwareIterator do
   it 'handles non-UTF8 input' do
     lines = ["\xc3\x28"]
-    result = described_class.new(lines).map_with_index do |line, number|
+    result = described_class.new(lines).map.with_index do |line, number|
+      line.should be_kind_of(String)
       [line =~ /\s/, number]
     end
     result.should == [[nil, 0]]
@@ -16,9 +17,17 @@ describe Cane::EncodingAwareIterator do
 
   it 'does not enter an infinite loop on persistently bad input' do
     ->{
-      described_class.new([""]).map_with_index do |line, number|
+      described_class.new([""]).map.with_index do |line, number|
         "\xc3\x28" =~ /\s/
       end
     }.should raise_error(ArgumentError)
   end
+
+  it 'allows each with no block' do
+    called_with_line = nil
+    described_class.new([""]).each.with_index do |line, number|
+      called_with_line = line
+    end
+    called_with_line.should == ""
+  end
 end

data/spec/parser_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+require "stringio"
+require 'cane/cli/parser'
+
+describe Cane::CLI::Parser do
+  def run(cli_args)
+    result = nil
+    output = StringIO.new("")
+    result = Cane::CLI::Parser.new(output).parse(cli_args.split(/\s+/m))
+
+    [output.string, result]
+  end
+
+  it 'allows style options to be configured' do
+    output, result = run("--style-glob myfile --style-measure 3")
+    result[:style_glob].should == 'myfile'
+    result[:style_measure].should == 3
+  end
+
+  it 'allows checking of a value in a file' do
+    output, result = run("--gte myfile,90")
+    result[:gte].should == [['myfile', '90']]
+  end
+
+  it 'allows upper bound of failed checks' do
+    output, result = run("--max-violations 1")
+    result[:max_violations].should == 1
+  end
+
+  it 'displays a help message' do
+    output, result = run("--help")
+
+    result.should be
+    output.should include("Usage:")
+  end
+
+  it 'handles invalid options by showing help' do
+    output, result = run("--bogus")
+
+    output.should include("Usage:")
+    result.should_not be
+  end
+
+  it 'displays version' do
+    output, result = run("--version")
+
+    result.should be
+    output.should include(Cane::VERSION)
+  end
+
+  it 'supports exclusions' do
+    options = [
+      "--abc-exclude", "Harness#complex_method",
+      "--style-exclude", 'myfile'
+    ].join(' ')
+
+    _, result = run(options)
+    result[:abc_exclude].should == [['Harness#complex_method']]
+    result[:style_exclude].should == [['myfile']]
+  end
+
+  describe 'argument ordering' do
+    it 'gives precedence to the last argument #1' do
+      _, result = run("--doc-glob myfile --no-doc")
+      result[:no_doc].should be
+
+      _, result = run("--no-doc --doc-glob myfile")
+      result[:no_doc].should_not be
+    end
+  end
+
+  it 'loads default options from .cane file' do
+    defaults = <<-EOS
+      --no-doc
+      --abc-glob myfile
+      --style-glob myfile
+    EOS
+    file = fire_replaced_class_double("Cane::File")
+    stub_const("Cane::File", file)
+    file.should_receive(:exists?).with('./.cane').and_return(true)
+    file.should_receive(:contents).with('./.cane').and_return(defaults)
+
+    _, result = run("--style-glob myotherfile")
+
+    result[:no_doc].should be
+    result[:abc_glob].should == 'myfile'
+    result[:style_glob].should == 'myotherfile'
+  end
+end

data/spec/rake_task_spec.rb

@@ -3,11 +3,34 @@ require 'spec_helper'
 require 'cane/rake_task'
 
 describe Cane::RakeTask do
-  it 'adds a new threshold' do
-    task = described_class.new do |t|
-      t.add_threshold 'coverage', :>=, 99
+  it 'enables cane to be configured an run via rake' do
+    fn = make_file("90")
+    my_check = Class.new(Struct.new(:opts)) do
+      def violations
+        [description: 'test', label: opts.fetch(:some_opt)]
+      end
     end
 
-    task.options[:gte].should == [["coverage", 99]]
+    task = Cane::RakeTask.new(:quality) do |cane|
+      cane.no_abc = true
+      cane.no_doc = true
+      cane.no_style = true
+      cane.add_threshold fn, :>=, 99
+      cane.use my_check, some_opt: "theopt"
+    end
+
+    task.no_abc.should == true
+
+    task.should_receive(:abort)
+    out = capture_stdout do
+      Rake::Task['quality'].invoke
+    end
+
+    out.should include("Quality threshold crossed")
+    out.should include("theopt")
+  end
+
+  after do
+    Rake::Task.clear
   end
 end

data/spec/runner_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+require 'cane'
+
+describe Cane::Runner do
+  describe '#run' do
+    it 'returns true iff fewer violations than max allowed' do
+      described_class.new(checks: [], max_violations: 0).run.should be
+      described_class.new(checks: [], max_violations: -1).run.should_not be
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,20 @@
+require 'rspec/fire'
 require 'tempfile'
+require 'stringio'
+require 'rake'
+require 'rake/tasklib'
+
+RSpec.configure do |config|
+  config.include(RSpec::Fire)
+
+  def capture_stdout &block
+    real_stdout, $stdout = $stdout, StringIO.new
+    yield
+    $stdout.string
+  ensure
+    $stdout = real_stdout
+  end
+end
 
 # Keep a reference to all tempfiles so they are not garbage collected until the
 # process exits.
@@ -12,16 +28,6 @@ def make_file(content)
   tempfile.path
 end
 
-def make_dot_cane(content)
-  File.open('./.cane', 'w') do |f|
-    f.puts content
-  end
-end
-
-def unmake_dot_cane
-  FileUtils.rm('./.cane')
-end
-
 require 'simplecov'
 
 class SimpleCov::Formatter::QualityFormatter

data/spec/style_check_spec.rb

@@ -18,8 +18,8 @@ describe Cane::StyleCheck do
   it 'creates a StyleViolation for each method above the threshold' do
     file_name = make_file(ruby_with_style_issue)
 
-    violations = check(file_name, style_measure: 80).violations
-    violations.length.should == 2
+    violations = check(file_name, style_measure: 8).violations
+    violations.length.should == 3
   end
 
   it 'skips declared exclusions' do
@@ -32,4 +32,16 @@ describe Cane::StyleCheck do
 
     violations.length.should == 0
   end
+
+  it 'does not include trailing new lines in the character count' do
+    file_name = make_file('#' * 80 + "\n" + '#' * 80)
+
+    violations = check(file_name,
+      style_measure: 80,
+      style_exclude: [file_name]
+    ).violations
+
+    violations.length.should == 0
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cane
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-20 00:00:00.000000000 Z
+date: 2012-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2152567380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,15 +21,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: *2152567380
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2152566600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -37,15 +32,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: *2152566600
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2152565760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -53,12 +43,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  version_requirements: *2152565760
+- !ruby/object:Gem::Dependency
+  name: rspec-fire
+  requirement: &2152564960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152564960
 description: Fails your build if code quality thresholds are not met
 email:
 - xavier@squareup.com
@@ -69,16 +65,21 @@ 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/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
 - lib/cane/abc_check.rb
-- lib/cane/cli/spec.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
 - lib/cane/file.rb
@@ -113,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Fails your build if code quality thresholds are not met. Provides complexity
@@ -121,9 +122,12 @@ summary: Fails your build if code quality thresholds are not met. Provides compl
 test_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/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