rspec-html 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffb46cc469517211466583fd590e8d77a39368eba859513771a43438508c3985
-  data.tar.gz: db46d8cc7a56d00e91517d8df9465d7c5915f82d4fc35b9314ba02f043921c1b
+  metadata.gz: cf565ab0af76a2408b1185d8516aa6a18ac94bdf3521bd76235ffeab2cf85c84
+  data.tar.gz: cceb245c801bb10e3a84d942a8101014a585ac5b00e958bd682b6b0a3599143a
 SHA512:
-  metadata.gz: d11b514814d2e1d3d1cbbe3dae17a36f2630863694cb6869accda703b873de201bbaa20b31ff01ff1368d7dae7906950c6d4cbfeb6e51700d05f8408e94f92c9
-  data.tar.gz: 16a6c1d7a286940171c8feafbd35f0732906e1adeb4b17737f38f0db393f47684fc3909ddacdcfc81297e90ed75fdfd7e6d18a3cdf8c68ed5f17972947715d73
+  metadata.gz: 07ea3aedf2366de58c8c39af7ff8fcf17ff273ea1df71799215a0f19fdd029a0e32a8517b154e140175b6211d258d6376ef4faa40fdcb645ca4183196a4cec96
+  data.tar.gz: ca57887c542a4817181d1da196fc05f9739be992aa7a10b2cdb7aae293d066ddfc6c2009aeb204cfc315ac2745ef36ac1792fa29b22f11a09cb02cb441a7d14b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-html (0.2.2)
+    rspec-html (0.2.3)
       nokogiri (~> 1.10)
       rspec (~> 3.0)
 

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.2'
+gem 'rspec-html', '~> 0.2.3'
 ```
 
 And rebuild your bundle:
@@ -55,12 +55,14 @@ expect(document.body.div(id: 'my-div').span(align: 'left')).to contain_text 'som
 ```
 
 #### Class Matching
-CSS classes are treated as a special case: to select an element matching a specific class (or array of classes) pass the `class` parameter:
+_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'
+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
@@ -131,7 +133,7 @@ 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'
 ```
 

data/lib/rspec/html/version.rb

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

data/lib/rspec_html.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
 require 'nokogiri'
+
 require 'pathname'
+require 'forwardable'
 
-require 'rspec_html/searchable'
-require 'rspec_html/element'
 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

data/lib/rspec_html/element.rb

@@ -3,14 +3,20 @@
 module RSpecHTML
   # HTML DOM element abstraction
   class Element
-    include Searchable
-
     attr_reader :name, :element
 
-    def initialize(element, name, siblings: [])
+    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
@@ -21,18 +27,21 @@ module RSpecHTML
       @element.to_s
     end
 
-    def self.reconstituted(tag, options = {})
-      name = tag.to_s.downcase
-      mapped_attributes = options.reject { |key| key.to_sym == :text }.map do |key, value|
-        next %(#{key}="#{value}") unless key.to_sym == :class && value.is_a?(Array)
+    Tags.each do |tag|
+      define_method tag.downcase do |*args|
+        options = args.first
+        return @search.new_from_find(tag.downcase, options) if options.nil?
 
-        %(#{key}="#{value.join(' ')}")
+        @search.new_from_where(tag.downcase, options)
       end
+    end
 
-      attributes = mapped_attributes.empty? ? nil : " #{mapped_attributes.join(' ')}"
-      return "<#{name}#{attributes} />" unless options.key?(:text)
+    def reconstituted
+      self.class.reconstituted(name, @options)
+    end
 
-      "<#{name}#{attributes}>#{options[:text]}</#{name}>"
+    def self.reconstituted(tag, options = {})
+      ReconstitutedElement.new(tag, options).to_s
     end
   end
 end

data/lib/rspec_html/matchers.rb

@@ -10,18 +10,22 @@ module RSpecHTML
     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)
+        rspec_html_matcher = class_.new(expected, options || {})
         match do |actual|
-          @actual = rspec_html_matcher.actual
-          rspec_html_matcher.match(actual)
+          rspec_html_matcher
+            .save_actual(actual)
+            .match(actual)
+            .tap { @actual = rspec_html_matcher.rspec_actual }
         end
         description { rspec_html_matcher.description }
-        failure_message { |actual| rspec_html_matcher.failure_message(actual) }
+        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)

data/lib/rspec_html/matchers/base.rb

@@ -18,24 +18,33 @@ module RSpecHTML
         end
       end
 
-      attr_reader :actual
+      attr_reader :rspec_actual
 
-      def initialize(expected, options = {})
+      def initialize(expected, options)
         @expected = expected
         @options = options
       end
 
       def description
-        template(:description, @expected)
+        template(:description, @options, @expected)
       end
 
-      def failure_message(actual)
-        template(:failure, @expected, actual)
+      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, expected, actual = nil)
+      def template(type, options, expected, actual = nil)
         ERB.new(template_path(type).read).result(binding)
       end
 

data/lib/rspec_html/matchers/contain_text.rb

@@ -9,7 +9,7 @@ module RSpecHTML
       diffable
 
       def match(actual)
-        @actual = actual&.text&.strip
+        @rspec_actual = actual&.text
         (actual&.text || '').include?(@expected.to_s)
       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/{searchable.rb → search.rb}

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
 module RSpecHTML
-  # Mixin module providing methods for searching text content of HTML entities
-  module Searchable
+  # 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
@@ -38,7 +43,7 @@ module RSpecHTML
     end
 
     def text
-      @element&.text || ''
+      @element&.text&.gsub(/\s+/, ' ')&.strip || ''
     end
 
     def size
@@ -48,18 +53,29 @@ module RSpecHTML
     end
     alias length size
 
-    private
-
-    def method_missing(tag, *args)
-      return super unless Tags.include?(tag)
-      return self.class.new(find(tag), tag, siblings: find(tag, all: true)) if args.empty?
+    def new_from_find(tag, options)
+      Element.new(
+        find(tag),
+        tag,
+        options: options,
+        siblings: find(tag, all: true)
+      )
+    end
 
-      self.class.new(where(tag, args.first), tag, siblings: where(tag, args.first, all: true))
+    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], name)
+      self.class.new(@siblings[val - 1], @element.name)
     end
 
     def range(val)
@@ -97,7 +113,8 @@ module RSpecHTML
     end
 
     def where_class(tag, class_or_classes)
-      selector = class_or_classes.is_a?(Array) ? class_or_classes.join('.') : 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
 
@@ -106,11 +123,5 @@ module RSpecHTML
 
       @element&.css(tag.to_s)
     end
-
-    # rubocop:disable Lint/MissingSuper
-    def respond_to_missing?(method_name, *_)
-      Tags.include?(method_name)
-    end
-    # rubocop:enable Lint/MissingSuper
   end
 end

data/lib/rspec_html/tags.rb

@@ -7,6 +7,10 @@ module RSpecHTML
       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[

data/templates/failure/contain_tag.erb

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

data/templates/failure/contain_text.erb

@@ -1,5 +1,5 @@
 <% if actual.element.nil? %>
-Expected <%= actual.name %> to contain <%= expected.inspect %> but the element did not exist.
+Expected <%= actual.reconstituted %> to contain <%= expected.inspect %> but the element did not exist.
 <% else %>
-Expected text in <<%= actual.name %>> <%= (actual.text&.strip || '').inspect %> to contain <%= expected.inspect %> but it did not.
+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.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Bob Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-12 00:00:00.000000000 Z
+date: 2020-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -192,7 +192,8 @@ files:
 - lib/rspec_html/matchers/base.rb
 - lib/rspec_html/matchers/contain_tag.rb
 - lib/rspec_html/matchers/contain_text.rb
-- lib/rspec_html/searchable.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