Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

This is a compatibility breaking change to fix our naming structure to be inline with ruby gem conventions #3

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

andrewhubbs
Copy link
Contributor

@andrewhubbs andrewhubbs commented Jun 16, 2017

❗️ 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:

  • Guidelines: http://guides.rubygems.org/name-your-gem/
  • Our gem name implies that scaleapi is a single word when it ought to be scale_api
  • Our gem defines the namespace 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

  • Update the gem name from scaleapi to scale_api
  • Update the namespace scale to match the gem name scale_api
  • Update usage and docs to use the class ScaleApi and scale_api folder structure

* Update gem naming to follow convention
  * Note this is useful because it prevents confusion for users and will
    avoid a class of naming collision issues users may run into
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant