cane 1.1.0 → 1.2.0

data/HISTORY.md

@@ -1,5 +1,11 @@
 # Cane History
 
+## 1.2.0 - 31 March 2012 (adce51b9)
+
+* Gracefully handle files with invalid syntax (#1)
+* Included class methods in ABC check (#8)
+* Can disable style and doc checks from rake task (#9)
+
 ## 1.1.0 - 24 March 2012 (ba8a74fc)
 
 * `app` added to default globs

data/README.md

@@ -72,6 +72,7 @@ It works just like this:
       Cane::RakeTask.new(:quality) do |cane|
         cane.abc_max = 10
         cane.add_threshold 'coverage/covered_percent', :>=, 99
+        cane.no_style = true
       end
 
       task :default => :quality

data/lib/cane/abc_check.rb

@@ -1,6 +1,7 @@
 require 'ripper'
 
 require 'cane/abc_max_violation'
+require 'cane/syntax_violation'
 
 module Cane
 
@@ -17,80 +18,100 @@ module Cane
     protected
 
     def find_violations(file_name)
-      ast = sexps_from_file(file_name)
+      ast = Ripper::SexpBuilder.new(File.open(file_name, 'r:utf-8').read).parse
+      case ast
+      when nil
+        InvalidAst.new(file_name)
+      else
+        RubyAst.new(file_name, max_allowed_complexity, ast)
+      end.violations
+    end
 
-      process_ast(ast).
-        select { |nesting, complexity| complexity > max_allowed_complexity }.
-        map { |x| AbcMaxViolation.new(file_name, x.first, x.last) }
+    # Null object for when the file cannot be parsed.
+    class InvalidAst < Struct.new(:file_name)
+      def violations
+        [SyntaxViolation.new(file_name)]
+      end
     end
 
-    # Recursive function to process an AST. The `complexity` variable mutates,
-    # which is a bit confusing. `nesting` does not.
-    def process_ast(node, complexity = {}, nesting = [])
-      if method_nodes.include?(node[0])
-        nesting = nesting + [node[1][1]]
-        complexity[nesting.join(" > ")] = calculate_abc(node)
-      elsif container_nodes.include?(node[0])
-        parent = if node[1][1][1].is_a?(Symbol)
-          node[1][1][1]
-        else
-          node[1][-1][1]
-        end
-        nesting = nesting + [parent]
+    # Wrapper object around sexps returned from ripper.
+    class RubyAst < Struct.new(:file_name, :max_allowed_complexity, :sexps)
+      def violations
+        process_ast(sexps).
+          select { |nesting, complexity| complexity > max_allowed_complexity }.
+          map { |x| AbcMaxViolation.new(file_name, x.first, x.last) }
       end
 
-      if node.is_a? Array
-        node[1..-1].each { |n| process_ast(n, complexity, nesting) if n }
+      protected
+
+      # Recursive function to process an AST. The `complexity` variable mutates,
+      # which is a bit confusing. `nesting` does not.
+      def process_ast(node, complexity = {}, nesting = [])
+        if method_nodes.include?(node[0])
+          nesting = nesting + [label_for(node)]
+          complexity[nesting.join(" > ")] = calculate_abc(node)
+        elsif container_nodes.include?(node[0])
+          parent  = node[1][-1][1]
+          nesting = nesting + [parent]
+        end
+
+        if node.is_a? Array
+          node[1..-1].each { |n| process_ast(n, complexity, nesting) if n }
+        end
+        complexity
       end
-      complexity
-    end
 
-    def sexps_from_file(file_name)
-      Ripper::SexpBuilder.new(File.open(file_name, 'r:utf-8').read).parse
-    end
+      def calculate_abc(method_node)
+        a = count_nodes(method_node, assignment_nodes)
+        b = count_nodes(method_node, branch_nodes) + 1
+        c = count_nodes(method_node, condition_nodes)
+        abc = Math.sqrt(a**2 + b**2 + c**2).round
+        abc
+      end
 
-    def max_allowed_complexity
-      opts.fetch(:max)
-    end
+      def label_for(node)
+        # A default case is deliberately omitted since I know of no way this
+        # could fail and want it to fail fast.
+        node.detect {|x|
+          [:@ident, :@op, :@kw, :@const, :@backtick].include?(x[0])
+        }[1]
+      end
 
-    def calculate_abc(method_node)
-      a = count_nodes(method_node, assignment_nodes)
-      b = count_nodes(method_node, branch_nodes) + 1
-      c = count_nodes(method_node, condition_nodes)
-      abc = Math.sqrt(a**2 + b**2 + c**2).round
-      abc
-    end
+      def count_nodes(node, types)
+        node.flatten.select { |n| types.include?(n) }.length
+      end
 
-    def count_nodes(node, types)
-      node.flatten.select { |n| types.include?(n) }.length
-    end
+      def assignment_nodes
+        [:assign, :opassign]
+      end
 
-    def file_names
-      Dir[opts.fetch(:files)]
-    end
+      def method_nodes
+        [:def, :defs]
+      end
 
-    def order(result)
-      result.sort_by(&:complexity).reverse
-    end
+      def container_nodes
+        [:class, :module]
+      end
 
-    def assignment_nodes
-      [:assign, :opassign]
-    end
+      def branch_nodes
+        [:call, :fcall, :brace_block, :do_block]
+      end
 
-    def method_nodes
-      [:def]
+      def condition_nodes
+        [:==, :===, :"<>", :"<=", :">=", :"=~", :>, :<, :else, :"<=>"]
+      end
     end
 
-    def container_nodes
-      [:class, :module]
+    def file_names
+      Dir[opts.fetch(:files)]
     end
 
-    def branch_nodes
-      [:call, :fcall, :brace_block, :do_block]
+    def order(result)
+      result.sort_by(&:sort_index).reverse
     end
 
-    def condition_nodes
-      [:==, :===, :"<>", :"<=", :">=", :"=~", :>, :<, :else, :"<=>"]
+    def max_allowed_complexity
+      opts.fetch(:max)
     end
   end
 end

data/lib/cane/abc_max_violation.rb

@@ -9,5 +9,7 @@ module Cane
     def description
       "Methods exceeded maximum allowed ABC complexity"
     end
+
+    alias_method :sort_index, :complexity
   end
 end

data/lib/cane/rake_task.rb

@@ -10,6 +10,7 @@ module Cane
   #   Cane::RakeTask.new(:quality) do |cane|
   #     cane.abc_max = 10
   #     cane.doc_glob = 'lib/**/*.rb'
+  #     cane.no_style = true
   #     cane.add_threshold 'coverage/covered_percent', :>=, 99
   #   end
   class RakeTask < ::Rake::TaskLib
@@ -21,10 +22,14 @@ module Cane
     attr_accessor :abc_max
     # Glob to run style checks over (default: "{lib,spec}/**/*.rb")
     attr_accessor :style_glob
+    # TRUE to disable style checks
+    attr_accessor :no_style
     # Max line length (default: 80)
     attr_accessor :style_measure
     # Glob to run doc checks over (default: "lib/**/*.rb")
     attr_accessor :doc_glob
+    # TRUE to disable doc checks
+    attr_accessor :no_doc
     # Max violations to tolerate (default: 0)
     attr_accessor :max_violations
 
@@ -54,8 +59,10 @@ module Cane
         :abc_glob,
         :abc_max,
         :doc_glob,
+        :no_doc,
         :max_violations,
         :style_glob,
+        :no_style,
         :style_measure
       ].inject(threshold: @threshold) do |opts, setting|
         value = self.send(setting)

data/lib/cane/syntax_violation.rb

@@ -0,0 +1,20 @@
+module Cane
+
+  # Value object used by AbcCheck for a file that cannot be parsed. This is
+  # handled by AbcCheck rather than a separate class since it is a low value
+  # violation (syntax errors should have been picked up by specs) but we still
+  # have to deal with the edge case.
+  class SyntaxViolation < Struct.new(:file_name)
+    def columns
+      [file_name]
+    end
+
+    def description
+      "Files contained invalid syntax"
+    end
+
+    def sort_index
+      0
+    end
+  end
+end

data/lib/cane/version.rb

@@ -1,3 +1,3 @@
 module Cane
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/spec/abc_check_spec.rb

@@ -20,8 +20,7 @@ describe Cane::AbcCheck do
     violations = described_class.new(files: file_name, max: 1).violations
     violations.length.should == 1
     violations[0].should be_instance_of(Cane::AbcMaxViolation)
-    violations[0].to_s.should include("Harness")
-    violations[0].to_s.should include("complex_method")
+    violations[0].columns.should == [file_name, "Harness > complex_method", 2]
   end
 
   it 'sorts violations by complexity' do
@@ -43,4 +42,40 @@ describe Cane::AbcCheck do
     complexities = violations.map(&:complexity)
     complexities.should == complexities.sort.reverse
   end
+
+  it 'creates a SyntaxViolation when code cannot be parsed' do
+    file_name = make_file(<<-RUBY)
+      class Harness
+    RUBY
+
+    violations = described_class.new(files: 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)
+  end
+
+  def self.it_should_extract_method_name(method_name, label=method_name)
+    it "creates an AbcMaxViolation for #{method_name}" do
+      file_name = make_file(<<-RUBY)
+        class Harness
+          def #{method_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}"
+    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 'next'
+  it_should_extract_method_name 'GET'
+  it_should_extract_method_name '`'
+  it_should_extract_method_name '>='
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cane
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-25 00:00:00.000000000 Z
+date: 2012-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tailor
-  requirement: &2160572120 !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: *2160572120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2160571620 !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: *2160571620
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2160571200 !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: *2160571200
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2160570720 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +69,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160570720
+  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
@@ -79,6 +99,7 @@ files:
 - 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
@@ -109,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.18
 signing_key: 
 specification_version: 3
 summary: Fails your build if code quality thresholds are not met. Provides complexity