New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create faraday deprecation class #1054
Merged
technoweenie
merged 3 commits into
lostisland:0.1x
from
BobbyMcWho:create-faraday-deprecation-class
Oct 17, 2019
Merged
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
# frozen_string_literal: true | ||
|
||
module Faraday | ||
# @param new_klass [Class] new Klass to use | ||
# | ||
# @return [Class] A modified version of new_klass that warns on | ||
# usage about deprecation. | ||
# @see Faraday::Deprecate | ||
module DeprecatedClass | ||
def self.proxy_class(new_klass) | ||
Class.new(new_klass).tap do |k| | ||
class << k | ||
extend Faraday::Deprecate | ||
# Make this more human readable than #<Class:Faraday::ClientError> | ||
klass_name = superclass.to_s[/^#<Class:(\w*::\w*)>$/, 1] | ||
deprecate :new, "#{klass_name}.new", '1.0' | ||
deprecate :inherited, klass_name, '1.0' | ||
end | ||
end | ||
end | ||
end | ||
|
||
# Deprecation using semver instead of date, based on Gem::Deprecate | ||
# Provides a single method +deprecate+ to be used to declare when | ||
# something is going away. | ||
# | ||
# class Legacy | ||
# def self.klass_method | ||
# # ... | ||
# end | ||
# | ||
# def instance_method | ||
# # ... | ||
# end | ||
# | ||
# extend Faraday::Deprecate | ||
# deprecate :instance_method, "X.z", '1.0' | ||
# | ||
# class << self | ||
# extend Faraday::Deprecate | ||
# deprecate :klass_method, :none, '1.0' | ||
# end | ||
# end | ||
module Deprecate | ||
def self.skip # :nodoc: | ||
@skip ||= false | ||
end | ||
|
||
def self.skip=(value) # :nodoc: | ||
@skip = value | ||
end | ||
|
||
# Temporarily turn off warnings. Intended for tests only. | ||
def skip_during | ||
original = Faraday::Deprecate.skip | ||
Faraday::Deprecate.skip, = true | ||
yield | ||
ensure | ||
Faraday::Deprecate.skip = original | ||
end | ||
|
||
# Simple deprecation method that deprecates +name+ by wrapping it up | ||
# in a dummy method. It warns on each call to the dummy method | ||
# telling the user of +repl+ (unless +repl+ is :none) and the | ||
# semver that it is planned to go away. | ||
# @param name [Symbol] the method symbol to deprecate | ||
# @param repl [#to_s, :none] the replacement to use, when `:none` it will | ||
# alert the user that no replacemtent is present. | ||
# @param ver [String] the semver the method will be removed. | ||
def deprecate(name, repl, ver) | ||
class_eval do | ||
old = "_deprecated_#{name}" | ||
alias_method old, name | ||
define_method name do |*args, &block| | ||
mod = is_a? Module | ||
target = mod ? "#{self}." : "#{self.class}#" | ||
target_message = if name == :inherited | ||
"Inheriting #{self}" | ||
else | ||
"#{target}#{name}" | ||
end | ||
|
||
msg = [ | ||
"NOTE: #{target_message} is deprecated", | ||
repl == :none ? ' with no replacement' : "; use #{repl} instead. ", | ||
"It will be removed in or after version #{Gem::Version.new(ver)}", | ||
"\n#{target}#{name} called from #{Gem.location_of_caller.join(':')}" | ||
] | ||
warn "#{msg.join}." unless Faraday::Deprecate.skip | ||
send old, *args, &block | ||
end | ||
end | ||
end | ||
|
||
module_function :deprecate, :skip_during | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
# frozen_string_literal: true | ||
|
||
RSpec.describe Faraday::ClientError do | ||
describe '.initialize' do | ||
subject { described_class.new(exception, response) } | ||
let(:response) { nil } | ||
|
||
context 'with exception only' do | ||
let(:exception) { RuntimeError.new('test') } | ||
|
||
it { expect(subject.wrapped_exception).to eq(exception) } | ||
it { expect(subject.response).to be_nil } | ||
it { expect(subject.message).to eq(exception.message) } | ||
it { expect(subject.backtrace).to eq(exception.backtrace) } | ||
it { expect(subject.inspect).to eq('#<Faraday::ClientError wrapped=#<RuntimeError: test>>') } | ||
end | ||
|
||
context 'with response hash' do | ||
let(:exception) { { status: 400 } } | ||
|
||
it { expect(subject.wrapped_exception).to be_nil } | ||
it { expect(subject.response).to eq(exception) } | ||
it { expect(subject.message).to eq('the server responded with status 400') } | ||
it { expect(subject.inspect).to eq('#<Faraday::ClientError response={:status=>400}>') } | ||
end | ||
|
||
context 'with string' do | ||
let(:exception) { 'custom message' } | ||
|
||
it { expect(subject.wrapped_exception).to be_nil } | ||
it { expect(subject.response).to be_nil } | ||
it { expect(subject.message).to eq('custom message') } | ||
it { expect(subject.inspect).to eq('#<Faraday::ClientError #<Faraday::ClientError: custom message>>') } | ||
end | ||
|
||
context 'with anything else #to_s' do | ||
let(:exception) { %w[error1 error2] } | ||
|
||
it { expect(subject.wrapped_exception).to be_nil } | ||
it { expect(subject.response).to be_nil } | ||
it { expect(subject.message).to eq('["error1", "error2"]') } | ||
it { expect(subject.inspect).to eq('#<Faraday::ClientError #<Faraday::ClientError: ["error1", "error2"]>>') } | ||
end | ||
|
||
context 'maintains backward-compatibility until 1.0' do | ||
it 'does not raise an error for error-namespaced classes but prints an error message' do | ||
error_message, error = with_warn_squelching { Faraday::Error::ClientError.new('foo') } | ||
|
||
expect(error).to be_a Faraday::ClientError | ||
expect(error_message).to match( | ||
Regexp.new( | ||
'NOTE: Faraday::Error::ClientError.new is deprecated; '\ | ||
'use Faraday::ClientError.new instead. It will be removed in or after version 1.0' | ||
) | ||
) | ||
end | ||
|
||
it 'does not raise an error for inherited error-namespaced classes but prints an error message' do | ||
error_message, = with_warn_squelching { class E < Faraday::Error::ClientError; end } | ||
|
||
expect(error_message).to match( | ||
Regexp.new( | ||
'NOTE: Inheriting Faraday::Error::ClientError is deprecated; '\ | ||
'use Faraday::ClientError instead. It will be removed in or after version 1.0' | ||
) | ||
) | ||
end | ||
|
||
it 'allows backward-compatible class to be subclassed' do | ||
expect { class CustomError < Faraday::Error::ClientError; end }.not_to raise_error | ||
end | ||
end | ||
|
||
def with_warn_squelching | ||
stderr_catcher = StringIO.new | ||
original_stderr = $stderr | ||
$stderr = stderr_catcher | ||
result = yield if block_given? | ||
[stderr_catcher.tap(&:rewind).string, result] | ||
ensure | ||
$stderr = original_stderr | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this should accept a
version
argument so we can proxy deprecated classes beyond 1.0. Probably not necessary for this PR on the0.1x
branch, but definitely once this gets ported tomaster
.