view_component 2.52.0 → 2.62.0

data/lib/view_component/rendering_component_helper.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module RenderingComponentHelper # :nodoc:
     def render_component(component)
-      self.response_body = component.render_in(self.view_context)
+      self.response_body = component.render_in(view_context)
     end
   end
 end

data/lib/view_component/rendering_monkey_patch.rb

@@ -4,7 +4,7 @@ module ViewComponent
   module RenderingMonkeyPatch # :nodoc:
     def render(options = {}, args = {})
       if options.respond_to?(:render_in)
-        self.response_body = options.render_in(self.view_context)
+        self.response_body = options.render_in(view_context)
       else
         super
       end

data/lib/view_component/slotable.rb

@@ -30,7 +30,7 @@ module ViewComponent
 
         slot_names.each do |slot_name|
           # Ensure slot_name isn't already declared
-          if self.slots.key?(slot_name)
+          if slots.key?(slot_name)
             raise ArgumentError.new("#{slot_name} slot declared multiple times")
           end
 
@@ -73,7 +73,7 @@ module ViewComponent
           class_name = "ViewComponent::Slot" unless class_name.present?
 
           # Register the slot on the component
-          self.slots[slot_name] = {
+          slots[slot_name] = {
             class_name: class_name,
             instance_variable_name: instance_variable_name,
             collection: collection
@@ -84,7 +84,7 @@ module ViewComponent
       def inherited(child)
         # Clone slot configuration into child class
         # see #test_slots_pollution
-        child.slots = self.slots.clone
+        child.slots = slots.clone
 
         super
       end
@@ -106,7 +106,7 @@ module ViewComponent
     #
     def slot(slot_name, **args, &block)
       # Raise ArgumentError if `slot` doesn't exist
-      unless slots.keys.include?(slot_name)
+      unless slots.key?(slot_name)
         raise ArgumentError.new "Unknown slot '#{slot_name}' - expected one of '#{slots.keys}'"
       end
 
@@ -123,8 +123,7 @@ module ViewComponent
       slot_instance = args.present? ? slot_class.new(**args) : slot_class.new
 
       # Capture block and assign to slot_instance#content
-      # rubocop:disable Rails/OutputSafety
-      slot_instance.content = view_context.capture(&block).to_s.strip.html_safe if block_given?
+      slot_instance.content = view_context.capture(&block).to_s.strip.html_safe if block
 
       if slot[:collection]
         # Initialize instance variable as an empty array

data/lib/view_component/slotable_v2.rb

@@ -9,7 +9,7 @@ module ViewComponent
 
     RESERVED_NAMES = {
       singular: %i[content render].freeze,
-      plural: %i[contents renders].freeze,
+      plural: %i[contents renders].freeze
     }.freeze
 
     # Setup component slot state
@@ -61,20 +61,26 @@ module ViewComponent
       # = Setting sub-component content
       #
       # Consumers of the component can render a sub-component by calling a
-      # helper method with the same name as the slot.
+      # helper method with the same name as the slot prefixed with `with_`.
       #
       #   <%= render_inline(MyComponent.new) do |component| %>
-      #     <% component.header(classes: "Foo") do %>
+      #     <% component.with_header(classes: "Foo") do %>
       #       <p>Bar</p>
       #     <% end %>
       #   <% end %>
       def renders_one(slot_name, callable = nil)
         validate_singular_slot_name(slot_name)
 
+        define_method :"with_#{slot_name}" do |*args, &block|
+          set_slot(slot_name, nil, *args, &block)
+        end
+        ruby2_keywords(:"with_#{slot_name}") if respond_to?(:ruby2_keywords, true)
+
         define_method slot_name do |*args, &block|
           if args.empty? && block.nil?
             get_slot(slot_name)
           else
+            # Deprecated: Will remove in 3.0
             set_slot(slot_name, nil, *args, &block)
           end
         end
@@ -112,15 +118,15 @@ module ViewComponent
       # = Setting sub-component content
       #
       # Consumers of the component can set the content of a slot by calling a
-      # helper method with the same name as the slot. The method can be
-      # called multiple times to append to the slot.
+      # helper method with the same name as the slot prefixed with `with_`. The
+      # method can be called multiple times to append to the slot.
       #
       #   <%= render_inline(MyComponent.new) do |component| %>
-      #     <% component.item(name: "Foo") do %>
+      #     <% component.with_item(name: "Foo") do %>
       #       <p>One</p>
       #     <% end %>
       #
-      #     <% component.item(name: "Bar") do %>
+      #     <% component.with_item(name: "Bar") do %>
       #       <p>two</p>
       #     <% end %>
       #   <% end %>
@@ -132,17 +138,31 @@ module ViewComponent
         # Define setter for singular names
         # for example `renders_many :items` allows fetching all tabs with
         # `component.tabs` and setting a tab with `component.tab`
+        #
+        # Deprecated: Will remove in 3.0
         define_method singular_name do |*args, &block|
           set_slot(slot_name, nil, *args, &block)
         end
         ruby2_keywords(singular_name.to_sym) if respond_to?(:ruby2_keywords, true)
 
+        define_method :"with_#{singular_name}" do |*args, &block|
+          set_slot(slot_name, nil, *args, &block)
+        end
+        ruby2_keywords(:"with_#{singular_name}") if respond_to?(:ruby2_keywords, true)
+
+        define_method :"with_#{slot_name}" do |collection_args = nil, &block|
+          collection_args.map do |args|
+            set_slot(slot_name, nil, **args, &block)
+          end
+        end
+
         # Instantiates and and adds multiple slots forwarding the first
         # argument to each slot constructor
         define_method slot_name do |collection_args = nil, &block|
           if collection_args.nil? && block.nil?
             get_slot(slot_name)
           else
+            # Deprecated: Will remove in 3.0
             collection_args.map do |args|
               set_slot(slot_name, nil, **args, &block)
             end
@@ -170,20 +190,20 @@ module ViewComponent
       # Clone slot configuration into child class
       # see #test_slots_pollution
       def inherited(child)
-        child.registered_slots = self.registered_slots.clone
+        child.registered_slots = registered_slots.clone
         super
       end
 
       private
 
       def register_slot(slot_name, **kwargs)
-        self.registered_slots[slot_name] = define_slot(slot_name, **kwargs)
+        registered_slots[slot_name] = define_slot(slot_name, **kwargs)
       end
 
       def define_slot(slot_name, collection:, callable:)
         # Setup basic slot data
         slot = {
-          collection: collection,
+          collection: collection
         }
         return slot unless callable
 
@@ -234,7 +254,7 @@ module ViewComponent
       end
 
       def raise_if_slot_registered(slot_name)
-        if self.registered_slots.key?(slot_name)
+        if registered_slots.key?(slot_name)
           # TODO remove? This breaks overriding slots when slots are inherited
           raise ArgumentError.new(
             "#{self} declares the #{slot_name} slot multiple times.\n\n" \
@@ -246,8 +266,8 @@ module ViewComponent
       def raise_if_slot_ends_with_question_mark(slot_name)
         if slot_name.to_s.ends_with?("?")
           raise ArgumentError.new(
-            "#{self} declares a slot named #{slot_name}, which ends with a question mark.\n\n"\
-            "This is not allowed because the ViewComponent framework already provides predicate "\
+            "#{self} declares a slot named #{slot_name}, which ends with a question mark.\n\n" \
+            "This is not allowed because the ViewComponent framework already provides predicate " \
             "methods ending in `?`.\n\n" \
             "To fix this issue, choose a different name."
           )
@@ -267,8 +287,6 @@ module ViewComponent
 
       if slot[:collection]
         []
-      else
-        nil
       end
     end
 
@@ -285,7 +303,7 @@ module ViewComponent
       # 2. Since we've to pass block content to components when calling
       # `render`, evaluating the block here would require us to call
       # `view_context.capture` twice, which is slower
-      slot.__vc_content_block = block if block_given?
+      slot.__vc_content_block = block if block
 
       # If class
       if slot_definition[:renderable]
@@ -301,7 +319,7 @@ module ViewComponent
         # methods like `content_tag` as well as parent component state.
         renderable_function = slot_definition[:renderable_function].bind(self)
         renderable_value =
-          if block_given?
+          if block
             renderable_function.call(*args) do |*rargs|
               view_context.capture(*rargs, &block)
             end

data/lib/view_component/test_helpers.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
+require "view_component/render_preview_helper"
+
 module ViewComponent
   module TestHelpers
     begin
       require "capybara/minitest"
+
       include Capybara::Minitest::Assertions
 
       def page
-        Capybara::Node::Simple.new(@rendered_component)
+        @page ||= Capybara::Node::Simple.new(rendered_content)
       end
 
       def refute_component_rendered
@@ -19,8 +22,8 @@ module ViewComponent
       # :nocov:
       if ENV["DEBUG"]
         warn(
-          "WARNING in `ViewComponent::TestHelpers`: You must add `capybara` " \
-          "to your Gemfile to use Capybara assertions."
+          "WARNING in `ViewComponent::TestHelpers`: Add `capybara` " \
+          "to Gemfile to use Capybara assertions."
         )
       end
 
@@ -28,7 +31,19 @@ module ViewComponent
     end
 
     # @private
-    attr_reader :rendered_component
+    attr_reader :rendered_content
+
+    # Returns the result of a render_inline call.
+    #
+    # @return [String]
+    def rendered_component
+      ViewComponent::Deprecation.warn(
+        "`rendered_component` is deprecated and will be removed in v3.0.0. " \
+        "Use `page` instead."
+      )
+
+      rendered_content
+    end
 
     # Render a component inline. Internally sets `page` to be a `Capybara::Node::Simple`,
     # allowing for Capybara assertions to be used:
@@ -41,14 +56,31 @@ module ViewComponent
     # @param component [ViewComponent::Base, ViewComponent::Collection] The instance of the component to be rendered.
     # @return [Nokogiri::HTML]
     def render_inline(component, **args, &block)
-      @rendered_component =
+      @page = nil
+      @rendered_content =
         if Rails.version.to_f >= 6.1
           controller.view_context.render(component, args, &block)
         else
           controller.view_context.render_component(component, &block)
         end
 
-      Nokogiri::HTML.fragment(@rendered_component)
+      Nokogiri::HTML.fragment(@rendered_content)
+    end
+
+    # Execute the given block in the view context. Internally sets `page` to be a
+    # `Capybara::Node::Simple`, allowing for Capybara assertions to be used:
+    #
+    # ```ruby
+    # render_in_view_context do
+    #   render(MyComponent.new)
+    # end
+    #
+    # assert_text("Hello, World!")
+    # ```
+    def render_in_view_context(&block)
+      @page = nil
+      @rendered_content = controller.view_context.instance_exec(&block)
+      Nokogiri::HTML.fragment(@rendered_content)
     end
 
     # @private
@@ -121,7 +153,7 @@ module ViewComponent
 
       request.path_info = path
       request.path_parameters = Rails.application.routes.recognize_path(path)
-      request.set_header("action_dispatch.request.query_parameters", Rack::Utils.parse_query(path.split("?")[1]))
+      request.set_header("action_dispatch.request.query_parameters", Rack::Utils.parse_nested_query(path.split("?")[1]))
       request.set_header(Rack::QUERY_STRING, path.split("?")[1])
       yield
     ensure

data/lib/view_component/translatable.rb

@@ -3,14 +3,13 @@
 require "erb"
 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
+    HTML_SAFE_TRANSLATION_KEY = /(?:_|\b)html\z/
 
     included do
       class_attribute :i18n_backend, instance_writer: false, instance_predicate: false
@@ -21,19 +20,16 @@ module ViewComponent
         @i18n_scope ||= virtual_path.sub(%r{^/}, "").gsub(%r{/_?}, ".")
       end
 
-      def _after_compile
-        super
-
+      def build_i18n_backend
         return if CompileCache.compiled? self
 
-        if (translation_files = _sidecar_files(%w[yml yaml])).any?
-          self.i18n_backend = I18nBackend.new(
+        self.i18n_backend = if (translation_files = _sidecar_files(%w[yml yaml])).any?
+          # Returning nil cleans up if translations file has been removed since the last compilation
+
+          I18nBackend.new(
             i18n_scope: i18n_scope,
-            load_paths: translation_files,
+            load_paths: translation_files
           )
-        else
-          # Cleanup if translations file has been removed since the last compilation
-          self.i18n_backend = nil
         end
       end
     end
@@ -53,7 +49,7 @@ module ViewComponent
 
       def scope_data(data)
         @i18n_scope.reverse_each do |part|
-          data = { part => data }
+          data = {part => data}
         end
         data
       end
@@ -68,7 +64,10 @@ module ViewComponent
       return key.map { |k| translate(k, **options) } if key.is_a?(Array)
 
       locale = options.delete(:locale) || ::I18n.locale
+      scope = options.delete(:scope)
+      scope = scope.join(".") if scope.is_a? Array
       key = key&.to_s unless key.is_a?(String)
+      key = "#{scope}.#{key}" if scope
       key = "#{i18n_scope}#{key}" if key.start_with?(".")
 
       if HTML_SAFE_TRANSLATION_KEY.match?(key)
@@ -95,7 +94,7 @@ module ViewComponent
         super(key, locale: locale, **options)
       end
     end
-    alias :t :translate
+    alias_method :t, :translate
 
     # Exposes .i18n_scope as an instance method
     def i18n_scope
@@ -109,7 +108,7 @@ module ViewComponent
         # It's assumed here that objects loaded by the i18n backend will respond to `#html_safe?`.
         # It's reasonable that if we're in Rails, `active_support/core_ext/string/output_safety.rb`
         # will provide this to `Object`.
-        translation.html_safe # rubocop:disable Rails/OutputSafety
+        translation.html_safe
       end
     end
 

data/lib/view_component/version.rb

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

data/lib/view_component.rb

@@ -11,9 +11,7 @@ module ViewComponent
   autoload :CompileCache
   autoload :ComponentError
   autoload :Deprecation
-  autoload :GlobalOutputBuffer
   autoload :Instrumentation
-  autoload :OutputBufferStack
   autoload :Preview
   autoload :PreviewTemplateError
   autoload :TestHelpers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.52.0
+  version: 2.62.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-25 00:00:00.000000000 Z
+date: 2022-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -185,19 +185,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-github
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -293,6 +293,7 @@ files:
 - README.md
 - app/assets/vendor/prism.css
 - app/assets/vendor/prism.min.js
+- app/controllers/concerns/view_component/preview_actions.rb
 - app/controllers/view_components_controller.rb
 - app/helpers/preview_helper.rb
 - app/views/test_mailer/test_email.html.erb
@@ -333,9 +334,7 @@ files:
 - lib/view_component/docs_builder_component.html.erb
 - lib/view_component/docs_builder_component.rb
 - lib/view_component/engine.rb
-- lib/view_component/global_output_buffer.rb
 - lib/view_component/instrumentation.rb
-- lib/view_component/output_buffer_stack.rb
 - lib/view_component/polymorphic_slots.rb
 - lib/view_component/preview.rb
 - lib/view_component/preview_template_error.rb
@@ -344,6 +343,7 @@ files:
 - lib/view_component/render_component_helper.rb
 - lib/view_component/render_component_to_string_helper.rb
 - lib/view_component/render_monkey_patch.rb
+- lib/view_component/render_preview_helper.rb
 - lib/view_component/render_to_string_monkey_patch.rb
 - lib/view_component/rendering_component_helper.rb
 - lib/view_component/rendering_monkey_patch.rb

data/lib/view_component/global_output_buffer.rb

@@ -1,99 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  module GlobalOutputBuffer
-    def render_in(view_context, &block)
-      unless view_context.output_buffer.is_a?(OutputBufferStack)
-        # use instance_variable_set here to avoid triggering the code in the #output_buffer= method below
-        view_context.instance_variable_set(:@output_buffer, OutputBufferStack.new(view_context.output_buffer))
-      end
-
-      @output_buffer = view_context.output_buffer
-      @global_buffer_in_use = true
-
-      super(view_context, &block)
-    end
-
-    def perform_render
-      # HAML unhelpfully assigns to @output_buffer directly, so we hold onto a reference to
-      # it and restore @output_buffer when the HAML engine is finished. In non-HAML cases,
-      # @output_buffer and orig_buf will point to the same object, making the reassignment
-      # statements no-ops.
-      orig_buf = @output_buffer
-      @output_buffer.push
-      result = render_template_for(@__vc_variant).to_s + _output_postamble
-      @output_buffer = orig_buf
-      @output_buffer.pop
-      result
-    end
-
-    def output_buffer=(other_buffer)
-      @output_buffer.replace(other_buffer)
-    end
-
-    def with_output_buffer(buf = nil)
-      unless buf
-        buf = ActionView::OutputBuffer.new
-        if output_buffer && output_buffer.respond_to?(:encoding)
-          buf.force_encoding(output_buffer.encoding)
-        end
-      end
-
-      output_buffer.push(buf)
-      result = nil
-
-      begin
-        yield
-      ensure
-        # assign result here to avoid a return statement, which will
-        # immediately return to the caller and swallow any errors
-        result = output_buffer.pop
-      end
-
-      result
-    end
-
-    module ActionViewMods
-      def output_buffer=(other_buffer)
-        if @output_buffer.is_a?(OutputBufferStack)
-          @output_buffer.replace(other_buffer)
-        else
-          super
-        end
-      end
-
-      def with_output_buffer(buf = nil)
-        unless buf
-          buf = ActionView::OutputBuffer.new
-          if @output_buffer && @output_buffer.respond_to?(:encoding)
-            buf.force_encoding(@output_buffer.encoding)
-          end
-        end
-
-        result = nil
-
-        if @output_buffer.is_a?(OutputBufferStack)
-          @output_buffer.push(buf)
-
-          begin
-            yield
-          ensure
-            result = @output_buffer.pop
-          end
-
-          result
-        else
-          @output_buffer, old_buffer = buf, output_buffer
-
-          begin
-            yield
-          ensure
-            @output_buffer = old_buffer
-          end
-
-          buf
-        end
-      end
-    end
-  end
-end

data/lib/view_component/output_buffer_stack.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  class OutputBufferStack
-    delegate_missing_to :@current_buffer
-    delegate :presence, :present?, :html_safe?, to: :@current_buffer
-
-    attr_reader :buffer_stack
-
-    def self.make_frame(*args)
-      ActionView::OutputBuffer.new(*args)
-    end
-
-    def initialize(initial_buffer = nil)
-      if initial_buffer.is_a?(self.class)
-        @current_buffer = self.class.make_frame(initial_buffer.current)
-        @buffer_stack = [*initial_buffer.buffer_stack[0..-2], @current_buffer]
-      else
-        @current_buffer = initial_buffer || self.class.make_frame
-        @buffer_stack = [@current_buffer]
-      end
-    end
-
-    def replace(buffer)
-      return if self == buffer
-
-      @current_buffer = buffer.current
-      @buffer_stack = buffer.buffer_stack
-    end
-
-    def append=(arg)
-      @current_buffer.append = arg
-    end
-
-    def safe_append=(arg)
-      @current_buffer.safe_append = arg
-    end
-
-    def safe_concat(arg)
-      # rubocop:disable Rails/OutputSafety
-      @current_buffer.safe_concat(arg)
-      # rubocop:enable Rails/OutputSafety
-    end
-
-    def length
-      @current_buffer.length
-    end
-
-    def push(buffer = nil)
-      buffer ||= self.class.make_frame
-      @buffer_stack.push(buffer)
-      @current_buffer = buffer
-    end
-
-    def pop
-      @buffer_stack.pop.tap do
-        @current_buffer = @buffer_stack.last
-      end
-    end
-
-    def to_s
-      @current_buffer
-    end
-
-    alias_method :current, :to_s
-  end
-end