Skip to content

Commit

Permalink
allow deprecated exception classes to rescue the current exception class
Browse files Browse the repository at this point in the history
  • Loading branch information
technoweenie committed Oct 17, 2019
1 parent f2e8694 commit ddab77c
Show file tree
Hide file tree
Showing 3 changed files with 131 additions and 2 deletions.
4 changes: 4 additions & 0 deletions lib/faraday/deprecate.rb
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ class << k
klass_name = superclass.to_s[/^#<Class:(\w{1}[\w:]*)>$/, 1]
deprecate :new, "#{klass_name}.new", '1.0'
deprecate :inherited, klass_name, '1.0'

def ===(other)
superclass === other || super
end
end
end
end
Expand Down
89 changes: 89 additions & 0 deletions spec/faraday/deprecate_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# frozen_string_literal: true

RSpec.describe Faraday::DeprecatedClass do
class SampleClass < StandardError
attr_accessor :foo

def initialize(foo = nil)
@foo = foo || :foo
end
end

SampleDeprecatedClass = Faraday::DeprecatedClass.proxy_class(SampleClass)

it 'does not raise error for deprecated classes but prints an error message' do
error_message, foobar = with_warn_squelching { SampleDeprecatedClass.new(:foo_bar) }
expect(foobar).to be_a(SampleClass)
expect(foobar.foo).to eq(:foo_bar)
expect(error_message).to match(
Regexp.new(
'NOTE: SampleDeprecatedClass.new is deprecated; '\
'use SampleClass.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.new(SampleDeprecatedClass) }

expect(error_message).to match(
Regexp.new(
'NOTE: Inheriting SampleDeprecatedClass is deprecated; '\
'use SampleClass instead. It will be removed in or after version 1.0'
)
)
end

it 'allows backward-compatible class to be subclassed' do
expect {
with_warn_squelching { Class.new(SampleDeprecatedClass) }
}.not_to raise_error
end

it 'allows rescuing of a current error with a deprecated error' do
begin
raise SampleClass, nil
rescue SampleDeprecatedClass
rescue StandardError => exc
fail "rescued #{exc.class.name} instead"
end
end

it 'allows rescuing of a current error with a current error' do
begin
raise SampleClass, nil
rescue SampleClass
rescue StandardError => exc
fail "rescued #{exc.class.name} instead"
end
end

it 'allows rescuing of a deprecated error with a deprecated error' do
begin
raise SampleDeprecatedClass, nil
rescue SampleDeprecatedClass
rescue StandardError => exc
fail "rescued #{exc.class.name} instead"
end
end

it 'allows rescuing of a deprecated error with a current error' do
begin
raise SampleDeprecatedClass, nil
rescue SampleClass
rescue StandardError => exc
fail "rescued #{exc.class.name} instead"
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
40 changes: 38 additions & 2 deletions spec/faraday/error_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
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 }
error_message, = with_warn_squelching { Class.new(Faraday::Error::ClientError) }

expect(error_message).to match(
Regexp.new(
Expand All @@ -67,7 +67,43 @@
end

it 'allows backward-compatible class to be subclassed' do
expect { class CustomError < Faraday::Error::ClientError; end }.not_to raise_error
expect { Class.new(Faraday::Error::ClientError) }.not_to raise_error
end

it 'allows rescuing of a current error with a deprecated error' do
begin
raise Faraday::ClientError, nil
rescue Faraday::Error::ClientError
rescue Faraday::Error => exc
fail "rescued #{exc.class.name} instead"
end
end

it 'allows rescuing of a current error with a current error' do
begin
raise Faraday::ClientError, nil
rescue Faraday::ClientError
rescue Faraday::Error => exc
fail "rescued #{exc.class.name} instead"
end
end

it 'allows rescuing of a deprecated error with a deprecated error' do
begin
raise Faraday::Error::ClientError, nil
rescue Faraday::Error::ClientError
rescue Faraday::Error => exc
fail "rescued #{exc.class.name} instead"
end
end

it 'allows rescuing of a deprecated error with a current error' do
begin
raise Faraday::Error::ClientError, nil
rescue Faraday::ClientError
rescue Faraday::Error => exc
fail "rescued #{exc.class.name} instead"
end
end
end

Expand Down

0 comments on commit ddab77c

Please sign in to comment.