Class: RailsBestPractices::Reviews::MoveModelLogicIntoModelReview

Inherits:
Review
  • Object
show all
Defined in:
lib/rails_best_practices/reviews/move_model_logic_into_model_review.rb

Overview

Review a controller file to make sure that complex model logic should not exist in controller, should be moved into a model.

See the best practice details here rails-bestpractices.com/posts/7-move-model-logic-into-the-model.

Implementation:

Review process:

check all method defines in the controller files,
if there are multiple method calls apply to one subject,
and the subject is a variable,
then they are complex model logic, and they should be moved into model.

Constant Summary

Constants inherited from Core::Check

Core::Check::ALL_FILES, Core::Check::CONTROLLER_FILES, Core::Check::DEPLOY_FILES, Core::Check::HELPER_FILES, Core::Check::MAILER_FILES, Core::Check::MIGRATION_FILES, Core::Check::MODEL_FILES, Core::Check::PARTIAL_VIEW_FILES, Core::Check::ROUTE_FILES, Core::Check::SCHEMA_FILE, Core::Check::VIEW_FILES

Instance Method Summary collapse

Methods inherited from Review

#model_associations, #model_attributes, #models, #remember_variable_use_count, #reset_variable_use_count, #variable, #variable_use_count

Methods inherited from Core::Check

add_callback, #add_error, #after_prepare, #after_review, callbacks, #errors, #increment_total_files_checked!, #interesting_files, interesting_files, interesting_nodes, #interesting_nodes, #method_missing, #node_end, #node_start, #parse_file?, #result, #total_files_checked

Constructor Details

#initialize(options = {}) ⇒ MoveModelLogicIntoModelReview

Returns a new instance of MoveModelLogicIntoModelReview.



25
26
27
28
 
# File 'lib/rails_best_practices/reviews/move_model_logic_into_model_review.rb', line 25

def initialize(options = {})
  super()
  @use_count = options['use_count'] || 4
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class RailsBestPractices::Core::Check

Instance Method Details

#start_def(node) ⇒ Object

check method define node to see if there are multiple method calls on one varialbe.

it will check every call nodes, if there are multiple call nodes who have the same subject, and the subject is a variable, then these method calls and attribute assignments should be moved into model.



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/rails_best_practices/reviews/move_model_logic_into_model_review.rb', line 36

def start_def(node)
  node.grep_nodes(:sexp_type => [:call, :assign]) do |child_node|
    remember_variable_use_count(child_node)
  end

  variable_use_count.each do |variable_node, count|
    add_error "move model logic into model (#{variable_node} use_count > #{@use_count})" if count > @use_count
  end

  reset_variable_use_count
end

#url ⇒ Object 



21
22
23
 
# File 'lib/rails_best_practices/reviews/move_model_logic_into_model_review.rb', line 21

def url
  "http://rails-bestpractices.com/posts/7-move-model-logic-into-the-model"
end