capistrano-db-tasks 0.2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,16 @@
+Copyright (c) 2009 Sébastien Gruhier - Xilinus/Maptimize
+
+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 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/README.markdown

@@ -0,0 +1,76 @@
+CapistranoDbTasks
+=================
+
+Add database AND assets tasks to capistrano to a Rails project.
+
+Currently
+
+* It only supports mysql and postgresql (both side remote and local)
+* Synchronize assets remote to local and local to remote
+
+Commands mysql, mysqldump (or pg_dump, psql), bzip2 and unbzip2 must be in your PATH
+
+Feel free to fork and to add more database support or new tasks.
+
+Install
+=======
+
+Add it as a gem:
+
+```ruby
+    gem "capistrano-db-tasks", require: false
+```
+
+Add to config/deploy.rb:
+
+```ruby
+    require 'capistrano-db-tasks'
+
+    # if you haven't already specified
+    set :rails_env, "production"
+
+    # if you want to remove the dump file after loading
+    set :db_local_clean, true
+
+    # If you want to import assets, you can change default asset dir (default = system)
+    # This directory must be in your shared directory on the server
+    set :assets_dir, %w(public/assets public/att)
+
+    # if you want to work on a specific local environment (default = ENV['RAILS_ENV'] || 'development')
+    set :locals_rails_env, "production"
+```
+
+Available tasks
+===============
+
+    app:local:sync      || app:pull     # Synchronize your local assets AND database using remote assets and database
+    app:remote:sync     || app:push     # Synchronize your remote assets AND database using local assets and database
+
+    assets:local:sync   || assets:pull  # Synchronize your local assets using remote assets
+    assets:remote:sync  || assets:push  # Synchronize your remote assets using local assets
+
+    db:local:sync       || db:pull      # Synchronize your local database using remote database data
+    db:remote:sync      || db:push      # Synchronize your remote database using local database data
+
+Example
+=======
+
+    cap db:pull
+    cap production db:pull # if you are using capistrano-ext to have multistages
+
+
+Contributors
+============
+
+* tilsammans (http://github.com/tilsammansee)
+* bigfive    (http://github.com/bigfive)
+* jakemauer  (http://github.com/jakemauer)
+* tjoneseng  (http://github.com/tjoneseng)
+
+TODO
+====
+
+* May be change project's name as it's not only database tasks now :)
+* Add tests
+
+Copyright (c) 2009 [Sébastien Gruhier - XILINUS], released under the MIT license

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'bundler'
+require 'bundler/gem_tasks'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the capistrano_db_tasks plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the capistrano_db_tasks plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CapistranoDbTasks'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/capistrano-db-tasks.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "capistrano-db-tasks/version"
+
+Gem::Specification.new do |s|
+  s.name        = "capistrano-db-tasks"
+  s.version     = CapistranoDbTasks::VERSION
+  s.authors     = ["Sebastien Gruhier"]
+  s.email       = ["sebastien.gruhier@xilinus.com"]
+  s.homepage    = "https://github.com/sgruhier/capistrano-db-tasks"
+  s.summary     = "A collection of capistrano tasks for syncing assets and databases"
+  s.description = "A collection of capistrano tasks for syncing assets and databases"
+
+  s.rubyforge_project = "capistrano-db-tasks"
+
+  s.files         = `git ls-files`.split("\n")
+  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_paths = ["lib"]
+
+  s.add_development_dependency "capistrano", "> 2.0.0"
+end

data/lib/capistrano-db-tasks/asset.rb

@@ -0,0 +1,23 @@
+module Asset
+  extend self
+
+  def remote_to_local(cap)
+    servers = cap.find_servers :roles => :app
+    port = cap.port rescue 22
+    [cap.assets_dir].flatten.each do |dir|
+      system("rsync -a --del -L -K -vv --progress --rsh='ssh -p #{port}' #{cap.user}@#{servers.first}:#{cap.current_path}/#{dir} #{cap.local_assets_dir}")
+    end
+  end
+
+  def local_to_remote(cap)
+    servers = cap.find_servers :roles => :app
+    port = cap.port rescue 22
+    [cap.assets_dir].flatten.each do |dir|
+      system("rsync -a --del -L -K -vv --progress --rsh='ssh -p #{port}' ./#{dir} #{cap.user}@#{servers.first}:#{cap.current_path}/#{cap.local_assets_dir}")
+    end
+  end
+
+  def to_string(cap)
+    [cap.assets_dir].flatten.join(" ")
+  end
+end

data/lib/capistrano-db-tasks/database.rb

@@ -0,0 +1,141 @@
+module Database
+  class Base
+    attr_accessor :config, :output_file
+    def initialize(cap_instance)
+      @cap = cap_instance
+    end
+
+    def mysql?
+      @config['adapter'] =~ /^mysql/
+    end
+
+    def postgresql?
+      %w(postgresql pg).include? @config['adapter']
+    end
+
+    def credentials
+      if mysql?
+        " -u #{@config['username']} " + (@config['password'] ? " -p\"#{@config['password']}\" " : '') + (@config['host'] ? " -h #{@config['host']}" : '') + (@config['socket'] ? " -S#{@config['socket']}" : '')
+      elsif postgresql?
+        " -U #{@config['username']} " + (@config['host'] ? " -h #{@config['host']}" : '')
+      end
+    end
+
+    def database
+      @config['database']
+    end
+
+    def current_time
+      Time.now.strftime("%Y-%m-%d-%H%M%S")
+    end
+
+    def output_file
+      @output_file ||= "db/#{database}_#{current_time}.sql.bz2"
+    end
+
+
+  private
+
+    def dump_cmd
+      if mysql?
+        "mysqldump #{credentials} #{database} --lock-tables=false"
+      elsif postgresql?
+        "pg_dump #{credentials} -c -O #{database}"
+      end
+    end
+
+    def import_cmd(file)
+      if mysql?
+        "mysql #{credentials} -D #{database} < #{file}"
+      elsif postgresql?
+        "psql #{credentials} #{database} < #{file}"
+      end
+    end
+
+  end
+
+  class Remote < Base
+    def initialize(cap_instance)
+      super(cap_instance)
+      @config = ""
+      @cap.run("cat #{@cap.current_path}/config/database.yml") do |c, s, d|
+        @config += d
+      end
+      @config = YAML.load(@config)[@cap.rails_env]
+    end
+
+    def dump
+      @cap.run "cd #{@cap.current_path} && #{dump_cmd} | bzip2 - - > #{output_file}"
+      self
+    end
+
+    def download(local_file = "#{output_file}")
+      remote_file = "#{@cap.current_path}/#{output_file}"
+      @cap.get remote_file, local_file
+    end
+
+    # cleanup = true removes the mysqldump file after loading, false leaves it in db/
+    def load(file, cleanup)
+      unzip_file = File.join(File.dirname(file), File.basename(file, '.bz2'))
+      # @cap.run "cd #{@cap.current_path} && bunzip2 -f #{file} && RAILS_ENV=#{@cap.rails_env} bundle exec rake db:drop db:create && #{import_cmd(unzip_file)}"
+      @cap.run "cd #{@cap.current_path} && bunzip2 -f #{file} && RAILS_ENV=#{@cap.rails_env} && #{import_cmd(unzip_file)}"
+      @cap.run("cd #{@cap.current_path} && rm #{unzip_file}") if cleanup
+    end
+  end
+
+  class Local < Base
+    def initialize(cap_instance)
+      super(cap_instance)
+      @config = YAML.load_file(File.join('config', 'database.yml'))[@cap.local_rails_env]
+      puts "local #{@config}"
+    end
+
+    # cleanup = true removes the mysqldump file after loading, false leaves it in db/
+    def load(file, cleanup)
+      unzip_file = File.join(File.dirname(file), File.basename(file, '.bz2'))
+      # system("bunzip2 -f #{file} && bundle exec rake db:drop db:create && #{import_cmd(unzip_file)} && bundle exec rake db:migrate")
+      system("bunzip2 -f #{file} && #{import_cmd(unzip_file)}")
+      File.unlink(unzip_file) if cleanup
+    end
+
+    def dump
+      system "#{dump_cmd} | bzip2 - - > #{output_file}"
+      self
+    end
+
+    def upload
+      remote_file = "#{@cap.current_path}/#{output_file}"
+      @cap.upload output_file, remote_file
+    end
+  end
+
+
+  class << self
+    def check(local_db, remote_db)
+      unless (local_db.mysql? && remote_db.mysql?) || (local_db.postgresql? && remote_db.postgresql?)
+        raise 'Only mysql or postgresql on remote and local server is supported'
+      end
+    end
+
+    def remote_to_local(instance)
+      local_db  = Database::Local.new(instance)
+      remote_db = Database::Remote.new(instance)
+
+      check(local_db, remote_db)
+
+      remote_db.dump.download
+      local_db.load(remote_db.output_file, instance.fetch(:db_local_clean))
+    end
+
+    def local_to_remote(instance)
+      local_db  = Database::Local.new(instance)
+      remote_db = Database::Remote.new(instance)
+
+      check(local_db, remote_db)
+
+      local_db.dump.upload
+      remote_db.load(local_db.output_file, instance.fetch(:db_local_clean))
+    end
+  end
+
+end

data/lib/capistrano-db-tasks/dbtasks.rb

@@ -0,0 +1,115 @@
+if Capistrano::Configuration.instance(false)
+
+  Capistrano::Configuration.instance(true).load do |instance|
+
+    require File.expand_path("#{File.dirname(__FILE__)}/util")
+    require File.expand_path("#{File.dirname(__FILE__)}/database")
+    require File.expand_path("#{File.dirname(__FILE__)}/asset")
+
+    instance.set :local_rails_env, ENV['RAILS_ENV'] || 'development' unless exists?(:local_rails_env)
+    instance.set :rails_env, 'production' unless exists?(:rails_env)
+    instance.set :stage, 'production' unless exists?(:stage)
+    instance.set :db_local_clean, false unless exists?(:db_local_clean)
+    instance.set :assets_dir, 'system' unless exists?(:assets_dir)
+    instance.set :local_assets_dir, 'public' unless exists?(:local_assets_dir)
+
+    namespace :db do
+      namespace :remote do
+        desc 'Synchronize your remote database using local database data'
+        task :sync, :roles => :db do
+          if Util.prompt 'Are you sure you want to REPLACE THE REMOTE DATABASE with local database'
+            Database.local_to_remote(instance)
+          end
+        end
+      end
+
+      namespace :local do
+        desc 'Synchronize your local database using remote database data'
+        task :sync, :roles => :db do
+          puts "Local database: #{Database::Local.new(instance).database}"
+          if Util.prompt 'Are you sure you want to erase your local database with server database'
+            Database.remote_to_local(instance)
+          end
+        end
+      end
+
+      desc 'Synchronize your local database using remote database data'
+      task :pull do
+        db.local.sync
+      end
+
+      desc 'Synchronize your remote database using local database data'
+      task :push do
+        db.remote.sync
+      end
+    end
+
+    namespace :assets do
+      namespace :remote do
+        desc 'Synchronize your remote assets using local assets'
+        task :sync, :roles => :app do
+          puts "Assets directories: #{assets_dir}"
+          if Util.prompt "Are you sure you want to erase your server assets with local assets"
+            Asset.local_to_remote(instance)
+          end
+        end
+      end
+
+      namespace :local do
+        desc 'Synchronize your local assets using remote assets'
+        task :sync, :roles => :app do
+          puts "Assets directories: #{local_assets_dir}"
+          if Util.prompt "Are you sure you want to erase your local assets with server assets"
+            Asset.remote_to_local(instance)
+          end
+        end
+      end
+
+      desc 'Synchronize your local assets using remote assets'
+      task :pull do
+        assets.local.sync
+      end
+
+      desc 'Synchronize your remote assets using local assets'
+      task :push do
+        assets.remote.sync
+      end
+    end
+
+    namespace :app do
+      namespace :remote do
+        desc 'Synchronize your remote assets AND database using local assets and database'
+        task :sync do
+          if Util.prompt "Are you sure you want to REPLACE THE REMOTE DATABASE AND your remote assets with local database and assets(#{assets_dir})"
+            Database.local_to_remote(instance)
+            Asset.local_to_remote(instance)
+          end
+        end
+      end
+
+      namespace :local do
+        desc 'Synchronize your local assets AND database using remote assets and database'
+        task :sync do
+          puts "Local database     : #{Database::Local.new(instance).database}"
+          puts "Assets directories : #{local_assets_dir}"
+          if Util.prompt "Are you sure you want to erase your local database AND your local assets with server database and assets(#{assets_dir})"
+            Database.remote_to_local(instance)
+            Asset.remote_to_local(instance)
+          end
+        end
+      end
+
+      desc 'Synchronize your local assets AND database using remote assets and database'
+      task :pull do
+        app.local.sync
+      end
+
+      desc 'Synchronize your remote assets AND database using local assets and database'
+      task :push do
+        app.remote.sync
+      end
+
+    end
+  end
+
+end

data/lib/capistrano-db-tasks/util.rb

@@ -0,0 +1,10 @@
+module Util
+  def self.prompt(msg, prompt = "(y)es, (n)o ")
+    answer = Capistrano::CLI.ui.ask("#{msg} #{prompt} ? ") do |q|
+      q.overwrite = false
+      q.validate = /^y$|^yes$|^n$|^no$/i
+      q.responses[:not_valid] = prompt
+    end
+    (answer =~ /^y$|^yes$/i) == 0
+  end
+end

data/lib/capistrano-db-tasks/version.rb

@@ -0,0 +1,3 @@
+module CapistranoDbTasks
+  VERSION = "0.2"
+end

data/lib/capistrano-db-tasks.rb

@@ -0,0 +1,2 @@
+require "capistrano"
+require File.expand_path("#{File.dirname(__FILE__)}/capistrano-db-tasks/dbtasks")

data/test/capistrano_db_tasks_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class CapistranoDbTasksTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-db-tasks
+version: !ruby/object:Gem::Version
+  version: '0.2'
+  prerelease: 
+platform: ruby
+authors:
+- Sebastien Gruhier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: A collection of capistrano tasks for syncing assets and databases
+email:
+- sebastien.gruhier@xilinus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- capistrano-db-tasks.gemspec
+- lib/capistrano-db-tasks.rb
+- lib/capistrano-db-tasks/asset.rb
+- lib/capistrano-db-tasks/database.rb
+- lib/capistrano-db-tasks/dbtasks.rb
+- lib/capistrano-db-tasks/util.rb
+- lib/capistrano-db-tasks/version.rb
+- test/capistrano_db_tasks_test.rb
+- test/test_helper.rb
+homepage: https://github.com/sgruhier/capistrano-db-tasks
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: capistrano-db-tasks
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A collection of capistrano tasks for syncing assets and databases
+test_files:
+- test/capistrano_db_tasks_test.rb
+- test/test_helper.rb