rspec-html 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cfd83e0a3a67f3f946b6ce6cb841e1cc32b591a590c84f85152ebc15c0c9930
-  data.tar.gz: a75ffeb0933fa3fa30d80fa89a4eff6da2211420fb04ec2fddf6ea287573fcb2
+  metadata.gz: e4eb7179d1b8e0ae007c863c0ff33ee3b7599e5f9d8d105fc5be06afd273f7a8
+  data.tar.gz: 391b0849d222beac92d0e98975da2f0eaf66d5bc1fce3285ba26d9ad36007250
 SHA512:
-  metadata.gz: 54886d022c1df32ce95b291769248387ef8d3044cda07f7ff9d314e91118c99dfacbe246b878e35f5bb7f8e1d4ddca88e5ebe387143d0eff3b7c446364c4d33c
-  data.tar.gz: 2437216d2611a1751e86f01c98d19442dbe33d6b21eee654711200dae3528a5000b23832a6b3b30cb91865a697d69605732143f56ba7cb6cb88949d8f27ef202
+  metadata.gz: 37f3419b01b9d60979a51e7f3866e2a3b42b87b1988141fe5819de6a76f387c844ebd1f79f44aecdf7e675d13c89fb92681fd21fbf63d78e02737e03ae9b2827
+  data.tar.gz: '08ffe7d4519cda519b2dc02bb9fcc3321fdf92ab76480c1a4f0d82b9c9e922aae8103d121b2f3c7649e9926484c9d27030e646d689763db1dc8385ed24abc706'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-html (0.3.0)
+    rspec-html (0.3.1)
       nokogiri (~> 1.10)
       rspec (~> 3.0)
 
@@ -21,8 +21,10 @@ GEM
     i18n (1.13.0)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
+    mini_portile2 (2.8.2)
     minitest (5.18.0)
-    nokogiri (1.13.10-x86_64-linux)
+    nokogiri (1.13.10)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     paint (2.3.0)
     parallel (1.23.0)

data/README.md

@@ -27,6 +27,19 @@ require 'rspec/html'
 
 Several [matchers](#matchers) are provided to identify text and _HTML_ elements within the _DOM_. These matchers can only be used with the provided [object interface](#object-interface).
 
+### Browser Inspection
+
+To open the current document in your operating system's default browser, call `document.open`. Use this to inspect _HTML_ content while debugging.
+
+```ruby
+it 'has complex HTML' do
+  get '/my/path'
+  document.open
+end
+```
+
+Alternatively `document.html_path` writes the current document to a temporary file and returns its path.
+
 ### Object Interface
 <a name="object-interface"></a>
 
@@ -47,7 +60,7 @@ This method can also be used for _ActionMailer_ emails:
 let(:document) { parse_html(ActionMailer::Base.deliveries.last.body.decoded) }
 ```
 
-**Changed in 0.3.0**: `parse_html` no longer sets the `document` automatically, you must use a `let` block to assign it yourself.
+**Changed in 0.3.0**: `parse_html` no longer assigns `document` automatically, you must use a `let` block to assign it yourself.
 
 To navigate the _DOM_ by a sequence of tag names use chained method calls on the `document` object:
 

data/lib/rspec/html/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module HTML
-    VERSION = '0.3.0'
+    VERSION = '0.3.1'
   end
 end

data/lib/rspec_html/browser.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RSpecHTML
+  # Convenience utility for loading a provided path in the operating system's default browser.
+  # Used for inspecting documents while debugging tests.
+  class Browser
+    def self.open(path)
+      new(path).open
+    end
+
+    def initialize(path)
+      @path = path
+    end
+
+    def open
+      log_launch_browser_event
+      system `#{command} '#{path}'`
+    end
+
+    private
+
+    attr_reader :path
+
+    def log_launch_browser_event
+      warn "\e[35m[rspec-html] Opening document in browser from: \e[32m#{caller[3]}\e[0m"
+    end
+
+    def command
+      return 'start' if RUBY_PLATFORM =~ /mswin|mingw|cygwin/
+      return 'open' if RUBY_PLATFORM =~ /darwin/
+      return 'xdg-open' if RUBY_PLATFORM =~ /linux|bsd/
+
+      raise ArgumentError, "Unable to detect operating system from #{RUBY_PLATFORM}"
+    end
+  end
+end

data/lib/rspec_html/element.rb

@@ -22,6 +22,16 @@ module RSpecHTML
       @search = Search.new(@element, @siblings, self)
     end
 
+    def open
+      Browser.open(html_path)
+    end
+
+    def html_path
+      @html_path ||= Pathname.new(Dir.mktmpdir('rspec-html')).join('document.html').tap do |path|
+        path.write(@element.inner_html)
+      end
+    end
+
     def present?
       return true if name == :document
 

data/lib/rspec_html/matchers/match_text.rb

@@ -29,7 +29,11 @@ module RSpecHTML
       end
 
       def regexp_siblings_match?(actual)
-        actual.siblings.any? { |sibling| @expected.match(sibling&.text || '') }
+        matching_siblings = actual.siblings.select { |sibling| @expected.match(sibling&.text || '') }
+        @actual_count = matching_siblings.size
+        return matching_siblings.size.positive? if @expected_count.nil?
+
+        matching_siblings.size.positive? && count_match?
       end
 
       def string_match?(actual)
@@ -40,7 +44,11 @@ module RSpecHTML
       end
 
       def string_siblings_match?(actual)
-        actual.siblings.any? { |sibling| (sibling&.text || '').include?(@expected.to_s) }
+        matching_siblings = actual.siblings.select { |sibling| (sibling&.text || '').include?(@expected.to_s) }
+        @actual_count = matching_siblings.size
+        return matching_siblings.size.positive? if @expected_count.nil?
+
+        matching_siblings.size.positive? && count_match?
       end
 
       def raise_argument_error

data/lib/rspec_html/search.rb

@@ -117,12 +117,12 @@ module RSpecHTML
 
     def index(val)
       zero_index_error if val.zero?
-      self.class.new(@siblings[val - 1], @element.name, element_wrapper)
+      Element.new(@siblings[val - 1], @element.name)
     end
 
     def range(val)
       zero_index_error if val.first.zero?
-      self.class.new(@siblings[(val.first - 1)..(val.last - 1)], :range, element_wrapper)
+      @siblings[(val.first - 1)..(val.last - 1)].map { |element| Element.new(element, @element.name) }
     end
 
     def zero_index_error
@@ -149,7 +149,10 @@ module RSpecHTML
 
     def where_xpath(tag, query)
       conditions = "[#{where_conditions(query)}]" unless query.compact.empty?
-      @element&.xpath(".//#{tag}#{conditions}")
+      result = @element&.xpath(".//#{tag}#{conditions}")
+      return result unless @siblings.is_a?(Nokogiri::XML::NodeSet) && result.empty?
+
+      @siblings.xpath(".//#{tag}#{conditions}")
     end
 
     def where_conditions(query)

data/lib/rspec_html.rb

@@ -4,6 +4,7 @@ require 'nokogiri'
 
 require 'pathname'
 require 'forwardable'
+require 'tempfile'
 
 require 'rspec_html/tags'
 require 'rspec_html/element'
@@ -11,6 +12,7 @@ require 'rspec_html/search'
 require 'rspec_html/reconstituted_element'
 require 'rspec_html/countable'
 require 'rspec_html/matchers'
+require 'rspec_html/browser'
 
 # Support module for rspec/html
 module RSpecHTML

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-html
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-13 00:00:00.000000000 Z
+date: 2023-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -61,6 +61,7 @@ files:
 - lib/rspec/html.rb
 - lib/rspec/html/version.rb
 - lib/rspec_html.rb
+- lib/rspec_html/browser.rb
 - lib/rspec_html/countable.rb
 - lib/rspec_html/element.rb
 - lib/rspec_html/matchers.rb