view_component 2.62.0 → 2.82.0

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,19 @@ module ViewComponent
     initializer "view_component.set_configs" do |app|
       options = app.config.view_component
 
-      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
+      %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.preview_route ||= ViewComponent::Base.preview_route
-      options.preview_controller ||= ViewComponent::Base.preview_controller
+      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?
 
       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 +35,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 +62,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 +78,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 +100,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
@@ -147,6 +131,12 @@ module ViewComponent
         end
       end
 
+      if Rails.env.test?
+        app.routes.prepend do
+          get("_system_test_entrypoint", to: "view_components_system_test#system_test_entrypoint")
+        end
+      end
+
       app.executor.to_run :before do
         CompileCache.invalidate! unless ActionView::Base.cache_template_loading
       end
@@ -154,13 +144,17 @@ module ViewComponent
   end
 end
 
+if RUBY_VERSION < "2.7.0"
+  ViewComponent::Deprecation.deprecation_warning("Support for Ruby versions < 2.7.0")
+end
+
 # :nocov:
 unless defined?(ViewComponent::Base)
   require "view_component/deprecation"
 
-  ViewComponent::Deprecation.warn(
-    "This manually engine loading is deprecated and will be removed in v3.0.0. " \
-    "Remove `require \"view_component/engine\"`."
+  ViewComponent::Deprecation.deprecation_warning(
+    "Manually loading the engine",
+    "remove `require \"view_component/engine\"`"
   )
 
   require "view_component"

data/lib/view_component/polymorphic_slots.rb

@@ -42,6 +42,10 @@ module ViewComponent
           define_method(getter_name) do
             get_slot(slot_name)
           end
+
+          define_method("#{getter_name}?") do
+            get_slot(slot_name).present?
+          end
         end
 
         renderable_hash = types.each_with_object({}) do |(poly_type, poly_callable), memo|
@@ -57,10 +61,12 @@ module ViewComponent
             end
 
           define_method(setter_name) do |*args, &block|
-            ViewComponent::Deprecation.warn(
-              "polymorphic slot setters like `#{setter_name}` are deprecated and will be removed in " \
-              "ViewComponent v3.0.0.\n\nUse `with_#{setter_name}` instead."
-            )
+            if _warn_on_deprecated_slot_setter
+              ViewComponent::Deprecation.deprecation_warning(
+                "Using polymorphic slot setters like `#{setter_name}`",
+                :"`with_#{setter_name}`"
+              )
+            end
 
             set_polymorphic_slot(slot_name, poly_type, *args, &block)
           end
@@ -83,7 +89,7 @@ module ViewComponent
       def set_polymorphic_slot(slot_name, poly_type = nil, *args, &block)
         slot_definition = self.class.registered_slots[slot_name]
 
-        if !slot_definition[:collection] && get_slot(slot_name)
+        if !slot_definition[:collection] && (defined?(@__vc_set_slots) && @__vc_set_slots[slot_name])
           raise ArgumentError, "content for slot '#{slot_name}' has already been provided"
         end
 

data/lib/view_component/render_component_helper.rb

@@ -3,6 +3,7 @@
 module ViewComponent
   module RenderComponentHelper # :nodoc:
     def render_component(component, &block)
+      component.set_original_view_context(__vc_original_view_context) if is_a?(ViewComponent::Base)
       component.render_in(self, &block)
     end
   end

data/lib/view_component/slotable.rb

@@ -23,9 +23,8 @@ module ViewComponent
       #   class_name: "Header" # class name string, used to instantiate Slot
       # )
       def with_slot(*slot_names, collection: false, class_name: nil)
-        ViewComponent::Deprecation.warn(
-          "`with_slot` is deprecated and will be removed in ViewComponent v3.0.0.\n" \
-          "Use the new slots API (https://viewcomponent.org/guide/slots.html) instead."
+        ViewComponent::Deprecation.deprecation_warning(
+          "`with_slot`", "use the new slots API (https://viewcomponent.org/guide/slots.html) instead"
         )
 
         slot_names.each do |slot_name|

data/lib/view_component/slotable_v2.rb

@@ -17,9 +17,19 @@ module ViewComponent
       # Hash of registered Slots
       class_attribute :registered_slots
       self.registered_slots = {}
+
+      class_attribute :_warn_on_deprecated_slot_setter
+      self._warn_on_deprecated_slot_setter = false
     end
 
     class_methods do
+      ##
+      # Enables deprecations coming to the Slots API in ViewComponent v3
+      #
+      def warn_on_deprecated_slot_setter
+        self._warn_on_deprecated_slot_setter = true
+      end
+
       ##
       # Registers a sub-component
       #
@@ -70,6 +80,7 @@ module ViewComponent
       #   <% end %>
       def renders_one(slot_name, callable = nil)
         validate_singular_slot_name(slot_name)
+        validate_plural_slot_name(ActiveSupport::Inflector.pluralize(slot_name).to_sym)
 
         define_method :"with_#{slot_name}" do |*args, &block|
           set_slot(slot_name, nil, *args, &block)
@@ -80,7 +91,16 @@ module ViewComponent
           if args.empty? && block.nil?
             get_slot(slot_name)
           else
-            # Deprecated: Will remove in 3.0
+            if _warn_on_deprecated_slot_setter
+              stack = caller_locations(3)
+
+              ViewComponent::Deprecation.deprecation_warning(
+                "Setting a slot with `##{slot_name}`",
+                "use `#with_#{slot_name}` to set the slot instead",
+                stack
+              )
+            end
+
             set_slot(slot_name, nil, *args, &block)
           end
         end
@@ -98,11 +118,11 @@ module ViewComponent
       #
       # = Example
       #
-      #   render_many :items, -> (name:) { ItemComponent.new(name: name }
+      #   renders_many :items, -> (name:) { ItemComponent.new(name: name }
       #
       #   # OR
       #
-      #   render_many :items, ItemComponent
+      #   renders_many :items, ItemComponent
       #
       # = Rendering sub-components
       #
@@ -131,16 +151,22 @@ module ViewComponent
       #     <% end %>
       #   <% end %>
       def renders_many(slot_name, callable = nil)
-        validate_plural_slot_name(slot_name)
-
         singular_name = ActiveSupport::Inflector.singularize(slot_name)
+        validate_plural_slot_name(slot_name)
+        validate_singular_slot_name(ActiveSupport::Inflector.singularize(slot_name).to_sym)
 
         # Define setter for singular names
         # for example `renders_many :items` allows fetching all tabs with
         # `component.tabs` and setting a tab with `component.tab`
-        #
-        # Deprecated: Will remove in 3.0
+
         define_method singular_name do |*args, &block|
+          if _warn_on_deprecated_slot_setter
+            ViewComponent::Deprecation.deprecation_warning(
+              "Setting a slot with `##{singular_name}`",
+              "use `#with_#{singular_name}` to set the slot instead"
+            )
+          end
+
           set_slot(slot_name, nil, *args, &block)
         end
         ruby2_keywords(singular_name.to_sym) if respond_to?(:ruby2_keywords, true)
@@ -162,7 +188,13 @@ module ViewComponent
           if collection_args.nil? && block.nil?
             get_slot(slot_name)
           else
-            # Deprecated: Will remove in 3.0
+            if _warn_on_deprecated_slot_setter
+              ViewComponent::Deprecation.deprecation_warning(
+                "Setting a slot with `##{slot_name}`",
+                "use `#with_#{slot_name}` to set the slot instead"
+              )
+            end
+
             collection_args.map do |args|
               set_slot(slot_name, nil, **args, &block)
             end
@@ -242,6 +274,14 @@ module ViewComponent
       end
 
       def validate_singular_slot_name(slot_name)
+        if slot_name.to_sym == :content
+          raise ArgumentError.new(
+            "#{self} declares a slot named content, which is a reserved word in ViewComponent.\n\n" \
+            "Content passed to a ViewComponent as a block is captured and assigned to the `content` accessor without having to create an explicit slot.\n\n" \
+            "To fix this issue, either use the `content` accessor directly or choose a different slot name."
+          )
+        end
+
         if RESERVED_NAMES[:singular].include?(slot_name.to_sym)
           raise ArgumentError.new(
             "#{self} declares a slot named #{slot_name}, which is a reserved word in the ViewComponent framework.\n\n" \

data/lib/view_component/system_test_case.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "active_support/test_case"
+
+module ViewComponent
+  class SystemTestCase < ActionDispatch::SystemTestCase
+    include ViewComponent::SystemTestHelpers
+
+    def page
+      Capybara.current_session
+    end
+  end
+end

data/lib/view_component/system_test_helpers.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module SystemTestHelpers
+    include TestHelpers
+
+    #
+    # Returns a block that can be used to visit the path of the inline rendered component.
+    # @param fragment [Nokogiri::Fragment] The fragment returned from `render_inline`.
+    # @param layout [String] The (optional) layout to use.
+    # @return [Proc] A block that can be used to visit the path of the inline rendered component.
+    def with_rendered_component_path(fragment, layout: false, &block)
+      # Add './tmp/view_components/' directory if it doesn't exist to store the rendered component HTML
+      FileUtils.mkdir_p("./tmp/view_components/") unless Dir.exist?("./tmp/view_components/")
+
+      file = Tempfile.new(["rendered_#{fragment.class.name}", ".html"], "tmp/view_components/")
+      begin
+        file.write(controller.render_to_string(html: fragment.to_html.html_safe, layout: layout))
+        file.rewind
+
+        block.call("/_system_test_entrypoint?file=#{file.path.split("/").last}")
+      ensure
+        file.unlink
+      end
+    end
+  end
+end

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
@@ -37,10 +35,7 @@ module ViewComponent
     #
     # @return [String]
     def rendered_component
-      ViewComponent::Deprecation.warn(
-        "`rendered_component` is deprecated and will be removed in v3.0.0. " \
-        "Use `page` instead."
-      )
+      ViewComponent::Deprecation.deprecation_warning("`rendered_component`", :"`page`")
 
       rendered_content
     end
@@ -67,21 +62,60 @@ module ViewComponent
       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:
+    # 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 name [String] The name of the preview to be rendered.
+    # @param from [ViewComponent::Preview] The class of the preview to be rendered.
+    # @param params [Hash] Parameters to be passed to the preview.
+    # @return [Nokogiri::HTML]
+    def render_preview(name, from: preview_class, params: {})
+      previews_controller = build_controller(Rails.application.config.view_component.preview_controller.constantize)
+
+      # From what I can tell, it's not possible to overwrite all request parameters
+      # at once, so we set them individually here.
+      params.each do |k, v|
+        previews_controller.request.params[k] = v
+      end
+
+      previews_controller.request.params[:path] = "#{from.preview_name}/#{name}"
+      previews_controller.set_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 (using `instance_exec`).
+    # Internally sets `page` to be a `Capybara::Node::Simple`, allowing for
+    # Capybara assertions to be used. All arguments are forwarded to the block.
     #
     # ```ruby
-    # render_in_view_context do
-    #   render(MyComponent.new)
+    # render_in_view_context(arg1, arg2:) do |arg1, arg2:|
+    #   render(MyComponent.new(arg1, arg2))
     # end
     #
     # assert_text("Hello, World!")
     # ```
-    def render_in_view_context(&block)
+    def render_in_view_context(*args, &block)
       @page = nil
-      @rendered_content = controller.view_context.instance_exec(&block)
+      @rendered_content = controller.view_context.instance_exec(*args, &block)
       Nokogiri::HTML.fragment(@rendered_content)
     end
+    ruby2_keywords(:render_in_view_context) if respond_to?(:ruby2_keywords, true)
 
     # @private
     def controller
@@ -151,10 +185,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.path_parameters = Rails.application.routes.recognize_path_with_request(request, path, {})
+      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
@@ -168,5 +203,20 @@ module ViewComponent
     def build_controller(klass)
       klass.new.tap { |c| c.request = request }.extend(Rails.application.routes.url_helpers)
     end
+
+    private
+
+    def preview_class
+      result = 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
+      result = result.constantize
+    rescue NameError
+      raise NameError, "`render_preview` expected to find #{result}, but it does not exist."
+    end
   end
 end

data/lib/view_component/translatable.rb

@@ -23,7 +23,7 @@ module ViewComponent
       def build_i18n_backend
         return if CompileCache.compiled? self
 
-        self.i18n_backend = if (translation_files = _sidecar_files(%w[yml yaml])).any?
+        self.i18n_backend = if (translation_files = sidecar_files(%w[yml yaml])).any?
           # Returning nil cleans up if translations file has been removed since the last compilation
 
           I18nBackend.new(

data/lib/view_component/version.rb

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

data/lib/view_component.rb

@@ -10,21 +10,24 @@ module ViewComponent
   autoload :Compiler
   autoload :CompileCache
   autoload :ComponentError
+  autoload :Config
   autoload :Deprecation
   autoload :Instrumentation
   autoload :Preview
   autoload :PreviewTemplateError
   autoload :TestHelpers
+  autoload :SystemTestHelpers
   autoload :TestCase
+  autoload :SystemTestCase
   autoload :TemplateError
   autoload :Translatable
 end
 
 # :nocov:
 if defined?(ViewComponent::Engine)
-  ViewComponent::Deprecation.warn(
-    "Manually loading the engine is deprecated and will be removed in v3.0.0. " \
-    "Remove `require \"view_component/engine\"`."
+  ViewComponent::Deprecation.deprecation_warning(
+    "Manually loading the engine",
+    "remove `require \"view_component/engine\"`"
   )
 elsif defined?(Rails::Engine)
   require "view_component/engine"