warning_signs 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5dd43f86a3822293460f2d79efb2c2e98a5cb6a86ca5b85a3d762b4e9b82a8e
-  data.tar.gz: 9dd3da0dbd012564356f1c477038f9cd5b00652149c064aea4006224b408940f
+  metadata.gz: ffe169d3fa9e10de71c8ca43c6ac4cf8dd3c036f716d9a9f608fc37ce01a1879
+  data.tar.gz: a7511cdd8e836b8e1906b8c44a9ea3ec3309918fd033935a05480f7179bc4722
 SHA512:
-  metadata.gz: 4e73a2bc35a1283b56061fad2717c6b0c9ce19f91c34b81645bf57c9e4c09eee2f93f727529c107a54c2e47fa6a8d88b9958af522b3a12929d18f505924b734f
-  data.tar.gz: eb2050074df9f17103a57ebbf506cba97a9f0a4b17d82db8b968c359751edbb8787033c708d19b5bb2e2b57b49346f138576f9cd98552cca80f12578d4ce908a
+  metadata.gz: babffad1137746742209cf4fe4adc14f7b2a905684b31f8e68569ccdcc9806945b88e690b75262bf62b9c4d09be77eb87cc5c7aeac58bc947d3ff3165eda9854
+  data.tar.gz: 23750e8b4849c3a1bd2d349fb26696e36eb34afcd71e0e3cb04619ed32234549f880cdc5f28e2d1da5fc57b1b1b519fc705ea75fe00de582c82e8612129473e8

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 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.4.0)
       awesome_print
       railties
 

data/README.md

@@ -150,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,10 +1,11 @@
 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
@@ -14,7 +15,7 @@ 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
 

data/lib/warning_signs/handler.rb

@@ -1,6 +1,6 @@
 module WarningSigns
   class Handler
-    attr_accessor :environments, :except, :only, :source
+    attr_accessor :environments, :except, :only, :source, :category_matcher
 
     def self.from_hash(hash)
       new(**hash.symbolize_keys)
@@ -13,7 +13,8 @@ module WarningSigns
       except: [],
       only: [],
       source: "any",
-      environments: []
+      environments: [],
+      ruby_warnings: {}
     )
       @except = except.map { Pattern.for(_1) }
       @only = only.map { Pattern.for(_1) }
@@ -22,6 +23,7 @@ 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)
       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)

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,11 +1,16 @@
 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

data/lib/warning_signs/version.rb

@@ -1,3 +1,3 @@
 module WarningSigns
-  VERSION = "0.3.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.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Noel Rappin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-05 00:00:00.000000000 Z
+date: 2023-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -177,6 +177,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