view_component 2.40.0 → 2.43.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6b59c1dbd53f3cb893d36ca15cb6838e6b127a36c895d2e062f961929f03bb9
-  data.tar.gz: b32e3ecaa9f9734eded75141a75baeaa4396652e475827ff9db29dcf647e36c7
+  metadata.gz: 68e0fc06b5f3e59c4baf241bef8827bb6d917823ee7d79052ff7e2e9406363da
+  data.tar.gz: a21f0dabe952531d817fdd6b3859089e4a21bd3f7474bdaee6c6b5953a653593
 SHA512:
-  metadata.gz: e1e2312bb9dda96f1f52d6fa513514e461b2c3f9880ffa8321fcba69aabeaf1d87fc5199a7cf190c2596184051c0db30539b4600dbe2a15b5a560f76dc04240f
-  data.tar.gz: fc65722d4b20457c22de5d0603b80b171777c18bbae19c579f841b4aa092e6feb8e821da8832b6c2fb283d6a2fbca8929967f379b96d68d8ad94c8b171fa2293
+  metadata.gz: 7c8068857218b70cba3d99fe04df088ab2bb0da3f03f9277352b7a96dcebaff10fcf0d1b3657004ca5d6552c2033173a599fd64ce81b1e5635db224d48617d51
+  data.tar.gz: e7808192370b1c9f3eb4af84def46ebbfc4828b23f4c75be2f4753b18463f733beff77fff65ba3ccaa690efb6365fa5dcab574b962f905deb1cfbd4475dc3f20

data/README.md

@@ -1,4 +1,4 @@
-# ViewComponent
+<img src="/docs/logo/viewcomponent-color-logo.svg" alt="ViewComponent logo" width="500">
 
 A framework for building reusable, testable & encapsulated view components in Ruby on Rails.
 

data/docs/CHANGELOG.md

@@ -7,6 +7,115 @@ title: Changelog
 
 ## main
 
+## 2.43.1
+
+* Remove unnecessary call to `ruby2_keywords` for polymorphic slot getters.
+
+    *Cameron Dutro*
+
+## 2.43.0
+
+* Add note about tests and instance methods.
+
+    *Joel Hawksley*
+
+* Flesh out `ViewComponents in practice`.
+
+    *Joel Hawksley*
+
+* Add CODEOWNERS entries for feature areas owned by community committers.
+
+    *Joel Hawksley*
+
+* Separate lint and CI workflows.
+
+    *Blake Williams*
+
+* Add support for `image_path` helper in previews.
+
+    *Tobias Ahlin*, *Joel Hawksley*
+
+* Add section to docs listing users of ViewComponent. Please submit a PR to add your team to the list!
+
+    *Joel Hawksley*
+
+* Fix loading issue with Stimulus generator and add specs for Stimulus generator.
+
+    *Peter Sumskas*
+
+* Remove dependency on `ActionDispatch::Static` in Rails middleware stack when enabling statics assets for source code preview.
+
+    *Gregory Igelmund*
+
+* Require `view_component/engine` automatically.
+
+    *Cameron Dutro*
+
+## 2.42.0
+
+* Add logo files and page to docs.
+
+    *Dylan Smith*
+
+* Add `ViewComponents in practice` documentation.
+
+    *Joel Hawksley*
+
+* Fix bug where calling lambda slots without arguments would break in Ruby < 2.7.
+
+    *Manuel Puyol*
+
+* Improve Stimulus controller template to import from `stimulus` or `@hotwired/stimulus`.
+
+    *Mario Schüttel*
+
+* Fix bug where `helpers` would instantiate and use a new `view_context` in each component.
+
+    *Blake Williams*, *Ian C. Anderson*
+
+* Implement polymorphic slots as experimental feature. See the Slots documentation to learn more.
+
+    *Cameron Dutro*
+
+## 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 using ruby2_keywords.
+
+    *Cameron Dutro*
+
 ## 2.40.0
 
 * Replace antipatterns section in the documentation with best practices.
@@ -62,7 +171,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 +235,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/rails/generators/stimulus/component_generator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "rails/generators/abstract_generator"
+
 module Stimulus
   module Generators
     class ComponentGenerator < ::Rails::Generators::NamedBase
@@ -12,6 +14,12 @@ module Stimulus
         template "component_controller.js", destination
       end
 
+      def stimulus_module
+        return "stimulus" if legacy_stimulus?
+
+        "@hotwired/stimulus"
+      end
+
       private
 
       def destination
@@ -21,6 +29,11 @@ module Stimulus
           File.join(component_path, class_path, "#{file_name}_component_controller.js")
         end
       end
+
+      def legacy_stimulus?
+        package_json_pathname = Rails.root.join("package.json")
+        package_json_pathname.exist? && JSON.parse(package_json_pathname.read).dig("dependencies", "stimulus").present?
+      end
     end
   end
 end

data/lib/rails/generators/stimulus/templates/component_controller.js.tt

@@ -1,4 +1,4 @@
-import { Controller } from "stimulus";
+import { Controller } from "<%= stimulus_module %>";
 
 export default class extends Controller {
   connect() {

data/lib/view_component/base.rb

@@ -5,6 +5,7 @@ require "active_support/configurable"
 require "view_component/collection"
 require "view_component/compile_cache"
 require "view_component/content_areas"
+require "view_component/polymorphic_slots"
 require "view_component/previewable"
 require "view_component/slotable"
 require "view_component/slotable_v2"
@@ -28,6 +29,8 @@ module ViewComponent
     class_attribute :content_areas
     self.content_areas = [] # class_attribute:default doesn't work until Rails 5.2
 
+    attr_accessor :original_view_context
+
     # EXPERIMENTAL: This API is experimental and may be removed at any time.
     # Hook for allowing components to do work as part of the compilation process.
     #
@@ -39,33 +42,18 @@ module ViewComponent
 
     # Entrypoint for rendering components.
     #
-    # 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
-    #
-    # Example subclass:
-    #
-    # app/components/my_component.rb:
-    # class MyComponent < ViewComponent::Base
-    #   def initialize(title:)
-    #     @title = title
-    #   end
-    # end
+    # - `view_context`: ActionView context from calling view
+    # - `block`: optional block to be captured within the view context
     #
-    # app/components/my_component.html.erb
-    # <span title="<%= @title %>">Hello, <%= content %>!</span>
+    # Returns HTML that has been escaped by the respective template handler.
     #
-    # 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)
 
       @view_context = view_context
+      self.original_view_context ||= view_context
+
       @lookup_context ||= view_context.lookup_context
 
       # required for path helpers in older Rails versions
@@ -149,9 +137,10 @@ module ViewComponent
     # @private
     def render(options = {}, args = {}, &block)
       if options.is_a? ViewComponent::Base
+        options.original_view_context = original_view_context
         super
       else
-        view_context.render(options, args, &block)
+        original_view_context.render(options, args, &block)
       end
     end
 
@@ -190,7 +179,14 @@ module ViewComponent
         )
       end
 
-      @__vc_helpers ||= controller.view_context
+      # Attempt to re-use the original view_context passed to the first
+      # component rendered in the rendering pipeline. This prevents the
+      # instantiation of a new view_context via `controller.view_context` which
+      # always returns a new instance of the view context class.
+      #
+      # This allows ivars to remain persisted when using the same helper via
+      # `helpers` across multiple components and partials.
+      @__vc_helpers ||= original_view_context || controller.view_context
     end
 
     # Exposes .virtual_path as an instance method
@@ -298,6 +294,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 +388,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/engine.rb

@@ -103,7 +103,7 @@ module ViewComponent
 
     initializer "static assets" do |app|
       if app.config.view_component.show_previews
-        app.middleware.insert_before(::ActionDispatch::Static, ::ActionDispatch::Static, "#{root}/app/assets/vendor")
+        app.middleware.use(::ActionDispatch::Static, "#{root}/app/assets/vendor")
       end
     end
 

data/lib/view_component/polymorphic_slots.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module PolymorphicSlots
+    # 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)
+      base.singleton_class.prepend(ClassMethods)
+      base.include(InstanceMethods)
+    end
+
+    module ClassMethods
+      def renders_one(slot_name, callable = nil)
+        return super unless callable.is_a?(Hash) && callable.key?(:types)
+
+        validate_singular_slot_name(slot_name)
+        register_polymorphic_slot(slot_name, callable[:types], collection: false)
+      end
+
+      def renders_many(slot_name, callable = nil)
+        return super unless callable.is_a?(Hash) && callable.key?(:types)
+
+        validate_plural_slot_name(slot_name)
+        register_polymorphic_slot(slot_name, callable[:types], collection: true)
+      end
+
+      def register_polymorphic_slot(slot_name, types, collection:)
+        renderable_hash = types.each_with_object({}) do |(poly_type, poly_callable), memo|
+          memo[poly_type] = define_slot(
+            "#{slot_name}_#{poly_type}", collection: collection, callable: poly_callable
+          )
+
+          getter_name = slot_name
+          setter_name =
+            if collection
+              "#{ActiveSupport::Inflector.singularize(slot_name)}_#{poly_type}"
+            else
+              "#{slot_name}_#{poly_type}"
+            end
+
+          define_method(getter_name) do
+            get_slot(slot_name)
+          end
+
+          define_method(setter_name) do |*args, &block|
+            set_polymorphic_slot(slot_name, poly_type, *args, &block)
+          end
+          ruby2_keywords(setter_name.to_sym) if respond_to?(:ruby2_keywords, true)
+        end
+
+        self.registered_slots[slot_name] = {
+          collection: collection,
+          renderable_hash: renderable_hash
+        }
+      end
+    end
+
+    module InstanceMethods
+      def set_polymorphic_slot(slot_name, poly_type = nil, *args, &block)
+        slot_definition = self.class.registered_slots[slot_name]
+
+        if !slot_definition[:collection] && get_slot(slot_name)
+          raise ArgumentError, "content for slot '#{slot_name}' has already been provided"
+        end
+
+        poly_def = slot_definition[:renderable_hash][poly_type]
+
+        set_slot(slot_name, poly_def, *args, &block)
+      end
+      ruby2_keywords(:set_polymorphic_slot) if respond_to?(:ruby2_keywords, true)
+    end
+  end
+end

data/lib/view_component/preview.rb

@@ -5,6 +5,7 @@ require "active_support/descendants_tracker"
 module ViewComponent # :nodoc:
   class Preview
     include ActionView::Helpers::TagHelper
+    include ActionView::Helpers::AssetTagHelper
     extend ActiveSupport::DescendantsTracker
 
     def render(component, **args, &block)

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
@@ -89,6 +89,7 @@ module ViewComponent
     def method_missing(symbol, *args, &block)
       @__vc_component_instance.public_send(symbol, *args, &block)
     end
+    ruby2_keywords(:method_missing) if respond_to?(:ruby2_keywords, true)
 
     def html_safe?
       to_s.html_safe?

data/lib/view_component/slotable_v2.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "active_support/concern"
-
 require "view_component/slot_v2"
 
 module ViewComponent
@@ -67,13 +66,14 @@ module ViewComponent
       def renders_one(slot_name, callable = nil)
         validate_singular_slot_name(slot_name)
 
-        define_method slot_name do |*args, **kwargs, &block|
-          if args.empty? && kwargs.empty? && block.nil?
+        define_method slot_name do |*args, &block|
+          if args.empty? && block.nil?
             get_slot(slot_name)
           else
-            set_slot(slot_name, *args, **kwargs, &block)
+            set_slot(slot_name, nil, *args, &block)
           end
         end
+        ruby2_keywords(slot_name.to_sym) if respond_to?(:ruby2_keywords, true)
 
         register_slot(slot_name, collection: false, callable: callable)
       end
@@ -123,9 +123,10 @@ module ViewComponent
         # Define setter for singular names
         # e.g. `renders_many :items` allows fetching all tabs with
         # `component.tabs` and setting a tab with `component.tab`
-        define_method singular_name do |*args, **kwargs, &block|
-          set_slot(slot_name, *args, **kwargs, &block)
+        define_method singular_name do |*args, &block|
+          set_slot(slot_name, nil, *args, &block)
         end
+        ruby2_keywords(singular_name.to_sym) if respond_to?(:ruby2_keywords, true)
 
         # Instantiates and and adds multiple slots forwarding the first
         # argument to each slot constructor
@@ -134,7 +135,7 @@ module ViewComponent
             get_slot(slot_name)
           else
             collection_args.map do |args|
-              set_slot(slot_name, **args, &block)
+              set_slot(slot_name, nil, **args, &block)
             end
           end
         end
@@ -162,27 +163,37 @@ module ViewComponent
 
       private
 
-      def register_slot(slot_name, collection:, callable:)
+      def register_slot(slot_name, **kwargs)
+        self.registered_slots[slot_name] = define_slot(slot_name, **kwargs)
+      end
+
+      def define_slot(slot_name, collection:, callable:)
         # Setup basic slot data
         slot = {
           collection: collection,
         }
+        return slot unless callable
+
         # If callable responds to `render_in`, we set it on the slot as a renderable
-        if callable && callable.respond_to?(:method_defined?) && callable.method_defined?(:render_in)
+        if callable.respond_to?(:method_defined?) && callable.method_defined?(:render_in)
           slot[:renderable] = callable
         elsif callable.is_a?(String)
           # If callable is a string, we assume it's referencing an internal class
           slot[:renderable_class_name] = callable
-        elsif callable
+        elsif callable.respond_to?(:call)
           # If slot does not respond to `render_in`, we assume it's a proc,
           # define a method, and save a reference to it to call when setting
           method_name = :"_call_#{slot_name}"
           define_method method_name, &callable
           slot[:renderable_function] = instance_method(method_name)
+        else
+          raise(
+            ArgumentError,
+            "invalid slot definition. Please pass a class, string, or callable (i.e. proc, lambda, etc)"
+          )
         end
 
-        # Register the slot on the component
-        self.registered_slots[slot_name] = slot
+        slot
       end
 
       def validate_plural_slot_name(slot_name)
@@ -235,9 +246,8 @@ module ViewComponent
       end
     end
 
-    def set_slot(slot_name, *args, **kwargs, &block)
-      slot_definition = self.class.registered_slots[slot_name]
-
+    def set_slot(slot_name, slot_definition = nil, *args, &block)
+      slot_definition ||= self.class.registered_slots[slot_name]
       slot = SlotV2.new(self)
 
       # Passing the block to the sub-component wrapper like this has two
@@ -253,23 +263,24 @@ module ViewComponent
 
       # If class
       if slot_definition[:renderable]
-        slot.__vc_component_instance = slot_definition[:renderable].new(*args, **kwargs)
+        slot.__vc_component_instance = slot_definition[:renderable].new(*args)
       # If class name as a string
       elsif slot_definition[:renderable_class_name]
         slot.__vc_component_instance =
-          self.class.const_get(slot_definition[:renderable_class_name]).new(*args, **kwargs)
+          self.class.const_get(slot_definition[:renderable_class_name]).new(*args)
       # If passed a lambda
       elsif slot_definition[:renderable_function]
         # Use `bind(self)` to ensure lambda is executed in the context of the
         # current component. This is necessary to allow the lambda to access helper
         # methods like `content_tag` as well as parent component state.
+        renderable_function = slot_definition[:renderable_function].bind(self)
         renderable_value =
           if block_given?
-            slot_definition[:renderable_function].bind(self).call(*args, **kwargs) do |*args, **kwargs|
-              view_context.capture(*args, **kwargs, &block)
+            renderable_function.call(*args) do |*args|
+              view_context.capture(*args, &block)
             end
           else
-            slot_definition[:renderable_function].bind(self).call(*args, **kwargs)
+            renderable_function.call(*args)
           end
 
         # Function calls can return components, so if it's a component handle it specially
@@ -291,5 +302,6 @@ module ViewComponent
 
       slot
     end
+    ruby2_keywords(:set_slot) if respond_to?(:ruby2_keywords, true)
   end
 end

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,8 +3,8 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 40
-    PATCH = 0
+    MINOR = 43
+    PATCH = 1
 
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end

data/lib/view_component.rb

@@ -17,3 +17,5 @@ module ViewComponent
   autoload :TemplateError
   autoload :Translatable
 end
+
+require "view_component/engine" if defined?(Rails::Engine)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.40.0
+  version: 2.43.1
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-09 00:00:00.000000000 Z
+date: 2021-11-09 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
@@ -300,6 +314,7 @@ files:
 - lib/view_component/content_areas.rb
 - lib/view_component/engine.rb
 - lib/view_component/instrumentation.rb
+- lib/view_component/polymorphic_slots.rb
 - lib/view_component/preview.rb
 - lib/view_component/preview_template_error.rb
 - lib/view_component/previewable.rb
@@ -341,7 +356,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: View components for Rails