rspec-html 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a44b3e325c465425333bc192cf43486377191f17056c9aaf4ec8de1f69d8b98
-  data.tar.gz: 59a989375d49adf9a4a53400f521660ef56aae326334835c5fd57deb83e44148
+  metadata.gz: 0d6b33d4bbde8f992f361359fed2e7ca1fa5aea60031bfeb72fcc719fe61bb4a
+  data.tar.gz: c8bbd8cae270839cba34034bdbd78a8d42085f01fe29891ef01eed6299805b1b
 SHA512:
-  metadata.gz: 7e17251c5710734d9b62badbea60798acd280d51e5bb208606fecd23fcff33e8c41220e979121925c5264bbb27a4effee9b54cb4d9a89fddb5a30e8858adc847
-  data.tar.gz: ea4ab89dc355ee02ae240746b4acb1f31a5b533e70b119b1f323f6ca290064194c9fa52de9a42b907a00d7452318d299e74ab8985f94a5a76fd15b10aebdfb25
+  metadata.gz: 810cc82b373e10c3ab4f137d7dc4648972f81654f07478b937b7eb38d43832273c5b0203ad8ebcc7fb6927efea78ac1d048663d9c4a5f95d8afa8459f8bdae97
+  data.tar.gz: 0a9e83ccf82b023d0f4809935c354ef3d31b5bb6cc95161395bd8b4246ae839fcc71abfc933563d913eea8fcd9ee0935992c535a5455ef230a768e91ca48981d

data/.rubocop.yml

@@ -2,3 +2,50 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
     - 'rspec-html.gemspec'
+
+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

data/Gemfile.lock

@@ -1,38 +1,38 @@
 PATH
   remote: .
   specs:
-    rspec-html (0.1.2)
+    rspec-html (0.2.0)
       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.88.0)
       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.1.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.2.0)
+      parser (>= 2.7.0.1)
+    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.88.0)
   rubocop-rspec (~> 1.36)
-  strong_versions (~> 0.3.2)
+  strong_versions (~> 0.4.5)
 
 BUNDLED WITH
    2.0.2

data/README.md

@@ -5,7 +5,7 @@ _RSpec::HTML_ provides a simple object interface to HTML responses from [_RSpec
 ## Installation
 
 ```ruby
-gem 'rspec-html', '~> 0.1.3'
+gem 'rspec-html', '~> 0.2.0'
 ```
 
 Bundle
@@ -26,17 +26,61 @@ Require the gem in your `spec_helper.rb`:
 require 'rspec/html'
 ```
 
-In request specs, access the HTML document through the provided object interface:
+In request specs, access the HTML document through the provided `document` object.
 
+### Object Interface
+
+To navigating 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 include '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(class: 'my-class')).to eql 'some text'
+```
+
+#### Attribute Retrieval
+To select an attribute from an element use the hash-style interface:
+```ruby
+expect(document.body.div.span[:class]).to eql 'my-class'
+expect(document.body.div.span['data-content']).to eql '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 eql '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 include 'some text'
+expect(document.body.css('span.my-class')).to include 'some text'
+```
+
+To simply check that an _XPath_ or _CSS_ selector exists use `have_xpath` and `have_css`:
 ```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
-end
+expect(document.body).to have_css 'html body div.myclass'
+expect(document.body).to have_xpath '//html/body/div[@class="myclass"]'
 ```
 
 ## Contributing

data/lib/rspec/html.rb

@@ -9,7 +9,7 @@ module RSpec
   # Module extension for RSpec::SharedContext
   module HTML
     def document
-      RSpecHTML::Document.new(response.body)
+      RSpecHTML::Element.new(Nokogiri::HTML.parse(response.body), :document)
     end
   end
 end

data/lib/rspec/html/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module HTML
-    VERSION = '0.1.3'
+    VERSION = '0.2.0'
   end
 end

data/lib/rspec_html.rb

@@ -5,10 +5,8 @@ require 'pathname'
 
 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/element'
+require 'rspec_html/tags'
 
 # Support module for rspec/html
 module RSpecHTML

data/lib/rspec_html/element.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RSpecHTML
+  # HTML DOM element abstraction
+  class Element
+    include Searchable
+    include Nameable
+
+    def initialize(element, name, siblings: [])
+      @name = name
+      @element = element
+      @siblings = siblings
+    end
+  end
+end

data/lib/rspec_html/searchable.rb

@@ -4,33 +4,98 @@ module RSpecHTML
   # Mixin module providing methods for searching text content of HTML entities
   module Searchable
     def include?(val)
-      @entity.text.include?(val)
+      @element.text.include?(val)
     end
 
     def css(*args)
-      @entity.css(*args)
+      self.class.new(@element&.css(*args), :css)
     end
 
     def xpath(*args)
-      @entity.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)
-      !css(*args).empty?
+      !@element&.css(*args)&.empty?
     end
 
     def has_xpath?(*args)
-      !xpath(*args).empty?
+      !@element&.xpath(*args)&.empty?
     end
     # rubocop:enable Naming/PredicateName
 
     def to_s
-      @entity.text.strip
+      @element&.text&.strip
     end
 
     def inspect
-      %("#{self}")
+      %("#{@element}")
+    end
+
+    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 size
+      return @element.size if @element.respond_to?(:size)
+
+      @siblings.size
+    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?
+
+      self.class.new(where(tag, args.first), tag, siblings: where(tag, args.first, all: true))
+    end
+
+    def index(val)
+      zero_index_error if val.zero?
+      self.class.new(@siblings[val - 1], 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 = @element&.xpath("//#{tag}[#{where_conditions(query)}]")
+      return matched&.first unless all
+
+      matched
+    end
+
+    def where_conditions(query)
+      query.map do |key, value|
+        %(@#{key}="#{value}")
+      end.join ' and '
+    end
+
+    def find(tag, all: false)
+      return @element&.css(tag.to_s)&.first unless all
+
+      @element&.css(tag.to_s)
+    end
+
+    def respond_to_missing?(method_name, *_)
+      Tags.include?(method_name)
     end
   end
 end

data/lib/rspec_html/tags.rb

@@ -0,0 +1,27 @@
+# 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
+
+    # 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.88.0'
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-html
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Bob Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2020-07-28 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.88.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.76.0
+        version: 0.88.0
 - !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,12 +187,10 @@ 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/element.rb
 - lib/rspec_html/nameable.rb
 - lib/rspec_html/searchable.rb
-- lib/rspec_html/title.rb
+- lib/rspec_html/tags.rb
 - rspec-html.gemspec
 homepage: https://github.com/bobf/rspec-html
 licenses:

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,23 +0,0 @@
-# frozen_string_literal: true
-
-module RSpecHTML
-  # HTML/BODY abstraction
-  class Head
-    include Nameable
-    include Searchable
-
-    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/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