guideline 0.0.3 → 0.0.4

data/bin/guideline

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path("../../lib/", __FILE__)
+require "guideline"
+require "yaml"
+require "slop"
+require "active_support/all"
+
+def parse_options
+  Slop.parse(:help => true) do
+    banner "Usage: guidline [directory] [options]"
+    on :c, :config, "path to guideline.yml"
+  end
+end
+
+def load_config(options)
+  path = options[:config] || File.expand_path("../../guideline.yml", __FILE__)
+  hash = YAML.load_file(path)
+  HashWithIndifferentAccess.new(hash)
+end
+
+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

data/examples/hard_tab_indent_checker.rb

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

@@ -17,8 +17,9 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
+  gem.add_dependency "slop"
   gem.add_dependency "active_support"
   gem.add_dependency "i18n"
-  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rspec", ">=2.12.0"
   gem.add_development_dependency "pry"
 end

data/guideline.yml

@@ -0,0 +1,4 @@
+"Guideline::LongLineChecker":
+  max: 80
+"Guideline::LongMethodChecker":
+  max: 10

data/lib/guideline/checker_factory.rb

@@ -0,0 +1,18 @@
+module Guideline
+  class CheckerFactory
+    def initialize(options, *checker_classes)
+      @options = options
+      @checker_classes = checker_classes
+    end
+
+    def create
+      @checker_classes.map do |klass|
+        klass.new(options_for(klass))
+      end
+    end
+
+    def options_for(klass)
+      @options[klass.to_s] || {}
+    end
+  end
+end

data/lib/guideline/checkers/checker.rb

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

data/lib/guideline/checkers/hard_tab_indent_checker.rb

@@ -3,7 +3,7 @@ module Guideline
     def check(path)
       path.each_line.with_index do |line, index|
         if line =~ /^ *\t/
-          add_error(
+          report(
             :message => "Use space indent instead of hard tab indent",
             :path    => path,
             :line    => index + 1

data/lib/guideline/checkers/long_line_checker.rb

@@ -1,22 +1,20 @@
 module Guideline
   class LongLineChecker < Checker
     def check(path)
-      lines(path).each_with_index do |line, index|
-        if line.has_error?
-          add_error(
-            :message => line.message,
-            :path    => path,
-            :line    => index + 1
-          )
-        end
+      lines(path).select(&:has_error?).each do |line|
+        report(
+          :line    => line.lineno,
+          :message => line.message,
+          :path    => path
+        )
       end
     end
 
     private
 
     def lines(path)
-      path.each_line.map do |line|
-        LineChecker.new(line, :max => max)
+      path.each_line.map.with_index do |line, index|
+        LineChecker.new(line, :max => max, :lineno => index + 1)
       end
     end
 
@@ -47,6 +45,10 @@ module Guideline
       def length
         @line.split(//).length
       end
+
+      def lineno
+        @options[:lineno]
+      end
     end
   end
 end

data/lib/guideline/checkers/long_method_checker.rb

@@ -6,7 +6,7 @@ module Guideline
     def check(path)
       MethodParser.parse(path.read) do |method|
         if method.height > max
-          add_error(
+          report(
             :message => method.message,
             :line    => method.line,
             :path    => path

data/lib/guideline/version.rb

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

data/lib/guideline/visitor.rb

@@ -12,7 +12,7 @@ module Guideline
 
     def check
       travel
-      errors
+      self
     end
 
     def render
@@ -63,18 +63,28 @@ module Guideline
       private
 
       def found_paths
-        search_paths(options[:only] || "**/*.rb")
+        Pathname.glob(only_pattern)
       end
 
       def excepted_paths
-        search_paths(options[:except])
+        if except_pattern
+          Pathname.glob(only_pattern)
+        else
+          []
+        end
       end
 
-      def search_paths(patterns)
-        Array(patterns).inject([]) do |paths, pattern|
-          paths + Pathname.glob(pattern)
+      def only_pattern
+        if options[:only]
+          "#{options[:only]}/**/*.rb"
+        else
+          "**/*.rb"
         end
       end
+
+      def except_pattern
+        options[:except]
+      end
     end
   end
 end

data/lib/guideline.rb

@@ -1,6 +1,7 @@
 require "guideline/version"
 require "guideline/visitor"
 require "guideline/error"
+require "guideline/checker_factory"
 require "guideline/checkers/checker"
 require "guideline/checkers/long_line_checker"
 require "guideline/checkers/long_method_checker"

data/spec/guideline/checker_factory_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+module Guideline
+  describe CheckerFactory do
+    describe "#create" do
+      subject do
+        described_class.new(
+          {
+            "Guideline::LongLineChecker" => { :max => 80 },
+            "Guideline::LongMethodChecker" => { :max => 10 },
+          },
+          LongLineChecker,
+          LongMethodChecker,
+        ).create
+      end
+
+      let(:checkers) do
+        subject
+      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
+      end
+    end
+  end
+end

data/spec/guideline/checkers/checker_spec.rb

@@ -18,21 +18,6 @@ module Guideline
       }
     end
 
-    describe "#initialize" do
-      subject do
-        instance
-      end
-
-      it "saves given options" do
-        described_class.new(options).instance_variable_get(:@options).should == options
-      end
-
-      it "can omit options" do
-        described_class.new.instance_variable_get(:@options).should == {}
-      end
-    end
-
-
     describe "#errors" do
       subject do
         instance.errors
@@ -43,9 +28,9 @@ module Guideline
       end
     end
 
-    describe "#add_error" do
+    describe "#report" do
       it "adds error record into its errors" do
-        instance.add_error(error)
+        instance.report(error)
         instance.errors.first.message.should == "message"
       end
     end
@@ -61,7 +46,7 @@ module Guideline
 
       context "when its errors is not empty" do
         before do
-          instance.add_error(error)
+          instance.report(error)
         end
 
         it { should be_true }

data/spec/guideline/visitor_spec.rb

@@ -7,11 +7,7 @@ module Guideline
     end
 
     let(:visitor) do
-      described_class.new(:checker => checker)
-    end
-
-    let(:options) do
-      { :checker => checker }
+      described_class.new(:checker => [checker])
     end
 
     let(:checker) do
@@ -26,16 +22,6 @@ module Guideline
       mock
     end
 
-    describe "#initialize" do
-      subject do
-        visitor
-      end
-
-      it "creates a new instance of #{described_class}" do
-        be_a described_class
-      end
-    end
-
     describe "#check" do
       subject do
         visitor.check

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guideline
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -12,8 +12,8 @@ cert_chain: []
 date: 2012-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: active_support
-  requirement: !ruby/object:Gem::Requirement
+  name: slop
+  requirement: &70129049410700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,15 +21,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  version_requirements: *70129049410700
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: &70129049409360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70129049409360
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70129049423300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -37,31 +43,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70129049423300
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70129049419980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.12.0
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70129049419980
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70129049417400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -69,16 +65,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70129049417400
 description: Guideline.gem checks if your code observes your coding guidelines
 email:
 - r7kamura@gmail.com
-executables: []
+executables:
+- guideline
 extensions: []
 extra_rdoc_files: []
 files:
@@ -87,10 +79,14 @@ files:
 - LICENSE.txt
 - 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/long_line_checker.rb
@@ -98,6 +94,7 @@ files:
 - lib/guideline/error.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/long_line_checker_spec.rb
@@ -125,11 +122,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: The guideline of your code
 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/long_line_checker_spec.rb
@@ -137,3 +135,4 @@ test_files:
 - spec/guideline/visitor_spec.rb
 - spec/guideline_spec.rb
 - spec/spec_helper.rb
+has_rdoc: