Class: RailsBestPractices::Prepares::HelperPrepare

Inherits:
Core::Check
  • Object
show all
Includes:
Core::Check::Accessable, Core::Check::Moduleable
Defined in:
lib/rails_best_practices/prepares/helper_prepare.rb

Overview

Remember helper methods.

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 included from Core::Check::Accessable

#current_access_control, included

Methods included from Core::Check::Moduleable

#current_module_name, included, #moduleable_modules

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, #url

Constructor Details

#initializeHelperPrepare

Returns a new instance of HelperPrepare.



14
15
16
17
# File 'lib/rails_best_practices/prepares/helper_prepare.rb', line 14

def initialize
  @helpers = Prepares.helpers
  @methods = Prepares.helper_methods
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 def node to remember all methods.

the remembered methods (@methods) are like

{
  "PostsHelper" => {
    "create_time" => {"file" => "app/helpers/posts_helper.rb", "line" => 10, "unused" => false},
    "update_time" => {"file" => "app/helpers/posts_helper.rb", "line" => 10, "unused" => false}
  }
}


33
34
35
36
37
38
# File 'lib/rails_best_practices/prepares/helper_prepare.rb', line 33

def start_def(node)
  if node.file =~ HELPER_FILES
    method_name = node.method_name.to_s
    @methods.add_method(current_module_name, method_name, {"file" => node.file, "line" => node.line}, current_access_control)
  end
end

#start_module(node) ⇒ Object

check module node to remember the module name.



20
21
22
# File 'lib/rails_best_practices/prepares/helper_prepare.rb', line 20

def start_module(node)
  @helpers << Core::Mod.new(current_module_name, [])
end