dump 1.0.0

data/.autotest

@@ -0,0 +1,13 @@
+Autotest.add_hook :reset do |at|
+  at.clear_mappings
+  at.add_mapping(%r%^(([^/]+)/.*)\.(?:rb|rake)$%) { |filename, m|
+    if m[2] == 'spec'
+      filename
+    else
+      at.files_matching(%r%^spec\/#{Regexp.escape(m[1])}_spec.rb%)
+    end
+  }
+  at.add_mapping(%r%^spec/(spec_helper|shared/.*)\.rb$%) {
+    at.files_matching %r%^spec/.*_spec\.rb$%
+  }
+end

data/.gitignore

@@ -0,0 +1,12 @@
+/pkg/
+/*.gem
+
+/doc/
+/rdoc/
+/.yardoc/
+/coverage/
+
+Makefile
+*.o
+*.bundle
+/tmp/

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2012 Ivan Kuchin
+
+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/README.markdown

@@ -0,0 +1,250 @@
+# DumpRake
+
+Rails app rake and capistrano tasks to create and restore dumps of database and assets.
+
+Works with rails 2 and rails 3.
+
+Requires at least ruby 1.8.7, tested with ruby 1.9.
+
+## Install
+
+Put in Gemfile if you are using bundler:
+
+    gem 'dump'
+
+Install as plugin for rails 3 (not recommended):
+
+    rails plugin install git://github.com/toy/dump.git
+
+Install as plugin for rails 2:
+
+    script/plugin install git://github.com/toy/dump.git
+
+### Capistrano integration
+
+To get capistrano tasks in rails 3, put in `config/deploy.rb`:
+
+    require 'dump/capistrano'
+
+### Assets config
+
+`config/assets` holds paths of dirs you want to dump in file:
+
+    public/audios
+    public/flash
+    public/images/upload
+    public/videos
+
+Generate in rails 3:
+
+    rails generate assets_config
+
+Generate in rails 2:
+
+    script/generate assets_config
+
+## Capistrano integration
+
+When using cap tasks, dump folder should be in persistent place and be linked to application folder, or you will lose all dumps every deploy. Default recipe creates link on after `deploy:update_code`.
+
+You can use cap dump:* tasks to control dumps on remote server. Don't forget to deploy application to remote server before using dump:remote tasks.
+Also you can set custom remote rake binary in your deploy.rb like:
+
+    set :rake, "/custom/rake"
+
+## Usage
+
+    # create dump
+    rake dump
+    rake dump:create
+
+    # list avaliable dumps
+    rake dump:versions
+
+    # restore dump
+    rake dump:restore
+
+    # delete old and unfinished dumps (all non tgz files will be deleted if they are not locked)
+    rake dump:cleanup
+
+### Environment variables
+
+#### While creating dumps:
+
+`DESC`, `DESCRIPTION` — free form description of dump
+
+    rake dump DESC='uploaded photos'
+
+`TAGS`, `TAG` — comma separated list of tags
+
+    rake dump TAGS='photos,videos'
+
+`ASSETS` — comma or colon separated list of paths or globs to dump
+
+    rake dump ASSETS='public/system:public/images/masks/*'
+    rake dump ASSETS='public/system,public/images/masks/*'
+
+`TABLES` — comma separated list of tables to dump or if prefixed by "-" — to skip; by default only sessions table is skipped; schema_info and schema_migrations are always included if they are present
+
+dump all tables except sessions:
+
+    rake dump
+
+dump all tables:
+
+    rake dump TABLES='-'
+
+dump only people, pages and photos tables:
+
+    rake dump TABLES='people,pages,photos'
+
+dump all tables except people and pages:
+
+    rake dump TABLES='-people,pages'
+
+#### While restoring dumps:
+
+`LIKE`, `VER`, `VERSION` — filter dumps by full dump name
+
+    rake dump:versions LIKE='2009'
+    rake dump:restore LIKE='2009' # restores last dump matching 2009
+
+`TAGS`, `TAG` — comma separated list of tags
+without '+' or '-' — dump should have any of such tags
+prefixed with '+' — dump should have every tag with prefix
+prefixed with '-' — dump should not have any of tags with prefix
+
+select dumps with tags photos or videos:
+
+    rake dump:restore TAGS='photos,videos'
+
+select dumps with tags photos and videos:
+
+    rake dump:restore TAGS='+photos,+videos'
+
+skip dumps with tags mirror and archive:
+
+    rake dump:restore TAGS='-mirror,-archive'
+
+select dumps with tags photos or videos, with tag important and without mirror:
+
+    rake dump:restore TAGS='photos,videos,+important,-mirror'
+
+`MIGRATE_DOWN` — don't run down for migrations not present in dump if you pass "0", "no" or "false"; pass "reset" to recreate (drop and create) db
+by default all migrations which are not present in dump are ran down
+
+don't run down for migrations:
+
+    rake dump:restore MIGRATE_DOWN=no
+
+reset database:
+
+    rake dump:restore MIGRATE_DOWN=reset
+
+`RESTORE_SCHEMA` — don't read/change schema if you pass "0", "no" or "false" (useful to just restore data for table; note that schema info tables are also not restored)
+
+don't restore schema:
+
+    rake dump:restore RESTORE_SCHEMA=no
+
+`RESTORE_TABLES` — works as TABLES, but for restoring
+
+restores only people, pages and photos tables:
+
+    rake dump RESTORE_TABLES='people,pages,photos'
+
+restores all tables except people and pages:
+
+    rake dump TABLES='-people,pages'
+
+`RESTORE_ASSETS` — works as ASSETS, but for restoring
+
+    rake dump RESTORE_ASSETS='public/system/a,public/system/b'
+    rake dump RESTORE_ASSETS='public/system/a:public/images/masks/*/new*'
+
+#### For listing dumps:
+
+`LIKE`, `VER`, `VERSION` and `TAG`, `TAGS` as for restoring
+
+`SUMMARY` — output info about dump: "1", "true" or "yes" for basic info, "2" or "schema" to display schema as well
+
+    rake dump:versions SUMMARY=1
+    rake dump:versions SUMMARY=full # output schema too
+
+#### For cleanup:
+
+`LIKE`, `VER`, `VERSION` and `TAG`, `TAGS` as for restoring
+
+`LEAVE` — number of dumps to leave
+
+    rake dump:cleanup LEAVE=10
+    rake dump:cleanup LEAVE=none
+
+### cap tasks
+
+For all cap commands environment variables are same as for rake tasks
+
+`TRANSFER_VIA` — transfer method (rsync, sftp or scp)
+By default transferring task will try to transfer using rsync if it is present, else it will try to use sftp and scp
+
+force transfer using scp:
+
+    cap dump:remote:download TRANSFER_VIA=scp
+    cap dump:mirror:down TRANSFER_VIA=scp
+
+`BACKUP`, `AUTOBACKUP`, `AUTO_BACKUP` — no autobackup if you pass "0", "no" or "false"
+by default backup is created before mirroring
+
+don't create backup:
+
+    cap dump:mirror:down BACKUP=0
+    cap dump:mirror:down AUTOBACKUP=no
+    cap dump:mirror:down AUTO_BACKUP=false
+
+#### Basic cap tasks are same as rake tasks
+
+    cap dump:local
+    cap dump:local:create
+    cap dump:local:restore
+    cap dump:local:versions
+    cap dump:local:cleanup
+
+    cap dump:remote
+    cap dump:remote:create
+    cap dump:remote:restore
+    cap dump:remote:versions
+    cap dump:remote:cleanup
+
+#### Dump exchanging tasks
+
+transfer selected dump to remote server:
+
+    cap dump:local:upload
+
+transfer selected dump to local:
+
+    cap dump:remote:download
+
+#### Mirroring tasks
+
+mirror local to remote (create local dump, upload it to remote and restore it there):
+
+    cap dump:mirror:up
+
+mirror remote to local (create remote dump, download it from remote and restore on local):
+
+    cap dump:mirror:down
+
+#### Backuping tasks
+
+backup remote on local (create remote dump and download it):
+
+    cap dump:backup:create
+
+restore backup (upload dump and restore on remote):
+
+    cap dump:backup:restore
+
+## Copyright
+
+Copyright (c) 2008-2012 Ivan Kuchin. See LICENSE.txt for details.

data/dump.gemspec

@@ -0,0 +1,22 @@
+# encoding: UTF-8
+
+Gem::Specification.new do |s|
+  s.name        = 'dump'
+  s.version     = '1.0.0'
+  s.summary     = %q{Rails app rake and capistrano tasks to create and restore dumps of database and assets}
+  s.homepage    = "http://github.com/toy/#{s.name}"
+  s.authors     = ['Ivan Kuchin']
+  s.license     = 'MIT'
+
+  s.rubyforge_project = s.name
+
+  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 = %w[lib]
+
+  s.add_dependency 'archive-tar-minitar', '= 0.5.2'
+  s.add_dependency 'progress', '~> 2.4.0'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'sqlite3'
+end

data/lib/dump.rb

@@ -0,0 +1,3 @@
+module Dump
+  require 'dump/railtie' if defined?(Rails)
+end

data/lib/dump/capistrano.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), '../../recipes/dump.rb')

data/lib/dump/railtie.rb

@@ -0,0 +1,8 @@
+module Dump
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/assets.rake'
+      load 'tasks/dump.rake'
+    end
+  end
+end

data/lib/dump_rake.rb

@@ -0,0 +1,85 @@
+# encoding: UTF-8
+
+require 'pathname'
+require 'find'
+require 'fileutils'
+require 'zlib'
+require 'tempfile'
+
+require 'rake'
+require 'archive/tar/minitar'
+require 'dump_rake/archive_tar_minitar_fix'
+require 'progress'
+
+class DumpRake
+  class << self
+    def versions(options = {})
+      Dump.list(options).each do |dump|
+        puts DumpRake::Env[:show_size] || $stdout.tty? ? "#{dump.human_size.to_s.rjust(7)}\t#{dump}" : dump
+        begin
+          case options[:summary].to_s.downcase[0, 1]
+          when *%w[1 t y]
+            puts DumpReader.summary(dump.path)
+            puts
+          when *%w[2 s]
+            puts DumpReader.summary(dump.path, :schema => true)
+            puts
+          end
+        rescue => e
+          $stderr.puts "Error reading dump: #{e}"
+          $stderr.puts
+        end
+      end
+    end
+
+    def create(options = {})
+      dump = Dump.new(options.merge(:dir => File.join(DumpRake::RailsRoot, 'dump')))
+
+      DumpWriter.create(dump.tmp_path)
+
+      File.rename(dump.tmp_path, dump.tgz_path)
+      puts File.basename(dump.tgz_path)
+    end
+
+    def restore(options = {})
+      dump = Dump.list(options).last
+
+      if dump
+        DumpReader.restore(dump.path)
+      else
+        $stderr.puts "Avaliable versions:"
+        $stderr.puts Dump.list
+      end
+    end
+
+    def cleanup(options = {})
+      unless options[:leave].nil? || /^\d+$/ === options[:leave] || options[:leave].downcase == 'none'
+        raise 'LEAVE should be number or "none"'
+      end
+
+      to_delete = []
+
+      all_dumps = Dump.list(options.merge(:all => true))
+      to_delete.concat(all_dumps.select{ |dump| dump.ext != 'tgz' })
+
+      dumps = Dump.list(options)
+      leave = (options[:leave] || 5).to_i
+      to_delete.concat(dumps[0, dumps.length - leave]) if dumps.length > leave
+
+      to_delete.each do |dump|
+        dump.lock do
+          begin
+            dump.path.unlink
+            puts "Deleted #{dump.path}"
+          rescue => e
+            $stderr.puts "Can not delete #{dump.path} — #{e}"
+          end
+        end
+      end
+    end
+  end
+end
+
+%w[rails_root assets table_manipulation dump dump_reader dump_writer env].each do |file|
+  require "dump_rake/#{file}"
+end

data/lib/dump_rake/archive_tar_minitar_fix.rb

@@ -0,0 +1,8 @@
+class Archive::Tar::Minitar::Reader::EntryStream
+  def getbyte
+    return nil if @read >= @size
+    ret = @io.getbyte
+    @read += 1 if ret
+    ret
+  end
+end

data/lib/dump_rake/assets.rb

@@ -0,0 +1,22 @@
+# encoding: UTF-8
+
+class DumpRake
+  module Assets
+    SPLITTER = /[:,]/
+
+    class << self
+      def assets
+        File.readlines(File.join(DumpRake::RailsRoot, 'config/assets')).map(&:strip).grep(/^[^#]/).join(':')
+      end
+
+      def glob_asset_children(asset, glob)
+        path = File.expand_path(asset, DumpRake::RailsRoot)
+        if path[0, DumpRake::RailsRoot.length] == DumpRake::RailsRoot # asset must be in rails root
+          Dir[File.join(path, glob)]
+        else
+          []
+        end
+      end
+    end
+  end
+end