Composer implementation for dependencies and autoload #1912

Rarst · 2015-01-16T12:05:38Z

✅ Functional and ready to merge.

deprecates Git submodules
implements autoload via Composer w/ PHP 5.2 compatibility

Intermediary instructions to install for testing (this will be down to single create-project in the end):

git clone https://github.com/Rarst/wordpress-seo --branch composer
cd wordpress-seo
composer install --no-dev

Rarst · 2015-01-16T12:11:23Z

Interesting aspect about testing — can you build using PHP 5.3+ on Travis, but test using PHP 5.2?

Rarst · 2015-01-19T11:21:43Z

Tests working, except coding style, see https://travis-ci.org/Yoast/wordpress-seo/jobs/47506113

Outstanding issues with that:

PHP 5.2 linter cannot parse some of vendor (not used, but still present).
Similarly WPCS detects errors with some of vendor.

Exclude vendor from checks altogether? Everything except vendor/yoast ?

jdevalk · 2015-01-19T11:22:58Z

I'd exclude vendor indeed.


          Removed submodules.


          Updated composer.json with dependencies and autoload (classmap plus 5…

….2 compat).


          Removed explicit class mapping in favor of composer autoload.


          Added vendor directory to gitignore


          Removed multisite conditional from WPSEO_Options_MS definition (break…

…s autoload).


          Added composer install to travis before script.


          Extended WPSEO_Option_MS constructor with conditional check.


          Updated module dependency branches in composer.json


          Excluded vendor directory from PHP lint check.


          Updated exclusions in code sniffer configuration to exclude vendor.


          Reapplied coding style, lost in rebase.


          Committed composer.lock file.

Rarst · 2015-01-20T20:28:47Z

Oookay, Composer all working and tests all green, including coding style and PHP 5.2

Next — writing up docs (where is good place for it?), getting team up to speed, and updating build process (which is what?).

It would be helpful if team started to try out intermediary install instructions above and enumerated what doesn't work smoothly and/or needs explaining.

jrfnl · 2015-01-20T20:46:59Z

The wiki seems like a logical place for instructions and such and possibly for the documentation as well ?

jrfnl · 2015-01-20T20:51:49Z

inc/class-wpseo-options.php

@@ -2791,192 +2791,195 @@ protected function clean_option( $option_value, $current_version = null, $all_ol
 /*******************************************************************
 * Option: wpseo_ms
 *******************************************************************/
-if ( is_multisite() ) {


If this conditional is removed, the WPSEO_Options constructor will need to be adjusted as it now checks for whether the class exists before creating/loading that option which would no longer be a valid test once you remove this.

I've moved the check to the _MS class' constructor (after checking in w/ @jdevalk if that makes sense in architecture). It will be instanced, but won't run logic unless in multisite context.

@Rarst I'd have to look in detail, but I suspect that will still make some things go wrong as in the WPSEO_Options class, the available instances are used for certain actions and that logic relies on the _ms option not being instantiated (when not on multisite).

Hmm ok, @Rarst can you look at that specific bit? :)

I stared at it and need a little more specific pointer towards part that might be going wrong. :)

I don't have the time at the moment to look at it and argue it in detail. The short of it is that your are changing the expected behaviour of the object without cause.

I suggest you either change the conditional in the WPSEO_Options class as I suggested before or add the conditional to the get_instance() method of the _ms class instead of the constructor. That way the behaviour doesn't change (instance will be null rather than a nearly empty object).
The constructor of the WPSEO_Options class needs to change either way as the whole class_exists() doesn't make sense anymore with all option classes always being available.

Added skip for MS only instances in Options constructor in 0decfde

@Rarst Thanks. Oh... the class_exists() can go now and the else should also apply to the code you've now added.

I misunderstood else (thought it's cleaning up instances, not pruning input list). Adjusted in https://github.com/Rarst/wordpress-seo/commit/797d6039205b062cfd30efeb7b422be7b45333a2

No worries, looks all good now ;-) Thanks for bearing with me on this.

jdevalk · 2015-01-21T08:25:48Z

I agree with @jrfnl on the wiki being the spot. @omarreiss could you see whether you can get it to work already based on the input by @Rarst in this pull?


          Implemented explicit conditional skip for multisite only options inst…

…ances.


          Adjusted option instances logic.

Rarst · 2015-01-22T09:59:55Z

I think this is now in good shape to merge into trunk and start testing out in that context (so that going through my fork step isn't required).

Although I would hold on that if anyone has unresolved implementation and/or workflow questions?

jdevalk · 2015-01-22T13:58:53Z

composer.json

+	"license": "GPL-2.0+",
+	"authors": [
+		{
+			"name": "Joost de Valk",


This needs to be Team Yoast :)

jdevalk · 2015-01-22T13:59:23Z

One last minor comment and then I'm all for it. @omarreiss any feedback?


          Updated authors section in composer.json

omarreiss · 2015-01-22T14:06:05Z

Nothing much, maybe drop a line in the Readme about local (development) setup? What steps do I need to take to get the plugin running from source?

Rarst · 2015-01-22T14:09:59Z

I'll update readme in a bit (need to eat :) ). The draft of instructions for common procedures (I could think of right away) is already up in in the wiki, ask if anything.

omarreiss · 2015-01-22T14:14:19Z

@Rarst Nice Wiki article! I had somehow missed that. I guess it would be more than enough to drop a reference to that article in the readme.


          Updated readme with Composer instructions.


          Updated lock file's hash to fix outdated warning.

Rarst · 2015-01-26T10:30:44Z

Readme updated, workflow possibilities ironed out some in the issue.

Rarst · 2015-01-29T10:21:32Z

Anything lingering that needs to happen for merge? :)

omarreiss · 2015-01-29T11:25:05Z

👍 from me. @jrfnl @jdevalk ?

jrfnl · 2015-01-29T11:38:29Z

I don't think I'll have time to play with this (test it) before I'll be travelling again, so go for it.
I'll try and get it working when I'm back in March and if I run into trouble with it (which I no doubt will, through no fault but my own), I'll contact @Rarst.

I just won't be able to run any more tests or send in PRs between when this is merged and when I'll have the time to get things working in two months time.


          Merge pull request #1912 from Rarst/composer

Composer implementation for dependencies and autoload

jdevalk · 2015-01-29T15:10:52Z

Merged :D

Rarst mentioned this pull request Jan 16, 2015

Composer roadmap #1890

Closed

10 of 10 tasks complete

Rarst added 12 commits Jan 16, 2015

Removed submodules.

d12b004

Updated composer.json with dependencies and autoload (classmap plus 5…

2601916

….2 compat).

Removed explicit class mapping in favor of composer autoload.

4780532

Added vendor directory to gitignore

c0d688c

Removed multisite conditional from WPSEO_Options_MS definition (break…

3bc7168

…s autoload).

Added composer install to travis before script.

d0e2123

Extended WPSEO_Option_MS constructor with conditional check.

f9b6d68

Updated module dependency branches in composer.json

418ab7d

Excluded vendor directory from PHP lint check.

c3664d8

Updated exclusions in code sniffer configuration to exclude vendor.

Loading status checks…

90d5a9a

Reapplied coding style, lost in rebase.

Loading status checks…

d897c47

Committed composer.lock file.

Loading status checks…

75e38f4

jrfnl reviewed Jan 20, 2015
View changes

Rarst added 2 commits Jan 21, 2015

Implemented explicit conditional skip for multisite only options inst…

Loading status checks…

0decfde

…ances.

Adjusted option instances logic.

Loading status checks…

797d603

jdevalk reviewed Jan 22, 2015
View changes

composer.json Outdated

"license": "GPL-2.0+",

"authors": [

{

"name": "Joost de Valk",

This comment has been minimized.

Sign in to view

jdevalk Jan 22, 2015 Member

This needs to be Team Yoast :)

Updated authors section in composer.json

Loading status checks…

44aa333

Updated readme with Composer instructions.

Loading status checks…

7f92e03

Updated lock file's hash to fix outdated warning.

Loading status checks…

53b8bd3

jdevalk added a commit that referenced this pull request Jan 29, 2015

Merge pull request #1912 from Rarst/composer

Loading status checks…

3686346

Composer implementation for dependencies and autoload

jdevalk merged commit 3686346 into Yoast:trunk Jan 29, 2015
1 check passed

1 check passed

continuous-integration/travis-ci The Travis CI build passed
Details

Rarst deleted the Rarst:composer branch Jan 29, 2015

Yoast / wordpress-seo

Composer implementation for dependencies and autoload #1912

Composer implementation for dependencies and autoload #1912

Rarst commented Jan 16, 2015

Rarst commented Jan 16, 2015

Rarst commented Jan 19, 2015

jdevalk commented Jan 19, 2015

Rarst commented Jan 20, 2015

jrfnl commented Jan 20, 2015

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

jdevalk commented Jan 21, 2015

Rarst commented Jan 22, 2015

This comment has been minimized.

jdevalk commented Jan 22, 2015

omarreiss commented Jan 22, 2015

Rarst commented Jan 22, 2015

omarreiss commented Jan 22, 2015

Rarst commented Jan 26, 2015

Rarst commented Jan 29, 2015

omarreiss commented Jan 29, 2015

jrfnl commented Jan 29, 2015

jdevalk commented Jan 29, 2015

Yoast / wordpress-seo

Join GitHub today

Composer implementation for dependencies and autoload #1912

Composer implementation for dependencies and autoload #1912

Conversation

Rarst commented Jan 16, 2015

Rarst commented Jan 16, 2015

Rarst commented Jan 19, 2015

jdevalk commented Jan 19, 2015

Rarst commented Jan 20, 2015

jrfnl commented Jan 20, 2015

This comment has been minimized.

jrfnl Jan 20, 2015 Contributor

This comment has been minimized.

Rarst Jan 20, 2015 Author Contributor

This comment has been minimized.

jrfnl Jan 20, 2015 Contributor

This comment has been minimized.

jdevalk Jan 21, 2015 Member

This comment has been minimized.

Rarst Jan 21, 2015 Author Contributor

This comment has been minimized.

jrfnl Jan 21, 2015 Contributor

This comment has been minimized.

Rarst Jan 21, 2015 Author Contributor

This comment has been minimized.

jrfnl Jan 21, 2015 Contributor

This comment has been minimized.

Rarst Jan 21, 2015 Author Contributor

This comment has been minimized.

jrfnl Jan 21, 2015 Contributor

jdevalk commented Jan 21, 2015

Rarst commented Jan 22, 2015

This comment has been minimized.

jdevalk Jan 22, 2015 Member

jdevalk commented Jan 22, 2015

omarreiss commented Jan 22, 2015

Rarst commented Jan 22, 2015

omarreiss commented Jan 22, 2015

Rarst commented Jan 26, 2015

Rarst commented Jan 29, 2015

omarreiss commented Jan 29, 2015

jrfnl commented Jan 29, 2015

jdevalk commented Jan 29, 2015