This is a compatibility breaking change to fix our naming structure to be inline with ruby gem conventions #3
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
❗️ This is a compatibility breaking change ❗️
Since this change will effectively kill the old gem and orphan users, it is going to be a good idea to fork this to a new repo, add warnings deprecating this gem, and redirect users to the new repo rather than actually merging this PR.
Issue
There are a couple things about our naming structure that collides with ruby gem conventions:
scaleapi
is a single word when it ought to bescale_api
Scale
in the lib directory. This is bad because it could collide with the naming used in the projects of gem users. It is best practice to only define the namespace that is the name of the gem in the naked lib folder. Note: At least one user seems to have run into this issue.Fix
scaleapi
toscale_api
scale
to match the gem namescale_api
ScaleApi
andscale_api
folder structure