capistrano-symfony 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b727a9e7183a8223bd8e058e9b40a7d12d38cf2
+  data.tar.gz: 1c88d66c1f6e43edf90b35295de2e25570ac7f3c
+SHA512:
+  metadata.gz: 30eb6fa38b3b5c9e47697c9882ecf0175d41db2c23b1108cf3293d0457d54ae36a73241f088ff9d837f624922371c2f69f2a61f21e2d509c5a444b6348f2e838
+  data.tar.gz: 3b2db625b7f91e074e786fd372f4cbeeb9e0a9d8b719466a8bec5949f86de24676943b536e4f362643f1fecd7469f67edab8f842e852fbf084f362fea046e060

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/LICENCE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Peter Mitchell
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,173 @@
+# Capistrano::Symfony
+
+Symfony 2 (standard edition) specific tasks for Capistrano v3
+(inspired by [capifony][2])
+
+It leverages the following capistrano tasks to deploy a Symfony app
+
+* https://github.com/capistrano/composer
+* https://github.com/capistrano/file-permissions
+
+## Installation
+
+```
+# Gemfile
+gem 'capistrano',  '~> 3.1'
+gem 'capistrano-symfony', '~> 0.1', :github => 'capistrano/symfony'
+```
+
+## Usage
+
+Require capistrano-symfony in your cap file
+
+```
+# Capfile
+require 'capistrano/symfony'
+```
+
+### Settings
+
+capistrano-symfony exposes the following settings (displayed with defaults):
+
+```ruby
+# Symfony environment
+set :symfony_env,  "prod"
+
+# Symfony application path
+set :app_path,              "app"
+
+# Symfony web path
+set :web_path,              "web"
+
+# Symfony log path
+set :log_path,              fetch(:app_path) + "/logs"
+
+# Symfony cache path
+set :cache_path,            fetch(:app_path) + "/cache"
+
+# Symfony config file path
+set :app_config_path,       fetch(:app_path) + "/config"
+
+# Controllers to clear
+set :controllers_to_clear, ["app_*.php"]
+
+# Files that need to remain the same between deploys
+set :linked_files,          []
+
+# Dirs that need to remain the same between deploys (shared dirs)
+set :linked_dirs,           [fetch(:log_path), fetch(:web_path) + "/uploads"]
+
+# Dirs that need to be writable by the HTTP Server (i.e. cache, log dirs)
+set :file_permissions_paths,         [fetch(:log_path), fetch(:cache_path)]
+
+# Name used by the Web Server (i.e. www-data for Apache)
+set :webserver_user,        "www-data"
+
+# Method used to set permissions (:chmod, :acl, or :chown)
+set :permission_method,     false
+
+# Execute set permissions
+set :use_set_permissions,   false
+
+# Symfony console path
+set :symfony_console_path, fetch(:app_path) + "/console"
+
+# Symfony console flags
+set :symfony_console_flags, "--no-debug"
+
+# Assets install path
+set :assets_install_path,   fetch(:web_path)
+
+# Assets install flags
+set :assets_install_flags,  '--symlink'
+
+# Assetic dump flags
+set :assetic_dump_flags,  ''
+
+fetch(:default_env).merge!(symfony_env: fetch(:symfony_env))
+```
+
+### Flow
+
+capistrano-symfony hooks into the [flow][1] offered by capistrano. It adds to that flow like so
+
+* ```symfony:create_cache_dir```
+* ```symfony:set_permissions```
+* ```symfony:cache:warmup```
+* ```symfony:clear_controllers```
+
+```
+deploy
+|__ deploy:starting
+|   |__ [before]
+|   |   |__ deploy:ensure_stage
+|   |   |__ deploy:set_shared_assets
+|   |__ deploy:check
+|__ deploy:started
+|__ deploy:updating
+|   |__ git:create_release
+|   |__ deploy:symlink:shared
+|   |__ symfony:create_cache_dir
+|   |__ symfony:set_permissions
+|__ deploy:updated
+|   |__ symfony:cache:warmup
+|   |__ symfony:clear_controllers
+|__ deploy:publishing
+|   |__ deploy:symlink:release
+|   |__ deploy:restart
+|__ deploy:published
+|__ deploy:finishing
+|   |__ deploy:cleanup
+|__ deploy:finished
+    |__ deploy:log_revision
+```
+
+### Integrated common tasks
+
+The folowing common tasks are already integrated:
+* ```symfony:assets:install```
+* ```symfony:assetic:dump```
+
+So you can use them with hooks like this:
+```ruby
+  after 'deploy:updated',   'symfony:assets:install'
+  after 'deploy:updated',   'symfony:assetic:dump'
+```
+
+### Using the Symfony console
+
+A task wrapping the symfony console is provided, making it easy to create tasks
+that call console methods.
+
+For example if you have installed the [DoctrineMigrationsBundle][3] in your
+project you may want to run migrations during a deploy.
+
+```ruby
+namespace :deploy do
+  task :migrate do
+    invoke 'symfony:console', 'doctrine:migrations:migrate', '--no-interaction'
+  end
+end
+```
+
+You can also apply role filter on your commands by passing a fourth parameter.
+
+```ruby
+namespace :deploy do
+  task :migrate do
+    invoke 'symfony:console', 'doctrine:migrations:migrate', '--no-interaction', 'db'
+  end
+end
+```
+
+[1]: http://capistranorb.com/documentation/getting-started/flow/
+[2]: http://capifony.org/
+[3]: http://symfony.com/doc/current/bundles/DoctrineMigrationsBundle/index.html
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/capistrano-symfony.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-symfony"
+  gem.version       = '0.4.0'
+  gem.authors       = ["Peter Mitchell"]
+  gem.email         = ["pete@peterjmit.com"]
+  gem.description   = %q{Symfony specific Capistrano tasks}
+  gem.summary       = %q{Capistrano Symfony - Easy deployment of Symfony 2 apps with Ruby over SSH}
+  gem.homepage      = "http://github.com/capitrano/capistrano-symfony"
+
+  gem.files         = `git ls-files`.split($/)
+  # no tests as of yet
+  # gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.licenses      = ['MIT']
+
+  gem.post_install_message = <<eos
+  WARNING - This gem has switched repositories. This gem is now for the
+  capitrano-symfony plugin located at https://github.com/capistrano/symfony.
+  This package behaves differently from the previous, and the release versions
+  have changed.
+
+  The Big Brains Company and Thomas Tourlourat (@armetiz) kindly agreed to
+  tranfer the ownership of this gem over to the Capistrano organization. The
+  previous repository can be found here https://github.com/TheBigBrainsCompany/capistrano-symfony
+eos
+
+  gem.add_dependency 'capistrano', '~> 3.1'
+  gem.add_dependency 'capistrano-composer', '~> 0.0.3'
+  gem.add_dependency 'capistrano-file-permissions', '~> 0.1.0'
+end

data/lib/capistrano/symfony.rb

@@ -0,0 +1,13 @@
+require "capistrano/file-permissions"
+require "capistrano/composer"
+require "capistrano/symfony/dsl"
+require "capistrano/symfony/symfony"
+
+# Core tasks for deploying symfony
+load File.expand_path("../tasks/deploy.rake", __FILE__)
+
+namespace :load do
+  task :defaults do
+    load "capistrano/symfony/defaults.rb"
+  end
+end

data/lib/capistrano/symfony/defaults.rb

@@ -0,0 +1,53 @@
+# Symfony environment
+set :symfony_env,  "prod"
+
+# Symfony application path
+set :app_path,              "app"
+
+# Symfony web path
+set :web_path,              "web"
+
+# Symfony log path
+set :log_path,              fetch(:app_path) + "/logs"
+
+# Symfony cache path
+set :cache_path,            fetch(:app_path) + "/cache"
+
+# Symfony config file path
+set :app_config_path,       fetch(:app_path) + "/config"
+
+# Controllers to clear
+set :controllers_to_clear, ["app_*.php"]
+
+# Files that need to remain the same between deploys
+set :linked_files,          []
+
+# Dirs that need to remain the same between deploys (shared dirs)
+set :linked_dirs,           [fetch(:log_path), fetch(:web_path) + "/uploads"]
+
+# Dirs that need to be writable by the HTTP Server (i.e. cache, log dirs)
+set :file_permissions_paths,         [fetch(:log_path), fetch(:cache_path)]
+
+# Name used by the Web Server (i.e. www-data for Apache)
+set :webserver_user,        "www-data"
+
+# Method used to set permissions (:chmod, :acl, or :chown)
+set :permission_method,     false
+
+# Execute set permissions
+set :use_set_permissions,   false
+
+# Symfony console path
+set :symfony_console_path, fetch(:app_path) + "/console"
+
+# Symfony console flags
+set :symfony_console_flags, "--no-debug"
+
+# Assets install path
+set :assets_install_path,   fetch(:web_path)
+
+# Assets install flags
+set :assets_install_flags,  '--symlink'
+
+# Assetic dump flags
+set :assetic_dump_flags,  ''

data/lib/capistrano/symfony/deploy.rb

@@ -0,0 +1 @@
+load File.expand_path("../../tasks/deploy.rake", __FILE__)

data/lib/capistrano/symfony/dsl.rb

@@ -0,0 +1 @@
+require 'capistrano/symfony/dsl/paths'

data/lib/capistrano/symfony/dsl/paths.rb

@@ -0,0 +1,29 @@
+require "capistrano/dsl/paths"
+
+module Capistrano
+  module DSL
+    module Paths
+
+      def symfony_app_path
+          release_path.join(fetch(:app_path))
+      end
+
+      def symfony_web_path
+          release_path.join(fetch(:web_path))
+      end
+
+      def symfony_log_path
+          release_path.join(fetch(:log_path))
+      end
+
+      def symfony_cache_path
+          release_path.join(fetch(:cache_path))
+      end
+
+      def symfony_config_path
+          release_path.join(fetch(:app_config_path))
+      end
+
+    end
+  end
+end

data/lib/capistrano/symfony/symfony.rb

@@ -0,0 +1 @@
+load File.expand_path("../../tasks/symfony.rake", __FILE__)

data/lib/capistrano/tasks/deploy.rake

@@ -0,0 +1,18 @@
+module Capistrano
+  class FileNotFound < StandardError
+  end
+end
+
+namespace :deploy do
+
+  task :updating do
+    invoke "symfony:create_cache_dir"
+    invoke "symfony:set_permissions"
+  end
+
+  task :updated do
+    invoke "symfony:cache:warmup"
+    invoke "symfony:clear_controllers"
+  end
+
+end

data/lib/capistrano/tasks/set_symfony_env.rake

@@ -0,0 +1,9 @@
+namespace :deploy do
+  task :set_symfony_env do
+    fetch(:default_env).merge!(symfony_env: fetch(:symfony_env) || 'prod')
+  end
+end
+
+Capistrano::DSL.stages.each do |stage|
+  after stage, 'deploy:set_symfony_env'
+end

data/lib/capistrano/tasks/symfony.rake

@@ -0,0 +1,97 @@
+load File.expand_path("../set_symfony_env.rake", __FILE__)
+
+namespace :symfony do
+  desc "Execute a provided symfony command"
+  task :console, :command, :params, :role do |t, args|
+    # ask only runs if argument is not provided
+    ask(:cmd, "cache:clear")
+    command = args[:command] || fetch(:cmd)
+    role = args[:role] || :all
+    params = args[:params] || ''
+
+    on release_roles(role) do
+      within release_path do
+        execute :php, fetch(:symfony_console_path), command, params, fetch(:symfony_console_flags)
+      end
+    end
+
+    Rake::Task[t.name].reenable
+  end
+
+  task :command, :command_name, :flags do |t, args|
+    on roles(:all) do
+      warn "The task symfony:command is deprecated in favor of symfony:console"
+      invoke "symfony:console", args[:command_name], args[:flags]
+    end
+  end
+
+
+  namespace :cache do
+    desc "Run app/console cache:clear for the #{fetch(:symfony_env)} environment"
+    task :clear do
+      invoke "symfony:console", "cache:clear"
+    end
+
+    desc "Run app/console cache:warmup for the #{fetch(:symfony_env)} environment"
+    task :warmup do
+      invoke "symfony:console", "cache:warmup"
+    end
+  end
+
+  namespace :assets do
+    desc "Install assets"
+    task :install do
+      invoke "symfony:console", "assets:install", fetch(:assets_install_path) + ' ' + fetch(:assets_install_flags)
+    end
+  end
+
+  namespace :assetic do
+    desc "Dump assets with Assetic"
+    task :dump do
+      invoke "symfony:console", "assetic:dump", fetch(:assetic_dump_flags)
+    end
+  end
+
+  desc "Create the cache directory"
+  task :create_cache_dir do
+    on release_roles :all do
+      within release_path do
+        if test "[ -d #{symfony_cache_path} ]"
+          execute :rm, "-rf", symfony_cache_path
+        end
+        execute :mkdir, "-pv", fetch(:cache_path)
+      end
+    end
+  end
+
+  desc "Create the cache directory"
+  task :set_permissions do
+    on release_roles :all do
+      if fetch(:use_set_permissions)
+        invoke "deploy:set_permissions:#{fetch(:permission_method).to_s}"
+      end
+    end
+  end
+
+  desc "Clear non production controllers"
+  task :clear_controllers do
+    next unless any? :controllers_to_clear
+    on release_roles :all do
+      within symfony_web_path do
+        execute :rm, "-f", *fetch(:controllers_to_clear)
+      end
+    end
+  end
+
+  desc "Build the bootstrap file"
+  task :build_bootstrap do
+    on release_roles :all do
+      within release_path do
+        execute :php, "./vendor/sensio/distribution-bundle/Sensio/Bundle/DistributionBundle/Resources/bin/build_bootstrap.php", fetch(:app_path)
+      end
+    end
+  end
+
+end
+
+task :symfony => ["symfony:console"]

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-symfony
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Peter Mitchell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: capistrano-composer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: capistrano-file-permissions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: Symfony specific Capistrano tasks
+email:
+- pete@peterjmit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENCE.txt
+- README.md
+- capistrano-symfony.gemspec
+- lib/capistrano-symfony.rb
+- lib/capistrano/symfony.rb
+- lib/capistrano/symfony/defaults.rb
+- lib/capistrano/symfony/deploy.rb
+- lib/capistrano/symfony/dsl.rb
+- lib/capistrano/symfony/dsl/paths.rb
+- lib/capistrano/symfony/symfony.rb
+- lib/capistrano/tasks/deploy.rake
+- lib/capistrano/tasks/set_symfony_env.rake
+- lib/capistrano/tasks/symfony.rake
+homepage: http://github.com/capitrano/capistrano-symfony
+licenses:
+- MIT
+metadata: {}
+post_install_message: |2
+    WARNING - This gem has switched repositories. This gem is now for the
+    capitrano-symfony plugin located at https://github.com/capistrano/symfony.
+    This package behaves differently from the previous, and the release versions
+    have changed.
+
+    The Big Brains Company and Thomas Tourlourat (@armetiz) kindly agreed to
+    tranfer the ownership of this gem over to the Capistrano organization. The
+    previous repository can be found here https://github.com/TheBigBrainsCompany/capistrano-symfony
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Capistrano Symfony - Easy deployment of Symfony 2 apps with Ruby over SSH
+test_files: []