├── .gitignore ├── .php_cs ├── .travis.yml ├── CONTRIBUTING.md ├── Command └── Deploy │ ├── InstallCommand.php │ ├── RunCommand.php │ └── SetupCommand.php ├── DependencyInjection ├── Configuration.php └── RCHCapistranoExtension.php ├── Generator ├── AbstractGenerator.php ├── CapfileGenerator.php ├── DeployGenerator.php ├── GemfileGenerator.php ├── GeneratorInterface.php ├── Handler.php ├── StagingGenerator.php └── YamlStagingGenerator.php ├── LICENSE ├── Makefile ├── RCHCapistranoBundle.php ├── README.md ├── Resources ├── config │ ├── capistrano │ │ ├── deploy │ │ │ └── production.rb │ │ └── tasks │ │ │ ├── download_composer.rake │ │ │ └── update_db_schema.rake │ ├── services.yml │ └── setup_dialog.yml └── doc │ ├── SCREENCAP.gif │ └── SCREENCAST.gif ├── Service └── Capitalizer.php ├── Test ├── Generator │ ├── StagingGeneratorTest.php │ └── YamlStagingGeneratorTest.php ├── autoload.php.dist └── bootstrap.php ├── Util ├── CanGenerateTrait.php ├── LocalizableTrait.php └── OutputWritableTrait.php ├── composer.json └── phpunit.xml.dist /.gitignore: -------------------------------------------------------------------------------- 1 | #### joe made this: https://goel.io/joe 2 | 3 | #####=== Symfony ===##### 4 | 5 | # Cache and logs (Symfony2) 6 | /app/cache/* 7 | /app/logs/* 8 | !app/cache/.gitkeep 9 | !app/logs/.gitkeep 10 | 11 | # Cache and logs (Symfony3) 12 | /var/cache/* 13 | /var/logs/* 14 | !var/cache/.gitkeep 15 | !var/logs/.gitkeep 16 | 17 | # Parameters 18 | /app/config/parameters.yml 19 | /app/config/parameters.ini 20 | 21 | # Managed by Composer 22 | /app/bootstrap.php.cache 23 | /var/bootstrap.php.cache 24 | /bin/* 25 | !bin/console 26 | !bin/symfony_requirements 27 | /vendor/ 28 | 29 | # Assets and user uploads 30 | /web/bundles/ 31 | /web/uploads/ 32 | 33 | # PHPUnit 34 | /app/phpunit.xml 35 | /phpunit.xml 36 | 37 | # Build data 38 | /build/ 39 | 40 | # Composer PHAR 41 | /composer.phar 42 | /composer.lock 43 | -------------------------------------------------------------------------------- /.php_cs: -------------------------------------------------------------------------------- 1 | in(array(__DIR__)) 5 | ; 6 | 7 | $header = << 11 | 12 | For the full copyright and license information, please view the LICENSE 13 | file that was distributed with this source code. 14 | EOF; 15 | 16 | Symfony\CS\Fixer\Contrib\HeaderCommentFixer::setHeader($header); 17 | 18 | return Symfony\CS\Config\Config::create() 19 | ->level(Symfony\CS\FixerInterface::SYMFONY_LEVEL) 20 | ->fixers(array( 21 | '-unalign_double_arrow', 22 | '-unalign_equals', 23 | 'align_double_arrow', 24 | 'newline_after_open_tag', 25 | 'ordered_use', 26 | 'header_comment', 27 | )) 28 | ->setUsingCache(false) 29 | ->finder($finder) 30 | ; 31 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: php 2 | 3 | php: 4 | - 5.6 5 | 6 | before_script: 7 | - composer selfupdate 8 | - composer install --dev 9 | 10 | script: 11 | - make test 12 | 13 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | ## Reporting bugs 2 | 3 | If you happen to find a bug, we kindly request you to report it. However, before submitting it, please report it using Github by following these 3 points: 4 | 5 | * Check if the bug is not already reported! 6 | * A clear title to resume the issue 7 | * A description of the workflow needed to reproduce the bug, 8 | 9 | > _NOTE:_ Don’t hesitate giving as much information as you can (OS, PHP version extensions …) 10 | 11 | ## Pull requests 12 | 13 | ### Matching coding standards 14 | 15 | Before each commit, be sure to match symfony coding standards by running the following command for fix: 16 | 17 | ```bash 18 | make cs 19 | ``` 20 | 21 | And then, add fixed file to your commit before push. 22 | 23 | ### Sending a Pull Request 24 | 25 | When you send a PR, just make sure that: 26 | 27 | * You add valid test cases. 28 | * Tests are green. 29 | * The related documentation is up-to-date. 30 | * You make the PR on the same branch you based your changes on. If you see commits 31 | that you did not make in your PR, you're doing it wrong. 32 | * Also don't forget to add a comment when you update a PR with a ping to the maintainer (``@username``), so he/she will get a notification. 33 | -------------------------------------------------------------------------------- /Command/Deploy/InstallCommand.php: -------------------------------------------------------------------------------- 1 | 7 | * 8 | * For the full copyright and license information, please view the LICENSE 9 | * file that was distributed with this source code. 10 | */ 11 | 12 | namespace RCH\CapistranoBundle\Command\Deploy; 13 | 14 | use RCH\CapistranoBundle\Generator\CapfileGenerator; 15 | use RCH\CapistranoBundle\Generator\GemfileGenerator; 16 | use RCH\CapistranoBundle\Util\CanGenerateTrait as CanGenerate; 17 | use RCH\CapistranoBundle\Util\LocalizableTrait as Localizable; 18 | use RCH\CapistranoBundle\Util\OutputWritableTrait as OutputWritable; 19 | use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand; 20 | use Symfony\Component\Console\Input\InputInterface; 21 | use Symfony\Component\Console\Output\OutputInterface; 22 | use Symfony\Component\Filesystem\Filesystem; 23 | 24 | /** 25 | * Setups Capfile & Gemfile. 26 | * 27 | * @author Robin Chalas 28 | */ 29 | class InstallCommand extends ContainerAwareCommand 30 | { 31 | use OutputWritable, Localizable, CanGenerate; 32 | 33 | /** 34 | * {@inheritdoc} 35 | */ 36 | protected function configure() 37 | { 38 | $this 39 | ->setName('rch:deploy:install') 40 | ->setDescription('Build installation files for capistrano requirements'); 41 | } 42 | 43 | /** 44 | * {@inheritdoc} 45 | */ 46 | protected function execute(InputInterface $input, OutputInterface $output) 47 | { 48 | $rootDir = $this->getRootDir(); 49 | $bundleConfigDir = $this->getPublishedConfigDir(); 50 | $fs = new Filesystem(); 51 | 52 | $this->sayWelcome($output); 53 | 54 | if (false === $fs->exists($bundleConfigDir)) { 55 | $fs->mkdir(array( 56 | $bundleConfigDir, 57 | $bundleConfigDir.'/task', 58 | $bundleConfigDir.'/staging', 59 | )); 60 | } 61 | 62 | $output->writeln(['', ' > generating ./Capfile', ' > generating ./Gemfile', '']); 63 | 64 | $requirements = ['capistrano/setup', 'capistrano/deploy', 'capistrano/composer', 'capistrano/symfony']; 65 | $gems = ["'capistrano', '~> 3.4'", "'capistrano-symfony', '~> 1.0.0.rc1'", "'capistrano-rbenv'"]; 66 | $capfile = new CapfileGenerator($requirements, $rootDir); 67 | $gemfile = new GemfileGenerator($gems, $rootDir); 68 | $this->generateMany([$capfile, $gemfile]); 69 | 70 | $output->writeln([ 71 | 'Successfully generated Capfile and Gemfile', 72 | '', 73 | ]); 74 | } 75 | } 76 | -------------------------------------------------------------------------------- /Command/Deploy/RunCommand.php: -------------------------------------------------------------------------------- 1 | 7 | * 8 | * For the full copyright and license information, please view the LICENSE 9 | * file that was distributed with this source code. 10 | */ 11 | 12 | namespace RCH\CapistranoBundle\Command\Deploy; 13 | 14 | use RCH\CapistranoBundle\Generator\StagingGenerator; 15 | use RCH\CapistranoBundle\Util\CanGenerateTrait as CanGenerate; 16 | use RCH\CapistranoBundle\Util\LocalizableTrait as Localizable; 17 | use RCH\CapistranoBundle\Util\OutputWritableTrait as OutputWritable; 18 | use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand; 19 | use Symfony\Component\Console\Exception\InvalidArgumentException; 20 | use Symfony\Component\Console\Input\InputInterface; 21 | use Symfony\Component\Console\Input\InputOption; 22 | use Symfony\Component\Console\Output\OutputInterface; 23 | use Symfony\Component\Process\ProcessBuilder; 24 | 25 | /** 26 | * Deployment command. 27 | * 28 | * @author Robin Chalas 29 | */ 30 | class RunCommand extends ContainerAwareCommand 31 | { 32 | use OutputWritable, Localizable, CanGenerate; 33 | 34 | /** 35 | * {@inheritdoc} 36 | */ 37 | protected function configure() 38 | { 39 | $this 40 | ->setDefinition(array(new InputOption('staging-name', '-sn', InputOption::VALUE_REQUIRED, 'Staging used', 'production'))) 41 | ->setName('rch:deploy:run') 42 | ->setDescription('Deploys application using Capistrano') 43 | ; 44 | } 45 | 46 | /** 47 | * Deploys application. 48 | * 49 | * @param InputInterface $input 50 | * @param OutputInterface $output 51 | */ 52 | protected function execute(InputInterface $input, OutputInterface $output) 53 | { 54 | $rootDir = $this->getRootDir(); 55 | $stagingName = $input->getOption('staging-name'); 56 | $stagingPath = $this->getCapistranoDir().'/deploy/'; 57 | $staging = sprintf('%s%s.rb', $stagingPath, $stagingName); 58 | 59 | $output->setVerbosity(OutputInterface::VERBOSITY_VERBOSE); 60 | $this->sayWelcome($output); 61 | 62 | if (false === file_exists($staging)) { 63 | $yamlStaging = sprintf('%s/config/rch/staging/%s.yml', $rootDir, $stagingName); 64 | 65 | if (false === file_exists($yamlStaging)) { 66 | throw new InvalidArgumentException(sprintf('Unable to find staging with name %s', $stagingName)); 67 | } 68 | 69 | $params = $this->parseYamlStaging($yamlStaging); 70 | $generator = new StagingGenerator($params, $stagingPath, $stagingName); 71 | 72 | $this->generate($generator); 73 | } 74 | 75 | $builder = new ProcessBuilder(['bundle', 'exec', 'cap', $stagingName, 'deploy']); 76 | $builder->setTimeout(null); 77 | $process = $builder->getProcess(); 78 | 79 | $process->run(function ($type, $buffer) use ($output) { 80 | $output->write(sprintf('%s', $buffer)); 81 | }); 82 | 83 | if (!$process->isSuccessful()) { 84 | $output->writeln(PHP_EOL); 85 | $output->writeln('Deployment failed'); 86 | $output->writeln( 87 | sprintf('Execute cap %s deploy --trace for more details', $stagingName) 88 | ); 89 | 90 | return $process->getExitCode(); 91 | } 92 | 93 | return $output->writeln( 94 | 'Project successfully deployed !' 95 | ); 96 | } 97 | } 98 | -------------------------------------------------------------------------------- /Command/Deploy/SetupCommand.php: -------------------------------------------------------------------------------- 1 | 7 | * 8 | * For the full copyright and license information, please view the LICENSE 9 | * file that was distributed with this source code. 10 | */ 11 | 12 | namespace RCH\CapistranoBundle\Command\Deploy; 13 | 14 | use RCH\CapistranoBundle\Generator\DeployGenerator; 15 | use RCH\CapistranoBundle\Generator\StagingGenerator; 16 | use RCH\CapistranoBundle\Generator\YamlStagingGenerator; 17 | use RCH\CapistranoBundle\Util\CanGenerateTrait as CanGenerate; 18 | use RCH\CapistranoBundle\Util\LocalizableTrait as Localizable; 19 | use RCH\CapistranoBundle\Util\OutputWritableTrait as OutputWritable; 20 | use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand; 21 | use Symfony\Component\Console\Helper\QuestionHelper; 22 | use Symfony\Component\Console\Input\InputInterface; 23 | use Symfony\Component\Console\Output\OutputInterface; 24 | use Symfony\Component\Console\Question\Question; 25 | use Symfony\Component\Filesystem\Filesystem; 26 | use Symfony\Component\Yaml\Yaml; 27 | 28 | /** 29 | * Setup capistrano workflow. 30 | * 31 | * @author Robin Chalas 32 | */ 33 | class SetupCommand extends ContainerAwareCommand 34 | { 35 | use OutputWritable, Localizable, CanGenerate; 36 | 37 | /** 38 | * {@inheritdoc} 39 | */ 40 | protected function configure() 41 | { 42 | $this 43 | ->setName('rch:deploy:setup') 44 | ->setDescription('Setup capistrano deployment configuration in interactive mode'); 45 | } 46 | 47 | /** 48 | * {@inheritdoc} 49 | */ 50 | protected function execute(InputInterface $input, OutputInterface $output) 51 | { 52 | } 53 | 54 | /** 55 | * Configures deployment. 56 | * 57 | * @param InputInterface $input 58 | * @param OutputInterface $output 59 | * 60 | * @return OutputInterface 61 | */ 62 | protected function interact(InputInterface $input, OutputInterface $output) 63 | { 64 | $questionHelper = $this->getHelper('question'); 65 | $formatter = $this->getHelper('formatter'); 66 | $rootDir = $this->getRootDir(); 67 | $fs = new Filesystem(); 68 | $appPath = explode('/', $rootDir); 69 | $appName = $appPath[count($appPath) - 2]; 70 | 71 | $this->initConfig($fs, $rootDir); 72 | $output->writeln([$formatter->formatSection('SETUP', 'Project settings'), '']); 73 | 74 | $deployData = $this->configureDeploy($input, $output, $questionHelper, $appName); 75 | $deploy = new DeployGenerator($deployData, $rootDir); 76 | $this->generate($deploy); 77 | 78 | $output->writeln(['', " > generating {$appName}/config/deploy.rb"]); 79 | $output->writeln(['Successfully created.', '']); 80 | $output->writeln([$formatter->formatSection('PRODUCTION', 'Remote server / SSH settings'), '']); 81 | 82 | $sshProps = $this->configureSSH($input, $output, $questionHelper, $deployData); 83 | $staging = new StagingGenerator($sshProps, $this->getCapistranoDeployDir()); 84 | $yamlStaging = new YamlStagingGenerator($sshProps, $this->getStagingsConfigDir()); 85 | 86 | $this->generateMany([$staging, $yamlStaging]); 87 | 88 | return $output->writeln('Remote server successfully configured'); 89 | } 90 | 91 | /** 92 | * Dump capistrano configuration skin from Resources directory. 93 | * 94 | * @param Filesystem $fs 95 | * @param string $rootDir Application root dir 96 | */ 97 | protected function initConfig(Filesystem $fs, $rootDir) 98 | { 99 | $bundleDir = $this->getBundleVendorDir(); 100 | $path = $this->getCapistranoDir(); 101 | 102 | if (!$fs->exists($path.'/deploy.rb') || !$fs->exists($path.'/deploy/production.rb')) { 103 | return $fs->mirror($bundleDir.'/Resources/config/capistrano', $path); 104 | } 105 | 106 | $fs->remove($path.'/deploy.rb'); 107 | $fs->remove($path.'/deploy'); 108 | $fs->remove($path); 109 | 110 | return $fs->mirror($bundleDir.'/Resources/config/capistrano', $path); 111 | } 112 | 113 | /** 114 | * Configure deploy.rb capistrano file. 115 | * 116 | * @param InputInterface $input 117 | * @param OutputInterface $output 118 | * @param QuestionHelper $questionHelper 119 | * @param string $appName 120 | * 121 | * @return array 122 | */ 123 | protected function configureDeploy(InputInterface $input, OutputInterface $output, QuestionHelper $questionHelper, $appName) 124 | { 125 | $data = []; 126 | $properties = array( 127 | 'application' => array( 128 | 'helper' => $appName, 129 | 'label' => 'Application', 130 | 'autocomplete' => [$appName], 131 | ), 132 | 'repo_url' => array( 133 | 'helper' => 'git@github.com:{user}/{repo}.git', 134 | 'label' => 'Repository', 135 | 'autocomplete' => [sprintf('git@github.com:chalasr/%s.git', $appName)], 136 | ), 137 | ); 138 | 139 | $properties += Yaml::parse(file_get_contents($this->getBundleVendorDir().'/Resources/config/setup_dialog.yml')); 140 | 141 | foreach ($properties as $key => $property) { 142 | if ('deploy_to' == $key && null !== $data['ssh_user']) { 143 | $property['helper'] = "/home/{$data['ssh_user']}/public_html"; 144 | } 145 | 146 | $question = new Question("{$property['label']} [{$property['helper']}]: ", $property['helper']); 147 | 148 | if (isset($property['autocomplete'])) { 149 | $question->setAutocompleterValues($property['autocomplete']); 150 | } 151 | 152 | $data[$key] = $questionHelper->ask($input, $output, $question); 153 | } 154 | 155 | $data['composer'] = $this->checkComposer($input, $output, $questionHelper, $data); 156 | $data['schemadb'] = $this->checkSchemaUpdate($input, $output, $questionHelper, $data); 157 | 158 | return $data; 159 | } 160 | 161 | /** 162 | * Check need of composer. 163 | * 164 | * @param InputInterface $input 165 | * @param OutputInterface $output 166 | * @param QuestionHelper $questionHelper 167 | * @param array $deployData 168 | * 169 | * @return bool 170 | */ 171 | protected function checkComposer(InputInterface $input, OutputInterface $output, QuestionHelper $questionHelper, $deployData) 172 | { 173 | $question = new Question('Download composer [yes]: ', 'yes'); 174 | $question->setAutocompleterValues(['yes', 'no']); 175 | $downloadComposer = $questionHelper->ask($input, $output, $question); 176 | $deployData['composer'] = $downloadComposer == 'yes' ? true : false; 177 | 178 | return $deployData['composer']; 179 | } 180 | 181 | /** 182 | * Check for database schema update. 183 | * 184 | * @param InputInterface $input 185 | * @param OutputInterface $output 186 | * @param QuestionHelper $questionHelper 187 | * @param array $deployData 188 | * 189 | * @return bool 190 | */ 191 | protected function checkSchemaUpdate(InputInterface $input, OutputInterface $output, QuestionHelper $questionHelper, $deployData) 192 | { 193 | $question = new Question('Update database schema [yes]: ', 'yes'); 194 | $question->setAutocompleterValues(['yes', 'no']); 195 | $wantDump = $questionHelper->ask($input, $output, $question); 196 | $deployData['schemadb'] = $wantDump == 'yes' ? true : false; 197 | 198 | return $deployData['schemadb']; 199 | } 200 | 201 | /** 202 | * Configure SSH options for production staging. 203 | * 204 | * @param InputInterface $input 205 | * @param OutputInterface $output 206 | * @param QuestionHelper $questionHelper 207 | * @param array $deployData 208 | * 209 | * @return array The production staging configuration 210 | */ 211 | protected function configureSSH(InputInterface $input, OutputInterface $output, QuestionHelper $questionHelper, $deployData) 212 | { 213 | $serverOptions = [ 214 | 'domain' => [ 215 | 'helper' => $deployData['ssh_user'], 216 | 'label' => 'Domain name', 217 | ], 218 | ]; 219 | $sshOptions = [ 220 | 'forwardAgent' => [ 221 | 'label' => 'SSH forward agent', 222 | 'helper' => 'false', 223 | ], 224 | 'authMethods' => [ 225 | 'label' => 'SSH auth method', 226 | 'helper' => 'publickey password', 227 | ], 228 | 'keys' => [ 229 | 'label' => 'Remote SSH key', 230 | 'helper' => sprintf('/home/%s/.ssh/id_rsa', $deployData['ssh_user']), 231 | ], 232 | ]; 233 | $sshProps = [ 234 | 'user' => $deployData['ssh_user'], 235 | 'keys' => '', 236 | 'forwardAgent' => false, 237 | 'authMethods' => 'publickey password', 238 | 'deployTo' => $deployData['deploy_to'], 239 | 'repoUrl' => $deployData['repo_url'], 240 | ]; 241 | 242 | $question = new Question("{$serverOptions['domain']['label']} [{$serverOptions['domain']['helper']}]: ", $serverOptions['domain']['helper']); 243 | $sshProps['domain'] = $questionHelper->ask($input, $output, $question); 244 | 245 | foreach ($sshOptions as $key => $property) { 246 | $question = new Question("{$property['label']} [{$property['helper']}]: ", $property['helper']); 247 | 248 | if (isset($property['autocomplete'])) { 249 | $question->setAutocompleterValues($property['autocomplete']); 250 | } 251 | 252 | $sshProps[$key] = $questionHelper->ask($input, $output, $question); 253 | } 254 | 255 | return $sshProps; 256 | } 257 | } 258 | -------------------------------------------------------------------------------- /DependencyInjection/Configuration.php: -------------------------------------------------------------------------------- 1 | 7 | * 8 | * For the full copyright and license information, please view the LICENSE 9 | * file that was distributed with this source code. 10 | */ 11 | 12 | namespace RCH\CapistranoBundle\DependencyInjection; 13 | 14 | use Symfony\Component\Config\Definition\Builder\TreeBuilder; 15 | use Symfony\Component\Config\Definition\ConfigurationInterface; 16 | 17 | /** 18 | * Merges configuration from app/config files. 19 | * 20 | * @author Robin Chalas 21 | */ 22 | class Configuration implements ConfigurationInterface 23 | { 24 | /** 25 | * {@inheritdoc} 26 | */ 27 | public function getConfigTreeBuilder() 28 | { 29 | $treeBuilder = new TreeBuilder(); 30 | $treeBuilder->root('rch_capistrano'); 31 | 32 | return $treeBuilder; 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /DependencyInjection/RCHCapistranoExtension.php: -------------------------------------------------------------------------------- 1 | 7 | * 8 | * For the full copyright and license information, please view the LICENSE 9 | * file that was distributed with this source code. 10 | */ 11 | 12 | namespace RCH\CapistranoBundle\DependencyInjection; 13 | 14 | use Symfony\Component\Config\FileLocator; 15 | use Symfony\Component\DependencyInjection\ContainerBuilder; 16 | use Symfony\Component\DependencyInjection\Loader; 17 | use Symfony\Component\HttpKernel\DependencyInjection\Extension; 18 | 19 | /** 20 | * This is the class that loads and manages your bundle configuration. 21 | * 22 | * @author Robin Chalas 23 | */ 24 | class RCHCapistranoExtension extends Extension 25 | { 26 | /** 27 | * {@inheritdoc} 28 | */ 29 | public function load(array $configs, ContainerBuilder $container) 30 | { 31 | $configuration = new Configuration(); 32 | $this->processConfiguration($configuration, $configs); 33 | 34 | $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config')); 35 | $loader->load('services.yml'); 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /Generator/AbstractGenerator.php: -------------------------------------------------------------------------------- 1 | 7 | * 8 | * For the full copyright and license information, please view the LICENSE 9 | * file that was distributed with this source code. 10 | */ 11 | 12 | namespace RCH\CapistranoBundle\Generator; 13 | 14 | /** 15 | * Abstract class for generators. 16 | * 17 | * @author Robin Chalas 18 | */ 19 | abstract class AbstractGenerator implements GeneratorInterface 20 | { 21 | /** 22 | * @var array 23 | */ 24 | protected $parameters; 25 | 26 | /** 27 | * @var string 28 | */ 29 | protected $path; 30 | 31 | /** 32 | * @var string 33 | */ 34 | protected $name; 35 | 36 | /** 37 | * @var mixed 38 | */ 39 | protected $file; 40 | 41 | /** 42 | * @var string 43 | */ 44 | protected static $headersTemplate = ' 45 | # This file is part of the RCHCapistranoBundle. 46 | # 47 | # (c) Robin Chalas 48 | # 49 | # For the full copyright and license information, please view the LICENSE 50 | # file that was distributed with this source code. 51 | '; 52 | 53 | /** 54 | * Constructor. 55 | * 56 | * @param array $parameters 57 | * @param string $path 58 | * @param string $name 59 | */ 60 | public function __construct(array $parameters, $path, $name) 61 | { 62 | $this->parameters = $parameters; 63 | $this->path = sprintf('%s/../%s', $path, $name); 64 | $this->name = $name; 65 | } 66 | 67 | /** 68 | * {@inheritdoc} 69 | */ 70 | public function open() 71 | { 72 | if (!is_dir($directory = dirname($this->path))) { 73 | try { 74 | mkdir($directory, 0777); 75 | } catch (\Exception $e) { 76 | throw new \RuntimeException(sprintf('Unable to create directory "%s". Please change the permissions or create the directory manually.', $directory)); 77 | } 78 | } 79 | 80 | if (file_exists($this->path)) { 81 | unlink($this->path); 82 | } 83 | 84 | $this->file = fopen($this->path, 'w'); 85 | } 86 | 87 | /** 88 | * Close generated file. 89 | */ 90 | public function close() 91 | { 92 | fclose($this->file); 93 | } 94 | 95 | /** 96 | * Add license headers. 97 | * 98 | * @internal 99 | * 100 | * @return string 101 | */ 102 | protected function addHeaders($generated) 103 | { 104 | return sprintf('%s%s%s', self::$headersTemplate, PHP_EOL, $generated); 105 | } 106 | } 107 | -------------------------------------------------------------------------------- /Generator/CapfileGenerator.php: -------------------------------------------------------------------------------- 1 | 7 | * 8 | * For the full copyright and license information, please view the LICENSE 9 | * file that was distributed with this source code. 10 | */ 11 | 12 | namespace RCH\CapistranoBundle\Generator; 13 | 14 | /** 15 | * Generates Capfile for capistrano. 16 | * 17 | * @internal 18 | * 19 | * @author Robin Chalas 20 | */ 21 | class CapfileGenerator extends AbstractGenerator 22 | { 23 | /** 24 | * @var string 25 | */ 26 | protected static $template = "require ''"; 27 | 28 | /** 29 | * @var string 30 | */ 31 | protected static $importTemplate = " 32 | 33 | Dir.glob('config/tasks/*.rake').each { |r| import r } 34 | "; 35 | 36 | /** 37 | * @param array $parameters 38 | * @param string $path 39 | * @param string $name 40 | */ 41 | public function __construct(array $parameters, $path, $name = 'Capfile') 42 | { 43 | parent::__construct($parameters, $path, $name); 44 | } 45 | 46 | /** 47 | * Writes Capfile. 48 | */ 49 | public function write() 50 | { 51 | $capfile = ''; 52 | 53 | foreach ($this->parameters as $namespace) { 54 | $line = str_replace('', $namespace, self::$template); 55 | $capfile = sprintf('%s%s%s', $capfile, PHP_EOL, $line); 56 | } 57 | 58 | $capfile .= self::$importTemplate; 59 | 60 | fwrite($this->file, $this->addHeaders($capfile)); 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /Generator/DeployGenerator.php: -------------------------------------------------------------------------------- 1 | 7 | * 8 | * For the full copyright and license information, please view the LICENSE 9 | * file that was distributed with this source code. 10 | */ 11 | 12 | namespace RCH\CapistranoBundle\Generator; 13 | 14 | /** 15 | * Generates deploy.rb file. 16 | * 17 | * @author Robin Chalas 18 | */ 19 | class DeployGenerator extends AbstractGenerator 20 | { 21 | /** 22 | * Template of deploy.rb. 23 | * 24 | * @var string 25 | */ 26 | protected static $defaultConfigTemplate = 27 | " 28 | # Default 29 | set :app_path, 'app' 30 | set :web_path, 'web' 31 | set :scm, 'git' 32 | set :format, :pretty 33 | set :log_level, :debug 34 | set :stage, 'production' 35 | set :pty, true 36 | set :log_path, fetch(:app_path) + '/logs' 37 | set :cache_path, fetch(:app_path) + '/cache' 38 | set :app_config_path, fetch(:app_path) + '/config' 39 | set :linked_files, ['app/config/parameters.yml'] 40 | 41 | # Permissions 42 | set :file_permissions_paths, [fetch(:log_path), fetch(:cache_path)] 43 | set :file_permissions_users, ['www-data'] 44 | set :webserver_user, 'www-data' 45 | 46 | # Assets 47 | set :assets_install_path, fetch(:web_path) 48 | set :assets_install_flags, '--symlink' 49 | 50 | # Composer 51 | set :composer_install_flags, '--no-dev --quiet --no-interaction --optimize-autoloader' 52 | set :composer_dump_autoload_flags, '--optimize' 53 | "; 54 | 55 | /** 56 | * Template of deploy.rb. 57 | * 58 | * @var string 59 | */ 60 | protected static $configTemplate = 61 | "# Server 62 | set :application, '' 63 | set :branch, '' 64 | set :model_manager, '' 65 | set :symfony_env, '' 66 | set :use_sudo, 67 | set :use_set_permissions, 68 | set :permission_method, 69 | set :keep_releases, 70 | "; 71 | 72 | /** 73 | * Template of composer:dowload task. 74 | * 75 | * @var string 76 | */ 77 | protected static $downloadComposerTaskTemplate = 78 | 'namespace :composer do 79 | # Download composer 80 | before :install, :download_composer 81 | end 82 | '; 83 | 84 | /** 85 | * Template of deploy:schemadb. 86 | * 87 | * @var string 88 | */ 89 | protected static $updateSchemaTaskTemplate = 90 | 'namespace :deploy do 91 | # Update database schema 92 | before :updated, :schemadb 93 | end 94 | '; 95 | 96 | /** 97 | * Constructor. 98 | * 99 | * @param array $parameters 100 | * @param string $path 101 | */ 102 | public function __construct(array $parameters, $path, $name = 'deploy.rb') 103 | { 104 | parent::__construct($parameters, $path, $name); 105 | $this->path = sprintf('%s/../config/%s', $path, $name); 106 | } 107 | 108 | /** 109 | * Writes deployment file. 110 | */ 111 | public function write() 112 | { 113 | foreach ($this->parameters as $prop => $value) { 114 | $placeHolders[] = sprintf('<%s>', $prop); 115 | $replacements[] = $value; 116 | } 117 | 118 | $config = str_replace($placeHolders, $replacements, self::$configTemplate); 119 | $config = sprintf('%s%s%s', self::$defaultConfigTemplate, PHP_EOL, $config); 120 | 121 | if (true === $this->parameters['composer']) { 122 | $config = sprintf('%s%s%s', $config, PHP_EOL, self::$downloadComposerTaskTemplate); 123 | } 124 | 125 | if (true === $this->parameters['schemadb']) { 126 | $config = sprintf('%s%s%s', $config, PHP_EOL, self::$updateSchemaTaskTemplate); 127 | } 128 | 129 | fwrite($this->file, $this->addHeaders($config)); 130 | } 131 | } 132 | -------------------------------------------------------------------------------- /Generator/GemfileGenerator.php: -------------------------------------------------------------------------------- 1 | 7 | * 8 | * For the full copyright and license information, please view the LICENSE 9 | * file that was distributed with this source code. 10 | */ 11 | 12 | namespace RCH\CapistranoBundle\Generator; 13 | 14 | /** 15 | * Generates stagings for capistrano. 16 | * 17 | * @author Robin Chalas 18 | */ 19 | class GemfileGenerator extends AbstractGenerator 20 | { 21 | /** 22 | * @var string 23 | */ 24 | protected static $template = 'gem '; 25 | 26 | private static $sourceTemplate = " 27 | 28 | source 'https://rubygems.org' 29 | "; 30 | 31 | /** 32 | * Constructor. 33 | * 34 | * @param array $parameters 35 | * @param string $path 36 | * @param string $name 37 | */ 38 | public function __construct(array $parameters, $path, $name = 'Gemfile') 39 | { 40 | parent::__construct($parameters, $path, $name); 41 | } 42 | 43 | /** 44 | * Writes Gemfile. 45 | */ 46 | public function write() 47 | { 48 | $gemfile = ''; 49 | 50 | foreach ($this->parameters as $gem) { 51 | $line = str_replace('', $gem, self::$template); 52 | $gemfile = sprintf('%s%s%s', $gemfile, PHP_EOL, $line); 53 | } 54 | 55 | $gemfile .= self::$sourceTemplate; 56 | 57 | fwrite($this->file, $this->addHeaders($gemfile)); 58 | } 59 | } 60 | -------------------------------------------------------------------------------- /Generator/GeneratorInterface.php: -------------------------------------------------------------------------------- 1 | 7 | * 8 | * For the full copyright and license information, please view the LICENSE 9 | * file that was distributed with this source code. 10 | */ 11 | 12 | namespace RCH\CapistranoBundle\Generator; 13 | 14 | /** 15 | * Interface for generators. 16 | * 17 | * @author Robin Chalas 18 | */ 19 | interface GeneratorInterface 20 | { 21 | /** 22 | * Opens an existing or newly created file. 23 | */ 24 | public function open(); 25 | 26 | /** 27 | * Writes in file. 28 | */ 29 | public function write(); 30 | 31 | /** 32 | * Closes the file. 33 | */ 34 | public function close(); 35 | } 36 | -------------------------------------------------------------------------------- /Generator/Handler.php: -------------------------------------------------------------------------------- 1 | 7 | * 8 | * For the full copyright and license information, please view the LICENSE 9 | * file that was distributed with this source code. 10 | */ 11 | 12 | namespace RCH\CapistranoBundle\Generator; 13 | 14 | /** 15 | * Handles configuration file generation. 16 | * 17 | * @author Robin Chalas 18 | */ 19 | class Handler 20 | { 21 | protected $generator; 22 | 23 | /** 24 | * Constructor. 25 | * 26 | * @param GeneratorInterface $generator 27 | */ 28 | public function __construct(GeneratorInterface $generator) 29 | { 30 | $this->generator = $generator; 31 | } 32 | 33 | /** 34 | * Generates. 35 | */ 36 | public function generate() 37 | { 38 | $this->generator->open(); 39 | $this->generator->write(); 40 | $this->generator->close(); 41 | } 42 | 43 | /** 44 | * @static 45 | * 46 | * @param GeneratorInterface $generator 47 | * 48 | * @return Handler 49 | */ 50 | public static function create(GeneratorInterface $generator) 51 | { 52 | return new self($generator); 53 | } 54 | } 55 | -------------------------------------------------------------------------------- /Generator/StagingGenerator.php: -------------------------------------------------------------------------------- 1 | 7 | * 8 | * For the full copyright and license information, please view the LICENSE 9 | * file that was distributed with this source code. 10 | */ 11 | 12 | namespace RCH\CapistranoBundle\Generator; 13 | 14 | /** 15 | * Generates stagings for capistrano. 16 | * 17 | * @author Robin Chalas 18 | */ 19 | class StagingGenerator extends AbstractGenerator 20 | { 21 | /** 22 | * @var string 23 | */ 24 | protected static $template = 25 | "server '', 26 | user: '', 27 | ssh_options: { 28 | user: '', 29 | keys: %w(), 30 | forward_agent: , 31 | auth_methods: %w(), 32 | } 33 | 34 | set :deploy_to, '' 35 | set :repo_url, '' 36 | "; 37 | 38 | /** 39 | * Constructor. 40 | * 41 | * @param array $parameters 42 | * @param string $path 43 | * @param string $name 44 | */ 45 | public function __construct(array $parameters, $path, $name = 'production') 46 | { 47 | parent::__construct($parameters, $path, $name); 48 | 49 | $this->path = sprintf('%s/%s.rb', $path, $name); 50 | } 51 | 52 | /** 53 | * Write staging in file. 54 | * 55 | * @param string $staging Generated staging 56 | */ 57 | public function write() 58 | { 59 | foreach ($this->parameters as $prop => $value) { 60 | $placeHolders[] = sprintf('<%s>', $prop); 61 | $replacements[] = $value; 62 | } 63 | 64 | $content = str_replace($placeHolders, $replacements, self::$template); 65 | 66 | fwrite($this->file, $this->addHeaders($content)); 67 | } 68 | } 69 | -------------------------------------------------------------------------------- /Generator/YamlStagingGenerator.php: -------------------------------------------------------------------------------- 1 | 7 | * 8 | * For the full copyright and license information, please view the LICENSE 9 | * file that was distributed with this source code. 10 | */ 11 | 12 | namespace RCH\CapistranoBundle\Generator; 13 | 14 | /** 15 | * Generates staging's configuration in YAML, used as source for build real '.rb' staging. 16 | * 17 | * @internal 18 | * 19 | * @author Robin Chalas 20 | */ 21 | class YamlStagingGenerator extends AbstractGenerator 22 | { 23 | /** 24 | * @var string 25 | */ 26 | protected static $template = " 27 | domain: '' 28 | user: '' 29 | keys: '' 30 | forward_agent: 31 | auth_methods: '' 32 | deploy_to: '' 33 | repo_url: '' 34 | "; 35 | 36 | /** 37 | * Constructor. 38 | * 39 | * @param array $parameters 40 | * @param string $path 41 | * @param string $name 42 | */ 43 | public function __construct(array $parameters, $path, $name = 'production') 44 | { 45 | parent::__construct($parameters, $path, $name); 46 | 47 | $this->path = sprintf('%s/%s.yml', $path, $name); 48 | } 49 | 50 | /** 51 | * Write staging in file. 52 | * 53 | * @param string $staging Generated staging 54 | */ 55 | public function write() 56 | { 57 | foreach ($this->parameters as $prop => $value) { 58 | $placeHolders[] = sprintf('<%s>', $prop); 59 | $replacements[] = $value; 60 | } 61 | 62 | $content = str_replace($placeHolders, $replacements, self::$template); 63 | 64 | fwrite($this->file, $this->addHeaders($content)); 65 | } 66 | } 67 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | ========================== 3 | 4 | Version 3, 29 June 2007 5 | 6 | Copyright © 2007 Free Software Foundation, Inc. <> 7 | 8 | Everyone is permitted to copy and distribute verbatim copies of this license 9 | document, but changing it is not allowed. 10 | 11 | ## Preamble 12 | 13 | The GNU General Public License is a free, copyleft license for software and other 14 | kinds of works. 15 | 16 | The licenses for most software and other practical works are designed to take away 17 | your freedom to share and change the works. By contrast, the GNU General Public 18 | License is intended to guarantee your freedom to share and change all versions of a 19 | program--to make sure it remains free software for all its users. We, the Free 20 | Software Foundation, use the GNU General Public License for most of our software; it 21 | applies also to any other work released this way by its authors. You can apply it to 22 | your programs, too. 23 | 24 | When we speak of free software, we are referring to freedom, not price. Our General 25 | Public Licenses are designed to make sure that you have the freedom to distribute 26 | copies of free software (and charge for them if you wish), that you receive source 27 | code or can get it if you want it, that you can change the software or use pieces of 28 | it in new free programs, and that you know you can do these things. 29 | 30 | To protect your rights, we need to prevent others from denying you these rights or 31 | asking you to surrender the rights. Therefore, you have certain responsibilities if 32 | you distribute copies of the software, or if you modify it: responsibilities to 33 | respect the freedom of others. 34 | 35 | For example, if you distribute copies of such a program, whether gratis or for a fee, 36 | you must pass on to the recipients the same freedoms that you received. You must make 37 | sure that they, too, receive or can get the source code. And you must show them these 38 | terms so they know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: (1) assert 41 | copyright on the software, and (2) offer you this License giving you legal permission 42 | to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains that there is 45 | no warranty for this free software. For both users' and authors' sake, the GPL 46 | requires that modified versions be marked as changed, so that their problems will not 47 | be attributed erroneously to authors of previous versions. 48 | 49 | Some devices are designed to deny users access to install or run modified versions of 50 | the software inside them, although the manufacturer can do so. This is fundamentally 51 | incompatible with the aim of protecting users' freedom to change the software. The 52 | systematic pattern of such abuse occurs in the area of products for individuals to 53 | use, which is precisely where it is most unacceptable. Therefore, we have designed 54 | this version of the GPL to prohibit the practice for those products. If such problems 55 | arise substantially in other domains, we stand ready to extend this provision to 56 | those domains in future versions of the GPL, as needed to protect the freedom of 57 | users. 58 | 59 | Finally, every program is threatened constantly by software patents. States should 60 | not allow patents to restrict development and use of software on general-purpose 61 | computers, but in those that do, we wish to avoid the special danger that patents 62 | applied to a free program could make it effectively proprietary. To prevent this, the 63 | GPL assures that patents cannot be used to render the program non-free. 64 | 65 | The precise terms and conditions for copying, distribution and modification follow. 66 | 67 | ## TERMS AND CONDITIONS 68 | 69 | ### 0. Definitions. 70 | 71 | “This License” refers to version 3 of the GNU General Public License. 72 | 73 | “Copyright” also means copyright-like laws that apply to other kinds of 74 | works, such as semiconductor masks. 75 | 76 | “The Program” refers to any copyrightable work licensed under this 77 | License. Each licensee is addressed as “you”. “Licensees” and 78 | “recipients” may be individuals or organizations. 79 | 80 | To “modify” a work means to copy from or adapt all or part of the work in 81 | a fashion requiring copyright permission, other than the making of an exact copy. The 82 | resulting work is called a “modified version” of the earlier work or a 83 | work “based on” the earlier work. 84 | 85 | A “covered work” means either the unmodified Program or a work based on 86 | the Program. 87 | 88 | To “propagate” a work means to do anything with it that, without 89 | permission, would make you directly or secondarily liable for infringement under 90 | applicable copyright law, except executing it on a computer or modifying a private 91 | copy. Propagation includes copying, distribution (with or without modification), 92 | making available to the public, and in some countries other activities as well. 93 | 94 | To “convey” a work means any kind of propagation that enables other 95 | parties to make or receive copies. Mere interaction with a user through a computer 96 | network, with no transfer of a copy, is not conveying. 97 | 98 | An interactive user interface displays “Appropriate Legal Notices” to the 99 | extent that it includes a convenient and prominently visible feature that (1) 100 | displays an appropriate copyright notice, and (2) tells the user that there is no 101 | warranty for the work (except to the extent that warranties are provided), that 102 | licensees may convey the work under this License, and how to view a copy of this 103 | License. If the interface presents a list of user commands or options, such as a 104 | menu, a prominent item in the list meets this criterion. 105 | 106 | ### 1. Source Code. 107 | 108 | The “source code” for a work means the preferred form of the work for 109 | making modifications to it. “Object code” means any non-source form of a 110 | work. 111 | 112 | A “Standard Interface” means an interface that either is an official 113 | standard defined by a recognized standards body, or, in the case of interfaces 114 | specified for a particular programming language, one that is widely used among 115 | developers working in that language. 116 | 117 | The “System Libraries” of an executable work include anything, other than 118 | the work as a whole, that (a) is included in the normal form of packaging a Major 119 | Component, but which is not part of that Major Component, and (b) serves only to 120 | enable use of the work with that Major Component, or to implement a Standard 121 | Interface for which an implementation is available to the public in source code form. 122 | A “Major Component”, in this context, means a major essential component 123 | (kernel, window system, and so on) of the specific operating system (if any) on which 124 | the executable work runs, or a compiler used to produce the work, or an object code 125 | interpreter used to run it. 126 | 127 | The “Corresponding Source” for a work in object code form means all the 128 | source code needed to generate, install, and (for an executable work) run the object 129 | code and to modify the work, including scripts to control those activities. However, 130 | it does not include the work's System Libraries, or general-purpose tools or 131 | generally available free programs which are used unmodified in performing those 132 | activities but which are not part of the work. For example, Corresponding Source 133 | includes interface definition files associated with source files for the work, and 134 | the source code for shared libraries and dynamically linked subprograms that the work 135 | is specifically designed to require, such as by intimate data communication or 136 | control flow between those subprograms and other parts of the work. 137 | 138 | The Corresponding Source need not include anything that users can regenerate 139 | automatically from other parts of the Corresponding Source. 140 | 141 | The Corresponding Source for a work in source code form is that same work. 142 | 143 | ### 2. Basic Permissions. 144 | 145 | All rights granted under this License are granted for the term of copyright on the 146 | Program, and are irrevocable provided the stated conditions are met. This License 147 | explicitly affirms your unlimited permission to run the unmodified Program. The 148 | output from running a covered work is covered by this License only if the output, 149 | given its content, constitutes a covered work. This License acknowledges your rights 150 | of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not convey, without 153 | conditions so long as your license otherwise remains in force. You may convey covered 154 | works to others for the sole purpose of having them make modifications exclusively 155 | for you, or provide you with facilities for running those works, provided that you 156 | comply with the terms of this License in conveying all material for which you do not 157 | control copyright. Those thus making or running the covered works for you must do so 158 | exclusively on your behalf, under your direction and control, on terms that prohibit 159 | them from making any copies of your copyrighted material outside their relationship 160 | with you. 161 | 162 | Conveying under any other circumstances is permitted solely under the conditions 163 | stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 164 | 165 | ### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 166 | 167 | No covered work shall be deemed part of an effective technological measure under any 168 | applicable law fulfilling obligations under article 11 of the WIPO copyright treaty 169 | adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention 170 | of such measures. 171 | 172 | When you convey a covered work, you waive any legal power to forbid circumvention of 173 | technological measures to the extent such circumvention is effected by exercising 174 | rights under this License with respect to the covered work, and you disclaim any 175 | intention to limit operation or modification of the work as a means of enforcing, 176 | against the work's users, your or third parties' legal rights to forbid circumvention 177 | of technological measures. 178 | 179 | ### 4. Conveying Verbatim Copies. 180 | 181 | You may convey verbatim copies of the Program's source code as you receive it, in any 182 | medium, provided that you conspicuously and appropriately publish on each copy an 183 | appropriate copyright notice; keep intact all notices stating that this License and 184 | any non-permissive terms added in accord with section 7 apply to the code; keep 185 | intact all notices of the absence of any warranty; and give all recipients a copy of 186 | this License along with the Program. 187 | 188 | You may charge any price or no price for each copy that you convey, and you may offer 189 | support or warranty protection for a fee. 190 | 191 | ### 5. Conveying Modified Source Versions. 192 | 193 | You may convey a work based on the Program, or the modifications to produce it from 194 | the Program, in the form of source code under the terms of section 4, provided that 195 | you also meet all of these conditions: 196 | 197 | * **a)** The work must carry prominent notices stating that you modified it, and giving a 198 | relevant date. 199 | * **b)** The work must carry prominent notices stating that it is released under this 200 | License and any conditions added under section 7. This requirement modifies the 201 | requirement in section 4 to “keep intact all notices”. 202 | * **c)** You must license the entire work, as a whole, under this License to anyone who 203 | comes into possession of a copy. This License will therefore apply, along with any 204 | applicable section 7 additional terms, to the whole of the work, and all its parts, 205 | regardless of how they are packaged. This License gives no permission to license the 206 | work in any other way, but it does not invalidate such permission if you have 207 | separately received it. 208 | * **d)** If the work has interactive user interfaces, each must display Appropriate Legal 209 | Notices; however, if the Program has interactive interfaces that do not display 210 | Appropriate Legal Notices, your work need not make them do so. 211 | 212 | A compilation of a covered work with other separate and independent works, which are 213 | not by their nature extensions of the covered work, and which are not combined with 214 | it such as to form a larger program, in or on a volume of a storage or distribution 215 | medium, is called an “aggregate” if the compilation and its resulting 216 | copyright are not used to limit the access or legal rights of the compilation's users 217 | beyond what the individual works permit. Inclusion of a covered work in an aggregate 218 | does not cause this License to apply to the other parts of the aggregate. 219 | 220 | ### 6. Conveying Non-Source Forms. 221 | 222 | You may convey a covered work in object code form under the terms of sections 4 and 223 | 5, provided that you also convey the machine-readable Corresponding Source under the 224 | terms of this License, in one of these ways: 225 | 226 | * **a)** Convey the object code in, or embodied in, a physical product (including a 227 | physical distribution medium), accompanied by the Corresponding Source fixed on a 228 | durable physical medium customarily used for software interchange. 229 | * **b)** Convey the object code in, or embodied in, a physical product (including a 230 | physical distribution medium), accompanied by a written offer, valid for at least 231 | three years and valid for as long as you offer spare parts or customer support for 232 | that product model, to give anyone who possesses the object code either (1) a copy of 233 | the Corresponding Source for all the software in the product that is covered by this 234 | License, on a durable physical medium customarily used for software interchange, for 235 | a price no more than your reasonable cost of physically performing this conveying of 236 | source, or (2) access to copy the Corresponding Source from a network server at no 237 | charge. 238 | * **c)** Convey individual copies of the object code with a copy of the written offer to 239 | provide the Corresponding Source. This alternative is allowed only occasionally and 240 | noncommercially, and only if you received the object code with such an offer, in 241 | accord with subsection 6b. 242 | * **d)** Convey the object code by offering access from a designated place (gratis or for 243 | a charge), and offer equivalent access to the Corresponding Source in the same way 244 | through the same place at no further charge. You need not require recipients to copy 245 | the Corresponding Source along with the object code. If the place to copy the object 246 | code is a network server, the Corresponding Source may be on a different server 247 | (operated by you or a third party) that supports equivalent copying facilities, 248 | provided you maintain clear directions next to the object code saying where to find 249 | the Corresponding Source. Regardless of what server hosts the Corresponding Source, 250 | you remain obligated to ensure that it is available for as long as needed to satisfy 251 | these requirements. 252 | * **e)** Convey the object code using peer-to-peer transmission, provided you inform 253 | other peers where the object code and Corresponding Source of the work are being 254 | offered to the general public at no charge under subsection 6d. 255 | 256 | A separable portion of the object code, whose source code is excluded from the 257 | Corresponding Source as a System Library, need not be included in conveying the 258 | object code work. 259 | 260 | A “User Product” is either (1) a “consumer product”, which 261 | means any tangible personal property which is normally used for personal, family, or 262 | household purposes, or (2) anything designed or sold for incorporation into a 263 | dwelling. In determining whether a product is a consumer product, doubtful cases 264 | shall be resolved in favor of coverage. For a particular product received by a 265 | particular user, “normally used” refers to a typical or common use of 266 | that class of product, regardless of the status of the particular user or of the way 267 | in which the particular user actually uses, or expects or is expected to use, the 268 | product. A product is a consumer product regardless of whether the product has 269 | substantial commercial, industrial or non-consumer uses, unless such uses represent 270 | the only significant mode of use of the product. 271 | 272 | “Installation Information” for a User Product means any methods, 273 | procedures, authorization keys, or other information required to install and execute 274 | modified versions of a covered work in that User Product from a modified version of 275 | its Corresponding Source. The information must suffice to ensure that the continued 276 | functioning of the modified object code is in no case prevented or interfered with 277 | solely because modification has been made. 278 | 279 | If you convey an object code work under this section in, or with, or specifically for 280 | use in, a User Product, and the conveying occurs as part of a transaction in which 281 | the right of possession and use of the User Product is transferred to the recipient 282 | in perpetuity or for a fixed term (regardless of how the transaction is 283 | characterized), the Corresponding Source conveyed under this section must be 284 | accompanied by the Installation Information. But this requirement does not apply if 285 | neither you nor any third party retains the ability to install modified object code 286 | on the User Product (for example, the work has been installed in ROM). 287 | 288 | The requirement to provide Installation Information does not include a requirement to 289 | continue to provide support service, warranty, or updates for a work that has been 290 | modified or installed by the recipient, or for the User Product in which it has been 291 | modified or installed. Access to a network may be denied when the modification itself 292 | materially and adversely affects the operation of the network or violates the rules 293 | and protocols for communication across the network. 294 | 295 | Corresponding Source conveyed, and Installation Information provided, in accord with 296 | this section must be in a format that is publicly documented (and with an 297 | implementation available to the public in source code form), and must require no 298 | special password or key for unpacking, reading or copying. 299 | 300 | ### 7. Additional Terms. 301 | 302 | “Additional permissions” are terms that supplement the terms of this 303 | License by making exceptions from one or more of its conditions. Additional 304 | permissions that are applicable to the entire Program shall be treated as though they 305 | were included in this License, to the extent that they are valid under applicable 306 | law. If additional permissions apply only to part of the Program, that part may be 307 | used separately under those permissions, but the entire Program remains governed by 308 | this License without regard to the additional permissions. 309 | 310 | When you convey a copy of a covered work, you may at your option remove any 311 | additional permissions from that copy, or from any part of it. (Additional 312 | permissions may be written to require their own removal in certain cases when you 313 | modify the work.) You may place additional permissions on material, added by you to a 314 | covered work, for which you have or can give appropriate copyright permission. 315 | 316 | Notwithstanding any other provision of this License, for material you add to a 317 | covered work, you may (if authorized by the copyright holders of that material) 318 | supplement the terms of this License with terms: 319 | 320 | * **a)** Disclaiming warranty or limiting liability differently from the terms of 321 | sections 15 and 16 of this License; or 322 | * **b)** Requiring preservation of specified reasonable legal notices or author 323 | attributions in that material or in the Appropriate Legal Notices displayed by works 324 | containing it; or 325 | * **c)** Prohibiting misrepresentation of the origin of that material, or requiring that 326 | modified versions of such material be marked in reasonable ways as different from the 327 | original version; or 328 | * **d)** Limiting the use for publicity purposes of names of licensors or authors of the 329 | material; or 330 | * **e)** Declining to grant rights under trademark law for use of some trade names, 331 | trademarks, or service marks; or 332 | * **f)** Requiring indemnification of licensors and authors of that material by anyone 333 | who conveys the material (or modified versions of it) with contractual assumptions of 334 | liability to the recipient, for any liability that these contractual assumptions 335 | directly impose on those licensors and authors. 336 | 337 | All other non-permissive additional terms are considered “further 338 | restrictions” within the meaning of section 10. If the Program as you received 339 | it, or any part of it, contains a notice stating that it is governed by this License 340 | along with a term that is a further restriction, you may remove that term. If a 341 | license document contains a further restriction but permits relicensing or conveying 342 | under this License, you may add to a covered work material governed by the terms of 343 | that license document, provided that the further restriction does not survive such 344 | relicensing or conveying. 345 | 346 | If you add terms to a covered work in accord with this section, you must place, in 347 | the relevant source files, a statement of the additional terms that apply to those 348 | files, or a notice indicating where to find the applicable terms. 349 | 350 | Additional terms, permissive or non-permissive, may be stated in the form of a 351 | separately written license, or stated as exceptions; the above requirements apply 352 | either way. 353 | 354 | ### 8. Termination. 355 | 356 | You may not propagate or modify a covered work except as expressly provided under 357 | this License. Any attempt otherwise to propagate or modify it is void, and will 358 | automatically terminate your rights under this License (including any patent licenses 359 | granted under the third paragraph of section 11). 360 | 361 | However, if you cease all violation of this License, then your license from a 362 | particular copyright holder is reinstated (a) provisionally, unless and until the 363 | copyright holder explicitly and finally terminates your license, and (b) permanently, 364 | if the copyright holder fails to notify you of the violation by some reasonable means 365 | prior to 60 days after the cessation. 366 | 367 | Moreover, your license from a particular copyright holder is reinstated permanently 368 | if the copyright holder notifies you of the violation by some reasonable means, this 369 | is the first time you have received notice of violation of this License (for any 370 | work) from that copyright holder, and you cure the violation prior to 30 days after 371 | your receipt of the notice. 372 | 373 | Termination of your rights under this section does not terminate the licenses of 374 | parties who have received copies or rights from you under this License. If your 375 | rights have been terminated and not permanently reinstated, you do not qualify to 376 | receive new licenses for the same material under section 10. 377 | 378 | ### 9. Acceptance Not Required for Having Copies. 379 | 380 | You are not required to accept this License in order to receive or run a copy of the 381 | Program. Ancillary propagation of a covered work occurring solely as a consequence of 382 | using peer-to-peer transmission to receive a copy likewise does not require 383 | acceptance. However, nothing other than this License grants you permission to 384 | propagate or modify any covered work. These actions infringe copyright if you do not 385 | accept this License. Therefore, by modifying or propagating a covered work, you 386 | indicate your acceptance of this License to do so. 387 | 388 | ### 10. Automatic Licensing of Downstream Recipients. 389 | 390 | Each time you convey a covered work, the recipient automatically receives a license 391 | from the original licensors, to run, modify and propagate that work, subject to this 392 | License. You are not responsible for enforcing compliance by third parties with this 393 | License. 394 | 395 | An “entity transaction” is a transaction transferring control of an 396 | organization, or substantially all assets of one, or subdividing an organization, or 397 | merging organizations. If propagation of a covered work results from an entity 398 | transaction, each party to that transaction who receives a copy of the work also 399 | receives whatever licenses to the work the party's predecessor in interest had or 400 | could give under the previous paragraph, plus a right to possession of the 401 | Corresponding Source of the work from the predecessor in interest, if the predecessor 402 | has it or can get it with reasonable efforts. 403 | 404 | You may not impose any further restrictions on the exercise of the rights granted or 405 | affirmed under this License. For example, you may not impose a license fee, royalty, 406 | or other charge for exercise of rights granted under this License, and you may not 407 | initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging 408 | that any patent claim is infringed by making, using, selling, offering for sale, or 409 | importing the Program or any portion of it. 410 | 411 | ### 11. Patents. 412 | 413 | A “contributor” is a copyright holder who authorizes use under this 414 | License of the Program or a work on which the Program is based. The work thus 415 | licensed is called the contributor's “contributor version”. 416 | 417 | A contributor's “essential patent claims” are all patent claims owned or 418 | controlled by the contributor, whether already acquired or hereafter acquired, that 419 | would be infringed by some manner, permitted by this License, of making, using, or 420 | selling its contributor version, but do not include claims that would be infringed 421 | only as a consequence of further modification of the contributor version. For 422 | purposes of this definition, “control” includes the right to grant patent 423 | sublicenses in a manner consistent with the requirements of this License. 424 | 425 | Each contributor grants you a non-exclusive, worldwide, royalty-free patent license 426 | under the contributor's essential patent claims, to make, use, sell, offer for sale, 427 | import and otherwise run, modify and propagate the contents of its contributor 428 | version. 429 | 430 | In the following three paragraphs, a “patent license” is any express 431 | agreement or commitment, however denominated, not to enforce a patent (such as an 432 | express permission to practice a patent or covenant not to sue for patent 433 | infringement). To “grant” such a patent license to a party means to make 434 | such an agreement or commitment not to enforce a patent against the party. 435 | 436 | If you convey a covered work, knowingly relying on a patent license, and the 437 | Corresponding Source of the work is not available for anyone to copy, free of charge 438 | and under the terms of this License, through a publicly available network server or 439 | other readily accessible means, then you must either (1) cause the Corresponding 440 | Source to be so available, or (2) arrange to deprive yourself of the benefit of the 441 | patent license for this particular work, or (3) arrange, in a manner consistent with 442 | the requirements of this License, to extend the patent license to downstream 443 | recipients. “Knowingly relying” means you have actual knowledge that, but 444 | for the patent license, your conveying the covered work in a country, or your 445 | recipient's use of the covered work in a country, would infringe one or more 446 | identifiable patents in that country that you have reason to believe are valid. 447 | 448 | If, pursuant to or in connection with a single transaction or arrangement, you 449 | convey, or propagate by procuring conveyance of, a covered work, and grant a patent 450 | license to some of the parties receiving the covered work authorizing them to use, 451 | propagate, modify or convey a specific copy of the covered work, then the patent 452 | license you grant is automatically extended to all recipients of the covered work and 453 | works based on it. 454 | 455 | A patent license is “discriminatory” if it does not include within the 456 | scope of its coverage, prohibits the exercise of, or is conditioned on the 457 | non-exercise of one or more of the rights that are specifically granted under this 458 | License. You may not convey a covered work if you are a party to an arrangement with 459 | a third party that is in the business of distributing software, under which you make 460 | payment to the third party based on the extent of your activity of conveying the 461 | work, and under which the third party grants, to any of the parties who would receive 462 | the covered work from you, a discriminatory patent license (a) in connection with 463 | copies of the covered work conveyed by you (or copies made from those copies), or (b) 464 | primarily for and in connection with specific products or compilations that contain 465 | the covered work, unless you entered into that arrangement, or that patent license 466 | was granted, prior to 28 March 2007. 467 | 468 | Nothing in this License shall be construed as excluding or limiting any implied 469 | license or other defenses to infringement that may otherwise be available to you 470 | under applicable patent law. 471 | 472 | ### 12. No Surrender of Others' Freedom. 473 | 474 | If conditions are imposed on you (whether by court order, agreement or otherwise) 475 | that contradict the conditions of this License, they do not excuse you from the 476 | conditions of this License. If you cannot convey a covered work so as to satisfy 477 | simultaneously your obligations under this License and any other pertinent 478 | obligations, then as a consequence you may not convey it at all. For example, if you 479 | agree to terms that obligate you to collect a royalty for further conveying from 480 | those to whom you convey the Program, the only way you could satisfy both those terms 481 | and this License would be to refrain entirely from conveying the Program. 482 | 483 | ### 13. Use with the GNU Affero General Public License. 484 | 485 | Notwithstanding any other provision of this License, you have permission to link or 486 | combine any covered work with a work licensed under version 3 of the GNU Affero 487 | General Public License into a single combined work, and to convey the resulting work. 488 | The terms of this License will continue to apply to the part which is the covered 489 | work, but the special requirements of the GNU Affero General Public License, section 490 | 13, concerning interaction through a network will apply to the combination as such. 491 | 492 | ### 14. Revised Versions of this License. 493 | 494 | The Free Software Foundation may publish revised and/or new versions of the GNU 495 | General Public License from time to time. Such new versions will be similar in spirit 496 | to the present version, but may differ in detail to address new problems or concerns. 497 | 498 | Each version is given a distinguishing version number. If the Program specifies that 499 | a certain numbered version of the GNU General Public License “or any later 500 | version” applies to it, you have the option of following the terms and 501 | conditions either of that numbered version or of any later version published by the 502 | Free Software Foundation. If the Program does not specify a version number of the GNU 503 | General Public License, you may choose any version ever published by the Free 504 | Software Foundation. 505 | 506 | If the Program specifies that a proxy can decide which future versions of the GNU 507 | General Public License can be used, that proxy's public statement of acceptance of a 508 | version permanently authorizes you to choose that version for the Program. 509 | 510 | Later license versions may give you additional or different permissions. However, no 511 | additional obligations are imposed on any author or copyright holder as a result of 512 | your choosing to follow a later version. 513 | 514 | ### 15. Disclaimer of Warranty. 515 | 516 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 517 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 518 | PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER 519 | EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 520 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE 521 | QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE 522 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 523 | 524 | ### 16. Limitation of Liability. 525 | 526 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY 527 | COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS 528 | PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, 529 | INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 530 | PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE 531 | OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE 532 | WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 533 | POSSIBILITY OF SUCH DAMAGES. 534 | 535 | ### 17. Interpretation of Sections 15 and 16. 536 | 537 | If the disclaimer of warranty and limitation of liability provided above cannot be 538 | given local legal effect according to their terms, reviewing courts shall apply local 539 | law that most closely approximates an absolute waiver of all civil liability in 540 | connection with the Program, unless a warranty or assumption of liability accompanies 541 | a copy of the Program in return for a fee. 542 | 543 | END OF TERMS AND CONDITIONS 544 | 545 | ## How to Apply These Terms to Your New Programs 546 | 547 | If you develop a new program, and you want it to be of the greatest possible use to 548 | the public, the best way to achieve this is to make it free software which everyone 549 | can redistribute and change under these terms. 550 | 551 | To do so, attach the following notices to the program. It is safest to attach them 552 | to the start of each source file to most effectively state the exclusion of warranty; 553 | and each file should have at least the “copyright” line and a pointer to 554 | where the full notice is found. 555 | 556 | 557 | Copyright (C) 558 | 559 | This program is free software: you can redistribute it and/or modify 560 | it under the terms of the GNU General Public License as published by 561 | the Free Software Foundation, either version 3 of the License, or 562 | (at your option) any later version. 563 | 564 | This program is distributed in the hope that it will be useful, 565 | but WITHOUT ANY WARRANTY; without even the implied warranty of 566 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 567 | GNU General Public License for more details. 568 | 569 | You should have received a copy of the GNU General Public License 570 | along with this program. If not, see . 571 | 572 | Also add information on how to contact you by electronic and paper mail. 573 | 574 | If the program does terminal interaction, make it output a short notice like this 575 | when it starts in an interactive mode: 576 | 577 | Copyright (C) 578 | This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. 579 | This is free software, and you are welcome to redistribute it 580 | under certain conditions; type 'show c' for details. 581 | 582 | The hypothetical commands 'show w' and 'show c' should show the appropriate parts of 583 | the General Public License. Of course, your program's commands might be different; 584 | for a GUI interface, you would use an “about box”. 585 | 586 | You should also get your employer (if you work as a programmer) or school, if any, to 587 | sign a “copyright disclaimer” for the program, if necessary. For more 588 | information on this, and how to apply and follow the GNU GPL, see 589 | <>. 590 | 591 | The GNU General Public License does not permit incorporating your program into 592 | proprietary programs. If your program is a subroutine library, you may consider it 593 | more useful to permit linking proprietary applications with the library. If this is 594 | what you want to do, use the GNU Lesser General Public License instead of this 595 | License. But first, please read 596 | <>. 597 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | cs: 2 | ./vendor/fabpot/php-cs-fixer/php-cs-fixer fix --verbose --config-file=.php_cs 3 | 4 | cs_dry_run: 5 | ./vendor/fabpot/php-cs-fixer/php-cs-fixer fix --verbose --dry-run 6 | 7 | test: 8 | phpunit 9 | -------------------------------------------------------------------------------- /RCHCapistranoBundle.php: -------------------------------------------------------------------------------- 1 | 7 | * 8 | * For the full copyright and license information, please view the LICENSE 9 | * file that was distributed with this source code. 10 | */ 11 | 12 | namespace RCH\CapistranoBundle; 13 | 14 | use Symfony\Component\HttpKernel\Bundle\Bundle; 15 | 16 | class RCHCapistranoBundle extends Bundle 17 | { 18 | } 19 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # RCH/CapistranoBundle 2 | 3 | [![Build Status](https://travis-ci.org/chalasr/RCHCapistranoBundle.svg?branch=master)](https://travis-ci.org/chalasr/RCHCapistranoBundle) 4 | [![SensioLabsInsight](https://insight.sensiolabs.com/projects/e814ac8b-4a1c-498d-b9ea-6e1edd2fb26f/mini.png)](https://insight.sensiolabs.com/projects/e814ac8b-4a1c-498d-b9ea-6e1edd2fb26f) 5 | 6 | ![](Resources/doc/SCREENCAST.gif) 7 | 8 | Integrates deployment as part of your development environment. 9 | 10 | - _Sets up a fast and automated deployment workflow_ 11 | - _Creates stagings in configuration format (YAML, PHP, XML)_ 12 | - _Controls tasks execution order through namespaces_ 13 | - _Generates custom tasks and environment variables_. 14 | 15 | Prerequisites 16 | ============= 17 | 18 | - Ruby >= 2.0 19 | 20 | This version of the bundle requires __Symfony 3+__. 21 | For a Symfony version between _2.4.x_ and the last LTS release, [__please use the 1.0 branch__](https://github.com/chalasr/rchcapistranobundle/tree/1.0). 22 | 23 | Installation 24 | ============ 25 | 26 | Download the bundle 27 | ------------------------------------------ 28 | 29 | ```bash 30 | $ composer require rch/capistrano-bundle:~2.0 31 | ``` 32 | 33 | This command requires you to have Composer installed globally, as explained 34 | in the [installation chapter](https://getcomposer.org/doc/00-intro.md) 35 | of the Composer documentation. 36 | 37 | Enable the Bundle 38 | ----------------- 39 | 40 | Then, enable the bundle by adding it to the list of registered bundles 41 | in the `app/AppKernel.php` file of your project: 42 | 43 | ```php 44 | // app/AppKernel.php 45 | 46 | $bundles = array( 47 | // ... 48 | new RCH\CapistranoBundle\RCHCapistranoBundle(), 49 | ); 50 | ``` 51 | 52 | Install & Configure Capistrano 53 | ------------------------- 54 | 55 | Build installation files for capistrano 56 | ```bash 57 | $ app/console rch:deploy:install 58 | ``` 59 | 60 | Install dependencies 61 | ```bash 62 | $ bundle install 63 | ``` 64 | 65 | Usage 66 | ====== 67 | 68 | Setup deployment configuration in interactive mode 69 | ```bash 70 | $ app/console rch:deploy:setup 71 | ``` 72 | 73 | Build Stagings 74 | --------------- 75 | 76 | ```yaml 77 | # app/config/rch/stagings/[staging].yml 78 | 79 | # Remote host 80 | domain: 'ssh_host' 81 | # Remote user 82 | user: 'ssh_user' 83 | # Remote key 84 | keys: '/home/ssh_user/.ssh/id_rsa' 85 | # Forward Agent 86 | forward_agent: 'false' 87 | # Authentication mode 88 | auth_methods: 'publickey password' 89 | # Deployment path 90 | deploy_to: '/path/to/deploy' 91 | ``` 92 | 93 | Run deployment 94 | -------------- 95 | 96 | ```bash 97 | $ app/console rch:deploy:run --staging-name=[STAGING-NAME] 98 | ``` 99 | 100 | Advanced usage 101 | =============== 102 | 103 | Look at [the capistrano documentation](https://github.com/capistrano/capistrano#usage). 104 | 105 | Contributing 106 | ============ 107 | 108 | This bundle needs help! 109 | For the contribution guidelines, see the [CONTRIBUTING.md](CONTRIBUTING.md) distributed file. 110 | 111 | Todo 112 | ----- 113 | 114 | - Command\Generate\GenerateStagingCommand, takes an yaml file as optional argument (even look for an existing if the argument is not set) and generates a staging for capistrano in interactive mode (optional). 115 | 116 | - Make the path of config files (staging, task) configurable using a bundle Extension. 117 | 118 | - Handle XML/PHP in GenerateStagingCommand. 119 | 120 | License 121 | ======= 122 | 123 | [![License](http://img.shields.io/:license-gpl3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0.html) 124 | -------------------------------------------------------------------------------- /Resources/config/capistrano/deploy/production.rb: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/chalasr/RCHCapistranoBundle/c4a4cbaa2bc05f33bf431fd3afe6cac39947640e/Resources/config/capistrano/deploy/production.rb -------------------------------------------------------------------------------- /Resources/config/capistrano/tasks/download_composer.rake: -------------------------------------------------------------------------------- 1 | desc "Download Composer" 2 | task :download_composer do 3 | on roles(:all) do 4 | execute "cd #{shared_path} && curl -s https://getcomposer.org/installer | php" 5 | SSHKit.config.command_map[:composer] = "#{shared_path.join("composer.phar")}" 6 | end 7 | end 8 | -------------------------------------------------------------------------------- /Resources/config/capistrano/tasks/update_db_schema.rake: -------------------------------------------------------------------------------- 1 | task :schemadb do 2 | invoke 'symfony:console', 'doctrine:schema:update', '--force' 3 | end 4 | -------------------------------------------------------------------------------- /Resources/config/services.yml: -------------------------------------------------------------------------------- 1 | parameters: 2 | rch_capistrano.capitalizer.class: RCH\CapistranoBundle\Service\Capitalizer 3 | 4 | services: 5 | rch_capistrano.capitalizer: 6 | class: "%rch_capistrano.capitalizer.class%" 7 | -------------------------------------------------------------------------------- /Resources/config/setup_dialog.yml: -------------------------------------------------------------------------------- 1 | branch: 2 | helper: 'master' 3 | label: 'Git branch' 4 | 5 | ssh_user: 6 | helper: '' 7 | label: SSH Username 8 | 9 | deploy_to: 10 | helper: ~ 11 | label: 'Remote directory' 12 | 13 | model_manager: 14 | helper: 'doctrine' 15 | label: 'Model manager' 16 | 17 | symfony_env: 18 | helper: 'prod' 19 | label: 'Environment' 20 | 21 | use_sudo: 22 | helper: 'false' 23 | label: 'Use sudo' 24 | autocomplete: ['true', 'false'] 25 | 26 | use_set_permissions: 27 | helper: 'true' 28 | label: 'Set permissions' 29 | autocomplete: ['true', 'false'] 30 | 31 | permission_method: 32 | helper: ':chmod' 33 | label: 'Permissions method' 34 | autocomplete: [':chmod', ':acl'] 35 | 36 | keep_releases: 37 | helper: 3 38 | label: 'Number of releases' 39 | -------------------------------------------------------------------------------- /Resources/doc/SCREENCAP.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/chalasr/RCHCapistranoBundle/c4a4cbaa2bc05f33bf431fd3afe6cac39947640e/Resources/doc/SCREENCAP.gif -------------------------------------------------------------------------------- /Resources/doc/SCREENCAST.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/chalasr/RCHCapistranoBundle/c4a4cbaa2bc05f33bf431fd3afe6cac39947640e/Resources/doc/SCREENCAST.gif -------------------------------------------------------------------------------- /Service/Capitalizer.php: -------------------------------------------------------------------------------- 1 | 7 | * 8 | * For the full copyright and license information, please view the LICENSE 9 | * file that was distributed with this source code. 10 | */ 11 | 12 | namespace RCH\CapistranoBundle\Service; 13 | 14 | /** 15 | * Capitalizes strings corresponding to language. 16 | * 17 | * @author Robin Chalas 18 | */ 19 | class Capitalizer 20 | { 21 | /** 22 | * Convert strings from under_scores to CamelCase. 23 | * 24 | * @param mixed $base 25 | * 26 | * @return mixed 27 | */ 28 | public function camelize($base) 29 | { 30 | $callback = create_function('$c', 'return strtoupper($c[1]);'); 31 | 32 | if (!is_array($base)) { 33 | return preg_replace_callback('/_([a-z])/', $callback, $base); 34 | } 35 | 36 | foreach ($base as $key => $val) { 37 | unset($base[$key]); 38 | $newKey = preg_replace_callback('/_([a-z])/', $callback, $key); 39 | $base[$newKey] = $val; 40 | } 41 | 42 | return $base; 43 | } 44 | 45 | /** 46 | * Converts strings from camelCase to under_score. 47 | * 48 | * @param mixed $base 49 | * 50 | * @return mixed 51 | */ 52 | public function uncamelize($base) 53 | { 54 | $callback = create_function('$c', 'return "_" . strtolower($c[1]);'); 55 | 56 | if (!is_array($base)) { 57 | $base[0] = strtolower($base[0]); 58 | 59 | return preg_replace_callback('/([A-Z])/', $callback, $base); 60 | } 61 | 62 | foreach ($base as $key => $val) { 63 | unset($base[$key]); 64 | $newKey = preg_replace_callback('/([A-Z])/', $callback, $key); 65 | $base[$newKey] = $val; 66 | } 67 | 68 | return $base; 69 | } 70 | } 71 | -------------------------------------------------------------------------------- /Test/Generator/StagingGeneratorTest.php: -------------------------------------------------------------------------------- 1 | 7 | * 8 | * For the full copyright and license information, please view the LICENSE 9 | * file that was distributed with this source code. 10 | */ 11 | 12 | namespace RCH\CapistranoBundle\Test\Generator; 13 | 14 | use RCH\CapistranoBundle\Generator\GeneratorInterface; 15 | use RCH\CapistranoBundle\Generator\StagingGenerator; 16 | 17 | /** 18 | * Tests the StagingGenerator. 19 | * 20 | * @author Robin Chalas 21 | */ 22 | class StagingGeneratorTest extends \PHPUnit_Framework_TestCase 23 | { 24 | /** @var string */ 25 | protected $path; 26 | 27 | /** @var string */ 28 | protected $name; 29 | 30 | /** @var array */ 31 | protected $params; 32 | 33 | /** @var string */ 34 | protected $expected = " 35 | # This file is part of the RCHCapistranoBundle. 36 | # 37 | # (c) Robin Chalas 38 | # 39 | # For the full copyright and license information, please view the LICENSE 40 | # file that was distributed with this source code. 41 | 42 | server 'rch.fr', 43 | user: 'chalasr', 44 | ssh_options: { 45 | user: 'chalasr', 46 | keys: %w(/home/ssh_user/.ssh/id_rsa), 47 | forward_agent: false, 48 | auth_methods: %w(publickey password), 49 | } 50 | 51 | set :deploy_to, '/var/www/html' 52 | set :repo_url, 'git@github.com:chalasr/RCHCapistranoBundle' 53 | "; 54 | 55 | public function setUp() 56 | { 57 | $this->path = sys_get_temp_dir().'/stagings/'; 58 | $this->name = 'test'; 59 | $this->params = array( 60 | 'domain' => 'rch.fr', 61 | 'user' => 'chalasr', 62 | 'keys' => '/home/ssh_user/.ssh/id_rsa', 63 | 'forwardAgent' => 'false', 64 | 'authMethods' => 'publickey password', 65 | 'deployTo' => '/var/www/html', 66 | 'repoUrl' => 'git@github.com:chalasr/RCHCapistranoBundle' 67 | ); 68 | } 69 | 70 | public function testGenerate() 71 | { 72 | $generator = new StagingGenerator($this->params, $this->path, $this->name); 73 | $this->generateStaging($generator); 74 | 75 | $this->assertEquals($this->expected, file_get_contents(sprintf('%s/%s.rb', $this->path, $this->name))); 76 | } 77 | 78 | private function generateStaging(GeneratorInterface $generator) 79 | { 80 | $generator->open(); 81 | $generator->write(); 82 | $generator->close(); 83 | } 84 | 85 | public function tearDown() 86 | { 87 | unlink(sprintf('%s/%s.rb', $this->path, $this->name)); 88 | rmdir($this->path); 89 | } 90 | } 91 | -------------------------------------------------------------------------------- /Test/Generator/YamlStagingGeneratorTest.php: -------------------------------------------------------------------------------- 1 | 7 | * 8 | * For the full copyright and license information, please view the LICENSE 9 | * file that was distributed with this source code. 10 | */ 11 | 12 | namespace RCH\CapistranoBundle\Test\Generator; 13 | 14 | use RCH\CapistranoBundle\Generator\GeneratorInterface; 15 | use RCH\CapistranoBundle\Generator\YamlStagingGenerator; 16 | 17 | /** 18 | * Tests the StagingGenerator. 19 | * 20 | * @author Robin Chalas 21 | */ 22 | class YamlStagingGeneratorTest extends \PHPUnit_Framework_TestCase 23 | { 24 | /** @var string */ 25 | protected $path; 26 | 27 | /** @var string */ 28 | protected $name; 29 | 30 | /** @var array */ 31 | protected $params; 32 | 33 | /** @var string */ 34 | protected $expected = " 35 | # This file is part of the RCHCapistranoBundle. 36 | # 37 | # (c) Robin Chalas 38 | # 39 | # For the full copyright and license information, please view the LICENSE 40 | # file that was distributed with this source code. 41 | 42 | 43 | domain: 'rch.fr' 44 | user: 'chalasr' 45 | keys: '/home/ssh_user/.ssh/id_rsa' 46 | forward_agent: false 47 | auth_methods: 'publickey password' 48 | deploy_to: '/var/www/html' 49 | repo_url: 'git@github.com:chalasr/RCHCapistranoBundle' 50 | "; 51 | 52 | public function setUp() 53 | { 54 | $this->path = sys_get_temp_dir().'/yaml_stagings/'; 55 | $this->name = 'test'; 56 | $this->params = array( 57 | 'domain' => 'rch.fr', 58 | 'user' => 'chalasr', 59 | 'keys' => '/home/ssh_user/.ssh/id_rsa', 60 | 'forwardAgent' => 'false', 61 | 'authMethods' => 'publickey password', 62 | 'deployTo' => '/var/www/html', 63 | 'repoUrl' => 'git@github.com:chalasr/RCHCapistranoBundle' 64 | ); 65 | } 66 | 67 | public function testGenerate() 68 | { 69 | $generator = new YamlStagingGenerator($this->params, $this->path, $this->name); 70 | $this->generateStaging($generator); 71 | 72 | $this->assertEquals($this->expected, file_get_contents(sprintf('%s/%s.yml', $this->path, $this->name))); 73 | } 74 | 75 | private function generateStaging(GeneratorInterface $generator) 76 | { 77 | $generator->open(); 78 | $generator->write(); 79 | $generator->close(); 80 | } 81 | 82 | public function tearDown() 83 | { 84 | unlink(sprintf('%s/%s.yml', $this->path, $this->name)); 85 | rmdir($this->path); 86 | } 87 | } 88 | -------------------------------------------------------------------------------- /Test/autoload.php.dist: -------------------------------------------------------------------------------- 1 | 7 | * 8 | * For the full copyright and license information, please view the LICENSE 9 | * file that was distributed with this source code. 10 | */ 11 | 12 | date_default_timezone_set('Europe/Paris'); 13 | 14 | if (file_exists($file = __DIR__.'/autoload.php')) { 15 | require_once $file; 16 | } elseif (file_exists($file = __DIR__.'/autoload.php.dist')) { 17 | require_once $file; 18 | } 19 | -------------------------------------------------------------------------------- /Util/CanGenerateTrait.php: -------------------------------------------------------------------------------- 1 | 7 | * 8 | * For the full copyright and license information, please view the LICENSE 9 | * file that was distributed with this source code. 10 | */ 11 | 12 | namespace RCH\CapistranoBundle\Util; 13 | 14 | use RCH\CapistranoBundle\Generator\GeneratorInterface; 15 | use RCH\CapistranoBundle\Generator\Handler; 16 | use Symfony\Component\Yaml\Yaml; 17 | 18 | /** 19 | * Provides helper methods. 20 | * 21 | * @author Robin Chalas 22 | */ 23 | trait CanGenerateTrait 24 | { 25 | /** 26 | * Generates a document from given configuration using given generator. 27 | * 28 | * @param GeneratorInterface $generator Instance of AbstractGeneratord 29 | * 30 | * @return callable 31 | */ 32 | public function generate(GeneratorInterface $generator) 33 | { 34 | $callback = function () use ($generator) { 35 | $handler = Handler::create($generator); 36 | $handler->generate(); 37 | }; 38 | 39 | return $callback(); 40 | } 41 | 42 | /** 43 | * Call CanGenerateTrait::generateMany for each generator of a given array. 44 | * 45 | * @param GeneratorInterface[] $generators 46 | */ 47 | public function generateMany(array $generators) 48 | { 49 | foreach ($generators as $generator) { 50 | $this->generate($generator); 51 | } 52 | } 53 | 54 | /** 55 | * Read staging parameters from YAML staging file. 56 | * 57 | * @param string $yamlFile The YAML staging filename 58 | * 59 | * @return array 60 | */ 61 | public function parseYamlStaging($yamlFile) 62 | { 63 | $container = !(property_exists(get_called_class(), 'container')) ? $this->getContainer() : $this->container; 64 | $capitalizer = $container->get('rch_capistrano.capitalizer'); 65 | $params = Yaml::parse(file_get_contents($yamlFile)); 66 | 67 | return $capitalizer->camelize($params); 68 | } 69 | } 70 | -------------------------------------------------------------------------------- /Util/LocalizableTrait.php: -------------------------------------------------------------------------------- 1 | 7 | * 8 | * For the full copyright and license information, please view the LICENSE 9 | * file that was distributed with this source code. 10 | */ 11 | 12 | namespace RCH\CapistranoBundle\Util; 13 | 14 | use Symfony\Component\Console\Exception\RuntimeException; 15 | 16 | /** 17 | * Retrieves directories absolute paths. 18 | * 19 | * @author Robin Chalas 20 | */ 21 | trait LocalizableTrait 22 | { 23 | /** 24 | * Get application root directory. 25 | * 26 | * @return string 27 | */ 28 | public function getRootDir() 29 | { 30 | return $this->getContainer()->get('kernel')->getRootDir(); 31 | } 32 | 33 | /** 34 | * Get bundle directory. 35 | * 36 | * @return string 37 | */ 38 | public function getBundleVendorDir() 39 | { 40 | $psr4Path = $this->getRootDir().'/../vendor/rch/capistrano-bundle'; 41 | $psr0Path = $psr4Path.'/RCH/CapistranoBundle'; 42 | 43 | if (is_dir($psr0Path)) { 44 | return $psr0Path; 45 | } 46 | 47 | return $psr4Path; 48 | } 49 | 50 | /** 51 | * Get published config directory. 52 | * 53 | * @return string 54 | */ 55 | public function getPublishedConfigDir() 56 | { 57 | return $this->getRootdir().'/config/rch'; 58 | } 59 | 60 | /** 61 | * Get capistrano config directory. 62 | * 63 | * @return string 64 | */ 65 | public function getCapistranoDir() 66 | { 67 | return $this->getRootdir().'/../config'; 68 | } 69 | 70 | /** 71 | * Get capistrano config directory. 72 | * 73 | * @return string 74 | */ 75 | public function getCapistranoDeployDir() 76 | { 77 | return $this->getCapistranoDir().'/deploy'; 78 | } 79 | 80 | /** 81 | * Get staging's configuration directory (Yaml). 82 | * 83 | * @return string 84 | */ 85 | public function getStagingsConfigDir() 86 | { 87 | return $this->getPublishedConfigDir().'/staging'; 88 | } 89 | 90 | /** 91 | * Get the Service Container. 92 | * 93 | * @return \Symfony\Component\DependencyInjection\ContainerInterface 94 | * 95 | * @throws RuntimeException If the service container is not accessible 96 | */ 97 | public function getContainer() 98 | { 99 | if (property_exists(__CLASS__, 'container')) { 100 | return $this->container; 101 | } else { 102 | return parent::getContainer(); 103 | } 104 | 105 | throw new RuntimeException(sprintf('The service container must be accessible from class %s to use this trait', __CLASS__)); 106 | } 107 | } 108 | -------------------------------------------------------------------------------- /Util/OutputWritableTrait.php: -------------------------------------------------------------------------------- 1 | 7 | * 8 | * For the full copyright and license information, please view the LICENSE 9 | * file that was distributed with this source code. 10 | */ 11 | 12 | namespace RCH\CapistranoBundle\Util; 13 | 14 | use Symfony\Component\Console\Formatter\OutputFormatterStyle; 15 | use Symfony\Component\Console\Output\OutputInterface; 16 | 17 | /** 18 | * Provides helper methods. 19 | * 20 | * @author Robin Chalas 21 | */ 22 | trait OutputWritableTrait 23 | { 24 | /** 25 | * Writes stylized welcome message in Output. 26 | * 27 | * @param InputInterface $input 28 | * @param OutputInterface $output 29 | */ 30 | public function sayWelcome(OutputInterface $output) 31 | { 32 | $breakline = ''; 33 | $output = $this->createBlockTitle($output); 34 | $title = $this->formatAsTitle('RCHCapistranoBundle - Continuous Deployment'); 35 | 36 | $welcome = array( 37 | $breakline, 38 | $title, 39 | $breakline, 40 | 'This bundle provides continuous deployment for Symfony2+ using Capistrano', 41 | 'Created by Robin Chalas - github.com/chalasr', 42 | $breakline, 43 | ); 44 | 45 | $output->writeln($welcome); 46 | } 47 | 48 | protected function createBlockTitle(OutputInterface $output) 49 | { 50 | $style = new OutputFormatterStyle('white', 'blue', array('bold')); 51 | $output->getFormatter()->setStyle('title', $style); 52 | 53 | return $output; 54 | } 55 | 56 | /** 57 | * Formats string as output block title. 58 | * 59 | * @param string $content 60 | * 61 | * @return string 62 | */ 63 | protected function formatAsTitle($content) 64 | { 65 | $formatter = $this->getHelper('formatter'); 66 | $title = $formatter->formatBlock($content, 'title', true); 67 | 68 | return $title; 69 | } 70 | } 71 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "rch/capistrano-bundle", 3 | "description": "Continuous deployment for Symfony2+", 4 | "keywords": ["deploy", "bundle", "symfony2", "capistrano", "capifony", "production", "workflow"], 5 | "type": "symfony-bundle", 6 | "license": "GPL-3.0", 7 | "authors": [ 8 | { 9 | "name": "Robin CHALAS", 10 | "email": "robin.chalas@gmail.com", 11 | "homepage": "https://github.com/chalasr/RCHCapistranoBundle" 12 | } 13 | ], 14 | "require": { 15 | "php": ">=5.5.9", 16 | "symfony/console": "~3.0", 17 | "symfony/filesystem": "~3.0", 18 | "symfony/yaml": "~3.0", 19 | "symfony/dependency-injection": "~3.0", 20 | "symfony/config": "~3.0" 21 | }, 22 | "autoload": { 23 | "psr-4": { "RCH\\CapistranoBundle\\": "" } 24 | }, 25 | "require-dev": { 26 | "fabpot/php-cs-fixer": "^1.11" 27 | }, 28 | "extra": { 29 | "branch-alias": { 30 | "dev-master": "2.0-dev" 31 | } 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /phpunit.xml.dist: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | ./Test 7 | 8 | 9 | 10 | 11 | 12 | ./ 13 | 14 | 15 | 16 | --------------------------------------------------------------------------------