deprecation_toolkit 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4a142310e36ffb312bd50a257a82260477fc8940
-  data.tar.gz: ca2b082fddc00a195c72e081eac71512d358b7dd
+SHA256:
+  metadata.gz: 14622e99341958cb8876efa74036f9f90eb27c77f10e24e59b3261c62d5c8b31
+  data.tar.gz: ea63088375c2c5c1010b267f38bf1b8acbc0e363bdd3cf33d4c6d762e47704bb
 SHA512:
-  metadata.gz: '038a0936b7029bd2b73b557fa0a43ce6d4b22dfdb92bb98ca9d1c06dd5084528f74809244944b717dbcc41cecde1cba3b358b707fece9a6d62fa3e88b9a96c57'
-  data.tar.gz: e2af9e16220b684ca29b79426918aed40c7cdb79ca90f85a72f0a9f7185dab4c21bb15d9cd279c322ccf78ad64f72d2e16462a6fa5abcc0d02e1c5b263781684
+  metadata.gz: bf5adecd962fd27a18c223c5852552b52a601230827cd761488ae7d62a8a745f013a62fc57d6ffba2b67c989e9c6cfb9436f76046d5b3159e5ac48d9aeb9f191
+  data.tar.gz: e51874283d799826c161c52ce091597c60b1583521d8e63b57341c61064241710611dd41aa7d4adbd7db2ef17a26e5ac0c5adb41920f1b04ca8fd86a9add4153

data/CHANGELOG.md

@@ -1,19 +1,30 @@
 # Change log
 
 ## master (unreleased)
+
+## 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.
+
+### 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.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    deprecation_toolkit (1.1.0)
+    deprecation_toolkit (1.2.0)
       activesupport (>= 4.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.1)
+    activesupport (5.2.1.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)

data/deprecation_toolkit.gemspec

@@ -14,6 +14,10 @@ Gem::Specification.new do |spec|
   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.required_ruby_version = '>= 2.3'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|

data/lib/deprecation_toolkit/behaviors/raise.rb

@@ -4,10 +4,12 @@ module DeprecationToolkit
   module Behaviors
     class Raise
       def self.trigger(_test, current_deprecations, recorded_deprecations)
-        error_class = if current_deprecations > recorded_deprecations
+        error_class = if current_deprecations.size > recorded_deprecations.size
           DeprecationIntroduced
-        else
+        elsif current_deprecations.size < recorded_deprecations.size
           DeprecationRemoved
+        else
+          DeprecationMismatch
         end
 
         raise error_class.new(current_deprecations, recorded_deprecations)
@@ -46,5 +48,23 @@ module DeprecationToolkit
         super(message)
       end
     end
+
+    class DeprecationMismatch < DeprecationException
+      def initialize(current_deprecations, recorded_deprecations)
+        message = <<~EOM
+          The recorded deprecations for this test doesn't match the one that got triggered.
+          Fix or record the new deprecations to discard this error.
+
+          You can re-record deprecations by adding the `--record-deprecations` flag when running your tests.
+
+          ===== Expected
+          #{recorded_deprecations.deprecations.join("\n")}
+          ===== Actual
+          #{current_deprecations.deprecations.join("\n")}
+        EOM
+
+        super(message)
+      end
+    end
   end
 end

data/lib/deprecation_toolkit/collector.rb

@@ -9,6 +9,7 @@ module DeprecationToolkit
 
     class_attribute :deprecations
     self.deprecations = []
+    delegate :size, to: :deprecations
 
     class << self
       def collect(message)

data/lib/deprecation_toolkit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeprecationToolkit
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deprecation_toolkit
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-13 00:00:00.000000000 Z
+date: 2018-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -105,7 +105,10 @@ files:
 homepage: https://github.com/shopify/deprecation_toolkit
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/shopify/deprecation_toolkit
+  source_code_uri: https://github.com/shopify/deprecation_toolkit
+  changelog_uri: https://github.com/Shopify/deprecation_toolkit/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -122,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Deprecation Toolkit around ActiveSupport::Deprecation