guideline 0.2.0 → 0.2.1

data/README.md

@@ -21,17 +21,18 @@ $ gem install guideline
 ```
 $ guideline --help
 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
+        --no-abc-complexity          (default: false) check method ABC complexity
+        --no-hard-tab-indent         (default: false) check hard tab indent
+        --no-hash-comma              (default: false) check last comma in Hash literal
+        --no-long-line               (default: false) check line length
+        --no-long-method             (default: false) check method height
+        --no-trailing-whitespace     (default: false) check trailing whitespace
+        --no-unused-method           (default: false) check unused method
+        --no-detail                  (default: false) only render summary
+        --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
 ```
 
 ```

data/lib/guideline.rb

@@ -1,6 +1,7 @@
 require "guideline/version"
 require "guideline/path_finder"
 require "guideline/visitor"
+require "guideline/renderer"
 require "guideline/error"
 require "guideline/option_parser"
 require "guideline/runner"

data/lib/guideline/checkers/checker.rb

@@ -10,14 +10,21 @@ module Guideline
 
     def report(options)
       errors << Error.new(
+        :line    => options[:line],
         :message => options[:message],
         :path    => options[:path],
-        :line    => options[:line]
+        :name    => name
       )
     end
 
     def has_error?
       !errors.empty?
     end
+
+    private
+
+    def name
+      @name ||= self.class.to_s.split("::").last
+    end
   end
 end

data/lib/guideline/error.rb

@@ -1,9 +1,16 @@
-require "ostruct"
-
 module Guideline
-  class Error < OpenStruct
+  class Error
+    attr_reader :line, :message, :path, :name
+
+    def initialize(options)
+      @line    = options[:line]
+      @message = options[:message]
+      @path    = options[:path]
+      @name    = options[:name]
+    end
+
     def render
-      puts "%4d: %s" % [line, message]
+      "%4d: %s" % [line, message]
     end
   end
 end

data/lib/guideline/option_parser.rb

@@ -3,17 +3,18 @@ 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",
+      "--no-abc-complexity",      "(default: false) check method ABC complexity",
+      "--no-hard-tab-indent",     "(default: false) check hard tab indent",
+      "--no-hash-comma",          "(default: false) check last comma in Hash literal",
+      "--no-long-line",           "(default: false) check line length",
+      "--no-long-method",         "(default: false) check method height",
+      "--no-trailing-whitespace", "(default: false) check trailing whitespace",
+      "--no-unused-method",       "(default: false) check unused method",
+      "--no-detail",              "(default: false) only render summary",
+      "--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)

data/lib/guideline/renderer.rb

@@ -0,0 +1,47 @@
+require "pathname"
+
+module Guideline
+  class Renderer
+    def initialize(errors)
+      @errors = errors
+    end
+
+    def detail
+      "".tap do |result|
+        errors_by_path.each do |path, errors|
+          result << "\n#{path}\n"
+          errors.sort_by(&:line).each {|error| result << "#{error.render}\n" }
+        end
+      end
+    end
+
+    def summary
+      "".tap do |result|
+        error_summary.each do |name, count|
+          result << "#{name}: #{count}\n"
+        end
+      end
+    end
+
+    private
+
+    def errors_by_path
+      errors.group_by(&:path)
+    end
+
+    def error_summary
+      errors.inject(summary_hash) do |hash, error|
+        hash[error.name] += 1
+        hash
+      end
+    end
+
+    def errors
+      @errors
+    end
+
+    def summary_hash
+      Hash.new {|hash, key| hash[key] = 0 }
+    end
+  end
+end

data/lib/guideline/runner.rb

@@ -5,17 +5,27 @@ module Guideline
     end
 
     def run
-      visitor.prepare
-      visitor.visit
-      visitor.render
+      puts renderer.detail if options[:detail] != false
+      puts
+      puts renderer.summary
     end
 
     private
 
+    def renderer
+      @renderer ||= Renderer.new(errors)
+    end
+
     def visitor
       @visitor ||= Visitor.new(options[:path], enable_checkers)
     end
 
+    def errors
+      visitor.prepare
+      visitor.visit
+      visitor.errors
+    end
+
     def enable_checkers
       array = []
       array << abc_complexity_checker      if options[:abc_complexity]      != false

data/lib/guideline/version.rb

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

data/lib/guideline/visitor.rb

@@ -25,12 +25,8 @@ module Guideline
       end
     end
 
-    def render
-      errors.group_by(&:path).each do |path, errors|
-        puts path
-        errors.sort_by(&:line).each(&:render)
-        puts
-      end
+    def errors
+      @errors ||= checkers.select(&:has_error?).map(&:errors).inject([], &:+)
     end
 
     private
@@ -46,9 +42,5 @@ module Guideline
     def pattern
       @pattern
     end
-
-    def errors
-      @errors ||= checkers.select(&:has_error?).map(&:errors).inject([], &:+)
-    end
   end
 end

data/spec/guideline/error_spec.rb

@@ -3,14 +3,17 @@ require "spec_helper"
 module Guideline
   describe Error do
     let(:error) do
-      described_class.new(:line => 1, :message => "message")
+      described_class.new(:line => 1, :type => :type, :message => "message")
     end
 
     describe "#render" do
-      it "renders its line and message" do
-        error.should_receive(:puts).with("   1: message")
+      subject do
         error.render
       end
+
+      it "return string including its line and message" do
+        should == "   1: message"
+      end
     end
   end
 end

data/spec/guideline/renderer_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+module Guideline
+  describe Renderer do
+    let(:renderer) do
+      described_class.new(errors)
+    end
+
+    let(:errors) do
+      [error]
+    end
+
+    let(:error) do
+      mock(
+        :line   => 1,
+        :path   => "path",
+        :render => "rendered",
+        :name   => "name"
+      )
+    end
+
+    describe "#detail" do
+      subject do
+        renderer.detail
+      end
+
+      it { should == "\npath\nrendered\n" }
+    end
+
+    describe "#summary" do
+      subject do
+        renderer.summary
+      end
+
+      it { should == "name: 1\n" }
+    end
+  end
+end

data/spec/guideline/visitor_spec.rb

@@ -56,25 +56,5 @@ 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", :line => 1)
-      end
-
-      it "calls #render of each error" do
-        error.should_receive(:render)
-        visitor.render
-      end
-    end
   end
 end

data/spec/spec_helper.rb

@@ -3,3 +3,9 @@ SimpleCov.start
 
 $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 require "guideline"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guideline
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -104,6 +104,7 @@ files:
 - lib/guideline/option_parser.rb
 - lib/guideline/parser/moduleable.rb
 - lib/guideline/path_finder.rb
+- lib/guideline/renderer.rb
 - lib/guideline/runner.rb
 - lib/guideline/version.rb
 - lib/guideline/visitor.rb
@@ -118,6 +119,7 @@ files:
 - spec/guideline/checkers/unused_method_checker_spec.rb
 - spec/guideline/error_spec.rb
 - spec/guideline/option_parser_spec.rb
+- spec/guideline/renderer_spec.rb
 - spec/guideline/runner_spec.rb
 - spec/guideline/visitor_spec.rb
 - spec/spec_helper.rb
@@ -157,6 +159,7 @@ test_files:
 - spec/guideline/checkers/unused_method_checker_spec.rb
 - spec/guideline/error_spec.rb
 - spec/guideline/option_parser_spec.rb
+- spec/guideline/renderer_spec.rb
 - spec/guideline/runner_spec.rb
 - spec/guideline/visitor_spec.rb
 - spec/spec_helper.rb