warning_signs 0.0.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55b5a8c89a3c99603f0b3878a341c8ab5cce9833a364ae43e6fa6e2f4a601b77
-  data.tar.gz: 288ec53101a4c0fcfc17b326521ed49b88bfb081e642795c6667d0adbdf687c9
+  metadata.gz: d5dd43f86a3822293460f2d79efb2c2e98a5cb6a86ca5b85a3d762b4e9b82a8e
+  data.tar.gz: 9dd3da0dbd012564356f1c477038f9cd5b00652149c064aea4006224b408940f
 SHA512:
-  metadata.gz: b6bbbff2c40d7299d8f559172a929d549f31ed5b1555262cae957d6958450e7fc9cadd87e4d6adcb23c15f9e16a0590336b9e036b54cbddcd32b097baf3e4929
-  data.tar.gz: c24f89c8d34ff9ea560998af85d6ae6385945e35fdb6d5acd0a01a3258e5bb09186308d730760bc7b9f2657628d673d1776c5bf00e9b08bc8eba545999efe92d
+  metadata.gz: 4e73a2bc35a1283b56061fad2717c6b0c9ce19f91c34b81645bf57c9e4c09eee2f93f727529c107a54c2e47fa6a8d88b9958af522b3a12929d18f505924b734f
+  data.tar.gz: eb2050074df9f17103a57ebbf506cba97a9f0a4b17d82db8b968c359751edbb8787033c708d19b5bb2e2b57b49346f138576f9cd98552cca80f12578d4ce908a

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 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
+
+## 0.0.1
+
 * Initial public release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    warning_signs (0.0.1)
+    warning_signs (0.3.0)
       awesome_print
       railties
 
@@ -48,6 +48,10 @@ GEM
     minitest (5.18.0)
     nokogiri (1.14.3-arm64-darwin)
       racc (~> 1.4)
+    nokogiri (1.14.3-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.14.3-x86_64-linux)
+      racc (~> 1.4)
     parallel (1.23.0)
     parser (3.2.2.1)
       ast (~> 2.4.1)
@@ -104,7 +108,7 @@ GEM
       rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
+    rubocop-ast (1.28.1)
       parser (>= 3.2.1.0)
     rubocop-performance (1.16.0)
       rubocop (>= 1.7.0, < 2.0)
@@ -115,7 +119,7 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    standard (1.28.0)
+    standard (1.28.2)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.50.2)

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.

data/lib/warning_signs/deprecation.rb

@@ -11,18 +11,23 @@ module WarningSigns
       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 if !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,25 +1,25 @@
 module WarningSigns
   class Handler
-    attr_accessor :behavior, :environments, :except, :only, :source
+    attr_accessor :environments, :except, :only, :source
 
     def self.from_hash(hash)
       new(**hash.symbolize_keys)
     end
 
     def initialize(
-      behavior: "ignore",
+      behavior: nil,
+      behaviors: [],
       environment: nil,
       except: [],
       only: [],
       source: "any",
       environments: []
     )
-      @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
       raise InvalidHandlerError unless valid?
@@ -50,14 +50,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_deprecation_catcher.rb

@@ -5,7 +5,16 @@ module WarningSigns
     end
 
     def augmented_message(message)
-      "RUBY DEPRECATION WARNING: #{message} called from #{caller_locations(2..2).first}"
+      "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
     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.0.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: warning_signs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Noel Rappin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-01 00:00:00.000000000 Z
+date: 2023-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -173,9 +173,12 @@ 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_deprecation_catcher.rb
+- lib/warning_signs/string_pattern.rb
 - lib/warning_signs/version.rb
 - lib/warning_signs/world.rb
 - warning_signs.gemspec