warning 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70b1655bff238b444c9373002b6d1010812a9a71
+  data.tar.gz: 2276292182d974e7fdb71802295ed1dc45771f82
+SHA512:
+  metadata.gz: 6a512057f73e7f275e806a9e9442919e128c0edcf312e730b4787f9b9630c8f088bdfce0af7a7b7f9d6e3811aa94ae95211a4b13d205353e1853c20f2f5a0a4d
+  data.tar.gz: 16e8d3da29e75c5c6f1dd70fede11564006ad30201923d8750aa0d383e77820fa4355c6fd6f6b44600bd276d9afd38706581c123c34898bbbf2534bb64cab5b3

data/CHANGELOG

@@ -0,0 +1,3 @@
+=== 0.9.0 (2016-08-09)
+
+* Initial Public Release

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2016 Jeremy Evans
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+  
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+   
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,68 @@
+= ruby-warning
+
+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.
+
+ruby-warning requires ruby 2.4+, as previous versions of ruby do
+not support custom processing of warnings.
+
+= Installation
+
+  gem install warning
+
+= Source Code
+
+Source code is available on GitHub at https://github.com/jeremyevans/ruby-warning
+
+= Usage 
+
+By default, requiring the library does not make changes to how ruby processes
+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.
+
+<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
+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.
+
+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.
+
+= 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__)
+
+  # Write warning to LOGGER at level warning
+  Warning.process do |warning|
+    LOGGER.warning(warning)
+  end
+
+  # Write warnings in the current file to LOGGER at level error
+  Warning.process(__FILE__) do |warning|
+    LOGGER.error(warning)
+  end
+
+= License
+
+MIT
+
+= Author
+
+Jeremy Evans <code@jeremyevans.net>

data/Rakefile

@@ -0,0 +1,39 @@
+require "rake"
+require "rake/clean"
+require 'rake/testtask'
+require "rdoc/task"
+
+CLEAN.include ["warning-*.gem", "rdoc"]
+
+desc "Build warning gem"
+task :package=>[:clean] do |p|
+  sh %{#{FileUtils::RUBY} -S gem build warning.gemspec}
+end
+
+### Specs
+
+desc "Run test"
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/test_*.rb']
+  t.verbose = true
+end
+
+task :default=>:test
+
+### RDoc
+
+RDOC_OPTS = ['--main', 'README.rdoc', "--quiet", "--line-numbers", "--inline-source", '--title', 'ruby-warning: Add custom processing for warnings']
+
+begin
+  gem 'hanna-nouveau'
+  RDOC_OPTS.concat(['-f', 'hanna'])
+rescue Gem::LoadError
+end
+
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.options += RDOC_OPTS
+  rdoc.rdoc_files.add %w"README.rdoc CHANGELOG MIT-LICENSE lib/**/*.rb"
+end

data/lib/warning.rb

@@ -0,0 +1,75 @@
+require 'monitor'
+
+module Warning
+  module Processor
+    # Clear all current ignored warnings and warning processors.
+    def clear
+      synchronize do
+        @ignore.clear
+        @process.clear
+      end
+    end
+    
+    # Ignore any warning messages matching the given regexp, if they
+    # start with the given path. 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__)
+    def ignore(regexp, path='')
+      synchronize do 
+        @ignore << [path, regexp]
+      end
+      nil
+    end
+
+    # Handle all warnings starting with the given path, instead of
+    # the default behavior of printing them to $stderr. Examples:
+    #
+    #   # Write warning to LOGGER at level warning
+    #   Warning.process do |warning|
+    #     LOGGER.warning(warning)
+    #   end
+    #
+    #   # Write warnings in the current file to LOGGER at level error level
+    #   Warning.process(__FILE__) do |warning|
+    #     LOGGER.error(warning)
+    #   end
+    def process(path='', &block)
+      synchronize do
+        @process << [path, block]
+        @process.sort_by!(&:first)
+        @process.reverse!
+      end
+      nil
+    end
+
+    # Handle ignored warnings and warning processors.  If the warning is
+    # not ignored 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
+
+      synchronize{@process.dup}.each do |path, block|
+        if str.start_with?(path)
+          block.call(str)
+          return
+        end
+      end
+
+      super
+    end
+  end
+
+  @ignore = []
+  @process = []
+
+  extend MonitorMixin
+  extend Processor
+end

data/test/test_warning.rb

@@ -0,0 +1,156 @@
+require 'minitest/unit'
+require 'minitest/autorun'
+
+class WarningTest < Minitest::Test
+  module EnvUtil
+    def verbose_warning
+      class << (stderr = "")
+        alias write <<
+      end
+      stderr, $stderr, verbose, $VERBOSE = $stderr, stderr, $VERBOSE, true
+      yield stderr
+      return $stderr
+    ensure
+      stderr, $stderr, $VERBOSE = $stderr, stderr, verbose
+    end
+    module_function :verbose_warning
+
+    def with_default_internal(enc)
+      verbose, $VERBOSE = $VERBOSE, nil
+      origenc, Encoding.default_internal = Encoding.default_internal, enc
+      $VERBOSE = verbose
+      yield
+    ensure
+      verbose, $VERBOSE = $VERBOSE, nil
+      Encoding.default_internal = origenc
+      $VERBOSE = verbose
+    end
+    module_function :with_default_internal
+  end
+
+  def assert_warning(pat, msg = nil)
+    stderr = EnvUtil.verbose_warning {
+      EnvUtil.with_default_internal(pat.encoding) {
+        yield
+      }
+    }
+    msg = message(msg) {diff pat, stderr}
+    assert(pat === stderr, msg)
+  end
+
+  def test_warning_ignore
+    obj = Object.new
+
+    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_nil(obj.instance_variable_get(:@ivar))
+    end
+
+    Warning.ignore(/instance variable @ivar not initialized/)
+
+    assert_warning '' do
+      assert_nil(obj.instance_variable_get(:@ivar))
+    end
+
+    assert_warning /instance variable @ivar2 not initialized/ do
+      assert_nil(obj.instance_variable_get(:@ivar2))
+    end
+
+    Warning.ignore(/instance variable @ivar2 not initialized/, __FILE__)
+
+    assert_warning '' do
+      assert_nil(obj.instance_variable_get(:@ivar2))
+    end
+
+    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_nil(obj.instance_variable_get(:@ivar3))
+    end
+
+    Warning.clear
+
+    assert_warning /instance variable @ivar not initialized/ do
+      assert_nil(obj.instance_variable_get(:@ivar))
+    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_nil(obj.instance_variable_get(:@ivar))
+    end
+    assert_nil(warn)
+
+    Warning.process(__FILE__) do |warning|
+      warn = [1, warning]
+    end
+
+    assert_warning '' do
+      assert_nil(obj.instance_variable_get(:@ivar2))
+    end
+    assert_equal(1, warn.first)
+    assert_match(/instance variable @ivar2 not initialized/, warn.last)
+    warn = nil
+
+    Warning.process(File.dirname(__FILE__)) do |warning|
+      warn = [2, warning]
+    end
+
+    assert_warning '' do
+      assert_nil(obj.instance_variable_get(:@ivar3))
+    end
+    assert_equal(1, warn.first)
+    assert_match(/instance variable @ivar3 not initialized/, warn.last)
+    warn = nil
+
+    Warning.process(__FILE__+':') do |warning|
+      warn = [3, warning]
+    end
+
+    assert_warning '' do
+      assert_nil(obj.instance_variable_get(:@ivar4))
+    end
+    assert_equal(3, warn.first)
+    assert_match(/instance variable @ivar4 not initialized/, warn.last)
+    warn = nil
+
+    Warning.clear
+
+    assert_warning /instance variable @ivar5 not initialized/ do
+      assert_nil(obj.instance_variable_get(:@ivar5))
+    end
+    assert_nil(warn)
+
+    Warning.process do |warning|
+      warn = [4, warning]
+    end
+
+    assert_warning '' do
+      assert_nil(obj.instance_variable_get(:@ivar6))
+    end
+    assert_equal(4, warn.first)
+    assert_match(/instance variable @ivar6 not initialized/, warn.last)
+  ensure
+    Warning.clear
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: warning
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Jeremy Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-09 00:00:00.000000000 Z
+dependencies: []
+description: |
+  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.
+email: code@jeremyevans.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- CHANGELOG
+- MIT-LICENSE
+files:
+- CHANGELOG
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/warning.rb
+- test/test_warning.rb
+homepage: https://github.com/jeremyevans/ruby-warning
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--quiet"
+- "--line-numbers"
+- "--inline-source"
+- "--title"
+- 'ruby-warning: Add custom processing for warnings'
+- "--main"
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Add custom processing for warnings
+test_files: []