Refactor Faker::IDNumber to Faker::IdNumber to be more consistent with other generator's naming convention.

[Jamal-A-Mohamed]

Co-authored-by: Salvador Tena [email protected]

Motivation / Background

This Pull Request has been created because of this issue #2787 which raises the inconsistency of generator names in the codebase. The PR changes the class name from IDNumber to IdNumber which puts it in line with the rest of the generators and updates tests and documentation as well.

Additional information

Testing:

Before changing the test files I ran the test task and made sure the delegation worked properly and that deprecation warnings were outputting correctly. screenshot is below. added the calling from the message after the fact.

Checklist

Before submitting the PR make sure the following are checked:

• [ X] This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
• [ X] 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]
• [X ] Tests are added or updated if you fix a bug, refactor something, or add a feature.
• [X ] 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.

[stefannibrasil]

Thank you @Jamal-A-Mohamed and Salvador! This is great. I left one suggestion, let me know if you have any questions. Thanks!

[stefannibrasil]

The Test failure is fixed by #2868 could you rebase this branch to get the changes there?

[stefannibrasil]

What do you think of naming this Deprecator? I find it a better name because class is not adding too much to the name.

[stefannibrasil]

I'm thinking if we can do something like how ActiveSupport does but a simplified version for deprecating generators: https://github.com/rails/rails/blob/main/activesupport/lib/active_support/deprecation/constant_accessor.rb

It would be a module mixin that would add the const_missing and intercept calls to the deprecated module. The other mixin method would let you register the deprecated and the new modules.

If we could this in a module to be included, we can just add it to the generator to deprecate_constant passing the generator and the replacement, ie:

# id_number.rb

module Faker
  class IdNumber < Base
    include Faker::Deprecator

    deprecate_constant(Faker::IDNumber, Faker::IdNumber)
  end
end

[Jamal-A-Mohamed]

Yeah, I think this is a good idea, will implement it that way.

[stefannibrasil]

Cool, thank you! That would fit nicely with the others to be deprecated. Let us know if you need any help.

[Jamal-A-Mohamed]

Hi @stefannibrasil ,
Sorry for the taking so long on this but haven't had a chance to touch this till this morning.
I am not able to figure out a way to intercept the const_missing calls to the Faker module itself. i.e Faker::Constant_name. I tried to prepend the extension/module to the Faker module itself but that doesn't seem to work. will continue to look at it but interested to hear if you have way to get around that.

[stefannibrasil]

Hi @Jamal-A-Mohamed thank you for your patience! I was almost there and @thdaraujo helped me with the final details. Here's how we could make it work: https://github.com/faker-ruby/faker/compare/main...hexdevs:faker:deprecator?expand=1

Not sure if you can cherry-pick this commit 8f54cbe to this branch.

[Jamal-A-Mohamed]

Awesome! Great Job to you both.
I cherry picked that from your guy's commit and pushed it up.
I would need to re-read to see what I was missing.
Let me know if you want me to squash commits and or write more tests.

[stefannibrasil]

Yay! Okay, almost there. I was testing some things on another project and pushed just one more commit here: efe80d0

Could you cherry-pick it again? That would be the only thing left before merging this. Thank you for your patience and your work on this!

[Jamal-A-Mohamed]

Done!

[stefannibrasil]

Nice, thank you for helping out on this one! 🎉

[stefannibrasil]

🎉