Menu

Chef Supermarket

Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

View our collection of guides, documentation, and articles

Cookbooks
Advanced Options

Select Badges

Select Supported Platforms

Select Status

RSS

composer (31) Versions 3.0.1

Installs/Configures Composer

Policyfile
Berkshelf
Knife 
cookbook 'composer', '~> 3.0.1', :supermarket
cookbook 'composer', '~> 3.0.1'
knife supermarket install composer
knife supermarket download composer
README
Dependencies
Quality 50%

composer cookbook

Description

This cookbook provides an easy way to install Composer, a dependency manager for PHP.

More information available at http://getcomposer.org/.

Requirements

⚠ This cookbook does not install PHP! Please make sure PHP is installed before this cookbook is included, e.g. by using the php cookbook.

Cookbooks:

No dependencies.

Platforms:

  • Ubuntu
  • Debian
  • RHEL
  • CentOS
  • Fedora
  • Windows

Attributes

  • node['composer']['url'] - Location of the source
  • node['composer']['install_dir'] - Installation target directory (absolute or relative path) if installing locally
  • node['composer']['bin'] - bin directory
  • node['composer']['install_globally'] - Installation method, :source or :package - default true
  • node['composer']['mask'] - Mask for composer.phar - default 0755
  • node['composer']['link_type'] - link type for composer.phar link - default :symbolic
  • node['composer']['global_configs'] - Hash with global config options for users, eg. { "userX" => { "github-oauth" => { "github.com" => "userX_oauth_token" }, "vendor-dir" => "myvendordir" } } - default {}
  • node['composer']['home_dir'] - COMPOSER_HOME, defaults to nil (in which case install_dir will be used), please do read the Composer documentation on COMPOSER_HOME when setting a custom home_dir
  • node['composer']['global_install']['install_dir'] - The default location to install the packages in for composer_install_global
  • node['composer']['global_install']['bin_dir'] - The default location to symlink the binaries when using composer_install_global

Resources

This cookbook includes resources for managing a Composer project and for installing Composer packages globally:

composer_project

Actions

Action Description
:install Reads the composer.json file from the current directory, resolves the dependencies, and installs them into project directory - this is the default action
:require Create composer.json file using specified package and version and installs it with the dependencies.
:update Gets the latest versions of the dependencies and updates the composer.lock file
:dump_autoload Updates the autoloader without having to go through an install or update (eg. because of new classes in a classmap package)
:remove Removes package from composer.json and uninstalls it

Properties

Name Description
project_dir The directory where your project's composer.json can be found (name attribute)
package The package to require or remove when using those actions
version The version of the package to require or remove when using those actions, default *.*.*. Be careful when uninstalling, the version has to match the installed package!
vendor Can be used to combine package and version, deprecated!
dev Install packages listed in require-dev, default false
quiet Do not output any message, default true
optimize_autoloader Optimize PSR0 packages to use classmaps, default false
prefer_dist use the dist installation method
prefer_source use the source installation method
bin_dir overwrites the composer bin dir
user the user to use when executing the composer commands
group the group to use when executing the composer commands
umask the umask to use when executing the composer commands
environment A hash of environment variables that will be available when running composer

Examples

# Install the project dependencies
composer_project "/path/to/project" do
  dev false
  quiet true
  prefer_dist false
  action :install
end

# Require the package in the project dir
composer_project "/path/to/project" do
  package 'vendor/package'
  version '*.*.*'
  dev false
  quiet true
  prefer_dist false
  action :require
end

# Update the project dependencies
composer_project "/path/to/project" do
  dev false
  quiet true
  action :update
end

# Dump-autoload in the project dir
composer_project "/path/to/project" do
  dev false
  quiet true
  action :dump_autoload
end

# Remove the package in the project dir
composer_project "/path/to/project" do
  package 'vendor/package'
  action :remove
end

composer_install_global

Actions

Action Description
:install Installs the package in the preferred global composer directory, putting binary symlinks in the preferred global binary directory (see attributes)
:update Gets the latest versions of the dependencies and updates the composer.lock file for the globally installed composer packages
:remove Removes package from the global composer.json and uninstalls it

Attribute parameters

Property Description
package The package to install or remove, name_attribute
version The version of the package to install or remove when using those actions, default *.*.*. Be careful when uninstalling, the version has to match the installed package!
install_dir the directory in which to make the global installation, default: see the attributes
bin_dir the directory in which to make the symlinks to the binaries, default: see the attributes
dev Install packages listed in require-dev, default false
quiet Do not output any message, default true
optimize_autoloader Optimize PSR0 packages to use classmaps, default false
prefer_dist use the dist installation method
prefer_source use the source installation method

Examples

# Install a package globally
composer_install_global "package" do
  version '~4.1'
  action :install
end

# Update the package
composer_install_global "package" do
  action :update
end

# Remove the package from the global installation
composer_install_global "package" do
  action :remove
end

Usage

  1. Make sure PHP is installed (e.g. include the php::default recipe)
  2. Set custom values for any attributes in a wrapper recipe / node data
  3. Include composer::default in your wrapper recipe / run list
  4. Use composer_project and composer_install_global in your recipes

References

License and Authors

Author: David Joos development@davidjoos.com
Copyright: 2016-2022, David Joos

Author: David Joos david.joos@escapestudios.com
Author: Escape Studios Development dev@escapestudios.com
Copyright: 2012-2015, Escape Studios

Unless otherwise noted, all files are released under the MIT license,
possible exceptions will contain licensing information in them.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

applications Applicable Versions
applications 0.0.1
boilerplate_php Applicable Versions
boilerplate_php 0.1.0
boilerplate_php 0.2.0
boilerplate_php 0.3.0
boilerplate_php 0.3.2
boilerplate_php 0.4.0
boilerplate_php 0.4.1
boilerplate_php 0.4.2
boilerplate_php 0.4.3
boilerplate_php 0.4.4
boilerplate_php 0.4.5
boilerplate_php 0.4.7
boilerplate_php 0.5.0
boilerplate_php 0.5.1
boilerplate_php 0.5.2
boilerplate_php 0.5.3
boilerplate_php 0.5.4
drupal-cookbook Applicable Versions
drupal-cookbook 0.1.0
drupal-cookbook 0.1.1
drupal-cookbook 0.1.2
drupal-cookbook 0.1.3
drupal-cookbook 0.1.4
drupal-cookbook 0.1.5
drupal-cookbook 0.1.6
jenkins-server Applicable Versions
jenkins-server 0.3.0
jenkins-server 0.3.1
jenkins-server 0.3.2
jenkins-server 0.4.0
jenkins-server 0.5.0
jenkins-server 0.5.1
jenkins-server 0.5.2
jenkins-server 0.5.3
jenkins-server 0.5.4
jenkins-server 0.5.5
jenkins-server 0.6.0
jenkins-server 0.7.0
jenkins-server 0.7.1
jenkins-server 0.7.2
jenkins-server 0.7.3
jenkins-server 0.7.4
jenkins-server 0.7.5
jenkins_drupal Applicable Versions
jenkins_drupal 0.1.4
jenkins_drupal 0.1.5
laravel Applicable Versions
laravel 1.0.0
opencart Applicable Versions
opencart 0.1.0
opencart 0.1.1
opencart 0.1.2
pagekit Applicable Versions
pagekit 0.1.0
pdepend Applicable Versions
pdepend 0.0.1
pdepend 0.0.2
pdepend 0.0.3
pdepend 0.0.4
pdepend 1.0.0
pdepend 1.1.0
pdepend 1.2.0
pdepend 1.2.1
phing Applicable Versions
phing 0.0.3
phpcb Applicable Versions
phpcb 1.1.0
phpcb 1.1.1
phpcpd Applicable Versions
phpcpd 0.0.1
phpcpd 0.0.2
phpcpd 1.0.0
phpcpd 1.1.0
phpcpd 1.1.1
phpcs Applicable Versions
phpcs 0.0.1
phpcs 0.0.2
phpcs 0.0.3
phpcs 0.0.4
phpcs 0.0.5
phpcs 0.0.6
phpcs 1.0.1
phpcs 1.1.0
phpcs 1.1.1
phpcs 1.2.0
phpcs 1.3.0
phpcs 1.3.1
phpcs 1.4.0
phpcs 1.4.1
phpdcd Applicable Versions
phpdcd 0.0.1
phpdcd 0.0.2
phpdcd 1.1.0
phpdcd 1.1.1
phpdoc Applicable Versions
phpdoc 1.1.0
phpdoc 1.1.1
phploc Applicable Versions
phploc 0.0.1
phploc 0.0.2
phploc 0.0.3
phploc 0.0.4
phploc 0.0.5
phploc 0.0.6
phploc 0.0.7
phploc 2.0.0
phploc 2.0.1
phploc 2.1.0
phploc 2.1.1
phpmd Applicable Versions
phpmd 0.0.1
phpmd 0.0.2
phpmd 0.0.3
phpmd 0.0.4
phpmd 0.0.5
phpmd 0.0.6
phpmd 0.1.0
phpmd 0.1.1
phpunit Applicable Versions
phpunit 0.0.1
phpunit 0.0.2
phpunit 0.0.3
phpunit 0.0.4
phpunit 0.0.5
phpunit 0.0.6
phpunit 0.0.7
phpunit 0.0.8
phpunit 0.0.9
phpunit 1.0.0
phpunit 1.0.1
phpunit 1.0.2
phpunit 1.1.0
phpunit 1.1.1
snipe-it Applicable Versions
snipe-it 0.1.0
symfony Applicable Versions
symfony 2.0.6
zarafa-sabre Applicable Versions
zarafa-sabre 1.0.0

Collaborator Number Metric 
            
3.0.1 passed this metric

Contributing File Metric 
            
3.0.1 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Foodcritic Metric 
            
3.0.1 passed this metric

No Binaries Metric 
            
3.0.1 passed this metric

Testing File Metric 
            
3.0.1 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric 
            
3.0.1 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number

David Joos David Joos
Escape Studios Development
Dieter Blomme

Details

View Source View Issues

Updated March 25, 2022 Created on

Supported Platforms

  • centos >= 0.0.0
  • fedora >= 0.0.0
  • debian >= 0.0.0
  • ubuntu >= 0.0.0
  • redhat >= 0.0.0
  • scientific >= 0.0.0
  • windows >= 0.0.0
  • amazon >= 0.0.0
  • centos_stream >= 0.0.0

License

MIT

Required Chef Infra Client

(>= 15.3)

Download Cookbook