view_component 2.14.1 → 2.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '084152c558b71f87f41d620f9cdce42e689e0b4159cdfa68f3cb041a7bbea3ba'
-  data.tar.gz: 45324159a07873ce92562650fe7c2ad6e8a279c3db216b3460a6075f71033180
+  metadata.gz: 6fcbca08ed9ca2f6cf62a7ad154dc297ba4606a62faf0aebeeaa544c2c76a663
+  data.tar.gz: 677f442dbcf86d4ca7cfbf4d3ad71a8cb92756ddfeb85afb3b973bd1238a56b2
 SHA512:
-  metadata.gz: 58f994aac7efdf81146972a351a12726131658e4ccbd8bf0661eb135d7935ff396c64752d9f9edd6dda50b90a4829aeb506f24edee712279aa1cf4bf4f15886d
-  data.tar.gz: 430b55482aaafaea6a27e73593861f897620cb635c2a2f14f14b5a772846a8f5a7b42bd973f637cd587816762891bcc432ced92dbac04fe1d391bf7734873a6a
+  metadata.gz: bd47863117cc291707ccee9b3bed69daeea0dd432cead045f6d8211ad201bbec34a23132836815751f9a5df64ab92fd3724dc3bf61e03282741d3d468e7c1faa
+  data.tar.gz: 150ebb993d9cdca790ffa437540cb454bea5021350a5a5f96b7596cb522b552a8507c5456e3353b6e2c7ee2df6edfb5eb5b92815f81c38996cb47c5e7351c324

data/CHANGELOG.md

@@ -1,5 +1,43 @@
 # master
 
+# 2.18.0
+
+* Fix auto-loading of previews (changes no longer require a server restart)
+
+    *Matt Brictson*
+
+* Add `default_preview_layout` configuration option to load custom app/views/layouts.
+
+    *Jared White, Juan Manuel Ramallo*
+
+* Calculate virtual_path once for all instances of a component class to improve performance.
+
+    *Brad Parker*
+
+# 2.17.1
+
+* Fix bug where rendering Slot with empty block resulted in error.
+
+    *Joel Hawksley*
+
+# 2.17.0
+
+* Slots return stripped HTML, removing leading and trailing whitespace.
+
+    *Jason Long, Joel Hawksley*
+
+# 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.

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,6 +674,14 @@ class TestComponentPreview < ViewComponent::Preview
 end
 ```
 
+You can also set a custom layout to be used by default for previews as well as the preview index pages via the `default_preview_layout` configuration option:
+
+`config/application.rb`
+```ruby
+# Set the default layout to app/views/layouts/component_preview.html.erb
+config.default_preview_layout = "component_preview"
+```
+
 Preview classes live in `test/components/previews`, which can be configured using the `preview_paths` option:
 
 `config/application.rb`
@@ -680,6 +698,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:
@@ -929,10 +998,10 @@ 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" />|
-|:---:|:---:|
-|@johannesengl|@czj|
-|Berlin, Germany|Paris, France|
+|<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" />|<img src="https://avatars.githubusercontent.com/bradparker?s=256" alt="bradparker" width="128" />|<img src="https://avatars.githubusercontent.com/mattbrictson?s=256" alt="mattbrictson" width="128" />|
+|:---:|:---:|:---:|:---:|:---:|
+|@johannesengl|@czj|@mrrooijen|@bradparker|@mattbrictson|
+|Berlin, Germany|Paris, France|The Netherlands|Brisbane, Australia|San Francisco|
 
 ## License
 

data/app/controllers/view_components_controller.rb

@@ -16,24 +16,34 @@ class ViewComponentsController < Rails::ApplicationController # :nodoc:
   def index
     @previews = ViewComponent::Preview.all
     @page_title = "Component Previews"
+    render "view_components/index", **determine_layout
   end
 
   def previews
     if params[:path] == @preview.preview_name
       @page_title = "Component Previews for #{@preview.preview_name}"
-      render "view_components/previews"
+      render "view_components/previews", **determine_layout
     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
+      layout = determine_layout(@render_args[:layout], prepend_views: false)[:layout]
+      template = @render_args[:template]
+      locals = @render_args[:locals]
+      opts = {}
+      opts[:layout] = layout if layout.present? || layout == false
+      opts[:locals] = locals if locals.present?
+      render template, opts # rubocop:disable GitHub/RailsControllerRenderLiteral
     end
   end
 
   private
 
+  def default_preview_layout # :doc:
+    ViewComponent::Base.default_preview_layout
+  end
+
   def show_previews? # :doc:
     ViewComponent::Base.show_previews
   end
@@ -56,7 +66,29 @@ class ViewComponentsController < Rails::ApplicationController # :nodoc:
     end
   end
 
+  # Returns either {} or {layout: value} depending on configuration
+  def determine_layout(layout_override = nil, prepend_views: true)
+    return {} unless defined?(Rails.root)
+
+    layout_declaration = {}
+
+    if !layout_override.nil?
+      # Allow component-level override, even if false (thus no layout rendered)
+      layout_declaration[:layout] = layout_override
+    elsif default_preview_layout.present?
+      layout_declaration[:layout] = default_preview_layout
+    end
+
+    prepend_application_view_paths if layout_declaration[:layout].present? && prepend_views
+
+    layout_declaration
+  end
+
   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

@@ -116,9 +116,9 @@ module ViewComponent
       @helpers ||= controller.view_context
     end
 
-    # Removes the first part of the path and the extension.
+    # Exposes .virutal_path as an instance method
     def virtual_path
-      self.class.source_location.gsub(%r{(.*app/components)|(\.rb)}, "")
+      self.class.virtual_path
     end
 
     # For caching, such as #cache_if
@@ -166,7 +166,7 @@ module ViewComponent
     mattr_accessor :render_monkey_patch_enabled, instance_writer: false, default: true
 
     class << self
-      attr_accessor :source_location
+      attr_accessor :source_location, :virtual_path
 
       # Render a component collection.
       def with_collection(collection, **args)
@@ -189,6 +189,9 @@ 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
 
+        # 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

data/lib/view_component/engine.rb

@@ -34,8 +34,8 @@ module ViewComponent
     initializer "view_component.set_autoload_paths" do |app|
       options = app.config.view_component
 
-      if options.show_previews && options.preview_path
-        ActiveSupport::Dependencies.autoload_paths << options.preview_path
+      if options.show_previews && !options.preview_paths.empty?
+        ActiveSupport::Dependencies.autoload_paths.concat(options.preview_paths)
       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,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/previewable.rb

@@ -7,6 +7,14 @@ module ViewComponent # :nodoc:
     extend ActiveSupport::Concern
 
     included do
+      # Set a custom default preview layout through app configuration:
+      #
+      #     config.view_component.default_preview_layout = "component_preview"
+      #
+      # This affects preview index pages as well as individual component previews
+      #
+      mattr_accessor :default_preview_layout, instance_writer: false
+
       # Set the location of component previews through app configuration:
       #
       #     config.view_component.preview_paths << "#{Rails.root}/lib/component_previews"

data/lib/view_component/slotable.rb

@@ -98,7 +98,7 @@ module ViewComponent
       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?
+      slot_instance.content = view_context.capture(&block).to_s.strip.html_safe if block_given?
 
       if slot[:collection]
         # Initialize instance variable as an empty array

data/lib/view_component/version.rb

@@ -3,8 +3,8 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 14
-    PATCH = 1
+    MINOR = 18
+    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.18.0
 platform: ruby
 authors:
 - GitHub Open Source
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-10 00:00:00.000000000 Z
+date: 2020-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -170,7 +170,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
-description: 
+description:
 email:
 - opensource+view_component@github.com
 executables: []
@@ -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
@@ -221,7 +222,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -237,7 +238,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: []