Changeset 1195

Timestamp:

04/17/05 16:43:48 (3 years ago)

Author:

david

Message:

Added assert_tag and assert_no_tag as a much improved alternative to the deprecated assert_template_xpath_match #1126 [Jamis Buck]

Files:

• trunk/actionpack/CHANGELOG (modified) (1 diff)
• trunk/actionpack/lib/action_controller/assertions.rb (modified) (1 diff)
• trunk/actionpack/lib/action_controller/test_process.rb (modified) (2 diffs)
• trunk/actionpack/lib/action_controller/vendor (added)
• trunk/actionpack/lib/action_controller/vendor/html-scanner (added)
• trunk/actionpack/lib/action_controller/vendor/html-scanner/html (added)
• trunk/actionpack/lib/action_controller/vendor/html-scanner/html/document.rb (added)
• trunk/actionpack/lib/action_controller/vendor/html-scanner/html/node.rb (added)
• trunk/actionpack/lib/action_controller/vendor/html-scanner/html/tokenizer.rb (added)
• trunk/actionpack/lib/action_controller/vendor/html-scanner/html/version.rb (added)
• trunk/actionpack/test/controller/test_test.rb (modified) (2 diffs)

trunk/actionpack/CHANGELOG

@@ -2 +2 @@
-
-* Added Request#xml_http_request? (and an alias xhr?) to that'll return true when the request came from one of the Javascript helper methods (Ajax). This can be used to give one behavior for modern browsers supporting Ajax, another to old browsers #1127 [Sam Stephenson]
+
+* Added assert_tag and assert_no_tag as a much improved alternative to the deprecated assert_template_xpath_match #1126 [Jamis Buck]
-
-* Deprecated the majority of all the testing assertions and replaced them with a much smaller core and access to all the collections the old assertions relied on. That way the regular test/unit assertions can be used against these. Added documentation about how to use it all.

trunk/actionpack/lib/action_controller/assertions.rb

@@ -117 +117 @@
-        assert_generates(path, options, defaults, extras, message)
-      end
+
+      # Asserts that there is a tag/node/element in the body of the response
+      # that meets all of the given conditions. The +conditions+ parameter must
+      # be a hash of any of the following keys (all are optional):
+      #
+      # * <tt>:tag</tt>: the node type must match the corresponding value
+      # * <tt>:attributes</tt>: a hash. The node's attributes must match the
+      #   corresponding values in the hash.
+      # * <tt>:parent</tt>: a hash. The node's parent must match the
+      #   corresponding hash.
+      # * <tt>:child</tt>: a hash. At least one of the node's immediate children
+      #   must meet the criteria described by the hash.
+      # * <tt>:ancestor</tt>: a hash. At least one of the node's ancestors must
+      #   meet the criteria described by the hash.
+      # * <tt>:descendant</tt>: a hash. At least one of the node's descendants
+      #   must meet the criteria described by the hash.
+      # * <tt>:children</tt>: a hash, for counting children of a node. Accepts
+      #   the keys:
+      # ** <tt>:count</tt>: either a number or a range which must equal (or
+      #    include) the number of children that match.
+      # ** <tt>:less_than</tt>: the number of matching children must be less
+      #    than this number.
+      # ** <tt>:greater_than</tt>: the number of matching children must be
+      #    greater than this number.
+      # ** <tt>:only</tt>: another hash consisting of the keys to use
+      #    to match on the children, and only matching children will be
+      #    counted.
+      # * <tt>:content</tt>: (text nodes only). The content of the node must
+      #   match the given value.
+      #
+      # Conditions are matched using the following algorithm:
+      #
+      # * if the condition is a string, it must be a substring of the value.
+      # * if the condition is a regexp, it must match the value.
+      # * if the condition is a number, the value must match number.to_s.
+      # * if the condition is +true+, the value must not be +nil+.
+      # * if the condition is +false+ or +nil+, the value must be +nil+.
+      #
+      # Usage:
+      #
+      #   # assert that there is a "span" tag
+      #   assert_tag :tag => "span"
+      #
+      #   # assert that there is a "span" inside of a "div"
+      #   assert_tag :tag => "span", :parent => { :tag => "div" }
+      #
+      #   # assert that there is a "span" somewhere inside a table
+      #   assert_tag :tag => "span", :ancestor => { :tag => "table" }
+      #
+      #   # assert that there is a "span" with at least one "em" child
+      #   assert_tag :tag => "span", :child => { :tag => "em" }
+      #
+      #   # assert that there is a "span" containing a (possibly nested)
+      #   # "strong" tag.
+      #   assert_tag :tag => "span", :descendant => { :tag => "strong" }
+      #
+      #   # assert that there is a "span" containing between 2 and 4 "em" tags
+      #   # as immediate children
+      #   assert_tag :tag => "span",
+      #              :children => { :count => 2..4, :only => { :tag => "em" } } 
+      #
+      #   # get funky: assert that there is a "div", with an "ul" ancestor
+      #   # and an "li" parent (with "class" = "enum"), and containing a 
+      #   # "span" descendant that contains text matching /hello world/
+      #   assert_tag :tag => "div",
+      #              :ancestor => { :tag => "ul" },
+      #              :parent => { :tag => "li",
+      #                           :attributes => { :class => "enum" } },
+      #              :descendant => { :tag => "span",
+      #                               :child => /hello world/ }
+      def assert_tag(opts)
+        tag = find_tag(opts)
+        assert tag, "expected tag, but no tag found matching #{opts.inspect} in:\n#{@response.body.inspect}"
+      end
+      
+      # Identical to #assert_tag, but asserts that a matching tag does _not_
+      # exist. (See #assert_tag for a full discussion of the syntax.)
+      def assert_no_tag(opts)
+        tag = find_tag(opts)
+        assert !tag, "expected no tag, but found tag matching #{opts.inspect} in:\n#{@response.body.inspect}"
+      end
+    
-    end
-  end

trunk/actionpack/lib/action_controller/test_process.rb

@@ -244 +244 @@
-        # execute the request and set/volley the response
-        def process(action, parameters = nil, session = nil, flash = nil)
+          @html_document = nil
-          @request.env['REQUEST_METHOD'] ||= "GET"
-          @request.action = action.to_s
@@ -304 +305 @@
-              (parameters||{}).update(:only_path => true, :action=>action))))
-        end
+
+        def html_document
+          require_html_scanner
+          @html_document ||= HTML::Document.new(@response.body)
+        end
+        
+        def find_tag(conditions)
+          html_document.find(conditions)
+        end
+
+        def find_all_tag(conditions)
+          html_document.find_all(conditions)
+        end
+
+        def require_html_scanner
+          return true if defined?(HTML::Document)
+          require 'html/document'
+        rescue LoadError
+          $:.unshift File.dirname(__FILE__) + "/vendor/html-scanner"
+          require 'html/document'
+        end
-      end
-  end

trunk/actionpack/test/controller/test_test.rb

@@ -9 +9 @@
-    def test_uri
-      render_text @request.request_uri
+    end
+
+    def test_html_output
+      render_text <<HTML
+<html>
+  <body>
+    <div id="foo">
+      <ul>
+        <li class="item">hello</li>
+        <li class="item">goodbye</li>
+      </ul>
+    </div>
+    <div id="bar">
+      <form action="/somewhere">
+        Name: <input type="text" name="person[name]" id="person_name" />
+      </form>
+    </div>
+  </body>
+</html>
+HTML
-    end
-  end
@@ -48 +68 @@
-    assert_equal @response.body, "/explicit/uri"
-  end
+
+  def test_assert_tag
+    process :test_html_output
+
+    # there is a 'div', id='bar', with an immediate child whose 'action'
+    # attribute matches the regexp /somewhere/.
+    assert_tag :tag => "div", :attributes => { :id => "bar" },
+               :child => { :attributes => { :action => /somewhere/ } }
+
+    # there is no 'div', id='foo', with a 'ul' child with more than
+    # 2 "li" children.
+    assert_no_tag :tag => "div", :attributes => { :id => "foo" },
+                  :child => {
+                    :tag => "ul",
+                    :children => { :greater_than => 2,
+                                   :only => { :tag => "li" } } }
+  end
-end