warning 0.10.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: '08cf870b5689f1fc79b3a2c1c9bd787c10802ed0'
-  data.tar.gz: 43f33015143cf420dd92f3db2ad0c5b91f05335d
+SHA256:
+  metadata.gz: 0fd71447749bdaad9176ecb3eb6302104bcaf5401516719beed80594d2fa234a
+  data.tar.gz: 18eee8db50ef702428bcfd5690c3f92d013b4b8013dd6cd28e554ff808cccbd6
 SHA512:
-  metadata.gz: 2f35fc384e25902773a66ec191ccdf522a762a3c6006d339b66ce4b16c11e1e67df9454d12be4a941c2ad0458b978707b1fc98bfde052c0918c48304d9bea30e
-  data.tar.gz: 6cd8864633508b1bcf4928d4d25c4d8e19763a48f58b1160eb9f03aa3a178413f4b42270bb92b9bf7f7d8941de2c5f02c53f05463ea5f003ab0eff769f535bea
+  metadata.gz: 8038062c8d96ec8eb800be734041654d3dd24a1a5ddda523c5c44f465f7cbdf3fdbaa3537e4d360ad9673effb4a54e27de544325235b0fe343ec13f6ee3ec948
+  data.tar.gz: 26324dfc9591fda0a4627d515c3b18738e55f3213c0ff76b15f7493616980c54cf3cf3b945985d460d230db69b57ccd687f2b4ac5f367feec1b1efeae72319f0

data/CHANGELOG

@@ -1,3 +1,13 @@
+=== 1.0.0 (2020-01-21)
+
+* Add support for :taint as regexp argument to Warning.ignore (jeremyevans)
+
+* Add support for :safe as regexp argument to Warning.ignore (jeremyevans)
+
+* Add Warning.dedup for deduplicating warnings (jeremyevans)
+
+* Add support for :keyword_separation as regexp argument to Warning.ignore (jeremyevans)
+
 === 0.10.1 (2017-11-16)
 
 * Correctly handle Warning.freeze (jeremyevans)

data/README.rdoc

@@ -2,8 +2,8 @@
 
 ruby-warning adds custom processing for warnings, including the
 ability to ignore specific warning messages, ignore warnings
-in specific files/directories, and add custom handling for all
-warnings in specific files/directories.
+in specific files/directories, deduplicate warnings, and add
+custom handling for all warnings in specific files/directories.
 
 ruby-warning requires ruby 2.4+, as previous versions of ruby do
 not support custom processing of warnings.
@@ -30,11 +30,14 @@ appropriate regexp.  The supported symbols are:
 * :ambiguous_slash
 * :bignum
 * :fixnum
+* :keyword_separation
 * :method_redefined
 * :missing_gvar
 * :missing_ivar
 * :not_reached
+* :safe
 * :shadow
+* :taint
 * :unused_var
 * :useless_operator
 
@@ -44,15 +47,27 @@ string instead of performing the default behavior. You can call
 <tt>Warning.process</tt> multiple times and it will operate intelligently,
 choosing the longest path prefix that the string starts with.
 
-<tt>Warning.clear</tt> just clears the current ignored warnings and warning
-processors.
+<tt>Warning.dedup</tt> deduplicates warnings, so that if a warning is received
+that is the same as a warning that has already been processed, the warning is
+ignored. Note that this should be used with care, since if the application
+generates an arbitrary number of unique warnings, that can lead to unbounded
+memory growth.
+
+<tt>Warning.clear</tt> resets the library to its initial state, clearing the
+current ignored warnings and warning processors, and turning off deduplication.
 
 By using path prefixes, it's fairly easy for a gem to set that specific warnings
 should be ignored inside the gem's directory.
 
 Note that path prefixes will not correctly handle warnings raised by
 <tt>Kernel#warn</tt>, unless the warning message given to <tt>Kernel#warn</tt>
-starts with the filename where the warning is used.
+starts with the filename where the warning is used. The <tt>Kernel#warn</tt>
++:uplevel+ option will make sure the warning starts with the filename.
+
+Note that many of the warnings this library can ignore are warnings caused
+during compilation (i.e. when files are loaded via require).  You should
+require this library and setup the appropriate warning handling before
+loading any code that could cause warnings.
 
 = Examples
 
@@ -78,6 +93,14 @@ starts with the filename where the warning is used.
     LOGGER.error(warning)
   end
 
+  # Deduplicate warnings
+  Warning.dedup
+
+  # Ignore all warnings in Gem dependencies
+  Gem.path.each do |path|
+    Warning.ignore(//, path)
+  end
+
 = License
 
 MIT

data/lib/warning.rb

@@ -15,16 +15,28 @@ module Warning
       shadow: /: warning: shadowing outer local variable - \w+\n\z/,
       unused_var: /: warning: assigned but unused variable - \w+\n\z/,
       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/,
     }
 
-    # Clear all current ignored warnings and warning processors.
+    # Clear all current ignored warnings, warning processors, and duplicate check cache.
+    # Also disables deduplicating warnings if that is currently enabled.
     def clear
       synchronize do
         @ignore.clear
         @process.clear
+        @dedup = false
       end
     end
 
+    # Deduplicate warnings, supress warning messages if the same warning message
+    # has already occurred.  Note that this can lead to unbounded memory use
+    # if unique warnings are generated.
+    def dedup
+      @dedup = {}
+    end
+
     def freeze
       @ignore.freeze
       @process.freeze
@@ -40,6 +52,7 @@ module Warning
     # :ambiguous_slash :: Ignore warnings for things like <tt>method /regexp/</tt>
     # :bignum :: Ignore warnings when referencing the ::Bignum constant.
     # :fixnum :: Ignore warnings when referencing the ::Fixnum constant.
+    # :keyword_separation :: Ignore warnings related to keyword argument separation.
     # :method_redefined :: Ignore warnings when defining a method in a class/module where a
     #                      method of the same name was already defined in that class/module.
     # :missing_gvar :: Ignore warnings for accesses to global variables
@@ -47,7 +60,9 @@ module Warning
     # :missing_ivar :: Ignore warnings for accesses to instance variables
     #                  that have not yet been initialized
     # :not_reached :: Ignore statement not reached warnings.
+    # :safe :: Ignore warnings related to $SAFE and related C-API functions.
     # :shadow :: Ignore warnings related to shadowing outer local variables.
+    # :taint :: Ignore warnings related to taint and related methods and C-API functions.
     # :unused_var :: Ignore warnings for unused variables.
     # :useless_operator :: Ignore warnings when using operators such as == and > when the
     #                      result is not used.
@@ -105,7 +120,8 @@ module Warning
     end
 
     # Handle ignored warnings and warning processors.  If the warning is
-    # not ignored and there is no warning processor setup for the warning
+    # 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|
@@ -114,6 +130,14 @@ module Warning
         end
       end
 
+      if @dedup
+        if synchronize{@dedup[str]}
+          return
+        end
+
+        synchronize{@dedup[str] = true}
+      end
+
       synchronize{@process.dup}.each do |path, block|
         if str.start_with?(path)
           block.call(str)
@@ -133,6 +157,7 @@ module Warning
 
   @ignore = []
   @process = []
+  @dedup = false
   @monitor = Monitor.new
 
   extend Processor

data/test/test_freeze_warning.rb

@@ -1,4 +1,5 @@
-require 'minitest/autorun'
+ENV['MT_NO_PLUGINS'] = '1' # Work around stupid autoloading of plugins
+require 'minitest/global_expectations/autorun'
 require 'warning'
 
 class WarningFreezeTest < Minitest::Test

data/test/test_warning.rb

@@ -1,5 +1,7 @@
-require 'minitest/autorun'
+ENV['MT_NO_PLUGINS'] = '1' # Work around stupid autoloading of plugins
+require 'minitest/global_expectations/autorun'
 require 'warning'
+require 'pathname'
 
 class WarningTest < Minitest::Test
   module EnvUtil
@@ -42,6 +44,28 @@ 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
+    end
+    assert_warning(/instance variable @ivar not initialized/) do
+      ivar
+    end
+
+    Warning.dedup
+
+    assert_warning(/instance variable @ivar not initialized/) do
+      ivar
+    end
+    assert_warning('') do
+      ivar
+    end
+  end
+
   def test_warning_ignore
     obj = Object.new
 
@@ -219,6 +243,98 @@ class WarningTest < Minitest::Test
     assert_warning '' do
       instance_eval('lambda{|a| lambda{|a|}}', __FILE__)
     end
+  end if RUBY_VERSION < '2.6'
+
+  if RUBY_VERSION > '2.7' && RUBY_VERSION < '2.8'
+    def h2kw(**kw)
+    end
+    def kw2h(h, **kw)
+    end
+    def skw(h=1, a: 1)
+    end
+
+    def test_warning_ignore_keyword
+      assert_warning(/warning: Using the last argument as keyword parameters is deprecated; maybe \*\* should be added to the call.*The called method `h2kw' is defined here/m) do
+        h2kw({})
+      end
+      assert_warning(/warning: Passing the keyword argument as the last hash parameter is deprecated.*The called method `kw2h' is defined here/m) do
+        kw2h(a: 1)
+      end
+      assert_warning(/warning: Splitting the last argument into positional and keyword parameters is deprecated.*The called method `skw' is defined here/m) do
+        skw("b" => 1, a: 2)
+      end
+      assert_warning(/warning: Splitting the last argument into positional and keyword parameters is deprecated.*The called method `skw' is defined here/m) do
+        skw({"b" => 1, a: 2})
+      end
+
+      Warning.ignore(:keyword_separation, __FILE__)
+
+      assert_warning '' do
+        h2kw({})
+        kw2h(a: 1)
+        skw("b" => 1, a: 2)
+        skw({"b" => 1, a: 2})
+      end
+    end
+
+    def test_warning_ignore_safe
+      assert_warning(/\$SAFE will become a normal global variable in Ruby 3\.0/) do
+        $SAFE = 0
+      end
+
+      Warning.ignore(:safe, __FILE__)
+
+      assert_warning("") do
+        $SAFE = 0
+      end
+    end
+  end
+
+  if RUBY_VERSION > '2.7' && RUBY_VERSION < '3.2'
+
+    def test_warning_ignore_taint
+      o = Object.new
+
+      assert_warning(/Object#taint is deprecated and will be removed in Ruby 3\.2/) do
+        o.taint
+      end
+      assert_warning(/Object#untaint is deprecated and will be removed in Ruby 3\.2/) do
+        o.untaint
+      end
+      assert_warning(/Object#tainted\? is deprecated and will be removed in Ruby 3\.2/) do
+        o.tainted?
+      end
+      assert_warning(/Object#trust is deprecated and will be removed in Ruby 3\.2/) do
+        o.trust
+      end
+      assert_warning(/Object#untrust is deprecated and will be removed in Ruby 3\.2/) do
+        o.untrust
+      end
+      assert_warning(/Object#untrusted\? is deprecated and will be removed in Ruby 3\.2/) do
+        o.untrusted?
+      end
+
+      path = Pathname.new(__FILE__)
+      assert_warning(/Pathname#taint is deprecated and will be removed in Ruby 3\.2/) do
+        path.taint
+      end
+      assert_warning(/Pathname#untaint is deprecated and will be removed in Ruby 3\.2/) do
+        path.untaint
+      end
+
+      Warning.ignore(:taint, __FILE__)
+
+      assert_warning("") do
+        o.taint
+        o.untaint
+        o.tainted?
+        o.trust
+        o.untrust
+        o.untrusted?
+        p.taint
+        p.untaint
+      end
+    end
   end
 
   def test_warning_ignore_symbol_array

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: warning
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-16 00:00:00.000000000 Z
-dependencies: []
+date: 2020-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest-global_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   ruby-warning adds custom processing for warnings, including the
   ability to ignore specific warning messages, ignore warnings
@@ -33,7 +47,11 @@ files:
 homepage: https://github.com/jeremyevans/ruby-warning
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/jeremyevans/ruby-warning/issues
+  changelog_uri: https://github.com/jeremyevans/ruby-warning/blob/master/CHANGELOG
+  documentation_uri: https://github.com/jeremyevans/ruby-warning/blob/master/README.rdoc
+  source_code_uri: https://github.com/jeremyevans/ruby-warning
 post_install_message: 
 rdoc_options:
 - "--quiet"
@@ -47,17 +65,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.99
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Add custom processing for warnings