uncruft 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fdb195d4b08809aa2c07c8496fcc908f11fcc990
+  data.tar.gz: 5790bc811ae97d8d3de5a851c26cd707b452b530
+SHA512:
+  metadata.gz: 766cefcb5c8b903953292269ad4ae8e451c4f1dd5f6f2b01d2c3f3283aefead950614b7354f9f28022ede6749aacfc042751c6cd9e9145b79b92bf5bb04d3df5
+  data.tar.gz: ace1be673782194643ffb5fe4b931fb7e7f947083084cb6c1c1af62deec03ef76ba44fb36c41384de516f97aaf2386b4957431f57d0c0f803bad8598bec4c243

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Betterment
+
+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 OR COPYRIGHT HOLDERS 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.md

@@ -0,0 +1,53 @@
+Uncruft
+========
+
+A library to assist with clearing out Rails deprecation warnings and upgrading Rails versions.
+
+## Getting Started
+
+Uncruft is designed to work with Rails 4.2 and higher.
+
+### Installation
+
+You can add Uncruft to your Gemfile with:
+
+```
+gem 'uncruft'
+```
+
+Then run `bundle install`.
+
+### Deprecation Warnings
+
+By default, deprecation warnings will cause your application to raise exceptions in `test` and `development` modes.
+
+The exception message will include the original deprecation warning, plus a link to [our troubleshooting guide](https://github.com/Betterment/uncruft/blob/master/GUIDE.md), to assist with resolving deprecations as they are encountered.
+
+## Whitelisting Deprecations
+
+When testing on a new Rails version for the first time, you will undoubtedly encounter many new warnings. As such, you can quickly whitelist all existing deprecation warnings encountered during your test suite like so:
+
+```bash
+WHITELIST_DEPRECATIONS=1 rake
+```
+
+You can also incrementally add new warnings to the whitelist as you encounter them:
+
+```bash
+WHITELIST_DEPRECATIONS=1 rspec path/to/my/failing/spec.rb
+```
+
+This will generate (or add to) a whitelist of warnings at `config/deprecations.ignore`. Any warning in that file will be ignored when next encountered.
+
+## How to Contribute
+
+We would love for you to contribute! Anything that benefits the majority of users—from a documentation fix to an entirely new feature—is encouraged.
+
+Before diving in, [check our issue tracker](//github.com/Betterment/uncruft/issues) and consider creating a new issue to get early feedback on your proposed change.
+
+### Suggested Workflow
+
+* Fork the project and create a new branch for your contribution.
+* Write your contribution (and any applicable test coverage).
+* Make sure all tests pass (`bundle exec rake`).
+* Submit a pull request.

data/Rakefile

@@ -0,0 +1,24 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+task(:default).clear
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+if ENV['APPRAISAL_INITIALIZED'] || ENV['TRAVIS']
+  task default: %i(rubocop spec)
+else
+  require 'appraisal'
+  Appraisal::Task.new
+  task default: :appraisal
+end

data/lib/uncruft.rb

@@ -0,0 +1,19 @@
+require 'uncruft/version'
+require 'uncruft/railtie'
+require 'uncruft/deprecation_handler'
+require 'uncruft/warning'
+
+module Uncruft
+  class << self
+    # http://api.rubyonrails.org/classes/ActiveModel/Type/Boolean.html
+    FALSE_VALUES = [false, 0, "0", "f", "F", "false", "FALSE", "off", "OFF"].to_set
+
+    def whitelist_deprecations?
+      ENV['WHITELIST_DEPRECATIONS'].presence && !FALSE_VALUES.include?(ENV['WHITELIST_DEPRECATIONS'])
+    end
+
+    def ignorefile_path
+      ENV['UNCRUFT_IGNOREFILE_PATH'] || Rails.root.join('config', 'deprecations.ignore')
+    end
+  end
+end

data/lib/uncruft/deprecation_handler.rb

@@ -0,0 +1,122 @@
+require 'set'
+
+module Uncruft
+  class DeprecationHandler
+    def call(message, _callstack)
+      line_number = line_number(message)
+      message = normalize_message(message)
+      handle_unknown_deprecation!(message, line_number) unless known_deprecations.include?(message)
+    end
+
+    def arity
+      2
+    end
+
+    private
+
+    def handle_unknown_deprecation!(message, line_number)
+      if Uncruft.whitelist_deprecations?
+        known_deprecations << message
+        write_deprecations_file!
+      else
+        raise error_message(message, line_number)
+      end
+    end
+
+    def write_deprecations_file!
+      file = File.open(Uncruft.ignorefile_path, 'w')
+      file.puts(file_content(known_deprecations))
+      file.close
+    end
+
+    def line_number(message)
+      message.match(/called from( .+ at)? .+:(\d+)/)&.[](2)
+    end
+
+    # Rails deprecation message formats found here:
+    # https://github.com/rails/rails/blob/5-0-stable/activesupport/lib/active_support/deprecation/reporting.rb#L75
+    def normalize_message(message)
+      remove_line_number(normalize_caller(normalize_callstack_path(message)))
+    end
+
+    def normalize_callstack_path(message)
+      if (gem_home = gem_home(message)).present?
+        message.gsub(gem_home, '$GEM_PATH')
+      elsif (absolute_path = absolute_path(message)).present?
+        message.gsub(absolute_path, relative_path(absolute_path))
+      end
+    end
+
+    def normalize_caller(message)
+      normalize_require_callers(remove_view_callers(message))
+    end
+
+    def normalize_require_callers(message)
+      message.gsub(/ <(top \(required\)|main)> at /, ' <global scope> at ')
+    end
+
+    def remove_view_callers(message)
+      message.gsub(/ _\w+__+\d+_\d+ at /, ' ')
+    end
+
+    def remove_line_number(message)
+      message.sub(/(called from( .+ at)? .+):\d+/, '\1')
+    end
+
+    def gem_home(message)
+      message.match(%r{called from( .+ at)? (#{ENV['GEM_HOME']}/(.+/)*gems)})&.[](2)
+    end
+
+    def absolute_path(message)
+      message.match(/called from( .+ at)? (.+):\d/)&.[](2)
+    end
+
+    def relative_path(absolute_path)
+      Pathname.new(absolute_path)
+        .relative_path_from(Rails.root).to_s
+        .gsub(%r{\A(../)*vendor/cache}, '$GEM_PATH')
+    rescue ArgumentError # When `relative_path_from` cannot find a relative path.
+      absolute_path
+    end
+
+    def error_message(message, line_number)
+      <<~ERROR.strip
+        #{message}:#{line_number}
+
+        To resolve this error, adjust your code according to the instructions above.
+        If you did not introduce this error or are unsure why you are seeing it,
+        you will find additional guidance at the URL below:
+        https://github.com/Betterment/uncruft/blob/master/GUIDE.md
+      ERROR
+    end
+
+    def known_deprecations_file_exists?
+      File.file?(Uncruft.ignorefile_path)
+    end
+
+    def known_deprecations
+      @known_deprecations ||= begin
+        if known_deprecations_file_exists?
+          file = File.read(Uncruft.ignorefile_path)
+          JSON.parse(file)['ignored_warnings'].to_set
+        else
+          Set.new
+        end
+      end
+    end
+
+    def file_content(deprecations)
+      JSON.pretty_generate ignored_warnings: deprecations.sort,
+                           updated: now,
+                           rails_version: Rails::VERSION::STRING
+    end
+
+    def now
+      if defined?(Timecop)
+        Timecop.return { Time.zone.now }
+      else
+        Time.zone.now
+      end
+    end
+  end
+end

data/lib/uncruft/railtie.rb

@@ -0,0 +1,14 @@
+require 'rails'
+
+module Uncruft
+  class Railtie < ::Rails::Railtie
+    if Rails.env.test? || Rails.env.development?
+      initializer 'uncruft.deprecation_handler', before: 'active_support.deprecation_behavior' do
+        strategies = [config.active_support.deprecation].flatten(1).compact
+        strategies.reject! { |s| s == :stderr }
+        strategies.unshift(DeprecationHandler.new)
+        config.active_support.deprecation = strategies
+      end
+    end
+  end
+end

data/lib/uncruft/version.rb

@@ -0,0 +1,3 @@
+module Uncruft
+  VERSION = '0.0.1'.freeze
+end

data/lib/uncruft/warning.rb

@@ -0,0 +1,32 @@
+module Uncruft
+  module Warning
+    DEPRECATION_PATTERN = /(deprecation|deprecated)/i
+
+    def warn(str)
+      if str =~ DEPRECATION_PATTERN # rubocop:disable Performance/RegexpMatch
+        message = strip_caller_info(str, caller_locations(1..1).first).strip
+        ActiveSupport::Deprecation.warn(message)
+      else
+        super
+      end
+    end
+
+    private
+
+    def strip_caller_info(str, cloc)
+      str.sub(cloc.to_s, '') # try full caller information first
+        .gsub(/#{cloc.path}(:#{cloc.lineno})?:?\s*/, '') # try path with optional line
+    end
+  end
+end
+
+if Rails.env.development? || Rails.env.test?
+  if defined?(Warning)
+    Warning.prepend(Uncruft::Warning)
+    Warning.singleton_class.prepend(Uncruft::Warning)
+  end
+  Kernel.prepend(Uncruft::Warning)
+  Kernel.singleton_class.prepend(Uncruft::Warning)
+  Object.prepend(Uncruft::Warning)
+  Object.singleton_class.prepend(Uncruft::Warning)
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,8 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)
+
+module Dummy
+  class Application < Rails::Application
+  end
+end

data/spec/dummy/config/deprecations.ignore

@@ -0,0 +1,7 @@
+{
+  "ignored_warnings": [
+    "Warning: BAD called from chicken/nuggets.rb"
+  ],
+  "updated": "2018-06-05 15:20:12 -0400",
+  "rails_version": "5.1.6"
+}

data/spec/examples.txt

@@ -0,0 +1,24 @@
+example_id                                              | status | run_time        |
+------------------------------------------------------- | ------ | --------------- |
+./spec/uncruft/deprecation_handler_spec.rb[1:1:1]       | passed | 0.00321 seconds |
+./spec/uncruft/deprecation_handler_spec.rb[1:1:2:1]     | passed | 0.01779 seconds |
+./spec/uncruft/deprecation_handler_spec.rb[1:1:2:2:1]   | passed | 0.00596 seconds |
+./spec/uncruft/deprecation_handler_spec.rb[1:1:3:1]     | passed | 0.00079 seconds |
+./spec/uncruft/deprecation_handler_spec.rb[1:1:4:1]     | passed | 0.00071 seconds |
+./spec/uncruft/deprecation_handler_spec.rb[1:1:5:1]     | passed | 0.00247 seconds |
+./spec/uncruft/deprecation_handler_spec.rb[1:1:6:1]     | passed | 0.0026 seconds  |
+./spec/uncruft/deprecation_handler_spec.rb[1:1:6:2:1]   | passed | 0.0029 seconds  |
+./spec/uncruft/deprecation_handler_spec.rb[1:1:6:3:1]   | passed | 0.00142 seconds |
+./spec/uncruft/deprecation_handler_spec.rb[1:1:6:3:2:1] | passed | 0.00168 seconds |
+./spec/uncruft/deprecation_handler_spec.rb[1:1:7:1]     | passed | 0.00052 seconds |
+./spec/uncruft/deprecation_handler_spec.rb[1:1:8:1]     | passed | 0.00211 seconds |
+./spec/uncruft/deprecation_handler_spec.rb[1:1:8:2:1]   | passed | 0.00335 seconds |
+./spec/uncruft/railtie_spec.rb[1:1]                     | passed | 0.06556 seconds |
+./spec/uncruft/railtie_spec.rb[1:2:1]                   | passed | 0.00156 seconds |
+./spec/uncruft/railtie_spec.rb[1:3:1]                   | passed | 0.00133 seconds |
+./spec/uncruft/warning_spec.rb[1:1]                     | passed | 0.00076 seconds |
+./spec/uncruft/warning_spec.rb[1:2:1]                   | passed | 0.00158 seconds |
+./spec/uncruft/warning_spec.rb[1:2:2:1]                 | passed | 0.00142 seconds |
+./spec/uncruft_spec.rb[1:1:1]                           | passed | 0.00533 seconds |
+./spec/uncruft_spec.rb[1:2:1]                           | passed | 0.00091 seconds |
+./spec/uncruft_spec.rb[1:2:2:1]                         | passed | 0.00151 seconds |

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'bundler'
+Bundler.require :default, :development
+
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path('dummy/config/application', __dir__)
+require 'support/rails_root'
+
+Time.zone = ActiveSupport::TimeZone.all.first
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+end

data/spec/support/rails_root.rb

@@ -0,0 +1,7 @@
+module ::Rails
+  class << self
+    def root
+      @root ||= Pathname.new(Dir.pwd).realpath.join('spec', 'dummy')
+    end
+  end
+end

data/spec/uncruft/deprecation_handler_spec.rb

@@ -0,0 +1,172 @@
+require 'spec_helper'
+
+RSpec.describe Uncruft::DeprecationHandler do
+  let(:ignorefile_path) { Rails.root.join('config', 'deprecations.ignore') }
+
+  before do
+    File.delete(ignorefile_path) if File.exist?(ignorefile_path)
+  end
+
+  subject { described_class.new }
+
+  describe '#call' do
+    let(:absolute_path) { Rails.root.join('chicken', 'nuggets.rb') }
+    let(:line_number) { 123 }
+    let(:caller_label) { '<something>' }
+    let(:message) { "Warning: BAD called from #{caller_label} at #{absolute_path}:#{line_number}" }
+    let(:expected_whitelist_entry) { 'Warning: BAD called from <something> at chicken/nuggets.rb' }
+    let(:expected_error) { "#{expected_whitelist_entry}:123" }
+    let(:expected_error_message) do
+      <<~ERROR.strip
+        #{expected_error}
+
+        To resolve this error, adjust your code according to the instructions above.
+        If you did not introduce this error or are unsure why you are seeing it,
+        you will find additional guidance at the URL below:
+        https://github.com/Betterment/uncruft/blob/master/GUIDE.md
+      ERROR
+    end
+
+    it 'sanitizes the message and raises an error' do
+      expect { subject.call(message, '') }.to raise_error(RuntimeError, expected_error_message)
+    end
+
+    context 'when whitelisting new deprecations' do
+      before do
+        allow(Uncruft).to receive(:whitelist_deprecations?).and_return(true)
+      end
+
+      it 'sanitizes the message and writes it to the file' do
+        expect { subject.call(message, '') }.to change { File.exist?(ignorefile_path) }.from(false).to(true)
+        expect(File.read(ignorefile_path)).to include(expected_whitelist_entry)
+      end
+
+      context 'when timecop is enabled' do
+        let(:test_started) { Time.zone.now }
+
+        it 'ignores time travel and writes the current time' do
+          Timecop.travel(test_started - 100.years) do
+            subject.call(message, '')
+
+            file_updated = Time.zone.parse(JSON.parse(File.read(ignorefile_path))['updated'])
+            expect(file_updated).to be_within(1.second).of(test_started)
+          end
+        end
+      end
+    end
+
+    context 'when caller is an erb file' do
+      let(:caller_label) { '_app_views_bananas_show__1234_567890' }
+      let(:expected_whitelist_entry) { 'Warning: BAD called from chicken/nuggets.rb' }
+
+      it 'sanitizes the message and raises an error' do
+        expect { subject.call(message, '') }.to raise_error(RuntimeError, expected_error_message)
+      end
+    end
+
+    context 'when caller is "top (required)"' do
+      let(:caller_label) { '<top (required)>' }
+      let(:expected_whitelist_entry) { 'Warning: BAD called from <global scope> at chicken/nuggets.rb' }
+
+      it 'sanitizes the caller and raises an error' do
+        expect { subject.call(message, '') }.to raise_error(RuntimeError, expected_error_message)
+      end
+    end
+
+    context 'when caller is "main"' do
+      let(:caller_label) { '<main>' }
+      let(:expected_whitelist_entry) { 'Warning: BAD called from <global scope> at chicken/nuggets.rb' }
+
+      it 'sanitizes the caller and raises an error' do
+        expect { subject.call(message, '') }.to raise_error(RuntimeError, expected_error_message)
+      end
+    end
+
+    context 'when message includes custom gem path' do
+      let(:absolute_path) { Pathname.new('/banana/banana/banana/gems/chicken/nuggets.rb') }
+      let(:expected_whitelist_entry) { "Warning: BAD called from <something> at $GEM_PATH/chicken/nuggets.rb" }
+
+      before do
+        allow(ENV).to receive(:[]).and_call_original
+        allow(ENV).to receive(:[]).with('GEM_HOME').and_return('/banana/banana/banana')
+      end
+
+      it 'sanitizes the message and raises an error' do
+        expect { subject.call(message, '') }.to raise_error(RuntimeError, expected_error_message)
+      end
+
+      context 'when gem home is nested' do
+        let(:absolute_path) { Pathname.new('/banana/banana/banana/arbitrary/gem/path/gems/chicken/nuggets.rb') }
+
+        it 'sanitizes the message and raises an error' do
+          expect { subject.call(message, '') }.to raise_error(RuntimeError, expected_error_message)
+        end
+      end
+
+      context 'when gem is vendored' do
+        let(:absolute_path) { Rails.root.join('vendor', 'cache', 'chicken', 'nuggets.rb') }
+
+        it 'sanitizes the message and raises an error' do
+          expect { subject.call(message, '') }.to raise_error(RuntimeError, expected_error_message)
+        end
+
+        context 'when gem is vendored elsewhere' do
+          let(:absolute_path) { Rails.root.join('..', '..', 'vendor', 'cache', 'chicken', 'nuggets.rb') }
+
+          it 'sanitizes the message and raises an error' do
+            expect { subject.call(message, '') }.to raise_error(RuntimeError, expected_error_message)
+          end
+        end
+      end
+    end
+
+    context 'when caller is not a filepath' do
+      let(:absolute_path) { '(pry)' }
+      let(:expected_whitelist_entry) { 'Warning: BAD called from <something> at (pry)' }
+
+      it 'sanitizes the message and raises an error' do
+        expect { subject.call(message, '') }.to raise_error(RuntimeError, expected_error_message)
+      end
+    end
+
+    context 'when whitelist exists' do
+      let(:message) { "Warning: BAD called from #{absolute_path}:#{line_number}" }
+      let(:file_content) do
+        <<~IGNOREFILE
+          {
+            "ignored_warnings": [
+              "Warning: BAD called from chicken/nuggets.rb"
+            ],
+            "updated": "2018-06-05 15:20:12 -0400",
+            "rails_version": "5.1.6"
+          }
+        IGNOREFILE
+      end
+
+      before do
+        File.open(ignorefile_path, 'w') do |f|
+          f.write file_content
+        end
+      end
+
+      it 'does not raise an error and leaves the file intact' do
+        expect(File.read(ignorefile_path)).to eq(file_content)
+        expect { subject.call(message, '') }.not_to change { File.read(ignorefile_path) }
+      end
+
+      context 'when whitelisting new deprecations' do
+        let(:line_number) { '456' }
+
+        before do
+          allow(Uncruft).to receive(:whitelist_deprecations?).and_return(true)
+        end
+
+        it 'does not raise an error and leaves the file intact' do
+          expect(File.read(ignorefile_path)).to eq(file_content)
+          expect { subject.call(message, '') }.not_to raise_error
+          expect(File.read(ignorefile_path)).to include('Warning: BAD called from chicken/nuggets.rb')
+        end
+      end
+    end
+  end
+end

data/spec/uncruft/railtie_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Uncruft::Railtie do
+  let(:app) { Rails.application }
+  let(:initializers) { app.initializers.tsort_each.select { |i| i.name.to_s.include?('deprecation') } }
+
+  it 'injects the default deprecation handler' do
+    expect { initializers.map { |i| i.run(app) } }.to change { Rails.application.config.active_support.deprecation }
+      .from(nil).to(a_collection_containing_exactly(an_instance_of(Uncruft::DeprecationHandler)))
+  end
+
+  context 'when the configured behavior is :stderr' do
+    before do
+      Rails.application.config.active_support.deprecation = :stderr
+    end
+
+    it 'injects the default deprecation handler' do
+      expect { initializers.map { |i| i.run(app) } }.to change { Rails.application.config.active_support.deprecation }
+        .from(:stderr).to(a_collection_containing_exactly(an_instance_of(Uncruft::DeprecationHandler)))
+    end
+  end
+
+  context 'when a custom deprecation behavior is already configured' do
+    before do
+      Rails.application.config.active_support.deprecation = :notify
+    end
+
+    it 'injects the default deprecation handler' do
+      expect { initializers.map { |i| i.run(app) } }.to change { Rails.application.config.active_support.deprecation }
+        .from(:notify).to(a_collection_containing_exactly(:notify, an_instance_of(Uncruft::DeprecationHandler)))
+    end
+  end
+end

data/spec/uncruft/warning_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Uncruft::Warning do
+  before do
+    stub_const('Warning', Kernel) unless defined?(Warning)
+  end
+
+  it "doesn't block generic warnings" do
+    expect(ActiveSupport::Deprecation).not_to receive(:warn)
+    warn('oh no, you should worry')
+    Kernel.warn('oh no, you should worry')
+    Warning.warn('oh no, you should worry')
+  end
+
+  context 'when warning includes the word "deprecation" or "deprecated"' do
+    it 'treats it as a deprecation warning' do
+      expect(ActiveSupport::Deprecation).to receive(:warn).and_return('banana').exactly(6).times
+      expect(warn('[dEpReCaTiOn] oh no, you should worry')).to eq 'banana'
+      expect(Kernel.warn('[dEpReCaTiOn] oh no, you should worry')).to eq 'banana'
+      expect(Warning.warn('[dEpReCaTiOn] oh no, you should worry')).to eq 'banana'
+      expect(warn('oh no, this is DePrEcAtEd, so you should worry')).to eq 'banana'
+      expect(Kernel.warn('oh no, this is DePrEcAtEd, so you should worry')).to eq 'banana'
+      expect(Warning.warn('oh no, this is DePrEcAtEd, so you should worry')).to eq 'banana'
+    end
+
+    context 'and when warning includes caller info' do
+      it 'strips out the path so that ActiveSupport::Deprecation can append a new one' do
+        path = caller_locations(0..0).first.path
+
+        expect(ActiveSupport::Deprecation).to receive(:warn).with('foo is deprecated!').and_return('hurray')
+        expect(warn("#{path}: foo is deprecated!")).to eq('hurray')
+
+        expect(ActiveSupport::Deprecation).to receive(:warn).with('[DEPRECATION] bar is no more.').and_return('huzzah')
+        expect(Kernel.warn("[DEPRECATION] bar is no more. #{path}:#{caller_locations(0..0).first.lineno}")).to eq('huzzah')
+
+        expect(ActiveSupport::Deprecation).to receive(:warn).with('Deprecation detected: banana --').and_return('we do our best...')
+        expect(Warning.warn("Deprecation detected: banana -- #{caller(0..0).first}")).to eq('we do our best...')
+      end
+    end
+  end
+end

data/spec/uncruft_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+RSpec.describe Uncruft do
+  describe '.whitelist_deprecations?' do
+    it 'handles common truthy and falsy values' do
+      allow(ENV).to receive(:[]).with('WHITELIST_DEPRECATIONS').and_return('1')
+      expect(described_class.whitelist_deprecations?).to eq true
+      allow(ENV).to receive(:[]).with('WHITELIST_DEPRECATIONS').and_return('t')
+      expect(described_class.whitelist_deprecations?).to eq true
+      allow(ENV).to receive(:[]).with('WHITELIST_DEPRECATIONS').and_return('T')
+      expect(described_class.whitelist_deprecations?).to eq true
+      allow(ENV).to receive(:[]).with('WHITELIST_DEPRECATIONS').and_return('true')
+      expect(described_class.whitelist_deprecations?).to eq true
+      allow(ENV).to receive(:[]).with('WHITELIST_DEPRECATIONS').and_return('TRUE')
+      expect(described_class.whitelist_deprecations?).to eq true
+      allow(ENV).to receive(:[]).with('WHITELIST_DEPRECATIONS').and_return('0')
+      expect(described_class.whitelist_deprecations?).to eq false
+      allow(ENV).to receive(:[]).with('WHITELIST_DEPRECATIONS').and_return('f')
+      expect(described_class.whitelist_deprecations?).to eq false
+      allow(ENV).to receive(:[]).with('WHITELIST_DEPRECATIONS').and_return('F')
+      expect(described_class.whitelist_deprecations?).to eq false
+      allow(ENV).to receive(:[]).with('WHITELIST_DEPRECATIONS').and_return('false')
+      expect(described_class.whitelist_deprecations?).to eq false
+      allow(ENV).to receive(:[]).with('WHITELIST_DEPRECATIONS').and_return('FALSE')
+      expect(described_class.whitelist_deprecations?).to eq false
+      allow(ENV).to receive(:[]).with('WHITELIST_DEPRECATIONS').and_return('')
+      expect(described_class.whitelist_deprecations?).to be_nil
+    end
+  end
+
+  describe '.ignorefile_path' do
+    it 'uses rails root' do
+      expect(described_class.ignorefile_path).to eq(Rails.root.join('config', 'deprecations.ignore'))
+    end
+
+    context 'when env var is set' do
+      before do
+        allow(ENV).to receive(:[]).with('UNCRUFT_IGNOREFILE_PATH').and_return('/path/to/file.txt')
+      end
+
+      it 'uses env var' do
+        expect(described_class.ignorefile_path).to eq('/path/to/file.txt')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: uncruft
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathan Griffith
+- Chris Zega
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-betterment
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description: A library to assist with clearing out Rails deprecation warnings and
+  upgrading Rails versions
+email:
+- nathan@betterment.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/uncruft.rb
+- lib/uncruft/deprecation_handler.rb
+- lib/uncruft/railtie.rb
+- lib/uncruft/version.rb
+- lib/uncruft/warning.rb
+- spec/dummy/config/application.rb
+- spec/dummy/config/deprecations.ignore
+- spec/dummy/log/test.log
+- spec/examples.txt
+- spec/spec_helper.rb
+- spec/support/rails_root.rb
+- spec/uncruft/deprecation_handler_spec.rb
+- spec/uncruft/railtie_spec.rb
+- spec/uncruft/warning_spec.rb
+- spec/uncruft_spec.rb
+homepage: https://github.com/Betterment/uncruft
+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.6.13
+signing_key: 
+specification_version: 4
+summary: A library to assist with Rails upgrades
+test_files:
+- spec/spec_helper.rb
+- spec/dummy/config/deprecations.ignore
+- spec/dummy/config/application.rb
+- spec/dummy/log/test.log
+- spec/examples.txt
+- spec/uncruft/railtie_spec.rb
+- spec/uncruft/warning_spec.rb
+- spec/uncruft/deprecation_handler_spec.rb
+- spec/support/rails_root.rb
+- spec/uncruft_spec.rb