view_component 2.65.0 → 2.68.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db3da8b9e69982d34a963e91a36a872b8c09a83526b142e51c0cf9548c0d704e
-  data.tar.gz: 305ea910ad67535dd4769d3c570bb11a3ef37aea09118174b0861ec7089ee234
+  metadata.gz: dc70b125c7bf45480588c0161df7993d19ce3f3c67f9303c2e7c09d836bc3b5e
+  data.tar.gz: 7cbaec3b7b25d762cfc8068f932520135c4e989a549754cdb9733d6c356853f0
 SHA512:
-  metadata.gz: 842babf3fd5a9c1e15c803e2605e6e4891b08c0766948f1e5a0e72bdaaf0b129a8b26959684adb8be257d295681ef241e3c828651a72e1badda342382cfca662
-  data.tar.gz: 920553b0b73da80802fb940821fb454cf7587063d7df89630f4fb9425c123b38cfc5e3e49b912022a556a8207f6ca8e6e47662d86056dbf603c548eb9197dee2
+  metadata.gz: 5afca6dd4a94bf0ee395fa72d577a7ce0031f590b6d6cd4c1fd7625422d71c5ebe6cce52111f9350b66803d3421cf504c694f8b35229fc726e2bd1d32dd414db
+  data.tar.gz: 185329894deb2a89735087da12093040e08a2009ba8b9fe934b83731539f93c479d130e2cd3a7d112895ad489b268167f0c8c71712ef42582921975e729eb59d

data/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 GitHub
+Copyright (c) 2018-present ViewComponent contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/app/controllers/concerns/view_component/preview_actions.rb

@@ -10,9 +10,7 @@ module ViewComponent
       around_action :set_locale, only: :previews
       before_action :require_local!, unless: :show_previews?
 
-      if respond_to?(:content_security_policy)
-        content_security_policy(false)
-      end
+      content_security_policy(false) if respond_to?(:content_security_policy)
     end
 
     def index
@@ -45,18 +43,18 @@ module ViewComponent
 
     # :doc:
     def default_preview_layout
-      ViewComponent::Base.default_preview_layout
+      ViewComponent::Base.config.default_preview_layout
     end
 
     # :doc:
     def show_previews?
-      ViewComponent::Base.show_previews
+      ViewComponent::Base.config.show_previews
     end
 
     # :doc:
     def find_preview
       candidates = []
-      params[:path].to_s.scan(%r{/|$}) { candidates << $` }
+      params[:path].to_s.scan(%r{/|$}) { candidates << Regexp.last_match.pre_match }
       preview = candidates.detect { |candidate| ViewComponent::Preview.exists?(candidate) }
 
       if preview
@@ -66,10 +64,8 @@ module ViewComponent
       end
     end
 
-    def set_locale
-      I18n.with_locale(params[:locale] || I18n.default_locale) do
-        yield
-      end
+    def set_locale(&block)
+      I18n.with_locale(params[:locale] || I18n.default_locale, &block)
     end
 
     # Returns either {} or {layout: value} depending on configuration

data/app/helpers/preview_helper.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PreviewHelper
-  AVAILABLE_PRISM_LANGUAGES = ["ruby", "erb", "haml"]
+  AVAILABLE_PRISM_LANGUAGES = %w[ruby erb haml]
   FALLBACK_LANGUAGE = "ruby"
 
   def preview_source
@@ -22,7 +22,7 @@ module PreviewHelper
       # Fetch template source via finding it through preview paths
       # to accomodate source view when exclusively using templates
       # for previews for Rails < 6.1.
-      all_template_paths = ViewComponent::Base.preview_paths.map do |preview_path|
+      all_template_paths = ViewComponent::Base.config.preview_paths.map do |preview_path|
         Dir.glob("#{preview_path}/**/*")
       end.flatten
 

data/app/views/view_components/preview.html.erb

@@ -1,5 +1,5 @@
 <% if @render_args[:component] %>
-  <% if ViewComponent::Base.render_monkey_patch_enabled || Rails.version.to_f >= 6.1 %>
+  <% if ViewComponent::Base.config.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]) %>
@@ -8,6 +8,6 @@
   <%= render template: @render_args[:template], locals: @render_args[:locals] || {} %>
 <% end %>
 
-<% if ViewComponent::Base.show_previews_source %>
+<% if ViewComponent::Base.config.show_previews_source %>
   <%= preview_source %>
 <% end %>

data/docs/CHANGELOG.md

@@ -9,6 +9,40 @@ title: Changelog
 
 ## main
 
+## 2.68.0
+
+* Update `gemspec` author to be ViewComponent team.
+
+    *Joel Hawksley*
+
+* Fix bug where `ViewComponent::Compiler` wasn't required.
+
+    *Joel Hawksley*
+
+## 2.67.0
+
+* Use ViewComponent::Base.config as the internal endpoint for config.
+
+    *Simon Fish*
+
+* Fix bug where `#with_request_url`, when used with query string, set the incorrect `request.path` and `request.fullpath`.
+
+    *Franz Liedke*
+
+* Add link to [ViewComponentAttributes](https://github.com/amba-Health/view_component_attributes) in Resources section of docs.
+
+    *Romaric Pascal*
+
+* `render_preview` test helper is available by default. It is no longer necessary to include `ViewComponent::RenderPreviewHelper`.
+
+    *Joel Hawksley*
+
+## 2.66.0
+
+* Add missing `generate.sidecar`, `generate.stimulus_controller`, `generate.locale`, `generate.distinct_locale_files`, `generate.preview` config options to `config.view_component`.
+
+    *Simon Fish*
+
 ## 2.65.0
 
 * Raise `ArgumentError` when conflicting Slots are defined.

data/lib/rails/generators/abstract_generator.rb

@@ -3,9 +3,7 @@
 module ViewComponent
   module AbstractGenerator
     def copy_view_file
-      unless options["inline"]
-        template "component.html.#{engine_name}", destination
-      end
+      template "component.html.#{engine_name}", destination unless options["inline"]
     end
 
     private
@@ -31,7 +29,7 @@ module ViewComponent
     end
 
     def component_path
-      ViewComponent::Base.view_component_path
+      ViewComponent::Base.config.view_component_path
     end
 
     def stimulus_controller
@@ -44,7 +42,7 @@ module ViewComponent
     end
 
     def sidecar?
-      options["sidecar"] || ViewComponent::Base.generate.sidecar
+      options["sidecar"] || ViewComponent::Base.config.generate.sidecar
     end
   end
 end

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

@@ -13,11 +13,12 @@ module Rails
       check_class_collision suffix: "Component"
 
       class_option :inline, type: :boolean, default: false
-      class_option :locale, type: :boolean, default: ViewComponent::Base.generate.locale
+      class_option :locale, type: :boolean, default: ViewComponent::Base.config.generate.locale
       class_option :parent, type: :string, desc: "The parent class for the generated component"
-      class_option :preview, type: :boolean, default: ViewComponent::Base.generate.preview
+      class_option :preview, type: :boolean, default: ViewComponent::Base.config.generate.preview
       class_option :sidecar, type: :boolean, default: false
-      class_option :stimulus, type: :boolean, default: ViewComponent::Base.generate.stimulus_controller
+      class_option :stimulus, type: :boolean,
+        default: ViewComponent::Base.config.generate.stimulus_controller
 
       def create_component_file
         template "component.rb", File.join(component_path, class_path, "#{file_name}_component.rb")
@@ -40,7 +41,7 @@ module Rails
       def parent_class
         return options[:parent] if options[:parent]
 
-        ViewComponent::Base.component_parent_class || default_parent_class
+        ViewComponent::Base.config.component_parent_class || default_parent_class
       end
 
       def initialize_signature

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

@@ -12,7 +12,7 @@ module Locale
       class_option :sidecar, type: :boolean, default: false
 
       def create_locale_file
-        if ViewComponent::Base.generate.distinct_locale_files
+        if ViewComponent::Base.config.generate.distinct_locale_files
           I18n.available_locales.each do |locale|
             create_file destination(locale), translations_hash([locale]).to_yaml
           end

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

@@ -9,7 +9,7 @@ module Preview
       check_class_collision suffix: "ComponentPreview"
 
       def create_preview_file
-        preview_paths = Rails.application.config.view_component.preview_paths
+        preview_paths = ViewComponent::Base.config.preview_paths
         return if preview_paths.count > 1
 
         path_prefix = preview_paths.one? ? preview_paths.first : "test/components/previews"

data/lib/view_component/base.rb

@@ -4,9 +4,10 @@ require "action_view"
 require "active_support/configurable"
 require "view_component/collection"
 require "view_component/compile_cache"
+require "view_component/compiler"
+require "view_component/config"
 require "view_component/content_areas"
 require "view_component/polymorphic_slots"
-require "view_component/previewable"
 require "view_component/slotable"
 require "view_component/slotable_v2"
 require "view_component/translatable"
@@ -14,10 +15,16 @@ require "view_component/with_content_helper"
 
 module ViewComponent
   class Base < ActionView::Base
-    include ActiveSupport::Configurable
+    class << self
+      delegate(*ViewComponent::Config.defaults.keys, to: :config)
+
+      def config
+        @config ||= ViewComponent::Config.defaults
+      end
+    end
+
     include ViewComponent::ContentAreas
     include ViewComponent::PolymorphicSlots
-    include ViewComponent::Previewable
     include ViewComponent::SlotableV2
     include ViewComponent::Translatable
     include ViewComponent::WithContentHelper
@@ -113,11 +120,9 @@ module ViewComponent
       @current_template = self
 
       if block && defined?(@__vc_content_set_by_with_content)
-        raise ArgumentError.new(
-          "It looks like a block was provided after calling `with_content` on #{self.class.name}, " \
+        raise ArgumentError, "It looks like a block was provided after calling `with_content` on #{self.class.name}, " \
           "which means that ViewComponent doesn't know which content to use.\n\n" \
           "To fix this issue, use either `with_content` or a block."
-        )
       end
 
       @__vc_content_evaluated = false
@@ -262,9 +267,7 @@ module ViewComponent
     # @private
     def format
       # Ruby 2.6 throws a warning without checking `defined?`, 2.7 doesn't
-      if defined?(@__vc_variant)
-        @__vc_variant
-      end
+      @__vc_variant if defined?(@__vc_variant)
     end
 
     # Use the provided variant instead of the one determined by the current request.
@@ -313,11 +316,9 @@ module ViewComponent
     # config.view_component.test_controller = "MyTestController"
     # ```
     #
-    # Defaults to ApplicationController. Can also be configured on a per-test
-    # basis using `with_controller_class`.
+    # Defaults to `nil`. If this is falsy, `"ApplicationController"` is used. Can also be
+    # configured on a per-test basis using `with_controller_class`.
     #
-    mattr_accessor :test_controller
-    @@test_controller = "ApplicationController"
 
     # Set if render monkey patches should be included or not in Rails <6.1:
     #
@@ -325,7 +326,6 @@ module ViewComponent
     # config.view_component.render_monkey_patch_enabled = false
     # ```
     #
-    mattr_accessor :render_monkey_patch_enabled, instance_writer: false, default: true
 
     # Path for component files
     #
@@ -333,9 +333,8 @@ module ViewComponent
     # config.view_component.view_component_path = "app/my_components"
     # ```
     #
-    # Defaults to `app/components`.
+    # Defaults to `nil`. If this is falsy, `app/components` is used.
     #
-    mattr_accessor :view_component_path, instance_writer: false, default: "app/components"
 
     # Parent class for generated components
     #
@@ -346,7 +345,6 @@ module ViewComponent
     # Defaults to nil. If this is falsy, generators will use
     # "ApplicationComponent" if defined, "ViewComponent::Base" otherwise.
     #
-    mattr_accessor :component_parent_class, instance_writer: false
 
     # Configuration for generators.
     #
@@ -397,7 +395,6 @@ module ViewComponent
     # ```
     #
     #  Defaults to `false`.
-    mattr_accessor :generate, instance_writer: false, default: ActiveSupport::OrderedOptions.new(false)
 
     class << self
       # @private
@@ -489,8 +486,8 @@ module ViewComponent
 
         # If Rails application is loaded, add application url_helpers to the component context
         # we need to check this to use this gem as a dependency
-        if defined?(Rails) && Rails.application
-          child.include Rails.application.routes.url_helpers unless child < Rails.application.routes.url_helpers
+        if defined?(Rails) && Rails.application && !(child < Rails.application.routes.url_helpers)
+          child.include Rails.application.routes.url_helpers
         end
 
         # Derive the source location of the component Ruby file from the call stack.
@@ -500,7 +497,7 @@ module ViewComponent
 
         # Removes the first part of the path and the extension.
         child.virtual_path = child.source_location.gsub(
-          %r{(.*#{Regexp.quote(ViewComponent::Base.view_component_path)})|(\.rb)}, ""
+          /(.*#{Regexp.quote(ViewComponent::Base.config.view_component_path)})|(\.rb)/, ""
         )
 
         # Set collection parameter to the extended component
@@ -591,20 +588,16 @@ module ViewComponent
         # parameters will be empty and ViewComponent will not be able to render
         # the component.
         if initialize_parameters.empty?
-          raise ArgumentError.new(
-            "The #{self} initializer is empty or invalid." \
+          raise ArgumentError, "The #{self} initializer is empty or invalid." \
             "It must accept the parameter `#{parameter}` to render it as a collection.\n\n" \
             "To fix this issue, update the initializer to accept `#{parameter}`.\n\n" \
             "See https://viewcomponent.org/guide/collections.html for more information on rendering collections."
-          )
         end
 
-        raise ArgumentError.new(
-          "The initializer for #{self} doesn't accept the parameter `#{parameter}`, " \
+        raise ArgumentError, "The initializer for #{self} doesn't accept the parameter `#{parameter}`, " \
           "which is required in order to render it as a collection.\n\n" \
           "To fix this issue, update the initializer to accept `#{parameter}`.\n\n" \
           "See https://viewcomponent.org/guide/collections.html for more information on rendering collections."
-        )
       end
 
       # Ensure the component initializer doesn't define
@@ -614,10 +607,8 @@ module ViewComponent
       def validate_initialization_parameters!
         return unless initialize_parameter_names.include?(RESERVED_PARAMETER)
 
-        raise ViewComponent::ComponentError.new(
-          "#{self} initializer can't accept the parameter `#{RESERVED_PARAMETER}`, as it will override a " \
+        raise ViewComponent::ComponentError, "#{self} initializer can't accept the parameter `#{RESERVED_PARAMETER}`, as it will override a " \
           "public ViewComponent method. To fix this issue, rename the parameter."
-        )
       end
 
       # @private

data/lib/view_component/config.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require "view_component/deprecation"
+
+module ViewComponent
+  class Config
+    class << self
+      # `new` without any arguments initializes the default configuration, but
+      # it's important to differentiate in case that's no longer the case in
+      # future.
+      alias_method :default, :new
+
+      def defaults
+        ActiveSupport::OrderedOptions.new.merge!({
+          generate: ActiveSupport::OrderedOptions.new(false),
+          preview_controller: "ViewComponentsController",
+          preview_route: "/rails/view_components",
+          show_previews_source: false,
+          instrumentation_enabled: false,
+          render_monkey_patch_enabled: true,
+          view_component_path: "app/components",
+          component_parent_class: nil,
+          show_previews: Rails.env.development? || Rails.env.test?,
+          preview_paths: default_preview_paths,
+          test_controller: "ApplicationController",
+          default_preview_layout: nil
+        })
+      end
+
+      # @!attribute generate
+      # @return [ActiveSupport::OrderedOptions]
+      # The subset of configuration options relating to generators.
+      #
+      # All options under this namespace default to `false` unless otherwise
+      # stated.
+      #
+      # #### #sidecar
+      #
+      # Always generate a component with a sidecar directory:
+      #
+      #     config.view_component.generate.sidecar = true
+      #
+      # #### #stimulus_controller
+      #
+      # Always generate a Stimulus controller alongside the component:
+      #
+      #     config.view_component.generate.stimulus_controller = true
+      #
+      # #### #locale
+      #
+      # Always generate translations file alongside the component:
+      #
+      #     config.view_component.generate.locale = true
+      #
+      # #### #distinct_locale_files
+      #
+      # Always generate as many translations files as available locales:
+      #
+      #     config.view_component.generate.distinct_locale_files = true
+      #
+      # One file will be generated for each configured `I18n.available_locales`,
+      # falling back to `[:en]` when no `available_locales` is defined.
+      #
+      # #### #preview
+      #
+      # Always generate a preview alongside the component:
+      #
+      #      config.view_component.generate.preview = true
+
+      # @!attribute preview_controller
+      # @return [String]
+      # The controller used for previewing components.
+      # Defaults to `ViewComponentsController`.
+
+      # @!attribute preview_route
+      # @return [String]
+      # The entry route for component previews.
+      # Defaults to `"/rails/view_components"`.
+
+      # @!attribute show_previews_source
+      # @return [Boolean]
+      # Whether to display source code previews in component previews.
+      # Defaults to `false`.
+
+      # @!attribute instrumentation_enabled
+      # @return [Boolean]
+      # Whether ActiveSupport notifications are enabled.
+      # Defaults to `false`.
+
+      # @!attribute render_monkey_patch_enabled
+      # @return [Boolean] Whether the #render method should be monkey patched.
+      # If this is disabled, use `#render_component` or
+      # `#render_component_to_string` instead.
+      # Defaults to `true`.
+
+      # @!attribute view_component_path
+      # @return [String]
+      # The path in which components, their templates, and their sidecars should
+      # be stored.
+      # Defaults to `"app/components"`.
+
+      # @!attribute component_parent_class
+      # @return [String]
+      # The parent class from which generated components will inherit.
+      # Defaults to `nil`. If this is falsy, generators will use
+      # `"ApplicationComponent"` if defined, `"ViewComponent::Base"` otherwise.
+
+      # @!attribute show_previews
+      # @return [Boolean]
+      # Whether component previews are enabled.
+      # Defaults to `true` in development and test environments.
+
+      # @!attribute preview_paths
+      # @return [Array<String>]
+      # The locations in which component previews will be looked up.
+      # Defaults to `['test/component/previews']` relative to your Rails root.
+
+      # @!attribute preview_path
+      # @deprecated Use #preview_paths instead. Will be removed in v3.0.0.
+
+      # @!attribute test_controller
+      # @return [String]
+      # The controller used for testing components.
+      # Can also be configured on a per-test basis using `#with_controller_class`.
+      # Defaults to `ApplicationController`.
+
+      # @!attribute default_preview_layout
+      # @return [String]
+      # A custom default layout used for the previews index page and individual
+      # previews.
+      # Defaults to `nil`. If this is falsy, `"component_preview"` is used.
+
+      def default_preview_paths
+        return [] unless defined?(Rails.root) && Dir.exist?("#{Rails.root}/test/components/previews")
+
+        ["#{Rails.root}/test/components/previews"]
+      end
+    end
+
+    def initialize
+      @config = self.class.defaults
+    end
+
+    def preview_path
+      preview_paths
+    end
+
+    def preview_path=(new_value)
+      ViewComponent::Deprecation.warn("`preview_path` will be removed in v3.0.0. Use `preview_paths` instead.")
+      self.preview_paths = Array.wrap(new_value)
+    end
+
+    delegate_missing_to :config
+
+    private
+
+    attr_reader :config
+  end
+end

data/lib/view_component/engine.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 require "rails"
+require "view_component/base"
 
 module ViewComponent
   class Engine < Rails::Engine # :nodoc:
-    config.view_component = ActiveSupport::OrderedOptions.new
-    config.view_component.preview_paths ||= []
+    config.view_component = ViewComponent::Base.config
 
     rake_tasks do
       load "view_component/rails/tasks/view_component.rake"
@@ -14,25 +14,20 @@ module ViewComponent
     initializer "view_component.set_configs" do |app|
       options = app.config.view_component
 
+      %i[generate preview_controller preview_route show_previews_source].each do |config_option|
+        options[config_option] ||= ViewComponent::Base.public_send(config_option)
+      end
+      options.instrumentation_enabled = false if options.instrumentation_enabled.nil?
       options.render_monkey_patch_enabled = true if options.render_monkey_patch_enabled.nil?
       options.show_previews = Rails.env.development? || Rails.env.test? if options.show_previews.nil?
-      options.show_previews_source ||= ViewComponent::Base.show_previews_source
       options.instrumentation_enabled = false if options.instrumentation_enabled.nil?
-      options.preview_route ||= ViewComponent::Base.preview_route
-      options.preview_controller ||= ViewComponent::Base.preview_controller
 
       if options.show_previews
+        # This is still necessary because when `config.view_component` is declared, `Rails.root` is unspecified.
         options.preview_paths << "#{Rails.root}/test/components/previews" if defined?(Rails.root) && Dir.exist?(
           "#{Rails.root}/test/components/previews"
         )
 
-        if options.preview_path.present?
-          ViewComponent::Deprecation.warn(
-            "`preview_path` will be removed in v3.0.0. Use `preview_paths` instead."
-          )
-          options.preview_paths << options.preview_path
-        end
-
         if options.show_previews_source
           require "method_source"
 
@@ -41,10 +36,6 @@ module ViewComponent
           end
         end
       end
-
-      ActiveSupport.on_load(:view_component) do
-        options.each { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
-      end
     end
 
     initializer "view_component.enable_instrumentation" do |app|
@@ -72,12 +63,6 @@ module ViewComponent
       end
     end
 
-    initializer "view_component.compile_config_methods" do
-      ActiveSupport.on_load(:view_component) do
-        config.compile_methods! if config.respond_to?(:compile_methods!)
-      end
-    end
-
     initializer "view_component.monkey_patch_render" do |app|
       next if Rails.version.to_f >= 6.1 || !app.config.view_component.render_monkey_patch_enabled
 
@@ -94,7 +79,7 @@ module ViewComponent
       end
     end
 
-    initializer "view_component.include_render_component" do |app|
+    initializer "view_component.include_render_component" do |_app|
       next if Rails.version.to_f >= 6.1
 
       ActiveSupport.on_load(:action_view) do
@@ -116,7 +101,7 @@ module ViewComponent
       end
     end
 
-    initializer "compiler mode" do |app|
+    initializer "compiler mode" do |_app|
       ViewComponent::Compiler.mode = if Rails.env.development? || Rails.env.test?
         ViewComponent::Compiler::DEVELOPMENT_MODE
       else
@@ -160,7 +145,7 @@ unless defined?(ViewComponent::Base)
 
   ViewComponent::Deprecation.warn(
     "This manually engine loading is deprecated and will be removed in v3.0.0. " \
-    "Remove `require \"view_component/engine\"`."
+    'Remove `require "view_component/engine"`.'
   )
 
   require "view_component"

data/lib/view_component/test_helpers.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "view_component/render_preview_helper"
-
 module ViewComponent
   module TestHelpers
     begin
@@ -67,6 +65,47 @@ module ViewComponent
       Nokogiri::HTML.fragment(@rendered_content)
     end
 
+    # Render a preview inline. Internally sets `page` to be a `Capybara::Node::Simple`,
+    # allowing for Capybara assertions to be used:
+    #
+    # ```ruby
+    # render_preview(:default)
+    # assert_text("Hello, World!")
+    # ```
+    #
+    # Note: `#rendered_preview` expects a preview to be defined with the same class
+    # name as the calling test, but with `Test` replaced with `Preview`:
+    #
+    # MyComponentTest -> MyComponentPreview etc.
+    #
+    # In RSpec, `Preview` is appended to `described_class`.
+    #
+    # @param preview [String] The name of the preview to be rendered.
+    # @return [Nokogiri::HTML]
+    def render_preview(name)
+      begin
+        preview_klass = if respond_to?(:described_class)
+          raise "`render_preview` expected a described_class, but it is nil." if described_class.nil?
+
+          "#{described_class}Preview"
+        else
+          self.class.name.gsub("Test", "Preview")
+        end
+        preview_klass = preview_klass.constantize
+      rescue NameError
+        raise NameError, "`render_preview` expected to find #{preview_klass}, but it does not exist."
+      end
+
+      previews_controller = build_controller(Rails.application.config.view_component.preview_controller.constantize)
+      previews_controller.request.params[:path] = "#{preview_klass.preview_name}/#{name}"
+      previews_controller.response = ActionDispatch::Response.new
+      result = previews_controller.previews
+
+      @rendered_content = result
+
+      Nokogiri::HTML.fragment(@rendered_content)
+    end
+
     # Execute the given block in the view context. Internally sets `page` to be a
     # `Capybara::Node::Simple`, allowing for Capybara assertions to be used:
     #
@@ -151,10 +190,11 @@ module ViewComponent
       old_request_query_string = request.query_string
       old_controller = defined?(@controller) && @controller
 
+      path, query = path.split("?", 2)
       request.path_info = path
       request.path_parameters = Rails.application.routes.recognize_path(path)
-      request.set_header("action_dispatch.request.query_parameters", Rack::Utils.parse_nested_query(path.split("?")[1]))
-      request.set_header(Rack::QUERY_STRING, path.split("?")[1])
+      request.set_header("action_dispatch.request.query_parameters", Rack::Utils.parse_nested_query(query))
+      request.set_header(Rack::QUERY_STRING, query)
       yield
     ensure
       request.path_info = old_request_path_info

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 65
+    MINOR = 68
     PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")

data/lib/view_component.rb

@@ -10,6 +10,7 @@ module ViewComponent
   autoload :Compiler
   autoload :CompileCache
   autoload :ComponentError
+  autoload :Config
   autoload :Deprecation
   autoload :Instrumentation
   autoload :Preview

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.65.0
+  version: 2.68.0
 platform: ruby
 authors:
-- GitHub Open Source
+- ViewComponent Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-09 00:00:00.000000000 Z
+date: 2022-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -104,16 +104,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: erb_lint
   requirement: !ruby/object:Gem::Requirement
@@ -300,19 +300,18 @@ dependencies:
   name: yard-activesupport-concern
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.1
 description:
 email:
-- opensource+view_component@github.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -357,6 +356,7 @@ files:
 - lib/view_component/compile_cache.rb
 - lib/view_component/compiler.rb
 - lib/view_component/component_error.rb
+- lib/view_component/config.rb
 - lib/view_component/content_areas.rb
 - lib/view_component/deprecation.rb
 - lib/view_component/docs_builder_component.html.erb
@@ -366,12 +366,10 @@ files:
 - lib/view_component/polymorphic_slots.rb
 - lib/view_component/preview.rb
 - lib/view_component/preview_template_error.rb
-- lib/view_component/previewable.rb
 - lib/view_component/rails/tasks/view_component.rake
 - 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_preview_helper.rb
 - lib/view_component/render_to_string_monkey_patch.rb
 - lib/view_component/rendering_component_helper.rb
 - lib/view_component/rendering_monkey_patch.rb
@@ -386,7 +384,7 @@ files:
 - lib/view_component/version.rb
 - lib/view_component/with_content_helper.rb
 - lib/yard/mattr_accessor_handler.rb
-homepage: https://github.com/github/view_component
+homepage: https://viewcomponent.org
 licenses:
 - MIT
 metadata:
@@ -409,5 +407,6 @@ requirements: []
 rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
-summary: View components for Rails
+summary: A framework for building reusable, testable & encapsulated view components
+  in Ruby on Rails.
 test_files: []

data/lib/view_component/previewable.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require "active_support/concern"
-
-module ViewComponent
-  module Previewable
-    extend ActiveSupport::Concern
-
-    included do
-      # Enable or disable component previews:
-      #
-      #     config.view_component.show_previews = true
-      #
-      # Defaults to `true` in development.
-      #
-      mattr_accessor :show_previews, instance_writer: false
-
-      # Enable or disable source code previews in component previews:
-      #
-      #     config.view_component.show_previews_source = true
-      #
-      # Defaults to `false`.
-      #
-      mattr_accessor :show_previews_source, instance_writer: false, default: false
-
-      # Set a custom default layout used for preview index and individual previews:
-      #
-      #     config.view_component.default_preview_layout = "component_preview"
-      #
-      mattr_accessor :default_preview_layout, instance_writer: false
-
-      # Set the location of component previews:
-      #
-      #     config.view_component.preview_paths << "#{Rails.root}/lib/component_previews"
-      #
-      mattr_accessor :preview_paths, instance_writer: false
-
-      # @deprecated Use `preview_paths` instead. Will be removed in v3.0.0.
-      mattr_accessor :preview_path, instance_writer: false
-
-      # Set the entry route for component previews:
-      #
-      #     config.view_component.preview_route = "/previews"
-      #
-      # Defaults to `/rails/view_components` when `show_previews` is enabled.
-      #
-      mattr_accessor :preview_route, instance_writer: false do
-        "/rails/view_components"
-      end
-
-      # Set the controller used for previewing components:
-      #
-      #     config.view_component.preview_controller = "MyPreviewController"
-      #
-      # Defaults to `ViewComponentsController`.
-      #
-      mattr_accessor :preview_controller, instance_writer: false do
-        "ViewComponentsController"
-      end
-    end
-  end
-end

data/lib/view_component/render_preview_helper.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  module RenderPreviewHelper
-    # Render a preview inline. Internally sets `page` to be a `Capybara::Node::Simple`,
-    # allowing for Capybara assertions to be used:
-    #
-    # ```ruby
-    # render_preview(:default)
-    # assert_text("Hello, World!")
-    # ```
-    #
-    # Note: `#rendered_preview` expects a preview to be defined with the same class
-    # name as the calling test, but with `Test` replaced with `Preview`:
-    #
-    # MyComponentTest -> MyComponentPreview etc.
-    #
-    # In RSpec, `Preview` is appended to `described_class`.
-    #
-    # @param preview [String] The name of the preview to be rendered.
-    # @return [Nokogiri::HTML]
-    def render_preview(name)
-      begin
-        preview_klass = if respond_to?(:described_class)
-          if described_class.nil?
-            raise "`render_preview` expected a described_class, but it is nil."
-          end
-
-          "#{described_class}Preview"
-        else
-          self.class.name.gsub("Test", "Preview")
-        end
-        preview_klass = preview_klass.constantize
-      rescue NameError
-        raise NameError.new(
-          "`render_preview` expected to find #{preview_klass}, but it does not exist."
-        )
-      end
-
-      previews_controller = build_controller(ViewComponent::Base.preview_controller.constantize)
-      previews_controller.request.params[:path] = "#{preview_klass.preview_name}/#{name}"
-      previews_controller.response = ActionDispatch::Response.new
-      result = previews_controller.previews
-
-      @rendered_content = result
-
-      Nokogiri::HTML.fragment(@rendered_content)
-    end
-  end
-end