Managing Dependencies with Composer (LakeKenoshaPHP September 2013)

Traditionally, managing third-party code in PHP projects has not been a trivial task. Fortunately, the PHP community now has Composer (https://getcomposer.org/), a top-notch dependency manager. Learn what Composer is and how you can put it to work for fun and profit. You will see how to set up a new project, find packages, as well as how to create and distribute your own packages.

Transcript

1. Managing Dependencies with Composer www.LakeKenoshaPHP.com September 17th, 2013
2. @beausimensen  simensen  beau.io  Beau Simensen
3. dflydev 
5. Dependency Manager for PHP
6. Dependencies Are External Requirements
7. Traditionally, Managing Dependencies Has Not Been Trivial
8. { “name”: “acme/my-project”, “description”: “Acme’s My Project”, “license”: “MIT”, “require”: { “silex/silex”: “1.1.*” }, “autoload”: { “psr-0”: { “Acme\\MyProject\\”: “src” } } }
9. Autoloading Versioning Packaging
10. Autoloading Versioning Packaging
11. // // life without autoloading // require “../vendor/whizbang/classes.php”; $service = new Acme\WhizBang\Thing()
12. // // life WITH autoloading // $service = new Acme\WhizBang\Thing()
13. // // Example autoloader that will load any fully qualified // class name in the Foo\Bar namespace. If someone tries // to load Foo\Bar\Baz, this autoloader will attempt to // include a file named src/Baz.php which is expected to // define Foo\Bar\Baz. // spl_autoload_register(function ($fqcn) { $prefix = 'Foo\\Bar\\'; $class = ltrim($class, '\\'); if (strncmp($prefix, $class, strlen($prefix)) === 0) { $relative = substr($class, strlen($prefix)); $file = __DIR__ . '/src/' . str_replace('\\', '/', $relative) . '.php'; if (is_readable($file)) { include $file; } } });
14. // // life when everyone has their own custom // autoloader bootstrap, registration classes // and manually configuring class loaders // require “../vendor/whizbang/bootstrap.php”; require “../vendor/awesomesoft/bootstrap.php”; require “../vendor/lessawesome/bootstrapper.php”; require “../vendor/ultraframework/classloader.php”; LessAwesome\BootStrapper::register(); UltraFramework\ClassLoader::register(array( “\\Acme\\MyApp\\” = “../src” ));
15. Composer Provides a Configurable Autoloader
16. Each Package Can Configure Its Own Autoloader Rules
17. require “vendor/autoload.php”;
18. Autoloading Versioning Packaging
19. Semantic Versioning http://semver.org/
20. MAJOR.MINOR.PATCH Which number do you increment and why?
21. MAJOR.MINOR.PATCH When you make API incompatible changes
22. MAJOR.MINOR.PATCH When you add backwards-compatible functionality
23. MAJOR.MINOR.PATCH When you make backwards-compatible bug fixes
24. Pre-Release Identifiers (Composer “Stability”) •1.0.0-alpha •1.0.0-beta.1 •1.0.0-RC2 •1.0.0 (stable)
25. Exact Versions 1.0.2
26. Ranges >=1.0,<2.0
27. Wildcards 1.0.*
28. Next Significant Release Tilde Operator
29. Next Significant Release ~1.2 >=1.2,<2.0
30. Next Significant Release ~1.2.3 >=1.2.3,<1.3
31. Let’s You Know What You Are Getting Into
32. Safe 1.3.* Only get bug fixes.
33. Reasonably Safe 1.* Get bug fixes and new features.
34. Crazy Sauce * Composer allows this, but don’t. Just don’t.
35. Other Version Schemes Can Be Used But don’t expect Composer to read your mind and do anything smart with them.
36. Autoloading Versioning Packaging
37. Any VCS Repository Can Be Treated like a Composer Package
38. Composer Treats Tags as Versions for VCS Repositories
39. GitHub and BitBucket Serve Tags as Archives
40. silex-1.0.1.tar.gz
41. • Integration into existing VCS workflow • Packaging is as simple as tagging and pushing • Hosting can be handled automatically by GitHub and BitBucket VCS Repository Benefits
42. https://packagist.org
43. Over 16,000 Packages
45. Basic Usage Managing dependencies for a project.
46. Install Composer http://getcomposer.org/download
47. $ curl -sS https://getcomposer.org/installer | php $ php composer.phar --version
48. $ chmod 755 composer.phar $ mv composer.phar ~/bin/composer $ composer --version
49. $ composer diag Check for common errors.
50. composer.json
51. { “name”: “acme/my-project”, “description”: “Acme’s My Project”, “license”: “MIT”, “require”: { “silex/silex”: “1.1.*” }, “autoload”: { “psr-0”: { “Acme\\MyProject\\”: “src” } } }
52. { “name”: “acme/my-project”, “description”: “Acme’s My Project”, “license”: “MIT”, “require”: { “silex/silex”: “1.1.*” }, “autoload”: { “psr-0”: { “Acme\\MyProject\\”: “src” } } }
53. vendor/project-name
54. { “name”: “acme/my-project”, “description”: “Acme’s My Project”, “license”: “MIT”, “require”: { “silex/silex”: “1.1.*” }, “autoload”: { “psr-0”: { “Acme\\MyProject\\”: “src” } } }
55. { “name”: “acme/my-project”, “description”: “Acme’s My Project”, “license”: “MIT”, “require”: { “silex/silex”: “1.1.*” }, “autoload”: { “psr-0”: { “Acme\\MyProject\\”: “src” } } }
56. $ composer validate Checks composer.json for errors.
57. Autoload Configuration
58. PSR-0 PHP Framework Interoperability Group http://php-fig.com
59. PSR-0’s Big Ideas • 1:1 mapping between fully qualified class names and the filesystem (one file / class) • Embrace namespaces • Support some legacy naming conventions
60. { “autoload”: { “psr-0”: { “Acme\\MyProject\\”: “src” } } }
61. { “autoload”: { “psr-0”: { “Acme\\MyProject\\”: “src” } } } $bar = new Acme\MyProject\Foo\Bar();
62. { “autoload”: { “psr-0”: { “Acme\\MyProject\\”: “src” } } } $bar = new Acme\MyProject\Foo\Bar(); src/Acme/MyProject/Foo/Bar.php
63. PSR-4 PHP Framework Interoperability Group (Coming Soon!) http://php-fig.com
64. PSR-4’s Big Ideas • 1:1 mapping between a part of fully qualified class names and the filesystem (one file / class) • Minimize the number of extra directories that PSR-0 required • Drop support for legacy naming conventions that PSR-0 supported
65. { “autoload”: { “psr-4”: { “Acme\\MyProject\\”: “src” } } }
66. { “autoload”: { “psr-4”: { “Acme\\MyProject\\”: “src” } } } $bar = new Acme\MyProject\Foo\Bar();
67. { “autoload”: { “psr-4”: { “Acme\\MyProject\\”: “src” } } } $bar = new Acme\MyProject\Foo\Bar(); src/Foo/Bar.php
68. // // Example autoloader that will load any fully qualified // class name in the Foo\Bar namespace. If someone tries // to load Foo\Bar\Baz, this autoloader will attempt to // include a file named src/Baz.php which is expected to // define Foo\Bar\Baz. // // This is PSR-4 in a nutshell. // spl_autoload_register(function ($fqcn) { $prefix = 'Foo\\Bar\\'; $class = ltrim($class, '\\'); if (strncmp($prefix, $class, strlen($prefix)) === 0) { $relative = substr($class, strlen($prefix)); $file = __DIR__ . '/src/' . str_replace('\\', '/', $relative) . '.php'; if (is_readable($file)) { include $file; } } });
69. Files Explicitly include certain files
70. { “autoload”: { “files”: [ “src/foo.class.php”, “src/bar.class.php” ] } }
71. { “autoload”: { “files”: [“src/functions.php”] } }
72. { “autoload”: { “files”: [“src/autoload.php”] } }
73. Classmap Generates a single key => value map classes found by scanning for .php and .inc files in specified directories
74. { “autoload”: { “classmap”: [ “src/includes/”, “resources/config.php” ] } }
75. composer.lock
76. $ composer install If composer.lock does not exist, it installs from composer.json and creates composer.lock. If composer.lock exists, it installs from there.
77. $ composer update Installs dependencies from composer.json and creates or updates composer.lock.
78. Stability
79. { “require”: { “silex/silex”: “~1.1@dev”, “symfony/http-foundation”: “@beta” } }
80. Stability Comes From Root Project
81. { “require”: { “silex/silex”: “~1.1@dev”, “symfony/http-foundation”: “@beta” }, “minimum-stability”: “alpha” }
82. Library Project Usage Maintaining a reusable Composer package.
83. Version Constraint Considerations
84. If the dependency specifications are too tight, you are in danger of version lock (the inability to upgrade a package without having to release new versions of every dependent package). — Semantic Versioning http://semver.org/
85. If dependencies are specified too loosely, you will inevitably be bitten by version promiscuity (assuming compatibility with more future versions than is reasonable). — Semantic Versioning http://semver.org/
86. { “require”: { “dflydev/doctrine-orm-service-provider”: “1.0.*”, “silex/silex”: “1.1.*”, “pimple/pimple”: “1.1.*”, “doctrine/orm”: “2.4.*” } } { “name”: “silex/silex”, “require”: { “pimple/pimple”: “1.*” } } { “name”: “dflydev/doctrine-orm-service-provider”, “require”: { “pimple/pimple”: “1.*”, “doctrine/orm”: “~2.3” } }
87. Branch Stability dev-master and @dev
88. { “require”: { “silex/silex”: “1.1@dev”, “pimple/pimple”: “dev-master” } }
89. Branch Versions Composer automatically detects numbered branches as development versions. Branch named 2.0 is treated as 2.0.*@dev
90. Branch Aliases Composer can alias a named branch to a specific development version. Branch named master is treated as 2.0.*@dev
91. { “extra”: { “branch-alias”: { “dev-master”: “2.0.x-dev” } } }
92. Dev Dependencies
93. { “require-dev”: { “phpunit/phpunit”: “3.7.*”, “acme/specialized”: “1.*” } }
94. • It is best to rely on version detection using tags and branches • There is a version key but do not use it • Composer skips branches and tags that do not have composer.json so you won’t magically get legacy versions VCS Repository Version Detection Gotchas
95. Solver
96. Solver A C B I H 1.* ~2.3 D F E G 1.* 1.4.* >=2.3.5 J K 1.4.10
97. Questions? #composer #sculpin #silex-php #dflydev @beausimensen 