view_component 2.30.0 → 2.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bb3c2781d5f07f404e5bf9582758537704a05c3937529c250ae657541d4f664
-  data.tar.gz: 0efa6d2e3bbf03ed206e02b9dad11bea1f5649ab655dfff78d1f48c68414129f
+  metadata.gz: 8ec532b985935e7b718bb74aa51eaaa5e5f26ea0df8936e0c131231c9e9c37ed
+  data.tar.gz: c0cde4fa2a1b4d2c0110085b8c3c1b4705117f9ffe20775a096c5c3b20aa0728
 SHA512:
-  metadata.gz: 9222381535158cc047e33e37341329c232ac984ee3f6895e95251cd9dabc9b92baebb69b336500932c264b48eb7f74ef0b7d3f918473d8fe83151ad73c18323b
-  data.tar.gz: 4da1bd8980affd316288695a52e9fcdccad912f3447081f0186194190ad48e52d397f36c34b3bea70ea743d32f2eda8d37779ecb588b50cbd626f7d89a4f365c
+  metadata.gz: 37cfdfd8cbf06773a015c13ed6f8c079f9d269045ba8ab1981e56d90cccf841152a8c9ab018b66c5289b8a1bbe5e4c7d1c8a0645e70578b1e97d9da098fe95cd
+  data.tar.gz: fe210839c3be3a8eb83e2bac1655f3ab5c5dc8d49727a413ba5ac46eeb0b4bb41e32f18c67b295bfe927cfc207dcc9df7f0c71f6ebc7f6064ea1c7c9fef6ddb7

data/CHANGELOG.md

@@ -2,6 +2,94 @@
 
 ## 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
+
+    *Will Cosgrove*
+
+* Don't raise an error when rendering empty components.
+
+    *Alex Robbin*
+
+## 2.32.0
+
+* Enable previews by default in test environment.
+
+    *Edouard Piron*
+
+* Fix test helper compatibility with Rails 7.0, TestRequest, and TestSession.
+
+    *Leo Correa*
+
+* Add experimental `_output_postamble` lifecyle method.
+
+    *Joel Hawksley*
+
+* Add compatibility notes on FAQ.
+
+    *Matheus Richard*
+
+* Add Bridgetown on Compatibility documentation.
+
+    *Matheus Richard*
+
+* Are you interested in building the future of ViewComponent? GitHub is looking to hire a Senior Engineer to work on Primer ViewComponents and ViewComponent. Apply here: [US/Canada](https://github.com/careers) / [Europe](https://boards.greenhouse.io/github/jobs/3132294). Feel free to reach out to joelhawksley@github.com with any questions.
+
+    *Joel Hawksley*
+
+## 2.31.1
+
+* Fix `DEPRECATION WARNING: before_render_check` when compiling `ViewComponent::Base`
+
+    *Dave Kroondyk*
+
+## 2.31.0
+
+_Note: This release includes an underlying change to Slots that may affect incorrect usage of the API, where Slots were set on a line prefixed by `<%=`. The result of setting a Slot should not be returned. (`<%`)_
+
+* Add `#with_content` to allow setting content without a block.
+
+    *Jordan Raine, Manuel Puyol*
+
+* Add `with_request_url` test helper.
+
+    *Mario Schüttel*
+
+* Improve feature parity with Rails translations
+  * Don't create a translation backend if the component has no translation file
+  * Mark translation keys ending with `html` as HTML-safe
+  * Always convert keys to String
+  * Support multiple keys
+
+    *Elia Schito*
+
+* Fix errors on `asset_url` helpers when `asset_host` has no protocol.
+
+    *Elia Schito*
+
+* Prevent slots from overriding the `#content` method when registering a slot with that name.
+
+    *Blake Williams*
+
+* Deprecate `with_slot` in favor of the new [slots API](https://viewcomponent.org/guide/slots.html).
+
+    *Manuel Puyol*
+
 ## 2.30.0
 
 * Deprecate `with_content_areas` in favor of [slots](https://viewcomponent.org/guide/slots.html).

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

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

data/lib/view_component.rb

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

data/lib/view_component/base.rb

@@ -7,12 +7,14 @@ require "view_component/compile_cache"
 require "view_component/previewable"
 require "view_component/slotable"
 require "view_component/slotable_v2"
+require "view_component/with_content_helper"
 
 module ViewComponent
   class Base < ActionView::Base
     include ActiveSupport::Configurable
     include ViewComponent::Previewable
     include ViewComponent::SlotableV2
+    include ViewComponent::WithContentHelper
 
     ViewContextCalledBeforeRenderError = Class.new(StandardError)
 
@@ -28,6 +30,7 @@ module ViewComponent
     # Hook for allowing components to do work as part of the compilation process.
     #
     # For example, one might compile component-specific assets at this point.
+    # @private TODO: add documentation
     def self._after_compile
       # noop
     end
@@ -56,6 +59,7 @@ module ViewComponent
     # returns:
     # <span title="greeting">Hello, world!</span>
     #
+    # @private
     def render_in(view_context, &block)
       self.class.compile(raise_errors: true)
 
@@ -79,13 +83,15 @@ module ViewComponent
       old_current_template = @current_template
       @current_template = self
 
+      raise ArgumentError.new("Block provided after calling `with_content`. Use one or the other.") if block && defined?(@_content_set_by_with_content)
+
       @_content_evaluated = false
       @_render_in_block = block
 
       before_render
 
       if render?
-        render_template_for(@variant)
+        render_template_for(@variant).to_s + _output_postamble
       else
         ""
       end
@@ -93,18 +99,36 @@ module ViewComponent
       @current_template = old_current_template
     end
 
+    # EXPERIMENTAL: Optional content to be returned after the rendered template.
+    #
+    # @return [String]
+    def _output_postamble
+      ""
+    end
+
+    # Called before rendering the component. Override to perform operations that depend on having access to the view context, such as helpers.
+    #
+    # @return [void]
     def before_render
       before_render_check
     end
 
+    # Called after rendering the component.
+    #
+    # @deprecated Use `before_render` instead. Will be removed in v3.0.0.
+    # @return [void]
     def before_render_check
       # noop
     end
 
+    # Override to determine whether the ViewComponent should render.
+    #
+    # @return [Boolean]
     def render?
       true
     end
 
+    # @private
     def initialize(*); end
 
     # Re-use original view_context if we're not rendering a component.
@@ -112,6 +136,8 @@ 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
         super
@@ -120,28 +146,38 @@ module ViewComponent
       end
     end
 
+    # The current controller. Use sparingly as doing so introduces coupling that inhibits encapsulation & reuse, often making testing difficult.
+    #
+    # @return [ActionController::Base]
     def controller
       raise ViewContextCalledBeforeRenderError, "`controller` can only be called at render time." if view_context.nil?
       @controller ||= view_context.controller
     end
 
-    # Provides a proxy to access helper methods from the context of the current controller
+    # A proxy through which to access helpers. Use sparingly as doing so introduces coupling that inhibits encapsulation & reuse, often making testing difficult.
+    #
+    # @return [ActionView::Base]
     def helpers
       raise ViewContextCalledBeforeRenderError, "`helpers` can only be called at render time." if view_context.nil?
       @helpers ||= controller.view_context
     end
 
     # Exposes .virtual_path as an instance method
+    #
+    # @private
     def virtual_path
       self.class.virtual_path
     end
 
     # For caching, such as #cache_if
+    # @private
     def view_cache_dependencies
       []
     end
 
     # For caching, such as #cache_if
+    #
+    # @private
     def format
       # Ruby 2.6 throws a warning without checking `defined?`, 2.7 does not
       if defined?(@variant)
@@ -150,6 +186,8 @@ module ViewComponent
     end
 
     # Assign the provided content to the content area accessor
+    #
+    # @private
     def with(area, content = nil, &block)
       unless content_areas.include?(area)
         raise ArgumentError.new "Unknown content_area '#{area}' - expected one of '#{content_areas}'"
@@ -163,21 +201,25 @@ module ViewComponent
       nil
     end
 
+    # 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
 
       self
     end
 
-    private
-
-    # Exposes the current request to the component.
-    # Use sparingly as doing so introduces coupling
-    # that inhibits encapsulation & reuse.
+    # The current request. Use sparingly as doing so introduces coupling that inhibits encapsulation & reuse, often making testing difficult.
+    #
+    # @return [ActionDispatch::Request]
     def request
-      @request ||= controller.request
+      @request ||= controller.request if controller.respond_to?(:request)
     end
 
+    private
+
     attr_reader :view_context
 
     def content
@@ -186,6 +228,8 @@ module ViewComponent
 
       @_content = if @view_context && @_render_in_block
         view_context.capture(self, &@_render_in_block)
+      elsif defined?(@_content_set_by_with_content)
+        @_content_set_by_with_content
       end
     end
 
@@ -280,7 +324,7 @@ module ViewComponent
       end
 
       def compiled?
-        template_compiler.compiled?
+        compiler.compiled?
       end
 
       # Compile templates to instance methods, assuming they haven't been compiled already.
@@ -288,11 +332,11 @@ module ViewComponent
       # Do as much work as possible in this step, as doing so reduces the amount
       # of work done each time a component is rendered.
       def compile(raise_errors: false)
-        template_compiler.compile(raise_errors: raise_errors)
+        compiler.compile(raise_errors: raise_errors)
       end
 
-      def template_compiler
-        @_template_compiler ||= Compiler.new(self)
+      def compiler
+        @_compiler ||= Compiler.new(self)
       end
 
       # we'll eventually want to update this to support other types
@@ -365,7 +409,7 @@ module ViewComponent
       def validate_initialization_parameters!
         return unless initialize_parameter_names.include?(RESERVED_PARAMETER)
 
-        raise ArgumentError.new(
+        raise ViewComponent::ComponentError.new(
           "#{self} initializer cannot contain " \
           "`#{RESERVED_PARAMETER}` since it will override a " \
           "public ViewComponent method."
@@ -385,7 +429,15 @@ module ViewComponent
       end
 
       def counter_argument_present?
-        instance_method(:initialize).parameters.map(&:second).include?(collection_counter_parameter)
+        initialize_parameter_names.include?(collection_counter_parameter)
+      end
+
+      def collection_iteration_parameter
+        "#{collection_parameter}_iteration".to_sym
+      end
+
+      def iteration_argument_present?
+        initialize_parameter_names.include?(collection_iteration_parameter)
       end
 
       private

data/lib/view_component/collection.rb

@@ -38,6 +38,7 @@ module ViewComponent
     def component_options(item, iterator)
       item_options = { component.collection_parameter => item }
       item_options[component.collection_counter_parameter] = iterator.index + 1 if component.counter_argument_present?
+      item_options[component.collection_iteration_parameter] = iterator if component.iteration_argument_present?
 
       @options.merge(item_options)
     end

data/lib/view_component/compiler.rb

@@ -13,12 +13,18 @@ module ViewComponent
     def compile(raise_errors: false)
       return if compiled?
 
+      subclass_instance_methods = component_class.instance_methods(false)
+
+      if subclass_instance_methods.include?(:with_content) && raise_errors
+        raise ViewComponent::ComponentError.new("#{component_class} implements a reserved method, `with_content`.")
+      end
+
       if template_errors.present?
         raise ViewComponent::TemplateError.new(template_errors) if raise_errors
         return false
       end
 
-      if component_class.instance_methods(false).include?(:before_render_check)
+      if subclass_instance_methods.include?(:before_render_check)
         ActiveSupport::Deprecation.warn(
           "`before_render_check` will be removed in v3.0.0. Use `before_render` instead."
         )

data/lib/view_component/component_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  class ComponentError < StandardError
+  end
+end

data/lib/view_component/engine.rb

@@ -12,7 +12,8 @@ module ViewComponent
       options = app.config.view_component
 
       options.render_monkey_patch_enabled = true if options.render_monkey_patch_enabled.nil?
-      options.show_previews = Rails.env.development? if options.show_previews.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/slot_v2.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
+require "view_component/with_content_helper"
+
 module ViewComponent
   class SlotV2
+    include ViewComponent::WithContentHelper
+
     attr_writer :_component_instance, :_content_block, :_content
 
     def initialize(parent)
@@ -26,10 +30,18 @@ module ViewComponent
 
       view_context = @parent.send(:view_context)
 
+      raise ArgumentError.new("Block provided after calling `with_content`. Use one or the other.") if defined?(@_content_block) && defined?(@_content_set_by_with_content)
+
       @content = if defined?(@_component_instance)
-        # render_in is faster than `parent.render`
-        if defined?(@_content_block)
+        if defined?(@_content_set_by_with_content)
+          @_component_instance.with_content(@_content_set_by_with_content)
+
+          view_context.capture do
+            @_component_instance.render_in(view_context)
+          end
+        elsif defined?(@_content_block)
           view_context.capture do
+            # render_in is faster than `parent.render`
             @_component_instance.render_in(view_context, &@_content_block)
           end
         else
@@ -41,6 +53,8 @@ module ViewComponent
         @_content
       elsif defined?(@_content_block)
         view_context.capture(&@_content_block)
+      elsif defined?(@_content_set_by_with_content)
+        @_content_set_by_with_content
       end
 
       @content

data/lib/view_component/slotable.rb

@@ -23,6 +23,11 @@ module ViewComponent
       #   class_name: "Header" # class name string, used to instantiate Slot
       # )
       def with_slot(*slot_names, collection: false, class_name: nil)
+        ActiveSupport::Deprecation.warn(
+          "`with_slot` is deprecated and will be removed in ViewComponent v3.0.0.\n" \
+          "Use the new slots API (https://viewcomponent.org/guide/slots.html) instead."
+        )
+
         slot_names.each do |slot_name|
           # Ensure slot_name is not already declared
           if self.slots.key?(slot_name)

data/lib/view_component/slotable_v2.rb

@@ -60,7 +60,7 @@ module ViewComponent
       # helper method with the same name as the slot.
       #
       #   <%= render_inline(MyComponent.new) do |component| %>
-      #     <%= component.header(classes: "Foo") do %>
+      #     <% component.header(classes: "Foo") do %>
       #       <p>Bar</p>
       #     <% end %>
       #   <% end %>
@@ -95,7 +95,7 @@ module ViewComponent
       # helper method with the same name as the slot.
       #
       #   <h1>
-      #     <%= items.each do |item| %>
+      #     <% items.each do |item| %>
       #       <%= item %>
       #     <% end %>
       #   </h1>
@@ -107,11 +107,11 @@ module ViewComponent
       # called multiple times to append to the slot.
       #
       #   <%= render_inline(MyComponent.new) do |component| %>
-      #     <%= component.item(name: "Foo") do %>
+      #     <% component.item(name: "Foo") do %>
       #       <p>One</p>
       #     <% end %>
       #
-      #     <%= component.item(name: "Bar") do %>
+      #     <% component.item(name: "Bar") do %>
       #       <p>two</p>
       #     <% end %>
       #   <% end %>
@@ -175,6 +175,10 @@ module ViewComponent
       end
 
       def validate_slot_name(slot_name)
+        if slot_name.to_sym == :content
+          raise ArgumentError.new("#{slot_name} is not a valid slot name.")
+        end
+
         if self.registered_slots.key?(slot_name)
           # TODO remove? This breaks overriding slots when slots are inherited
           raise ArgumentError.new("#{slot_name} slot declared multiple times")
@@ -251,7 +255,7 @@ module ViewComponent
         @_set_slots[slot_name] = slot
       end
 
-      nil
+      slot
     end
   end
 end

data/lib/view_component/test_helpers.rb

@@ -39,7 +39,12 @@ module ViewComponent
     end
 
     def request
-      @request ||= ActionDispatch::TestRequest.create
+      @request ||=
+        begin
+          request = ActionDispatch::TestRequest.create
+          request.session = ActionController::TestSession.new
+          request
+        end
     end
 
     def with_variant(variant)
@@ -60,6 +65,17 @@ module ViewComponent
       @controller = old_controller
     end
 
+    def with_request_url(path)
+      old_request_path_parameters = request.path_parameters
+      old_controller = defined?(@controller) && @controller
+
+      request.path_parameters = Rails.application.routes.recognize_path(path)
+      yield
+    ensure
+      request.path_parameters = old_request_path_parameters
+      @controller = old_controller
+    end
+
     def build_controller(klass)
       klass.new.tap { |c| c.request = request }.extend(Rails.application.routes.url_helpers)
     end

data/lib/view_component/translatable.rb

@@ -9,6 +9,8 @@ module ViewComponent
   module Translatable
     extend ActiveSupport::Concern
 
+    HTML_SAFE_TRANSLATION_KEY = /(?:_|\b)html\z/.freeze
+
     included do
       class_attribute :i18n_backend, instance_writer: false, instance_predicate: false
     end
@@ -21,11 +23,16 @@ module ViewComponent
       def _after_compile
         super
 
-        unless CompileCache.compiled? self
+        return if CompileCache.compiled? self
+
+        if (translation_files = _sidecar_files(%w[yml yaml])).any?
           self.i18n_backend = I18nBackend.new(
             i18n_scope: i18n_scope,
-            load_paths: _sidecar_files(%w[yml yaml]),
+            load_paths: translation_files,
           )
+        else
+          # Cleanup if translations file has been removed since the last compilation
+          self.i18n_backend = nil
         end
       end
     end
@@ -55,21 +62,28 @@ module ViewComponent
       end
     end
 
-    def translate(key = nil, locale: nil, **options)
-      locale ||= ::I18n.locale
+    def translate(key = nil, **options)
+      return super unless i18n_backend
+      return key.map { |k| translate(k, **options) } if key.is_a?(Array)
 
+      locale = options.delete(:locale) || ::I18n.locale
+      key = key&.to_s unless key.is_a?(String)
       key = "#{i18n_scope}#{key}" if key.start_with?(".")
 
-      result = catch(:exception) do
+      translated = catch(:exception) do
         i18n_backend.translate(locale, key, options)
       end
 
       # Fallback to the global translations
-      if result.is_a? ::I18n::MissingTranslation
-        result = helpers.t(key, locale: locale, **options)
+      if translated.is_a? ::I18n::MissingTranslation
+        return super(key, locale: locale, **options)
+      end
+
+      if HTML_SAFE_TRANSLATION_KEY.match?(key)
+        translated = translated.html_safe
       end
 
-      result
+      translated
     end
     alias :t :translate
 

data/lib/view_component/version.rb

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

data/lib/view_component/with_content_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module WithContentHelper
+    def with_content(value)
+      if value.nil?
+        raise ArgumentError.new("No content provided.")
+      else
+        @_content_set_by_with_content = value
+      end
+
+      self
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.30.0
+  version: 2.34.0
 platform: ruby
 authors:
 - GitHub Open Source
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-02 00:00:00.000000000 Z
+date: 2021-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -212,7 +212,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
-description: 
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+description:
 email:
 - opensource+view_component@github.com
 executables: []
@@ -223,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
@@ -246,7 +261,9 @@ files:
 - lib/view_component/collection.rb
 - lib/view_component/compile_cache.rb
 - 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
@@ -265,12 +282,13 @@ files:
 - lib/view_component/test_helpers.rb
 - lib/view_component/translatable.rb
 - lib/view_component/version.rb
+- lib/view_component/with_content_helper.rb
 homepage: https://github.com/github/view_component
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -285,8 +303,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: View components for Rails
 test_files: []