rails-dom-testing 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4c5e946843592cec1b0b7e17a9dc5fe9b2b0ceb
-  data.tar.gz: 4cae76910af7476691d495a0ab84863e363824e3
+  metadata.gz: 25916970c49a8bacd1a2153cedaf2474cdceb73a
+  data.tar.gz: a3ce7d48ccb543f0abf1bd2354493a3281a38a04
 SHA512:
-  metadata.gz: d4ead231de2ed2c888eba70d866eae3a58a7eb853c5863b67278a87e4b164beae052af93c3c6c36b51ef198964a7613b8c874ee9a3fc60ec0168484ce92b5e10
-  data.tar.gz: 7744ed519a6cff2f3e77395aced9a5d104e034ebddb7370897f53ad68d55f00917bfff1891fe8d4f494754f23630b7899c0afd1147c49dbbf7b2460dd8feb5a8
+  metadata.gz: 0c3389884b69ad22df708e36656e72cafa18b71868d6aadab3e47d0f8228ec885c84f06bde22424a6e84c9a2612ccb210b951e3fbbb3f4fa863dd26def4d5f0d
+  data.tar.gz: 3340db215cba92832210bc2847ebb043c855461fc76fcaaa39e70463599a6b5fd2fa3030795a805ada92e9a2cf72e37cfab2d724bb865feae056ac835878540d

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.0.2
+
+* Add deprecated `assert_tag`.
+
 # 1.0.0
 
 * First Release.

data/lib/rails/dom/testing/assertions.rb

@@ -7,11 +7,13 @@ module Rails
       module Assertions
         autoload :DomAssertions, 'rails/dom/testing/assertions/dom_assertions'
         autoload :SelectorAssertions, 'rails/dom/testing/assertions/selector_assertions'
+        autoload :TagAssertions, 'rails/dom/testing/assertions/tag_assertions'
 
         extend ActiveSupport::Concern
 
         include DomAssertions
         include SelectorAssertions
+        include TagAssertions
       end
     end
   end

data/lib/rails/dom/testing/assertions/tag_assertions.rb

@@ -0,0 +1,155 @@
+require 'active_support/deprecation'
+require 'rails/deprecated_sanitizer/html-scanner'
+
+module Rails
+  module Dom
+    module Testing
+      module Assertions
+        # Pair of assertions to testing elements in the HTML output of the response.
+        module TagAssertions
+          # 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>:sibling</tt>: a hash. At least one of the node's siblings must
+          #   meet the criteria described by the hash.
+          # * <tt>:after</tt>: a hash. The node must be after any sibling meeting
+          #   the criteria described by the hash, and at least one sibling must match.
+          # * <tt>:before</tt>: a hash. The node must be before any sibling meeting
+          #   the criteria described by the hash, and at least one sibling must match.
+          # * <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>: the textual content of the node must match the
+          #   given value. This will not match HTML tags in the body of a
+          #   tag--only text.
+          #
+          # 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+.
+          #
+          #   # Assert that there is a "span" tag
+          #   assert_tag tag: "span"
+          #
+          #   # Assert that there is a "span" tag with id="x"
+          #   assert_tag tag: "span", attributes: { id: "x" }
+          #
+          #   # Assert that there is a "span" tag using the short-hand
+          #   assert_tag :span
+          #
+          #   # Assert that there is a "span" tag with id="x" using the short-hand
+          #   assert_tag :span, attributes: { id: "x" }
+          #
+          #   # 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/ }
+          #
+          # <b>Please note</b>: +assert_tag+ and +assert_no_tag+ only work
+          # with well-formed XHTML. They recognize a few tags as implicitly self-closing
+          # (like br and hr and such) but will not work correctly with tags
+          # that allow optional closing tags (p, li, td). <em>You must explicitly
+          # close all of your tags to use these assertions.</em>
+          def assert_tag(*opts)
+            ActiveSupport::Deprecation.warn("assert_tag is deprecated and will be removed at Rails 5. Use assert_select to get the same feature.")
+
+            opts = opts.size > 1 ? opts.last.merge({ tag: opts.first.to_s }) : opts.first
+            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.)
+          #
+          #   # Assert that there is not a "div" containing a "p"
+          #   assert_no_tag tag: "div", descendant: { tag: "p" }
+          #
+          #   # Assert that an unordered list is empty
+          #   assert_no_tag tag: "ul", descendant: { tag: "li" }
+          #
+          #   # Assert that there is not a "p" tag with between 1 to 3 "img" tags
+          #   # as immediate children
+          #   assert_no_tag tag: "p",
+          #              children: { count: 1..3, only: { tag: "img" } }
+          def assert_no_tag(*opts)
+            ActiveSupport::Deprecation.warn("assert_no_tag is deprecated and will be removed at Rails 5. Use assert_select to get the same feature.")
+
+            opts = opts.size > 1 ? opts.last.merge({ tag: opts.first.to_s }) : opts.first
+            tag = _find_tag(opts)
+
+            assert !tag, "expected no tag, but found tag matching #{opts.inspect} in:\n#{@response.body.inspect}"
+          end
+
+          def find_tag(conditions)
+            ActiveSupport::Deprecation.warn("find_tag is deprecated and will be removed at Rails 5 without replacement.")
+
+            _find_tag(conditions)
+          end
+
+          def find_all_tag(conditions)
+            ActiveSupport::Deprecation.warn("find_all_tag is deprecated and will be removed at Rails 5 without replacement. Use assert_select to get the same feature.")
+
+            html_scanner_document.find_all(conditions)
+          end
+
+          private
+            def _find_tag(conditions)
+              html_scanner_document.find(conditions)
+            end
+
+            def html_scanner_document
+              xml = @response.content_type =~ /xml$/
+              @html_document ||= HTML::Document.new(@response.body, false, xml)
+            end
+        end
+      end
+    end
+  end
+end

data/lib/rails/dom/testing/version.rb

@@ -1,7 +1,7 @@
 module Rails
   module Dom
     module Testing
-      VERSION = "1.0.0"
+      VERSION = "1.0.2"
     end
   end
 end

data/test/tag_assertions_test.rb

@@ -0,0 +1,218 @@
+require 'test_helper'
+require 'rails/dom/testing/assertions/tag_assertions'
+
+HTML_TEST_OUTPUT = <<HTML
+<html>
+  <body>
+    <a href="/"><img src="/images/button.png" /></a>
+    <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
+
+class AssertTagTest < ActiveSupport::TestCase
+  include Rails::Dom::Testing::Assertions::TagAssertions
+
+  class FakeResponse
+    attr_accessor :content_type, :body
+
+    def initialize(content_type, body)
+      @content_type, @body = content_type, body
+    end
+  end
+
+  setup do
+    @response = FakeResponse.new 'html', HTML_TEST_OUTPUT
+  end
+
+  def test_assert_tag_tag
+    assert_deprecated do
+      # there is a 'form' tag
+      assert_tag tag: 'form'
+      # there is not an 'hr' tag
+      assert_no_tag tag: 'hr'
+    end
+  end
+
+  def test_assert_tag_attributes
+    assert_deprecated do
+      # there is a tag with an 'id' of 'bar'
+      assert_tag attributes: { id: "bar" }
+      # there is no tag with a 'name' of 'baz'
+      assert_no_tag attributes: { name: "baz" }
+    end
+  end
+
+  def test_assert_tag_parent
+    assert_deprecated do
+      # there is a tag with a parent 'form' tag
+      assert_tag parent: { tag: "form" }
+      # there is no tag with a parent of 'input'
+      assert_no_tag parent: { tag: "input" }
+    end
+  end
+
+  def test_assert_tag_child
+    assert_deprecated do
+      # there is a tag with a child 'input' tag
+      assert_tag child: { tag: "input" }
+      # there is no tag with a child 'strong' tag
+      assert_no_tag child: { tag: "strong" }
+    end
+  end
+
+  def test_assert_tag_ancestor
+    assert_deprecated do
+      # there is a 'li' tag with an ancestor having an id of 'foo'
+      assert_tag ancestor: { attributes: { id: "foo" } }, tag: "li"
+      # there is no tag of any kind with an ancestor having an href matching 'foo'
+      assert_no_tag ancestor: { attributes: { href: /foo/ } }
+    end
+  end
+
+  def test_assert_tag_descendant
+    assert_deprecated do
+      # there is a tag with a descendant 'li' tag
+      assert_tag descendant: { tag: "li" }
+      # there is no tag with a descendant 'html' tag
+      assert_no_tag descendant: { tag: "html" }
+    end
+  end
+
+  def test_assert_tag_sibling
+    assert_deprecated do
+      # there is a tag with a sibling of class 'item'
+      assert_tag sibling: { attributes: { class: "item" } }
+      # there is no tag with a sibling 'ul' tag
+      assert_no_tag sibling: { tag: "ul" }
+    end
+  end
+
+  def test_assert_tag_after
+    assert_deprecated do
+      # there is a tag following a sibling 'div' tag
+      assert_tag after: { tag: "div" }
+      # there is no tag following a sibling tag with id 'bar'
+      assert_no_tag after: { attributes: { id: "bar" } }
+    end
+  end
+
+  def test_assert_tag_before
+    assert_deprecated do
+      # there is a tag preceding a tag with id 'bar'
+      assert_tag before: { attributes: { id: "bar" } }
+      # there is no tag preceding a 'form' tag
+      assert_no_tag before: { tag: "form" }
+    end
+  end
+
+  def test_assert_tag_children_count
+    assert_deprecated do
+      # there is a tag with 2 children
+      assert_tag children: { count: 2 }
+      # in particular, there is a <ul> tag with two children (a nameless pair of <li>s)
+      assert_tag tag: 'ul', children: { count: 2 }
+      # there is no tag with 4 children
+      assert_no_tag children: { count: 4 }
+    end
+  end
+
+  def test_assert_tag_children_less_than
+    assert_deprecated do
+      # there is a tag with less than 5 children
+      assert_tag children: { less_than: 5 }
+      # there is no 'ul' tag with less than 2 children
+      assert_no_tag children: { less_than: 2 }, tag: "ul"
+    end
+  end
+
+  def test_assert_tag_children_greater_than
+    assert_deprecated do
+      # there is a 'body' tag with more than 1 children
+      assert_tag children: { greater_than: 1 }, tag: "body"
+      # there is no tag with more than 10 children
+      assert_no_tag children: { greater_than: 10 }
+    end
+  end
+
+  def test_assert_tag_children_only
+    assert_deprecated do
+      # there is a tag containing only one child with an id of 'foo'
+      assert_tag children: { count: 1,
+                             only: { attributes: { id: "foo" } } }
+      # there is no tag containing only one 'li' child
+      assert_no_tag children: { count: 1, only: { tag: "li" } }
+    end
+  end
+
+  def test_assert_tag_content
+    assert_deprecated do
+      # the output contains the string "Name"
+      assert_tag content: /Name/
+      # the output does not contain the string "test"
+      assert_no_tag content: /test/
+    end
+  end
+
+  def test_assert_tag_multiple
+    assert_deprecated do
+      # 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
+
+  def test_assert_tag_children_without_content
+    assert_deprecated do
+      # there is a form tag with an 'input' child which is a self closing tag
+      assert_tag tag: "form",
+        children: { count: 1,
+                    only: { tag: "input" } }
+
+        # the body tag has an 'a' child which in turn has an 'img' child
+        assert_tag tag: "body",
+          children: { count: 1,
+                      only: { tag: "a",
+                              children: { count: 1,
+                                          only: { tag: "img" } } } }
+    end
+  end
+
+  def test_assert_tag_attribute_matching
+    assert_deprecated do
+      @response.body = '<input type="text" name="my_name">'
+      assert_tag tag: 'input',
+        attributes: { name: /my/, type: 'text' }
+      assert_no_tag tag: 'input',
+        attributes: { name: 'my', type: 'text' }
+      assert_no_tag tag: 'input',
+        attributes: { name: /^my$/, type: 'text' }
+    end
+  end
+
+  def test_assert_tag_content_matching
+    assert_deprecated do
+      @response.body = "<p>hello world</p>"
+      assert_tag tag: "p", content: "hello world"
+      assert_tag tag: "p", content: /hello/
+      assert_no_tag tag: "p", content: "hello"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-dom-testing
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Rafael Mendonça França
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-18 00:00:00.000000000 Z
+date: 2014-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -39,6 +39,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails-deprecated_sanitizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -98,9 +112,11 @@ files:
 - lib/rails/dom/testing/assertions/selector_assertions.rb
 - lib/rails/dom/testing/assertions/selector_assertions/html_selector.rb
 - lib/rails/dom/testing/assertions/selector_assertions/substitution_context.rb
+- lib/rails/dom/testing/assertions/tag_assertions.rb
 - lib/rails/dom/testing/version.rb
 - test/dom_assertions_test.rb
 - test/selector_assertions_test.rb
+- test/tag_assertions_test.rb
 - test/test_helper.rb
 homepage: https://github.com/kaspth/rails-dom-testing
 licenses:
@@ -122,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: This gem can compare doms and assert certain elements exists in doms using
@@ -130,4 +146,6 @@ summary: This gem can compare doms and assert certain elements exists in doms us
 test_files:
 - test/dom_assertions_test.rb
 - test/selector_assertions_test.rb
+- test/tag_assertions_test.rb
 - test/test_helper.rb
+has_rdoc: