view_component 2.11.0 → 2.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eec4666da3c79cf466b01641169db9055d1201684acf30169d05cfb9129a7dc2
-  data.tar.gz: 6cfe7e0dee9f5becab077ba05093ea04a38927d2b4cf22d58bff9c4a3cbcd0e3
+  metadata.gz: '084152c558b71f87f41d620f9cdce42e689e0b4159cdfa68f3cb041a7bbea3ba'
+  data.tar.gz: 45324159a07873ce92562650fe7c2ad6e8a279c3db216b3460a6075f71033180
 SHA512:
-  metadata.gz: f3a49b502f6f62c611ff8f700d4a84a2fe30e2a203a57a81964a2d99b005bd20ce431a93ba2319d7ac0dd1a358147d4bec97747b97ea3c386b2e27b5a4a4c241
-  data.tar.gz: 4c98f7b14919f9d56ec3a73e179be99f19cd2ec4157591bf3d1661cd5e8fd9a893110b4ba67dc8f0e79095b8d13974ed8a59904df41016f59515998316c03f2b
+  metadata.gz: 58f994aac7efdf81146972a351a12726131658e4ccbd8bf0661eb135d7935ff396c64752d9f9edd6dda50b90a4829aeb506f24edee712279aa1cf4bf4f15886d
+  data.tar.gz: 430b55482aaafaea6a27e73593861f897620cb635c2a2f14f14b5a772846a8f5a7b42bd973f637cd587816762891bcc432ced92dbac04fe1d391bf7734873a6a

data/CHANGELOG.md

@@ -1,5 +1,50 @@
 # master
 
+# 2.14.1
+
+* Allow using `render_inline` in test when the render monkey patch is disabled with `config.view_component.render_monkey_patch_enabled = false` in versions of Rails < 6.1.
+
+    *Clément Joubert*
+
+* Fix kwargs warnings in slotable.
+
+    Fixes:
+
+    ```
+    view_component/lib/view_component/slotable.rb:98: warning: Using the last argument as keyword parameters is deprecated; maybe ** should be added to the call
+    view_component/test/app/components/slots_component.rb:18: warning: The called method `initialize' is defined here
+    ```
+
+    *Eileen M. Uchitelle*
+
+# 2.14.0
+
+* Add `config.preview_paths` to support multiple locations of component preview files. Deprecate `config.preview_path`.
+
+    *Tomas Celizna*
+
+* Only print warning about a missing capybara dependency if the `DEBUG` environment variable is set.
+
+    *Richard Macklin*
+
+# 2.13.0
+
+* Add the ability to disable the render monkey patch with `config.view_component.render_monkey_patch_enabled`. In versions of Rails < 6.1, add `render_component` and `render_component_to_string` methods which can be used for rendering components instead of `render`.
+
+    *Johannes Engl*
+
+# 2.12.0
+
+* Implement Slots as potential successor to Content Areas.
+
+    *Jens Ljungblad, Brian Bugh, Jon Palmer, Joel Hawksley*
+
+# 2.11.1
+
+* Fix kwarg warnings in Ruby 2.7.
+
+    *Joel Hawksley*
+
 # 2.11.0
 
 * Ensure Rails configuration is available within components.

data/README.md

@@ -160,6 +160,133 @@ Returning:
 </div>
 ```
 
+#### Slots (experimental)
+
+_Slots are currently under development as a successor to Content Areas. The Slot APIs should be considered unfinished and subject to breaking changes in non-major releases of ViewComponent._
+
+Slots enable multiple blocks of content to be passed to a single ViewComponent.
+
+Slots exist in two forms: normal slots and collection slots.
+
+Normal slots can be rendered once per component. They expose an accessor with the name of the slot that returns an instance of `ViewComponent::Slot`, etc.
+
+Collection slots can be rendered multiple times. They expose an accessor with the pluralized name of the slot (`#rows`), which is an Array of `ViewComponent::Slot` instances.
+
+To learn more about the design of the Slots API, see https://github.com/github/view_component/pull/348.
+
+##### Defining Slots
+
+Slots are defined by the `with_slot` macro:
+
+`with_slot :header`
+
+To define a collection slot, add `collection: true`:
+
+`with_slot :row, collection: true`
+
+To define a slot with a custom class, pass `class_name`:
+
+`with_slot :body, class_name: 'BodySlot`
+
+Slot classes should be subclasses of `ViewComponent::Slot`.
+
+##### Example ViewComponent with Slots
+
+`# box_component.rb`
+```ruby
+class BoxComponent < ViewComponent::Base
+  include ViewComponent::Slotable
+
+  with_slot :body, :footer
+  with_slot :header, class_name: "Header"
+  with_slot :row, collection: true, class_name: "Row"
+
+  class Header < ViewComponent::Slot
+    def initialize(class_names: "")
+      @class_names = class_names
+    end
+
+    def class_names
+      "Box-header #{@class_names}"
+    end
+  end
+
+  class Row < ViewComponent::Slot
+    def initialize(theme: :gray)
+      @theme = theme
+    end
+
+    def theme_class_name
+      case @theme
+      when :gray
+        "Box-row--gray"
+      when :hover_gray
+        "Box-row--hover-gray"
+      when :yellow
+        "Box-row--yellow"
+      when :blue
+        "Box-row--blue"
+      when :hover_blue
+        "Box-row--hover-blue"
+      else
+        "Box-row--gray"
+      end
+    end
+  end
+end
+```
+
+`# box_component.html.erb`
+```erb
+<div class="Box">
+  <% if header %>
+    <div class="<%= header.class_names %>">
+      <%= header.content %>
+    </div>
+  <% end %>
+  <% if body %>
+    <div class="Box-body">
+      <%= body.content %>
+    </div>
+  <% end %>
+  <% if rows.any? %>
+    <ul>
+      <% rows.each do |row| %>
+        <li class="Box-row <%= row.theme_class_name %>">
+          <%= row.content %>
+        </li>
+      <% end %>
+    </ul>
+  <% end %>
+  <% if footer %>
+    <div class="Box-footer">
+      <%= footer %>
+    </div>
+  <% end %>
+</div>
+```
+
+`# index.html.erb`
+```erb
+<%= render(BoxComponent.new) do |component| %>
+  <% component.slot(:header, class_names: "my-class-name") do %>
+    This is my header!
+  <% end %>
+  <% component.slot(:body) do %>
+    This is the body.
+  <% end %>
+  <% component.slot(:row) do %>
+    Row one
+  <% end %>
+  <% component.slot(:row, theme: :yellow) do %>
+    Yellow row
+  <% end %>
+  <% component.slot(:footer) do %>
+    This is the footer.
+  <% end %>
+<% end %>
+```
+
 ### Inline Component
 
 ViewComponents can render without a template file, by defining a `call` method:
@@ -537,11 +664,11 @@ class TestComponentPreview < ViewComponent::Preview
 end
 ```
 
-Preview classes live in `test/components/previews`, which can be configured using the `preview_path` option:
+Preview classes live in `test/components/previews`, which can be configured using the `preview_paths` option:
 
 `config/application.rb`
 ```ruby
-config.view_component.preview_path = "#{Rails.root}/lib/component_previews"
+config.view_component.preview_paths << "#{Rails.root}/lib/component_previews"
 ```
 
 Previews are served from <http://localhost:3000/rails/view_components> by default. To use a different endpoint, set the `preview_route` option:
@@ -581,7 +708,19 @@ To use component previews:
 
 `config/application.rb`
 ```ruby
-config.view_component.preview_path = "#{Rails.root}/spec/components/previews"
+config.view_component.preview_paths << "#{Rails.root}/spec/components/previews"
+```
+
+### Disabling the render monkey patch (Rails < 6.1)
+
+In order to [avoid conflicts](https://github.com/github/view_component/issues/288) between ViewComponent and other gems that also monkey patch the `render` method, it is possible to configure ViewComponent to not include the render monkey patch:
+
+`config.view_component.render_monkey_patch_enabled = false # defaults to true`
+
+With the monkey patch disabled, use `render_component` (or  `render_component_to_string`) instead:
+
+```
+<%= render_component Component.new(message: "bar") %>
 ```
 
 ### Sidecar assets (experimental)
@@ -731,7 +870,8 @@ ViewComponent is far from a novel idea! Popular implementations of view componen
 ## Resources
 
 - [Encapsulating Views, RailsConf 2020](https://youtu.be/YVYRus_2KZM)
-- [Rethinking the View Layer with Components - Ruby Rogues Podcast](https://devchat.tv/ruby-rogues/rr-461-rethinking-the-view-layer-with-components-with-joel-hawksley/)
+- [Rethinking the View Layer with Components, Ruby Rogues Podcast](https://devchat.tv/ruby-rogues/rr-461-rethinking-the-view-layer-with-components-with-joel-hawksley/)
+- [ViewComponents in Action with Andrew Mason, Ruby on Rails Podcast](https://5by5.tv/rubyonrails/320)
 - [ViewComponent at GitHub with Joel Hawksley](https://the-ruby-blend.fireside.fm/9)
 - [Components, HAML vs ERB, and Design Systems](https://the-ruby-blend.fireside.fm/4)
 - [Choosing the Right Tech Stack with Dave Paola](https://5by5.tv/rubyonrails/307)
@@ -784,10 +924,15 @@ ViewComponent is built by:
 |@simonrand|@fugufish|@cover|@franks921|@fsateler|
 |Dublin, Ireland|Salt Lake City, Utah|Barcelona|South Africa|Chile|
 
-|<img src="https://avatars.githubusercontent.com/maxbeizer?s=256" alt="maxbeizer" width="128" />|<img src="https://avatars.githubusercontent.com/franco?s=256" alt="franco" width="128" />|<img src="https://avatars.githubusercontent.com/tbroad-ramsey?s=256" alt="tbroad-ramsey" width="128" />|
-|:---:|:---:|:---:|
-|@maxbeizer|@franco|@tbroad-ramsey|
-|Nashville, TN|Switzerland|Spring Hill, TN|
+|<img src="https://avatars.githubusercontent.com/maxbeizer?s=256" alt="maxbeizer" width="128" />|<img src="https://avatars.githubusercontent.com/franco?s=256" alt="franco" width="128" />|<img src="https://avatars.githubusercontent.com/tbroad-ramsey?s=256" alt="tbroad-ramsey" width="128" />|<img src="https://avatars.githubusercontent.com/jensljungblad?s=256" alt="jensljungblad" width="128" />|<img src="https://avatars.githubusercontent.com/bbugh?s=256" alt="bbugh" width="128" />|
+|:---:|:---:|:---:|:---:|:---:|
+|@maxbeizer|@franco|@tbroad-ramsey|@jensljungblad|@bbugh|
+|Nashville, TN|Switzerland|Spring Hill, TN|New York, NY|Austin, TX|
+
+|<img src="https://avatars.githubusercontent.com/johannesengl?s=256" alt="johannesengl" width="128" />|<img src="https://avatars.githubusercontent.com/czj?s=256" alt="czj" width="128" />|
+|:---:|:---:|
+|@johannesengl|@czj|
+|Berlin, Germany|Paris, France|
 
 ## License
 

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/previewable"
+require "view_component/slotable"
 
 module ViewComponent
   class Base < ActionView::Base
@@ -17,6 +18,10 @@ 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
@@ -157,12 +162,15 @@ module ViewComponent
     mattr_accessor :test_controller
     @@test_controller = "ApplicationController"
 
+    # Configure if render monkey patches should be included or not in Rails <6.1.
+    mattr_accessor :render_monkey_patch_enabled, instance_writer: false, default: true
+
     class << self
       attr_accessor :source_location
 
       # Render a component collection.
-      def with_collection(*args)
-        Collection.new(self, *args)
+      def with_collection(collection, **args)
+        Collection.new(self, collection, **args)
       end
 
       # Provide identifier for ActionView template annotations
@@ -181,6 +189,10 @@ module ViewComponent
         # has been re-defined by the consuming application, likely in ApplicationComponent.
         child.source_location = caller_locations(1, 10).reject { |l| l.label == "inherited" }[0].absolute_path
 
+        # Clone slot configuration into child class
+        # see #test_slots_pollution
+        child.slots = self.slots.clone
+
         super
       end
 

data/lib/view_component/collection.rb

@@ -9,7 +9,7 @@ module ViewComponent
       @component.validate_collection_parameter!(validate_default: true)
 
       @collection.map do |item|
-        content = @component.new(component_options(item, iterator)).render_in(view_context, &block)
+        content = @component.new(**component_options(item, iterator)).render_in(view_context, &block)
         iterator.iterate!
         content
       end.join.html_safe

data/lib/view_component/engine.rb

@@ -6,15 +6,24 @@ require "view_component"
 module ViewComponent
   class Engine < Rails::Engine # :nodoc:
     config.view_component = ActiveSupport::OrderedOptions.new
+    config.view_component.preview_paths ||= []
 
     initializer "view_component.set_configs" do |app|
       options = app.config.view_component
 
+      options.render_monkey_patch_enabled = true if options.render_monkey_patch_enabled.nil?
       options.show_previews = Rails.env.development? if options.show_previews.nil?
       options.preview_route ||= ViewComponent::Base.preview_route
 
       if options.show_previews
-        options.preview_path ||= defined?(Rails.root) ? "#{Rails.root}/test/components/previews" : nil
+        options.preview_paths << "#{Rails.root}/test/components/previews" if defined?(Rails.root)
+
+        if options.preview_path.present?
+          ActiveSupport::Deprecation.warn(
+            "`preview_path` will be removed in v3.0.0. Use `preview_paths` instead."
+          )
+          options.preview_paths << options.preview_path
+        end
       end
 
       ActiveSupport.on_load(:view_component) do
@@ -42,21 +51,35 @@ module ViewComponent
       end
     end
 
-    initializer "view_component.monkey_patch_render" do
+    initializer "view_component.monkey_patch_render" do |app|
+      next if Rails.version.to_f >= 6.1 || !app.config.view_component.render_monkey_patch_enabled
+
       ActiveSupport.on_load(:action_view) do
-        if Rails.version.to_f < 6.1
-          require "view_component/render_monkey_patch"
-          ActionView::Base.prepend ViewComponent::RenderMonkeyPatch
-        end
+        require "view_component/render_monkey_patch"
+        ActionView::Base.prepend ViewComponent::RenderMonkeyPatch
       end
 
       ActiveSupport.on_load(:action_controller) do
-        if Rails.version.to_f < 6.1
-          require "view_component/rendering_monkey_patch"
-          require "view_component/render_to_string_monkey_patch"
-          ActionController::Base.prepend ViewComponent::RenderingMonkeyPatch
-          ActionController::Base.prepend ViewComponent::RenderToStringMonkeyPatch
-        end
+        require "view_component/rendering_monkey_patch"
+        require "view_component/render_to_string_monkey_patch"
+        ActionController::Base.prepend ViewComponent::RenderingMonkeyPatch
+        ActionController::Base.prepend ViewComponent::RenderToStringMonkeyPatch
+      end
+    end
+
+    initializer "view_component.include_render_component" do |app|
+      next if Rails.version.to_f >= 6.1
+
+      ActiveSupport.on_load(:action_view) do
+        require "view_component/render_component_helper"
+        ActionView::Base.include ViewComponent::RenderComponentHelper
+      end
+
+      ActiveSupport.on_load(:action_controller) do
+        require "view_component/rendering_component_helper"
+        require "view_component/render_component_to_string_helper"
+        ActionController::Base.include ViewComponent::RenderingComponentHelper
+        ActionController::Base.include ViewComponent::RenderComponentToStringHelper
       end
     end
 

data/lib/view_component/preview.rb

@@ -65,13 +65,13 @@ module ViewComponent # :nodoc:
       private
 
       def load_previews
-        if preview_path
+        Array(preview_paths).each do |preview_path|
           Dir["#{preview_path}/**/*_preview.rb"].sort.each { |file| require_dependency file }
         end
       end
 
-      def preview_path
-        Base.preview_path
+      def preview_paths
+        Base.preview_paths
       end
 
       def show_previews

data/lib/view_component/previewable.rb

@@ -9,8 +9,11 @@ module ViewComponent # :nodoc:
     included do
       # Set the location of component previews through app configuration:
       #
-      #     config.view_component.preview_path = "#{Rails.root}/lib/component_previews"
+      #     config.view_component.preview_paths << "#{Rails.root}/lib/component_previews"
       #
+      mattr_accessor :preview_paths, instance_writer: false
+
+      # TODO: deprecated, remove in v3.0.0
       mattr_accessor :preview_path, instance_writer: false
 
       # Enable or disable component previews through app configuration:

data/lib/view_component/render_component_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module RenderComponentHelper # :nodoc:
+    def render_component(component, &block)
+      component.render_in(self, &block)
+    end
+  end
+end

data/lib/view_component/render_component_to_string_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module RenderComponentToStringHelper # :nodoc:
+    def render_component_to_string(component)
+      component.render_in(self.view_context)
+    end
+  end
+end

data/lib/view_component/rendering_component_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module RenderingComponentHelper # :nodoc:
+    def render_component(component)
+      self.response_body = component.render_in(self.view_context)
+    end
+  end
+end

data/lib/view_component/slot.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  class Slot
+    attr_accessor :content
+  end
+end

data/lib/view_component/slotable.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+require "view_component/slot"
+
+module ViewComponent
+  module Slotable
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # support initializing slots as:
+      #
+      # with_slot(
+      #   :header,
+      #   collection: true|false,
+      #   class_name: "Header" # class name string, used to instantiate Slot
+      # )
+      def with_slot(*slot_names, collection: false, class_name: nil)
+        slot_names.each do |slot_name|
+          # Ensure slot_name is not already declared
+          if self.slots.key?(slot_name)
+            raise ArgumentError.new("#{slot_name} slot declared multiple times")
+          end
+
+          # Ensure slot name is not :content
+          if slot_name == :content
+            raise ArgumentError.new ":content is a reserved slot name. Please use another name, such as ':body'"
+          end
+
+          # Set the name of the method used to access the Slot(s)
+          accessor_name =
+            if collection
+              # If Slot is a collection, set the accessor
+              # name to the pluralized form of the slot name
+              # For example: :tab => :tabs
+              ActiveSupport::Inflector.pluralize(slot_name)
+            else
+              slot_name
+            end
+
+          instance_variable_name = "@#{accessor_name}"
+
+          # If the slot is a collection, define an accesor that defaults to an empty array
+          if collection
+            class_eval <<-RUBY
+              def #{accessor_name}
+                #{instance_variable_name} ||= []
+              end
+            RUBY
+          else
+            attr_reader accessor_name
+          end
+
+          # Default class_name to ViewComponent::Slot
+          class_name = "ViewComponent::Slot" unless class_name.present?
+
+          # Register the slot on the component
+          self.slots[slot_name] = {
+            class_name: class_name,
+            instance_variable_name: instance_variable_name,
+            collection: collection
+          }
+        end
+      end
+    end
+
+    # Build a Slot instance on a component,
+    # exposing it for use inside the
+    # component template.
+    #
+    # slot: Name of Slot, in symbol form
+    # **args: Arguments to be passed to Slot initializer
+    #
+    # For example:
+    # <%= render(SlotsComponent.new) do |component| %>
+    #   <% component.slot(:footer, class_names: "footer-class") do %>
+    #     <p>This is my footer!</p>
+    #   <% end %>
+    # <% end %>
+    #
+    def slot(slot_name, **args, &block)
+      # Raise ArgumentError if `slot` does not exist
+      unless slots.keys.include?(slot_name)
+        raise ArgumentError.new "Unknown slot '#{slot_name}' - expected one of '#{slots.keys}'"
+      end
+
+      slot = slots[slot_name]
+
+      # The class name of the Slot, such as Header
+      slot_class = self.class.const_get(slot[:class_name])
+
+      unless slot_class <= ViewComponent::Slot
+        raise ArgumentError.new "#{slot[:class_name]} must inherit from ViewComponent::Slot"
+      end
+
+      # Instantiate Slot class, accommodating Slots that don't accept arguments
+      slot_instance = args.present? ? slot_class.new(**args) : slot_class.new
+
+      # Capture block and assign to slot_instance#content
+      slot_instance.content = view_context.capture(&block) if block_given?
+
+      if slot[:collection]
+        # Initialize instance variable as an empty array
+        # if slot is a collection and has yet to be initialized
+        unless instance_variable_defined?(slot[:instance_variable_name])
+          instance_variable_set(slot[:instance_variable_name], [])
+        end
+
+        # Append Slot instance to collection accessor Array
+        instance_variable_get(slot[:instance_variable_name]) << slot_instance
+      else
+         # Assign the Slot instance to the slot accessor
+        instance_variable_set(slot[:instance_variable_name], slot_instance)
+      end
+
+      # Return nil, as this method should not output anything to the view itself.
+      nil
+    end
+  end
+end

data/lib/view_component/test_helpers.rb

@@ -14,13 +14,18 @@ module ViewComponent
         assert_no_selector("body")
       end
     rescue LoadError
-      warn "WARNING in `ViewComponent::TestHelpers`: You must add `capybara` to your Gemfile to use Capybara assertions."
+      warn "WARNING in `ViewComponent::TestHelpers`: You must add `capybara` to your Gemfile to use Capybara assertions." if ENV["DEBUG"]
     end
 
     attr_reader :rendered_component
 
     def render_inline(component, **args, &block)
-      @rendered_component = controller.view_context.render(component, args, &block)
+      @rendered_component =
+        if Rails.version.to_f >= 6.1
+          controller.view_context.render(component, args, &block)
+        else
+          controller.view_context.render_component(component, &block)
+        end
 
       Nokogiri::HTML.fragment(@rendered_component)
     end

data/lib/view_component/version.rb

@@ -3,8 +3,8 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 11
-    PATCH = 0
+    MINOR = 14
+    PATCH = 1
 
     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.11.0
+  version: 2.14.1
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-16 00:00:00.000000000 Z
+date: 2020-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -204,9 +204,14 @@ files:
 - lib/view_component/engine.rb
 - lib/view_component/preview.rb
 - lib/view_component/previewable.rb
+- lib/view_component/render_component_helper.rb
+- lib/view_component/render_component_to_string_helper.rb
 - lib/view_component/render_monkey_patch.rb
 - lib/view_component/render_to_string_monkey_patch.rb
+- lib/view_component/rendering_component_helper.rb
 - lib/view_component/rendering_monkey_patch.rb
+- lib/view_component/slot.rb
+- lib/view_component/slotable.rb
 - lib/view_component/template_error.rb
 - lib/view_component/test_case.rb
 - lib/view_component/test_helpers.rb