Backfill breaking change #89
Merged
Conversation
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
Nest existing test for coming compatibility test Test assumed behavior
Fix Rubocop violation around `extend self` in `Module`s. `class << self` is clearest in this case because we need to set attr_accessors on the Module as well as the `reset!` method. `module_function` also pollutes the including object as it gets a private method of the same name. No need to include instance methods on Config::Client or include it in Api::Client if the ATTRIBUTE array is simply splatted into attr_accessor (and is easier to follow where it comes from)
Extract Config accessory to module for clearer inclusion/extension into IEX::Api
agrberg
force-pushed
the
backfill_breaking_change
branch
from
12562b8 to
46365db
Compare
agrberg
commented
Oct 31, 2020
| @@ -445,7 +445,7 @@ client.post('ref-data/isin', isin: ['US0378331005'], token: 'secret_token') # [{ | |||
| You can configure client options globally or directly with a `IEX::Api::Client` instance. | |||
|
|
|||
| ```ruby | |||
| IEX::Api::Client.configure do |config| | |||
There was a problem hiding this comment.
I didn't dig too deeply but going back to 1.2.0 before I started screwin' around there was no IEX::Api::Client.configure method. I believe this was a mistake in the docs between IEX::Api.configure and IEX::Api::Client.new(…)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I found a breaking change where we could no longer assign the logger through the config object. The following was broken by #88
I fixed that in this PR as to not release a Gem version w/ a breaking change unless necessary. I also changed how
IEX::Apiis augmented to provideloggerandconfig. I believe it makes it clearer where the methods come from as well as making those inLoggerreusable forConfig::Client's extension. Let me know what you think.