view_component 2.40.0 → 2.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6b59c1dbd53f3cb893d36ca15cb6838e6b127a36c895d2e062f961929f03bb9
-  data.tar.gz: b32e3ecaa9f9734eded75141a75baeaa4396652e475827ff9db29dcf647e36c7
+  metadata.gz: ec24d635f8ce5341c3735ab855b9099fe2ea9179bb21a8fe79ba0f14f374ec44
+  data.tar.gz: fbc578b4554de38f01a4e92bbcf6ddfaf146ac04fb75e871f8d2378f8a19c053
 SHA512:
-  metadata.gz: e1e2312bb9dda96f1f52d6fa513514e461b2c3f9880ffa8321fcba69aabeaf1d87fc5199a7cf190c2596184051c0db30539b4600dbe2a15b5a560f76dc04240f
-  data.tar.gz: fc65722d4b20457c22de5d0603b80b171777c18bbae19c579f841b4aa092e6feb8e821da8832b6c2fb283d6a2fbca8929967f379b96d68d8ad94c8b171fa2293
+  metadata.gz: 9ed08e30f614fc25aeb1c1826d159b312fba175a95a71966112069a27bc1da3255948b1c9504b06f55b6c476fda4418f13b3e42050664dc3146def0ff1ba0636
+  data.tar.gz: b02c7784cc31a3e5cfe5d6ec55879bbe832446557810a3884034e871effece891164424f4d4bf34664c3d8a239683405ea31d92b7351321ce0fc8c33c802f3a5

data/docs/CHANGELOG.md

@@ -7,6 +7,45 @@ title: Changelog
 
 ## main
 
+## 2.41.0
+
+* Add `sprockets-rails` development dependency to fix test suite failures when using rails@main.
+
+    *Blake Williams*
+
+* Fix Ruby indentation warning.
+
+    *Blake Williams*
+
+* Add `--parent` generator option to specify the parent class.
+* Add config option `config.view_component.component_parent_class` to change it project-wide.
+
+    *Hans Lemuet*
+
+* Update docs to add example for using Devise helpers in tests.
+
+    *Matthew Rider*
+
+* Fix bug where `with_collection_parameter` did not inherit from parent component.
+
+    *Will Drexler*, *Christian Campoli*
+
+* Allow query parameters in `with_request_url` test helper.
+
+    *Javi Martín*
+
+* Add "how to render a component to a string" to FAQ.
+
+    *Hans Lemuet*
+
+* Add `#render_in` to API docs.
+
+    *Hans Lemuet*
+
+* Forward keyword arguments from slot wrapper to component instance.
+
+    *Cameron Dutro*
+
 ## 2.40.0
 
 * Replace antipatterns section in the documentation with best practices.
@@ -62,7 +101,7 @@ title: Changelog
 
 * Add test case for conflict with internal `@variant` variable.
 
-   *David Backeus*
+    *David Backeus*
 
 * Document decision to not change naming convention recommendation to remove `-Component` suffix.
 
@@ -126,7 +165,7 @@ title: Changelog
 
 * Ensure consistent indentation with Rubocop.
 
-    *Joel Hawksley
+    *Joel Hawksley*
 
 * Bump `activesupport` upper bound from `< 7.0` to `< 8.0`.
 

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

@@ -12,6 +12,7 @@ module Rails
       argument :attributes, type: :array, default: [], banner: "attribute"
       check_class_collision suffix: "Component"
       class_option :inline, type: :boolean, default: false
+      class_option :parent, type: :string, desc: "The parent class for the generated component"
       class_option :stimulus, type: :boolean, default: ViewComponent::Base.generate_stimulus_controller
       class_option :sidecar, type: :boolean, default: false
 
@@ -32,7 +33,9 @@ module Rails
       private
 
       def parent_class
-        defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base"
+        return options[:parent] if options[:parent]
+
+        ViewComponent::Base.component_parent_class || default_parent_class
       end
 
       def initialize_signature
@@ -48,6 +51,10 @@ module Rails
       def initialize_call_method_for_inline?
         options["inline"]
       end
+
+      def default_parent_class
+        defined?(ApplicationComponent) ? ApplicationComponent : ViewComponent::Base
+      end
     end
   end
 end

data/lib/view_component/base.rb

@@ -39,29 +39,12 @@ module ViewComponent
 
     # Entrypoint for rendering components.
     #
-    # view_context: ActionView context from calling view
-    # block: optional block to be captured within the view context
+    # - `view_context`: ActionView context from calling view
+    # - `block`: optional block to be captured within the view context
     #
-    # returns HTML that has been escaped by the respective template handler
+    # Returns HTML that has been escaped by the respective template handler.
     #
-    # Example subclass:
-    #
-    # app/components/my_component.rb:
-    # class MyComponent < ViewComponent::Base
-    #   def initialize(title:)
-    #     @title = title
-    #   end
-    # end
-    #
-    # app/components/my_component.html.erb
-    # <span title="<%= @title %>">Hello, <%= content %>!</span>
-    #
-    # In use:
-    # <%= render MyComponent.new(title: "greeting") do %>world<% end %>
-    # returns:
-    # <span title="greeting">Hello, world!</span>
-    #
-    # @private
+    # @return [String]
     def render_in(view_context, &block)
       self.class.compile(raise_errors: true)
 
@@ -298,6 +281,14 @@ module ViewComponent
     # Defaults to "app/components".
     mattr_accessor :view_component_path, instance_writer: false, default: "app/components"
 
+    # Parent class for generated components
+    #
+    #     config.view_component.component_parent_class = "MyBaseComponent"
+    #
+    # Defaults to "ApplicationComponent" if defined, "ViewComponent::Base" otherwise.
+    mattr_accessor :component_parent_class,
+                   instance_writer: false
+
     class << self
       # @private
       attr_accessor :source_location, :virtual_path
@@ -384,6 +375,9 @@ module ViewComponent
           %r{(.*#{Regexp.quote(ViewComponent::Base.view_component_path)})|(\.rb)}, ""
         )
 
+        # Set collection parameter to the extended component
+        child.with_collection_parameter provided_collection_parameter
+
         super
       end
 

data/lib/view_component/slot_v2.rb

@@ -62,7 +62,7 @@ module ViewComponent
           view_context.capture(&@__vc_content_block)
         elsif defined?(@__vc_content_set_by_with_content)
           @__vc_content_set_by_with_content
-             end
+        end
 
       @content = @content.to_s
     end
@@ -86,8 +86,14 @@ module ViewComponent
     #   end
     # end
     #
-    def method_missing(symbol, *args, &block)
-      @__vc_component_instance.public_send(symbol, *args, &block)
+    if RUBY_VERSION >= "2.7.0"
+      def method_missing(symbol, *args, **kwargs, &block)
+        @__vc_component_instance.public_send(symbol, *args, **kwargs, &block)
+      end
+    else
+      def method_missing(symbol, *args, &block)
+        @__vc_component_instance.public_send(symbol, *args, &block)
+      end
     end
 
     def html_safe?

data/lib/view_component/test_helpers.rb

@@ -114,12 +114,15 @@ module ViewComponent
     # @param path [String] The path to set for the current request.
     def with_request_url(path)
       old_request_path_parameters = request.path_parameters
+      old_request_query_parameters = request.query_parameters
       old_controller = defined?(@controller) && @controller
 
       request.path_parameters = Rails.application.routes.recognize_path(path)
+      request.set_header("action_dispatch.request.query_parameters", Rack::Utils.parse_query(path.split("?")[1]))
       yield
     ensure
       request.path_parameters = old_request_path_parameters
+      request.set_header("action_dispatch.request.query_parameters", old_request_query_parameters)
       @controller = old_controller
     end
 

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 40
+    MINOR = 41
     PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.40.0
+  version: 2.41.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-09 00:00:00.000000000 Z
+date: 2021-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -226,6 +226,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.2
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement