capistrano-exts 1.11.3 → 1.12.0

data/.todo

@@ -1,5 +1,11 @@
 <?xml version="1.0"?>
 <todo version="0.1.20">
+    <note priority="veryhigh" time="1316597225" done="1316600338">
+        Rename deploy:folders to deploy:setup:folders
+        <comment>
+            Can't be done, setup is a task
+        </comment>
+    </note>
     <note priority="high" time="1316510985">
         Add skip_table_on_sync configuration, if defined, we should not replace these tables on the target's database.
     </note>
@@ -12,4 +18,7 @@
     <note priority="medium" time="1316510880">
         Add tests using Vagrant (branch vagrant)
     </note>
+    <note priority="medium" time="1316594507">
+        In the nginx template file, we need to define the error pages dynamically and not in a hardcoded way.
+    </note>
 </todo>

data/README.md

@@ -18,7 +18,7 @@ gem install capistrano-exts
 or add it to your Gemfile
 
 ```ruby
-gem 'capistrano-exts', '>=1.11.3', :require => false
+gem 'capistrano-exts', '>=1.12.0', :require => false
 ```
 
 # Setup
@@ -39,8 +39,8 @@ set :stages, [:development, :staging, :production]
 set :default_stage, :development
 
 # Capistrano extensions
-# Valid extensions: :multistage, :git, :deploy, :mysql, :rails, :contao, :contents, :god, :unicorn, :servers
-set :capistrano_extensions, [:multistage, :git, :deploy, :mysql, :rails, :servers]
+# Valid extensions: :multistage, :git, :mysql, :rails, :contao, :contents, :god, :unicorn, :servers
+set :capistrano_extensions, [:multistage, :git, :mysql, :rails, :servers]
 ```
 
 Then run the command

data/TODO

@@ -9,3 +9,6 @@
 
 - Add tests using Vagrant (branch vagrant)
   (added Tue Sep 20 11:28:00 2011, incomplete, priority medium)
+
+- In the nginx template file, we need to define the error pages dynamically and not in a hardcoded way.
+  (added Wed Sep 21 10:41:47 2011, incomplete, priority medium)

data/examples/php_fpm/deploy/development.rb

@@ -89,6 +89,22 @@ set :shared_items, [
 #
 #############
 
+#############
+# Maintenance
+#
+
+# Set the maintenance path to wherever you have stored the maintenance page,
+# it could be a single file or an entire folder. The template will be parsed
+# with ERB.
+# if it's a folder, capistrano expects an index.html file. You could provide an
+# index.rhtml file and it would be parsed with ERB before uploading to the server
+# set :maintenance_path,
+#   File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'maintenance'))
+
+#
+#
+#############
+
 #############
 # Mysql
 #

data/examples/php_fpm/deploy/production.rb

@@ -89,6 +89,22 @@ set :shared_items, [
 #
 #############
 
+#############
+# Maintenance
+#
+
+# Set the maintenance path to wherever you have stored the maintenance page,
+# it could be a single file or an entire folder. The template will be parsed
+# with ERB.
+# if it's a folder, capistrano expects an index.html file. You could provide an
+# index.rhtml file and it would be parsed with ERB before uploading to the server
+# set :maintenance_path,
+#   File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'maintenance'))
+
+#
+#
+#############
+
 #############
 # Mysql
 #

data/examples/php_fpm/deploy/staging.rb

@@ -89,6 +89,22 @@ set :shared_items, [
 #
 #############
 
+#############
+# Maintenance
+#
+
+# Set the maintenance path to wherever you have stored the maintenance page,
+# it could be a single file or an entire folder. The template will be parsed
+# with ERB.
+# if it's a folder, capistrano expects an index.html file. You could provide an
+# index.rhtml file and it would be parsed with ERB before uploading to the server
+# set :maintenance_path,
+#   File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'maintenance'))
+
+#
+#
+#############
+
 #############
 # Mysql
 #

data/examples/rails_passenger/deploy/development.rb

@@ -91,6 +91,22 @@ set :configuration_files, [
 #
 #############
 
+#############
+# Maintenance
+#
+
+# Set the maintenance path to wherever you have stored the maintenance page,
+# it could be a single file or an entire folder. The template will be parsed
+# with ERB.
+# if it's a folder, capistrano expects an index.html file. You could provide an
+# index.rhtml file and it would be parsed with ERB before uploading to the server
+# set :maintenance_path,
+#   File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'maintenance'))
+
+#
+#
+#############
+
 #############
 # Mysql
 #

data/examples/rails_passenger/deploy/production.rb

@@ -91,6 +91,22 @@ set :configuration_files, [
 #
 #############
 
+#############
+# Maintenance
+#
+
+# Set the maintenance path to wherever you have stored the maintenance page,
+# it could be a single file or an entire folder. The template will be parsed
+# with ERB.
+# if it's a folder, capistrano expects an index.html file. You could provide an
+# index.rhtml file and it would be parsed with ERB before uploading to the server
+# set :maintenance_path,
+#   File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'maintenance'))
+
+#
+#
+#############
+
 #############
 # Mysql
 #

data/examples/rails_passenger/deploy/staging.rb

@@ -91,6 +91,22 @@ set :configuration_files, [
 #
 #############
 
+#############
+# Maintenance
+#
+
+# Set the maintenance path to wherever you have stored the maintenance page,
+# it could be a single file or an entire folder. The template will be parsed
+# with ERB.
+# if it's a folder, capistrano expects an index.html file. You could provide an
+# index.rhtml file and it would be parsed with ERB before uploading to the server
+# set :maintenance_path,
+#   File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'maintenance'))
+
+#
+#
+#############
+
 #############
 # Mysql
 #

data/examples/rails_reverse_proxy/deploy/development.rb

@@ -91,6 +91,22 @@ set :configuration_files, [
 #
 #############
 
+#############
+# Maintenance
+#
+
+# Set the maintenance path to wherever you have stored the maintenance page,
+# it could be a single file or an entire folder. The template will be parsed
+# with ERB.
+# if it's a folder, capistrano expects an index.html file. You could provide an
+# index.rhtml file and it would be parsed with ERB before uploading to the server
+# set :maintenance_path,
+#   File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'maintenance'))
+
+#
+#
+#############
+
 #############
 # Mysql
 #

data/examples/rails_reverse_proxy/deploy/production.rb

@@ -91,6 +91,22 @@ set :configuration_files, [
 #
 #############
 
+#############
+# Maintenance
+#
+
+# Set the maintenance path to wherever you have stored the maintenance page,
+# it could be a single file or an entire folder. The template will be parsed
+# with ERB.
+# if it's a folder, capistrano expects an index.html file. You could provide an
+# index.rhtml file and it would be parsed with ERB before uploading to the server
+# set :maintenance_path,
+#   File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'maintenance'))
+
+#
+#
+#############
+
 #############
 # Mysql
 #

data/examples/rails_reverse_proxy/deploy/staging.rb

@@ -91,6 +91,22 @@ set :configuration_files, [
 #
 #############
 
+#############
+# Maintenance
+#
+
+# Set the maintenance path to wherever you have stored the maintenance page,
+# it could be a single file or an entire folder. The template will be parsed
+# with ERB.
+# if it's a folder, capistrano expects an index.html file. You could provide an
+# index.rhtml file and it would be parsed with ERB before uploading to the server
+# set :maintenance_path,
+#   File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'maintenance'))
+
+#
+#
+#############
+
 #############
 # Mysql
 #

data/lib/capistrano-exts.rb

@@ -2,7 +2,7 @@
 
 # Add it to PATH
 ROOT_PATH = File.expand_path(File.dirname(__FILE__))
-$: << ROOT_PATH if File.directory?(ROOT_PATH) && !$:.include?(ROOT_PATH)
+$: << ROOT_PATH if File.directory?(ROOT_PATH) and not $:.include?(ROOT_PATH)
 
 # Require our core extensions
 require 'capistrano-exts/core_ext'

data/lib/capistrano-exts/receipts.rb

@@ -1,14 +1,23 @@
 require 'capistrano'
-require 'capistrano-exts/receipts/functions'
+require 'capistrano/errors'
+require 'erb'
+
 
 # Verify that Capistrano is version 2
 unless Capistrano::Configuration.respond_to?(:instance)
   abort "This extension requires Capistrano 2"
 end
 
+DEFAULT_RECEIPTS = %w{functions deploy web files}
+
 Capistrano::Configuration.instance(:must_exist).load do
   on :load do
     if exists?(:capistrano_extensions)
+      # Merge the requested receipts with the default receipts
+      capistrano_extensions = fetch(:capistrano_extensions) << DEFAULT_RECEIPTS
+      capistrano_extensions.flatten!.uniq!
+
+      # Require requested + default receipts
       capistrano_extensions.each do |receipt|
         require "capistrano-exts/receipts/#{receipt.to_s}"
       end

data/lib/capistrano-exts/receipts/contao.rb

@@ -1,7 +1,3 @@
-require 'capistrano'
-require 'capistrano/errors'
-require 'capistrano-exts/receipts/functions'
-require 'capistrano-exts/receipts/deploy'
 require 'capistrano-exts/receipts/mysql'
 
 # Verify that Capistrano is version 2
@@ -38,7 +34,7 @@ Capistrano::Configuration.instance(:must_exist).load do
 
     desc "[internal] Setup contao's localconfig"
     task :setup_localconfig, :roles => :app, :except => { :no_release => true } do
-      localconfig_php_config_path = "#{fetch :shared_path}/config/system_config_localconfig.php"
+      localconfig_php_config_path = "#{fetch :shared_path}/config/public_system_config_localconfig.php"
       unless remote_file_exists?(localconfig_php_config_path)
         on_rollback { run "rm -f #{localconfig_php_config_path}" }
 

data/lib/capistrano-exts/receipts/contents.rb

@@ -1,7 +1,3 @@
-require 'capistrano'
-require 'capistrano/errors'
-require 'capistrano-exts/receipts/functions'
-
 # Verify that Capistrano is version 2
 unless Capistrano::Configuration.respond_to?(:instance)
   abort "This extension requires Capistrano 2"
@@ -83,7 +79,7 @@ Capistrano::Configuration.instance(:must_exist).load do
       export_filename_argv = ARGV.try(:[], argv_file_index)
 
       # Generate the file name
-      if export_filename_argv && !export_filename_argv =~ /.+:.+/ && !File.exists?(export_filename_argv)
+      if export_filename_argv and not export_filename_argv =~ /.+:.+/ and not File.exists?(export_filename_argv)
         export_filename = export_filename_argv
       else
         export_filename = random_tmp_file + ".tar.gz"
@@ -101,7 +97,7 @@ Capistrano::Configuration.instance(:must_exist).load do
       # Find out at which index the file is located ?
       argv_file_index = ARGV.index("contents:import") + 1
 
-      unless ARGV.size >= (argv_file_index + 1) && File.exists?(ARGV[argv_file_index])
+      unless ARGV.size >= (argv_file_index + 1) and File.exists?(ARGV[argv_file_index])
         logger.important "ERROR: please run 'cap import <gzipped tar>'"
         exit 1
       else

data/lib/capistrano-exts/receipts/deploy.rb

@@ -1,8 +1,3 @@
-require 'capistrano'
-require 'capistrano/errors'
-require 'capistrano-exts/receipts/functions'
-require 'capistrano-exts/receipts/files'
-
 # Verify that Capistrano is version 2
 unless Capistrano::Configuration.respond_to?(:instance)
   abort "This extension requires Capistrano 2"
@@ -38,14 +33,15 @@ Capistrano::Configuration.instance(:must_exist).load do
       backup_path = fetch :backup_path, "#{fetch :deploy_to}/backups"
 
       run <<-CMD
-        mkdir -p #{fetch :deploy_to} &&
-        mkdir -p #{backup_path} &&
-        mkdir -p #{fetch :shared_path}/items
+        #{try_sudo} mkdir -p #{fetch :deploy_to} &&
+        #{try_sudo} mkdir -p #{backup_path} &&
+        #{try_sudo} mkdir -p #{fetch :shared_path}/items &&
+        #{try_sudo} mkdir -p #{shared_path}/__system__
       CMD
 
       if exists? :logs_path
         run <<-CMD
-          mkdir -p #{fetch :logs_path}
+          #{try_sudo} mkdir -p #{fetch :logs_path}
         CMD
       end
     end

data/lib/capistrano-exts/receipts/files.rb

@@ -1,7 +1,3 @@
-require 'capistrano'
-require 'capistrano/errors'
-require 'capistrano-exts/receipts/functions'
-
 # Verify that Capistrano is version 2
 unless Capistrano::Configuration.respond_to?(:instance)
   abort "This extension requires Capistrano 2"

data/lib/capistrano-exts/receipts/functions.rb

@@ -1,4 +1,3 @@
-require 'capistrano'
 require 'digest/sha1'
 require 'highline'
 
@@ -15,8 +14,6 @@ Capistrano::Configuration.instance(:must_exist).load do
   end
 
   def link_file(source_file, destination_file)
-    p source_file
-    p destination_file
     if remote_file_exists?(source_file)
       begin
         run "#{try_sudo} ln -nsf #{source_file} #{destination_file}"
@@ -133,7 +130,7 @@ password: #{credentials[:pass]}
   # This function asks the user for confirmation (confirm running the task)
   # If the user answers no, then the task won't be executed.
   def ask_for_confirmation(what, options = {})
-    unless exists?(:force) && fetch(:force) == true
+    unless exists?(:force) and fetch(:force) == true
       # Ask for a confirmation
       response = ask(what, options)
       if response =~ /(no?)|(a(bort)?|\n)/i

data/lib/capistrano-exts/receipts/git.rb

@@ -1,6 +1,4 @@
-require 'capistrano'
 require 'highline'
-require 'capistrano-exts/receipts/deploy'
 
 # Verify that Capistrano is version 2
 unless Capistrano::Configuration.respond_to?(:instance)

data/lib/capistrano-exts/receipts/god.rb

@@ -1,5 +1,3 @@
-require 'capistrano'
-
 # Verify that Capistrano is version 2
 unless Capistrano::Configuration.respond_to?(:instance)
   abort "This extension requires Capistrano 2"

data/lib/capistrano-exts/receipts/multistage.rb

@@ -2,8 +2,6 @@
 # https://github.com/capistrano/capistrano-ext and has been modified
 # To allow configuration in either seperate files or in-line configurations
 
-require 'capistrano'
-require 'capistrano-exts/receipts/functions'
 require 'fileutils'
 
 unless Capistrano::Configuration.respond_to?(:instance)

data/lib/capistrano-exts/receipts/mysql.rb

@@ -1,8 +1,3 @@
-require 'capistrano'
-require 'capistrano/errors'
-require 'capistrano-exts/receipts/functions'
-require 'capistrano-exts/receipts/deploy'
-
 # Verify that Capistrano is version 2
 unless Capistrano::Configuration.respond_to?(:instance)
   abort "This extension requires Capistrano 2"
@@ -160,7 +155,7 @@ Capistrano::Configuration.instance(:must_exist).load do
       # Find out at which index the file is located ?
       argv_file_index = ARGV.index("mysql:import_db_dump") + 1
 
-      unless ARGV.size >= (argv_file_index + 1) && File.exists?(ARGV[argv_file_index])
+      unless ARGV.size >= (argv_file_index + 1) and File.exists?(ARGV[argv_file_index])
         logger.important "ERROR: please run 'cap mysql:import_db_dump <sql dump>'"
         exit 1
       else
@@ -229,7 +224,7 @@ Capistrano::Configuration.instance(:must_exist).load do
       export_filename_argv = ARGV.try(:[], argv_file_index)
 
       # Generate the file name
-      if export_filename_argv && !export_filename_argv =~ /.+:.+/ && !File.exists?(export_filename_argv)
+      if export_filename_argv and not export_filename_argv =~ /.+:.+/ and not File.exists?(export_filename_argv)
         export_filename = export_filename_argv
       else
         export_filename = random_tmp_file + ".sql"
@@ -320,7 +315,7 @@ Capistrano::Configuration.instance(:must_exist).load do
 
       desc "[internal] write database #{var.gsub(/_/, ' ')}"
       task "write_#{var}" do
-        unless exists?("mysql_#{var}_file".to_sym) && remote_file_exists?(fetch "mysql_#{var}_file".to_sym)
+        unless exists?("mysql_#{var}_file".to_sym) and remote_file_exists?(fetch "mysql_#{var}_file".to_sym)
           mysql_credentials_file = fetch "mysql_#{var}_file".to_sym
           credentials_formatted_content = credentials_formatted(fetch "mysql_#{var}".to_sym)
           random_file = random_tmp_file(credentials_formatted_content)
@@ -355,7 +350,7 @@ Capistrano::Configuration.instance(:must_exist).load do
           mysql_credentials_pass_regex_match = fetch "mysql_#{var}_pass_regex_match".to_sym
 
           # We haven't got the credentials yet, look for them
-          if exists?("mysql_#{var}_file".to_sym) && remote_file_exists?(fetch "mysql_#{var}_file".to_sym)
+          if exists?("mysql_#{var}_file".to_sym) and remote_file_exists?(fetch "mysql_#{var}_file".to_sym)
             mysql_credentials_file = fetch "mysql_#{var}_file".to_sym
 
             begin
@@ -395,7 +390,7 @@ Capistrano::Configuration.instance(:must_exist).load do
           end
 
           # Finally set it so it's available and write it to the server.
-          if mysql_credentials[:user].present? && mysql_credentials[:pass].present?
+          if mysql_credentials[:user].present? and mysql_credentials[:pass].present?
             set "mysql_#{var}".to_sym, mysql_credentials
             find_and_execute_task("mysql:write_#{var}")
           end