rails_best_practices 1.10.0 → 1.10.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_best_practices (1.10.0)
+    rails_best_practices (1.10.1)
       activesupport
       awesome_print
       colored

data/README.md

@@ -1,8 +1,9 @@
-rails_best_practices
-====================
+# rails_best_practices
 
 [![Build Status](https://secure.travis-ci.org/railsbp/rails_best_practices.png)](http://travis-ci.org/railsbp/rails_best_practices)
 
+[![Coderwall Endorse](http://api.coderwall.com/flyerhzm/endorsecount.png)](http://coderwall.com/flyerhzm)
+
 [![Click here to lend your support to: rails best practices and make a donation at www.pledgie.com !](http://www.pledgie.com/campaigns/12057.png?skin_name=chrome)](http://www.pledgie.com/campaigns/12057)
 
 rails_best_practices is a code metric tool to check the quality of rails codes.
@@ -21,8 +22,7 @@ following template engines:
 
 rails_best_practices works well only in ruby 1.9.2 and ruby 1.9.3 so far.
 
-Usage
------
+## Usage
 
 At the root directory of rails app
 
@@ -58,8 +58,7 @@ By default rails_best_practices will do parse codes in vendor, spec, test and fe
         -v, --version                    Show this version
         -h, --help                       Show this message
 
-Resources
----------
+## Resources
 
 Homepage: <http://rails-bestpractices.com>
 
@@ -77,8 +76,7 @@ Wiki: <http://github.com/railsbp/rails_best_practices/wiki>
 
 Issue Tracker: <http://github.com/railsbp/rails_best_practices/issues>
 
-Install
--------
+## Install
 
 rails_best_practices gem is rewritten based on ripper instead of ruby_parser to support ruby 1.9 new syntax.
 
@@ -88,8 +86,7 @@ or add in Gemfile
 
     gem "rails_best_practices"
 
-Issue
------
+## Issue
 
 If you install the rails_best_practices with bundler-installed github-sourced gem, please use the following command instead.
 
@@ -101,8 +98,7 @@ If you got NoMethodError or any syntax error, you should use debug mode to detec
 
 Then give me the error stack and the source code of the file that rails_best_practices is parsing error.
 
-Customize Configuration
------------------------
+## Customize Configuration
 
 First run
 
@@ -152,8 +148,7 @@ Now you can customize this configuration file, the default configuration is as f
 
 You can remove or comment one review to disable it, and you can change the options.
 
-Implementation
---------------
+## Implementation
 
 Move code from Controller to Model
 
@@ -222,18 +217,15 @@ Other
 4. Use parentheses in method def
 5. Long line
 
-Write Your Own Check List
--------------------------
+## Write Your Own Check List
 
 If you want to write your own check list (some check list only for your rails projects), please read this first, [How to write your own check list?][1]
 
-Contribute
-----------
+## Contribute
 
 If you want to add your rails best practices into the gem, please post your best practices on <http://rails-bestpractices.com>
 
-Contact Us
-----------
+## Contact Us
 
 We provide rails consulting services, you can contact us by twitter or email.
 

data/lib/rails_best_practices/reviews/hash_syntax_review.rb

@@ -13,6 +13,8 @@ module RailsBestPractices
       interesting_nodes :hash, :bare_assoc_hash
       interesting_files ALL_FILES
 
+      VALID_SYMBOL_KEY = /\A[@$_A-Za-z]([_\w]*[!_=?\w])?\z/
+
       def initialize(options = {})
         super()
         @only_symbol = options[:only_symbol]
@@ -21,43 +23,51 @@ module RailsBestPractices
 
       # check hash node to see if it is ruby 1.8 style.
       def start_hash(node)
-        return if s(:hash, nil) == node
-        pair_nodes = node[1][1]
-
-        if hash_is_18?(pair_nodes)
+        if !empty_hash?(node) &&
+           hash_is_18?(node) &&
+           valid_keys?(node) &&
+           !haml_class_node?(node)
           add_error "change Hash Syntax to 1.9"
         end
       end
 
-      # check bare_assoc_hash node to see if it is ruby 1.8 style.
-      def start_bare_assoc_hash(node)
-        pair_nodes = node[1]
+      alias_method :start_bare_assoc_hash, :start_hash
 
-        if hash_is_18?(pair_nodes)
-          add_error "change Hash Syntax to 1.9"
+      protected
+        # check if hash node is empty.
+        def empty_hash?(node)
+          s(:hash, nil) == node || s(:bare_assoc_hash, nil) == node
         end
-      end
 
-      protected
         # check if hash key/value pairs are ruby 1.8 style.
-        #
-        # hash key of ruby 1.9 style is :@label,
-        # so if it is not, then it is ruby 1.8 style.
-        def hash_is_18?(pair_nodes)
+        def hash_is_18?(node)
+          pair_nodes = :hash == node.sexp_type ? node[1][1] : node[1]
           return false if pair_nodes.blank?
+
           pair_nodes.size.times do |i|
             if @only_symbol
               return true if :symbol_literal == pair_nodes[i][1].sexp_type
             elsif @only_string
               return true if :string_literal == pair_nodes[i][1].sexp_type
-            elsif :@label != pair_nodes[i][1].sexp_type
+            elsif :symbol_literal == pair_nodes[i][1].sexp_type ||
+                  :string_literal == pair_nodes[i][1].sexp_type
               return true
             end
           end
 
           false
         end
+
+        # check if the hash keys are valid to be converted to ruby 1.9
+        # syntax.
+        def valid_keys?(node)
+          node.hash_keys.all? { |key| key =~ VALID_SYMBOL_KEY }
+        end
+
+        # check if hash is generated by haml class or id nodes.
+        def haml_class_node?(node)
+          node.hash_size == 1 && (node.hash_keys.first == "class" || node.hash_keys.first == "id")
+        end
     end
   end
 end
-

data/lib/rails_best_practices/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module RailsBestPractices
-  VERSION = "1.10.0"
+  VERSION = "1.10.1"
 end

data/spec/rails_best_practices/reviews/hash_syntax_review_spec.rb

@@ -62,6 +62,32 @@ module RailsBestPractices
         runner.should have(1).errors
         runner.errors[0].to_s.should == "app/models/user.rb:3 - change Hash Syntax to 1.9"
       end
+
+      it "should ignore haml_out" do
+        content =<<-EOF
+%div{ class: "foo1" }
+.div{ class: "foo2" }
+#div{ class: "foo3" }
+        EOF
+        runner.review('app/views/files/show.html.haml', content)
+        runner.should have(0).errors
+      end
+
+      it "should not consider hash with array key" do
+        content =<<-EOF
+        transition [:unverified, :verified] => :deleted
+        EOF
+        runner.review('app/models/post.rb', content)
+        runner.should have(0).errors
+      end
+
+      it "should not consider hash with charaters not valid for symbol" do
+        content =<<-EOF
+        subject.stub(:` => 'Error')
+        EOF
+        runner.review('app/models/post.rb', content)
+        runner.should have(0).errors
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_best_practices
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.10.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-19 00:00:00.000000000 Z
+date: 2012-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sexp_processor
-  requirement: &70312121266920 !ruby/object:Gem::Requirement
+  requirement: &70244299371240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70312121266920
+  version_requirements: *70244299371240
 - !ruby/object:Gem::Dependency
   name: progressbar
-  requirement: &70312121266140 !ruby/object:Gem::Requirement
+  requirement: &70244299370320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70312121266140
+  version_requirements: *70244299370320
 - !ruby/object:Gem::Dependency
   name: colored
-  requirement: &70312121264060 !ruby/object:Gem::Requirement
+  requirement: &70244299368200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70312121264060
+  version_requirements: *70244299368200
 - !ruby/object:Gem::Dependency
   name: erubis
-  requirement: &70312121262840 !ruby/object:Gem::Requirement
+  requirement: &70244299367020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70312121262840
+  version_requirements: *70244299367020
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70312121261320 !ruby/object:Gem::Requirement
+  requirement: &70244299365100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70312121261320
+  version_requirements: *70244299365100
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70312121281720 !ruby/object:Gem::Requirement
+  requirement: &70244299385840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70312121281720
+  version_requirements: *70244299385840
 - !ruby/object:Gem::Dependency
   name: awesome_print
-  requirement: &70312121280640 !ruby/object:Gem::Requirement
+  requirement: &70244299384580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70312121280640
+  version_requirements: *70244299384580
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70312121279160 !ruby/object:Gem::Requirement
+  requirement: &70244299383080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70312121279160
+  version_requirements: *70244299383080
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70312121276940 !ruby/object:Gem::Requirement
+  requirement: &70244299380940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70312121276940
+  version_requirements: *70244299380940
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &70312121275740 !ruby/object:Gem::Requirement
+  requirement: &70244299379800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70312121275740
+  version_requirements: *70244299379800
 - !ruby/object:Gem::Dependency
   name: slim
-  requirement: &70312121295400 !ruby/object:Gem::Requirement
+  requirement: &70244299399240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70312121295400
+  version_requirements: *70244299399240
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70312121292680 !ruby/object:Gem::Requirement
+  requirement: &70244299396840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,7 +142,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70312121292680
+  version_requirements: *70244299396840
 description: a code metric tool for rails codes, written in Ruby.
 email:
 - flyerhzm@gmail.com
@@ -325,7 +325,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3377092891025064967
+      hash: -3797206044319773055
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: