capistrano-extensions 0.1.5 → 0.1.8

data/ISSUES.txt

@@ -0,0 +1,10 @@
+Known Bugs and Shortcomings
+
+(this one is specific to passenger-recipes, which really should be merged into capistrano-extensions...)
+* When introducing a new shared content directory, a bug can manifest itself when trying to sync production data back to your staging server.  Consider the following scenario:
+  1) Add a new upload field to your app (e.g. using file_column)
+  2) Update the deploy script to reference this new shared directory (via either :shared_content or :content_directories)
+  3) Try cap remote:sync FROM=production TO=staging --> It will fail when it tries to tarball up the shared content on production.
+  
+Currently, the best workaround is to log onto your production server and created the shared content directory, e.g. #{shared_path}/content/model_that_you_added_file_column_to
+

data/Manifest.txt

@@ -1,11 +1,15 @@
 History.txt
+ISSUES.txt
 Manifest.txt
 README.txt
 Rakefile
+TODO
 bin/capistrano-extensions-sync-content
 bin/capistrano-extensions-sync-db
 capistrano-extensions.gemspec
 lib/capistrano-extensions.rb
 lib/capistrano-extensions/deploy.rb
 lib/capistrano-extensions/geminstaller_dependency.rb
+lib/capistrano-extensions/recipes/content_sync.rb
+lib/capistrano-extensions/recipes/db_sync.rb
 lib/capistrano-extensions/version.rb

data/README.rdoc

@@ -0,0 +1,32 @@
+= capistrano-extensions
+
+* Stable API: http://johntrupiano.rubyforge.org/capistrano-extensions
+* Source: http://github.com/jtrupiano/capistrano-extensions
+
+== DESCRIPTION/FEATURES:
+
+This gem provides a base set of {Capistrano}[http://www.capify.org/] extensions including the following:
+  * a new :gemfile RemoteDependency type
+  * tasks/helpers for handling public and private asset folders (e.g. created by the file_column plugin)
+  * tasks/helpers for auto-syncing server gems (via integration with the {GemInstaller}[http://geminstaller.rubyforge.org/] gem)
+  * helpers for dealing with multiple deployable environments (e.g. staging, prodtest, production)
+  * tasks for working with remote logfiles
+  * tasks for database/asset synchronization from production back to local environments
+  * integration with {environmentalist}[http://johntrupiano.rubyforge.org/environmentalist]
+
+For a detailed exploration of these features, check out the wiki: http://github.com/jtrupiano/capistrano-extensions/wikis/home
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* Capistrano ~> 2.5.5
+* GemInstaller ~> 0.5.1
+
+== INSTALL:
+
+* sudo gem install capistrano-extensions (stable from rubyforge)
+* sudo gem install jtrupiano-capistrano-extensions (HEAD of repo from github)
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 8

data/lib/capistrano-extensions/deploy.rb

@@ -1,9 +1,8 @@
 require 'capistrano-extensions/geminstaller_dependency'
-require 'capistrano/server_definition'
 
 # Overrides the majority of recipes from Capistrano's deploy recipe set.
 Capistrano::Configuration.instance(:must_exist).load do
-  # Add sls_recipes to the load path  
+  # Add us to the load path
   @load_paths << File.expand_path(File.dirname(__FILE__))
 
   # ========================================================================
@@ -27,10 +26,10 @@ Capistrano::Configuration.instance(:must_exist).load do
   # changes if you do decide to muck with these!
   # =========================================================================
 
-  set(:use_sudo, false)     # we don't want to use sudo-- we don't have to!
-  set(:deploy_via, :export) # we don't want our .svn folders on the server!
-  _cset(:deploy_to) { "/var/www/vhosts/#{application}" }
-  _cset(:deployable_environments, [:production])
+  set(:use_sudo, false)   # we don't want to use sudo-- we don't have to!
+  set(:deploy_via, :copy) # no need to have subversion on the production server
+  _cset(:deploy_to) { "/var/vhosts/#{application}" }
+  _cset(:deployable_environments, [:staging])
 
   _cset(:rails_config_path) { File.join(latest_release, 'config') }
   _cset(:db_conf)           { 
@@ -45,11 +44,36 @@ Capistrano::Configuration.instance(:must_exist).load do
   _cset(:public_path)   { File.join(latest_release, 'public') }
   _cset(:log_path)      { "/var/log/#{application}" }
   
+  # Local Properties
+  _cset(:tmp_dir, "tmp/cap")
+  # when local:syncing, should we keep backups just in case of failure?
+  _cset(:store_dev_backups, false)
+  # how long to allow remote backups to be valid (at both cache levels)
+  _cset(:remote_backup_expires, 172800) # 2 days in seconds.
+  # when remote:syncing, should we keep backups just in case of failure?
+  _cset(:store_remote_backups, true)
+  # paths to exclude during deployment
+  _cset(:exclude_paths, [])
+  
+  _cset(:copy_cache) { File.expand_path("~/.capistrano/#{application}") }
+  set(:copy_exclude) {
+    # don't deploy the other environment directories
+    envs = fetch(:deployable_environments).dup
+    envs.delete_if { |env| rails_env.to_sym == env.to_sym }
+    envs.map! { |env| File.join("config", "#{env}") }
+    
+    envs + fetch(:exclude_paths)
+  }
+  
+  _cset(:zip, "gzip")
+  _cset(:unzip, "gunzip")
+  _cset(:zip_ext, "gz")
+  
   # Allow recipes to ask for a certain local environment
   def local_db_conf(env = nil)
     env ||= fetch(:rails_env)
     fetch(:config_structure, :rails).to_sym == :sls ?
-      File.join('config', env, 'database.yml') :
+      File.join('config', env.to_s, 'database.yml') :
       File.join('config', 'database.yml')
   end
 
@@ -79,17 +103,16 @@ Capistrano::Configuration.instance(:must_exist).load do
   # Now, let's actually include our common recipes!
   namespace :deploy do
     desc <<-DESC
-      [capistrano-extensions] Creates shared directories and symbolic links to them by the 
-      :content_directories and :shared_content properties.  See the README for 
-      further explanation.
+      [capistrano-extensions] Creates shared directories and symbolic links to them by reading the 
+      :content_directories and :shared_content properties.  See the README for further explanation.
     DESC
     task :create_shared_file_column_dirs, :roles => :app, :except => { :no_release => true } do
       mappings = content_directories.inject(shared_content) { |hsh, dir| hsh.merge({"content/#{dir}" => "public/#{dir}"}) }
       mappings.each_pair do |remote, local|
         run <<-CMD
+          umask 0022 && 
           mkdir -p #{shared_path}/#{remote} &&
-          ln -sf #{shared_path}/#{remote} #{latest_release}/#{local} &&
-          chmod 755 -R #{shared_path}/#{remote}
+          ln -sf #{shared_path}/#{remote} #{latest_release}/#{local}
         CMD
       end
     end
@@ -115,88 +138,17 @@ Capistrano::Configuration.instance(:must_exist).load do
       filesystem
     DESC
     task :pull do
-      tmp_location = "#{shared_path}/#{rails_env}.log.gz"
-      run "cp #{log_path}/#{rails_env}.log #{shared_path}/ && gzip #{shared_path}/#{rails_env}.log"
-      get "#{tmp_location}", "#{application}-#{rails_env}.log.gz"
+      tmp_location = "#{shared_path}/#{rails_env}.log.#{zip_ext}"
+      run "cp #{log_path}/#{rails_env}.log #{shared_path}/ && #{zip} #{shared_path}/#{rails_env}.log"
+      get "#{tmp_location}", "#{application}-#{rails_env}.log.#{zip_ext}"
       run "rm #{tmp_location}"
     end
   end
 
+  load 'recipes/db_sync'
+  load 'recipes/content_sync'
+  
   namespace :remote do
-    desc <<-DESC
-      [capistrano-extensions] Uploads the backup file downloaded from local:backup_db (specified via the FROM env variable), 
-      copies it to the remove environment specified by RAILS_ENV, and imports (via mysql command line tool) it back into the 
-      remote database.
-    DESC
-    task :restore_db, :roles => :db do
-      env = ENV['FROM'] || 'production'
-      
-      puts "\033[1;41m Restoring database backup to #{rails_env} environment \033[0m"
-      if deployable_environments.include?(rails_env.to_sym)
-        # remote environment
-        local_backup_file = "#{application}-#{env}-db.sql.gz"
-        remote_file       = "#{shared_path}/restore_db.sql"
-        if !File.exists?(local_backup_file)
-          puts "Could not find backup file: #{local_backup_file}"
-          exit 1
-        end
-        upload(local_backup_file, "#{remote_file}.gz")
-
-        pass_str = pluck_pass_str(db)
-        run "gunzip -f #{remote_file}.gz"
-        run "mysql -u#{db['username']} #{pass_str} #{db['database']} < #{remote_file}"
-        run "rm -f #{remote_file}"
-      end
-    end
-
-    desc <<-DESC
-      [capistrano-extensions]: Backs up target deployable environment's database (identified
-      by the FROM environment variable, which defaults to 'production') and restores it to 
-      the remote database identified by the TO environment variable, which defaults to "staging."
-    DESC
-    task :sync_db do
-      system("capistrano-extensions-sync-db #{ENV['FROM'] || 'production'} #{ENV['TO'] || 'staging'}")
-    end
-
-    desc <<-DESC
-      [capistrano-extensions]: Uploads the backup file downloaded from local:backup_content (specified via the 
-      FROM env variable), copies it to the remote environment specified by RAILS_ENV, and unpacks it into the 
-      shared/ directory.
-    DESC
-    task :restore_content do
-      from = ENV['FROM'] || 'production'
-      
-      if deployable_environments.include?(rails_env.to_sym)
-        local_backup_file = "#{application}-#{from}-content_backup.tar.gz"
-        remote_file       = "#{shared_path}/content_backup.tar.gz"
-        
-        if !File.exists?(local_backup_file)
-          puts "Could not find backup file: #{local_backup_file}"
-          exit 1
-        end
-        
-        upload(local_backup_file, "#{remote_file}")
-        remote_dirs = ["content"] + shared_content.keys
-        
-        run("cd #{shared_path} && rm -rf #{remote_dirs.join(' ')} && tar xzf #{remote_file} -C #{shared_path}/")
-      end
-    end
-    
-    desc <<-DESC
-      [capistrano-extensions]: Backs up target deployable environment's shared content (identified by the FROM environment 
-      variable, which defaults to 'production') and restores it to the remote environment identified 
-      by the TO envrionment variable, which defaults to "staging."  
-
-      Because multiple capistrano configurations must be loaded, an external executable
-      (capistrano-extensions-sync_content) is invoked, which independently calls capistrano.  See the 
-      executable at $GEM_HOME/capistrano-extensions-0.1.2/bin/capistrano-extensions-sync_content
-
-      $> cap remote:sync_content FROM=production TO=staging
-    DESC
-    task :sync_content do
-      system("capistrano-extensions-sync-content #{ENV['FROM'] || 'production'} #{ENV['TO'] || 'staging'}")
-    end
-    
     desc <<-DESC
       [capistrano-extensions]: Wrapper fro remote:sync_db and remote:sync_content.
       $> cap remote:sync FROM=production TO=staging
@@ -209,116 +161,42 @@ Capistrano::Configuration.instance(:must_exist).load do
 
   namespace :local do
     desc <<-DESC
-      [capistrano-extensions]: Backs up deployable environment's database (identified by the 
-      RAILS_ENV environment variable, which defaults to 'production') and copies it to the local machine
-    DESC
-    task :backup_db, :roles => :db do 
-      pass_str = pluck_pass_str(db)
-
-      run "mysqldump -u#{db['username']} #{pass_str} #{db['database']} > #{shared_path}/db_backup.sql"
-      run "gzip #{shared_path}/db_backup.sql"
-      get "#{shared_path}/db_backup.sql.gz", "#{application}-#{rails_env}-db.sql.gz"
-      run "rm -f #{shared_path}/db_backup.sql.gz #{shared_path}/db_backup.sql"
-    end
-    
-    desc <<-DESC
-      [capistrano-extensions] Untars the backup file downloaded from local:backup_db (specified via the FROM env 
-      variable, which defalts to RAILS_ENV), and imports (via mysql command line tool) it back into the database 
-      defined in the RAILS_ENV env variable.
-      
-      ToDo: implement proper rollback: currently, if the mysql import succeeds, but the rm fails,
-      the database won't be rolled back.  Not sure this is even all that important or necessary, since
-      it's a local database that doesn't demand integrity (in other words, you're still going to have to
-      fix it, but it's not mission critical).
-    DESC
-    task :restore_db, :roles => :db do
-      on_rollback { "gzip #{application}-#{from}-db.sql"}
-      
-      from = ENV['FROM'] || rails_env
-      
-      env = ENV['RESTORE_ENV'] || 'development'
-      y = YAML.load_file(local_db_conf(env))[env]
-      db, user = y['database'], (y['username'] || 'root') # update me!
-
-      pass_str = pluck_pass_str(y)
-
-      puts "\033[1;41m Restoring database backup to #{env} environment \033[0m"
-      # local
-      system <<-CMD
-        gunzip #{application}-#{from}-db.sql.gz &&
-        mysql -u#{user} #{pass_str} #{db} < #{application}-#{from}-db.sql
-      CMD
-    end
-    
-    desc <<-DESC
-      [capistrano-extensions]: Downloads a tarball of uploaded content (that lives in public/ 
-      directory, as specified by the :content_directories property) from the production site 
-      back to the local filesystem
+      [capistrano-extensions]: Wrapper for local:sync_db and local:sync_content
+      $> cap local:sync RAILS_ENV=production RESTORE_ENV=development
     DESC
-    task :backup_content do
-      folders = ["content"] + shared_content.keys
-      
-      run "cd #{shared_path} && tar czf #{shared_path}/content_backup.tar.gz #{folders.join(' ')}"
-      
-      #run "cd #{content_path} && tar czf #{shared_path}/content_backup.tar.gz *"
-      download("#{shared_path}/content_backup.tar.gz", "#{application}-#{rails_env}-content_backup.tar.gz")
-      run "rm -f #{shared_path}/content_backup.tar.gz"
+    task :sync do
+      sync_db
+      sync_content
     end
+  end
+  
+  namespace :util do
     
-    desc <<-DESC
-      [capistrano-extensions]: Restores the backed up content (evn var FROM specifies which environment
-      was backed up, defaults to RAILS_ENV) to the local development environment app
-    DESC
-    task :restore_content do
-      from = ENV['FROM'] || rails_env
-      
-      system "mkdir -p tmp/content-#{from}"
-      system "tar xzf #{application}-#{from}-content_backup.tar.gz -C tmp/content-#{from}"
-      system "rm -f #{application}-#{from}-content_backup.tar.gz"
-
-      shared_content.each_pair do |remote, local|
-        system "rm -rf #{local} && mv tmp/content-#{from}/#{remote} #{local}"
+    namespace :tmp do
+      desc "[capistrano-extensions]: Displays warning if :tmp_dir has more than 10 files or is greater than 50MB"
+      task :check do
+        #[ 5 -le "`ls -1 tmp/cap | wc -l`" ] && echo "Display Me"
+        cmd = %Q{ [ 10 -le "`ls -1 #{tmp_dir} | wc -l`" ] || [ 50 -le "`du -sh #{tmp_dir} | awk '{print int($1)}'`" ] && printf "\033[1;41m Clean up #{tmp_dir} directory \033[0m\n" && du -sh #{tmp_dir}/*  }
+        system(cmd)
       end
       
-      content_directories.each do |public_dir|
-        system "rm -rf public/#{public_dir}"
-        system "mv tmp/content-#{from}/content/#{public_dir} public/"
-      end
-
-    end
-    
-    desc <<-DESC
-      [capistrano-extensions]: Wrapper for local:backup_db and local:restore_db.      
-      $> cap local:sync_db RAILS_ENV=production RESTORE_ENV=development
-    DESC
-    task :sync_db do
-      transaction do
-        backup_db
-        ENV['FROM'] = rails_env
-        restore_db
-      end
-    end
-    
-    desc <<-DESC
-      [capistrano-extensions]: Wrapper for local:backup_content and local:restore_content
-      $> cap local:sync_content RAILS_ENV=production RESTORE_ENV=development
-    DESC
-    task :sync_content do
-      transaction do
-        backup_content
-        restore_content
+      desc "[capistrano-extensions]: Remove the current remote env's backups from :tmp_dir"
+      task :clean_remote do
+        system("rm -f #{tmp_dir}/#{application}-#{rails_env}*")
       end
-    end
     
-    desc <<-DESC
-      [capistrano-extensions]: Wrapper for local:sync_db and local:sync_content
-      $> cap local:sync RAILS_ENV=production RESTORE_ENV=development
-    DESC
-    task :sync do
-      sync_db
-      sync_content
+      # desc "Removes all but a single backup from :tmp_dir"
+      # task :clean do
+      #   
+      # end
+      # 
+      # desc "Removes all tmp files from :tmp_dir"
+      # task :remove do
+      #   
+      # end
     end
   end
+  
 end
 
 def pluck_pass_str(db_config)
@@ -327,4 +205,42 @@ def pluck_pass_str(db_config)
     pass_str = "-p#{pass_str.gsub('$', '\$')}"
   end
   pass_str || ''
-end
+end
+
+module LocalUtils
+  def current_timestamp
+    @current_timestamp ||= Time.now.to_i
+  end
+
+  def local_db_backup_file(args = {})
+    env = args[:env] || rails_env
+    timestamp = args[:timestamp] || current_timestamp
+    "#{tmp_dir}/#{application}-#{env}-db-#{timestamp}.sql"
+  end
+
+  def local_content_backup_dir(args={})
+    env = args[:env] || rails_env
+    timestamp = args[:timestamp] || current_timestamp
+    "#{tmp_dir}/#{application}-#{env}-content-#{timestamp}"
+  end
+
+  def retrieve_local_files(env, type)
+    `ls -r #{tmp_dir} | awk -F"-" '{ if ($2 ~ /#{env}/ && $3 ~ /#{type}/) { print $4; } }'`.split(' ')
+  end
+  
+  def most_recent_local_backup(env, type)
+    retrieve_local_files(env, type).first.to_i
+  end
+end
+
+module RemoteUtils
+  def last_mod_time(path)
+    capture("stat -c%Y #{path}").to_i
+  end
+  
+  def server_cache_valid?(path)
+    capture("[ -f #{path} ] || echo '1'").empty? && ((Time.now.to_i - last_mod_time(path)) <= remote_backup_expires) # two days in seconds
+  end
+end
+
+include LocalUtils, RemoteUtils

data/lib/capistrano-extensions/recipes/content_sync.rb

@@ -0,0 +1,103 @@
+namespace :remote do
+  desc <<-DESC
+    [capistrano-extensions]: Uploads the backup file downloaded from local:backup_content (specified via the 
+    FROM env variable), copies it to the remote environment specified by RAILS_ENV, and unpacks it into the 
+    shared/ directory.
+  DESC
+  task :restore_content do
+    from = ENV['FROM'] || 'production'
+    
+    if deployable_environments.include?(rails_env.to_sym)
+      generate_remote_content_backup if store_remote_backups
+      
+      local_backup_file = local_content_backup_dir(:timestamp => most_recent_local_backup(from, 'content'), :env => from) + ".tar.#{zip_ext}"
+      remote_dir        = "#{shared_path}/restore_#{from}_content"
+      remote_file       = "#{remote_dir}.tar.#{zip_ext}"
+      
+      if !File.exists?(local_backup_file)
+        puts "Could not find backup file: #{local_backup_file}"
+        exit 1
+      end
+      
+      upload(local_backup_file, "#{remote_file}")
+      remote_dirs = [content_dir] + shared_content.keys
+      
+      run("cd #{shared_path} && rm -rf #{remote_dirs.join(' ')} && tar xzf #{remote_file} -C #{shared_path}/")
+    end
+  end
+  
+  desc <<-DESC
+    [capistrano-extensions]: Backs up remote server's shared content and restores it to a separate remote server.
+    $> cap remote:sync_content FROM=production TO=staging
+  DESC
+  task :sync_content do
+    system("capistrano-extensions-sync-content #{ENV['FROM'] || 'production'} #{ENV['TO'] || 'staging'}")
+  end
+end
+
+namespace :local do
+  desc <<-DESC
+    [capistrano-extensions]: Downloads a tarball of shared content (identified by the :shared_content and 
+    :content_directories properties) from a deployable environment (RAILS_ENV) to the local filesystem.
+  DESC
+  task :backup_content do
+    # sort by last alphabetically (forcing the most recent timestamp to the top)
+    files = retrieve_local_files(rails_env, 'content')
+    
+    if files.empty?
+      # pull it from the server
+      generate_remote_content_backup unless server_cache_valid?(content_backup_file)
+      system("mkdir -p #{tmp_dir}")
+      download(content_backup_file, "#{local_content_backup_dir}.tar.#{zip_ext}")
+    else
+      # set us up to use our local cache
+      @current_timestamp = files.first.to_i # actually has the extension hanging off of it, but shouldn't be a problem
+    end      
+    # Notify user if :tmp_dir is too large
+    util::tmp::check
+  end
+  
+  desc <<-DESC
+    [capistrano-extensions]: Restores the backed up content (env var FROM specifies which environment
+    was backed up, defaults to RAILS_ENV) to the local development environment app
+  DESC
+  task :restore_content do
+    from = ENV['FROM'] || rails_env
+    
+    local_dir = local_content_backup_dir(:env => from)
+    system "mkdir -p #{local_dir}"
+    system "tar xzf #{local_dir}.tar.#{zip_ext} -C #{local_dir}"
+
+    shared_content.each_pair do |remote, local|
+      system "rm -rf #{local} && mv #{local_dir}/#{remote} #{local}"
+    end
+    
+    content_directories.each do |public_dir|
+      system "rm -rf public/#{public_dir}"
+      system "mv #{local_dir}/content/#{public_dir} public/"
+    end
+
+    system "rm -rf #{local_dir}"
+  end
+  
+  
+  desc <<-DESC
+    [capistrano-extensions]: Wrapper for local:backup_content and local:restore_content
+    $> cap local:sync_content RAILS_ENV=production RESTORE_ENV=development
+  DESC
+  task :sync_content do
+    transaction do
+      backup_content
+      restore_content
+    end
+  end
+end
+
+def content_backup_file
+  "#{shared_path}/backup_#{rails_env}_content.tar.#{zip_ext}"
+end
+
+def generate_remote_content_backup
+  folders = [content_dir] + shared_content.keys
+  run "cd #{shared_path} && tar czf #{content_backup_file} #{folders.join(' ')}"
+end

data/lib/capistrano-extensions/recipes/db_sync.rb

@@ -0,0 +1,136 @@
+namespace :remote do
+  desc <<-DESC
+    [capistrano-extensions] Uploads the backup file downloaded from local:backup_db (specified via the FROM env variable), 
+    copies it to the remote environment specified by RAILS_ENV, and imports (via mysql command line tool) it back into the 
+    remote database.
+  DESC
+  task :restore_db, :roles => :db do
+    env = ENV['FROM'] || 'production'
+    
+    puts "\033[1;41m Restoring database backup to #{rails_env} environment \033[0m"
+    if deployable_environments.include?(rails_env.to_sym)
+      generate_remote_db_backup if store_remote_backups
+      
+      # remote environment
+      local_backup_file = local_db_backup_file(:timestamp => most_recent_local_backup(env, 'db'), :env => env) + ".#{zip_ext}"
+      remote_file       = "#{shared_path}/restore_#{env}_db.sql"
+      
+      if !File.exists?(local_backup_file)
+        puts "Could not find backup file: #{local_backup_file}"
+        exit 1
+      end
+      upload(local_backup_file, "#{remote_file}.#{zip_ext}")
+
+      pass_str = pluck_pass_str(db)
+      run "#{unzip} -c #{remote_file}.#{zip_ext} > #{remote_file}"
+      run "mysql -u#{db['username']} #{pass_str} #{db['database']} < #{remote_file}"
+      run "rm -f #{remote_file}"
+    end
+  end
+
+  desc <<-DESC
+    [capistrano-extensions]: Backs up target deployable environment's database (identified
+    by the FROM environment variable, which defaults to 'production') and restores it to 
+    the remote database identified by the TO environment variable, which defaults to "staging."
+  DESC
+  task :sync_db do
+    system("capistrano-extensions-sync-db #{ENV['FROM'] || 'production'} #{ENV['TO'] || 'staging'}")
+  end
+end
+
+namespace :local do
+  desc <<-DESC
+    [capistrano-extensions]: Backs up deployable environment's database (identified by the 
+    RAILS_ENV environment variable, which defaults to 'production') and copies it to the local machine
+  DESC
+  task :backup_db, :roles => :db do 
+    
+    # sort by last alphabetically (forcing the most recent timestamp to the top)
+    files = retrieve_local_files(rails_env, 'db')
+
+    if files.empty?
+      # pull it from the server
+      generate_remote_db_backup unless server_cache_valid?(db_backup_zip_file)
+      system "mkdir -p #{tmp_dir}"
+      download(db_backup_zip_file, "#{local_db_backup_file}.#{zip_ext}")
+    else
+      # set us up to use our local cache
+      @current_timestamp = files.first.to_i # actually has the extension hanging off of it, but shouldn't be a problem
+    end
+  end
+      
+  desc <<-DESC
+    [capistrano-extensions] Untars the backup file downloaded from local:backup_db (specified via the FROM env 
+    variable, which defalts to RAILS_ENV), and imports (via mysql command line tool) it back into the database 
+    defined in the RESTORE_ENV env variable (defaults to development).
+  DESC
+  task :restore_db, :roles => :db do
+    from = ENV['FROM'] || rails_env
+    env  = ENV['RESTORE_ENV'] || 'development'
+    
+    y = YAML.load_file(local_db_conf(env))[env]
+    db, user = y['database'], (y['username'] || 'root') # update me!
+
+    pass_str = pluck_pass_str(y)
+    mysql_str  = "mysql -u#{user} #{pass_str} #{db}"
+    mysql_dump = "mysqldump --add-drop-database -u#{user} #{pass_str} #{db}"
+    
+    local_backup_file  = local_db_backup_file(:env => env)
+    remote_backup_file = local_db_backup_file(:env => from)
+
+    puts "\033[1;41m Restoring database backup to #{env} environment \033[0m"
+
+    # local
+    cmd = ""
+    if store_dev_backups
+      cmd << <<-CMD
+        mkdir -p #{tmp_dir} && 
+        #{mysql_dump} | #{zip} > #{local_backup_file}.#{zip_ext} && 
+      CMD
+    end
+    cmd << <<-CMD
+      #{unzip} -c #{remote_backup_file}.#{zip_ext} > #{remote_backup_file} &&
+      #{mysql_str} < #{remote_backup_file} && 
+      rm -f #{remote_backup_file}
+    CMD
+    system(cmd.strip)
+    
+    # Notify user if :tmp_dir is too large
+    util::tmp::check
+  end
+  
+  desc <<-DESC
+    [capistrano-extensions]: Wrapper for local:backup_db and local:restore_db.      
+    $> cap local:sync_db RAILS_ENV=production RESTORE_ENV=development
+  DESC
+  task :sync_db do
+    transaction do
+      backup_db
+      ENV['FROM'] = rails_env
+      restore_db
+    end
+  end
+  
+  desc <<-DESC
+    [capistrano-extensions]: Ensure that a fresh remote data dump is retrieved before syncing to the local environment.
+  DESC
+  task :resync_db do
+    util::tmp::clean_remote
+    sync_db
+  end
+  
+end
+
+def db_backup_file
+  "#{shared_path}/backup_#{rails_env}_db.sql"
+end
+
+def db_backup_zip_file
+  "#{db_backup_file}.#{zip_ext}"
+end
+
+def generate_remote_db_backup
+  pass_str = pluck_pass_str(db)
+  run "mysqldump --add-drop-database -u#{db['username']} #{pass_str} #{db['database']} > #{db_backup_file}"
+  run "rm -f #{db_backup_zip_file} && #{zip} #{db_backup_file} && rm -f #{db_backup_file}"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: capistrano-extensions
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.1.8
 platform: ruby
 authors: 
 - John Trupiano
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-22 00:00:00 -05:00
+date: 2009-04-27 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.5.4
+        version: 2.5.5
     version: 
 - !ruby/object:Gem::Dependency 
   name: geminstaller
@@ -30,17 +30,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.5.0
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.8.2
+        version: 0.5.1
     version: 
 description: A base set of Capistrano extensions-- aids with the file_column plugin, the GemInstaller gem, multiple deployable environments, logfile helpers, and database/asset synchronization from production to local environment
 email: jtrupiano@gmail.com
@@ -50,27 +40,28 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- README.txt
+- README.rdoc
 files: 
 - History.txt
+- ISSUES.txt
 - Manifest.txt
-- README.txt
-- Rakefile
+- README.rdoc
+- VERSION.yml
 - bin/capistrano-extensions-sync-content
 - bin/capistrano-extensions-sync-db
-- capistrano-extensions.gemspec
-- lib/capistrano-extensions.rb
+- lib/capistrano-extensions
 - lib/capistrano-extensions/deploy.rb
 - lib/capistrano-extensions/geminstaller_dependency.rb
-- lib/capistrano-extensions/version.rb
+- lib/capistrano-extensions/recipes
+- lib/capistrano-extensions/recipes/content_sync.rb
+- lib/capistrano-extensions/recipes/db_sync.rb
+- lib/capistrano-extensions.rb
 has_rdoc: true
 homepage: http://github.com/jtrupiano/capistrano-extensions
 post_install_message: 
 rdoc_options: 
-- --main
-- README.txt
+- --inline-source
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/README.txt

@@ -1,53 +0,0 @@
-= capistrano-extensions
-
-* http://github.com/jtrupiano/capistrano-extensions
-
-== DESCRIPTION/FEATURES:
-
-This gem provides a base set of Capistrano extensions including the following:
-  * a new :gemfile RemoteDependency type
-  * tasks/helpers for handling public and private asset folders (e.g. created by the file_column plugin)
-  * tasks/helpers for auto-syncing server gems (via integration with Chad Wooley's GemInstaller gem)
-  * helpers for dealing with multiple deployable environments (e.g. staging, prodtest, production)
-  * tasks for working with remote logfiles
-  * tasks for database/asset synchronization from production back to local environments
-
-For a detailed exploration of these features, check out the wiki: http://github.com/jtrupiano/capistrano-extensions/wikis/home
-
-== SYNOPSIS:
-
-  FIX (code sample of usage)
-
-== REQUIREMENTS:
-
-* Capistrano ~> 2.5.4
-* GemInstaller ~> 0.5.0
-
-== INSTALL:
-
-* sudo gem install capistrano-extensions
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2008 FIX
-
-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/Rakefile

@@ -1,35 +0,0 @@
-# -*- ruby -*-
-
-require 'rubygems'
-require 'hoe'
-require './lib/capistrano-extensions.rb'
-require "./lib/capistrano-extensions/version"
-
-PKG_NAME      = "capistrano-extensions"
-PKG_BUILD     = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
-version = CapistranoExtensions::Version::STRING.dup
-if ENV['SNAPSHOT'].to_i == 1
-  version << "." << Time.now.utc.strftime("%Y%m%d%H%M%S")
-end
-PKG_VERSION   = version
-PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
-
-Hoe.new(PKG_NAME, PKG_VERSION) do |p|
-  p.rubyforge_name = 'johntrupiano' # if different than lowercase project name
-  p.developer('John Trupiano', 'jtrupiano@gmail.com')
-  p.name = PKG_NAME
-  p.version = PKG_VERSION
-  #p.platform = Gem::Platform::RUBY
-  p.author = "John Trupiano"
-  p.email = "jtrupiano@gmail.com"
-  p.description = %q(A base set of Capistrano extensions-- aids with the file_column plugin, the GemInstaller gem, multiple deployable environments, logfile helpers, and database/asset synchronization from production to local environment)
-  p.summary = p.description # More details later??
-  p.remote_rdoc_dir = PKG_NAME # Release to /PKG_NAME
-  #  p.changes = p.paragraphs_of('CHANGELOG', 0..1).join("\n\n")
-  p.extra_deps << ["capistrano", "~> 2.5.4"]
-  p.extra_deps << ["geminstaller", "~> 0.5.0"]
-  p.need_zip = true
-  p.need_tar = false
-end
-
-# vim: syntax=Ruby

data/capistrano-extensions.gemspec

@@ -1,39 +0,0 @@
-Gem::Specification.new do |s|
-  s.name = %q{capistrano-extensions}
-  s.version = "0.1.4"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["John Trupiano"]
-  s.date = %q{2008-09-12}
-  s.description = %q{A base set of Capistrano extensions-- aids with the file_column plugin, the GemInstaller gem, multiple deployable environments, logfile helpers, and database/asset synchronization from production to local environment}
-  s.email = %q{jtrupiano@gmail.com}
-  s.executables = ["capistrano-extensions-sync-content", "capistrano-extensions-sync-db"]
-  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
-  s.files = ["History.txt", "Manifest.txt", "README.txt", "Rakefile", "bin/capistrano-extensions-sync-content", "bin/capistrano-extensions-sync-db", "lib/capistrano-extensions.rb", "lib/capistrano-extensions/deploy.rb", "lib/capistrano-extensions/geminstaller_dependency.rb", "lib/capistrano-extensions/version.rb"]
-  s.has_rdoc = true
-  s.homepage = %q{http://github.com/jtrupiano/capistrano-extensions}
-  s.rdoc_options = ["--main", "README.txt"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{johntrupiano}
-  s.rubygems_version = %q{1.2.0}
-  s.summary = %q{A base set of Capistrano extensions-- aids with the file_column plugin, the GemInstaller gem, multiple deployable environments, logfile helpers, and database/asset synchronization from production to local environment}
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
-
-    if current_version >= 3 then
-      s.add_runtime_dependency(%q<capistrano>, [">= 2.4.3"])
-      s.add_runtime_dependency(%q<geminstaller>, [">= 0.4.3"])
-      s.add_development_dependency(%q<hoe>, [">= 1.7.0"])
-    else
-      s.add_dependency(%q<capistrano>, [">= 2.4.3"])
-      s.add_dependency(%q<geminstaller>, [">= 0.4.3"])
-      s.add_dependency(%q<hoe>, [">= 1.7.0"])
-    end
-  else
-    s.add_dependency(%q<capistrano>, [">= 2.4.3"])
-    s.add_dependency(%q<geminstaller>, [">= 0.4.3"])
-    s.add_dependency(%q<hoe>, [">= 1.7.0"])
-  end
-end

data/lib/capistrano-extensions/version.rb

@@ -1,20 +0,0 @@
-module CapistranoExtensions
-  module Version #:nodoc:
-    # A method for comparing versions of required modules. It expects two
-    # arrays of integers as parameters, the first being the minimum version
-    # required, and the second being the actual version available. It returns
-    # true if the actual version is at least equal to the required version.
-    def self.check(required, actual) #:nodoc:
-      required = required.map { |v| "%06d" % v }.join(".")
-      actual   = actual.map { |v| "%06d" % v }.join(".")
-      return actual >= required
-    end
-
-    MAJOR = 0
-    MINOR = 1
-    TINY  = 5
-
-    STRING = [MAJOR, MINOR, TINY].join(".")
-  end
-end
-