view_component 4.5.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bb24a0e61e0b08097feff53e3303b5961b3c7bf24a8cc81b9a70480e7a7bfea
-  data.tar.gz: 7ba2ec6ff0f9ecaaf391c9218c86ebdbba78ac5cdee29d76c6f5367dc4fc7840
+  metadata.gz: 761d9451b4af2b617182339d3a356985d119be9ff490018815d9affd6ede89dc
+  data.tar.gz: 508b8e0699e11bbed4f649cebc9df0015e08e45b1cf92c1c528f13d566422c79
 SHA512:
-  metadata.gz: ef478e3d1270858f2d08fcfafee488c1c6899d9f80f7dcf0827f024519b60a366128e09ca308032d98a2087e993a6d6d4b36f5b8406d9fecb6baf05619ef72e9
-  data.tar.gz: 17f0d08421581f0f1b584debb484626b66f821317ff32d573dc2f52649a2cf6a82d911caec0bbb2362ee42bb9d99550c0857ebea42b0011b366f86149f1ec125
+  metadata.gz: 4820e68ab750d1c89901c2244527e8896d42a270afb20d8add4c0437fab80d7f4623e9da3817baafda390d94c77c0d5e79959f95772fedc571b132565fcd8bca
+  data.tar.gz: 1a3118de2ce98910b40ba370b13618083c396565a7b2db128eea39de7263c2d17240865caf2f94c7e83ee9113537cd5d18f6b6c3c80e137d5f5e15f1f823ba17

data/docs/CHANGELOG.md

@@ -10,6 +10,20 @@ nav_order: 6
 
 ## main
 
+## 4.6.0
+
+* Add `view_identifier` to the `render.view_component` instrumentation event payload, containing the path to the component's template file (e.g. `app/components/my_component.html.erb`). For components using inline render methods, `view_identifier` will be `nil`.
+
+    *GitHub Copilot*
+
+* Replace deprecated `require_dependency` with `require` in preview loading.
+
+    *GitHub Copilot*
+
+* Return `html_safe` empty string from `render_in` when `render?` is false.
+
+    *Copilot*
+
 ## 4.5.0
 
 * Fix initialization ordering issue causing missing asset errors in Sprockets.

data/lib/view_component/base.rb

@@ -160,7 +160,7 @@ module ViewComponent
 
         value
       else
-        ""
+        "".html_safe
       end
     ensure
       view_context.instance_variable_set(:@virtual_path, @old_virtual_path)

data/lib/view_component/instrumentation.rb

@@ -11,15 +11,28 @@ module ViewComponent # :nodoc:
     def render_in(view_context, &block)
       return super if !Rails.application.config.view_component.instrumentation_enabled.present?
 
+      payload = {
+        name: self.class.name,
+        identifier: self.class.identifier,
+        view_identifier: nil
+      }
+
       ActiveSupport::Notifications.instrument(
         "render.view_component",
-        {
-          name: self.class.name,
-          identifier: self.class.identifier
-        }
+        payload
       ) do
-        super
+        result = super
+        payload[:view_identifier] = @__vc_instrumentation_view_identifier
+        result
       end
+    ensure
+      @__vc_instrumentation_view_identifier = nil
+    end
+
+    def around_render
+      result = super
+      @__vc_instrumentation_view_identifier = current_template&.path
+      result
     end
   end
 end

data/lib/view_component/preview.rb

@@ -95,7 +95,7 @@ module ViewComponent # :nodoc:
       # @private
       def __vc_load_previews
         Array(preview_paths).each do |preview_path|
-          Dir["#{preview_path}/**/*preview.rb"].sort.each { |file| require_dependency file }
+          Dir["#{preview_path}/**/*preview.rb"].sort.each { |file| require file }
         end
       end
 

data/lib/view_component/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.6.0
 platform: ruby
 authors:
 - ViewComponent Team
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: A framework for building reusable, testable & encapsulated view components
   in Ruby on Rails.