Deprecate three methods for version 2.0 (#1446)

lostisland · Aug 22, 2022 · 2b1f331 · 2b1f331
1 parent 71dcb9c
commit 2b1f331
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 17 deletions.
diff --git a/lib/faraday/connection.rb b/lib/faraday/connection.rb
@@ -319,14 +319,14 @@ def basic_auth(login, pass)
     #
     # @return [void]
     def token_auth(token, options = nil)
-      warn <<~TEXT
-        WARNING: `Faraday::Connection#token_auth` is deprecated; it will be removed in version 2.0.
-        While initializing your connection, use `#request(:token_auth, ...)` instead.
-        See https://lostisland.github.io/faraday/middleware/authentication for more usage info.
-      TEXT
       set_authorization_header(:token_auth, token, options)
     end
 
+    deprecate :token_auth,
+              '#request(:token_auth, ...)',
+              '2.0',
+              'See https://lostisland.github.io/faraday/middleware/authentication for more usage info.'
+
     # Sets up a custom Authorization header.
     #
     # @param type [String] authorization type
@@ -346,14 +346,14 @@ def token_auth(token, options = nil)
     #
     # @return [void]
     def authorization(type, token)
-      warn <<~TEXT
-        WARNING: `Faraday::Connection#authorization` is deprecated; it will be removed in version 2.0.
-        While initializing your connection, use `#request(:authorization, ...)` instead.
-        See https://lostisland.github.io/faraday/middleware/authentication for more usage info.
-      TEXT
       set_authorization_header(:authorization, type, token)
     end
 
+    deprecate :authorization,
+              '#request(:authorization, ...)',
+              '2.0',
+              'See https://lostisland.github.io/faraday/middleware/authentication for more usage info.'
+
     # Check if the adapter is parallel-capable.
     #
     # @yield if the adapter isn't parallel-capable, or if no adapter is set yet.

diff --git a/lib/faraday/deprecate.rb b/lib/faraday/deprecate.rb
@@ -78,7 +78,7 @@ def skip_during
     # @param repl [#to_s, :none] the replacement to use, when `:none` it will
     #   alert the user that no replacement is present.
     # @param ver [String] the semver the method will be removed.
-    def deprecate(name, repl, ver)
+    def deprecate(name, repl, ver, custom_message = nil)
       class_eval do
         gem_ver = Gem::Version.new(ver)
         old = "_deprecated_#{name}"
@@ -95,7 +95,8 @@ def deprecate(name, repl, ver)
           msg = [
             "NOTE: #{target_message} is deprecated",
             repl == :none ? ' with no replacement' : "; use #{repl} instead. ",
-            "It will be removed in or after version #{gem_ver}",
+            "It will be removed in or after version #{gem_ver} ",
+            custom_message,
             "\n#{target}#{name} called from #{Gem.location_of_caller.join(':')}"
           ]
           warn "#{msg.join}." unless Faraday::Deprecate.skip

diff --git a/lib/faraday/request.rb b/lib/faraday/request.rb
@@ -58,13 +58,12 @@ def self.create(request_method)
     end
 
     def method
-      warn <<~TEXT
-        WARNING: `Faraday::Request##{__method__}` is deprecated; use `#http_method` instead. It will be removed in or after version 2.0.
-        `Faraday::Request##{__method__}` called from #{caller_locations(1..1).first}
-      TEXT
       http_method
     end
 
+    extend Faraday::Deprecate
+    deprecate :method, :http_method, '2.0'
+
     # Replace params, preserving the existing hash type.
     #
     # @param hash [Hash] new params

diff --git a/spec/faraday/request_spec.rb b/spec/faraday/request_spec.rb
@@ -25,7 +25,7 @@
   describe 'deprecate method for HTTP method' do
     let(:http_method) { :post }
     let(:expected_warning) do
-      %r{WARNING: `Faraday::Request#method` is deprecated; use `#http_method` instead. It will be removed in or after version 2.0.\n`Faraday::Request#method` called from .+/spec/faraday/request_spec.rb:\d+.}
+      %r{NOTE: Faraday::Request#method is deprecated; use http_method instead\. It will be removed in or after version 2.0 \nFaraday::Request#method called from .+/spec/faraday/request_spec.rb:\d+.}
     end
 
     it { expect(subject.method).to eq(:post) }