diff --git a/.gitignore b/.gitignore index 39844871..321de2a3 100644 --- a/.gitignore +++ b/.gitignore @@ -5,4 +5,3 @@ /app/loggerconfig.php /app/pluginconfig.php /app/config.yml -/tests/PHPCI/config.yml diff --git a/LICENSE.md b/LICENSE.md index 4c4f6952..4db5eba9 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,4 +1,7 @@ -Copyright (c) 2013-2014, Block 8 Limited +PHP Censor Copyright (c) 2016, Corpsee +All rights reserved. + +PHPCI Copyright (c) 2013, Block 8 Limited All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/README.md b/README.md index 0b304a8c..7945ada8 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,34 @@ -PHPCI -===== +PHP Censor +---------- -PHPCI is a free and open source (BSD License) continuous integration tool specifically designed for PHP. We've built it with simplicity in mind, so whilst it doesn't do *everything* Jenkins can do, it is a breeze to set up and use. +PHP Censor is a fork of PHPCI (And B8Framework). PHP Censor is a free and open source (BSD-2-Clause license) continuous +integration tool specifically designed for PHP. We've built it with simplicity in mind, so whilst it doesn't +do *everything* Jenkins can do, it is a breeze to set up and use. -**Current Build Status** +What it does +============ -[![Build Status](http://phpci.block8.net/build-status/image/2?branch=master)](http://phpci.block8.net/build-status/view/2?branch=master) - -**Chat Room** - -We have a chat room for discussing PHPCI, you can access it here: [![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/Block8/PHPCI?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=body_badge) - -##What it does: * Clones your project from Github, Bitbucket or a local path * Allows you to set up and tear down test databases. * Installs your project's Composer dependencies. -* Runs through any combination of the [supported plugins](https://www.phptesting.org/wiki#plugins). +* Runs through any combination of the [supported plugins](docs/README.md)). * You can mark directories for the plugins to ignore. * You can mark certain plugins as being allowed to fail (but still run.) -### What it doesn't do (yet): +What it doesn't do (yet) +======================== + * Virtualised testing. * Multiple PHP-version tests. * Install PEAR or PECL extensions. * Deployments - We strongly recommend using [Deployer](http://phpdeployment.org) -## Getting Started: -We've got documentation on our website on [installing PHPCI](https://www.phptesting.org/install-phpci) and [adding support for PHPCI to your projects](https://www.phptesting.org/wiki/Adding-PHPCI-Support-to-Your-Projects). +Documentation +============= -## Contributing -Contributions from others would be very much appreciated! Please read our [guide to contributing](https://github.com/Block8/PHPCI/blob/master/.github/CONTRIBUTING.md) for more information on how to get involved. +[PHP Censor documentation](docs/README.md) -## Questions? -Your best place to go is the [mailing list](https://groups.google.com/forum/#!forum/php-ci). If you're already a member of the mailing list, you can simply email php-ci@googlegroups.com. +License +======= + +The PHP Censor is open source software licensed under the BSD-2-Clause license. diff --git a/app/config.example.yml b/app/config.example.yml index a9f05ab2..6bd101ca 100644 --- a/app/config.example.yml +++ b/app/config.example.yml @@ -3,11 +3,11 @@ b8: servers: read: localhost write: localhost - name: phpci - username: root - password: root -phpci: - url: 'http://phpci.local' + name: php-censor-db + username: php-censor-user + password: php-censor-password +php-censor: + url: 'http://php-censor.local' worker: host: localhost - queue: phpci + queue: php-censor-queue diff --git a/app/phinx.php b/app/phinx.php index 687b9249..e2a5dc7e 100644 --- a/app/phinx.php +++ b/app/phinx.php @@ -18,12 +18,12 @@ if (!is_array($writeServers)) { $conf = [ 'paths' => [ - 'migrations' => 'src/PHPCI/Migrations', + 'migrations' => 'src/PHPCensor/Migrations', ], 'environments' => [ 'default_migration_table' => 'migration', - 'default_database' => 'phpci', - 'phpci' => [ + 'default_database' => 'php-censor', + 'php-censor' => [ 'adapter' => 'mysql', 'host' => end($writeServers), 'name' => $config->get('b8.database.name'), diff --git a/app/pluginconfig.example.php b/app/pluginconfig.example.php index ac5f7724..538d30ff 100644 --- a/app/pluginconfig.example.php +++ b/app/pluginconfig.example.php @@ -1,6 +1,6 @@ registerResource( // This function will be called when the resource is needed. function() { @@ -18,6 +18,6 @@ return function (PHPCI\Plugin\Util\Factory $factory) { "ResourceArray", // The resource will only be given when the type hint is: - PHPCI\Plugin\Util\Factory::TYPE_ARRAY + PHPCensor\Plugin\Util\Factory::TYPE_ARRAY ); }; diff --git a/bin/console b/bin/console index c6de3a00..4d1cddd7 100755 --- a/bin/console +++ b/bin/console @@ -9,21 +9,21 @@ * @link http://www.phptesting.org/ */ -use PHPCI\Command\RunCommand; -use PHPCI\Command\RebuildCommand; -use PHPCI\Command\UpdateCommand; -use PHPCI\Command\InstallCommand; -use PHPCI\Command\DaemonCommand; -use PHPCI\Command\PollCommand; -use PHPCI\Command\CreateAdminCommand; -use PHPCI\Command\CreateBuildCommand; -use PHPCI\Command\WorkerCommand; -use PHPCI\Command\RebuildQueueCommand; -use PHPCI\Service\BuildService; +use PHPCensor\Command\RunCommand; +use PHPCensor\Command\RebuildCommand; +use PHPCensor\Command\UpdateCommand; +use PHPCensor\Command\InstallCommand; +use PHPCensor\Command\DaemonCommand; +use PHPCensor\Command\PollCommand; +use PHPCensor\Command\CreateAdminCommand; +use PHPCensor\Command\CreateBuildCommand; +use PHPCensor\Command\WorkerCommand; +use PHPCensor\Command\RebuildQueueCommand; +use PHPCensor\Service\BuildService; use Symfony\Component\Console\Application; use b8\Store\Factory; -define('PHPCI_IS_CONSOLE', true); +define('IS_CONSOLE', true); require_once(dirname(__DIR__) . '/bootstrap.php'); diff --git a/bin/daemonise b/bin/daemonise index 29314c5f..a5c44011 100755 --- a/bin/daemonise +++ b/bin/daemonise @@ -9,10 +9,10 @@ * @link http://www.phptesting.org/ */ -use PHPCI\Command\DaemoniseCommand; +use PHPCensor\Command\DaemoniseCommand; use Symfony\Component\Console\Application; -define('PHPCI_IS_CONSOLE', true); +define('IS_CONSOLE', true); require_once(dirname(__DIR__) . '/bootstrap.php'); diff --git a/bootstrap.php b/bootstrap.php index 25968cd3..27087f69 100644 --- a/bootstrap.php +++ b/bootstrap.php @@ -7,34 +7,30 @@ * @link http://www.phptesting.org/ */ -use PHPCI\Logging\LoggerConfig; +use PHPCensor\Logging\LoggerConfig; if (!defined('ROOT_DIR')) { define('ROOT_DIR', __DIR__ . DIRECTORY_SEPARATOR); } -if (!defined('PHPCI_DIR')) { - define('PHPCI_DIR', ROOT_DIR . 'src' . DIRECTORY_SEPARATOR . 'PHPCI' . DIRECTORY_SEPARATOR); +if (!defined('SRC_DIR')) { + define('SRC_DIR', ROOT_DIR . 'src' . DIRECTORY_SEPARATOR . 'PHPCensor' . DIRECTORY_SEPARATOR); } -if (!defined('PHPCI_PUBLIC_DIR')) { - define('PHPCI_PUBLIC_DIR', ROOT_DIR . 'public' . DIRECTORY_SEPARATOR); +if (!defined('PUBLIC_DIR')) { + define('PUBLIC_DIR', ROOT_DIR . 'public' . DIRECTORY_SEPARATOR); } -if (!defined('PHPCI_APP_DIR')) { - define('PHPCI_APP_DIR', ROOT_DIR . 'app' . DIRECTORY_SEPARATOR); +if (!defined('APP_DIR')) { + define('APP_DIR', ROOT_DIR . 'app' . DIRECTORY_SEPARATOR); } -if (!defined('PHPCI_BIN_DIR')) { - define('PHPCI_BIN_DIR', ROOT_DIR . 'bin' . DIRECTORY_SEPARATOR); +if (!defined('BIN_DIR')) { + define('BIN_DIR', ROOT_DIR . 'bin' . DIRECTORY_SEPARATOR); } -if (!defined('PHPCI_RUNTIME_DIR')) { - define('PHPCI_RUNTIME_DIR', ROOT_DIR . 'runtime' . DIRECTORY_SEPARATOR); -} - -if (!defined('PHPCI_BUILDS_DIR')) { - define('PHPCI_BUILDS_DIR', ROOT_DIR . 'runtime' . DIRECTORY_SEPARATOR . 'builds' . DIRECTORY_SEPARATOR); +if (!defined('RUNTIME_DIR')) { + define('RUNTIME_DIR', ROOT_DIR . 'runtime' . DIRECTORY_SEPARATOR); } if (!defined('IS_WIN')) { @@ -43,31 +39,31 @@ if (!defined('IS_WIN')) { require_once(ROOT_DIR . 'vendor/autoload.php'); -\PHPCI\ErrorHandler::register(); +\PHPCensor\ErrorHandler::register(); -if (defined('PHPCI_IS_CONSOLE') && PHPCI_IS_CONSOLE) { - $loggerConfig = LoggerConfig::newFromFile(PHPCI_APP_DIR . "loggerconfig.php"); +if (defined('IS_CONSOLE') && IS_CONSOLE) { + $loggerConfig = LoggerConfig::newFromFile(APP_DIR . "loggerconfig.php"); } // Load configuration if present: $conf = []; -$conf['b8']['app']['namespace'] = 'PHPCI'; +$conf['b8']['app']['namespace'] = 'PHPCensor'; $conf['b8']['app']['default_controller'] = 'Home'; -$conf['b8']['view']['path'] = PHPCI_DIR . 'View' . DIRECTORY_SEPARATOR; +$conf['b8']['view']['path'] = SRC_DIR . 'View' . DIRECTORY_SEPARATOR; $config = new b8\Config($conf); -$configFile = PHPCI_APP_DIR . 'config.yml'; +$configFile = APP_DIR . 'config.yml'; if (file_exists($configFile)) { $config->loadYaml($configFile); } -if (!defined('PHPCI_URL') && !empty($config)) { - define('PHPCI_URL', $config->get('phpci.url', '') . '/'); +if (!defined('APP_URL') && !empty($config)) { + define('APP_URL', $config->get('php-censor.url', '') . '/'); } -if (!defined('PHPCI_IS_CONSOLE')) { - define('PHPCI_IS_CONSOLE', false); +if (!defined('IS_CONSOLE')) { + define('IS_CONSOLE', false); } -\PHPCI\Helper\Lang::init($config); +\PHPCensor\Helper\Lang::init($config); diff --git a/composer.json b/composer.json index f6a4ec0c..c6f81f78 100644 --- a/composer.json +++ b/composer.json @@ -1,74 +1,80 @@ { - "name": "block8/phpci", - "description": "Simple continuous integration for PHP projects.", - "minimum-stability": "stable", - "type": "library", - "keywords": ["php", "phpci", "ci", "continuous", "integration", "testing", "phpunit", "continuous integration", "jenkins", "travis"], - "homepage": "http://www.phptesting.org/", - "license": "BSD-2-Clause", - "authors": [ - { - "name": "Dan Cryer", - "email": "dan.cryer@block8.co.uk", - "homepage": "http://www.block8.co.uk", - "role": "Developer" - } - ], - "support": { - "email": "hello+phpci@block8.co.uk", - "issues": "https://github.com/Block8/PHPCI/issues", - "source": "https://github.com/Block8/PHPCI" + "name": "corpsee/php-censor", + "description": "Simple continuous integration for PHP projects. PHPCI fork.", + "minimum-stability": "stable", + "type": "library", + "keywords": ["php", "php-censor", "ci", "continuous integration"], + "homepage": "https://github.com/corpsee/php-censor", + "license": "BSD-2-Clause", + "authors": [ + { + "name": "Corpsee", + "email": "poisoncorpsee@gmail.com", + "homepage": "http://corpsee.com", + "role": "PHP Censor developer" }, - "autoload": { - "psr-4": { - "PHPCI\\": "src/PHPCI/", - "b8\\": "src/B8Framework/" - } - }, - "autoload-dev": { - "psr-4": { - "Tests\\PHPCI\\": "tests/PHPCI/", - "Tests\\b8\\": "tests/B8Framework/" - } - }, - "require": { - "php": ">=5.4.0", - "ext-pdo": "*", - "ext-pdo_mysql": "*", - "ircmaxell/password-compat": "1.0.*", - "swiftmailer/swiftmailer": "5.4.*", - "symfony/yaml": "2.8.*", - "symfony/console": "2.8.*", - "psr/log": "1.0.*", - "monolog/monolog": "1.17.*", - "pimple/pimple": "3.0.*", - "robmorgan/phinx": "0.5.*", - "sensiolabs/ansi-to-html": "1.1.*", - "pda/pheanstalk": "3.1.*" - }, - "require-dev": { - "phpunit/phpunit": "4.8.*", - "phpmd/phpmd": "2.4.*", - "sebastian/phpcpd": "2.0.*", - "squizlabs/php_codesniffer": "2.6.*", - "block8/php-docblock-checker": "1.0.*", - "phploc/phploc": "3.0.*", - "jakub-onderka/php-parallel-lint": "0.9.*" - }, - "suggest": { - "block8/php-docblock-checker": "PHP Docblock Checker", - "phpmd/phpmd": "PHP Mess Detector", - "sebastian/phpcpd": "PHP Copy/Paste Detector", - "squizlabs/php_codesniffer": "PHP Code Sniffer", - "phpspec/phpspec": "PHP Spec", - "fabpot/php-cs-fixer": "PHP Coding Standards Fixer", - "phploc/phploc": "PHP Lines of Code", - "atoum/atoum": "Atoum", - "jakub-onderka/php-parallel-lint": "Parallel Linting Tool", - "behat/behat": "Behat BDD Testing", - "phptal/phptal": "PHPTAL templating engine", - "maknz/slack": "Slack", - "hipchat/hipchat-php": "Hipchat", - "mremi/flowdock": "Flowdock" + { + "name": "Dan Cryer", + "email": "dan.cryer@block8.co.uk", + "homepage": "http://www.block8.co.uk", + "role": "PHPCI developer" } + ], + "support": { + "issues": "https://github.com/corpsee/php-censor/issues", + "source": "https://github.com/corpsee/php-censor" + }, + "autoload": { + "psr-4": { + "PHPCensor\\": "src/PHPCensor/", + "b8\\": "src/B8Framework/" + } + }, + "autoload-dev": { + "psr-4": { + "Tests\\PHPCensor\\": "tests/PHPCensor/", + "Tests\\b8\\": "tests/B8Framework/" + } + }, + "require": { + "php": ">=5.4.0", + "ext-pdo": "*", + "ext-pdo_mysql": "*", + + "ircmaxell/password-compat": "1.0.*", + "swiftmailer/swiftmailer": "5.4.*", + "symfony/yaml": "2.8.*", + "symfony/console": "2.8.*", + "psr/log": "1.0.*", + "monolog/monolog": "1.17.*", + "pimple/pimple": "3.0.*", + "robmorgan/phinx": "0.5.*", + "sensiolabs/ansi-to-html": "1.1.*", + "pda/pheanstalk": "3.1.*" + }, + "require-dev": { + "phpunit/phpunit": "4.8.*", + "phpmd/phpmd": "2.4.*", + "sebastian/phpcpd": "2.0.*", + "squizlabs/php_codesniffer": "2.6.*", + "block8/php-docblock-checker": "1.0.*", + "phploc/phploc": "3.0.*", + "jakub-onderka/php-parallel-lint": "0.9.*" + }, + "suggest": { + "block8/php-docblock-checker": "PHP Docblock Checker", + "phpmd/phpmd": "PHP Mess Detector", + "sebastian/phpcpd": "PHP Copy/Paste Detector", + "squizlabs/php_codesniffer": "PHP Code Sniffer", + "phpspec/phpspec": "PHP Spec", + "fabpot/php-cs-fixer": "PHP Coding Standards Fixer", + "phploc/phploc": "PHP Lines of Code", + "atoum/atoum": "Atoum", + "jakub-onderka/php-parallel-lint": "Parallel Linting Tool", + "behat/behat": "Behat BDD Testing", + "phptal/phptal": "PHPTAL templating engine", + "maknz/slack": "Slack", + "hipchat/hipchat-php": "Hipchat", + "mremi/flowdock": "Flowdock" + } } diff --git a/composer.lock b/composer.lock index bc775fde..81d8965e 100644 --- a/composer.lock +++ b/composer.lock @@ -4,8 +4,8 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file", "This file is @generated automatically" ], - "hash": "1a7e6ffa53784a02d845d40fc34455f1", - "content-hash": "aea45980fd51944fe67aeb4a0677ec88", + "hash": "051fd6b7588f4f8e7d0a838f6a98b892", + "content-hash": "aadffadc413d506fc161c5486c8bd885", "packages": [ { "name": "ircmaxell/password-compat", @@ -262,16 +262,16 @@ }, { "name": "robmorgan/phinx", - "version": "v0.5.3", + "version": "v0.5.5", "source": { "type": "git", "url": "https://github.com/robmorgan/phinx.git", - "reference": "4e7fee7792f4bf3dbf55ee29001850ba26c86a88" + "reference": "da9950a5e5b9314ebf72ddc6317ed587ce9ba8dc" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/robmorgan/phinx/zipball/4e7fee7792f4bf3dbf55ee29001850ba26c86a88", - "reference": "4e7fee7792f4bf3dbf55ee29001850ba26c86a88", + "url": "https://api.github.com/repos/robmorgan/phinx/zipball/da9950a5e5b9314ebf72ddc6317ed587ce9ba8dc", + "reference": "da9950a5e5b9314ebf72ddc6317ed587ce9ba8dc", "shasum": "" }, "require": { @@ -297,17 +297,17 @@ "MIT" ], "authors": [ - { - "name": "Rob Morgan", - "email": "robbym@gmail.com", - "homepage": "http://robmorgan.id.au", - "role": "Lead Developer" - }, { "name": "Woody Gilk", "email": "woody.gilk@gmail.com", "homepage": "http://shadowhand.me", "role": "Developer" + }, + { + "name": "Rob Morgan", + "email": "robbym@gmail.com", + "homepage": "https://robmorgan.id.au", + "role": "Lead Developer" } ], "description": "Phinx makes it ridiculously easy to manage the database migrations for your PHP app.", @@ -319,7 +319,7 @@ "migrations", "phinx" ], - "time": "2016-03-07 14:09:22" + "time": "2016-06-17 15:29:02" }, { "name": "sensiolabs/ansi-to-html", @@ -367,23 +367,23 @@ }, { "name": "swiftmailer/swiftmailer", - "version": "v5.4.1", + "version": "v5.4.3", "source": { "type": "git", "url": "https://github.com/swiftmailer/swiftmailer.git", - "reference": "0697e6aa65c83edf97bb0f23d8763f94e3f11421" + "reference": "4cc92842069c2bbc1f28daaaf1d2576ec4dfe153" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/swiftmailer/swiftmailer/zipball/0697e6aa65c83edf97bb0f23d8763f94e3f11421", - "reference": "0697e6aa65c83edf97bb0f23d8763f94e3f11421", + "url": "https://api.github.com/repos/swiftmailer/swiftmailer/zipball/4cc92842069c2bbc1f28daaaf1d2576ec4dfe153", + "reference": "4cc92842069c2bbc1f28daaaf1d2576ec4dfe153", "shasum": "" }, "require": { "php": ">=5.3.3" }, "require-dev": { - "mockery/mockery": "~0.9.1,<0.9.4" + "mockery/mockery": "~0.9.1" }, "type": "library", "extra": { @@ -416,20 +416,20 @@ "mail", "mailer" ], - "time": "2015-06-06 14:19:39" + "time": "2016-07-08 11:51:25" }, { "name": "symfony/config", - "version": "v3.0.4", + "version": "v3.1.2", "source": { "type": "git", "url": "https://github.com/symfony/config.git", - "reference": "980ee40c28f00acff8906c11b778aab5f0db74c2" + "reference": "bcf5aebabc95b56e370e13d78565f74c7d8726dc" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/config/zipball/980ee40c28f00acff8906c11b778aab5f0db74c2", - "reference": "980ee40c28f00acff8906c11b778aab5f0db74c2", + "url": "https://api.github.com/repos/symfony/config/zipball/bcf5aebabc95b56e370e13d78565f74c7d8726dc", + "reference": "bcf5aebabc95b56e370e13d78565f74c7d8726dc", "shasum": "" }, "require": { @@ -442,7 +442,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "3.0-dev" + "dev-master": "3.1-dev" } }, "autoload": { @@ -469,20 +469,20 @@ ], "description": "Symfony Config Component", "homepage": "https://symfony.com", - "time": "2016-03-04 07:55:57" + "time": "2016-06-29 05:41:56" }, { "name": "symfony/console", - "version": "v2.8.4", + "version": "v2.8.8", "source": { "type": "git", "url": "https://github.com/symfony/console.git", - "reference": "9a5aef5fc0d4eff86853d44202b02be8d5a20154" + "reference": "c392a6ec72f2122748032c2ad6870420561ffcfa" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/console/zipball/9a5aef5fc0d4eff86853d44202b02be8d5a20154", - "reference": "9a5aef5fc0d4eff86853d44202b02be8d5a20154", + "url": "https://api.github.com/repos/symfony/console/zipball/c392a6ec72f2122748032c2ad6870420561ffcfa", + "reference": "c392a6ec72f2122748032c2ad6870420561ffcfa", "shasum": "" }, "require": { @@ -529,20 +529,20 @@ ], "description": "Symfony Console Component", "homepage": "https://symfony.com", - "time": "2016-03-17 09:19:04" + "time": "2016-06-29 07:02:14" }, { "name": "symfony/filesystem", - "version": "v3.0.4", + "version": "v3.1.2", "source": { "type": "git", "url": "https://github.com/symfony/filesystem.git", - "reference": "f82499a459dcade2ea56df94cc58b19c8bde3d20" + "reference": "322da5f0910d8aa0b25fa65ffccaba68dbddb890" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/filesystem/zipball/f82499a459dcade2ea56df94cc58b19c8bde3d20", - "reference": "f82499a459dcade2ea56df94cc58b19c8bde3d20", + "url": "https://api.github.com/repos/symfony/filesystem/zipball/322da5f0910d8aa0b25fa65ffccaba68dbddb890", + "reference": "322da5f0910d8aa0b25fa65ffccaba68dbddb890", "shasum": "" }, "require": { @@ -551,7 +551,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "3.0-dev" + "dev-master": "3.1-dev" } }, "autoload": { @@ -578,20 +578,20 @@ ], "description": "Symfony Filesystem Component", "homepage": "https://symfony.com", - "time": "2016-03-27 10:24:39" + "time": "2016-06-29 05:41:56" }, { "name": "symfony/polyfill-mbstring", - "version": "v1.1.1", + "version": "v1.2.0", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-mbstring.git", - "reference": "1289d16209491b584839022f29257ad859b8532d" + "reference": "dff51f72b0706335131b00a7f49606168c582594" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-mbstring/zipball/1289d16209491b584839022f29257ad859b8532d", - "reference": "1289d16209491b584839022f29257ad859b8532d", + "url": "https://api.github.com/repos/symfony/polyfill-mbstring/zipball/dff51f72b0706335131b00a7f49606168c582594", + "reference": "dff51f72b0706335131b00a7f49606168c582594", "shasum": "" }, "require": { @@ -603,7 +603,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "1.1-dev" + "dev-master": "1.2-dev" } }, "autoload": { @@ -637,20 +637,20 @@ "portable", "shim" ], - "time": "2016-01-20 09:13:37" + "time": "2016-05-18 14:26:46" }, { "name": "symfony/yaml", - "version": "v2.8.4", + "version": "v2.8.8", "source": { "type": "git", "url": "https://github.com/symfony/yaml.git", - "reference": "584e52cb8f788a887553ba82db6caacb1d6260bb" + "reference": "dba4bb5846798cd12f32e2d8f3f35d77045773c8" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/yaml/zipball/584e52cb8f788a887553ba82db6caacb1d6260bb", - "reference": "584e52cb8f788a887553ba82db6caacb1d6260bb", + "url": "https://api.github.com/repos/symfony/yaml/zipball/dba4bb5846798cd12f32e2d8f3f35d77045773c8", + "reference": "dba4bb5846798cd12f32e2d8f3f35d77045773c8", "shasum": "" }, "require": { @@ -686,7 +686,7 @@ ], "description": "Symfony Yaml Component", "homepage": "https://symfony.com", - "time": "2016-03-04 07:54:35" + "time": "2016-06-29 05:29:29" } ], "packages-dev": [ @@ -885,38 +885,87 @@ "time": "2016-03-10 15:15:04" }, { - "name": "phpdocumentor/reflection-docblock", - "version": "2.0.4", + "name": "phpdocumentor/reflection-common", + "version": "1.0", "source": { "type": "git", - "url": "https://github.com/phpDocumentor/ReflectionDocBlock.git", - "reference": "d68dbdc53dc358a816f00b300704702b2eaff7b8" + "url": "https://github.com/phpDocumentor/ReflectionCommon.git", + "reference": "144c307535e82c8fdcaacbcfc1d6d8eeb896687c" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/phpDocumentor/ReflectionDocBlock/zipball/d68dbdc53dc358a816f00b300704702b2eaff7b8", - "reference": "d68dbdc53dc358a816f00b300704702b2eaff7b8", + "url": "https://api.github.com/repos/phpDocumentor/ReflectionCommon/zipball/144c307535e82c8fdcaacbcfc1d6d8eeb896687c", + "reference": "144c307535e82c8fdcaacbcfc1d6d8eeb896687c", "shasum": "" }, "require": { - "php": ">=5.3.3" + "php": ">=5.5" }, "require-dev": { - "phpunit/phpunit": "~4.0" - }, - "suggest": { - "dflydev/markdown": "~1.0", - "erusev/parsedown": "~1.0" + "phpunit/phpunit": "^4.6" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "2.0.x-dev" + "dev-master": "1.0.x-dev" } }, "autoload": { - "psr-0": { - "phpDocumentor": [ + "psr-4": { + "phpDocumentor\\Reflection\\": [ + "src" + ] + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Jaap van Otterdijk", + "email": "opensource@ijaap.nl" + } + ], + "description": "Common reflection classes used by phpdocumentor to reflect the code structure", + "homepage": "http://www.phpdoc.org", + "keywords": [ + "FQSEN", + "phpDocumentor", + "phpdoc", + "reflection", + "static analysis" + ], + "time": "2015-12-27 11:43:31" + }, + { + "name": "phpdocumentor/reflection-docblock", + "version": "3.1.0", + "source": { + "type": "git", + "url": "https://github.com/phpDocumentor/ReflectionDocBlock.git", + "reference": "9270140b940ff02e58ec577c237274e92cd40cdd" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/phpDocumentor/ReflectionDocBlock/zipball/9270140b940ff02e58ec577c237274e92cd40cdd", + "reference": "9270140b940ff02e58ec577c237274e92cd40cdd", + "shasum": "" + }, + "require": { + "php": ">=5.5", + "phpdocumentor/reflection-common": "^1.0@dev", + "phpdocumentor/type-resolver": "^0.2.0", + "webmozart/assert": "^1.0" + }, + "require-dev": { + "mockery/mockery": "^0.9.4", + "phpunit/phpunit": "^4.4" + }, + "type": "library", + "autoload": { + "psr-4": { + "phpDocumentor\\Reflection\\": [ "src/" ] } @@ -928,30 +977,78 @@ "authors": [ { "name": "Mike van Riel", - "email": "mike.vanriel@naenius.com" + "email": "me@mikevanriel.com" } ], - "time": "2015-02-03 12:10:50" + "description": "With this component, a library can provide support for annotations via DocBlocks or otherwise retrieve information that is embedded in a DocBlock.", + "time": "2016-06-10 09:48:41" }, { - "name": "phploc/phploc", - "version": "3.0.0", + "name": "phpdocumentor/type-resolver", + "version": "0.2", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/phploc.git", - "reference": "2917d010fbfd503d9e836cefff249cb3c1b3f17a" + "url": "https://github.com/phpDocumentor/TypeResolver.git", + "reference": "b39c7a5b194f9ed7bd0dd345c751007a41862443" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/phploc/zipball/2917d010fbfd503d9e836cefff249cb3c1b3f17a", - "reference": "2917d010fbfd503d9e836cefff249cb3c1b3f17a", + "url": "https://api.github.com/repos/phpDocumentor/TypeResolver/zipball/b39c7a5b194f9ed7bd0dd345c751007a41862443", + "reference": "b39c7a5b194f9ed7bd0dd345c751007a41862443", + "shasum": "" + }, + "require": { + "php": ">=5.5", + "phpdocumentor/reflection-common": "^1.0" + }, + "require-dev": { + "mockery/mockery": "^0.9.4", + "phpunit/phpunit": "^5.2||^4.8.24" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.0.x-dev" + } + }, + "autoload": { + "psr-4": { + "phpDocumentor\\Reflection\\": [ + "src/" + ] + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Mike van Riel", + "email": "me@mikevanriel.com" + } + ], + "time": "2016-06-10 07:14:17" + }, + { + "name": "phploc/phploc", + "version": "3.0.1", + "source": { + "type": "git", + "url": "https://github.com/sebastianbergmann/phploc.git", + "reference": "74f917e6f80f291856989960d31afa44a4196859" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sebastianbergmann/phploc/zipball/74f917e6f80f291856989960d31afa44a4196859", + "reference": "74f917e6f80f291856989960d31afa44a4196859", "shasum": "" }, "require": { "php": ">=5.6", "sebastian/finder-facade": "~1.1", - "sebastian/git": "~2.0", - "sebastian/version": "~1.0.3", + "sebastian/git": "~2.1", + "sebastian/version": "~1.0.3|~2.0", "symfony/console": "~2.5|~3.0" }, "require-dev": { @@ -984,24 +1081,24 @@ ], "description": "A tool for quickly measuring the size of a PHP project.", "homepage": "https://github.com/sebastianbergmann/phploc", - "time": "2016-01-13 10:20:53" + "time": "2016-04-25 08:11:21" }, { "name": "phpmd/phpmd", - "version": "2.4.2", + "version": "2.4.3", "source": { "type": "git", "url": "https://github.com/phpmd/phpmd.git", - "reference": "fccbdb6b222f6d7a6d35af1c396ba5435cec76a9" + "reference": "2b9c2417a18696dfb578b38c116cd0ddc19b256e" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/phpmd/phpmd/zipball/fccbdb6b222f6d7a6d35af1c396ba5435cec76a9", - "reference": "fccbdb6b222f6d7a6d35af1c396ba5435cec76a9", + "url": "https://api.github.com/repos/phpmd/phpmd/zipball/2b9c2417a18696dfb578b38c116cd0ddc19b256e", + "reference": "2b9c2417a18696dfb578b38c116cd0ddc19b256e", "shasum": "" }, "require": { - "pdepend/pdepend": "~2.0", + "pdepend/pdepend": "^2.0.4", "php": ">=5.3.0" }, "require-dev": { @@ -1049,36 +1146,36 @@ "phpmd", "pmd" ], - "time": "2016-03-10 17:17:44" + "time": "2016-04-04 11:52:04" }, { "name": "phpspec/prophecy", - "version": "v1.6.0", + "version": "v1.6.1", "source": { "type": "git", "url": "https://github.com/phpspec/prophecy.git", - "reference": "3c91bdf81797d725b14cb62906f9a4ce44235972" + "reference": "58a8137754bc24b25740d4281399a4a3596058e0" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/phpspec/prophecy/zipball/3c91bdf81797d725b14cb62906f9a4ce44235972", - "reference": "3c91bdf81797d725b14cb62906f9a4ce44235972", + "url": "https://api.github.com/repos/phpspec/prophecy/zipball/58a8137754bc24b25740d4281399a4a3596058e0", + "reference": "58a8137754bc24b25740d4281399a4a3596058e0", "shasum": "" }, "require": { "doctrine/instantiator": "^1.0.2", "php": "^5.3|^7.0", - "phpdocumentor/reflection-docblock": "~2.0", - "sebastian/comparator": "~1.1", - "sebastian/recursion-context": "~1.0" + "phpdocumentor/reflection-docblock": "^2.0|^3.0.2", + "sebastian/comparator": "^1.1", + "sebastian/recursion-context": "^1.0" }, "require-dev": { - "phpspec/phpspec": "~2.0" + "phpspec/phpspec": "^2.0" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "1.5.x-dev" + "dev-master": "1.6.x-dev" } }, "autoload": { @@ -1111,7 +1208,7 @@ "spy", "stub" ], - "time": "2016-02-15 07:46:21" + "time": "2016-06-07 08:13:47" }, { "name": "phpunit/php-code-coverage", @@ -1265,21 +1362,24 @@ }, { "name": "phpunit/php-timer", - "version": "1.0.7", + "version": "1.0.8", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-timer.git", - "reference": "3e82f4e9fc92665fafd9157568e4dcb01d014e5b" + "reference": "38e9124049cf1a164f1e4537caf19c99bf1eb260" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-timer/zipball/3e82f4e9fc92665fafd9157568e4dcb01d014e5b", - "reference": "3e82f4e9fc92665fafd9157568e4dcb01d014e5b", + "url": "https://api.github.com/repos/sebastianbergmann/php-timer/zipball/38e9124049cf1a164f1e4537caf19c99bf1eb260", + "reference": "38e9124049cf1a164f1e4537caf19c99bf1eb260", "shasum": "" }, "require": { "php": ">=5.3.3" }, + "require-dev": { + "phpunit/phpunit": "~4|~5" + }, "type": "library", "autoload": { "classmap": [ @@ -1302,7 +1402,7 @@ "keywords": [ "timer" ], - "time": "2015-06-21 08:01:12" + "time": "2016-05-12 18:03:57" }, { "name": "phpunit/php-token-stream", @@ -1355,16 +1455,16 @@ }, { "name": "phpunit/phpunit", - "version": "4.8.24", + "version": "4.8.27", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/phpunit.git", - "reference": "a1066c562c52900a142a0e2bbf0582994671385e" + "reference": "c062dddcb68e44b563f66ee319ddae2b5a322a90" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/a1066c562c52900a142a0e2bbf0582994671385e", - "reference": "a1066c562c52900a142a0e2bbf0582994671385e", + "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/c062dddcb68e44b563f66ee319ddae2b5a322a90", + "reference": "c062dddcb68e44b563f66ee319ddae2b5a322a90", "shasum": "" }, "require": { @@ -1378,7 +1478,7 @@ "phpunit/php-code-coverage": "~2.1", "phpunit/php-file-iterator": "~1.4", "phpunit/php-text-template": "~1.2", - "phpunit/php-timer": ">=1.0.6", + "phpunit/php-timer": "^1.0.6", "phpunit/phpunit-mock-objects": "~2.3", "sebastian/comparator": "~1.1", "sebastian/diff": "~1.2", @@ -1423,7 +1523,7 @@ "testing", "xunit" ], - "time": "2016-03-14 06:16:08" + "time": "2016-07-21 06:48:14" }, { "name": "phpunit/phpunit-mock-objects", @@ -1599,16 +1699,16 @@ }, { "name": "sebastian/environment", - "version": "1.3.5", + "version": "1.3.7", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/environment.git", - "reference": "dc7a29032cf72b54f36dac15a1ca5b3a1b6029bf" + "reference": "4e8f0da10ac5802913afc151413bc8c53b6c2716" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/environment/zipball/dc7a29032cf72b54f36dac15a1ca5b3a1b6029bf", - "reference": "dc7a29032cf72b54f36dac15a1ca5b3a1b6029bf", + "url": "https://api.github.com/repos/sebastianbergmann/environment/zipball/4e8f0da10ac5802913afc151413bc8c53b6c2716", + "reference": "4e8f0da10ac5802913afc151413bc8c53b6c2716", "shasum": "" }, "require": { @@ -1645,20 +1745,20 @@ "environment", "hhvm" ], - "time": "2016-02-26 18:40:46" + "time": "2016-05-17 03:18:57" }, { "name": "sebastian/exporter", - "version": "1.2.1", + "version": "1.2.2", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/exporter.git", - "reference": "7ae5513327cb536431847bcc0c10edba2701064e" + "reference": "42c4c2eec485ee3e159ec9884f95b431287edde4" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/exporter/zipball/7ae5513327cb536431847bcc0c10edba2701064e", - "reference": "7ae5513327cb536431847bcc0c10edba2701064e", + "url": "https://api.github.com/repos/sebastianbergmann/exporter/zipball/42c4c2eec485ee3e159ec9884f95b431287edde4", + "reference": "42c4c2eec485ee3e159ec9884f95b431287edde4", "shasum": "" }, "require": { @@ -1666,12 +1766,13 @@ "sebastian/recursion-context": "~1.0" }, "require-dev": { + "ext-mbstring": "*", "phpunit/phpunit": "~4.4" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "1.2.x-dev" + "dev-master": "1.3.x-dev" } }, "autoload": { @@ -1711,7 +1812,7 @@ "export", "exporter" ], - "time": "2015-06-21 07:55:53" + "time": "2016-06-17 09:04:28" }, { "name": "sebastian/finder-facade", @@ -1754,16 +1855,16 @@ }, { "name": "sebastian/git", - "version": "2.1.1", + "version": "2.1.3", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/git.git", - "reference": "38638de3e94830a5cd7a5956135589b967609cd5" + "reference": "5100bc50cd9e70f424c643618e142214225024f3" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/git/zipball/38638de3e94830a5cd7a5956135589b967609cd5", - "reference": "38638de3e94830a5cd7a5956135589b967609cd5", + "url": "https://api.github.com/repos/sebastianbergmann/git/zipball/5100bc50cd9e70f424c643618e142214225024f3", + "reference": "5100bc50cd9e70f424c643618e142214225024f3", "shasum": "" }, "require": { @@ -1795,7 +1896,7 @@ "keywords": [ "git" ], - "time": "2016-02-21 15:02:23" + "time": "2016-06-15 09:30:19" }, { "name": "sebastian/global-state", @@ -1850,23 +1951,23 @@ }, { "name": "sebastian/phpcpd", - "version": "2.0.3", + "version": "2.0.4", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/phpcpd.git", - "reference": "6f868833a18de143d5733eafb5078b9801f8052b" + "reference": "24d9a880deadb0b8c9680e9cfe78e30b704225db" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/phpcpd/zipball/6f868833a18de143d5733eafb5078b9801f8052b", - "reference": "6f868833a18de143d5733eafb5078b9801f8052b", + "url": "https://api.github.com/repos/sebastianbergmann/phpcpd/zipball/24d9a880deadb0b8c9680e9cfe78e30b704225db", + "reference": "24d9a880deadb0b8c9680e9cfe78e30b704225db", "shasum": "" }, "require": { "php": ">=5.3.3", "phpunit/php-timer": ">=1.0.6", "sebastian/finder-facade": "~1.1", - "sebastian/version": "~1.0", + "sebastian/version": "~1.0|~2.0", "symfony/console": "~2.7|^3.0", "theseer/fdomdocument": "~1.4" }, @@ -1897,7 +1998,7 @@ ], "description": "Copy/Paste Detector (CPD) for PHP code.", "homepage": "https://github.com/sebastianbergmann/phpcpd", - "time": "2016-04-17 13:55:09" + "time": "2016-04-17 19:32:49" }, { "name": "sebastian/recursion-context", @@ -1989,16 +2090,16 @@ }, { "name": "squizlabs/php_codesniffer", - "version": "2.6.0", + "version": "2.6.2", "source": { "type": "git", "url": "https://github.com/squizlabs/PHP_CodeSniffer.git", - "reference": "1bcdf03b068a530ac1962ce671dead356eeba43b" + "reference": "4edb770cb853def6e60c93abb088ad5ac2010c83" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/1bcdf03b068a530ac1962ce671dead356eeba43b", - "reference": "1bcdf03b068a530ac1962ce671dead356eeba43b", + "url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/4edb770cb853def6e60c93abb088ad5ac2010c83", + "reference": "4edb770cb853def6e60c93abb088ad5ac2010c83", "shasum": "" }, "require": { @@ -2063,20 +2164,20 @@ "phpcs", "standards" ], - "time": "2016-04-03 22:58:34" + "time": "2016-07-13 23:29:13" }, { "name": "symfony/dependency-injection", - "version": "v3.0.4", + "version": "v3.1.2", "source": { "type": "git", "url": "https://github.com/symfony/dependency-injection.git", - "reference": "6a9058101b591edced21ca3c83c80a3978f5c6b0" + "reference": "b7272b65f2f46cbe77def7d33916f2613669c508" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/dependency-injection/zipball/6a9058101b591edced21ca3c83c80a3978f5c6b0", - "reference": "6a9058101b591edced21ca3c83c80a3978f5c6b0", + "url": "https://api.github.com/repos/symfony/dependency-injection/zipball/b7272b65f2f46cbe77def7d33916f2613669c508", + "reference": "b7272b65f2f46cbe77def7d33916f2613669c508", "shasum": "" }, "require": { @@ -2089,13 +2190,14 @@ }, "suggest": { "symfony/config": "", + "symfony/expression-language": "For using expressions in service container configuration", "symfony/proxy-manager-bridge": "Generate service proxies to lazy load them", "symfony/yaml": "" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "3.0-dev" + "dev-master": "3.1-dev" } }, "autoload": { @@ -2122,20 +2224,20 @@ ], "description": "Symfony DependencyInjection Component", "homepage": "https://symfony.com", - "time": "2016-03-30 10:41:14" + "time": "2016-06-29 05:42:25" }, { "name": "symfony/finder", - "version": "v3.0.4", + "version": "v3.1.2", "source": { "type": "git", "url": "https://github.com/symfony/finder.git", - "reference": "c54e407b35bc098916704e9fd090da21da4c4f52" + "reference": "8201978de88a9fa0923e18601bb17f1df9c721e7" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/finder/zipball/c54e407b35bc098916704e9fd090da21da4c4f52", - "reference": "c54e407b35bc098916704e9fd090da21da4c4f52", + "url": "https://api.github.com/repos/symfony/finder/zipball/8201978de88a9fa0923e18601bb17f1df9c721e7", + "reference": "8201978de88a9fa0923e18601bb17f1df9c721e7", "shasum": "" }, "require": { @@ -2144,7 +2246,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "3.0-dev" + "dev-master": "3.1-dev" } }, "autoload": { @@ -2171,7 +2273,7 @@ ], "description": "Symfony Finder Component", "homepage": "https://symfony.com", - "time": "2016-03-10 11:13:05" + "time": "2016-06-29 05:41:56" }, { "name": "theseer/fdomdocument", @@ -2212,6 +2314,55 @@ "description": "The classes contained within this repository extend the standard DOM to use exceptions at all occasions of errors instead of PHP warnings or notices. They also add various custom methods and shortcuts for convenience and to simplify the usage of DOM.", "homepage": "https://github.com/theseer/fDOMDocument", "time": "2015-05-27 22:58:02" + }, + { + "name": "webmozart/assert", + "version": "1.0.2", + "source": { + "type": "git", + "url": "https://github.com/webmozart/assert.git", + "reference": "30eed06dd6bc88410a4ff7f77b6d22f3ce13dbde" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/webmozart/assert/zipball/30eed06dd6bc88410a4ff7f77b6d22f3ce13dbde", + "reference": "30eed06dd6bc88410a4ff7f77b6d22f3ce13dbde", + "shasum": "" + }, + "require": { + "php": ">=5.3.3" + }, + "require-dev": { + "phpunit/phpunit": "^4.6" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.0-dev" + } + }, + "autoload": { + "psr-4": { + "Webmozart\\Assert\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Bernhard Schussek", + "email": "bschussek@gmail.com" + } + ], + "description": "Assertions to validate method input/output with nice error messages.", + "keywords": [ + "assert", + "check", + "validate" + ], + "time": "2015-08-24 13:29:44" } ], "aliases": [], diff --git a/docs/en/README.md b/docs/en/README.md index e53c3865..ab6cd0e2 100644 --- a/docs/en/README.md +++ b/docs/en/README.md @@ -1,21 +1,21 @@ -PHPCI documentation -------------------- +PHP Censor documentation +------------------------ Getting Started =============== -* [Installing PHPCI](installing.md) +* [Installing PHP Censor](installing.md) * [Adding a Virtual Host](virtual_host.md) * [Run Builds Using a Worker](workers/worker.md) * [Run Builds Using a Daemon](workers/daemon.md) * [Run Builds Using Cron](workers/cron.md) -* [Adding PHPCI Support to Your Projects](config.md) +* [Adding PHP Censor Support to Your Projects](config.md) * [Setting up Logging](logging.md) -* [Updating PHPCI](updating.md) -* [Configuring PHPCI](configuring.md) +* [Updating PHP Censor](updating.md) +* [Configuring PHP Censor](configuring.md) -Using PHPCI -=========== +Using PHP Censor +================ * Automatically building commits pushed to * [Github](sources/github.md) diff --git a/docs/en/config.md b/docs/en/config.md index f35c613d..79c02432 100644 --- a/docs/en/config.md +++ b/docs/en/config.md @@ -1,7 +1,8 @@ -Adding PHPCI Support to Your Projects -------------------------------------- +Adding PHP Censor Support to Your Projects +------------------------------------------ -Similar to Travis CI, to support PHPCI in your project, you simply need to add a `phpci.yml` file to the root of your repository. The file should look something like this: +Similar to Travis CI, to support PHP Censor in your project, you simply need to add a `.php-censor.yml` (`phpci.yml`/`.phpci.yml` for backward compatibility with PHPCI) file to the root of +your repository. The file should look something like this: ```yml build_settings: @@ -48,7 +49,7 @@ complete: - "DROP DATABASE IF EXISTS test;" ``` -As mentioned earlier, PHPCI is powered by plugins, there are several phases in which plugins can be run: +As mentioned earlier, PHP Censor is powered by plugins, there are several phases in which plugins can be run: * `setup` - This phase is designed to initialise the build procedure. * `test` - The tests that should be run during the build. Plugins run during this phase will contribute to the success or failure of the build. diff --git a/docs/en/configuring.md b/docs/en/configuring.md index 826db858..b5c30077 100644 --- a/docs/en/configuring.md +++ b/docs/en/configuring.md @@ -1,13 +1,13 @@ -Configuring PHPCI ------------------ +Configuring PHP Censor +---------------------- -The PHPCI configuration on the server is automatically generated into the `phpci/PHPCI/config.yml` file during installation. One might need to also edit the file manually. +The PHP Censor configuration on the server is automatically generated into the `config.yml` file during installation. One might need to also edit the file manually. -For example, to [disable authentication](https://www.phptesting.org/news/phpci-1-5-released), one could log into phpci and go into the settings to disable it. But if you have already set up a username/password pair and have forgotten the password, and if the server is on a local network, and it's not sending the `forgot password` email, then editing the config file manually would be handy. To do so, just edit the `phpci` section in the config file (which is in [yaml format](https://en.wikipedia.org/wiki/YAML)), and add +For example, one could log into PHP Censor and go into the settings to disable it. But if you have already set up a username/password pair and have forgotten the password, and if the server is on a local network, and it's not sending the `forgot password` email, then editing the config file manually would be handy. To do so, just edit the `php-censor` section in the config file (which is in [yaml format](https://en.wikipedia.org/wiki/YAML)), and add - phpci: + php-censor: authentication_settings: state: 1 user_id: 1 -where you can get the user_id by logging into the mysql database and selecting your user ID from the `users` table in the `phpci` database. +where you can get the user_id by logging into the mysql database and selecting your user ID from the `users` table in the PHP Censor database. diff --git a/docs/en/installing.md b/docs/en/installing.md index 602b91f3..0880aab1 100644 --- a/docs/en/installing.md +++ b/docs/en/installing.md @@ -1,5 +1,5 @@ -Installing PHPCI ----------------- +Installing PHP Censor +--------------------- What you'll need ================ @@ -12,24 +12,24 @@ What you'll need * The following functions need to be enabled: `exec()`, `shell_exec()` and `proc_open()` in php.ini. * PHP must have OpenSSL support enabled. -Installing PHPCI from Composer +Installing PHP Censor from Composer +=================================== + +* Go to the directory in which you want to install PHP Censor, for example: `/var/www` +* Download Composer if you haven't already: `curl -sS https://getcomposer.org/installer | php` +* Download PHP Censor: `./composer.phar create-project corpsee/php-censor php-censor --keep-vcs --no-dev` +* Go to the newly created PHP Censor directory, and install Composer dependencies: `cd php-censor && ../composer.phar install` +* Run the PHP Censor installer: `./console php-censor:install` +* [Add a virtual host to your web server](virtual_host.md), pointing to the `public` directory within your new PHP Censor directory. You'll need to set up rewrite rules to point all non-existent requests to PHP Censor. +* [Set up the PHP Censor Worker](workers/worker.md), or you can run builds using the [daemon](workers/daemon.md) or [a cron-job](workers/cron.md) to run PHP Censor builds. + +Installing PHP Censor Manually ============================== -* Go to the directory in which you want to install PHPCI, for example: `/var/www` -* Download Composer if you haven't already: `curl -sS https://getcomposer.org/installer | php` -* Download PHPCI: `./composer.phar create-project block8/phpci phpci --keep-vcs --no-dev` -* Go to the newly created PHPCI directory, and install Composer dependencies: `cd phpci && ../composer.phar install` -* Run the PHPCI installer: `./console phpci:install` -* [Add a virtual host to your web server](virtual_host.md), pointing to the `public` directory within your new PHPCI directory. You'll need to set up rewrite rules to point all non-existent requests to PHPCI. -* [Set up the PHPCI Worker](workers/worker.md), or you can run builds using the [PHPCI daemon](workers/daemon.md) or [a cron-job](workers/cron.md) to run PHPCI builds. - -Installing PHPCI Manually -========================= - -* Go to the directory in which you want to install PHPCI, for example: `/var/www` -* [Download PHPCI](https://github.com/Block8/PHPCI/releases/latest) and unzip it. -* Go to the PHPCI directory: `cd /var/www/phpci` +* Go to the directory in which you want to install PHP Censor, for example: `/var/www` +* [Download PHP Censor](https://github.com/corpsee/php-censor/releases/latest) and unzip it. +* Go to the PHP Censor directory: `cd /var/www/php-censor` * Install dependencies using Composer: `composer install` -* Install PHPCI itself: `php ./console phpci:install` -* [Add a virtual host to your web server](virtual_host.md), pointing to the `public` directory within your new PHPCI directory. You'll need to set up rewrite rules to point all non-existent requests to PHPCI. -* [Set up the PHPCI Worker](workers/worker.md), or you can run builds using the [PHPCI daemon](workers/daemon.md) or [a cron-job](workers/cron.md) to run PHPCI builds. +* Install PHP Censor itself: `./console php-censor:install` +* [Add a virtual host to your web server](virtual_host.md), pointing to the `public` directory within your new PHP Censor directory. You'll need to set up rewrite rules to point all non-existent requests to PHP Censor. +* [Set up the PHP Censor Worker](workers/worker.md), or you can run builds using the [daemon](workers/daemon.md) or [a cron-job](workers/cron.md) to run PHP Censor builds. diff --git a/docs/en/interpolation.md b/docs/en/interpolation.md index 2c29b72d..db604abd 100644 --- a/docs/en/interpolation.md +++ b/docs/en/interpolation.md @@ -18,4 +18,4 @@ Where something can be one of the following: * **BUILD** - The build number * **PROJECT_TITLE** - The name of the project * **BUILD_PATH** - The path to the build -* **BUILD_URI** - The URL to the build in PHPCI +* **BUILD_URI** - The URL to the build in PHP Censor diff --git a/docs/en/logging.md b/docs/en/logging.md index 456f6654..48f6ff9a 100644 --- a/docs/en/logging.md +++ b/docs/en/logging.md @@ -4,10 +4,10 @@ Setting up Logging Basics ====== -The phpci codebase makes use of the [psr3](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md) logging standard. By default we use [Monolog](https://github.com/Seldaek/monolog) to handle the actual work implementing this standard. +The PHP Censor codebase makes use of the [PSR3](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md) logging standard. By default we use [Monolog](https://github.com/Seldaek/monolog) to handle the actual work implementing this standard. -How to Setup Logging (For people running a PHPCI instance) -========================================================== +How to Setup Logging (For people running a PHP Censor instance) +=============================================================== The only step required to activate logging is to create a file in the root directory called loggerconfig.php with content like the following: @@ -22,9 +22,9 @@ return array( } ); ``` -This file should return an array of key value pairs. Each key tells phpci which command to attach the logger to (the underscore is a special value which matches all commands). For each command an array of [Monolog](https://github.com/Seldaek/monolog) handlers should be returned. In the example above we've used one that simply writes to the file system but in practise this could be any handler written for monolog. +This file should return an array of key value pairs. Each key tells PHP Censor which command to attach the logger to (the underscore is a special value which matches all commands). For each command an array of [Monolog](https://github.com/Seldaek/monolog) handlers should be returned. In the example above we've used one that simply writes to the file system but in practise this could be any handler written for monolog. -Once this file is created all plugins and core phpci functionality should start writing to the configured handlers. +Once this file is created all plugins and core PHP Censor functionality should start writing to the configured handlers. How to write to the Log (For people creating a new plugin) ========================================================== @@ -33,7 +33,7 @@ How to write to the Log (For people creating a new plugin) For plugin creators the simplest way to get hold of an error logger is to add a parameter to the constructor and typehint on 'Psr\Log\LoggerInterface'. The code that loads your plugin will automatically inject the logger when it sees this. For example: ```php -class ExampleLoggingPlugin implements \PHPCI\Plugin +class ExampleLoggingPlugin implements \PHPCensor\Plugin { protected $log; diff --git a/docs/en/plugins/atoum.md b/docs/en/plugins/atoum.md index a2617f46..e9e7b413 100644 --- a/docs/en/plugins/atoum.md +++ b/docs/en/plugins/atoum.md @@ -11,7 +11,7 @@ Configuration - **args** [string, optional] - Allows you to pass command line arguments to Atoum. - **config** [string, optional] - Path to an Atoum configuration file. - **directory** [string, optional] - Path in which to run Atom (defaults to the build root). -- **executable** [string, optional] - Allows you to provide a path to the Atom binary (defaults to PHPCI root, vendor/bin, or a system-provided Atom binary). +- **executable** [string, optional] - Allows you to provide a path to the Atom binary (defaults to PHP Censor root, vendor/bin, or a system-provided Atom binary). ### Examples ```yml diff --git a/docs/en/plugins/behat.md b/docs/en/plugins/behat.md index 16b8b8f1..87cede9a 100644 --- a/docs/en/plugins/behat.md +++ b/docs/en/plugins/behat.md @@ -8,7 +8,7 @@ Configuration ### Options -- **executable** [string, optional] - Allows you to provide a path to the Behat binary (defaults to PHPCI root, vendor/bin, or a system-provided Behat binary). +- **executable** [string, optional] - Allows you to provide a path to the Behat binary (defaults to PHP Censor root, vendor/bin, or a system-provided Behat binary). - **features** [string, optional] - Provide a list of Behat features to run. ### Examples diff --git a/docs/en/plugins/codeception.md b/docs/en/plugins/codeception.md index db4e07e3..b0ed7f2a 100644 --- a/docs/en/plugins/codeception.md +++ b/docs/en/plugins/codeception.md @@ -10,7 +10,7 @@ Configuration * **config** - Required - Can be either a single string pointing to a Codeception configuration file, or an array of configuration file paths. By default this is called `codeception.yml` and will be in the root of your project. -* **args** - Optional - The string of arguments to be passed to the run command. **Important**, due to the assumption made on line [132](https://github.com/Block8/PHPCI/blob/master/PHPCI/Plugin/Codeception.php#L132) regarding the value of `--xml` being the next argument which will not be correct if the user provides arguments using this config param, you must specify `report.xml` before any user input arguments to satisfy the report processing on line [146](https://github.com/Block8/PHPCI/blob/master/PHPCI/Plugin/Codeception.php#L146) +* **args** - Optional - The string of arguments to be passed to the run command.**Important**, due to the assumption made on line [132](https://github.com/Block8/PHPCI/blob/master/PHPCI/Plugin/Codeception.php#L132) regarding the value of `--xml` being the next argument which will not be correct if the user provides arguments using this config param, you must specify `report.xml` before any user input arguments to satisfy the report processing on line [146](https://github.com/Block8/PHPCI/blob/master/PHPCI/Plugin/Codeception.php#L146) * **path** - Optional - The path from the root of your project to the root of the codeception _output directory diff --git a/docs/en/plugins/composer.md b/docs/en/plugins/composer.md index 2da4037f..dd0b8c3b 100644 --- a/docs/en/plugins/composer.md +++ b/docs/en/plugins/composer.md @@ -28,7 +28,7 @@ setup: Warning ======= -If you are using a Composer private repository like Satis, with HTTP authentication, you must check your username and password inside the ```auth.json``` file. PHPCI uses the ```--no-interaction``` flag, so it will not warn if you must provide that info. +If you are using a Composer private repository like Satis, with HTTP authentication, you must check your username and password inside the ```auth.json``` file. PHP Censor uses the ```--no-interaction``` flag, so it will not warn if you must provide that info. For more info, please check the Composer documentation. diff --git a/docs/en/plugins/deployer.md b/docs/en/plugins/deployer.md index 2cc3867e..a157e381 100644 --- a/docs/en/plugins/deployer.md +++ b/docs/en/plugins/deployer.md @@ -9,7 +9,7 @@ Configuration ### Options * **webhook_url** [required, string] - The URL to your Deployer WebHook -* **reason** [optional, string] - Your deployment message. Default - PHPCI Build #%BUILD% - %COMMIT_MESSAGE% +* **reason** [optional, string] - Your deployment message. Default - PHP Censor Build #%BUILD% - %COMMIT_MESSAGE% * **update_only** [optional, bool, true|false] - Whether the deployment should only be run if the currently deployed branches matches the one being built. Default - true ### Examples @@ -18,6 +18,6 @@ Configuration success: deployer: webhook_url: "https://deployer.example.com/deploy/QZaF1bMIUqbMFTmKDmgytUuykRN0cjCgW9SooTnwkIGETAYhDTTYoR8C431t" - reason: "PHPCI Build #%BUILD% - %COMMIT_MESSAGE%" + reason: "PHP Censor Build #%BUILD% - %COMMIT_MESSAGE%" update_only: true ``` diff --git a/docs/en/plugins/email.md b/docs/en/plugins/email.md index e5f49f66..52130e21 100644 --- a/docs/en/plugins/email.md +++ b/docs/en/plugins/email.md @@ -19,7 +19,7 @@ Configuration ### Examples -See [Adding PHPCI Support to Your Projects](https://www.phptesting.org/wiki/Adding-PHPCI-Support-to-Your-Projects) for more information about how to configure plugins. +See [Adding PHP Censor Support to Your Projects](../config.md) for more information about how to configure plugins. Send an email to the committer as well as one@exameple.com if a build fails: ```yml diff --git a/docs/en/plugins/env.md b/docs/en/plugins/env.md index 05c80e1b..fc2e806a 100644 --- a/docs/en/plugins/env.md +++ b/docs/en/plugins/env.md @@ -1,7 +1,7 @@ Plugin Env ---------- -Sets environment variables on the PHPCI server for the build. +Sets environment variables on the PHP Censor server for the build. Configuration ============= diff --git a/docs/en/plugins/grunt.md b/docs/en/plugins/grunt.md index 512eedc7..fb104ff2 100644 --- a/docs/en/plugins/grunt.md +++ b/docs/en/plugins/grunt.md @@ -9,7 +9,7 @@ Configuration ### Options - **directory** [string, optional] - The directory in which to run Grunt (defaults to build root.) -- **grunt** [string, optional] - Allows you to provide a path to Grunt (defaults to PHPCI root, vendor/bin, or a system-provided Grunt). +- **grunt** [string, optional] - Allows you to provide a path to Grunt (defaults to PHP Censor root, vendor/bin, or a system-provided Grunt). - **gruntfile** [string, optional] - Gruntfile to run (defaults to `Gruntfile.js`). - **task** [string, optional] - The Grunt task to run. diff --git a/docs/en/plugins/phing.md b/docs/en/plugins/phing.md index ac27930e..b6cad449 100644 --- a/docs/en/plugins/phing.md +++ b/docs/en/plugins/phing.md @@ -22,5 +22,5 @@ phing: targets: - "build:test" properties: - config_file: "PHPCI" + config_file: "php-censor" ``` diff --git a/docs/en/plugins/php_code_sniffer.md b/docs/en/plugins/php_code_sniffer.md index 69032db7..35f4c653 100644 --- a/docs/en/plugins/php_code_sniffer.md +++ b/docs/en/plugins/php_code_sniffer.md @@ -34,7 +34,7 @@ For use with an existing project: test: php_code_sniffer: standard: "/phpcs.xml" # The leading slash is needed to trigger an external ruleset. - # Without it, PHPCI looks for a rule named "phpcs.xml" + # Without it, PHP Censor looks for a rule named "phpcs.xml" allowed_errors: -1 # Even a single error will cause the build to fail. -1 = unlimited allowed_warnings: -1 ``` diff --git a/docs/en/plugins/php_parallel_lint.md b/docs/en/plugins/php_parallel_lint.md index f264fabc..2ec6cf6f 100644 --- a/docs/en/plugins/php_parallel_lint.md +++ b/docs/en/plugins/php_parallel_lint.md @@ -1,7 +1,7 @@ Plugin PHP Parallel Lint ------------------------ -Similar to the [standard PHP Lint plugin](https://github.com/Block8/PHPCI/wiki/Lint-plugin), except that it uses the [PHP Parallel Lint](https://github.com/JakubOnderka/PHP-Parallel-Lint) project to run. +Similar to the [standard PHP Lint plugin](lint.md), except that it uses the [PHP Parallel Lint](https://github.com/JakubOnderka/PHP-Parallel-Lint) project to run. Configuration ============= diff --git a/docs/en/plugins/php_unit.md b/docs/en/plugins/php_unit.md index 8a3fc50e..dc95e9e3 100644 --- a/docs/en/plugins/php_unit.md +++ b/docs/en/plugins/php_unit.md @@ -39,8 +39,8 @@ test: Troubleshooting =============== -If standard logging of PHPCI is not enough, to get standard output from any command, including PHPUnit, edit `BaseCommandExecutor::executeCommand()` to see what exactly is wrong -* Run `composer update` in phpunit plugin directory of PHPCI to get all of its dependencies -* If phpunit is inside of the project's composer.json, it might interfere with PHPCI's phpunit installation +If standard logging of PHP Censor is not enough, to get standard output from any command, including PHPUnit, edit `BaseCommandExecutor::executeCommand()` to see what exactly is wrong +* Run `composer update` in phpunit plugin directory of PHP Censor to get all of its dependencies +* If phpunit is inside of the project's composer.json, it might interfere with PHP Censor's phpunit installation * Make sure you have XDebug installed.`The Xdebug extension is not loaded. No code coverage will be generated.` Otherwise test report parsing in `TapParser` will fail, wanting coverage report as well `Invalid TAP string, number of tests does not match specified test count.` diff --git a/docs/en/plugins/shell.md b/docs/en/plugins/shell.md index ad1319ad..44d4e365 100644 --- a/docs/en/plugins/shell.md +++ b/docs/en/plugins/shell.md @@ -3,19 +3,6 @@ Plugin Shell Runs a given Shell command. -**Note: ** Because this plugin could potentially be abused, it requires extra steps to enable it: - -1. In the root of your PHPCI system, in the same directory where you'll find composer.json and vars.php, look for a file local_vars.php. If it does not exist, create it. -2. In local_vars.php add this code: - -```php - - <%BUILD_URI%|Build #%BUILD%> has finished for commit <%COMMIT_URI%|%SHORT_COMMIT% (%COMMIT_EMAIL%)> on branch <%BRANCH_URI%|%BRANCH%>` | | `show_status` | No | Whether or not to append the build status as an attachment in slack. Default - true @@ -24,8 +24,8 @@ Send a message if the build fails: failure: slack_notify: webhook_url: "https://hooks.slack.com/services/R212T827A/G983UY31U/aIp0yuW9u0iTqwAMOEwTg" - room: "#phpci" - username: "PHPCI" + room: "#php-censor" + username: "PHP Censor" icon: ":ghost:" message: "%PROJECT_TITLE% - build %BUILD% failed! :angry:" show_status: false @@ -37,8 +37,8 @@ Send a message if the build is successful: success: slack_notify: webhook_url: "https://hooks.slack.com/services/R212T827A/G983UY31U/aIp0yuW9u0iTqwAMOEwTg" - room: "#phpci" - username: "PHPCI" + room: "#php-censor" + username: "PHP Censor" icon: ":ghost:" message: "%PROJECT_TITLE% - build %BUILD% succeeded! :smiley:" show_status: false @@ -50,8 +50,8 @@ Send a message every time the build runs: complete: slack_notify: webhook_url: "https://hooks.slack.com/services/R212T827A/G983UY31U/aIp0yuW9u0iTqwAMOEwTg" - room: "#phpci" - username: "PHPCI" + room: "#php-censor" + username: "PHP Censor" icon: ":ghost:" message: "%PROJECT_TITLE% - build %BUILD% completed" show_status: true diff --git a/docs/en/plugins/xmpp.md b/docs/en/plugins/xmpp.md index e9448ca2..5c2f1ae5 100644 --- a/docs/en/plugins/xmpp.md +++ b/docs/en/plugins/xmpp.md @@ -10,7 +10,7 @@ Installation ============ 1. On debian system (for example) use aptitude command to install sendxmpp -2. Add XMPP plugin in "complete" section of your phpci.yml +2. Add XMPP plugin in "complete" section of your `php-censor.yml` Configuration ============= @@ -37,6 +37,6 @@ complete: - "recipient2@jabber.org" server: "gtalk.google.com" tls: 1 - alias: "PHPCi Notification" + alias: "PHP Censor Notification" date_format: "%d/%m/%Y" ``` diff --git a/docs/en/sources/bitbucket.md b/docs/en/sources/bitbucket.md index 6b5d4626..f81f0e8c 100644 --- a/docs/en/sources/bitbucket.md +++ b/docs/en/sources/bitbucket.md @@ -3,7 +3,7 @@ Automatically building commits pushed to Bitbucket If you would like your builds to run automatically whenever there is a commit or other similar activity in your Bitbucket repository, perform the following steps: -1. Log into PHPCI. +1. Log into PHP Censor. 2. Click on your Bitbucket project. 3. Copy the web hook link specified on the left. 4. Log into Bitbucket and go to your repo. diff --git a/docs/en/sources/git.md b/docs/en/sources/git.md index 3bbf58cc..7ca4eed6 100644 --- a/docs/en/sources/git.md +++ b/docs/en/sources/git.md @@ -16,7 +16,7 @@ Installation #!/bin/sh PROJECT_ID=1 -PHPCI_URL="http://my.server.com/PHPCI/" +APP_URL="http://my.server.com/php-censor/" trigger_hook() { NEWREV="$2" @@ -44,7 +44,7 @@ trigger_hook() { --data-urlencode commit="$NEWREV" \ --data-urlencode committer="$COMMITTER" \ --data-urlencode message="$MESSAGE" \ - "$PHPCI_URL/webhook/git/$PROJECT_ID" + "$APP_URL/webhook/git/$PROJECT_ID" } if [ -n "$1" -a -n "$2" -a -n "$3" ]; then diff --git a/docs/en/sources/github.md b/docs/en/sources/github.md index 28e10ce0..adcf7dde 100644 --- a/docs/en/sources/github.md +++ b/docs/en/sources/github.md @@ -3,12 +3,12 @@ Automatically building commits pushed to GitHub If you would like your builds to run automatically whenever there is a commit or other similar activity in your GitHub repository, perform the following steps: -1. Log into PHPCI. +1. Log into PHP Censor. 2. Click on your GitHub project. 3. Copy the web hook link specified on the right of the page. 4. Log into GitHub and go to your repository. 5. Click the settings icon on the lower right sidebar. 6. Click on "Webhooks & Services". 7. Add your web hook link you copied above, and specify when you would like it to run. -8. Add the public key for the project in PHPCI to the deploy keys for the repository on GitHub. -9. Verify that the initial test delivery was successful. If not, make sure that your PHPCI machine is reachable from the internet. +8. Add the public key for the project in PHP Censor to the deploy keys for the repository on GitHub. +9. Verify that the initial test delivery was successful. If not, make sure that your PHP Censor machine is reachable from the internet. diff --git a/docs/en/sources/gitlab.md b/docs/en/sources/gitlab.md index d7d74b08..70c6986b 100644 --- a/docs/en/sources/gitlab.md +++ b/docs/en/sources/gitlab.md @@ -3,12 +3,12 @@ Automatically building commits pushed to GitLab If you would like your builds to run automatically whenever there is a commit or other similar activity in your GitLab repository, perform the following steps: -1. Log into PHPCI. +1. Log into PHP Censor. 2. Click on your Gitlab project. 3. Copy the web hook link specified on the left. 4. Log into Gitlab and go to your repo. 5. Click the "settings" tab in the top right corner of the page. 6. Click on "Web Hooks". -7. Paste the link you copied from PHPCI into the "URL" textbox. -8. Select the events which you want to trigger a PHPCI build. The default and recommended setup is to only enable "push events." +7. Paste the link you copied from PHP Censor into the "URL" textbox. +8. Select the events which you want to trigger a PHP Censor build. The default and recommended setup is to only enable "push events." 9. Click "Add Web Hook," and verify that the test was successful. diff --git a/docs/en/status.md b/docs/en/status.md index fa7491b9..1408a195 100644 --- a/docs/en/status.md +++ b/docs/en/status.md @@ -4,31 +4,31 @@ Project Status Images and Status Page Status Image ============ -Most Continuous Integration systems provide a simple image URL that you can use to display your project status on other web sites (like Github) - PHPCI is no different. +Most Continuous Integration systems provide a simple image URL that you can use to display your project status on other web sites (like Github) - PHP Censor is no different. -You can find the status image at the following location: `http://{PHPCI URL}/build-status/image/{PROJECT ID}` +You can find the status image at the following location: `http://{PHP_CENSOR_URL}/build-status/image/{PROJECT ID}` -So for example, our instance of PHPCI is at `phpci.block8.net`, and our PHPCI project ID is `2`, so the image URL is: `http://phpci.block8.net/build-status/image/2`. +So for example, our instance of PHP Censor is at `php-censor.local`, and our PHP Censor project ID is `2`, so the image URL is: `http://php-censor.local/build-status/image/2`. Example: -![](http://phpci.block8.net/build-status/image/2) +![](http://php-censor.local/build-status/image/2) Status Page =========== -PHPCI also provides a public project status page, that is accessible for everyone. +PHP Censor also provides a public project status page, that is accessible for everyone. -You can find the status page at the following location: `http://{PHPCI URL}/build-status/view/{PROJECT ID}` +You can find the status page at the following location: `http://{PHP_CENSOR_URL}/build-status/view/{PROJECT ID}` Example: -http://phpci.block8.net/build-status/view/2 +http://php-censor.local/build-status/view/2 ### Where do I find my project ID? -Go to your instance of PHPCI, and open the project you are interested in. The project ID is the number in the last part of the URL in your browser. +Go to your instance of PHP Censor, and open the project you are interested in. The project ID is the number in the last part of the URL in your browser. Example: -http://phpci.block8.net/project/view/2 ~> PROJECT ID: `2` +http://php-censor.local/project/view/2 ~> PROJECT ID: `2` ### Enable/disable status image and page You can enable or disable access to the public status image and page in your project's settings. diff --git a/docs/en/updating.md b/docs/en/updating.md index 37a3645d..74a5380c 100644 --- a/docs/en/updating.md +++ b/docs/en/updating.md @@ -1,11 +1,11 @@ -Updating PHPCI --------------- +Updating PHP Censor +------------------- -Updating PHPCI to the latest release, or even dev-master updates is something that will need to be done from time to time. Most of this may be self-explanatory, but for clarity and completeness, it should be added to the documentation. +Updating PHP Censor to the latest release, or even dev-master updates is something that will need to be done from time to time. Most of this may be self-explanatory, but for clarity and completeness, it should be added to the documentation. -1. Go to your PHPCI root folder in a Terminal. +1. Go to your PHP Censor root folder in a Terminal. 2. Pull the latest code. This would look like this: `git pull` -3. Update the PHPCI database: `./console phpci:update` +3. Update the PHP Censor database: `./console php-censor:update` 4. Update the composer and its packages: `composer self-update && composer update` -5. Return to the PHPCI admin screens and check your desired plugins are still installed correctly. +5. Return to the PHP Censor admin screens and check your desired plugins are still installed correctly. 7. Run a build to make sure everything is working as expected. diff --git a/docs/en/virtual_host.md b/docs/en/virtual_host.md index 92cb1191..cbd48110 100644 --- a/docs/en/virtual_host.md +++ b/docs/en/virtual_host.md @@ -1,7 +1,7 @@ Adding a Virtual Host --------------------- -In order to access the PHPCI web interface, you need to set up a virtual host in your web server. +In order to access the PHP Censor web interface, you need to set up a virtual host in your web server. Below are a few examples of how to do this for various different web servers. @@ -13,10 +13,10 @@ server { ... standard virtual host ... location / { - try_files $uri @phpci; + try_files $uri @php-censor; } - location @phpci { + location @php-censor { # Pass to FastCGI: fastcgi_pass unix:/path/to/phpfpm.sock; fastcgi_index index.php; @@ -31,7 +31,7 @@ server { Apache Example ============== -For Apache, you can use a standard virtual host, as long as your server supports PHP. All you need to do is add the following to a `.htaccess` file in your PHPCI `/public` directory. +For Apache, you can use a standard virtual host, as long as your server supports PHP. All you need to do is add the following to a `.htaccess` file in your PHP Censor `/public` directory. ``` @@ -47,23 +47,22 @@ For Apache, you can use a standard virtual host, as long as your server supports ``` ServerAdmin user@domain.com - DocumentRoot /var/www/phpci/public - ServerName phpci.vagrant - ServerAlias phpci.vagrant + DocumentRoot /var/www/php-censor.local/public + ServerName php-censor.local - + Options Indexes FollowSymLinks AllowOverride All Require all granted - ErrorLog ${APACHE_LOG_DIR}/phpci-error_log - CustomLog ${APACHE_LOG_DIR}/phpci-access_log combined + ErrorLog ${APACHE_LOG_DIR}/php-censor-error_log + CustomLog ${APACHE_LOG_DIR}/php-censor-access_log combined ``` - Add in /etc/hosts ``` -127.0.0.1 phpci.vagrant +127.0.0.1 php-censor.local ``` Built-in PHP Server Example diff --git a/docs/en/workers/cron.md b/docs/en/workers/cron.md index 67df7201..d0a2da1f 100644 --- a/docs/en/workers/cron.md +++ b/docs/en/workers/cron.md @@ -1,17 +1,17 @@ Run Builds Using Cron --------------------- -Running builds using cron is a quick and simple method of getting up and running with PHPCI. It also removes the need for PHPCI to be running all the time. +Running builds using cron is a quick and simple method of getting up and running with PHP Censor. It also removes the need for PHP Censor to be running all the time. -If you want a little more control over how PHPCI runs, you may want to [set up the PHPCI daemon](workers/daemon.md) instead. +If you want a little more control over how PHP Censor runs, you may want to [set up the PHP Censor daemon](workers/daemon.md) instead. Setting up the Cron Job ======================= -You'll want to set up PHPCI to run as a regular cronjob, so run `crontab -e` and enter the following: +You'll want to set up PHP Censor to run as a regular cronjob, so run `crontab -e` and enter the following: ```sh -* * * * * /usr/bin/php /path/to/phpci/console phpci:run-builds +* * * * * /usr/bin/php /path/to/php-censor/console php-censor:run-builds ``` -**Note:** Make sure you change the `/path/to/phpci` to the directory in which you installed PHPCI, and update the PHP path if necessary. +**Note:** Make sure you change the `/path/to/php-censor` to the directory in which you installed PHP Censor, and update the PHP path if necessary. diff --git a/docs/en/workers/daemon.md b/docs/en/workers/daemon.md index 4c0e86d5..350cf3be 100644 --- a/docs/en/workers/daemon.md +++ b/docs/en/workers/daemon.md @@ -1,11 +1,11 @@ Run Builds Using a Daemon ------------------------- -The PHPCI daemon runs in the background on your server and continuously checks for new builds. Unless already running a build, the daemon should pick up and start running new builds within seconds of being created. +The PHP Censor daemon runs in the background on your server and continuously checks for new builds. Unless already running a build, the daemon should pick up and start running new builds within seconds of being created. -The daemon is also useful if you want to run multiple PHPCI workers in a virtualised environment (i.e. Docker) +The daemon is also useful if you want to run multiple PHP Censor workers in a virtualised environment (i.e. Docker) -If you want to run PHPCI builds on a regular schedule instead, you should [set up a cron-job](workers/cron.md). +If you want to run PHP Censor builds on a regular schedule instead, you should [set up a cron-job](workers/cron.md). Starting the Daemon =================== @@ -13,11 +13,11 @@ Starting the Daemon On a Linux/Unix server, the following command will start the daemon and keep it running even when you log out of the server: ```sh -nohup php ./daemonise phpci:daemonise >/dev/null 2>&1 & +nohup php ./daemonise php-censor:daemonise >/dev/null 2>&1 & ``` If you need to debug what's going on with your builds, you can also run the daemon directly using the following command, which will output the daemon's log directly to your terminal: ```sh -php daemonise phpci:daemonise +php daemonise php-censor:daemonise ``` diff --git a/docs/en/workers/worker.md b/docs/en/workers/worker.md index af4765ca..07be7937 100644 --- a/docs/en/workers/worker.md +++ b/docs/en/workers/worker.md @@ -1,9 +1,9 @@ Run Builds Using a Worker ------------------------- -The PHPCI Worker (added in v1.7) runs in the background on your server and waits for new builds to be added to a Beanstalkd queue. Unless already running a build, the worker will pick up and start running new builds almost immediately after their creation. +The PHP Censor Worker runs in the background on your server and waits for new builds to be added to a Beanstalkd queue. Unless already running a build, the worker will pick up and start running new builds almost immediately after their creation. -The worker is the recommended way to run PHPCI builds. You can run several workers all watching one queue, allowing jobs to be run simultaneously without the overhead of polling your MySQL database. +The worker is the recommended way to run PHP Censor builds. You can run several workers all watching one queue, allowing jobs to be run simultaneously without the overhead of polling your MySQL database. If you can't run Beanstalkd on your server, or would prefer to run builds on a regular schedule, you should consider using the [build daemon](workers/daemon.md) or [running builds via Cron](workers/cron.md). @@ -13,49 +13,49 @@ Pre-Requisites * You need to install [Beanstalkd](http://kr.github.io/beanstalkd/) - On Ubuntu, this is as simple as running `apt-get install beanstalkd`. * [Supervisord](http://supervisord.org/) needs to be installed and running on your server. -Setting up the PHPCI Worker -=========================== +Setting up the PHP Censor worker +================================ ### On a new installation -Setting up the worker on a new installation of PHPCI is as simple as entering the appropriate values for your Beanstalkd server hostname and queue name when running the PHPCI installer. By default, the installer assumes that you'll be using beanstalkd on `localhost` and will use the queue name `phpci`. +Setting up the worker on a new installation of PHP Censor is as simple as entering the appropriate values for your Beanstalkd server hostname and queue name when running the PHP Censor installer. By default, the installer assumes that you'll be using beanstalkd on `localhost` and will use the queue name `php-censor-queue`. -![PHPCI Worker Installer](https://www.phptesting.org/media/render/f48f63699a04444630352643af18b643) +![PHP Censor Worker Installer](https://www.phptesting.org/media/render/f48f63699a04444630352643af18b643) ### On an existing installation -On an existing installation, to set up the worker, you simply need to add the beanstalkd host and queue names directly into your `/PHPCI/config.yml` file. You should add a `worker` key beneath the `phpci` section, with the properties `host` and `queue` as outlined in the screenshot below: +On an existing installation, to set up the worker, you simply need to add the beanstalkd host and queue names directly into your `config.yml` file. You should add a `worker` key beneath the `php-censor` section, with the properties `host` and `queue` as outlined in the screenshot below: -![PHPCI Worker Config](https://www.phptesting.org/media/render/9a88e9298670f2913f5798e68b94c9ed) +![PHP Censor Worker Config](https://www.phptesting.org/media/render/9a88e9298670f2913f5798e68b94c9ed) -Running the PHPCI Worker -======================== +Running the PHP Censor worker +============================= -Once you've set up PHPCI to add your jobs to a beanstalkd queue, you need to start the worker so that it can pick up and run your builds. On most servers, it is best to manage this using supervisord. The following instructions work on Ubuntu, but will need slight amendments for other distributions. +Once you've set up PHP Censor to add your jobs to a beanstalkd queue, you need to start the worker so that it can pick up and run your builds. On most servers, it is best to manage this using supervisord. The following instructions work on Ubuntu, but will need slight amendments for other distributions. -Using your preferred text editor, create a file named `phpci.conf` under `/etc/supervisor/conf.d`. In it, enter the following config: +Using your preferred text editor, create a file named `php-censor.conf` under `/etc/supervisor/conf.d`. In it, enter the following config: ``` -[program:phpci] -command=/path/to/phpci/latest/console phpci:worker +[program:php-censor] +command=/path/to/php-censor/latest/console php-censor:worker process_name=%(program_name)s_%(process_num)02d -stdout_logfile=/var/log/phpci.log -stderr_logfile=/var/log/phpci-err.log -user=phpci +stdout_logfile=/var/log/php-censor.log +stderr_logfile=/var/log/php-censor-err.log +user=php-censor autostart=true autorestart=true -environment=HOME="/home/phpci",USER="phpci" +environment=HOME="/home/php-censor",USER="php-censor" numprocs=2 ``` -You'll need to edit the '/path/to/phpci', the `user` value and the `environment` value to suit your server. The user needs to be an actual system user with suitable permissions to execute PHP and PHPCI. +You'll need to edit the '/path/to/php-censor', the `user` value and the `environment` value to suit your server. The user needs to be an actual system user with suitable permissions to execute PHP and PHP Censor. -Once you've created this file, simply restart supervisord using the command `service supervisor restart` and 2 instances of PHPCI's worker should start immediately. You can verify this by running the command `ps aux | grep phpci`, which should give you output as follows: +Once you've created this file, simply restart supervisord using the command `service supervisor restart` and 2 instances of PHP Censor's worker should start immediately. You can verify this by running the command `ps aux | grep php-censor`, which should give you output as follows: ``` -➜ ~ ps aux | grep phpci -phpci 19057 0.0 0.9 200244 18720 ? S 03:00 0:01 php /phpci/console phpci:worker -phpci 19058 0.0 0.9 200244 18860 ? S 03:00 0:01 php /phpci/console phpci:worker +➜ ~ ps aux | grep php-censor +php-censor 19057 0.0 0.9 200244 18720 ? S 03:00 0:01 php /php-censor/console php-censor:worker +php-censor 19058 0.0 0.9 200244 18860 ? S 03:00 0:01 php /php-censor/console php-censor:worker ``` -That's it! Now, whenever you create a new build in PHPCI, it should start building immediately. +That's it! Now, whenever you create a new build in PHP Censor, it should start building immediately. diff --git a/phpcs.xml b/phpcs.xml index a392a201..9aa40933 100644 --- a/phpcs.xml +++ b/phpcs.xml @@ -1,19 +1,19 @@ - + - Codestyle ruleset for PHPCI + Codestyle ruleset for PHP Censor - PHPCI + PHP Censor - PHPCI/Migrations/* - PHPCI/Model/Base/* - PHPCI/Languages/* - Tests/* + src/PHPCensor/Migrations/* + src/PHPCensor/Model/Base/* + src/PHPCensor/Languages/* + tests/* vendor/* diff --git a/phpmd.xml b/phpmd.xml index 69b822fd..b1b0a56d 100644 --- a/phpmd.xml +++ b/phpmd.xml @@ -1,5 +1,5 @@ - - PHPCI rule set + PHP Censor rule set diff --git a/phpunit.xml b/phpunit.xml index 0b01dcd6..166bea97 100644 --- a/phpunit.xml +++ b/phpunit.xml @@ -12,29 +12,29 @@ bootstrap="./tests/bootstrap.php" > - - - ./tests/PHPCI/Controller + + ./tests/PHPCensor/Controller - - ./tests/PHPCI/Helper + + ./tests/PHPCensor/Helper - - ./tests/PHPCI/Logging + + ./tests/PHPCensor/Logging - - ./tests/PHPCI/Model + + ./tests/PHPCensor/Model - - ./tests/PHPCI/Plugin + + ./tests/PHPCensor/Plugin - - - ./tests/PHPCI/Service + + ./tests/PHPCensor/Service - - - + + + - - - - + + + + - +
- +