rails_best_practices 0.10.1 → 1.0.0

data/lib/rails_best_practices/reviews/dry_bundler_in_capistrano_review.rb

@@ -10,9 +10,9 @@ module RailsBestPractices
     # Implementation:
     #
     # Review process:
-    #   only check the call nodes to see if there is bundler namespace in config/deploy.rb file,
+    #   only check the command nodes to see if there is bundler namespace in config/deploy.rb file,
     #
-    #   if the message of call node is :namespace and the arguments of the call node is :bundler,
+    #   if the message of command node is "namespace" and the first argument  is "bundler",
     #   then it should use bundler's capistrano recipe.
     class DryBundlerInCapistranoReview < Review
       def url
@@ -20,26 +20,16 @@ module RailsBestPractices
       end
 
       def interesting_nodes
-        [:call]
+        [:command]
       end
 
       def interesting_files
         /config\/deploy.rb/
       end
 
-      # check call node to see if it is with message :namespace and arguments :bundler.
-      #
-      # the ruby code is
-      #
-      #     namespace :bundler do
-      #       ...
-      #     end
-      #
-      # then the call node is as follows
-      #
-      #     s(:call, nil, :namespace, s(:arglist, s(:lit, :bundler)))
-      def start_call(node)
-        if :namespace == node.message and equal?(node.arguments[1], "bundler")
+      # check call node to see if it is with message "namespace" and argument "bundler".
+      def start_command(node)
+        if "namespace" == node.message.to_s && "bundler" == node.arguments.all[0].to_s
           add_error "dry bundler in capistrano"
         end
       end

data/lib/rails_best_practices/reviews/isolate_seed_data_review.rb

@@ -10,14 +10,14 @@ module RailsBestPractices
     # Implementation:
     #
     # Review process:
-    #   1. check all local assignment and instance assignment nodes,
-    #   if the right value is a call node with message :new,
+    #   1. check all assignment nodes,
+    #   if the right value is a call node with message "new",
     #   then remember their left value as new variables.
     #
     #   2. check all call nodes,
-    #   if the message is :create or :create!,
+    #   if the message is "create" or "create!",
     #   then it should be isolated to db seed.
-    #   if the message is :save or :save!,
+    #   if the message is "save" or "save!",
     #   and the subject is included in new variables,
     #   then it should be isolated to db seed.
     class IsolateSeedDataReview < Review
@@ -26,7 +26,7 @@ module RailsBestPractices
       end
 
       def interesting_nodes
-        [:call, :lasgn, :iasgn]
+        [:call, :assign]
       end
 
       def interesting_files
@@ -38,53 +38,37 @@ module RailsBestPractices
         @new_variables = []
       end
 
-      # check local assignment node.
+      # check assignment node.
       #
-      # if the right value of the node is a call node with :new message,
-      # then remember it as new variables (@new_variables).
-      def start_lasgn(node)
-        remember_new_variable(node)
-      end
-
-      # check instance assignment node.
-      #
-      # if the right value of the node is a call node with :new message,
-      # then remember it as new variables (@new_variables).
-      def start_iasgn(node)
+      # if the right value of the node is a call node with "new" message,
+      # then remember it as new variables.
+      def start_assign(node)
         remember_new_variable(node)
       end
 
       # check the call node.
       #
-      # if the message of the call node is :create or :create!,
+      # if the message of the call node is "create" or "create!",
       # then you should isolate it to seed data.
       #
-      # if the message of the call node is :save or :save!,
+      # if the message of the call node is "save" or "save!",
       # and the subject of the call node is included in @new_variables,
       # then you should isolate it to seed data.
       def start_call(node)
-        if [:create, :create!].include? node.message
+        if ["create", "create!"].include? node.message.to_s
           add_error("isolate seed data")
-        elsif [:save, :save!].include? node.message
+        elsif ["save", "save!"].include? node.message.to_s
           add_error("isolate seed data") if new_record?(node)
         end
       end
 
       private
-        # check local assignment or instance assignment node,
-        # if the right vavlue is a call node with message :new,
+        # check assignment node,
+        # if the right vavlue is a method_add_arg node with message "new",
         # then remember the left value as new variable.
-        #
-        # if the local variable node is
-        #
-        #     s(:lasgn, :role, s(:call, s(:const, :Role), :new, s(:arglist, s(:hash, s(:lit, :name), s(:lvar, :name)))))
-        #
-        # then the new variables (@new_variables) is
-        #
-        #     ["role"]
         def remember_new_variable(node)
           right_value = node.right_value
-          if :call == right_value.node_type && :new == right_value.message
+          if :method_add_arg == right_value.sexp_type && "new" == right_value.message.to_s
             @new_variables << node.left_value.to_s
           end
         end

data/lib/rails_best_practices/reviews/keep_finders_on_their_own_model_review.rb

@@ -18,14 +18,14 @@ module RailsBestPractices
     #   then it should keep finders on its own model.
     class KeepFindersOnTheirOwnModelReview < Review
 
-      FINDERS = [:find, :all, :first, :last]
+      FINDERS = %w(find all first last)
 
       def url
         "http://rails-bestpractices.com/posts/13-keep-finders-on-their-own-model"
       end
 
       def interesting_nodes
-        [:call]
+        [:method_add_arg]
       end
 
       def interesting_files
@@ -36,36 +36,27 @@ module RailsBestPractices
       #
       # if the call node is
       #
-      # 1. the message of call node is one of the :find, :all, :first or :last
+      # 1. the message of call node is one of the find, all, first or last
       # 2. the subject of call node is also a call node (it's the other model)
       # 3. the any of its arguments is a hash (complex finder)
       #
       # then it should keep finders on its own model.
-      def start_call(node)
+
+      def start_method_add_arg(node)
         add_error "keep finders on their own model" if other_finder?(node)
       end
 
       private
         # check if the call node is the finder of other model.
         #
-        # the message of the node should be one of :find, :all, :first or :last,
+        # the message of the node should be one of find, all, first or last,
         # and the subject of the node should be with message :call (this is the other model),
-        # and any of its arguments is a hash, like
-        #
-        #     s(:call,
-        #       s(:call, s(:self), :comment, s(:arglist)),
-        #       :find,
-        #       s(:arglist, s(:lit, :all),
-        #         s(:hash,
-        #           s(:lit, :conditions),
-        #           s(:hash, s(:lit, :is_spam), s(:false)),
-        #           s(:lit, :limit),
-        #           s(:lit, 10)
-        #         )
-        #       )
-        #     )
+        # and any of its arguments is a hash,
+        # then it is the finder of other model.
         def other_finder?(node)
-          FINDERS.include?(node.message) && :call == node.subject.node_type && node.arguments.children.any? { |node| :hash == node.node_type }
+          FINDERS.include?(node[1].message.to_s) &&
+            :call == node[1].subject.sexp_type &&
+            node.arguments.grep_nodes_count(:sexp_type => :bare_assoc_hash) > 0
         end
     end
   end

data/lib/rails_best_practices/reviews/law_of_demeter_review.rb

@@ -16,6 +16,7 @@ module RailsBestPractices
     #   and outer the call node, it is also a call node,
     #   then it violate the law of demeter.
     class LawOfDemeterReview < Review
+      ASSOCIATION_METHODS = %w(belongs_to has_one)
 
       def url
         "http://rails-bestpractices.com/posts/15-the-law-of-demeter"
@@ -29,17 +30,10 @@ module RailsBestPractices
       #
       # if the subject of the call node is also a call node,
       # and the subject of the subject call node matchs one of the class names,
-      # and the message of the subject call node matchs one of the association name with the class name, like
-      #
-      #     s(:call,
-      #       s(:call, s(:ivar, :@invoice), :user, s(:arglist)),
-      #       :name,
-      #       s(:arglist)
-      #     )
-      #
+      # and the message of the subject call node matchs one of the association name with the class name,
       # then it violates the law of demeter.
       def start_call(node)
-        if [:lvar, :ivar].include?(node.subject.subject.node_type) && need_delegate?(node)
+        if :call == node.subject.sexp_type && need_delegate?(node)
           add_error "law of demeter"
         end
       end
@@ -50,29 +44,14 @@ module RailsBestPractices
         # if the subject of subject of the call node matchs any in model names,
         # and the message of subject of the call node matchs any in association names,
         # then it needs delegate.
-        #
-        # e.g. the source code is
-        #
-        #     @invoic.user.name
-        #
-        # then the call node is
-        #
-        #     s(:call, s(:call, s(:ivar, :@invoice), :user, s(:arglist)), :name, s(:arglist))
-        #
-        # as you see the subject of subject of the call node is [:ivar, @invoice],
-        # and the message of subject of the call node is :user
         def need_delegate?(node)
-          class_name = node.subject.subject.to_s(:remove_at => true).classify
+          return unless variable(node)
+          class_name = variable(node).to_s.sub('@', '').classify
           association_name = node.subject.message.to_s
           association = model_associations.get_association(class_name, association_name)
           attribute_name = node.message.to_s
-          association && association_methods.include?(association[:meta]) &&
-            is_association_attribute?(association[:class_name], association_name, attribute_name)
-        end
-
-        # only check belongs_to and has_one association.
-        def association_methods
-          [:belongs_to, :has_one]
+          association && ASSOCIATION_METHODS.include?(association["meta"]) &&
+            is_association_attribute?(association["class_name"], association_name, attribute_name)
         end
 
         def is_association_attribute?(association_class, association_name, attribute_name)

data/lib/rails_best_practices/reviews/move_code_into_controller_review.rb

@@ -13,40 +13,42 @@ module RailsBestPractices
     #   only check all view files to see if there are finders, then the finders should be moved to controller.
     class MoveCodeIntoControllerReview < Review
 
-      FINDERS = [:find, :all, :first, :last]
+      FINDERS = %w(find all first last)
 
       def url
         "http://rails-bestpractices.com/posts/24-move-code-into-controller"
       end
 
       def interesting_nodes
-        [:call]
+        [:method_add_arg, :assign]
       end
 
       def interesting_files
         VIEW_FILES
       end
 
-      # check call nodes.
+      # check method_add_arg nodes.
       #
-      # if the subject of the call node is a constant,
-      # and the message of the call node is one of the :find, :all, :first and :last,
+      # if the subject of the method_add_arg node is a constant,
+      # and the message of the method_add_arg node is one of the find, all, first and last,
       # then it is a finder and should be moved to controller.
-      def start_call(node)
+      def start_method_add_arg(node)
         add_error "move code into controller" if finder?(node)
       end
 
+      # check assign nodes.
+      #
+      # if the subject of the right value node is a constant,
+      # and the message of the right value node is one of the find, all, first and last,
+      # then it is a finder and should be moved to controller.
+      def start_assign(node)
+        add_error "move code into controller", node.file, node.right_value.line if finder?(node.right_value)
+      end
+
       private
         # check if the node is a finder call node.
-        # e.g. the following call node is a finder
-        #
-        #     s(:call,
-        #       s(:const, :Post),
-        #       :find,
-        #       s(:arglist, s(:lit, :all))
-        #     )
         def finder?(node)
-          :const == node.subject.node_type && FINDERS.include?(node.message)
+          node.subject.const? && FINDERS.include?(node.message.to_s)
         end
     end
   end

data/lib/rails_best_practices/reviews/move_code_into_helper_review.rb

@@ -12,10 +12,10 @@ module RailsBestPractices
     # Implementation:
     #
     # Review process:
-    #   check al method calls to see if there is a complex options_for_select helper.
+    #   check al method method_add_arg nodes to see if there is a complex options_for_select helper.
     #
-    #   if the message of the call node is options_for_select,
-    #   and the first argument of the call node is array,
+    #   if the message of the method_add_arg node is options_for_select,
+    #   and the first argument of the method_add_arg node is array,
     #   and the size of the array is greater than array_count defined,
     #   then the options_for_select method should be moved into helper.
     class MoveCodeIntoHelperReview < Review
@@ -24,7 +24,7 @@ module RailsBestPractices
       end
 
       def interesting_nodes
-        [:call]
+        [:method_add_arg]
       end
 
       def interesting_files
@@ -36,12 +36,12 @@ module RailsBestPractices
         @array_count = options['array_count'] || 3
       end
 
-      # check call node with message options_for_select (sorry we only check options_for_select helper now).
+      # check method_add_arg node with message options_for_select (sorry we only check options_for_select helper now).
       #
       # if the first argument of options_for_select method call is an array,
       # and the size of the array is more than @array_count defined,
       # then the options_for_select helper should be moved into helper.
-      def start_call(node)
+      def start_method_add_arg(node)
         add_error "move code into helper (array_count >= #{@array_count})" if complex_select_options?(node)
       end
 
@@ -50,29 +50,11 @@ module RailsBestPractices
         #
         # if the first argument is an array,
         # and the size of array is greater than @array_count you defined,
-        # then it is complext, e.g.
-        #
-        #     s(:call, nil, :options_for_select,
-        #       s(:arglist,
-        #         s(:array,
-        #           s(:array,
-        #             s(:call, nil, :t, s(:arglist, s(:lit, :draft))),
-        #             s(:str, "draft")
-        #           ),
-        #           s(:array,
-        #             s(:call, nil, :t, s(:arglist, s(:lit, :published))),
-        #             s(:str, "published")
-        #           )
-        #         ),
-        #         s(:call,
-        #           s(:call, nil, :params, s(:arglist)),
-        #           :[],
-        #           s(:arglist, s(:lit, :default_state))
-        #         )
-        #       )
-        #     )
+        # then it is complext.
         def complex_select_options?(node)
-          :options_for_select == node.message && :array == node.arguments[1].node_type && node.arguments[1].size > @array_count
+          "options_for_select" == node[1].message.to_s &&
+            :array == node.arguments.all[0].sexp_type &&
+            node.arguments.all[0].array_size > @array_count
         end
     end
   end

data/lib/rails_best_practices/reviews/move_code_into_model_review.rb

@@ -10,16 +10,15 @@ module RailsBestPractices
     # Implementation:
     #
     # Review process:
-    #   check if there are multiple method calls or attribute assignments apply to one subject,
-    #   and the subject is a local variable or instance variable,
-    #   then they should be moved into model.
+    #   check if, unless, elsif there are multiple method calls or attribute assignments apply to one subject,
+    #   and the subject is a variable, then they should be moved into model.
     class MoveCodeIntoModelReview < Review
       def url
         "http://rails-bestpractices.com/posts/25-move-code-into-model"
       end
 
       def interesting_nodes
-        [:if]
+        [:if, :unless, :elsif]
       end
 
       def interesting_files
@@ -31,22 +30,24 @@ module RailsBestPractices
         @use_count = options['use_count'] || 2
       end
 
-      # check if node to see whose conditional statementnodes contain multiple call nodes with same subject who is a local variable or instance variable.
+      # check if node to see whose conditional statementnodes contain multiple call nodes with same subject who is a variable.
       #
-      # it will check every call and attrasgn nodes in the conditional statement nodes.
+      # it will check every call and assignment nodes in the conditional statement nodes.
       #
-      # if there are multiple call and attrasgn nodes who have the same subject,
-      # and the subject is a local variable or an instance variable,
-      # then the conditional statement nodes should be moved into model.
+      # if there are multiple call and assignment nodes who have the same subject,
+      # and the subject is a variable, then the conditional statement nodes should be moved into model.
       def start_if(node)
-        node.conditional_statement.grep_nodes(:node_type => [:call, :attrasgn]) { |child_node| remember_variable_use_count(child_node) }
+        node.conditional_statement.grep_nodes(:sexp_type => :call) { |child_node| remember_variable_use_count(child_node) }
 
         variable_use_count.each do |variable_node, count|
-          add_error "move code into model (#{variable_node} use_count > #{@use_count})", variable_node.file, variable_node.line if count > @use_count
+          add_error "move code into model (#{variable_node} use_count > #{@use_count})" if count > @use_count
         end
 
         reset_variable_use_count
       end
+
+      alias_method :start_unless, :start_if
+      alias_method :start_elsif, :start_if
     end
   end
 end

data/lib/rails_best_practices/reviews/move_finder_to_named_scope_review.rb

@@ -10,55 +10,44 @@ module RailsBestPractices
     # Implementation:
     #
     # Review process:
-    #   check all method calls in controller files.
+    #   check all method method_add_arg nodes in controller files.
     #   if there is any call node with message find, all, first or last,
     #   and it has a hash argument,
     #   then it is a complex finder, and should be moved to model's named scope.
     class MoveFinderToNamedScopeReview < Review
 
-      FINDER = [:find, :all, :first, :last]
+      FINDERS = %w(find all first last)
 
       def url
         "http://rails-bestpractices.com/posts/1-move-finder-to-named_scope"
       end
 
       def interesting_nodes
-        [:call]
+        [:method_add_arg]
       end
 
       def interesting_files
         CONTROLLER_FILES
       end
 
-      # check call node if its message is one of :find, :all, :first or :last,
+      # check method_add_ag node if its message is one of find, all, first or last,
       # and it has a hash argument,
       # then the call node is the finder that should be moved to model's named_scope.
-      def start_call(node)
+      def start_method_add_arg(node)
         add_error "move finder to named_scope" if finder?(node)
       end
 
       private
-        # check if the call node is a finder.
+        # check if the method_add_arg node is a finder.
         #
-        # if the subject of call node is a constant,
-        # and the message of call node is one of find, all, first or last,
+        # if the subject of method_add_arg node is a constant,
+        # and the message of call method_add_arg is one of find, all, first or last,
         # and any of its arguments is a hash,
-        # then it is a finder. e.g.
-        #
-        #     s(:call, s(:const, :Post), :find,
-        #       s(:arglist, s(:lit, :all),
-        #         s(:hash,
-        #           s(:lit, :conditions),
-        #           s(:hash, s(:lit, :state), s(:str, "public")),
-        #           s(:lit, :limit),
-        #           s(:lit, 10),
-        #           s(:lit, :order),
-        #           s(:str, "created_at desc")
-        #         )
-        #       )
-        #     )
-        def finder?(call_node)
-          :const == call_node.subject.node_type && FINDER.include?(call_node.message) && call_node.arguments.children.any? { |node| :hash == node.node_type }
+        # then it is a finder.
+        def finder?(node)
+          FINDERS.include?(node[1].message.to_s) &&
+            :call == node[1].sexp_type &&
+            node.arguments.grep_nodes_count(:sexp_type => :bare_assoc_hash) > 0
         end
     end
   end