warning_signs 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffe169d3fa9e10de71c8ca43c6ac4cf8dd3c036f716d9a9f608fc37ce01a1879
-  data.tar.gz: a7511cdd8e836b8e1906b8c44a9ea3ec3309918fd033935a05480f7179bc4722
+  metadata.gz: 52cb05e7b564245d88a8ef7906fce215c31ebe482cdaaee537d738004f8c35c8
+  data.tar.gz: e8ad757904f8c87f2a5afe3c486873ffb4b955cd711be81a6021390284c35691
 SHA512:
-  metadata.gz: babffad1137746742209cf4fe4adc14f7b2a905684b31f8e68569ccdcc9806945b88e690b75262bf62b9c4d09be77eb87cc5c7aeac58bc947d3ff3165eda9854
-  data.tar.gz: 23750e8b4849c3a1bd2d349fb26696e36eb34afcd71e0e3cb04619ed32234549f880cdc5f28e2d1da5fc57b1b1b519fc705ea75fe00de582c82e8612129473e8
+  metadata.gz: 41cc8a65c3e4b37dab7904d8537459ae84f0badfc00b013cf15c888fc072c913e69963bf663e1c9a735274e1029b01f0fc782a4b76f1d98b693a333556667e0f
+  data.tar.gz: 33d9f42ca6d9dabf5e8501805b4db5cc62b54a4264b542d5f2fa110b2b7df3edc6fbcafcaa89e1c7b4828515cfdae4c745154df0002e3f8880757d26a056683c

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 0.6.0
+
+* Allow for format options in messages
+* Allow for filter options in backtrace
+* Allow for multiple output behaviors based on environment
+
+## 0.5.1
+
+* Better filtering of backtraces 
+
+## 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,9 +1,9 @@
 PATH
   remote: .
   specs:
-    warning_signs (0.4.0)
+    warning_signs (0.6.0)
       awesome_print
-      railties
+      railties (<= 7.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -41,16 +41,16 @@ GEM
     json (2.6.3)
     language_server-protocol (3.17.0.3)
     lint_roller (1.0.0)
-    loofah (2.20.0)
+    loofah (2.21.3)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
+      nokogiri (>= 1.12.0)
     method_source (1.0.0)
     minitest (5.18.0)
-    nokogiri (1.14.3-arm64-darwin)
+    nokogiri (1.15.0-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.14.3-x86_64-darwin)
+    nokogiri (1.15.0-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.14.3-x86_64-linux)
+    nokogiri (1.15.0-x86_64-linux)
       racc (~> 1.4)
     parallel (1.23.0)
     parser (3.2.2.1)
@@ -130,7 +130,7 @@ GEM
     standard-performance (1.0.1)
       lint_roller (~> 1.0)
       rubocop-performance (~> 1.16.0)
-    thor (1.2.1)
+    thor (1.2.2)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)

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
 
@@ -16,9 +16,11 @@ To install Warning Signs add
 to your gemfile, you will most likely want it to be in all environments, but 
 under some use cases, you may not need it in production.
 
+### Rails 7.1 is not supported yet, it changed intenral deprecation objects
+
 ## 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.
 
@@ -26,6 +28,8 @@ You should remove any environment settings in Rails that are managing
 `config.active_support.deprecation`, or at least those that are not
 set to `:notify` -- use WarningSigns to handle those settings...
 
+### Handlers
+
 Warning Signs  allows you to define _handlers_ in the YAML file. A handler 
 consists of the following:
 
@@ -50,7 +54,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:
@@ -58,6 +62,8 @@ handlers:
     behavior: log
 ```
 
+### Environments
+
 Multiple environments need to be handled in a nested list. This example 
 raises exceptions in the test environment, but logs in other environments
 
@@ -70,6 +76,8 @@ handlers:
         behavior: log
 ```
 
+### Sources
+
 This example raises exceptions for Ruby deprecations, but ignores Rails 
 deprecations:
 
@@ -98,6 +106,96 @@ 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.
 
+### Message Formatters
+
+Message formatters can affect how and what data is passed to the output 
+channel. You can define one handler:
+
+```yaml
+handlers:
+  - environment: all
+    behavior: log
+    message_formatter:
+      backtrace_lines: 3
+      format: hash
+      filter_backtrace: filter_internals
+```
+
+There are a few attributes of message formatter that you can set
+
+* `backtrace_lines` is the number of filtered lines of backtrace, after the 
+  current line, that are sent to the output. The default is zero. (For 
+  raising exceptions, the default is the entire backtrace).
+* `format` can be `text`, `json`, `hash`, or `yaml`. Non text formats are 
+  hashes with keys `message` and `backtrace`, with the `json` and `yaml` 
+  formats converted to strings in those formats.
+* `filter_backtrace` has three settings. The default is `yes`, which filters 
+  out Ruby internals, references to warning signs itself, and lines from 
+  gems. To not filter at all, say `no`. To filter internals but not gems, 
+  say `filter_internals`.
+
+If a message formatter is not specified, the default is a hash with zero 
+backtrace lines.
+
+Or you can define multiple message formatters. These can separate format 
+based on output behavior.
+
+In this example, `log` behaviors are sent in hash format, while `stderr` 
+behaviors are sent in `text` format. Instead of an `only` list, an `except` 
+list can be specified.
+
+```yaml
+handlers:
+  - environment: all
+    behaviors:
+      - log
+      - stderr
+      - raise
+    message_formatters:
+      - backtrace_lines: 3
+        format: hash
+        behaviors:
+          only:
+            - log
+      - backtrace_lines: 3
+        format: text
+        behaviors:
+          only:
+            - stderr
+```
+
+You can also define multiple message formatters based on environment.
+
+In this case, logs in production get hash format, while logs in development 
+get yaml format.
+
+```yaml
+handlers:
+  - environment: all
+    behaviors:
+      - log
+    message_formatters:
+      - backtrace_lines: 3
+        format: hash
+        environments:
+          only:
+            - production
+      - backtrace_lines: 3
+        format: yaml
+        environments:
+          only:
+            - development
+```
+
+Environments can also be listed negatively with `except`.
+
+Environment and behavior matching can be used together.
+
+If no message formatter matches a given message, the default is text format 
+with no backtrace lines.
+
+### Pattern Matching
+
 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
@@ -151,11 +249,13 @@ handlers:
         behavior: log
 ```
 
+### Ruby Warning Types
+
 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.
@@ -179,8 +279,3 @@ handlers:
         - blank
     behavior: log
 ```
-
-## To Do:
-
-* write to standard out as a behavior
-* Ability to customize output message format

data/lib/warning_signs/behavior/base.rb

@@ -0,0 +1,28 @@
+module WarningSigns
+  module Behavior
+    class Base
+      attr_reader :message_formatter, :message, :backtrace
+
+      def self.for(behavior_type, *args)
+        class_name = "WarningSigns::Behavior::#{behavior_type.classify}"
+        class_name.constantize.new(*args)
+      end
+
+      def initialize(message, backtrace, message_formatter)
+        @message = message
+        @backtrace = backtrace
+        @message_formatter = message_formatter
+      end
+
+      def formatted_message
+        result = message_formatter.format_message(message, backtrace)
+        result = [result] unless result.is_a?(Array)
+        result
+      end
+
+      def emit
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/warning_signs/behavior/ignore.rb

@@ -0,0 +1,9 @@
+module WarningSigns
+  module Behavior
+    class Ignore < Base
+      def emit
+        # no-op
+      end
+    end
+  end
+end

data/lib/warning_signs/behavior/log.rb

@@ -0,0 +1,9 @@
+module WarningSigns
+  module Behavior
+    class Log < Base
+      def emit
+        formatted_message.each { Rails.logger.warn(_1) }
+      end
+    end
+  end
+end

data/lib/warning_signs/behavior/raise.rb

@@ -0,0 +1,16 @@
+module WarningSigns
+  module Behavior
+    class Raise < Base
+      def filtered_backtrace
+        return backtrace if message_formatter.backtrace_lines.zero?
+        message_formatter.filtered_backtrace(backtrace)
+      end
+
+      def emit
+        raise UnhandledDeprecationError,
+          formatted_message.first,
+          filtered_backtrace[1..].map(&:to_s)
+      end
+    end
+  end
+end

data/lib/warning_signs/behavior/stderr.rb

@@ -0,0 +1,11 @@
+# standard:disable Style/StderrPuts
+module WarningSigns
+  module Behavior
+    class Stderr < Base
+      def emit
+        formatted_message.each { $stderr.puts(_1) }
+      end
+    end
+  end
+end
+# standard:enable Style/StderrPuts

data/lib/warning_signs/behavior/stdout.rb

@@ -0,0 +1,11 @@
+# standard:disable Style/StdoutPuts
+module WarningSigns
+  module Behavior
+    class Stdout < Base
+      def emit
+        formatted_message.each { $stdout.puts(_1) }
+      end
+    end
+  end
+end
+# standard:enable Style/StdoutPuts

data/lib/warning_signs/caller_helper.rb

@@ -0,0 +1,20 @@
+module WarningSigns
+  module CallerHelper
+    def caller_filtered
+      caller.reject do |location|
+        ignore_line(location.to_s)
+      end
+    end
+
+    def ignore_line(line, filter_backtraces: "yes".inquiry)
+      return false if filter_backtraces.no?
+      partial_result = line.include?("<internal:") ||
+        line.include?("warning_signs/lib") ||
+        line.include?("warning_signs/spec")
+      return partial_result if filter_backtraces.filter_internals?
+      partial_result ||
+        line.include?("rubygems") ||
+        line.include?("/gems")
+    end
+  end
+end

data/lib/warning_signs/deprecation.rb

@@ -1,17 +1,22 @@
 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: [])
       @message = message
       @source = source.to_s.downcase.inquiry
       @category = category
+      @backtrace = backtrace || []
     end
 
     def handler
       World.instance.handler_for(self)
     end
 
+    def message_formatter_for(behavior)
+      handler.message_formatter_for(behavior)
+    end
+
     # force raise to be the last element if it is present
     def behaviors
       result = (handler&.environment&.behaviors || []).inquiry
@@ -20,15 +25,13 @@ module WarningSigns
     end
 
     def invoke
-      behaviors.each do |behavior|
-        case behavior
-        when "raise"
-          raise UnhandledDeprecationError, message
-        when "log"
-          Rails.logger.warn(message)
-        when "stderr"
-          $stderr.puts(message) # standard:disable Style/StderrPuts
-        end
+      behaviors.each do |behavior_type|
+        Behavior::Base.for(
+          behavior_type,
+          message,
+          backtrace,
+          message_formatter_for(behavior_type)
+        ).emit
       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, :only_except, :source,
+      :category_matcher, :backtrace_lines, :message_formatters
 
     def self.from_hash(hash)
       new(**hash.symbolize_keys)
@@ -14,27 +15,48 @@ module WarningSigns
       only: [],
       source: "any",
       environments: [],
-      ruby_warnings: {}
+      ruby_warnings: {},
+      message_formatter: nil,
+      message_formatters: []
     )
-      @except = except.map { Pattern.for(_1) }
-      @only = only.map { Pattern.for(_1) }
+      @only_except = OnlyExcept.new(
+        only: only.map { Pattern.for(_1) },
+        except: except.map { Pattern.for(_1) }
+      )
       @environments = environments.map { Environment.new(**_1.symbolize_keys) }
       if environment.present?
-        @environments << Environment.new(environment: environment, behaviors: behaviors, behavior: behavior)
+        @environments << Environment.new(
+          environment: environment,
+          behaviors: behaviors,
+          behavior: behavior
+        )
       end
       @source = source.to_s.downcase.inquiry
       @category_matcher = RubyCategoryMatcher.new(**ruby_warnings.symbolize_keys)
+      @message_formatters = MessageFormatterList.new(
+        message_formatters: message_formatters,
+        message_formatter: message_formatter
+      )
       raise InvalidHandlerError unless valid?
     end
 
+    def message_formatter_for(behavior)
+      message_formatters.behavior_match(behavior) ||
+        MessageFormatter::Text.new
+    end
+
     def valid?
-      except.empty? || only.empty?
+      only_except.valid?
     end
 
     def known_source?(deprecation_source)
       deprecation_source.in?(%w[ruby rails])
     end
 
+    def pattern_match?(message)
+      only_except.only_except_match?(message)
+    end
+
     def match?(deprecation)
       source_match?(deprecation.source) &&
         pattern_match?(deprecation.message) &&
@@ -45,29 +67,11 @@ module WarningSigns
       category_matcher.match?(category)
     end
 
-    def pattern_match?(message)
-      only_match?(message) && except_match?(message)
-    end
-
     def source_match?(deprecation_source)
       return known_source?(deprecation_source) if source.any?
       source == deprecation_source
     end
 
-    def only_match?(message)
-      return true if only.empty?
-      only.any? do |only_pattern|
-        only_pattern.match?(message)
-      end
-    end
-
-    def except_match?(message)
-      return true if except.empty?
-      except.none? do |except_pattern|
-        except_pattern.match?(message)
-      end
-    end
-
     def enabled_for_ruby?
       source.ruby? || source.all?
     end

data/lib/warning_signs/message_formatter/base.rb

@@ -0,0 +1,39 @@
+module WarningSigns
+  module MessageFormatter
+    class Base
+      include CallerHelper
+      attr_reader :backtrace_lines, :behaviors, :environments, :filter_backtraces
+
+      def self.for(**args)
+        args = args.symbolize_keys
+        type = args.delete(:format) || "text"
+        class_name = "WarningSigns::MessageFormatter::#{type.classify}"
+        class_name.constantize.new(**args)
+      end
+
+      def initialize(backtrace_lines: 0, behaviors: {}, environments: {}, filter_backtraces: "yes")
+        @backtrace_lines = backtrace_lines
+        @behaviors = OnlyExcept.new(**behaviors.symbolize_keys)
+        @environments = OnlyExcept.new(**environments.symbolize_keys)
+        @filter_backtraces = filter_backtraces.to_s.downcase.inquiry
+      end
+
+      def format_message(message, backtrace)
+        raise NotImplementedError
+      end
+
+      def filtered_backtrace(backtrace)
+        return [] if backtrace.nil?
+        result = backtrace.reject do |location|
+          ignore_line(location.to_s, filter_backtraces: filter_backtraces)
+        end
+        result.empty? ? backtrace : result
+      end
+
+      def filtered_backtrace_lines(backtrace)
+        return [] if backtrace_lines.zero?
+        filtered_backtrace(backtrace)[1..backtrace_lines] || []
+      end
+    end
+  end
+end

data/lib/warning_signs/message_formatter/hash.rb

@@ -0,0 +1,12 @@
+module WarningSigns
+  module MessageFormatter
+    class Hash < Base
+      def format_message(message, backtrace)
+        {
+          message: message,
+          backtrace: filtered_backtrace_lines(backtrace).map(&:to_s)
+        }
+      end
+    end
+  end
+end

data/lib/warning_signs/message_formatter/json.rb

@@ -0,0 +1,12 @@
+module WarningSigns
+  module MessageFormatter
+    class Json < Base
+      def format_message(message, backtrace)
+        {
+          message: message,
+          backtrace: filtered_backtrace_lines(backtrace).map(&:to_s)
+        }.to_json
+      end
+    end
+  end
+end

data/lib/warning_signs/message_formatter/text.rb

@@ -0,0 +1,9 @@
+module WarningSigns
+  module MessageFormatter
+    class Text < Base
+      def format_message(message, backtrace)
+        [message] + filtered_backtrace_lines(backtrace)
+      end
+    end
+  end
+end

data/lib/warning_signs/message_formatter/yaml.rb

@@ -0,0 +1,12 @@
+module WarningSigns
+  module MessageFormatter
+    class Yaml < Base
+      def format_message(message, backtrace)
+        {
+          message: message,
+          backtrace: filtered_backtrace_lines(backtrace).map(&:to_s)
+        }.to_yaml
+      end
+    end
+  end
+end

data/lib/warning_signs/message_formatter_list.rb

@@ -0,0 +1,25 @@
+module WarningSigns
+  class MessageFormatterList
+    include Enumerable
+
+    attr_reader :message_formatters
+
+    def initialize(message_formatters: [], message_formatter: nil)
+      @message_formatters = message_formatters.map do
+        MessageFormatter::Base.for(**_1)
+      end
+      @message_formatters << MessageFormatter::Base.for(**message_formatter) if message_formatter
+    end
+
+    def each(&block)
+      message_formatters.each(&block)
+    end
+
+    def behavior_match(behavior)
+      message_formatters.find do
+        _1.behaviors.only_except_match?(behavior) &&
+          _1.environments.only_except_match?(Rails.env)
+      end
+    end
+  end
+end

data/lib/warning_signs/only_except.rb

@@ -0,0 +1,32 @@
+module WarningSigns
+  class OnlyExcept
+    attr_accessor :only, :except
+
+    def initialize(only: [], except: [])
+      @only = only
+      @except = except
+    end
+
+    def only_except_match?(message)
+      only_match?(message) && except_match?(message)
+    end
+
+    def only_match?(message)
+      return true if only.empty?
+      only.any? do |only_pattern|
+        only_pattern.match?(message)
+      end
+    end
+
+    def except_match?(message)
+      return true if except.empty?
+      except.none? do |except_pattern|
+        except_pattern.match?(message)
+      end
+    end
+
+    def valid?
+      except.empty? || only.empty?
+    end
+  end
+end

data/lib/warning_signs/rails_deprecation_catcher.rb

@@ -3,7 +3,11 @@ module WarningSigns
     attach_to :rails
 
     def deprecation(event)
-      Deprecation.new(event.payload[:message], source: "rails").invoke
+      Deprecation.new(
+        event.payload[:message],
+        source: "rails",
+        backtrace: caller
+      ).invoke
     end
   end
 end

data/lib/warning_signs/ruby_deprecation_catcher.rb

@@ -1,25 +1,19 @@
 module WarningSigns
   module RubyDeprecationCatcher
+    include CallerHelper
+
     def warn(message, category: nil)
       Deprecation.new(
         augmented_message(message, category),
         source: "ruby",
-        category: category
+        category: category,
+        backtrace: caller
       ).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_filtered.first}"
     end
   end
 end

data/lib/warning_signs/version.rb

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

data/lib/warning_signs.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "English"
 require "yaml"
 require "rails/railtie"
 require "active_support/all"

data/warning_signs.gemspec

@@ -39,5 +39,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "yard"
 
   spec.add_runtime_dependency "awesome_print"
-  spec.add_runtime_dependency "railties"
+  spec.add_runtime_dependency "railties", "<= 7.1.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.6.0
 platform: ruby
 authors:
 - Noel Rappin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
+date: 2023-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -140,16 +140,16 @@ dependencies:
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 7.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 7.1.0
 description: A gem for managing ruby and rails deprecation warnings
 email:
 - noelrap@hey.com
@@ -170,9 +170,23 @@ files:
 - bin/console
 - bin/setup
 - lib/warning_signs.rb
+- lib/warning_signs/behavior/base.rb
+- lib/warning_signs/behavior/ignore.rb
+- lib/warning_signs/behavior/log.rb
+- lib/warning_signs/behavior/raise.rb
+- lib/warning_signs/behavior/stderr.rb
+- lib/warning_signs/behavior/stdout.rb
+- lib/warning_signs/caller_helper.rb
 - lib/warning_signs/deprecation.rb
 - lib/warning_signs/environment.rb
 - lib/warning_signs/handler.rb
+- lib/warning_signs/message_formatter/base.rb
+- lib/warning_signs/message_formatter/hash.rb
+- lib/warning_signs/message_formatter/json.rb
+- lib/warning_signs/message_formatter/text.rb
+- lib/warning_signs/message_formatter/yaml.rb
+- lib/warning_signs/message_formatter_list.rb
+- lib/warning_signs/only_except.rb
 - lib/warning_signs/pattern.rb
 - lib/warning_signs/rails_deprecation_catcher.rb
 - lib/warning_signs/railtie.rb