rails_best_practices 1.9.1 → 1.10.0

data/.rvmrc

@@ -1,2 +1,2 @@
 rvm_gemset_create_on_use_flag=1
-rvm gemset use ruby-1.9.3-p125@rails_best_practices
+rvm gemset use ruby-1.9.3-p194@rails_best_practices

data/Gemfile

@@ -5,6 +5,6 @@ if RUBY_PLATFORM =~ /darwin/i
   gem 'rb-fsevent'
   gem 'growl'
 end
-
+gem 'pry'
 gem 'guard'
 gem 'guard-rspec'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_best_practices (1.9.1)
+    rails_best_practices (1.10.0)
       activesupport
       awesome_print
       colored
@@ -17,6 +17,7 @@ GEM
       i18n (~> 0.6)
       multi_json (~> 1.0)
     awesome_print (1.0.2)
+    coderay (1.0.6)
     colored (1.2)
     diff-lcs (1.1.3)
     erubis (2.7.0)
@@ -27,10 +28,15 @@ GEM
       guard (>= 0.8.4)
     haml (3.1.3)
     i18n (0.6.0)
+    method_source (0.7.1)
     multi_json (1.2.0)
     progressbar (0.11.0)
+    pry (0.9.9.6)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7.1)
+      slop (>= 2.4.4, < 3)
     rake (0.9.2.2)
-    rb-fsevent (0.4.3.1)
+    rb-fsevent (0.9.1)
     rspec (2.7.0)
       rspec-core (~> 2.7.0)
       rspec-expectations (~> 2.7.0)
@@ -43,6 +49,7 @@ GEM
     slim (1.0.4)
       temple (~> 0.3.4)
       tilt (~> 1.3.2)
+    slop (2.4.4)
     temple (0.3.4)
     thor (0.14.6)
     tilt (1.3.3)
@@ -56,6 +63,7 @@ DEPENDENCIES
   guard
   guard-rspec
   haml
+  pry
   rails_best_practices!
   rake
   rb-fsevent

data/README.md

@@ -112,40 +112,43 @@ to generate `rails_best_practices.yml` file.
 
 Now you can customize this configuration file, the default configuration is as follows:
 
-    MoveFinderToNamedScopeCheck: { }
-    UseModelAssociationCheck: { }
-    UseScopeAccessCheck: { }
     AddModelVirtualAttributeCheck: { }
-    ReplaceComplexCreationWithFactoryMethodCheck: { attribute_assignment_count: 2 }
-    MoveModelLogicIntoModelCheck: { use_count: 4 }
-    OveruseRouteCustomizationsCheck: { customize_count: 3 }
-    NeedlessDeepNestingCheck: { nested_count: 2 }
-    NotUseDefaultRouteCheck: {  }
+    AlwaysAddDbIndexCheck: { }
+    DryBundlerInCapistranoCheck: { }
+    HashSyntaxCheck: { only_symbol: false, only_string: false }
+    IsolateSeedDataCheck: { }
     KeepFindersOnTheirOwnModelCheck: { }
     LawOfDemeterCheck: { }
-    UseObserverCheck: { }
-    IsolateSeedDataCheck: { }
-    AlwaysAddDbIndexCheck: { }
-    UseBeforeFilterCheck: { customize_count: 2 }
+    LongLineCheck: { max_line_length: 80 }
     MoveCodeIntoControllerCheck: { }
-    MoveCodeIntoModelCheck: { use_count: 2 }
     MoveCodeIntoHelperCheck: { array_count: 3 }
-    ReplaceInstanceVariableWithLocalVariableCheck: { }
-    DryBundlerInCapistranoCheck: { }
-    UseSayWithTimeInMigrationsCheck: { }
-    UseQueryAttributeCheck: { }
-    RemoveTrailingWhitespaceCheck: { }
-    UseMultipartAlternativeAsContentTypeOfEmailCheck: {}
-    SimplifyRenderInViewsCheck: {}
-    SimplifyRenderInControllersCheck: {}
+    MoveCodeIntoModelCheck: { use_count: 2 }
+    MoveFinderToNamedScopeCheck: { }
+    MoveModelLogicIntoModelCheck: { use_count: 4 }
+    NeedlessDeepNestingCheck: { nested_count: 2 }
+    NotUseDefaultRouteCheck: {  }
+    NotUseTimeAgoInWordsCheck: {}
+    OveruseRouteCustomizationsCheck: { customize_count: 3 }
+    ProtectMassAssignmentCheck: {}
     RemoveEmptyHelpersCheck: {}
     RemoveTabCheck: {}
-    RestrictAutoGeneratedRoutesCheck: { }
-    RemoveUnusedMethodsInModelsCheck: { except_methods: [] }
+    RemoveTrailingWhitespaceCheck: { }
     RemoveUnusedMethodsInControllersCheck: { except_methods: [] }
     RemoveUnusedMethodsInHelpersCheck: { except_methods: [] }
-    NotUseTimeAgoInWordsCheck: {}
-    ProtectMassAssignmentCheck: {}
+    RemoveUnusedMethodsInModelsCheck: { except_methods: [] }
+    ReplaceComplexCreationWithFactoryMethodCheck: { attribute_assignment_count: 2 }
+    ReplaceInstanceVariableWithLocalVariableCheck: { }
+    RestrictAutoGeneratedRoutesCheck: { }
+    SimplifyRenderInControllersCheck: {}
+    SimplifyRenderInViewsCheck: {}
+    UseBeforeFilterCheck: { customize_count: 2 }
+    UseModelAssociationCheck: { }
+    UseMultipartAlternativeAsContentTypeOfEmailCheck: {}
+    UseObserverCheck: { }
+    UseParenthesesInMethodDefCheck: {}
+    UseQueryAttributeCheck: { }
+    UseSayWithTimeInMigrationsCheck: { }
+    UseScopeAccessCheck: { }
 
 You can remove or comment one review to disable it, and you can change the options.
 
@@ -184,7 +187,7 @@ Mailer
 Migration
 
 1. Isolating seed data
-2. Always add db`index
+2. Always add db index
 3. Use say with time in migrations
 
 Controller
@@ -215,6 +218,9 @@ Other
 
 1. Remove trailing whitespace
 2. Remove tab
+3. Hash Syntax
+4. Use parentheses in method def
+5. Long line
 
 Write Your Own Check List
 -------------------------
@@ -236,7 +242,7 @@ Follow us on twitter: <http://twitter.com/railsbp>
 Send us email: <team@railsbp.com>
 
 
-Copyright © 2009 - 2011 Richard Huang (flyerhzm@gmail.com), released under the MIT license
+Copyright © 2009 - 2012 Richard Huang (flyerhzm@gmail.com), released under the MIT license
 
 
 [1]:https://github.com/railsbp/rails_best_practices/wiki/How-to-write-your-own-check-list

data/lib/rails_best_practices/analyzer.rb

@@ -115,7 +115,7 @@ module RailsBestPractices
     #
     # @param [Array] dirs what directories to expand
     # @return [Array] all files expanded
-    def expand_dirs_to_files *dirs
+    def expand_dirs_to_files(*dirs)
       extensions = ['rb', 'erb', 'rake', 'rhtml', 'haml', 'slim', 'builder', 'rxml']
 
       dirs.flatten.map { |entry|
@@ -135,7 +135,7 @@ module RailsBestPractices
     #
     # @param [Array] files
     # @return [Array] sorted files
-    def file_sort files
+    def file_sort(files)
       models = files.find_all { |file| file =~ Core::Check::MODEL_FILES }
       mailers = files.find_all { |file| file =~ Core::Check::MAILER_FILES }
       helpers = files.find_all { |file| file =~ Core::Check::HELPER_FILES }
@@ -152,7 +152,7 @@ module RailsBestPractices
     # @param [Array] files
     # @param [Regexp] pattern files match the pattern will be ignored
     # @return [Array] files that not match the pattern
-    def file_ignore files, pattern
+    def file_ignore(files, pattern)
       files.reject { |file| file.index(pattern) }
     end
 
@@ -160,7 +160,7 @@ module RailsBestPractices
     #
     # @param [Array] files
     # @param [Regexp] patterns, files match any pattern will be accepted
-    def file_accept files, patterns
+    def file_accept(files, patterns)
       files.reject { |file| !patterns.any? { |pattern| file =~ pattern } }
     end
 
@@ -217,15 +217,15 @@ module RailsBestPractices
       File.open(@options["output-file"], "w+") do |file|
         eruby = Erubis::Eruby.new(template)
         file.puts eruby.evaluate(
-          :errors => errors,
-          :error_types => error_types,
-          :textmate => @options["with-textmate"],
-          :mvim => @options["with-mvim"],
-          :github => @options["with-github"],
-          :github_name => @options["github-name"],
-          :last_commit_id => last_commit_id,
-          :git => @options["with-git"],
-          :hg => @options["with-hg"]
+          errors: errors,
+          error_types: error_types,
+          textmate: @options["with-textmate"],
+          mvim: @options["with-mvim"],
+          github: @options["with-github"],
+          github_name: @options["github-name"],
+          last_commit_id: last_commit_id,
+          git: @options["with-git"],
+          hg: @options["with-hg"]
         )
       end
     end

data/lib/rails_best_practices/core/check.rb

@@ -81,11 +81,11 @@ module RailsBestPractices
       # @param [Integer] line_number, is the line number of the source code which is reviewing
       def add_error(message, filename = @node.file, line_number = @node.line)
         errors << RailsBestPractices::Core::Error.new(
-          :filename => filename,
-          :line_number => line_number,
-          :message => message,
-          :type => self.class.to_s,
-          :url => url
+          filename: filename,
+          line_number: line_number,
+          message: message,
+          type: self.class.to_s,
+          url: url
         )
       end
 
@@ -312,7 +312,7 @@ module RailsBestPractices
             # remember hash values for hash key "methods".
             #
             #     def to_xml(options = {})
-            #       super options.merge(:exclude => :visible, :methods => [:is_discussion_conversation])
+            #       super options.merge(exclude: :visible, methods: [:is_discussion_conversation])
             #     end
             add_callback "start_bare_assoc_hash" do |node|
               if node.hash_keys.include? "methods"
@@ -336,6 +336,7 @@ module RailsBestPractices
 
             private
               def mark_used(method_node)
+                return if method_node == :call
                 if :bare_assoc_hash == method_node.sexp_type
                   method_node.hash_values.each { |value_node| mark_used(value_node) }
                 elsif :array == method_node.sexp_type

data/lib/rails_best_practices/core/checking_visitor.rb

@@ -17,7 +17,7 @@ module RailsBestPractices
       # remember all the checks for prepare and review processes according to interesting_nodes.
       #
       # @param [Hash] options
-      #     {:lexicals => [], :prepares => [], :reviews => []}
+      #     {lexicals: [], prepares: [], reviews: []}
       def initialize(options={})
         @lexicals = options[:lexicals]
         [:prepare, :review].each do |process|

data/lib/rails_best_practices/core/runner.rb

@@ -48,10 +48,9 @@ module RailsBestPractices
         @lexicals = lexicals.empty? ? load_lexicals : lexicals
         @prepares = prepares.empty? ? load_prepares : prepares
         @reviews = reviews.empty? ? load_reviews : reviews
-
         load_plugin_reviews if reviews.empty?
 
-        @checker ||= CheckingVisitor.new(:prepares => @prepares, :reviews => @reviews, :lexicals => @lexicals)
+        @checker ||= CheckingVisitor.new(prepares: @prepares, reviews: @reviews, lexicals: @lexicals)
         @debug = false
         @whiny = false
       end
@@ -169,7 +168,7 @@ module RailsBestPractices
           elsif filename =~ /.*\.haml$/
             begin
               require 'haml'
-              content = Haml::Engine.new(content, {:ugly => true}).precompiled
+              content = Haml::Engine.new(content, {ugly: true}).precompiled
               # remove \xxx characters
               content.gsub!(/\\\d{3}/, '')
             rescue LoadError

data/lib/rails_best_practices/core_ext/sexp.rb

@@ -21,11 +21,16 @@ class Sexp
   #     s(:@ident, "test", s(2, 12)
   #       => 2
   def line
-    if [:def, :defs, :command, :command_call, :call, :fcall, :method_add_arg, :method_add_block,
-      :var_ref, :vcall, :const_ref, :const_path_ref, :class, :module, :if, :unless, :elsif, :binary,
-      :alias, :symbol_literal, :symbol, :aref].include? sexp_type
+    case sexp_type
+    when :def, :defs, :command, :command_call, :call, :fcall, :method_add_arg, :method_add_block,
+         :var_ref, :vcall, :const_ref, :const_path_ref, :class, :module, :if, :unless, :elsif, :ifop, :binary,
+         :alias, :symbol_literal, :symbol, :aref, :hash, :assoc_new, :string_literal
       self[1].line
-    elsif :array == sexp_type
+    when :assoclist_from_args, :bare_assoc_hash
+      self[1][0].line
+    when :string_add
+      self[2].line
+    when :array
       array_values.first.line
     else
       self.last.first if self.last.is_a? Array
@@ -53,10 +58,10 @@ class Sexp
   #
   # options is the grep conditions, like
   #
-  #     :sexp_type => :call,
-  #     :subject => "Post",
-  #     :message => ["find", "new"]
-  #     :to_s => "devise"
+  #     sexp_type: :call,
+  #     subject: "Post",
+  #     message: ["find", "new"]
+  #     to_s: "devise"
   #
   # the condition key is one of :sexp_type, :subject, :message, :to_s,
   # the condition value can be Symbol, Array or Sexp.
@@ -81,9 +86,9 @@ class Sexp
   #
   # options is the grep conditions, like
   #
-  #     :sexp_type => :call,
-  #     :subject => s(:const, Post),
-  #     :message => [:find, :new]
+  #     sexp_type: :call,
+  #     subject: s(:const, Post),
+  #     message: [:find, :new]
   #
   # the condition key is one of :sexp_type, :subject, :message, and to_s,
   # the condition value can be Symbol, Array or Sexp.
@@ -326,7 +331,7 @@ class Sexp
   #
   # @return [Sexp] conditional statement of if node
   def conditional_statement
-    if [:if, :unless, :elsif].include? sexp_type
+    if [:if, :unless, :elsif, :ifop].include? sexp_type
       self[1]
     end
   end
@@ -745,11 +750,7 @@ class Sexp
   def to_object
     case sexp_type
     when :array
-      if nil == self[1]
-        []
-      else
-        arguments.all.map(&:to_s)
-      end
+      array_values.map(&:to_s)
     else
       to_s
     end

data/lib/rails_best_practices/lexicals.rb

@@ -1,3 +1,4 @@
 # encoding: utf-8
 require 'rails_best_practices/lexicals/remove_trailing_whitespace_check'
 require 'rails_best_practices/lexicals/remove_tab_check'
+require 'rails_best_practices/lexicals/long_line_check'

data/lib/rails_best_practices/lexicals/long_line_check.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+require 'rails_best_practices/reviews/review'
+module RailsBestPractices
+  module Lexicals
+    # Keep lines fewer than 80 characters.
+    class LongLineCheck < Core::Check
+      def initialize(options = {})
+        super()
+        @max_line_length = options['max_line_length'] || 80
+      end
+
+      # check if a line is over 80 characters
+      #
+      # @param [String] filename name of the file
+      # @param [String] content content of the file
+      def check(filename, content)
+        # Only check ruby files
+        if /\.rb$/ =~ filename
+          line_no = 0
+          content.each_line do |line|
+            line_no += 1
+            actual_line_length = line.sub(/\s+$/, '').length
+            if actual_line_length > @max_line_length
+              add_error("line is longer than #{@max_line_length} characters (#{actual_line_length} characters)", filename, line_no)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_best_practices/prepares/config_prepare.rb

@@ -12,7 +12,7 @@ module RailsBestPractices
       end
 
       def start_assign(node)
-        if node.left_value.grep_node(:sexp_type => [:vcall, :var_ref], :to_s => "config").present?
+        if node.left_value.grep_node(sexp_type: [:vcall, :var_ref], to_s: "config").present?
           @configs[node.left_value.to_s] = node.right_value.to_s
         end
       end

data/lib/rails_best_practices/reviews.rb

@@ -31,3 +31,5 @@ require 'rails_best_practices/reviews/remove_unused_methods_in_controllers_revie
 require 'rails_best_practices/reviews/remove_unused_methods_in_helpers_review'
 require 'rails_best_practices/reviews/not_use_time_ago_in_words_review'
 require 'rails_best_practices/reviews/protect_mass_assignment_review'
+require 'rails_best_practices/reviews/use_parentheses_in_method_def_review'
+require 'rails_best_practices/reviews/hash_syntax_review'

data/lib/rails_best_practices/reviews/add_model_virtual_attribute_review.rb

@@ -53,9 +53,9 @@ module RailsBestPractices
           left_value = node.left_value
           right_value = node.right_value
           return unless :field == left_value.sexp_type && :call == right_value.sexp_type
-          aref_node = right_value.grep_node(:sexp_type => :aref)
+          aref_node = right_value.grep_node(sexp_type: :aref)
           if aref_node
-            assignments(left_value.subject.to_s) << {:message => left_value.message.to_s, :arguments => aref_node.to_s}
+            assignments(left_value.subject.to_s) << {message: left_value.message.to_s, arguments: aref_node.to_s}
           end
         end
 

data/lib/rails_best_practices/reviews/always_add_db_index_review.rb

@@ -17,7 +17,7 @@ module RailsBestPractices
     #   if the subject of command node is "add_index", then remember the index columns
     #   after all of these, at the end of review process
     #
-    #       ActiveRecord::Schema.define(:version => 20101201111111) do
+    #       ActiveRecord::Schema.define(version: 20101201111111) do
     #         ......
     #       end
     #

data/lib/rails_best_practices/reviews/hash_syntax_review.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+require 'rails_best_practices/reviews/review'
+
+module RailsBestPractices
+  module Reviews
+    # Check ruby 1.8 style hash and suggest to change hash syntax to 1.9.
+    #
+    # Review process:
+    #   check hash nodes in all files,
+    #   if the sexp type of hash key nodes is not :@lable,
+    #   then the hash is ruby 1.8 style.
+    class HashSyntaxReview < Review
+      interesting_nodes :hash, :bare_assoc_hash
+      interesting_files ALL_FILES
+
+      def initialize(options = {})
+        super()
+        @only_symbol = options[:only_symbol]
+        @only_string = options[:only_string]
+      end
+
+      # 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)
+          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]
+
+        if hash_is_18?(pair_nodes)
+          add_error "change Hash Syntax to 1.9"
+        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)
+          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
+              return true
+            end
+          end
+
+          false
+        end
+    end
+  end
+end
+