guideline 0.1.1 → 0.1.2

data/bin/guideline

@@ -9,11 +9,12 @@ options = Runner.parse(ARGV)
 checkers = CheckerFactory.new(
   options[:config],
   AbcComplexityChecker,
-  UnusedMethodChecker,
+  HardTabIndentChecker,
   HashCommaChecker,
   LongLineChecker,
   LongMethodChecker,
-  HardTabIndentChecker
+  TrailingWhitespaceChecker,
+  UnusedMethodChecker,
 ).create
 
 visitor = Visitor.new(:only => ARGV[0], :checker => checkers)

data/lib/guideline.rb

@@ -2,11 +2,13 @@ require "guideline/version"
 require "guideline/visitor"
 require "guideline/error"
 require "guideline/runner"
+require "guideline/parser/moduleable"
 require "guideline/checker_factory"
 require "guideline/checkers/checker"
-require "guideline/checkers/long_line_checker"
-require "guideline/checkers/long_method_checker"
+require "guideline/checkers/abc_complexity_checker"
 require "guideline/checkers/hard_tab_indent_checker"
 require "guideline/checkers/hash_comma_checker"
+require "guideline/checkers/long_line_checker"
+require "guideline/checkers/long_method_checker"
+require "guideline/checkers/trailing_whitespace_checker"
 require "guideline/checkers/unused_method_checker"
-require "guideline/checkers/abc_complexity_checker"

data/lib/guideline/checkers/abc_complexity_checker.rb

@@ -1,4 +1,4 @@
-require "ripper"
+require "code_analyzer"
 
 module Guideline
   class AbcComplexityChecker < Checker
@@ -36,38 +36,6 @@ module Guideline
       @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]
@@ -75,7 +43,7 @@ module Guideline
       CONDITION_TOKENS = [:==, :===, :"<>", :<=, :>=, :=~, :>, :<, :<=>]
       ALL_NODES        = ASSIGNMENT_NODES + BRANCH_NODES + CONDITION_NODES
 
-      include Moduleable
+      include Parser::Moduleable
 
       attr_reader :assignment, :branch, :condition
 

data/lib/guideline/checkers/trailing_whitespace_checker.rb

@@ -0,0 +1,15 @@
+module Guideline
+  class TrailingWhitespaceChecker < Checker
+    def check(path)
+      path.each_line.with_index do |line, index|
+        if line =~ / $/
+          report(
+            :message => "Remove trailing whitespace",
+            :path    => path,
+            :line    => index + 1
+          )
+        end
+      end
+    end
+  end
+end

data/lib/guideline/checkers/unused_method_checker.rb

@@ -49,9 +49,13 @@ module Guideline
     def report_unused_methods(path)
       unused_methods.each do |method|
         report(
-          :message => "Remove unused method <#{method.name}>",
           :path    => path,
-          :line    => method.line
+          :line    => method.line,
+          :message => "Remove unused method <%s%s%s>" % [
+            method.module_name,
+            method.class_method ? "." : "#",
+            method.name,
+          ],
         )
       end
     end
@@ -78,12 +82,30 @@ module Guideline
     end
 
     class MethodDefinitionChecker < MethodChecker
+      include Parser::Moduleable
+
       interesting_files /.*\.rb/
-      interesting_nodes :def
+      interesting_nodes :def, :defs
 
       add_callback :start_def do |node|
-        definition = Definition.new(:line => node.line, :name => node.method_name.to_s)
-        call(definition)
+        call(
+          Definition.new(
+            :line        => node.line,
+            :name        => node.method_name.to_s,
+            :module_name => current_module_name,
+          )
+        )
+      end
+
+      add_callback :start_defs do |node|
+        call(
+          Definition.new(
+            :line         => node.line,
+            :name         => node.method_name.to_s,
+            :module_name  => current_module_name,
+            :class_method => true,
+          )
+        )
       end
     end
 

data/lib/guideline/parser/moduleable.rb

@@ -0,0 +1,35 @@
+module Guideline
+  class Parser
+    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
+  end
+end

data/lib/guideline/version.rb

@@ -1,3 +1,3 @@
 module Guideline
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/guideline/checkers/trailing_whitespace_checker_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+module Guideline
+  describe TrailingWhitespaceChecker do
+    describe "#check" do
+      let(:checker) do
+        described_class.new
+      end
+
+      let(:path) do
+        mock(:each_line => script.each_line)
+      end
+
+      context "when there is trailing whitespace" do
+        let(:script) do
+          <<-EOF
+            1 
+          EOF
+        end
+
+        it "detects error" do
+          checker.check(path)
+          checker.should have_error
+        end
+      end
+
+      context "when there is no trailing whitespace" do
+        let(:script) do
+          <<-EOF
+            1
+          EOF
+        end
+
+        it "does not detect error" do
+          checker.check(path)
+          checker.should_not have_error
+        end
+      end
+    end
+  end
+end

data/spec/guideline/checkers/unused_method_checker_spec.rb

@@ -68,6 +68,44 @@ module Guideline
         checker.check(path)
         checker.send(:definitions).should be_empty
       end
+
+      context "when there is unused instance method" do
+        let(:script) do
+          <<-EOF
+            class A
+              def c
+                1
+              end
+            end
+          EOF
+        end
+
+        it "reports it as instance method" do
+          checker.should_receive(:report) do |args|
+            args[:message].should include("A#c")
+          end
+          checker.check(path)
+        end
+      end
+
+      context "when there is unused class method" do
+        let(:script) do
+          <<-EOF
+            class A
+              def self.c
+                1
+              end
+            end
+          EOF
+        end
+
+        it "reports it as class method" do
+          checker.should_receive(:report) do |args|
+            args[:message].should include("A.c")
+          end
+          checker.check(path)
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guideline
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-02 00:00:00.000000000 Z
+date: 2012-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slop
-  requirement: &70218636493320 !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: *70218636493320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: code_analyzer
-  requirement: &70218636492900 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70218636492900
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70218636492480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70218636492480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70218636491980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: 2.12.0
   type: :development
   prerelease: false
-  version_requirements: *70218636491980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70218636522520 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +85,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70218636522520
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70218636522060 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +101,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70218636522060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Guideline.gem checks that your code is protectingthe rule of coding guideline
 email:
 - r7kamura@gmail.com
@@ -101,8 +131,10 @@ 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/trailing_whitespace_checker.rb
 - lib/guideline/checkers/unused_method_checker.rb
 - lib/guideline/error.rb
+- lib/guideline/parser/moduleable.rb
 - lib/guideline/runner.rb
 - lib/guideline/version.rb
 - lib/guideline/visitor.rb
@@ -113,11 +145,11 @@ 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/trailing_whitespace_checker_spec.rb
 - spec/guideline/checkers/unused_method_checker_spec.rb
 - spec/guideline/error_spec.rb
 - spec/guideline/runner_spec.rb
 - spec/guideline/visitor_spec.rb
-- spec/guideline_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/r7kamura/guideline
 licenses: []
@@ -139,7 +171,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
@@ -151,10 +183,9 @@ 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/trailing_whitespace_checker_spec.rb
 - spec/guideline/checkers/unused_method_checker_spec.rb
 - spec/guideline/error_spec.rb
 - spec/guideline/runner_spec.rb
 - spec/guideline/visitor_spec.rb
-- spec/guideline_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/spec/guideline_spec.rb

@@ -1,4 +0,0 @@
-require "spec_helper"
-
-module Guideline
-end