view_component 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 819e2fcc432b7272d23885e2ea361725b7eae87f4aeb216b2100500cadfd1ffc
-  data.tar.gz: 3958ff12852ee60b017ddeea924073bf7a787efe70d47929e692726fcd791adb
+  metadata.gz: 79d1337f1589a6e9ec7617c7d07917825c4f90b2e6093e6e925ef9fad3e06937
+  data.tar.gz: aaa0ddcd3a30c628409a4001efdd99c702ff5b97ff7873a3f3e092e05b54c3f6
 SHA512:
-  metadata.gz: ef854e693634333b5843a3cfb13f02271775c05856af79e439335f6154b2be9b4781fd4fa0a931eaad7f928048e9232cbd764dffc87fd64ee1730ec3c3af169c
-  data.tar.gz: 15300b4f6d30eaa481210993b6ff17cdfb5647498af89a25d951a961bbc6fe48c400dff287574ccf51f0c742d8dc753fd7ae6b753fe278af67b29bb95e0c315d
+  metadata.gz: 98381938a50a979a6ee135dff98c4e3b13a4a1b5ac8ee2f19c7e5f9b1bdc04470b355c55696d2724c733fab29a9379fe59c0a8e4273374e9db5210202be2dc06
+  data.tar.gz: 0b5276ff41b7b7ff493f935c75e8c3e8cc604decc42a950c97f1da3becccfba3446b40178c35b9b54578a47f3718bfa53ba2c6e91ec7b929a6adc7f26f41f782

data/docs/CHANGELOG.md

@@ -10,15 +10,83 @@ nav_order: 6
 
 ## main
 
+## 4.2.0
+
+* Fix translation scope resolution in deeply nested component blocks (3+ levels). Translations called inside deeply nested slot blocks using `renders_many`/`renders_one` were incorrectly resolving to an intermediate component's scope instead of the partial's scope where the block was defined. The fix captures the virtual path at block definition time and restores it during block execution, ensuring translations always resolve relative to where the block was created regardless of nesting depth.
+
+    *Nathaniel Watts*
+
+* Allow `render_inline` with Nokogiri::HTML5 to parse more arbitrary content including bare table content otherwise illegal fragments like `<td>`.
+
+    *Jonathan Rochkind*
+
+* Remove known issue from docs as ActiveScaffold is [now compatible](https://github.com/activescaffold/active_scaffold/pull/743) with ViewComponent.
+
+    *David Löwenfels*
+
+* Add test to document the current behavior for resolving relative translation keys within partial blocks. When rendering a partial, relative translation keys are resolved relative to the partial's own path rather than the caller’s path. This test ensures that this behavior remains consistent.
+
+    *Oussama Hilal*
+
+* Allow I18n calls in `render?`.
+
+    *23tux*
+
+* ViewComponent now works without `rails` and `railties` gems loaded, enabling compatibility with Bridgetown 2.0.
+
+    *Tom Lord*
+
+* Capture partial block in the component's context, allowing access to the component instance inside the block.
+
+    *23tux*
+
+* Add `after_compile` class method hook to enable extensions to run logic after component compilation.
+
+    *Jose Solás*
+
+* Fix outdated reference to preview layout configuration in docs.
+
+    *Lucas Geron*
+
+* Allow ruby-head CI job to fail without failing workflow.
+
+    *Hakan Ensari*
+
+* Fix bug where error line numbers were incorrect in Rails 8.1.
+
+    *Joel Hawksley*
+
+* Remove `< 8.2` upper bound for `activesupport` and `actionview` dependencies.
+
+    *Hans Lemuet*
+
+* Test compatibility with Herb/ReActionView.
+
+    *Joel Hawksley*
+
+* Remove Who Uses ViewComponent section from docs.
+
+    *Joel Hawksley*
+
+## 4.1.1
+
+* Resolve deprecation warning for `ActiveSupport::Configurable`.
+
+    *Simon Fish*
+
+* Make `ViewComponent::VERSION` accessible to other gems by default.
+
+    *Hans Lemuet*
+
 ## 4.1.0
 
 * Add Rails 8.1 support.
 
     *Hans Lemuet*
 
-* Add Carwow to list of companies using ViewComponent.
+* Declare `actionview` as a `view_component` gem dependency.
 
-    *Tom Lord*
+    *Michal Cichra*
 
 ## 4.0.2
 
@@ -498,10 +566,6 @@ This release makes the following breaking changes:
 
     *Martin Meyerhoff*, *Joel Hawksley*
 
-* Add Content Harmony & Learn To Be to list of companies using ViewComponent.
-
-    *Kane Jamison*
-
 * Clarify error message about render-dependent logic.
 
   Error messages about render-dependent logic were sometimes inaccurate, saying `during initialization` despite also being raised after a component had been initialized but before it was rendered.
@@ -520,10 +584,6 @@ This release makes the following breaking changes:
 
     *Reegan Viljoen*
 
-* Add HomeStyler AI to list of companies using ViewComponent.
-
-    *JP Balarini*
-
 ## 3.21.0
 
 * Updates testing docs to include an example of how to use with RSpec.
@@ -534,10 +594,6 @@ This release makes the following breaking changes:
 
     *KAWAKAMI Moeki*
 
-* Add FreeATS to list of companies using ViewComponent.
-
-    *Ilia Liamshin*
-
 * Ensure HTML output safety wrapper is used for all inline templates.
 
     *Joel Hawksley*
@@ -588,10 +644,6 @@ This release makes the following breaking changes:
 
     *Blake Williams*
 
-* Add [Niva]([niva.co](https://www.niva.co/)) to companies who use `ViewComponent`.
-
-    *Daniel Vu Dao*
-
 * Fix `preview_paths` in docs.
 
     *Javier Aranda*
@@ -656,10 +708,6 @@ This release makes the following breaking changes:
 
     *Joel Hawksley*
 
-* Add Kicksite to list of companies using ViewComponent.
-
-    *Adil Lari*
-
 * Allow overridden slot methods to use `super`.
 
     *Andrew Schwartz*
@@ -899,10 +947,6 @@ This release makes the following breaking changes:
 
     *Simon Fish*
 
-* Add Simundia to list of companies using ViewComponent.
-
-    *Alexandre Ignjatovic*
-
 * Reduce UnboundMethod objects by memoizing initialize_parameters.
 
     *Rainer Borene*
@@ -953,10 +997,6 @@ This release makes the following breaking changes:
 
     *milk1000cc*
 
-* Add PeopleForce to list of companies using ViewComponent.
-
-    *Volodymyr Khandiuk*
-
 ## 3.5.0
 
 * Add Skroutz to users list.
@@ -1031,14 +1071,6 @@ This release makes the following breaking changes:
 
     *Joel Hawksley*
 
-* Add Ophelos to list of companies using ViewComponent.
-
-    *Graham Rogers*
-
-* Add FlightLogger to list of companies using ViewComponent.
-
-    *Joseph Carpenter*
-
 * Fix coverage reports overwriting each other when running locally.
 
     *Jonathan del Strother*
@@ -1278,14 +1310,6 @@ Run into an issue with this release? [Let us know](https://github.com/ViewCompon
 
     *Graham Rogers*
 
-* Add Krystal to list of companies using ViewComponent.
-
-     *Matt Bearman*
-
-* Add Mon Ami to list of companies using ViewComponent.
-
-    *Ethan Lee-Tyson*
-
 ## 3.0.0.rc1
 
 1,000+ days and 100+ releases later, the 200+ contributors to ViewComponent are proud to ship v3.0.0!
@@ -1434,10 +1458,6 @@ Run into an issue with this release? [Let us know](https://github.com/ViewCompon
 
     *Hans Lemuet*
 
-* Add Startup Jobs to list of companies using ViewComponent.
-
-    *Marc Köhlbrugge*
-
 * Run PVC's accessibility tests in a single process to avoid resource contention in CI.
 
     *Cameron Dutro*
@@ -1478,10 +1498,6 @@ Run into an issue with this release? [Let us know](https://github.com/ViewCompon
 
 ## 2.74.0
 
-* Add Avo to list of companies using ViewComponent.
-
-    *Adrian Marin*
-
 * Promote experimental `_output_postamble` method to public API as `output_postamble`.
 
     *Joel Hawksley*
@@ -1508,10 +1524,6 @@ Run into an issue with this release? [Let us know](https://github.com/ViewCompon
 
     *Erinna Chen*
 
-* Add PrintReleaf to list of companies using ViewComponent.
-
-    *Ry Kulp*
-
 * Simplify CI configuration to a single build per Ruby/Rails version.
 
     *Joel Hawksley*
@@ -1520,10 +1532,6 @@ Run into an issue with this release? [Let us know](https://github.com/ViewCompon
 
     *Ruben Smit*
 
-* Add Yobbers to list of companies using ViewComponent.
-
-    *Anton Prins*
-
 ## 2.72.0
 
 * Deprecate support for Ruby < 2.7 for removal in v3.0.0.
@@ -1538,10 +1546,6 @@ Run into an issue with this release? [Let us know](https://github.com/ViewCompon
 
     *Joel Hawksley.
 
-* Add Aluuno to list of companies using ViewComponent.
-
-    *Daniel Naves de Carvalho*
-
 * Add `source_code_uri` to gemspec.
 
     *Yoshiyuki Hirano*
@@ -1576,22 +1580,10 @@ Run into an issue with this release? [Let us know](https://github.com/ViewCompon
 
     *Joel Hawksley*
 
-* Add Arrows to list of companies using ViewComponent.
-
-    *Matt Swanson*
-
-* Add WIP to list of companies using ViewComponent.
-
-    *Marc Köhlbrugge*
-
 * Update slots documentation to include how to reference slots.
 
     *Brittany Ellich*
 
-* Add Clio to list of companies using ViewComponent.
-
-    *Mike Buckley*
-
 ## 2.69.0
 
 * Add missing `require` to fix `pvc` build.
@@ -1709,10 +1701,6 @@ Run into an issue with this release? [Let us know](https://github.com/ViewCompon
 
     *Vikram Dighe*
 
-* Add HappyCo to list of companies using ViewComponent.
-
-    *Josh Clayton*
-
 * Add predicate method support to polymorphic slots.
 
     *Graham Rogers*
@@ -1823,10 +1811,6 @@ Run into an issue with this release? [Let us know](https://github.com/ViewCompon
 
     *Thomas Hutterer*
 
-* Add FreeAgent to list of companies using ViewComponent.
-
-    *Simon Fish*
-
 * Include polymorphic slots in `ViewComponent::Base` by default.
 
     *Cameron Dutro*
@@ -1882,18 +1866,6 @@ Run into an issue with this release? [Let us know](https://github.com/ViewCompon
 
     *Joel Hawksley*
 
-* Add G2 to list of companies that use ViewComponent.
-
-    *Jack Shuff*
-
-* Add Within3 to list of companies that use ViewComponent.
-
-    *Drew Bragg*
-
-* Add Mission Met to list of companies that use ViewComponent.
-
-    *Nick Smith*
-
 * Fix `#with_request_url` test helper not parsing nested query parameters into nested hashes.
 
     *Richard Marbach*
@@ -1933,10 +1905,6 @@ Run into an issue with this release? [Let us know](https://github.com/ViewCompon
 
     *Blake Williams*
 
-* Add QuickNode to list of companies that use ViewComponent.
-
-    *Luc Castera*
-
 * Include the `Translatable` module by default.
 
     *Elia Schito*
@@ -1967,10 +1935,6 @@ Run into an issue with this release? [Let us know](https://github.com/ViewCompon
 
     *Jason Swett*
 
-* Add Bearer to list of companies that use ViewComponent.
-
-    *Yaroslav Shmarov*
-
 * Add articles to resources page.
 
     *Joel Hawksley*
@@ -2000,10 +1964,6 @@ Run into an issue with this release? [Let us know](https://github.com/ViewCompon
 
     *Hans Lemuet*
 
-* Alphabetize companies using ViewComponent and add Brightline to the list.
-
-    *Jack Schuss*
-
 * Add CMYK value for ViewComponent Red color on logo page.
 
     *Dylan Smith*

data/lib/view_component/base.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "action_view"
-require "active_support/configurable"
 require "view_component/collection"
 require "view_component/compile_cache"
 require "view_component/compiler"
@@ -47,7 +46,7 @@ module ViewComponent
     end
 
     include ActionView::Helpers
-    include Rails.application.routes.url_helpers if defined?(Rails) && Rails.application
+    include Rails.application.routes.url_helpers if defined?(Rails.application.routes)
     include ERB::Escape
     include ActiveSupport::CoreExt::ERBUtil
 
@@ -132,6 +131,7 @@ module ViewComponent
 
       @__vc_content_evaluated = false
       @__vc_render_in_block = block
+      @view_context.instance_variable_set(:@virtual_path, virtual_path)
 
       before_render
 
@@ -139,8 +139,6 @@ module ViewComponent
         value = nil
 
         @output_buffer.with_buffer do
-          @view_context.instance_variable_set(:@virtual_path, virtual_path)
-
           rendered_template =
             around_render do
               render_template_for(@__vc_requested_details).to_s
@@ -261,6 +259,9 @@ module ViewComponent
         @view_context.render(options, args, &block)
       elsif block
         __vc_original_view_context.render(options, args) do
+          # capture the block output in the view context of the component
+          output = capture(&block)
+
           # Partials are rendered to their own buffer and do not append to the
           # original @output_buffer we retain a reference to in #render_in. This
           # is a problem since the block passed to us here in the #render method
@@ -268,7 +269,7 @@ module ViewComponent
           # appends to the original @output_buffer. To avoid this, we evaluate the
           # block in the view context instead, which will append to the output buffer
           # created for the partial.
-          __vc_original_view_context.instance_exec(&block)
+          __vc_original_view_context.capture { output }
         end
       else
         __vc_original_view_context.render(options, args)
@@ -302,7 +303,7 @@ module ViewComponent
       @__vc_helpers ||= __vc_original_view_context || controller.view_context
     end
 
-    if ::Rails.env.development? || ::Rails.env.test?
+    if defined?(Rails.env) && (::Rails.env.development? || ::Rails.env.test?)
       # @private
       def method_missing(method_name, *args) # rubocop:disable Style/MissingRespondToMissing
         super
@@ -331,7 +332,7 @@ module ViewComponent
       []
     end
 
-    if Rails::VERSION::MAJOR == 7 && Rails::VERSION::MINOR == 1
+    if defined?(Rails::VERSION) && Rails::VERSION::MAJOR == 7 && Rails::VERSION::MINOR == 1
       # Rails expects us to define `format` on all renderables,
       # but we do not know the `format` of a ViewComponent until runtime.
       def format
@@ -362,7 +363,7 @@ module ViewComponent
 
       @__vc_content =
         if __vc_render_in_block_provided?
-          with_original_virtual_path do
+          with_captured_virtual_path(@old_virtual_path) do
             view_context.capture(self, &@__vc_render_in_block)
           end
         elsif __vc_content_set_by_with_content_defined?
@@ -378,11 +379,14 @@ module ViewComponent
     end
 
     # @private
-    def with_original_virtual_path
-      @view_context.instance_variable_set(:@virtual_path, @old_virtual_path)
+    # Temporarily sets the virtual path to the captured value, then restores it.
+    # This ensures translations and other path-dependent code execute with the correct scope.
+    def with_captured_virtual_path(captured_path)
+      old_virtual_path = @view_context.instance_variable_get(:@virtual_path)
+      @view_context.instance_variable_set(:@virtual_path, captured_path)
       yield
     ensure
-      @view_context.instance_variable_set(:@virtual_path, virtual_path)
+      @view_context.instance_variable_set(:@virtual_path, old_virtual_path)
     end
 
     private
@@ -611,6 +615,16 @@ module ViewComponent
         __vc_compiler.compiled?
       end
 
+      # Hook called by the compiler after a component is compiled.
+      #
+      # Extensions can override this class method to run logic after
+      # compilation (e.g., generate helpers, register metadata, etc.).
+      #
+      # By default, this is a no-op.
+      def after_compile
+        # no-op by default
+      end
+
       # @private
       def __vc_ensure_compiled
         __vc_compile unless __vc_compiled?

data/lib/view_component/collection.rb

@@ -20,7 +20,7 @@ module ViewComponent
       components.each(&block)
     end
 
-    if Rails::VERSION::MAJOR == 7 && Rails::VERSION::MINOR == 1
+    if defined?(Rails::VERSION) && Rails::VERSION::MAJOR == 7 && Rails::VERSION::MINOR == 1
       # Rails expects us to define `format` on all renderables,
       # but we do not know the `format` of a ViewComponent until runtime.
       def format

data/lib/view_component/compiler.rb

@@ -52,6 +52,8 @@ module ViewComponent
         @component.__vc_build_i18n_backend
 
         CompileCache.register(@component)
+
+        @component.after_compile
       end
     end
 

data/lib/view_component/config.rb

@@ -163,7 +163,7 @@ module ViewComponent
         options = ActiveSupport::OrderedOptions.new
         options.controller = "ViewComponentsController"
         options.route = "/rails/view_components"
-        options.enabled = Rails.env.development? || Rails.env.test?
+        options.enabled = defined?(Rails.env) && (Rails.env.development? || Rails.env.test?)
         options.default_layout = nil
         options.paths = default_preview_paths
         options

data/lib/view_component/configurable.rb

@@ -4,14 +4,30 @@ module ViewComponent
   module Configurable
     extend ActiveSupport::Concern
 
+    class_methods do
+      def config
+        @_config ||= if respond_to?(:superclass) && superclass.respond_to?(:config)
+          superclass.config.inheritable_copy
+        else
+          ActiveSupport::OrderedOptions.new
+        end
+      end
+
+      def configure
+        yield config
+      end
+    end
+
     included do
       next if respond_to?(:config) && config.respond_to?(:view_component) && config.respond_to_missing?(:instrumentation_enabled)
 
-      include ActiveSupport::Configurable
-
       configure do |config|
         config.view_component ||= ActiveSupport::InheritableOptions.new
       end
+
+      def config
+        self.class.config
+      end
     end
   end
 end

data/lib/view_component/slot.rb

@@ -6,7 +6,7 @@ module ViewComponent
   class Slot
     include ViewComponent::WithContentHelper
 
-    attr_writer :__vc_component_instance, :__vc_content_block, :__vc_content
+    attr_writer :__vc_component_instance, :__vc_content_block, :__vc_content, :__vc_content_block_virtual_path
 
     def initialize(parent)
       @parent = parent
@@ -58,7 +58,7 @@ module ViewComponent
           if defined?(@__vc_content_block)
             # render_in is faster than `parent.render`
             @__vc_component_instance.render_in(view_context) do |*args|
-              @parent.with_original_virtual_path do
+              @parent.with_captured_virtual_path(@__vc_content_block_virtual_path) do
                 @__vc_content_block.call(*args)
               end
             end
@@ -68,7 +68,7 @@ module ViewComponent
         elsif defined?(@__vc_content)
           @__vc_content
         elsif defined?(@__vc_content_block)
-          @parent.with_original_virtual_path do
+          @parent.with_captured_virtual_path(@__vc_content_block_virtual_path) do
             view_context.capture(&@__vc_content_block)
           end
         elsif defined?(@__vc_content_set_by_with_content)

data/lib/view_component/slotable.rb

@@ -390,7 +390,12 @@ module ViewComponent
       # 2. Since we have to pass block content to components when calling
       # `render`, evaluating the block here would require us to call
       # `view_context.capture` twice, which is slower
-      slot.__vc_content_block = block if block
+      if block
+        slot.__vc_content_block = block
+        # Capture the virtual path at the time the block is defined, so that
+        # translations resolve relative to where the block was created, not where it's rendered
+        slot.__vc_content_block_virtual_path = view_context.instance_variable_get(:@virtual_path)
+      end
 
       # If class
       if slot_definition[:renderable]
@@ -408,7 +413,9 @@ module ViewComponent
         renderable_value =
           if block
             renderable_function.call(*args, **kwargs) do |*rargs|
-              view_context.capture(*rargs, &block)
+              with_captured_virtual_path(@old_virtual_path) do
+                view_context.capture(*rargs, &block)
+              end
             end
           else
             renderable_function.call(*args, **kwargs)

data/lib/view_component/template.rb

@@ -21,11 +21,20 @@ module ViewComponent
 
     class File < Template
       def initialize(component:, details:, path:)
+        # Rails 8.1 added a newline to the compiled ERB output in
+        # https://github.com/rails/rails/pull/53731
+        lineno =
+          if Rails::VERSION::MAJOR >= 8 && Rails::VERSION::MINOR > 0 && details.handler == :erb
+            - 1
+          else
+            0
+          end
+
         super(
           component: component,
           details: details,
           path: path,
-          lineno: 0
+          lineno: lineno
         )
       end
 
@@ -45,11 +54,20 @@ 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 the compiled ERB output in
+        # https://github.com/rails/rails/pull/53731
+        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

data/lib/view_component/test_helpers.rb

@@ -40,7 +40,7 @@ module ViewComponent
       @page = nil
       @rendered_content = vc_test_view_context.render(component, args, &block)
 
-      fragment = Nokogiri::HTML5.fragment(@rendered_content)
+      fragment = Nokogiri::HTML5.fragment(@rendered_content, context: "template")
       @vc_test_view_context = nil
       fragment
     end

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 4
-    MINOR = 1
+    MINOR = 2
     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.1.0
+  version: 4.2.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.2'
   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.2'
+        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