view_component 4.20.0 → 4.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04ae333990353bff3c4671c78db517fbe53ddcb15d9bfeb4448bc2d52c710f5b
-  data.tar.gz: ef958403f0326485a5f2035a9d744c878197c041247df3f76e68cf2712b9a652
+  metadata.gz: 829de474217e06e2148d92de68ef3d93dd8a31e314b40073fc292440508731b8
+  data.tar.gz: 1dfb4a41b58c47814b115b72e6cfc736e3239886376632e7177cadfa024c8582
 SHA512:
-  metadata.gz: 68e6ae32b57a9c1323ed64eb82c866e9595f2aeca16009b532f4922e85abe72536b06dc61d75328a202faef438f57e4d9deebef8ace06c96a3c7d609ad946a38
-  data.tar.gz: 52ef898174f4270dbc4bdcc91c0d841d35fe12c04c8b46e0639b0b1cb1a43b2789d24174cf70f2bc4ee3718eae536448b24833247cdd9a0f891c33678186060f
+  metadata.gz: 644364f5c6e4375b130074078de4e692dfdc4fca34ceca1bfedd307a135cfe9bd8ed81b111f08e1222af4d334afcb81fee48ee50a9b92bc21df591f783230314
+  data.tar.gz: d7902711e70321bc27f0b4b9bbf5dbd7f75864444dcaacf4bdfc762c765c87f688463b9f65edcf01656aea723fc82baf421edcf6f35989ce60c9875ebb91c699

data/docs/CHANGELOG.md

@@ -10,6 +10,100 @@ nav_order: 6
 
 ## main
 
+## 4.21.0
+
+* Avoid `NameError` during eager loading when components include modules with temporary names.
+
+    *Joel Hawksley*
+
+* Avoid repeated scanning of unterminated ERB tags during cache dependency discovery.
+
+    *Joel Hawksley*
+
+* Skip dependency compilation for static ERB markup and literal templates while preserving helper-rendered component tracking.
+
+    *Joel Hawksley*
+
+* Track helper-rendered component cache dependencies, enforce single-use instances on cache hits, and emit one render notification per self-cached render.
+
+    *Joel Hawksley*
+
+* Resolve symbolic translation defaults in sidecars, restore request URL state in tests, and refresh inherited templates whenever template reloading is enabled.
+
+    *Joel Hawksley*
+
+* Reuse existing GitHub releases when retrying a failed gem publish.
+
+    *Joel Hawksley*
+
+* Prevent self-cache key collisions and track component references in views and format-specific partial dependencies.
+
+    *Joel Hawksley*
+
+* Isolate preview and request parameters, honor preview locale callbacks, restore controller view contexts, and accept nil translation keys.
+
+    *Joel Hawksley*
+
+* Honor negative generator flags and preserve pre-release versions throughout release automation. Report gem publishing failures.
+
+    *Joel Hawksley*
+
+* Fix fragment cache collisions after `render_parent`, missing relative-partial and inherited-template dependencies, format fallback cache collisions, and stale cached output after development template edits.
+
+    *Joel Hawksley*
+
+* Fix template method collisions between formats and variants, preserve default slot state, and copy collection spacer slots independently.
+
+    *Joel Hawksley*
+
+* Apply `--skip-suffix` to all generated component files and restore full request URLs after `with_request_url` blocks.
+
+    *Joel Hawksley*
+
+* Reset the assertion page when rendering a preview so assertions inspect the latest output.
+
+    *Joel Hawksley*
+
+* Rediscover templates after development changes, including added or removed variants and parent templates.
+
+    *Joel Hawksley*
+
+* Include all requested variants in output cache keys, preserving fallback order.
+
+    *Joel Hawksley*
+
+* Resolve cache dependencies in their Ruby lexical namespaces and component template scopes.
+
+    *Joel Hawksley*
+
+* Keep default slot configuration isolated between parent components and subclasses.
+
+    *Joel Hawksley*
+
+* Preserve the calling view's translation scope when a component returns cached output or rejects content.
+
+    *Joel Hawksley*
+
+* Reduce rendering and collection overhead, and speed up eager loading by sharing template-path parsing and avoiding redundant template and ancestor checks.
+
+    *Joel Hawksley*
+
+* Speed up eager loading by sharing source-file reads between template compilation and cache digest precomputation, and reduce nested-render and default-slot lookup overhead.
+
+    *Joel Hawksley*
+
+* Speed up eager loading by sharing sidecar directory listings during compilation, and reduce per-render state reset overhead.
+
+    *Joel Hawksley*
+
+* Ignore unresolved partial dependencies inferred from dynamic renders, such as `render UI.button`, without requiring configuration for component facades. Real partials and explicit dependencies are preserved.
+
+    *Joel Hawksley*
+
+* Raise `ViewComponent::UnknownConfigOptionError` when setting a `config.view_component` option that doesn't exist, rather than ignoring it. This includes options renamed or removed in 4.0, such as `preview_controller` (now `previews.controller`), and the error names the replacement. Replacing `previews` or `generate` with a hash preserves this validation, including through Hash mutation methods such as `merge!`, `update`, `store`, and `replace`.
+
+    *Fiona Burcombe*
+
 ## 4.20.0
 
 * Fix `invalid byte sequence in UTF-8` errors when precomputing cache digests for components loaded from encrypted or binary source files.

data/lib/generators/view_component/abstract_generator.rb

@@ -2,6 +2,22 @@
 
 module ViewComponent
   module AbstractGenerator
+    def self.included(generator)
+      generator.class_option :skip_suffix, type: :boolean, default: false
+    end
+
+    def initialize(...)
+      super
+      generate = ViewComponent::Base.config.generate
+      defaults = {
+        "sidecar" => generate.sidecar,
+        "stimulus" => generate.stimulus_controller,
+        "typescript" => generate.typescript
+      }.slice(*self.class.class_options.keys.map(&:to_s))
+      # Resolve defaults once so hooks inherit explicit false values as well.
+      self.options = options.class.new(defaults.merge(options)).freeze
+    end
+
     def copy_view_file
       template("component.html.#{engine_name}", destination) unless options["inline"] || options["call"]
     end
@@ -21,7 +37,11 @@ module ViewComponent
     end
 
     def destination_file_name
-      "#{file_name}_component"
+      "#{file_name}#{"_component" unless options[:skip_suffix]}"
+    end
+
+    def component_class_name
+      "#{class_name}#{"Component" unless options[:skip_suffix]}"
     end
 
     def file_name
@@ -42,15 +62,15 @@ module ViewComponent
     end
 
     def sidecar?
-      options["sidecar"] || ViewComponent::Base.config.generate.sidecar
+      options["sidecar"]
     end
 
     def stimulus?
-      options["stimulus"] || ViewComponent::Base.config.generate.stimulus_controller
+      options["stimulus"]
     end
 
     def typescript?
-      options["typescript"] || ViewComponent::Base.config.generate.typescript
+      options["typescript"]
     end
   end
 end

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

@@ -10,20 +10,22 @@ module ViewComponent
       source_root File.expand_path("templates", __dir__)
 
       argument :attributes, type: :array, default: [], banner: "attribute"
-      check_class_collision suffix: "Component"
 
       class_option :call, type: :boolean, default: false
       class_option :inline, type: :boolean, default: false
       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.config.generate.preview
-      class_option :sidecar, type: :boolean, default: false
-      class_option :stimulus, type: :boolean,
-        default: ViewComponent::Base.config.generate.stimulus_controller
-      class_option :skip_suffix, type: :boolean, default: false
+      class_option :sidecar, type: :boolean
+      class_option :stimulus, type: :boolean
+      class_option :typescript, type: :boolean
+
+      def check_class_collision
+        class_collisions component_class_name
+      end
 
       def create_component_file
-        template "component.rb", File.join(component_path, class_path, "#{file_name}#{"_component" unless options[:skip_suffix]}.rb")
+        template "component.rb", File.join(component_path, class_path, "#{destination_file_name}.rb")
       end
 
       hook_for :test_framework

data/lib/generators/view_component/component/templates/component.rb.tt

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 <% module_namespacing do -%>
-class <%= class_name %><%= options[:skip_suffix] ? "" : "Component" %> < <%= parent_class %>
+class <%= component_class_name %> < <%= parent_class %>
 <%- if inline_template? -%>
   <%= template_engine %>_template <<~<%= template_engine.upcase %>
     <h1>Hello, World!</h1>

data/lib/generators/view_component/erb/erb_generator.rb

@@ -9,10 +9,10 @@ module ViewComponent
       include ViewComponent::AbstractGenerator
 
       source_root File.expand_path("templates", __dir__)
-      class_option :sidecar, type: :boolean, default: false
+      class_option :sidecar, type: :boolean
       class_option :inline, type: :boolean, default: false
       class_option :call, type: :boolean, default: false
-      class_option :stimulus, type: :boolean, default: false
+      class_option :stimulus, type: :boolean
 
       def engine_name
         "erb"

data/lib/generators/view_component/haml/haml_generator.rb

@@ -8,7 +8,7 @@ module ViewComponent
       include ViewComponent::AbstractGenerator
 
       source_root File.expand_path("templates", __dir__)
-      class_option :sidecar, type: :boolean, default: false
+      class_option :sidecar, type: :boolean
 
       def engine_name
         "haml"

data/lib/generators/view_component/locale/locale_generator.rb

@@ -9,7 +9,7 @@ module ViewComponent
 
       source_root File.expand_path("templates", __dir__)
       argument :attributes, type: :array, default: [], banner: "attribute"
-      class_option :sidecar, type: :boolean, default: false
+      class_option :sidecar, type: :boolean
 
       def create_locale_file
         if ViewComponent::Base.config.generate.distinct_locale_files
@@ -35,11 +35,7 @@ module ViewComponent
 
       def destination(locale = nil)
         extension = ".#{locale}" if locale
-        if sidecar?
-          File.join(component_path, class_path, "#{file_name}_component", "#{file_name}_component#{extension}.yml")
-        else
-          File.join(component_path, class_path, "#{file_name}_component#{extension}.yml")
-        end
+        File.join(destination_directory, "#{destination_file_name}#{extension}.yml")
       end
     end
   end

data/lib/generators/view_component/preview/preview_generator.rb

@@ -1,13 +1,20 @@
 # frozen_string_literal: true
 
+require "generators/view_component/abstract_generator"
+
 module ViewComponent
   module Generators
     class PreviewGenerator < ::Rails::Generators::NamedBase
+      include ViewComponent::AbstractGenerator
+
       source_root File.expand_path("templates", __dir__)
       class_option :preview_path, type: :string, desc: "Path for previews, required when multiple preview paths are configured", default: ViewComponent::Base.config.generate.preview_path
 
       argument :attributes, type: :array, default: [], banner: "attribute"
-      check_class_collision suffix: "ComponentPreview"
+
+      def check_class_collision
+        class_collisions "#{component_class_name}Preview"
+      end
 
       def create_preview_file
         preview_paths = ViewComponent::Base.config.previews.paths
@@ -20,15 +27,11 @@ module ViewComponent
           preview_paths.one? ? preview_paths.first : "test/components/previews"
         end
 
-        template "component_preview.rb", File.join(path_prefix, class_path, "#{file_name}_component_preview.rb")
+        template "component_preview.rb", File.join(path_prefix, class_path, "#{destination_file_name}_preview.rb")
       end
 
       private
 
-      def file_name
-        @_file_name ||= super.sub(/_component\z/i, "")
-      end
-
       def render_signature
         return if attributes.blank?
 

data/lib/generators/view_component/preview/templates/component_preview.rb.tt

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 <% module_namespacing do -%>
-class <%= class_name %>ComponentPreview < ViewComponent::Preview
+class <%= component_class_name %>Preview < ViewComponent::Preview
   def default
-    render(<%= class_name %>Component.new<%= "(#{render_signature})" if render_signature %>)
+    render(<%= component_class_name %>.new<%= "(#{render_signature})" if render_signature %>)
   end
 end
 <% end -%>

data/lib/generators/view_component/rspec/rspec_generator.rb

@@ -10,7 +10,7 @@ module ViewComponent
       source_root File.expand_path("templates", __dir__)
 
       def create_test_file
-        template "component_spec.rb", File.join(spec_component_path, class_path, "#{file_name}_component_spec.rb")
+        template "component_spec.rb", File.join(spec_component_path, class_path, "#{destination_file_name}_spec.rb")
       end
 
       private

data/lib/generators/view_component/rspec/templates/component_spec.rb.tt

@@ -2,7 +2,7 @@
 
 require "rails_helper"
 
-RSpec.describe <%= namespaced? ? "#{namespace.name}::" : '' %><%= class_name %>Component, type: :component do
+RSpec.describe <%= namespaced? ? "#{namespace.name}::" : '' %><%= component_class_name %>, type: :component do
   pending "add some examples to (or delete) #{__FILE__}"
 
   # it "renders something useful" do

data/lib/generators/view_component/slim/slim_generator.rb

@@ -8,7 +8,7 @@ module ViewComponent
       include ViewComponent::AbstractGenerator
 
       source_root File.expand_path("templates", __dir__)
-      class_option :sidecar, type: :boolean, default: false
+      class_option :sidecar, type: :boolean
 
       def engine_name
         "slim"

data/lib/generators/view_component/stimulus/stimulus_generator.rb

@@ -8,8 +8,8 @@ module ViewComponent
       include ViewComponent::AbstractGenerator
 
       source_root File.expand_path("templates", __dir__)
-      class_option :sidecar, type: :boolean, default: false
-      class_option :typescript, type: :boolean, default: false
+      class_option :sidecar, type: :boolean
+      class_option :typescript, type: :boolean
 
       def create_stimulus_controller
         template "component_controller.#{filetype}", destination
@@ -28,11 +28,7 @@ module ViewComponent
       end
 
       def destination
-        if sidecar?
-          File.join(component_path, class_path, "#{file_name}_component", "#{file_name}_component_controller.#{filetype}")
-        else
-          File.join(component_path, class_path, "#{file_name}_component_controller.#{filetype}")
-        end
+        File.join(destination_directory, "#{destination_file_name}_controller.#{filetype}")
       end
 
       def legacy_stimulus?

data/lib/generators/view_component/test_unit/templates/component_test.rb.tt

@@ -2,11 +2,11 @@
 
 require "test_helper"
 
-class <%= namespaced? ? "#{namespace.name}::" : '' %><%= class_name %>ComponentTest < ViewComponent::TestCase
+class <%= namespaced? ? "#{namespace.name}::" : '' %><%= component_class_name %>Test < ViewComponent::TestCase
   def test_component_renders_something_useful
     # assert_equal(
     #   %(<span>Hello, components!</span>),
-    #   render_inline(<%= class_name %>Component.new(message: "Hello, components!")).css("span").to_html
+    #   render_inline(<%= component_class_name %>.new(message: "Hello, components!")).css("span").to_html
     # )
   end
 end

data/lib/generators/view_component/test_unit/test_unit_generator.rb

@@ -1,19 +1,20 @@
 # frozen_string_literal: true
 
+require "generators/view_component/abstract_generator"
+
 module ViewComponent
   module Generators
     class TestUnitGenerator < ::Rails::Generators::NamedBase
+      include ViewComponent::AbstractGenerator
+
       source_root File.expand_path("templates", __dir__)
-      check_class_collision suffix: "ComponentTest"
 
-      def create_test_file
-        template "component_test.rb", File.join("test/components", class_path, "#{file_name}_component_test.rb")
+      def check_class_collision
+        class_collisions "#{component_class_name}Test"
       end
 
-      private
-
-      def file_name
-        @_file_name ||= super.sub(/_component\z/i, "")
+      def create_test_file
+        template "component_test.rb", File.join("test/components", class_path, "#{destination_file_name}_test.rb")
       end
     end
   end