ruby_warning_filter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 821c2df551dbf8fdcd0ba9889fbe8716606626d4
+  data.tar.gz: 2b06bcb3f1d649eef059437075db368da6678e7d
+SHA512:
+  metadata.gz: 695653150630dc7307f548f6c031e8fbc898ff24c918788b928628e8e99bcf9a39ce0243abbe8baaf2cc1bb2f57c77c8b2d208e3c583ffc4c55a7f96ab4645e7
+  data.tar.gz: 6df030eafa9370d022744a44e50537ca5e4814aea2568306f498812936a4cee935ddcea5759114ff350befbc3e4bcfc711c68e6eaa98f4686ba8a5155a49fb04

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem "rake", "~> 10.0"
+gem "minitest", "~> 5.0"

data/Manifest.txt

@@ -0,0 +1,7 @@
+Gemfile
+Manifest.txt
+Rakefile
+Readme.md
+lib/ruby_warning_filter.rb
+ruby_warning_filter.gemspec
+test/ruby_warnings_filter_test.rb

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+  t.warning = true
+end
+
+task :default => :test

data/Readme.md

@@ -0,0 +1,29 @@
+# Hassle-free Ruby warnings
+
+Ruby warnings are cool. They prevent you from making typos in instance variables, making unused variables, accidentally overriding methods, and more. Unfortunately, many libraries still don’t check their code for warnings. In a big enough project you end up with tons of warnings from all the libraries you use which renders the whole thing useless. But it doesn’t have to be this way!
+
+With the help of this gem you can filter out all those useless messages and only get the warnings relevant to your code.
+
+## Usage
+
+Add to your Gemfile:
+
+```ruby
+gem "ruby_warning_filter", "~> 1.0.0"
+```
+
+Put the following code somewhere before your project is loaded. In a Rails application, a good place would be at the end of "config/boot.rb".
+
+```ruby
+$VERBOSE = true
+require "ruby_warning_filter"
+$stderr = RubyWarningFilter.new($stderr)
+```
+
+When running your app or tests you should see only relevant warnings. Now, go fix them!
+
+## Feedback
+
+[![Build Status](https://travis-ci.org/semaperepelitsa/ruby_warning_filter.svg?branch=master)](https://travis-ci.org/semaperepelitsa/ruby_warning_filter)
+
+The filter works by proxying all writes to stderr. It has been running for a while in many of my work projects with good results. However, it is probably not comprehensive. Please, report any warnings that it misses or swallows by error.

data/lib/ruby_warning_filter.rb

@@ -0,0 +1,82 @@
+require 'delegate'
+
+# Filter IO from Ruby warnings that come out of external gems.
+# There is no other way currently to filter out Ruby warnings other than hijacking stderr.
+#
+#   $VERBOSE = true
+#   require "ruby_warning_filter"
+#   $stderr = RubyWarningFilter.new($stderr)
+#
+# Number of occurred non-filtered warnings can be read with ruby_warnings:
+#
+#   $stderr.ruby_warnings #=> 0
+#   @foo # warning: instance variable @foo not initialized
+#   $stderr.ruby_warnings #=> 1
+#
+# The filter only overrides "write" method. This is OK since Ruby uses "write" internally
+# when emitting warnings. Helper methods such as "puts", "print", "printf" will do native "write"
+# bypassing the filter.
+#
+class RubyWarningFilter < DelegateClass(IO)
+  attr_reader :ruby_warnings
+
+  def initialize(io, ignore_path: Gem.path)
+    super(io)
+    @ruby_warnings = 0
+    @ignored = false
+    @ignore_path = ignore_path
+  end
+
+  def write(line)
+    if @ignored && (backtrace?(line) || line == "\n")
+      # Ignore the whole backtrace after ignored warning.
+      # Some warnings write newline separately for some reason.
+      @ignored = true
+      nil
+    elsif @ignored && eval_redefined?(line)
+      # Some gems use eval to redefine methods and the second warning with the source does not have file path, so we need to ignore that explicitly.
+      @ignored = false
+      nil
+    elsif ruby_warning?(line)
+      @ignored = ignored_warning?(line)
+      unless @ignored
+        @ruby_warnings += 1
+        super
+      end
+    else
+      super
+    end
+  end
+
+  private
+
+  def ruby_warning?(line)
+    line =~ %r{:(\d+|in `\S+'): warning:}
+  end
+
+  def ignored_warning?(line)
+    external_warning?(line) || ignored_template_warning?(line)
+  end
+
+  def external_warning?(line)
+    @ignore_path.any?{ |path| line.start_with?(path) }
+  end
+
+  # Variables used in tag attributes (Slim) always cause a warning.
+  # TODO: Report this.
+  def ignored_template_warning?(line)
+    line =~ %r{\.slim:\d+: warning: possibly useless use of a variable in void context$}
+  end
+
+  def backtrace?(line)
+    line.start_with?("\tfrom")
+  end
+
+  def whitespace?(line)
+    line =~ /^\s*$/
+  end
+
+  def eval_redefined?(line)
+    line =~ /\(eval\):\d+: warning: previous definition of .+ was here/
+  end
+end

data/ruby_warning_filter.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |gem|
+  gem.name    = "ruby_warning_filter"
+  gem.version = "1.0.0"
+  gem.summary = "Hassle-free Ruby warnings"
+  gem.license = "MIT"
+  gem.author  = "Semyon Perepelitsa"
+  gem.email   = "sema@sema.in"
+
+  gem.homepage = "https://github.com/semaperepelitsa/ruby_warning_filter"
+
+  gem.files = File.read("Manifest.txt").split("\n")
+  gem.test_files = gem.files.grep(%r{^test/})
+end

data/test/ruby_warnings_filter_test.rb

@@ -0,0 +1,87 @@
+require "bundler/setup"
+require_relative "../lib/ruby_warning_filter"
+gem "minitest", "~> 5.0"
+require "minitest/autorun"
+require "stringio"
+STDOUT.sync = true
+
+class RubyWarningsFilterTest < MiniTest::Test
+  def setup
+    @err = RubyWarningFilter.new(StringIO.new, ignore_path: ["/path/to/ruby/2.2.0/gems"])
+  end
+
+  def test_no_effect
+    assert_equal 0, @err.ruby_warnings
+    @err.puts "hello"
+    assert_equal "hello\n", @err.string
+    assert_equal 0, @err.ruby_warnings
+  end
+
+  def test_ruby_warning
+    @err.write "/path/to/script/middleware_test.rb:58: warning: assigned but unused variable - status\n"
+    assert_equal "/path/to/script/middleware_test.rb:58: warning: assigned but unused variable - status\n",
+      @err.string
+    assert_equal 1, @err.ruby_warnings
+
+    @err.write "/path/to/ruby/2.2.0/gems/unicode_utils-1.4.0/lib/unicode_utils/sid.rb:11: warning: shadowing outer local variable - al\n"
+
+    # This warning actually writes newline separately.
+    @err.write "/path/to/ruby/2.2.0/gems/dragonfly-1.0.6/lib/dragonfly/utils.rb:41:in `uri_unescape': warning: URI.unescape is obsolete"
+    @err.write "\n"
+
+    assert_equal "/path/to/script/middleware_test.rb:58: warning: assigned but unused variable - status\n",
+      @err.string
+    assert_equal 1, @err.ruby_warnings
+  end
+
+  def test_backtrace
+    # in gem
+    @err.write "/path/to/ruby/2.2.0/gems/sass-3.4.12/lib/sass/util/normalized_map.rb:2: warning: loading in progress...\n"
+    @err.write "\tfrom /path/to/app/bin/rails:4:in  `<main>'\n"
+
+    # in app
+    @err.write "/path/to/app/script:1: warning: loading in progress...\n"
+    @err.write "\tfrom /path/to/app/bin/rails:4:in  `<main>'\n"
+
+    @err.write "something other\n"
+
+    assert_equal \
+      "/path/to/app/script:1: warning: loading in progress...\n"\
+      "\tfrom /path/to/app/bin/rails:4:in  `<main>'\n"\
+      "something other\n",
+      @err.string
+
+    assert_equal 1, @err.ruby_warnings
+  end
+
+  def test_method_redefined_eval
+    # in gem
+    @err.write "/path/to/ruby/2.2.0/gems/compass-core-1.0.3/lib/gradient_support.rb:319: warning: method redefined; discarding old to_moz\n"
+    @err.write "(eval):2: warning: previous definition of to_moz was here\n"
+
+    # in app
+    @err.write "/path/to/app.rb:123: warning: method redefined; discarding old foo\n"
+    @err.write "(eval):2: warning: previous definition of foo was here\n"
+
+    @err.write "something other\n"
+
+    assert_equal \
+      "/path/to/app.rb:123: warning: method redefined; discarding old foo\n"\
+      "(eval):2: warning: previous definition of foo was here\n"\
+      "something other\n",
+      @err.string
+    
+    assert_equal 2, @err.ruby_warnings
+  end
+
+  def test_template_warning
+    @err.write "/path/to/app/template.html.slim:2: warning: possibly useless use of a variable in void context\n"
+    assert_equal "", @err.string
+    assert_equal 0, @err.ruby_warnings
+
+    @err.write "/path/to/app/template.html.slim:2: warning: assigned but unused variable - foo\n"
+    assert_equal "/path/to/app/template.html.slim:2: warning: assigned but unused variable - foo\n",
+      @err.string
+    assert_equal 1, @err.ruby_warnings
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: ruby_warning_filter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Semyon Perepelitsa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-04 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: sema@sema.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Manifest.txt
+- Rakefile
+- Readme.md
+- lib/ruby_warning_filter.rb
+- ruby_warning_filter.gemspec
+- test/ruby_warnings_filter_test.rb
+homepage: https://github.com/semaperepelitsa/ruby_warning_filter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Hassle-free Ruby warnings
+test_files:
+- test/ruby_warnings_filter_test.rb