guideline 0.0.5 → 0.0.6

data/bin/guideline

@@ -8,6 +8,7 @@ options = Runner.parse(ARGV)
 
 checkers = CheckerFactory.new(
   options[:config],
+  UnusedMethodChecker,
   HashCommaChecker,
   LongLineChecker,
   LongMethodChecker,
@@ -15,5 +16,6 @@ checkers = CheckerFactory.new(
 ).create
 
 visitor = Visitor.new(:only => ARGV[0], :checker => checkers)
+visitor.prepare
 visitor.visit
 visitor.render

data/guideline.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency "slop"
+  gem.add_dependency "code_analyzer"
   gem.add_dependency "active_support"
   gem.add_dependency "i18n"
   gem.add_development_dependency "rspec", ">=2.12.0"

data/lib/guideline/checkers/unused_method_checker.rb

@@ -0,0 +1,114 @@
+require "code_analyzer"
+
+module Guideline
+  class UnusedMethodChecker < Checker
+    def check(path)
+      definition_visitor.check(path.to_s, path.read)
+      report_unused_methods(path)
+      clear_definitions
+    end
+
+    def prepare(path)
+      call_visitor.check(path.to_s, path.read)
+    end
+
+    private
+
+    def calls
+      @calls ||= []
+    end
+
+    def call_visitor
+      create_visitor(call_checker)
+    end
+
+    def call_checker
+      MethodCallChecker.new do |method_name|
+        calls << method_name
+      end
+    end
+
+    def definitions
+      @definitions ||= []
+    end
+
+    def definition_visitor
+      create_visitor(definition_checker)
+    end
+
+    def definition_checker
+      MethodDefinitionChecker.new do |definition|
+        definitions << definition
+      end
+    end
+
+    def create_visitor(checker)
+      CodeAnalyzer::CheckingVisitor::Default.new(checkers: [checker])
+    end
+
+    def report_unused_methods(path)
+      unused_methods.each do |method|
+        report(
+          :message => "Remove unused method <#{method.name}>",
+          :path    => path,
+          :line    => method.line
+        )
+      end
+    end
+
+    def unused_methods
+      definitions.reject do |method|
+        calls.include?(method.name)
+      end
+    end
+
+    def clear_definitions
+      definitions.clear
+    end
+
+    class MethodChecker < CodeAnalyzer::Checker
+      def initialize(*, &callback)
+        @callback = callback
+        super
+      end
+
+      def call(method)
+        @callback.call(method)
+      end
+    end
+
+    class MethodDefinitionChecker < MethodChecker
+      interesting_files /.*\.rb/
+      interesting_nodes :def
+
+      add_callback :start_def do |node|
+        definition = Definition.new(:line => node.line, :name => node.method_name.to_s)
+        call(definition)
+      end
+    end
+
+    class MethodCallChecker < MethodChecker
+      interesting_files /.*\.rb/
+      interesting_nodes :call, :fcall, :vcall, :var_ref
+
+      add_callback :start_call do |node|
+        call(node.message.to_s)
+      end
+
+      add_callback :start_fcall do |node|
+        call(node.message.to_s)
+      end
+
+      add_callback :start_vcall do |node|
+        call(node.to_s)
+      end
+
+      add_callback :start_var_ref do |node|
+        call(node.to_s)
+      end
+    end
+
+    class Definition < OpenStruct
+    end
+  end
+end

data/lib/guideline/runner.rb

@@ -8,6 +8,7 @@ module Guideline
     def parse(argv)
       hash = Parser.parse(argv)
       hash[:config] = load_config(hash[:config])
+      hash.delete(:help)
       hash
     end
 

data/lib/guideline/version.rb

@@ -1,3 +1,3 @@
 module Guideline
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/guideline/visitor.rb

@@ -16,7 +16,14 @@ module Guideline
           checker.check(path)
         end
       end
-      self
+    end
+
+    def prepare
+      paths.each do |path|
+        checkers.each do |checker|
+          checker.prepare(path) if checker.respond_to?(:prepare)
+        end
+      end
     end
 
     def render

data/lib/guideline.rb

@@ -8,3 +8,4 @@ require "guideline/checkers/long_line_checker"
 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"

data/spec/guideline/checkers/hard_tab_indent_checker_spec.rb

@@ -8,11 +8,11 @@ module Guideline
       end
 
       let(:path) do
-        mock(:each_line => content.each_line)
+        mock(:each_line => script.each_line)
       end
 
       context "when there is hard tab indent" do
-        let(:content) do
+        let(:script) do
           <<-EOF
             def foo
             \t1
@@ -20,14 +20,14 @@ module Guideline
           EOF
         end
 
-        specify "checker detects error" do
+        it "detects error" do
           checker.check(path)
           checker.should have_error
         end
       end
 
       context "when there is no hard tab indent" do
-        let(:content) do
+        let(:script) do
           <<-EOF
             def foo
               1
@@ -35,7 +35,7 @@ module Guideline
           EOF
         end
 
-        specify "checker does not detect error" do
+        it "does not detect error" do
           checker.check(path)
           checker.should_not have_error
         end

data/spec/guideline/checkers/hash_comma_checker_spec.rb

@@ -23,7 +23,7 @@ module Guideline
           EOF
         end
 
-        specify "checker does not detect error" do
+        it "does not detect error" do
           should_not have_error
         end
       end
@@ -35,7 +35,7 @@ module Guideline
           EOF
         end
 
-        specify "checker does not detect error" do
+        it "does not detect error" do
           should_not have_error
         end
       end
@@ -49,7 +49,21 @@ module Guideline
           EOF
         end
 
-        specify "checker detects error" do
+        it "detects error" do
+          should have_error
+        end
+      end
+
+      context "when there is no last comma in multiline hash of new syntax" do
+        let(:script) do
+          <<-EOF
+            {
+              a: 1
+            }
+          EOF
+        end
+
+        it "detects error" do
           should have_error
         end
       end
@@ -63,7 +77,7 @@ module Guideline
           EOF
         end
 
-        specify "checker detects error" do
+        it "detects error" do
           should have_error
         end
       end
@@ -77,7 +91,7 @@ module Guideline
           EOF
         end
 
-        specify "checker does not detect error" do
+        it "does not detect error" do
           should_not have_error
         end
       end
@@ -93,7 +107,7 @@ module Guideline
           EOF
         end
 
-        specify "checker detects error" do
+        it "detects error" do
           should have_error
         end
       end

data/spec/guideline/checkers/long_line_checker_spec.rb

@@ -8,11 +8,11 @@ module Guideline
       end
 
       let(:path) do
-        mock(:each_line => content.each_line)
+        mock(:each_line => script.each_line)
       end
 
       context "when there is too line" do
-        let(:content) do
+        let(:script) do
           <<-EOF
             def foo
               too looooooooooooooooooooooooong line
@@ -20,14 +20,14 @@ module Guideline
           EOF
         end
 
-        specify "checker detects error" do
+        it "detects error" do
           checker.check(path)
           checker.should have_error
         end
       end
 
       context "when there is no too long line" do
-        let(:content) do
+        let(:script) do
           <<-EOF
             def foo
               not loooooooooooooooooooooooong line
@@ -35,7 +35,7 @@ module Guideline
           EOF
         end
 
-        specify "checker does not detect error" do
+        it "does not detect error" do
           checker.check(path)
           checker.should_not have_error
         end

data/spec/guideline/checkers/long_method_checker_spec.rb

@@ -8,11 +8,11 @@ module Guideline
       end
 
       let(:path) do
-        mock(:read => content)
+        mock(:read => script)
       end
 
       context "when there is too long method" do
-        let(:content) do
+        let(:script) do
           <<-EOF
             def foo
               1
@@ -21,14 +21,14 @@ module Guideline
           EOF
         end
 
-        specify "checker detects error" do
+        it "detects error" do
           checker.check(path)
           checker.should have_error
         end
       end
 
       context "when there is no too long method" do
-        let(:content) do
+        let(:script) do
           <<-EOF
             def foo
               1
@@ -36,7 +36,7 @@ module Guideline
           EOF
         end
 
-        specify "checker does not detect error" do
+        it "does not detect error" do
           checker.check(path)
           checker.should_not have_error
         end

data/spec/guideline/checkers/unused_method_checker_spec.rb

@@ -0,0 +1,73 @@
+require "spec_helper"
+
+module Guideline
+  describe UnusedMethodChecker do
+    let(:checker) do
+      described_class.new
+    end
+
+    let(:path) do
+      mock(:read => script, :to_s => "mock.rb")
+    end
+
+    describe "#prepare" do
+      let(:script) do
+        <<-EOF
+          a
+          b()
+          d.c
+          f.e()
+        EOF
+      end
+
+      it "remembers method calls" do
+        checker.prepare(path)
+        checker.send(:calls).should == %w[a b c d e f]
+      end
+    end
+
+    describe "#check" do
+      before do
+        checker.instance_variable_set(:@calls, %w[a b])
+      end
+
+      let(:script) do
+        <<-EOF
+          def a
+            1
+          end
+
+          def b
+            2
+          end
+
+          def c
+            3
+          end
+        EOF
+      end
+
+      it "remembers method definitions" do
+        checker.stub(:clear_definitions)
+        checker.check(path)
+        checker.send(:definitions).map(&:name).should == %w[a b c]
+      end
+
+      it "detects unused method definitions" do
+        checker.stub(:clear_definitions)
+        checker.check(path)
+        checker.send(:unused_methods).map(&:name).should == %w[c]
+      end
+
+      it "reports unused method definitions" do
+        checker.should_receive(:report)
+        checker.check(path)
+      end
+
+      it "clears up its definitions after check" do
+        checker.check(path)
+        checker.send(:definitions).should be_empty
+      end
+    end
+  end
+end

data/spec/guideline/runner_spec.rb

@@ -7,17 +7,34 @@ module Guideline
         described_class.parse(argv)
       end
 
+      before do
+        YAML.stub(:load_file).and_return(config)
+      end
+
+      let(:config) do
+        { "a" => 1 }
+      end
+
       let(:path) do
         File.expand_path("../../../guideline.yml", __FILE__)
       end
 
-      context "when config option is passed" do
-        let(:argv) do
-          ["--config", path]
-        end
+      let(:argv) do
+        ["--config", path]
+      end
 
-        it "parses ARGV and returns options with config hash" do
-          should have_key(:config)
+      it "loads config option as YAML path" do
+        YAML.should_receive(:load_file).with(path)
+        subject
+      end
+
+      it "returns config option as HashWithIndifferentAccess" do
+        subject[:config].should be_a HashWithIndifferentAccess
+      end
+
+      context "when config option is passed" do
+        it "returns parsed options" do
+          should == { :config => config }
         end
       end
 
@@ -26,8 +43,8 @@ module Guideline
           ["-c", path]
         end
 
-        it "parses ARGV and returns options with config hash" do
-          should have_key(:config)
+        it "returns parsed options" do
+          should == { :config => config }
         end
       end
 
@@ -36,20 +53,11 @@ module Guideline
           []
         end
 
-        it "parses ARGV and returns options with config hash" do
+        it "returns parsed options with default config path" do
+          described_class.should_receive(:default_config_path)
           should have_key(:config)
         end
       end
-
-      context "when config option is wrong" do
-        let(:argv) do
-          ["--config", "wrong config path"]
-        end
-
-        it do
-          expect { subject }.to raise_error(StandardError)
-        end
-      end
     end
   end
 end

data/spec/guideline/visitor_spec.rb

@@ -23,10 +23,34 @@ module Guideline
     end
 
     describe "#visit" do
-      it "calls checker#check with matched path" do
+      it "calls checker#check with path" do
         checker.should_receive(:check).with(path)
         visitor.visit
       end
     end
+
+    describe "#prepare" do
+      context "if checker can respond to #prepare" do
+        before do
+          checker.stub(:respond_to?).with(:prepare).and_return(true)
+        end
+
+        it "calls checker#prepare with path" do
+          checker.should_receive(:prepare).with(path)
+          visitor.prepare
+        end
+      end
+
+      context "if checker cannot respond to #prepare" do
+        before do
+          checker.stub(:respond_to?).with(:prepare).and_return(false)
+        end
+
+        it "does not call checker#prepare with path" do
+          checker.should_not_receive(:prepare)
+          visitor.prepare
+        end
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guideline
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-23 00:00:00.000000000 Z
+date: 2012-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slop
-  requirement: &70304744680520 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,31 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70304744680520
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: code_analyzer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: active_support
-  requirement: &70304744680100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +53,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70304744680100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70304744679680 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +69,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70304744679680
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70304744679180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +85,15 @@ dependencies:
         version: 2.12.0
   type: :development
   prerelease: false
-  version_requirements: *70304744679180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70304744678760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +101,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70304744678760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Guideline.gem checks if your code observes your coding guidelines
 email:
 - r7kamura@gmail.com
@@ -89,6 +130,7 @@ files:
 - lib/guideline/checkers/hash_comma_checker.rb
 - lib/guideline/checkers/long_line_checker.rb
 - lib/guideline/checkers/long_method_checker.rb
+- lib/guideline/checkers/unused_method_checker.rb
 - lib/guideline/error.rb
 - lib/guideline/runner.rb
 - lib/guideline/version.rb
@@ -99,6 +141,7 @@ files:
 - spec/guideline/checkers/hash_comma_checker_spec.rb
 - spec/guideline/checkers/long_line_checker_spec.rb
 - spec/guideline/checkers/long_method_checker_spec.rb
+- spec/guideline/checkers/unused_method_checker_spec.rb
 - spec/guideline/runner_spec.rb
 - spec/guideline/visitor_spec.rb
 - spec/guideline_spec.rb
@@ -123,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: The guideline of your code
@@ -134,8 +177,8 @@ test_files:
 - spec/guideline/checkers/hash_comma_checker_spec.rb
 - spec/guideline/checkers/long_line_checker_spec.rb
 - spec/guideline/checkers/long_method_checker_spec.rb
+- spec/guideline/checkers/unused_method_checker_spec.rb
 - spec/guideline/runner_spec.rb
 - spec/guideline/visitor_spec.rb
 - spec/guideline_spec.rb
 - spec/spec_helper.rb
-has_rdoc: