guideline 0.0.8 → 0.0.9

data/README.md

@@ -1,16 +1,34 @@
 # Guideline
-Check your code
-
-## Installation
-
+Guideline checks that your code is protecting the rule of coding guideline.  
+This library requires Ruby 1.9 or later.
+
+## Feature
+* For each method
+ * Check ABC-complexity
+ * Check the number of lines
+ * Check unused method
+* For each file
+ * Check the precense of hard tab indent
+ * Check the presense of comma at the end of multiline Hash literal
+ * Check the horizontal length of each line
+
+## Install
 ```
 $ 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.
+    -h, --help        Display this help message.
+```
 
 ```
-$ guideline
+$ guideline ./chatroid
+
 lib/chatroid/adapter/campfire.rb
   26: Line length  85 should be less than  80 characters
 
@@ -26,3 +44,13 @@ spec/chatroid/adapter/twitter_spec.rb
 lib/chatroid/adapter/twitter.rb
   19: Too long  12 lines method <#stream>
 ```
+
+```
+$ guideline ./guideline
+
+lib/guideline/checkers/abc_complexity_checker.rb
+  40: ABC Complexity of method<Guideline::AbcComplexityChecker::Moduleable.included> 16 should be less than 10
+
+lib/guideline/error.rb
+   5: Remove unused method <render>
+```

data/guideline.gemspec

@@ -8,7 +8,8 @@ Gem::Specification.new do |gem|
   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.description   = "Guideline.gem checks that your code is protecting" +
+                      "the rule of coding guideline"
   gem.summary       = "The guideline of your code"
   gem.homepage      = "https://github.com/r7kamura/guideline"
 
@@ -20,7 +21,6 @@ Gem::Specification.new do |gem|
   gem.add_dependency "slop"
   gem.add_dependency "code_analyzer"
   gem.add_dependency "active_support"
-  gem.add_dependency "i18n"
   gem.add_development_dependency "rspec", ">=2.12.0"
   gem.add_development_dependency "pry"
 end

data/lib/guideline/runner.rb

@@ -1,32 +1,56 @@
 require "yaml"
+require "fileutils"
 require "slop"
+require "active_support/core_ext/hash/indifferent_access"
 
 module Guideline
-  module Runner
-    extend self
+  class Runner
+    CONFIG_FILE_NAME = ".guideline.yml"
 
-    def parse(argv)
-      hash = Parser.parse(argv)
-      hash[:config] = load_config(hash[:config])
-      hash.delete(:help)
-      hash
+    def self.parse(*argv)
+      new(*argv).parse
     end
 
-    private
+    def initialize(argv)
+      @hash = Parser.parse(argv).with_indifferent_access
+    end
 
-    def load_config(path)
-      hash = load_yaml(path || default_config_path)
-      HashWithIndifferentAccess.new(hash)
+    def parse
+      generate_default_config_file if @hash[:init]
+      @hash[:config] = load_config
+      @hash.delete(:help)
+      @hash
     end
 
-    def load_yaml(path)
-      YAML.load_file(path)
+    private
+
+    def load_config
+      YAML.load_file(config_path)
     rescue Errno::ENOENT
-      raise "No such config file - #{path}"
+      puts "No such config file - #{config_path}"
+      exit
+    end
+
+    def config_path
+      @hash[:config] || default_config_path
     end
 
     def default_config_path
-      File.expand_path("../../../guideline.yml", __FILE__)
+      File.expand_path("../../../#{CONFIG_FILE_NAME}", __FILE__)
+    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
+    end
+
+    def config_file_exist?
+      File.exist?(CONFIG_FILE_NAME)
     end
 
     class Parser
@@ -47,8 +71,9 @@ module Guideline
 
       def slop
         @slop ||= Slop.new(:help => true) do
-          banner "Usage: guidline [directory] [options]"
-          on :c=, :config=, "path to config YAML file"
+          banner "Usage: guideline [directory] [options]"
+          on :c=, :config=, "Path to config YAML file."
+          on :i, :init, "Generate config YAML template into current directory."
         end
       end
     end

data/lib/guideline/version.rb

@@ -1,3 +1,3 @@
 module Guideline
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/lib/guideline/visitor.rb

@@ -1,5 +1,4 @@
 require "pathname"
-require "active_support/all"
 
 module Guideline
   class Visitor

data/spec/guideline/runner_spec.rb

@@ -8,54 +8,88 @@ module Guideline
       end
 
       before do
-        YAML.stub(:load_file).and_return(config)
+        described_class.any_instance.stub(:puts)
       end
 
-      let(:config) do
-        { "a" => 1 }
+      let(:argv) do
+        []
       end
 
-      let(:path) do
-        File.expand_path("../../../guideline.yml", __FILE__)
-      end
+      it { should be_a HashWithIndifferentAccess }
 
-      let(:argv) do
-        ["--config", path]
-      end
+      context "when given --init option" do
+        let(:argv) do
+          ["--init"]
+        end
 
-      it "loads config option as YAML path" do
-        YAML.should_receive(:load_file).with(path)
-        subject
-      end
+        context "when config file already exists" do
+          before do
+            described_class.any_instance.stub(:config_file_exist? => true)
+          end
 
-      it "returns config option as HashWithIndifferentAccess" do
-        subject[:config].should be_a HashWithIndifferentAccess
+          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
+            described_class.any_instance.stub(:config_file_exist? => false)
+          end
+
+          it "generates config file" do
+            FileUtils.should_receive(:copy)
+            expect { subject }.to raise_error(SystemExit)
+          end
+        end
       end
 
-      context "when config option is passed" do
-        it "returns parsed options" do
-          should == { :config => config }
+      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,
+          }
         end
       end
 
-      context "when config option is passed in short version" do
+      context "when existent file is specified by --config option" do
         let(:argv) do
-          ["-c", path]
+          ["--config", "existent.yml"]
+        end
+
+        before do
+          YAML.stub(:load_file).and_return("a" => "b")
         end
 
-        it "returns parsed options" do
-          should == { :config => config }
+        it "returns config parsed from specified file" do
+          should == {
+            "config" => {
+              "a" => "b",
+            },
+            "init" => nil,
+          }
         end
       end
 
-      context "when config option is not passed" do
+      context "when non-existent file is specified by --config option" do
         let(:argv) do
-          []
+          ["--config", "non-existent.yml"]
         end
 
-        it "returns parsed options with default config path" do
-          described_class.should_receive(:default_config_path)
-          should have_key(:config)
+        it do
+          expect { subject }.to raise_error
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guideline
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-30 00:00:00.000000000 Z
+date: 2012-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slop
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70154114004860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,15 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70154114004860
 - !ruby/object:Gem::Dependency
   name: code_analyzer
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70154114004440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -37,31 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70154114004440
 - !ruby/object:Gem::Dependency
   name: active_support
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: i18n
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70154114004020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -69,15 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70154114004020
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70154114003520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -85,15 +54,10 @@ dependencies:
         version: 2.12.0
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 2.12.0
+  version_requirements: *70154114003520
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70154114003100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -101,13 +65,8 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  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
+  version_requirements: *70154114003100
+description: Guideline.gem checks that your code is protectingthe rule of coding guideline
 email:
 - r7kamura@gmail.com
 executables:
@@ -116,13 +75,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .guideline.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/guideline
 - guideline.gemspec
-- guideline.yml
 - lib/guideline.rb
 - lib/guideline/checker_factory.rb
 - lib/guideline/checkers/abc_complexity_checker.rb
@@ -168,7 +127,7 @@ 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
@@ -185,3 +144,4 @@ test_files:
 - spec/guideline/visitor_spec.rb
 - spec/guideline_spec.rb
 - spec/spec_helper.rb
+has_rdoc: