rspec-html 0.1.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 413a58c112d2fbb3af070285d637a63c860b6bcb66c4a4370f253c387d600cf5
-  data.tar.gz: ecef355b3d1e0c766b76c2107298fdff7eca6b508b80fefecc2b01847ebb8f1f
+  metadata.gz: cf565ab0af76a2408b1185d8516aa6a18ac94bdf3521bd76235ffeab2cf85c84
+  data.tar.gz: cceb245c801bb10e3a84d942a8101014a585ac5b00e958bd682b6b0a3599143a
 SHA512:
-  metadata.gz: c142dad521ba1f3b5ef4b789954d64eb0ae8b8a58ad437f3c73bf3341f167593eb0b7ea1a14b46c83994d536ece5f44a1a10f18c01e8d01f9822ec86cc7e3737
-  data.tar.gz: 1d83c8fb486c4bc71da176760f29e9ed631fd9e02ac26531e40114ed4169ad4e556a42c6d0cbd2f2bbc4933b49b63897c3f8248a7078d8d485aff0ed3e704018
+  metadata.gz: 07ea3aedf2366de58c8c39af7ff8fcf17ff273ea1df71799215a0f19fdd029a0e32a8517b154e140175b6211d258d6376ef4faa40fdcb645ca4183196a4cec96
+  data.tar.gz: ca57887c542a4817181d1da196fc05f9739be992aa7a10b2cdb7aae293d066ddfc6c2009aeb204cfc315ac2745ef36ac1792fa29b22f11a09cb02cb441a7d14b

data/.rubocop.yml

@@ -2,3 +2,84 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
     - 'rspec-html.gemspec'
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 100
+
+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
+Style/SlicingWithRange:
+  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/Gemfile.lock

@@ -1,38 +1,38 @@
 PATH
   remote: .
   specs:
-    rspec-html (0.1.2)
+    rspec-html (0.2.3)
       nokogiri (~> 1.10)
       rspec (~> 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    betterp (0.1.3)
-      paint (~> 2.0)
-    byebug (11.0.1)
-    concurrent-ruby (1.1.5)
-    diff-lcs (1.3)
-    i18n (1.7.0)
+    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)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
     mini_portile2 (2.4.0)
-    nokogiri (1.10.9)
+    nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
-    paint (2.1.1)
-    parallel (1.19.1)
-    parser (2.6.5.0)
-      ast (~> 2.4.0)
+    paint (2.2.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (10.5.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.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-its (1.3.0)
@@ -41,36 +41,40 @@ GEM
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
-    rubocop (0.76.0)
-      jaro_winkler (~> 1.5.1)
+    rspec-support (3.9.3)
+    rubocop (0.89.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-rspec (1.36.0)
-      rubocop (>= 0.68.1)
+      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)
-    strong_versions (0.3.2)
-      i18n (>= 0.5.0)
+    strong_versions (0.4.5)
+      i18n (>= 0.5)
       paint (~> 2.0)
-    unicode-display_width (1.6.0)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  betterp (~> 0.1.3)
   bundler (~> 2.0)
   byebug (~> 11.0)
+  devpack (~> 0.1.2)
   i18n (~> 1.7)
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec-html!
   rspec-its (~> 1.3)
-  rubocop (~> 0.76.0)
+  rubocop (~> 0.89.1)
   rubocop-rspec (~> 1.36)
-  strong_versions (~> 0.3.2)
+  strong_versions (~> 0.4.5)
 
 BUNDLED WITH
    2.0.2

data/README.md

@@ -4,18 +4,17 @@ _RSpec::HTML_ provides a simple object interface to HTML responses from [_RSpec
 
 ## Installation
 
+Add the gem to your `Gemfile`:
+
 ```ruby
-gem 'rspec-html', '~> 0.1.2'
+gem 'rspec-html', '~> 0.2.3'
 ```
 
-Bundle
-And then execute:
-
-    $ bundle
+And rebuild your bundle:
 
-Or install it yourself as:
-
-    $ gem install rspec-html
+```bash
+$ bundle install
+```
 
 ## Usage
 
@@ -26,19 +25,118 @@ Require the gem in your `spec_helper.rb`:
 require 'rspec/html'
 ```
 
-In request specs, access the HTML document through the provided object interface:
+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).
+
+### Object Interface
+<a name="object-interface"></a>
+
+The top-level object `document` is available in all tests which reflects the current response body (e.g. in request specs).
+
+If you need to parse _HTML_ manually you can use the provided `parse_html` helper and then access `document` as normal:
 
 ```ruby
-RSpec.describe 'something', type: :request do
-  it 'does something' do
-    get '/'
-    expect(document.body).to include 'something'
-    expect(document.body).to have_css 'html body div.myclass'
-    expect(document.body).to have_xpath '//html/body/div[@class="myclass"]'
-  end
+before { parse_html('<html><body>hello</body></html>') }
+it 'says hello' do
+  expect(document.body).to contain_text 'hello'
 end
 ```
 
+To navigate the _DOM_ by a sequence of tag names use chained method calls on the `document` object:
+
+#### Tag Traversal
+```ruby
+expect(document.body.div.span).to contain_text 'some text'
+```
+
+#### Attribute Matching
+To select an element matching certain attributes pass a hash to any of the chained methods:
+```ruby
+expect(document.body.div(id: 'my-div').span(align: 'left')).to contain_text 'some text'
+```
+
+#### Class Matching
+_CSS_ classes are treated as a special case: to select an element matching a set of classes pass the `class` parameter:
+```ruby
+expect(document.body.div(id: 'my-div').span(class: 'my-class')).to contain_text 'some text'
+expect(document.body.div(id: 'my-div').span(class: 'my-class my-other-class')).to contain_text 'some text'
+```
+
+Classes can be provided in any order, i.e. `'my-class my-other-class'` is equivalent to `'my-other-class my-class'`.
+
+#### Text Matching
+To select an element that includes a given text string (i.e. excluding mark-up) use the `text` option:
+```ruby
+expect(document.body.div(text: 'some text').input[:value]).to eql 'some-value'
+```
+
+#### Attribute Retrieval
+To select an attribute from an element use the hash-style interface:
+```ruby
+expect(document.body.div.span[:class]).to contain_text 'my-class'
+expect(document.body.div.span['data-content']).to contain_text 'my content'
+```
+
+#### Indexing a Matching Set
+To select an index from a set of matched elements use the array-style interface (the first matching element is `1`, not `0`):
+```ruby
+expect(document.body.div[1].span[1][:class]).to contain_text 'my-class'
+```
+
+#### Element Existence
+To test if a matching element was found use the `exist` matcher:
+```ruby
+expect(document.body.div[1]).to exist
+expect(document.body.div[4]).to_not exist
+```
+
+#### Length of matched attributes
+To test the length of matched elements use the `#size` or `#length` method:
+```ruby
+expect(document.body.div.size).to eql 3
+expect(document.body.div.length).to eql 3
+```
+
+#### XPath / CSS Selectors
+If you need something more specific you can always use the _Nokogiri_ `#xpath` and `#css` methods on any element:
+```ruby
+expect(document.body.xpath('//span[@class="my-class"]')).to contain_text 'some text'
+expect(document.body.css('span.my-class')).to contain_text 'some text'
+```
+
+To simply check that an _XPath_ or _CSS_ selector exists use `have_xpath` and `have_css`:
+```ruby
+expect(document.body).to have_css 'html body div.myclass'
+expect(document.body).to have_xpath '//html/body/div[@class="myclass"]'
+```
+
+### Custom Matchers
+<a name="matchers"></a>
+
+#### contain_text
+
+Use the `contain_text` matcher to locate text within a _DOM_ element. All mark-up elements are stripped when using this matcher.
+
+```ruby
+expect(document.body.form).to contain_text 'Please enter your password'
+```
+
+#### contain_tag
+
+Use the `contain_tag` matcher to locate _DOM_ elements within any given element. This matcher accepts two arguments:
+
+* The tag name of the element you want to match (e.g. `:div`);
+* _(Optional)_ A hash of options. All options supported by the [object interface](#object-interface) can be used here.
+
+Without options:
+```ruby
+expect(document.div(class: 'my-class')).to contain_tag :span
+```
+
+With options:
+```ruby
+expect(document.form(class: 'my-form')).to contain_tag :input, name: 'email', class: 'email-input'
+```
+
 ## Contributing
 
 Feel free to make a pull request.

data/lib/rspec/html.rb

@@ -9,7 +9,17 @@ module RSpec
   # Module extension for RSpec::SharedContext
   module HTML
     def document
-      RSpecHTML::Document.new(response.body)
+      return @document if @document
+
+      if !defined?(response) || response.nil?
+        raise RSpecHTML::NoResponseError, 'No `response` object found. Make a request first.'
+      end
+
+      RSpecHTML::Element.new(Nokogiri::HTML.parse(response.body), :document)
+    end
+
+    def parse_html(content)
+      @document = RSpecHTML::Element.new(Nokogiri::HTML.parse(content), :document)
     end
   end
 end

data/lib/rspec/html/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module HTML
-    VERSION = '0.1.2'
+    VERSION = '0.2.3'
   end
 end

data/lib/rspec_html.rb

@@ -1,18 +1,23 @@
 # frozen_string_literal: true
 
 require 'nokogiri'
+
 require 'pathname'
+require 'forwardable'
 
-require 'rspec_html/nameable'
-require 'rspec_html/searchable'
-require 'rspec_html/body'
-require 'rspec_html/document'
-require 'rspec_html/head'
-require 'rspec_html/title'
+require 'rspec_html/tags'
+require 'rspec_html/element'
+require 'rspec_html/search'
+require 'rspec_html/reconstituted_element'
+require 'rspec_html/matchers'
 
 # Support module for rspec/html
 module RSpecHTML
+  class Error < StandardError; end
+  class NoResponseError < Error; end
   def self.root
     Pathname.new(__dir__).parent
   end
 end
+
+RSpec.configure { |config| config.include RSpecHTML::Matchers }

data/lib/rspec_html/element.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RSpecHTML
+  # HTML DOM element abstraction
+  class Element
+    attr_reader :name, :element
+
+    extend Forwardable
+
+    def_delegators :@search,
+                   :has_css?, :has_xpath?, :include?, :present?, :exist?,
+                   :text, :size, :length, :[]
+
+    def initialize(element, name, options: {}, siblings: [])
+      @name = name
+      @element = element
+      @options = options
+      @siblings = siblings
+      @search = Search.new(@element, @siblings)
+    end
+
+    def inspect
+      "<#{self.class}::#{name.to_s.capitalize}>"
+    end
+
+    def to_s
+      @element.to_s
+    end
+
+    Tags.each do |tag|
+      define_method tag.downcase do |*args|
+        options = args.first
+        return @search.new_from_find(tag.downcase, options) if options.nil?
+
+        @search.new_from_where(tag.downcase, options)
+      end
+    end
+
+    def reconstituted
+      self.class.reconstituted(name, @options)
+    end
+
+    def self.reconstituted(tag, options = {})
+      ReconstitutedElement.new(tag, options).to_s
+    end
+  end
+end

data/lib/rspec_html/matchers.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'rspec_html/matchers/base'
+require 'rspec_html/matchers/contain_text'
+require 'rspec_html/matchers/contain_tag'
+
+module RSpecHTML
+  # Provides matchers for identifying elements and text within a DOM element.
+  module Matchers
+    extend RSpec::Matchers::DSL
+    extend RSpec::Matchers::DSL::Macros
+
+    # rubocop:disable Metrics/MethodLength
+    def self.define_matcher(name, class_)
+      matcher name do |expected, options|
+        rspec_html_matcher = class_.new(expected, options || {})
+        match do |actual|
+          rspec_html_matcher
+            .save_actual(actual)
+            .match(actual)
+            .tap { @actual = rspec_html_matcher.rspec_actual }
+        end
+        description { rspec_html_matcher.description }
+        failure_message { rspec_html_matcher.failure_message }
+        diffable if class_.diffable?
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    define_matcher(:contain_text, ContainText)
+    define_matcher(:contain_tag, ContainTag)
+  end
+end

data/lib/rspec_html/matchers/base.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module RSpecHTML
+  module Matchers
+    # Mix-in class to provide a uniform interface and message templating for all matchers.
+    module Base
+      def self.included(base)
+        base.class_eval do
+          class << self
+            def diffable
+              @diffable = true
+            end
+
+            def diffable?
+              @diffable
+            end
+          end
+        end
+      end
+
+      attr_reader :rspec_actual
+
+      def initialize(expected, options)
+        @expected = expected
+        @options = options
+      end
+
+      def description
+        template(:description, @options, @expected)
+      end
+
+      def failure_message
+        template(:failure, @options, @expected, @actual)
+      end
+
+      def save_actual(actual)
+        @actual = actual
+        self
+      end
+
+      def reconstituted(element, options)
+        RSpecHTML::Element.reconstituted(element, options)
+      end
+
+      private
+
+      def template(type, options, expected, actual = nil)
+        ERB.new(template_path(type).read).result(binding)
+      end
+
+      def template_path(type)
+        RSpecHTML.root.join('templates', type.to_s, "#{filename}.erb")
+      end
+
+      def filename
+        _, _, name = self.class.name.rpartition('::')
+        (name[0] + name[1..].gsub(/(.)([A-Z])/, '\1_\2')).downcase
+      end
+    end
+  end
+end

data/lib/rspec_html/matchers/contain_tag.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RSpecHTML
+  module Matchers
+    # Matches elements within a given DOM element.
+    class ContainTag
+      include Base
+
+      def match(actual)
+        @actual = actual.to_s
+        actual.public_send(@expected, @options).present?
+      end
+    end
+  end
+end

data/lib/rspec_html/matchers/contain_text.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RSpecHTML
+  module Matchers
+    # Matches text within a given DOM element.
+    class ContainText
+      include Base
+
+      diffable
+
+      def match(actual)
+        @rspec_actual = actual&.text
+        (actual&.text || '').include?(@expected.to_s)
+      end
+    end
+  end
+end

data/lib/rspec_html/reconstituted_element.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RSpecHTML
+  # Reconstructs an HTML representation of an element from provided parameters.
+  class ReconstitutedElement
+    def initialize(tag, options)
+      @tag = tag
+      @options = options
+    end
+
+    def to_s
+      name = @tag.to_s.downcase
+      return '#document' if name == 'document'
+      return name if name == 'document'
+      return "<#{name}#{formatted_attributes} />" unless @options&.key?(:text)
+
+      "<#{name}#{formatted_attributes}>#{@options[:text]}</#{name}>"
+    end
+
+    private
+
+    def mapped_attributes
+      return [] if @options.nil?
+
+      @options.reject { |key| key.to_sym == :text }.map do |key, value|
+        next %(#{key}="#{value}") unless key.to_sym == :class && value.is_a?(Array)
+
+        %(#{key}="#{value.join(' ')}")
+      end
+    end
+
+    def formatted_attributes
+      mapped_attributes.empty? ? nil : " #{mapped_attributes.join(' ')}"
+    end
+  end
+end

data/lib/rspec_html/search.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module RSpecHTML
+  # Provides element/attribute/text searching for HTML entities
+  class Search
+    def initialize(element, siblings)
+      @element = element
+      @siblings = siblings
+    end
+
+    def include?(val)
+      text.include?(val)
+    end
+
+    def css(*args)
+      self.class.new(@element&.css(*args), :css)
+    end
+
+    def xpath(*args)
+      self.class.new(@element&.xpath(*args), :xpath)
+    end
+
+    def present?
+      !@element.nil?
+    end
+    alias exist? present?
+
+    # rubocop:disable Naming/PredicateName
+    def has_css?(*args)
+      !@element&.css(*args)&.empty?
+    end
+
+    def has_xpath?(*args)
+      !@element&.xpath(*args)&.empty?
+    end
+    # rubocop:enable Naming/PredicateName
+
+    def [](val)
+      return index(val) if val.is_a?(Integer)
+      return range(val) if val.is_a?(Range)
+
+      @element&.attr(val.to_s)
+    end
+
+    def text
+      @element&.text&.gsub(/\s+/, ' ')&.strip || ''
+    end
+
+    def size
+      return @element.size if @element.respond_to?(:size)
+
+      @siblings.size
+    end
+    alias length size
+
+    def new_from_find(tag, options)
+      Element.new(
+        find(tag),
+        tag,
+        options: options,
+        siblings: find(tag, all: true)
+      )
+    end
+
+    def new_from_where(tag, options)
+      Element.new(
+        where(tag, options),
+        tag,
+        options: options,
+        siblings: where(tag, options, all: true)
+      )
+    end
+
+    private
+
+    def index(val)
+      zero_index_error if val.zero?
+      self.class.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)
+    end
+
+    def zero_index_error
+      raise ArgumentError, 'Index for matched sets starts at 1, not 0.'
+    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
+      return matched&.first unless all
+
+      matched
+    end
+
+    def where_xpath(tag, query)
+      conditions = "[#{where_conditions(query)}]" unless query.compact.empty?
+      @element&.xpath("//#{tag}#{conditions}")
+    end
+
+    def where_conditions(query)
+      query.compact.map do |key, value|
+        next if value.nil?
+        next %(@#{key}="#{value}") unless key == :text
+
+        %[contains(text(),"#{value}")]
+      end.join ' and '
+    end
+
+    def where_class(tag, class_or_classes)
+      classes = class_or_classes.is_a?(Array) ? class_or_classes : class_or_classes.to_s.split
+      selector = classes.map(&:to_s).join('.')
+      @element&.css("#{tag}.#{selector}")
+    end
+
+    def find(tag, all: false)
+      return @element&.css(tag.to_s)&.first unless all
+
+      @element&.css(tag.to_s)
+    end
+  end
+end

data/lib/rspec_html/tags.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RSpecHTML
+  # HTML tag identification, used to determine viability for DOM traversal via chained methods.
+  class Tags
+    def self.include?(val)
+      tags.include?(val.to_s.upcase)
+    end
+
+    def self.each(&block)
+      tags.each { |tag| block.call(tag) }
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def self.tags
+      %w[
+        A ABBR ACRONYM ADDRESS APPLET AREA ARTICLE ASIDE AUDIO B BASE BASEFONT BDI BDO BGSOUND
+        BIG BLINK BLOCKQUOTE BODY BR BUTTON CANVAS CAPTION CENTER CITE CODE COL COLGROUP COMMAND
+        CONTENT DATA DATALIST DD DEL DETAILS DFN DIALOG DIR DIV DL DT ELEMENT EM EMBED FIELDSET
+        FIGCAPTION FIGURE FONT FOOTER FORM FRAME FRAMESET H1 H2 H3 H4 H5 H6 HEAD HEADER HGROUP HR
+        HTML I IFRAME IMAGE IMG INPUT INS ISINDEX KBD KEYGEN LABEL LEGEND LI LINK LISTING MAIN
+        MAIN MAP MARK MARQUEE MENU MENUITEM META METER MULTICOL NAV NEXTID NOBR NOEMBED NOFRAMES
+        NOSCRIPT OBJECT OL OPTGROUP OPTION OUTPUT P PARAM PICTURE PLAINTEXT PRE PROGRESS Q RB RP
+        RT RTC RUBY S SAMP SCRIPT SECTION SELECT SHADOW SLOT SMALL SOURCE SPACER SPAN STRIKE
+        STRONG STYLE SUB SUMMARY SUP TABLE TBODY TD TEMPLATE TEXTAREA TFOOT TH THEAD TIME TITLE
+        TR TRACK TT U UL VAR VIDEO WBR XMP
+      ]
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/rspec-html.gemspec

@@ -31,13 +31,13 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'nokogiri', '~> 1.10'
   spec.add_dependency 'rspec', '~> 3.0'
 
-  spec.add_development_dependency 'betterp', '~> 0.1.3'
   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 'i18n', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec-its', '~> 1.3'
-  spec.add_development_dependency 'rubocop', '~> 0.76.0'
+  spec.add_development_dependency 'rubocop', '~> 0.89.1'
   spec.add_development_dependency 'rubocop-rspec', '~> 1.36'
-  spec.add_development_dependency 'strong_versions', '~> 0.3.2'
+  spec.add_development_dependency 'strong_versions', '~> 0.4.5'
 end

data/templates/description/contain_tag.erb

@@ -0,0 +1 @@
+contain tag <%= RSpecHTML::Element.reconstituted(expected, @options) %>

data/templates/description/contain_text.erb

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

data/templates/failure/contain_tag.erb

@@ -0,0 +1,5 @@
+<% if actual.element.nil? %>
+Expected <%= reconstituted(actual, @options) %> to contain <%= reconstituted(expected, @options) %> but the element did not exist.
+<% else %>
+Expected <%= reconstituted(actual, @options) %> to contain <%= reconstituted(expected, @options) %> but it did not.
+<% end %>

data/templates/failure/contain_text.erb

@@ -0,0 +1,5 @@
+<% if actual.element.nil? %>
+Expected <%= actual.reconstituted %> to contain <%= expected.inspect %> but the element did not exist.
+<% else %>
+Expected text in <%= actual.reconstituted %> <%= (actual.text&.strip || '').inspect %> to contain <%= 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.1.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Bob Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-27 00:00:00.000000000 Z
+date: 2020-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -39,47 +39,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: betterp
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: devpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: 0.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.76.0
+        version: 0.89.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.76.0
+        version: 0.89.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: 0.4.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: 0.4.5
 description: HTML document abstraction and matchers for RSpec
 email:
 - git@bob.frl
@@ -187,13 +187,19 @@ files:
 - lib/rspec/html.rb
 - lib/rspec/html/version.rb
 - lib/rspec_html.rb
-- lib/rspec_html/body.rb
-- lib/rspec_html/document.rb
-- lib/rspec_html/head.rb
-- lib/rspec_html/nameable.rb
-- lib/rspec_html/searchable.rb
-- lib/rspec_html/title.rb
+- lib/rspec_html/element.rb
+- lib/rspec_html/matchers.rb
+- lib/rspec_html/matchers/base.rb
+- lib/rspec_html/matchers/contain_tag.rb
+- lib/rspec_html/matchers/contain_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/failure/contain_tag.erb
+- templates/failure/contain_text.erb
 homepage: https://github.com/bobf/rspec-html
 licenses:
 - MIT

data/lib/rspec_html/body.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module RSpecHTML
-  # HTML/BODY abstraction
-  class Body
-    include Searchable
-    include Nameable
-
-    def initialize(parsed_html)
-      @name = :body
-      @entity = parsed_html.css('body')
-    end
-  end
-end

data/lib/rspec_html/document.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module RSpecHTML
-  # HTML Document representation
-  class Document
-    def initialize(html)
-      @html = html
-    end
-
-    # rubocop:disable Naming/PredicateName
-    def has_xpath?(*args)
-      !parsed_html.xpath(*args).empty?
-    end
-
-    def has_css?(*args)
-      !parsed_html.css(*args).empty?
-    end
-    # rubocop:enable Naming/PredicateName
-
-    def body
-      Body.new(parsed_html)
-    end
-
-    def head
-      Head.new(parsed_html)
-    end
-
-    private
-
-    def parsed_html
-      @parsed_html ||= Nokogiri::HTML(@html)
-    end
-  end
-end

data/lib/rspec_html/head.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module RSpecHTML
-  # HTML/BODY abstraction
-  class Head
-    include Nameable
-
-    def initialize(parsed_html)
-      @parsed_html = parsed_html
-      @entity = parsed_html.css('head')
-      @name = :head
-    end
-
-    def title
-      Title.new(@parsed_html)
-    end
-
-    def include?(val)
-      title.include?(val)
-    end
-  end
-end

data/lib/rspec_html/nameable.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module RSpecHTML
-  # Mixin module providing methods allowing an entity to specify its name
-  module Nameable
-    attr_reader :name
-  end
-end

data/lib/rspec_html/searchable.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module RSpecHTML
-  # Mixin module providing methods for searching text content of HTML entities
-  module Searchable
-    def include?(val)
-      @entity.text.include?(val)
-    end
-
-    def to_s
-      @entity.text.strip
-    end
-
-    def inspect
-      %("#{self}")
-    end
-  end
-end

data/lib/rspec_html/title.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module RSpecHTML
-  # HTML/HEAD/TITLE abstraction
-  class Title
-    include Searchable
-    include Nameable
-
-    def initialize(parsed_html)
-      @name = :title
-      @entity = parsed_html.css('head title')
-    end
-  end
-end