composer the right way

Composerthe right way

@rdohmsRafael Dohms

photo: smileymanwithahat

photo: Rob Allen

The Composer Cookbookhttps://leanpub.com/composer-cookbook

https://leanpub.com/composer-cookbook

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!

discovery Packagist

"


composer.lock!

discovery sourcePackagist

"

Repository

#


composer.lock!

discovery source

installation

Packagist

"

Vendor Folder

$

Repository

#


composer.lock!

$ composer init

Library Publisher

$ composer init

Library Publisher

$ composer require <vendor>/<package>

Library Consumer

$ composer require monolog/monologUsing version ~1.11 for 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

Tag it and Bag it

Library Publisher Tagging

# Simple Tag$ git tag v1.2.3 !!!# Annotated Tag $ git tag -a v1.2.3 -m “Description of Release"

Library Publisher “I'm out"

photo: jilliancorinne


Click here and provide another


coming soon

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.0, <1.3


~1.2.3>=1.2.0, <1.3


)

"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

*~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


Deploying a new release of your application to production.

?

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

Your application

$

Public Repository

#


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

check latest compatible release

update



commit your lock file


$ composer update --lock

Tip

Pick the correct version

Library Consumer Version Selection


dev-master

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.


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" } ]

+


$ composer show -v symfony/symfony

Tip


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


Production Server

-

Packagist

.


Production Server

-

Packagist

.

/ Man in the middle


Build Server

0

Production Server

-

"

Packagist

.

/ Man in the middle


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

,



,

1 Install same versions

1 Uses information defined in the composer.lock file



,



,

1 Downloads distribution packages

1 Can use local cache for previously downloaded

1 No git required



,



,

1 Avoids download unnecessary developer libraries



,



,

1 Generates classmap from PSR-0/4 autoloaders

1 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 Private Packages and Proxy

Satis and Toran

composer Packagist

"

Your application

$

Public Repository

#


composer

Packagist

"

Your application

$

Public Repository

#

Satis / Toran

"

Private Repository

2

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


3 my-js-library

4



3 my-js-library! package.json

4



3 my-js-library! package.json

! bower.json

4



3 my-js-library

! composer.json

! package.json

! bower.json

4



3 my-js-library

! composer.json

! package.json

! bower.json

! .gemspec

4



3 my-js-library

! composer.json

! package.json

! bower.json

! .gemspec

4

/

/


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/11878

Thank you.any questions?

5 http://slides.doh.ms

6 http://doh.ms

7 @rdohms

https://joind.in/11878

http://slides.doh.ms

http://doh.ms

composer the right way

Engineering