app-deployer 0.0.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MGIzNjE1OWIyOGZmNWI0YjFkNmQ5ZDk3ODI4NWRhNmExYzUxNDVkYQ==
+  data.tar.gz: !binary |-
+    ZTI1OGNlYWJjMzhhZjAxMjMwZDNhOGQ1MzU5ZjQ0NmE5ZTNjZTBlMQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YjY1OWQ0OGIxNWExZmM1ZmE0NjA2NTdmNmJkNGQzNWQ1ZDQyOGNjOGUwMDI2
+    MzRhYjU0M2RmNTMxZGRlODhlYTE0ZmQ3YzZiMzcyODkwODQyN2M2NGUzYzZj
+    ZWVhZWUxNzgwMjQxNjUzNWY1OTcwM2M4ZGZhMDA0NDFkNjc5YjM=
+  data.tar.gz: !binary |-
+    NGEwYmFjNDQ2ODY5Y2Y0Y2Q0MzE0YmEyNzNmNjE3MmQzMDQ0MWVlZTE2OTg3
+    ZjZjN2YxYWU1ZTA3ZDExOWQzYTM0MGVlNTVjYmQzNmQ3YThjMWFhYjBmMmNk
+    MmEwODc0OWRkMDA4NmZjOTE0ZGRjZDFhMzJiZGUxZGQzOWM4Yjg=

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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in deployer.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ricky Dunlop
+
+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,174 @@
+# App Deployer
+
+This gem makes it easy to deploy non rails apps/sites, it also comes with some useful helper tasks for frameworks like lithium and cakephp.
+
+It is used by rehabstudio for almost every deployment we do.
+
+## Installation
+**Please be aware that this gem is in active development and some features may not work as expected.**
+
+If you find any issues/bugs please add them to the issue tracker, or even better, see the Contributing section at the bottom.
+
+####Required Gems
+We need to ensure we have the following gems installed
+
+    $ gem install bundler capistrano
+
+
+####To install locally:
+
+1. clone the repo
+2. cd to the directory
+3. Run `rake install`
+
+---
+
+When it is available from rubygems.org you will be able to install it yourself as:
+
+    $ gem install app-deployer
+
+## Usage
+
+####Basic deployment
+
+Open your application's Capfile and make it look like this:
+
+    require 'rubygems'
+    require 'app-deployer'
+    
+Open your config/deploy.rb file and add this:
+
+    set :application, 'myapp'
+    set :user, "your-deploy-user"
+    set :repository, "https://path-to git-repo.git"
+    set :deploy_to, "/var/www/myapp"
+
+    server "http://yourserver.com", :web, :app
+
+
+####Multistage
+You can also set this up to use capistrano's multistage extension. This is great if you have to deploy the app to multiple servers like dev, staging etc.
+
+To use multistage you should also add the following to your Capfile:
+
+    require 'capistrano/ext/multistage' 
+    set :stages, %w(development, staging, production)
+    set :default_stage, "production"
+    
+The setup of your deploy scripts will also change, instead of having config/deploy.rb you need to create a folder called deploy in your config folder and also separate file for each stage. 
+
+You will need a file for each item in the stages variable in your Capfile.
+
+So in this example we would need development.rb, staging.rb and production.rb to be located in the config/deploy directory.
+
+
+###Initial setup
+To setup your app you need to run 
+
+    cap deploy:setup
+    
+or if you are using multistage you would use this (subsituting <stage> with the stage name)
+
+    cap <stage> deploy:setup
+    
+This will create the necessary folder structure for deployment
+
+###Deploying
+To deploy your app you can now run
+
+    cap deploy
+
+or for multistage
+
+    cap <stage> deploy
+  
+
+##Framework tasks
+To use the extra tasks that are available for frameworks you need to include the file at the bottom of your deploy file.
+
+
+###CakePHP
+A lot of the tasks are based on the capcake gem but some have been slightly modified.
+To use the CakePHP tasks, add the following at the bottom of your deploy file:
+    
+    require 'app-deployer/framework/cakephp/cakephp'
+
+This will add in some hooks to the deployment process.
+
+####Setup
+On initial setup of your site a DB config file will be generated for you. Just fill in the values at the prompt
+
+The tmp folders and any shared folders will also be setup. See Shared folders below for more info on these.
+
+
+####After deploy hooks
+Each time you deploy, symlinks for the database file and any shared folders will be created for your app.
+
+The tmp cache will also be cleared.
+
+####Changing the CakePHP repo and branch
+Use these lines below to change your repo/branch
+    
+    set :cakephp_repo, "git://github.com/cakephp/cakephp.git"
+    set :cake_branch,  "origin/2.2"
+
+
+####Shared folders
+If you have an uploads folder that you want to preserve on each deploy you can declare them using:
+
+    set :shared_app_dirs, ["webroot/uploads"]
+    
+Each time you deploy these folders will be symlinked to the current directory. 
+These folders will also be created on deploy:setup to save you creating them manually
+
+####Older version support
+If you are still using CakePHP 1.3 you will need to set the following in your deploy file.
+    
+    set: cakephp_version, 1.3 
+
+###Lithium
+First we need to include the lithium tasks in our deploy file
+
+    require 'app-deployer/framework/lithium/lithium'
+    
+    
+###EC2
+If you use Amazon EC2, you can add this line to make capistrano use your pem file
+
+    ssh_options[:keys] = ["#{ENV['HOME']}/.ssh/your-key.pem"]
+    
+
+##Servers
+###Apache
+To use any of the apache tasks you need to include the file in your deploy script
+
+    require 'app-deployer/server/apache/apache'
+
+To put your server into maintenance mode run:
+
+    cap apache:maintenance:start
+
+To take it out of maintenance mode run:
+
+    cap apache:maintenance:end
+
+###Nginx
+To be completed
+
+###PHP5-FPM
+You can automatically reload the php-fpm service after a deploy by including the task at the bottom of your deploy file
+
+    require 'app-deployer/server/php-fpm'
+
+
+You should ensure the deploy user has the correct privileges to do this by adding a line to the sudoers file using visudo
+
+    deploy ALL=(ALL) NOPASSWD: /usr/sbin/service php5-fpm reload
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/app-deployer.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/app-deployer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ricky Dunlop"]
+  gem.email         = ["ricky@rehabstudio.com"]
+  gem.description   = %q{Features a modular design allowing it to be extended for various frameworks. Includes recipes for CakePHP, Lithium, MySQL, Nginx, Apache. Uses Railsless deploy}
+  gem.summary       = %q{Deploy PHP apps using Capistrano}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.add_dependency 'capistrano', ">= 2.13.5"
+  gem.add_dependency 'colored', ">= 1.2.0"
+  gem.name          = "app-deployer"
+  gem.require_paths = ["lib"]
+  gem.version       = App::Deployer::VERSION
+end

data/lib/app-deployer.rb

@@ -0,0 +1,11 @@
+require "app-deployer/version"
+require 'app-deployer/helpers'
+require 'app-deployer/railsless-deploy'
+require 'app-deployer/composer'
+require 'app-deployer/compass'
+require 'colored'
+
+module App
+  module Deployer
+  end
+end

data/lib/app-deployer/compass.rb

@@ -0,0 +1,8 @@
+Capistrano::Configuration.instance(:must_exist).load do
+	namespace :compass do
+		desc 'Compiles Compass files into stylsheets'
+		task :compile do
+			run("cd #{latest_release}/webroot; compass compile --output-style nested --force -e production")
+		end
+	end
+end

data/lib/app-deployer/composer.rb

@@ -0,0 +1,68 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :composer do
+    desc "Gets composer and installs it"
+    task :get, :roles => :app, :except => { :no_release => true } do
+      if remote_file_exists?("#{previous_release}/composer.phar")
+        pretty_print "--> Copying Composer from previous release"
+        run "#{try_sudo} sh -c 'cp #{previous_release}/composer.phar #{latest_release}/'"
+        puts_ok
+      end
+
+      if !remote_file_exists?("#{latest_release}/composer.phar")
+        pretty_print "--> Downloading Composer"
+
+        run "#{try_sudo} sh -c 'cd #{latest_release} && curl #{curl_options} -sS http://getcomposer.org/installer | #{php_bin}'"
+      else
+        pretty_print "--> Updating Composer"
+
+        run "#{try_sudo} sh -c 'cd #{latest_release} && #{php_bin} composer.phar self-update'"
+      end
+      puts_ok
+    end
+
+    desc "Updates composer"
+
+    desc "Runs composer to install vendors from composer.lock file"
+    task :install, :roles => :app, :except => { :no_release => true } do
+      if !composer_bin
+        composer.get
+        set :composer_bin, "#{php_bin} composer.phar"
+      end
+
+      pretty_print "--> Installing Composer dependencies"
+      run "#{try_sudo} sh -c 'cd #{latest_release} && #{composer_bin} install #{composer_options}'"
+      puts_ok
+    end
+
+    desc "Runs composer to update vendors, and composer.lock file"
+    task :update, :roles => :app, :except => { :no_release => true } do
+      if !composer_bin
+        composer.get
+        set :composer_bin, "#{php_bin} composer.phar"
+      end
+
+      pretty_print "--> Updating Composer dependencies"
+      run "#{try_sudo} sh -c 'cd #{latest_release} && #{composer_bin} update #{composer_options}'"
+      puts_ok
+    end
+
+    desc "Dumps an optimized autoloader"
+    task :dump_autoload, :roles => :app, :except => { :no_release => true } do
+      if !composer_bin
+        composer.get
+        set :composer_bin, "#{php_bin} composer.phar"
+      end
+
+      pretty_print "--> Dumping an optimized autoloader"
+      run "#{try_sudo} sh -c 'cd #{latest_release} && #{composer_bin} dump-autoload --optimize'"
+      puts_ok
+    end
+
+    task :copy_vendors, :roles => :app, :except => { :no_release => true } do
+      pretty_print "--> Copying vendors from previous release"
+
+      run "vendorDir=#{current_path}/libraries; if [ -d $vendorDir ] || [ -h $vendorDir ]; then cp -a $vendorDir #{latest_release}/libraries; fi;"
+      puts_ok
+    end
+  end
+end

data/lib/app-deployer/framework/cakephp/cakephp.rb

@@ -0,0 +1,215 @@
+Capistrano::Configuration.instance(:must_exist).load do
+
+  require 'erb'
+
+  # =========================================================================
+  # Settings
+  # =========================================================================
+
+  _cset :shared_app_dirs, []
+  _cset(:cakephp_branch)  { "master" }
+  _cset(:cakephp_repo)    { "https://github.com/cakephp/cakephp.git" }
+  _cset :cakephp_version, 2
+  _cset :tmp_children,    %w(cache logs sessions tests)
+  _cset :cache_children,  %w(models persistent views)
+  _cset :logs_files,      %w(debug error)
+  _cset(:tmp_path)        { File.join(shared_path, "tmp") }
+  _cset(:cache_path)      { File.join(tmp_path, "cache") }
+  _cset(:logs_path)       { File.join(tmp_path, "logs") }
+  if cakephp_version >= 2
+    set :shared_children,       %w(Config tmp)
+    set :database_partial_path, "Config/database.php"
+  else
+    set :shared_children,       %w(config tmp)
+    set :database_partial_path, "config/database.php"
+  end
+  set(:database_path)     { File.join(shared_path, database_partial_path) }
+
+  # =========================================================================
+  # Hooks
+  # =========================================================================
+
+  after('deploy:setup',           'cakephp:setup')
+  after('deploy:create_symlink',  'cakephp:create_symlink')
+
+  ["composer:install", "composer:update"].each do |action|
+    before action do
+      if copy_vendors
+        composer.copy_vendors
+      end
+    end
+  end
+
+  after "deploy:finalize_update" do
+    if use_composer
+      if update_vendors
+        composer.update
+      else
+        composer.install
+      end
+    end
+    if clear_cache
+      cakephp.cache.clear
+    end
+  end
+
+  # =========================================================================
+  # Tasks
+  # =========================================================================
+
+  namespace :cakephp do
+
+    desc <<-DESC
+      Prepares server for deployment of a CakePHP application. \
+
+      By default, it will create a shallow clone of the CakePHP repository \
+      inside #{shared_path}/cakephp and run deploy:cake:update.
+    DESC
+    task :setup do
+      transaction do
+        run "cd #{shared_path} && git clone --depth 1 #{cakephp_repo} cakephp"
+        checkout
+        shared.setup
+        database.config
+      end
+    end
+
+    desc <<-DESC
+      Checkout a new branch/tag.
+    DESC
+    task :checkout do
+      stream "cd #{shared_path}/cakephp && git checkout -q #{cakephp_branch}"
+    end
+
+    desc <<-DESC
+      Update the cake repository to the latest version.
+    DESC
+    task :update do
+      stream "cd #{shared_path}/cakephp && git pull"
+    end
+
+    desc <<-DESC
+      This is a task that will get called from the deploy:create_symlink task \
+      It runs just before the release is symlinked to the current directory \
+
+      You should use it to create symlinks to things like your database config \
+      and any shared directories or files that your app uses  .
+    DESC
+    task :create_symlink do
+      transaction do
+        database.create_symlink
+        shared.create_symlink
+      end
+    end
+
+    # Framework specific tasks
+
+    # Caching
+    namespace :cache do
+      desc <<-DESC
+        Clears CakePHP's APP/tmp/cache and its sub-directories.
+
+        Recursively finds all files in :cache_path and runs `rm -f` on each. If a file \
+        is renamed/removed after it was found but before it removes it, no error \
+        will prompt (-ignore_readdir_race). If symlinks are found, they will not be followed.
+
+        You will rarely need to call this task directly; instead, use the `deploy' \
+        task (which performs a complete deploy, including `cake:cache:clear')
+      DESC
+      task :clear, :roles => :web, :except => { :no_release => true } do
+        run "#{try_sudo} find -P #{cache_path} -ignore_readdir_race -type f -name '*' -exec rm -f {} \\;"
+      end
+    end
+
+    # Database config
+    namespace :database do
+      desc <<-DESC
+        Generates CakePHP database configuration file in #{shared_path}/config \
+        and symlinks #{current_path}/config/database.php to it
+      DESC
+      task :config, :roles => :web, :except => { :no_release => true } do
+        on_rollback { run "rm -f #{database_path}; true" }
+        puts "Database configuration"
+        prompt_with_default(:datasource, cakephp_version >= 2 ? "Database/Mysql" : "mysql")
+        prompt_with_default(:persistent, 'false')
+        prompt_with_default(:host, "localhost")
+        prompt_with_default(:login, user)
+        set :password, Capistrano::CLI.password_prompt("password:")
+        prompt_with_default(:database, "")
+        prompt_with_default(:prefix, "")
+        prompt_with_default(:encoding, 'utf8')
+
+        template = File.read(File.join(File.dirname(__FILE__), "templates", "database.php.erb"))
+        result = ERB.new(template).result(binding)
+
+        put(result, "#{database_path}", :mode => 0644, :via => :scp)
+        after("deploy:create_symlink", "cakephp:database:create_symlink")
+      end
+
+      desc <<-DESC
+        Creates required CakePHP's APP/config/database.php as a symlink to \
+        #{deploy_to}/shared/config/database.php
+      DESC
+      task :create_symlink, :roles => :web, :except => { :no_release => true } do
+        run "#{try_sudo} rm -f #{current_path}/#{database_partial_path}"
+        run "#{try_sudo} ln -s #{database_path} #{current_path}/#{database_partial_path}"
+      end
+    end
+
+    # Shared directories and files
+    namespace :shared do
+      desc <<-DESC
+        Creates shared folders on the server
+      DESC
+      task :setup do
+        dirs      = [deploy_to, releases_path, shared_path]
+        dirs     += shared_children.map { |d| File.join(shared_path, d) }
+        tmp_dirs  = tmp_children.map { |d| File.join(tmp_path, d) }
+        tmp_dirs += cache_children.map { |d| File.join(cache_path, d) }
+        run "#{try_sudo} mkdir -p #{(dirs + tmp_dirs).join(' ')}"
+        run "#{try_sudo} chmod -R 777 #{tmp_path}" if (!user.empty?)
+
+        if shared_app_dirs
+          shared_app_dirs.each { | link | run "#{try_sudo} mkdir -p #{shared_path}/#{link}" }
+        end
+      end
+
+      desc <<-DESC
+        Symlinks all files and folders
+      DESC
+      task :create_symlink do
+        run "ln -s #{shared_path}/tmp #{latest_release}/tmp";
+        if shared_app_dirs
+          shared_app_dirs.each { | link | run "ln -s #{shared_path}/#{link} #{current_path}/#{link}" }
+        end
+      end
+    end
+
+    # Logs
+    namespace :log do
+      desc <<-DESC
+        Clears CakePHP's APP/tmp/logs and its sub-directories
+
+        Recursively finds all files in :logs_path and runs `rm -f` on each. If a file \
+        is renamed/removed after it was found but before it removes it, no error \
+        will prompt (-ignore_readdir_race). If symlinks are found, they will not be followed.
+      DESC
+      task :clear, :roles => :web, :except => { :no_release => true } do
+        run "#{try_sudo} find -P #{logs_path} -ignore_readdir_race -type f -name '*' -exec rm -f {} \\;"
+      end
+
+      desc <<-DESC
+        Streams the result of `tail -f` on all :logs_files \
+
+        By default, the files are `debug` and `error`. You can add your own \
+        in config/deploy.rb
+
+        set :logs_files %w(debug error my_log_file)
+      DESC
+      task :tail, :roles => :web, :except => { :no_release => true } do
+        files = logs_files.map { |d| File.join(logs_path, d) }
+        stream "#{try_sudo} tail -f #{files.join(' ')}"
+      end
+    end
+  end
+end