view_component 2.33.0 → 2.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e1d8f453f26f7d62a3549dcfb34a85a6fadfc05a7b38515ebe53bba7500acc9
-  data.tar.gz: 39122c530de9fb557f7e66a0a3e6b94c20c492776edc45b193e2b3b60b834e39
+  metadata.gz: 8ec532b985935e7b718bb74aa51eaaa5e5f26ea0df8936e0c131231c9e9c37ed
+  data.tar.gz: c0cde4fa2a1b4d2c0110085b8c3c1b4705117f9ffe20775a096c5c3b20aa0728
 SHA512:
-  metadata.gz: 6f016eb4da5b952a220971e0163853b8ca77dd5bc820b634d525316b4117654b78a279ffeb7bb8d66ce68401cc41a350861696152992923445a1c3d6c587b2ed
-  data.tar.gz: 4203337d6188eea75e7d79ca246ca5309e5af7197256207e48c37b248958dbad49c07efff0a964d206d9c462ee5d1af3365f36f9f2d9e68661f7dbfe066e4a01
+  metadata.gz: 37cfdfd8cbf06773a015c13ed6f8c079f9d269045ba8ab1981e56d90cccf841152a8c9ab018b66c5289b8a1bbe5e4c7d1c8a0645e70578b1e97d9da098fe95cd
+  data.tar.gz: fe210839c3be3a8eb83e2bac1655f3ab5c5dc8d49727a413ba5ac46eeb0b4bb41e32f18c67b295bfe927cfc207dcc9df7f0c71f6ebc7f6064ea1c7c9fef6ddb7

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 ## main
 
+## 2.34.0
+
+* Add the ability to enable ActiveSupport notifications (`!render.view_component` event) with `config.view_component.instrumentation_enabled`.
+
+  *Svyatoslav Kryukov*
+
+* Add [Generators](https://viewcomponent.org/guide/generators.html) page to documentation.
+
+    *Hans Lemuet*
+
+* Fix bug where ViewComponents did not work in ActionMailers.
+
+    *dark-panda*
+
 ## 2.33.0
 
 * Add support for `_iteration` parameter when rendering in a collection

data/app/views/test_mailer/test_email.html.erb

@@ -0,0 +1 @@
+<%= render MailerComponent.new %>

data/lib/view_component.rb

@@ -8,6 +8,7 @@ module ViewComponent
   autoload :Base
   autoload :Compiler
   autoload :ComponentError
+  autoload :Instrumentation
   autoload :Preview
   autoload :PreviewTemplateError
   autoload :TestHelpers

data/lib/view_component/base.rb

@@ -136,6 +136,7 @@ module ViewComponent
     # This prevents an exception when rendering a partial inside of a component that has also been rendered outside
     # of the component. This is due to the partials compiled template method existing in the parent `view_context`,
     #  and not the component's `view_context`.
+    #
     # @private
     def render(options = {}, args = {}, &block)
       if options.is_a? ViewComponent::Base
@@ -162,6 +163,7 @@ module ViewComponent
     end
 
     # Exposes .virtual_path as an instance method
+    #
     # @private
     def virtual_path
       self.class.virtual_path
@@ -174,6 +176,7 @@ module ViewComponent
     end
 
     # For caching, such as #cache_if
+    #
     # @private
     def format
       # Ruby 2.6 throws a warning without checking `defined?`, 2.7 does not
@@ -183,6 +186,7 @@ module ViewComponent
     end
 
     # Assign the provided content to the content area accessor
+    #
     # @private
     def with(area, content = nil, &block)
       unless content_areas.include?(area)
@@ -197,7 +201,10 @@ module ViewComponent
       nil
     end
 
-    # @private TODO: add documentation
+    # Use the provided variant instead of the one determined by the current request.
+    #
+    # @param variant [Symbol] The variant to be used by the component.
+    # @return [self]
     def with_variant(variant)
       @variant = variant
 
@@ -208,7 +215,7 @@ module ViewComponent
     #
     # @return [ActionDispatch::Request]
     def request
-      @request ||= controller.request
+      @request ||= controller.request if controller.respond_to?(:request)
     end
 
     private

data/lib/view_component/engine.rb

@@ -13,6 +13,7 @@ module ViewComponent
 
       options.render_monkey_patch_enabled = true if options.render_monkey_patch_enabled.nil?
       options.show_previews = Rails.env.development? || Rails.env.test? if options.show_previews.nil?
+      options.instrumentation_enabled = false if options.instrumentation_enabled.nil?
       options.preview_route ||= ViewComponent::Base.preview_route
       options.preview_controller ||= ViewComponent::Base.preview_controller
 
@@ -30,7 +31,17 @@ module ViewComponent
       end
 
       ActiveSupport.on_load(:view_component) do
-        options.each { |k, v| send("#{k}=", v) }
+        options.each { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
+      end
+    end
+
+    initializer "view_component.enable_instrumentation" do |app|
+      ActiveSupport.on_load(:view_component) do
+        if app.config.view_component.instrumentation_enabled.present?
+          # :nocov:
+          ViewComponent::Base.prepend(ViewComponent::Instrumentation)
+          # :nocov:
+        end
       end
     end
 

data/lib/view_component/instrumentation.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "active_support/notifications"
+
+module ViewComponent # :nodoc:
+  module Instrumentation
+    def self.included(mod)
+      mod.prepend(self)
+    end
+
+    def render_in(view_context, &block)
+      ActiveSupport::Notifications.instrument("!render.view_component", name: self.class.name, identifier: self.class.identifier) do
+        super(view_context, &block)
+      end
+    end
+  end
+end

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 33
+    MINOR = 34
     PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.33.0
+  version: 2.34.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-02 00:00:00.000000000 Z
+date: 2021-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -237,6 +237,7 @@ files:
 - LICENSE.txt
 - README.md
 - app/controllers/view_components_controller.rb
+- app/views/test_mailer/test_email.html.erb
 - app/views/view_components/index.html.erb
 - app/views/view_components/preview.html.erb
 - app/views/view_components/previews.html.erb
@@ -262,6 +263,7 @@ files:
 - lib/view_component/compiler.rb
 - lib/view_component/component_error.rb
 - lib/view_component/engine.rb
+- lib/view_component/instrumentation.rb
 - lib/view_component/preview.rb
 - lib/view_component/preview_template_error.rb
 - lib/view_component/previewable.rb