capistrano-symfony 0.4.0 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b727a9e7183a8223bd8e058e9b40a7d12d38cf2
-  data.tar.gz: 1c88d66c1f6e43edf90b35295de2e25570ac7f3c
+  metadata.gz: bdd325f7ad038221c25a713f886371589c41f67f
+  data.tar.gz: 9f8eca0db6a8025bdf35fd52bd8e8e2a34f965de
 SHA512:
-  metadata.gz: 30eb6fa38b3b5c9e47697c9882ecf0175d41db2c23b1108cf3293d0457d54ae36a73241f088ff9d837f624922371c2f69f2a61f21e2d509c5a444b6348f2e838
-  data.tar.gz: 3b2db625b7f91e074e786fd372f4cbeeb9e0a9d8b719466a8bec5949f86de24676943b536e4f362643f1fecd7469f67edab8f842e852fbf084f362fea046e060
+  metadata.gz: 1ec6cbc57993dd8fa3b95be1064868350e9fe89a1ce7082b89da03100fd37c6798e3664d4f785acba6cac5336c90911cdab5eaae14fe3877db0a2cfe651167c7
+  data.tar.gz: 603679bd05fd0b8e59de9c589fd4626c43019d428147effba011ae030955b0e6d7a7114929473531e0fc4ef762dd6b790a6a285d41162b0c2c3344853d4e4193

data/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Capistrano Symfony 1.x Changelog
+
+
+## `1.0.0.rc1`
+
+https://github.com/capistrano/symfony/compare/0.4.0...1.0.0.rc1
+
+* Use file permissions gem v1
+* Symfony 3 directory structure is on by default
+* Remove `use_set_permission` variable
+* Remove `web/uploads` as a default linked directory
+* Remove support for Assetic (see: https://github.com/symfony/symfony-standard/pull/860)
+* Support SensioLabsDistributionBundle 5 (#49)
+* Support Symfony 3 directory structure (#31)
+* `build_bootstrap_path` is now a DSL method
+* `symfony_console` is now a DSL method (use instead of `invoke "symfony:console"`)
+* Paths DSL file has been moved to `lib/capistrano/dsl/symfony.rb`
+* Deprecated `symfony:command` task has been removed
+* `webserver_user` variable has been removed (#40)
+* Various typo fixes
+
+### Contributors
+
+Thanks to everyone who has filed an issue or submitted a fix
+
+  * @kriswallsmith
+  * @zaerl
+  * @sandermarechal
+  * @pborreli
+  * @wideawake
+  * @issei-m
+  * alafon

data/README.md

@@ -1,7 +1,6 @@
 # Capistrano::Symfony
 
-Symfony 2 (standard edition) specific tasks for Capistrano v3
-(inspired by [capifony][2])
+Symfony 2 (standard edition) specific tasks for Capistrano v3 (inspired by [capifony][2]).
 
 It leverages the following capistrano tasks to deploy a Symfony app
 
@@ -12,8 +11,8 @@ It leverages the following capistrano tasks to deploy a Symfony app
 
 ```
 # Gemfile
-gem 'capistrano',  '~> 3.1'
-gem 'capistrano-symfony', '~> 0.1', :github => 'capistrano/symfony'
+gem 'capistrano',  '~> 3.4'
+gem 'capistrano-symfony', '~> 1.0.0.rc1'
 ```
 
 ## Usage
@@ -25,76 +24,74 @@ Require capistrano-symfony in your cap file
 require 'capistrano/symfony'
 ```
 
+
 ### Settings
 
-capistrano-symfony exposes the following settings (displayed with defaults):
+If you are using an un-modified symfony-standard edition, version 3 then you do not need to change/add anything to your `deploy.rb` other than what is required from Capistrano.
+
+We do however expose the following settings (shown with default evaluated values) that can be modified to suit your project. Please refer to `lib/capistrano/symfony/defaults.rb` to see exactly how the defaults are set up.
+
 
 ```ruby
-# Symfony environment
+# Symfony console commands will use this environment for execution
 set :symfony_env,  "prod"
 
-# Symfony application path
-set :app_path,              "app"
-
-# Symfony web path
-set :web_path,              "web"
+# Set this to 2 for the old directory structure
+set :symfony_directory_structure, 3
+# Set this to 4 if using the older SensioDistributionBundle
+set :sensio_distribution_version, 5
 
-# Symfony log path
-set :log_path,              fetch(:app_path) + "/logs"
+# symfony-standard edition directories
+set :app_path, "app"
+set :web_path, "web"
+set :var_path, "var"
+set :bin_path, "bin"
 
-# Symfony cache path
-set :cache_path,            fetch(:app_path) + "/cache"
+# The next 3 settings are lazily evaluated from the above values, so take care
+# when modifying them
+set :app_config_path, "app/config"
+set :log_path, "var/logs"
+set :cache_path, "var/cache"
 
-# Symfony config file path
-set :app_config_path,       fetch(:app_path) + "/config"
+set :symfony_console_path, "bin/console"
+set :symfony_console_flags, "--no-debug"
 
-# Controllers to clear
+# Remove app_dev.php during deployment, other files in web/ can be specified here
 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
+# asset management
+set :assets_install_path, "web"
+set :assets_install_flags,  '--symlink'
 
-# Symfony console path
-set :symfony_console_path, fetch(:app_path) + "/console"
+# Share files/directories between releases
+set :linked_files, []
+set :linked_dirs, ["var/logs"]
 
-# Symfony console flags
-set :symfony_console_flags, "--no-debug"
-
-# Assets install path
-set :assets_install_path,   fetch(:web_path)
+# Set correct permissions between releases, this is turned off by default
+set :file_permissions_paths, ["var"]
+set :permission_method, false
+```
 
-# Assets install flags
-set :assets_install_flags,  '--symlink'
+#### Using this plugin with the old Symfony 2 directory structure and SensioDistributionBundle <= 4
 
-# Assetic dump flags
-set :assetic_dump_flags,  ''
+Add the following to `deploy.rb` to use the old directory structure
 
-fetch(:default_env).merge!(symfony_env: fetch(:symfony_env))
 ```
+# deploy.rb
+set :symfony_directory_structure, 2
+set :sensio_distribution_version, 4
+```
+
+If you are upgrading this gem and have modified `linked_dirs` or "advanced" variables such as `log_path` then you will need to update those accordingly
 
 ### 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```
+* `symfony:create_cache_dir`
+* `symfony:set_permissions`
+* `symfony:cache:warmup`
+* `symfony:clear_controllers`
 
 ```
 deploy
@@ -122,16 +119,38 @@ deploy
     |__ deploy:log_revision
 ```
 
+### File permissions
+
+Set the `permission_method` variable to one of `:chmod`, `:acl`, or `:chgrp` in your `deploy.rb` to handle the common scenario of a web user and the deploy user being different.
+
+Both will need access to the files/directories such as `var/cache` and `web/uploads` (if you handle uploads). Set `file_permissions_users` to your webserver user
+
+Example:
+
+```
+# deploy.rb
+
+set :permission_method, :acl
+set :file_permissions_users, ["nginx"]
+set :file_permissions_paths, ["var", "web/uploads"]
+```
+
+Please note that `:acl` requires that `setfacl` be available on your deployment target
+
+See [the symfony documentation](http://symfony.com/doc/current/book/installation.html#checking-symfony-application-configuration-and-setup) and [the file permission capistrano plugin](https://github.com/capistrano/file-permissions) for reference
+
 ### Integrated common tasks
 
-The folowing common tasks are already integrated:
-* ```symfony:assets:install```
-* ```symfony:assetic:dump```
+The following common tasks are available:
+
+* `symfony:assets:install`
+* `symfony:build_bootstrap` - useful if you disable composer
+
+So you can use them with hooks in your project's `deploy.rb` like this:
 
-So you can use them with hooks like this:
 ```ruby
-  after 'deploy:updated',   'symfony:assets:install'
-  after 'deploy:updated',   'symfony:assetic:dump'
+after 'deploy:updated', 'symfony:assets:install'
+before 'deploy:updated', 'symfony:build_bootstrap'
 ```
 
 ### Using the Symfony console
@@ -145,17 +164,19 @@ 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'
+    symfony_console('doctrine:migrations:migrate', '--no-interaction')
   end
 end
 ```
 
-You can also apply role filter on your commands by passing a fourth parameter.
+If you want to execute a command on a host with a given role you can use the Capistrano `on` DSL, additionally using `within` from Capistrano will change the directory
 
 ```ruby
 namespace :deploy do
   task :migrate do
-    invoke 'symfony:console', 'doctrine:migrations:migrate', '--no-interaction', 'db'
+    on roles(:db) do
+      symfony_console('doctrine:migrations:migrate', '--no-interaction')
+    end
   end
 end
 ```

data/capistrano-symfony.gemspec

@@ -4,12 +4,12 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = "capistrano-symfony"
-  gem.version       = '0.4.0'
+  gem.version       = '1.0.0.rc1'
   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.summary       = %q{Capistrano Symfony - Easy deployment of Symfony 2 & 3 apps with Ruby over SSH}
+  gem.homepage      = "http://github.com/capistrano/capistrano-symfony"
 
   gem.files         = `git ls-files`.split($/)
   # no tests as of yet
@@ -25,11 +25,11 @@ Gem::Specification.new do |gem|
   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
+  transfer 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'
+  gem.add_dependency 'capistrano-file-permissions', '~> 1.0'
 end

data/lib/capistrano/dsl/symfony.rb

@@ -0,0 +1,57 @@
+module Capistrano
+  module DSL
+    module Symfony
+
+      def symfony_app_path
+          release_path.join(fetch(:app_path))
+      end
+
+      def symfony_web_path
+          release_path.join(fetch(:web_path))
+      end
+
+      def symfony_bin_path
+        release_path.join(fetch(:bin_path))
+      end
+
+      def symfony_var_path
+        release_path.join(fetch(:var_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
+
+      def symfony_console_path
+          release_path.join(fetch(:symfony_console_path))
+      end
+
+      def symfony_vendor_path
+        release_path.join('vendor')
+      end
+
+      def build_bootstrap_path
+        bootstrap_path = symfony_vendor_path.join("sensio/distribution-bundle")
+
+        if fetch(:sensio_distribution_version).to_i <= 4
+          bootstrap_path = bootstrap_path.join("Sensio/Bundle/DistributionBundle")
+        end
+
+        bootstrap_path.join("Resources/bin/build_bootstrap.php")
+      end
+
+      def symfony_console(command, params = '')
+        execute :php, symfony_console_path, command, params, fetch(:symfony_console_flags)
+      end
+
+    end
+  end
+end

data/lib/capistrano/symfony.rb

@@ -1,6 +1,10 @@
+require "capistrano/dsl/symfony"
+self.extend Capistrano::DSL::Symfony
+
+SSHKit::Backend::Netssh.send(:include, Capistrano::DSL::Symfony)
+
 require "capistrano/file-permissions"
 require "capistrano/composer"
-require "capistrano/symfony/dsl"
 require "capistrano/symfony/symfony"
 
 # Core tasks for deploying symfony

data/lib/capistrano/symfony/defaults.rb

@@ -1,53 +1,42 @@
-# Symfony environment
+#
+# Symfony defaults
+#
 set :symfony_env,  "prod"
 
-# Symfony application path
-set :app_path,              "app"
+set :symfony_directory_structure, 3
+set :sensio_distribution_version, 5
 
-# Symfony web path
-set :web_path,              "web"
+# symfony-standard edition top-level directories
+set :app_path, "app"
+set :web_path, "web"
+set :var_path, "var"
+set :bin_path, "bin"
 
-# Symfony log path
-set :log_path,              fetch(:app_path) + "/logs"
+# Use closures for directories nested under the top level dirs, so that
+# any changes to web/app etc do not require these to be changed also
+set :app_config_path, -> { fetch(:app_path) + "/config" }
+set :log_path, -> { fetch(:symfony_directory_structure) == 2 ? fetch(:app_path) + "/logs" : fetch(:var_path) + "/logs" }
+set :cache_path, -> { fetch(:symfony_directory_structure) == 2 ? fetch(:app_path) + "/cache" : fetch(:var_path) + "/cache" }
 
-# Symfony cache path
-set :cache_path,            fetch(:app_path) + "/cache"
-
-# Symfony config file path
-set :app_config_path,       fetch(:app_path) + "/config"
+# console
+set :symfony_console_path, -> { fetch(:symfony_directory_structure) == 2 ?  fetch(:app_path) + '/console' : fetch(:bin_path) + "/console" }
+set :symfony_console_flags, "--no-debug"
 
-# 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)]
+# assets
+set :assets_install_path, fetch(:web_path)
+set :assets_install_flags,  '--symlink'
 
-# Name used by the Web Server (i.e. www-data for Apache)
-set :webserver_user,        "www-data"
+#
+# Capistrano defaults
+#
+set :linked_files, []
+set :linked_dirs, -> { [fetch(:log_path)] }
 
+#
+# Configure capistrano/file-permissions defaults
+#
+set :file_permissions_paths, -> { fetch(:symfony_directory_structure) == 2 ? [fetch(:log_path), fetch(:cache_path)] : [fetch(:var_path)] }
 # 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,  ''
+set :permission_method, false

data/lib/capistrano/tasks/symfony.rake

@@ -11,44 +11,37 @@ namespace :symfony do
 
     on release_roles(role) do
       within release_path do
-        execute :php, fetch(:symfony_console_path), command, params, fetch(:symfony_console_flags)
+        symfony_console(command, params)
       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"
+      on release_roles(:all) do
+        symfony_console "cache:clear"
+      end
     end
 
     desc "Run app/console cache:warmup for the #{fetch(:symfony_env)} environment"
     task :warmup do
-      invoke "symfony:console", "cache:warmup"
+      on release_roles(:all) do
+        symfony_console "cache:warmup"
+      end
     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)
+      on release_roles(:all) do
+        within release_path do
+          symfony_console "assets:install", fetch(:assets_install_path) + ' ' + fetch(:assets_install_flags)
+        end
+      end
     end
   end
 
@@ -64,10 +57,10 @@ namespace :symfony do
     end
   end
 
-  desc "Create the cache directory"
+  desc "Set user/group permissions on configured paths"
   task :set_permissions do
     on release_roles :all do
-      if fetch(:use_set_permissions)
+      if fetch(:permission_method) != false
         invoke "deploy:set_permissions:#{fetch(:permission_method).to_s}"
       end
     end
@@ -87,7 +80,7 @@ namespace :symfony do
   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)
+        execute :php, build_bootstrap_path, fetch(:app_path)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-symfony
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Peter Mitchell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-17 00:00:00.000000000 Z
+date: 2016-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '1.0'
 description: Symfony specific Capistrano tasks
 email:
 - pete@peterjmit.com
@@ -60,20 +60,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - LICENCE.txt
 - README.md
 - capistrano-symfony.gemspec
 - lib/capistrano-symfony.rb
+- lib/capistrano/dsl/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
+homepage: http://github.com/capistrano/capistrano-symfony
 licenses:
 - MIT
 metadata: {}
@@ -84,7 +84,7 @@ post_install_message: |2
     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
+    transfer 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:
@@ -96,13 +96,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: Capistrano Symfony - Easy deployment of Symfony 2 apps with Ruby over SSH
+summary: Capistrano Symfony - Easy deployment of Symfony 2 & 3 apps with Ruby over
+  SSH
 test_files: []

data/lib/capistrano/symfony/dsl.rb

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

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

@@ -1,29 +0,0 @@
-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