packwerk 3.2.0 → 3.2.2

data/sorbet/rbi/gems/rails-dom-testing@2.0.3.rbi

@@ -1,123 +1,455 @@
+# typed: true
+
 # DO NOT EDIT MANUALLY
 # This is an autogenerated file for types exported from the `rails-dom-testing` gem.
-# Please instead update this file by running `dev typecheck update`.
-
-# typed: true
+# Please instead update this file by running `bin/tapioca gem rails-dom-testing`.
 
+# source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/html_selector.rb#4
 class HTMLSelector
+  # @return [HTMLSelector] a new instance of HTMLSelector
+  #
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/html_selector.rb#7
   def initialize(values, previous_selection = T.unsafe(nil), &root_fallback); end
 
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/html_selector.rb#33
   def context; end
+
+  # Returns the value of attribute css_selector.
+  #
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/html_selector.rb#5
   def css_selector; end
+
+  # Returns the value of attribute message.
+  #
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/html_selector.rb#5
   def message; end
+
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/html_selector.rb#25
   def select; end
+
+  # @return [Boolean]
+  #
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/html_selector.rb#19
   def selecting_no_body?; end
+
+  # Returns the value of attribute tests.
+  #
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/html_selector.rb#5
   def tests; end
 
   private
 
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/html_selector.rb#87
   def extract_equality_tests; end
+
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/html_selector.rb#59
   def extract_root(previous_selection, root_fallback); end
+
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/html_selector.rb#76
   def extract_selectors; end
+
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/html_selector.rb#35
   def filter(matches); end
 
   class << self
+    # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/html_selector.rb#33
     def context; end
   end
 end
 
+# source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/html_selector.rb#31
 HTMLSelector::NO_STRIP = T.let(T.unsafe(nil), Array)
 
+# source://rails-dom-testing//lib/rails/dom/testing/assertions.rb#4
 module Rails
-  extend(::ActiveSupport::Autoload)
-
   class << self
+    # source://railties/7.0.3.1/lib/rails.rb#38
     def app_class; end
-    def app_class=(_); end
+
+    # source://railties/7.0.3.1/lib/rails.rb#38
+    def app_class=(_arg0); end
+
+    # source://railties/7.0.3.1/lib/rails.rb#39
     def application; end
-    def application=(_); end
+
+    # source://railties/7.0.3.1/lib/rails.rb#37
+    def application=(_arg0); end
+
+    # source://railties/7.0.3.1/lib/rails.rb#116
     def autoloaders; end
+
+    # source://railties/7.0.3.1/lib/rails.rb#50
     def backtrace_cleaner; end
+
+    # source://railties/7.0.3.1/lib/rails.rb#38
     def cache; end
-    def cache=(_); end
+
+    # source://railties/7.0.3.1/lib/rails.rb#38
+    def cache=(_arg0); end
+
+    # source://railties/7.0.3.1/lib/rails.rb#46
     def configuration; end
+
+    # source://railties/7.0.3.1/lib/rails.rb#72
     def env; end
+
+    # source://railties/7.0.3.1/lib/rails.rb#79
     def env=(environment); end
+
+    # source://railties/7.0.3.1/lib/rails.rb#83
+    def error; end
+
+    # source://railties/7.0.3.1/lib/rails/gem_version.rb#5
     def gem_version; end
+
+    # source://railties/7.0.3.1/lib/rails.rb#96
     def groups(*groups); end
-    def initialize!(*args, &block); end
-    def initialized?(*args, &block); end
+
+    # source://railties/7.0.3.1/lib/rails.rb#43
+    def initialize!(*_arg0, **_arg1, &_arg2); end
+
+    # source://railties/7.0.3.1/lib/rails.rb#43
+    def initialized?(*_arg0, **_arg1, &_arg2); end
+
+    # source://railties/7.0.3.1/lib/rails.rb#38
     def logger; end
-    def logger=(_); end
+
+    # source://railties/7.0.3.1/lib/rails.rb#38
+    def logger=(_arg0); end
+
+    # source://railties/7.0.3.1/lib/rails.rb#112
     def public_path; end
+
+    # source://railties/7.0.3.1/lib/rails.rb#63
     def root; end
+
+    # source://railties/7.0.3.1/lib/rails/version.rb#7
     def version; end
   end
 end
 
-module Rails::Dom
-end
+# source://rails-dom-testing//lib/rails/dom/testing/assertions.rb#5
+module Rails::Dom; end
 
-module Rails::Dom::Testing
-end
+# source://rails-dom-testing//lib/rails/dom/testing/assertions.rb#6
+module Rails::Dom::Testing; end
 
+# source://rails-dom-testing//lib/rails/dom/testing/assertions.rb#7
 module Rails::Dom::Testing::Assertions
-  include(::Rails::Dom::Testing::Assertions::DomAssertions)
-  include(::Rails::Dom::Testing::Assertions::SelectorAssertions::CountDescribable)
-  include(::Rails::Dom::Testing::Assertions::SelectorAssertions)
-  extend(::ActiveSupport::Concern)
+  include ::Rails::Dom::Testing::Assertions::DomAssertions
+  include ::Rails::Dom::Testing::Assertions::SelectorAssertions::CountDescribable
+  include ::Rails::Dom::Testing::Assertions::SelectorAssertions
+  extend ::ActiveSupport::Concern
 end
 
+# source://rails-dom-testing//lib/rails/dom/testing/assertions/dom_assertions.rb#5
 module Rails::Dom::Testing::Assertions::DomAssertions
+  # \Test two HTML strings for equivalency (e.g., equal even when attributes are in another order)
+  #
+  #   # assert that the referenced method generates the appropriate HTML string
+  #   assert_dom_equal '<a href="http://www.example.com">Apples</a>', link_to("Apples", "http://www.example.com")
+  #
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/dom_assertions.rb#10
   def assert_dom_equal(expected, actual, message = T.unsafe(nil)); end
+
+  # The negated form of +assert_dom_equal+.
+  #
+  #   # assert that the referenced method does not generate the specified HTML string
+  #   assert_dom_not_equal '<a href="http://www.example.com">Apples</a>', link_to("Oranges", "http://www.example.com")
+  #
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/dom_assertions.rb#20
   def assert_dom_not_equal(expected, actual, message = T.unsafe(nil)); end
 
   protected
 
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/dom_assertions.rb#28
   def compare_doms(expected, actual); end
+
+  # @return [Boolean]
+  #
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/dom_assertions.rb#63
   def equal_attribute?(attr, other_attr); end
+
+  # @return [Boolean]
+  #
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/dom_assertions.rb#50
   def equal_attribute_nodes?(nodes, other_nodes); end
+
+  # @return [Boolean]
+  #
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/dom_assertions.rb#38
   def equal_children?(child, other_child); end
 
   private
 
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/dom_assertions.rb#69
   def fragment(text); end
 end
 
+# Adds the +assert_select+ method for use in Rails functional
+# test cases, which can be used to make assertions on the response HTML of a controller
+# action. You can also call +assert_select+ within another +assert_select+ to
+# make assertions on elements selected by the enclosing assertion.
+#
+# Use +css_select+ to select elements without making an assertions, either
+# from the response HTML or elements selected by the enclosing assertion.
+#
+# In addition to HTML responses, you can make the following assertions:
+#
+# * +assert_select_encoded+ - Assertions on HTML encoded inside XML, for example for dealing with feed item descriptions.
+# * +assert_select_email+ - Assertions on the HTML body of an e-mail.
+#
+# source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/count_describable.rb#7
 module Rails::Dom::Testing::Assertions::SelectorAssertions
-  include(::Rails::Dom::Testing::Assertions::SelectorAssertions::CountDescribable)
+  include ::Rails::Dom::Testing::Assertions::SelectorAssertions::CountDescribable
 
+  # An assertion that selects elements and makes one or more equality tests.
+  #
+  # If the first argument is an element, selects all matching elements
+  # starting from (and including) that element and all its children in
+  # depth-first order.
+  #
+  # If no element is specified +assert_select+ selects from
+  # the element returned in +document_root_element+
+  # unless +assert_select+ is called from within an +assert_select+ block.
+  # Override +document_root_element+ to tell +assert_select+ what to select from.
+  # The default implementation raises an exception explaining this.
+  #
+  # When called with a block +assert_select+ passes an array of selected elements
+  # to the block. Calling +assert_select+ from the block, with no element specified,
+  # runs the assertion on the complete set of elements selected by the enclosing assertion.
+  # Alternatively the array may be iterated through so that +assert_select+ can be called
+  # separately for each element.
+  #
+  #
+  # ==== Example
+  # If the response contains two ordered lists, each with four list elements then:
+  #   assert_select "ol" do |elements|
+  #     elements.each do |element|
+  #       assert_select element, "li", 4
+  #     end
+  #   end
+  #
+  # will pass, as will:
+  #   assert_select "ol" do
+  #     assert_select "li", 8
+  #   end
+  #
+  # The selector may be a CSS selector expression (String) or an expression
+  # with substitution values (Array).
+  # Substitution uses a custom pseudo class match. Pass in whatever attribute you want to match (enclosed in quotes) and a ? for the substitution.
+  # assert_select returns nil if called with an invalid css selector.
+  #
+  # assert_select "div:match('id', ?)", /\d+/
+  #
+  # === Equality Tests
+  #
+  # The equality test may be one of the following:
+  # * <tt>true</tt> - Assertion is true if at least one element selected.
+  # * <tt>false</tt> - Assertion is true if no element selected.
+  # * <tt>String/Regexp</tt> - Assertion is true if the text value of at least
+  #   one element matches the string or regular expression.
+  # * <tt>Integer</tt> - Assertion is true if exactly that number of
+  #   elements are selected.
+  # * <tt>Range</tt> - Assertion is true if the number of selected
+  #   elements fit the range.
+  # If no equality test specified, the assertion is true if at least one
+  # element selected.
+  #
+  # To perform more than one equality tests, use a hash with the following keys:
+  # * <tt>:text</tt> - Narrow the selection to elements that have this text
+  #   value (string or regexp).
+  # * <tt>:html</tt> - Narrow the selection to elements that have this HTML
+  #   content (string or regexp).
+  # * <tt>:count</tt> - Assertion is true if the number of selected elements
+  #   is equal to this value.
+  # * <tt>:minimum</tt> - Assertion is true if the number of selected
+  #   elements is at least this value.
+  # * <tt>:maximum</tt> - Assertion is true if the number of selected
+  #   elements is at most this value.
+  #
+  # If the method is called with a block, once all equality tests are
+  # evaluated the block is called with an array of all matched elements.
+  #
+  #   # At least one form element
+  #   assert_select "form"
+  #
+  #   # Form element includes four input fields
+  #   assert_select "form input", 4
+  #
+  #   # Page title is "Welcome"
+  #   assert_select "title", "Welcome"
+  #
+  #   # Page title is "Welcome" and there is only one title element
+  #   assert_select "title", {count: 1, text: "Welcome"},
+  #       "Wrong title or more than one title element"
+  #
+  #   # Page contains no forms
+  #   assert_select "form", false, "This page must contain no forms"
+  #
+  #   # Test the content and style
+  #   assert_select "body div.header ul.menu"
+  #
+  #   # Use substitution values
+  #   assert_select "ol>li:match('id', ?)", /item-\d+/
+  #
+  #   # All input fields in the form have a name
+  #   assert_select "form input" do
+  #     assert_select ":match('name', ?)", /.+/  # Not empty
+  #   end
+  #
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions.rb#161
   def assert_select(*args, &block); end
+
+  # Extracts the body of an email and runs nested assertions on it.
+  #
+  # You must enable deliveries for this assertion to work, use:
+  #   ActionMailer::Base.perform_deliveries = true
+  #
+  #  assert_select_email do
+  #    assert_select "h1", "Email alert"
+  #  end
+  #
+  #  assert_select_email do
+  #    items = assert_select "ol>li"
+  #    items.each do
+  #       # Work with items here...
+  #    end
+  #  end
+  #
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions.rb#247
   def assert_select_email(&block); end
+
+  # Extracts the content of an element, treats it as encoded HTML and runs
+  # nested assertion on it.
+  #
+  # You typically call this method within another assertion to operate on
+  # all currently selected elements. You can also pass an element or array
+  # of elements.
+  #
+  # The content of each element is un-encoded, and wrapped in the root
+  # element +encoded+. It then calls the block with all un-encoded elements.
+  #
+  #   # Selects all bold tags from within the title of an Atom feed's entries (perhaps to nab a section name prefix)
+  #   assert_select "feed[xmlns='http://www.w3.org/2005/Atom']" do
+  #     # Select each entry item and then the title item
+  #     assert_select "entry>title" do
+  #       # Run assertions on the encoded title elements
+  #       assert_select_encoded do
+  #         assert_select "b"
+  #       end
+  #     end
+  #   end
+  #
+  #
+  #   # Selects all paragraph tags from within the description of an RSS feed
+  #   assert_select "rss[version=2.0]" do
+  #     # Select description element of each feed item.
+  #     assert_select "channel>item>description" do
+  #       # Run assertions on the encoded elements.
+  #       assert_select_encoded do
+  #         assert_select "p"
+  #       end
+  #     end
+  #   end
+  #
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions.rb#211
   def assert_select_encoded(element = T.unsafe(nil), &block); end
+
+  # Select and return all matching elements.
+  #
+  # If called with a single argument, uses that argument as a selector.
+  # Called without an element +css_select+ selects from
+  # the element returned in +document_root_element+
+  #
+  # The default implementation of +document_root_element+ raises an exception explaining this.
+  #
+  # Returns an empty Nokogiri::XML::NodeSet if no match is found.
+  #
+  # If called with two arguments, uses the first argument as the root
+  # element and the second argument as the selector. Attempts to match the
+  # root element and any of its children.
+  # Returns an empty Nokogiri::XML::NodeSet if no match is found.
+  #
+  # The selector may be a CSS selector expression (String).
+  # css_select returns nil if called with an invalid css selector.
+  #
+  #   # Selects all div tags
+  #   divs = css_select("div")
+  #
+  #   # Selects all paragraph tags and does something interesting
+  #   pars = css_select("p")
+  #   pars.each do |par|
+  #     # Do something fun with paragraphs here...
+  #   end
+  #
+  #   # Selects all list items in unordered lists
+  #   items = css_select("ul>li")
+  #
+  #   # Selects all form tags and then all inputs inside the form
+  #   forms = css_select("form")
+  #   forms.each do |form|
+  #     inputs = css_select(form, "input")
+  #     ...
+  #   end
+  #
+  # @raise [ArgumentError]
+  #
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions.rb#59
   def css_select(*args); end
 
   private
 
+  # +equals+ must contain :minimum, :maximum and :count keys
+  #
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions.rb#270
   def assert_size_match!(size, equals, css_selector, message = T.unsafe(nil)); end
+
+  # @raise [NotImplementedError]
+  #
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions.rb#264
   def document_root_element; end
+
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions.rb#282
   def nest_selection(selection); end
+
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions.rb#291
   def nodeset(node); end
 end
 
+# source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/count_describable.rb#8
 module Rails::Dom::Testing::Assertions::SelectorAssertions::CountDescribable
-  extend(::ActiveSupport::Concern)
-
+  extend ::ActiveSupport::Concern
 
   private
 
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/count_describable.rb#12
   def count_description(min, max, count); end
+
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/count_describable.rb#24
   def pluralize_element(quantity); end
 end
 
+# source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/substitution_context.rb#1
 class SubstitutionContext
+  # @return [SubstitutionContext] a new instance of SubstitutionContext
+  #
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/substitution_context.rb#2
   def initialize; end
 
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/substitution_context.rb#16
   def match(matches, attribute, matcher); end
+
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/substitution_context.rb#6
   def substitute!(selector, values, format_for_presentation = T.unsafe(nil)); end
 
   private
 
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/substitution_context.rb#21
   def matcher_for(value, format_for_presentation); end
+
+  # @return [Boolean]
+  #
+  # source://rails-dom-testing//lib/rails/dom/testing/assertions/selector_assertions/substitution_context.rb#30
   def substitutable?(value); end
 end