minitest-have_tag 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0e81fcc535cc8aa06f7ca58c684346bebf51bd19
-  data.tar.gz: 864ff70023d0a4f7a89f2595e02e6ba3f50488e1
+SHA256:
+  metadata.gz: 623e8d0312c42b0f58a82525ab9d7b436ecc75b28cbb4005bf270cbbd7fadec2
+  data.tar.gz: 45a0fd0e3d9be6586430323535372144fc564b828004665f39a1a2290c30d22f
 SHA512:
-  metadata.gz: 493f7085a0ebec29b0fb34068a1b4b5971caebc97deef51b1543ae07e3acc0eb51c91cda757dc9bb6fb97953d0b7abefd05f5b737dd2f224dadc1d4432b1f865
-  data.tar.gz: a9c0e8a3c18da870c21d0822fad7752458dbedff39263832143f4c02fc81c76943ad90b3efa7b36af25e0fbc86f606d033d44ec48a93d6ae4478207ece8624c7
+  metadata.gz: 344472efb8b3de1dfde5eb5863002f91d29f5d03fc797aa3d0150edc21434bc5f70ba0270a25583dc4a9ca1854e3cf5adbd580d5a6755801b35781d1d3dd00e3
+  data.tar.gz: 3e6d0e53d2617f9893fc86bc772ceb6acd823b170cfdf1cdde1768adf31e4b1893dfe95602ea248269d37ec08e5ca404964b4d615419c3733864b326a5d01b0f

data/.github/dependabot.yml

@@ -0,0 +1,24 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "saturday"
+      time: "21:45"
+      timezone: Asia/Kuala_Lumpur
+  - package-ecosystem: "bundler" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    groups:
+      patch-and-minor-dependencies:
+        update-types: ["patch", "minor"]
+    schedule:
+      interval: "weekly"
+      day: "saturday"
+      time: "21:45"
+      timezone: Asia/Kuala_Lumpur

data/.github/workflows/ruby.yml

@@ -0,0 +1,45 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# GitHub recommends pinning actions to a commit SHA.
+# To get a newer version, you will need to update the SHA.
+# You can also reference a tag or branch, but the action may change without warning.
+
+name: Ruby
+
+on:
+  push:
+    branches: ["master", "ruby-v3x"]
+  pull_request:
+    branches: ["master", "ruby-v3x"]
+
+permissions:
+  contents: read
+
+jobs:
+  lint_and_test:
+    env:
+      RACK_ENV: test
+      COVERAGE: "true"
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby-version: ["3.0", "3.1", "3.2", "3.3"]
+        # Disable JRuby for now
+        # ruby-version: ["3.0", "3.1", "3.2", "3.3", "jruby-9.4"]
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 3
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+        # change this to (see https://github.com/ruby/setup-ruby#versioning):
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run rake (lint and test)
+        run: bundle exec rake

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/rubocop/

data/.rubocop.yml

@@ -0,0 +1,40 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-minitest
+  - rubocop-performance
+  - rubocop-rake
+
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+AllCops:
+  TargetRubyVersion: "3.0"
+  NewCops: enable
+
+Layout/LineLength:
+  Exclude:
+    - "minitest-have_tag.gemspec"
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - "spec/**/*.rb"
+    - "**/*.gemspec"
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - "lib/minitest/have_tag.rb"
+
+Style/Documentation:
+  Exclude:
+    - "spec/**/*"
+    - "test/**/*"

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-09-25 13:15:56 UTC using RuboCop version 1.66.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/CODE_OF_CONDUCT.md

@@ -1,13 +1,27 @@
 # 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.
+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.
+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.
+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.
+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.
+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/)
+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

@@ -1,4 +1,78 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in minitest-have_tag.gemspec
 gemspec
+
+# adding these to silence warnings for Ruby v3.5
+gem 'fiddle'
+gem 'logger'
+gem 'ostruct'
+
+group :development do
+  # A command line tool to easily handle events on file system modifications
+  # DOCS: https://github.com/guard/guard
+  gem 'guard'
+  # automatically runs your tests with Minitest framework
+  # DOCS: https://github.com/guard/guard-minitest
+  gem 'guard-minitest'
+
+  # Ruby testing framework
+  # DOCS: https://github.com/seattlerb/minitest
+  gem 'minitest', '~> 5.7', '>= 5.7.0'
+  # Adds specific assertions for testing exceptions with minitest
+  # DOCS: https://github.com/kematzy/minitest-assert_errors
+  gem 'minitest-assert_errors'
+  # Around and before_all/after_all hooks for Minitest
+  # DOCS: https://github.com/jeremyevans/minitest-hooks
+  gem 'minitest-hooks', '~> 1.1', '>= 1.1.0'
+  # Colored red/green output for Minitest
+  # DOCS: https://github.com/blowmage/minitest-rg
+  gem 'minitest-rg', '~> 5.3', '>= 5.3.0'
+
+  # Simple testing API for Rack apps
+  # DOCS: https://github.com/rack/rack-test
+  gem 'rack-test', '~> 2.1'
+  # Ruby build program with capabilities similar to Make
+  # DOCS: https://github.com/ruby/rake
+  gem 'rake', '~> 13.0'
+
+  # Ruby static code analyzer and formatter
+  # DOCS: https://github.com/rubocop/rubocop
+  gem 'rubocop', '~> 1.31', require: false
+  # Code style checking for Minitest files
+  # DOCS: https://github.com/rubocop/rubocop-minitest
+  gem 'rubocop-minitest', require: false
+  # Performance optimization analysis for your projects
+  # DOCS: https://github.com/rubocop/rubocop-performance
+  gem 'rubocop-performance', require: false
+  # A RuboCop extension focused on enforcing Rake best practices and coding conventions
+  # DOCS: https://github.com/rubocop/rubocop-rake
+  gem 'rubocop-rake', require: false
+
+  # Code coverage for Ruby
+  # DOCS: https://github.com/simplecov-ruby/simplecov
+  gem 'simplecov'
+end
+
+# Linux-specific gems
+install_if -> { RUBY_PLATFORM.include?('linux') } do
+  # Linux inotify wrapper for Ruby
+  # DOCS: https://github.com/guard/rb-inotify
+  gem 'rb-inotify', require: false
+end
+
+# macOS-specific gems
+install_if -> { RUBY_PLATFORM.include?('darwin') } do
+  # FSEvents API with signals handled for macOS
+  # DOCS: https://github.com/thibaudgg/rb-fsevent
+  gem 'rb-fsevent', require: false
+end
+
+# Windows-specific gems
+install_if -> { Gem.win_platform? } do
+  # Windows Directory Monitor - A library which can be used to monitor directories for changes
+  # DOCS: https://github.com/Maher4Ever/wdm
+  gem 'wdm'
+end

data/Guardfile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest do
+  # with Minitest::Spec
+  watch(%r{^spec/(.*)_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+end

data/README.md

@@ -1,209 +1,233 @@
 # Minitest::HaveTag
 
-Adds methods to Minitest to test for existence of HTML tags, including contents, within a provided 
-string.
+[![Ruby](https://github.com/kematzy/minitest-have_tag/actions/workflows/ruby.yml/badge.svg?branch=master)](https://github.com/kematzy/minitest-have_tag/actions/workflows/ruby.yml) - [![Gem Version](https://badge.fury.io/rb/minitest-have_tag.svg)](https://badge.fury.io/rb/minitest-have_tag) - [![Minitest Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop-minitest)
 
-Currently adds the following methods:
+Adds methods to Minitest to test for existence of HTML tags, including contents,
+within a provided string.
+
+## Added methods:
 
 ### Minitest::Assertions
 
-*  **`:assert_have_tag(actual, expected, contents = nil, msg = nil)`**
+- **`:assert_have_tag(actual, expected, contents = nil, msg = nil)`**
 
-* **`:refute_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).`must_have_tag(expected, contents = nil, msg = nil)`**
 
-* **actual.`wont_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:
+Add this gem to your application `Gemfile`:
 
 ```ruby
 gem 'minitest-have_tag'
 ```
 
-And then execute:
+or for the cutting edge:
 
-    $ bundle
+```ruby
+gem 'minitest-have_tag',
+    git: 'https://github.com/kematzy/minitest-have_tag',
+    branch: 'master'
+```
 
-Or install it yourself as:
+To install the gems, run:
 
-    $ gem install minitest-have_tag
+```bash
+bundle install
+```
 
-<br>
 ---
 
-
 ## Usage
 
-Add the gem to your **Gemfile** or **.gemspec** file and then load the gem in your `spec_helper.rb`
-file as follows:
+Load the gem in your `spec/spec_helper.rb` file as follows:
 
 ```ruby
- # <snip...>
- 
- require 'minitest/autorun'
- 
- # load assert_have_tag() support
- require 'minitest/have_tag'
- 
- # <snip...>
+# <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.
+Adding the above to your `spec/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')
-  
-```    
+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')
+```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, 
+
+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')
+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:
+### Runtime
 
-* minitest
-* nokogiri
+- minitest
+- nokogiri
 
+### Development & Tests
 
-### Development & Tests:
+- guard
+- guard-minitest
+- minitest
+- minitest-assert_errors
+- minitest-hooks
+- minitest-rg
+- rack-test (~> 2.1)
+- rake (~> 13.0)
+- rubocop (~> 1.31)
+- rubocop-minitest
+- rubocop-performance
+- rubocop-rake
+- simplecov
 
-* bundler (~> 1.10)
-* rake  (~> 10.0)
-* minitest-hooks
-* minitest-rg
+---
 
-* simplecov
+## Development
 
+Get started with these commands:
 
-<br>
+```bash
+# clone the repository
+git clone https://github.com/kematzy/minitest-have_tag.git
 
+# change into repository directory
+cd minitest-have_tag/
 
-## Development
+# install dependencies
+bundle install
 
-After checking out the repo, run `bundle install` to install dependencies. Then, run 
-`bundle exec rake spec` to run the tests.
+# run the default tests with coverage & rubocop checking
+bundle exec rake
 
-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).
+# enable automatic reloading of tests during development
+bundle exec guard
+```
 
-<br>
+To install this gem onto your local machine, run `bundle exec rake install`.
 
+To release a new version:
 
-## Contributing
+- ensure `bundle exec rake` passes.
+- update the version number in `version.rb`.
+- run `bundle exec rake release` to:
+  - create a Git tag for the version;
+  - pushes Git commits and tags to GitHub;
+  - pushes the `.gem` file to [rubygems.org](https://rubygems.org).
 
-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.
+## Contributing
 
-<br>
+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.
 
-## 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.
+---
 
+## Note on Patches/Pull Requests
 
-<br>
+- 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.
 
+---
 
 ## Copyright
 
-Copyright (c) 2015 Kematzy
+Copyright (c) 2015 - 2024 Kematzy
 
 Released under the MIT License. See LICENSE for further details.
-

data/Rakefile

@@ -1,28 +1,25 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
 require 'rake/testtask'
 
+RuboCop::RakeTask.new
+
 Rake::TestTask.new(:spec) do |t|
   t.libs << 'spec'
   t.libs << 'lib'
+  t.options = '--rg'
   t.test_files = FileList['spec/**/*_spec.rb']
 end
 
-task :default => :spec
+task default: %i[rubocop coverage]
+
+desc 'alias for spec task'
+task test: :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/version.rb

@@ -1,8 +1,7 @@
+# frozen_string_literal: true
 
 module Minitest
-  
   module HaveTag
-    VERSION = "0.1.0"
+    VERSION = '0.2.1'
   end
-  
 end

data/lib/minitest/have_tag.rb

@@ -1,24 +1,39 @@
+# frozen_string_literal: false
+
 require 'minitest'
 require 'minitest/have_tag/version'
 
+# rubocop:disable Style/Documentation
 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
+  #
+  # This method asserts that a specific HTML tag or structure is present in the given HTML content.
+  # It can check for tags, attributes, and even specific content.
+  #
+  # @param actual [String] The HTML content to be tested
+  # @param expected [String] The CSS selector or tag to search for
+  # @param contents [String, Regexp, nil] Optional. The expected contents of the tag
+  # @param msg [String, nil] Optional. Custom error message
+  #
+  # @return [Boolean] True if the tag is found and matches the criteria
+  #
+  # @example Basic usage
+  #     assert_have_tag('<br>', 'br')
+  #
+  # @example Checking for CSS class
   #     assert_have_tag('<hr class="divider">', 'hr.divider')
   #     assert_have_tag('<hr class="divider">', 'hr[@class=divider]')
-  #     
-  #     # check for CSS :id attribute
+  #
+  # @example Checking for CSS id
   #     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')
-  #     
+  #
+  # @example Checking for specific content
+  #     assert_have_tag('<div class="row">contents</div>', 'div.row', 'contents')
+  #
+  # @example Complex HTML structure
   #     html = <<-HTML
   #       <div id="intro" class="row">
   #         <div class="col-md-12">
@@ -26,73 +41,54 @@ module Minitest::Assertions
   #         </div>
   #       </div>
   #     HTML
-  #     # 
   #     assert_have_tag(html, 'div#intro.row > .col-md-12 > h1', 'Header')
-  #     
-  #     
-  #     Produces an extensive error message when something is wrong
-  #     
+  #
+  # @example Error message
   #     assert_have_tag('<br>', 'brr')
-  #       #=> 'Expected "<br>" to have tag ["brr"], but no such tag was found'
-  #     
+  #       # Raises error: '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}]"
-    
+    msg = build_message(msg, actual, expected)
     doc = Nokogiri::HTML(actual)
-    res  = doc.css(expected)
-    
+    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
+      matching = check_contents(res, contents, msg)
     end
     assert matching, msg
   end
-  
-  # Method to test for non-existence of the expected HTML tag, including contents, 
+
+  # 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>')
-  #     
+  #
+  # This method is used to assert that a specific HTML tag or structure is NOT present
+  # in the given HTML content. It can check for tags, attributes, and even specific content.
+  #
+  # @param actual [String] The HTML content to be tested
+  # @param expected [String] The CSS selector or tag to search for
+  # @param contents [String, Regexp, nil] Optional. The expected contents of the tag
+  # @param msg [String, nil] Optional. Custom error message
+  #
+  # @return [Boolean] True if the tag is not found or doesn't match the criteria
+  #
+  # @example Basic usage
+  #     refute_have_tag('<abbr>', 'br')  # Passes
+  #
+  # @example Checking for CSS class
+  #     refute_have_tag('<hr class="divider">', 'hr.space')  # Passes
+  #     refute_have_tag('<hr class="divider">', 'hr[@class=space]')  # Passes
+  #
+  # @example Checking for CSS id
+  #     refute_have_tag('<hr id="divider">', 'hr#space')  # Passes
+  #     refute_have_tag('<hr id="divider">', 'hr[@id=space]')  # Passes
+  #
+  # @example Checking for specific content
+  #     refute_have_tag('<div class="row">contents</div>', 'hr.row', '<h1>Header</h1>')  # Passes
+  #
+  # @example Complex HTML structure
   #     html = <<-HTML
   #       <div id="intro" class="row">
   #         <div class="col-md-12">
@@ -100,61 +96,100 @@ module Minitest::Assertions
   #         </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(html, 'div#intro.row > .col-md-12 > h2', 'Header')  # Passes
+  #
+  # @example Error message
   #     refute_have_tag('<br>', 'br')
-  #       #=> 'Expected "<br>" to NOT have tag ["br"], but such a tag was found'
-  #     
+  #       # Raises error: '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}]"
-    
+    msg = build_message(msg, actual, expected, refute: true)
     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
+    res = doc.css(expected)
+
+    if res.empty?
       matching = false
+    else
+      msg << ', but such a tag was found'
+      matching = check_contents(res, contents, msg)
     end
     refute matching, msg
   end
-  
+
+  private
+
+  # Builds an error message for tag assertions
+  #
+  # @param msg [String, nil] Custom error message
+  # @param actual [String] The actual HTML content being tested
+  # @param expected [String] The expected tag or selector
+  # @param refute [Boolean] Whether this is for a refutation (default: false)
+  #
+  # @return [String] The formatted error message
+  #
+  def build_message(msg, actual, expected, refute: false)
+    msg = msg.nil? ? '' : "#{msg}\n"
+    msg << "Expected #{actual.inspect} to #{refute ? 'NOT ' : ''}have tag [#{expected.inspect}]"
+  end
+
+  # Checks the contents of the found tag against the expected contents
+  #
+  # @param res [Nokogiri::XML::NodeSet] The result of the CSS selector query
+  # @param contents [String, Regexp, nil] The expected contents of the tag
+  # @param msg [String] The error message to be appended to
+  #
+  # @return [Boolean] True if contents match, false otherwise
+  #
+  def check_contents(res, contents, msg)
+    return true unless contents
+
+    if contents.is_a?(String)
+      check_string_contents(res, contents, msg)
+    elsif contents.is_a?(Regexp)
+      check_regexp_contents(res, contents, msg)
+    else
+      msg << ", ERROR: contents is neither String nor Regexp, it's [#{contents.class}]"
+      false
+    end
+  end
+
+  # Checks if the inner HTML of the found tag exactly matches the expected string contents
+  #
+  # @param res [Nokogiri::XML::NodeSet] The result of the CSS selector query
+  # @param contents [String] The expected contents of the tag
+  # @param msg [String] The error message to be appended to
+  #
+  # @return [Boolean] True if contents match exactly, false otherwise
+  #
+  def check_string_contents(res, contents, msg)
+    if res.any? { |tag| tag.inner_html == contents }
+      true
+    else
+      msg << " with contents [#{contents.inspect}], but the tags content found "
+      msg << "is [#{res.map(&:inner_html).join(', ')}]"
+      false
+    end
+  end
+
+  # Checks if the inner HTML of the found tag matches the expected regular expression
+  #
+  # @param res [Nokogiri::XML::NodeSet] The result of the CSS selector query
+  # @param contents [Regexp] The expected regular expression to match against the tag's contents
+  # @param msg [String] The error message to be appended to
+  #
+  # @return [Boolean] True if contents match the regular expression, false otherwise
+  #
+  def check_regexp_contents(res, contents, msg)
+    if res.inner_html.match contents
+      true
+    else
+      msg << " with inner_html [#{res.inner_html}],"
+      msg << " but did not match Regexp [#{contents.inspect}]"
+      false
+    end
+  end
 end
+# rubocop:enable Style/Documentation
 
 # add support for Spec syntax
 module Minitest::Expectations

data/minitest-have_tag.gemspec

@@ -1,6 +1,9 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require 'minitest/have_tag/version'
 
 Gem::Specification.new do |spec|
@@ -9,10 +12,13 @@ Gem::Specification.new do |spec|
   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.summary       = 'Minitest assertions for testing HTML output'
+  spec.description   = [
+    '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'
+  spec.required_ruby_version = '>= 3.0.0'
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.
@@ -26,18 +32,14 @@ Gem::Specification.new do |spec|
   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'
-  
+
+  spec.platform         = Gem::Platform::RUBY
+  spec.extra_rdoc_files = ['README.md', 'LICENSE.txt']
+  spec.rdoc_options += ['--quiet', '--line-numbers', '--inline-source', '--title',
+                        'Minitest::HaveTag: assertions for testing HTML output', '--main', 'README.md']
+
+  spec.add_dependency('minitest', '~> 5.7', '>= 5.7.0')
+  spec.add_dependency('nokogiri')
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,153 +1,67 @@
 --- !ruby/object:Gem::Specification
 name: minitest-have_tag
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Kematzy
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-01-01 00:00:00.000000000 Z
+date: 2024-09-25 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:
+        version: '5.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.7.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:
+        version: '5.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.7.0
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   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
+description: '["Adds Minitest assertion for testing HTML output, including contents,
+  within a provided string"]'
 email:
 - kematzy@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -157,25 +71,32 @@ files:
 homepage: http://github.com/kematzy/minitest-have_tag
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
-rdoc_options: []
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options:
+- "--quiet"
+- "--line-numbers"
+- "--inline-source"
+- "--title"
+- 'Minitest::HaveTag: assertions for testing HTML output'
+- "--main"
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.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: 
+rubygems_version: 3.5.16
+signing_key:
 specification_version: 4
 summary: Minitest assertions for testing HTML output
 test_files: []

data/.travis.yml

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