rspec-html 0.2.7 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d97c22c301a390a13dd3faa6e259633d6c991346e35da9cb3abded233b2a3809
-  data.tar.gz: 10d4ce1f83f23f6a2620050a3d6cf680aab9f5c63dd59d51f2d18170140742bf
+  metadata.gz: d4bc7abc0e55d59ef4b3b1175dbca0022b5cdd0e2707f2d356ba46d5810feb2f
+  data.tar.gz: 8a6a33977d7218bdba104a768fb7c601c88ad9aa0f6aaf157c8534e239813ea5
 SHA512:
-  metadata.gz: 4389b7626dee960fe7933446a09a72d6bf1021395184b3b6fc0a5f2afd8a7d42b40422a7a92880030cc157bd4e15961546799884bb330c90ce251ef575316ee4
-  data.tar.gz: d789b659fff49df36383b979b92127af11a268568687f67bcdebf7860e0b12950c93082548fb79540c513eb8b5588c7983fa27b2b34f3c986bc73b1db990ffd3
+  metadata.gz: fe9b21c6c38c786e815f89f02e943263f60c88d772f532de0f9e50e4b3e017ea21bd264b9ecd464102d272f7c53c52ea12e70c279e8b2fbf0f5f9095cabfbde2
+  data.tar.gz: 650e39fd4844ffacab77edadeb5a1229004b22a23bf38fe6e21f4d8c17e91c7f79dd22655184c209072e6ac5a7ed5ebe03e98d8854c83e8764b055ea2876dff1

data/.rubocop.yml

@@ -3,9 +3,6 @@ Metrics/BlockLength:
     - 'spec/**/*'
     - 'rspec-html.gemspec'
 
-Gemspec/RequiredRubyVersion:
-  Enabled: false
-
 AllCops:
   NewCops: enable
 

data/.ruby-version

@@ -1 +1 @@
-2.7.1
+2.6.9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-html (0.2.7)
+    rspec-html (0.2.9)
       nokogiri (~> 1.10)
       rspec (~> 3.0)
 
@@ -9,75 +9,73 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    byebug (11.1.3)
-    concurrent-ruby (1.1.9)
-    devpack (0.1.3)
-    diff-lcs (1.4.4)
-    i18n (1.8.11)
+    concurrent-ruby (1.1.10)
+    devpack (0.4.0)
+    diff-lcs (1.5.0)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    mini_portile2 (2.6.1)
-    nokogiri (1.12.5)
-      mini_portile2 (~> 2.6.1)
+    nokogiri (1.13.6-x86_64-linux)
       racc (~> 1.4)
     paint (2.2.1)
-    parallel (1.21.0)
-    parser (3.0.3.2)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     racc (1.6.0)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.0)
+    regexp_parser (2.3.1)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
+      rspec-support (~> 3.11.0)
     rspec-its (1.3.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.10.2)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rubocop (0.93.1)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.29.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
-      rexml
-      rubocop-ast (>= 0.6.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.15.0)
-      parser (>= 3.0.1.1)
-    rubocop-rspec (1.44.1)
-      rubocop (~> 0.87)
-      rubocop-ast (>= 0.7.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.10.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     strong_versions (0.4.5)
       i18n (>= 0.5)
       paint (~> 2.0)
-    unicode-display_width (1.8.0)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 2.0)
-  byebug (~> 11.0)
-  devpack (~> 0.1.2)
+  devpack (~> 0.4.0)
   i18n (~> 1.7)
   rake (~> 13.0)
   rspec-html!
   rspec-its (~> 1.3)
-  rubocop (~> 0.93.1)
-  rubocop-rspec (~> 1.36)
+  rubocop (~> 1.29)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.10)
   strong_versions (~> 0.4.5)
 
 BUNDLED WITH
-   2.1.4
+   2.3.11

data/README.md

@@ -7,7 +7,7 @@ _RSpec::HTML_ provides a simple object interface to HTML responses from [_RSpec
 Add the gem to your `Gemfile`:
 
 ```ruby
-gem 'rspec-html', '~> 0.2.7'
+gem 'rspec-html', '~> 0.2.10'
 ```
 
 And rebuild your bundle:
@@ -41,6 +41,11 @@ it 'says hello' do
 end
 ```
 
+This method can also be used for _ActionMailer_ emails:
+```ruby
+before { parse_html(ActionMailer::Base.deliveries.last.body.decoded) }
+```
+
 To navigate the _DOM_ by a sequence of tag names use chained method calls on the `document` object:
 
 #### Tag Traversal
@@ -63,6 +68,17 @@ expect(document.body.div(id: 'my-div').span(class: 'my-class my-other-class')).t
 
 Classes can be provided in any order, i.e. `'my-class my-other-class'` is equivalent to `'my-other-class my-class'`.
 
+#### Simple CSS Matching
+To use a simple CSS selector when no other attributes are needed, pass a string to the tag method:
+```ruby
+expect(document.body.div('#my-id.my-class1.my-class2')).to contain_text 'some text'
+```
+
+This is effectively shorthand for:
+```ruby
+expect(document.body.div(id: 'my-id', class: 'my-class1 my-class2')).to contain_text 'some text'
+```
+
 #### Text Matching
 To select an element that includes a given text string (i.e. excluding mark-up) use the `text` option:
 ```ruby
@@ -112,12 +128,15 @@ expect(document.body).to have_xpath '//html/body/div[@class="myclass"]'
 ### Custom Matchers
 <a name="matchers"></a>
 
-#### contain_text
+#### match_text
+
+Use the `match_text` matcher to locate text within a _DOM_ element. All mark-up elements are stripped when using this matcher.
 
-Use the `contain_text` matcher to locate text within a _DOM_ element. All mark-up elements are stripped when using this matcher.
+This matcher receives either a string or a regular expression.
 
 ```ruby
-expect(document.body.form).to contain_text 'Please enter your password'
+expect(document.body.form).to match_text 'Please enter your password'
+expect(document.body.form).to match_text /Please enter your [a-z]+/
 ```
 
 #### contain_tag

data/lib/rspec/html/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module HTML
-    VERSION = '0.2.7'
+    VERSION = '0.2.10'
   end
 end

data/lib/rspec_html/matchers/contain_text.rb

@@ -2,13 +2,15 @@
 
 module RSpecHTML
   module Matchers
-    # Matches text within a given DOM element.
+    # Matches text within a given DOM element (strips HTML tags and compares text content only).
+    # (Deprecated in favour of `#match_text`.
     class ContainText
       include Base
 
       diffable
 
       def match(actual)
+        warn('[rspec-html] The `contain_text` matcher is deprecated. Use `match_text` instead.')
         @rspec_actual = actual&.text
         (actual&.text || '').include?(@expected.to_s)
       end

data/lib/rspec_html/matchers/match_text.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RSpecHTML
+  module Matchers
+    # Matches text or regex within a given DOM element (strips HTML tags and compares text content only).
+    class MatchText
+      include Base
+
+      diffable
+
+      def match(actual)
+        @rspec_actual = actual&.text
+        return (actual&.text || '').include?(@expected.to_s) unless @expected.is_a?(Regexp)
+
+        @expected.match(actual&.text || '')
+      end
+    end
+  end
+end

data/lib/rspec_html/matchers.rb

@@ -3,6 +3,7 @@
 require 'rspec_html/matchers/base'
 require 'rspec_html/matchers/contain_text'
 require 'rspec_html/matchers/contain_tag'
+require 'rspec_html/matchers/match_text'
 
 module RSpecHTML
   # Provides matchers for identifying elements and text within a DOM element.
@@ -29,5 +30,6 @@ module RSpecHTML
 
     define_matcher(:contain_text, ContainText)
     define_matcher(:contain_tag, ContainTag)
+    define_matcher(:match_text, MatchText)
   end
 end

data/lib/rspec_html/reconstituted_element.rb

@@ -12,6 +12,7 @@ module RSpecHTML
       name = @tag.to_s.downcase
       return '#document' if name == 'document'
       return name if name == 'document'
+      return "<#{name}#{@options} />" if @options.is_a?(String)
       return "<#{name}#{formatted_attributes} />" unless @options&.key?(:text)
 
       "<#{name}#{formatted_attributes}>#{@options[:text]}</#{name}>"

data/lib/rspec_html/search.rb

@@ -2,6 +2,7 @@
 
 module RSpecHTML
   # Provides element/attribute/text searching for HTML entities
+  # rubocop:disable Metrics/ClassLength
   class Search
     def initialize(element, siblings)
       @element = element
@@ -56,7 +57,7 @@ module RSpecHTML
     def size
       return @element.size if @element.respond_to?(:size)
 
-      @siblings.size
+      @siblings&.size || 0
     end
     alias length size
 
@@ -95,17 +96,23 @@ module RSpecHTML
     end
 
     def where(tag, query, all: false)
-      matched = if query[:class]
-                  where_class(tag, query[:class]) & where_xpath(tag, query.merge(class: nil))
-                else
-                  where_xpath(tag, query)
-                end
+      matched = matched_from_query(tag, query)
       return nil unless matched || all
       return matched&.first unless all
 
       matched
     end
 
+    def matched_from_query(tag, query)
+      if query.is_a?(String)
+        @element&.css("#{tag}#{query}")
+      elsif query[:class]
+        where_class(tag, query[:class]) & where_xpath(tag, query.merge(class: nil))
+      else
+        where_xpath(tag, query)
+      end
+    end
+
     def where_xpath(tag, query)
       conditions = "[#{where_conditions(query)}]" unless query.compact.empty?
       @element&.xpath("//#{tag}#{conditions}")
@@ -132,4 +139,5 @@ module RSpecHTML
       @element&.css(tag.to_s)
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/rspec_html.rb

@@ -15,6 +15,7 @@ require 'rspec_html/matchers'
 module RSpecHTML
   class Error < StandardError; end
   class NoResponseError < Error; end
+
   def self.root
     Pathname.new(__dir__).parent
   end

data/rspec-html.gemspec

@@ -28,16 +28,18 @@ Gem::Specification.new do |spec|
   spec.executables   = []
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.6'
   spec.add_dependency 'nokogiri', '~> 1.10'
   spec.add_dependency 'rspec', '~> 3.0'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'byebug', '~> 11.0'
-  spec.add_development_dependency 'devpack', '~> 0.1.2'
+  spec.add_development_dependency 'devpack', '~> 0.4.0'
   spec.add_development_dependency 'i18n', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec-its', '~> 1.3'
-  spec.add_development_dependency 'rubocop', '~> 0.93.1'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.36'
+  spec.add_development_dependency 'rubocop', '~> 1.29'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.10'
   spec.add_development_dependency 'strong_versions', '~> 0.4.5'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/templates/description/match_text.erb

@@ -0,0 +1 @@
+match text <%= expected.inspect %>

data/templates/failure/match_text.erb

@@ -0,0 +1,5 @@
+<% unless actual.exist? %>
+Expected <%= actual.reconstituted %> to match <%= expected.inspect %> but the element did not exist.
+<% else %>
+Expected text in <%= actual.reconstituted %> <%= (actual.truncated_text).inspect %> to match <%= expected.inspect %> but it did not.
+<% end %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-html
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.10
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-16 00:00:00.000000000 Z
+date: 2022-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -52,34 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: devpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -128,28 +114,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.93.1
+        version: '1.29'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.93.1
+        version: '1.29'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.36'
+        version: '2.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.36'
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: strong_versions
   requirement: !ruby/object:Gem::Requirement
@@ -192,14 +192,17 @@ files:
 - lib/rspec_html/matchers/base.rb
 - lib/rspec_html/matchers/contain_tag.rb
 - lib/rspec_html/matchers/contain_text.rb
+- lib/rspec_html/matchers/match_text.rb
 - lib/rspec_html/reconstituted_element.rb
 - lib/rspec_html/search.rb
 - lib/rspec_html/tags.rb
 - rspec-html.gemspec
 - templates/description/contain_tag.erb
 - templates/description/contain_text.erb
+- templates/description/match_text.erb
 - templates/failure/contain_tag.erb
 - templates/failure/contain_text.erb
+- templates/failure/match_text.erb
 homepage: https://github.com/bobf/rspec-html
 licenses:
 - MIT
@@ -207,6 +210,7 @@ metadata:
   homepage_uri: https://github.com/bobf/rspec-html
   source_code_uri: https://github.com/bobf/rspec-html
   changelog_uri: https://github.com/bobf/rspec-html/blob/master/LICENSE
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -215,14 +219,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3.1
 signing_key:
 specification_version: 4
 summary: RSpec HTML