view_component 2.57.1 → 2.59.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c0dea17d60642f97d9edad061c538054015eac0f774bc58d37ba30c177a76ac
-  data.tar.gz: bb12f7080b7c90ab0e475550bf44577ef25d2b1e0d0966cc5f07c272d9ea5fec
+  metadata.gz: ca82494216cd6b91d9a073bd1ab025cbe48049560893a500e72caff01141e02f
+  data.tar.gz: 9eecd79663f09edb31cae5a104b861c4922a99a92307f583b0703b11053a2d60
 SHA512:
-  metadata.gz: 3eb53d5be8bdb0ab083f0c57938bda3df2094c6368619efb59254bd8ce6a749ffcd4d1dab653b80be48a17f361fa15611c9086c2a526891d81e92527ffd67c9d
-  data.tar.gz: 418af4138439260637f53b025de631a11f222a699030afe36d3b51b7a31c5f451e7d3eb2ec5c6d13fa39b9b44e12e27fae972b631c92133bfbf054079695b80d
+  metadata.gz: 4e04336d18bd57be41e3ae4637ae1978a4884a352fced4b852a40901fa1ff02a13e6266ab4c669fbb3669fa718eecbfd8a5b13c54df79cbb9b692e278f02f35e
+  data.tar.gz: 2fed6153f148f683afe4cd27c909051aedfc92e9f896e6fe41736083d05217e7df15ac12799291fd2299ca59c1ee12e7ec1145ac9be5ee78cacb81d55fccf548

data/app/controllers/concerns/view_component/preview_actions.rb

@@ -37,21 +37,24 @@ module ViewComponent
         opts = {}
         opts[:layout] = layout if layout.present? || layout == false
         opts[:locals] = locals if locals.present?
-        render "view_components/preview", opts # rubocop:disable GitHub/RailsControllerRenderLiteral
+        render "view_components/preview", opts
       end
     end
 
     private
 
-    def default_preview_layout # :doc:
+    # :doc:
+    def default_preview_layout
       ViewComponent::Base.default_preview_layout
     end
 
-    def show_previews? # :doc:
+    # :doc:
+    def show_previews?
       ViewComponent::Base.show_previews
     end
 
-    def find_preview # :doc:
+    # :doc:
+    def find_preview
       candidates = []
       params[:path].to_s.scan(%r{/|$}) { candidates << $` }
       preview = candidates.detect { |candidate| ViewComponent::Preview.exists?(candidate) }

data/app/helpers/preview_helper.rb

@@ -7,14 +7,14 @@ module PreviewHelper
   def preview_source
     return if @render_args.nil?
 
-    render "preview_source" # rubocop:disable GitHub/RailsViewRenderPathsExist
+    render "preview_source"
   end
 
   def find_template_data(lookup_context:, template_identifier:)
     template = lookup_context.find_template(template_identifier)
 
     if Rails.version.to_f >= 6.1 || template.source.present?
-      return {
+      {
         source: template.source,
         prism_language_name: prism_language_name_by_template(template: template)
       }
@@ -40,7 +40,7 @@ module PreviewHelper
       template_source = File.read(template_file_path)
       prism_language_name = prism_language_name_by_template_path(template_file_path: template_file_path)
 
-      return {
+      {
         source: template_source,
         prism_language_name: prism_language_name
       }

data/docs/CHANGELOG.md

@@ -9,6 +9,102 @@ title: Changelog
 
 ## main
 
+## 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.

data/lib/rails/generators/abstract_generator.rb

@@ -36,10 +36,10 @@ module ViewComponent
 
     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
 

data/lib/view_component/base.rb

@@ -16,6 +16,7 @@ module ViewComponent
   class Base < ActionView::Base
     include ActiveSupport::Configurable
     include ViewComponent::ContentAreas
+    include ViewComponent::PolymorphicSlots
     include ViewComponent::Previewable
     include ViewComponent::SlotableV2
     include ViewComponent::Translatable
@@ -31,6 +32,10 @@ module ViewComponent
     class_attribute :content_areas
     self.content_areas = [] # class_attribute:default doesn't work until Rails 5.2
 
+    # Config option that strips trailing whitespace in templates before compiling them.
+    class_attribute :__vc_strip_trailing_whitespace, instance_accessor: false, instance_predicate: false
+    self.__vc_strip_trailing_whitespace = false # class_attribute:default doesn't work until Rails 5.2
+
     attr_accessor :__vc_original_view_context
 
     # Components render in their own view context. Helpers and other functionality
@@ -135,8 +140,10 @@ module ViewComponent
     # Subclass components that call `super` inside their template code will cause a
     # double render if they emit the result:
     #
-    #     <%= super %> # double-renders
-    #     <% super %> # does not double-render
+    # ```erb
+    # <%= super %> # double-renders
+    # <% super %> # does not double-render
+    # ```
     #
     # Calls `super`, returning `nil` to avoid rendering the result twice.
     def render_parent
@@ -187,7 +194,8 @@ module ViewComponent
     end
 
     # @private
-    def initialize(*); end
+    def initialize(*)
+    end
 
     # Re-use original view_context if we're not rendering a component.
     #
@@ -315,7 +323,9 @@ module ViewComponent
 
     # Set the controller used for testing components:
     #
-    #     config.view_component.test_controller = "MyTestController"
+    # ```ruby
+    # config.view_component.test_controller = "MyTestController"
+    # ```
     #
     # Defaults to ApplicationController. Can also be configured on a per-test
     # basis using `with_controller_class`.
@@ -325,13 +335,17 @@ module ViewComponent
 
     # Set if render monkey patches should be included or not in Rails <6.1:
     #
-    #     config.view_component.render_monkey_patch_enabled = false
+    # ```ruby
+    # config.view_component.render_monkey_patch_enabled = false
+    # ```
     #
     mattr_accessor :render_monkey_patch_enabled, instance_writer: false, default: true
 
     # Path for component files
     #
-    #     config.view_component.view_component_path = "app/my_components"
+    # ```ruby
+    # config.view_component.view_component_path = "app/my_components"
+    # ```
     #
     # Defaults to `app/components`.
     #
@@ -339,7 +353,9 @@ module ViewComponent
 
     # Parent class for generated components
     #
-    #     config.view_component.component_parent_class = "MyBaseComponent"
+    # ```ruby
+    # config.view_component.component_parent_class = "MyBaseComponent"
+    # ```
     #
     # Defaults to nil. If this is falsy, generators will use
     # "ApplicationComponent" if defined, "ViewComponent::Base" otherwise.
@@ -355,25 +371,33 @@ module ViewComponent
     #
     # Always generate a component with a sidecar directory:
     #
-    #     config.view_component.generate.sidecar = true
+    # ```ruby
+    # config.view_component.generate.sidecar = true
+    # ```
     #
     # #### #stimulus_controller
     #
     # Always generate a Stimulus controller alongside the component:
     #
-    #     config.view_component.generate.stimulus_controller = true
+    # ```ruby
+    # config.view_component.generate.stimulus_controller = true
+    # ```
     #
     # #### #locale
     #
     # Always generate translations file alongside the component:
     #
-    #     config.view_component.generate.locale = true
+    # ```ruby
+    # config.view_component.generate.locale = true
+    # ```
     #
     # #### #distinct_locale_files
     #
     # Always generate as many translations files as available locales:
     #
-    #     config.view_component.generate.distinct_locale_files = true
+    # ```ruby
+    # config.view_component.generate.distinct_locale_files = true
+    # ```
     #
     # One file will be generated for each configured `I18n.available_locales`,
     # falling back to `[:en]` when no `available_locales` is defined.
@@ -382,7 +406,9 @@ module ViewComponent
     #
     # Always generate preview alongside the component:
     #
-    #      config.view_component.generate.preview = true
+    # ```ruby
+    # config.view_component.generate.preview = true
+    # ```
     #
     #  Defaults to `false`.
     mattr_accessor :generate, instance_writer: false, default: ActiveSupport::OrderedOptions.new(false)
@@ -436,7 +462,9 @@ module ViewComponent
 
       # Render a component for each element in a collection ([documentation](/guide/collections)):
       #
-      #     render(ProductsComponent.with_collection(@products, foo: :bar))
+      # ```ruby
+      # render(ProductsComponent.with_collection(@products, foo: :bar))
+      # ```
       #
       # @param collection [Enumerable] A list of items to pass the ViewComponent one at a time.
       # @param args [Arguments] Arguments to pass to the ViewComponent every time.
@@ -532,13 +560,35 @@ module ViewComponent
 
       # Set the parameter name used when rendering elements of a collection ([documentation](/guide/collections)):
       #
-      #     with_collection_parameter :item
+      # ```ruby
+      # with_collection_parameter :item
+      # ```
       #
       # @param parameter [Symbol] The parameter name used when rendering elements of a collection.
       def with_collection_parameter(parameter)
         @provided_collection_parameter = parameter
       end
 
+      # Strips trailing whitespace from templates before compiling them.
+      #
+      # ```ruby
+      # class MyComponent < ViewComponent::Base
+      #   strip_trailing_whitespace
+      # end
+      # ```
+      #
+      # @param value [Boolean] Whether or not to strip newlines.
+      def strip_trailing_whitespace(value = true)
+        self.__vc_strip_trailing_whitespace = value
+      end
+
+      # Whether trailing whitespace will be stripped before compilation.
+      #
+      # @return [Boolean]
+      def strip_trailing_whitespace?
+        __vc_strip_trailing_whitespace
+      end
+
       # Ensure the component initializer accepts the
       # collection parameter. By default, we don't
       # validate that the default parameter name
@@ -586,11 +636,7 @@ module ViewComponent
 
       # @private
       def collection_parameter
-        if provided_collection_parameter
-          provided_collection_parameter
-        else
-          name && name.demodulize.underscore.chomp("_component").to_sym
-        end
+        provided_collection_parameter || name && name.demodulize.underscore.chomp("_component").to_sym
       end
 
       # @private

data/lib/view_component/capybara_simple_session.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  # This is a simpler version of {Capybara::Session}.
+  #
+  # It only includes {Capybara::Node::Finders}, {Capybara::Node::Matchers},
+  # {#within} and {#within_element}. It is useful in that it does not require a
+  # session, an application or a driver, but can still use Capybara's finders
+  # and matchers on any string that contains HTML.
+  class CapybaraSimpleSession
+    # Most of the code in this class is shamelessly stolen from the
+    # {Capybara::Session} class in the Capybara gem
+    # (https://github.com/teamcapybara/capybara/blob/e704d00879fb1d1e1a0cc01e04c101bcd8af4a68/lib/capybara/session.rb#L38).
+
+    NODE_METHODS = %i[
+      all
+      first
+      text
+
+      find
+      find_all
+      find_button
+      find_by_id
+      find_field
+      find_link
+
+      has_content?
+      has_text?
+      has_css?
+      has_no_content?
+      has_no_text?
+      has_no_css?
+      has_no_xpath?
+      has_xpath?
+      has_link?
+      has_no_link?
+      has_button?
+      has_no_button?
+      has_field?
+      has_no_field?
+      has_checked_field?
+      has_unchecked_field?
+      has_no_table?
+      has_table?
+      has_select?
+      has_no_select?
+      has_selector?
+      has_no_selector?
+      has_no_checked_field?
+      has_no_unchecked_field?
+
+      assert_selector
+      assert_no_selector
+      assert_all_of_selectors
+      assert_none_of_selectors
+      assert_any_of_selectors
+      assert_text
+      assert_no_text
+    ].freeze
+
+    private_constant :NODE_METHODS
+
+    SESSION_METHODS = %i[within within_element within_fieldset within_table].freeze
+
+    private_constant :SESSION_METHODS
+
+    DSL_METHODS = (NODE_METHODS + SESSION_METHODS).freeze
+
+    # Stolen from: https://github.com/teamcapybara/capybara/blob/e704d00879fb1d1e1a0cc01e04c101bcd8af4a68/lib/capybara/session.rb#L767-L774.
+    NODE_METHODS.each do |method|
+      if RUBY_VERSION >= "2.7"
+        class_eval <<~METHOD, __FILE__, __LINE__ + 1
+          def #{method}(...)
+            current_scope.#{method}(...)
+          end
+        METHOD
+      else
+        define_method method do |*args, &block|
+          current_scope.send(method, *args, &block)
+        end
+      end
+    end
+
+    # Initializes the receiver with the given string of HTML.
+    #
+    # @param html [String] the HTML to create the session out of
+    def initialize(html)
+      @document = Capybara::Node::Simple.new(html)
+    end
+
+    # (see Capybara::Session#within)
+    def within(*args, **kw_args)
+      new_scope = args.first.respond_to?(:to_capybara_node) ? args.first.to_capybara_node : find(*args, **kw_args)
+      begin
+        scopes.push(new_scope)
+        yield if block_given?
+      ensure
+        scopes.pop
+      end
+    end
+
+    # (see Capybara::Session#within_element)
+    alias_method :within_element, :within
+
+    # (see Capybara::Session#within_fieldset)
+    def within_fieldset(locator, &block)
+      within(:fieldset, locator, &block)
+    end
+
+    # (see Capybara::Session#within_table)
+    def within_table(locator, &block)
+      within(:table, locator, &block)
+    end
+
+    # (see Capybara::Node::Element#native)
+    def native
+      current_scope.native
+    end
+
+    private
+
+    attr_reader :document
+
+    def scopes
+      @scopes ||= [nil]
+    end
+
+    def current_scope
+      scopes.last.presence || document
+    end
+  end
+end

data/lib/view_component/collection.rb

@@ -18,9 +18,9 @@ module ViewComponent
 
     def render_in(view_context, &block)
       components.map do |component|
-        component.set_original_view_context(self.__vc_original_view_context)
+        component.set_original_view_context(__vc_original_view_context)
         component.render_in(view_context, &block)
-      end.join.html_safe # rubocop:disable Rails/OutputSafety
+      end.join.html_safe
     end
 
     def components
@@ -61,7 +61,7 @@ module ViewComponent
     end
 
     def component_options(item, iterator)
-      item_options = { component.collection_parameter => item }
+      item_options = {component.collection_parameter => item}
       item_options[component.collection_counter_parameter] = iterator.index + 1 if component.counter_argument_present?
       item_options[component.collection_iteration_parameter] = iterator.dup if component.iteration_argument_present?
 

data/lib/view_component/compiler.rb

@@ -31,6 +31,8 @@ module ViewComponent
       return if compiled? && !force
       return if component_class == ViewComponent::Base
 
+      component_class.superclass.compile(raise_errors: raise_errors) if should_compile_superclass?
+
       with_lock do
         subclass_instance_methods = component_class.instance_methods(false)
 
@@ -68,11 +70,13 @@ module ViewComponent
             component_class.send(:remove_method, method_name.to_sym)
           end
 
+          # rubocop:disable Style/EvalWithLocation
           component_class.class_eval <<-RUBY, template[:path], 0
           def #{method_name}
             #{compiled_template(template[:path])}
           end
           RUBY
+          # rubocop:enable Style/EvalWithLocation
         end
 
         define_render_template_for
@@ -151,15 +155,15 @@ module ViewComponent
           end
 
           invalid_variants =
-            templates.
-            group_by { |template| template[:variant] }.
-            map { |variant, grouped| variant if grouped.length > 1 }.
-            compact.
-            sort
+            templates
+              .group_by { |template| template[:variant] }
+              .map { |variant, grouped| variant if grouped.length > 1 }
+              .compact
+              .sort
 
           unless invalid_variants.empty?
             errors <<
-              "More than one template found for #{'variant'.pluralize(invalid_variants.count)} " \
+              "More than one template found for #{"variant".pluralize(invalid_variants.count)} " \
               "#{invalid_variants.map { |v| "'#{v}'" }.to_sentence} in #{component_class}. " \
               "There can only be one template file per variant."
           end
@@ -177,8 +181,8 @@ module ViewComponent
             count = duplicate_template_file_and_inline_variant_calls.count
 
             errors <<
-              "Template #{'file'.pluralize(count)} and inline render #{'method'.pluralize(count)} " \
-              "found for #{'variant'.pluralize(count)} " \
+              "Template #{"file".pluralize(count)} and inline render #{"method".pluralize(count)} " \
+              "found for #{"variant".pluralize(count)} " \
               "#{duplicate_template_file_and_inline_variant_calls.map { |v| "'#{v}'" }.to_sentence} " \
               "in #{component_class}. " \
               "There can only be a template file or inline render method per variant."
@@ -236,8 +240,9 @@ module ViewComponent
     end
 
     def compiled_template(file_path)
-      handler = ActionView::Template.handler_for_extension(File.extname(file_path).gsub(".", ""))
+      handler = ActionView::Template.handler_for_extension(File.extname(file_path).delete("."))
       template = File.read(file_path)
+      template.rstrip! if component_class.strip_trailing_whitespace?
 
       if handler.method(:call).parameters.length > 1
         handler.call(component_class, template)
@@ -259,5 +264,14 @@ module ViewComponent
         "call"
       end
     end
+
+    def should_compile_superclass?
+      development? &&
+        templates.empty? &&
+        !(
+          component_class.instance_methods(false).include?(:call) ||
+            component_class.private_instance_methods(false).include?(:call)
+        )
+    end
   end
 end

data/lib/view_component/content_areas.rb

@@ -21,7 +21,7 @@ module ViewComponent
         )
       end
 
-      if block_given?
+      if block
         content = view_context.capture(&block)
       end
 

data/lib/view_component/docs_builder_component.rb

@@ -28,7 +28,7 @@ module ViewComponent
       end
 
       def types
-        " → [#{@method.tag(:return).types.join(',')}]" if @method.tag(:return)&.types && show_types?
+        " → [#{@method.tag(:return).types.join(",")}]" if @method.tag(:return)&.types && show_types?
       end
 
       def signature_or_name

data/lib/view_component/engine.rb

@@ -77,7 +77,8 @@ module ViewComponent
       options = app.config.view_component
 
       if options.show_previews && !options.preview_paths.empty?
-        ActiveSupport::Dependencies.autoload_paths.concat(options.preview_paths)
+        paths_to_add = options.preview_paths - ActiveSupport::Dependencies.autoload_paths
+        ActiveSupport::Dependencies.autoload_paths.concat(paths_to_add) if paths_to_add.any?
       end
     end
 
@@ -133,10 +134,10 @@ module ViewComponent
 
     initializer "compiler mode" do |app|
       ViewComponent::Compiler.mode = if Rails.env.development? || Rails.env.test?
-                                       ViewComponent::Compiler::DEVELOPMENT_MODE
-                                     else
-                                       ViewComponent::Compiler::PRODUCTION_MODE
-                                     end
+        ViewComponent::Compiler::DEVELOPMENT_MODE
+      else
+        ViewComponent::Compiler::PRODUCTION_MODE
+      end
     end
 
     config.after_initialize do |app|

data/lib/view_component/global_output_buffer.rb

@@ -34,13 +34,14 @@ module ViewComponent
     def with_output_buffer(buf = nil)
       unless buf
         buf = ActionView::OutputBuffer.new
+        # rubocop:disable Style/SafeNavigation
         if output_buffer && output_buffer.respond_to?(:encoding)
           buf.force_encoding(output_buffer.encoding)
         end
+        # rubocop:enable Style/SafeNavigation
       end
 
       output_buffer.push(buf)
-      result = nil
 
       begin
         yield
@@ -65,13 +66,13 @@ module ViewComponent
       def with_output_buffer(buf = nil)
         unless buf
           buf = ActionView::OutputBuffer.new
+          # rubocop:disable Style/SafeNavigation
           if @output_buffer && @output_buffer.respond_to?(:encoding)
             buf.force_encoding(@output_buffer.encoding)
           end
+          # rubocop:enable Style/SafeNavigation
         end
 
-        result = nil
-
         if @output_buffer.is_a?(OutputBufferStack)
           @output_buffer.push(buf)
 

data/lib/view_component/output_buffer_stack.rb

@@ -37,9 +37,7 @@ module ViewComponent
     end
 
     def safe_concat(arg)
-      # rubocop:disable Rails/OutputSafety
       @current_buffer.safe_concat(arg)
-      # rubocop:enable Rails/OutputSafety
     end
 
     def length

data/lib/view_component/polymorphic_slots.rb

@@ -5,6 +5,17 @@ module ViewComponent
     # In older rails versions, using a concern isn't a good idea here because they appear to not work with
     # Module#prepend and class methods.
     def self.included(base)
+      if base != ViewComponent::Base
+        # :nocov:
+        location = Kernel.caller_locations(1, 1)[0]
+
+        warn(
+          "warning: ViewComponent::PolymorphicSlots is now included in ViewComponent::Base by default "\
+          "and can be removed from #{location.path}:#{location.lineno}"
+        )
+        # :nocov:
+      end
+
       base.singleton_class.prepend(ClassMethods)
       base.include(InstanceMethods)
     end
@@ -45,8 +56,12 @@ module ViewComponent
               "#{slot_name}_#{poly_type}"
             end
 
-          # Deprecated: Will be removed in 3.0
           define_method(setter_name) do |*args, &block|
+            ViewComponent::Deprecation.warn(
+              "polymorphic slot setters like `#{setter_name}` are deprecated and will be removed in"\
+              "ViewComponent v3.0.0.\n\nUse `with_#{setter_name}` instead."
+            )
+
             set_polymorphic_slot(slot_name, poly_type, *args, &block)
           end
           ruby2_keywords(setter_name.to_sym) if respond_to?(:ruby2_keywords, true)
@@ -57,7 +72,7 @@ module ViewComponent
           ruby2_keywords(:"with_#{setter_name}") if respond_to?(:ruby2_keywords, true)
         end
 
-        self.registered_slots[slot_name] = {
+        registered_slots[slot_name] = {
           collection: collection,
           renderable_hash: renderable_hash
         }

data/lib/view_component/preview.rb

@@ -14,7 +14,7 @@ module ViewComponent # :nodoc:
         block: block,
         component: component,
         locals: {},
-        template: "view_components/preview",
+        template: "view_components/preview"
       }
     end
 
@@ -66,10 +66,12 @@ module ViewComponent # :nodoc:
         name.chomp("Preview").underscore
       end
 
+      # rubocop:disable Style/TrivialAccessors
       # Setter for layout name.
       def layout(layout_name)
         @layout = layout_name
       end
+      # rubocop:enable Style/TrivialAccessors
 
       # Returns the relative path (from preview_path) to the preview example template if the template exists
       def preview_example_template_path(example)
@@ -87,15 +89,15 @@ module ViewComponent # :nodoc:
         end
 
         path = Dir["#{preview_path}/#{preview_name}_preview/#{example}.html.*"].first
-        Pathname.new(path).
-          relative_path_from(Pathname.new(preview_path)).
-          to_s.
-          sub(/\..*$/, "")
+        Pathname.new(path)
+          .relative_path_from(Pathname.new(preview_path))
+          .to_s
+          .sub(/\..*$/, "")
       end
 
       # Returns the method body for the example from the preview file.
       def preview_source(example)
-        source = self.instance_method(example.to_sym).source.split("\n")
+        source = instance_method(example.to_sym).source.split("\n")
         source[1...(source.size - 1)].join("\n")
       end
 

data/lib/view_component/render_component_to_string_helper.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module RenderComponentToStringHelper # :nodoc:
     def render_component_to_string(component)
-      component.render_in(self.view_context)
+      component.render_in(view_context)
     end
   end
 end

data/lib/view_component/render_to_string_monkey_patch.rb

@@ -4,7 +4,7 @@ module ViewComponent
   module RenderToStringMonkeyPatch # :nodoc:
     def render_to_string(options = {}, args = {})
       if options.respond_to?(:render_in)
-        options.render_in(self.view_context)
+        options.render_in(view_context)
       else
         super
       end

data/lib/view_component/rendering_component_helper.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module RenderingComponentHelper # :nodoc:
     def render_component(component)
-      self.response_body = component.render_in(self.view_context)
+      self.response_body = component.render_in(view_context)
     end
   end
 end

data/lib/view_component/rendering_monkey_patch.rb

@@ -4,7 +4,7 @@ module ViewComponent
   module RenderingMonkeyPatch # :nodoc:
     def render(options = {}, args = {})
       if options.respond_to?(:render_in)
-        self.response_body = options.render_in(self.view_context)
+        self.response_body = options.render_in(view_context)
       else
         super
       end

data/lib/view_component/slotable.rb

@@ -30,7 +30,7 @@ module ViewComponent
 
         slot_names.each do |slot_name|
           # Ensure slot_name isn't already declared
-          if self.slots.key?(slot_name)
+          if slots.key?(slot_name)
             raise ArgumentError.new("#{slot_name} slot declared multiple times")
           end
 
@@ -73,7 +73,7 @@ module ViewComponent
           class_name = "ViewComponent::Slot" unless class_name.present?
 
           # Register the slot on the component
-          self.slots[slot_name] = {
+          slots[slot_name] = {
             class_name: class_name,
             instance_variable_name: instance_variable_name,
             collection: collection
@@ -84,7 +84,7 @@ module ViewComponent
       def inherited(child)
         # Clone slot configuration into child class
         # see #test_slots_pollution
-        child.slots = self.slots.clone
+        child.slots = slots.clone
 
         super
       end
@@ -106,7 +106,7 @@ module ViewComponent
     #
     def slot(slot_name, **args, &block)
       # Raise ArgumentError if `slot` doesn't exist
-      unless slots.keys.include?(slot_name)
+      unless slots.key?(slot_name)
         raise ArgumentError.new "Unknown slot '#{slot_name}' - expected one of '#{slots.keys}'"
       end
 
@@ -123,8 +123,7 @@ module ViewComponent
       slot_instance = args.present? ? slot_class.new(**args) : slot_class.new
 
       # Capture block and assign to slot_instance#content
-      # rubocop:disable Rails/OutputSafety
-      slot_instance.content = view_context.capture(&block).to_s.strip.html_safe if block_given?
+      slot_instance.content = view_context.capture(&block).to_s.strip.html_safe if block
 
       if slot[:collection]
         # Initialize instance variable as an empty array

data/lib/view_component/slotable_v2.rb

@@ -9,7 +9,7 @@ module ViewComponent
 
     RESERVED_NAMES = {
       singular: %i[content render].freeze,
-      plural: %i[contents renders].freeze,
+      plural: %i[contents renders].freeze
     }.freeze
 
     # Setup component slot state
@@ -190,20 +190,20 @@ module ViewComponent
       # Clone slot configuration into child class
       # see #test_slots_pollution
       def inherited(child)
-        child.registered_slots = self.registered_slots.clone
+        child.registered_slots = registered_slots.clone
         super
       end
 
       private
 
       def register_slot(slot_name, **kwargs)
-        self.registered_slots[slot_name] = define_slot(slot_name, **kwargs)
+        registered_slots[slot_name] = define_slot(slot_name, **kwargs)
       end
 
       def define_slot(slot_name, collection:, callable:)
         # Setup basic slot data
         slot = {
-          collection: collection,
+          collection: collection
         }
         return slot unless callable
 
@@ -254,7 +254,7 @@ module ViewComponent
       end
 
       def raise_if_slot_registered(slot_name)
-        if self.registered_slots.key?(slot_name)
+        if registered_slots.key?(slot_name)
           # TODO remove? This breaks overriding slots when slots are inherited
           raise ArgumentError.new(
             "#{self} declares the #{slot_name} slot multiple times.\n\n" \
@@ -287,8 +287,6 @@ module ViewComponent
 
       if slot[:collection]
         []
-      else
-        nil
       end
     end
 
@@ -305,7 +303,7 @@ module ViewComponent
       # 2. Since we've to pass block content to components when calling
       # `render`, evaluating the block here would require us to call
       # `view_context.capture` twice, which is slower
-      slot.__vc_content_block = block if block_given?
+      slot.__vc_content_block = block if block
 
       # If class
       if slot_definition[:renderable]
@@ -321,7 +319,7 @@ module ViewComponent
         # methods like `content_tag` as well as parent component state.
         renderable_function = slot_definition[:renderable_function].bind(self)
         renderable_value =
-          if block_given?
+          if block
             renderable_function.call(*args) do |*rargs|
               view_context.capture(*rargs, &block)
             end

data/lib/view_component/test_helpers.rb

@@ -1,15 +1,37 @@
 # frozen_string_literal: true
 
 require "view_component/render_preview_helper"
+require "view_component/capybara_simple_session"
 
 module ViewComponent
   module TestHelpers
     begin
       require "capybara/minitest"
+
       include Capybara::Minitest::Assertions
 
+      CapybaraSimpleSession::DSL_METHODS.each do |method|
+        if RUBY_VERSION >= "2.7"
+          class_eval <<~METHOD, __FILE__, __LINE__ + 1
+            def #{method}(...)
+              page.method("#{method}").call(...)
+            end
+          METHOD
+        else
+          define_method method do |*args, &block|
+            page.send method, *args, &block
+          end
+        end
+      end
+
+      def self.included(mod)
+        Capybara::Node::Simple.send(:define_method, :to_capybara_node) do
+          self
+        end
+      end
+
       def page
-        Capybara::Node::Simple.new(@rendered_content)
+        @page ||= CapybaraSimpleSession.new(rendered_content)
       end
 
       def refute_component_rendered
@@ -32,6 +54,9 @@ module ViewComponent
     # @private
     attr_reader :rendered_content
 
+    # Returns the result of a render_inline call.
+    #
+    # @return [String]
     def rendered_component
       ViewComponent::Deprecation.warn(
         "`rendered_component` is deprecated and will be removed in v3.0.0. " \
@@ -52,6 +77,7 @@ module ViewComponent
     # @param component [ViewComponent::Base, ViewComponent::Collection] The instance of the component to be rendered.
     # @return [Nokogiri::HTML]
     def render_inline(component, **args, &block)
+      @page = nil
       @rendered_content =
         if Rails.version.to_f >= 6.1
           controller.view_context.render(component, args, &block)
@@ -73,6 +99,7 @@ module ViewComponent
     # assert_text("Hello, World!")
     # ```
     def render_in_view_context(&block)
+      @page = nil
       @rendered_content = controller.view_context.instance_exec(&block)
       Nokogiri::HTML.fragment(@rendered_content)
     end

data/lib/view_component/translatable.rb

@@ -9,7 +9,7 @@ module ViewComponent
   module Translatable
     extend ActiveSupport::Concern
 
-    HTML_SAFE_TRANSLATION_KEY = /(?:_|\b)html\z/.freeze
+    HTML_SAFE_TRANSLATION_KEY = /(?:_|\b)html\z/
 
     included do
       class_attribute :i18n_backend, instance_writer: false, instance_predicate: false
@@ -23,14 +23,13 @@ module ViewComponent
       def build_i18n_backend
         return if CompileCache.compiled? self
 
-        if (translation_files = _sidecar_files(%w[yml yaml])).any?
-          self.i18n_backend = I18nBackend.new(
+        self.i18n_backend = if (translation_files = _sidecar_files(%w[yml yaml])).any?
+          # Returning nil cleans up if translations file has been removed since the last compilation
+
+          I18nBackend.new(
             i18n_scope: i18n_scope,
-            load_paths: translation_files,
+            load_paths: translation_files
           )
-        else
-          # Cleanup if translations file has been removed since the last compilation
-          self.i18n_backend = nil
         end
       end
     end
@@ -50,7 +49,7 @@ module ViewComponent
 
       def scope_data(data)
         @i18n_scope.reverse_each do |part|
-          data = { part => data }
+          data = {part => data}
         end
         data
       end
@@ -95,7 +94,7 @@ module ViewComponent
         super(key, locale: locale, **options)
       end
     end
-    alias :t :translate
+    alias_method :t, :translate
 
     # Exposes .i18n_scope as an instance method
     def i18n_scope
@@ -109,7 +108,7 @@ module ViewComponent
         # It's assumed here that objects loaded by the i18n backend will respond to `#html_safe?`.
         # It's reasonable that if we're in Rails, `active_support/core_ext/string/output_safety.rb`
         # will provide this to `Object`.
-        translation.html_safe # rubocop:disable Rails/OutputSafety
+        translation.html_safe
       end
     end
 

data/lib/view_component/version.rb

@@ -3,8 +3,8 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 57
-    PATCH = 1
+    MINOR = 59
+    PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end

data/lib/view_component.rb

@@ -7,6 +7,7 @@ module ViewComponent
   extend ActiveSupport::Autoload
 
   autoload :Base
+  autoload :CapybaraSimpleSession
   autoload :Compiler
   autoload :CompileCache
   autoload :ComponentError

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.57.1
+  version: 2.59.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-15 00:00:00.000000000 Z
+date: 2022-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -185,19 +185,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-github
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -325,6 +325,7 @@ files:
 - lib/rails/generators/test_unit/templates/component_test.rb.tt
 - lib/view_component.rb
 - lib/view_component/base.rb
+- lib/view_component/capybara_simple_session.rb
 - lib/view_component/collection.rb
 - lib/view_component/compile_cache.rb
 - lib/view_component/compiler.rb