view_component 2.82.0 → 3.0.0

data/lib/view_component/test_helpers.rb

@@ -28,17 +28,10 @@ module ViewComponent
       # :nocov:
     end
 
-    # @private
-    attr_reader :rendered_content
-
     # Returns the result of a render_inline call.
     #
-    # @return [String]
-    def rendered_component
-      ViewComponent::Deprecation.deprecation_warning("`rendered_component`", :"`page`")
-
-      rendered_content
-    end
+    # @return [ActionView::OutputBuffer]
+    attr_reader :rendered_content
 
     # Render a component inline. Internally sets `page` to be a `Capybara::Node::Simple`,
     # allowing for Capybara assertions to be used:
@@ -54,9 +47,9 @@ module ViewComponent
       @page = nil
       @rendered_content =
         if Rails.version.to_f >= 6.1
-          controller.view_context.render(component, args, &block)
+          vc_test_controller.view_context.render(component, args, &block)
         else
-          controller.view_context.render_component(component, &block)
+          vc_test_controller.view_context.render_component(component, &block)
         end
 
       Nokogiri::HTML.fragment(@rendered_content)
@@ -81,8 +74,8 @@ module ViewComponent
     # @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)
+    def render_preview(name, from: __vc_test_helpers_preview_class, params: {})
+      previews_controller = __vc_test_helpers_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.
@@ -104,7 +97,7 @@ module ViewComponent
     # Capybara assertions to be used. All arguments are forwarded to the block.
     #
     # ```ruby
-    # render_in_view_context(arg1, arg2:) do |arg1, arg2:|
+    # render_in_view_context(arg1, arg2: nil) do |arg1, arg2:|
     #   render(MyComponent.new(arg1, arg2))
     # end
     #
@@ -112,26 +105,11 @@ module ViewComponent
     # ```
     def render_in_view_context(*args, &block)
       @page = nil
-      @rendered_content = controller.view_context.instance_exec(*args, &block)
+      @rendered_content = vc_test_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
-      @controller ||= build_controller(Base.test_controller.constantize)
-    end
-
-    # @private
-    def request
-      @request ||=
-        begin
-          request = ActionDispatch::TestRequest.create
-          request.session = ActionController::TestSession.new
-          request
-        end
-    end
-
     # Set the Action Pack request variant for the given block:
     #
     # ```ruby
@@ -142,12 +120,12 @@ module ViewComponent
     #
     # @param variant [Symbol] The variant to be set for the provided block.
     def with_variant(variant)
-      old_variants = controller.view_context.lookup_context.variants
+      old_variants = vc_test_controller.view_context.lookup_context.variants
 
-      controller.view_context.lookup_context.variants = variant
+      vc_test_controller.view_context.lookup_context.variants = variant
       yield
     ensure
-      controller.view_context.lookup_context.variants = old_variants
+      vc_test_controller.view_context.lookup_context.variants = old_variants
     end
 
     # Set the controller to be used while executing the given block,
@@ -161,12 +139,12 @@ module ViewComponent
     #
     # @param klass [ActionController::Base] The controller to be used.
     def with_controller_class(klass)
-      old_controller = defined?(@controller) && @controller
+      old_controller = defined?(@vc_test_controller) && @vc_test_controller
 
-      @controller = build_controller(klass)
+      @vc_test_controller = __vc_test_helpers_build_controller(klass)
       yield
     ensure
-      @controller = old_controller
+      @vc_test_controller = old_controller
     end
 
     # Set the URL of the current request (such as when using request-dependent path helpers):
@@ -179,34 +157,69 @@ module ViewComponent
     #
     # @param path [String] The path to set for the current request.
     def with_request_url(path)
-      old_request_path_info = request.path_info
-      old_request_path_parameters = request.path_parameters
-      old_request_query_parameters = request.query_parameters
-      old_request_query_string = request.query_string
-      old_controller = defined?(@controller) && @controller
+      old_request_path_info = vc_test_request.path_info
+      old_request_path_parameters = vc_test_request.path_parameters
+      old_request_query_parameters = vc_test_request.query_parameters
+      old_request_query_string = vc_test_request.query_string
+      old_controller = defined?(@vc_test_controller) && @vc_test_controller
 
       path, query = path.split("?", 2)
-      request.path_info = path
-      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)
+      vc_test_request.path_info = path
+      vc_test_request.path_parameters = Rails.application.routes.recognize_path_with_request(vc_test_request, path, {})
+      vc_test_request.set_header("action_dispatch.request.query_parameters", Rack::Utils.parse_nested_query(query))
+      vc_test_request.set_header(Rack::QUERY_STRING, query)
       yield
     ensure
-      request.path_info = old_request_path_info
-      request.path_parameters = old_request_path_parameters
-      request.set_header("action_dispatch.request.query_parameters", old_request_query_parameters)
-      request.set_header(Rack::QUERY_STRING, old_request_query_string)
-      @controller = old_controller
+      vc_test_request.path_info = old_request_path_info
+      vc_test_request.path_parameters = old_request_path_parameters
+      vc_test_request.set_header("action_dispatch.request.query_parameters", old_request_query_parameters)
+      vc_test_request.set_header(Rack::QUERY_STRING, old_request_query_string)
+      @vc_test_controller = old_controller
     end
 
-    # @private
-    def build_controller(klass)
-      klass.new.tap { |c| c.request = request }.extend(Rails.application.routes.url_helpers)
+    # Access the controller used by `render_inline`:
+    #
+    # ```ruby
+    # test "logged out user sees login link" do
+    #   vc_test_controller.expects(:logged_in?).at_least_once.returns(false)
+    #   render_inline(LoginComponent.new)
+    #   assert_selector("[aria-label='You must be signed in']")
+    # end
+    # ```
+    #
+    # @return [ActionController::Base]
+    def vc_test_controller
+      @vc_test_controller ||= __vc_test_helpers_build_controller(Base.test_controller.constantize)
     end
 
+    # Access the request used by `render_inline`:
+    #
+    # ```ruby
+    # test "component does not render in Firefox" do
+    #   request.env["HTTP_USER_AGENT"] = "Mozilla/5.0"
+    #   render_inline(NoFirefoxComponent.new)
+    #   refute_component_rendered
+    # end
+    # ```
+    #
+    # @return [ActionDispatch::TestRequest]
+    def vc_test_request
+      @vc_test_request ||=
+        begin
+          out = ActionDispatch::TestRequest.create
+          out.session = ActionController::TestSession.new
+          out
+        end
+    end
+
+    # Note: We prefix private methods here to prevent collisions in consumer's tests.
     private
 
-    def preview_class
+    def __vc_test_helpers_build_controller(klass)
+      klass.new.tap { |c| c.request = vc_test_request }.extend(Rails.application.routes.url_helpers)
+    end
+
+    def __vc_test_helpers_preview_class
       result = if respond_to?(:described_class)
         raise "`render_preview` expected a described_class, but it is nil." if described_class.nil?
 

data/lib/view_component/translatable.rb

@@ -21,7 +21,7 @@ module ViewComponent
       end
 
       def build_i18n_backend
-        return if CompileCache.compiled? self
+        return if compiled?
 
         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
@@ -32,6 +32,27 @@ module ViewComponent
           )
         end
       end
+
+      def i18n_key(key, scope = nil)
+        scope = scope.join(".") if scope.is_a? Array
+        key = key&.to_s unless key.is_a?(String)
+        key = "#{scope}.#{key}" if scope
+        key = "#{i18n_scope}#{key}" if key.start_with?(".")
+        key
+      end
+
+      def translate(key = nil, **options)
+        return key.map { |k| translate(k, **options) } if key.is_a?(Array)
+
+        ensure_compiled
+
+        locale = options.delete(:locale) || ::I18n.locale
+        key = i18n_key(key, options.delete(:scope))
+
+        i18n_backend.translate(locale, key, options)
+      end
+
+      alias_method :t, :translate
     end
 
     class I18nBackend < ::I18n::Backend::Simple
@@ -60,19 +81,16 @@ module ViewComponent
     end
 
     def translate(key = nil, **options)
+      raise ViewComponent::TranslateCalledBeforeRenderError if view_context.nil?
+
       return super unless i18n_backend
       return key.map { |k| translate(k, **options) } if key.is_a?(Array)
 
       locale = options.delete(:locale) || ::I18n.locale
-      scope = options.delete(:scope)
-      scope = scope.join(".") if scope.is_a? Array
-      key = key&.to_s unless key.is_a?(String)
-      key = "#{scope}.#{key}" if scope
-      key = "#{i18n_scope}#{key}" if key.start_with?(".")
-
-      if HTML_SAFE_TRANSLATION_KEY.match?(key)
-        html_escape_translation_options!(options)
-      end
+      key = self.class.i18n_key(key, options.delete(:scope))
+      as_html = HTML_SAFE_TRANSLATION_KEY.match?(key)
+
+      html_escape_translation_options!(options) if as_html
 
       if key.start_with?(i18n_scope + ".")
         translated =
@@ -85,10 +103,7 @@ module ViewComponent
           return super(key, locale: locale, **options)
         end
 
-        if HTML_SAFE_TRANSLATION_KEY.match?(key)
-          translated = html_safe_translation(translated)
-        end
-
+        translated = html_safe_translation(translated) if as_html
         translated
       else
         super(key, locale: locale, **options)
@@ -101,6 +116,8 @@ module ViewComponent
       self.class.i18n_scope
     end
 
+    private
+
     def html_safe_translation(translation)
       if translation.respond_to?(:map)
         translation.map { |element| html_safe_translation(element) }
@@ -112,18 +129,13 @@ module ViewComponent
       end
     end
 
-    private
-
     def html_escape_translation_options!(options)
       options.each do |name, value|
-        unless i18n_option?(name) || (name == :count && value.is_a?(Numeric))
-          options[name] = ERB::Util.html_escape(value.to_s)
-        end
-      end
-    end
+        next if ::I18n.reserved_keys_pattern.match?(name)
+        next if name == :count && value.is_a?(Numeric)
 
-    def i18n_option?(name)
-      (@i18n_option_names ||= I18n::RESERVED_KEYS.to_set).include?(name)
+        options[name] = ERB::Util.html_escape(value.to_s)
+      end
     end
   end
 end

data/lib/view_component/version.rb

@@ -2,11 +2,12 @@
 
 module ViewComponent
   module VERSION
-    MAJOR = 2
-    MINOR = 82
+    MAJOR = 3
+    MINOR = 0
     PATCH = 0
+    PRE = nil
 
-    STRING = [MAJOR, MINOR, PATCH].join(".")
+    STRING = [MAJOR, MINOR, PATCH, PRE].compact.join(".")
   end
 end
 

data/lib/view_component/with_content_helper.rb

@@ -3,14 +3,9 @@
 module ViewComponent
   module WithContentHelper
     def with_content(value)
-      if value.nil?
-        raise ArgumentError.new(
-          "No content provided to `#with_content` for #{self}.\n\n" \
-          "To fix this issue, pass a value."
-        )
-      else
-        @__vc_content_set_by_with_content = value
-      end
+      raise NilWithContentError if value.nil?
+
+      @__vc_content_set_by_with_content = value
 
       self
     end

data/lib/view_component.rb

@@ -7,29 +7,20 @@ module ViewComponent
   extend ActiveSupport::Autoload
 
   autoload :Base
+  autoload :CaptureCompatibility
   autoload :Compiler
   autoload :CompileCache
   autoload :ComponentError
   autoload :Config
   autoload :Deprecation
+  autoload :InlineTemplate
   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.deprecation_warning(
-    "Manually loading the engine",
-    "remove `require \"view_component/engine\"`"
-  )
-elsif defined?(Rails::Engine)
-  require "view_component/engine"
-end
-# :nocov:
+require "view_component/engine" if defined?(Rails::Engine)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.82.0
+  version: 3.0.0
 platform: ruby
 authors:
 - ViewComponent Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-11 00:00:00.000000000 Z
+date: 2023-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -90,16 +90,16 @@ dependencies:
   name: better_html
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -118,16 +118,16 @@ dependencies:
   name: erb_lint
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.37
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.37
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
@@ -212,6 +212,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-md
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
@@ -353,20 +367,20 @@ files:
 - lib/rails/generators/test_unit/templates/component_test.rb.tt
 - lib/view_component.rb
 - lib/view_component/base.rb
+- lib/view_component/capture_compatibility.rb
 - lib/view_component/collection.rb
 - 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
 - lib/view_component/docs_builder_component.rb
 - lib/view_component/engine.rb
+- lib/view_component/errors.rb
+- lib/view_component/inline_template.rb
 - lib/view_component/instrumentation.rb
-- lib/view_component/polymorphic_slots.rb
 - lib/view_component/preview.rb
-- lib/view_component/preview_template_error.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
@@ -375,12 +389,9 @@ files:
 - lib/view_component/rendering_component_helper.rb
 - lib/view_component/rendering_monkey_patch.rb
 - lib/view_component/slot.rb
-- lib/view_component/slot_v2.rb
 - lib/view_component/slotable.rb
-- lib/view_component/slotable_v2.rb
 - lib/view_component/system_test_case.rb
 - lib/view_component/system_test_helpers.rb
-- lib/view_component/template_error.rb
 - lib/view_component/test_case.rb
 - lib/view_component/test_helpers.rb
 - lib/view_component/translatable.rb
@@ -402,7 +413,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/view_component/content_areas.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-require "active_support/concern"
-
-require "view_component/slot"
-
-# DEPRECATED - ContentAreas is deprecated and will be removed in v3.0.0
-module ViewComponent
-  module ContentAreas
-    extend ActiveSupport::Concern
-
-    # Assign the provided content to the content area accessor
-    #
-    # @private
-    def with(area, content = nil, &block)
-      unless content_areas.include?(area)
-        raise ArgumentError.new(
-          "Unknown content_area '#{area}' for #{self} - expected one of '#{content_areas}'.\n\n" \
-          "To fix this issue, add `with_content_area :#{area}` to #{self} or reference " \
-          "a valid content area."
-        )
-      end
-
-      if block
-        content = view_context.capture(&block)
-      end
-
-      instance_variable_set("@#{area}".to_sym, content)
-      nil
-    end
-
-    class_methods do
-      def with_content_areas(*areas)
-        ViewComponent::Deprecation.deprecation_warning(
-          "`with_content_areas`", "use slots (https://viewcomponent.org/guide/slots.html) instead"
-        )
-
-        if areas.include?(:content)
-          raise ArgumentError.new(
-            "#{self} defines a content area called :content, which is a reserved name. \n\n" \
-            "To fix this issue, use another name, such as `:body`."
-          )
-        end
-
-        areas.each do |area|
-          define_method area.to_sym do
-            content unless content_evaluated? # ensure content is loaded so content_areas will be defined
-            instance_variable_get(:"@#{area}") if instance_variable_defined?(:"@#{area}")
-          end
-        end
-
-        self.content_areas = areas
-      end
-    end
-  end
-end

data/lib/view_component/polymorphic_slots.rb

@@ -1,103 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  module PolymorphicSlots
-    # In older rails versions, using a concern isn't a good idea here because they appear to not work with
-    # Module#prepend and class methods.
-    def self.included(base)
-      if base != ViewComponent::Base
-        # :nocov:
-        location = Kernel.caller_locations(1, 1)[0]
-
-        warn(
-          "warning: ViewComponent::PolymorphicSlots is now included in ViewComponent::Base by default " \
-          "and can be removed from #{location.path}:#{location.lineno}"
-        )
-        # :nocov:
-      end
-
-      base.singleton_class.prepend(ClassMethods)
-      base.include(InstanceMethods)
-    end
-
-    module ClassMethods
-      def renders_one(slot_name, callable = nil)
-        return super unless callable.is_a?(Hash) && callable.key?(:types)
-
-        validate_singular_slot_name(slot_name)
-        register_polymorphic_slot(slot_name, callable[:types], collection: false)
-      end
-
-      def renders_many(slot_name, callable = nil)
-        return super unless callable.is_a?(Hash) && callable.key?(:types)
-
-        validate_plural_slot_name(slot_name)
-        register_polymorphic_slot(slot_name, callable[:types], collection: true)
-      end
-
-      def register_polymorphic_slot(slot_name, types, collection:)
-        unless types.empty?
-          getter_name = slot_name
-
-          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|
-          memo[poly_type] = define_slot(
-            "#{slot_name}_#{poly_type}", collection: collection, callable: poly_callable
-          )
-
-          setter_name =
-            if collection
-              "#{ActiveSupport::Inflector.singularize(slot_name)}_#{poly_type}"
-            else
-              "#{slot_name}_#{poly_type}"
-            end
-
-          define_method(setter_name) do |*args, &block|
-            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
-          ruby2_keywords(setter_name.to_sym) if respond_to?(:ruby2_keywords, true)
-
-          define_method("with_#{setter_name}") do |*args, &block|
-            set_polymorphic_slot(slot_name, poly_type, *args, &block)
-          end
-          ruby2_keywords(:"with_#{setter_name}") if respond_to?(:ruby2_keywords, true)
-        end
-
-        registered_slots[slot_name] = {
-          collection: collection,
-          renderable_hash: renderable_hash
-        }
-      end
-    end
-
-    module InstanceMethods
-      def set_polymorphic_slot(slot_name, poly_type = nil, *args, &block)
-        slot_definition = self.class.registered_slots[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
-
-        poly_def = slot_definition[:renderable_hash][poly_type]
-
-        set_slot(slot_name, poly_def, *args, &block)
-      end
-      ruby2_keywords(:set_polymorphic_slot) if respond_to?(:ruby2_keywords, true)
-    end
-  end
-end

data/lib/view_component/preview_template_error.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  class PreviewTemplateError < StandardError
-  end
-end