warning_signs 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffe169d3fa9e10de71c8ca43c6ac4cf8dd3c036f716d9a9f608fc37ce01a1879
-  data.tar.gz: a7511cdd8e836b8e1906b8c44a9ea3ec3309918fd033935a05480f7179bc4722
+  metadata.gz: 4d9af94718f30c122c45153b7c2837ec2544ab06d3c3f5356b6062408e766d64
+  data.tar.gz: c038f7baf62f0f15c63041e47c54281e9c9c26c8dfc489f96c98780e7490b523
 SHA512:
-  metadata.gz: babffad1137746742209cf4fe4adc14f7b2a905684b31f8e68569ccdcc9806945b88e690b75262bf62b9c4d09be77eb87cc5c7aeac58bc947d3ff3165eda9854
-  data.tar.gz: 23750e8b4849c3a1bd2d349fb26696e36eb34afcd71e0e3cb04619ed32234549f880cdc5f28e2d1da5fc57b1b1b519fc705ea75fe00de582c82e8612129473e8
+  metadata.gz: 5b47dd7876dec5213c03fb2774ee2add5a5da6f35d40dac9d33f8a27dd5767ac80bbc507b009d01887695184e2c24af5bd286028b41b647e56b63e1e3fc0f74b
+  data.tar.gz: 14618990cbda30ebb76dcf6d362b67c4eacdbb700005d3f1aef6c15dc98348a43e5c67323ed3b286ee1b37ad5d0a88b7a4d721ea78c20948baa8a97560d0fdb6

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.5.0
+
+* Allow handlers to print out backtraces for log, stdout, and stderr behaviors
+
 ## 0.4.0
 
 * Allow handlers to take into account Ruby warning categories

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    warning_signs (0.4.0)
+    warning_signs (0.5.0)
       awesome_print
       railties
 

data/README.md

@@ -2,10 +2,10 @@
 
 The Warning Signs gem builds upon the ideas of the
 [Ruby Warning Gem](https://github.com/jeremyevans/ruby-warning) 
-and [Stop Ignoring Your Ruby and Rails Deprecations](https://blog.testdouble.com/posts/2023-04-24-stop-ignoring-your-ruby-and-rails-deprecations/).
+and [Stop ignoring your Rails (and Ruby) deprecations!](https://blog.testdouble.com/posts/2023-04-24-stop-ignoring-your-ruby-and-rails-deprecations/).
 
 The idea is to provide an easily-configurable way to manage deprecation 
-warnings from Ruby and Rails to support your upgrade tool.
+warnings from Ruby and Rails to support your upgrades.
 
 ## Installing Warning Signs
 
@@ -18,7 +18,7 @@ under some use cases, you may not need it in production.
 
 ## Using Warning Signs
 
-The Warning Signs  gem looks for a `.warning_sign.yml` file when the Rails 
+The Warning Signs gem looks for a `.warning_signs.yml` file when the Rails
 application starts. If it does not find the file, it will not load and the 
 processing of deprecations will be unaffected.
 
@@ -50,7 +50,7 @@ Handlers are matched in order. If no handler applies to a deprecation
 warning, Ruby warnings is ignored, Rails warnings are passed through
 the ActiveSupport notification mechanism.
 
-The following sample logs all deprecation warnings:
+The following example logs all deprecation warnings:
 
 ```yaml
 handlers:
@@ -98,6 +98,20 @@ No matter what order you have the behaviors in, a `raise` behavior will be
 executed last so that the other behaviors happen before the exception is 
 invoked.
 
+The attribute `backtrace_lines` can be used to print extra lines of the 
+backtrace to the output for the `log`, `stderr`, and `stdout` behaviors. 
+Currently, it's one attribute that applies to all behaviors. This can be 
+useful, especially if the direct cause of the issue is in a gem.
+
+```yaml
+handlers:
+  - environment: all
+    backtrace_lines: 5
+    behaviors: 
+      - raise
+      - log
+```
+
 A common pattern is to focus only on specific deprecations and ignore others.
 For example, this setting file would raise on Ruby keyword argument 
 deprecations and ignore other ruby deprecations
@@ -155,7 +169,7 @@ Ruby warnings can have an optional category, there are two predefined
 categories, `deprecated` and `experimental`. You can specify a handler to 
 match those categories based on an "only" or "except" matcher. If you want 
 to specially handle warnings that do not have a defined category, you can 
-refer to them as `blank`,
+refer to them as `blank`.
 
 This handler only handles Ruby warnings that are deprecated, other warnings 
 are ignored.
@@ -182,5 +196,4 @@ handlers:
 
 ## To Do:
 
-* write to standard out as a behavior
 * Ability to customize output message format

data/lib/warning_signs/caller_location_helper.rb

@@ -0,0 +1,17 @@
+module WarningSigns
+  module CallerLocationHelper
+    def caller_location_start
+      caller_locations.find_index do |location|
+        !ignore_line(location.to_s)
+      end || 0
+    end
+
+    def ignore_line(line)
+      line.include?("<internal:") ||
+        line.include?("warning_signs/lib") ||
+        line.include?("warning_signs/spec") ||
+        line.include?("rubygems") ||
+        line.include?("/gems")
+    end
+  end
+end

data/lib/warning_signs/deprecation.rb

@@ -1,11 +1,12 @@
 module WarningSigns
   class Deprecation
-    attr_accessor :message, :source, :category
+    attr_accessor :message, :source, :category, :backtrace
 
-    def initialize(message, source:, category: nil)
+    def initialize(message, source:, category: nil, backtrace: nil)
       @message = message
       @source = source.to_s.downcase.inquiry
       @category = category
+      @backtrace = backtrace
     end
 
     def handler
@@ -19,6 +20,12 @@ module WarningSigns
       (result - ["raise"]) << "raise"
     end
 
+    def backtrace_lines
+      lines = handler&.backtrace_lines || 0
+      return "" if lines.zero?
+      backtrace[1..lines].join("\n")
+    end
+
     def invoke
       behaviors.each do |behavior|
         case behavior
@@ -26,8 +33,13 @@ module WarningSigns
           raise UnhandledDeprecationError, message
         when "log"
           Rails.logger.warn(message)
+          backtrace_lines.split("\n").each { Rails.logger.warn(_1) }
         when "stderr"
           $stderr.puts(message) # standard:disable Style/StderrPuts
+          $stderr.puts(backtrace_lines) # standard:disable Style/StderrPuts
+        when "stdout"
+          $stdout.puts(message) # standard:disable Style/StdoutPuts
+          $stdout.puts(backtrace_lines) # standard:disable Style/StdoutPuts
         end
       end
     end

data/lib/warning_signs/handler.rb

@@ -1,6 +1,7 @@
 module WarningSigns
   class Handler
-    attr_accessor :environments, :except, :only, :source, :category_matcher
+    attr_accessor :environments, :except, :only, :source,
+      :category_matcher, :backtrace_lines
 
     def self.from_hash(hash)
       new(**hash.symbolize_keys)
@@ -14,7 +15,8 @@ module WarningSigns
       only: [],
       source: "any",
       environments: [],
-      ruby_warnings: {}
+      ruby_warnings: {},
+      backtrace_lines: 0
     )
       @except = except.map { Pattern.for(_1) }
       @only = only.map { Pattern.for(_1) }
@@ -24,6 +26,7 @@ module WarningSigns
       end
       @source = source.to_s.downcase.inquiry
       @category_matcher = RubyCategoryMatcher.new(**ruby_warnings.symbolize_keys)
+      @backtrace_lines = backtrace_lines
       raise InvalidHandlerError unless valid?
     end
 

data/lib/warning_signs/rails_deprecation_catcher.rb

@@ -1,9 +1,14 @@
 module WarningSigns
   class RailsDeprecationCatcher < ActiveSupport::Subscriber
+    include CallerLocationHelper
     attach_to :rails
 
     def deprecation(event)
-      Deprecation.new(event.payload[:message], source: "rails").invoke
+      Deprecation.new(
+        event.payload[:message],
+        source: "rails",
+        backtrace: caller_locations[caller_location_start..]
+      ).invoke
     end
   end
 end

data/lib/warning_signs/ruby_deprecation_catcher.rb

@@ -1,25 +1,18 @@
 module WarningSigns
   module RubyDeprecationCatcher
+    include CallerLocationHelper
     def warn(message, category: nil)
       Deprecation.new(
         augmented_message(message, category),
         source: "ruby",
-        category: category
+        category: category,
+        backtrace: caller_locations[caller_location_start..]
       ).invoke
     end
 
     def augmented_message(message, category)
       category_part = category.present? ? " #{category.upcase}: " : ": "
-      "RUBY WARNING#{category_part}#{message} called from #{caller_location}"
-    end
-
-    def caller_location
-      caller_locations.find do |location|
-        !location.to_s.include?("internal:warning") &&
-          !location.to_s.include?("warning_signs") &&
-          !location.to_s.include?("rubygems") &&
-          !location.to_s.include?("/gems")
-      end
+      "RUBY WARNING#{category_part}#{message} called from #{caller_locations[caller_location_start]}"
     end
   end
 end

data/lib/warning_signs/version.rb

@@ -1,3 +1,3 @@
 module WarningSigns
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: warning_signs
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Noel Rappin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
+date: 2023-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -170,6 +170,7 @@ files:
 - bin/console
 - bin/setup
 - lib/warning_signs.rb
+- lib/warning_signs/caller_location_helper.rb
 - lib/warning_signs/deprecation.rb
 - lib/warning_signs/environment.rb
 - lib/warning_signs/handler.rb