Class: ActionView::Component::Base

Inherits:
Base
  • Object
show all
Includes:
ActionController::RequestForgeryProtection, ActiveModel::Validations, ActiveSupport::Configurable
Defined in:
lib/action_view/component/base.rb

Defined Under Namespace

Classes: DummyTemplate

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Base

Returns a new instance of Base.



73
 
# File 'lib/action_view/component/base.rb', line 73

def initialize(*); end

Class Method Details

.compile ⇒ Object

Compile template to #call instance method, assuming it hasn’t been compiled already. We could in theory do this on app boot, at least in production environments. Right now this just compiles the template the first time the component is rendered.



97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/action_view/component/base.rb', line 97

def compile
  return if @compiled && ActionView::Base.cache_template_loading

  class_eval <<-RUBY, __FILE__, __LINE__ + 1
    def call
      @output_buffer = ActionView::OutputBuffer.new
      #{compiled_template}
    end
  RUBY

  @compiled = true
end

.inherited(child) ⇒ Object 



88
89
90
91
92
 
# File 'lib/action_view/component/base.rb', line 88

def inherited(child)
  child.include Rails.application.routes.url_helpers unless child < Rails.application.routes.url_helpers

  super
end

Instance Method Details

#controller ⇒ Object 



83
84
85
 
# File 'lib/action_view/component/base.rb', line 83

def controller
  @controller ||= view_context.controller
end

#render(options = {}, args = {}, &block) ⇒ Object 



75
76
77
78
79
80
81
 
# File 'lib/action_view/component/base.rb', line 75

def render(options = {}, args = {}, &block)
  if options.is_a?(String) || (options.is_a?(Hash) && options.has_key?(:partial))
    view_context.render(options, args, &block)
  else
    super
  end
end

#render_in(view_context, *args, &block) ⇒ Object

Entrypoint for rendering components. Called by ActionView::Base#render.

view_context: ActionView context from calling view args(hash): params to be passed to component being rendered block: optional block to be captured within the view context

returns HTML that has been escaped by the respective template handler

Example subclass:

app/components/my_component.rb: class MyComponent < ActionView::Component::Base

def initialize(title:)
  @title = title
end

end

app/components/my_component.html.erb <span title=“<%= @title %>”>Hello, <%= content %>!</span>

In use: <%= render MyComponent, title: “greeting” do %>world<% end %> returns: <span title=“greeting”>Hello, world!</span>



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/action_view/component/base.rb', line 61

def render_in(view_context, *args, &block)
  self.class.compile
  @view_context = view_context
  @view_renderer ||= view_context.view_renderer
  @lookup_context ||= view_context.lookup_context
  @view_flow ||= view_context.view_flow

  @content = view_context.capture(&block) if block_given?
  validate!
  call
end