view_component 2.28.0 → 2.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0abc25e32e2befb60487f209469b2d9b96d6f1380a345466bcc816addc9f65d1
-  data.tar.gz: a72e8ad8a5cfa1bbfd0bbbaa5510e14abd4818657b356681930537d8d5efa95e
+  metadata.gz: 0cdb5a57cbe401fab359e9daedfcb0180b2e6ec07bd332e7616c6a611442df13
+  data.tar.gz: 11ec2515ac60b615adc2a52cc7b526c7632871363a24a7b3128ca9a4873d57a1
 SHA512:
-  metadata.gz: 0b3f1cd9a86493fd5fbf68537536435c13b202bcba0d01e8d58f20ba0c158b7cdf1f878c75103d4b6a00f54e89227f7cb6b083bbbab17122e3e7f6b9d7c7f20d
-  data.tar.gz: 4a29369a237c75889bce3a0777e5ff82e2bd7d25966ea31004fb293db5a6015aed2abd618340504ee89481d43970a35ff05c3aec2e113ff8b6378ed39415dfec
+  metadata.gz: ba44487de1f76102ec0fa9ea4fdd4af85c079c665c0e879855af5fe57577878a176badfef0af2a3d06d3384e852986048ab1332ed0a78fc589adea83f087b037
+  data.tar.gz: 32b565ca3c4759b366acf47de7f42a74ec52adb96d951013759cb5a289ffc16956b432bbee8e0dd79c3291c16386655fd7b8332da2ad3ba29db9dadcc87456a9

data/CHANGELOG.md

@@ -2,6 +2,101 @@
 
 ## main
 
+## 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).
+
+    *Joel Hawksley*
+
+## 2.29.0
+
+* Allow Slot lambdas to share data from the parent component and allow chaining on the returned component.
+
+    *Sjors Baltus, Blake Williams*
+
+* Experimental: Add `ViewComponent::Translatable`
+  * `t` and `translate` now will look first into the sidecar YAML translations file.
+  * `helpers.t` and `I18n.t` still reference the global Rails translation files.
+  * `l` and `localize` will still reference the global Rails translation files.
+
+    *Elia Schito*
+
+* Fix rendering output of pass through slots when using HAML.
+
+    *Alex Robbin, Blake Williams*
+
+* Experimental: call `._sidecar_files` to fetch the sidecar files for a given list of extensions, e.g. passing `["yml", "yaml"]`.
+
+    *Elia Schito*
+
+* Fix bug where a single `jbuilder` template matched multiple template handlers.
+
+    *Niels Slot*
+
 ## 2.28.0
 
 * Include SlotableV2 by default in Base. **Note:** It's no longer necessary to include `ViewComponent::SlotableV2` to use Slots.

data/README.md

@@ -6,14 +6,6 @@ A framework for building reusable, testable & encapsulated view components in Ru
 
 See [viewcomponent.org](https://viewcomponent.org/) for documentation.
 
-## Installation
-
-In `Gemfile`, add:
-
-```ruby
-gem "view_component", require: "view_component/engine"
-```
-
 ## Contributing
 
 This project is intended to be a safe, welcoming space for collaboration. Contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. We recommend reading the [contributing guide](./CONTRIBUTING.md) as well.

data/lib/view_component.rb

@@ -7,9 +7,11 @@ module ViewComponent
 
   autoload :Base
   autoload :Compiler
+  autoload :ComponentError
   autoload :Preview
   autoload :PreviewTemplateError
   autoload :TestHelpers
   autoload :TestCase
   autoload :TemplateError
+  autoload :Translatable
 end

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) + _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,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
         super
@@ -120,28 +145,36 @@ 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 .virutal_path as an instance method
+    # 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 +183,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)
         raise ArgumentError.new "Unknown content_area '#{area}' - expected one of '#{content_areas}'"
@@ -163,21 +197,22 @@ module ViewComponent
       nil
     end
 
+    # @private TODO: add documentation
     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
     end
 
+    private
+
     attr_reader :view_context
 
     def content
@@ -186,6 +221,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
 
@@ -206,6 +243,47 @@ module ViewComponent
     class << self
       attr_accessor :source_location, :virtual_path
 
+      # EXPERIMENTAL: This API is experimental and may be removed at any time.
+      # Find sidecar files for the given extensions.
+      #
+      # The provided array of extensions is expected to contain
+      # strings starting without the "dot", example: `["erb", "haml"]`.
+      #
+      # For example, one might collect sidecar CSS files that need to be compiled.
+      def _sidecar_files(extensions)
+        return [] unless source_location
+
+        extensions = extensions.join(",")
+
+        # view files in a directory named like the component
+        directory = File.dirname(source_location)
+        filename = File.basename(source_location, ".rb")
+        component_name = name.demodulize.underscore
+
+        # Add support for nested components defined in the same file.
+        #
+        # e.g.
+        #
+        # class MyComponent < ViewComponent::Base
+        #   class MyOtherComponent < ViewComponent::Base
+        #   end
+        # end
+        #
+        # Without this, `MyOtherComponent` will not look for `my_component/my_other_component.html.erb`
+        nested_component_files = if name.include?("::") && component_name != filename
+          Dir["#{directory}/#{filename}/#{component_name}.*{#{extensions}}"]
+        else
+          []
+        end
+
+        # view files in the same directory as the component
+        sidecar_files = Dir["#{directory}/#{component_name}.*{#{extensions}}"]
+
+        sidecar_directory_files = Dir["#{directory}/#{component_name}/#{filename}.*{#{extensions}}"]
+
+        (sidecar_files - [source_location] + sidecar_directory_files + nested_component_files).uniq
+      end
+
       # Render a component collection.
       def with_collection(collection, **args)
         Collection.new(self, collection, **args)
@@ -239,7 +317,7 @@ module ViewComponent
       end
 
       def compiled?
-        template_compiler.compiled?
+        compiler.compiled?
       end
 
       # Compile templates to instance methods, assuming they haven't been compiled already.
@@ -247,11 +325,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
@@ -268,6 +346,11 @@ module ViewComponent
       end
 
       def with_content_areas(*areas)
+        ActiveSupport::Deprecation.warn(
+          "`with_content_areas` is deprecated and will be removed in ViewComponent v3.0.0.\n" \
+          "Use slots (https://viewcomponent.org/guide/slots.html) instead."
+        )
+
         if areas.include?(:content)
           raise ArgumentError.new ":content is a reserved content area name. Please use another name, such as ':body'"
         end
@@ -319,7 +402,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."
@@ -339,7 +422,7 @@ 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
 
       private

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."
         )
@@ -114,50 +120,18 @@ module ViewComponent
     end
 
     def templates
-      @templates ||= matching_views_in_source_location.each_with_object([]) do |path, memo|
-        pieces = File.basename(path).split(".")
-
-        memo << {
-          path: path,
-          variant: pieces.second.split("+").second&.to_sym,
-          handler: pieces.last
-        }
-      end
-    end
-
-    def matching_views_in_source_location
-      source_location = component_class.source_location
-      return [] unless source_location
-
-      extensions = ActionView::Template.template_handler_extensions.join(",")
-
-      # view files in a directory named like the component
-      directory = File.dirname(source_location)
-      filename = File.basename(source_location, ".rb")
-      component_name = component_class.name.demodulize.underscore
-
-      # Add support for nested components defined in the same file.
-      #
-      # e.g.
-      #
-      # class MyComponent < ViewComponent::Base
-      #   class MyOtherComponent < ViewComponent::Base
-      #   end
-      # end
-      #
-      # Without this, `MyOtherComponent` will not look for `my_component/my_other_component.html.erb`
-      nested_component_files = if component_class.name.include?("::") && component_name != filename
-        Dir["#{directory}/#{filename}/#{component_name}.*{#{extensions}}"]
-      else
-        []
+      @templates ||= begin
+        extensions = ActionView::Template.template_handler_extensions
+
+        component_class._sidecar_files(extensions).each_with_object([]) do |path, memo|
+          pieces = File.basename(path).split(".")
+          memo << {
+            path: path,
+            variant: pieces.second.split("+").second&.to_sym,
+            handler: pieces.last
+          }
+        end
       end
-
-      # view files in the same directory as the component
-      sidecar_files = Dir["#{directory}/#{component_name}.*{#{extensions}}"]
-
-      sidecar_directory_files = Dir["#{directory}/#{component_name}/#{filename}.*{#{extensions}}"]
-
-      (sidecar_files - [source_location] + sidecar_directory_files + nested_component_files)
     end
 
     def inline_calls

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,7 @@ 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.preview_route ||= ViewComponent::Base.preview_route
       options.preview_controller ||= ViewComponent::Base.preview_controller
 

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)
@@ -25,19 +29,32 @@ module ViewComponent
       return @content if defined?(@content)
 
       view_context = @parent.send(:view_context)
-      @content = view_context.capture do
-        if defined?(@_component_instance)
-          # render_in is faster than `parent.render`
-          if defined?(@_content_block)
-            @_component_instance.render_in(view_context, &@_content_block)
-          else
+
+      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)
+        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)
-          @_content
         elsif defined?(@_content_block)
-          @_content_block.call
+          view_context.capture do
+            # render_in is faster than `parent.render`
+            @_component_instance.render_in(view_context, &@_content_block)
+          end
+        else
+          view_context.capture do
+            @_component_instance.render_in(view_context)
+          end
         end
+      elsif defined?(@_content)
+        @_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")
@@ -227,7 +231,9 @@ module ViewComponent
         # current component. This is necessary to allow the lambda to access helper
         # methods like `content_tag` as well as parent component state.
         renderable_value = if block_given?
-          slot_definition[:renderable_function].bind(self).call(*args, **kwargs) { view_context.capture(&block) }
+          slot_definition[:renderable_function].bind(self).call(*args, **kwargs) do |*args, **kwargs|
+            view_context.capture(*args, **kwargs, &block)
+          end
         else
           slot_definition[:renderable_function].bind(self).call(*args, **kwargs)
         end
@@ -249,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

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "set"
+require "i18n"
+require "action_view/helpers/translation_helper"
+require "active_support/concern"
+
+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
+
+    class_methods do
+      def i18n_scope
+        @i18n_scope ||= virtual_path.sub(%r{^/}, "").gsub(%r{/_?}, ".")
+      end
+
+      def _after_compile
+        super
+
+        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: translation_files,
+          )
+        else
+          # Cleanup if translations file has been removed since the last compilation
+          self.i18n_backend = nil
+        end
+      end
+    end
+
+    class I18nBackend < ::I18n::Backend::Simple
+      EMPTY_HASH = {}.freeze
+
+      def initialize(i18n_scope:, load_paths:)
+        @i18n_scope = i18n_scope.split(".")
+        @load_paths = load_paths
+      end
+
+      # Ensure the Simple backend won't load paths from ::I18n.load_path
+      def load_translations
+        super(@load_paths)
+      end
+
+      def scope_data(data)
+        @i18n_scope.reverse_each do |part|
+          data = { part => data}
+        end
+        data
+      end
+
+      def store_translations(locale, data, options = EMPTY_HASH)
+        super(locale, scope_data(data), options)
+      end
+    end
+
+    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?(".")
+
+      translated = catch(:exception) do
+        i18n_backend.translate(locale, key, options)
+      end
+
+      # Fallback to the global translations
+      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
+
+      translated
+    end
+    alias :t :translate
+
+    # Exposes .i18n_scope as an instance method
+    def i18n_scope
+      self.class.i18n_scope
+    end
+  end
+end

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 28
+    MINOR = 32
     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.28.0
+  version: 2.32.0
 platform: ruby
 authors:
 - GitHub Open Source
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-16 00:00:00.000000000 Z
+date: 2021-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -128,6 +128,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -198,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: []
@@ -232,6 +260,7 @@ 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/preview.rb
 - lib/view_component/preview_template_error.rb
@@ -249,13 +278,15 @@ files:
 - lib/view_component/template_error.rb
 - lib/view_component/test_case.rb
 - 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
@@ -270,8 +301,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: []