Dependency management system for PHP 5.3 applications running on *nix using the RocketSled framework
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
README.markdown
autoload.php
dependency.class.php
rocket_pack.class.php

README.markdown

RocketPack - dependency manager for PHP 5.3+

RocketPack is a dependency management system for PHP 5.3+ applications.

Currently it only supports dependencies using git on *nix but we could add additional version control and operating systems in later on.

###NB: If you were already using RocketPack before October 30, 2013, this is a new version that is setup to operate as a completely standalone package independent of RocketSled. If you would like to continue using the previous version, please use release tagged 0.2.2 and before and fork from there.

Goals

  • Work like git submodules without the headaches
  • Allow installation in multiple directories (eg. for shared codebases)
  • Config files written in PHP (for hackability and general configurability)
  • Framework and (repository) language agnostic

Usage

Versioning your packages with RocketPack

Create a rocketpack config file (called, for example, rocketpack.config.php) that looks like this:

<?php
    RocketPack\Dependency::register(function()
    {
        RocketPack\Dependency::into(dirname(__FILE__).'../')
        ->add('https://github.com/iaindooley/Args')
        ->add('https://github.com/iaindooley/Murphy','b5ad86d1193eb7efbe7be3ba26ff5b4e5a0476d4')
        ;
    });

The first argument to the add() method can be anything that can be passed to git clone.

For example you can change the name of the install directory:

    RocketPack\Dependency::register(function()
    {
        RocketPack\Dependency::into(dirname(__FILE__).'../')
        ->add('git@bitbucket.com:company/lowercaserepo CamelCaseRepo')
        ;
    });

The second argument can be anything that can be passed to git checkout. For example:

    RocketPack\Dependency::register(function()
    {
        RocketPack\Dependency::into(dirname(__FILE__).'../')
        ->add('git@bitbucket.com:company/lowercaserepo CamelCaseRepo','-b some-branch origin/some-branch')
        ;
    });

When you install a package with RocketPack it will put a file called .rocketpack in the directory with the repo and version string in it. Any future attempts to install the same repo with a different version will throw an exception of type RocketPack\DependencyException.

You can also chain calls to into() and install things into a bunch of different directories:

RocketPack\Dependency::register(function() use($some_other_dir)
{
    RocketPack\Dependency::into(dirname(__FILE__).'../')
    ->add('https://github.com/iaindooley/Args')
    ->add('https://github.com/iaindooley/Murphy','b5ad86d1193eb7efbe7be3ba26ff5b4e5a0476d4')
    ->add('git@bitbucket.com:company/lowercaserepo CamelCaseRepo')
    ->into($some_other_dir)
    ->add('https://github.com/iaindooley/CrazyHorse')
    ;
});

Installing packages with RocketPack

In order to execute your RocketPack config files, just pass an array of full file paths to one or more RocketPack config files into the RocketPack::install() method:

$packs = array(
    'rocketpack.config.php',
);

RocketPack::install($packs);

NB: the file paths will just be passed into require_once() so you need to make sure you pass in the full file paths.

A complete example

Create a file called rocketpack.config.php that looks like this:

<?php
    RocketPack\Dependency::register(function()
    {
        RocketPack\Dependency::into(dirname(__FILE__))
        ->add('https://github.com/jquery/jquery','1.10.2')
        ;
    });

Create a file called install.php in the same directory that looks like this:

<?php
    require_once('RocketPack/autoload.php');
    $packs = array(
        'rocketpack.config.php',
    );
    
    RocketPack::install($packs);

Recursion

If any of the packages you install contain a file called rocketpack.config.php the install process will be run again recursively.