view_component 2.12.0 → 2.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8661a26312dc3649e30ee17fbc94f6fd73be410067f8a7fac8b6aaefc4338d11
-  data.tar.gz: 1024034624c49bb65bfe1fc3466886ffa60cd9699a58c7427ea6dbedb9baa03b
+  metadata.gz: 9ccdcdb195fbc49953c3663294a7345eb012f88344d1375456a07c6ef781b1d8
+  data.tar.gz: b2cf7cb1139e318f2ca7712242e610c31a42c78448a5d3151db1550a41e00355
 SHA512:
-  metadata.gz: 24ddc5373c2fbb7cd81ef4f4077ea66a30ea797fbb9d4c444135d3d8590b5151596fddc18f5bc5e1f18fec65ca87572858513409385489524c11c1929cff3567
-  data.tar.gz: cf63eb464e88e02310cb55f9c6c779c31622174777dbd1f39a24d0e9ac40407c555ac51012c5ea8c06bdeccac7aab880475c02c678c3fbff9ef22f5ca6cf797e
+  metadata.gz: 72657816a14d62166791f37d2f83cfd81efe8f186678bcf21e40c50d38d64663fbc4e2b9fe881820ba26f2a7ea258d5d6c0cb47a73132d5443f66db3489d1921
+  data.tar.gz: e7abe1071862dfb3208e2615176fd352b0f6cd6e7ef947b1dfb4528e435682908cd01ab8091b33612b234eebf7121a7dd00e5cb8890bc6ae1160fdf5bcbdcd3f

data/CHANGELOG.md

@@ -1,5 +1,50 @@
 # master
 
+# 2.16.0
+
+* Add `--sidecar` option to the erb, haml and slim generators. Places the generated template in the sidecar directory.
+
+    *Michael van Rooijen*
+
+# 2.15.0
+
+* Add support for templates as ViewComponent::Preview examples.
+
+    *Juan Manuel Ramallo
+
+# 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.

data/README.md

@@ -341,15 +341,25 @@ As an alternative, views and other assets can be placed in a sidecar directory w
 ```
 app/components
 ├── ...
-├── test_component.rb
-├── test_component
-|   ├── test_component.css
-|   ├── test_component.html.erb
-|   └── test_component.js
+├── example_component.rb
+├── example_component
+|   ├── example_component.css
+|   ├── example_component.html.erb
+|   └── example_component.js
 ├── ...
 
 ```
 
+To generate a component with a sidecar directory, use the `--sidecar` flag:
+
+```
+bin/rails generate component Example title content --sidecar
+      invoke  test_unit
+      create  test/components/example_component_test.rb
+      create  app/components/example_component.rb
+      create  app/components/example_component/example_component.html.erb
+```
+
 ### Conditional Rendering
 
 Components can implement a `#render?` method to be called after initialization to determine if the component should render.
@@ -664,11 +674,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:
@@ -680,6 +690,57 @@ config.view_component.preview_route = "/previews"
 
 This example will make the previews available from <http://localhost:3000/previews>.
 
+#### Preview templates
+
+Given a preview `test/components/previews/cell_component_preview.rb`, template files can be defined at `test/components/previews/cell_component_preview/`:
+
+`test/components/previews/cell_component_preview.rb`
+```ruby
+class CellComponentPreview < ViewComponent::Preview
+  def default
+  end
+end
+```
+
+`test/components/previews/cell_component_preview/default.html.erb`
+```erb
+<table class="table">
+  <tbody>
+    <tr>
+      <%= render CellComponent.new %>
+    </tr>
+  </tbody>
+</div>
+```
+
+To use a different location for preview templates, pass the `template` argument:
+(the path should be relative to `config.view_component.preview_path`):
+
+`test/components/previews/cell_component_preview.rb`
+```ruby
+class CellComponentPreview < ViewComponent::Preview
+  def default
+    render_with_template(template: 'custom_cell_component_preview/my_preview_template')
+  end
+end
+```
+
+Values from `params` can be accessed through `locals`:
+
+`test/components/previews/cell_component_preview.rb`
+```ruby
+class CellComponentPreview < ViewComponent::Preview
+  def default(title: "Default title", subtitle: "A subtitle")
+    render_with_template(locals: {
+      title: title,
+      subtitle: subtitle
+    })
+  end
+end
+```
+
+Which enables passing in a value with <http://localhost:3000/rails/components/cell_component/default?title=Custom+title&subtitle=Another+subtitle>.
+
 #### Configuring TestController
 
 Component tests and previews assume the existence of an `ApplicationController` class, which be can be configured using the `test_controller` option:
@@ -708,7 +769,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)
@@ -917,6 +990,11 @@ ViewComponent is built by:
 |@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" />|<img src="https://avatars.githubusercontent.com/mrrooijen?s=256" alt="mrrooijen" width="128" />|
+|:---:|:---:|:---:|
+|@johannesengl|@czj|@mrrooijen|
+|Berlin, Germany|Paris, France|The Netherlands|
+
 ## License
 
 ViewComponent is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/app/controllers/view_components_controller.rb

@@ -24,11 +24,16 @@ class ViewComponentsController < Rails::ApplicationController # :nodoc:
       render "view_components/previews"
     else
       prepend_application_view_paths
+      prepend_preview_examples_view_path
       @example_name = File.basename(params[:path])
       @render_args = @preview.render_args(@example_name, params: params.permit!)
       layout = @render_args[:layout]
-      opts = layout.nil? ? {} : { layout: layout }
-      render "view_components/preview", opts
+      template = @render_args[:template]
+      locals = @render_args[:locals]
+      opts = {}
+      opts[:layout] = layout if layout.present?
+      opts[:locals] = locals if locals.present?
+      render template, opts # rubocop:disable GitHub/RailsControllerRenderLiteral
     end
   end
 
@@ -59,4 +64,8 @@ class ViewComponentsController < Rails::ApplicationController # :nodoc:
   def prepend_application_view_paths
     prepend_view_path Rails.root.join("app/views") if defined?(Rails.root)
   end
+
+  def prepend_preview_examples_view_path
+    prepend_view_path(ViewComponent::Base.preview_paths)
+  end
 end

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

@@ -6,13 +6,22 @@ module Erb
   module Generators
     class ComponentGenerator < Base
       source_root File.expand_path("templates", __dir__)
+      class_option :sidecar, type: :boolean, default: false
 
       def copy_view_file
-        template "component.html.erb", File.join("app/components", class_path, "#{file_name}_component.html.erb")
+        template "component.html.erb", destination
       end
 
       private
 
+      def destination
+        if options["sidecar"]
+          File.join("app/components", class_path, "#{file_name}_component", "#{file_name}_component.html.erb")
+        else
+          File.join("app/components", class_path, "#{file_name}_component.html.erb")
+        end
+      end
+
       def file_name
         @_file_name ||= super.sub(/_component\z/i, "")
       end

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

@@ -6,13 +6,22 @@ module Haml
   module Generators
     class ComponentGenerator < Erb::Generators::ComponentGenerator
       source_root File.expand_path("templates", __dir__)
+      class_option :sidecar, type: :boolean, default: false
 
       def copy_view_file
-        template "component.html.haml", File.join("app/components", class_path, "#{file_name}_component.html.haml")
+        template "component.html.haml", destination
       end
 
       private
 
+      def destination
+        if options["sidecar"]
+          File.join("app/components", class_path, "#{file_name}_component", "#{file_name}_component.html.haml")
+        else
+          File.join("app/components", class_path, "#{file_name}_component.html.haml")
+        end
+      end
+
       def file_name
         @_file_name ||= super.sub(/_component\z/i, "")
       end

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

@@ -6,13 +6,22 @@ module Slim
   module Generators
     class ComponentGenerator < Erb::Generators::ComponentGenerator
       source_root File.expand_path("templates", __dir__)
+      class_option :sidecar, type: :boolean, default: false
 
       def copy_view_file
-        template "component.html.slim", File.join("app/components", class_path, "#{file_name}_component.html.slim")
+        template "component.html.slim", destination
       end
 
       private
 
+      def destination
+        if options["sidecar"]
+          File.join("app/components", class_path, "#{file_name}_component", "#{file_name}_component.html.slim")
+        else
+          File.join("app/components", class_path, "#{file_name}_component.html.slim")
+        end
+      end
+
       def file_name
         @_file_name ||= super.sub(/_component\z/i, "")
       end

data/lib/view_component.rb

@@ -7,6 +7,7 @@ module ViewComponent
 
   autoload :Base
   autoload :Preview
+  autoload :PreviewTemplateError
   autoload :TestHelpers
   autoload :TestCase
   autoload :TemplateError

data/lib/view_component/base.rb

@@ -162,6 +162,9 @@ 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
 

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

@@ -8,7 +8,20 @@ module ViewComponent # :nodoc:
     extend ActiveSupport::DescendantsTracker
 
     def render(component, **args, &block)
-      { component: component, args: args, block: block }
+      {
+        args: args,
+        block: block,
+        component: component,
+        locals: {},
+        template: "view_components/preview",
+      }
+    end
+
+    def render_with_template(template: nil, locals: {})
+      {
+        template: template,
+        locals: locals
+      }
     end
 
     class << self
@@ -23,6 +36,8 @@ module ViewComponent # :nodoc:
         example_params_names = instance_method(example).parameters.map(&:last)
         provided_params = params.slice(*example_params_names).to_h.symbolize_keys
         result = provided_params.empty? ? new.public_send(example) : new.public_send(example, **provided_params)
+        result ||= {}
+        result[:template] = preview_example_template_path(example) if result[:template].nil?
         @layout = nil unless defined?(@layout)
         result.merge(layout: @layout)
       end
@@ -62,16 +77,30 @@ module ViewComponent # :nodoc:
         @layout = layout_name
       end
 
+      # Returns the relative path (from preview_path) to the preview example template if the template exists
+      def preview_example_template_path(example)
+        preview_path = Array(preview_paths).detect do |preview_path|
+          Dir["#{preview_path}/#{preview_name}_preview/#{example}.html.*"].first
+        end
+
+        if preview_path.nil?
+          raise PreviewTemplateError, "preview template for example #{example} does not exist"
+        end
+
+        path = Dir["#{preview_path}/#{preview_name}_preview/#{example}.html.*"].first
+        Pathname.new(path).relative_path_from(Pathname.new(preview_path)).to_s
+      end
+
       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/preview_template_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  class PreviewTemplateError < StandardError
+  end
+end

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/slotable.rb

@@ -95,7 +95,7 @@ module ViewComponent
       end
 
       # Instantiate Slot class, accommodating Slots that don't accept arguments
-      slot_instance = args.present? ? slot_class.new(args) : slot_class.new
+      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?

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,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 12
+    MINOR = 16
     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.12.0
+  version: 2.16.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2020-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -203,9 +203,13 @@ files:
 - lib/view_component/compile_cache.rb
 - lib/view_component/engine.rb
 - lib/view_component/preview.rb
+- lib/view_component/preview_template_error.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