Composer The Right Way - 010PHP

Composerthe right way

@rdohmsRafael Dohms

photo: smileymanwithahat

photo: Rob Allen

jobs.usabilla.comWe are hiring!

photo: 18millionpixels

Library Publisher


Library Publisher

Library Consumer


Library Publisher

Library

Library Consumer


Library Publisher

Library

Library Consumer

Packagist



{ "require": { "monolog/monolog": “2.0” }}



{ "name": “monolog/monolog”

...}




...}

./composer.json has been updatedLoading composer repositories with package informationUpdating dependencies (including require-dev)Your requirements could not be resolved to an installable set of packages.

Problem 1 - The requested package monolog/monolog could not be found in any version, there may be a typo in the package name.

Potential causes: - A typo in the package name - The package is not available in a stable-enough version according to your minimum-stability setting see <https://groups.google.com/d/topic/composer-dev/_g3ASeIFlrc/discussion> for more details.

Read <http://getcomposer.org/doc/articles/troubleshooting.md> for further common problems.

Installation failed, reverting ./composer.json to its original content.




...}






___~1.1




...}






./composer.json has been updatedLoading composer repositories with package informationUpdating dependencies (including require-dev) - Installing psr/log (1.0.0) Loading from cache

- Installing monolog/monolog (1.11.0) Downloading: 100%

monolog/monolog suggests installing graylog2/gelf-php (Allow sending log messages to a GrayLog2 server)[...]monolog/monolog suggests installing ext-mongo (Allow sending log messages to a MongoDB server)monolog/monolog suggests installing aws/aws-sdk-php (Allow sending log messages to AWS services like DynamoDB)monolog/monolog suggests installing rollbar/rollbar (Allow sending log messages to Rollbar)Writing lock fileGenerating autoload files

___~1.1


composer

composercomposer.json!


composer.lock!


composer.lock!

discovery Packagist

"


composer.lock!

discovery sourcePackagist

"

Repository

#


composer.lock!

discovery source

installation

Packagist

"

Vendor Folder

$

Repository

#


composer.lock!

$ composer self-update

Production

$ composer self-update --snapshot

Development

$ composer self-update --preview

CI / Build

$ composer init

Library Publisher

$ composer init

Library Publisher

$ composer require <vendor>/<package>

Library Consumer

Install instructions


1. Edit your composer.json


1. Edit your composer.json2. Add `package/vendor`


1. Edit your composer.json2. Add `package/vendor`3. Run `composer update`


1. Edit your composer.json2. Add `package/vendor`3. Run `composer update`

or was that install? err… i can’t remember.

$ composer require monolog/monolog

Tip


Tip

Using version ^1.11 for monolog/monolog

$ composer require monolog/monolog --sort-packages

Tip


--prefer-stable--prefer-lowest--no-scripts

Tip

$ composer remove monolog/monolog

Tip

Library PublishersComposer for

Library Publisher Unique vendor names

vendor / package


pick your own unique vendor


or join a collective

README!

CHANGELOG%

LICENSE&

Library Publisher What’s in your library?

README!

CHANGELOG%

LICENSE&


' What problem does it solve?' Usage examples' Install instructions' How can I contribute?

README!

CHANGELOG%

LICENSE&


' List relevant changes' Make BC breaks prominent' Show examples of how to upgrade


README!

CHANGELOG%

LICENSE&


' List relevant changes' Make BC breaks prominent' Show examples of how to upgrade

' Pick one that reflects your values' choosealicense.com can help


Library Publisher Semantic Versioning

1 . 2 3.major minor patch



Bug Fixes



New Features Bug Fixes



API / BC Breaks New Features Bug Fixes

Library Publisher Tagging

Please, tag your releases.

Library Publisher Tagging

Please, tag your releases.

often!

http://phppackagechecklist.com/

The PHP PackageChecklist

Library Publisher The Checklist

Library Publisher “I'm out"

photo: nickwebb



Click here and provide an alternative


Pick the correct version

Library Publisher Pick a Version

*the asteriskLibrary Publisher Pick a Version

*the asterisk○Library Publisher Pick a Version

~the tilde


~1.2>=1.2.0, <2.0.0


~1.2>=1.2.0, <2.0.0


)

~1.2.3>=1.2.3, <1.3


~1.2.3>=1.2.3, <1.3


)

Yo @rdohms, I’m really happy for you and

I’m gonna let you finish, but the tilde operator is

totally old news.

^the caretLibrary Publisher Pick a Version

1.2.3>=1.2.3, <2.0.0


^

1.2.3>=1.2.3, <2.0.0


)

^)

0.3.0>=0.3.0, <0.4.0


^

0.3.0>=0.3.0, <0.4.0


^)

0.3.0>=0.3.0, <0.4.0


^)

Major Version Zero

"require": { "zendframework/zend-stdlib": “2.1.*”, "zendframework/zend-servicemanager": "2.1.*",},

“require-dev": { “phpunit/phpunit": “~3.7”}


"require": { "zendframework/zend-stdlib": “^2.3”, "zendframework/zend-servicemanager": “^2.3",},

“require-dev": { “phpunit/phpunit": “~4”}

3rd party library

Your application






3rd party library

Your application

*






3rd party library

Your application

*






3rd party library

Your application

*

^2.1

Library ConsumersComposer for

Library Consumer Install or update?

install or update?


Make sure you have installed the last updates from other developers.

?

install updateor


Make sure you have installed the last updates from other developers.

?

install updateor


Deploying a new release of your application to production.

?

install updateor


Deploying a new release of your application to production.

?

install updateor


Checked out a new project and want to start coding.

?

install updateor


Checked out a new project and want to start coding.

?

install updateor


Grab new versions for the dependencies of your project.

?

install updateor


Grab new versions for the dependencies of your project.

?

install updateor

Your application

$

Public Repository

#

Library Consumer Behind the scenes with install/update

composer.lock!

composer installcomposer update

Your application

$

Public Repository

#


composer.lock!

read


Your application

$

Public Repository

#


composer.lock!

read grab version


Your application

$

Public Repository

#


composer.lock!

read grab version

check latest compatible release


Your application

$

Public Repository

#


composer.lock!

read grab version


update


Your application

$

Public Repository

#


composer.lock!

read grab version


update


no lock file? composer update

Library Consumer The .lock issue

commit your lock file*



* always! even for libraries! :D



* always! even for libraries! :D** we will discuss that over beer.

Tip

since beta1

Library Consumer Updating interactively

$ composer update —interactive (-i)

Tip

since beta1

Library Consumer Updating interactively

CONFLICT (content): Merge conflict in composer.lockAutomatic merge failed; fix conflicts and then commit the result.

Library Consumer Merge Conflict

CONFLICT (content): Merge conflict in composer.lockAutomatic merge failed; fix conflicts and then commit the result.

Library Consumer Merge Conflict

# First. # Get the valid, clean external version of the lock$ git checkout origin/<target> -- composer.lock composer.json

# Second.# Replay your changes, whatever they were$ composer require <new/package> --update-with-dependencies$ composer update <existing/package>

# Third.# Commit your changes$ git add .$ git commit.

# Profit!

Solving Merge Conflicts

Library Consumer Solving Merge Conflicts

Pick the correct version

Library Consumer Version Selection


dev-master



Tip

since beta1

$ composer why-not <package>

doctrine/doctrine-bundle 1.6.2 requires symfony/framework-bundle (~2.3|~3.0)doctrine/doctrine-cache-bundle 1.3.0 requires symfony/doctrine-bridge (~2.2|~3.0)doctrine/doctrine-fixtures-bundle 2.3.0 requires symfony/doctrine-bridge (~2.3|~3.0)doctrine/doctrine-migrations-bundle dev-master requires symfony/framework-bundle (~2.3|~3.0)doctrine/migrations dev-master requires symfony/yaml (~2.3|~3.0)doctrine/orm v2.5.4 requires symfony/console (~2.5|~3.0)friendsofsymfony/rest-bundle 1.7.7 requires symfony/http-kernel (^2.3.24|~3.0)incenteev/composer-parameter-handler v2.1.2 requires symfony/yaml (~2.3|~3.0)jms/serializer-bundle 1.1.0 requires symfony/framework-bundle (~2.3|~3.0)knplabs/knp-paginator-bundle 2.5.1 requires symfony/framework-bundle (~2.3|~3.0)kriswallsmith/assetic v1.3.2 requires symfony/process (~2.1|~3.0)

Tip

since beta1

$ composer outdated

composer/composer 1.0.3 1.1.0 filp/whoops 2.1.0 2.1.2 justinrainbow/json-schema 1.6.1 2.0.3 nikic/fast-route v0.7.0 v1.0.0 oscarotero/psr7-middlewares v3.14.3 v3.15.1

Tip

Library Consumer Using forks

found a bug?


$ composer install --prefer-source

Tip



patch it,


patch it,fork it,


patch it,fork it,

push it…


patch it,fork it,

push it…wait for it.


patch it,fork it,

push it…wait for it.


symfony/symfony


symfony/symfony

rdohms/symfony


symfony/symfony

rdohms/symfony

"repositories": [ { "type": "vcs", "url": "https://github.com/rdohms/symfony" } ]


symfony/symfony

rdohms/symfony

"repositories": [ { "type": "vcs", "url": "https://github.com/rdohms/symfony" } ]

+


Do not put forked repositories

on packagist

,


"require": { "symfony/symfony": "dev-my-patch as 2.5.0"}

Tip

Library Consumer Composer and deployments

Composer and

production


$ composer install --prefer-dist --no-dev --optimize-autoloader

,



,



,

- Install same versions

- Uses information defined in the composer.lock file



,



,

- Downloads distribution packages

- Can use local cache for previously downloaded

- No git required



,



,

- Avoids download unnecessary developer libraries



,



,

- Generates classmap from PSR-0/4 autoloaders

- Speeds up autoloading

Library Consumer Licensing

$ composer licenses

Name: __root__Version: 1.0.0Licenses: noneDependencies:

doctrine/annotations v1.2.1 MIT doctrine/cache v1.3.1 MIT doctrine/collections v1.2 MIT doctrine/common v2.4.2 MIT doctrine/inflector v1.0 MIT doctrine/lexer v1.0 MIT psr/log 1.0.0 MIT symfony/symfony v2.5.6 MIT twig/twig v1.16.2 BSD-3-Clause

Tip

Library Consumer Simulating Environments

Tip

Production Server

.

Development Server

.


Tip

Production Server

.

Development Server

.PHP 7.0

PHP 5.6


"config": { "platform": { "php": “5.6.2”, “ext-mongodb”: “1.1” } },

Tip

Production Server

.

Development Server

.PHP 7.0

PHP 5.6


$ composer install —-ignore-platform-reqs

Tip

Library Consumer Private Packages and Proxy

Satis and Toran

composer Packagist

"

Your application

$

Public Repository

#


composer

Packagist

"

Your application

$

Public Repository

#

Satis / Toran

"

Private Repository

/

proxy



toranproxy.comprivate repos, automatic packagist proxy

and support composer development

Library Consumer Tooling

$ composer require jquery/jquery

How many of you?



Javascript only Developer


0 my-js-library

1



0 my-js-library! package.json

1



0 my-js-library! package.json

! bower.json

1



0 my-js-library

! composer.json

! package.json

! bower.json

1



0 my-js-library

! composer.json

! package.json

! bower.json

! .gemspec

1



0 my-js-library

! composer.json

! package.json

! bower.json

! .gemspec

1

2

2




Right tool.Right job.

Library Consumer One last thing

One last thing…

Library Consumer pickle!

Library Consumer pickle!

$ pickle install memcache

https://wiki.php.net/rfc/picklehttps://github.com/FriendsOfPHP/pickle

Thank you.

https://joind.in/talk/cc531


Thank you.any questions?

3 http://slides.doh.ms

4 http://doh.ms

5 @rdohms

https://joind.in/talk/cc531


http://slides.doh.ms

http://doh.ms

Composer The Right Way - 010PHP

Software