ten_years_rails 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cb75bc7f573b543ca6491b72f0289b4f107b93b8
+  data.tar.gz: ede4f3a2877aee2dbb3d0034b6b99d3b570b0cc4
+SHA512:
+  metadata.gz: 0d98fba5b66b37ad5ba174f234ae2670c5908687c97db16339a61364a8b3ab343dfb698d90b25c9d75a8e5faec2d7eeab1fcea9045ee716b6b85c24ff9ca9625
+  data.tar.gz: 1c230f4d09bd81f2fb89e346f32304b05c26be4a4c715a8d93e5d7b83135156ef3ec5cfce648805fc6c1bab91409d4eb91ae5b8b95bca8a0b1ce5c9c0ac41f6c

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ten_years_rails.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: .
+  specs:
+    ten_years_rails (0.1.0)
+      actionview
+      activesupport
+      colorize (>= 0.8.1)
+      rest-client (>= 2.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (5.2.0)
+      activesupport (= 5.2.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    builder (3.2.3)
+    colorize (0.8.1)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    erubi (1.7.1)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    netrc (0.11.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    rake (10.4.2)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  ten_years_rails!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jordan Raine
+
+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,96 @@
+# Ten Years of Rails Upgrades
+
+This is a companion to the "Ten Years of Rails Upgrades" conference talk. You'll find various utilities that we use at Clio to help us prepare for and complete Rails upgrades.
+
+These scripts are still early days and may not work in every environment or app.
+
+I wouldn't recommend adding this to your Gemfile long-term. Rather, try out the scripts and use them as a point of reference. Feel free to tweak them to better fit your environment.
+
+## Usage
+
+### `bundle_report`
+
+Learn about your Gemfile and see what needs updating.
+
+```bash
+# Show all out-of-date gems
+bundle_report outdated
+# Show five oldest, out-of-date gems
+bundle_report outdated | head -n 5
+# Show gems that don't work with Rails 5.2.0
+bundle_report compatibility --rails-version=5.2.0
+bundle_report --help
+```
+
+### Deprecation tracking
+
+If you're using RSpec, add this snippet to `rails_helper.rb` or `spec_helper.rb` (whichever loads Rails).
+
+```ruby
+RSpec.configure do |config|
+  # Tracker deprecation messages in each file
+  if ENV["DEPRECATION_TRACKER"]
+    DeprecationTracker.track_rspec(
+      config,
+      shitlist_path: "spec/support/deprecation_warning.shitlist.json",
+      mode: ENV["DEPRECATION_TRACKER"],
+      transform_message: -> (message) { message.gsub("#{Rails.root}/", "") }
+    )
+  end
+end
+```
+
+We don't use MiniTest, so there isn't a prebuilt config for it but I suspect it's pretty similar to `DeprecationTracker.track_rspec`.
+
+Once you have that, you can start using deprecation tracking in your tests:
+
+```bash
+# Run your tests and save the deprecations to the shitlist
+DEPRECATION_TRACKER=save rspec
+# Run your tests and raise an error when the deprecations change
+DEPRECATION_TRACKER=compare rspec
+```
+
+#### `deprecations` command
+
+Once you have stored your deprecations, you can use `deprecations` to display common warnings, run specs, or update the shitlist file.
+
+```bash
+deprecations info
+deprecations info --pattern "ActiveRecord::Base"
+deprecations run
+deprecations --help # For more options and examples
+```
+
+Right now, the path to the shitlist is hardcoded so make sure you store yours at `spec/support/deprecations.shitlist.json`.
+
+### Dual-boot Rails next
+
+This command helps you dual-boot your application.
+
+```bash
+next --init         # Create Gemfile.next
+vim Gemfile         # Tweak your dependencies conditionally using `next?`
+next bundle install # Install new gems
+next rails s        # Start server using Gemfile.next
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ten_years_rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ten_years_rails
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ten_years_rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/deprecation_tracker.md

@@ -0,0 +1,120 @@
+# Deprecation Tracker
+
+In order to control the deprecation warnings that occur during a test run, we create a shitlist of deprecation warnings that we expect to see for each spec file. If code run by a spec file changes how often or what deprecation warning occurs, an error is raised after the RSpec run is complete.
+
+It looks something like this:
+
+```
+An error occurred in an `after(:suite)` hook.
+Failure/Error: raise UnexpectedDeprecations, message
+
+DeprecationTracker::UnexpectedDeprecations:
+  ⚠️  Deprecation warnings have changed!
+
+  Code called by the following spec files is now generating different deprecation warnings:
+
+  ./spec/deprecation_spec.rb
+
+  Here is a diff between what is expected and what was generated by this process:
+
+  diff --git a/spec/support/deprecation_tracker.json b/var/folders/mv/x81dlrp92w5053_m9bgqbkmm0000gp/T/test-deprecations20180328-33449-xgor20
+  index 76d2118f9f2..257be30d46c 100644
+  --- a/spec/support/deprecation_tracker.json
+  +++ b/var/folders/mv/x81dlrp92w5053_m9bgqbkmm0000gp/T/test-deprecations20180328-33449-xgor20
+  @@ -1,7 +1,8 @@
+   {
+     "./spec/deprecation_spec.rb": [
+       "DEPRECATION WARNING: `ActiveRecord::Base.symbolized_base_class` is deprecated and will be removed without replacement. (called from block (2 levels) in <top (required)> at /Users/Jordan/projects/themis3/spec/deprecation_spec.rb:5)",
+  -    "DEPRECATION WARNING: `ActiveRecord::Base.symbolized_base_class` is deprecated and will be removed without replacement. (called from block (2 levels) in <top (required)> at /Users/Jordan/projects/themis3/spec/deprecation_spec.rb:6)"
+  +    "DEPRECATION WARNING: `ActiveRecord::Base.symbolized_base_class` is deprecated and will be removed without replacement. (called from block (2 levels) in <top (required)> at /Users/Jordan/projects/themis3/spec/deprecation_spec.rb:6)",
+  +    "DEPRECATION WARNING: `ActiveRecord::Base.symbolized_base_class` is deprecated and will be removed without replacement. (called from block (2 levels) in <top (required)> at /Users/Jordan/projects/themis3/spec/deprecation_spec.rb:7)"
+     ],
+     "./spec/models/refund_spec.rb": [
+
+# ./spec/support/deprecation_tracker.rb:65:in `compare'
+# ./spec/support/deprecation_tracker.rb:29:in `block in track_rspec'
+# /Users/Jordan/.rbenv/versions/2.4.3/bin/rspec:23:in `load'
+# /Users/Jordan/.rbenv/versions/2.4.3/bin/rspec:23:in `<top (required)>'
+# /Users/Jordan/.rbenv/versions/2.4.3/bin/bundle:23:in `load'
+# /Users/Jordan/.rbenv/versions/2.4.3/bin/bundle:23:in `<main>'
+
+Finished in 1.83 seconds (files took 9.09 seconds to load)
+1 example, 0 failures, 1 error occurred outside of examples
+```
+
+When the diff shows a line was removed, it means we expected to see that deprecation message but didn't.
+When the diff shows a line was added, it means didn't expect to see that deprecation message.
+
+> **Protip**: If you find the diff difficult to read in your terminal, copy/paste it into your text editor and set syntax highlighting to "diff" for a colorized view.
+
+Keeping a list of all deprecation warnings has two primary benefits:
+
+- We can fail CI when new deprecation warnings are added (i.e., "stop the bleeding")
+- We can more easily find and eliminate deprecation warnings
+
+## Modes
+
+The deprecation tracker has three mode: `compare`, `save`, and off.
+
+- `DEPRECATION_TRACKER=compare rspec foo_spec.rb`: in `compare` mode, changes to the deprecation warnings output by a test file will trigger an error. 
+- `DEPRECATION_TRACKER=save rspec foo_spec.rb`: in `save` mode, changes to the deprecation warnings output by a test file will update the shitlist.
+- `rspec foo_spec.rb`: when turned off, changes to the deprecation warnings output by a test file won't trigger a warning or update the shitlist.
+
+
+## What does it track?
+
+This tracks deprecations from Rails and `Kernel#warn`, the latter often used by gems that don't use ActiveSupport.
+
+It only tracks deprecation warnings that occur during a test and not before or after. This means that some deprecations, for example the ones you might see while the app boots, won't be tracked.
+
+It also doesn't track constant deprecations (`warning: constant Foo is deprecated`) because those [happen in C code](http://ruby-doc.org/core-2.3.0/Module.html#method-i-deprecate_constant). (If you can think of a way to capture these, do it!)
+
+## How do I get my pull request green on CI?
+
+### There are _added_ deprecation warnings
+
+If the diff shows added deprecation warnings, you'll need to go back and change code until those messages don't happen. Under normal circumstances, we shouldn't increase the number of deprecation warnings.
+
+You can check if your test file has changed deprecation warnings by running this command:
+
+```bash
+DEPRECATION_TRACKER=compare bundle exec rspec spec/foo_spec.rb
+```
+
+In this case, an error will be raised if `spec/foo_spec.rb` triggers deprecation warnings that are different than we expect.
+
+> An example of when it would be OK to increase the number of deprecation warnings is during a Rails upgrade. We're not introducing code that adds deprecation warnings but rather change libraries so what used to be safe to call is now deprecated.
+
+### There are _removed_ deprecation warnings
+
+If the diff shows removed deprecation warnings, congratulations! Pat yourself on the back and then run this command:
+
+```ruby
+DEPRECATION_TRACKER=save bundle exec rspec <spec files mentioned in the error>
+```
+
+This will rerun the tests that reduces the number of deprecation warnings and save that to the log.
+
+Be sure to commit your changes, then push and wait for CI to go ✅.
+
+### The deprecation warnings are _different_
+
+If the diff shows added and removed lines, the deprecation messages we expected to see may have changed. Most deprecation warnings contain the file and line of app code that caused it. If the line number changes, the deprecation warning message will also change. In this case, you can follow the same steps as you would if you removed deprecation warnings to update the stale deprecation messages:
+
+```ruby
+DEPRECATION_TRACKER=save bundle exec rspec <spec files mentioned in the error>
+```
+
+This will update the deprecation warning shitlist. Be sure to commit your changes, then push and wait for CI to go ✅.
+
+## Where is the shitlist stored?
+
+```
+spec/support/deprecation_warnings.shitlist.json
+```
+
+## How does it work?
+
+While running tests, we keep track of what test file is being run and record each deprecation warning as it happens. After the test run is complete, we compare the deprecation messages we saw with the deprecation messages we expected to see and raise an error if the two differ.
+
+See `spec/support/deprecation_tracker.rb` for implementation details.

data/exe/bundle_report

@@ -0,0 +1,264 @@
+#!/usr/bin/env ruby
+#
+# Print a report on our Gemfile
+# Why not just use `bundle outdated`? It doesn't give us the information we care about (and it fails).
+#
+at_exit do
+  require "optparse"
+
+  options = {}
+  option_parser = OptionParser.new do |opts|
+    opts.banner = <<~EOS
+      Usage: #{$0} [report-type] [options]
+
+      report-type  There are two report types available: `outdated` and `compatibility`
+
+      Examples:
+        #{$0} compatibility --rails-version 5.0
+        #{$0} outdated
+    EOS
+
+    opts.separator ""
+    opts.separator "Options:"
+
+    opts.on("--rails-version [STRING]", "Rails version to check compatibility against (defaults to 5.0)") do |rails_version|
+      options[:rails_version] = rails_version
+    end
+
+    opts.on("--include-rails-gems", "Include Rails gems in compatibility report (defaults to false)") do
+      options[:include_rails_gems] = true
+    end
+
+    opts.on_tail("-h", "--help", "Show this message") do
+      puts opts
+      exit
+    end
+  end
+
+  begin
+    option_parser.parse!
+  rescue OptionParser::ParseError => e
+    STDERR.puts e.message.red
+    puts option_parser
+    exit 1
+  end
+
+  report_type = ARGV.first
+
+  case report_type
+  when "outdated" then BundleReport.outdated
+  else
+    BundleReport.compatibility(rails_version: options.fetch(:rails_version, "5.0"), include_rails_gems: options.fetch(:include_rails_gems, false))
+  end
+end
+
+# Needs to happen first
+require "bundler/setup"
+
+require "action_view"
+require "active_support/core_ext/object/acts_like"
+require "colorize"
+require "cgi"
+require "erb"
+require "json"
+require "rest-client"
+
+class BundleReport
+  def self.compatibility(rails_version:, include_rails_gems:)
+    incompatible_gems = BundleReport::GemInfo.all.reject do |gem|
+      gem.compatible_with_rails?(rails_version: rails_version) || (!include_rails_gems && gem.from_rails?)
+    end.sort_by do |gem|
+      [
+        gem.latest_version.compatible_with_rails?(rails_version: rails_version) ? 0 : 1,
+        gem.name
+      ].join("-")
+    end
+
+    incompatible_gems_by_state = incompatible_gems.group_by { |gem| gem.state(rails_version) }
+
+    template = <<~ERB
+      <% if incompatible_gems_by_state[:latest_compatible] -%>
+      <%= "=> Incompatible with Rails #{rails_version} (with new versions that are compatible):".white.bold %>
+      <%= "These gems will need to be upgraded before upgrading to Rails #{rails_version}.".italic %>
+
+      <% incompatible_gems_by_state[:latest_compatible].each do |gem| -%>
+      <%= gem_header(gem) %> - upgrade to <%= gem.latest_version.version %>
+      <% end -%>
+
+      <% end -%>
+      <% if incompatible_gems_by_state[:incompatible] -%>
+      <%= "=> Incompatible with Rails #{rails_version} (with no new compatible versions):".white.bold %>
+      <%= "These gems will need to be removed or replaced before upgrading to Rails #{rails_version}.".italic %>
+
+      <% incompatible_gems_by_state[:incompatible].each do |gem| -%>
+      <%= gem_header(gem) %> - new version, <%= gem.latest_version.version %>, is not compatible with Rails #{rails_version}
+      <% end -%>
+
+      <% end -%>
+      <% if incompatible_gems_by_state[:no_new_version] -%>
+      <%= "=> Incompatible with Rails #{rails_version} (with no new versions):".white.bold %>
+      <%= "These gems will need to be upgraded by us or removed before upgrading to Rails #{rails_version}.".italic %>
+      <%= "This list is likely to contain internal gems, like Cuddlefish.".italic %>
+
+      <% incompatible_gems_by_state[:no_new_version].each do |gem| -%>
+      <%= gem_header(gem) %> - new version not found
+      <% end -%>
+
+      <% end -%>
+      <%= incompatible_gems.length.to_s.red %> gems incompatible with Rails <%= rails_version %>
+    ERB
+
+    puts ERB.new(template, nil, "-").result(binding)
+  end
+
+  def self.gem_header(_gem)
+    header = "#{_gem.name} #{_gem.version}".bold
+    header << " (loaded from git)".magenta if _gem.sourced_from_git?
+    header
+  end
+
+  def self.outdated
+    gems = BundleReport::GemInfo.all
+    out_of_date_gems = gems.reject(&:up_to_date?).sort_by(&:created_at)
+    percentage_out_of_date = ((out_of_date_gems.count / gems.count.to_f) * 100).round
+    sourced_from_git = gems.select(&:sourced_from_git?)
+
+    out_of_date_gems.each do |_gem|
+      header = "#{_gem.name} #{_gem.version}"
+
+      puts <<~MESSAGE
+        #{header.bold.white}: released #{_gem.age} (latest version, #{_gem.latest_version.version}, released #{_gem.latest_version.age})
+      MESSAGE
+    end
+
+    puts ""
+    puts <<~MESSAGE
+      #{"#{sourced_from_git.count}".yellow} gems are sourced from git
+      #{"#{out_of_date_gems.length}".red} of the #{gems.count} gems are out-of-date (#{percentage_out_of_date}%)
+    MESSAGE
+  end
+
+  class GemInfo
+    include ActionView::Helpers::DateHelper
+
+    class NullGemInfo < GemInfo
+      def initialize; end
+
+      def age
+        "-"
+      end
+
+      def time_to_latest_version
+        "-"
+      end
+
+      def created_at
+        Time.now
+      end
+
+      def up_to_date?
+        false
+      end
+
+      def version
+        "NOT FOUND"
+      end
+
+      def unsatisfied_rails_dependencies(*)
+        ["unknown"]
+      end
+
+      def state(_)
+        :null
+      end
+    end
+
+    def self.all
+      Gem::Specification.each.map do |gem_specification|
+        new(gem_specification)
+      end
+    end
+
+    attr_reader :gem_specification, :version, :name
+    def initialize(gem_specification)
+      @gem_specification = gem_specification
+      @version = gem_specification.version
+      @name = gem_specification.name
+    end
+
+    def age
+      "#{time_ago_in_words(created_at)} ago"
+    end
+
+    def sourced_from_git?
+      !!gem_specification.git_version
+    end
+
+    def time_to_latest_version
+      distance_of_time_in_words(created_at, latest_version.created_at)
+    end
+
+    def created_at
+      @created_at ||= gem_specification.date
+    end
+
+    def up_to_date?
+      version == latest_version.version
+    end
+
+    def state(rails_version)
+      if compatible_with_rails?(rails_version: rails_version)
+        :compatible
+      elsif latest_version.compatible_with_rails?(rails_version: rails_version)
+        :latest_compatible
+      elsif latest_version.version == "NOT FOUND"
+        :no_new_version
+      else
+        :incompatible
+      end
+    end
+
+    def latest_version
+      @latest_version ||= begin
+        latest_gem_specification = Gem.latest_spec_for(name)
+        if latest_gem_specification
+          GemInfo.new(latest_gem_specification)
+        else
+          NullGemInfo.new
+        end
+      end
+    end
+
+    def compatible_with_rails?(rails_version: Gem::Version.new("5.0"))
+      unsatisfied_rails_dependencies(rails_version: rails_version).empty?
+    end
+
+    def unsatisfied_rails_dependencies(rails_version:)
+      rails_dependencies = gem_specification.runtime_dependencies.select {|dependency| rails_gems.include?(dependency.name) }
+
+      rails_dependencies.reject do |rails_dependency|
+        rails_dependency.requirement.satisfied_by?(Gem::Version.new(rails_version))
+      end
+    end
+
+    def from_rails?
+      rails_gems.include?(name)
+    end
+
+    private def rails_gems
+      [
+        "rails",
+        "activemodel",
+        "activerecord",
+        "actionmailer",
+        "actioncable",
+        "actionpack",
+        "actionview",
+        "activejob",
+        "activestorage",
+        "activesupport",
+        "railties",
+      ]
+    end
+  end
+end

data/exe/deprecations

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby
+require "json"
+require "colorize"
+require "optparse"
+require "set"
+
+def run_tests(deprecation_warnings, tracker_mode:, next_mode:)
+  rspec_command = if next_mode
+    "bin/next rspec"
+  else
+    "bundle exec rspec"
+  end
+
+  command = "DEPRECATION_TRACKER=#{tracker_mode} #{rspec_command} #{deprecation_warnings.keys.join(" ")}"
+  puts command
+  exec command
+end
+
+def print_info(deprecation_warnings, verbose: false)
+  frequency_by_message = deprecation_warnings.each_with_object({}) do |(test_file, messages), hash|
+    messages.each do |message|
+      hash[message] ||= { test_files: Set.new, occurrences: 0 }
+      hash[message][:test_files] << test_file
+      hash[message][:occurrences] += 1
+    end
+  end.sort_by {|message, data| data[:occurrences] }.reverse.to_h
+
+  puts "Ten most common deprecation warnings:".underline
+  frequency_by_message.take(10).each do |message, data|
+    puts "Occurrences: #{data.fetch(:occurrences)}".bold
+    puts "Test files: #{data.fetch(:test_files).to_a.join(" ")}" if verbose
+    puts message.red
+    puts "----------"
+  end
+end
+
+options = {}
+option_parser = OptionParser.new do |opts|
+  opts.banner = <<~MESSAGE
+    Usage: #{__FILE__.to_s} [options] [mode]
+
+      Parses the deprecation warning shitlist and show info or run tests.
+
+    Examples:
+      bin/deprecations info # Show top ten deprecations
+      bin/deprecations --next info # Show top ten deprecations for Rails 5
+      bin/deprecations --pattern "ActiveRecord::Base" --verbose info # Show full details on deprecations matching pattern
+      bin/deprecations --tracker-mode save --pattern "pass" run # Run tests that output deprecations matching pattern and update shitlist
+
+    Modes:
+      info
+        Show information on the ten most frequent deprceation warnings.
+
+      run
+        Run tests that are known to cause deprecation warnings. Use --pattern to filter what tests are run.
+
+    Options:
+  MESSAGE
+
+  opts.on("--next", "Run against the next shitlist") do |next_mode|
+    options[:next] = next_mode
+  end
+
+  opts.on("--tracker-mode MODE", "Set DEPRECATION_TRACKER in test mode. Options: save or compare") do |tracker_mode|
+    options[:tracker_mode] = tracker_mode
+  end
+
+  opts.on("--pattern RUBY_REGEX", "Filter deprecation warnings with a pattern.") do |pattern|
+    options[:pattern] = pattern
+  end
+
+  opts.on("--verbose", "show more information") do
+    options[:verbose] = true
+  end
+
+  opts.on_tail("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end
+
+option_parser.parse!
+
+options[:mode] = ARGV.last
+path = options[:next] ? "spec/support/deprecation_warning.next.shitlist.json" : "spec/support/deprecation_warning.shitlist.json"
+
+pattern_string = options.fetch(:pattern, ".+")
+pattern = /#{pattern_string}/
+
+deprecation_warnings = JSON.parse(File.read(path)).each_with_object({}) do |(test_file, messages), hash|
+  filtered_messages = messages.select {|message| message.match(pattern) }
+  hash[test_file] = filtered_messages if !filtered_messages.empty?
+end
+
+if deprecation_warnings.empty?
+  abort "No test files with deprecations matching #{pattern.inspect}."
+  exit 2
+end
+
+case options.fetch(:mode, "info")
+when "run" then run_tests(deprecation_warnings, next_mode: options[:next], tracker_mode: options[:tracker_mode])
+when "info" then print_info(deprecation_warnings, verbose: options[:verbose])
+when nil
+  STDERR.puts "Must pass a mode: run or info".red
+  puts option_parser
+  exit 1
+else
+  STDERR.puts "Unknown mode: #{options[:mode]}".red
+  exit 1
+end

data/exe/gem-next-diff

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+#
+# Output a markdown table containing the version differences between the Gemfile and Gemfile.next.
+# This can be used as a TODO list to bring the two Gemfiles as close to parity as possible,
+# either by upgrading gems within `Gemfile` or downgrading gems within `Gemfile.next`.
+#
+
+def parse_gem_versions(&block)
+  bundler_output = block.call
+  bundler_output.split("\n").each_with_object({}) do |line, hash|
+    next unless line.start_with?("Using")
+
+    gem_name, version = line.split(/\s+/)[1..2]
+    hash[gem_name] = version
+  end
+end
+
+rails_gems = [
+  "rails",
+  "activemodel",
+  "activerecord",
+  "actionmailer",
+  "actioncable",
+  "actionpack",
+  "actionview",
+  "activejob",
+  "activestorage",
+  "activesupport",
+  "railties",
+]
+
+gems = parse_gem_versions { `BUNDLE_CACHE_PATH=vendor/cache BUNDLE_GEMFILE=Gemfile bundle install` }
+gems_next = parse_gem_versions { `BUNDLE_CACHE_PATH=vendor/cache.next BUNDLE_GEMFILE=Gemfile.next bundle install` }
+all_gem_names = (gems.keys + gems_next.keys).uniq.sort
+
+puts "| Gem | `Gemfile` version | `Gemfile.next` version | Rails internals |"
+puts "|-----|-------------------|------------------------|-----------------| "
+all_gem_names.each do |gem_name|
+  gem_version = gems[gem_name] || "-"
+  gem_next_version = gems_next[gem_name] || "-"
+  rails_internal = rails_gems.include?(gem_name) ? "✅" : ""
+
+  if gem_version != gem_next_version
+    puts "| **#{gem_name}** | #{gem_version} | #{gem_next_version} | #{rails_internal} |"
+  end
+end

data/exe/next

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# Ruby wrapper around next.sh so it works with Rubygems
+exe_dir = File.expand_path(File.dirname(__FILE__))
+exec(File.join(exe_dir, 'next.sh'), *ARGV)

data/exe/next.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+if [[ "${@}" == "--init" ]]; then
+  echo "doing a thing"
+  # Add next? top of Gemfile
+  cat <<-STRING > Gemfile.tmp
+def next?
+  File.basename(__FILE__) == "Gemfile.next"
+end
+STRING
+  cat Gemfile >> Gemfile.tmp
+  mv Gemfile.tmp Gemfile
+
+  ln -s Gemfile Gemfile.next
+  exit $?
+fi
+
+if [[ "${@}" =~ ^bundle ]]; then
+  BUNDLE_GEMFILE=Gemfile.next BUNDLE_CACHE_PATH=vendor/cache.next $@
+else
+  BUNDLE_GEMFILE=Gemfile.next BUNDLE_CACHE_PATH=vendor/cache.next bundle exec $@
+fi
+
+COMMAND_EXIT=$?
+
+GEM_NOT_FOUND=7 # https://github.com/bundler/bundler/blob/master/lib/bundler/errors.rb#L35
+EXECUTABLE_NOT_FOUND=127 # https://github.com/bundler/bundler/blob/master/lib/bundler/cli/exec.rb#L62
+if [[ $COMMAND_EXIT -eq $GEM_NOT_FOUND || $COMMAND_EXIT -eq $EXECUTABLE_NOT_FOUND ]]; then
+  BLUE='\033[0;34m'
+  UNDERLINE_WHITE='\033[37m'
+  NO_COLOR='\033[0m'
+
+  echo -e "${BLUE}Having trouble running commands with ${UNDERLINE_WHITE}bin/next${BLUE}?"
+  echo -e "Try running ${UNDERLINE_WHITE}bin/next bundle install${BLUE}, then try your command again.${NO_COLOR}"
+fi
+
+exit $COMMAND_EXIT

data/lib/deprecation_tracker.rb

@@ -0,0 +1,147 @@
+require "json"
+
+# A shitlist for deprecation warnings during test runs. It has two modes: "save" and "compare"
+#
+# DEPRECATION_TRACKER=save
+# Record deprecation warnings, grouped by spec file. After the test run, save to a file.
+#
+# DEPRECATION_TRACKER=compare
+# Tracks deprecation warnings, grouped by spec file. After the test run, compare against shitlist of expected
+# deprecation warnings. If anything is added or removed, raise an error with a diff of the changes.
+#
+class DeprecationTracker
+  UnexpectedDeprecations = Class.new(StandardError)
+
+  module KernelWarnTracker
+    def self.callbacks
+      @callbacks ||= []
+    end
+
+    def warn(*messages)
+      KernelWarnTracker.callbacks.each do |callback|
+        messages.each { |message| callback.(message) }
+      end
+
+      super
+    end
+  end
+
+  # There are two forms of the `warn` method: one for class Kernel and one for instances of Kernel (i.e., every Object)
+  Object.prepend(KernelWarnTracker)
+  Kernel.singleton_class.prepend(KernelWarnTracker)
+
+  def self.track_rspec(rspec_config, shitlist_path:, mode:, transform_message: nil)
+    deprecation_tracker = DeprecationTracker.new(shitlist_path, transform_message)
+    ActiveSupport::Deprecation.behavior << -> (message, _callstack) { deprecation_tracker.add(message) }
+    KernelWarnTracker.callbacks << -> (message) { deprecation_tracker.add(message) }
+
+    rspec_config.around do |example|
+      deprecation_tracker.bucket = example.metadata.fetch(:rerun_file_path)
+
+      begin
+        example.run
+      ensure
+        deprecation_tracker.bucket = nil
+      end
+    end
+
+    rspec_config.after(:suite) do
+      if mode == "save"
+        deprecation_tracker.save
+      elsif mode == "compare"
+        deprecation_tracker.compare
+      end
+    end
+  end
+
+  attr_reader :deprecation_messages, :shitlist_path, :transform_message
+  attr_reader :bucket
+
+  def initialize(shitlist_path, transform_message = nil)
+    @shitlist_path = shitlist_path
+    @transform_message = transform_message || -> (message) { message }
+    @deprecation_messages = {}
+  end
+
+  def add(message)
+    return if bucket.nil?
+
+    @deprecation_messages[bucket] << transform_message.(message)
+  end
+
+  def bucket=(value)
+    @bucket = value
+    @deprecation_messages[value] ||= [] unless value.nil?
+  end
+
+  def compare
+    shitlist = read_shitlist
+
+    changed_buckets = []
+    normalized_deprecation_messages.each do |bucket, messages|
+      if shitlist[bucket] != messages
+        changed_buckets << bucket
+      end
+    end
+
+    if changed_buckets.length > 0
+      message = <<~MESSAGE.red
+        ⚠️  Deprecation warnings have changed!
+
+        Code called by the following spec files is now generating different deprecation warnings:
+
+        #{changed_buckets.join("\n")}
+
+        To check your failures locally, you can run:
+
+        DEPRECATION_TRACKER=compare bundle exec rspec #{changed_buckets.join(" ")}
+
+        Here is a diff between what is expected and what was generated by this process:
+
+        #{diff}
+
+        See \e[4;37mdev-docs/testing/deprecation_tracker.md\e[0;31m for more information.
+      MESSAGE
+
+      raise UnexpectedDeprecations, message
+    end
+  end
+
+  def diff
+    new_shitlist = create_temp_shitlist
+    `git diff --no-index #{shitlist_path} #{new_shitlist.path}`
+  ensure
+    new_shitlist.delete
+  end
+
+  def save
+    new_shitlist = create_temp_shitlist
+    FileUtils.cp(new_shitlist.path, shitlist_path)
+  ensure
+    new_shitlist&.delete
+  end
+
+  def create_temp_shitlist
+    temp_file = Tempfile.new("temp-deprecation-tracker-shitlist")
+    temp_file.write(JSON.pretty_generate(normalized_deprecation_messages))
+    temp_file.flush
+
+    temp_file
+  end
+
+  # Normalize deprecation messages to reduce noise from file output and test files to be tracked with separate test runs
+  def normalized_deprecation_messages
+    normalized = read_shitlist.merge(deprecation_messages).each_with_object({}) do |(bucket, messages), hash|
+      hash[bucket] = messages.sort
+    end
+
+    normalized.reject {|_key, value| value.empty? }.sort_by {|key, _value| key }.to_h
+  end
+
+  def read_shitlist
+    return {} unless File.exist?(shitlist_path)
+    JSON.parse(File.read(shitlist_path))
+  rescue JSON::ParserError => e
+    raise "#{shitlist_path} is not valid JSON: #{e.message}"
+  end
+end

data/lib/ten_years_rails.rb

@@ -0,0 +1,6 @@
+require "ten_years_rails/version"
+require "deprecation_tracker"
+
+module TenYearsRails
+  # Your code goes here...
+end

data/lib/ten_years_rails/version.rb

@@ -0,0 +1,3 @@
+module TenYearsRails
+  VERSION = "0.2.0"
+end

data/ten_years_rails.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ten_years_rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ten_years_rails"
+  spec.version       = TenYearsRails::VERSION
+  spec.authors       = ["Jordan Raine"]
+  spec.email         = ["jnraine@gmail.com"]
+
+  spec.summary       = %q{Companion code to Ten Years of Rails Upgrades}
+  spec.homepage      = "https://github.com/clio/ten_years_rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "actionview"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "colorize", ">= 0.8.1"
+  spec.add_dependency "rest-client", ">= 2.0.2"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: ten_years_rails
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Jordan Raine
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- jnraine@gmail.com
+executables:
+- bundle_report
+- deprecations
+- gem-next-diff
+- next
+- next.sh
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- deprecation_tracker.md
+- exe/bundle_report
+- exe/deprecations
+- exe/gem-next-diff
+- exe/next
+- exe/next.sh
+- lib/deprecation_tracker.rb
+- lib/ten_years_rails.rb
+- lib/ten_years_rails/version.rb
+- ten_years_rails.gemspec
+homepage: https://github.com/clio/ten_years_rails
+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.14
+signing_key: 
+specification_version: 4
+summary: Companion code to Ten Years of Rails Upgrades
+test_files: []