Add RBS Support

[corrupt952]

Describe the feature

I propose adding RBS (Ruby Signature) support to Mongoid. RBS is Ruby's standard type definition file format, which can be bundled with the gem itself. This addition would greatly enhance the development experience for Mongoid users by providing better code completion, type checking, and documentation within modern IDEs.

Use Case

With the increasing adoption of Language Server Protocol (LSP) in development environments, RBS support would enable:

1. Automatic method suggestions
2. Type checking for argument and method names
3. In-editor API documentation
4. Improved code navigation

By incorporating RBS into Mongoid, we can ensure accurate type information for each version of the library, enhancing developer productivity and code quality.

Proposed Solution

1. Create a sig directory in the Mongoid gem to store RBS files.
2. Implement an RBS generator that can create type definitions based on Mongoid's existing code and documentation.
3. Integrate the RBS generation process into Mongoid's build pipeline to ensure RBS files are always up-to-date with the latest code changes.
4. Include generated RBS files in gem releases, making them immediately available to users.

Other Information

RBS is gaining traction in the Ruby community, with many popular gems already providing RBS support. Adding this feature to Mongoid would align it with modern Ruby development practices and potentially attract more users who rely on static type checking and enhanced IDE support.

I'm willing to contribute to this effort if the Mongoid team is interested in pursuing this idea. Let me know if you need any additional information or clarification on this proposal.

[alexbevi]

Hey @corrupt952, thanks for the suggestion! Ruby type annotation support is definitely something we've discussed internally but are not yet convinced we should be prioritizing yet.

[johnnyshields]

@corrupt952 today, Mongoid has complete code comments with type annotations. It would be fairly easy to write a script that generates RBS from the comments.

[corrupt952]

Thanks @alexbevi and @johnnyshields for your replies!
I'll give that RBS generation idea a try.