Class: RailsBestPractices::Reviews::RemoveEmptyHelpersReview

Inherits:
Review show all
Defined in:
lib/rails_best_practices/reviews/remove_empty_helpers_review.rb

Overview

Review a helper file to make sure it is not an empty moduel.

See the best practice details here rails-bestpractices.com/posts/72-remove-empty-helpers.

Implementation:

Review process:

check all helper files, if the body of module is nil, then the helper file should be removed.

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_module(node) ⇒ Object

check the body of module node, if it is nil, then it should be removed.



23
24
25
26
27
 
# File 'lib/rails_best_practices/reviews/remove_empty_helpers_review.rb', line 23

def start_module(node)
  if s(:bodystmt, s(:stmts_add, s(:stmts_new), s(:void_stmt)), nil, nil, nil) == node.body
    add_error "remove empty helpers", node.file, node.line
  end
end

#url ⇒ Object 



18
19
20
 
# File 'lib/rails_best_practices/reviews/remove_empty_helpers_review.rb', line 18

def url
  "http://rails-bestpractices.com/posts/72-remove-empty-helpers"
end