Clearer deprecation message on error

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.6.1 Dec 15, 2023
+
+* Warning Signs error message makes it clearer that Warning Signs is 
+  triggering the error
+
 ## 0.6.0
 
 * Allow for format options in messages

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    warning_signs (0.6.0)
+    warning_signs (0.6.1)
       awesome_print
       railties (<= 7.1.0)
 

lib/warning_signs.rb

@@ -14,8 +14,6 @@ module WarningSigns
   SAMPLE_CONSTANT = "foobar"
 
   class InvalidHandlerError < StandardError; end
-
-  class UnhandledDeprecationError < StandardError; end
 end
 
 loader.eager_load

lib/warning_signs/unhandled_deprecation_error.rb

@@ -0,0 +1,9 @@
+module WarningSigns
+  class UnhandledDeprecationError < StandardError
+    MESSAGE = "This error was raised by the Warning Signs gem in response to a deprecation warning in Ruby or Rails. If this warning is not causing problems, you can add it to the exceptions list in .warning_signs.yml."
+
+    def message
+      super + "\n\n" + MESSAGE
+    end
+  end
+end

lib/warning_signs/version.rb

@@ -1,3 +1,3 @@
 module WarningSigns
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

spec/warning_signs/unhandled_deprecation_error_spec.rb

@@ -0,0 +1,8 @@
+module WarningSigns
+  RSpec.describe UnhandledDeprecationError do
+    it "handles warnings" do
+      exe = UnhandledDeprecationError.new("Feature x is going away")
+      expect(exe.message.ends_with?("exceptions list in .warning_signs.yml.")).to be_truthy
+    end
+  end
+end