JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources
Incorrect Namespace for the gem
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 2.3k
- Forks
- 546
- PR merge metrics
- No merged PRs in 30d
Description
Regarding conventions this gem should be wrapped to
module JsonapiResources
end
Instead we have
module JSONAPI
end
I am pretty sure it was simplified specially to have more elegant code. But this decision was potentially dangerous. Now we have other young ruby gem https://github.com/beauby/jsonapi to simplify json parsing. it has same namespace that is correct and follows conventions. Unfortunately I could not use both gems at the same time, because instead of JSONAPI::Resource loading from jsonapi gem it loads code from jsonapi-resources gem. Super bad and blocker for me.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The request is to replace the gem's JSONAPI namespace with JsonapiResources to avoid collision with the jsonapi gem. Start by auditing the public JSONAPI references and compatibility implications; done means both gems can be used together without breaking supported behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rails, ruby
- Domain
- backend
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100