capistrano_transmit 0.2.2 → 1.0.0

data/README.rdoc

@@ -24,7 +24,7 @@ Mac OS X development.
   
 or in your +Gemfile+:
 
-  gem 'capistrano_transmit'
+  gem 'capistrano_transmit', '~> 1.0.0'
   
 Then add to your deploy.rb:
 
@@ -32,19 +32,18 @@ Then add to your deploy.rb:
 
 == Examples
 
-  cap transmit:get:mysql		# Fetch the remote production MySQL database
-							              # and overwrite your local development database with it
-  cap transmit:get:assets		# Fetch the remote assets into your local development environment
-
-
+  cap transmit:get:mysql		# Fetch the production database into local development
   cap transmit:put:mysql		# Overwrite the production MySQL database with your development data
 
 == Prerequisites
 
-This Capistrano extension assumes some variables are present in your deploy.rb:
+You need Capistrano 2 for this gem to work.
+
+A couple variables can be overridden by setting them in config/deploy.rb:
 
-  user						          # the SSH user for connecting to the deploy host
-  deploy_host					      # the host on which to run the db dump
+  user                      # SSH user, defaults to nil, which falls back to your unix user
+  deploy_host               # the host on which to run the db dump, falls back to your first db
+  dumpfile                  # remote pathname to dump the database in, defaults to tmp/${production}.sql.gz
 
 
 Copyright (c) 2010-2011 Joost Baaij, released under the MIT license.

data/capistrano_transmit.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{capistrano_transmit}
-  s.version = "0.2.2"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joost Baaij"]

data/lib/capistrano/transmit.rb

@@ -4,11 +4,9 @@ end
 
 Capistrano::Configuration.instance.load do
   
-  _cset :user,      ""
-  _cset :db_config, { capture("cat #{current_path}/config/database.yml") }
-  _cset :db_remote, { YAML::load(db_config)['production'] }
-  _cset :db_local,  { YAML::load_file("config/database.yml")['development'] }
-  _cset :dumpfile,  { "#{current_path}/tmp/#{db_remote['database']}.sql.gz" }
+  _cset :user,        nil
+  _cset(:deploy_host) { find_servers(:roles => :db).first.host }
+  _cset(:dumpfile)    { "#{current_path}/tmp/#{_db_remote['database']}.sql.gz" }
   
   after "transmit:get:mysql", "transmit:cleanup"
   after "transmit:put:mysql", "transmit:cleanup"
@@ -17,32 +15,62 @@ Capistrano::Configuration.instance.load do
     namespace :get do
       desc 'Fetch the remote production database and overwrite your local development database with it'
       task :mysql, :roles => :db do
-        run "mysqldump --opt --quick --extended-insert --skip-lock-tables -u #{db_remote['username']} --password='#{db_remote['password']}' --host='#{db_remote['host']}' #{db_remote['database']} | gzip > #{dumpfile}"
+        run "mysqldump --opt --quick --extended-insert --skip-lock-tables #{_remote_db_auth} | gzip > #{dumpfile}"
 
-        system "rsync -vP #{user}@#{deploy_host}:#{dumpfile} tmp/#{db_local["database"]}.sql.gz"
-        system "gunzip < tmp/#{db_local["database"]}.sql.gz | mysql -u #{db_local['username']} --password='#{db_local['password']}' --host='#{db_local['host']}' #{db_local['database']}"
+        system "rsync -vP #{_user_with_host}:#{dumpfile} tmp/#{_db_local["database"]}.sql.gz"
+        system "gunzip < tmp/#{_db_local["database"]}.sql.gz | mysql #{_local_db_auth}"
       end
 
       desc 'Fetch the assets from the production server to the development environment'
       task :assets, :roles => :app do
-        system "rsync -Lcrvz #{user}@#{deploy_host}:#{current_path}/public ."
+        system "rsync -Lcrvz #{_user_with_host}:#{current_path}/public ."
       end
     end
 
     namespace :put do
       desc 'Upload the local development database to the remote production database and overwrite it'
       task :mysql, :roles => :db do
-        system "mysqldump --opt -u #{db_local['username']} --password='#{db_local['password']}' --host='#{db_local['host']}' #{db_local['database']} > tmp/#{db_local['database']}.sql"
+        system "mysqldump --opt #{_local_db_auth} > tmp/#{_db_local['database']}.sql"
 
-        system "rsync -vP tmp/#{db_local['database']}.sql #{user}@#{deploy_host}:#{dumpfile}"
-        run "mysql -u #{db_remote['username']} --password='#{db_remote['password']}' --host='#{db_remote['host']}' #{db_remote['database']} < #{dumpfile}"
+        system "rsync -vP tmp/#{_db_local['database']}.sql #{_user_with_host}:#{dumpfile}"
+        run "mysql #{_remote_db_auth} < #{dumpfile}"
       end
     end
   
     task :cleanup do
       run "rm #{dumpfile}"
-      system "rm tmp/#{db_local['database']}.sql.gz"
+      system "rm tmp/#{_db_local['database']}.sql.gz"
     end
   end
 
+  # Return just the deploy host when user not set.  
+  def _user_with_host
+    user.nil? ? deploy_host : "#{user}@#{deploy_host}"
+  end
+
+  # Output of the entire database.yml on the remote server.
+  def _db_config
+    @_db_config       ||= capture("cat #{current_path}/config/database.yml")
+  end
+
+  # Production database configuration hash.
+  def _db_remote
+    @_db_remote       ||= YAML::load(_db_config)['production']
+  end
+
+  # Development database configuration hash.
+  def _db_local
+    @_db_local        ||= YAML::load_file("config/database.yml")['development']
+  end
+  
+  # Complete remote database connection string.
+  def _remote_db_auth
+    @_remote_db_auth  ||= "-u #{_db_remote['username']} --password='#{_db_remote['password']}' --host='#{_db_remote['host']}' #{_db_remote['database']}"
+  end
+
+  # Complete local database connection string.
+  def _local_db_auth
+    @_local_db_auth   ||= "-u #{_db_local['username']} --password='#{_db_local['password']}' --host='#{_db_local['host']}' #{_db_local['database']}"
+  end
+  
 end

metadata

@@ -2,7 +2,7 @@
 name: capistrano_transmit
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.2
+  version: 1.0.0
 platform: ruby
 authors: 
 - Joost Baaij