guideline 0.0.4 → 0.0.5

data/README.md

@@ -8,18 +8,21 @@ $ gem install guideline
 ```
 
 ## Usage
-https://github.com/r7kamura/guideline/tree/master/examples
 
 ```
-$ ruby examples/long_line_checker.rb
-spec/guideline/checker_spec.rb
-  27: Line length  88 should be less than  80 characters
+$ guideline
+lib/chatroid/adapter/campfire.rb
+  26: Line length  85 should be less than  80 characters
 
-$ ruby examples/long_method_checker.rb
-lib/guideline/checker/long_line_checker.rb
-   3: Too long   9 lines method <#check>
+lib/chatroid/adapter/twitter/event.rb
+  48: Line length  87 should be less than  80 characters
 
-lib/guideline/checker/long_method_checker.rb
-   6: Too long   9 lines method <#check>
-  42: Too long  10 lines method <#on_def>
+spec/chatroid/adapter/twitter/event_spec.rb
+  49: Line length  81 should be less than  80 characters
+
+spec/chatroid/adapter/twitter_spec.rb
+  30: Line length  85 should be less than  80 characters
+
+lib/chatroid/adapter/twitter.rb
+  19: Too long  12 lines method <#stream>
 ```

data/bin/guideline

@@ -2,32 +2,18 @@
 
 $LOAD_PATH.unshift File.expand_path("../../lib/", __FILE__)
 require "guideline"
-require "yaml"
-require "slop"
-require "active_support/all"
+include Guideline
 
-def parse_options
-  Slop.parse(:help => true) do
-    banner "Usage: guidline [directory] [options]"
-    on :c, :config, "path to guideline.yml"
-  end
-end
+options = Runner.parse(ARGV)
 
-def load_config(options)
-  path = options[:config] || File.expand_path("../../guideline.yml", __FILE__)
-  hash = YAML.load_file(path)
-  HashWithIndifferentAccess.new(hash)
-end
+checkers = CheckerFactory.new(
+  options[:config],
+  HashCommaChecker,
+  LongLineChecker,
+  LongMethodChecker,
+  HardTabIndentChecker
+).create
 
-options = parse_options
-config  = load_config(options)
-
-Guideline::Visitor.new(
-  :only    => ARGV[0],
-  :checker => Guideline::CheckerFactory.new(
-    config,
-    Guideline::LongLineChecker,
-    Guideline::LongMethodChecker,
-    Guideline::HardTabIndentChecker
-  ).create
-).check.render
+visitor = Visitor.new(:only => ARGV[0], :checker => checkers)
+visitor.visit
+visitor.render

data/lib/guideline/checkers/hash_comma_checker.rb

@@ -0,0 +1,128 @@
+require "ripper"
+
+module Guideline
+  class HashCommaChecker < Checker
+    def check(path)
+      HashParser.parse(path.read) do |line|
+        report(
+          :message => "There should be a comma after the last value of Hash",
+          :line    => line,
+          :path    => path
+        )
+      end
+    end
+
+    class HashParser < Ripper
+      class << self
+        attr_reader :callback
+
+        def parse(*, &callback)
+          @callback = callback
+          super
+        end
+      end
+
+      private
+
+      def on_lbrace(token)
+        push_stacks
+      end
+
+      def on_rbrace(token)
+        call(lineno) if has_error?
+        pop_stacks
+      end
+
+      def on_lbracket(token)
+        push_stacks
+      end
+
+      def on_rbracket(token)
+        pop_stacks
+      end
+
+      def on_lparen(token)
+        push_stacks
+      end
+
+      def on_rparen(token)
+        pop_stacks
+      end
+
+      def on_kw(token)
+        case token
+        when "do"
+          push_stacks
+        when "end"
+          pop_stacks
+        end
+      end
+
+      def on_op(token)
+        increase_key if token == "=>"
+      end
+
+      def on_comma(token)
+        increase_comma
+      end
+
+      def on_label(token)
+        increase_key
+      end
+
+      def on_nl(token)
+        increase_line
+      end
+      alias_method :on_ignored_nl, :on_nl
+
+      def call(method)
+        callback.call(method)
+      end
+
+      def callback
+        self.class.callback
+      end
+
+      def has_error?
+        line[-1] && key[-1] && comma[-1] &&
+        line[-1] > 0 && key[-1] > comma[-1]
+      end
+
+      def key
+        @key ||= []
+      end
+
+      def line
+        @line ||= []
+      end
+
+      def comma
+        @comma ||= []
+      end
+
+      def pop_stacks
+        key.pop
+        line.pop
+        comma.pop
+      end
+
+      def push_stacks
+        key   << 0
+        line  << 0
+        comma << 0
+      end
+
+      def increase_key
+        key[-1] += 1 if key[-1]
+      end
+
+      def increase_line
+        line[-1] += 1 if line[-1]
+      end
+
+      def increase_comma
+        comma[-1] += 1 if comma[-1]
+      end
+    end
+  end
+end

data/lib/guideline/checkers/long_line_checker.rb

@@ -43,7 +43,7 @@ module Guideline
       end
 
       def length
-        @line.split(//).length
+        @line.split(//).length - 1
       end
 
       def lineno

data/lib/guideline/runner.rb

@@ -0,0 +1,55 @@
+require "yaml"
+require "slop"
+
+module Guideline
+  module Runner
+    extend self
+
+    def parse(argv)
+      hash = Parser.parse(argv)
+      hash[:config] = load_config(hash[:config])
+      hash
+    end
+
+    private
+
+    def load_config(path)
+      hash = load_yaml(path || default_config_path)
+      HashWithIndifferentAccess.new(hash)
+    end
+
+    def load_yaml(path)
+      YAML.load_file(path)
+    rescue Errno::ENOENT
+      raise "No such config file - #{path}"
+    end
+
+    def default_config_path
+      File.expand_path("../../../guideline.yml", __FILE__)
+    end
+
+    class Parser
+      def self.parse(argv)
+        new(argv).parse
+      end
+
+      def initialize(argv)
+        @argv = argv
+      end
+
+      def parse
+        slop.parse(@argv)
+        slop.to_hash
+      end
+
+      private
+
+      def slop
+        @slop ||= Slop.new(:help => true) do
+          banner "Usage: guidline [directory] [options]"
+          on :c=, :config=, "path to config YAML file"
+        end
+      end
+    end
+  end
+end

data/lib/guideline/version.rb

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

data/lib/guideline/visitor.rb

@@ -10,8 +10,12 @@ module Guideline
       @block   = block
     end
 
-    def check
-      travel
+    def visit
+      paths.each do |path|
+        checkers.each do |checker|
+          checker.check(path)
+        end
+      end
       self
     end
 
@@ -25,14 +29,6 @@ module Guideline
 
     private
 
-    def travel
-      paths.each do |path|
-        checkers.each do |checker|
-          checker.check(path)
-        end
-      end
-    end
-
     def paths
       PathFinder.find(options)
     end

data/lib/guideline.rb

@@ -1,8 +1,10 @@
 require "guideline/version"
 require "guideline/visitor"
 require "guideline/error"
+require "guideline/runner"
 require "guideline/checker_factory"
 require "guideline/checkers/checker"
 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"

data/spec/guideline/checker_factory_spec.rb

@@ -19,10 +19,10 @@ module Guideline
       end
 
       it "creates instances of given classes with given config" do
-        LongLineChecker.should_receive(:new).with(:max => 80).and_call_original
-        LongMethodChecker.should_receive(:new).with(:max => 10).and_call_original
         checkers[0].should be_a LongLineChecker
         checkers[1].should be_a LongMethodChecker
+        checkers[0].send(:max).should == 80
+        checkers[1].send(:max).should == 10
       end
     end
   end

data/spec/guideline/checkers/hard_tab_indent_checker_spec.rb

@@ -26,7 +26,7 @@ module Guideline
         end
       end
 
-      context "when there is no too long line" do
+      context "when there is no hard tab indent" do
         let(:content) do
           <<-EOF
             def foo

data/spec/guideline/checkers/hash_comma_checker_spec.rb

@@ -0,0 +1,102 @@
+require "spec_helper"
+
+module Guideline
+  describe HashCommaChecker do
+    describe "#check" do
+      subject do
+        checker.check(path)
+        checker
+      end
+
+      let(:checker) do
+        described_class.new
+      end
+
+      let(:path) do
+        mock(:read => script)
+      end
+
+      context "when there is no last comma in sigleline hash" do
+        let(:script) do
+          <<-EOF
+            { :a => 1 }
+          EOF
+        end
+
+        specify "checker does not detect error" do
+          should_not have_error
+        end
+      end
+
+      context "when there is last comma in sigleline hash" do
+        let(:script) do
+          <<-EOF
+            { :a => 1, }
+          EOF
+        end
+
+        specify "checker does not detect error" do
+          should_not have_error
+        end
+      end
+
+      context "when there is no last comma in multiline hash" do
+        let(:script) do
+          <<-EOF
+            {
+              :a => 1
+            }
+          EOF
+        end
+
+        specify "checker detects error" do
+          should have_error
+        end
+      end
+
+      context "when there is no last comma in multiline hash with array" do
+        let(:script) do
+          <<-EOF
+            {
+              :a => [1, 2, 3]
+            }
+          EOF
+        end
+
+        specify "checker detects error" do
+          should have_error
+        end
+      end
+
+      context "when there is last comma in multiline hash" do
+        let(:script) do
+          <<-EOF
+            {
+              :a => 1,
+            }
+          EOF
+        end
+
+        specify "checker does not detect error" do
+          should_not have_error
+        end
+      end
+
+      context "when there is no last comma in multiline nested hash" do
+        let(:script) do
+          <<-EOF
+            {
+              :a => {
+                :b => 1,
+              }
+            }
+          EOF
+        end
+
+        specify "checker detects error" do
+          should have_error
+        end
+      end
+    end
+  end
+end

data/spec/guideline/checkers/long_line_checker_spec.rb

@@ -15,7 +15,7 @@ module Guideline
         let(:content) do
           <<-EOF
             def foo
-              too looooooooooooooooooooooooooooooooooooooooooooooooooooong line
+              too looooooooooooooooooooooooong line
             end
           EOF
         end
@@ -30,7 +30,7 @@ module Guideline
         let(:content) do
           <<-EOF
             def foo
-              not long line
+              not loooooooooooooooooooooooong line
             end
           EOF
         end

data/spec/guideline/runner_spec.rb

@@ -0,0 +1,55 @@
+require "spec_helper"
+
+module Guideline
+  describe Runner do
+    describe ".parse" do
+      subject do
+        described_class.parse(argv)
+      end
+
+      let(:path) do
+        File.expand_path("../../../guideline.yml", __FILE__)
+      end
+
+      context "when config option is passed" do
+        let(:argv) do
+          ["--config", path]
+        end
+
+        it "parses ARGV and returns options with config hash" do
+          should have_key(:config)
+        end
+      end
+
+      context "when config option is passed in short version" do
+        let(:argv) do
+          ["-c", path]
+        end
+
+        it "parses ARGV and returns options with config hash" do
+          should have_key(:config)
+        end
+      end
+
+      context "when config option is not passed" do
+        let(:argv) do
+          []
+        end
+
+        it "parses ARGV and returns options with config hash" do
+          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

@@ -22,14 +22,10 @@ module Guideline
       mock
     end
 
-    describe "#check" do
-      subject do
-        visitor.check
-      end
-
+    describe "#visit" do
       it "calls checker#check with matched path" do
         checker.should_receive(:check).with(path)
-        subject
+        visitor.visit
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guideline
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-22 00:00:00.000000000 Z
+date: 2012-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slop
-  requirement: &70129049410700 !ruby/object:Gem::Requirement
+  requirement: &70304744680520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70129049410700
+  version_requirements: *70304744680520
 - !ruby/object:Gem::Dependency
   name: active_support
-  requirement: &70129049409360 !ruby/object:Gem::Requirement
+  requirement: &70304744680100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70129049409360
+  version_requirements: *70304744680100
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70129049423300 !ruby/object:Gem::Requirement
+  requirement: &70304744679680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70129049423300
+  version_requirements: *70304744679680
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70129049419980 !ruby/object:Gem::Requirement
+  requirement: &70304744679180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 2.12.0
   type: :development
   prerelease: false
-  version_requirements: *70129049419980
+  version_requirements: *70304744679180
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70129049417400 !ruby/object:Gem::Requirement
+  requirement: &70304744678760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70129049417400
+  version_requirements: *70304744678760
 description: Guideline.gem checks if your code observes your coding guidelines
 email:
 - r7kamura@gmail.com
@@ -80,25 +80,26 @@ files:
 - README.md
 - Rakefile
 - bin/guideline
-- examples/hard_tab_indent_checker.rb
-- examples/long_line_checker.rb
-- examples/long_method_checker.rb
 - guideline.gemspec
 - guideline.yml
 - lib/guideline.rb
 - lib/guideline/checker_factory.rb
 - lib/guideline/checkers/checker.rb
 - lib/guideline/checkers/hard_tab_indent_checker.rb
+- lib/guideline/checkers/hash_comma_checker.rb
 - lib/guideline/checkers/long_line_checker.rb
 - lib/guideline/checkers/long_method_checker.rb
 - lib/guideline/error.rb
+- lib/guideline/runner.rb
 - lib/guideline/version.rb
 - lib/guideline/visitor.rb
 - spec/guideline/checker_factory_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
 - spec/guideline/checkers/long_line_checker_spec.rb
 - spec/guideline/checkers/long_method_checker_spec.rb
+- spec/guideline/runner_spec.rb
 - spec/guideline/visitor_spec.rb
 - spec/guideline_spec.rb
 - spec/spec_helper.rb
@@ -130,8 +131,10 @@ test_files:
 - spec/guideline/checker_factory_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
 - spec/guideline/checkers/long_line_checker_spec.rb
 - spec/guideline/checkers/long_method_checker_spec.rb
+- spec/guideline/runner_spec.rb
 - spec/guideline/visitor_spec.rb
 - spec/guideline_spec.rb
 - spec/spec_helper.rb

data/examples/hard_tab_indent_checker.rb

@@ -1,9 +0,0 @@
-#!/usr/bin/env ruby
-
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
-require "guideline"
-
-checker = Guideline::HardTabIndentChecker.new
-visitor = Guideline::Visitor.new(:checker => checker)
-visitor.check
-visitor.render

data/examples/long_line_checker.rb

@@ -1,9 +0,0 @@
-#!/usr/bin/env ruby
-
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
-require "guideline"
-
-checker = Guideline::LongLineChecker.new(:max => 80)
-visitor = Guideline::Visitor.new(:checker => checker)
-visitor.check
-visitor.render

data/examples/long_method_checker.rb

@@ -1,9 +0,0 @@
-#!/usr/bin/env ruby
-
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
-require "guideline"
-
-checker = Guideline::LongMethodChecker.new(:max => 5)
-visitor = Guideline::Visitor.new(:checker => checker)
-visitor.check
-visitor.render