with_clues 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a9250314165c2529d8ac1a12ccc085a2abf2098f057b5778b1544c34dff21f9c
+  data.tar.gz: 9f737b4264d64955b17174ac44c9336d8dfa8fe79152b00cf96447b48ac15208
+SHA512:
+  metadata.gz: 9bf1631b167e606916d8d7e87bba3236bf829c0614c722b05fc5ac99c103cd96fb44f4c1e548bbcdbfcc71205e3661ba9d9d58f0a844cf7c004dc618174ab253
+  data.tar.gz: cdb5e7836e91a48764ad70afeeed9f1aeaf872b3cf748c4663431e522cfc7f4006a00045ab7a03b7fa905d9865f5442dba5621b0e47172fa3c18b4738d1022fe

data/.circleci/config.yml

@@ -0,0 +1,35 @@
+version: 2.1
+orbs:
+  # See https://circleci.com/developer/orbs/orb/circleci/ruby
+  ruby: circleci/ruby@1.1.2
+jobs:                # keyword
+  test:              # my name for the job
+    parameters:      # keyword
+      ruby-version:  # my parameter name
+        type: string # type is a keyword
+    docker:          # keyword
+      - image: cimg/base:stable
+    steps:                                       # keyword
+      - checkout                                 # magic name
+      - ruby/install:                            # ruby/ is from the orb name, install is a command in that orb
+          version: << parameters.ruby-version >> # magic nonsense for param subst
+      - run:
+          command: "bin/setup"
+      - run:
+          name: "Create the test results directory because you can't just store_test_results with a file and if you do you do not get any sort of error because wtf is with this platform?"
+          command: mkdir -p /tmp/test-results
+      - run:
+          command: bin/ci /tmp/test-results/rspec_results.xml
+      - store_test_results:                      # store_test_results is magic from circle
+          path: /tmp/test-results                # path is a param to store_test_results and it must be a directory not a file
+      - store_artifacts:                         # store_artifacts is magic from circle
+          path: /tmp/test-results                # path is the param to store_artifacts
+workflows:              # keyword
+  all-rubies:           # my name for the workflow
+    jobs:               # keyword
+      - test:           # my name for the job
+          matrix:       # keyword
+            parameters: # keyword
+              # All rubies being maintained per this page:
+              # https://www.ruby-lang.org/en/downloads/branches/
+              ruby-version: [ "2.5", "2.6", "2.7", "3.0" ]

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at davetron5000 (at) gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+

data/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# Contributing
+
+* Code changes for style, cleanliness, eleganance, or other aesthetic stuff will not be accepted.
+* All proposed changes must have a clear problem statement and be based on a real-world scenario. Imagined problems will not be solved.
+* Tests are appreciated with all pull requests.

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in with_clues.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/LICENSE.md

@@ -0,0 +1,33 @@
+[with_clues] Copyright (2021) (David Copeland)(“Licensor”)
+
+Hippocratic License Version Number: 2.1.
+
+Purpose. The purpose of this License is for the Licensor named above to permit the Licensee (as defined below) broad permission, if consistent with Human Rights Laws and Human Rights Principles (as each is defined below), to use and work with the Software (as defined below) within the full scope of Licensor’s copyright and patent rights, if any, in the Software, while ensuring attribution and protecting the Licensor from liability.
+
+Permission and Conditions. The Licensor grants permission by this license (“License”), free of charge, to the extent of Licensor’s rights under applicable copyright and patent law, to any person or entity (the “Licensee”) obtaining a copy of this software and associated documentation files (the “Software”), to do everything with the Software that would otherwise infringe (i) the Licensor’s copyright in the Software or (ii) any patent claims to the Software that the Licensor can license or becomes able to license, subject to all of the following terms and conditions:
+
+* Acceptance. This License is automatically offered to every person and entity subject to its terms and conditions. Licensee accepts this License and agrees to its terms and conditions by taking any action with the Software that, absent this License, would infringe any intellectual property right held by Licensor.
+
+* Notice. Licensee must ensure that everyone who gets a copy of any part of this Software from Licensee, with or without changes, also receives the License and the above copyright notice (and if included by the Licensor, patent, trademark and attribution notice). Licensee must cause any modified versions of the Software to carry prominent notices stating that Licensee changed the Software. For clarity, although Licensee is free to create modifications of the Software and distribute only the modified portion created by Licensee with additional or different terms, the portion of the Software not modified must be distributed pursuant to this License. If anyone notifies Licensee in writing that Licensee has not complied with this Notice section, Licensee can keep this License by taking all practical steps to comply within 30 days after the notice. If Licensee does not do so, Licensee’s License (and all rights licensed hereunder) shall end immediately.
+
+* Compliance with Human Rights Principles and Human Rights Laws.
+
+    1. Human Rights Principles.
+
+        (a) Licensee is advised to consult the articles of the United Nations Universal Declaration of Human Rights and the United Nations Global Compact that define recognized principles of international human rights (the “Human Rights Principles”). Licensee shall use the Software in a manner consistent with Human Rights Principles.
+
+        (b) Unless the Licensor and Licensee agree otherwise, any dispute, controversy, or claim arising out of or relating to (i) Section 1(a) regarding Human Rights Principles, including the breach of Section 1(a), termination of this License for breach of the Human Rights Principles, or invalidity of Section 1(a) or (ii) a determination of whether any Law is consistent or in conflict with Human Rights Principles pursuant to Section 2, below, shall be settled by arbitration in accordance with the Hague Rules on Business and Human Rights Arbitration (the “Rules”); provided, however, that Licensee may elect not to participate in such arbitration, in which event this License (and all rights licensed hereunder) shall end immediately. The number of arbitrators shall be one unless the Rules require otherwise.
+
+        Unless both the Licensor and Licensee agree to the contrary: (1) All documents and information concerning the arbitration shall be public and may be disclosed by any party; (2) The repository referred to under Article 43 of the Rules shall make available to the public in a timely manner all documents concerning the arbitration which are communicated to it, including all submissions of the parties, all evidence admitted into the record of the proceedings, all transcripts or other recordings of hearings and all orders, decisions and awards of the arbitral tribunal, subject only to the arbitral tribunal's powers to take such measures as may be necessary to safeguard the integrity of the arbitral process pursuant to Articles 18, 33, 41 and 42 of the Rules; and (3) Article 26(6) of the Rules shall not apply.
+
+    2. Human Rights Laws. The Software shall not be used by any person or entity for any systems, activities, or other uses that violate any Human Rights Laws.  “Human Rights Laws” means any applicable laws, regulations, or rules (collectively, “Laws”) that protect human, civil, labor, privacy, political, environmental, security, economic, due process, or similar rights; provided, however, that such Laws are consistent and not in conflict with Human Rights Principles (a dispute over the consistency or a conflict between Laws and Human Rights Principles shall be determined by arbitration as stated above).  Where the Human Rights Laws of more than one jurisdiction are applicable or in conflict with respect to the use of the Software, the Human Rights Laws that are most protective of the individuals or groups harmed shall apply.
+
+    3. Indemnity. Licensee shall hold harmless and indemnify Licensor (and any other contributor) against all losses, damages, liabilities, deficiencies, claims, actions, judgments, settlements, interest, awards, penalties, fines, costs, or expenses of whatever kind, including Licensor’s reasonable attorneys’ fees, arising out of or relating to Licensee’s use of the Software in violation of Human Rights Laws or Human Rights Principles.
+
+* Failure to Comply. Any failure of Licensee to act according to the terms and conditions of this License is both a breach of the License and an infringement of the intellectual property rights of the Licensor (subject to exceptions under Laws, e.g., fair use). In the event of a breach or infringement, the terms and conditions of this License may be enforced by Licensor under the Laws of any jurisdiction to which Licensee is subject. Licensee also agrees that the Licensor may enforce the terms and conditions of this License against Licensee through specific performance (or similar remedy under Laws) to the extent permitted by Laws. For clarity, except in the event of a breach of this License, infringement, or as otherwise stated in this License, Licensor may not terminate this License with Licensee.
+
+* Enforceability and Interpretation. If any term or provision of this License is determined to be invalid, illegal, or unenforceable by a court of competent jurisdiction, then such invalidity, illegality, or unenforceability shall not affect any other term or provision of this License or invalidate or render unenforceable such term or provision in any other jurisdiction; provided, however, subject to a court modification pursuant to the immediately following sentence, if any term or provision of this License pertaining to Human Rights Laws or Human Rights Principles is deemed invalid, illegal, or unenforceable against Licensee by a court of competent jurisdiction, all rights in the Software granted to Licensee shall be deemed null and void as between Licensor and Licensee. Upon a determination that any term or provision is invalid, illegal, or unenforceable, to the extent permitted by Laws, the court may modify this License to affect the original purpose that the Software be used in compliance with Human Rights Principles and Human Rights Laws as closely as possible. The language in this License shall be interpreted as to its fair meaning and not strictly for or against any party.
+
+* Disclaimer. TO THE FULL EXTENT ALLOWED BY LAW, THIS SOFTWARE COMES “AS IS,” WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED, AND LICENSOR AND ANY OTHER CONTRIBUTOR SHALL NOT BE LIABLE TO ANYONE FOR ANY DAMAGES OR OTHER LIABILITY ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THIS LICENSE, UNDER ANY KIND OF LEGAL CLAIM.
+
+This Hippocratic License is an Ethical Source license (https://ethicalsource.dev) and is offered for use by licensors and licensees at their own risk, on an “AS IS” basis, and with no warranties express or implied, to the maximum extent permitted by Laws.

data/README.md

@@ -0,0 +1,159 @@
+# `with_clues` - temporarily provide more context when tests fail. Beats `puts`
+
+Suppose you have this:
+
+```ruby
+expect(page).to have_content("My Awesome Site")
+```
+
+And Capybara says that that content is not there and that is all it says.  You might slap in a `puts page.html` and try again.
+Instead, what if you could not do that and do this?
+
+```ruby
+with_clues do
+  expect(page).to have_content("My Awesome Site")
+end
+```
+
+And *that* would print out your HTML?  Or your JavaScript console?  Or whatever else?  Neat, right?
+
+## Install
+
+```
+gem install with_clues
+```
+
+Or, in `Gemfile`:
+
+```ruby
+gem "with_clues"
+```
+
+For Rails, you might want to do this:
+
+```ruby
+gem "with_clues", group: :test
+```
+
+Then `bundle install`
+
+## Setup
+
+Best thing to do is mix into your base test class.
+
+### For Minitest
+
+If you are using Rails, probably something like this:
+
+```ruby
+# test/test_helper.rb
+require "with_clues"
+
+class ActiveSupport::TestCase
+  include WithClues::Method
+
+  # ...
+end
+```
+
+If you aren't using Rails, add the `require` and `include` wherever you configure your base test case (or just put it in each test individually).
+
+### For RSpec
+
+You'll want to put this in your `spec/spec_helper.rb` file:
+
+```ruby
+require "with_clues"
+RSpec.configure do |c|
+  c.include WithClues::Method
+end
+```
+
+## Use
+
+In general, you would not want to wrap all tests with `with_clues`.  This is a diagnostic tool to allow you to get more
+information on a test that is failing.  As such, your workflow might be:
+
+1. Notice a test failing that you cannot easily diagnose
+1. Wrap the failing assertion in `with_clues`:
+
+   ```ruby
+   with_clues do
+     expect(page).to have_selector("div.foo.bar")
+   end
+   ```
+1. Run the test again, and see the additional info.
+1. Once you've made the test pass, remove `with_clues`
+
+## Included Clues
+
+There are three clues included:
+
+* Dumping HTML - when `page` exists, it will dump the contents of `page.html` when the test fails
+* Dumping Browser logs - for a browser-based test, it will dump anything that was `console.log`'ed
+* Arbitrary context you pass in, for example when testing an Active Record
+
+  ```ruby
+  person = Person.where(name: "Pat")
+  with_clues(person.inspect) do
+    expect(person.valid?).to eq(true)
+  end
+  ```
+
+  If the test fails, `person.inspect` is included in the output
+
+## Adding Your Own Clues
+
+`with_clues` is intended as a diagnostic tool you can develop and enhance over time.  As your team writes more code or develops
+more conventions, you can develop diagnostics as well.
+
+To add one, create a class that implements `dump(notifier, context:)`:
+
+* `notifier` is a `WithClues::Notifier` that you should use to produce output:
+  * `notify` - output text, preceded with `[ with_clues ]` (this is so you can tell output from your code vs from `with_clues`)
+  * `blank_line` - a blank line (no prefix)
+  * `notify_raw` - output text without a prefix, useful for removing ambiguity about what is being output
+* `context:` the context passed into `with_clues` (nil if it was omitted)
+
+For example, suppose you want to output information about an Active Record like so:
+
+```ruby
+with_clues(person) do
+  # some test
+end
+```
+
+If this test fails, you output the person's ID and any `errors`.
+
+Create this class, e.g. in `spec/support/active_record_clues.rb`:
+
+```ruby
+class ActiveRecordClues
+  def dump(notifier, context:)
+    if context.kind_of?(ActiveRecord::Base)
+      notifier.notify "#{context.class}: id: #{context.id}"
+      notifier.notify "#{context.class}: errors: #{context.errors.inspect}"
+    end
+  end
+end
+```
+
+To use it, call `WithClues::Method.use_custom_clue`, for example, in your `spec_helper.rb`:
+
+```ruby
+require "with_clues"
+require_relative "support/active_record_clues"
+
+RSpec.configure do |c|
+  c.include WithClues::Method
+end
+
+WithClues::Method.use_custom_clue ActiveRecordClues
+```
+
+You can use multiple clues by repeatedly calling `use_custom_clue`
+
+## Developing
+
+* Get set up with `bin/setup`
+* Run tests with `bin/ci`

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/ci

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+set -e
+echo "[bin/ci] Running tests"
+if [ -z $1 ]; then
+  bin/rspec --format=doc
+else
+  echo "[bin/ci] Generating JUnit XML output to $1"
+  bin/rspec --format RspecJunitFormatter --out $1 --format=doc
+fi

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "with_clues"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/mk_gem

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+
+require "fileutils"
+require "pathname"
+
+include FileUtils
+
+gem_name = ARGV[0]
+
+if gem_name.nil?
+  puts "usage: #{$0} gem_name"
+  exit 1
+end
+
+root = Pathname(__FILE__).dirname / ".."
+
+module_name = gem_name.split(/_/).map { |part|
+  part.capitalize
+}.join
+
+mkdir_p root / "lib"
+
+File.open(root / "lib" / "#{gem_name}.rb", "w") do |file|
+  file.puts "module #{module_name}"
+  file.puts "end"
+end
+
+mkdir_p root / "lib" / gem_name
+
+File.open(root / "lib" / gem_name / "version.rb", "w") do |file|
+  file.puts "module #{module_name}"
+  file.puts "  VERSION=\"1.0.0\""
+  file.puts "end"
+end
+
+gemspec = File.read("rubygem.gemspec")
+File.open(root / "#{gem_name}.gemspec","w") do |file|
+  file.puts "require_relative \"lib/#{gem_name}/version\""
+  file.puts
+  gemspec.split(/\n/).each do |line|
+    if line =~ /^\s*spec.name/
+      file.puts "  spec.name = \"#{gem_name}\""
+    elsif line =~ /^\s*spec.version/
+      file.puts "  spec.version = #{module_name}::VERSION"
+    elsif line.include?("«gem_name»")
+      file.puts line.gsub(/«gem_name»/,gem_name)
+    else
+      file.puts line
+    end
+  end
+end
+
+license = File.read(root / "LICENSE.md")
+File.open(root / "LICENSE.md","w") do |file|
+  license.split(/\n/).each_with_index do |line,index|
+    if index == 0
+      file.puts "[#{gem_name}] Copyright (2021) (David Copeland)(“Licensor”)"
+    else
+      file.puts line
+    end
+  end
+end
+
+readme = File.read(root / "README.md")
+File.open(root / "README.md","w") do |file|
+  license.split(/\n/).each_with_index do |line,index|
+    if index == 0
+      file.puts "# #{gem_name} - does a thing"
+    else
+      file.puts line
+    end
+  end
+end

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle check || bundle install

data/lib/with_clues.rb

@@ -0,0 +1,3 @@
+module WithClues
+end
+require_relative "with_clues/method"

data/lib/with_clues/browser_logs.rb

@@ -0,0 +1,29 @@
+module WithClues
+  class BrowserLogs
+    def dump(notifier, page:, context:)
+      if !page.respond_to?(:driver)
+        notifier.notify "Something may be wrong. page (#{page.class}) does not respond to #driver"
+        return
+      end
+      if page.driver.respond_to?(:browser)
+        if page.driver.browser.respond_to?(:manage)
+          if page.driver.browser.manage.respond_to?(:logs)
+            logs = page.driver.browser.manage.logs
+            browser_logs = logs.get(:browser)
+            notifier.notify "BROWSER LOGS {"
+            browser_logs.each do |log|
+              notifier.notify_raw log.message
+            end
+            notifier.notify "} END BROWSER LOGS"
+          else
+            notifier.notify "NO BROWSER LOGS: page.driver.browser.manage #{page.driver.browser.manage.class} does not respond to #logs"
+          end
+        else
+          notifier.notify "NO BROWSER LOGS: page.driver.browser #{page.driver.browser.class} does not respond to #manage"
+        end
+      else
+        notifier.notify "NO BROWSER LOGS: page.driver #{page.driver.class} does not respond to #browser"
+      end
+    end
+  end
+end

data/lib/with_clues/html.rb

@@ -0,0 +1,16 @@
+module WithClues
+  class Html
+    def dump(notifier, page:, context:)
+      if !page.respond_to?(:html)
+        notifier.notify "Something may be wrong. page (#{page.class}) does not respond to #html"
+        return
+      end
+      notifier.blank_line
+      notifier.notify "HTML {"
+      notifier.blank_line
+      notifier.notify_raw page.html
+      notifier.blank_line
+      notifier.notify "} END HTML"
+    end
+  end
+end

data/lib/with_clues/method.rb

@@ -0,0 +1,40 @@
+require_relative "html"
+require_relative "browser_logs"
+require_relative "notifier"
+
+module WithClues
+  module Method
+    @@clue_classes = {
+      require_page: [
+        WithClues::BrowserLogs,
+        WithClues::Html,
+      ],
+      custom: []
+    }
+    # Wrap any assertion with this method to get more
+    # useful context and diagnostics when a test is
+    # unexpectedly failing
+    def with_clues(context=nil, &block)
+      notifier = WithClues::Notifier.new($stdout)
+      block.()
+      notifier.notify "A passing test has been wrapped with `with_clues`. You should remove the call to `with_clues`"
+    rescue Exception => ex
+      notifier.notify context
+      @@clue_classes[:custom].each do |klass|
+        klass.new.dump(notifier, context: context)
+      end
+      if !defined?(page)
+        raise ex
+      end
+      notifier.notify "Test failed: #{ex.message}"
+      @@clue_classes[:require_page].each do |klass|
+        klass.new.dump(notifier, context: context, page: page)
+      end
+      raise ex
+    end
+
+    def self.use_custom_clue(klass)
+      @@clue_classes[:custom] << klass
+    end
+  end
+end

data/lib/with_clues/notifier.rb

@@ -0,0 +1,19 @@
+module WithClues
+  class Notifier
+    def initialize(io)
+      @io = io
+    end
+
+    def blank_line
+      self.notify_raw("")
+    end
+
+    def notify(message)
+      @io.puts "[ with_clues ] #{message}"
+    end
+
+    def notify_raw(message)
+      @io.puts message
+    end
+  end
+end

data/lib/with_clues/version.rb

@@ -0,0 +1,3 @@
+module WithClues
+  VERSION="1.0.0"
+end

data/with_clues.gemspec

@@ -0,0 +1,31 @@
+require_relative "lib/with_clues/version"
+
+#require_relative "lib/«gem»/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "with_clues"
+  spec.version = WithClues::VERSION
+  spec.authors       = ["Dave Copeland"]
+  spec.email         = ["davec@naildrivin5.com"]
+  spec.summary       = %q{WTF does this do?}
+  spec.homepage      = "https://sustainable-rails.com"
+  spec.license       = "Hippocratic"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/sustainable-rails/with_clues"
+  spec.metadata["changelog_uri"] = "https://github.com/sustainable-rails/with_clues/releases"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency("rspec")
+  spec.add_development_dependency("minitest")
+  spec.add_development_dependency("capybara")
+  spec.add_development_dependency("rspec_junit_formatter")
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: with_clues
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dave Copeland
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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
+  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: capybara
+  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: rspec_junit_formatter
+  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:
+email:
+- davec@naildrivin5.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/ci
+- bin/console
+- bin/mk_gem
+- bin/rake
+- bin/rspec
+- bin/setup
+- lib/with_clues.rb
+- lib/with_clues/browser_logs.rb
+- lib/with_clues/html.rb
+- lib/with_clues/method.rb
+- lib/with_clues/notifier.rb
+- lib/with_clues/version.rb
+- with_clues.gemspec
+homepage: https://sustainable-rails.com
+licenses:
+- Hippocratic
+metadata:
+  homepage_uri: https://sustainable-rails.com
+  source_code_uri: https://github.com/sustainable-rails/with_clues
+  changelog_uri: https://github.com/sustainable-rails/with_clues/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: WTF does this do?
+test_files: []