view_component 2.22.1 → 2.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 443af024d4cbb4251192a8d21eb95d40ad011aaac81a6572acfade86fd237f2d
-  data.tar.gz: bf7768afd857d6ed5580105a947fb5329615b01513f748c7856e33cd1cc43af9
+  metadata.gz: fcba3738e1cef136c14cd82cc3dd8301596f576b8891bd668e5216ff0dca9bc6
+  data.tar.gz: 7bd2112814c640f4b524f557799d1484fcaf88240505e7e09753cdacf7af87bd
 SHA512:
-  metadata.gz: 3f04ddd1e8c82e8b7bf586eb249a0c8dcbdf6a3b214c9b26fabf988d2c1696f78cd684654d8a7ffc7d86bf8e282204a8643784bc1c8b0153338b688b8cfe252f
-  data.tar.gz: 4b7d2fa52955349650500493c90882b05809b74fb447d590ea96aea9781198233dd091db7db1b4a643c4185830f9ff10b8e5a44dd2c48ccb3c9f8c42ad0525ea
+  metadata.gz: e97c8b9fe11d78da84c129f99bfa19c8e76596064d76adc78f28127410f7f5b31a856c31a4a1e8444c707d7d228b1ffe4c01d9b70ffcc54a3ef9bd7edba7a61b
+  data.tar.gz: 6856e490404554040459f57bfab1ae523a00808498230078bc914f97f1bcaf19d1f4a50c5ba66c5d31b0250d2d3185df0f4a93b6761bd875349e0b3a7f643466

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 ## master
 
+## 2.23.0
+
+* Add `ActionView::SlotableV2`
+  * `with_slot` becomes `renders_one`.
+  * `with_slot collection: true` becomes `renders_many`.
+  * Slot definitions now accept either a component class, component class name, or a lambda instead of a `class_name:` keyword argument.
+  * Slots now support positional arguments.
+  * Slots no longer use the `content` attribute to render content, instead relying on `to_s`. e.g. `<%= my_slot %>`.
+  * Slot values are no longer set via the `slot` method, and instead use the name of the slot.
+
+    *Blake Williams*
+
+* Add `frozen_string_literal: true` to generated component template.
+
+    *Max Beizer*
+
 ## 2.22.1
 
 * Revert refactor that broke rendering for some users.

data/lib/rails/generators/component/templates/component.rb.tt

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class <%= class_name %>Component < <%= parent_class %>
 <%- if initialize_signature -%>
   def initialize(<%= initialize_signature %>)

data/lib/view_component/base.rb

@@ -6,6 +6,7 @@ require "view_component/collection"
 require "view_component/compile_cache"
 require "view_component/previewable"
 require "view_component/slotable"
+require "view_component/slotable_v2"
 
 module ViewComponent
   class Base < ActionView::Base
@@ -20,10 +21,6 @@ module ViewComponent
     class_attribute :content_areas
     self.content_areas = [] # class_attribute:default doesn't work until Rails 5.2
 
-    # Hash of registered Slots
-    class_attribute :slots
-    self.slots = {}
-
     # Entrypoint for rendering components.
     #
     # view_context: ActionView context from calling view
@@ -99,13 +96,16 @@ module ViewComponent
 
     def initialize(*); end
 
-    # If trying to render a partial or template inside a component,
-    # pass the render call to the parent view_context.
+    # Re-use original view_context if we're not rendering a component.
+    #
+    # This prevents an exception when rendering a partial inside of a component that has also been rendered outside
+    # of the component. This is due to the partials compiled template method existing in the parent `view_context`,
+    #  and not the component's `view_context`.
     def render(options = {}, args = {}, &block)
-      if options.is_a?(String) || (options.is_a?(Hash) && options.has_key?(:partial))
-        view_context.render(options, args, &block)
-      else
+      if options.is_a? ViewComponent::Base
         super
+      else
+        view_context.render(options, args, &block)
       end
     end
 
@@ -132,7 +132,10 @@ module ViewComponent
 
     # For caching, such as #cache_if
     def format
-      @variant
+      # Ruby 2.6 throws a warning without checking `defined?`, 2.7 does not
+      if defined?(@variant)
+        @variant
+      end
     end
 
     # Assign the provided content to the content area accessor
@@ -207,10 +210,6 @@ module ViewComponent
         # Removes the first part of the path and the extension.
         child.virtual_path = child.source_location.gsub(%r{(.*app/components)|(\.rb)}, "")
 
-        # Clone slot configuration into child class
-        # see #test_slots_pollution
-        child.slots = self.slots.clone
-
         super
       end
 
@@ -291,7 +290,6 @@ module ViewComponent
       def provided_collection_parameter
         @provided_collection_parameter ||= nil
       end
-
     end
 
     ActiveSupport.run_load_hooks(:view_component, self)

data/lib/view_component/compiler.rb

@@ -146,21 +146,36 @@ module ViewComponent
       source_location = component_class.source_location
       return [] unless source_location
 
-      location_without_extension = source_location.chomp(File.extname(source_location))
-
       extensions = ActionView::Template.template_handler_extensions.join(",")
 
-      # view files in the same directory as the component
-      sidecar_files = Dir["#{location_without_extension}.*{#{extensions}}"]
-
       # view files in a directory named like the component
       directory = File.dirname(source_location)
       filename = File.basename(source_location, ".rb")
       component_name = component_class.name.demodulize.underscore
 
+      # Add support for nested components defined in the same file.
+      #
+      # e.g.
+      #
+      # class MyComponent < ViewComponent::Base
+      #   class MyOtherComponent < ViewComponent::Base
+      #   end
+      # end
+      #
+      # Without this, `MyOtherComponent` will not look for `my_component/my_other_component.html.erb`
+      nested_component_files = if component_class.name.include?("::")
+        nested_component_path = component_class.name.deconstantize.underscore
+        Dir["#{directory}/#{nested_component_path}/#{component_name}.*{#{extensions}}"]
+      else
+        []
+      end
+
+      # view files in the same directory as the component
+      sidecar_files = Dir["#{directory}/#{component_name}.*{#{extensions}}"]
+
       sidecar_directory_files = Dir["#{directory}/#{component_name}/#{filename}.*{#{extensions}}"]
 
-      (sidecar_files - [source_location] + sidecar_directory_files)
+      (sidecar_files - [source_location] + sidecar_directory_files + nested_component_files)
     end
 
     def inline_calls

data/lib/view_component/slot_v2.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  class SlotV2
+    attr_writer :_component_instance, :_content_block, :_content
+
+    def initialize(parent)
+      @parent = parent
+    end
+
+    # Used to render the slot content in the template
+    #
+    # There's currently 3 different values that may be set, that we can render.
+    #
+    # If the slot renderable is a component, the string class name of a
+    # component, or a function that returns a component, we render that
+    # component instance, returning the string.
+    #
+    # If the slot renderable is a function and returns a string, it is
+    # set as `@_content` and is returned directly.
+    #
+    # If there is no slot renderable, we evaluate the block passed to
+    # the slot and return it.
+    def to_s
+      if defined?(@_component_instance)
+        # render_in is faster than `parent.render`
+        @_component_instance.render_in(
+          @parent.send(:view_context),
+          &@_content_block
+        )
+      elsif defined?(@_content)
+        @_content
+      elsif defined?(@_content_block)
+        @_content_block.call
+      end
+    end
+
+    # Allow access to public component methods via the wrapper
+    #
+    # e.g.
+    #
+    # calling `header.name` (where `header` is a slot) will call `name`
+    # on the `HeaderComponent` instance.
+    #
+    # Where the component may look like:
+    #
+    # class MyComponent < ViewComponent::Base
+    #   has_one :header, HeaderComponent
+    #
+    #   class HeaderComponent < ViewComponent::Base
+    #     def name
+    #       @name
+    #     end
+    #   end
+    # end
+    #
+    def method_missing(symbol, *args, &block)
+      @_component_instance.public_send(symbol, *args, &block)
+    end
+
+    def respond_to_missing?(symbol, include_all = false)
+      @_component_instance.respond_to?(symbol, include_all)
+    end
+  end
+end

data/lib/view_component/slotable.rb

@@ -8,6 +8,12 @@ module ViewComponent
   module Slotable
     extend ActiveSupport::Concern
 
+    included do
+      # Hash of registered Slots
+      class_attribute :slots
+      self.slots = {}
+    end
+
     class_methods do
       # support initializing slots as:
       #
@@ -63,6 +69,14 @@ module ViewComponent
           }
         end
       end
+
+      def inherited(child)
+        # Clone slot configuration into child class
+        # see #test_slots_pollution
+        child.slots = self.slots.clone
+
+        super
+      end
     end
 
     # Build a Slot instance on a component,

data/lib/view_component/slotable_v2.rb

@@ -0,0 +1,249 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+require "view_component/slot_v2"
+
+module ViewComponent
+  module SlotableV2
+    extend ActiveSupport::Concern
+
+    # Setup component slot state
+    included do
+      # Hash of registered Slots
+      class_attribute :registered_slots
+      self.registered_slots = {}
+    end
+
+    class_methods do
+      ##
+      # Registers a sub-component
+      #
+      # = Example
+      #
+      #   renders_one :header -> (classes:) do
+      #     HeaderComponent.new(classes: classes)
+      #   end
+      #
+      #   # OR
+      #
+      #   renders_one :header, HeaderComponent
+      #
+      #   where `HeaderComponent` is defined as:
+      #
+      #   class HeaderComponent < ViewComponent::Base
+      #     def initialize(classes:)
+      #       @classes = classes
+      #     end
+      #   end
+      #
+      #   and has the following template:
+      #
+      #   <header class="<%= @classes %>">
+      #     <%= content %>
+      #   </header>
+      #
+      # = Rendering sub-component content
+      #
+      # The component's sidecar template can access the sub-component by calling a
+      # helper method with the same name as the sub-component.
+      #
+      #   <h1>
+      #     <%= header do %>
+      #       My header title
+      #     <% end %>
+      #   </h1>
+      #
+      # = Setting sub-component content
+      #
+      # Consumers of the component can render a sub-component by calling a
+      # helper method with the same name as the slot.
+      #
+      #   <%= render_inline(MyComponent.new) do |component| %>
+      #     <%= component.header(classes: "Foo") do %>
+      #       <p>Bar</p>
+      #     <% end %>
+      #   <% end %>
+      def renders_one(slot_name, callable = nil)
+        validate_slot_name(slot_name)
+
+        define_method slot_name do |*args, **kwargs, &block|
+          if args.empty? && kwargs.empty? && block.nil?
+            get_slot(slot_name)
+          else
+            set_slot(slot_name, *args, **kwargs, &block)
+          end
+        end
+
+        register_slot(slot_name, collection: false, callable: callable)
+      end
+
+      ##
+      # Registers a collection sub-component
+      #
+      # = Example
+      #
+      #   render_many :items, -> (name:) { ItemComponent.new(name: name }
+      #
+      #   # OR
+      #
+      #   render_many :items, ItemComponent
+      #
+      # = Rendering sub-components
+      #
+      # The component's sidecar template can access the slot by calling a
+      # helper method with the same name as the slot.
+      #
+      #   <h1>
+      #     <%= items.each do |item| %>
+      #       <%= item %>
+      #     <% end %>
+      #   </h1>
+      #
+      # = Setting sub-component content
+      #
+      # Consumers of the component can set the content of a slot by calling a
+      # helper method with the same name as the slot. The method can be
+      # called multiple times to append to the slot.
+      #
+      #   <%= render_inline(MyComponent.new) do |component| %>
+      #     <%= component.item(name: "Foo") do %>
+      #       <p>One</p>
+      #     <% end %>
+      #
+      #     <%= component.item(name: "Bar") do %>
+      #       <p>two</p>
+      #     <% end %>
+      #   <% end %>
+      def renders_many(slot_name, callable = nil)
+        validate_slot_name(slot_name)
+
+        singular_name = ActiveSupport::Inflector.singularize(slot_name)
+
+        # 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)
+        end
+
+        # Instantiates and and adds multiple slots forwarding the first
+        # argument to each slot constructor
+        define_method slot_name do |collection_args = nil, &block|
+          if collection_args.nil? && block.nil?
+            get_slot(slot_name)
+          else
+            collection_args.each do |args|
+              set_slot(slot_name, **args, &block)
+            end
+          end
+        end
+
+        register_slot(slot_name, collection: true, callable: callable)
+      end
+
+      # Clone slot configuration into child class
+      # see #test_slots_pollution
+      def inherited(child)
+        child.registered_slots = self.registered_slots.clone
+        super
+      end
+
+      private
+
+      def register_slot(slot_name, collection:, callable:)
+        # Setup basic slot data
+        slot = {
+          collection: collection,
+        }
+        # 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)
+          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
+          # 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)
+        end
+
+        # Register the slot on the component
+        self.registered_slots[slot_name] = slot
+      end
+
+      def validate_slot_name(slot_name)
+        if self.registered_slots.key?(slot_name)
+          # TODO remove? This breaks overriding slots when slots are inherited
+          raise ArgumentError.new("#{slot_name} slot declared multiple times")
+        end
+      end
+    end
+
+    def get_slot(slot_name)
+      slot = self.class.registered_slots[slot_name]
+      @_set_slots ||= {}
+
+      if @_set_slots[slot_name]
+        return @_set_slots[slot_name]
+      end
+
+      if slot[:collection]
+        []
+      else
+        nil
+      end
+    end
+
+    def set_slot(slot_name, *args, **kwargs, &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
+      # benefits:
+      #
+      # 1. If this is a `content_area` style sub-component, we will render the
+      # block via the `slot`
+      #
+      # 2. Since we have 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._content_block = block if block_given?
+
+      # If class
+      if slot_definition[:renderable]
+        slot._component_instance = slot_definition[:renderable].new(*args, **kwargs)
+      # If class name as a string
+      elsif slot_definition[:renderable_class_name]
+        slot._component_instance = self.class.const_get(slot_definition[:renderable_class_name]).new(*args, **kwargs)
+      # 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_value = slot_definition[:renderable_function].bind(self).call(*args, **kwargs, &block)
+
+        # Function calls can return components, so if it's a component handle it specially
+        if renderable_value.respond_to?(:render_in)
+          slot._component_instance = renderable_value
+        else
+          slot._content = renderable_value
+        end
+      end
+
+      @_set_slots ||= {}
+
+      if slot_definition[:collection]
+        @_set_slots[slot_name] ||= []
+        @_set_slots[slot_name].push(slot)
+      else
+        @_set_slots[slot_name] = slot
+      end
+
+      nil
+    end
+  end
+end

data/lib/view_component/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.22.1
+  version: 2.23.0
 platform: ruby
 authors:
 - GitHub Open Source
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-10 00:00:00.000000000 Z
+date: 2020-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -184,7 +184,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.2
-description: 
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description:
 email:
 - opensource+view_component@github.com
 executables: []
@@ -227,7 +241,9 @@ files:
 - lib/view_component/rendering_component_helper.rb
 - lib/view_component/rendering_monkey_patch.rb
 - lib/view_component/slot.rb
+- lib/view_component/slot_v2.rb
 - lib/view_component/slotable.rb
+- lib/view_component/slotable_v2.rb
 - lib/view_component/template_error.rb
 - lib/view_component/test_case.rb
 - lib/view_component/test_helpers.rb
@@ -237,7 +253,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -253,7 +269,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: View components for Rails
 test_files: []