Fix/Deprecate FmaBrotherhood Generator #2856

kirkkwang · 2023-11-14T00:06:01Z

Motivation / Background

This Pull Request has been created because of this issue:

Fix/Deprecate FmaBrotherhood Generator #2853

Additional information

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 #issue-number]
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:

Open an issue first for discussion before you write any code.
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 Documentation guidelines.

This commit will rename instances of room to the_room including the locales. Originally the `room.md` had a typo that referenced ::Room and not ::TheRoom which is also fixed here. Ref: - faker-ruby#2787 Co-authored-by: Jamal-A-Mohamed <jamalashur@gmail.com> Co-authored-by: Salvador <salvador.tena@scientist.com>

This commit fixes the naming discrpencies with the FmaBrotherhood (now FullmetalAlchemistBrotherhood) class and its filename. This adds deprecation warnings for the old FmaBrotherhood class and also makes the new FullmetalAlchemistBrotherhood class. Fix: - faker-ruby#2853

stefannibrasil

Thank you @kirkkwang for working on this and for your patience for this review. I left a few comments, let me know if you have any questions :)

lib/faker/japanese_media/fullmetal_alchemist_brotherhood.rb

test/faker/japanese_media/test_faker_fullmetal_alchemist_brotherhood.rb

stefannibrasil · 2024-02-02T15:26:20Z

hi @kirkkwang just checking on this one :)

kirkkwang · 2024-02-02T16:48:32Z

hi @kirkkwang just checking on this one :)

Oh thanks for reminding me! I totally forgot 😅

stefannibrasil · 2024-02-25T21:02:28Z

Hi @kirkkwang we merged this Deprecator that we can use for this one as well: #2858

kirkkwang · 2024-02-26T00:32:39Z

@stefannibrasil wow that makes this so much easier, great addition! I've pushed up a change with a proposed refactor, lemme know if that fits the idea. If not I can revert.

stefannibrasil

thank you @kirkkwang ! Left two small suggestions.

test/faker/japanese_media/test_faker_fullmetal_alchemist_brotherhood.rb

test/test_faker_deprecator.rb

stefannibrasil · 2024-02-26T16:57:05Z

test/faker/japanese_media/test_faker_fullmetal_alchemist_brotherhood.rb

@@ -18,4 +18,22 @@ def test_city
  def test_country
    assert_match(/\w+/, @tester.country)
  end
+
+  def test_using_a_deprecated_generator_returns_a_warning_message


Almost there! Sorry, I wasn't super clear. For this test, we want to keep both classes covered.

We can have the old test in this same file, like we did for IDNumber:

https://github.com/faker-ruby/faker/blob/main/test/faker/default/test_faker_id_number.rb#L292

So we'd have two classes in this file. One for testing Faker::JapaneseMedia::FmaBrotherhood and another for Faker::JapaneseMedia::FullmetalAlchemistBrotherhood. Does that make sense?

We want to be sure the behaviour is maintained despite of which class is being used.

that makes sense, do i keep this test still in here?
test_using_a_deprecated_generator_returns_a_warning_message

That behaviour is covered by the deprecator test, so we can remove them from here 👍

@stefannibrasil i pushed the changes, let me know if this is what you're looking for

This commit will refactor the changes from `FmaBrotherhood` to `FullmetalAlchemistBrotherhood` and use `Faker::Deprecator`.

stefannibrasil

thank you, @kirkkwang 🎉

stefannibrasil · 2024-02-26T18:02:13Z

lib/faker/japanese_media/fullmetal_alchemist_brotherhood.rb

        end
      end
    end
+
+    include Faker::Deprecator


* Favor 'The Room' instead of 'Room' This commit will rename instances of room to the_room including the locales. Originally the `room.md` had a typo that referenced ::Room and not ::TheRoom which is also fixed here. Ref: - faker-ruby#2787 Co-authored-by: Jamal-A-Mohamed <jamalashur@gmail.com> Co-authored-by: Salvador <salvador.tena@scientist.com> * Fix/Deprecate FmaBrotherhood Generator This commit fixes the naming discrpencies with the FmaBrotherhood (now FullmetalAlchemistBrotherhood) class and its filename. This adds deprecation warnings for the old FmaBrotherhood class and also makes the new FullmetalAlchemistBrotherhood class. Fix: - faker-ruby#2853 * Refactor deprecation for `FmaBrotherhood` This commit will refactor the changes from `FmaBrotherhood` to `FullmetalAlchemistBrotherhood` and use `Faker::Deprecator`. --------- Co-authored-by: Jamal-A-Mohamed <jamalashur@gmail.com> Co-authored-by: Salvador <salvador.tena@scientist.com> Co-authored-by: Stefanni Brasil <stefannibrasil@gmail.com>

* update Faker::Australia to Faker::Locations::Australia * Bump minitest from 5.21.1 to 5.21.2 (#2894) Bumps [minitest](https://github.com/minitest/minitest) from 5.21.1 to 5.21.2. - [Changelog](https://github.com/minitest/minitest/blob/master/History.rdoc) - [Commits](minitest/minitest@v5.21.1...v5.21.2) --- updated-dependencies: - dependency-name: minitest dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump rubocop from 1.59.0 to 1.60.2 (#2896) Bumps [rubocop](https://github.com/rubocop/rubocop) from 1.59.0 to 1.60.2. - [Release notes](https://github.com/rubocop/rubocop/releases) - [Changelog](https://github.com/rubocop/rubocop/blob/master/CHANGELOG.md) - [Commits](rubocop/rubocop@v1.59.0...v1.60.2) --- updated-dependencies: - dependency-name: rubocop dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Add Kenya to supported countries (#2871) * Add Kenya to supported countries * Add tests for locale * clan up pull request * Add landline telephone numbers and cell phone formats * Bump minitest from 5.21.2 to 5.22.2 (#2902) Bumps [minitest](https://github.com/minitest/minitest) from 5.21.2 to 5.22.2. - [Changelog](https://github.com/minitest/minitest/blob/master/History.rdoc) - [Commits](minitest/minitest@v5.21.2...v5.22.2) --- updated-dependencies: - dependency-name: minitest dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump test-unit from 3.6.1 to 3.6.2 (#2906) Bumps [test-unit](https://github.com/test-unit/test-unit) from 3.6.1 to 3.6.2. - [Release notes](https://github.com/test-unit/test-unit/releases) - [Commits](test-unit/test-unit@3.6.1...3.6.2) --- updated-dependencies: - dependency-name: test-unit dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Refactor `Faker::IDNumber` to `Faker::IdNumber` to be more consistent with other generator's naming convention. (#2858) * Deprecate IDNumber to IdNumber per issue#2787 * wip * Add a Faker::Deprecator module Co-authored-by: Thiago Araujo <thd.araujo@gmail.com> * Add more specs and improve warning message --------- Co-authored-by: jamal.mohamed <jamal.mohamed@covermymeds.com> Co-authored-by: Stefanni Brasil <stefannibrasil@gmail.com> Co-authored-by: Thiago Araujo <thd.araujo@gmail.com> * Fix/Deprecate FmaBrotherhood Generator (#2856) * Favor 'The Room' instead of 'Room' This commit will rename instances of room to the_room including the locales. Originally the `room.md` had a typo that referenced ::Room and not ::TheRoom which is also fixed here. Ref: - #2787 Co-authored-by: Jamal-A-Mohamed <jamalashur@gmail.com> Co-authored-by: Salvador <salvador.tena@scientist.com> * Fix/Deprecate FmaBrotherhood Generator This commit fixes the naming discrpencies with the FmaBrotherhood (now FullmetalAlchemistBrotherhood) class and its filename. This adds deprecation warnings for the old FmaBrotherhood class and also makes the new FullmetalAlchemistBrotherhood class. Fix: - #2853 * Refactor deprecation for `FmaBrotherhood` This commit will refactor the changes from `FmaBrotherhood` to `FullmetalAlchemistBrotherhood` and use `Faker::Deprecator`. --------- Co-authored-by: Jamal-A-Mohamed <jamalashur@gmail.com> Co-authored-by: Salvador <salvador.tena@scientist.com> Co-authored-by: Stefanni Brasil <stefannibrasil@gmail.com> * Bump i18n from 1.14.1 to 1.14.4 (#2913) Bumps [i18n](https://github.com/ruby-i18n/i18n) from 1.14.1 to 1.14.4. - [Release notes](https://github.com/ruby-i18n/i18n/releases) - [Changelog](https://github.com/ruby-i18n/i18n/blob/master/CHANGELOG.md) - [Commits](ruby-i18n/i18n@v1.14.1...v1.14.4) --- updated-dependencies: - dependency-name: i18n dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Remove duplicates in doc file (#2914) * Bump rubocop from 1.60.2 to 1.62.1 (#2916) Bumps [rubocop](https://github.com/rubocop/rubocop) from 1.60.2 to 1.62.1. - [Release notes](https://github.com/rubocop/rubocop/releases) - [Changelog](https://github.com/rubocop/rubocop/blob/master/CHANGELOG.md) - [Commits](rubocop/rubocop@v1.60.2...v1.62.1) --- updated-dependencies: - dependency-name: rubocop dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump yard from 0.9.34 to 0.9.36 (#2909) Bumps [yard](https://github.com/lsegal/yard) from 0.9.34 to 0.9.36. - [Release notes](https://github.com/lsegal/yard/releases) - [Changelog](https://github.com/lsegal/yard/blob/main/CHANGELOG.md) - [Commits](lsegal/yard@v0.9.34...v0.9.36) --- updated-dependencies: - dependency-name: yard dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Deprecated Faker::Australia * Added Docs for Australia * Updated Readme to include Locations * Updated locales path for australia * updated test to differentiate deprecated methods * Removed whitespaces from australia.yml --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Andrew Nduati <nduatiandrew@gmail.com> Co-authored-by: Jamal-A-Mohamed <37128483+Jamal-A-Mohamed@users.noreply.github.com> Co-authored-by: jamal.mohamed <jamal.mohamed@covermymeds.com> Co-authored-by: Stefanni Brasil <stefannibrasil@gmail.com> Co-authored-by: Thiago Araujo <thd.araujo@gmail.com> Co-authored-by: Kirk Wang <kirk.wang@scientist.com> Co-authored-by: Jamal-A-Mohamed <jamalashur@gmail.com> Co-authored-by: Salvador <salvador.tena@scientist.com> Co-authored-by: Michael Marusyk <31774981+mmarusyk@users.noreply.github.com>

kirkkwang and others added 2 commits November 13, 2023 14:23

Merge branch 'faker-ruby:main' into main

1c8e604

kirkkwang force-pushed the main branch 2 times, most recently from f29c607 to 6de8b50 Compare November 14, 2023 01:10

kirkkwang force-pushed the main branch from 6de8b50 to 3fef6b3 Compare November 14, 2023 01:20

thdaraujo added the rubyconf2023 label Nov 20, 2023

stefannibrasil added the ⏲️ PR: In Queue for Review label Nov 21, 2023

Merge branch 'main' into main

f6d6659

stefannibrasil reviewed Dec 8, 2023

View reviewed changes

lib/faker/japanese_media/fullmetal_alchemist_brotherhood.rb Outdated Show resolved Hide resolved

lib/faker/japanese_media/fullmetal_alchemist_brotherhood.rb Show resolved Hide resolved

test/faker/japanese_media/test_faker_fullmetal_alchemist_brotherhood.rb Outdated Show resolved Hide resolved

Merge branch 'main' into main

1a43e22

Merge branch 'faker-ruby:main' into main

838bbf3

kirkkwang force-pushed the main branch 2 times, most recently from be49ee3 to a7129ce Compare February 26, 2024 00:29

stefannibrasil reviewed Feb 26, 2024

View reviewed changes

test/faker/japanese_media/test_faker_fullmetal_alchemist_brotherhood.rb Outdated Show resolved Hide resolved

test/test_faker_deprecator.rb Outdated Show resolved Hide resolved

kirkkwang force-pushed the main branch from a7129ce to eb4f865 Compare February 26, 2024 16:39

stefannibrasil reviewed Feb 26, 2024

View reviewed changes

Refactor deprecation for FmaBrotherhood

50b540f

This commit will refactor the changes from `FmaBrotherhood` to `FullmetalAlchemistBrotherhood` and use `Faker::Deprecator`.

kirkkwang force-pushed the main branch from eb4f865 to 50b540f Compare February 26, 2024 17:57

stefannibrasil approved these changes Feb 26, 2024

View reviewed changes

stefannibrasil merged commit 7990a43 into faker-ruby:main Feb 26, 2024
8 checks passed

stefannibrasil mentioned this pull request Mar 26, 2024

Added docs for Deprecator in CONTRIBUTING.md #2919

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix/Deprecate FmaBrotherhood Generator #2856

Fix/Deprecate FmaBrotherhood Generator #2856

kirkkwang commented Nov 14, 2023

stefannibrasil left a comment

stefannibrasil commented Feb 2, 2024

kirkkwang commented Feb 2, 2024

stefannibrasil commented Feb 25, 2024

kirkkwang commented Feb 26, 2024

stefannibrasil left a comment

stefannibrasil Feb 26, 2024

kirkkwang Feb 26, 2024

stefannibrasil Feb 26, 2024

kirkkwang Feb 26, 2024

stefannibrasil left a comment

stefannibrasil Feb 26, 2024

Fix/Deprecate FmaBrotherhood Generator #2856

Fix/Deprecate FmaBrotherhood Generator #2856

Conversation

kirkkwang commented Nov 14, 2023

Motivation / Background

Additional information

Checklist

stefannibrasil left a comment

Choose a reason for hiding this comment

stefannibrasil commented Feb 2, 2024

kirkkwang commented Feb 2, 2024

stefannibrasil commented Feb 25, 2024

kirkkwang commented Feb 26, 2024

stefannibrasil left a comment

Choose a reason for hiding this comment

stefannibrasil Feb 26, 2024

Choose a reason for hiding this comment

kirkkwang Feb 26, 2024

Choose a reason for hiding this comment

stefannibrasil Feb 26, 2024

Choose a reason for hiding this comment

kirkkwang Feb 26, 2024

Choose a reason for hiding this comment

stefannibrasil left a comment

Choose a reason for hiding this comment

stefannibrasil Feb 26, 2024

Choose a reason for hiding this comment