guideline 0.1.3 → 0.2.0

data/README.md

@@ -20,15 +20,22 @@ $ gem install guideline
 ## Usage
 ```
 $ guideline --help
-Usage: guideline [directory] [options]
-    -c, --config       Path to config YAML file.
-    -i, --init         Generate config YAML template into current directory.
-    -v, --version      Show version number.
-    -h, --help         Display this help message.
+Usage: guideline [options]
+        --no-abc-complexity          (default: true) check method ABC complexity
+        --no-hard-tab-indent         (default: true) check hard tab indent
+        --no-hash-comma              (default: true) check last comma in Hash literal
+        --no-long-line               (default: true) check line length
+        --no-long-method             (default: true) check method height
+        --no-trailing-whitespace     (default: true) check trailing whitespace
+        --no-unused-method           (default: true) check unused method
+        --abc-complexity=            (default:   15) threshold of ABC complexity
+        --long-line=                 (default:   80) threshold of long line
+        --long-method=               (default:   10) threshold of long method
+        --path=                      (default:   ./) checked file or dir or glob pattern
 ```
 
 ```
-$ guideline ./chatroid
+$ guideline --path /path/to/chatroid
 
 lib/chatroid/adapter/campfire.rb
   26: Line length  85 should be less than  80 characters
@@ -47,7 +54,7 @@ lib/chatroid/adapter/twitter.rb
 ```
 
 ```
-$ guideline ./guideline
+$ guideline --path /path/to/guideline
 
 lib/guideline/checkers/abc_complexity_checker.rb
   40: ABC Complexity of method<Guideline::AbcComplexityChecker::Moduleable.included> 16 should be less than 10

data/bin/guideline

@@ -2,22 +2,5 @@
 
 $LOAD_PATH.unshift File.expand_path("../../lib/", __FILE__)
 require "guideline"
-include Guideline
 
-options = Runner.parse(ARGV)
-
-checkers = CheckerFactory.new(
-  options[:config],
-  AbcComplexityChecker,
-  HardTabIndentChecker,
-  HashCommaChecker,
-  LongLineChecker,
-  LongMethodChecker,
-  TrailingWhitespaceChecker,
-  UnusedMethodChecker,
-).create
-
-visitor = Visitor.new(:only => ARGV[0], :checker => checkers)
-visitor.prepare
-visitor.visit
-visitor.render
+Guideline::Runner.run

data/guideline.gemspec

@@ -18,9 +18,7 @@ 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 "code_analyzer"
-  gem.add_dependency "activesupport"
   gem.add_development_dependency "rspec", ">=2.12.0"
   gem.add_development_dependency "pry"
   gem.add_development_dependency "simplecov"

data/lib/guideline.rb

@@ -1,6 +1,8 @@
 require "guideline/version"
+require "guideline/path_finder"
 require "guideline/visitor"
 require "guideline/error"
+require "guideline/option_parser"
 require "guideline/runner"
 require "guideline/parser/moduleable"
 require "guideline/checker_factory"

data/lib/guideline/checkers/abc_complexity_checker.rb

@@ -2,6 +2,8 @@ require "code_analyzer"
 
 module Guideline
   class AbcComplexityChecker < Checker
+    DEFAULT_MAX = 15
+
     def check(path)
       @current_path = path
       visitor.check(path.to_s, path.read)
@@ -12,22 +14,18 @@ module Guideline
 
     def checker
       AbcParser.new do |complexity, method, module_name, class_method_flag|
-        begin
-          if complexity > max
-            report(
-              :path    => @current_path,
-              :line    => method.line,
-              :message => "ABC Complexity of method<%s%s%s>%3d should be less than %d" % [
-                module_name,
-                class_method_flag ? "." : "#",
-                method.method_name,
-                complexity,
-                max,
-              ]
-            )
-          end
-        rescue Exception
-          require "pry"; binding.pry
+        if complexity > max
+          report(
+            :path    => @current_path,
+            :line    => method.line,
+            :message => "ABC Complexity of method<%s%s%s>%3d should be less than %d" % [
+              module_name,
+              class_method_flag ? "." : "#",
+              method.method_name,
+              complexity,
+              max,
+            ]
+          )
         end
       end
     end
@@ -37,7 +35,7 @@ module Guideline
     end
 
     def max
-      @options[:max]
+      (@options[:max] || DEFAULT_MAX).to_i
     end
 
     class AbcParser <  CodeAnalyzer::Checker

data/lib/guideline/checkers/long_line_checker.rb

@@ -1,5 +1,7 @@
 module Guideline
   class LongLineChecker < Checker
+    DEFAULT_MAX = 80
+
     def check(path)
       lines(path).select(&:has_error?).each do |line|
         report(
@@ -19,7 +21,7 @@ module Guideline
     end
 
     def max
-      @options[:max]
+      (@options[:max] || DEFAULT_MAX).to_i
     end
 
     class LineChecker

data/lib/guideline/checkers/long_method_checker.rb

@@ -3,6 +3,8 @@ require "ostruct"
 
 module Guideline
   class LongMethodChecker < Checker
+    DEFAULT_MAX = 10
+
     def check(path)
       MethodParser.parse(path.read) do |method|
         if method.height > max
@@ -18,7 +20,7 @@ module Guideline
     private
 
     def max
-      @options[:max] || 50
+      (@options[:max] || DEFAULT_MAX).to_i
     end
 
     class Method < OpenStruct

data/lib/guideline/option_parser.rb

@@ -0,0 +1,89 @@
+require "optparse"
+
+module Guideline
+  class OptionParser < ::OptionParser
+    OPTIONS = [
+      "--no-abc-complexity",      "(default: true) check method ABC complexity",
+      "--no-hard-tab-indent",     "(default: true) check hard tab indent",
+      "--no-hash-comma",          "(default: true) check last comma in Hash literal",
+      "--no-long-line",           "(default: true) check line length",
+      "--no-long-method",         "(default: true) check method height",
+      "--no-trailing-whitespace", "(default: true) check trailing whitespace",
+      "--no-unused-method",       "(default: true) check unused method",
+      "--abc-complexity=",        "(default:   15) threshold of ABC complexity",
+      "--long-line=",             "(default:   80) threshold of long line",
+      "--long-method=",           "(default:   10) threshold of long method",
+      "--path=",                  "(default:   ./) checked file or dir or glob pattern",
+    ]
+
+    def self.parse(argv = ARGV)
+      new.parse(argv)
+    end
+
+    def initialize(*)
+      super
+      configure_checker_options
+    end
+
+    def parse(*)
+      super
+      options
+    end
+
+    def options
+      @options ||= {}
+    end
+
+    private
+
+    def configure_checker_options
+      arguments.each do |argument|
+        on(argument.key, argument.description) do |value|
+          options[argument.to_sym] = value
+        end
+      end
+    end
+
+    def arguments
+      OPTIONS.each_slice(2).map do |key, description|
+        Argument.new(key, description)
+      end
+    end
+
+    class Argument
+      attr_reader :key, :description
+
+      def initialize(key, description)
+        @key         = key
+        @description = description
+      end
+
+      def to_sym
+        str = @key
+        str = without_head_hyphen(str)
+        str = without_head_no(str)
+        str = without_last_equal(str)
+        str = underscored(str)
+        str.to_sym
+      end
+
+      private
+
+      def underscored(str)
+        str.gsub("-", "_")
+      end
+
+      def without_head_hyphen(str)
+        str.gsub(/^--/, "")
+      end
+
+      def without_head_no(str)
+        str.gsub(/^no-/, "")
+      end
+
+      def without_last_equal(str)
+        str.gsub(/=$/, "")
+      end
+    end
+  end
+end

data/lib/guideline/path_finder.rb

@@ -0,0 +1,54 @@
+require "pathname"
+
+module Guideline
+  class PathFinder
+    def self.find(pattern)
+      new(pattern).paths
+    end
+
+    def initialize(pattern)
+      @pattern = pattern
+    end
+
+    def paths
+      Pathname.glob(recognized_pattern)
+    end
+
+    private
+
+    def pattern
+      @pattern
+    end
+
+    def path
+      @path ||= Pathname.new(pattern)
+    end
+
+    def recognized_pattern
+      case
+      when pattern_not_given?
+        default_glob
+      when directory?
+        default_glob_with_directory
+      else
+        pattern
+      end
+    end
+
+    def pattern_not_given?
+      pattern.nil?
+    end
+
+    def directory?
+      path.directory?
+    end
+
+    def default_glob
+      "**/*.rb"
+    end
+
+    def default_glob_with_directory
+      File.join(path, default_glob)
+    end
+  end
+end

data/lib/guideline/runner.rb

@@ -1,96 +1,63 @@
-require "yaml"
-require "fileutils"
-require "slop"
-require "active_support/core_ext/hash/indifferent_access"
-
 module Guideline
   class Runner
-    CONFIG_FILE_NAME = ".guideline.yml"
-
-    def self.parse(*argv)
-      new(*argv).parse
-    end
-
-    def initialize(argv)
-      @hash = Parser.parse(argv).with_indifferent_access
+    def self.run
+      new.run
     end
 
-    def parse
-      before_hook
-      @hash[:config] = load_config
-      @hash.delete(:help)
-      @hash
+    def run
+      visitor.prepare
+      visitor.visit
+      visitor.render
     end
 
     private
 
-    def before_hook
-      case
-      when @hash[:init]
-        generate_default_config_file
-      when @hash[:version]
-        show_version
-      end
+    def visitor
+      @visitor ||= Visitor.new(options[:path], enable_checkers)
     end
 
-    def show_version
-      puts VERSION
-      exit
+    def enable_checkers
+      array = []
+      array << abc_complexity_checker      if options[:abc_complexity]      != false
+      array << hard_tab_indent_checker     if options[:hard_tab_indent]     != false
+      array << hash_comma_checker          if options[:hash_comma]          != false
+      array << long_line_checker           if options[:long_line]           != false
+      array << long_method_checker         if options[:long_method]         != false
+      array << trailing_whitespace_checker if options[:trailing_whitespace] != false
+      array << unused_method_checker       if options[:unused_method]       != false
+      array
     end
 
-    def load_config
-      YAML.load_file(config_path)
-    rescue Errno::ENOENT
-      puts "No such config file - #{config_path}"
-      exit
+    def options
+      @options ||= OptionParser.parse
     end
 
-    def config_path
-      @hash[:config] || default_config_path
+    def abc_complexity_checker
+      AbcComplexityChecker.new(:max => options[:abc_complexity])
     end
 
-    def default_config_path
-      File.expand_path("../../../#{CONFIG_FILE_NAME}", __FILE__)
+    def hard_tab_indent_checker
+      HardTabIndentChecker.new
     end
 
-    def generate_default_config_file
-      if config_file_exist?
-        puts "./#{CONFIG_FILE_NAME} already exists"
-      else
-        FileUtils.copy(default_config_path, "./")
-        puts "./#{CONFIG_FILE_NAME} was generated"
-      end
-      exit
+    def hash_comma_checker
+      HashCommaChecker.new
     end
 
-    def config_file_exist?
-      File.exist?(CONFIG_FILE_NAME)
+    def long_line_checker
+      LongLineChecker.new(:max => options[:long_line])
     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
+    def long_method_checker
+      LongMethodChecker.new(:max => options[:long_method])
+    end
 
-      private
+    def trailing_whitespace_checker
+      TrailingWhitespaceChecker.new
+    end
 
-      def slop
-        @slop ||= Slop.new(:help => true) do
-          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
+    def unused_method_checker
+      UnusedMethodChecker.new
     end
   end
 end

data/lib/guideline/version.rb

@@ -1,3 +1,3 @@
 module Guideline
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/guideline/visitor.rb

@@ -4,9 +4,9 @@ module Guideline
   class Visitor
     attr_reader :options
 
-    def initialize(options, &block)
-      @options = options
-      @block   = block
+    def initialize(pattern, checkers)
+      @pattern  = pattern
+      @checkers = checkers
     end
 
     def visit
@@ -36,59 +36,19 @@ module Guideline
     private
 
     def paths
-      PathFinder.find(options)
+      PathFinder.find(pattern)
     end
 
     def checkers
-      @checkers ||= Array(options[:checker])
+      @checkers
     end
 
-    def errors
-      @errors ||= checkers.select(&:has_error?).map(&:errors).inject([], &:+)
+    def pattern
+      @pattern
     end
 
-    class PathFinder
-      attr_reader :options
-
-      def self.find(options = {})
-        new(options).paths
-      end
-
-      def initialize(options = {})
-        @options = options
-      end
-
-      def paths
-        (found_paths - excepted_paths).select(&:exist?)
-      end
-
-      private
-
-      def found_paths
-        Pathname.glob(only_pattern)
-      end
-
-      def excepted_paths
-        if except_pattern
-          Pathname.glob(except_pattern)
-        else
-          []
-        end
-      end
-
-      def only_pattern
-        if options[:only]
-          File.expand_path(options[:only])
-        else
-          File.expand_path("**/*.rb")
-        end
-      end
-
-      def except_pattern
-        if options[:except]
-          File.expand_path(options[:except])
-        end
-      end
+    def errors
+      @errors ||= checkers.select(&:has_error?).map(&:errors).inject([], &:+)
     end
   end
 end

data/spec/guideline/option_parser_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+
+module Guideline
+  describe OptionParser do
+    describe ".parse" do
+      subject do
+        described_class.parse(argv)
+      end
+
+      context "when ARGV is --no-abc-complexity" do
+        let(:argv) do
+          ["--no-abc-complexity"]
+        end
+        it { should == { :abc_complexity => false } }
+      end
+
+      context "when ARGV is --abc-complexity 5" do
+        let(:argv) do
+          ["--abc-complexity", "5"]
+        end
+        it { should == { :abc_complexity => "5" } }
+      end
+
+      context "when ARGV is --non-existent-key" do
+        let(:argv) do
+          ["--non-existent-key"]
+        end
+        it do
+          expect { subject }.to raise_error
+        end
+      end
+    end
+  end
+end

data/spec/guideline/runner_spec.rb

@@ -2,111 +2,62 @@ require "spec_helper"
 
 module Guideline
   describe Runner do
-    describe ".parse" do
-      subject do
-        described_class.parse(argv)
+    let(:runner) do
+      described_class.new
+    end
+
+    describe ".run" do
+      it "creates its instance and call #run" do
+        described_class.any_instance.should_receive(:run)
+        described_class.run
       end
+    end
 
+    describe "#run" do
       before do
-        runner.stub(:puts)
+        runner.stub(:enable_checkers => enable_checkers)
       end
 
-      let(:argv) do
-        []
+      let(:enable_checkers) do
+        [checker]
       end
 
-      let(:runner) do
-        described_class.any_instance
+      let(:checker) do
+        mock(:has_error? => false)
       end
 
-      it { should be_a HashWithIndifferentAccess }
-
-      context "when given --init option" do
-        let(:argv) do
-          ["--init"]
-        end
-
-        context "when config file already exists" do
-          before do
-            File.stub(:exist? => true)
-          end
-
-          it "does not generate config file" do
-            FileUtils.should_not_receive(:copy)
-            expect { subject }.to raise_error(SystemExit)
-          end
-        end
-
-        context "when config file does not exist" do
-          before do
-            File.stub(:exist? => false)
-          end
-
-          it "generates config file" do
-            FileUtils.should_receive(:copy)
-            expect { subject }.to raise_error(SystemExit)
-          end
-        end
+      it "runs enable checkers" do
+        checker.should_receive(:check).at_least(1)
+        runner.run
       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
+    describe "#enable_checkers" do
+      subject do
+        runner.send(:enable_checkers)
       end
 
-      context "when not given --config option" do
-        it "returns default config parsed from guideline.yml" do
-          should == {
-            "config" => {
-              "Guideline::LongLineChecker" => {
-                "max" => 80,
-              },
-              "Guideline::LongMethodChecker" => {
-                "max" => 10,
-              },
-              "Guideline::AbcComplexityChecker" => {
-                "max" => 10,
-              },
-            },
-            "init" => nil,
-            "version" => nil,
-          }
-        end
+      before do
+        runner.stub(:options => options)
       end
 
-      context "when existent file is specified by --config option" do
-        let(:argv) do
-          ["--config", "existent.yml"]
-        end
-
-        before do
-          YAML.stub(:load_file).and_return("a" => "b")
+      context "when options[:abc_complexity] is false" do
+        let(:options) do
+          { :abc_complexity => false }
         end
 
-        it "returns config parsed from specified file" do
-          should == {
-            "config" => {
-              "a" => "b",
-            },
-            "init" => nil,
-            "version" => nil,
-          }
+        it "does not include AbcComplexityChecker" do
+          should_not be_any {|checker| checker.is_a?(AbcComplexityChecker) }
         end
       end
 
-      context "when non-existent file is specified by --config option" do
-        let(:argv) do
-          ["--config", "non-existent.yml"]
+      context "when options[:abc_complexity] is nil" do
+        let(:options) do
+          {}
         end
 
-        it do
-          expect { subject }.to raise_error
+        it "includes AbcComplexityChecker" do
+          should be_any {|checker| checker.is_a?(AbcComplexityChecker) }
         end
       end
     end

data/spec/guideline/visitor_spec.rb

@@ -3,11 +3,15 @@ require "spec_helper"
 module Guideline
   describe Visitor do
     let(:visitor) do
-      described_class.new(options)
+      described_class.new(pattern, checkers)
     end
 
-    let(:options) do
-      { :checker => [checker] }
+    let(:pattern) do
+      nil
+    end
+
+    let(:checkers) do
+      [checker]
     end
 
     let(:checker) do
@@ -16,29 +20,16 @@ module Guideline
 
     describe "#visit" do
       let(:path) do
-        Pathname.new("spec/guideline/visitor_spec.rb")
+        Pathname.new(__FILE__)
       end
 
-      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
+      let(:pattern) do
+        path.to_s
       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
+      it "calls checker.check with found paths" do
+        checker.should_receive(:check).with(path).at_least(1)
+        visitor.visit
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guideline
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-09 00:00:00.000000000 Z
+date: 2012-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: slop
-  requirement: &70221529066600 !ruby/object:Gem::Requirement
+  name: code_analyzer
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,43 +21,31 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70221529066600
-- !ruby/object:Gem::Dependency
-  name: code_analyzer
-  requirement: &70221529082560 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: *70221529082560
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &70221529082140 !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: 2.12.0
+  type: :development
   prerelease: false
-  version_requirements: *70221529082140
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70221529081640 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.12.0
-  type: :development
-  prerelease: false
-  version_requirements: *70221529081640
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70221529081220 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70221529081220
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70221529080760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +69,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70221529080760
+  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
@@ -86,7 +84,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .guideline.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -104,7 +101,9 @@ files:
 - lib/guideline/checkers/trailing_whitespace_checker.rb
 - lib/guideline/checkers/unused_method_checker.rb
 - lib/guideline/error.rb
+- lib/guideline/option_parser.rb
 - lib/guideline/parser/moduleable.rb
+- lib/guideline/path_finder.rb
 - lib/guideline/runner.rb
 - lib/guideline/version.rb
 - lib/guideline/visitor.rb
@@ -118,6 +117,7 @@ files:
 - spec/guideline/checkers/trailing_whitespace_checker_spec.rb
 - spec/guideline/checkers/unused_method_checker_spec.rb
 - spec/guideline/error_spec.rb
+- spec/guideline/option_parser_spec.rb
 - spec/guideline/runner_spec.rb
 - spec/guideline/visitor_spec.rb
 - spec/spec_helper.rb
@@ -141,7 +141,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
@@ -156,7 +156,7 @@ test_files:
 - spec/guideline/checkers/trailing_whitespace_checker_spec.rb
 - spec/guideline/checkers/unused_method_checker_spec.rb
 - spec/guideline/error_spec.rb
+- spec/guideline/option_parser_spec.rb
 - spec/guideline/runner_spec.rb
 - spec/guideline/visitor_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/.guideline.yml

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