Fix Email.address() typespec #570
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
What changed? ============ In #386, evuez pointed out that the `Bamboo.Email.address()` typespec shows `String.t() | {String.t(), String.t()}`. But no adapter actually supports the `String.t()` type. Given that the code was introduced [before the typespecs](#150) (and thus we can treat the code as the source of truth when in doubt), and since `Bamboo.Email.get_address/1`'s explicit intent is to abstract the internal representation of email addresses in case Bamboo changes how it stores them: > Gets just the email address from a normalized email address. > Normalized email addresses are 2 item tuples {name, address}. This gets the address part of the tuple. Use this instead of calling elem(address, 1) so that if Bamboo changes how email addresses are represented your code will still work I think the correct change here is to remove the `String.t()` portion of the typespec rather than update the code to handle that typespec. In other words, I think we made a typo when introducing the typespec. So this PR would be merged instead of #386.
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.
What changed?
In #386, @evuez correctly pointed out that the
Bamboo.Email.address()typespec showsString.t() | {String.t(), String.t()}. But no adapter actually supports theString.t()type.Given that the code was introduced before the typespecs (and thus we can treat the code as the source of truth when in doubt), and since
Bamboo.Email.get_address/1's explicit intent is to abstract the internal representation of email addresses in case Bamboo changes how it stores them:-- From
get_address/1docs.I think the correct change here is to remove the
String.t()portion of the typespec rather than update the code to handle that typespec. In other words, I think we made a typo when introducing the typespec. So this PR would be merged instead of #386.