warning 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 719af8cdb41da57d07edb0fa0eac81d2bb017d5d816cadf98e600cc75e63f4aa
-  data.tar.gz: 169550daf070386f36072d01c9c36303c631b6f598cf358e0f16e786f1d4ac68
+  metadata.gz: c2628e7956e2f0c2a7f55ef1d4397a1f1ff8339d48904b49fc16692934930464
+  data.tar.gz: 72b7fa93465fe52a2907ef2172d3c90694308af52bb2cd5b9117c6e7084419d1
 SHA512:
-  metadata.gz: 5ddf24399c73e0b2b747189d02972c3616482ac90c3c9e89b16b8594a1e2c6cf005b3b81bab905de6f30d3fd1882d806c8746fd317f59e6915408f80f054ee8f
-  data.tar.gz: a5f1d714b59737dd6e67ab000687783acff87c3fe5cfd85bac2828c91556a7de5637d082e82d0a34198b53580a324c69639da93e07c0436e4f648e0031c7ff00
+  metadata.gz: e8f95072982d387477121b90c13790876743d9a40a0a32c06a1ea72720b85c6d831c4dceff28445dd8be2a3ba6e915670b874a908e6b438cce40c83229f95a15
+  data.tar.gz: 3cf24b069bc071cdf425aad86fae1c0b37b3cf723ee8c365a09a183da7e3f737f7eb454f8b1fbc29be1a9651d01fd286e13562ea442c1ae57ca5fc2c045a7570

data/CHANGELOG

@@ -1,3 +1,13 @@
+=== 1.2.0 (2021-02-16)
+
+* Add support for :void_context as regexp argument to Warning.ignore (jeremyevans)
+
+* Support :category keyword to Warning.warn on Ruby 3.0 (jeremyevans)
+
+* Fix :taint warning handling on Ruby 3.0 (jeremyevans)
+
+* Fix :ambiguous_slash warning handling on Ruby 3.0 (jeremyevans)
+
 === 1.1.0 (2020-06-12)
 
 * Allow Warning.process to be called with a hash of actions instead of a block (jeremyevans)

data/README.rdoc

@@ -42,6 +42,7 @@ appropriate regexp.  The supported symbols are:
 * :taint
 * :unused_var
 * :useless_operator
+* :void_context
 
 <tt>Warning.process</tt> takes an optional path prefix and a block, and if the
 warning string starts with the path prefix, it calls the block with the warning

data/lib/warning.rb

@@ -4,7 +4,7 @@ module Warning
   module Processor
     # Map of symbols to regexps for warning messages to ignore.
     IGNORE_MAP = {
-      ambiguous_slash: /: warning: ambiguous first argument; put parentheses or a space even after `\/' operator\n\z/,
+      ambiguous_slash: /: warning: ambiguous first argument; put parentheses or a space even after `\/' operator\n\z|: warning: ambiguity between regexp and two divisions: wrap regexp in parentheses or add a space after `\/' operator\n\z/,
       arg_prefix: /: warning: `[&\*]' interpreted as argument prefix\n\z/,
       bignum: /: warning: constant ::Bignum is deprecated\n\z/,
       fixnum: /: warning: constant ::Fixnum is deprecated\n\z/,
@@ -17,8 +17,9 @@ module Warning
       useless_operator: /: warning: possibly useless use of [><!=]+ in void context\n\z/,
       keyword_separation: /: warning: (?:Using the last argument (?:for `.+' )?as keyword parameters is deprecated; maybe \*\* should be added to the call|Passing the keyword argument (?:for `.+' )?as the last hash parameter is deprecated|Splitting the last argument (?:for `.+' )?into positional and keyword parameters is deprecated|The called method (?:`.+' )?is defined here)\n\z/,
       safe: /: warning: (?:rb_safe_level_2_warning|rb_safe_level|rb_set_safe_level_force|rb_set_safe_level|rb_secure|rb_insecure_operation|rb_check_safe_obj|\$SAFE) will (?:be removed|become a normal global variable) in Ruby 3\.0\n\z/,
-      taint: /: warning: (?:rb_error_untrusted|rb_check_trusted|Pathname#taint|Pathname#untaint|rb_env_path_tainted|Object#tainted\?|Object#taint|Object#untaint|Object#untrusted\?|Object#untrust|Object#trust|rb_obj_infect|rb_tainted_str_new|rb_tainted_str_new_cstr) is deprecated and will be removed in Ruby 3\.2\.\n\z/,
+      taint: /: warning: (?:rb_error_untrusted|rb_check_trusted|Pathname#taint|Pathname#untaint|rb_env_path_tainted|Object#tainted\?|Object#taint|Object#untaint|Object#untrusted\?|Object#untrust|Object#trust|rb_obj_infect|rb_tainted_str_new|rb_tainted_str_new_cstr) is deprecated and will be removed in Ruby 3\.2\.?\n\z/,
       mismatched_indentations: /: warning: mismatched indentations at '.+' with '.+' at \d+\n\z/,
+      void_context: /possibly useless use of :: in void context/,
     }
 
     # Map of action symbols to procs that return the symbol
@@ -75,6 +76,8 @@ module Warning
     # :unused_var :: Ignore warnings for unused variables.
     # :useless_operator :: Ignore warnings when using operators such as == and > when the
     #                      result is not used.
+    # :void_context :: Ignore warnings for :: to reference constants when the result is not
+    #                  used (often used to trigger autoload).
     #
     # Examples:
     #
@@ -126,7 +129,7 @@ module Warning
     # Instead of passing a block, you can pass a hash of actions to take for specific
     # warnings, using regexp as keys and a callable objects as values:
     #
-    #   Warning.ignore(__FILE__,
+    #   Warning.process(__FILE__,
     #     /instance variable @\w+ not initialized/ => proc do |warning|
     #       LOGGER.warning(warning)
     #     end,
@@ -166,57 +169,63 @@ module Warning
       nil
     end
 
-    # Handle ignored warnings and warning processors.  If the warning is
-    # not ignored, is not a duplicate warning (if checking for duplicates)
-    # and there is no warning processor setup for the warning
-    # string, then use the default behavior of writing to $stderr.
-    def warn(str)
-      synchronize{@ignore.dup}.each do |path, regexp|
-        if str.start_with?(path) && str =~ regexp
-          return
-        end
-      end
 
-      if @dedup
-        if synchronize{@dedup[str]}
-          return
+    if RUBY_VERSION >= '3.0'
+      method_args = ', category: nil'
+      super_ = "category ? super : super(str)"
+    else
+      super_ = "super"
+    end
+
+    class_eval(<<-END, __FILE__, __LINE__+1)
+      def warn(str#{method_args})
+        synchronize{@ignore.dup}.each do |path, regexp|
+          if str.start_with?(path) && str =~ regexp
+            return
+          end
         end
 
-        synchronize{@dedup[str] = true}
-      end
+        if @dedup
+          if synchronize{@dedup[str]}
+            return
+          end
+
+          synchronize{@dedup[str] = true}
+        end
 
-      action = catch(:action) do
-        synchronize{@process.dup}.each do |path, block|
-          if str.start_with?(path)
-            if block.is_a?(Hash)
-              block.each do |regexp, blk|
-                if str =~ regexp
-                  throw :action, blk.call(str)
+        action = catch(:action) do
+          synchronize{@process.dup}.each do |path, block|
+            if str.start_with?(path)
+              if block.is_a?(Hash)
+                block.each do |regexp, blk|
+                  if str =~ regexp
+                    throw :action, blk.call(str)
+                  end
                 end
+              else
+                throw :action, block.call(str)
               end
-            else
-              throw :action, block.call(str)
             end
           end
+
+          :default
         end
 
-        :default
-      end
+        case action
+        when :default
+          #{super_}
+        when :backtrace
+          #{super_}
+          $stderr.puts caller
+        when :raise
+          raise str
+        else
+          # nothing
+        end
 
-      case action
-      when :default
-        super
-      when :backtrace
-        super
-        $stderr.puts caller
-      when :raise
-        raise str
-      else
-        # nothing
+        nil
       end
-
-      nil
-    end
+    END
 
     private
 

data/test/test_freeze_warning.rb

@@ -40,31 +40,30 @@ class WarningFreezeTest < Minitest::Test
   end
 
   def test_warning_ignore
-    obj = Object.new
     w = nil
 
-    Warning.ignore(/instance variable @ivar not initialized/)
+    Warning.ignore(/global variable `\$test_warning_ignore' not initialized/)
     Warning.process do |warning|
       w = [4, warning]
     end
     Warning.freeze
 
     assert_raises RuntimeError do
-      Warning.ignore(/instance variable @ivar not initialized/)
+      Warning.ignore(/global variable `\$test_warning_ignore' not initialized/)
     end
     assert_raises RuntimeError do
       Warning.process{|warning| w = [4, warning]}
     end
 
     assert_warning '' do
-      assert_nil(obj.instance_variable_get(:@ivar))
+      $test_warning_ignore
     end
     assert_nil w
 
     assert_warning '' do
-      assert_nil(obj.instance_variable_get(:@ivar6))
+      $test_warning_ignore2
     end
     assert_equal(4, w.first)
-    assert_match(/instance variable @ivar6 not initialized/, w.last)
+    assert_match(/global variable `\$test_warning_ignore2' not initialized/, w.last)
   end
 end

data/test/test_warning.rb

@@ -48,71 +48,65 @@ class WarningTest < Minitest::Test
     Warning.clear
   end
 
-  def ivar
-    Object.new.instance_variable_get(:@ivar)
-  end
-
   def test_warning_dedup
-    assert_warning(/instance variable @ivar not initialized/) do
-      ivar
+    gvar = ->{$test_warning_dedup}
+
+    assert_warning(/global variable `\$test_warning_dedup' not initialized/) do
+      gvar.call
     end
-    assert_warning(/instance variable @ivar not initialized/) do
-      ivar
+    assert_warning(/global variable `\$test_warning_dedup' not initialized/) do
+      gvar.call
     end
 
     Warning.dedup
 
-    assert_warning(/instance variable @ivar not initialized/) do
-      ivar
+    assert_warning(/global variable `\$test_warning_dedup' not initialized/) do
+      gvar.call
     end
     assert_warning('') do
-      ivar
+      gvar.call
     end
   end
 
   def test_warning_ignore
-    obj = Object.new
-
-    assert_warning(/instance variable @ivar not initialized/) do
-      assert_nil(obj.instance_variable_get(:@ivar))
-    end
-
-    assert_warning(/instance variable @ivar not initialized/) do
-      assert_nil(obj.instance_variable_get(:@ivar))
+    assert_warning(/global variable `\$test_warning_ignore' not initialized/) do
+      assert_nil($test_warning_ignore)
     end
 
-    Warning.ignore(/instance variable @ivar not initialized/)
+    Warning.ignore(/global variable `\$test_warning_ignore' not initialized/)
 
     assert_warning '' do
-      assert_nil(obj.instance_variable_get(:@ivar))
+      assert_nil($test_warning_ignore)
     end
 
-    assert_warning(/instance variable @ivar2 not initialized/) do
-      assert_nil(obj.instance_variable_get(:@ivar2))
+    assert_warning(/global variable `\$test_warning_ignore2' not initialized/) do
+      assert_nil($test_warning_ignore2)
     end
 
-    Warning.ignore(/instance variable @ivar2 not initialized/, __FILE__)
+    Warning.ignore(/global variable `\$test_warning_ignore2' not initialized/, __FILE__)
 
     assert_warning '' do
-      assert_nil(obj.instance_variable_get(:@ivar2))
+      assert_nil($test_warning_ignore2)
     end
 
-    assert_warning(/instance variable @ivar3 not initialized/) do
-      assert_nil(obj.instance_variable_get(:@ivar3))
+    assert_warning(/global variable `\$test_warning_ignore3' not initialized/) do
+      assert_nil($test_warning_ignore3)
     end
 
-    Warning.ignore(/instance variable @ivar3 not initialized/, __FILE__+'a')
+    Warning.ignore(/global variable `\$test_warning_ignore3' not initialized/, __FILE__ + 'a')
 
-    assert_warning(/instance variable @ivar3 not initialized/) do
-      assert_nil(obj.instance_variable_get(:@ivar3))
+    assert_warning(/global variable `\$test_warning_ignore3' not initialized/) do
+      assert_nil($test_warning_ignore3)
     end
   end
 
   def test_warning_ignore_missing_ivar
     Warning.clear
 
-    assert_warning(/instance variable @ivar not initialized/) do
-      assert_nil(instance_variable_get(:@ivar))
+    unless RUBY_VERSION >= '3.0'
+      assert_warning(/instance variable @ivar not initialized/) do
+        assert_nil(instance_variable_get(:@ivar))
+      end
     end
 
     Warning.ignore(:missing_ivar, __FILE__)
@@ -184,9 +178,21 @@ class WarningTest < Minitest::Test
     end
   end
 
+  def test_warning_ignore_void_context
+    assert_warning(/warning: possibly useless use of :: in void context/) do
+      instance_eval('::Object; nil', __FILE__, __LINE__)
+    end
+
+    Warning.ignore(:void_context, __FILE__)
+
+    assert_warning '' do
+      instance_eval('::Object; nil', __FILE__, __LINE__)
+    end
+  end
+
   def test_warning_ignore_ambiguous_slash
     def self.d(re); end
-    assert_warning(/warning: ambiguous first argument; put parentheses or a space even after `\/' operator/) do
+    assert_warning(/warning: ambi/) do
       instance_eval('d /a/', __FILE__)
     end
 
@@ -368,15 +374,14 @@ class WarningTest < Minitest::Test
   end
 
   def test_warning_process
-    obj = Object.new
     warn = nil
 
     Warning.process(__FILE__+'a') do |warning|
       warn = [0, warning]
     end
 
-    assert_warning(/instance variable @ivar not initialized/) do
-      assert_nil(obj.instance_variable_get(:@ivar))
+    assert_warning(/global variable `\$test_warning_process' not initialized/) do
+      $test_warning_process
     end
     assert_nil(warn)
 
@@ -385,10 +390,10 @@ class WarningTest < Minitest::Test
     end
 
     assert_warning '' do
-      assert_nil(obj.instance_variable_get(:@ivar2))
+      $test_warning_process2
     end
     assert_equal(1, warn.first)
-    assert_match(/instance variable @ivar2 not initialized/, warn.last)
+    assert_match(/global variable `\$test_warning_process2' not initialized/, warn.last)
     warn = nil
 
     Warning.process(File.dirname(__FILE__)) do |warning|
@@ -396,10 +401,10 @@ class WarningTest < Minitest::Test
     end
 
     assert_warning '' do
-      assert_nil(obj.instance_variable_get(:@ivar3))
+      $test_warning_process3
     end
     assert_equal(1, warn.first)
-    assert_match(/instance variable @ivar3 not initialized/, warn.last)
+    assert_match(/global variable `\$test_warning_process3' not initialized/, warn.last)
     warn = nil
 
     Warning.process(__FILE__+':') do |warning|
@@ -407,16 +412,16 @@ class WarningTest < Minitest::Test
     end
 
     assert_warning '' do
-      assert_nil(obj.instance_variable_get(:@ivar4))
+      $test_warning_process4
     end
     assert_equal(3, warn.first)
-    assert_match(/instance variable @ivar4 not initialized/, warn.last)
+    assert_match(/global variable `\$test_warning_process4' not initialized/, warn.last)
     warn = nil
 
     Warning.clear
 
-    assert_warning(/instance variable @ivar5 not initialized/) do
-      assert_nil(obj.instance_variable_get(:@ivar5))
+    assert_warning(/global variable `\$test_warning_process5' not initialized/) do
+      $test_warning_process5
     end
     assert_nil(warn)
 
@@ -425,10 +430,10 @@ class WarningTest < Minitest::Test
     end
 
     assert_warning '' do
-      assert_nil(obj.instance_variable_get(:@ivar6))
+      $test_warning_process6
     end
     assert_equal(4, warn.first)
-    assert_match(/instance variable @ivar6 not initialized/, warn.last)
+    assert_match(/global variable `\$test_warning_process6' not initialized/, warn.last)
   end
 
   def test_warning_process_block_return_default
@@ -438,10 +443,10 @@ class WarningTest < Minitest::Test
       :default
     end
 
-    assert_warning(/instance variable @ivar not initialized/) do
-      ivar
+    assert_warning(/global variable `\$test_warning_process_block_return_default' not initialized/) do
+      $test_warning_process_block_return_default
     end
-    assert_match(/instance variable @ivar not initialized/, w)
+    assert_match(/global variable `\$test_warning_process_block_return_default' not initialized/, w)
   end
 
   def test_warning_process_block_return_backtrace
@@ -451,10 +456,10 @@ class WarningTest < Minitest::Test
       :backtrace
     end
 
-    assert_warning(/instance variable @ivar not initialized.*#{__FILE__}/m) do
-      ivar
+    assert_warning(/global variable `\$test_warning_process_block_return_backtrace' not initialized.*#{__FILE__}/m) do
+      $test_warning_process_block_return_backtrace
     end
-    assert_match(/instance variable @ivar not initialized/, w)
+    assert_match(/global variable `\$test_warning_process_block_return_backtrace' not initialized/, w)
   end
 
   def test_warning_process_block_return_raise
@@ -464,26 +469,29 @@ class WarningTest < Minitest::Test
       :raise
     end
 
-    assert_raises(RuntimeError, /instance variable @ivar not initialized/) do
-      EnvUtil.verbose_warning{ivar}
+    assert_raises(RuntimeError) do
+      $test_warning_process_block_return_raise
     end
-    assert_match(/instance variable @ivar not initialized/, w)
+    assert_match(/global variable `\$test_warning_process_block_return_raise' not initialized/, w)
   end
 
   def test_warning_process_action
     w = nil
-    Warning.process(__FILE__, :missing_ivar=>:default, :missing_gvar=>:backtrace, :ambiguous_slash=>:raise)
+    Warning.process(__FILE__, :method_redefined=>:default, :missing_gvar=>:backtrace, :ambiguous_slash=>:raise)
     Warning.process(__FILE__, :not_reached=>proc do |warning|
       w = warning
       :raise
     end)
 
-    assert_warning(/instance variable @ivar not initialized/) do
-      ivar
+    assert_warning(/warning: method redefined/) do
+      Class.new do
+        def a; end
+        def a; end
+      end
     end
 
-    assert_warning(/global variable `\$gvar' not initialized.*#{__FILE__}/m) do
-      $gvar
+    assert_warning(/global variable `\$test_warning_process_action' not initialized.*#{__FILE__}/m) do
+      $test_warning_process_action
     end
 
     Warning.process(__FILE__) do |warning|
@@ -491,7 +499,7 @@ class WarningTest < Minitest::Test
       :raise
     end
 
-    assert_raises(RuntimeError, /warning: ambiguous first argument; put parentheses or a space even after `\/' operator/) do
+    assert_raises(RuntimeError, /warning: ambi/) do
       EnvUtil.verbose_warning{instance_eval('d /a/', __FILE__)}
     end
 
@@ -512,4 +520,12 @@ class WarningTest < Minitest::Test
       Warning.process(__FILE__, :missing_ivar=>:default){}
     end
   end
+
+  if RUBY_VERSION >= '3.0'
+    def test_warning_warn_category_keyword
+      assert_warning('foo') do
+        Warning.warn("foo", category: :deprecated)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: warning
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-12 00:00:00.000000000 Z
+date: 2021-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest-global_expectations
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Add custom processing for warnings