view_component 2.60.0 → 2.62.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b74cdfd2d8306224e0fc89d244d70f08fbf779ec9a892affd0fe766b16a4ac6d
-  data.tar.gz: d401c34f06238713ba43d97e5b50b9db647f946f8937e964c57578918b3418fb
+  metadata.gz: e57d7d7eece678a577cf5f89f4b506fbe1026c79cc8b28d269e6984a01de29c7
+  data.tar.gz: e8fd167897e4bbcfaf0b4d657605acf26a5e1c6dc72e6fd5a868e0e0e76d232b
 SHA512:
-  metadata.gz: a3c56fb2399e387fb57f6976264ea7aa3d3ce9e4490a741cf660876fe90fb5265bf80a865887a082cf282259a04b8477416546bdd21a2be08ac21744aa8316b5
-  data.tar.gz: 71049fb1fcc3cd1a09404feb9ab7a5aee6b2c9e5dc88c377233472953ee3e498f4a95a973033d717413e8d128a0ea3e95d955885692581b9e62c26fb66a18d0f
+  metadata.gz: a6bae85903899c93cb78e11a49082c4e6c2393605c9b3e94cca98ecff1e790a97dd7acda4c5e13b11ad4e4591384d0d30e62d86831998577531b595378f9fcb7
+  data.tar.gz: 814913871cc0d5b4865a6864a0585f06d6c26088cdbab888e4c4d33787f7ab2e74c9dafffd52fe726999d03b9a453186b3f495afc1c0c9da5207b5edb3a89480

data/docs/CHANGELOG.md

@@ -9,6 +9,42 @@ title: Changelog
 
 ## main
 
+## 2.62.0
+
+* Remove the experimental global output buffer feature.
+* Restore functionality that used to attempt to compile templates on each call to `#render_in`.
+* Un-pin `rails` `main` dependency.
+
+    *Cameron Dutro*
+
+* Add blank space between "in" and "ViewComponent" in a deprecation warning.
+
+    *Vikram Dighe*
+
+* Add HappyCo to list of companies using ViewComponent.
+
+    *Josh Clayton*
+
+## 2.61.1
+
+* Revert `Expose Capybara DSL methods directly inside tests.` This change unintentionally broke other Capybara methods and thus introduced a regression. We aren't confident that we can fail forward so we have decided to revert this change.
+
+    *Joel Hawksley*, *Blake Williams*
+
+* Revert change making content evaluation consistent.
+
+    *Blake Williams*
+
+* Pin `rails` `main` dependency due to incompatibility with Global Output Buffer.
+
+    *Joel Hawksley*
+
+## 2.61.0
+
+* Ensure side-effects in `content` are consistently evaluated before components are rendered. This change effectively means that `content` is evaluated for every component render where `render?` returns true. As a result, code that is passed to a component via a block/content will now always be evaluated, before `#call`, which can reveal bugs in existing components.
+
+    *Blake Williams*
+
 ## 2.60.0
 
 * Add support for `render_preview` in RSpec tests.

data/lib/view_component/base.rb

@@ -86,10 +86,12 @@ module ViewComponent
     #
     # @return [String]
     def render_in(view_context, &block)
+      self.class.compile(raise_errors: true)
+
       @view_context = view_context
       self.__vc_original_view_context ||= view_context
 
-      @output_buffer = ActionView::OutputBuffer.new unless defined?(@global_buffer_in_use) && @global_buffer_in_use
+      @output_buffer = ActionView::OutputBuffer.new
 
       @lookup_context ||= view_context.lookup_context
 
@@ -124,7 +126,7 @@ module ViewComponent
       before_render
 
       if render?
-        perform_render
+        render_template_for(@__vc_variant).to_s + _output_postamble
       else
         ""
       end
@@ -132,11 +134,6 @@ module ViewComponent
       @current_template = old_current_template
     end
 
-    # @private
-    def perform_render
-      render_template_for(@__vc_variant).to_s + _output_postamble
-    end
-
     # Subclass components that call `super` inside their template code will cause a
     # double render if they emit the result:
     #
@@ -152,17 +149,6 @@ module ViewComponent
       nil
     end
 
-    # @private
-    # :nocov:
-    def render_template_for(variant = nil)
-      # Force compilation here so the compiler always redefines render_template_for.
-      # This is mostly a safeguard to prevent infinite recursion.
-      self.class.compile(raise_errors: true, force: true)
-      # .compile replaces this method; call the new one
-      render_template_for(variant)
-    end
-    # :nocov:
-
     # EXPERIMENTAL: Optional content to be returned after the rendered template.
     #
     # @return [String]

data/lib/view_component/compile_cache.rb

@@ -20,11 +20,10 @@ module ViewComponent
 
     def invalidate_class!(klass)
       cache.delete(klass)
-      klass.compiler.reset_render_template_for
     end
 
     def invalidate!
-      cache.each { |klass| invalidate_class!(klass) }
+      cache.clear
     end
   end
 end

data/lib/view_component/compiler.rb

@@ -34,6 +34,8 @@ module ViewComponent
       component_class.superclass.compile(raise_errors: raise_errors) if should_compile_superclass?
 
       with_lock do
+        CompileCache.invalidate_class!(component_class)
+
         subclass_instance_methods = component_class.instance_methods(false)
 
         if subclass_instance_methods.include?(:with_content) && raise_errors
@@ -66,8 +68,8 @@ module ViewComponent
           # as Ruby warns when redefining a method.
           method_name = call_method_name(template[:variant])
 
-          if component_class.instance_methods(false).include?(method_name.to_sym)
-            component_class.send(:remove_method, method_name.to_sym)
+          if component_class.instance_methods.include?(method_name.to_sym)
+            component_class.send(:undef_method, method_name.to_sym)
           end
 
           # rubocop:disable Style/EvalWithLocation
@@ -96,18 +98,14 @@ module ViewComponent
       end
     end
 
-    def reset_render_template_for
-      if component_class.instance_methods(false).include?(:render_template_for)
-        component_class.send(:remove_method, :render_template_for)
-      end
-    end
-
     private
 
     attr_reader :component_class
 
     def define_render_template_for
-      reset_render_template_for
+      if component_class.instance_methods.include?(:render_template_for)
+        component_class.send(:undef_method, :render_template_for)
+      end
 
       variant_elsifs = variants.compact.uniq.map do |variant|
         "elsif variant.to_sym == :#{variant}\n    #{call_method_name(variant)}"

data/lib/view_component/engine.rb

@@ -20,7 +20,6 @@ module ViewComponent
       options.instrumentation_enabled = false if options.instrumentation_enabled.nil?
       options.preview_route ||= ViewComponent::Base.preview_route
       options.preview_controller ||= ViewComponent::Base.preview_controller
-      options.use_global_output_buffer = false if options.use_global_output_buffer.nil?
 
       if options.show_previews
         options.preview_paths << "#{Rails.root}/test/components/previews" if defined?(Rails.root) && Dir.exist?(
@@ -58,21 +57,6 @@ module ViewComponent
       end
     end
 
-    initializer "view_component.enable_global_output_buffer" do |app|
-      ActiveSupport.on_load(:view_component) do
-        env_use_gob = ENV.fetch("VIEW_COMPONENT_USE_GLOBAL_OUTPUT_BUFFER", "false") == "true"
-        config_use_gob = app.config.view_component.use_global_output_buffer
-
-        if config_use_gob || env_use_gob
-          # :nocov:
-          app.config.view_component.use_global_output_buffer = true
-          ViewComponent::Base.prepend(ViewComponent::GlobalOutputBuffer)
-          ActionView::Base.prepend(ViewComponent::GlobalOutputBuffer::ActionViewMods)
-          # :nocov:
-        end
-      end
-    end
-
     initializer "view_component.set_autoload_paths" do |app|
       options = app.config.view_component
 

data/lib/view_component/polymorphic_slots.rb

@@ -10,7 +10,7 @@ module ViewComponent
         location = Kernel.caller_locations(1, 1)[0]
 
         warn(
-          "warning: ViewComponent::PolymorphicSlots is now included in ViewComponent::Base by default "\
+          "warning: ViewComponent::PolymorphicSlots is now included in ViewComponent::Base by default " \
           "and can be removed from #{location.path}:#{location.lineno}"
         )
         # :nocov:
@@ -58,7 +58,7 @@ module ViewComponent
 
           define_method(setter_name) do |*args, &block|
             ViewComponent::Deprecation.warn(
-              "polymorphic slot setters like `#{setter_name}` are deprecated and will be removed in"\
+              "polymorphic slot setters like `#{setter_name}` are deprecated and will be removed in " \
               "ViewComponent v3.0.0.\n\nUse `with_#{setter_name}` instead."
             )
 

data/lib/view_component/slotable_v2.rb

@@ -266,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."
           )

data/lib/view_component/test_helpers.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "view_component/render_preview_helper"
-require "view_component/capybara_simple_session"
 
 module ViewComponent
   module TestHelpers
@@ -10,28 +9,8 @@ module ViewComponent
 
       include Capybara::Minitest::Assertions
 
-      CapybaraSimpleSession::DSL_METHODS.each do |method|
-        if RUBY_VERSION >= "2.7"
-          class_eval <<~METHOD, __FILE__, __LINE__ + 1
-            def #{method}(...)
-              page.method("#{method}").call(...)
-            end
-          METHOD
-        else
-          define_method method do |*args, &block|
-            page.send method, *args, &block
-          end
-        end
-      end
-
-      def self.included(mod)
-        Capybara::Node::Simple.send(:define_method, :to_capybara_node) do
-          self
-        end
-      end
-
       def page
-        @page ||= CapybaraSimpleSession.new(rendered_content)
+        @page ||= Capybara::Node::Simple.new(rendered_content)
       end
 
       def refute_component_rendered

data/lib/view_component/version.rb

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

data/lib/view_component.rb

@@ -7,14 +7,11 @@ module ViewComponent
   extend ActiveSupport::Autoload
 
   autoload :Base
-  autoload :CapybaraSimpleSession
   autoload :Compiler
   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.60.0
+  version: 2.62.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-18 00:00:00.000000000 Z
+date: 2022-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -325,7 +325,6 @@ files:
 - lib/rails/generators/test_unit/templates/component_test.rb.tt
 - lib/view_component.rb
 - lib/view_component/base.rb
-- lib/view_component/capybara_simple_session.rb
 - lib/view_component/collection.rb
 - lib/view_component/compile_cache.rb
 - lib/view_component/compiler.rb
@@ -335,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

data/lib/view_component/capybara_simple_session.rb

@@ -1,132 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  # This is a simpler version of {Capybara::Session}.
-  #
-  # It only includes {Capybara::Node::Finders}, {Capybara::Node::Matchers},
-  # {#within} and {#within_element}. It is useful in that it does not require a
-  # session, an application or a driver, but can still use Capybara's finders
-  # and matchers on any string that contains HTML.
-  class CapybaraSimpleSession
-    # Most of the code in this class is shamelessly stolen from the
-    # {Capybara::Session} class in the Capybara gem
-    # (https://github.com/teamcapybara/capybara/blob/e704d00879fb1d1e1a0cc01e04c101bcd8af4a68/lib/capybara/session.rb#L38).
-
-    NODE_METHODS = %i[
-      all
-      first
-      text
-
-      find
-      find_all
-      find_button
-      find_by_id
-      find_field
-      find_link
-
-      has_content?
-      has_text?
-      has_css?
-      has_no_content?
-      has_no_text?
-      has_no_css?
-      has_no_xpath?
-      has_xpath?
-      has_link?
-      has_no_link?
-      has_button?
-      has_no_button?
-      has_field?
-      has_no_field?
-      has_checked_field?
-      has_unchecked_field?
-      has_no_table?
-      has_table?
-      has_select?
-      has_no_select?
-      has_selector?
-      has_no_selector?
-      has_no_checked_field?
-      has_no_unchecked_field?
-
-      assert_selector
-      assert_no_selector
-      assert_all_of_selectors
-      assert_none_of_selectors
-      assert_any_of_selectors
-      assert_text
-      assert_no_text
-    ].freeze
-
-    private_constant :NODE_METHODS
-
-    SESSION_METHODS = %i[within within_element within_fieldset within_table].freeze
-
-    private_constant :SESSION_METHODS
-
-    DSL_METHODS = (NODE_METHODS + SESSION_METHODS).freeze
-
-    # Stolen from: https://github.com/teamcapybara/capybara/blob/e704d00879fb1d1e1a0cc01e04c101bcd8af4a68/lib/capybara/session.rb#L767-L774.
-    NODE_METHODS.each do |method|
-      if RUBY_VERSION >= "2.7"
-        class_eval <<~METHOD, __FILE__, __LINE__ + 1
-          def #{method}(...)
-            current_scope.#{method}(...)
-          end
-        METHOD
-      else
-        define_method method do |*args, &block|
-          current_scope.send(method, *args, &block)
-        end
-      end
-    end
-
-    # Initializes the receiver with the given string of HTML.
-    #
-    # @param html [String] the HTML to create the session out of
-    def initialize(html)
-      @document = Capybara::Node::Simple.new(html)
-    end
-
-    # (see Capybara::Session#within)
-    def within(*args, **kw_args)
-      new_scope = args.first.respond_to?(:to_capybara_node) ? args.first.to_capybara_node : find(*args, **kw_args)
-      begin
-        scopes.push(new_scope)
-        yield if block_given?
-      ensure
-        scopes.pop
-      end
-    end
-
-    # (see Capybara::Session#within_element)
-    alias_method :within_element, :within
-
-    # (see Capybara::Session#within_fieldset)
-    def within_fieldset(locator, &block)
-      within(:fieldset, locator, &block)
-    end
-
-    # (see Capybara::Session#within_table)
-    def within_table(locator, &block)
-      within(:table, locator, &block)
-    end
-
-    # (see Capybara::Node::Element#native)
-    def native
-      current_scope.native
-    end
-
-    private
-
-    attr_reader :document
-
-    def scopes
-      @scopes ||= [nil]
-    end
-
-    def current_scope
-      scopes.last.presence || document
-    end
-  end
-end

data/lib/view_component/global_output_buffer.rb

@@ -1,100 +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
-        # rubocop:disable Style/SafeNavigation
-        if output_buffer && output_buffer.respond_to?(:encoding)
-          buf.force_encoding(output_buffer.encoding)
-        end
-        # rubocop:enable Style/SafeNavigation
-      end
-
-      output_buffer.push(buf)
-
-      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
-          # rubocop:disable Style/SafeNavigation
-          if @output_buffer && @output_buffer.respond_to?(:encoding)
-            buf.force_encoding(@output_buffer.encoding)
-          end
-          # rubocop:enable Style/SafeNavigation
-        end
-
-        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,65 +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)
-      @current_buffer.safe_concat(arg)
-    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