warning 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70b1655bff238b444c9373002b6d1010812a9a71
-  data.tar.gz: 2276292182d974e7fdb71802295ed1dc45771f82
+  metadata.gz: c0a00f58401bfb0c3b182b5e472de7d417e5e9c7
+  data.tar.gz: 6e4a3377be9ee85d5de9848e4eaaa20b367035a4
 SHA512:
-  metadata.gz: 6a512057f73e7f275e806a9e9442919e128c0edcf312e730b4787f9b9630c8f088bdfce0af7a7b7f9d6e3811aa94ae95211a4b13d205353e1853c20f2f5a0a4d
-  data.tar.gz: 16e8d3da29e75c5c6f1dd70fede11564006ad30201923d8750aa0d383e77820fa4355c6fd6f6b44600bd276d9afd38706581c123c34898bbbf2534bb64cab5b3
+  metadata.gz: 1e3c7971f5ec2a5b28ec263aa6847778f45790b3554cdfee4fc8b4c08af21e3459dcf148fd8618b4d632cbd285e6afd6518ededc69a01469ea676666df564a5c
+  data.tar.gz: 674820530875fa42a1920f06673add77b66210fee9b50bd150cbafdce603e275c30c422cf985838e6f5500096aeb815c40d2a5d7cb5766b430a7912bf7f2238b

data/CHANGELOG

@@ -1,3 +1,21 @@
+=== 0.10.0 (2016-11-16)
+
+* Add support for :arg_prefix and :shadow as regexp argument to Warning.ignore (jeremyevans)
+
+* Add support for :useless_operator as regexp argument to Warning.ignore (jeremyevans)
+
+* Add support for :missing_gvar as regexp argument to Warning.ignore (jeremyevans)
+
+* Add support for :ambiguous_slash and :unused_var as regexp arguments to Warning.ignore (jeremyevans)
+
+* Add support for :fixnum and :bignum as regexp arguments to Warning.ignore (jeremyevans)
+
+* Add support for array of symbols as regexp argument to Warning.ignore (jeremyevans)
+
+* Add support for :not_reached as regexp argument to Warning.ignore (jeremyevans)
+
+* Add support for :missing_ivar and :method_redefined as regexp argument to Warning.ignore (jeremyevans)
+
 === 0.9.0 (2016-08-09)
 
 * Initial Public Release

data/README.rdoc

@@ -23,7 +23,20 @@ warnings, it just adds methods that allow you to customize the processing.
 
 <tt>Warning.ignore</tt> takes a regexp and optionally a path prefix, and ignores
 any warning that matches the regular expression if it starts with the path
-prefix.
+prefix.  It can also take a symbol or an array of symbols, and will use an
+appropriate regexp.  The supported symbols are:
+
+* :arg_prefix
+* :ambiguous_slash
+* :bignum
+* :fixnum
+* :method_redefined
+* :missing_gvar
+* :missing_ivar
+* :not_reached
+* :shadow
+* :unused_var
+* :useless_operator
 
 <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
@@ -49,6 +62,12 @@ starts with the filename where the warning is used.
   # Ignore all uninitialized instance variable warnings in current file
   Warning.ignore(/instance variable @\w+ not initialized/, __FILE__)
 
+  # Ignore all uninitialized instance variable warnings in current file
+  Warning.ignore(:missing_ivar, __FILE__)
+
+  # Ignore all Fixnum and Bignum warnings in current file
+  Warning.ignore([:fixnum, :bignum], __FILE__)
+
   # Write warning to LOGGER at level warning
   Warning.process do |warning|
     LOGGER.warning(warning)

data/lib/warning.rb

@@ -2,6 +2,21 @@ require 'monitor'
 
 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/,
+      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/,
+      method_redefined: /: warning: method redefined; discarding old .+\n\z|: warning: previous definition of .+ was here\n\z/,
+      missing_gvar: /: warning: global variable `\$.+' not initialized\n\z/,
+      missing_ivar: /: warning: instance variable @.+ not initialized\n\z/,
+      not_reached: /: warning: statement not reached\n\z/,
+      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/,
+    }
+
     # Clear all current ignored warnings and warning processors.
     def clear
       synchronize do
@@ -11,14 +26,51 @@ module Warning
     end
     
     # Ignore any warning messages matching the given regexp, if they
-    # start with the given path. Examples:
+    # start with the given path.
+    # The regexp can also be one of the following symbols (or an array including them), which will
+    # use an appropriate regexp for the given warning:
+    #
+    # :arg_prefix :: Ignore warnings when using * or & as an argument prefix
+    # :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.
+    # :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
+    #                  that have not yet been initialized
+    # :missing_ivar :: Ignore warnings for accesses to instance variables
+    #                  that have not yet been initialized
+    # :not_reached :: Ignore statement not reached warnings.
+    # :shadow :: Ignore warnings related to shadowing outer local variables.
+    # :unused_var :: Ignore warnings for unused variables.
+    # :useless_operator :: Ignore warnings when using operators such as == and > when the
+    #                      result is not used.
+    #
+    # Examples:
     #
     #   # Ignore all uninitialized instance variable warnings
     #   Warning.ignore(/instance variable @\w+ not initialized/)
     #
     #   # Ignore all uninitialized instance variable warnings in current file
     #   Warning.ignore(/instance variable @\w+ not initialized/, __FILE__)
+    #
+    #   # Ignore all uninitialized instance variable warnings in current file
+    #   Warning.ignore(:missing_ivar, __FILE__)
+    #
+    #   # Ignore all uninitialized instance variable and method redefined warnings in current file
+    #   Warning.ignore([:missing_ivar, :method_redefined],  __FILE__)
     def ignore(regexp, path='')
+      case regexp
+      when Regexp
+        # already regexp
+      when Symbol
+        regexp = IGNORE_MAP.fetch(regexp)
+      when Array
+        regexp = Regexp.union(regexp.map{|re| IGNORE_MAP.fetch(re)})
+      else
+        raise TypeError, "first argument to Warning.ignore should be Regexp, Symbol, or Array of Symbols, got #{regexp.inspect}"
+      end
+
       synchronize do 
         @ignore << [path, regexp]
       end

data/test/test_warning.rb

@@ -1,5 +1,5 @@
-require 'minitest/unit'
 require 'minitest/autorun'
+require 'warning'
 
 class WarningTest < Minitest::Test
   module EnvUtil
@@ -38,16 +38,18 @@ class WarningTest < Minitest::Test
     assert(pat === stderr, msg)
   end
 
+  def teardown
+    Warning.clear
+  end
+
   def test_warning_ignore
     obj = Object.new
 
-    assert_warning /instance variable @ivar not initialized/ do
+    assert_warning(/instance variable @ivar not initialized/) do
       assert_nil(obj.instance_variable_get(:@ivar))
     end
 
-    require 'warning'
-
-    assert_warning /instance variable @ivar not initialized/ do
+    assert_warning(/instance variable @ivar not initialized/) do
       assert_nil(obj.instance_variable_get(:@ivar))
     end
 
@@ -57,7 +59,7 @@ class WarningTest < Minitest::Test
       assert_nil(obj.instance_variable_get(:@ivar))
     end
 
-    assert_warning /instance variable @ivar2 not initialized/ do
+    assert_warning(/instance variable @ivar2 not initialized/) do
       assert_nil(obj.instance_variable_get(:@ivar2))
     end
 
@@ -67,36 +69,181 @@ class WarningTest < Minitest::Test
       assert_nil(obj.instance_variable_get(:@ivar2))
     end
 
-    assert_warning /instance variable @ivar3 not initialized/ do
+    assert_warning(/instance variable @ivar3 not initialized/) do
       assert_nil(obj.instance_variable_get(:@ivar3))
     end
 
     Warning.ignore(/instance variable @ivar3 not initialized/, __FILE__+'a')
 
-    assert_warning /instance variable @ivar3 not initialized/ do
+    assert_warning(/instance variable @ivar3 not initialized/) do
       assert_nil(obj.instance_variable_get(:@ivar3))
     end
+  end
 
+  def test_warning_ignore_missing_ivar
     Warning.clear
 
-    assert_warning /instance variable @ivar not initialized/ do
-      assert_nil(obj.instance_variable_get(:@ivar))
+    assert_warning(/instance variable @ivar not initialized/) do
+      assert_nil(instance_variable_get(:@ivar))
+    end
+
+    Warning.ignore(:missing_ivar, __FILE__)
+
+    assert_warning '' do
+      assert_nil(instance_variable_get(:@ivar))
+    end
+  end
+
+  def test_warning_ignore_missing_gvar
+    assert_warning(/global variable `\$gvar' not initialized/) do
+      $gvar
+    end
+
+    Warning.ignore(:missing_gvar, __FILE__)
+
+    assert_warning '' do
+      $gvar
+    end
+  end
+
+  def test_warning_ignore_method_redefined
+    def self.a; end
+
+    assert_warning(/method redefined; discarding old a.+previous definition of a was here/m) do
+      def self.a; end
+    end
+
+    Warning.ignore(:method_redefined, __FILE__)
+
+    assert_warning '' do
+      def self.a; end
+    end
+  end
+
+  def test_warning_ignore_not_reached
+    assert_warning(/: warning: statement not reached/) do
+      instance_eval('def self.b; return; 1 end', __FILE__)
+    end
+
+    Warning.ignore(:not_reached, __FILE__)
+
+    assert_warning '' do
+      instance_eval('def self.c; return; 1 end', __FILE__)
+    end
+  end
+
+  def test_warning_ignore_fixnum
+    assert_warning(/warning: constant ::Fixnum is deprecated/) do
+      ::Fixnum
+    end
+
+    Warning.ignore(:fixnum, __FILE__)
+
+    assert_warning '' do
+      ::Fixnum
+    end
+  end
+
+  def test_warning_ignore_bignum
+    assert_warning(/warning: constant ::Bignum is deprecated/) do
+      ::Bignum
+    end
+
+    Warning.ignore(:bignum, __FILE__)
+
+    assert_warning '' do
+      ::Bignum
+    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
+      instance_eval('d /a/', __FILE__)
+    end
+
+    Warning.ignore(:ambiguous_slash, __FILE__)
+
+    assert_warning '' do
+      instance_eval('d /a/', __FILE__)
+    end
+  end
+
+  def test_warning_ignore_unused_var
+    assert_warning(/warning: assigned but unused variable - \w+/) do
+      instance_eval('def self.e; b = 1; 2 end', __FILE__)
+    end
+
+    Warning.ignore(:unused_var, __FILE__)
+
+    assert_warning '' do
+      instance_eval('def self.f; b = 1; 2 end', __FILE__)
+    end
+  end
+
+  def test_warning_ignore_useless_operator
+    assert_warning(/warning: possibly useless use of == in void context/) do
+      instance_eval('1 == 2; true', __FILE__)
+    end
+
+    Warning.ignore(:useless_operator, __FILE__)
+
+    assert_warning '' do
+      instance_eval('1 == 2; true', __FILE__)
+    end
+  end
+
+  def test_warning_ignore_arg_prefix
+    assert_warning(/: warning: `\*' interpreted as argument prefix/) do
+      instance_eval('Array *[nil]', __FILE__)
+    end
+
+    assert_warning(/: warning: `&' interpreted as argument prefix/) do
+      instance_eval('tap &proc{}', __FILE__)
+    end
+    Warning.ignore(:arg_prefix, __FILE__)
+
+    assert_warning '' do
+      instance_eval('Array *[nil]', __FILE__)
+      instance_eval('tap &proc{}', __FILE__)
+    end
+  end
+
+  def test_warning_ignore_shadow
+    assert_warning(/warning: shadowing outer local variable - a/) do
+      instance_eval('lambda{|a| lambda{|a|}}', __FILE__)
+    end
+
+    Warning.ignore(:shadow, __FILE__)
+
+    assert_warning '' do
+      instance_eval('lambda{|a| lambda{|a|}}', __FILE__)
+    end
+  end
+
+  def test_warning_ignore_symbol_array
+    def self.c; end
+
+    assert_warning(/statement not reached.+method redefined; discarding old c.+previous definition of c was here/m) do
+      instance_eval('def self.c; return; 1 end', __FILE__)
+    end
+
+    Warning.ignore([:method_redefined, :not_reached], __FILE__)
+
+    assert_warning '' do
+      instance_eval('def self.c; return; 1 end', __FILE__)
     end
-  ensure
-    Warning.clear
   end
 
   def test_warning_process
     obj = Object.new
     warn = nil
 
-    require 'warning'
-
     Warning.process(__FILE__+'a') do |warning|
       warn = [0, warning]
     end
 
-    assert_warning /instance variable @ivar not initialized/ do
+    assert_warning(/instance variable @ivar not initialized/) do
       assert_nil(obj.instance_variable_get(:@ivar))
     end
     assert_nil(warn)
@@ -136,7 +283,7 @@ class WarningTest < Minitest::Test
 
     Warning.clear
 
-    assert_warning /instance variable @ivar5 not initialized/ do
+    assert_warning(/instance variable @ivar5 not initialized/) do
       assert_nil(obj.instance_variable_get(:@ivar5))
     end
     assert_nil(warn)
@@ -150,7 +297,5 @@ class WarningTest < Minitest::Test
     end
     assert_equal(4, warn.first)
     assert_match(/instance variable @ivar6 not initialized/, warn.last)
-  ensure
-    Warning.clear
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: warning
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-09 00:00:00.000000000 Z
+date: 2016-11-16 00:00:00.000000000 Z
 dependencies: []
 description: |
   ruby-warning adds custom processing for warnings, including the
@@ -46,9 +46,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: 2.3.99
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -56,7 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Add custom processing for warnings