capistrano-exts 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in capistrano-exts.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,13 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard 'rspec', version: 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/capistrano-exts/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec/" }
+end

data/Rakefile

@@ -0,0 +1,9 @@
+# Require default tasks provided by bundler
+require 'bundler/gem_tasks'
+
+# Require RSpec tasks
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+# The default task is tests
+task :default => :spec

data/capistrano-exts.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "capistrano-exts/version"
+
+Gem::Specification.new do |s|
+  s.name        = "capistrano-exts"
+  s.version     = Capistrano::Extensions::Version::STRING.dup
+  s.authors     = ["Wael Nasreddine"]
+  s.email       = ["wael.nasreddine@gmail.com"]
+  s.homepage    = "https://github.com/Extensions/capistrano-exts"
+  s.summary     = %q{Handy extensions for Capistrano}
+  s.description = s.summary
+
+  s.rubyforge_project = "capistrano-exts"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # Run-time dependencies
+  s.add_dependency('capistrano', '>=2.8.0')
+  s.add_dependency('i18n', '>=0.6.0')
+  s.add_dependency('activesupport', '>=3.1.0')
+
+  # Development dependencies
+  s.add_development_dependency('rspec', '>=2.6.0')
+  s.add_development_dependency('mocha', '>=0.2.12')
+  s.add_development_dependency('factory_girl', '>=2.0.5')
+  s.add_development_dependency('faker19', '>=1.0.5')
+  s.add_development_dependency('guard', '>=0.6.2')
+  s.add_development_dependency('guard-bundler', '>=0.1.3')
+  s.add_development_dependency('guard-rspec', '>=0.4.3')
+  s.add_development_dependency('growl_notify', '0.0.1')
+end

data/examples/php_fpm/deploy/development.rb

@@ -0,0 +1,121 @@
+# DEVELOPMENT-specific deployment configuration
+# please put general deployment config in config/deploy.rb
+
+# Here you can set the server which you would like to, each server
+# each role can have multiple servers, each server defined as user@server.com:port
+# => port can be omiped and it defaults to 22
+role :web, 'root@example_dev_web.com:22'
+role :app, 'root@example_dev_app.com:22'
+role :db, 'root@example_dev_db.com:22', primary: true
+
+# The project's branch to use
+# Uncomment and edit this if you're using git, for other SCM's please refer
+# to capistrano's documentation
+set :branch, "master"
+
+# Use sudo ?
+set :use_sudo, false
+
+# Define deployments options
+set :deploy_to,   "/home/vhosts/#{application}"
+set :deploy_via,  :remote_cache
+set :logs_path,   "#{deploy_to}/logs"
+set :public_path, -> { "#{current_path}/public" }
+
+# Keep only the last 5 releases
+set :keep_releases, 5
+
+# Using RVM? Set this to the ruby version/gemset to use
+set :rvm_ruby_string, "1.9.2"
+
+# Mysql credentials
+set :mysql_credentials_file,                  -> { "#{deploy_to}/.mysql_password"}
+set :mysql_credentials_host_regex,            /hostname: (.*)$/o
+set :mysql_credentials_host_regex_match,      1
+set :mysql_credentials_user_regex,            /username: (.*)$/o
+set :mysql_credentials_user_regex_match,      1
+set :mysql_credentials_pass_regex,            /password: (.*)$/o
+set :mysql_credentials_pass_regex_match,      1
+set :mysql_root_credentials_file,             "/root/.mysql_password"
+set :mysql_root_credentials_host_regex,       /hostname: (.*)$/o
+set :mysql_root_credentials_host_regex_match, 1
+set :mysql_root_credentials_user_regex,       /username: (.*)$/o
+set :mysql_root_credentials_user_regex_match, 1
+set :mysql_root_credentials_pass_regex,       /password: (.*)$/o
+set :mysql_root_credentials_pass_regex_match, 1
+
+#############
+# Web server
+#
+
+# Which web server to use?
+# valid options: :nginx and :apache
+set :web_server_app, :nginx
+
+# Server specific configurations
+# Uncomment as necessary, default option are as follow
+# set :nginx_init_path, '/etc/init.d/nginx'
+# set :apache_init_path, '/etc/init.d/apache2'
+
+# Absolute path to this application's web server configuration
+# This gem suppose that you are already including files from the folder you're placing
+# the config file in, if not the application won't be up after deployment
+set :web_conf_file, -> { "/etc/nginx/#{fetch(:stage).to_s}/#{fetch :application}.conf" }
+
+# Which port does the server runs on ?
+set :web_server_listen_port, 80
+
+# What is the application url ?
+# THis is used for Virtual Hosts
+set :application_url, %w(example.com www.example.com)
+
+# What are the names of the indexes
+set :web_server_indexes, %w(index.php index.html)
+
+# HTTP Basic Authentifications
+# Uncomment this if you would like to add HTTP Basic authentifications,
+#
+# Change the 'web_server_auth_file' to the absolute path of the htpasswd file
+# web_server_auth_credentials is an array of user/password hashes, you can use
+# gen_pass(length) in a Proc to generate a new password as shown below
+#
+set :web_server_auth_file,        -> { "/etc/nginx/htpasswds/#{fetch :application}.crypt" }
+set :web_server_auth_credentials, [
+                                    {user: 'user1', password: 'pass1'},
+                                    {user: 'user2', password: -> { gen_pass(8) } },
+                                  ]
+
+# Enable mode rewrite ?
+set :web_server_mod_rewrite, true
+
+# Which server mode to operate on?
+# Valid options:
+#
+# For Nginx:
+# => :rails_reverse_proxy, :rails_passenger, :php_fpm
+# => :rails_reverse_proxy is used for unicorn (Rack apps)
+# => :rails_passenger runs rails apps
+# => :php_fpm is used to deliver websites written using PHP
+#
+# For Apache
+# =>
+set :web_server_mode, :php_fpm
+
+# Server mode specific configurations
+# Uncomment and edit the one depending on the enabled mode
+# php_fpm settings
+# => On which host, php-fpm is running ?
+set :php_fpm_host, 'localhost'
+# => Which port ?
+set :php_fpm_port, '9000'
+
+# reverse_proxy settings (Unicorn for example)
+# => On which host the proxy is running ?
+# set :reverse_proxy_server_address, 'localhost'
+# => On which port ?
+# set :reverse_proxy_server_port, 45410
+# => What is the path to the socket file
+# set :reverse_proxy_socket, -> { "#{shared_path}/sockets/unicorn.sock"}
+
+#
+#############

data/examples/php_fpm/deploy/production.rb

@@ -0,0 +1,121 @@
+# DEVELOPMENT-specific deployment configuration
+# please put general deployment config in config/deploy.rb
+
+# Here you can set the server which you would like to, each server
+# each role can have multiple servers, each server defined as user@server.com:port
+# => port can be omiped and it defaults to 22
+role :web, 'root@example_prod_web.com:22'
+role :app, 'root@example_prod_app.com:22'
+role :db, 'root@example_prod_db.com:22', primary: true
+
+# The project's branch to use
+# Uncomment and edit this if you're using git, for other SCM's please refer
+# to capistrano's documentation
+set :branch, "production"
+
+# Use sudo ?
+set :use_sudo, false
+
+# Define deployments options
+set :deploy_to,   "/home/vhosts/#{application}"
+set :deploy_via,  :remote_cache
+set :logs_path,   "#{deploy_to}/logs"
+set :public_path, -> { "#{current_path}/public" }
+
+# Keep only the last 5 releases
+set :keep_releases, 5
+
+# Using RVM? Set this to the ruby version/gemset to use
+set :rvm_ruby_string, "1.9.2"
+
+# Mysql credentials
+set :mysql_credentials_file,                  -> { "#{deploy_to}/.mysql_password"}
+set :mysql_credentials_host_regex,            /hostname: (.*)$/o
+set :mysql_credentials_host_regex_match,      1
+set :mysql_credentials_user_regex,            /username: (.*)$/o
+set :mysql_credentials_user_regex_match,      1
+set :mysql_credentials_pass_regex,            /password: (.*)$/o
+set :mysql_credentials_pass_regex_match,      1
+set :mysql_root_credentials_file,             "/root/.mysql_password"
+set :mysql_root_credentials_host_regex,       /hostname: (.*)$/o
+set :mysql_root_credentials_host_regex_match, 1
+set :mysql_root_credentials_user_regex,       /username: (.*)$/o
+set :mysql_root_credentials_user_regex_match, 1
+set :mysql_root_credentials_pass_regex,       /password: (.*)$/o
+set :mysql_root_credentials_pass_regex_match, 1
+
+#############
+# Web server
+#
+
+# Which web server to use?
+# valid options: :nginx and :apache
+set :web_server_app, :nginx
+
+# Server specific configurations
+# Uncomment as necessary, default option are as follow
+# set :nginx_init_path, '/etc/init.d/nginx'
+# set :apache_init_path, '/etc/init.d/apache2'
+
+# Absolute path to this application's web server configuration
+# This gem suppose that you are already including files from the folder you're placing
+# the config file in, if not the application won't be up after deployment
+set :web_conf_file, -> { "/etc/nginx/#{fetch(:stage).to_s}/#{fetch :application}.conf" }
+
+# Which port does the server runs on ?
+set :web_server_listen_port, 80
+
+# What is the application url ?
+# THis is used for Virtual Hosts
+set :application_url, %w(example.com www.example.com)
+
+# What are the names of the indexes
+set :web_server_indexes, %w(index.php index.html)
+
+# HTTP Basic Authentifications
+# Uncomment this if you would like to add HTTP Basic authentifications,
+#
+# Change the 'web_server_auth_file' to the absolute path of the htpasswd file
+# web_server_auth_credentials is an array of user/password hashes, you can use
+# gen_pass(length) in a Proc to generate a new password as shown below
+#
+# set :web_server_auth_file,        -> { "/etc/nginx/htpasswds/#{fetch :application}.crypt" }
+# set :web_server_auth_credentials, [
+#                                     {user: 'user1', password: 'pass1'},
+#                                     {user: 'user2', password: -> { gen_pass(8) } },
+#                                   ]
+
+# Enable mode rewrite ?
+set :web_server_mod_rewrite, true
+
+# Which server mode to operate on?
+# Valid options:
+#
+# For Nginx:
+# => :rails_reverse_proxy, :rails_passenger, :php_fpm
+# => :rails_reverse_proxy is used for unicorn (Rack apps)
+# => :rails_passenger runs rails apps
+# => :php_fpm is used to deliver websites written using PHP
+#
+# For Apache
+# =>
+set :web_server_mode, :php_fpm
+
+# Server mode specific configurations
+# Uncomment and edit the one depending on the enabled mode
+# php_fpm settings
+# => On which host, php-fpm is running ?
+set :php_fpm_host, 'localhost'
+# => Which port ?
+set :php_fpm_port, '9000'
+
+# reverse_proxy settings (Unicorn for example)
+# => On which host the proxy is running ?
+# set :reverse_proxy_server_address, 'localhost'
+# => On which port ?
+# set :reverse_proxy_server_port, 45410
+# => What is the path to the socket file
+# set :reverse_proxy_socket, -> { "#{shared_path}/sockets/unicorn.sock"}
+
+#
+#############

data/examples/php_fpm/deploy/staging.rb

@@ -0,0 +1,121 @@
+# DEVELOPMENT-specific deployment configuration
+# please put general deployment config in config/deploy.rb
+
+# Here you can set the server which you would like to, each server
+# each role can have multiple servers, each server defined as user@server.com:port
+# => port can be omiped and it defaults to 22
+role :web, 'root@example_staging_web.com:22'
+role :app, 'root@example_staging_app.com:22'
+role :db, 'root@example_staging_db.com:22', primary: true
+
+# The project's branch to use
+# Uncomment and edit this if you're using git, for other SCM's please refer
+# to capistrano's documentation
+set :branch, "staging"
+
+# Use sudo ?
+set :use_sudo, false
+
+# Define deployments options
+set :deploy_to,   "/home/vhosts/#{application}"
+set :deploy_via,  :remote_cache
+set :logs_path,   "#{deploy_to}/logs"
+set :public_path, -> { "#{current_path}/public" }
+
+# Keep only the last 5 releases
+set :keep_releases, 5
+
+# Using RVM? Set this to the ruby version/gemset to use
+set :rvm_ruby_string, "1.9.2"
+
+# Mysql credentials
+set :mysql_credentials_file,                  -> { "#{deploy_to}/.mysql_password"}
+set :mysql_credentials_host_regex,            /hostname: (.*)$/o
+set :mysql_credentials_host_regex_match,      1
+set :mysql_credentials_user_regex,            /username: (.*)$/o
+set :mysql_credentials_user_regex_match,      1
+set :mysql_credentials_pass_regex,            /password: (.*)$/o
+set :mysql_credentials_pass_regex_match,      1
+set :mysql_root_credentials_file,             "/root/.mysql_password"
+set :mysql_root_credentials_host_regex,       /hostname: (.*)$/o
+set :mysql_root_credentials_host_regex_match, 1
+set :mysql_root_credentials_user_regex,       /username: (.*)$/o
+set :mysql_root_credentials_user_regex_match, 1
+set :mysql_root_credentials_pass_regex,       /password: (.*)$/o
+set :mysql_root_credentials_pass_regex_match, 1
+
+#############
+# Web server
+#
+
+# Which web server to use?
+# valid options: :nginx and :apache
+set :web_server_app, :nginx
+
+# Server specific configurations
+# Uncomment as necessary, default option are as follow
+# set :nginx_init_path, '/etc/init.d/nginx'
+# set :apache_init_path, '/etc/init.d/apache2'
+
+# Absolute path to this application's web server configuration
+# This gem suppose that you are already including files from the folder you're placing
+# the config file in, if not the application won't be up after deployment
+set :web_conf_file, -> { "/etc/nginx/#{fetch(:stage).to_s}/#{fetch :application}.conf" }
+
+# Which port does the server runs on ?
+set :web_server_listen_port, 80
+
+# What is the application url ?
+# THis is used for Virtual Hosts
+set :application_url, %w(example.com www.example.com)
+
+# What are the names of the indexes
+set :web_server_indexes, %w(index.php index.html)
+
+# HTTP Basic Authentifications
+# Uncomment this if you would like to add HTTP Basic authentifications,
+#
+# Change the 'web_server_auth_file' to the absolute path of the htpasswd file
+# web_server_auth_credentials is an array of user/password hashes, you can use
+# gen_pass(length) in a Proc to generate a new password as shown below
+#
+# set :web_server_auth_file,        -> { "/etc/nginx/htpasswds/#{fetch :application}.crypt" }
+# set :web_server_auth_credentials, [
+#                                     {user: 'user1', password: 'pass1'},
+#                                     {user: 'user2', password: -> { gen_pass(8) } },
+#                                   ]
+
+# Enable mode rewrite ?
+set :web_server_mod_rewrite, true
+
+# Which server mode to operate on?
+# Valid options:
+#
+# For Nginx:
+# => :rails_reverse_proxy, :rails_passenger, :php_fpm
+# => :rails_reverse_proxy is used for unicorn (Rack apps)
+# => :rails_passenger runs rails apps
+# => :php_fpm is used to deliver websites written using PHP
+#
+# For Apache
+# =>
+set :web_server_mode, :php_fpm
+
+# Server mode specific configurations
+# Uncomment and edit the one depending on the enabled mode
+# php_fpm settings
+# => On which host, php-fpm is running ?
+set :php_fpm_host, 'localhost'
+# => Which port ?
+set :php_fpm_port, '9000'
+
+# reverse_proxy settings (Unicorn for example)
+# => On which host the proxy is running ?
+# set :reverse_proxy_server_address, 'localhost'
+# => On which port ?
+# set :reverse_proxy_server_port, 45410
+# => What is the path to the socket file
+# set :reverse_proxy_socket, -> { "#{shared_path}/sockets/unicorn.sock"}
+
+#
+#############

data/examples/php_fpm/deploy.rb

@@ -0,0 +1,38 @@
+# Adding necessary paths
+$:.unshift(File.expand_path('./lib', ENV['rvm_path'])) # Add RVM's lib directory to the load path.
+
+#####################
+## CHANGE AFTER ME ##
+#####################
+
+set :application,           "example_app"
+set :repository,            "git://github.com/example/example_app.git"
+set :scm,                   :git
+set :git_enable_submodules, 1
+
+# Stages
+set :stages, [:development, :staging, :production]
+set :default_stage, :development
+
+# Capistrano extensions
+set :capistrano_extensions, [:multistage, :git, :base, :mysql, :contao, :servers]
+
+default_run_options[:pty] = true
+ssh_options[:forward_agent] = true
+
+##################
+## DEPENDENCIES ##
+##################
+
+after "deploy", "deploy:cleanup" # keeps only last 5 releases
+
+###########################
+## DO NOT TOUCH AFTER ME ##
+###########################
+
+# Require capistrano-exts
+require 'capistrano-exts'
+
+# rvm bootstrap
+# Comment this if ruby is not installed on the server!
+# require "rvm/capistrano"

data/examples/rails_passenger/deploy/development.rb

@@ -0,0 +1,121 @@
+# DEVELOPMENT-specific deployment configuration
+# please put general deployment config in config/deploy.rb
+
+# Here you can set the server which you would like to, each server
+# each role can have multiple servers, each server defined as user@server.com:port
+# => port can be omiped and it defaults to 22
+role :web, 'root@example_dev_web.com:22'
+role :app, 'root@example_dev_app.com:22'
+role :db, 'root@example_dev_db.com:22', primary: true
+
+# The project's branch to use
+# Uncomment and edit this if you're using git, for other SCM's please refer
+# to capistrano's documentation
+set :branch, "master"
+
+# Use sudo ?
+set :use_sudo, false
+
+# Define deployments options
+set :deploy_to,   "/home/vhosts/#{application}"
+set :deploy_via,  :remote_cache
+set :logs_path,   "#{deploy_to}/logs"
+set :public_path, -> { "#{current_path}/public" }
+
+# Keep only the last 5 releases
+set :keep_releases, 5
+
+# Using RVM? Set this to the ruby version/gemset to use
+set :rvm_ruby_string, "1.9.2"
+
+# Mysql credentials
+set :mysql_credentials_file,                  -> { "#{deploy_to}/.mysql_password"}
+set :mysql_credentials_host_regex,            /hostname: (.*)$/o
+set :mysql_credentials_host_regex_match,      1
+set :mysql_credentials_user_regex,            /username: (.*)$/o
+set :mysql_credentials_user_regex_match,      1
+set :mysql_credentials_pass_regex,            /password: (.*)$/o
+set :mysql_credentials_pass_regex_match,      1
+set :mysql_root_credentials_file,             "/root/.mysql_password"
+set :mysql_root_credentials_host_regex,       /hostname: (.*)$/o
+set :mysql_root_credentials_host_regex_match, 1
+set :mysql_root_credentials_user_regex,       /username: (.*)$/o
+set :mysql_root_credentials_user_regex_match, 1
+set :mysql_root_credentials_pass_regex,       /password: (.*)$/o
+set :mysql_root_credentials_pass_regex_match, 1
+
+#############
+# Web server
+#
+
+# Which web server to use?
+# valid options: :nginx and :apache
+set :web_server_app, :nginx
+
+# Server specific configurations
+# Uncomment as necessary, default option are as follow
+# set :nginx_init_path, '/etc/init.d/nginx'
+# set :apache_init_path, '/etc/init.d/apache2'
+
+# Absolute path to this application's web server configuration
+# This gem suppose that you are already including files from the folder you're placing
+# the config file in, if not the application won't be up after deployment
+set :web_conf_file, -> { "/etc/nginx/#{fetch(:stage).to_s}/#{fetch :application}.conf" }
+
+# Which port does the server runs on ?
+set :web_server_listen_port, 80
+
+# What is the application url ?
+# THis is used for Virtual Hosts
+set :application_url, %w(example.com www.example.com)
+
+# What are the names of the indexes
+set :web_server_indexes, %w(index.php index.html)
+
+# HTTP Basic Authentifications
+# Uncomment this if you would like to add HTTP Basic authentifications,
+#
+# Change the 'web_server_auth_file' to the absolute path of the htpasswd file
+# web_server_auth_credentials is an array of user/password hashes, you can use
+# gen_pass(length) in a Proc to generate a new password as shown below
+#
+set :web_server_auth_file,        -> { "/etc/nginx/htpasswds/#{fetch :application}.crypt" }
+set :web_server_auth_credentials, [
+                                    {user: 'user1', password: 'pass1'},
+                                    {user: 'user2', password: -> { gen_pass(8) } },
+                                  ]
+
+# Enable mode rewrite ?
+set :web_server_mod_rewrite, true
+
+# Which server mode to operate on?
+# Valid options:
+#
+# For Nginx:
+# => :rails_reverse_proxy, :rails_passenger, :php_fpm
+# => :rails_reverse_proxy is used for unicorn (Rack apps)
+# => :rails_passenger runs rails apps
+# => :php_fpm is used to deliver websites written using PHP
+#
+# For Apache
+# =>
+set :web_server_mode, :rails_passenger
+
+# Server mode specific configurations
+# Uncomment and edit the one depending on the enabled mode
+# php_fpm settings
+# => On which host, php-fpm is running ?
+# set :php_fpm_host, 'localhost'
+# => Which port ?
+# set :php_fpm_port, '9000'
+
+# reverse_proxy settings (Unicorn for example)
+# => On which host the proxy is running ?
+# set :reverse_proxy_server_address, 'localhost'
+# => On which port ?
+# set :reverse_proxy_server_port, 45410
+# => What is the path to the socket file
+# set :reverse_proxy_socket, -> { "#{shared_path}/sockets/unicorn.sock"}
+
+#
+#############