Skip to content

Rails Namespace Conflict with jsonapi.rb #1413

@SingleShot

Description

@SingleShot

This issue is a (choose one):

  • Problem/bug report.
  • Feature request.
  • Request for support. Note: Please try to avoid submitting issues for support requests. Use Gitter instead.

Checklist before submitting:

  • I've searched for an existing issue.
  • I've asked my question on Gitter and have not received a satisfactory answer.
  • I've included a complete bug report template. This step helps us and allows us to see the bug without trying to reproduce the problem from your description. It helps you because you will frequently detect if it's a problem specific to your project.
  • The feature I'm asking for is compliant with the JSON:API spec.

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions