guideline 0.0.1 → 0.0.2

data/README.md

@@ -1,4 +1,5 @@
 # Guideline
+Check your code
 
 ## Installation
 
@@ -7,5 +8,18 @@ $ gem install guideline
 ```
 
 ## Usage
+https://github.com/r7kamura/guideline/tree/master/examples
 
-See 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
+
+$ ruby examples/long_method_checker.rb
+lib/guideline/checker/long_line_checker.rb
+   3: Too long   9 lines method <#check>
+
+lib/guideline/checker/long_method_checker.rb
+   6: Too long   9 lines method <#check>
+  42: Too long  10 lines method <#on_def>
+```

data/examples/long_line_checker.rb

@@ -3,27 +3,7 @@
 $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 require "guideline"
 
-checker = Guideline::LongLineChecker.new(:max => 128)
+checker = Guideline::LongLineChecker.new(:max => 80)
 visitor = Guideline::Visitor.new(:checker => checker)
-errors  = visitor.check
-errors.group_by(&:path).each do |path, error_set|
-  puts path
-  error_set.each do |error|
-    puts "%4d: %s" % [error.line, error.message]
-  end
-  puts
-end
-
-__END__
-app/controllers/blogs_controller.rb
-   8: Line length 169 should be less than 128 characters
-
-app/models/blog.rb
-   4: Line length 169 should be less than 128 characters
-
-spec/controllers/blogs_controller_spec.rb
-   6: Line length 139 should be less than 128 characters
-  10: Line length 194 should be less than 128 characters
-  16: Line length 145 should be less than 128 characters
-  17: Line length 139 should be less than 128 characters
-  21: Line length 194 should be less than 128 characters
+visitor.check
+visitor.render

data/examples/long_method_checker.rb

@@ -0,0 +1,9 @@
+#!/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

data/lib/guideline/checker/long_method_checker.rb

@@ -0,0 +1,73 @@
+require "ripper"
+require "ostruct"
+
+module Guideline
+  class LongMethodChecker < Checker
+    def check(path)
+      MethodParser.parse(path.read) do |method|
+        if method.height > max
+          add_error(
+            :message => method.message,
+            :line    => method.line,
+            :path    => path
+          )
+        end
+      end
+    end
+
+    private
+
+    def max
+      @options[:max] || 50
+    end
+
+    class Method < OpenStruct
+      def message
+        "Too long %3d lines method <#%s>" % [height, name]
+      end
+    end
+
+    class MethodParser < Ripper
+      class << self
+        attr_reader :callback
+
+        def parse(*, &callback)
+          @callback = callback
+          super
+        end
+      end
+
+      private
+
+      def on_def(name, *)
+        start  = lineno_stack.pop
+        finish = lineno
+        height = finish - start - 1
+        method = Method.new(
+          :name   => name,
+          :line   => start,
+          :height => height
+        )
+        call(method)
+        super
+      end
+
+      def on_kw(name)
+        lineno_stack << lineno if name == "def"
+        super
+      end
+
+      def lineno_stack
+        @lineno_stack ||= []
+      end
+
+      def call(method)
+        callback.call(method)
+      end
+
+      def callback
+        self.class.callback
+      end
+    end
+  end
+end

data/lib/guideline/checker.rb

@@ -9,7 +9,7 @@ module Guideline
     end
 
     def add_error(options)
-      errors << OpenStruct.new(
+      errors << Error.new(
         :message => options[:message],
         :path    => options[:path],
         :line    => options[:line]

data/lib/guideline/error.rb

@@ -0,0 +1,9 @@
+require "ostruct"
+
+module Guideline
+  class Error < OpenStruct
+    def render
+      puts "%4d: %s" % [line, message]
+    end
+  end
+end

data/lib/guideline/version.rb

@@ -1,3 +1,3 @@
 module Guideline
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/guideline/visitor.rb

@@ -1,4 +1,5 @@
 require "pathname"
+require "active_support/all"
 
 module Guideline
   class Visitor
@@ -14,6 +15,14 @@ module Guideline
       errors
     end
 
+    def render
+      errors.group_by(&:path).each do |path, errors|
+        puts path
+        errors.each(&:render)
+        puts
+      end
+    end
+
     private
 
     def travel

data/lib/guideline.rb

@@ -1,7 +1,6 @@
-require "ostruct"
-require "active_support/all"
-
 require "guideline/version"
 require "guideline/visitor"
+require "guideline/error"
 require "guideline/checker"
 require "guideline/checker/long_line_checker"
+require "guideline/checker/long_method_checker"

data/spec/guideline/checker/long_line_checker_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+module Guideline
+  describe LongLineChecker do
+    describe "#check" do
+      subject do
+        checker.check(path)
+      end
+
+      let(:checker) do
+        described_class.new(:max => 1)
+      end
+
+      let(:path) do
+        Pathname.new(__FILE__)
+      end
+
+      it do
+        should be_a Array
+      end
+
+      it do
+        subject
+        checker.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.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-20 00:00:00.000000000 Z
+date: 2012-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_support
-  requirement: &70150348023000 !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: *70150348023000
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70150348021800 !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: *70150348021800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70150348020440 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70150348020440
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70150348034340 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +69,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70150348034340
+  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
@@ -68,12 +88,16 @@ files:
 - README.md
 - Rakefile
 - examples/long_line_checker.rb
+- examples/long_method_checker.rb
 - guideline.gemspec
 - lib/guideline.rb
 - lib/guideline/checker.rb
 - lib/guideline/checker/long_line_checker.rb
+- lib/guideline/checker/long_method_checker.rb
+- lib/guideline/error.rb
 - lib/guideline/version.rb
 - lib/guideline/visitor.rb
+- spec/guideline/checker/long_line_checker_spec.rb
 - spec/guideline/checker_spec.rb
 - spec/guideline/visitor_spec.rb
 - spec/guideline_spec.rb
@@ -98,13 +122,13 @@ 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
 test_files:
+- spec/guideline/checker/long_line_checker_spec.rb
 - spec/guideline/checker_spec.rb
 - spec/guideline/visitor_spec.rb
 - spec/guideline_spec.rb
 - spec/spec_helper.rb
-has_rdoc: