warning_signs 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f982e2333c10256fd6056e6cf26208949d18721a98d5fbb1bdf7c7de19092856
-  data.tar.gz: ab14c9f2b8116c49c5b711d5dfc651285cccd004c11b82acef60505505412ca3
+  metadata.gz: ffe169d3fa9e10de71c8ca43c6ac4cf8dd3c036f716d9a9f608fc37ce01a1879
+  data.tar.gz: a7511cdd8e836b8e1906b8c44a9ea3ec3309918fd033935a05480f7179bc4722
 SHA512:
-  metadata.gz: 11ea7552143006ab573fa74211b7306eedd136f7a738887a8ff16f51965d4c1778f2e7af8a2f152d1787b05644a684848e0f3efe6fdd600baeed20a0e1d9f6d4
-  data.tar.gz: 3536a9efdbc5ce68a0fa6243c456df00c8cfba30e8d523614173aa97a98c2bea6d4e7078f4b541ac2fa32ea925c09aac224dcd95f5d5ed9eeca63944a7b3432b
+  metadata.gz: babffad1137746742209cf4fe4adc14f7b2a905684b31f8e68569ccdcc9806945b88e690b75262bf62b9c4d09be77eb87cc5c7aeac58bc947d3ff3165eda9854
+  data.tar.gz: 23750e8b4849c3a1bd2d349fb26696e36eb34afcd71e0e3cb04619ed32234549f880cdc5f28e2d1da5fc57b1b1b519fc705ea75fe00de582c82e8612129473e8

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 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
+* Allow only and except matchers to be regular expressions
+
+## 0.2.0
+
+* Test for "other environment"
+
 ## 0.1.0
 
 * Smarter caller information for Ruby warnings

data/Gemfile.lock

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

data/README.md

@@ -83,6 +83,21 @@ handlers:
     behavior: ignore
 ```
 
+A single environment can have multiple behaviors. This is helpful if you are,
+say dealing with end-to-end specs that swallow exceptions:
+
+```yaml
+handlers:
+  - environment: all
+    behaviors: 
+      - raise
+      - log
+```
+
+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.
+
 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
@@ -99,7 +114,22 @@ handlers:
 ```
 
 Patterns are matched if the deprecation message contains the pattern as a 
-substring
+substring.
+
+The pattern can be a regular expression, denoted by using regular expression 
+syntax _inside_ the string in the YAML:
+
+```yaml
+handlers:
+  - source: ruby
+    only:
+      - "/Using .* argument/"
+    environment: all
+    behavior: log
+```
+
+The pattern inside the slashes is converted to a Ruby `Regexp` and patterns 
+are matched if the regexp and the deprecation warning message match.
 
 Another pattern is to have a list of ignored deprecations and then remove 
 messages one by one and manage them individually.
@@ -120,3 +150,37 @@ 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:
+
+* write to standard out as a behavior
+* Ability to customize output message format

data/lib/warning_signs/deprecation.rb

@@ -1,28 +1,34 @@
 module WarningSigns
   class Deprecation
-    attr_accessor :message, :source
+    attr_accessor :message, :source, :category
 
-    def initialize(message, source:)
+    def initialize(message, source:, category: nil)
       @message = message
       @source = source.to_s.downcase.inquiry
+      @category = category
     end
 
     def handler
       World.instance.handler_for(self)
     end
 
-    def behavior
-      handler&.environment&.behavior
+    # force raise to be the last element if it is present
+    def behaviors
+      result = (handler&.environment&.behaviors || []).inquiry
+      return result unless result.raise?
+      (result - ["raise"]) << "raise"
     end
 
     def invoke
-      case behavior
-      when "raise"
-        raise UnhandledDeprecationError, message
-      when "log"
-        Rails.logger.warn(message)
-      when "stderr"
-        $stderr.puts(message) # standard:disable Style/StderrPuts
+      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
       end
     end
   end

data/lib/warning_signs/environment.rb

@@ -1,10 +1,12 @@
 module WarningSigns
   class Environment
-    attr_accessor :environment, :behavior
+    attr_accessor :environment, :behaviors
 
-    def initialize(environment:, behavior:)
+    def initialize(environment:, behaviors: [], behavior: nil)
       @environment = environment.to_s.downcase.inquiry
-      @behavior = behavior.to_s.downcase.inquiry
+      @behaviors = (behaviors + [behavior])
+        .compact
+        .map { _1.to_s.downcase.inquiry }
     end
   end
 end

data/lib/warning_signs/handler.rb

@@ -1,27 +1,29 @@
 module WarningSigns
   class Handler
-    attr_accessor :behavior, :environments, :except, :only, :source
+    attr_accessor :environments, :except, :only, :source, :category_matcher
 
     def self.from_hash(hash)
       new(**hash.symbolize_keys)
     end
 
     def initialize(
-      behavior: "ignore",
+      behavior: nil,
+      behaviors: [],
       environment: nil,
       except: [],
       only: [],
       source: "any",
-      environments: []
+      environments: [],
+      ruby_warnings: {}
     )
-      @behavior = behavior.to_s.downcase.inquiry
-      @except = except
-      @only = only
+      @except = except.map { Pattern.for(_1) }
+      @only = only.map { Pattern.for(_1) }
       @environments = environments.map { Environment.new(**_1.symbolize_keys) }
       if environment.present?
-        @environments << Environment.new(environment: environment, 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)
       raise InvalidHandlerError unless valid?
     end
 
@@ -35,7 +37,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)
@@ -50,14 +57,14 @@ module WarningSigns
     def only_match?(message)
       return true if only.empty?
       only.any? do |only_pattern|
-        message.include?(only_pattern)
+        only_pattern.match?(message)
       end
     end
 
     def except_match?(message)
       return true if except.empty?
-      except.none? do |only_pattern|
-        message.include?(only_pattern)
+      except.none? do |except_pattern|
+        except_pattern.match?(message)
       end
     end
 

data/lib/warning_signs/pattern.rb

@@ -0,0 +1,11 @@
+module WarningSigns
+  class Pattern
+    def self.for(raw_pattern)
+      if raw_pattern.starts_with?("/") && raw_pattern.ends_with?("/")
+        RegexPattern.new(raw_pattern)
+      else
+        StringPattern.new(raw_pattern)
+      end
+    end
+  end
+end

data/lib/warning_signs/regex_pattern.rb

@@ -0,0 +1,13 @@
+module WarningSigns
+  class RegexPattern
+    attr_accessor :pattern
+
+    def initialize(raw_pattern)
+      @pattern = Regexp.new(raw_pattern[1...-1])
+    end
+
+    def match?(message)
+      pattern.match?(message)
+    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,17 +1,24 @@
 module WarningSigns
   module RubyDeprecationCatcher
-    def warn(message)
-      Deprecation.new(augmented_message(message), source: "ruby").invoke
+    def warn(message, category: nil)
+      Deprecation.new(
+        augmented_message(message, category),
+        source: "ruby",
+        category: category
+      ).invoke
     end
 
-    def augmented_message(message)
-      "RUBY DEPRECATION WARNING: #{message} called from #{caller_location}"
+    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?("warning_signs") &&
+          !location.to_s.include?("rubygems") &&
+          !location.to_s.include?("/gems")
       end
     end
   end

data/lib/warning_signs/string_pattern.rb

@@ -0,0 +1,13 @@
+module WarningSigns
+  class StringPattern
+    attr_accessor :pattern
+
+    def initialize(raw_pattern)
+      @pattern = raw_pattern
+    end
+
+    def match?(message)
+      message.include?(pattern)
+    end
+  end
+end

data/lib/warning_signs/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: warning_signs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Noel Rappin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-04 00:00:00.000000000 Z
+date: 2023-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -173,9 +173,13 @@ files:
 - lib/warning_signs/deprecation.rb
 - lib/warning_signs/environment.rb
 - lib/warning_signs/handler.rb
+- lib/warning_signs/pattern.rb
 - 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
 - lib/warning_signs/world.rb
 - warning_signs.gemspec