orderly 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cea3ece86863bb26014c5444e2ef64b1cbae500fe21e72cd9acade819b2787be
-  data.tar.gz: 234a6c96a889e2b8ba46aa804601edc53f07cdbdc9eaf8ab8b82ca96b7e254ba
+  metadata.gz: 9b7a52ca99c21471d257d31243449fe036db51c784d0dfd22b01ff96397fe00d
+  data.tar.gz: 9abdc383f871e3c53d8af0c3949f9f5de2762f03b41c37697579d542c93805e3
 SHA512:
-  metadata.gz: 7ebadf197892f14c1be4097868cbc029327f49dd92af25f302be83e6a18bb06fc8c12d019c5273940bfd37dd548ce048d1b7c5e3fd00d28345994e904a3881eb
-  data.tar.gz: c77f6fe4aa0e51972dc1226519e3979bc8c26c527ff307ba1e7a8c0f1d3e4be5b2b8888e1926f302b5d5169deb6e4d1e092aca967090035bbdadd02a10f443cc
+  metadata.gz: 58409a784670ceed76d638d35465cc1f2c5ecf83e48955772347b889ea5a73034d348bda45fb1f12b75b8f16282039ff99286041f7b898c10f153d1ef4a0f73c
+  data.tar.gz: d13c0ed1d8fbef1701afaf853f58545db4ff3cc930109c4c11917d4132cc624862de3edcaccba62e20500a9a0a63adf7a54b052994d5ff9f3bdb10c53d152890

data/README.md

@@ -20,19 +20,44 @@ Or install it yourself as:
 
 In an rspec request spec, do
 
-    this.should appear_before(that)
-    # or
-    expect(this).to appear_before(that)
+```ruby
+let(:this) { "<li>Andrea</li>" }
+let(:that) { "<li>Luis</li>" }
 
-or, to assert that something does not appear before
+expect(this).to appear_before(that)
 
-    this.should_not appear_before(that)
-    # or
-    expect(this).to_not appear_before(that)
+# or use capybara elements
+this = find('.this')
+that = find('.that')
 
-Error handling in place for cases where this or that does not appear on the page.
+expect(this).to appear_before(that)
+```
+
+To assert that something does not appear before
+
+```ruby
+expect(this).to_not appear_before(that)
+```
+
+By default, `appear_before` matches against HTML. If you want to only compare text, use the `only_text`-option:
+
+```ruby
+# <dl>
+#   <dt>First name:</dt>
+#   <dd>Andrea</dt>
+#
+#   <dt>Last name:</dt>
+#   <dd>Robbinovich</dt>
+# </dl>
+
+expect("First name: Andrea").to appear_before("Last name: Robbinovich", only_text: true)
+```
 
 ## Changelog
+### 0.1.1 (2020-02-20)
+- Add support for `only_text`-option
+- Add support for using capybara nodes
+
 ### 0.1.0 (2019-08-08)
 - Add support for capybara `within`-blocks
 

data/lib/orderly.rb

@@ -2,12 +2,13 @@ require "orderly/version"
 require "rspec/expectations"
 
 module Orderly
-  RSpec::Matchers.define :appear_before do |later_content|
+  RSpec::Matchers.define :appear_before do |later_content, only_text: false|
     match do |earlier_content|
       begin
         node = page.respond_to?(:current_scope) ? page.current_scope : page.send(:current_node)
-        html = html_for_node(node)
-        html.index(earlier_content) < html.index(later_content)
+        data = only_text ? text_for_node(node) : html_for_node(node)
+
+        data.index(extract_content(earlier_content)) < data.index(extract_content(later_content))
       rescue ArgumentError
         raise "Could not locate later content on page: #{later_content}"
       rescue NoMethodError
@@ -17,12 +18,26 @@ module Orderly
 
     def html_for_node(node)
       if node.is_a?(Capybara::Node::Document)
-        page.body
-      elsif node.native.respond_to?(:inner_html)
-        node.native.inner_html
+        html_for_node(node.find(:xpath, '//body'))
+      elsif node.native.respond_to?(:to_html)
+        node.native.to_html
       else
-        page.driver.evaluate_script("arguments[0].innerHTML", node.native)
+        node.evaluate_script("this.outerHTML")
       end
     end
+
+    def extract_content(node)
+      if node.is_a?(String)
+        node
+      else
+        html_for_node(node)
+      end
+    end
+
+    def text_for_node(node)
+      # NOTE: we need to normalize spaces due to differences between rack-test
+      # and headless chrome.
+      node.text.gsub(/[[:space:]]+/, ' ').strip
+    end
   end
 end

data/lib/orderly/version.rb

@@ -1,3 +1,3 @@
 module Orderly
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.1".freeze
 end

data/spec/lib/orderly_spec.rb

@@ -50,5 +50,49 @@ describe Orderly do
         end
       end
     end
+
+    context "when only_text option is passed" do
+      context "when that is equal to option from HTML" do
+        let(:this) { "ability" }
+        let(:that) { "option" }
+
+        it "asserts this is before that" do
+          page.visit "/options"
+
+          expect(this).to appear_before(that, only_text: true)
+        end
+      end
+
+      context "when text is split in HTML" do
+        let(:this) { "First name: Andrea" }
+        let(:that) { "Last name: Robbinovich" }
+
+        it "asserts this is before that" do
+          page.visit "/description-list"
+
+          expect(this).to appear_before(that, only_text: true)
+        end
+      end
+    end
+
+    context "when a capybara element is passed" do
+      it "asserts that the first capybara element appears before the second" do
+        page.visit "/elements-with-ids"
+        div1 = page.find("#div-1")
+        div2 = page.find("#div-2")
+
+        expect(div1).to appear_before(div2)
+      end
+    end
+
+    context "when the page returns tags without closing forward slashes" do
+      it "normalizes those tags" do
+        page.visit "/response-with-unclosed-tag"
+        img1 = page.find("#img-1")
+        img2 = page.find("#img-2")
+
+        expect(img1).to appear_before(img2)
+      end
+    end
   end
 end

data/spec/test_app.rb

@@ -25,12 +25,48 @@ class TestApp < Sinatra::Base
   end
 
   get '/thatthisthatthis' do
-    "#{that}
+    <<-HTML
+    #{that}
     <div class='outer-div'>
       #{this}
       <div class='inner-div'>
       #{that + this}
       </div>
-    </div>"
+    </div>
+    HTML
+  end
+
+  get '/options' do
+    <<-HTML
+    <select>
+      <option>ability</option>
+      <option>option</option>
+    </select>
+    HTML
+  end
+
+  get '/description-list' do
+    <<-HTML
+    <dl>
+      <dt>First name:</dt>
+      <dd>Andrea</dt>
+      <dt>Last name:</dt>
+      <dd>Robbinovich</dt>
+    </dl>
+    HTML
+  end
+
+  get '/elements-with-ids' do
+    <<-HTML
+    <div id="div-1">Foo</div>
+    <div id="div-2">Bar</div>
+    HTML
+  end
+
+  get '/response-with-unclosed-tag' do
+    <<-HTML
+    <img id="img-1" src="https://i.picsum.photos/id/1082/200/300.jpg">
+    <img id="img-2" src="https://i.picsum.photos/id/1082/200/300.jpg" />
+    HTML
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orderly
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - John Gesimondo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-08 00:00:00.000000000 Z
+date: 2020-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -152,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Assert this is before that