jtrupiano-capistrano-extensions 0.1.3

data/History.txt

@@ -0,0 +1,22 @@
+# Created 2008-08-20
+
+=== v0.1.3 / 2008-08-25
+* 2008-08-25 : VERSION BUMP
+  Introduced a new property :shared_content, which is intended to completely replace :content_directories
+  eventually.  All directories previously specified by :content_directories go through a simple transformation
+  to match the new hash construct that is :shared_content.  Now, we can specify non-public directories (though
+  they are still limited to within RAILS_ROOT), e.g.
+  
+  set(:shared_content) { "feeds" => "content" }
+  
+  This will create a symlink whose source is #{shared_path}/feeds and whose target is RAILS_ROOT/content.
+  Then, on successive deployments, this symlink is just recreated, and all of our feeds are still accessible
+  (because they were stored outside of RAILS_ROOT and then symlinked in).
+
+=== v0.1.2 / 2008-07-20
+2008-08-20
+*	Fixed a mysql bug that was encountered in "sync" operations.  When passing a password on the command-line
+	(e.g. mysqldump -uuser -ppass), $'s in the password need to be escaped.  I also fixed the scenario where
+	there was no password (common for restoring to the development environment).  Previously you would be
+	prompted for a password only in the case where there was no password required.  This was a result of 
+	the way the mysql commands were being built: "mysql -u#{user} -p#{password}" where password was nil or ""

data/Manifest.txt

@@ -0,0 +1,11 @@
+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
+

data/README.txt

@@ -0,0 +1,217 @@
+= 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 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
+
+== INCOMPLETE:
+  * Missing a detailed sample config file
+  * Describe the shortcomings (or rather my dissatisfaction) with the remote syncing executables for
+    assets/db.  It works fine for now, but is a little wasteful.
+  * Database synchronization _only_ works for MySQL. (not sure if I intend to change this any time soon)
+  * This has really only been tested on single-server deployments, so I'm not sure how well it will work
+    on more complex environments -- I'll personally be able to test that in the coming month or two, but
+    that will be dictated by necessity.
+  * Still no support for user-uploaded assets stored outside of the public/ directory
+  * Need to automate the generation of this document: the descriptions for each attribute/task
+    should mirror the description in the deploy script (in other words, I should only have to update the
+    the documentation in one place).
+
+== CAPISTRANO CODE EXTENSIONS:
+* new RemoteDependency type :gemfile
+
+  depend(:remote, :gemfile, "config/geminstaller.yml")
+
+  Aliases the depend method (with depend_without_gemfile).  Proxies all calls with :type != :gemfile
+  to the aliased method.  When :type == :gemfile, the gems file is parsed (using geminstaller 
+  codebase) to iteratively call depend_without_gemfile with each gem found in the YAML file.
+
+  This is still really only suitable for single-server deployments.  The idea would be to add new
+  options to the geminstaller.yml config syntax that would allow us to reference specific
+  capistrano roles for a given gem.  For instance, the database server won't need all of our rails
+  gems.  A separate ferret server may require it's own set of gems, etc.
+
+== NEW RECIPE PROPERTIES --> DEFAULTS
+  # Provides a way to specify which uploadable asset directories (that live in public/)
+  # should be retrievable via the local:copy_production_content and local:copy_production
+  # tasks described below.  Note that this parameter is also utilized by the
+  # passenger-recipes gem to keep these uploadable assets in the shared/ context.
+  :content_directories --> []
+  
+  # This property is similar to :content_directories, except it doesn't assume that the symlinks
+  # exist in the public/ directory (the default location for FileColumn file storage).
+  #
+  # This property is a hash of remote => local mappings, e.g.
+  #
+  #   "feeds" => "content" (or "uploaded_assets/meal" => "public/meal")
+  #  
+  # These examples will effectively create the following symlinks in a deployable environment:
+  #   ln -sf \#{shared_path}/feeds RAILS_ROOT/content
+  #   ln -sf \#{shared_path}/uploaded_assets/meal RAILS_ROOT/public/meal
+  #  
+  # Each key (the "remote" directory) must be a directory found in \#{shared_path} (in a deployable environment)  
+  # Each value (the "local" directory) must be a directory found in RAILS_ROOT (in a local environment)
+  :shared_content --> {}
+
+  # Which environments are deployable-- for each environment specified in this array,
+  # a helper function by the same name is created that is executed only if RAILS_ENV
+  # is set to that value.  See examples/sample_deploy.rb for a code sample.
+  :deployable_environments --> [:production]
+
+  # We at SLS use a different config structure than rails does out of the box.
+  # Setting this value to :sls will alter some of the expected paths.  Normally,
+  # you will not have to set this variable.  To see a discussion of the SLS config
+  # file structure, see http://blog.smartlogicsolutions.com/2008/06/02/better-setup-for-environments-in-rails/
+  :config_structure --> :rails
+
+== NEW RECIPES:
+* deploy:create_shared_file_column_dirs
+  
+  Creates shared filecolumn directories and symbolic links to them by 
+  reading the :content_directories property.  Note that this task is not invoked by default,
+  but rather is exposed to you as a helper.  To utilize, you'll want to override
+  deploy:default and invoke this yourself.
+  
+* deploy:gem_update
+
+  Invokes geminstaller to ensure that the proper gem set is installed on the target server.  
+  Note that this task is not invoked by default, but rather is exposed to you as a helper.
+  
+* log:pull
+
+  Tarballs deployable environment's rails logfile (identified by 
+  RAILS_ENV environment variable, which defaults to 'production') and copies it to the local
+  filesystem
+  
+* local:backup_db
+
+  Backs up deployable environment's database (identified by the 
+  RAILS_ENV environment variable, which defaults to 'production') and copies it to the local machine
+
+* local:restore_db
+
+  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).
+
+* local:backup_content
+
+  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
+  
+* local:restore_content
+
+  Restores the backed up content (evn var FROM specifies which environment was backed up, 
+  defaults to RAILS_ENV) to the local development environment app
+
+* local:sync_db
+
+  Wrapper for local:backup_db and local:restore_db
+
+  $> cap local:sync_db RAILS_ENV=production RESTORE_ENV=development
+  
+* local:sync_content
+
+  Wrapper for local:backup_content and local:restore_content
+  
+  $> cap local:sync_content RAILS_ENV=production RESTORE_ENV=development
+  
+* local:sync
+
+  Wrapper for local:sync_db and local:sync_content
+  
+  $> cap local:sync RAILS_ENV=production RESTORE_ENV=development
+
+* remote:restore_db
+
+  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.
+
+* remote:sync_db
+
+  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."  
+
+  Because multiple capistrano configurations must be loaded, an external executable
+  (capistrano-extensions-sync_db) is invoked, which independently calls capistrano.  See the 
+  executable at $GEM_HOME/capistrano-extensions-0.1.3/bin/capistrano-extensions-sync_db
+
+  $> cap remote:sync_db FROM=production TO=staging
+
+* remote:restore_content
+
+  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.
+
+* remote:sync_content
+
+  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
+
+* remote:sync
+
+  Wrapper fro remote:sync_db and remote:sync_content.
+  
+  $> cap remote:sync FROM=production TO=staging
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* Capistrano = 2.4.3
+* GemInstaller = 0.4.3
+
+== INSTALL:
+
+* rake gem
+* sudo gem install pkg/capistrano-extensions-0.1.3.gem --local
+
+== 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

@@ -0,0 +1,47 @@
+# GEM_SPEC = eval(File.read("#{File.dirname(__FILE__)}/#{PKG_NAME}.gemspec"))
+# 
+# Rake::GemPackageTask.new(GEM_SPEC) do |p|
+#   p.gem_spec = GEM_SPEC
+#   p.need_tar = true
+#   p.need_zip = true
+# end
+# 
+# desc "Clean up generated directories and files"
+# task :clean do
+#   rm_rf "pkg"
+# end
+
+
+# -*- 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'] : ''
+PKG_VERSION   = CapistranoExtensions::Version::STRING + PKG_BUILD
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+
+
+Hoe.new('capistrano-extensions', PKG_VERSION) do |p|
+  # p.rubyforge_name = 'capistrano-extensionsx' # if different than lowercase project name
+  # p.developer('FIX', 'FIX@example.com')
+  p.name = "capistrano-extensions"
+  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 = 'capistrano-extensions' # Release to /capistrano-extensions
+  #  p.changes = p.paragraphs_of('CHANGELOG', 0..1).join("\n\n")
+  p.extra_deps << ["capistrano", ">= 2.4.3"]
+  p.extra_deps << ["geminstaller", ">= 0.4.3"]
+  p.need_zip = true
+  p.need_tar = false
+end
+
+# vim: syntax=Ruby

data/bin/capistrano-extensions-sync-content

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+if ARGV.size < 2
+  puts "Improper invocation: capistrano-extensions-copy-production-db backup_env restore_env"
+  exit 1
+end
+
+system("cap local:backup_content RAILS_ENV=#{ARGV[0]}")
+system("cap remote:restore_content RAILS_ENV=#{ARGV[1]} FROM=#{ARGV[0]}")

data/bin/capistrano-extensions-sync-db

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+if ARGV.size < 2
+  puts "Improper invocation: capistrano-extensions-copy-production-db backup_env restore_env"
+  exit 1
+end
+
+system("cap local:backup_db RAILS_ENV=#{ARGV[0]}")
+system("cap remote:restore_db RAILS_ENV=#{ARGV[1]} FROM=#{ARGV[0]}")

data/lib/capistrano-extensions.rb

@@ -0,0 +1,2 @@
+gem 'capistrano', '>= 2.4.3'   # load v2.4.3 or higher
+gem 'geminstaller', '>= 0.4.3' # load v0.4.3 or higher

data/lib/capistrano-extensions/deploy.rb

@@ -0,0 +1,324 @@
+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  
+  @load_paths << File.expand_path(File.dirname(__FILE__))
+
+  # ========================================================================
+  # These variables MUST be set in the client capfiles. If they are not set,
+  # the deploy will fail with an error.
+  # ========================================================================
+
+
+  # =========================================================================
+  # These variables may be set in the client capfile if their default values
+  # are not sufficient.
+  # =========================================================================
+
+  _cset(:content_directories, []) # I'd like to eventually remove this...
+  _cset(:shared_content, {})
+  _cset(:rails_env) { ENV['RAILS_ENV'].nil? ? fetch(:deployable_environments).first : ENV['RAILS_ENV'] }  
+
+  # =========================================================================
+  # These variables should NOT be changed unless you are very confident in
+  # what you are doing. Make sure you understand all the implications of your
+  # 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])
+
+  _cset(:rails_config_path) { File.join(latest_release, 'config') }
+  _cset(:db_conf)           { 
+    fetch(:config_structure, :rails).to_sym == :sls ?
+      File.join(rails_config_path, rails_env, 'database.yml') :
+      File.join(rails_config_path, 'database.yml')
+  }
+
+  # Where uploaded content is stored
+  _cset(:content_dir, "content")
+  _cset(:content_path)  { File.join(shared_path, content_dir) }
+  _cset(:public_path)   { File.join(latest_release, 'public') }
+  _cset(:log_path)      { "/var/log/#{application}" }
+  
+  # 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', 'database.yml')
+  end
+
+  # Read from the local machine-- BE CAREFUL!!!
+  set(:db) { YAML.load_file(local_db_conf)[rails_env] }
+
+  # Let's define helpers for our deployable environments
+  # Can we possibly just infer this from the config directory structure?
+  deployable_environments.each do |env|
+    src = <<-CODE
+      def #{env.to_s}(&block)
+        if rails_env.to_s == '#{env.to_s}'
+          puts "*** Deploying to the \033[1;41m  #{env.to_s.capitalize} \033[0m server!"
+          yield
+          puts <<-DEBUG
+            rails_env: \#{rails_env}
+            deploy_to: \#{deploy_to}
+            content_directories: \#{content_directories.join(', ')}
+            shared_content: \#{shared_content.keys.join(', ')}
+          DEBUG
+        end
+      end
+    CODE
+    eval src
+  end
+
+  # 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.
+    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
+          mkdir -p #{shared_path}/#{remote} &&
+          ln -sf #{shared_path}/#{remote} #{latest_release}/#{local} &&
+          chmod 755 -R #{shared_path}/#{remote}
+        CMD
+      end
+    end
+
+    desc <<-DESC
+      [capistrano-extensions]: Invokes geminstaller to ensure that the proper gem set is installed on 
+      the target server.  Note that this task is not invoked by default, but rather is exposed to you
+      as a helper.
+    DESC
+    task :gem_update, :roles => :app do
+      run <<-CMD
+        gem sources -u &&
+        #{sudo} geminstaller -e -c #{rails_config_path}/geminstaller.yml
+      CMD
+    end
+
+  end
+  
+  namespace :log do
+    desc <<-DESC
+      [capistrano-extensions]: Tarballs deployable environment's rails logfile (identified by 
+      RAILS_ENV environment variable, which defaults to 'production') and copies it to the local
+      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"
+      run "rm #{tmp_location}"
+    end
+  end
+
+  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
+    DESC
+    task :sync do
+      sync_db
+      sync_content
+    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 
+      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'] # 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
+    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 *"
+      get "#{shared_path}/content_backup.tar.gz", "#{application}-#{rails_env}-content_backup.tar.gz"
+      run "rm -f #{shared_path}/content_backup.tar.gz"
+    end
+    
+    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 "tar xzf #{application}-#{from}-content_backup.tar.gz -C public/"
+      system "rm -f #{application}-#{from}-content_backup.tar.gz"
+
+      shared_content.each_pair do |remote, local|
+        system "rm -rf #{local} && mv public/#{remote} #{local}"
+      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
+      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
+    end
+  end
+end
+
+def pluck_pass_str(db_config)
+  pass_str = db_config['password']
+  if !pass_str.nil?
+    pass_str = "-p#{pass_str.gsub('$', '\$')}"
+  end
+  pass_str || ''
+end

data/lib/capistrano-extensions/geminstaller_dependency.rb

@@ -0,0 +1,35 @@
+require 'geminstaller'
+
+Capistrano::Configuration.instance(:must_exist).load do
+
+  def pluck_accessor_hash(obj, attrs = [])
+    ret = {}
+    attrs.each do |attr|
+      ret[attr] = obj.send(attr)
+    end
+    ret
+  end
+
+  alias :depend_without_gemfile :depend
+
+  # Auxiliary helper method for the `deploy:check' task. Lets you set up your
+  # own dependencies.
+  def depend(location, type, *args)
+    if type == :gemfile
+      registry = GemInstaller::Registry.new
+      config_builder = registry.config_builder
+      path = args.pop
+      config_builder.config_file_paths = path
+      config = config_builder.build_config
+      gems = config.gems
+      
+      gems.each do |agem|
+        # gem() function defined in Capistrano's RemoteDependency class
+        options = pluck_accessor_hash(agem, [:platform, :install_options, :check_for_upgrade, :no_autogem, :fix_dependencies])
+        depend_without_gemfile(location, :gem, agem.name, agem.version, options)
+      end
+    else
+      depend_without_gemfile(location, type, *args)
+    end
+  end
+end

data/lib/capistrano-extensions/version.rb

@@ -0,0 +1,20 @@
+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  = 3
+
+    STRING = [MAJOR, MINOR, TINY].join(".")
+  end
+end
+

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: jtrupiano-capistrano-extensions
+version: !ruby/object:Gem::Version 
+  version: 0.1.3
+platform: ruby
+authors: 
+- John Trupiano
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-26 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.4.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: geminstaller
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    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
+executables: 
+- capistrano-extensions-sync-content
+- capistrano-extensions-sync-db
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+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
+has_rdoc: true
+homepage: http://github.com/jtrupiano/capistrano-extensions
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: capistrano-extensions
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: 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
+test_files: []
+