JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Rails Namespace Conflict with jsonapi.rb

Open
#1,413 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
2.3k
Forks
546
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Rails references inside the JSONAPI namespace, especially the Railtie inheritance and logger usage described in the issue, and reproduce the conflict alongside the jsonapi.rb gem. Done means the library resolves the intended Rails methods without a namespace clash while existing behavior remains intact.

Written by the indexing model from the issue text.

Assessment

Tech stack
rails, ruby
Domain
api, backend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.