Change Styleguide around acronym capitalization, and fix recent PaymentIntent code #1037
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
The capitalization recommendation it made is *not* being followed by the app. I specifically checked URL vs `Url`, and it's overwhelmingly `URL`. `stripeID` beats `stripeId` by about 2 to 1. You can see fully capitalized acronyms in class names too. I believe this better matches the actual style of the codebase, and will enable new code to be consistent with the old.
…leguide This was a fairly new API added about 4 months ago.
danj-stripe
commented
Nov 8, 2018
| NSString *redirectURL = nextSourceAction[@"value"][@"url"]; | ||
| return [self initWithNativeRedirectURL:nil | ||
| redirectURL:[NSURL URLWithString:redirectURL] | ||
| returnURL:paymentIntent.returnUrl |
There was a problem hiding this comment.
After this PR lands, the only case-sensitive search results for Url are the returnUrl property on STPPaymentIntent.
That property is being removed for IOS-1013, so I left it unchanged in this PR.
danj-stripe
commented
Nov 8, 2018
| @@ -18,7 +18,7 @@ | |||
|
|
|||
| - Avoid single letter variables. Try using `idx` / `jdx` instead of `i` / `j` in for loops. | |||
|
|
|||
| - Prefer `urlString` over `URLString` (acronym prefix), `baseUrlString` over `baseURLString` (acronym infix), and `stripeId` over `stripeID` (acronym suffix) | |||
There was a problem hiding this comment.
I'm not sure where this came from. It doesn't match the code. I took a shot at re-writing it to what I believe is the dominant style of the code base, but feedback on what the replacement should say would be great.
csabol-stripe
approved these changes
Nov 13, 2018
yuki-stripe
pushed a commit
that referenced
this pull request
May 3, 2022
BOUNCER-953 [StripeCardScan iOS] Remove the outer base64 encoding layer in the verification payload
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.
Summary
Fixes the styleguide to match the codebase, and updates recent code that was written
to follow the (incorrect) styleguide re: URL vs Url.
Only one public-facing property needed changing. Deprecated it, along with a fixit to
make the upgrade path easier for users. Everything else was private or test-only.
Motivation
I'd been following the STYLEGUIDE.md while working on the last PaymentIntent-related PRs.
While working on another PaymentIntent-related PR, I noticed the inconsistency, and
took the time to fix all of the
Urlcases.Testing
I specifically checked URL vs
Url, and it was overwhelminglyURL.stripeIDbeatsstripeIdby about 2 to 1, but I'm not going to change them.You can see fully capitalized acronyms in class names too.
The automated tests verify no functionality change, and the fixit on the only
public-facing property worked to update the sample code.