# encoding: utf-8 require 'rails_best_practices/reviews/review' module RailsBestPractices module Reviews # Review a controller file to make sure that complex model creation should not exist in controller, should be replaced with factory method. # # See the best practice details here http://rails-bestpractices.com/posts/6-replace-complex-creation-with-factory-method. # # Implementation: # # Review process: # check all method defines in the controller files, # if there are multiple attribute assignments apply to one subject, # and the subject is a local variable or an instance variable, # and after them there is a call node with message :save or :save!, # then these attribute assignments are complex creation, should be replaced with factory method. class ReplaceComplexCreationWithFactoryMethodReview < Review def url "http://rails-bestpractices.com/posts/6-replace-complex-creation-with-factory-method" end def interesting_nodes [:defn] end def interesting_files CONTROLLER_FILES end def initialize(options = {}) super() @attrasgn_count = options['attribute_assignment_count'] || 2 end # check method define node to see if there are multiple attribute assignments, more than @attrasgn_count, on one local variable or instance variable before save. # # it wll check every attrasgn nodes in method define node, # if there are multiple attrasgn nodes who have the same subject, # and the subject is a local variable or an instance variable, # and after them, there is a call node with message :save or :save!, # then these attribute assignments are complex creation, should be replaced with factory method. def start_defn(node) node.recursive_children do |child_node| case child_node.node_type when :attrasgn remember_variable_use_count(child_node) when :call check_variable_save(child_node) else end end reset_variable_use_count end private # check the call node to see if it is with message :save or :save!, # and the count attribute assignment on the subject of the call node is greater than @attrasgn_count defined, # then it is a complex creation, should be replaced with factory method. def check_variable_save(node) if [:save, :save!].include? node.message variable = node.subject if variable_use_count[variable].to_i > @attrasgn_count add_error "replace complex creation with factory method (#{variable} attribute_assignment_count > #{@attrasgn_count})" end end end end end end