view_component 2.17.0 → 2.19.0

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/app/views/view_components/preview.html.erb

@@ -1 +1,5 @@
-<%= render(@render_args[:component], @render_args[:args], &@render_args[:block])%>
+<% if ViewComponent::Base.render_monkey_patch_enabled || Rails.version.to_f >= 6.1 %>
+  <%= render(@render_args[:component], @render_args[:args], &@render_args[:block])%>
+<% else %>
+  <%= render_component(@render_args[:component], &@render_args[:block])%>
+<% end %>

data/lib/view_component/base.rb

@@ -12,6 +12,8 @@ module ViewComponent
     include ActiveSupport::Configurable
     include ViewComponent::Previewable
 
+    ViewContextCalledBeforeRenderError = Class.new(StandardError)
+
     # For CSRF authenticity tokens in forms
     delegate :form_authenticity_token, :protect_against_forgery?, :config, to: :helpers
 
@@ -108,17 +110,19 @@ module ViewComponent
     end
 
     def controller
+      raise ViewContextCalledBeforeRenderError, "`controller` can only be called at render time." if view_context.nil?
       @controller ||= view_context.controller
     end
 
     # Provides a proxy to access helper methods from the context of the current controller
     def helpers
+      raise ViewContextCalledBeforeRenderError, "`helpers` can only be called at render time." if view_context.nil?
       @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 +170,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)
@@ -179,6 +183,10 @@ module ViewComponent
       end
 
       def inherited(child)
+        # Compile so child will inherit compiled `call_*` template methods that
+        # `compile` defines
+        compile
+
         # If we're in Rails, add application url_helpers to the component context
         if defined?(Rails)
           child.include Rails.application.routes.url_helpers unless child < Rails.application.routes.url_helpers
@@ -189,6 +197,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
@@ -378,17 +389,17 @@ module ViewComponent
 
         location_without_extension = source_location.chomp(File.extname(source_location))
 
-        extenstions = ActionView::Template.template_handler_extensions.join(",")
+        extensions = ActionView::Template.template_handler_extensions.join(",")
 
-        # view files in the same directory as te component
-        sidecar_files = Dir["#{location_without_extension}.*{#{extenstions}}"]
+        # view files in the same directory as the component
+        sidecar_files = Dir["#{location_without_extension}.*{#{extensions}}"]
 
         # view files in a directory named like the component
         directory = File.dirname(source_location)
         filename = File.basename(source_location, ".rb")
         component_name = name.demodulize.underscore
 
-        sidecar_directory_files = Dir["#{directory}/#{component_name}/#{filename}.*{#{extenstions}}"]
+        sidecar_directory_files = Dir["#{directory}/#{component_name}/#{filename}.*{#{extensions}}"]
 
         (sidecar_files - [source_location] + sidecar_directory_files)
       end

data/lib/view_component/collection.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "action_view/renderer/collection_renderer" if Rails.version.to_f >= 6.1
+
 module ViewComponent
   class Collection
     def render_in(view_context, &block)

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

@@ -24,6 +24,8 @@ module ViewComponent # :nodoc:
       }
     end
 
+    alias_method :render_component, :render
+
     class << self
       # Returns all component preview classes.
       def all
@@ -42,21 +44,11 @@ module ViewComponent # :nodoc:
         result.merge(layout: @layout)
       end
 
-      # Returns the component object class associated to the preview.
-      def component
-        name.chomp("Preview").constantize
-      end
-
       # Returns all of the available examples for the component preview.
       def examples
         public_instance_methods(false).map(&:to_s).sort
       end
 
-      # Returns +true+ if the example of the component preview exists.
-      def example_exists?(example)
-        examples.include?(example)
-      end
-
       # Returns +true+ if the preview exists.
       def exists?(preview)
         all.any? { |p| p.preview_name == preview }
@@ -102,10 +94,6 @@ module ViewComponent # :nodoc:
       def preview_paths
         Base.preview_paths
       end
-
-      def show_previews
-        Base.show_previews
-      end
     end
   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).strip.html_safe 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/test_helpers.rb

@@ -14,7 +14,11 @@ module ViewComponent
         assert_no_selector("body")
       end
     rescue LoadError
+      # We don't have a test case for running an application without capybara installed.
+      # It's probably fine to leave this without coverage.
+      # :nocov:
       warn "WARNING in `ViewComponent::TestHelpers`: You must add `capybara` to your Gemfile to use Capybara assertions." if ENV["DEBUG"]
+      # :nocov:
     end
 
     attr_reader :rendered_component

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 17
+    MINOR = 19
     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.17.0
+  version: 2.19.0
 platform: ruby
 authors:
 - GitHub Open Source
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2020-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,6 +30,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -157,20 +171,20 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.18.0
 - !ruby/object:Gem::Dependency
-  name: simplecov-erb
+  name: simplecov-console
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.7.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
-description: 
+        version: 0.7.2
+description:
 email:
 - opensource+view_component@github.com
 executables: []
@@ -222,7 +236,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -238,7 +252,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: []