warning_signs 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5dd43f86a3822293460f2d79efb2c2e98a5cb6a86ca5b85a3d762b4e9b82a8e
-  data.tar.gz: 9dd3da0dbd012564356f1c477038f9cd5b00652149c064aea4006224b408940f
+  metadata.gz: 4d9af94718f30c122c45153b7c2837ec2544ab06d3c3f5356b6062408e766d64
+  data.tar.gz: c038f7baf62f0f15c63041e47c54281e9c9c26c8dfc489f96c98780e7490b523
 SHA512:
-  metadata.gz: 4e73a2bc35a1283b56061fad2717c6b0c9ce19f91c34b81645bf57c9e4c09eee2f93f727529c107a54c2e47fa6a8d88b9958af522b3a12929d18f505924b734f
-  data.tar.gz: eb2050074df9f17103a57ebbf506cba97a9f0a4b17d82db8b968c359751edbb8787033c708d19b5bb2e2b57b49346f138576f9cd98552cca80f12578d4ce908a
+  metadata.gz: 5b47dd7876dec5213c03fb2774ee2add5a5da6f35d40dac9d33f8a27dd5767ac80bbc507b009d01887695184e2c24af5bd286028b41b647e56b63e1e3fc0f74b
+  data.tar.gz: 14618990cbda30ebb76dcf6d362b67c4eacdbb700005d3f1aef6c15dc98348a43e5c67323ed3b286ee1b37ad5d0a88b7a4d721ea78c20948baa8a97560d0fdb6

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 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
+* Ruby warning message better handles Ruby warning categories
+
 ## 0.3.0
 
 * Allow multiple behaviors in a single environment

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    warning_signs (0.3.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
@@ -150,3 +164,36 @@ handlers:
       - environment: other
         behavior: log
 ```
+
+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`.
+
+This handler only handles Ruby warnings that are deprecated, other warnings 
+are ignored.
+
+```yaml
+handlers:
+  - environment: all
+    ruby_warnings:
+      only:
+        - deprecated
+    behavior: log
+```
+
+This handler handles any Ruby warning with a category
+
+```yaml
+handlers:
+  - environment: all
+    ruby_warnings:
+      except:
+        - blank
+    behavior: log
+```
+
+## To Do:
+
+* 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,10 +1,12 @@
 module WarningSigns
   class Deprecation
-    attr_accessor :message, :source
+    attr_accessor :message, :source, :category, :backtrace
 
-    def initialize(message, source:)
+    def initialize(message, source:, category: nil, backtrace: nil)
       @message = message
       @source = source.to_s.downcase.inquiry
+      @category = category
+      @backtrace = backtrace
     end
 
     def handler
@@ -14,10 +16,16 @@ module WarningSigns
     # force raise to be the last element if it is present
     def behaviors
       result = (handler&.environment&.behaviors || []).inquiry
-      return result if !result.raise?
+      return result unless result.raise?
       (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
@@ -25,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
+    attr_accessor :environments, :except, :only, :source,
+      :category_matcher, :backtrace_lines
 
     def self.from_hash(hash)
       new(**hash.symbolize_keys)
@@ -13,7 +14,9 @@ module WarningSigns
       except: [],
       only: [],
       source: "any",
-      environments: []
+      environments: [],
+      ruby_warnings: {},
+      backtrace_lines: 0
     )
       @except = except.map { Pattern.for(_1) }
       @only = only.map { Pattern.for(_1) }
@@ -22,6 +25,8 @@ module WarningSigns
         @environments << Environment.new(environment: environment, behaviors: behaviors, behavior: behavior)
       end
       @source = source.to_s.downcase.inquiry
+      @category_matcher = RubyCategoryMatcher.new(**ruby_warnings.symbolize_keys)
+      @backtrace_lines = backtrace_lines
       raise InvalidHandlerError unless valid?
     end
 
@@ -35,7 +40,12 @@ module WarningSigns
 
     def match?(deprecation)
       source_match?(deprecation.source) &&
-        pattern_match?(deprecation.message)
+        pattern_match?(deprecation.message) &&
+        category_match?(deprecation.category)
+    end
+
+    def category_match?(category)
+      category_matcher.match?(category)
     end
 
     def pattern_match?(message)

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_category_matcher.rb

@@ -0,0 +1,29 @@
+module WarningSigns
+  class RubyCategoryMatcher
+    attr_accessor :only, :except
+
+    def initialize(only: [], except: [])
+      @only = only.compact.map { _1.to_sym }
+      @except = except.compact.map { _1.to_sym }
+    end
+
+    def match?(category)
+      category = :blank if category.blank?
+      only_match?(category) && except_match?(category)
+    end
+
+    def only_match?(category)
+      return true if only.empty?
+      only.any? do |only_pattern|
+        only_pattern === category&.to_sym
+      end
+    end
+
+    def except_match?(category)
+      return true if except.empty?
+      except.none? do |except_pattern|
+        except_pattern === category&.to_sym
+      end
+    end
+  end
+end

data/lib/warning_signs/ruby_deprecation_catcher.rb

@@ -1,20 +1,18 @@
 module WarningSigns
   module RubyDeprecationCatcher
-    def warn(message)
-      Deprecation.new(augmented_message(message), source: "ruby").invoke
+    include CallerLocationHelper
+    def warn(message, category: nil)
+      Deprecation.new(
+        augmented_message(message, category),
+        source: "ruby",
+        category: category,
+        backtrace: caller_locations[caller_location_start..]
+      ).invoke
     end
 
-    def augmented_message(message)
-      "RUBY DEPRECATION WARNING: #{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
+    def augmented_message(message, category)
+      category_part = category.present? ? " #{category.upcase}: " : ": "
+      "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.3.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.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Noel Rappin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-05 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
@@ -177,6 +178,7 @@ files:
 - lib/warning_signs/rails_deprecation_catcher.rb
 - lib/warning_signs/railtie.rb
 - lib/warning_signs/regex_pattern.rb
+- lib/warning_signs/ruby_category_matcher.rb
 - lib/warning_signs/ruby_deprecation_catcher.rb
 - lib/warning_signs/string_pattern.rb
 - lib/warning_signs/version.rb