guideline 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in guideline.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ryo NAKAMURA
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,11 @@
+# Guideline
+
+## Installation
+
+```
+$ gem install guideline
+```
+
+## Usage
+
+See https://github.com/r7kamura/guideline/tree/master/examples

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/examples/long_line_checker.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "guideline"
+
+checker = Guideline::LongLineChecker.new(:max => 128)
+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

data/guideline.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'guideline/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "guideline"
+  gem.version       = Guideline::VERSION
+  gem.authors       = ["Ryo NAKAMURA"]
+  gem.email         = ["r7kamura@gmail.com"]
+  gem.description   = "Guideline.gem checks if your code observes your coding guidelines"
+  gem.summary       = "The guideline of your code"
+  gem.homepage      = "https://github.com/r7kamura/guideline"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "active_support"
+  gem.add_dependency "i18n"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "pry"
+end

data/lib/guideline/checker/long_line_checker.rb

@@ -0,0 +1,52 @@
+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
+      end
+    end
+
+    private
+
+    def lines(path)
+      path.each_line.map do |line|
+        LineChecker.new(line, :max => max)
+      end
+    end
+
+    def max
+      @options[:max]
+    end
+
+    class LineChecker
+      def initialize(line, options = {})
+        @line    = line
+        @options = options
+      end
+
+      def message
+        actual = "%3d" % length
+        limit  = "%3d" % max
+        "Line length #{actual} should be less than #{limit} characters"
+      end
+
+      def has_error?
+        length > max
+      end
+
+      def max
+        @options[:max] || 80
+      end
+
+      def length
+        @line.split(//).length
+      end
+    end
+  end
+end

data/lib/guideline/checker.rb

@@ -0,0 +1,23 @@
+module Guideline
+  class Checker
+    def initialize(options = {})
+      @options = options
+    end
+
+    def errors
+      @errors ||= []
+    end
+
+    def add_error(options)
+      errors << OpenStruct.new(
+        :message => options[:message],
+        :path    => options[:path],
+        :line    => options[:line]
+      )
+    end
+
+    def has_error?
+      !errors.empty?
+    end
+  end
+end

data/lib/guideline/version.rb

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

data/lib/guideline/visitor.rb

@@ -0,0 +1,71 @@
+require "pathname"
+
+module Guideline
+  class Visitor
+    attr_reader :options
+
+    def initialize(options, &block)
+      @options = options
+      @block   = block
+    end
+
+    def check
+      travel
+      errors
+    end
+
+    private
+
+    def travel
+      paths.each do |path|
+        checkers.each do |checker|
+          checker.check(path)
+        end
+      end
+    end
+
+    def paths
+      PathFinder.find(options)
+    end
+
+    def checkers
+      @checkers ||= Array(options[:checker])
+    end
+
+    def errors
+      @errors ||= checkers.select(&:has_error?).map(&:errors).inject([], &:+)
+    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
+        search_paths(options[:only] || "**/*.rb")
+      end
+
+      def excepted_paths
+        search_paths(options[:except])
+      end
+
+      def search_paths(patterns)
+        Array(patterns).inject([]) do |paths, pattern|
+          paths + Pathname.glob(pattern)
+        end
+      end
+    end
+  end
+end

data/lib/guideline.rb

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

data/spec/guideline/checker_spec.rb

@@ -0,0 +1,71 @@
+require "spec_helper"
+
+module Guideline
+  describe Checker do
+    let(:instance) do
+      described_class.new(options)
+    end
+
+    let(:options) do
+      mock
+    end
+
+    let(:error) do
+      {
+        :message => "message",
+        :path    => "path",
+        :line    => "line",
+      }
+    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
+      end
+
+      it "returns an Array" do
+        should be_a Array
+      end
+    end
+
+    describe "#add_error" do
+      it "adds error record into its errors" do
+        instance.add_error(error)
+        instance.errors.first.message.should == "message"
+      end
+    end
+
+    describe "#has_error?" do
+      subject do
+        instance.has_error?
+      end
+
+      context "when its errors is empty" do
+        it { should be_false }
+      end
+
+      context "when its errors is not empty" do
+        before do
+          instance.add_error(error)
+        end
+
+        it { should be_true }
+      end
+    end
+  end
+end

data/spec/guideline/visitor_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+
+module Guideline
+  describe Visitor do
+    before do
+      visitor.stub(:paths).and_return(paths)
+    end
+
+    let(:visitor) do
+      described_class.new(:checker => checker)
+    end
+
+    let(:options) do
+      { :checker => checker }
+    end
+
+    let(:checker) do
+      mock(:has_error? => false)
+    end
+
+    let(:paths) do
+      [path]
+    end
+
+    let(:path) do
+      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
+      end
+
+      it "calls checker#check with matched path" do
+        checker.should_receive(:check).with(path)
+        subject
+      end
+    end
+  end
+end

data/spec/guideline_spec.rb

@@ -0,0 +1,4 @@
+require "spec_helper"
+
+module Guideline
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "guideline"

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: guideline
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ryo NAKAMURA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: &70150348023000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70150348023000
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70150348021800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70150348021800
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70150348020440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70150348020440
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70150348034340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70150348034340
+description: Guideline.gem checks if your code observes your coding guidelines
+email:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/long_line_checker.rb
+- guideline.gemspec
+- lib/guideline.rb
+- lib/guideline/checker.rb
+- lib/guideline/checker/long_line_checker.rb
+- lib/guideline/version.rb
+- lib/guideline/visitor.rb
+- spec/guideline/checker_spec.rb
+- spec/guideline/visitor_spec.rb
+- spec/guideline_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/r7kamura/guideline
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: The guideline of your code
+test_files:
+- spec/guideline/checker_spec.rb
+- spec/guideline/visitor_spec.rb
+- spec/guideline_spec.rb
+- spec/spec_helper.rb
+has_rdoc: