Renaming Two Packages?

60 views
Skip to first unread message

Paul M. Jones

unread,
Apr 20, 2014, 11:00:29 AM4/20/14
to aur...@googlegroups.com
Hi everybody,

As you know, Aura *library* packages have no dependencies. However, *kernel* and *project* packages do have dependencies (as will any future *bundle* packages that combine libraries). To make it obvious which packages have dependencies and which don't, kernel and project package names are suffixed with `_Kernel` and `_Project`.

However, this raises an inconsistency in how we name packages. Sql_Query and Sql_Schema have underscores in the name, and that underscore is inconsistent for informational purposes (they are library packages, not packages with dependencies).

To remedy this, I am strongly considering renaming them to SqlQuery and SqlSchema to remove the underscores. As they are not yet in stable release (the schema package is not even in beta yet) this would be the time to do it.

If I do so, it would mean pointing your composer.json to the new package name (or otherwise pointing your installations to the new package). It also means the PHP namespace would change, so you would have to grep your code to replace "Sql_Query" (etc) with "SqlQuery".

Any objections to this plan?


--
Paul M. Jones
pmjo...@gmail.com
http://paul-m-jones.com

Modernizing Legacy Applications in PHP
http://mlaphp.com



Hari K T

unread,
Apr 20, 2014, 11:57:42 AM4/20/14
to aur...@googlegroups.com
Paul, 

I believe there is still people who are not here or are not subscribed to the mailing list. Could you announce a link in twitter via @auraphp handle ?

Thanks

Hari K T

You can ring me : +91 9388 75 8821

Skype  : kthari85
Twitter : harikt


--
You received this message because you are subscribed to the Google Groups "The Aura Project for PHP" group.
To unsubscribe from this group and stop receiving emails from it, send an email to auraphp+u...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Jake A. Smith

unread,
Apr 20, 2014, 3:11:51 PM4/20/14
to aur...@googlegroups.com
I think that makes a lot of sense and its an easy enough change to make.

JS

Jesse Burns

unread,
Apr 20, 2014, 6:49:44 PM4/20/14
to aur...@googlegroups.com
I agree, those are small changes to make for the sake of consistency in
Aura.
> pmjo...@gmail.com <javascript:>
> http://paul-m-jones.com
>
> Modernizing Legacy Applications in PHP
> http://mlaphp.com
>
>
>
> --
> You received this message because you are subscribed to the Google
> Groups "The Aura Project for PHP" group.
> To unsubscribe from this group and stop receiving emails from it, send
> an email to auraphp+u...@googlegroups.com
> <mailto:auraphp+u...@googlegroups.com>.
> For more options, visit https://groups.google.com/d/optout.

--

Jesse Burns
jbWebWare.com - Bringing The Web To You!!!
AllianceCMS.com - Bringing Us Together!!!

Stan Lemon

unread,
Apr 20, 2014, 7:29:59 PM4/20/14
to aur...@googlegroups.com, Paul M. Jones
I agree with the other opinions expressed. I like this and generally think it’s an improvement in naming.

SL
--
You received this message because you are subscribed to the Google Groups "The Aura Project for PHP" group.
To unsubscribe from this group and stop receiving emails from it, send an email to auraphp+u...@googlegroups.com.

Paul M. Jones

unread,
Apr 24, 2014, 2:26:08 PM4/24/14
to aur...@googlegroups.com
Hi all,

The consensus seems clear: go ahead and rename Sql_Query and Sql_Schema to SqlQuery and SqlSchema, respectively.

The rename carries some negative consequences, all of which should be relatively easy to remedy in the short term:

- All existing remote clones to break. After the rename, you will have to either change your origin, or re-clone the repository.

- All existing composer.json references will break. After the rename, you will have to change from "aura/sql-query" to "aura/sqlquery", and from "aura/sql-schema" to "aura/sqlschema".

- All existing extensions and typehints to classes from those packages will break. After the rename, you will have to change from Aura\Sql_Query\* to Aura\SqlQuery\*, and from Aura\Sql_Schema\* to Aura\SqlSchema\*.

So that we do not lose the issue/PR/etc history on the existing repositories, I will be renaming them in place. I may or may not create "dummy" replacement repos to point old links to the new repos.

I will do the rename soon, probably no earlier than this weekend, and certainly no later than the end of next week.

Thanks for your input everyone!

Hari K T

unread,
Apr 24, 2014, 10:38:39 PM4/24/14
to aur...@googlegroups.com
Hey,

- All existing composer.json references will break. After the rename, you will have to change from "aura/sql-query" to "aura/sqlquery", and from "aura/sql-schema" to "aura/sqlschema".

I guess we could use the replace functionality here.

You can note an example https://github.com/cordoval/random-packagist-test/blob/master/composer.json#L3 .

{
    "name": "auraphp/sql-query",
    "replace": {
        "aura/sqlquery": "no-sure on version"
    }
}

And also the repo will stay with a readme so links are not broken.
 
So that we do not lose the issue/PR/etc history on the existing repositories, I will be renaming them in place.  I may or may not create "dummy" replacement repos to point old links to the new repos.

Yes dummy's are good. Ping Simensen or Crodos for more information on this.
 
I will do the rename soon, probably no earlier than this weekend, and certainly no later than the end of next week.

Great! But don't do it on Friday your time, for that can break the stuffs for people and the last minute of  weekends .

As always thanks for all your work Paul :-)

Jesse Burns

unread,
Apr 24, 2014, 11:24:19 PM4/24/14
to aur...@googlegroups.com
On 4/24/2014 2:26 PM, Paul M. Jones wrote:
> So that we do not lose the issue/PR/etc history on the existing repositories, I will be renaming them in place. I may or may not create "dummy" replacement repos to point old links to the new repos.

I believe that when you rename a repo Github will now automatically
redirect to the newly named repo if someone references the old repo
url/name.

See this article: https://help.github.com/articles/renaming-a-repository

I had passed a personal repo to an organization, then passed it again to
another organization, and forgot to update links on my site that pointed
to the old location of the repo (and it's issue tracker and wiki). I
didn't catch the old links for a while because nothing seemed broke due
to Github automatically redirecting to the repo's new location (and
because I'm a space shot and missed them while updating links lol) :-p

So don't worry about 'dummy' repo's, Github has you covered ;-)

Hari K T

unread,
Apr 24, 2014, 11:28:10 PM4/24/14
to aur...@googlegroups.com
 
I believe that when you rename a repo Github will now automatically redirect to the newly named repo if someone references the old repo url/name.

See this article: https://help.github.com/articles/renaming-a-repository

I had passed a personal repo to an organization, then passed it again to another organization, and forgot to update links on my site that pointed to the old location of the repo (and it's issue tracker and wiki). I didn't catch the old links for a while because nothing seemed broke due to Github automatically redirecting to the repo's new location (and because I'm a space shot and missed them while updating links lol) :-p

So don't worry about 'dummy' repo's, Github has you covered ;-)

and I believe they will redirect only for a short time though. If not great! .

Jesse Burns

unread,
Apr 24, 2014, 11:32:21 PM4/24/14
to aur...@googlegroups.com
It's been at least three months for me.

That article doesn't mention if it's only for a limited time, but it does state this warning:

Warning: If you reuse the old repository name by creating a new repository or renaming an existing one, it will break the redirects!

Paul M. Jones

unread,
Apr 30, 2014, 12:37:36 PM4/30/14
to aur...@googlegroups.com

On Apr 24, 2014, at 1:26 PM, Paul M. Jones <pmjo...@gmail.com> wrote:

> The consensus seems clear: go ahead and rename Sql_Query and Sql_Schema to SqlQuery and SqlSchema, respectively.

I have completed the rename. The consequences were not as negative as I thought they might be:


> - All existing remote clones to break. After the rename, you will have to either change your origin, or re-clone the repository.

It turns out that you do not need to change the origin, as Github will redirect appropriately. (I have re-cloned my repo just to be sure though.)


> - All existing composer.json references will break. After the rename, you will have to change from "aura/sql-query" to "aura/sqlquery", and from "aura/sql-schema" to "aura/sqlschema".

I have not updated Packagist yet, as I do not seem to be able to get to it right now. I will let you know when I do so.


> - All existing extensions and typehints to classes from those packages will break. After the rename, you will have to change from Aura\Sql_Query\* to Aura\SqlQuery\*, and from Aura\Sql_Schema\* to Aura\SqlSchema\*.

This is still true.


> I may or may not create "dummy" replacement repos to point old links to the new repos.

Github is redirecting from the old names to the new ones so no dummy repo is needed.

Thanks everybody!

Hari K T

unread,
Apr 30, 2014, 10:15:43 PM4/30/14
to aur...@googlegroups.com
Hi, 

Good to see the rename. Some comments inline.

> The consensus seems clear: go ahead and rename Sql_Query and Sql_Schema to SqlQuery and SqlSchema, respectively.

I have completed the rename. The consequences were not as negative as I thought they might be:


> - All existing remote clones to break. After the rename, you will have to either change your origin, or re-clone the repository.

It turns out that you do not need to change the origin, as Github will redirect appropriately. (I have re-cloned my repo just to be sure though.)

Good to hear :) .
 

> - All existing composer.json references will break. After the rename, you will have to change from "aura/sql-query" to "aura/sqlquery", and from "aura/sql-schema" to "aura/sqlschema".

I have not updated Packagist yet, as I do not seem to be able to get to it right now.  I will let you know when I do so.


Yes, I was checking the packagist . Updated the github url for the sql-query https://packagist.org/packages/aura/sql-query .

We need to update the composer.json of master branch. Is there any reason you are waiting for the rename ?

Hari K T

unread,
May 2, 2014, 4:25:34 AM5/2/14
to aur...@googlegroups.com
Hey,

> - All existing composer.json references will break. After the rename, you will have to change from "aura/sql-query" to "aura/sqlquery", and from "aura/sql-schema" to "aura/sqlschema".

I have not updated Packagist yet, as I do not seem to be able to get to it right now.  I will let you know when I do so.

So packagist is being updated.
Reply all
Reply to author
Forward
0 new messages