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

Update String#camelize to provide feedback when a wrong option is sent #30039

Merged
merged 2 commits into from Aug 3, 2017

Conversation

Projects
None yet
4 participants
@ricardotk002
Contributor

ricardotk002 commented Aug 2, 2017

Summary

String#camelize was returning nil without any feedback when an
invalid option was sent as parameter. This update makes the method to
raise an ArgumentError when the option passed is invalid, similar to what
Ruby does for String#downcase (and other methods) in 2.4.1.

Previously:

'one_two'.camelize(true)
=> nil

Now:

'one_two'.camelize(true)
=> ArgumentError: Invalid option, use either :upper or :lower.
@rails-bot

This comment has been minimized.

rails-bot commented Aug 2, 2017

Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @sgrif (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review.

Please see the contribution instructions for more information.

Update String#camelize to provide feedback when wrong option is passed
String#camelize was returning nil without any feedback when an
invalid option was passed as parameter. This update makes the method
to raises an ArgumentError when the option passed is invalid, similar
to what Ruby does for String#downcase (and others) in 2.4.1.

https://ruby-doc.org/core-2.4.1/String.html#method-i-downcase
@lugray

This comment has been minimized.

Contributor

lugray commented Aug 2, 2017

I think principle of least surprise would have 'one_two'.camelize(true) behave like ActiveSupport::Inflector.camelize('one_two', true). What about

uppercase_first_letter = {upper: true, lower: false}.fetch(first_letter, first_letter)
ActiveSupport::Inflector.camelize(self, uppercase_first_letter)

@ricardotk002 ricardotk002 changed the title from Update String#camelize to provide feedback when wrong option is passed to Update String#camelize to provide feedback when a wrong option is sent Aug 2, 2017

@ricardotk002

This comment has been minimized.

Contributor

ricardotk002 commented Aug 2, 2017

hey @lugray 👋 , that was my first approach but then I realized that it would make it accept any truthy/falsy value and still work somehow. Another option I considered was to return the same string without modifications, but this is pretty much the same of how it is now: users don't get much feedback about what's happening and they might need to go to the docs in order to learn more about it.

I went to Ruby's String docs to learn more of other methods and I think this implementation follows those designs. You can check String#downcase https://ruby-doc.org/core-2.4.1/String.html#method-i-downcase

'one_two'.downcase(true)
=> ArgumentError: invalid option

@sgrif sgrif merged commit f105ab0 into rails:master Aug 3, 2017

1 check was pending

codeclimate Code Climate is analyzing this code.
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment