view_component 2.50.0 → 2.69.0

data/app/views/view_components/preview.html.erb

@@ -1,5 +1,5 @@
 <% if @render_args[:component] %>
-  <% if ViewComponent::Base.render_monkey_patch_enabled || Rails.version.to_f >= 6.1 %>
+  <% if ViewComponent::Base.config.render_monkey_patch_enabled || Rails.version.to_f >= 6.1 %>
     <%= render(@render_args[:component], @render_args[:args], &@render_args[:block]) %>
   <% else %>
     <%= render_component(@render_args[:component], &@render_args[:block]) %>
@@ -8,6 +8,6 @@
   <%= render template: @render_args[:template], locals: @render_args[:locals] || {} %>
 <% end %>
 
-<% if ViewComponent::Base.show_previews_source %>
+<% if ViewComponent::Base.config.show_previews_source %>
   <%= preview_source %>
 <% end %>

data/docs/CHANGELOG.md

@@ -3,10 +3,432 @@ layout: default
 title: Changelog
 ---
 
+<!-- Add unreleased changes under the "main" heading. -->
+
 # Changelog
 
+* Add missing `require` to fix `pvc` build.
+
+    *Joel Hawksley*
+
+* Add `config.view_component.use_consistent_rendering_lifecycle` to ensure side-effects in `content` are consistently evaluated before components are rendered. This change effectively means that `content` is evaluated for every component render where `render?` returns true. As a result, code that's passed to a component via a block/content will now always be evaluated, before `#call`, which can reveal bugs in existing components. This configuration option defaults to `false` but will be enabled in 3.0 and the old behavior will be removed.
+
+    *Blake Williams*
+
 ## main
 
+## 2.69.0
+
+* Update Prism to version 1.28.0.
+
+    *Thomas Hutterer*
+
+* Corrects the deprecation warning for named slots to show the file and line where the slot is called.
+
+    *River Bailey*
+
+## 2.68.0
+
+* Update `gemspec` author to be ViewComponent team.
+
+    *Joel Hawksley*
+
+* Fix bug where `ViewComponent::Compiler` wasn't required.
+
+    *Joel Hawksley*
+
+## 2.67.0
+
+* Use ViewComponent::Base.config as the internal endpoint for config.
+
+    *Simon Fish*
+
+* Fix bug where `#with_request_url`, when used with query string, set the incorrect `request.path` and `request.fullpath`.
+
+    *Franz Liedke*
+
+* Add link to [ViewComponentAttributes](https://github.com/amba-Health/view_component_attributes) in Resources section of docs.
+
+    *Romaric Pascal*
+
+* `render_preview` test helper is available by default. It is no longer necessary to include `ViewComponent::RenderPreviewHelper`.
+
+    *Joel Hawksley*
+
+## 2.66.0
+
+* Add missing `generate.sidecar`, `generate.stimulus_controller`, `generate.locale`, `generate.distinct_locale_files`, `generate.preview` config options to `config.view_component`.
+
+    *Simon Fish*
+
+## 2.65.0
+
+* Raise `ArgumentError` when conflicting Slots are defined.
+
+    Before this change it was possible to define Slots with conflicting names, for example:
+
+    ```ruby
+    class MyComponent < ViewComponent::Base
+      renders_one :item
+      renders_many :items
+    end
+    ```
+
+    *Joel Hawksley*
+
+## 2.64.0
+
+* Add `warn_on_deprecated_slot_setter` flag to opt-in to deprecation warning.
+
+    In [v2.54.0](https://viewcomponent.org/CHANGELOG.html#2540), the Slots API was updated to require the `with_*` prefix for setting Slots. The non-`with_*` setters will be deprecated in a coming version and removed in `v3.0`.
+
+    To enable the coming deprecation warning, add `warn_on_deprecated_slot_setter`:
+
+    ```ruby
+    class DeprecatedSlotsSetterComponent < ViewComponent::Base
+      warn_on_deprecated_slot_setter
+    end
+    ```
+
+    *Joel Hawksley*
+
+* Add [`m`](https://rubygems.org/gems/m) to development environment.
+
+    *Joel Hawksley*
+
+* Fix potential deadlock scenario in the compiler's development mode.
+
+    *Blake Williams*
+
+## 2.63.0
+
+* Fixed typo in `renders_many` documentation.
+
+    *Graham Rogers*
+
+* Add documentation about working with `turbo-rails`.
+
+    *Matheus Poli Camilo*
+
+* Fix issue causing helper methods to not be available in nested components when the render monkey patch is disabled and `render_component` is used.
+
+    *Daniel Scheffknecht*
+
+## 2.62.0
+
+* Remove the experimental global output buffer feature.
+* Restore functionality that used to attempt to compile templates on each call to `#render_in`.
+* Un-pin `rails` `main` dependency.
+
+    *Cameron Dutro*
+
+* Add blank space between "in" and "ViewComponent" in a deprecation warning.
+
+    *Vikram Dighe*
+
+* Add HappyCo to list of companies using ViewComponent.
+
+    *Josh Clayton*
+
+* Add predicate method support to polymorphic slots.
+
+    *Graham Rogers*
+
+## 2.61.1
+
+* Revert `Expose Capybara DSL methods directly inside tests.` This change unintentionally broke other Capybara methods and thus introduced a regression. We aren't confident that we can fail forward so we have decided to revert this change.
+
+    *Joel Hawksley*, *Blake Williams*
+
+* Revert change making content evaluation consistent.
+
+    *Blake Williams*
+
+* Pin `rails` `main` dependency due to incompatibility with Global Output Buffer.
+
+    *Joel Hawksley*
+
+## 2.61.0
+
+* Ensure side-effects in `content` are consistently evaluated before components are rendered. This change effectively means that `content` is evaluated for every component render where `render?` returns true. As a result, code that is passed to a component via a block/content will now always be evaluated, before `#call`, which can reveal bugs in existing components.
+
+    *Blake Williams*
+
+## 2.60.0
+
+* Add support for `render_preview` in RSpec tests.
+
+    *Thomas Hutterer*
+
+## 2.59.0
+
+* Expose Capybara DSL methods directly inside tests.
+
+    The following Capybara methods are now available directly without having to use the `page` method:
+
+  * [`all`](https://rubydoc.info/github/teamcapybara/capybara/Capybara%2FNode%2FFinders:all)
+  * [`first`](https://rubydoc.info/github/teamcapybara/capybara/Capybara%2FNode%2FFinders:first)
+  * [`text`](https://rubydoc.info/github/teamcapybara/capybara/Capybara%2FNode%2FSimple:text)
+  * [`find`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FFinders:find)
+  * [`find_all`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FFinders:find_all)
+  * [`find_button`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FFinders:find_button)
+  * [`find_by_id`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FFinders:find_by_id)
+  * [`find_field`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FFinders:find_field)
+  * [`find_link`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FFinders:find_link)
+  * [`has_content?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_content%3F)
+  * [`has_text?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_text%3F)
+  * [`has_css?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_css%3F)
+  * [`has_no_content?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_content%3F)
+  * [`has_no_text?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_text%3F)
+  * [`has_no_css?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_css%3F)
+  * [`has_no_xpath?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_xpath%3F)
+  * [`has_xpath?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_xpath%3F)
+  * [`has_link?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_link%3F)
+  * [`has_no_link?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_link%3F)
+  * [`has_button?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_button%3F)
+  * [`has_no_button?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_button%3F)
+  * [`has_field?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_field%3F)
+  * [`has_no_field?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_field%3F)
+  * [`has_checked_field?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_checked_field%3F)
+  * [`has_unchecked_field?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_unchecked_field%3F)
+  * [`has_no_table?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_table%3F)
+  * [`has_table?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_table%3F)
+  * [`has_select?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_select%3F)
+  * [`has_no_select?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_select%3F)
+  * [`has_selector?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_selector%3F)
+  * [`has_no_selector?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_selector%3F)
+  * [`has_no_checked_field?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_checked_field%3F)
+  * [`has_no_unchecked_field?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_unchecked_field%3F)
+
+* Add support for `within*` Capybara DLS methods:
+
+  * [`within`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FSession:within)
+  * [`within_element`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FSession:within)
+  * [`within_fieldset`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FSession:within_fieldset)
+  * [`within_table`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FSession:within_table)
+
+    *Jacob Carlborg*
+
+## 2.58.0
+
+* Switch to `standardrb`.
+
+    *Joel Hawksley*
+
+* Add BootrAils article to resources.
+
+    *Joel Hawksley*
+
+* Add @boardfish and @spone as maintainers.
+
+    *Joel Hawksley*, *Cameron Dutro*, *Blake Williams*
+
+* Re-compile updated, inherited templates when class caching is disabled.
+
+    *Patrick Arnett*
+
+* Add the latest version to the docs index.
+* Improve the docs: add the versions various features were introduced in.
+
+    *Hans Lemuet*
+
+* Update docs to reflect lack of block content support in controllers.
+
+    *Joel Hawksley*
+
+* Prevent adding duplicates to `autoload_paths`.
+
+    *Thomas Hutterer*
+
+* Add FreeAgent to list of companies using ViewComponent.
+
+    *Simon Fish*
+
+* Include polymorphic slots in `ViewComponent::Base` by default.
+
+    *Cameron Dutro*
+
+* Add per-component config option for stripping newlines from templates before compilation.
+
+    *Cameron Dutro*
+
+* Add link to article by Matouš Borák.
+
+    *Joel Hawksley*
+
+## 2.57.1
+
+* Fix issue causing `NoMethodError`s when calling helper methods from components rendered as part of a collection.
+* Fix syntax error in the ERB example in the polymorphic slots docs.
+
+    *Cameron Dutro*
+
+## 2.57.0
+
+* Add missing `require` for `Translatable` module in `Base`.
+
+    *Hans Lemuet*
+
+* Allow anything that responds to `#render_in` to be rendered in the parent component's view context.
+
+    *Cameron Dutro*
+
+* Fix script/release so it honors semver.
+
+    *Cameron Dutro*
+
+## 2.56.2
+
+* Restore removed `rendered_component`, marking it for deprecation in v3.0.0.
+
+    *Tyson Gach*, *Richard Macklin*, *Joel Hawksley*
+
+## 2.56.1
+
+* Rename private accessor `rendered_component` to `rendered_content`.
+
+    *Yoshiyuki Hirano*, *Simon Dawson*
+
+## 2.56.0
+
+* Introduce experimental `render_preview` test helper. Note: `@rendered_component` in `TestHelpers` has been renamed to `@rendered_content`.
+
+    *Joel Hawksley*
+
+* Move framework tests into sandbox application.
+
+    *Joel Hawksley*
+
+* Add G2 to list of companies that use ViewComponent.
+
+    *Jack Shuff*
+
+* Add Within3 to list of companies that use ViewComponent.
+
+    *Drew Bragg*
+
+* Add Mission Met to list of companies that use ViewComponent.
+
+    *Nick Smith*
+
+* Fix `#with_request_url` test helper not parsing nested query parameters into nested hashes.
+
+    *Richard Marbach*
+
+## 2.55.0
+
+* Add `render_parent` convenience method to avoid confusion between `<%= super %>` and `<% super %>` in template code.
+
+    *Cameron Dutro*
+
+* Add note about discouraging inheritance.
+
+    *Joel Hawksley*
+
+* Clean up grammar in documentation.
+
+    *Joel Hawksley*
+
+* The ViewComponent team at GitHub is hiring! We're looking for a Rails engineer with accessibility experience: [https://boards.greenhouse.io/github/jobs/4020166](https://boards.greenhouse.io/github/jobs/4020166). Reach out to joelhawksley@github.com with any questions!
+
+* The ViewComponent team is hosting a happy hour at RailsConf. Join us for snacks, drinks, and stickers: [https://www.eventbrite.com/e/viewcomponent-happy-hour-tickets-304168585427](https://www.eventbrite.com/e/viewcomponent-happy-hour-tickets-304168585427)
+
+## 2.54.1
+
+* Update docs dependencies.
+
+    *Joel Hawksley*
+
+* Resolve warning in slots API.
+* Raise in the test environment when ViewComponent code emits a warning.
+
+    *Blake Williams*
+
+## 2.54.0
+
+* Add `with_*` slot API for defining slots. Note: we plan to deprecate the non `with_*` API for slots in an upcoming release.
+
+    *Blake Williams*
+
+* Add QuickNode to list of companies that use ViewComponent.
+
+    *Luc Castera*
+
+* Include the `Translatable` module by default.
+
+    *Elia Schito*
+
+* Update docs dependencies.
+
+    *Joel Hawksley*
+
+## 2.53.0
+
+* Add support for relative I18n scopes to translations.
+
+    *Elia Schito*
+
+* Update CI configuration to use latest Rails 7.0.
+
+    *Hans Lemuet*
+
+* Document how to use blocks with lambda slots.
+
+    *Sam Partington*
+
+* Skip Rails 5.2 in local test environment if using incompatible Ruby version.
+
+    *Cameron Dutro*, *Blake Williams*, *Joel Hawksley*
+
+* Improve landing page documentation.
+
+    *Jason Swett*
+
+* Add Bearer to list of companies that use ViewComponent.
+
+    *Yaroslav Shmarov*
+
+* Add articles to resources page.
+
+    *Joel Hawksley*
+
+* Enable rendering arbitrary block contents in the view context in tests.
+
+    *Cameron Dutro*
+
+## 2.52.0
+
+* Add ADR for separate slot getter/setter API.
+
+    *Blake Williams*
+
+* Add the option to use a "global" output buffer so `form_for` and friends can be used with view components.
+
+    *Cameron Dutro*, *Blake Williams*
+
+* Fix fragment caching in partials when global output buffer is enabled.
+* Fix template inheritance when eager loading is disabled.
+
+    *Cameron Dutro*
+
+## 2.51.0
+
+* Update the docs only when releasing a new version.
+
+    *Hans Lemuet*
+
+* Alphabetize companies using ViewComponent and add Brightline to the list.
+
+    *Jack Schuss*
+
+* Add CMYK value for ViewComponent Red color on logo page.
+
+    *Dylan Smith*
+
+* Improve performance by moving template compilation from `#render_in` to `#render_template_for`.
+
+    *Cameron Dutro*
+
 ## 2.50.0
 
 * Add tests for `layout` usage when rendering via controller.
@@ -91,10 +513,14 @@ title: Changelog
 
     *Joel Hawksley*
 
-* Add Ruby 3.1 and Rails 7.0 to CI
+* Add Ruby 3.1 and Rails 7.0 to CI.
 
     *Peter Goldstein*
 
+* Move preview logic to module for easier app integration.
+
+    *Sammy Henningsson*
+
 ## 2.48.0
 
 * Correct path in example test command in Contributing docs.

data/lib/rails/generators/abstract_generator.rb

@@ -3,9 +3,7 @@
 module ViewComponent
   module AbstractGenerator
     def copy_view_file
-      unless options["inline"]
-        template "component.html.#{engine_name}", destination
-      end
+      template "component.html.#{engine_name}", destination unless options["inline"]
     end
 
     private
@@ -31,20 +29,20 @@ module ViewComponent
     end
 
     def component_path
-      ViewComponent::Base.view_component_path
+      ViewComponent::Base.config.view_component_path
     end
 
     def stimulus_controller
       if options["stimulus"]
-        File.join(destination_directory, destination_file_name).
-          sub("#{component_path}/", "").
-          gsub("_", "-").
-          gsub("/", "--")
+        File.join(destination_directory, destination_file_name)
+          .sub("#{component_path}/", "")
+          .tr("_", "-")
+          .gsub("/", "--")
       end
     end
 
     def sidecar?
-      options["sidecar"] || ViewComponent::Base.generate.sidecar
+      options["sidecar"] || ViewComponent::Base.config.generate.sidecar
     end
   end
 end

data/lib/rails/generators/component/component_generator.rb

@@ -13,11 +13,12 @@ module Rails
       check_class_collision suffix: "Component"
 
       class_option :inline, type: :boolean, default: false
-      class_option :locale, type: :boolean, default: ViewComponent::Base.generate.locale
+      class_option :locale, type: :boolean, default: ViewComponent::Base.config.generate.locale
       class_option :parent, type: :string, desc: "The parent class for the generated component"
-      class_option :preview, type: :boolean, default: ViewComponent::Base.generate.preview
+      class_option :preview, type: :boolean, default: ViewComponent::Base.config.generate.preview
       class_option :sidecar, type: :boolean, default: false
-      class_option :stimulus, type: :boolean, default: ViewComponent::Base.generate.stimulus_controller
+      class_option :stimulus, type: :boolean,
+        default: ViewComponent::Base.config.generate.stimulus_controller
 
       def create_component_file
         template "component.rb", File.join(component_path, class_path, "#{file_name}_component.rb")
@@ -40,7 +41,7 @@ module Rails
       def parent_class
         return options[:parent] if options[:parent]
 
-        ViewComponent::Base.component_parent_class || default_parent_class
+        ViewComponent::Base.config.component_parent_class || default_parent_class
       end
 
       def initialize_signature

data/lib/rails/generators/locale/component_generator.rb

@@ -12,7 +12,7 @@ module Locale
       class_option :sidecar, type: :boolean, default: false
 
       def create_locale_file
-        if ViewComponent::Base.generate.distinct_locale_files
+        if ViewComponent::Base.config.generate.distinct_locale_files
           I18n.available_locales.each do |locale|
             create_file destination(locale), translations_hash([locale]).to_yaml
           end

data/lib/rails/generators/preview/component_generator.rb

@@ -9,7 +9,7 @@ module Preview
       check_class_collision suffix: "ComponentPreview"
 
       def create_preview_file
-        preview_paths = Rails.application.config.view_component.preview_paths
+        preview_paths = ViewComponent::Base.config.preview_paths
         return if preview_paths.count > 1
 
         path_prefix = preview_paths.one? ? preview_paths.first : "test/components/previews"