Skip to content
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

Rename Faker::show to Faker::Theater #2921

Conversation

keshavbiswa
Copy link
Contributor

@keshavbiswa keshavbiswa commented Mar 26, 2024

This Pull Request has been created because of naming issues identified here: #2787

This PR replaces the usage of Faker::Show to be Faker::Theater for the following reasons:

The file was created under faker/music/show.rb but the class definition is Faker::Show At the very least the class should be name-spaced correctly as Faker::Music::Show

Faker::Show is ambiguous for its current usage. Faker::Music::Show would also be ambiguous. The class supports three methods: adult_musical kids_musical play that generate names for musicals and plays which all can be categorized under Theater.

Checklist

Before submitting the PR make sure the following are checked:

  • This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
  • Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #]
  • Tests are added or updated if you fix a bug, refactor something, or add a feature.
  • Tests and Rubocop are passing before submitting your proposed changes.

If you're proposing a new generator or locale:

  • Double-check the existing generators documentation to make sure the new generator you want to add doesn't already exist.
  • You've reviewed and followed the Contributing guidelines.

@keshavbiswa
Copy link
Contributor Author

@stefannibrasil Please review :)

Copy link
Contributor

@stefannibrasil stefannibrasil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! One small ask: could you rewrite the commit message with the details from the original PR:

This Pull Request has been created because of naming issues identified here: https://github.com/faker-ruby/faker/issues/2787

This PR replaces the usage of Faker::Show to be Faker::Theater for the following reasons:

The file was created under faker/music/show.rb but the class definition is Faker::Show At the very least the class should be name-spaced correctly as Faker::Music::Show

Faker::Show is ambiguous for its current usage. Faker::Music::Show would also be ambiguous. The class supports three methods: adult_musical kids_musical play that generate names for musicals and plays which all can be categorized under Theater.

It helps with tracking down what was the reason behind the change.

README.md Show resolved Hide resolved
@keshavbiswa
Copy link
Contributor Author

Thank you! One small ask: could you rewrite the commit message with the details from the original PR:

This Pull Request has been created because of naming issues identified here: https://github.com/faker-ruby/faker/issues/2787

This PR replaces the usage of Faker::Show to be Faker::Theater for the following reasons:

The file was created under faker/music/show.rb but the class definition is Faker::Show At the very least the class should be name-spaced correctly as Faker::Music::Show

Faker::Show is ambiguous for its current usage. Faker::Music::Show would also be ambiguous. The class supports three methods: adult_musical kids_musical play that generate names for musicals and plays which all can be categorized under Theater.

It helps with tracking down what was the reason behind the change.

Do you mean the commit message or the PR description?

@keshavbiswa
Copy link
Contributor Author

@stefannibrasil I have updated the PR description for it. Let me know if you need me to rewrite the commit message as well.

@stefannibrasil
Copy link
Contributor

@stefannibrasil I have updated the PR description for it. Let me know if you need me to rewrite the commit message as well.

the commit message is better, thanks!

@keshavbiswa
Copy link
Contributor Author

@stefannibrasil Can we merge this?

Copy link
Contributor

@stefannibrasil stefannibrasil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks ⭐

class << self
##
# Produces the name of a musical for an older audience
#
# @return [String]
#
# @example
# Faker::Alphanumeric.alpha
# #=> "West Side Story"
# Faker::Theater.adult_musical
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch!

@stefannibrasil stefannibrasil merged commit dd8c88c into faker-ruby:main Apr 2, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants