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.

Select Badges

Select Supported Platforms

RSS

composer (27) Versions 2.6.0

Installs/Configures Composer

Berkshelf/Librarian
Policyfile
Knife
cookbook 'composer', '= 2.6.0'
cookbook 'composer', '= 2.6.0', :supermarket
knife cookbook site install composer
knife cookbook site download composer
README
Dependencies
Quality

Build Status

 composer cookbook

 Description

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

More information? http://getcomposer.org/

 Requirements

Cookbooks:

  • php
  • windows

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 - 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']['php_recipe'] - The php recipe to include, defaults to "php::default"
  • 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 / Providers

This cookbook includes an LWRP for managing a Composer project and one for a global installation of composer packages

composer_project

Actions

  • :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

Attribute parameters

  • 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

  • :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

  • 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. include recipe[composer] in a run list
  2. tweak the attributes via attributes/default.rb --- OR --- override the attribute on a higher level

 References

 License and Authors

Author: David Joos development@davidjoos.com Copyright: 2016, 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

windows >= 0.0.0
php >= 0.0.0
apt >= 0.0.0

Contingent cookbooks

applications Applicable Versions
boilerplate_php Applicable Versions
drupal-cookbook Applicable Versions
jenkins-server Applicable Versions
jenkins_drupal Applicable Versions
laravel Applicable Versions
opencart Applicable Versions
pagekit Applicable Versions
pdepend Applicable Versions
phing Applicable Versions
phpcb Applicable Versions
phpcpd Applicable Versions
phpcs Applicable Versions
phpdcd Applicable Versions
phpdoc Applicable Versions
phploc Applicable Versions
phpmd Applicable Versions
phpunit Applicable Versions
symfony Applicable Versions
zarafa-sabre Applicable Versions

Collaborator Number Metric
            

2.6.0 passed this metric

Contributing File Metric
            

2.6.0 passed this metric

Foodcritic Metric
            

2.6.0 failed this metric

FC066: Ensure chef_version is set in metadata: composer/metadata.rb:1
FC074: LWRP should use DSL to define resource's default action: composer/resources/install_global.rb:1
FC074: LWRP should use DSL to define resource's default action: composer/resources/project.rb:1
Run with Foodcritic Version 11.1.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any

License Metric
            

2.6.0 passed this metric

No Binaries Metric
            

2.6.0 passed this metric

Publish Metric
            

2.6.0 passed this metric

Supported Platforms Metric
            

2.6.0 passed this metric

Testing File Metric
            

2.6.0 passed this metric

Version Tag Metric
            

2.6.0 passed this metric