view_component 2.14.1 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '084152c558b71f87f41d620f9cdce42e689e0b4159cdfa68f3cb041a7bbea3ba'
-  data.tar.gz: 45324159a07873ce92562650fe7c2ad6e8a279c3db216b3460a6075f71033180
+  metadata.gz: 9e01b3b2899158831379c51c72086d84ca838b829a9638eeaec381aa287fa8c8
+  data.tar.gz: fab254768f2f88651ed2c89e9e09ef5fa7e50524dad061435e5abd4e7de1a4ae
 SHA512:
-  metadata.gz: 58f994aac7efdf81146972a351a12726131658e4ccbd8bf0661eb135d7935ff396c64752d9f9edd6dda50b90a4829aeb506f24edee712279aa1cf4bf4f15886d
-  data.tar.gz: 430b55482aaafaea6a27e73593861f897620cb635c2a2f14f14b5a772846a8f5a7b42bd973f637cd587816762891bcc432ced92dbac04fe1d391bf7734873a6a
+  metadata.gz: b1ce90df482ab031bf57b808ec1cd0015774d3061733ae4e934d18a8b569e0aa6d22ac71107016ca0ab73f76acb720c7113d21daba2a74a5d313f53ae245e435
+  data.tar.gz: 96e33d8a65235bf8831ce07aec2f13b5bec2617be30c2a11cca2fa969516d167be4eaf2390a6296db2f1e61f1523115e2fd53aa6af1e39a6d661f85a03baf626

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # master
 
+# 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.

data/README.md

@@ -680,6 +680,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:

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/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/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,6 +77,20 @@ 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

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

@@ -3,8 +3,8 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 14
-    PATCH = 1
+    MINOR = 15
+    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.14.1
+  version: 2.15.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-10 00:00:00.000000000 Z
+date: 2020-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -203,6 +203,7 @@ 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