capistrano-ash 1.0.0 → 1.1.0

data/README.textile

@@ -1,3 +1,25 @@
+h2. Overview
+
+Run the following commands in the command line from the project's root directory
+
+<pre>
+  <code>
+    capify .
+    rm -Rf config/deploy.rb; mkdir -p config/deploy
+    touch config/deploy/staging.rb config/deploy/production.rb
+  </code>
+</pre>
+
+After you have edited your @Capfile@ and @staging.rb@ and @production.rb@ files, you will need to run the following command only once per environment:
+
+<pre>
+  <code>
+    cap staging deploy:setup
+    cap production deploy:setup
+  </code>
+</pre>
+
+
 h2. Deploying Magento
 
 Check the "Wiki":https://github.com/augustash/capistrano-ash/wiki for detailed installation instructions.

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/lib/ash/base.rb

@@ -4,7 +4,6 @@ Dir['vendor/plugins/*/recipes/*.rb'].each { |plugin| load(plugin) }
 
 # Required gems/libraries
 require 'rubygems'
-require 'railsless-deploy'
 require 'ash/common'
 require 'capistrano/ext/multistage'
 
@@ -92,8 +91,8 @@ configuration.load do
     desc "Set standard permissions for Ash servers"
     task :fixperms, :except => { :no_release => true } do
       # chmod the files and directories.
-      sudo "find #{latest_release} -type d -exec chmod 755 {} \\;"
-      sudo "find #{latest_release} -type f -exec chmod 644 {} \\;"
+      try_sudo "find #{latest_release} -type d -exec chmod 755 {} \\;"
+      try_sudo "find #{latest_release} -type f -exec chmod 644 {} \\;"
     end
 
     desc "Test: Task used to verify Capistrano is working. Prints operating system name."
@@ -159,35 +158,50 @@ configuration.load do
       web
     end
 
-    desc "Perform a backup of web files"
-    task :web, :roles => :web do
-      puts "Backing up web files (user uploaded content and previous release)"
+    desc <<-DESC
+      Requires the rsync package to be installed.
+      
+      Performs a file-level backup of the application and any assets \
+      from the shared directory that have been symlinked into the \
+      applications root or sub-directories.
       
-      if !backup_exclude.nil? && !backup_exclude.empty?
-        logger.debug "processing backup exclusions..."
-        backup_exclude.each do |pattern|
-          exclude_string << "--exclude '#{pattern}' "
+      You can specify which files or directories to exclude from being \
+      backed up (i.e., log files, sessions, cache) by setting the \
+      :backup_exclude variable
+          set(:backup_exclude) { [ "var/", "tmp/", logs/debug.log ] }
+    DESC
+    task :web, :roles => :web do
+      if previous_release
+        puts "Backing up web files (user uploaded content and previous release)"
+
+        if backup_exclude.present?
+          logger.debug "processing backup exclusions..."
+          backup_exclude.each do |pattern|
+            exclude_string << "--exclude '#{pattern}' "
+          end
+          logger.debug "Exclude string = #{exclude_string}"
         end
-        logger.debug "Exclude string = #{exclude_string}"
+
+        # Copy the previous release to the /tmp directory
+        logger.debug "Copying previous release to the /tmp/#{release_name} directory"
+        run "rsync -avzrtpL #{exclude_string} #{current_path}/ /tmp/#{release_name}/"
+        # create the tarball of the previous release
+        set :archive_name, "release_B4_#{release_name}.tar.gz"
+        logger.debug "Creating a Tarball of the previous release in #{backups_path}/#{archive_name}"
+        run "cd /tmp && tar -cvpf - ./#{release_name}/ | gzip -c --best > #{backups_path}/#{archive_name}"
+
+        # remove the the temporary copy
+        logger.debug "Removing the tempory copy"
+        run "rm -rf /tmp/#{release_name}"
+      else
+        logger.important "no previous release to backup; backup of files skipped"
       end
-      
-      # Copy the previous release to the /tmp directory
-      logger.debug "Copying previous release to the /tmp/#{release_name} directory"
-      run "rsync -avzrtpL #{exclude_string} #{current_path}/ /tmp/#{release_name}/"
-      # create the tarball of the previous release
-      set :archive_name, "release_B4_#{release_name}.tar.gz"
-      logger.debug "Creating a Tarball of the previous release in #{backups_path}/#{archive_name}"
-      run "cd /tmp && tar -cvpf - ./#{release_name}/ | gzip -c --best > #{backups_path}/#{archive_name}"
-      
-      # remove the the temporary copy
-      logger.debug "Removing the tempory copy"
-      run "rm -rf /tmp/#{release_name}"
     end
 
     desc "Perform a backup of database files"
     task :db, :roles => :db do
       puts "Backing up the database now and putting dump file in the previous release directory"
-      # define the filename (include the current_path so the dump file will be within the dirrectory)
+      # define the filename (include the current_path so the dump file will be within the directory)
       filename = "#{current_path}/#{dbname}_dump-#{Time.now.to_s.gsub(/ /, "_")}.sql.gz"
       # dump the database for the proper environment
       run "mysqldump -u #{dbuser} -p #{dbname} | gzip -c --best > #{filename}" do |ch, stream, out|

data/lib/ash/drupal.rb

@@ -1,5 +1,6 @@
 # Require our base library.
 require 'ash/base'
+require 'railsless-deploy'
 
 configuration = Capistrano::Configuration.respond_to?(:instance) ?
   Capistrano::Configuration.instance(:must_exist) :
@@ -31,13 +32,15 @@ configuration.load do
     desc "Setup shared application directories and permissions after initial setup"
     task :setup_shared, :roles => :web do
       # remove Capistrano specific directories
-      run "rm -Rf #{shared_path}/log"
-      run "rm -Rf #{shared_path}/pids"
-      run "rm -Rf #{shared_path}/system"
+      run<<-CMD
+        rm -Rf #{shared_path}/log &&
+        rm -Rf #{shared_path}/pids &&
+        rm -Rf #{shared_path}/system
+      CMD
 
       # create shared directories
       multisites.each_pair do |folder, url|
-          run "mkdir -p #{shared_path}/#{url}/files"
+        run "mkdir -p #{shared_path}/#{url}/files"
       end
 
       # set correct permissions
@@ -48,8 +51,8 @@ configuration.load do
     task :finalize_update, :except => { :no_release => true } do
       # remove shared directories
       multisites.each_pair do |folder, url|
-          run "mv #{latest_release}/sites/#{folder} #{latest_release}/sites/#{url}"
-          run "rm -Rf #{latest_release}/sites/#{url}/files"
+        run "mv #{latest_release}/sites/#{folder} #{latest_release}/sites/#{url}"
+        run "rm -Rf #{latest_release}/sites/#{url}/files"
       end
     end
 
@@ -75,7 +78,7 @@ configuration.load do
     task :db, :roles => :db do
       puts "Backing up the database now and putting dump file in the previous release directory"
       multisites.each_pair do |folder, url|
-        # define the filename (include the current_path so the dump file will be within the dirrectory)
+        # define the filename (include the current_path so the dump file will be within the directory)
         filename = "#{current_path}/#{folder}_dump-#{Time.now.to_s.gsub(/ /, "_")}.sql.gz"
         # dump the database for the proper environment
         run "#{drush_bin} -l #{url} -r #{current_path} sql-dump | gzip -c --best > #{filename}"
@@ -90,9 +93,11 @@ configuration.load do
    desc "Symlink shared directories"
    task :symlink, :except => { :no_release => true } do
       multisites.each_pair do |folder, url|
-        run "ln -nfs #{shared_path}/#{url}/files #{current_release}/sites/#{url}/files"
-        run "ln -nfs #{latest_release}/sites/#{url}/settings.php.#{stage} #{latest_release}/sites/#{url}/settings.php"
-        run "#{drush_bin} -l #{url} -r #{current_path} vset --yes file_directory_path sites/#{url}/files"
+        run<<-CMD
+          ln -nfs #{shared_path}/#{url}/files #{latest_release}/sites/#{url}/files &&
+          ln -nfs #{latest_release}/sites/#{url}/settings.php.#{stage} #{latest_release}/sites/#{url}/settings.php &&
+          #{drush_bin} -l #{url} -r #{current_path} vset --yes file_directory_path sites/#{url}/files
+        CMD
       end
    end
 

data/lib/ash/drupal_shared_hosting.rb

@@ -0,0 +1,31 @@
+# Require our base drupal library
+require 'ash/drupal'
+
+configuration = Capistrano::Configuration.respond_to?(:instance) ?
+  Capistrano::Configuration.instance(:must_exist) :
+  Capistrano.configuration(:must_exist)
+
+configuration.load do
+  # --------------------------------------------
+  # Overloaded Methods
+  # --------------------------------------------
+  namespace :deploy do
+    desc "Setup shared application directories and permissions after initial setup"
+    task :setup_shared, :roles => :web do
+      # remove Capistrano specific directories
+      run<<-CMD
+        rm -Rf #{shared_path}/log &&
+        rm -Rf #{shared_path}/pids &&
+        rm -Rf #{shared_path}/system
+      CMD
+
+      # create shared directories
+      multisites.each_pair do |folder, url|
+        run "mkdir -p #{shared_path}/#{url}/files"
+      end
+
+      # set correct permissions for a shared hosting environment
+      run "chmod -R 755 #{shared_path}/*"
+    end
+  end
+end

data/lib/ash/hosted_magento.rb

@@ -1,5 +1,6 @@
 # Required base libraries
 require 'ash/base'
+require 'railsless-deploy'
 
 # Bootstrap Capistrano instance
 configuration = Capistrano::Configuration.respond_to?(:instance) ?

data/lib/ash/magento.rb

@@ -1,5 +1,6 @@
 # Required base libraries
 require 'ash/base'
+require 'railsless-deploy'
 
 # Bootstrap Capistrano instance
 configuration = Capistrano::Configuration.respond_to?(:instance) ?

data/lib/ash/wordpress.rb

@@ -1,5 +1,6 @@
 # Require our base library.
 require 'ash/base'
+require 'railsless-deploy'
 
 configuration = Capistrano::Configuration.respond_to?(:instance) ?
   Capistrano::Configuration.instance(:must_exist) :
@@ -26,14 +27,17 @@ namespace :deploy do
   desc "Setup shared application directories and permissions after initial setup"
   task :setup_shared, :roles => :web do
     # remove Capistrano specific directories
-    run "rm -Rf #{shared_path}/log"
-    run "rm -Rf #{shared_path}/pids"
-    run "rm -Rf #{shared_path}/system"
-
+    run<<-CMD
+      rm -Rf #{shared_path}/log &&
+      rm -Rf #{shared_path}/pids &&
+      rm -Rf #{shared_path}/system
+    CMD
+    
     # create shared directories
-    run "mkdir -p #{shared_path}/uploads"
-    run "mkdir -p #{shared_path}/cache"
-
+    run<<-CMD
+      mkdir -p #{shared_path}/uploads &&
+      mkdir -p #{shared_path}/cache
+    CMD
     # set correct permissions
     run "chmod -R 777 #{shared_path}/*"
   end
@@ -41,11 +45,16 @@ namespace :deploy do
   desc "[internal] Touches up the released code. This is called by update_code after the basic deploy finishes."
   task :finalize_update, :except => { :no_release => true } do
     # remove shared directories
-    run "rm -Rf #{latest_release}/#{uploads_path}"
-    run "rm -Rf #{latest_release}/wp-content/cache"
+    run<<-CMD
+      rm -Rf #{latest_release}/#{uploads_path} &&
+      rm -Rf #{latest_release}/wp-content/cache
+    CMD
+    
     # Removing cruft files.
-    run "rm -Rf #{latest_release}/license.txt"
-    run "rm -Rf #{latest_release}/readme.html"
+    run<<-CMD
+      rm -Rf #{latest_release}/license.txt &&
+      rm -Rf #{latest_release}/readme.html
+    CMD
   end
 end
 
@@ -55,9 +64,11 @@ end
 namespace :wordpress do
   desc "Links the correct settings file"
   task :symlink do
-    run "ln -nfs #{shared_path}/uploads #{current_release}/#{uploads_path}"
-    run "ln -nfs #{shared_path}/cache #{current_release}/wp-content/cache"
-    run "ln -nfs #{latest_release}/wp-config.php.#{stage} #{latest_release}/wp-config.php"
+    run<<-CMD
+      ln -nfs #{shared_path}/uploads #{current_release}/#{uploads_path} &&
+      ln -nfs #{shared_path}/cache #{current_release}/wp-content/cache &&
+      ln -nfs #{latest_release}/wp-config.php.#{stage} #{latest_release}/wp-config.php
+    CMD
   end
   
   desc "Set URL in database"

data/lib/ash/wordpress_shared_hosting.rb

@@ -0,0 +1,32 @@
+# Require our base drupal library
+require 'ash/wordpress'
+
+configuration = Capistrano::Configuration.respond_to?(:instance) ?
+  Capistrano::Configuration.instance(:must_exist) :
+  Capistrano.configuration(:must_exist)
+
+configuration.load do
+  # --------------------------------------------
+  # Overloaded Methods
+  # --------------------------------------------
+  namespace :deploy do
+    desc "Setup shared application directories and permissions after initial setup"
+    task :setup_shared, :roles => :web do
+      # remove Capistrano specific directories
+      run<<-CMD
+        rm -Rf #{shared_path}/log &&
+        rm -Rf #{shared_path}/pids &&
+        rm -Rf #{shared_path}/system
+      CMD
+      
+      # create shared directories
+      run<<-CMD
+        mkdir -p #{shared_path}/uploads &&
+        mkdir -p #{shared_path}/cache
+      CMD
+
+      # set correct permissions
+      run "chmod -R 755 #{shared_path}/*"
+    end
+  end
+end

data/lib/ash/zend_doctrine.rb

@@ -1,5 +1,7 @@
 # Require our base library.
 require 'ash/base'
+require 'railsless-deploy'
+
 
 configuration = Capistrano::Configuration.respond_to?(:instance) ?
   Capistrano::Configuration.instance(:must_exist) :
@@ -20,38 +22,45 @@ configuration.load do
   namespace :deploy do
     desc "Setup shared directories and permissions after initial setup"
     task :setup_shared, :roles => :web, :except => { :no_release => true } do
-        run "mkdir -p #{shared_path}/var"
-        run "mkdir -p #{shared_path}/var/logs"
-        run "mkdir -p #{shared_path}/var/cache"
-        run "mkdir -p #{shared_path}/var/sessions"
-        run "mkdir -p #{shared_path}/system"
-        sudo "chmod -R 777 #{shared_path}/*"
+      run<<-CMD 
+        mkdir -p #{shared_path}/var &&
+        mkdir -p #{shared_path}/var/logs &&
+        mkdir -p #{shared_path}/var/cache && 
+        mkdir -p #{shared_path}/var/sessions &&
+        mkdir -p #{shared_path}/system
+      CMD
+      try_sudo "chmod -R 777 #{shared_path}/*"
     end
     
     desc "[internal] Touches up the released code. This is called by update_code after the basic deploy finishes."
     task :finalize_update, :roles => :web, :except => { :no_release => true } do
-        # remove shared directories
-        run "rm -Rf #{latest_release}/var"
-        run "rm -Rf #{latest_release}/public/system"
+      # remove shared directories
+      run "rm -Rf #{latest_release}/var"
+      run "rm -Rf #{latest_release}/public/system"
     end
   end
   
   namespace :zend do
     desc "Symlink shared directories"
     task :symlink, :except => { :no_release => true } do
-        run "ln -nfs #{shared_path}/var #{current_release}/var"
-        run "ln -nfs #{shared_path}/system #{current_release}/public/system"
-        run "mv #{current_release}/application/configs/application.ini.dist #{current_release}/application/configs/application.ini"
-        run "ln -nfs #{current_release}/application/Application.#{stage}.php #{current_release}/application/Application.php"
-        run "mv #{current_release}/public/htaccess.#{stage} #{current_release}/public/.htaccess"
-        run "cp #{current_release}/scripts/doctrine-cli.#{stage} #{current_release}/scripts/doctrine-cli"
-        sudo "chmod +x #{current_release}/scripts/doctrine-cli"
-        
-        # remove the example or other environment example files
-        run "rm -f #{current_release}/scripts/doctrine-cli.dist"
-        run "rm -f #{current_release}/scripts/doctrine-cli.staging"
-        run "rm -f #{current_release}/scripts/doctrine-cli.production"
-        run "rm -f #{current_release}/application/Application.example.php"
+      run<<-CMD
+        ln -nfs #{shared_path}/var #{current_release}/var &&
+        ln -nfs #{shared_path}/system #{current_release}/public/system &&
+        mv #{current_release}/application/configs/application.ini.dist #{current_release}/application/configs/application.ini &&
+        ln -nfs #{current_release}/application/Application.#{stage}.php #{current_release}/application/Application.php &&
+        mv #{current_release}/public/htaccess.#{stage} #{current_release}/public/.htaccess &&
+        cp #{current_release}/scripts/doctrine-cli.#{stage} #{current_release}/scripts/doctrine-cli
+      CMD
+      
+      try_sudo "chmod +x #{current_release}/scripts/doctrine-cli"
+      
+      # remove the example or other environment example files
+      run<<-CMD
+        rm -f #{current_release}/scripts/doctrine-cli.dist &&
+        rm -f #{current_release}/scripts/doctrine-cli.staging &&
+        rm -f #{current_release}/scripts/doctrine-cli.production &&
+        rm -f #{current_release}/application/Application.example.php
+      CMD
     end
   end
   

data/lib/ash/zend_doctrine_shared_hosting.rb

@@ -0,0 +1,28 @@
+# Require our base drupal library
+require 'ash/zend_doctrine'
+
+configuration = Capistrano::Configuration.respond_to?(:instance) ?
+  Capistrano::Configuration.instance(:must_exist) :
+  Capistrano.configuration(:must_exist)
+
+configuration.load do
+  # --------------------------------------------
+  # Overloaded Methods
+  # --------------------------------------------
+  namespace :deploy do
+    desc<<-DESC
+      Setup shared directories and permissions after initial setup \
+      for a shared hosting enviroment
+    DESC
+    task :setup_shared, :roles => :web, :except => { :no_release => true } do
+      run<<-CMD 
+        mkdir -p #{shared_path}/var &&
+        mkdir -p #{shared_path}/var/logs &&
+        mkdir -p #{shared_path}/var/cache && 
+        mkdir -p #{shared_path}/var/sessions &&
+        mkdir -p #{shared_path}/system
+      CMD
+      try_sudo "chmod -R 755 #{shared_path}/*"
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: capistrano-ash
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - August Ash
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-17 00:00:00 -05:00
+date: 2011-05-19 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -31,10 +31,13 @@ files:
 - lib/ash/base.rb
 - lib/ash/common.rb
 - lib/ash/drupal.rb
+- lib/ash/drupal_shared_hosting.rb
 - lib/ash/hosted_magento.rb
 - lib/ash/magento.rb
 - lib/ash/wordpress.rb
+- lib/ash/wordpress_shared_hosting.rb
 - lib/ash/zend_doctrine.rb
+- lib/ash/zend_doctrine_shared_hosting.rb
 has_rdoc: true
 homepage: https://github.com/augustash/capistrano-ash
 licenses: []