rails--rails/actionview/CHANGELOG.md

268 lines
8.0 KiB
Markdown
Raw Normal View History

* Transforms a Hash into HTML Attributes, ready to be interpolated into ERB.
<input <%= tag.attributes(type: :text, aria: { label: "Search" }) %> >
# => <input type="text" aria-label="Search">
*Sean Doyle*
2020-11-02 21:12:47 +00:00
## Rails 6.1.0.rc1 (November 02, 2020) ##
* Yield translated strings to calls of `ActionView::FormBuilder#button`
when a block is given.
*Sean Doyle*
Yield `Tags::Label::LabelBuilder#translations` When translating a `<label>` element's contents, it is difficult (or "possible", yet undocumented) to make the translation text available to a block scope. For instance, when rendering a `rich_text_area`, passing the `aria-label` attribute might be important. Prior to this commit, doing so would require a double lookup of the translation key: ```erb <%# one time here, implicitly %> <%= form.label(:content) do %> <%= form.rich_text_area( :content, # one time here, explicitly "aria-label" => translate("helpers.label.post.content"), ) %> <% end %> ``` The current implementation of the `#label` helper method already yields an instance of `ActionView::Helpers::Tags::Label::LabelBuilder`, but that class is undocumented. Instance of that class respond to `#translation` calls, which will return the translated text content. By aliasing `#translation` to `#to_s`, we're able to expose that value without the burden of exposing an additional class to the public API. Instead, view-level interpolation (either `<%= %>`, `#{ }`, or direct calls to [`capture`][capture] will coerce the value to a String, and implicitly invoke `#translation`. The new view code might look something like this: ```erb <%= form.label(:content) do |label| %> <%= form.rich_text_area(:content, "aria-label" => label) %> <% end %> ``` Callers of the helper are still free to omit the block parameter. [capture]: https://api.rubyonrails.org/classes/ActionView/Helpers/CaptureHelper.html#method-i-capture
2020-02-22 06:45:00 +00:00
* Alias `ActionView::Helpers::Tags::Label::LabelBuilder#translation` to
`#to_s` so that `form.label` calls can yield that value to their blocks.
*Sean Doyle*
* Rename the new `TagHelper#class_names` method to `TagHelper#token_list`,
and make the original available as an alias.
token_list("foo", "foo bar")
# => "foo bar"
*Sean Doyle*
Serialize aria- namespaced list attributes Summary === Prior to this commit, calls passing `aria: { labelledby: [...] }` serialized the `aria-labelledby` Array value as JSON. This commit introduces special case logic to serialize `aria-` prefixed `TrueClass`, `FalseClass`, `Hash`, and `Array` values more appropriately. An element's [`aria-labelledby` attribute][aria-labelledby] and [`aria-describedby` attribute][aria-describedby] can accept a space-delimited list of identifier values (much like the [`class` attribute][class] accepts a space delimited [`DOMTokenList` value][DOMTokenList]). Similarly, there are [no boolean `aria-` attributes][aria-attributes] (only `true`, `false`, or undefined), so this commit serializes `true` to `"true"` and `false` to `"false"`. Testing --- This change moves an assertion _outside_ of a loop over `["aria", :aria]`. Prior to this change, the second assertion within the loop wasn't utilizing the iterated value as a Hash key. That is to say: `aria:` (where an `aria` local variable is declared) is not equivalent an equivalent syntax to `aria =>`. Since the migration to `**options` in response to Ruby 2.7 deprecations, invoking `tag.a("aria" => {...})` incorrectly coerces the `"aria" => {...}` has to be the `TagBuilder#a` method `content = nil` ordered argument, instead of its `options` keyword arguments. This commit does not modify that behavior, but it _does_ move the assertion outside the block so that it isn't run unnecessarily. [aria-labelledby]: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-labelledby_attribute [aria-describedby]: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-describedby_attribute [aria-attributes]: https://www.w3.org/TR/wai-aria-1.1/#propcharacteristic_value [class]: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/class [DOMTokenList]: https://developer.mozilla.org/en-US/docs/Web/API/DOMTokenList [class_names]: https://edgeapi.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html#method-i-class_names
2020-10-29 01:41:21 +00:00
* ARIA Array and Hash attributes are treated as space separated `DOMTokenList`
values. This is useful when declaring lists of label text identifiers in
`aria-labelledby` or `aria-describedby`.
tag.input type: 'checkbox', name: 'published', aria: {
invalid: @post.errors[:published].any?,
labelledby: ['published_context', 'published_label'],
describedby: { published_errors: @post.errors[:published].any? }
}
#=> <input
type="checkbox" name="published" aria-invalid="true"
aria-labelledby="published_context published_label"
aria-describedby="published_errors"
>
*Sean Doyle*
* Remove deprecated `escape_whitelist` from `ActionView::Template::Handlers::ERB`.
*Rafael Mendonça França*
* Remove deprecated `find_all_anywhere` from `ActionView::Resolver`.
*Rafael Mendonça França*
* Remove deprecated `formats` from `ActionView::Template::HTML`.
*Rafael Mendonça França*
* Remove deprecated `formats` from `ActionView::Template::RawFile`.
*Rafael Mendonça França*
* Remove deprecated `formats` from `ActionView::Template::Text`.
*Rafael Mendonça França*
* Remove deprecated `find_file` from `ActionView::PathSet`.
*Rafael Mendonça França*
* Remove deprecated `rendered_format` from `ActionView::LookupContext`.
*Rafael Mendonça França*
* Remove deprecated `find_file` from `ActionView::ViewPaths`.
*Rafael Mendonça França*
* Require that `ActionView::Base` subclasses implement `#compiled_method_container`.
*Rafael Mendonça França*
* Remove deprecated support to pass an object that is not a `ActionView::LookupContext` as the first argument
in `ActionView::Base#initialize`.
*Rafael Mendonça França*
* Remove deprecated `format` argument `ActionView::Base#initialize`.
*Rafael Mendonça França*
* Remove deprecated `ActionView::Template#refresh`.
*Rafael Mendonça França*
* Remove deprecated `ActionView::Template#original_encoding`.
*Rafael Mendonça França*
* Remove deprecated `ActionView::Template#variants`.
*Rafael Mendonça França*
* Remove deprecated `ActionView::Template#formats`.
*Rafael Mendonça França*
* Remove deprecated `ActionView::Template#virtual_path=`.
*Rafael Mendonça França*
* Remove deprecated `ActionView::Template#updated_at`.
*Rafael Mendonça França*
* Remove deprecated `updated_at` argument required on `ActionView::Template#initialize`.
*Rafael Mendonça França*
* Make `locals` argument required on `ActionView::Template#initialize`.
*Rafael Mendonça França*
* Remove deprecated `ActionView::Template.finalize_compiled_template_methods`.
*Rafael Mendonça França*
* Remove deprecated `config.action_view.finalize_compiled_template_methods`
*Rafael Mendonça França*
* Remove deprecated support to calling `ActionView::ViewPaths#with_fallback` with a block.
*Rafael Mendonça França*
* Remove deprecated support to passing absolute paths to `render template:`.
*Rafael Mendonça França*
* Remove deprecated support to passing relative paths to `render file:`.
*Rafael Mendonça França*
* Remove support to template handlers that don't accept two arguments.
*Rafael Mendonça França*
* Remove deprecated pattern argument in `ActionView::Template::PathResolver`.
*Rafael Mendonça França*
* Remove deprecated support to call private methods from object in some view helpers.
*Rafael Mendonça França*
* `ActionView::Helpers::TranslationHelper#translate` accepts a block, yielding
the translated text and the fully resolved translation key:
<%= translate(".relative_key") do |translation, resolved_key| %>
<span title="<%= resolved_key %>"><%= translation %></span>
<% end %>
*Sean Doyle*
Ensure cache fragment digests include all templates A Rails view may rely on several templates (e.g. layouts and partials) in addition to the template for the action being rendered (e.g. "show.html.erb"). To track which view file is currently being rendered for the purpose of generating template tree digests used in cache fragment keys, Action View uses a stack, the top item of which is accessed via the @current_template variable (introduced in 1581cab). Consider the following template: <!-- home.html.erb --> <%= render layout: "wrapper" do %> <%= cache "foo" %> HOME <%= end %> <%= end %> Inside the block passed to the render helper, @current_template corresponds to the wrapper.html.erb template instead of home.html.erb. As wrapper.html.erb is then used as the root node for generating the template tree digest used in the cache fragment key, the cache fragment fails to expire upon changes to home.html.erb. Additionally, should a second template use the wrapper.html.erb layout and contain a cache fragment with the same key, the cache fragment keys for both templates will be identical - causing cached content to "leak" from one view to another (as described in #38984). This commit skips adding templates to the stack when rendered as a layout with a block via the render helper, ensuring correct and unique cache fragment digests. Additionally, the virtual_path keyword arguments found in CacheHelper and all references to the are removed as they no longer possess any function. (Following the introduction of @current_template, virtual_path is accessed via @current_template.virtual_path rather than as a standalone variable.)
2020-04-24 21:29:00 +00:00
* Ensure cache fragment digests include all relevant template dependencies when
fragments are contained in a block passed to the render helper. Remove the
virtual_path keyword arguments found in CacheHelper as they no longer possess
any function following 1581cab.
2020-06-07 03:58:22 +00:00
Fixes #38984.
Ensure cache fragment digests include all templates A Rails view may rely on several templates (e.g. layouts and partials) in addition to the template for the action being rendered (e.g. "show.html.erb"). To track which view file is currently being rendered for the purpose of generating template tree digests used in cache fragment keys, Action View uses a stack, the top item of which is accessed via the @current_template variable (introduced in 1581cab). Consider the following template: <!-- home.html.erb --> <%= render layout: "wrapper" do %> <%= cache "foo" %> HOME <%= end %> <%= end %> Inside the block passed to the render helper, @current_template corresponds to the wrapper.html.erb template instead of home.html.erb. As wrapper.html.erb is then used as the root node for generating the template tree digest used in the cache fragment key, the cache fragment fails to expire upon changes to home.html.erb. Additionally, should a second template use the wrapper.html.erb layout and contain a cache fragment with the same key, the cache fragment keys for both templates will be identical - causing cached content to "leak" from one view to another (as described in #38984). This commit skips adding templates to the stack when rendered as a layout with a block via the render helper, ensuring correct and unique cache fragment digests. Additionally, the virtual_path keyword arguments found in CacheHelper and all references to the are removed as they no longer possess any function. (Following the introduction of @current_template, virtual_path is accessed via @current_template.virtual_path rather than as a standalone variable.)
2020-04-24 21:29:00 +00:00
*Aaron Lipman*
* Deprecate `config.action_view.raise_on_missing_translations` in favor of
`config.i18n.raise_on_missing_translations`.
New generalized configuration option now determines whether an error should be raised
for missing translations in controllers and views.
*fatkodima*
2020-06-07 03:58:22 +00:00
* Instrument layout rendering in `TemplateRenderer#render_with_layout` as `render_layout.action_view`,
and include (when necessary) the layout's virtual path in notification payloads for collection and partial renders.
*Zach Kemp*
* `ActionView::Base.annotate_rendered_view_with_filenames` annotates HTML output with template file names.
*Joel Hawksley*, *Aaron Patterson*
* `ActionView::Helpers::TranslationHelper#translate` returns nil when
passed `default: nil` without a translation matching `I18n#translate`.
*Stefan Wrobel*
* `OptimizedFileSystemResolver` prefers template details in order of locale,
formats, variants, handlers.
*Iago Pimenta*
* Added `class_names` helper to create a CSS class value with conditional classes.
*Joel Hawksley*, *Aaron Patterson*
* Add support for conditional values to TagBuilder.
*Joel Hawksley*
* `ActionView::Helpers::FormOptionsHelper#select` should mark option for `nil` as selected.
```ruby
@post = Post.new
@post.category = nil
# Before
select("post", "category", none: nil, programming: 1, economics: 2)
# =>
# <select name="post[category]" id="post_category">
# <option value="">none</option>
# <option value="1">programming</option>
# <option value="2">economics</option>
# </select>
# After
select("post", "category", none: nil, programming: 1, economics: 2)
# =>
# <select name="post[category]" id="post_category">
# <option selected="selected" value="">none</option>
# <option value="1">programming</option>
# <option value="2">economics</option>
# </select>
```
*bogdanvlviv*
* Log lines for partial renders and started template renders are now
emitted at the `DEBUG` level instead of `INFO`.
Completed template renders are still logged at the `INFO` level.
*DHH*
* ActionView::Helpers::SanitizeHelper: support rails-html-sanitizer 1.1.0.
*Juanito Fatas*
2019-11-24 00:20:00 +00:00
* Added `phone_to` helper method to create a link from mobile numbers.
*Pietro Moro*
* annotated_source_code returns an empty array so TemplateErrors without a
template in the backtrace are surfaced properly by DebugExceptions.
*Guilherme Mansur*, *Kasper Timm Hansen*
* Add autoload for SyntaxErrorInTemplate so syntax errors are correctly raised by DebugExceptions.
*Guilherme Mansur*, *Gannon McGibbon*
2019-11-24 00:20:00 +00:00
* `RenderingHelper` supports rendering objects that `respond_to?` `:render_in`.
*Joel Hawksley*, *Natasha Umer*, *Aaron Patterson*, *Shawn Allen*, *Emily Plummer*, *Diana Mounter*, *John Hawthorn*, *Nathan Herald*, *Zaid Zawaideh*, *Zach Ahn*
* Fix `select_tag` so that it doesn't change `options` when `include_blank` is present.
*Younes SERRAJ*
2019-04-24 19:57:14 +00:00
Please check [6-0-stable](https://github.com/rails/rails/blob/6-0-stable/actionview/CHANGELOG.md) for previous changes.