guideline 0.0.7 → 0.0.8

data/bin/guideline

@@ -8,6 +8,7 @@ options = Runner.parse(ARGV)
 
 checkers = CheckerFactory.new(
   options[:config],
+  AbcComplexityChecker,
   UnusedMethodChecker,
   HashCommaChecker,
   LongLineChecker,

data/guideline.yml

@@ -2,3 +2,5 @@
   max: 80
 "Guideline::LongMethodChecker":
   max: 10
+"Guideline::AbcComplexityChecker":
+  max: 10

data/lib/guideline/checkers/abc_complexity_checker.rb

@@ -0,0 +1,151 @@
+require "ripper"
+
+module Guideline
+  class AbcComplexityChecker < Checker
+    def check(path)
+      @current_path = path
+      visitor.check(path.to_s, path.read)
+      @current_path = nil
+    end
+
+    private
+
+    def checker
+      AbcParser.new do |complexity, method, module_name, class_method_flag|
+        if complexity > max
+          report(
+            :path    => @current_path,
+            :line    => method.line,
+            :message => "ABC Complexity of method<%s%s%s>%3d should be less than %d" % [
+              module_name,
+              class_method_flag ? "." : "#",
+              method.method_name,
+              complexity,
+              max,
+            ]
+          )
+        end
+      end
+    end
+
+    def visitor
+      CodeAnalyzer::CheckingVisitor::Default.new(checkers: [checker])
+    end
+
+    def max
+      @options[:max]
+    end
+
+    module Moduleable
+      def self.included(base)
+        base.class_eval do
+          interesting_nodes :class, :module
+
+          add_callback :start_class do |node|
+            modules << node.class_name.to_s
+          end
+
+          add_callback :start_module do |node|
+            modules << node.module_name.to_s
+          end
+
+          add_callback :end_class do |node|
+            modules.pop
+          end
+
+          add_callback :end_module do |node|
+            modules.pop
+          end
+        end
+      end
+
+      def current_module_name
+        modules.join("::")
+      end
+
+      def modules
+        @moduels ||= []
+      end
+    end
+
+    class AbcParser <  CodeAnalyzer::Checker
+      ASSIGNMENT_NODES = [:assign, :opassign]
+      BRANCH_NODES     = [:call, :fcall, :vcall, :zsuper, :yield0, :brace_block, :do_block]
+      CONDITION_NODES  = [:else]
+      CONDITION_TOKENS = [:==, :===, :"<>", :<=, :>=, :=~, :>, :<, :<=>]
+      ALL_NODES        = ASSIGNMENT_NODES + BRANCH_NODES + CONDITION_NODES
+
+      include Moduleable
+
+      attr_reader :assignment, :branch, :condition
+
+      interesting_files /.*\.rb/
+      interesting_nodes :def, :defs, :binary, :zsuper, *ALL_NODES
+
+      ASSIGNMENT_NODES.each do |name|
+        add_callback :"start_#{name}" do |node|
+          @assignment += 1
+        end
+      end
+
+      BRANCH_NODES.each do |name|
+        add_callback :"start_#{name}" do |node|
+          @branch += 1
+        end
+      end
+
+      CONDITION_NODES.each do |name|
+        add_callback :"start_#{name}" do |node|
+          @condition += 1
+        end
+      end
+
+      add_callback :start_def do |node|
+        @current_method = node
+        clear
+      end
+
+      add_callback :start_defs do |node|
+        @current_method = node
+        clear
+      end
+
+      add_callback :end_def do |node|
+        @callback.call(complexity, @current_method, current_module_name, false)
+        @current_method = nil
+      end
+
+      add_callback :end_defs do |node|
+        @callback.call(complexity, @current_method, current_module_name, true)
+        @current_method = nil
+      end
+
+      add_callback :start_binary do |node|
+        @condition += 1 if condition_table[node[2]]
+      end
+
+      def initialize(*, &callback)
+        clear
+        @callback = callback
+        super
+      end
+
+      def clear
+        @assignment = 0
+        @branch     = 0
+        @condition  = 0
+      end
+
+      def complexity
+        Math.sqrt(@assignment ** 2 + @branch ** 2 + @condition ** 2)
+      end
+
+      def condition_table
+        @condition_table ||= CONDITION_TOKENS.inject({}) do |hash, token|
+          hash[token] = true
+          hash
+        end
+      end
+    end
+  end
+end

data/lib/guideline/version.rb

@@ -1,3 +1,3 @@
 module Guideline
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/guideline.rb

@@ -9,3 +9,4 @@ require "guideline/checkers/long_method_checker"
 require "guideline/checkers/hard_tab_indent_checker"
 require "guideline/checkers/hash_comma_checker"
 require "guideline/checkers/unused_method_checker"
+require "guideline/checkers/abc_complexity_checker"

data/spec/guideline/checkers/abc_complexity_checker_spec.rb

@@ -0,0 +1,171 @@
+require "spec_helper"
+
+module Guideline
+  describe AbcComplexityChecker do
+    describe "#check" do
+      subject do
+        checker.check(path)
+        checker
+      end
+
+      let(:checker) do
+        described_class.new(:max => 1.4)
+      end
+
+      let(:path) do
+        mock(:read => script, :to_s => "mock.rb")
+      end
+
+      context "when there is a few assignment" do
+        let(:script) do
+          <<-EOF
+            def a
+              b = 1
+            end
+          EOF
+        end
+        it { should_not have_error }
+      end
+
+      context "when there is too much assign" do
+        let(:script) do
+          <<-EOF
+            def a
+              b = 1
+              c = 2
+            end
+          EOF
+        end
+        it { should have_error }
+      end
+
+      context "when there is too much opassign" do
+        let(:script) do
+          <<-EOF
+            def a
+              b += 1
+              c += 1
+            end
+          EOF
+        end
+        it { should have_error }
+      end
+
+      context "when there is too much else statement" do
+        let(:script) do
+          <<-EOF
+            def a
+              if b
+                1
+              else
+                2
+              end
+
+              if c
+                3
+              else
+                4
+              end
+            end
+          EOF
+        end
+        it { should have_error }
+      end
+
+      context "when there is too much comparison operator" do
+        let(:script) do
+          <<-EOF
+            def a
+              b == 1
+              c == 2
+            end
+          EOF
+        end
+        it { should have_error }
+      end
+
+      context "when there is too much fcall" do
+        let(:script) do
+          <<-EOF
+            def a
+              b()
+              c()
+            end
+          EOF
+        end
+        it { should have_error }
+      end
+
+      context "when there is too much vcall" do
+        let(:script) do
+          <<-EOF
+            def a
+              b
+              c
+            end
+          EOF
+        end
+        it { should have_error }
+      end
+
+      context "when there is too much call and vcall" do
+        let(:script) do
+          <<-EOF
+            def a
+              b.c
+            end
+          EOF
+        end
+        it { should have_error }
+      end
+
+      context "when there is too much vcall and do_block" do
+        let(:script) do
+          <<-EOF
+            def a
+              a do
+                1
+              end
+            end
+          EOF
+        end
+        it { should have_error }
+      end
+
+      context "when there is too much vcall and brace_block" do
+        let(:script) do
+          <<-EOF
+            def a
+              a { 1 }
+            end
+          EOF
+        end
+        it { should have_error }
+      end
+
+      context "when there is too much yield" do
+        let(:script) do
+          <<-EOF
+            def a
+              yield
+              yield
+            end
+          EOF
+        end
+        it { should have_error }
+      end
+
+      context "when there is too much super" do
+        let(:script) do
+          <<-EOF
+            def a
+              super
+              super
+            end
+          EOF
+        end
+        it { should have_error }
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guideline
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-29 00:00:00.000000000 Z
+date: 2012-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slop
@@ -125,6 +125,7 @@ files:
 - guideline.yml
 - lib/guideline.rb
 - lib/guideline/checker_factory.rb
+- lib/guideline/checkers/abc_complexity_checker.rb
 - lib/guideline/checkers/checker.rb
 - lib/guideline/checkers/hard_tab_indent_checker.rb
 - lib/guideline/checkers/hash_comma_checker.rb
@@ -136,6 +137,7 @@ files:
 - lib/guideline/version.rb
 - lib/guideline/visitor.rb
 - spec/guideline/checker_factory_spec.rb
+- spec/guideline/checkers/abc_complexity_checker_spec.rb
 - spec/guideline/checkers/checker_spec.rb
 - spec/guideline/checkers/hard_tab_indent_checker_spec.rb
 - spec/guideline/checkers/hash_comma_checker_spec.rb
@@ -172,6 +174,7 @@ specification_version: 3
 summary: The guideline of your code
 test_files:
 - spec/guideline/checker_factory_spec.rb
+- spec/guideline/checkers/abc_complexity_checker_spec.rb
 - spec/guideline/checkers/checker_spec.rb
 - spec/guideline/checkers/hard_tab_indent_checker_spec.rb
 - spec/guideline/checkers/hash_comma_checker_spec.rb