cerebris / jsonapi-resources

A resource-focused Rails library for developing JSON:API compliant servers.
http://jsonapi-resources.com
MIT License
2.32k stars 533 forks source link

Rails Namespace Conflict with jsonapi.rb #1413

Open SingleShot opened 1 year ago

SingleShot commented 1 year ago

This issue is a (choose one):

Checklist before submitting:

Description

We have a project that uses the jsonapi.rb gem. We'd like to slowly switch over to use jsonapi-resources. The former contains a module named JSONAPI::Rails. The latter contains a module named JSONAPI within which there are multiple uses of Rails, e.g. class Railtie < Rails::Railtie and Rails.logger. This leads to a namespace clash and jsonapi-resources fails to work in such a project, being unable to find any Rails methods, etc.

While it can be argued that this is not a bug in jsonapi-resources, it would probably be good to avoid this namespace clash if easy, especially when the clash is with another JSON:API gem. Fixing this would make it easier for projects to evaluate and switch over to jsonapi-resources. In our case, we have a large project and would want to migrate to jsonapi-resources piece by piece, but currently must do so wholesale.

A simple and modest fix would be to fully scope references to Rails, e.g. ::Rails::Railtie and ::Rails.logger. This is a safe change to jsoonapi-resources

Sorry - I could not get the bug template to execute successfully. If you are willing to accept this "bug" report I will submit an MR.