deprecation_toolkit 1.5.1 → 2.2.3

data/.rubocop.yml

@@ -1,12 +0,0 @@
-inherit_from:
-  - https://shopify.github.io/ruby-style-guide/rubocop.yml
-
-AllCops:
-  TargetRubyVersion: 2.5
-  Exclude:
-    - gemfiles/vendor/**/*
-
-Style/MethodCallWithArgsParentheses:
-  Exclude:
-    - Gemfile
-    - gemfiles/*

data/.travis.yml

@@ -1,18 +0,0 @@
-sudo: false
-cache: bundler
-language: ruby
-before_install:
-  - gem update bundler
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
-gemfile:
-  - gemfiles/activesupport_5.2.gemfile
-  - gemfiles/activesupport_6.0.gemfile
-script:
-  - bundle exec rubocop --config .rubocop.yml
-  - bundle exec rake test
-  - bundle exec rspec
-notifications:
-  email: false

data/CHANGELOG.md

@@ -1,42 +0,0 @@
-# Change log
-
-## master (unreleased)
-
-## 1.4.0 (2019-04-29)
-* [#37](https://github.com/Shopify/deprecation_toolkit/pull/37): Add Rspec support. (@andrewmarkle)
-
-## 1.3.0 (2019-02-28)
-* [#38](https://github.com/Shopify/deprecation_toolkit/pull/38): Add a way to mark test as flaky. (@Edouard-chin)
-* [#39](https://github.com/Shopify/deprecation_toolkit/pull/39): Introduced a way to help recording massive amount of deprecations. (@Edouard-chin)
-
-## 1.2.1 (2019-01-09)
-
-### Bug fixes
-* [#34](https://github.com/Shopify/deprecation_toolkit/pull/34): Fixes SystemStackError with RubyGems v3 and Ruby 2.5+. (@dylanahsmith)
-
-## 1.2.0 (2018-11-28)
-
-### New features
-
-* [#30](https://github.com/Shopify/deprecation_toolkit/pull/30): Introduce a `DeprecationMismatch` error class. (@Edouard-chin)
-### Bug fixes
-* [#29](https://github.com/Shopify/deprecation_toolkit/pull/29): Fix issue where the error class triggered was incorrect in some circumstances. (@Edouard-chin)
-
-## 1.1.0 (2018-11-13)
-
-### New features
-
-* [#28](https://github.com/Shopify/deprecation_toolkit/pull/28): `Configuration.allowed_deprecations` now accepts Procs.
-  This is useful if you need to whitelist deprecations based on the caller.
-
-## 1.0.3 (2018-10-25)
-
-### Bug fixes
-
-* [#22](https://github.com/Shopify/deprecation_toolkit/pull/22): Fixes `Kernel.warn` not triggering deprecation. (@rmacklin)
-
-## 1.0.2 (2018-10-01)
-
-### New features
-
-* [#15](https://github.com/Shopify/deprecation_toolkit/pull/15): Add support for ActiveSupport 4.2. (@andrewmarkle)

data/Gemfile

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec
-
-group :deployment do
-  gem 'rake'
-  gem 'rubocop'
-end

data/Gemfile.lock

@@ -1,69 +0,0 @@
-PATH
-  remote: .
-  specs:
-    deprecation_toolkit (1.5.1)
-      activesupport (>= 4.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (6.0.2.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
-    ast (2.4.0)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
-    i18n (1.8.2)
-      concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    minitest (5.11.3)
-    parallel (1.19.1)
-    parser (2.7.1.1)
-      ast (~> 2.4.0)
-    rainbow (3.0.0)
-    rake (12.3.2)
-    rexml (3.2.4)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.82.0)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.7.0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      rexml
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    ruby-progressbar (1.10.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    zeitwerk (2.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (>= 1.16)
-  deprecation_toolkit!
-  minitest (~> 5.0)
-  rake
-  rspec (~> 3.0)
-  rubocop
-
-BUNDLED WITH
-   1.17.3

data/Rakefile

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.warning = true
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-task(default: :test)

data/deprecation_toolkit.gemspec

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "deprecation_toolkit/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "deprecation_toolkit"
-  spec.version = DeprecationToolkit::VERSION
-  spec.authors = %w(Shopify)
-  spec.email = ["rails@shopify.com"]
-
-  spec.summary = "Deprecation Toolkit around ActiveSupport::Deprecation"
-  spec.homepage = "https://github.com/shopify/deprecation_toolkit"
-  spec.license = "MIT"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/shopify/deprecation_toolkit"
-  spec.metadata["changelog_uri"] = "https://github.com/Shopify/deprecation_toolkit/blob/master/CHANGELOG.md"
-
-  spec.metadata['allowed_push_host'] = "https://rubygems.org"
-
-  spec.required_ruby_version = '>= 2.5'
-
-  spec.files = %x(git ls-files -z).split("\x0").reject do |f|
-    f.match(%r{^(test)/})
-  end
-  spec.require_paths = %w(lib)
-
-  spec.add_runtime_dependency('activesupport', '>= 4.2')
-
-  spec.add_development_dependency("bundler", ">= 1.16")
-  spec.add_development_dependency("rake", "~> 10.0")
-  spec.add_development_dependency("minitest", "~> 5.0")
-  spec.add_development_dependency("rspec", "~> 3.0")
-end

data/gemfiles/activesupport_5.2.gemfile

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-source "https://rubygems.org"
-
-gem "activesupport", "~> 5.2"
-
-group :deployment do
-  gem "rake"
-  gem "rubocop"
-end
-
-gemspec path: "../"

data/gemfiles/activesupport_6.0.gemfile

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-source "https://rubygems.org"
-
-gem "activesupport", "~> 6.0"
-
-group :deployment do
-  gem "rake"
-  gem "rubocop"
-end
-
-gemspec path: "../"

data/gemfiles/spec/deprecations/deprecation_toolkit/behaviors/raise.yml

@@ -1,12 +0,0 @@
----
-test_deprecation_toolkit/behaviors/raise_.trigger_raises_a_deprecation_removed_error_when_deprecations_are_removed:
-- 'DEPRECATION WARNING: Foo'
-- 'DEPRECATION WARNING: Bar'
-test_deprecation_toolkit/behaviors/raise_.trigger_raises_a_deprecation_removed_when_mismatched_and_less_than_expected:
-- 'DEPRECATION WARNING: A'
-- 'DEPRECATION WARNING: B'
-test_deprecation_toolkit/behaviors/raise_.trigger_raises_a_deprecation_mismatch_when_same_number_of_deprecations_are_triggered_with_mismatches:
-- 'DEPRECATION WARNING: C'
-test_deprecation_toolkit/behaviors/raise_.trigger_does_not_raise_when_deprecations_are_triggered_but_were_already_recorded:
-- 'DEPRECATION WARNING: Foo'
-- 'DEPRECATION WARNING: Bar'

data/gemfiles/test/deprecations

@@ -1 +0,0 @@
-../../test/deprecations

data/shipit.rubygems.yml

@@ -1 +0,0 @@
-# using the default shipit config

data/spec/deprecation_toolkit/behaviors/disabled_spec.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-RSpec.describe(DeprecationToolkit::Behaviors::Raise) do
-  before do
-    @previous_configuration = DeprecationToolkit::Configuration.behavior
-    DeprecationToolkit::Configuration.behavior = DeprecationToolkit::Behaviors::Disabled
-  end
-
-  after do
-    DeprecationToolkit::Configuration.behavior = @previous_configuration
-  end
-
-  it '.trigger noop any deprecations' do |example|
-    expect do
-      ActiveSupport::Deprecation.warn("Foo")
-      ActiveSupport::Deprecation.warn("Bar")
-
-      DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
-    end.not_to(raise_error)
-  end
-end

data/spec/deprecation_toolkit/behaviors/raise_spec.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-RSpec.describe(DeprecationToolkit::Behaviors::Raise) do
-  before do
-    @previous_configuration = DeprecationToolkit::Configuration.behavior
-    DeprecationToolkit::Configuration.behavior = DeprecationToolkit::Behaviors::Raise
-  end
-
-  after do
-    DeprecationToolkit::Configuration.behavior = @previous_configuration
-  end
-
-  it ".trigger raises an DeprecationIntroduced error when deprecations are introduced" do |example|
-    expect do
-      ActiveSupport::Deprecation.warn("Foo")
-      ActiveSupport::Deprecation.warn("Bar")
-
-      DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
-    end.to(raise_error(DeprecationToolkit::Behaviors::DeprecationIntroduced))
-  end
-
-  it ".trigger raises a DeprecationRemoved error when deprecations are removed" do |example|
-    expect do
-      ActiveSupport::Deprecation.warn("Foo")
-
-      DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
-    end.to(raise_error(DeprecationToolkit::Behaviors::DeprecationRemoved))
-  end
-
-  it '.trigger raises a DeprecationRemoved when mismatched and less than expected' do |example|
-    expect do
-      ActiveSupport::Deprecation.warn("C")
-
-      DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
-    end.to(raise_error(DeprecationToolkit::Behaviors::DeprecationRemoved))
-  end
-
-  it '.trigger raises a DeprecationMismatch when same number of deprecations are triggered with mismatches' do |example|
-    expect do
-      ActiveSupport::Deprecation.warn("A")
-
-      DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
-    end.to(raise_error(DeprecationToolkit::Behaviors::DeprecationMismatch))
-  end
-
-  it ".trigger does not raise when deprecations are triggered but were already recorded" do |example|
-    expect do
-      ActiveSupport::Deprecation.warn("Foo")
-      ActiveSupport::Deprecation.warn("Bar")
-
-      DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
-    end.not_to(raise_error)
-  end
-
-  it ".trigger does not raise when deprecations are allowed with Regex" do |example|
-    @old_allowed_deprecations = DeprecationToolkit::Configuration.allowed_deprecations
-    DeprecationToolkit::Configuration.allowed_deprecations = [/John Doe/]
-
-    begin
-      ActiveSupport::Deprecation.warn("John Doe")
-      expect do
-        DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
-      end.not_to(raise_error)
-    ensure
-      DeprecationToolkit::Configuration.allowed_deprecations = @old_allowed_deprecations
-    end
-  end
-
-  it ".trigger does not raise when deprecations are allowed with Procs" do |example|
-    class_eval <<-RUBY, 'my_file.rb', 1337
-      def deprecation_caller
-        deprecation_callee
-      end
-
-      def deprecation_callee
-        ActiveSupport::Deprecation.warn("John Doe")
-      end
-    RUBY
-
-    old_allowed_deprecations = DeprecationToolkit::Configuration.allowed_deprecations
-    DeprecationToolkit::Configuration.allowed_deprecations = [
-      ->(_, stack) { stack.first.to_s =~ /my_file\.rb/ },
-    ]
-
-    begin
-      deprecation_caller
-      expect do
-        DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
-      end.not_to(raise_error)
-    ensure
-      DeprecationToolkit::Configuration.allowed_deprecations = old_allowed_deprecations
-    end
-  end
-end

data/spec/deprecation_toolkit/behaviors/record_spec.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-require "tmpdir"
-
-RSpec.describe(DeprecationToolkit::Behaviors::Record) do
-  before do
-    @previous_deprecation_path = DeprecationToolkit::Configuration.deprecation_path
-    @deprecation_path = Dir.mktmpdir
-    @previous_behavior = DeprecationToolkit::Configuration.behavior
-    DeprecationToolkit::Configuration.behavior = DeprecationToolkit::Behaviors::Record
-    DeprecationToolkit::Configuration.deprecation_path = @deprecation_path
-  end
-
-  after do
-    DeprecationToolkit::Configuration.behavior = @previous_behavior
-    DeprecationToolkit::Configuration.deprecation_path = @previous_deprecation_path
-    FileUtils.rm_rf(@deprecation_path)
-  end
-
-  it '.trigger should record deprecations' do |example|
-    expect_deprecations_recorded("Foo", "Bar", example) do
-      ActiveSupport::Deprecation.warn("Foo")
-      ActiveSupport::Deprecation.warn("Bar")
-
-      DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
-    end
-  end
-
-  it ".trigger re-record an existing deprecation file" do |example|
-    expect_deprecations_recorded("Foo", "Bar", example) do
-      ActiveSupport::Deprecation.warn("Foo")
-      ActiveSupport::Deprecation.warn("Bar")
-
-      DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
-    end
-
-    expect_deprecations_recorded("Foo", example) do
-      ActiveSupport::Deprecation.warn("Foo")
-
-      DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
-    end
-  end
-
-  it ".trigger removes the deprecation file when all deprecations were removed" do |example|
-    expect_deprecations_recorded("Foo", example) do
-      ActiveSupport::Deprecation.warn("Foo")
-
-      DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
-    end
-
-    expect do
-      expect_deprecations_recorded("Foo", example) do
-        DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
-      end
-    end.to(raise_error(Errno::ENOENT))
-  end
-
-  private
-
-  def expect_deprecations_recorded(*deprecation_triggered, example)
-    yield
-
-    recorded = YAML.load_file(
-      "#{@deprecation_path}/deprecation_toolkit/behaviors/record.yml"
-    ).fetch("test_" + example.full_description.underscore.squish.tr(" ", "_"))
-    triggered = deprecation_triggered.map { |msg| "DEPRECATION WARNING: #{msg}" }
-
-    expect(recorded).to(eq(triggered))
-  end
-end

data/spec/deprecations/deprecation_toolkit/behaviors/raise.yml

@@ -1,12 +0,0 @@
----
-test_deprecation_toolkit/behaviors/raise_.trigger_raises_a_deprecation_removed_error_when_deprecations_are_removed:
-- 'DEPRECATION WARNING: Foo'
-- 'DEPRECATION WARNING: Bar'
-test_deprecation_toolkit/behaviors/raise_.trigger_raises_a_deprecation_removed_when_mismatched_and_less_than_expected:
-- 'DEPRECATION WARNING: A'
-- 'DEPRECATION WARNING: B'
-test_deprecation_toolkit/behaviors/raise_.trigger_raises_a_deprecation_mismatch_when_same_number_of_deprecations_are_triggered_with_mismatches:
-- 'DEPRECATION WARNING: C'
-test_deprecation_toolkit/behaviors/raise_.trigger_does_not_raise_when_deprecations_are_triggered_but_were_already_recorded:
-- 'DEPRECATION WARNING: Foo'
-- 'DEPRECATION WARNING: Bar'

data/spec/rspec/plugin_env_options_spec.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-# This needs to be set before we require `spec_helper` to simulate setting an ENV when running a spec like:
-# `DEPRECATION_BEHAVIOR="record" bundle exec rspec path/to/spec.rb`
-ENV['DEPRECATION_BEHAVIOR'] = "record"
-
-require 'spec_helper'
-
-RSpec.describe("DeprecationToolkit::RSpecPlugin ENV options") do
-  it 'should set the behavior to `Record` when ENV variable is set' do
-    expect(DeprecationToolkit::Configuration.behavior).to(eq(DeprecationToolkit::Behaviors::Record))
-  end
-end

data/spec/rspec/plugin_spec.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-RSpec.describe(DeprecationToolkit::RSpecPlugin) do
-  it "should add `notify` behavior to the deprecations behavior list" do
-    behavior = ActiveSupport::Deprecation::DEFAULT_BEHAVIORS[:notify]
-
-    expect(ActiveSupport::Deprecation.behavior).to(include(behavior))
-  end
-
-  it "doesn't remove previous deprecation behaviors" do
-    behavior = ActiveSupport::Deprecation::DEFAULT_BEHAVIORS[:silence]
-    ActiveSupport::Deprecation.behavior = behavior
-
-    expect(ActiveSupport::Deprecation.behavior).to(include(behavior))
-  end
-end

data/spec/spec_helper.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-$LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
-require "deprecation_toolkit"
-require "deprecation_toolkit/rspec_plugin"
-require "active_support/all"
-
-DeprecationToolkit::Configuration.test_runner = :rspec
-DeprecationToolkit::Configuration.deprecation_path = "spec/deprecations"
-ActiveSupport::Deprecation.behavior = :silence
-
-RSpec.configure do |config|
-  # Disable RSpec exposing methods globally on `Module` and `main`
-  config.disable_monkey_patching!
-
-  config.expect_with(:rspec) do |c|
-    c.syntax = :expect
-  end
-end