Class: RailsBestPractices::Reviews::ReplaceInstanceVariableWithLocalVariableReview

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

Overview

Review a partail view file to make sure there is no instance variable.

See the best practice details here rails-bestpractices.com/posts/27-replace-instance-variable-with-local-variable.

Implementation:

Review process:

check all instance variable in partial view files,
if exist, then they should be replaced with local variable

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!, #initialize, interesting_files, #interesting_files, #interesting_nodes, interesting_nodes, #method_missing, #node_end, #node_start, #parse_file?, #result, #total_files_checked

Constructor Details

This class inherits a constructor from RailsBestPractices::Core::Check

Dynamic Method Handling

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

Instance Method Details

#start_var_ref(node) ⇒ Object

check ivar node in partial view file, it is an instance variable, and should be replaced with local variable.



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

def start_var_ref(node)
  if node.to_s.start_with?('@')
    add_error "replace instance variable with local variable"
  end
end

#start_vcall(node) ⇒ Object

check ivar node in partial view file, it is an instance variable, and should be replaced with local variable.



33
34
35
36
37
 
# File 'lib/rails_best_practices/reviews/replace_instance_variable_with_local_variable_review.rb', line 33

def start_vcall(node)
  if node.to_s.start_with?('@')
    add_error "replace instance variable with local variable"
  end
end

#url ⇒ Object 



19
20
21
 
# File 'lib/rails_best_practices/reviews/replace_instance_variable_with_local_variable_review.rb', line 19

def url
  "http://rails-bestpractices.com/posts/27-replace-instance-variable-with-local-variable"
end