Class: ActionView::Base

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses: ActionDispatch::DebugView
Super Chains via Extension / Inclusion / Inheritance
Instance Chain: self, `Helpers`, `Helpers::TranslationHelper`, `Helpers::RenderingHelper`, `Helpers::NumberHelper`, `Helpers::JavaScriptHelper`, `Helpers::FormOptionsHelper`, `Helpers::FormHelper`, `RecordIdentifier`, `ModelNaming`, `Helpers::FormTagHelper`, `Helpers::TextHelper`, `Helpers::SanitizeHelper`, `Helpers::UrlHelper`, `Helpers::DebugHelper`, `Helpers::DateHelper`, `Helpers::CsrfHelper`, `Helpers::CspHelper`, `Helpers::ControllerHelper`, `Helpers::ContentExfiltrationPreventionHelper`, `Helpers::CacheHelper`, `Helpers::AtomFeedHelper`, `Helpers::AssetTagHelper`, `Helpers::TagHelper`, `Helpers::OutputSafetyHelper`, `Helpers::CaptureHelper`, `Helpers::AssetUrlHelper`, `Helpers::ActiveModelHelper`, `::ActiveSupport::Benchmarkable`, `::ERB::Util`, `::ActiveSupport::CoreExt::ERBUtilPrivate`, `::ActiveSupport::CoreExt::ERBUtil`, `Context`
Inherits:	Object
Defined in:	actionview/lib/action_view/base.rb

Overview

Action View templates can be written in several ways. If the template file has a .erb extension, then it uses the erubi template system which can embed Ruby into an HTML document. If the template file has a .builder extension, then Jim Weirich’s Builder::XmlMarkup library is used.

ERB

You trigger ::ERB by using embeddings such as <% %>, <% -%>, and <%= %>. The <%= %> tag set is used when you want output. Consider the following loop for names:

<b>Names of all the people</b>
<% @people.each do |person| %>
  Name: <%= person.name %><br/>
<% end %>

The loop is set up in regular embedding tags <% %>, and the name is written using the output embedding tag <%= %>. Note that this is not just a usage suggestion. Regular output functions like print or puts won’t work with ::ERB templates. So this would be wrong:

<%# WRONG %>
Hi, Mr. <% puts "Frodo" %>

If you absolutely must write from within a function use concat.

When on a line that only contains whitespaces except for the tag, <% %> suppresses leading and trailing whitespace, including the trailing newline. <% %> and <%- -%> are the same. Note however that <%= %> and <%= -%> are different: only the latter removes trailing whitespaces.

Using sub templates

Using sub templates allows you to sidestep tedious replication and extract common display structures in shared templates. The classic example is the use of a header and footer (even though the Action Pack-way would be to use Layouts):

<%= render "application/header" %>
Something really specific and terrific
<%= render "application/footer" %>

As you see, we use the output embeddings for the render methods. The render call itself will just return a string holding the result of the rendering. The output embedding writes it to the current template.

But you don’t have to restrict yourself to static includes. Templates can share variables amongst themselves by using instance variables defined using the regular embedding tags. Like this:

<% @page_title = "A Wonderful Hello" %>
<%= render "application/header" %>

Now the header can pick up on the @page_title variable and use it for outputting a title tag:

<title><%= @page_title %></title>

Passing local variables to sub templates

You can pass local variables to sub templates by using a hash with the variable names as keys and the objects as values:

<%= render "application/header", { headline: "Welcome", person: person } %>

These can now be accessed in application/header with:

Headline: <%= headline %>
First name: <%= person.first_name %>

The local variables passed to sub templates can be accessed as a hash using the local_assigns hash. This lets you access the variables as:

Headline: <%= local_assigns[:headline] %>

This is useful in cases where you aren’t sure if the local variable has been assigned. Alternatively, you could also use defined? headline to first check if the variable has been assigned before using it.

By default, templates will accept any locals as keyword arguments. To restrict what locals a template accepts, add a locals: magic comment:

<%# locals: (headline:) %>

Headline: <%= headline %>

In cases where the local variables are optional, declare the keyword argument with a default value:

<%# locals: (headline: nil) %>

<% unless headline.nil? %>
Headline: <%= headline %>
<% end %>

Read more about strict locals in Action View Overview in the guides.

Template caching

By default, Rails will compile each template to a method in order to render it. When you alter a template, Rails will check the file’s modification time and recompile it in development mode.

Builder

Builder templates are a more programmatic alternative to ::ERB. They are especially useful for generating XML content. An XmlMarkup object named xml is automatically made available to templates with a .builder extension.

Here are some basic examples:

xml.em("emphasized")                                 # => <em>emphasized</em>
xml.em { xml.b("emph & bold") }                      # => <em><b>emph &amp; bold</b></em>
xml.a("A Link", "href" => "http://onestepback.org")  # => <a href="http://onestepback.org">A Link</a>
xml.target("name" => "compile", "option" => "fast")  # => <target option="fast" name="compile"\>
                                                     # NOTE: order of attributes is not specified.

Any method with a block will be treated as an XML markup tag with nested markup in the block. For example, the following:

xml.div do
  xml.h1(@person.name)
  xml.p(@person.bio)
end

would produce something like:

<div>
  <h1>David Heinemeier Hansson</h1>
  <p>A product of Danish Design during the Winter of '79...</p>
</div>

Here is a full-length RSS example actually used on Basecamp:

xml.rss("version" => "2.0", "xmlns:dc" => "http://purl.org/dc/elements/1.1/") do
  xml.channel do
    xml.title(@feed_title)
    xml.link(@url)
    xml.description "Basecamp: Recent items"
    xml.language "en-us"
    xml.ttl "40"

    @recent_items.each do |item|
      xml.item do
        xml.title(item_title(item))
        xml.description(item_description(item)) if item_description(item)
        xml.pubDate(item_pubDate(item))
        xml.guid(@person.firm.account.url + @recent_items.url(item))
        xml.link(@person.firm.account.url + @recent_items.url(item))

        xml.tag!("dc:creator", item.author_name) if item_has_creator?(item)
      end
    end
  end
end

For more information on Builder please consult the source code.

Constant Summary

Class Attribute Summary

._routes rw
._routes? ⇒ Boolean rw
.annotate_rendered_view_with_filenames (also: #annotate_rendered_view_with_filenames) rw

Annotate rendered view with file names.
.automatically_disable_submit_tag (also: #automatically_disable_submit_tag) rw

Specify whether submit_tag should automatically disable on click.
.cache_template_loading rw
.cache_template_loading=(value) rw
.default_formats (also: #default_formats) rw

Specify default_formats that can be rendered.
.field_error_proc (also: #field_error_proc) rw

Specify the proc used to decorate input tags that refer to attributes with errors.
.logger rw
.logger? ⇒ Boolean rw
.prefix_partial_path_with_controller_namespace rw
.prefix_partial_path_with_controller_namespace? ⇒ Boolean rw
.streaming_completion_on_exception (also: #streaming_completion_on_exception) rw

How to complete the streaming when an exception occurs.
.xss_safe? ⇒ Boolean readonly Internal use only

Class Method Summary

.empty
.with_context(context, assigns = {}, controller = nil)
.with_view_paths(view_paths, assigns = {}, controller = nil)
.changed?(other) ⇒ Boolean Internal use only
.new(lookup_context, assigns, controller) ⇒ Base constructor Internal use only
.with_empty_template_cache Internal use only

Instance Attribute Summary

#_routes rw
#_routes? ⇒ Boolean rw
#annotate_rendered_view_with_filenames rw
#assigns rw
#automatically_disable_submit_tag rw
#config rw
#default_formats rw
#field_error_proc rw
#formats rw
#locale rw
#logger rw
#logger? ⇒ Boolean rw
#lookup_context readonly
#prefix_partial_path_with_controller_namespace rw
#prefix_partial_path_with_controller_namespace? ⇒ Boolean rw
#streaming_completion_on_exception rw
#view_paths rw
#view_renderer readonly

`Helpers` - Included

#debug_missing_translation

`Helpers::TranslationHelper` - Included

#raise_on_missing_translations

Specify whether an error should be raised for missing translations.

`Helpers::FormHelper` - Included

#default_form_builder, #form_with_generates_ids, #form_with_generates_remote_forms, #multiple_file_field_include_hidden

`Helpers::FormTagHelper` - Included

#default_enforce_utf8, #embed_authenticity_token_in_remote_forms

`Helpers::SanitizeHelper` - Included

#sanitizer_vendor

`Helpers::UrlHelper` - Included

#button_to_generates_button_tag

`Helpers::ControllerHelper` - Included

#controller, #request

`Helpers::ContentExfiltrationPreventionHelper` - Included

#prepend_content_exfiltration_prevention

`Helpers::CacheHelper` - Included

#caching?

Returns whether the current view fragment is within a cache block.

`Helpers::AssetTagHelper` - Included

#apply_stylesheet_media_default, #image_decoding, #image_loading, #preload_links_header

`Context` - Included

#output_buffer, #view_flow

Instance Method Summary

#_run(method, template, locals, buffer, add_to_stack: true, has_strict_locals: false, &block)
#compiled_method_container
#in_rendering_context(options)
#assign(new_assigns) Internal use only

`Helpers::TranslationHelper` - Included

#l	Alias for Helpers::TranslationHelper#localize.
#localize	Delegates to `I18n.localize` with no additional functionality.
#t	Alias for Helpers::TranslationHelper#translate.
#translate	Delegates to `I18n#translate` but also performs three additional functions.
#missing_translation, #scope_key_by_partial

`Helpers::RenderingHelper` - Included

#_layout_for	Overrides _layout_for in the context object so it supports the case a block is passed to a partial.
#render	Returns the result of a render that’s dictated by the options hash.

`Helpers::NumberHelper` - Included

#number_to_currency	Delegates to ActiveSupport::NumberHelper#number_to_currency.
#number_to_human	Delegates to ActiveSupport::NumberHelper#number_to_human.
#number_to_human_size	Delegates to ActiveSupport::NumberHelper#number_to_human_size.
#number_to_percentage	Delegates to ActiveSupport::NumberHelper#number_to_percentage.
#number_to_phone	Delegates to ActiveSupport::NumberHelper#number_to_phone.
#number_with_delimiter	Delegates to ActiveSupport::NumberHelper#number_to_delimited.
#number_with_precision	Delegates to ActiveSupport::NumberHelper#number_to_rounded.
#delegate_number_helper_method, #escape_units, #escape_unsafe_options, #parse_float, #valid_float?, #wrap_with_output_safety_handling

`Helpers::JavaScriptHelper` - Included

#escape_javascript	Escapes carriage returns and single and double quotes for JavaScript segments.
#j	Alias for Helpers::JavaScriptHelper#escape_javascript.
#javascript_tag	Returns a JavaScript tag with the `content` inside.
#javascript_cdata_section

`Helpers::FormOptionsHelper` - Included

#collection_check_boxes	Returns check box tags for the collection of existing return values of `method` for `object`‘s class.
#collection_radio_buttons	Returns radio button tags for the collection of existing return values of `method` for `object`‘s class.
#collection_select	Returns `<select>` and `<option>` tags for the collection of existing return values of `method` for `object`‘s class.
#grouped_collection_select	Returns `<select>`, `<optgroup>` and `<option>` tags for the collection of existing return values of `method` for `object`‘s class.
#grouped_options_for_select	Returns a string of `<option>` tags, like `options_for_select`, but wraps them with `<optgroup>` tags:
#option_groups_from_collection_for_select	Returns a string of `<option>` tags, like `options_from_collection_for_select`, but groups them by `<optgroup>` tags based on the object relationships of the arguments.
#options_for_select	Accepts a container (hash, array, enumerable, your type) and returns a string of option tags.
#options_from_collection_for_select	Returns a string of option tags that have been compiled by iterating over the `collection` and assigning the result of a call to the `value_method` as the option value and the `text_method` as the option text.
#select	Create a select tag and a series of contained option tags for the provided object and method.
#time_zone_options_for_select	Returns a string of option tags for pretty much any time zone in the world.
#time_zone_select	Returns select and option tags for the given object and method, using `#time_zone_options_for_select` to generate the list of option tags.
#weekday_options_for_select	Returns a string of option tags for the days of the week.
#weekday_select	Returns select and option tags for the given object and method, using `weekday_options_for_select` to generate the list of option tags.
#extract_selected_and_disabled, #extract_values_from_collection, #option_html_attributes, #option_text_and_value, #option_value_selected?, #prompt_text, #value_for_collection

`Helpers::FormHelper` - Included

#check_box	Returns a checkbox tag tailored for accessing a specified attribute (identified by `method`) on an object assigned to the template (identified by `object`).
#color_field	Returns a text_field of type “color”.
#date_field	Returns a text_field of type “date”.
#datetime_field	Returns a text_field of type “datetime-local”.
#datetime_local_field	Alias for Helpers::FormHelper#datetime_field.
#email_field	Returns a text_field of type “email”.
#fields	Scopes input fields with either an explicit scope or model.
#fields_for	Creates a scope around a specific model object like form_with, but doesn’t create the form tags themselves.
#file_field	Returns a file upload input tag tailored for accessing a specified attribute (identified by `method`) on an object assigned to the template (identified by `object`).
#form_for	Creates a form that allows the user to create or update the attributes of a specific model object.
#form_with	Creates a form tag based on mixing URLs, scopes, or models.
#hidden_field	Returns a hidden input tag tailored for accessing a specified attribute (identified by `method`) on an object assigned to the template (identified by `object`).
#label	Returns a label tag tailored for labelling an input field for a specified attribute (identified by `method`) on an object assigned to the template (identified by `object`).
#month_field	Returns a text_field of type “month”.
#number_field	Returns an input tag of type “number”.
#password_field	Returns an input tag of the “password” type tailored for accessing a specified attribute (identified by `method`) on an object assigned to the template (identified by `object`).
#phone_field	Alias for Helpers::FormHelper#telephone_field.
#radio_button	Returns a radio button tag for accessing a specified attribute (identified by `method`) on an object assigned to the template (identified by `object`).
#range_field	Returns an input tag of type “range”.
#search_field	Returns an input of type “search” for accessing a specified attribute (identified by `method`) on an object assigned to the template (identified by `object_name`).
#telephone_field	Returns a text_field of type “tel”.
#text_area	Returns a textarea opening and closing tag set tailored for accessing a specified attribute (identified by `method`) on an object assigned to the template (identified by `object`).
#text_field	Returns an input tag of the “text” type tailored for accessing a specified attribute (identified by `method`) on an object assigned to the template (identified by `object`).
#time_field	Returns a text_field of type “time”.
#url_field	Returns a text_field of type “url”.
#week_field	Returns a text_field of type “week”.
#default_form_builder_class, #html_options_for_form_with, #instantiate_builder, #_object_for_form_builder, #apply_form_for_options!

`RecordIdentifier` - Included

#dom_class	The DOM class convention is to use the singular form of an object or class.
#dom_id	The DOM id convention is to use the singular form of an object or class with the id following an underscore.
#record_key_for_dom_id	Returns a string representation of the key attribute(s) that is suitable for use in an HTML DOM id.

`ModelNaming` - Included

#convert_to_model	Converts the given object to an Active Model compliant one.
#model_name_from_record_or_class

`Helpers::FormTagHelper` - Included

#button_tag	Creates a button element that defines a `submit` button, `reset` button or a generic button which can be used in JavaScript, for example.
#check_box_tag	Creates a check box form input tag.
#color_field_tag	Creates a text field of type “color”.
#date_field_tag	Creates a text field of type “date”.
#datetime_field_tag	Creates a text field of type “datetime-local”.
#datetime_local_field_tag	Alias for Helpers::FormTagHelper#datetime_field_tag.
#email_field_tag	Creates a text field of type “email”.
#field_id	Generate an HTML `id` attribute value for the given name and field combination.
#field_name	Generate an HTML `name` attribute value for the given name and field combination.
#field_set_tag	Creates a field set for grouping HTML form elements.
#fieldset_tag	Alias for Helpers::FormTagHelper#field_set_tag.
#file_field_tag	Creates a file upload field.
#form_tag	Starts a form tag that points the action to a URL configured with `url_for_options` just like `ActionController::Base#url_for`.
#hidden_field_tag	Creates a hidden form input field used to transmit data that would be lost due to HTTP’s statelessness or data that should be hidden from the user.
#image_submit_tag	Displays an image which when clicked will submit the form.
#label_tag	Creates a label element.
#month_field_tag	Creates a text field of type “month”.
#number_field_tag	Creates a number field.
#password_field_tag	Creates a password field, a masked text field that will hide the users input behind a mask character.
#phone_field_tag	Alias for Helpers::FormTagHelper#telephone_field_tag.
#radio_button_tag	Creates a radio button; use groups of radio buttons named the same to allow users to select from a group of options.
#range_field_tag	Creates a range form element.
#search_field_tag	Creates a text field of type “search”.
#select_tag	Creates a dropdown selection box, or if the `:multiple` option is set to true, a multiple choice selection box.
#submit_tag	Creates a submit button with the text `value` as the caption.
#telephone_field_tag	Creates a text field of type “tel”.
#text_area_tag	Creates a text input area; use a textarea for longer text inputs such as blog posts or descriptions.
#text_field_tag	Creates a standard text field; use these text fields to input smaller chunks of text like a username or a search query.
#time_field_tag	Creates a text field of type “time”.
#url_field_tag	Creates a text field of type “url”.
#utf8_enforcer_tag	Creates the hidden UTF-8 enforcer tag.
#week_field_tag	Creates a text field of type “week”.
#convert_direct_upload_option_to_url, #extra_tags_for_form, #form_tag_html, #form_tag_with_body, #html_options_for_form,
#sanitize_to_id	see www.w3.org/TR/html4/types.html#type-name.
#set_default_disable_with

`Helpers::TextHelper` - Included

#concat	The preferred method of outputting text in your views is to use the `<%= "text" %>` eRuby syntax.
#current_cycle	Returns the current cycle string after a cycle has been started.
#cycle	Creates a Cycle object whose `to_s` method cycles through elements of an array every time it is called.
#excerpt	Extracts the first occurrence of `phrase` plus surrounding text from `text`.
#highlight	Highlights occurrences of `phrases` in `text` by formatting them with a highlighter string.
#pluralize	Attempts to pluralize the `singular` word unless `count` is 1.
#reset_cycle	Resets a cycle so that it starts from the first element the next time it is called.
#safe_concat,
#simple_format	Returns `text` transformed into HTML using simple formatting rules.
#truncate	Truncates `text` if it is longer than a specified `:length`.
#word_wrap	Wraps the `text` into lines no longer than `line_width` width.
#cut_excerpt_part,
#get_cycle	The cycle helpers need to store the cycles in a place that is guaranteed to be reset every time a page is rendered, so it uses an instance variable of `Base`.
#set_cycle, #split_paragraphs

`Helpers::SanitizeHelper` - Included

#sanitize	Sanitizes HTML input, stripping all but known-safe tags and attributes.
#sanitize_css	Sanitizes a block of CSS code.
#strip_links	Strips all link tags from `html` leaving just the link text.
#strip_tags	Strips all HTML tags from `html`, including comments and special characters.

`Helpers::UrlHelper` - Included

#button_to	Generates a form containing a single button that submits to the URL created by the set of `options`.
#current_page?	True if the current request URI was generated by the given `options`.
#link_to	Creates an anchor element of the given `name` using a URL created by the set of `options`.
#link_to_if	Creates a link tag of the given `name` using a URL created by the set of `options` if `condition` is true, otherwise only the name is returned.
#link_to_unless	Creates a link tag of the given `name` using a URL created by the set of `options` unless `condition` is true, in which case only the name is returned.
#link_to_unless_current	Creates a link tag of the given `name` using a URL created by the set of `options` unless the current request URI is the same as the links, in which case only the name is returned (or the given block is yielded, if one exists).
#mail_to	Creates a mailto link tag to the specified `email_address`, which is also used as the name of the link unless `name` is specified.
#phone_to	Creates a TEL anchor link tag to the specified `phone_number`.
#sms_to	Creates an SMS anchor link tag to the specified `phone_number`.
#add_method_to_attributes!, #convert_options_to_data_attributes, #link_to_remote_options?, #method_for_options, #method_not_get_method?, #method_tag, #remove_trailing_slash!,
#to_form_params	Returns an array of hashes each containing `:name` and `:value` keys suitable for use as the names and values of form input fields:
#token_tag, #url_target,
#url_for	Basic implementation of url_for to allow use helpers without routes existence.
#_back_url, #_filtered_referrer

`Helpers::DebugHelper` - Included

#debug

Returns a YAML representation of object wrapped with <pre> and </pre>.

`Helpers::DateHelper` - Included

#date_select	Returns a set of select tags (one for year, month, and day) pre-selected for accessing a specified date-based attribute (identified by `method`) on an object assigned to the template (identified by `object`).
#datetime_select	Returns a set of select tags (one for year, month, day, hour, and minute) pre-selected for accessing a specified datetime-based attribute (identified by `method`) on an object assigned to the template (identified by `object`).
#distance_of_time_in_words	Reports the approximate distance in time between two `::Time`, `::Date`, or `::DateTime` objects or integers as seconds.
#distance_of_time_in_words_to_now	Alias for Helpers::DateHelper#time_ago_in_words.
#select_date	Returns a set of HTML select-tags (one for year, month, and day) pre-selected with the `date`.
#select_datetime	Returns a set of HTML select-tags (one for year, month, day, hour, minute, and second) pre-selected with the `datetime`.
#select_day	Returns a select tag with options for each of the days 1 through 31 with the current day selected.
#select_hour	Returns a select tag with options for each of the hours 0 through 23 with the current hour selected.
#select_minute	Returns a select tag with options for each of the minutes 0 through 59 with the current minute selected.
#select_month	Returns a select tag with options for each of the months January through December with the current month selected.
#select_second	Returns a select tag with options for each of the seconds 0 through 59 with the current second selected.
#select_time	Returns a set of HTML select-tags (one for hour and minute).
#select_year	Returns a select tag with options for each of the five years on each side of the current, which is selected.
#time_ago_in_words	Like `distance_of_time_in_words`, but where `to_time` is fixed to `Time.now`.
#time_select	Returns a set of select tags (one for hour, minute, and optionally second) pre-selected for accessing a specified time-based attribute (identified by `method`) on an object assigned to the template (identified by `object`).
#time_tag	Returns an HTML time tag for the given date or time.
#normalize_distance_of_time_argument_to_time

`Helpers::CsrfHelper` - Included

#csrf_meta_tag	Alias for Helpers::CsrfHelper#csrf_meta_tags.
#csrf_meta_tags	Returns meta tags “csrf-param” and “csrf-token” with the name of the cross-site request forgery protection parameter and token, respectively.

`Helpers::CspHelper` - Included

#csp_meta_tag

Returns a meta tag “csp-nonce” with the per-session nonce value for allowing inline <script> tags.

`Helpers::ControllerHelper` - Included

#assign_controller, #logger, #respond_to?

`Helpers::ContentExfiltrationPreventionHelper` - Included

#prevent_content_exfiltration

`Helpers::CacheHelper` - Included

#cache	This helper exposes a method for caching fragments of a view rather than an entire action or page.
#cache_fragment_name	This helper returns the name of a cache key for a given fragment cache call.
#cache_if	Cache fragments of a view if `condition` is true.
#cache_unless	Cache fragments of a view unless `condition` is true.
#uncacheable!	Raises `UncacheableFragmentError` when called from within a `cache` block.
#fragment_for, #fragment_name_with_digest, #read_fragment_for, #write_fragment_for, #digest_path_from_template

`Helpers::AtomFeedHelper` - Included

#atom_feed

Adds easy defaults to writing Atom feeds with the Builder template engine (this does not work on ::ERB or any other template languages).

`Helpers::AssetTagHelper` - Included

#audio_tag	Returns an HTML audio tag for the `sources`.
#auto_discovery_link_tag	Returns a link tag that browsers and feed readers can use to auto-detect an RSS, Atom, or JSON feed.
#favicon_link_tag	Returns a link tag for a favicon managed by the asset pipeline.
#image_tag	Returns an HTML image tag for the `source`.
#javascript_include_tag	Returns an HTML script tag for each of the `sources` provided.
#picture_tag	Returns an HTML picture tag for the `sources`.
#preload_link_tag	Returns a link tag that browsers can use to preload the `source`.
#stylesheet_link_tag	Returns a stylesheet link tag for the sources specified as arguments.
#video_tag	Returns an HTML video tag for the `sources`.
#check_for_image_tag_errors, #extract_dimensions, #multiple_sources_tag_builder, #resolve_asset_source, #resolve_link_as, #send_preload_links_header

`Helpers::TagHelper` - Included

#cdata_section	Returns a CDATA section with the given `content`.
#class_names	Alias for Helpers::TagHelper#token_list.
#content_tag	Returns an HTML block tag of type `name` surrounding the `content`.
#escape_once	Returns an escaped version of `html` without affecting existing escaped entities.
#tag	Returns an HTML tag.
#token_list	Returns a string of tokens built from `args`.
#build_tag_values, #ensure_valid_html5_tag_name, #tag_builder

`Helpers::OutputSafetyHelper` - Included

#raw	This method outputs without escaping a string.
#safe_join	This method returns an HTML safe string similar to what `Array#join` would return.
#to_sentence	Converts the array to a comma-separated sentence where the last element is joined by the connector word.

`Helpers::CaptureHelper` - Included

#capture	The capture method extracts part of a template as a string object.
#content_for	Calling `content_for` stores a block of markup in an identifier for later use.
#content_for?	`content_for?` checks whether any content has been captured yet using `content_for`.
#provide	The same as `content_for` but when used with streaming flushes straight back to the layout.
#with_output_buffer	Use an alternate output buffer for the duration of the block.

`Helpers::AssetUrlHelper` - Included

#asset_path	This is the entry point for all assets.
#asset_url	Computes the full URL to an asset in the public directory.
#audio_path	Computes the path to an audio asset in the public audios directory.
#audio_url	Computes the full URL to an audio asset in the public audios directory.
#compute_asset_extname	Compute extname to append to asset path.
#compute_asset_host	Pick an asset host for this source.
#compute_asset_path	Computes asset path to public directory.
#font_path	Computes the path to a font asset.
#font_url	Computes the full URL to a font asset.
#image_path	Computes the path to an image asset.
#image_url	Computes the full URL to an image asset.
#javascript_path	Computes the path to a JavaScript asset in the public javascripts directory.
#javascript_url	Computes the full URL to a JavaScript asset in the public javascripts directory.
#path_to_asset	Alias for Helpers::AssetUrlHelper#asset_path.
#path_to_audio	Alias for Helpers::AssetUrlHelper#audio_path.
#path_to_font	Alias for Helpers::AssetUrlHelper#font_path.
#path_to_image	Alias for Helpers::AssetUrlHelper#image_path.
#path_to_javascript	Alias for Helpers::AssetUrlHelper#javascript_path.
#path_to_stylesheet	Alias for Helpers::AssetUrlHelper#stylesheet_path.
#path_to_video	Alias for Helpers::AssetUrlHelper#video_path.
#public_compute_asset_path	Alias for Helpers::AssetUrlHelper#compute_asset_path.
#stylesheet_path	Computes the path to a stylesheet asset in the public stylesheets directory.
#stylesheet_url	Computes the full URL to a stylesheet asset in the public stylesheets directory.
#url_to_asset	Alias for Helpers::AssetUrlHelper#asset_url.
#url_to_audio	Alias for Helpers::AssetUrlHelper#audio_url.
#url_to_font	Alias for Helpers::AssetUrlHelper#font_url.
#url_to_image	Alias for Helpers::AssetUrlHelper#image_url.
#url_to_javascript	Alias for Helpers::AssetUrlHelper#javascript_url.
#url_to_stylesheet	Alias for Helpers::AssetUrlHelper#stylesheet_url.
#url_to_video	Alias for Helpers::AssetUrlHelper#video_url.
#video_path	Computes the path to a video asset in the public videos directory.
#video_url	Computes the full URL to a video asset in the public videos directory.

`::ActiveSupport::Benchmarkable` - Included

#benchmark

Allows you to measure the execution time of a block in a template and records the result to the log.

`::ERB::Util` - Included

#html_escape_once	A utility method for escaping HTML without affecting existing escaped entities.
#json_escape	A utility method for escaping HTML entities in JSON strings.
#xml_name_escape	A utility method for escaping XML names of tags and names of attributes.

`::ActiveSupport::CoreExt::ERBUtil` - Included

#h	Alias for ActiveSupport::CoreExt::ERBUtil#html_escape.
#html_escape	A utility method for escaping HTML tag characters.
#unwrapped_html_escape	Alias for ActiveSupport::CoreExt::ERBUtil#html_escape.

`Context` - Included

#_layout_for	Encapsulates the interaction with the view flow so it returns the correct buffer on `yield`.
#_prepare_context	Prepares the context by setting the appropriate instance variables.

Constructor Details

.new(lookup_context, assigns, controller) ⇒ `Base`

This method is for internal use only.

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 244


def initialize(lookup_context, assigns, controller) # :nodoc:
  @_config = ActiveSupport::InheritableOptions.new

  @lookup_context = lookup_context

  @view_renderer = ActionView::Renderer.new @lookup_context
  @current_template = nil

  assign_controller(controller)
  _prepare_context

  super()

  # Assigns must be called last to minimize the number of shapes
  assign(assigns)
end

Class Attribute Details

._routes (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 181


class_attribute :_routes

._routes? ⇒ `Boolean` (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 181


class_attribute :_routes

.annotate_rendered_view_with_filenames (rw) Also known as: #annotate_rendered_view_with_filenames

Annotate rendered view with file names

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 179


cattr_accessor :annotate_rendered_view_with_filenames, default: false

.automatically_disable_submit_tag (rw) Also known as: #automatically_disable_submit_tag

Specify whether submit_tag should automatically disable on click

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 176


cattr_accessor :automatically_disable_submit_tag, default: true

.cache_template_loading (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 187


def cache_template_loading
  ActionView::Resolver.caching?
end

.cache_template_loading=(value) (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 191


def cache_template_loading=(value)
  ActionView::Resolver.caching = value
end

.default_formats (rw) Also known as: #default_formats

Specify default_formats that can be rendered.

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 173


cattr_accessor :default_formats

.field_error_proc (rw) Also known as: #field_error_proc

Specify the proc used to decorate input tags that refer to attributes with errors.

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 161


cattr_accessor :field_error_proc, default: Proc.new { |html_tag, instance| content_tag :div, html_tag, class: "field_with_errors" }

.logger (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 182


class_attribute :logger

.logger? ⇒ `Boolean` (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 182


class_attribute :logger

.prefix_partial_path_with_controller_namespace (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 170


class_attribute :prefix_partial_path_with_controller_namespace, default: true

.prefix_partial_path_with_controller_namespace? ⇒ `Boolean` (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 170


class_attribute :prefix_partial_path_with_controller_namespace, default: true

.streaming_completion_on_exception (rw) Also known as: #streaming_completion_on_exception

How to complete the streaming when an exception occurs. This is our best guess: first try to close the attribute, then the tag.

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 165


cattr_accessor :streaming_completion_on_exception, default: %("><script>window.location = "/500.html"</script></html>)

.xss_safe? ⇒ `Boolean` (readonly)

This method is for internal use only.

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 195


def xss_safe? # :nodoc:
  true
end

Class Method Details

.changed?(other) ⇒ `Boolean`

This method is for internal use only.

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 213


def changed?(other) # :nodoc:
  compiled_method_container != other.compiled_method_container
end

.empty

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 230


def self.empty
  with_view_paths([])
end

.with_context(context, assigns = {}, controller = nil)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 238


def self.with_context(context, assigns = {}, controller = nil)
  new context, assigns, controller
end

.with_empty_template_cache

This method is for internal use only.

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 199


def with_empty_template_cache # :nodoc:
  subclass = Class.new(self) {
    # We can't implement these as self.class because subclasses will
    # share the same template cache as superclasses, so "changed?" won't work
    # correctly.
    define_method(:compiled_method_container)           { subclass }
    define_singleton_method(:compiled_method_container) { subclass }

    def inspect
      "#<ActionView::Base:#{'%#016x' % (object_id << 1)}>"
    end
  }
end

.with_view_paths(view_paths, assigns = {}, controller = nil)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 234


def self.with_view_paths(view_paths, assigns = {}, controller = nil)
  with_context ActionView::LookupContext.new(view_paths), assigns, controller
end

Instance Attribute Details

#_routes (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 181


class_attribute :_routes

#_routes? ⇒ `Boolean` (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 181


class_attribute :_routes

#annotate_rendered_view_with_filenames (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 179


cattr_accessor :annotate_rendered_view_with_filenames, default: false

#assigns (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 219


attr_internal :config, :assigns

#automatically_disable_submit_tag (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 176


cattr_accessor :automatically_disable_submit_tag, default: true

#config (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 219


attr_internal :config, :assigns

#default_formats (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 173


cattr_accessor :default_formats

#field_error_proc (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 161


cattr_accessor :field_error_proc, default: Proc.new { |html_tag, instance| content_tag :div, html_tag, class: "field_with_errors" }

#formats (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 221


delegate :formats, :formats=, :locale, :locale=, :view_paths, :view_paths=, to: :lookup_context

#locale (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 221


delegate :formats, :formats=, :locale, :locale=, :view_paths, :view_paths=, to: :lookup_context

#logger (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 182


class_attribute :logger

#logger? ⇒ `Boolean` (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 182


class_attribute :logger

#lookup_context (readonly)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 218


attr_reader :view_renderer, :lookup_context

#prefix_partial_path_with_controller_namespace (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 170


class_attribute :prefix_partial_path_with_controller_namespace, default: true

#prefix_partial_path_with_controller_namespace? ⇒ `Boolean` (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 170


class_attribute :prefix_partial_path_with_controller_namespace, default: true

#streaming_completion_on_exception (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 165


cattr_accessor :streaming_completion_on_exception, default: %("><script>window.location = "/500.html"</script></html>)

#view_paths (rw)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 221


delegate :formats, :formats=, :locale, :locale=, :view_paths, :view_paths=, to: :lookup_context

#view_renderer (readonly)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 218


attr_reader :view_renderer, :lookup_context

Instance Method Details

#_run(method, template, locals, buffer, add_to_stack: true, has_strict_locals: false, &block)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 261


def _run(method, template, locals, buffer, add_to_stack: true, has_strict_locals: false, &block)
  _old_output_buffer, _old_virtual_path, _old_template = @output_buffer, @virtual_path, @current_template
  @current_template = template if add_to_stack
  @output_buffer = buffer

  if has_strict_locals
    begin
      public_send(method, buffer, **locals, &block)
    rescue ArgumentError => argument_error
      raise(
        ArgumentError,
        argument_error.
          message.
            gsub("unknown keyword:", "unknown local:").
            gsub("missing keyword:", "missing local:").
            gsub("no keywords accepted", "no locals accepted").
            concat(" for #{@current_template.short_identifier}")
      )
    end
  else
    public_send(method, locals, buffer, &block)
  end
ensure
  @output_buffer, @virtual_path, @current_template = _old_output_buffer, _old_virtual_path, _old_template
end

#assign(new_assigns)

This method is for internal use only.

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 223


def assign(new_assigns) # :nodoc:
  @_assigns = new_assigns
  new_assigns.each { |key, value| instance_variable_set("@#{key}", value) }
end

#compiled_method_container

Raises:

(NotImplementedError)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 287


def compiled_method_container
  raise NotImplementedError, <<~msg.squish
    Subclasses of ActionView::Base must implement `compiled_method_container`
    or use the class method `with_empty_template_cache` for constructing
    an ActionView::Base subclass that has an empty cache.
  msg
end

#in_rendering_context(options)

[ GitHub ]

# File 'actionview/lib/action_view/base.rb', line 295


def in_rendering_context(options)
  old_view_renderer  = @view_renderer
  old_lookup_context = @lookup_context

  if !lookup_context.html_fallback_for_js && options[:formats]
    formats = Array(options[:formats])
    if formats == [:js]
      formats << :html
    end
    @lookup_context = lookup_context.with_prepended_formats(formats)
    @view_renderer = ActionView::Renderer.new @lookup_context
  end

  yield @view_renderer
ensure
  @view_renderer = old_view_renderer
  @lookup_context = old_lookup_context
end

Class: ActionView::Base

Overview

ERB

Using sub templates

Passing local variables to sub templates

Template caching

Builder

Constant Summary

::ERB::Util - Included

Helpers::AssetUrlHelper - Included

Helpers::TagHelper - Included

Helpers::AssetTagHelper - Included

Helpers::ContentExfiltrationPreventionHelper - Included

Helpers::ControllerHelper - Included

Helpers::DateHelper - Included

Helpers::UrlHelper - Included

RecordIdentifier - Included

Helpers::JavaScriptHelper - Included

Helpers::TranslationHelper - Included

Class Attribute Summary

Class Method Summary

Instance Attribute Summary

Helpers - Included

Helpers::TranslationHelper - Included

Helpers::FormHelper - Included

Helpers::FormTagHelper - Included

Helpers::SanitizeHelper - Included

Helpers::UrlHelper - Included

Helpers::ControllerHelper - Included

Helpers::ContentExfiltrationPreventionHelper - Included

Helpers::CacheHelper - Included

Helpers::AssetTagHelper - Included

Context - Included

Instance Method Summary

Helpers::TranslationHelper - Included

Helpers::RenderingHelper - Included

Helpers::NumberHelper - Included

Helpers::JavaScriptHelper - Included

Helpers::FormOptionsHelper - Included

Helpers::FormHelper - Included

RecordIdentifier - Included

ModelNaming - Included

Helpers::FormTagHelper - Included

Helpers::TextHelper - Included

Helpers::SanitizeHelper - Included

Helpers::UrlHelper - Included

Helpers::DebugHelper - Included

Helpers::DateHelper - Included

Helpers::CsrfHelper - Included

Helpers::CspHelper - Included

Helpers::ControllerHelper - Included

Helpers::ContentExfiltrationPreventionHelper - Included

Helpers::CacheHelper - Included

Helpers::AtomFeedHelper - Included

Helpers::AssetTagHelper - Included

Helpers::TagHelper - Included

Helpers::OutputSafetyHelper - Included

Helpers::CaptureHelper - Included

Helpers::AssetUrlHelper - Included

::ActiveSupport::Benchmarkable - Included

::ERB::Util - Included

::ActiveSupport::CoreExt::ERBUtil - Included

Context - Included

Constructor Details

.new(lookup_context, assigns, controller) ⇒ Base

Class Attribute Details

._routes (rw)

._routes? ⇒ Boolean (rw)

.annotate_rendered_view_with_filenames (rw) Also known as: #annotate_rendered_view_with_filenames

.automatically_disable_submit_tag (rw) Also known as: #automatically_disable_submit_tag

.cache_template_loading (rw)

.cache_template_loading=(value) (rw)

.default_formats (rw) Also known as: #default_formats

.field_error_proc (rw) Also known as: #field_error_proc

.logger (rw)

.logger? ⇒ Boolean (rw)

.prefix_partial_path_with_controller_namespace (rw)

.prefix_partial_path_with_controller_namespace? ⇒ Boolean (rw)

.streaming_completion_on_exception (rw) Also known as: #streaming_completion_on_exception

.xss_safe? ⇒ Boolean (readonly)

`::ERB::Util` - Included

`Helpers::AssetUrlHelper` - Included

`Helpers::TagHelper` - Included

`Helpers::AssetTagHelper` - Included

`Helpers::ContentExfiltrationPreventionHelper` - Included

`Helpers::ControllerHelper` - Included

`Helpers::DateHelper` - Included

`Helpers::UrlHelper` - Included

`RecordIdentifier` - Included

`Helpers::JavaScriptHelper` - Included

`Helpers::TranslationHelper` - Included

`Helpers` - Included

`Helpers::TranslationHelper` - Included

`Helpers::FormHelper` - Included

`Helpers::FormTagHelper` - Included

`Helpers::SanitizeHelper` - Included

`Helpers::UrlHelper` - Included

`Helpers::ControllerHelper` - Included

`Helpers::ContentExfiltrationPreventionHelper` - Included

`Helpers::CacheHelper` - Included

`Helpers::AssetTagHelper` - Included

`Context` - Included

`Helpers::TranslationHelper` - Included

`Helpers::RenderingHelper` - Included

`Helpers::NumberHelper` - Included

`Helpers::JavaScriptHelper` - Included

`Helpers::FormOptionsHelper` - Included

`Helpers::FormHelper` - Included

`RecordIdentifier` - Included

`ModelNaming` - Included

`Helpers::FormTagHelper` - Included

`Helpers::TextHelper` - Included

`Helpers::SanitizeHelper` - Included

`Helpers::UrlHelper` - Included

`Helpers::DebugHelper` - Included

`Helpers::DateHelper` - Included

`Helpers::CsrfHelper` - Included

`Helpers::CspHelper` - Included

`Helpers::ControllerHelper` - Included

`Helpers::ContentExfiltrationPreventionHelper` - Included

`Helpers::CacheHelper` - Included

`Helpers::AtomFeedHelper` - Included

`Helpers::AssetTagHelper` - Included

`Helpers::TagHelper` - Included

`Helpers::OutputSafetyHelper` - Included

`Helpers::CaptureHelper` - Included

`Helpers::AssetUrlHelper` - Included

`::ActiveSupport::Benchmarkable` - Included

`::ERB::Util` - Included

`::ActiveSupport::CoreExt::ERBUtil` - Included

`Context` - Included

.new(lookup_context, assigns, controller) ⇒ `Base`

._routes? ⇒ `Boolean` (rw)

.logger? ⇒ `Boolean` (rw)

.prefix_partial_path_with_controller_namespace? ⇒ `Boolean` (rw)

.xss_safe? ⇒ `Boolean` (readonly)

.changed?(other) ⇒ `Boolean`

#_routes? ⇒ `Boolean` (rw)

#logger? ⇒ `Boolean` (rw)

#prefix_partial_path_with_controller_namespace? ⇒ `Boolean` (rw)