wegolint 0.0.3 → 0.0.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    wegolint (0.0.3)
+    wegolint (0.0.4)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -1,8 +1,8 @@
 ## What is it?
-This is a tool that validates a code file for a set of style guide rules. These
-rules are run along with the standard parser for the given language. The main
-use for this tool is to pass errors and line numbers to the [Syntastic Vim
-plugin](https://github.com/scrooloose/syntastic).
+This is a tool that validates a code file against a set of style guide rules
+defined using regexes. These rules are run along with the standard parser for
+the given language. The main use for this tool is to pass errors and line
+numbers to the [Syntastic Vim plugin](https://github.com/scrooloose/syntastic).
 
 ## Installation Steps
 1. Install syntastic fork into `~/.vim/bundle/`:
@@ -21,3 +21,17 @@ let g:syntastic_javascript_checker='wegolint'
 
 ## Screenshot with Syntastic
 ![Screenshot](http://dl.dropbox.com/u/48928587/Screenshots/h.png)
+
+## Rule Definition Syntax
+Wegolint uses a simple DSL for adding new rules:
+
+```ruby
+# only run this rule against Ruby files, default is to run against all files
+language :ruby do
+  rule "Don't use foo as a var name" do
+    pattern /foo =/
+  end
+end
+```
+
+Rules can be added by dropping files into the `~/.wegolint` folder. 

data/lib/wegolint/dsl.rb

@@ -2,6 +2,7 @@ module WegoLint
   module DSL
     module RuleDirectives
       @@collapse_quotes = false
+      @@collapse_hashes = false
 
       def included(klass)
         @@pattern = nil
@@ -19,6 +20,15 @@ module WegoLint
       def collapse_quotes?
         @@collapse_quotes
       end
+
+      def collapse_hashes
+        @@collapse_hashes = true
+      end
+
+      def collapse_hashes?
+        @@collapse_hashes
+      end
+
     end
 
     def language(name, &block)

data/lib/wegolint/rule.rb

@@ -16,6 +16,7 @@ class WegoLint::Rule
   def run(text)
     text.split("\n").each_with_index do |line, index|
       line = collapse_quotes(line) if self.class.collapse_quotes?
+      line = collapse_hashes(line) if self.class.collapse_hashes?
       if line =~ self.class.pattern
         @errors << {message: description, line_number: index + 1 }
       end
@@ -32,6 +33,10 @@ class WegoLint::Rule
     /(#{no_space_beginning_block}|#{no_space_end_block})/
   end
 
+  def collapse_hashes(line)
+    line.gsub(/\{.*?(\w+\:|\=\>).*?}/, "{ }")
+  end
+
   def collapse_quotes(line)
     newline = line
     ['"', "'"].each do |char|

data/lib/wegolint/rule_registry.rb

@@ -24,25 +24,33 @@ class WegoLint::RuleRegistry
   end
 
   def find_by_description(description)
-    rules.keys.each do |key|
-      match = rules[key].find {|rule| rule.description == description }
-      return match if match
+    rules.keys.each do |ruleset|
+      match = rules[ruleset].keys.find { |key| key == description }
+      return rules[ruleset][match] if match
     end
     nil
   end
 
   def load_rules
-    Dir[File.dirname(__FILE__) + '/rules/*'].each { |rule| require rule }
+    local_rules_dir = File.dirname(__FILE__) + '/../../rules/'
+    Dir[local_rules_dir + '*'].each { |rule| require rule }
+
+    rules_directory = ENV["HOME"] + '/.wegolint'
+    standard_rules_directory = rules_directory + '/standard'
+    FileUtils.mkdir_p rules_directory
+    FileUtils.mkdir_p standard_rules_directory
+    Dir[rules_directory + '/**/*.rb'].each { |rule| require rule }
   end
 
   # Pattern stolen from rspec
   def add_rule(description, block)
     WegoLint::RuleRegistry::rule_count += 1
-    klass = WegoLint::RuleRegistry.const_set("Rule_#{WegoLint::RuleRegistry::rule_count}",
-             subclass(WegoLint::Rule, block))
-    @rules[@language_context] = [] unless @rules[@language_context]
+    klass = WegoLint::RuleRegistry.
+      const_set("Rule_#{WegoLint::RuleRegistry::rule_count}",
+                subclass(WegoLint::Rule, block))
+    @rules[@language_context] = {} unless @rules[@language_context]
     rule = klass.new(description, @language_context)
-    @rules[@language_context] << rule
+    @rules[@language_context][description] = rule
     rule
   end
 

data/lib/wegolint/version.rb

@@ -0,0 +1,3 @@
+module WegoLint
+  VERSION = '0.0.4'
+end

data/lib/wegolint/wegolinter.rb

@@ -47,19 +47,9 @@ class WegoLint::WegoLinter
     end
   end
 
-  # The real algorithm for this has to find the first instance of any pair,
-  # strip it, start over, find the second instance, strip it, start over, etc.
-  def collapse_quotes(line)
-    newline = line
-    ['"', "'"].each do |char|
-      newline.gsub!(/#{char}.+?#{char}/, "#{char}TEST#{char}")
-    end
-    newline
-  end
-
   def apply_rules(text, ruleset = :general)
     return unless rules[ruleset]
-    rules[ruleset].each do |rule|
+    rules[ruleset].each do |key, rule|
       rule.run(text)
       @output += format_errors(rule.errors) + "\n" unless rule.errors.empty?
     end

data/{lib/wegolint/rules → rules}/ruby.rb

@@ -2,6 +2,7 @@ language :ruby do
   rule 'Space should be around block { |param| foo }' do
     pattern /[\.\s]#{block_not_padded}/
 
+    collapse_hashes
     collapse_quotes
   end
 

data/spec/rule_registry_spec.rb

@@ -23,7 +23,7 @@ describe RuleRegistry do
 
     context "when there are more than two rules" do
       before do
-        rule_registry.add_rule('Another rule', proc { pattern /bar/ } )
+        rule_registry.add_rule('Another rule', proc { pattern /bar/ })
       end
 
       it "creates a rule with the specified pattern" do
@@ -35,15 +35,24 @@ describe RuleRegistry do
   describe ".rules" do
     it "rule is added to the general rules list when language is not set" do
       rule_registry.add_rule(description, block)
-      rule = rule_registry.rules[:general].first
+      rule = rule_registry.rules[:general]['A new rule']
       rule.description.should == 'A new rule'
     end
 
     it "rule is added to the language rules list when language is set" do
       rule_registry.language_context = :ruby
       rule_registry.add_rule('Another rule', block)
-      rule = rule_registry.rules[:ruby].first
+      rule = rule_registry.rules[:ruby]['Another rule']
       rule.description.should == 'Another rule'
     end
+
+    it "rule overrides previously set rule with same description" do
+      rule_registry.language_context = :ruby
+      rule1 = rule_registry.add_rule('A rule', block)
+      rule2 = rule_registry.add_rule('A rule', block)
+      rule = rule_registry.rules[:ruby]['A rule']
+      rule1.should_not === rule
+      rule2.should === rule
+    end
   end
 end

data/spec/rule_spec.rb

@@ -66,11 +66,17 @@ a = 1
 ['a','b','c'].each {|item| puts item }
 ['a','b','c'].each { |item| puts item}
 b = 2
+def foo(array)
+end
+foo {key: 'value'}
+foo {:key => 'value'}
 EOF
       end
 
       it { should_have_error description, 2, :ruby  }
       it { should_have_error description, 3, :ruby  }
+      it { should_not_have_error description, 7, :ruby  }
+      it { should_not_have_error description, 8, :ruby  }
     end
 
     context 'No spaces after (, [ or before ], )' do

data/spec/wegolinter_spec.rb

@@ -18,9 +18,10 @@ describe WegoLinter do
     end
 
     it "sorts rules into language groups" do
-      subject[:general].should_not be_empty
-      subject[:ruby].should_not be_empty
-      subject[:general].first.should be_a Rule
+      subject[:general].should_not be_nil
+      subject[:ruby].should_not be_nil
+      subject[:general].first[0].should be_a String
+      subject[:general].first[1].should be_a Rule
     end
   end
 

data/wegolint.gemspec

@@ -1,6 +1,8 @@
+require File.expand_path('../lib/wegolint/version', __FILE__)
+
 Gem::Specification.new do |s|
   s.name        = 'wegolint'
-  s.version     = '0.0.3'
+  s.version     = WegoLint::VERSION
   s.date        = '2012-09-30'
   s.summary     = 'Parses code for style guide violations'
   s.description = <<-EOF

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wegolint
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -34,9 +34,10 @@ files:
 - lib/wegolint/dsl.rb
 - lib/wegolint/rule.rb
 - lib/wegolint/rule_registry.rb
-- lib/wegolint/rules/general.rb
-- lib/wegolint/rules/ruby.rb
+- lib/wegolint/version.rb
 - lib/wegolint/wegolinter.rb
+- rules/general.rb
+- rules/ruby.rb
 - spec/rule_registry_spec.rb
 - spec/rule_spec.rb
 - spec/spec_helper.rb