view_component 2.59.0 → 2.61.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca82494216cd6b91d9a073bd1ab025cbe48049560893a500e72caff01141e02f
-  data.tar.gz: 9eecd79663f09edb31cae5a104b861c4922a99a92307f583b0703b11053a2d60
+  metadata.gz: f405812996b460c943dba2ae0802dbc7e924ce3ae45ff69eb917333c77ecb890
+  data.tar.gz: b50121e18674aa4c5f7b569cc4c2edb5078d4685192e8154d4654b4b21a03ef6
 SHA512:
-  metadata.gz: 4e04336d18bd57be41e3ae4637ae1978a4884a352fced4b852a40901fa1ff02a13e6266ab4c669fbb3669fa718eecbfd8a5b13c54df79cbb9b692e278f02f35e
-  data.tar.gz: 2fed6153f148f683afe4cd27c909051aedfc92e9f896e6fe41736083d05217e7df15ac12799291fd2299ca59c1ee12e7ec1145ac9be5ee78cacb81d55fccf548
+  metadata.gz: 23b295998753b2f0d17af1ee5cbc18ec0602cafa48c1ca4ee19568073c38453c79b7aadd1ec42160eab0b522d4a5c3c10f8682a224ed771b4ff25da1e97730fa
+  data.tar.gz: 43e4f27eb614d7de04e6b44747e4d7f2c006367cae62b2b3dc7ad67bdc6a22ea9ea7822308895b704bd19a50879d3bb3ecf2f0209adb9f039eb149217ef479b5

data/docs/CHANGELOG.md

@@ -9,6 +9,32 @@ title: Changelog
 
 ## main
 
+## 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.
+
+    *Thomas Hutterer*
+
 ## 2.59.0
 
 * Expose Capybara DSL methods directly inside tests.

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/render_preview_helper.rb

@@ -15,11 +15,21 @@ module ViewComponent
     #
     # MyComponentTest -> MyComponentPreview etc.
     #
+    # In RSpec, `Preview` is appended to `described_class`.
+    #
     # @param preview [String] The name of the preview to be rendered.
     # @return [Nokogiri::HTML]
     def render_preview(name)
       begin
-        preview_klass = self.class.name.gsub("Test", "Preview")
+        preview_klass = if respond_to?(:described_class)
+          if described_class.nil?
+            raise "`render_preview` expected a described_class, but it is nil."
+          end
+
+          "#{described_class}Preview"
+        else
+          self.class.name.gsub("Test", "Preview")
+        end
         preview_klass = preview_klass.constantize
       rescue NameError
         raise NameError.new(

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,8 +3,8 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 59
-    PATCH = 0
+    MINOR = 61
+    PATCH = 1
 
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end

data/lib/view_component.rb

@@ -7,7 +7,6 @@ module ViewComponent
   extend ActiveSupport::Autoload
 
   autoload :Base
-  autoload :CapybaraSimpleSession
   autoload :Compiler
   autoload :CompileCache
   autoload :ComponentError

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.59.0
+  version: 2.61.1
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-13 00:00:00.000000000 Z
+date: 2022-07-21 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

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