модуль AbstractController::Helpers::ClassMethods

# File actionpack/lib/abstract_controller/helpers.rb, line 107
      

Возвращает список имён помощников в заданном пути.

ActionController::Base.all_helpers_from_path 'app/helpers'
# => ["application", "chart", "rubygems"]

# File actionpack/lib/abstract_controller/helpers.rb, line 222
def clear_helpers
  inherited_helper_methods = _helper_methods
  self._helpers = Module.new
  self._helper_methods = Array.new

  inherited_helper_methods.each { |meth| helper_method meth }
  default_helper_module! unless anonymous?
end

Очищает все существующие помощники в этом классе, сохраняя только помощника с таким же именем, как и у этого класса.

# File actionpack/lib/abstract_controller/helpers.rb, line 211
def helper(*args, &block)
  modules_for_helpers(args).each do |mod|
    next if _helpers.include?(mod)
    _helpers_for_modification.include(mod)
  end

  _helpers_for_modification.module_eval(&block) if block_given?
end

Включает указанные модули в класс шаблона.

Модули могут быть указаны различными способами. Все следующие вызовы включают FooHelper:

# Module, recommended.
helper FooHelper

# String/symbol without the "helper" suffix, camel or snake case.
helper "Foo"
helper :Foo
helper "foo"
helper :foo

Последние два предполагают, что "foo".camelize возвращает «Foo».

Когда передаются строки или символы, метод находит фактический объект модуля, используя String#constantize. Поэтому, если модуль ещё не загружен, он должен быть загружаемым автоматически, что обычно и происходит.

Поддерживаются пространства имён. Следующие вызовы включают Foo::BarHelper:

# Module, recommended.
helper Foo::BarHelper

# String/symbol without the "helper" suffix, camel or snake case.
helper "Foo::Bar"
helper :"Foo::Bar"
helper "foo/bar"
helper :"foo/bar"

Последние два предполагают, что "foo/bar".camelize возвращает «Foo::Bar».

Метод также принимает блок. Если он присутствует, блок вычисляется в контексте модуля помощника контроллера. Этот простой вызов делает метод wadus доступным в шаблонах окружающего контроллера:

helper do
  def wadus
    "wadus"
  end
end

Кроме того, все вышеперечисленные стили могут быть смешаны вместе:

helper FooHelper, "woo", "bar/baz" do
  def wadus
    "wadus"
  end
end

# File actionpack/lib/abstract_controller/helpers.rb, line 140
      def helper_method(*methods)
        methods.flatten!
        self._helper_methods += methods

        location = caller_locations(1, 1).first
        file, line = location.path, location.lineno

        methods.each do |method|
          # def current_user(*args, &block)
          #   controller.send(:'current_user', *args, &block)
          # end
          _helpers_for_modification.class_eval <<~ruby_eval.lines.map(&:strip).join(";"), file, line
            def #{method}(*args, &block)
              controller.send(:'#{method}', *args, &block)
            end
            ruby2_keywords(:'#{method}')
          ruby_eval
        end
      end

Объявляет метод контроллера как помощник. Например, следующее делает методы контроллера current_user и logged_in? доступными для представления:

class ApplicationController < ActionController::Base
  helper_method :current_user, :logged_in?

  private
    def current_user
      @current_user ||= User.find_by(id: session[:user])
    end

    def logged_in?
      current_user != nil
    end
end

В представлении:

<% if logged_in? -%>Welcome, <%= current_user.name %><% end -%>

Параметры

• method[, method] - Имя или имена метода контроллера, которые нужно сделать доступными для представления.

# File actionpack/lib/abstract_controller/helpers.rb, line 84
def inherited(klass)
  # Inherited from parent by default
  klass._helpers = nil

  klass.class_eval { default_helper_module! } unless klass.anonymous?
  super
end

При наследовании класса, модуль помощника оборачивается в новый модуль. Это гарантирует, что модуль родительского класса может быть изменён независимо от дочернего.

# File actionpack/lib/abstract_controller/helpers.rb, line 97
      

Принимая массив значений, аналогичных тем, которые принимаются helper, этот метод возвращает массив соответствующих модулей в том же порядке.