view_component 2.58.0 → 2.61.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73dd7bae94ee1c5a5886e248924ccfea872df61e783e713c0744390d6729d128
-  data.tar.gz: e70c67571e32098ee5997b7912d07e65d427e265766c5caa398bcd47d06d3e55
+  metadata.gz: f46bf10c68e5273401ec52134ae2cf55d844f9b01c55121e082146364194e144
+  data.tar.gz: 81ec5867c81158b0c06fdab309674f2f5a9cef7cf0546575308084ac928116c6
 SHA512:
-  metadata.gz: '080f91f8f3f6aa9e0db95a4b533643c627be1e31fe8fcd32cea979556e52a351f956a9b01000f0a4654039f2588d88fa6680107f5b94c1103fa4a5c0190953f3'
-  data.tar.gz: 7c4e322ca388053c13ad36ad8d79e706aede23d5a2e25d15cdadb2e2e8c6776c95a5981c5588134061534037fd89a11c859fe74110418072378ee4b14e10b8d6
+  metadata.gz: 05450d5c3e5376fe7aa4a2a934ee2b7179cafb91681cf1b6ed7f1469bd3db29f92d0ba6e96930e36403f7e250a3b7b8aeb7cc061aa30954d2d8524c6d7081d6b
+  data.tar.gz: 91101a168fee89fd23dad833c769027db7022a852b07b918d427b40a8b1997b861827724f7390dd470f4e69e1a8351638a43cd2d34f6df9bf20c64be0eb61d43

data/docs/CHANGELOG.md

@@ -9,6 +9,67 @@ title: Changelog
 
 ## main
 
+## 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.
+
+    The following Capybara methods are now available directly without having to use the `page` method:
+
+  * [`all`](https://rubydoc.info/github/teamcapybara/capybara/Capybara%2FNode%2FFinders:all)
+  * [`first`](https://rubydoc.info/github/teamcapybara/capybara/Capybara%2FNode%2FFinders:first)
+  * [`text`](https://rubydoc.info/github/teamcapybara/capybara/Capybara%2FNode%2FSimple:text)
+  * [`find`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FFinders:find)
+  * [`find_all`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FFinders:find_all)
+  * [`find_button`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FFinders:find_button)
+  * [`find_by_id`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FFinders:find_by_id)
+  * [`find_field`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FFinders:find_field)
+  * [`find_link`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FFinders:find_link)
+  * [`has_content?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_content%3F)
+  * [`has_text?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_text%3F)
+  * [`has_css?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_css%3F)
+  * [`has_no_content?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_content%3F)
+  * [`has_no_text?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_text%3F)
+  * [`has_no_css?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_css%3F)
+  * [`has_no_xpath?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_xpath%3F)
+  * [`has_xpath?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_xpath%3F)
+  * [`has_link?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_link%3F)
+  * [`has_no_link?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_link%3F)
+  * [`has_button?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_button%3F)
+  * [`has_no_button?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_button%3F)
+  * [`has_field?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_field%3F)
+  * [`has_no_field?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_field%3F)
+  * [`has_checked_field?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_checked_field%3F)
+  * [`has_unchecked_field?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_unchecked_field%3F)
+  * [`has_no_table?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_table%3F)
+  * [`has_table?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_table%3F)
+  * [`has_select?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_select%3F)
+  * [`has_no_select?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_select%3F)
+  * [`has_selector?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_selector%3F)
+  * [`has_no_selector?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_selector%3F)
+  * [`has_no_checked_field?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_checked_field%3F)
+  * [`has_no_unchecked_field?`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:has_no_unchecked_field%3F)
+
+* Add support for `within*` Capybara DLS methods:
+
+  * [`within`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FSession:within)
+  * [`within_element`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FSession:within)
+  * [`within_fieldset`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FSession:within_fieldset)
+  * [`within_table`](https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FSession:within_table)
+
+    *Jacob Carlborg*
+
 ## 2.58.0
 
 * Switch to `standardrb`.

data/lib/view_component/base.rb

@@ -124,6 +124,10 @@ module ViewComponent
       before_render
 
       if render?
+        # preload content to support slot delegation and to consistently perform
+        # side-effects that may exist in the block
+        content
+
         perform_render
       else
         ""

data/lib/view_component/capybara_simple_session.rb

@@ -0,0 +1,132 @@
+# 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/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/test_helpers.rb

@@ -1,15 +1,37 @@
 # frozen_string_literal: true
 
 require "view_component/render_preview_helper"
+require "view_component/capybara_simple_session"
 
 module ViewComponent
   module TestHelpers
     begin
       require "capybara/minitest"
+
       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
-        Capybara::Node::Simple.new(@rendered_content)
+        @page ||= CapybaraSimpleSession.new(rendered_content)
       end
 
       def refute_component_rendered
@@ -55,6 +77,7 @@ 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)
+      @page = nil
       @rendered_content =
         if Rails.version.to_f >= 6.1
           controller.view_context.render(component, args, &block)
@@ -76,6 +99,7 @@ module ViewComponent
     # 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

data/lib/view_component/version.rb

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

data/lib/view_component.rb

@@ -7,6 +7,7 @@ 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.58.0
+  version: 2.61.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-13 00:00:00.000000000 Z
+date: 2022-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -325,6 +325,7 @@ 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