rails_best_practices 1.10.1 → 1.11.0

data/lib/rails_best_practices/prepares/schema_prepare.rb

@@ -15,14 +15,14 @@ module RailsBestPractices
         @model_attributes = Prepares.model_attributes
       end
 
-      def start_command(node)
+      add_callback :start_command do |node|
         if "create_table" == node.message.to_s
           @last_klazz = node.arguments.all.first.to_s.classify
         end
       end
 
       # check command_call node to remember the model attributes.
-      def start_command_call(node)
+      add_callback :start_command_call do |node|
         if ATTRIBUTE_TYPES.include? node.message.to_s
           attribute_name = node.arguments.all.first.to_s
           @model_attributes.add_attribute(@last_klazz, attribute_name, node.message.to_s)

data/lib/rails_best_practices/reviews/add_model_virtual_attribute_review.rb

@@ -11,17 +11,14 @@ module RailsBestPractices
     #
     # Review process:
     #   check method define nodes in all controller files,
-    #   if there are more than one [] method calls with the same subject and arguments,
+    #   if there are more than one [] method calls with the same receiver and arguments,
     #   but assigned to one model's different attribute.
     #   and after these method calls, there is a save method call for that model,
     #   then the model needs to add a virtual attribute.
     class AddModelVirtualAttributeReview < Review
       interesting_nodes :def
       interesting_files CONTROLLER_FILES
-
-      def url
-        "http://rails-bestpractices.com/posts/4-add-model-virtual-attribute"
-      end
+      url "http://rails-bestpractices.com/posts/4-add-model-virtual-attribute"
 
       # check method define nodes to see if there are some attribute assignments that can use model virtual attribute instead in review process.
       #
@@ -31,10 +28,10 @@ module RailsBestPractices
       # 2. the messages of attribute assignment nodes housld be different (:first_name= , :last_name=)
       # 3. the argument of call nodes with message :[] should be same (:full_name)
       # 4. there should be a call node with message :save or :save! after attribute assignment nodes
-      # 5. and the subject of save or save! call node should be the same with the subject of attribute assignment nodes
+      # 5. and the receiver of save or save! call node should be the same with the receiver of attribute assignment nodes
       #
       # then the attribute assignment nodes can add model virtual attribute instead.
-      def start_def(node)
+      add_callback :start_def do |node|
         @assignments = {}
         node.recursive_children do |child|
           case child.sexp_type
@@ -55,30 +52,37 @@ module RailsBestPractices
           return unless :field == left_value.sexp_type && :call == right_value.sexp_type
           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.receiver.to_s) << {message: left_value.message.to_s, arguments: aref_node.to_s}
           end
         end
 
         # check a call node with message "save" or "save!",
-        # if there exists an attribute assignment for the subject of this call node,
+        # if there exists an attribute assignment for the receiver of this call node,
         # and if the arguments of this attribute assignments has duplicated entries (different message and same arguments),
         # then this node needs to add a virtual attribute.
         def call_assignment(node)
           if ["save", "save!"].include? node.message.to_s
-            subject = node.subject.to_s
-            add_error "add model virtual attribute (for #{subject})" if params_dup?(assignments(subject).collect {|h| h[:arguments]})
+            receiver = node.receiver.to_s
+            add_error "add model virtual attribute (for #{receiver})" if params_dup?(assignments(receiver).collect {|h| h[:arguments]})
           end
         end
 
         # if the nodes are duplicated.
         def params_dup?(nodes)
           return false if nodes.nil?
-          !nodes.dups.empty?
+          !dups(nodes).empty?
+        end
+
+        # get the assignments of receiver.
+        def assignments(receiver)
+          @assignments[receiver] ||= []
         end
 
-        # get the assignments of subject.
-        def assignments(subject)
-          @assignments[subject] ||= []
+        # Get the duplicate entries from an Enumerable.
+        #
+        # @return [Enumerable] the duplicate entries.
+        def dups(nodes)
+          nodes.inject({}) {|h,v| h[v]=h[v].to_i+1; h}.reject{|k,v| v==1}.keys
         end
     end
   end

data/lib/rails_best_practices/reviews/always_add_db_index_review.rb

@@ -11,10 +11,10 @@ module RailsBestPractices
     #
     # Review process:
     #   only check the command and command_calls nodes and at the end of review process,
-    #   if the subject of command node is "create_table", then remember the table names
-    #   if the subject of command_call node is "integer" and suffix with id, then remember it as foreign key
+    #   if the receiver of command node is "create_table", then remember the table names
+    #   if the receiver of command_call node is "integer" and suffix with id, then remember it as foreign key
     #   if the sujbect of command_call node is "string", the name of it is _type suffixed and there is an integer column _id suffixed, then remember it as polymorphic foreign key
-    #   if the subject of command node is "add_index", then remember the index columns
+    #   if the receiver 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
@@ -24,14 +24,9 @@ module RailsBestPractices
     #   if there are any foreign keys not existed in index columns,
     #   then the foreign keys should add db index.
     class AlwaysAddDbIndexReview < Review
-      include Afterable
-
       interesting_nodes :command, :command_call
       interesting_files SCHEMA_FILE
-
-      def url
-        "http://rails-bestpractices.com/posts/21-always-add-db-index"
-      end
+      url "http://rails-bestpractices.com/posts/21-always-add-db-index"
 
       def initialize
         super
@@ -44,11 +39,9 @@ module RailsBestPractices
       #
       # if the message of command_call node is "create_table", then remember the table name.
       # if the message of command_call node is "add_index", then remember it as index columns.
-      def start_command_call(node)
-        case node.message.to_s
-        when "integer", "string"
+      add_callback :start_command_call do |node|
+        if %w(integer string).include? node.message.to_s
           remember_foreign_key_columns(node)
-        else
         end
       end
 
@@ -59,7 +52,7 @@ module RailsBestPractices
       #
       # if the message of command node is "type" and the name of argument is _type suffixed,
       # then remember it with _id suffixed column as polymorphic foreign key.
-      def start_command(node)
+      add_callback :start_command do |node|
         case node.message.to_s
         when "create_table"
           remember_table_nodes(node)
@@ -73,14 +66,14 @@ module RailsBestPractices
       # compare foreign keys and index columns,
       # if there are any foreign keys not existed in index columns,
       # then we should add db index for that foreign keys.
-      def after_review
+      add_callback :after_check do
         remove_table_not_exist_foreign_keys
         remove_only_type_foreign_keys
         combine_polymorphic_foreign_keys
         @foreign_keys.each do |table, foreign_key|
           table_node = @table_nodes[table]
           foreign_key.each do |column|
-            if indexed?(table, column)
+            if not_indexed?(table, column)
               add_error "always add db index (#{table} => [#{Array(column).join(', ')}])", table_node.file, table_node.line
             end
           end
@@ -160,7 +153,7 @@ module RailsBestPractices
         end
 
         # check if the table's column is indexed.
-        def indexed?(table, column)
+        def not_indexed?(table, column)
           index_columns = @index_columns[table]
           !index_columns || !index_columns.any? { |e| greater_than_or_equal(Array(e), Array(column)) }
         end

data/lib/rails_best_practices/reviews/dry_bundler_in_capistrano_review.rb

@@ -17,13 +17,10 @@ module RailsBestPractices
     class DryBundlerInCapistranoReview < Review
       interesting_nodes :command
       interesting_files DEPLOY_FILES
-
-      def url
-        "http://rails-bestpractices.com/posts/51-dry-bundler-in-capistrano"
-      end
+      url "http://rails-bestpractices.com/posts/51-dry-bundler-in-capistrano"
 
       # check call node to see if it is with message "namespace" and argument "bundler".
-      def start_command(node)
+      add_callback :start_command do |node|
         if "namespace" == node.message.to_s && "bundler" == node.arguments.all[0].to_s
           add_error "dry bundler in capistrano"
         end

data/lib/rails_best_practices/reviews/hash_syntax_review.rb

@@ -15,24 +15,13 @@ module RailsBestPractices
 
       VALID_SYMBOL_KEY = /\A[@$_A-Za-z]([_\w]*[!_=?\w])?\z/
 
-      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)
-        if !empty_hash?(node) &&
-           hash_is_18?(node) &&
-           valid_keys?(node) &&
-           !haml_class_node?(node)
+      add_callback :start_hash, :start_bare_assoc_hash do |node|
+        if !empty_hash?(node) && hash_is_18?(node) && valid_keys?(node)
           add_error "change Hash Syntax to 1.9"
         end
       end
 
-      alias_method :start_bare_assoc_hash, :start_hash
-
       protected
         # check if hash node is empty.
         def empty_hash?(node)
@@ -44,18 +33,7 @@ module RailsBestPractices
           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 :symbol_literal == pair_nodes[i][1].sexp_type ||
-                  :string_literal == pair_nodes[i][1].sexp_type
-              return true
-            end
-          end
-
-          false
+          pair_nodes.any? { |pair_node| :symbol_literal == pair_node[1].sexp_type }
         end
 
         # check if the hash keys are valid to be converted to ruby 1.9
@@ -63,11 +41,6 @@ module RailsBestPractices
         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/reviews/isolate_seed_data_review.rb

@@ -18,15 +18,12 @@ module RailsBestPractices
     #   if the message is "create" or "create!",
     #   then it should be isolated to db seed.
     #   if the message is "save" or "save!",
-    #   and the subject is included in new variables,
+    #   and the receiver is included in new variables,
     #   then it should be isolated to db seed.
     class IsolateSeedDataReview < Review
       interesting_nodes :call, :assign
       interesting_files MIGRATION_FILES
-
-      def url
-        "http://rails-bestpractices.com/posts/20-isolating-seed-data"
-      end
+      url "http://rails-bestpractices.com/posts/20-isolating-seed-data"
 
       def initialize
         super
@@ -37,7 +34,7 @@ module RailsBestPractices
       #
       # if the right value of the node is a call node with "new" message,
       # then remember it as new variables.
-      def start_assign(node)
+      add_callback :start_assign do |node|
         remember_new_variable(node)
       end
 
@@ -47,9 +44,9 @@ module RailsBestPractices
       # then you should isolate it to seed data.
       #
       # if the message of the call node is "save" or "save!",
-      # and the subject of the call node is included in @new_variables,
+      # and the receiver of the call node is included in @new_variables,
       # then you should isolate it to seed data.
-      def start_call(node)
+      add_callback :start_call do |node|
         if ["create", "create!"].include? node.message.to_s
           add_error("isolate seed data")
         elsif ["save", "save!"].include? node.message.to_s
@@ -68,9 +65,9 @@ module RailsBestPractices
           end
         end
 
-        # see if the subject of the call node is included in the @new_varaibles.
+        # see if the receiver of the call node is included in the @new_varaibles.
         def new_record?(node)
-          @new_variables.include? node.subject.to_s
+          @new_variables.include? node.receiver.to_s
         end
     end
   end

data/lib/rails_best_practices/reviews/keep_finders_on_their_own_model_review.rb

@@ -19,24 +19,20 @@ module RailsBestPractices
     class KeepFindersOnTheirOwnModelReview < Review
       interesting_nodes :method_add_arg
       interesting_files MODEL_FILES
+      url "http://rails-bestpractices.com/posts/13-keep-finders-on-their-own-model"
 
       FINDERS = %w(find all first last)
 
-      def url
-        "http://rails-bestpractices.com/posts/13-keep-finders-on-their-own-model"
-      end
-
       # check all the call nodes to see if there is a finder for other model.
       #
       # if the call node is
       #
       # 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)
+      # 2. the receiver 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_method_add_arg(node)
+      add_callback :start_method_add_arg do |node|
         add_error "keep finders on their own model" if other_finder?(node)
       end
 
@@ -44,12 +40,12 @@ module RailsBestPractices
         # 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,
-        # and the subject of the node should be with message :call (this is the other model),
+        # and the receiver of the node should be with message :call (this is the other model),
         # and any of its arguments is a hash,
         # then it is the finder of other model.
         def other_finder?(node)
           FINDERS.include?(node[1].message.to_s) &&
-            :call == node[1].subject.sexp_type &&
+            :call == node[1].receiver.sexp_type &&
             node.arguments.grep_nodes_count(sexp_type: :bare_assoc_hash) > 0
         end
     end

data/lib/rails_best_practices/reviews/law_of_demeter_review.rb

@@ -11,28 +11,25 @@ module RailsBestPractices
     #
     # Review process:
     #   check all method calls to see if there is method call to the association object.
-    #   if there is a call node whose subject is an object of model (compare by name),
+    #   if there is a call node whose receiver is an object of model (compare by name),
     #   and whose message is an association of that model (also compare by name),
     #   and outer the call node, it is also a call node,
     #   then it violate the law of demeter.
     class LawOfDemeterReview < Review
       interesting_nodes :call
       interesting_files ALL_FILES
+      url "http://rails-bestpractices.com/posts/15-the-law-of-demeter"
 
       ASSOCIATION_METHODS = %w(belongs_to has_one)
 
-      def url
-        "http://rails-bestpractices.com/posts/15-the-law-of-demeter"
-      end
-
       # check the call node,
       #
-      # 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,
+      # if the receiver of the call node is also a call node,
+      # and the receiver of the receiver call node matchs one of the class names,
+      # and the message of the receiver call node matchs one of the association name with the class name,
       # then it violates the law of demeter.
-      def start_call(node)
-        if :call == node.subject.sexp_type && need_delegate?(node)
+      add_callback :start_call do |node|
+        if :call == node.receiver.sexp_type && need_delegate?(node)
           add_error "law of demeter"
         end
       end
@@ -40,13 +37,13 @@ module RailsBestPractices
       private
         # check if the call node can use delegate to avoid violating law of demeter.
         #
-        # 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,
+        # if the receiver of receiver of the call node matchs any in model names,
+        # and the message of receiver of the call node matchs any in association names,
         # then it needs delegate.
         def need_delegate?(node)
           return unless variable(node)
           class_name = variable(node).to_s.sub('@', '').classify
-          association_name = node.subject.message.to_s
+          association_name = node.receiver.message.to_s
           association = model_associations.get_association(class_name, association_name)
           attribute_name = node.message.to_s
           association && ASSOCIATION_METHODS.include?(association["meta"]) &&

data/lib/rails_best_practices/reviews/move_code_into_controller_review.rb

@@ -14,35 +14,32 @@ module RailsBestPractices
     class MoveCodeIntoControllerReview < Review
       interesting_nodes :method_add_arg, :assign
       interesting_files VIEW_FILES
+      url "http://rails-bestpractices.com/posts/24-move-code-into-controller"
 
       FINDERS = %w(find all first last)
 
-      def url
-        "http://rails-bestpractices.com/posts/24-move-code-into-controller"
-      end
-
       # check method_add_arg nodes.
       #
-      # if the subject of the method_add_arg node is a constant,
+      # if the receiver 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_method_add_arg(node)
+      add_callback :start_method_add_arg do |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,
+      # if the receiver 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_callback :start_assign do |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.
         def finder?(node)
-          node.subject.const? && FINDERS.include?(node.message.to_s)
+          node.receiver.const? && FINDERS.include?(node.message.to_s)
         end
     end
   end

data/lib/rails_best_practices/reviews/move_code_into_helper_review.rb

@@ -21,10 +21,7 @@ module RailsBestPractices
     class MoveCodeIntoHelperReview < Review
       interesting_nodes :method_add_arg
       interesting_files VIEW_FILES
-
-      def url
-        "http://rails-bestpractices.com/posts/26-move-code-into-helper"
-      end
+      url "http://rails-bestpractices.com/posts/26-move-code-into-helper"
 
       def initialize(options = {})
         super()
@@ -36,7 +33,7 @@ module RailsBestPractices
       # 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_method_add_arg(node)
+      add_callback :start_method_add_arg do |node|
         add_error "move code into helper (array_count >= #{@array_count})" if complex_select_options?(node)
       end