guideline 0.0.9 → 0.1.0

data/guideline.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency "active_support"
   gem.add_development_dependency "rspec", ">=2.12.0"
   gem.add_development_dependency "pry"
+  gem.add_development_dependency "simplecov"
 end

data/lib/guideline/checkers/unused_method_checker.rb

@@ -89,7 +89,7 @@ module Guideline
 
     class MethodCallChecker < MethodChecker
       interesting_files /.*\.rb/
-      interesting_nodes :call, :fcall, :vcall, :var_ref
+      interesting_nodes :call, :fcall, :vcall
 
       add_callback :start_call do |node|
         call(node.message.to_s)
@@ -102,10 +102,6 @@ module Guideline
       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

data/lib/guideline/runner.rb

@@ -16,7 +16,7 @@ module Guideline
     end
 
     def parse
-      generate_default_config_file if @hash[:init]
+      before_hook
       @hash[:config] = load_config
       @hash.delete(:help)
       @hash
@@ -24,6 +24,20 @@ module Guideline
 
     private
 
+    def before_hook
+      case
+      when @hash[:init]
+        generate_default_config_file
+      when @hash[:version]
+        show_version
+      end
+    end
+
+    def show_version
+      puts VERSION
+      exit
+    end
+
     def load_config
       YAML.load_file(config_path)
     rescue Errno::ENOENT
@@ -74,6 +88,7 @@ module Guideline
           banner "Usage: guideline [directory] [options]"
           on :c=, :config=, "Path to config YAML file."
           on :i, :init, "Generate config YAML template into current directory."
+          on :v, :version, "Show version number"
         end
       end
     end

data/lib/guideline/version.rb

@@ -1,3 +1,3 @@
 module Guideline
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

data/lib/guideline/visitor.rb

@@ -70,18 +70,14 @@ module Guideline
 
       def excepted_paths
         if except_pattern
-          Pathname.glob(only_pattern)
+          Pathname.glob(except_pattern)
         else
           []
         end
       end
 
       def only_pattern
-        if options[:only]
-          "#{options[:only]}/**/*.rb"
-        else
-          "**/*.rb"
-        end
+        options[:only] || "**/*.rb"
       end
 
       def except_pattern

data/spec/guideline/checkers/abc_complexity_checker_spec.rb

@@ -166,6 +166,60 @@ module Guideline
         end
         it { should have_error }
       end
+
+      context "when there is module definition" do
+        let(:script) do
+          <<-EOF
+            module ModuleName
+              def a
+                b.c
+              end
+            end
+          EOF
+        end
+        it "reports error method with module name" do
+          checker.should_receive(:report) do |args|
+            args[:message].should include("ModuleName#a")
+          end
+          subject
+        end
+      end
+
+      context "when there is class definition" do
+        let(:script) do
+          <<-EOF
+            class ClassName
+              def a
+                b.c
+              end
+            end
+          EOF
+        end
+        it "reports error method with class name" do
+          checker.should_receive(:report) do |args|
+            args[:message].should include("ClassName#a")
+          end
+          subject
+        end
+      end
+
+      context "when there is class method definition" do
+        let(:script) do
+          <<-EOF
+            class ClassName
+              def self.a
+                b.c
+              end
+            end
+          EOF
+        end
+        it "reports error class method with class name" do
+          checker.should_receive(:report) do |args|
+            args[:message].should include("ClassName.a")
+          end
+          subject
+        end
+      end
     end
   end
 end

data/spec/guideline/checkers/hash_comma_checker_spec.rb

@@ -28,10 +28,12 @@ module Guideline
         end
       end
 
-      context "when there is last comma in sigleline hash" do
+      context "when there is last comma" do
         let(:script) do
           <<-EOF
-            { :a => 1, }
+            {
+              :a => 1,
+            }
           EOF
         end
 
@@ -40,7 +42,7 @@ module Guideline
         end
       end
 
-      context "when there is no last comma in multiline hash" do
+      context "when there is no last comma" do
         let(:script) do
           <<-EOF
             {
@@ -54,7 +56,7 @@ module Guideline
         end
       end
 
-      context "when there is no last comma in multiline hash of new syntax" do
+      context "when there is no last comma with new hash syntax" do
         let(:script) do
           <<-EOF
             {
@@ -68,7 +70,7 @@ module Guideline
         end
       end
 
-      context "when there is no last comma in multiline hash with array" do
+      context "when there is no last comma with array" do
         let(:script) do
           <<-EOF
             {
@@ -82,27 +84,27 @@ module Guideline
         end
       end
 
-      context "when there is last comma in multiline hash" do
+      context "when there is no last comma with nested hash" do
         let(:script) do
           <<-EOF
             {
-              :a => 1,
+              :a => {
+                :b => 1,
+              }
             }
           EOF
         end
 
-        it "does not detect error" do
-          should_not have_error
+        it "detects error" do
+          should have_error
         end
       end
 
-      context "when there is no last comma in multiline nested hash" do
+      context "when there is no last comma with embedded expansion" do
         let(:script) do
-          <<-EOF
+          <<-'EOF'
             {
-              :a => {
-                :b => 1,
-              }
+              :a => "#{b(1, 2)}"
             }
           EOF
         end
@@ -112,17 +114,33 @@ module Guideline
         end
       end
 
-      context "when there is embedded expansion brace" do
+      context "when there is no last comma with round braces" do
         let(:script) do
           <<-'EOF'
             {
-              :a => "#{b}",
+              :a => b(1, 2)
             }
           EOF
         end
 
-        it "does not detect error" do
-          should_not have_error
+        it "detects error" do
+          should have_error
+        end
+      end
+
+      context "when there is no last comma with do-end args" do
+        let(:script) do
+          <<-'EOF'
+            {
+              :a => b do |c, d|
+                1
+              end
+            }
+          EOF
+        end
+
+        it "detects error" do
+          should have_error
         end
       end
     end

data/spec/guideline/error_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+
+module Guideline
+  describe Error do
+    let(:error) do
+      described_class.new(:line => 1, :message => "message")
+    end
+
+    describe "#render" do
+      it "renders its line and message" do
+        error.should_receive(:puts).with("   1: message")
+        error.render
+      end
+    end
+  end
+end

data/spec/guideline/runner_spec.rb

@@ -8,13 +8,17 @@ module Guideline
       end
 
       before do
-        described_class.any_instance.stub(:puts)
+        runner.stub(:puts)
       end
 
       let(:argv) do
         []
       end
 
+      let(:runner) do
+        described_class.any_instance
+      end
+
       it { should be_a HashWithIndifferentAccess }
 
       context "when given --init option" do
@@ -24,7 +28,7 @@ module Guideline
 
         context "when config file already exists" do
           before do
-            described_class.any_instance.stub(:config_file_exist? => true)
+            File.stub(:exist? => true)
           end
 
           it "does not generate config file" do
@@ -35,7 +39,7 @@ module Guideline
 
         context "when config file does not exist" do
           before do
-            described_class.any_instance.stub(:config_file_exist? => false)
+            File.stub(:exist? => false)
           end
 
           it "generates config file" do
@@ -45,6 +49,17 @@ module Guideline
         end
       end
 
+      context "when given --version option" do
+        let(:argv) do
+          ["--version"]
+        end
+
+        it "shows current version number and exit" do
+          runner.should_receive(:puts).with(VERSION)
+          expect { subject }.to raise_error(SystemExit)
+        end
+      end
+
       context "when not given --config option" do
         it "returns default config parsed from guideline.yml" do
           should == {
@@ -60,6 +75,7 @@ module Guideline
               },
             },
             "init" => nil,
+            "version" => nil,
           }
         end
       end
@@ -79,6 +95,7 @@ module Guideline
               "a" => "b",
             },
             "init" => nil,
+            "version" => nil,
           }
         end
       end

data/spec/guideline/visitor_spec.rb

@@ -2,30 +2,54 @@ require "spec_helper"
 
 module Guideline
   describe Visitor do
-    before do
-      visitor.stub(:paths).and_return(paths)
+    let(:visitor) do
+      described_class.new(options)
     end
 
-    let(:visitor) do
-      described_class.new(:checker => [checker])
+    let(:options) do
+      { :checker => [checker] }
     end
 
     let(:checker) do
       mock(:has_error? => false)
     end
 
-    let(:paths) do
-      [path]
-    end
+    describe "#visit" do
+      let(:path) do
+        Pathname.new("spec/guideline/visitor_spec.rb")
+      end
 
-    let(:path) do
-      mock
-    end
+      context "when :only option is not specified" do
+        it "visits all paths" do
+          called = false
+          checker.should_receive(:check).at_least(1) do |args|
+            called = true if args == path
+          end
+          visitor.visit
+          called.should be_true
+        end
+      end
 
-    describe "#visit" do
-      it "calls checker#check with path" do
-        checker.should_receive(:check).with(path)
-        visitor.visit
+      context "when :only option is specified" do
+        before do
+          options[:only] = "lib/**/*.rb"
+        end
+
+        it "does not visit paths which are not specified" do
+          checker.should_not_receive(:check).with(path)
+          visitor.visit
+        end
+      end
+
+      context "when :except option is specified" do
+        before do
+          options[:except] = "spec/**/*.rb"
+        end
+
+        it "does not visit paths which are specified" do
+          checker.should_not_receive(:check).with(path)
+          visitor.visit
+        end
       end
     end
 
@@ -36,7 +60,7 @@ module Guideline
         end
 
         it "calls checker#prepare with path" do
-          checker.should_receive(:prepare).with(path)
+          checker.should_receive(:prepare).at_least(1)
           visitor.prepare
         end
       end
@@ -52,5 +76,25 @@ module Guideline
         end
       end
     end
+
+    describe "#render" do
+      before do
+        visitor.instance_variable_set(:@errors, errors)
+        visitor.stub(:puts)
+      end
+
+      let(:errors) do
+        [error]
+      end
+
+      let(:error) do
+        mock(:path => "path")
+      end
+
+      it "calls #render of each error" do
+        error.should_receive(:render)
+        visitor.render
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,2 +1,5 @@
+require "simplecov"
+SimpleCov.start
+
 $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 require "guideline"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guideline
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slop
-  requirement: &70154114004860 !ruby/object:Gem::Requirement
+  requirement: &70231125798820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70154114004860
+  version_requirements: *70231125798820
 - !ruby/object:Gem::Dependency
   name: code_analyzer
-  requirement: &70154114004440 !ruby/object:Gem::Requirement
+  requirement: &70231125798400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70154114004440
+  version_requirements: *70231125798400
 - !ruby/object:Gem::Dependency
   name: active_support
-  requirement: &70154114004020 !ruby/object:Gem::Requirement
+  requirement: &70231125797980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70154114004020
+  version_requirements: *70231125797980
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70154114003520 !ruby/object:Gem::Requirement
+  requirement: &70231125797480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 2.12.0
   type: :development
   prerelease: false
-  version_requirements: *70154114003520
+  version_requirements: *70231125797480
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70154114003100 !ruby/object:Gem::Requirement
+  requirement: &70231125797060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70154114003100
+  version_requirements: *70231125797060
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70231125796600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70231125796600
 description: Guideline.gem checks that your code is protectingthe rule of coding guideline
 email:
 - r7kamura@gmail.com
@@ -103,6 +114,7 @@ files:
 - 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/error_spec.rb
 - spec/guideline/runner_spec.rb
 - spec/guideline/visitor_spec.rb
 - spec/guideline_spec.rb
@@ -140,6 +152,7 @@ test_files:
 - 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/error_spec.rb
 - spec/guideline/runner_spec.rb
 - spec/guideline/visitor_spec.rb
 - spec/guideline_spec.rb