rspec-html 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f8ba6978f02ad1d8763eb137332a30db8807af2f1f484b843cf65e41afffa5e
-  data.tar.gz: 3619e2e57b5f05c45a7f2bc6612a8e8f1a7c6ce5b8628a3be2bee9d16a2e5835
+  metadata.gz: 8b6fbffdbd1506e148ae25b7900d508e3f50048cb3c2d27ed25ef2fd5a93d0ab
+  data.tar.gz: 8868853f56675ca2d4487b155a8da72c668ed6f80ebf61885f718a653d3b58a5
 SHA512:
-  metadata.gz: df6d3216cf9bf3ea3d4db4149420aaaf9fc8ea7342bc03142b1e82cde2d71ec4f4a653b1dd94b2c3cfdeb88309b5416c5c575e5bed706d7d0b615407ff7da358
-  data.tar.gz: 18c22ee25803f0fb6f01f772e44c55b7dc2a17f02911721ccd7f56304d5b2ad7ed611eab2c38030e6a40f4cf99954087b31db61ba24cd73e0035f878f6d7e7ba
+  metadata.gz: 63b9fa7b4043a45485bb6423c26ab1812e8ab56283285ad6f3e92402fe4f47c5a20e5f62b1102816f5a24a25c04965310464e69eacfc0619e7500cf716bde298
+  data.tar.gz: 1065cfee90afa2c3372c524abf7e6a7383c56f6e349d35f1f9bbe06b6e803665459c41f7360d9066baeccd5375d4a666cddd64f4921be85dd5b25faa668453dd

data/.gitignore

@@ -12,3 +12,5 @@
 
 *.swp
 *.swo
+.byebug_history
+rspec-html-*.gem

data/Gemfile.lock

@@ -2,17 +2,24 @@ PATH
   remote: .
   specs:
     rspec-html (0.1.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)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.5)
+      mini_portile2 (~> 2.4.0)
     paint (2.1.1)
     parallel (1.19.1)
     parser (2.6.5.0)
@@ -54,7 +61,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  betterp (~> 0.1.3)
   bundler (~> 2.0)
+  byebug (~> 11.0)
+  i18n (~> 1.7)
   rake (~> 10.0)
   rspec-html!
   rspec-its (~> 1.3)

data/README.md

@@ -1,17 +1,14 @@
-# Rspec::Html
+# RSpec::HTML
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rspec/html`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+_RSpec::HTML_ provides a simple object interface to HTML responses from [_RSpec Rails_ request specs](https://relishapp.com/rspec/rspec-rails/docs/request-specs/request-spec).
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
 ```ruby
-gem 'rspec-html'
+gem 'rspec-html', '~> 0.1.1'
 ```
 
+Bundle
 And then execute:
 
     $ bundle
@@ -22,18 +19,28 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Require the gem in your `spec_helper.rb`:
 
-## Development
+```
+# spec/spec_helper.rb
+require 'rspec/html'
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+In request specs, access the HTML document through the provided object interface:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+RSpec.describe 'something', type: :request do
+  it 'does something' do
+    get '/'
+    expect(document.body).to include 'something'
+  end
+end
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rspec-html.
+Feel free to make a pull request.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+[MIT License](LICENSE)

data/lib/rspec/html.rb

@@ -1,10 +1,20 @@
 # frozen_string_literal: true
 
+require 'rspec'
+require 'rspec_html'
+
 require 'rspec/html/version'
 
-module Rspec
-  module Html
-    class Error < StandardError; end
-    # Your code goes here...
+module RSpec
+  # Module extension for RSpec::SharedContext
+  module HTML
+    def document
+      RSpecHTML::Document.new(response.body)
+    end
   end
 end
+
+RSpec.configure do |config|
+  config.include RSpec::HTML
+  config.backtrace_exclusion_patterns << %r{/lib/rspec/html}
+end

data/lib/rspec/html/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-module Rspec
-  module Html
-    VERSION = '0.1.0'
+module RSpec
+  module HTML
+    VERSION = '0.1.1'
   end
 end

data/lib/rspec_html.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+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'
+
+# Support module for rspec/html
+module RSpecHTML
+  def self.root
+    Pathname.new(__dir__).parent
+  end
+end

data/lib/rspec_html/body.rb

@@ -0,0 +1,14 @@
+# 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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RSpecHTML
+  # HTML Document representation
+  class Document
+    def initialize(html)
+      @html = html
+    end
+
+    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

@@ -0,0 +1,22 @@
+# 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

@@ -0,0 +1,8 @@
+# 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

@@ -0,0 +1,18 @@
+# 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

@@ -0,0 +1,14 @@
+# 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

data/rspec-html.gemspec

@@ -6,7 +6,7 @@ require 'rspec/html/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'rspec-html'
-  spec.version       = Rspec::Html::VERSION
+  spec.version       = RSpec::HTML::VERSION
   spec.authors       = ['Bob Farrell']
   spec.email         = ['git@bob.frl']
 
@@ -28,9 +28,13 @@ Gem::Specification.new do |spec|
   spec.executables   = []
   spec.require_paths = ['lib']
 
+  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 'i18n', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec-its', '~> 1.3'
   spec.add_development_dependency 'rubocop', '~> 0.76.0'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rspec-html
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Bob Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-23 00:00:00.000000000 Z
+date: 2019-12-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: betterp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +66,34 @@ 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: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -129,6 +185,13 @@ files:
 - bin/setup
 - 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
 - rspec-html.gemspec
 homepage: https://github.com/bobf/rspec-html
 licenses: