cap_sync 0.0.7 → 0.0.8

data/README.rdoc

@@ -1,4 +1,4 @@
-= Capistrano Sync Recipes
+= Capistrano Db & Data Sync Recipes
 
 Recipes to clone database & public data from production server to developement machine.
 
@@ -7,51 +7,31 @@ Recipes to clone database & public data from production server to developement m
 Add this to your Gemfile
 
   group :development do
-    gem 'cap_sync', :require => false
+    gem 'cap_sync'
   end
 
-Add following line to your Capfile:
+Add following line to your deploy.rb:
 
-  require 'cap_sync' 
+  require 'cap_sync/capistrano' 
 
 = Syncing database
 
-  > cap sync:db
+  > bundle exec cap sync:db
 
-Does following:
-1. Accesses production server.
-2. Dumps database to app's tmp.
-3. Downloads dump to local app's tmp.
-4. Imports dump to local app's development database.
+See lib/cap_sync/db.rb for list of available options.
 
-Remote database credentials are loaded from remote application config/database.yml.
-
-Available variables and defaults:
-  :sync_local_env => 'development',      # Local environment key in database.yml
-  :sync_remote_env => 'production',      # Remote environment key in database.yml
-  :sync_remote_dump_cmd => 'mysqldump',  # Remote mysqldump command
-  :sync_local_load_cmd => 'mysql',       # Local mysqldump command
-  :sync_keep_dumps => false,             # Keep downloaded dump in app's tmp after syncing
-
-You can modify it in your deploy.rb as follows:
-
-  set :sync_local_cmd, '/usr/local/bin/mysql/bin'
+You can set: local & remote environment, mysql dump/client command & flags, turn compression on/off, etc.
 
 = Syncing data
 
-  > cap sync:data
+  > bundle exec cap sync:data
   
-Rsync's local and remote folders. By default, does incremental implicit synchronization.
+Rsync's local and remote folders. By default, does incremental implicit synchronization with rsync.
 
-Available variables and defaults:
-  :sync_method => :rsync,                                         # :rsync - sync with rsync, :cap - sync with capistrano
-  :sync_folders => {"#{shared_path}/system" => "public/system"},  # Folders to sync remote => local
-  :rsync_cmd => "rsync",                                          # rsync command
-  :rsync_flags => "-rv --stats --delete"                          # rsync flags
+See lib/cap_sync/data.rb for list of available options.
 
 = Todo
 
 1. Correctly handle multiple servers (database).
-2. Tests.
-3. Sync multiple databases.
-4. Sync up and down.
+2. Envflags to modify options on the fly.
+3. Win32 compability.

data/cap_sync.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "cap_sync"
-  s.version     = '0.0.7'
+  s.version     = '0.0.8'
   s.platform    = Gem::Platform::RUBY
   s.author      = "Victor Sokolov"
   s.email       = "gzigzigzeo@gmail.com"
@@ -15,4 +15,4 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_path  = 'lib'
-end
+end

data/lib/cap_sync/capistrano.rb

@@ -0,0 +1,14 @@
+# -*- encoding: utf-8 -*-
+
+configuration = Capistrano::Configuration.respond_to?(:instance) ?
+  Capistrano::Configuration.instance(:must_exist) :
+  Capistrano.configuration(:must_exist)
+
+configuration.load do
+
+_cset(:app_name) { abort('Set the application name before loading "cap_sync"') }
+
+end
+
+require 'cap_sync/db'
+require 'cap_sync/data'

data/lib/cap_sync/data.rb

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+configuration = Capistrano::Configuration.respond_to?(:instance) ?
+  Capistrano::Configuration.instance(:must_exist) :
+  Capistrano.configuration(:must_exist)
+
+configuration.load do
+
+_cset(:sync_folders, {"#{shared_path}/system" => "public/system"})
+_cset(:sync_rsync_cmd, "rsync -rv --stats --delete --compress --skip-compress=jpg,gif,png,mp4")
+
+# :sync for rsync, :cap for capistrano (used when rsync is not installed remotely)
+_cset(:sync_method, :rsync)
+
+namespace :sync do
+  desc "Sync remote production data with local development machine"
+  task :data do
+    folders_to_sync = sync_folders
+    
+    if sync_method == :rsync
+      folders_to_sync.each do |remote, local|
+        host = find_servers(:roles => :web).first.host        
+        system("#{sync_rsync_cmd} #{user}@#{host}:#{remote}/. #{local}")
+      end
+    elsif sync_method == :cap
+      folders_to_sync.each do |remote, local|
+        ::FileUtils.rm_rf(local, :verbose => true)
+        download(remote, local, :recursive => true) do |event, downloader, *args|
+          case event
+          when :close then
+            puts "finished with #{args[0].remote}"
+          when :mkdir then
+            puts "creating directory #{args[0]}"
+          when :finish then
+            puts "all done!"
+          end
+        end
+      end
+    else
+      raise ArgumentError, "Unknown sync method: should be :cap or :sync"
+    end        
+  end
+end
+
+end

data/lib/cap_sync/db.rb

@@ -0,0 +1,79 @@
+# -*- encoding: utf-8 -*-
+
+require 'fileutils'
+
+configuration = Capistrano::Configuration.respond_to?(:instance) ?
+  Capistrano::Configuration.instance(:must_exist) :
+  Capistrano.configuration(:must_exist)
+
+configuration.load do
+
+_cset(:sync_local_env, 'development')
+_cset(:sync_remote_env, 'production')
+_cset(:sync_local_load_cmd, 'mysql')
+_cset(:sync_remote_dump_cmd, 'mysqldump')
+_cset(:sync_local_tmp_path, 'tmp')
+_cset(:sync_remote_tmp_path, "#{shared_path}/tmp")
+_cset(:sync_local_keep_dumps, false)
+_cset(:sync_remote_keep_dumps, false)
+_cset(:sync_compress, true)
+_cset(:sync_compress_cmd, 'gzip -c') # gzip -c #{dump} #{gzipped_dump}
+
+# File should be kept after decompression if local_keep_dumps is on 
+_cset(:sync_uncompress_cmd, 'gunzip -c') # gunzip -c #{gzipped_dump} > #{dump}
+
+namespace :sync do
+  desc "Sync remote production database with local development database"
+  task :db do
+    # Get the dump of remote database
+    username, password, database, host, port = remote_database_config(sync_remote_env)
+    dump = "sync-#{Time.now.to_i}.sql"
+    run "#{sync_remote_dump_cmd} -u #{username} --password=\"#{password}\" -h #{host} --port #{port} #{database} > #{sync_remote_tmp_path}/#{dump}"
+
+    # Compress and download it
+    if sync_compress
+      run "#{sync_compress_cmd} #{sync_remote_tmp_path}/#{dump} > #{sync_remote_tmp_path}/#{dump}.gz"
+      get "#{sync_remote_tmp_path}/#{dump}.gz", "#{sync_local_tmp_path}/#{dump}.gz"
+      system("#{sync_uncompress_cmd} -c #{sync_local_tmp_path}/#{dump}.gz > #{sync_local_tmp_path}/#{dump}")
+    else
+      get "#{sync_remote_tmp_path}/#{dump}", "#{sync_local_tmp_path}/#{dump}"
+    end
+
+    # Load dump into local database
+    username, password, database, host, port = local_database_config(sync_local_env)
+    system("#{sync_local_load_cmd} #{database} -u#{username} --password=\"#{password}\" < #{sync_local_tmp_path}/#{dump}")
+
+    # Remove temporary files
+    unless sync_local_keep_dumps
+      FileUtils.rm("#{sync_local_tmp_path}/#{dump}")
+      FileUtils.rm("#{sync_local_tmp_path}/#{dump}.gz") if sync_compress
+    else
+      # If compression is on, keeps only gzipped dump
+      FileUtils.rm("#{sync_local_tmp_path}/#{dump}") if sync_compress
+    end
+
+    unless sync_remote_keep_dumps
+      run "rm #{sync_remote_tmp_path}/#{dump}"
+      run "rm #{sync_remote_tmp_path}/#{dump}.gz" if sync_compress
+    else
+      run "rm #{sync_remote_tmp_path}/#{dump}" if sync_compress
+    end
+  end
+end
+
+end
+
+def local_database_config(env)
+  db = File.open("config/database.yml") { |yf| YAML::load(yf) }
+  defaults_config(db[env.to_s])
+end
+
+def remote_database_config(env)
+  remote_config = capture("cat #{current_path}/config/database.yml")
+  db = YAML::load(remote_config)
+  defaults_config(db[env.to_s])
+end
+
+def defaults_config(db)
+  return db['username'], db['password'], db['database'], (db['host'] || '127.0.0.1'), (db['port'] || 3306)
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cap_sync
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 15
   prerelease: 
   segments: 
   - 0
   - 0
-  - 7
-  version: 0.0.7
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - Victor Sokolov
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-14 00:00:00 +04:00
-default_executable: 
+date: 2011-12-15 00:00:00 Z
 dependencies: []
 
 description: Recipes to clone database & public data from production server to developement machine
@@ -33,8 +32,9 @@ files:
 - README.rdoc
 - Rakefile
 - cap_sync.gemspec
-- lib/cap_sync.rb
-has_rdoc: true
+- lib/cap_sync/capistrano.rb
+- lib/cap_sync/data.rb
+- lib/cap_sync/db.rb
 homepage: http://github.com/gzigzigzeo/cap_sync
 licenses: []
 
@@ -64,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Recipes to clone database & public data from production server to developement machine

data/lib/cap_sync.rb

@@ -1,81 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-require 'fileutils'
-
-Capistrano::Configuration.instance(:must_exist).load do
-  {
-    :sync_local_env => 'development',      # Local environment key in database.yml
-    :sync_remote_env => 'production',      # Remote environment key in database.yml
-    :sync_remote_dump_cmd => 'mysqldump',  # Remote mysqldump command
-    :sync_local_load_cmd => 'mysql',       # Local mysqldump command
-    :sync_keep_dumps => false,             # Keep downloaded dump in app's tmp after syncing
-
-    :sync_folders => {"#{shared_path}/system" => "public/system"},  # Folders to sync remote => local
-    :rsync_cmd => "rsync",                                          # rsync command
-    :rsync_flags => "-rv --stats --delete",                         # rsync flags
-    :sync_method => :rsync                                          # :rsync or :cap
-  }.each do |var, value|
-    self.set(var, value) unless exists?(var)
-  end
-
-  namespace :sync do
-    desc "Sync remote production database with local development machine"
-    task :db do
-      username, password, database, host, port = remote_database_config(sync_remote_env)
-
-      temp = "sync-#{Time.now.to_i}.sql"
-      run "#{sync_remote_dump_cmd} -u #{username} --password=\"#{password}\" -h #{host} --port #{port} #{database} > #{shared_path}/#{temp}"
-      get "#{shared_path}/#{temp}", "tmp/#{temp}"
-
-      username, password, database, host, port = local_database_config(sync_local_env)
-
-      system("#{sync_local_load_cmd} #{database} -u#{username} --password=\"#{password}\" < tmp/#{temp}")
-      FileUtils.rm("tmp/#{temp}") unless sync_keep_dumps
-      run "rm #{shared_path}/#{temp}"
-    end
-
-    desc "Sync remote production data with local development machine"
-    task :data do
-      folders_to_sync = Hash[*ENV['FOLDERS'].split(',')] unless ENV['FOLDERS'].nil?
-      folders_to_sync ||= sync_folders
-      
-      if sync_method == :rsync
-        folders_to_sync.each do |remote, local|
-          host = find_servers(:roles => :web).first.host        
-          system("#{rsync_cmd} #{rsync_flags} #{user}@#{host}:#{remote}/. #{local}")
-        end
-      elsif sync_method == :cap
-        folders_to_sync.each do |remote, local|
-          ::FileUtils.rm_rf(local, :verbose => true)
-          download(remote, local, :recursive => true) do |event, downloader, *args|
-            case event
-            when :close then
-              puts "finished with #{args[0].remote}"
-            when :mkdir then
-              puts "creating directory #{args[0]}"
-            when :finish then
-              puts "all done!"
-            end
-          end
-        end
-      else
-        raise ArgumentError, "Unknown sync method: should be :cap or :sync"
-      end        
-    end
-  end
-
-  def local_database_config(env)
-    db = File.open("config/database.yml") { |yf| YAML::load(yf) }
-    defaults_config(db[env.to_s])
-  end
-
-  def remote_database_config(env)
-    remote_config = capture("cat #{current_path}/config/database.yml")
-    db = YAML::load(remote_config)
-    defaults_config(db[env.to_s])
-  end
-
-  def defaults_config(db)
-    return db['username'], db['password'], db['database'], db['host'], (db['port'] || 3306)
-  end
-end