rspec-html 0.2.6 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b613fed0b8e19c8069435ab30d735afa9660c66bb7beb6ee226aede70014f0e
-  data.tar.gz: c3526928723a917ed6511d3e17e6627df79090d342203e78fa64ab84e174a309
+  metadata.gz: 152d9f0198dc22aa14461a8814b98d3be18e663e1b9b95206247cdc3c99ffdf7
+  data.tar.gz: ea64b6dafe91b0e13a46e3231a493c0a2b7097458ac02b28d5599639dc3f585f
 SHA512:
-  metadata.gz: f3e0dfbd5105659467f468131d7ea32baaf94e406af8dbef7e521ff762572479ad0394ee69474e1fc2f510e493d62d5981cb32b9756665b63af9c7d12220750d
-  data.tar.gz: 8cbc3b3579dee20f89d55de6b6e8221f1a32e73b67e3b875a18b8b604d579a12e46d835d63cc14c0c4453022a888f3b44b92d2c7ab97c08299945eb7538382cd
+  metadata.gz: 728cc6614e604366f38f90d85e93d9822480bbe56b7542810c4887d1723db4b2d39963b8c77a7d5415b5a8fe21489df56135c13630442f2201d18ba4bc2d01a3
+  data.tar.gz: b77a735db02261431fea9caabf7d3674c7365198709167780761a983e8175a11ce7d770d81c75202b23a719c8faf110559321fff305f4ccb1eba527176c1d763

data/.rubocop.yml

@@ -3,85 +3,9 @@ Metrics/BlockLength:
     - 'spec/**/*'
     - 'rspec-html.gemspec'
 
-Gemspec/RequiredRubyVersion:
-  Enabled: false
-
-Layout/LineLength:
-  Max: 100
+AllCops:
+  NewCops: enable
 
 # Compatibility with older (< 2.6) Rubies.
 Style/SlicingWithRange:
   Enabled: false
-
-Layout/EmptyLinesAroundAttributeAccessor:
-  Enabled: true
-Layout/SpaceAroundMethodCallOperator:
-  Enabled: true
-Lint/DeprecatedOpenSSLConstant:
-  Enabled: true
-Lint/DuplicateElsifCondition:
-  Enabled: true
-Lint/MixedRegexpCaptureTypes:
-  Enabled: true
-Lint/RaiseException:
-  Enabled: true
-Lint/StructNewOverride:
-  Enabled: true
-Style/AccessorGrouping:
-  Enabled: true
-Style/ArrayCoercion:
-  Enabled: true
-Style/BisectedAttrAccessor:
-  Enabled: true
-Style/CaseLikeIf:
-  Enabled: true
-Style/ExponentialNotation:
-  Enabled: true
-Style/HashAsLastArrayItem:
-  Enabled: true
-Style/HashEachMethods:
-  Enabled: true
-Style/HashLikeCase:
-  Enabled: true
-Style/HashTransformKeys:
-  Enabled: true
-Style/HashTransformValues:
-  Enabled: true
-Style/RedundantAssignment:
-  Enabled: true
-Style/RedundantFetchBlock:
-  Enabled: true
-Style/RedundantFileExtensionInRequire:
-  Enabled: true
-Style/RedundantRegexpCharacterClass:
-  Enabled: true
-Style/RedundantRegexpEscape:
-  Enabled: true
-Lint/BinaryOperatorWithIdenticalOperands:
-  Enabled: true
-Lint/DuplicateRescueException:
-  Enabled: true
-Lint/EmptyConditionalBody:
-  Enabled: true
-Lint/FloatComparison:
-  Enabled: true
-Lint/MissingSuper:
-  Enabled: true
-Lint/OutOfRangeRegexpRef:
-  Enabled: true
-Lint/SelfAssignment:
-  Enabled: true
-Lint/TopLevelReturnWithArgument:
-  Enabled: true
-Lint/UnreachableLoop:
-  Enabled: true
-Style/ExplicitBlockArgument:
-  Enabled: true
-Style/GlobalStdStream:
-  Enabled: true
-Style/OptionalBooleanParameter:
-  Enabled: true
-Style/SingleArgumentDig:
-  Enabled: true
-Style/StringConcatenation:
-  Enabled: true

data/.ruby-version

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

data/Gemfile.lock

@@ -1,80 +1,81 @@
 PATH
   remote: .
   specs:
-    rspec-html (0.2.5)
+    rspec-html (0.2.9)
       nokogiri (~> 1.10)
       rspec (~> 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.1)
-    byebug (11.1.3)
-    concurrent-ruby (1.1.6)
-    devpack (0.1.2)
-    diff-lcs (1.4.4)
-    i18n (1.8.5)
+    ast (2.4.2)
+    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.4.0)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
-    paint (2.2.0)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    nokogiri (1.13.6-x86_64-linux)
+      racc (~> 1.4)
+    paint (2.2.1)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.7.1)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    racc (1.6.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.3.1)
+    rexml (3.2.5)
+    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.9.0)
+      rspec-support (~> 3.11.0)
     rspec-its (1.3.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.9.1)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.89.1)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.29.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
-      rexml
-      rubocop-ast (>= 0.3.0, < 1.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 (0.3.0)
-      parser (>= 2.7.1.4)
-    rubocop-rspec (1.42.0)
-      rubocop (>= 0.87.0)
-    ruby-progressbar (1.10.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.7.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.89.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.6'
+gem 'rspec-html', '~> 0.2.9'
 ```
 
 And rebuild your bundle:
@@ -63,6 +63,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 +123,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.6'
+    VERSION = '0.2.9'
   end
 end

data/lib/rspec_html/element.rb

@@ -8,7 +8,7 @@ module RSpecHTML
     extend Forwardable
 
     def_delegators :@search,
-                   :has_css?, :has_xpath?, :include?, :text, :truncated_text, :size, :length, :[]
+                   :has_css?, :has_xpath?, :include?, :text, :truncated_text, :size, :length, :css, :xpath, :[]
 
     def initialize(element, name, options: {}, siblings: [])
       @name = name

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
@@ -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.89.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.6
+  version: 0.2.9
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-09 00:00:00.000000000 Z
+date: 2022-05-28 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.89.1
+        version: '1.29'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.89.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