minitest-have_tag 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e81fcc535cc8aa06f7ca58c684346bebf51bd19
+  data.tar.gz: 864ff70023d0a4f7a89f2595e02e6ba3f50488e1
+SHA512:
+  metadata.gz: 493f7085a0ebec29b0fb34068a1b4b5971caebc97deef51b1543ae07e3acc0eb51c91cda757dc9bb6fb97953d0b7abefd05f5b737dd2f224dadc1d4432b1f865
+  data.tar.gz: a9c0e8a3c18da870c21d0822fad7752458dbedff39263832143f4c02fc81c76943ad90b3efa7b36af25e0fbc86f606d033d44ec48a93d6ae4478207ece8624c7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in minitest-have_tag.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Kematzy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,209 @@
+# Minitest::HaveTag
+
+Adds methods to Minitest to test for existence of HTML tags, including contents, within a provided 
+string.
+
+Currently adds the following methods:
+
+### Minitest::Assertions
+
+*  **`:assert_have_tag(actual, expected, contents = nil, msg = nil)`**
+
+* **`:refute_have_tag(actual, expected, contents = nil, msg = nil)`**
+
+### Minitest::Expectations
+
+* **actual.`must_have_tag(expected, contents = nil, msg = nil)`**
+
+* **actual.`wont_have_tag(expected, contents = nil, msg = nil)`**
+
+<br>
+---
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'minitest-have_tag'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install minitest-have_tag
+
+<br>
+---
+
+
+## Usage
+
+Add the gem to your **Gemfile** or **.gemspec** file and then load the gem in your `spec_helper.rb`
+file as follows:
+
+```ruby
+ # <snip...>
+ 
+ require 'minitest/autorun'
+ 
+ # load assert_have_tag() support
+ require 'minitest/have_tag'
+ 
+ # <snip...>
+```
+
+Adding the above to your `spec_helper.rb` file automatically adds the key helper methods to the 
+`Minitest::Assertions` to test for existence of HTML tag, including contents, within the provided 
+String.
+
+<br>
+
+### `assert_have_tag()`
+
+```ruby
+ assert_have_tag('<br>', 'br')  #=> 
+ 
+ # check for CSS :class attribute
+ assert_have_tag('<hr class="divider">', 'hr.divider')
+ assert_have_tag('<hr class="divider">', 'hr[@class=divider]')
+ 
+ # check for CSS :id attribute
+ assert_have_tag('<hr id="divider">', 'hr#divider')
+ assert_have_tag('<hr id="divider">', 'hr[@id=divider]')
+ 
+ # check for contents within a <div...>
+ assert_have_tag('<div class="row">contents</div>', 'hr.row', 'contents')
+ 
+ html = <<-HTML
+   <div id="intro" class="row">
+     <div class="col-md-12">
+       <h1>Header</h1>
+     </div>
+   </div>
+ HTML
+ 
+ # 
+ assert_have_tag(html, 'div#intro.row > .col-md-12 > h1', 'Header')
+  
+```    
+
+Produces an extensive error message when something is wrong
+
+```ruby    
+ assert_have_tag('<br>', 'brr')
+   #=> 'Expected "<br>" to have tag ["brr"], but no such tag was found'
+```
+
+<br>
+
+### `:refute_have_tag()`
+  
+Method to test for non-existence of the expected HTML tag, including contents, 
+within the provided string.
+
+```ruby
+ refute_have_tag('<abbr>', 'br')  #=> 
+ 
+ # check for CSS :class attribute
+ refute_have_tag('<hr class="divider">', 'hr.space')
+ refute_have_tag('<hr class="divider">', 'hr[@class=space]')
+ 
+ # check for CSS :id attribute
+ refute_have_tag('<hr id="divider">', 'hr#space')
+ refute_have_tag('<hr id="divider">', 'hr[@id=space]')
+ 
+ # check for contents within a <div...>
+ refute_have_tag('<div class="row">contents</div>', 'hr.row', '<h1>Header</h1>')
+ 
+ html = <<-HTML
+   <div id="intro" class="row">
+     <div class="col-md-12">
+       <h1>Header</h1>
+     </div>
+   </div>
+ HTML
+ # 
+ refute_have_tag(html, 'div#intro.row > .col-md-12 > h1', 'Header')
+```
+ 
+Produces an extensive error message when something is wrong:
+ 
+```ruby
+ refute_have_tag('<br>', 'br')
+   #=> 'Expected "<br>" to NOT have tag ["br"], but such a tag was found'
+```
+
+
+<br>
+--- 
+
+## Dependencies
+
+This Gem depends upon the following:
+
+### Runtime:
+
+* minitest
+* nokogiri
+
+
+### Development & Tests:
+
+* bundler (~> 1.10)
+* rake  (~> 10.0)
+* minitest-hooks
+* minitest-rg
+
+* simplecov
+
+
+<br>
+
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run 
+`bundle exec rake spec` to run the tests.
+
+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).
+
+<br>
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/kematzy/minitest-have_tag). 
+
+This project is intended to be a safe, welcoming space for collaboration, and contributors are 
+expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+<br>
+
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix in a separate branch.
+* Add spec tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with Rakefile, version, or history.
+  * (if you want to have your own version, that is fine but bump version in a commit by itself 
+    I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+
+<br>
+
+
+## Copyright
+
+Copyright (c) 2015 Kematzy
+
+Released under the MIT License. See LICENSE for further details.
+

data/Rakefile

@@ -0,0 +1,28 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'spec'
+  t.libs << 'lib'
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+desc 'Run specs with coverage'
+task :coverage do
+  ENV['COVERAGE'] = '1'
+  Rake::Task['spec'].invoke
+    # `open coverage/index.html` # if OSX
+end
+
+desc 'Run Rubocop report'
+task :rubocop do
+  res = `which rubocop`
+  if res != ""
+    `rubocop -f html -o ./rubocop/report.html lib/`
+      # `open rubocop/report.html` # if OSX
+  else
+    puts "\nERROR: 'rubocop' gem is not installed or available. Please install with 'gem install rubocop'."
+  end
+end

data/lib/minitest/have_tag.rb

@@ -0,0 +1,163 @@
+require 'minitest'
+require 'minitest/have_tag/version'
+
+module Minitest::Assertions
+  require 'nokogiri'
+  
+  # Method to test for existence of HTML tag, including contents, within the provided string.
+  # 
+  #     assert_have_tag('<br>', 'br')  #=> 
+  #     
+  #     # check for CSS :class attribute
+  #     assert_have_tag('<hr class="divider">', 'hr.divider')
+  #     assert_have_tag('<hr class="divider">', 'hr[@class=divider]')
+  #     
+  #     # check for CSS :id attribute
+  #     assert_have_tag('<hr id="divider">', 'hr#divider')
+  #     assert_have_tag('<hr id="divider">', 'hr[@id=divider]')
+  #     
+  #     # check for contents within a <div...>
+  #     assert_have_tag('<div class="row">contents</div>', 'hr.row', 'contents')
+  #     
+  #     html = <<-HTML
+  #       <div id="intro" class="row">
+  #         <div class="col-md-12">
+  #           <h1>Header</h1>
+  #         </div>
+  #       </div>
+  #     HTML
+  #     # 
+  #     assert_have_tag(html, 'div#intro.row > .col-md-12 > h1', 'Header')
+  #     
+  #     
+  #     Produces an extensive error message when something is wrong
+  #     
+  #     assert_have_tag('<br>', 'brr')
+  #       #=> 'Expected "<br>" to have tag ["brr"], but no such tag was found'
+  #     
+  #
+  def assert_have_tag(actual, expected, contents = nil, msg = nil)
+    msg = msg.nil? ? '' : "#{msg}\n"
+    msg << "Expected #{actual.inspect} to have tag [#{expected.inspect}]"
+    
+    doc = Nokogiri::HTML(actual)
+    res  = doc.css(expected)
+    
+    if res.empty?
+      msg << ', but no such tag was found'
+      matching = false
+    else
+      # such a tag was found
+      matching = true
+      
+      if contents
+        if contents.is_a?(String)
+          if res.inner_html == contents
+            matching = true
+          else
+            msg << " with contents [#{contents.inspect}], but the tag content is [#{res.inner_html}]"
+            matching = false
+          end
+        elsif contents.is_a?(Regexp)
+          if res.inner_html =~ contents
+            matching = true
+          else
+            msg << " with inner_html [#{res.inner_html}],"
+            msg << " but did not match Regexp [#{contents.inspect}]"
+            matching = false
+          end
+        else
+          msg << ", ERROR: contents is neither String nor Regexp, it's [#{contents.class}]"
+          matching = false
+        end
+      else
+        # no contents given, so ignore
+      end
+    end
+    assert matching, msg
+  end
+  
+  # Method to test for non-existence of the expected HTML tag, including contents, 
+  # within the provided string.
+  # 
+  #     refute_have_tag('<abbr>', 'br')  #=> 
+  #     
+  #     # check for CSS :class attribute
+  #     refute_have_tag('<hr class="divider">', 'hr.space')
+  #     refute_have_tag('<hr class="divider">', 'hr[@class=space]')
+  #     
+  #     # check for CSS :id attribute
+  #     refute_have_tag('<hr id="divider">', 'hr#space')
+  #     refute_have_tag('<hr id="divider">', 'hr[@id=space]')
+  #     
+  #     # check for contents within a <div...>
+  #     refute_have_tag('<div class="row">contents</div>', 'hr.row', '<h1>Header</h1>')
+  #     
+  #     html = <<-HTML
+  #       <div id="intro" class="row">
+  #         <div class="col-md-12">
+  #           <h1>Header</h1>
+  #         </div>
+  #       </div>
+  #     HTML
+  #     # 
+  #     refute_have_tag(html, 'div#intro.row > .col-md-12 > h1', 'Header')
+  #     
+  #     
+  #     Produces an extensive error message when something is wrong
+  #     
+  #     refute_have_tag('<br>', 'br')
+  #       #=> 'Expected "<br>" to NOT have tag ["br"], but such a tag was found'
+  #     
+  #
+  def refute_have_tag(actual, expected, contents = nil, msg = nil)
+    msg = msg.nil? ? '' : "#{msg}\n"
+    msg << "Expected #{actual.inspect} to NOT have tag [#{expected.inspect}]"
+    
+    doc = Nokogiri::HTML(actual)
+    res  = doc.css(expected)
+    
+    # if res has something within it that means we have mostly a match, 
+    # so now we need to check contents
+    unless res.empty?
+      msg << ', but such a tag was found'
+      matching = true
+      
+      if contents
+        if contents.is_a?(String)
+          if res.inner_html == contents
+            matching = true
+          else
+            msg << " with contents [#{contents.inspect}], but the tag content is [#{res.inner_html}]"
+            matching = false
+          end
+        elsif contents.is_a?(Regexp)
+          if res.inner_html =~ contents
+            matching = true
+          else
+            msg << " with inner_html [#{res.inner_html}],"
+            msg << " but did not match Regexp [#{contents.inspect}]"
+            matching = false
+          end
+        else
+          msg << ", ERROR: contents is neither String nor Regexp, it's [#{contents.class}]"
+          matching = false
+        end
+      else
+        # no contents given, so ignore
+      end
+      
+    else
+      # such a tag was found, BAD
+      matching = false
+    end
+    refute matching, msg
+  end
+  
+end
+
+# add support for Spec syntax
+module Minitest::Expectations
+  infect_an_assertion :assert_have_tag, :must_have_tag, :reverse
+  infect_an_assertion :refute_have_tag, :wont_have_tag, :reverse
+end

data/lib/minitest/have_tag/version.rb

@@ -0,0 +1,8 @@
+
+module Minitest
+  
+  module HaveTag
+    VERSION = "0.1.0"
+  end
+  
+end

data/minitest-have_tag.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minitest/have_tag/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'minitest-have_tag'
+  spec.version       = Minitest::HaveTag::VERSION
+  spec.authors       = ['Kematzy']
+  spec.email         = ['kematzy@gmail.com']
+
+  spec.summary       = %q{Minitest assertions for testing HTML output}
+  spec.description   = %q{Adds Minitest assertion for testing HTML output, including contents, within a provided string}
+  spec.homepage      = 'http://github.com/kematzy/minitest-have_tag'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  
+  spec.add_runtime_dependency 'minitest'
+  spec.add_runtime_dependency 'nokogiri'
+  
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  # spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-assert_errors'
+  spec.add_development_dependency 'minitest-hooks'
+  spec.add_development_dependency 'minitest-rg'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'simplecov'
+  
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: minitest-have_tag
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kematzy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-assert_errors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-rg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds Minitest assertion for testing HTML output, including contents,
+  within a provided string
+email:
+- kematzy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/minitest/have_tag.rb
+- lib/minitest/have_tag/version.rb
+- minitest-have_tag.gemspec
+homepage: http://github.com/kematzy/minitest-have_tag
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Minitest assertions for testing HTML output
+test_files: []