cane 1.4.0 → 2.0.0

data/spec/abc_check_spec.rb

@@ -3,6 +3,10 @@ require 'spec_helper'
 require 'cane/abc_check'
 
 describe Cane::AbcCheck do
+  def check(file_name, opts = {})
+    described_class.new(opts.merge(abc_glob: file_name))
+  end
+
   it 'creates an AbcMaxViolation for each method above the threshold' do
     file_name = make_file(<<-RUBY)
       class Harness
@@ -17,10 +21,10 @@ describe Cane::AbcCheck do
       end
     RUBY
 
-    violations = described_class.new(files: file_name, max: 1).violations
+    violations = check(file_name, abc_max: 1).violations
     violations.length.should == 1
-    violations[0].should be_instance_of(Cane::AbcMaxViolation)
-    violations[0].columns.should == [file_name, "Harness > complex_method", 2]
+    violations[0].values_at(:file, :label, :value).should ==
+      [file_name, "Harness#complex_method", 2]
   end
 
   it 'sorts violations by complexity' do
@@ -37,22 +41,21 @@ describe Cane::AbcCheck do
       end
     RUBY
 
-    violations = described_class.new(files: file_name, max: 0).violations
+    violations = check(file_name, abc_max: 0).violations
     violations.length.should == 2
-    complexities = violations.map(&:complexity)
+    complexities = violations.map {|x| x[:value] }
     complexities.should == complexities.sort.reverse
   end
 
-  it 'creates a SyntaxViolation when code cannot be parsed' do
+  it 'creates a violation when code cannot be parsed' do
     file_name = make_file(<<-RUBY)
       class Harness
     RUBY
 
-    violations = described_class.new(files: file_name).violations
+    violations = check(file_name).violations
     violations.length.should == 1
-    violations[0].should be_instance_of(Cane::SyntaxViolation)
-    violations[0].columns.should == [file_name]
-    violations[0].description.should be_instance_of(String)
+    violations[0][:file].should == file_name
+    violations[0][:description].should be_instance_of(String)
   end
 
   it 'skips declared exclusions' do
@@ -84,33 +87,62 @@ describe Cane::AbcCheck do
 
     exclusions = %w[ Harness#instance_meth  Harness.class_meth
                      Harness::Nested#i_meth Harness::Nested.c_meth ]
-    violations = described_class.new(files: file_name, max: 0,
-                                     exclusions: exclusions).violations
+    violations = check(file_name,
+      abc_max:        0,
+      abc_exclude: exclusions
+    ).violations
     violations.length.should == 1
-    violations[0].should be_instance_of(Cane::AbcMaxViolation)
-    columns = violations[0].columns
-    columns.should == [file_name, "Harness > Nested > other_meth", 1]
+    violations[0].values_at(:file, :label, :value).should ==
+      [file_name, "Harness::Nested#other_meth", 1]
+  end
+
+  it "creates an AbcMaxViolation for method in assigned anonymous class" do
+    file_name = make_file(<<-RUBY)
+      MyClass = Struct.new(:foo) do
+        def test_method(a)
+          b = a
+          return b if b > 3
+        end
+      end
+    RUBY
+
+    violations = check(file_name, abc_max: 1).violations
+    violations[0][:label] == "MyClass#test_method"
+  end
+
+  it "creates an AbcMaxViolation for method in anonymous class" do
+    file_name = make_file(<<-RUBY)
+      Class.new do
+        def test_method(a)
+          b = a
+          return b if b > 3
+        end
+      end
+    RUBY
+
+    violations = check(file_name, abc_max: 1).violations
+    violations[0][:label].should == "(anon)#test_method"
   end
 
-  def self.it_should_extract_method_name(method_name, label=method_name)
-    it "creates an AbcMaxViolation for #{method_name}" do
+  def self.it_should_extract_method_name(name, label=name, sep='#')
+    it "creates an AbcMaxViolation for #{name}" do
       file_name = make_file(<<-RUBY)
         class Harness
-          def #{method_name}(a)
+          def #{name}(a)
             b = a
             return b if b > 3
           end
         end
       RUBY
 
-      violations = described_class.new(files: file_name, max: 1).violations
-      violations[0].detail.should == "Harness > #{label}"
+      violations = check(file_name, abc_max: 1).violations
+      violations[0][:label].should == "Harness#{sep}#{label}"
     end
   end
 
   # These method names all create different ASTs. Which is weird.
   it_should_extract_method_name 'a'
-  it_should_extract_method_name 'self.a', 'a'
+  it_should_extract_method_name 'self.a', 'a', '.'
   it_should_extract_method_name 'next'
   it_should_extract_method_name 'GET'
   it_should_extract_method_name '`'

data/spec/cane_spec.rb

@@ -14,7 +14,7 @@ describe 'Cane' do
   def run(cli_args)
     result = nil
     output = capture_stdout do
-      result = Cane::CLI.run(cli_args.split(' '))
+      result = Cane::CLI.run(['--no-abc'] + cli_args.split(' '))
     end
 
     [output, result ? 0 : 1]
@@ -42,8 +42,8 @@ describe 'Cane' do
     file_name = make_file("whitespace ")
 
     output, exitstatus = run("--style-glob #{file_name}")
-    exitstatus.should == 1
     output.should include("Lines violated style requirements")
+    exitstatus.should == 1
   end
 
   it 'allows measure to be configured' do
@@ -59,7 +59,7 @@ describe 'Cane' do
 
     output, exitstatus = run("--style-glob #{file_name} --style-measure 80")
     exitstatus.should == 0
-    output.should be_empty
+    output.should == ""
   end
 
   it 'allows upper bound of failed checks' do
@@ -74,8 +74,8 @@ describe 'Cane' do
     file_name = make_file("89")
 
     output, exitstatus = run("--gte #{file_name},90")
-    exitstatus.should == 1
     output.should include("Quality threshold crossed")
+    exitstatus.should == 1
   end
 
   it 'allows checking of class documentation' do
@@ -143,21 +143,30 @@ describe 'Cane' do
       end
     RUBY
 
-    exclusions_file = make_file(<<-YAML)
-abc:
-  - Harness#complex_method
-style:
-  - #{file_name}
-    YAML
-
     options = [
       "--abc-glob", file_name,
+      "--abc-exclude", "Harness#complex_method",
       "--abc-max", 1,
       "--style-glob", file_name,
-      "--exclusions-file", exclusions_file
+      "--style-exclude", file_name
     ].join(' ')
 
     _, exitstatus = run(options)
     exitstatus.should == 0
   end
+
+  it 'handles invalid unicode input' do
+    fn = make_file("\xc3\x28")
+
+    _, exitstatus = run("--style-glob #{fn} --abc-glob #{fn} --doc-glob #{fn}")
+
+    exitstatus.should == 0
+  end
+
+  it 'handles invalid options by showing help' do
+    out, exitstatus = run("--bogus")
+
+    out.should include("Usage:")
+    exitstatus.should == 1
+  end
 end

data/spec/doc_check_spec.rb

@@ -3,6 +3,10 @@ require 'spec_helper'
 require 'cane/doc_check'
 
 describe Cane::DocCheck do
+  def check(file_name, opts = {})
+    described_class.new(opts.merge(doc_glob: file_name))
+  end
+
   it 'creates a DocViolation for each undocumented class' do
     file_name = make_file <<-RUBY
 # This class is documented
@@ -16,17 +20,34 @@ class Meta
 end
     RUBY
 
-    violations = described_class.new(files: file_name).violations
+    violations = check(file_name).violations
     violations.length.should == 2
 
-    violations[0].should be_instance_of(Cane::UndocumentedClassViolation)
-    violations[0].file_name.should == file_name
-    violations[0].number.should == 3
-    violations[0].columns.last.should eq("NoDoc")
+    violations[0].values_at(:file, :line, :label).should == [
+      file_name, 3, "NoDoc"
+    ]
+
+    violations[1].values_at(:file, :line, :label).should == [
+      file_name, 4, "AlsoNoDoc"
+    ]
+  end
+
+  it 'ignores magic encoding comments' do
+    file_name = make_file <<-RUBY
+# coding = utf-8
+class NoDoc; end
+# -*-  encoding :  utf-8  -*-
+class AlsoNoDoc; end
+    RUBY
+
+    violations = check(file_name).violations
+    violations.length.should == 2
 
-    violations[1].should be_instance_of(Cane::UndocumentedClassViolation)
-    violations[1].file_name.should == file_name
-    violations[1].number.should == 4
-    violations[1].columns.last.should eq("AlsoNoDoc")
+    violations[0].values_at(:file, :line, :label).should == [
+      file_name, 2, "NoDoc"
+    ]
+    violations[1].values_at(:file, :line, :label).should == [
+      file_name, 4, "AlsoNoDoc"
+    ]
   end
 end

data/spec/encoding_aware_iterator_spec.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+require 'spec_helper'
+
+require 'cane/encoding_aware_iterator'
+
+# Example bad input from:
+#   http://stackoverflow.com/questions/1301402/example-invalid-utf8-string
+describe Cane::EncodingAwareIterator do
+  it 'handles non-UTF8 input' do
+    lines = ["\xc3\x28"]
+    result = described_class.new(lines).map_with_index do |line, number|
+      [line =~ /\s/, number]
+    end
+    result.should == [[nil, 0]]
+  end
+
+  it 'does not enter an infinite loop on persistently bad input' do
+    ->{
+      described_class.new([""]).map_with_index do |line, number|
+        "\xc3\x28" =~ /\s/
+      end
+    }.should raise_error(ArgumentError)
+  end
+end

data/spec/rake_task_spec.rb

@@ -0,0 +1,13 @@
+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
+    end
+
+    task.options[:gte].should == [["coverage", 99]]
+  end
+end

data/spec/style_check_spec.rb

@@ -3,6 +3,10 @@ require 'spec_helper'
 require 'cane/style_check'
 
 describe Cane::StyleCheck do
+  def check(file_name, opts = {})
+    described_class.new(opts.merge(style_glob: file_name))
+  end
+
   let(:ruby_with_style_issue) do
     [
       "def test  ",
@@ -14,16 +18,18 @@ describe Cane::StyleCheck do
   it 'creates a StyleViolation for each method above the threshold' do
     file_name = make_file(ruby_with_style_issue)
 
-    violations = Cane::StyleCheck.new(files: file_name, measure: 80).violations
+    violations = check(file_name, style_measure: 80).violations
     violations.length.should == 2
-    violations[0].should be_instance_of(StyleViolation)
   end
 
   it 'skips declared exclusions' do
     file_name = make_file(ruby_with_style_issue)
 
-    violations = Cane::StyleCheck.new(files: file_name, measure: 80,
-                                      exclusions: [file_name]).violations
+    violations = check(file_name,
+      style_measure: 80,
+      style_exclude: [file_name]
+    ).violations
+
     violations.length.should == 0
   end
 end

data/spec/threshold_check_spec.rb

@@ -2,11 +2,12 @@ require 'spec_helper'
 
 require 'cane/threshold_check'
 
-describe ThresholdCheck do
+describe Cane::ThresholdCheck do
   it 'returns a value of unavailable when file cannot be read' do
-    check = ThresholdCheck.new([[:>=, 'bogus_file', 20]])
+    check = Cane::ThresholdCheck.new(gte: [['bogus_file', 20]])
     violations = check.violations
     violations.length.should == 1
-    violations[0].to_s.should include("unavailable")
+    violations[0][:label].should ==
+      'bogus_file is unavailable, should be >= 20'
   end
 end

data/spec/violation_formatter_spec.rb

@@ -4,10 +4,9 @@ require 'cane/violation_formatter'
 
 describe Cane::ViolationFormatter do
   def violation(description)
-    stub("violation",
-      description: description,
-      columns:     []
-    )
+    {
+      description: description
+    }
   end
 
   it 'includes number of violations in the group header' do
@@ -15,7 +14,7 @@ describe Cane::ViolationFormatter do
   end
 
   it 'includes total number of violations' do
-    violations = [violation("FAIL1"),violation("FAIL2")]
+    violations = [violation("FAIL1"), violation("FAIL2")]
     result = described_class.new(violations).to_s
     result.should include("Total Violations: 2")
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cane
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-02 00:00:00.000000000 Z
+date: 2012-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -70,22 +70,21 @@ files:
 - spec/abc_check_spec.rb
 - spec/cane_spec.rb
 - spec/doc_check_spec.rb
+- spec/encoding_aware_iterator_spec.rb
+- spec/rake_task_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/abc_max_violation.rb
 - lib/cane/cli/spec.rb
-- lib/cane/cli/translator.rb
 - lib/cane/cli.rb
 - lib/cane/doc_check.rb
+- lib/cane/encoding_aware_iterator.rb
+- lib/cane/file.rb
 - lib/cane/rake_task.rb
 - lib/cane/style_check.rb
-- lib/cane/style_violation.rb
-- lib/cane/syntax_violation.rb
 - lib/cane/threshold_check.rb
-- lib/cane/threshold_violation.rb
 - lib/cane/version.rb
 - lib/cane/violation_formatter.rb
 - lib/cane.rb
@@ -123,6 +122,8 @@ test_files:
 - spec/abc_check_spec.rb
 - spec/cane_spec.rb
 - spec/doc_check_spec.rb
+- spec/encoding_aware_iterator_spec.rb
+- spec/rake_task_spec.rb
 - spec/spec_helper.rb
 - spec/style_check_spec.rb
 - spec/threshold_check_spec.rb

data/lib/cane/abc_max_violation.rb

@@ -1,15 +0,0 @@
-module Cane
-
-  # Value object used by AbcCheck for a method that is too complicated.
-  class AbcMaxViolation < Struct.new(:file_name, :detail, :complexity)
-    def columns
-      [file_name, detail, complexity]
-    end
-
-    def description
-      "Methods exceeded maximum allowed ABC complexity"
-    end
-
-    alias_method :sort_index, :complexity
-  end
-end

data/lib/cane/cli/translator.rb

@@ -1,71 +0,0 @@
-require 'yaml'
-
-module Cane
-  module CLI
-
-    # Translates CLI options with given defaults to a hash suitable to be
-    # passed to `Cane.run`.
-    class Translator < Struct.new(:options, :defaults)
-      def to_hash
-        result = {}
-        translate_abc_options(result)
-        translate_doc_options(result)
-        translate_style_options(result)
-
-        result[:threshold] = options.fetch(:threshold, [])
-        result[:max_violations] = option_with_default(:max_violations).to_i
-
-        result
-      end
-
-      def translate_abc_options(result)
-        result[:abc] = {
-          files:      option_with_default(:abc_glob),
-          max:        option_with_default(:abc_max).to_i,
-          exclusions: exclusions_for('abc')
-        } unless check_disabled(:no_abc, [:abc_glob, :abc_max])
-      end
-
-      def translate_style_options(result)
-        result[:style] = {
-          files:      option_with_default(:style_glob),
-          measure:    option_with_default(:style_measure).to_i,
-          exclusions: exclusions_for('style')
-        } unless check_disabled(:no_style, [:style_glob])
-      end
-
-      def translate_doc_options(result)
-        result[:doc] = {
-          files: option_with_default(:doc_glob),
-        } unless check_disabled(:no_doc, [:doc_glob])
-      end
-
-      def check_disabled(check, params)
-        relevant_options = options.keys & params + [check]
-
-        check == relevant_options[-1]
-      end
-
-      def option_with_default(key)
-        options.fetch(key, defaults.fetch(key))
-      end
-
-    private
-
-      def exclusions_for(tool)
-        Array(exclusions[tool])
-      end
-
-      def exclusions
-        @exclusions ||= begin
-          if file = options[:exclusions_file]
-            YAML.load_file(file)
-          else
-            {}
-          end
-        end
-      end
-    end
-
-  end
-end