view_component 2.17.1 → 2.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76647927ca9d6adc1f23b0f7acc97f65e411ecf7c3d68ffb3b210ada62031b81
-  data.tar.gz: d76bb0c82db7d35dd6f49b4bff446a34b80a7058d238d0aa118d2dd9c47bd60a
+  metadata.gz: 6fcbca08ed9ca2f6cf62a7ad154dc297ba4606a62faf0aebeeaa544c2c76a663
+  data.tar.gz: 677f442dbcf86d4ca7cfbf4d3ad71a8cb92756ddfeb85afb3b973bd1238a56b2
 SHA512:
-  metadata.gz: 2a58fbf794f76e90f29d7b0fbf948041bcfd84df62629b21ee61372fe469cd5718228514ecd88b2db5f29d703a39b8c8f082bce0cea60649bac6dfea7ad76bc7
-  data.tar.gz: add095b1e488f653742934fb7c773951dd579e40884621ca538edc3b533d056c4fc6f6c61dc7488eb6a86cf7fb49a6f98093702693c5fc4148dfcedf9622f88e
+  metadata.gz: bd47863117cc291707ccee9b3bed69daeea0dd432cead045f6d8211ad201bbec34a23132836815751f9a5df64ab92fd3724dc3bf61e03282741d3d468e7c1faa
+  data.tar.gz: 150ebb993d9cdca790ffa437540cb454bea5021350a5a5f96b7596cb522b552a8507c5456e3353b6e2c7ee2df6edfb5eb5b92815f81c38996cb47c5e7351c324

data/CHANGELOG.md

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

data/README.md

@@ -674,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`
@@ -990,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" />|<img src="https://avatars.githubusercontent.com/mrrooijen?s=256" alt="mrrooijen" width="128" />|
-|:---:|:---:|:---:|
-|@johannesengl|@czj|@mrrooijen|
-|Berlin, Germany|Paris, France|The Netherlands|
+|<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,22 +16,23 @@ 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]
+      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?
+      opts[:layout] = layout if layout.present? || layout == false
       opts[:locals] = locals if locals.present?
       render template, opts # rubocop:disable GitHub/RailsControllerRenderLiteral
     end
@@ -39,6 +40,10 @@ class ViewComponentsController < Rails::ApplicationController # :nodoc:
 
   private
 
+  def default_preview_layout # :doc:
+    ViewComponent::Base.default_preview_layout
+  end
+
   def show_previews? # :doc:
     ViewComponent::Base.show_previews
   end
@@ -61,6 +66,24 @@ 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

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

@@ -3,8 +3,8 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 17
-    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.17.1
+  version: 2.18.0
 platform: ruby
 authors:
 - GitHub Open Source
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-22 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: []
@@ -222,7 +222,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -238,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: []