view_component 4.0.0 → 4.12.0

data/lib/view_component/template.rb

@@ -21,11 +21,39 @@ module ViewComponent
 
     class File < Template
       def initialize(component:, details:, path:)
+        # If the template file has no format (e.g. .erb instead of .html.erb),
+        # assume the default format (html).
+        if details.format.nil?
+          Kernel.warn("WARNING: Template format for #{path} is missing, defaulting to :html.")
+          details = ActionView::TemplateDetails.new(details.locale, details.handler, DEFAULT_FORMAT, details.variant)
+        end
+
+        @strip_annotation_line = false
+
+        # Rails 8.1 added a newline to compiled ERB output (rails/rails#53731).
+        # Use -1 to compensate for correct line numbers in stack traces.
+        # However, negative line numbers cause segfaults when Ruby's coverage
+        # is enabled (bugs.ruby-lang.org/issues/19363). In that case, strip the
+        # annotation line from compiled source instead.
+        lineno =
+          if Rails::VERSION::MAJOR >= 8 && Rails::VERSION::MINOR > 0 && details.handler == :erb
+            if coverage_running?
+              # Can't use negative lineno with coverage (causes segfault on Linux).
+              # Strip annotation line if enabled to preserve correct line numbers.
+              @strip_annotation_line = ActionView::Base.annotate_rendered_view_with_filenames
+              0
+            else
+              -1
+            end
+          else
+            0
+          end
+
         super(
           component: component,
           details: details,
           path: path,
-          lineno: 0
+          lineno: lineno
         )
       end
 
@@ -37,6 +65,16 @@ module ViewComponent
       def source
         ::File.read(@path)
       end
+
+      private
+
+      def compiled_source
+        result = super
+        # Strip the annotation line to maintain correct line numbers when coverage
+        # is running (avoids segfault from negative lineno)
+        result = result.partition(";").last if @strip_annotation_line
+        result
+      end
     end
 
     class Inline < Template
@@ -45,11 +83,22 @@ module ViewComponent
       def initialize(component:, inline_template:)
         details = ActionView::TemplateDetails.new(nil, inline_template.language.to_sym, nil, nil)
 
+        # Rails 8.1 added a newline to compiled ERB output (rails/rails#53731).
+        # Subtract 1 to compensate for correct line numbers in stack traces.
+        # Inline templates start at line 2+ (defined inside a class), so this
+        # won't result in negative line numbers that cause segfaults with coverage.
+        lineno =
+          if Rails::VERSION::MAJOR >= 8 && Rails::VERSION::MINOR > 0 && details.handler == :erb
+            inline_template.lineno - 1
+          else
+            inline_template.lineno
+          end
+
         super(
           component: component,
           details: details,
           path: inline_template.path,
-          lineno: inline_template.lineno,
+          lineno: lineno,
         )
 
         @source = inline_template.source.dup
@@ -108,6 +157,10 @@ module ViewComponent
       @component.define_method(safe_method_name, @component.instance_method(@call_method_name))
     end
 
+    def coverage_running?
+      defined?(Coverage) && Coverage.running?
+    end
+
     def safe_method_name_call
       m = safe_method_name
       proc { send(m) }

data/lib/view_component/test_helpers.rb

@@ -35,12 +35,23 @@ module ViewComponent
     # ```
     #
     # @param component [ViewComponent::Base, ViewComponent::Collection] The instance of the component to be rendered.
+    #
     # @return [Nokogiri::HTML5]
     def render_inline(component, **args, &block)
       @page = nil
-      @rendered_content = vc_test_controller.view_context.render(component, args, &block)
+      @rendered_content = vc_test_view_context.render(component, args, &block)
 
-      Nokogiri::HTML5.fragment(@rendered_content)
+      fragment = Nokogiri::HTML5.fragment(@rendered_content, context: "template")
+      @vc_test_view_context = nil
+      fragment
+    end
+
+    # Returns the view context used to render components in tests. Note that the view context
+    # is reset after each call to `render_inline`.
+    #
+    # @return [ActionView::Base]
+    def vc_test_view_context
+      @vc_test_view_context ||= vc_test_controller.view_context
     end
 
     # `JSON.parse`-d component output.
@@ -61,17 +72,18 @@ module ViewComponent
     # 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::HTML5]
+    #
+    # @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`.
     def render_preview(name, from: __vc_test_helpers_preview_class, params: {})
       previews_controller = __vc_test_helpers_build_controller(Rails.application.config.view_component.previews.controller.constantize)
 
@@ -103,7 +115,7 @@ module ViewComponent
     # ```
     def render_in_view_context(...)
       @page = nil
-      @rendered_content = vc_test_controller.view_context.instance_exec(...)
+      @rendered_content = vc_test_view_context.instance_exec(...)
       Nokogiri::HTML5.fragment(@rendered_content)
     end
 
@@ -115,7 +127,7 @@ module ViewComponent
     # end
     # ```
     #
-    # @param variants [Symbol[]] The variants to be set for the provided block.
+    # @param variants [Array<Symbol>] The variants to be set for the provided block.
     def with_variant(*variants)
       old_variants = vc_test_controller.view_context.lookup_context.variants
 
@@ -152,7 +164,7 @@ module ViewComponent
     # end
     # ```
     #
-    # @param formats [Symbol[]] The format(s) to be set for the provided block.
+    # @param formats [Array<Symbol>] The format(s) to be set for the provided block.
     def with_format(*formats)
       old_formats = vc_test_controller.view_context.lookup_context.formats
 
@@ -186,10 +198,19 @@ module ViewComponent
     # end
     # ```
     #
+    # To specify a protocol, pass the protocol param:
+    #
+    # ```ruby
+    # with_request_url("/users/42", protocol: :https) do
+    #   render_inline(MyComponent.new)
+    # end
+    # ```
+    #
     # @param full_path [String] The path to set for the current request.
     # @param host [String] The host to set for the current request.
     # @param method [String] The request method to set for the current request.
-    def with_request_url(full_path, host: nil, method: nil)
+    # @param protocol [Symbol] The protocol to set for the current request (e.g., `:http` or `:https`).
+    def with_request_url(full_path, host: nil, method: nil, protocol: nil)
       old_request_host = vc_test_request.host
       old_request_method = vc_test_request.request_method
       old_request_path_info = vc_test_request.path_info
@@ -197,6 +218,7 @@ module ViewComponent
       old_request_query_parameters = vc_test_request.query_parameters
       old_request_query_string = vc_test_request.query_string
       old_request_format = vc_test_request.format.symbol
+      old_request_scheme = vc_test_request.scheme
       old_controller = defined?(@vc_test_controller) && @vc_test_controller
 
       path, query = full_path.split("?", 2)
@@ -204,6 +226,7 @@ module ViewComponent
       vc_test_request.instance_variable_set(:@original_fullpath, full_path)
       vc_test_request.host = host if host
       vc_test_request.request_method = method if method
+      vc_test_request.set_header(Rack::RACK_URL_SCHEME, protocol.to_s) if protocol
       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",
@@ -213,6 +236,7 @@ module ViewComponent
     ensure
       vc_test_request.host = old_request_host
       vc_test_request.request_method = old_request_method
+      vc_test_request.set_header(Rack::RACK_URL_SCHEME, old_request_scheme)
       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)

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 4
-    MINOR = 0
+    MINOR = 12
     PATCH = 0
     PRE = nil
 

data/lib/view_component.rb

@@ -2,6 +2,7 @@
 
 require "action_view"
 require "active_support/dependencies/autoload"
+require "view_component/version"
 
 module ViewComponent
   extend ActiveSupport::Autoload
@@ -16,7 +17,7 @@ module ViewComponent
   autoload :Preview
   autoload :Translatable
 
-  if Rails.env.test?
+  if defined?(Rails.env) && Rails.env.test?
     autoload :TestHelpers
     autoload :SystemSpecHelpers
     autoload :SystemTestHelpers

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.12.0
 platform: ruby
 authors:
 - ViewComponent Team
@@ -16,9 +16,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.1.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,9 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.1.0
-    - - "<"
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '8.1'
+        version: 7.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -127,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 4.0.10
 specification_version: 4
 summary: A framework for building reusable, testable & encapsulated view components
   in Ruby on Rails.