bootstrap-db 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bootstrap-db.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tom Meier
+
+MIT License
+
+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.md

@@ -0,0 +1,81 @@
+# Bootstrap-DB
+
+## Purpose
+
+Collection of rake tasks for speeding up the capture and load of database snapshots (dumps).
+Currently accepting MySQL & Postgres databases and specifically gear to Rails applications.
+
+## Add this line to your application's Gemfile:
+
+```
+  gem 'bootstrap-db'
+```
+
+## Commands (with example usage)
+
+### Database Dump
+
+```
+  rake bootstrap:db:dump                                          #Dump default to db/bootstrap/bootstrap_data.sql
+  rake bootstrap:db:dump Rails.env=production                     #Dump specific Rails environment using database.yml
+  rake bootstrap:db:dump FILE=db/bootstrap/live_database.dump     #Dump to specific location
+  rake bootstrap:db:dump FILE_NAME=live_database.dump             #Dump specific file to default bootstrap location
+```
+
+#### Additional options:
+
+  * Dump file with comma delimited tables ignored:
+```
+  rake bootstrap:db:dump IGNORE_TABLES='messages,incidents'
+```
+
+### Database Load
+
+Load, and overwrite, current database environment with a passed file name.
+
+```
+  rake bootstrap:db:load                                          #Load default from db/bootstrap/bootstrap_data.sql
+  rake bootstrap:db:load Rails.env=production                     #Load specific Rails environment using database.yml
+  rake bootstrap:db:load FILE=db/bootstrap/live_database_dump.sql #Load from specific dump
+  rake bootstrap:db:load FILE_NAME=live_database_dump.sql         #Load specific file from default bootstrap location
+```
+
+### Additional options:
+
+Pass in any additional parameters that your database accepts:
+  * eg. mysqldump *--help* / pg_dump *--help*
+
+```
+  rake bootstrap:db:dump ADDITIONAL_PARAMS='-d,-t'
+  rake bootstrap:db:load ADDITIONAL_PARAMS='-d,-t'
+```
+
+Pass 'VERBOSE=true' if you'd like to see more information. For example:
+
+```
+  rake bootstrap:db:dump VERBOSE=true
+```
+
+## Requirements
+
+ * Rails
+ * config/database.yml exists and set correctly
+ * database.yml has a 'host' value set for environments
+ * mysql/postgresql
+
+
+## TODO (if we end up using this more)
+
+  * This has been quickly rebuilt from a ridiculously old project of mine (http://github.com/tommeier/bootstrap). This should be refactored into proper objects and expose classes as well as rake tasks. Fully tested.
+  * Proper mapping of parameter for dumping (eg. --username) to database config
+  * List required attributes for each database (like `host` and raise on missing)
+  * Load config once, and apply a bunch of custom items. For instance, mysql default bootstrap should be a *.sql file and the default for postgres should be *.dump for faster loads
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Create some tests
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bootstrap-db.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bootstrap/db/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bootstrap-db"
+  spec.version       = Bootstrap::Db::VERSION
+  spec.authors       = ["Tom Meier"]
+  spec.email         = ["tom@venombytes.com"]
+  spec.description   = %q{Database dump and loader}
+  spec.summary       = %q{Database dump and loader}
+  spec.homepage      = "http://github.com/tommeier/bootstrap-db"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'railties'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/bootstrap/db/config.rb

@@ -0,0 +1,47 @@
+module Bootstrap
+  module Db
+    class Config
+      DB_CONFIG_PATH = 'config/database.yml'
+
+      attr_accessor :settings, :adapter, :dump_name, :dump_path, :dump_dir
+
+      def initialize(settings)
+        self.settings = settings
+        self.adapter  = settings[Rails.env]["adapter"].to_sym
+
+        self.dump_path = ENV['FILE'] || File.join(default_dump_path, ENV['FILE_NAME'] || default_dump_name)
+        self.dump_name = File.basename(self.dump_path)
+        self.dump_dir  = File.dirname(self.dump_path)
+      end
+
+      def self.load!(configuration_path = File.join(Rails.root, DB_CONFIG_PATH))
+        unless File.exists?(configuration_path)
+          raise "Error - Please ensure your '#{File.basename(configuration_path)}' exists"
+        end
+
+        config = YAML::load(ERB.new(IO.read(configuration_path)).result)
+
+        unless config[Rails.env]["host"]
+          raise "Please ensure your '#{File.basename(configuration_path)}' file has a host for the database. eg. host = localhost"
+        end
+
+        new(config)
+      end
+
+      private
+
+        def default_dump_path
+          @default_dump_path ||= File.join(Rails.root, 'db', 'bootstrap')
+        end
+
+        def default_dump_name
+          @default_dump_name ||= case self.adapter
+          when :postgresql
+            'bootstrap_data.dump' #Custom format 'c'
+          else
+            'bootstrap_data.sql' #MySQL
+          end
+        end
+    end
+  end
+end

data/lib/bootstrap/db/railtie.rb

@@ -0,0 +1,7 @@
+module Bootstrap
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "bootstrap/db/tasks/bootstrap-db.rake"
+    end
+  end
+end

data/lib/bootstrap/db/rake_helper.rb

@@ -0,0 +1,21 @@
+module Bootstrap
+  module Db
+    module RakeHelper
+
+      def log(output)
+        STDERR.puts "[bootstrap-db] #{output}"
+      end
+
+      def display_and_execute(command)
+        log(command) if ENV['VERBOSE'] == 'true'
+        execute_command(command)
+      end
+
+      def execute_command(command)
+        output = `#{command} 2>&1`
+        raise "Error : #{output}" unless $?.success?
+        output
+      end
+    end
+  end
+end

data/lib/bootstrap/db/tasks/bootstrap-db.rake

@@ -0,0 +1,88 @@
+require File.join(File.dirname(__FILE__), '../rake_helper')
+
+namespace :bootstrap do
+  namespace :db do
+    include Bootstrap::Db::RakeHelper
+
+    desc "Dump the current database to a SQL file"
+    task :dump => :environment do
+      config = Bootstrap::Db::Config.load!
+
+      settings        = config.settings[Rails.env]
+      ignore_tables   = ENV['IGNORE_TABLES'].split(',')     if ENV['IGNORE_TABLES']
+      passed_params   = ENV['ADDITIONAL_PARAMS'].split(',') if ENV['ADDITIONAL_PARAMS']
+
+      #Create directories if they don't exist
+      Dir.mkdir config.dump_dir unless File.exists?(config.dump_dir)
+
+      log "Generating dump of database: '#{config.dump_name}'"
+
+      case config.adapter
+      when :mysql
+        #mysqldump --help
+        default_sql_attrs = "-q --add-drop-table --add-locks --extended-insert --lock-tables --single-transaction"
+        if ignore_tables
+          ignore_tables.each do |table_name|
+            default_sql_attrs += " --ignore-table=#{settings["database"]}.#{table_name.strip}"
+          end
+        end
+
+        if passed_params
+          passed_params.each do |param|
+            default_sql_attrs += " #{param}"
+          end
+        end
+
+        password_attrs = " -p#{settings["password"]}" if settings["password"]
+        #--all-tablespaces
+        display_and_execute("mysqldump #{default_sql_attrs} -h #{settings["host"]} -u #{settings["username"]}#{password_attrs} #{settings["database"]} > #{config.dump_path}")
+
+      when :postgresql
+        #pg_dump --help
+        default_sql_attrs = "--clean --format=c"
+
+        if ignore_tables.present?
+          ignore_tables.each do |table_name|
+            default_sql_attrs += " --exclude-table=#{settings["database"]}.#{table_name.strip}"
+          end
+        end
+
+        if passed_params.present?
+          passed_params.each do |param|
+            default_sql_attrs += " #{param}"
+          end
+        end
+
+        user_attribute = " --username=#{settings["username"]}" if settings['username']
+
+        display_and_execute("pg_dump #{default_sql_attrs} --host=#{settings["host"]} --port=#{settings["port"] || 5432}#{user_attribute} --file=#{config.dump_path} #{settings["database"]}")
+      else
+        raise "Error : Task not supported by '#{settings['adapter']}'"
+      end
+      log "Dump completed --> '#{config.dump_path}'"
+    end
+
+    desc "Load a SQL dump into the current environment"
+    task :load => :environment do
+      config    = Bootstrap::Db::Config.load!
+      settings  = config.settings[Rails.env]
+      raise "Unable to find dump at location - '#{config.dump_path}'" unless File.exists?(config.dump_path)
+
+      log "Loading dump: '#{config.dump_name}'"
+
+      case config.adapter
+      when :mysql
+        password_attrs = " -p#{settings["password"]}" if settings["password"]
+        display_and_execute("mysql -f -h #{settings["host"]} -u #{settings["username"]}#{password_attrs.to_s} #{settings["database"]} < #{config.dump_path}")
+      when :postgresql
+        default_sql_attrs = "--exit-on-error --clean --single-transaction --format=c"
+        user_attribute    = " --username=#{settings["username"]}" if settings['username']
+        display_and_execute("pg_restore #{default_sql_attrs} --host=#{settings["host"]} --port=#{settings["port"] || 5432} --dbname=#{settings["database"]}#{user_attribute} #{config.dump_path}")
+      else
+        raise "Task not supported by '#{settings['adapter']}'"
+      end
+
+      log "Database load completed..."
+    end
+  end
+end

data/lib/bootstrap/db/version.rb

@@ -0,0 +1,5 @@
+module Bootstrap
+  module Db
+    VERSION = "0.0.1"
+  end
+end

data/lib/bootstrap/db.rb

@@ -0,0 +1,11 @@
+require 'bootstrap/db/version'
+
+module Bootstrap
+  module Db
+  end
+end
+
+require 'bootstrap/db/config'
+require 'bootstrap/db/railtie'
+
+

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: bootstrap-db
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tom Meier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Database dump and loader
+email:
+- tom@venombytes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bootstrap-db.gemspec
+- lib/bootstrap/db.rb
+- lib/bootstrap/db/config.rb
+- lib/bootstrap/db/railtie.rb
+- lib/bootstrap/db/rake_helper.rb
+- lib/bootstrap/db/tasks/bootstrap-db.rake
+- lib/bootstrap/db/version.rb
+homepage: http://github.com/tommeier/bootstrap-db
+licenses:
+- MIT
+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: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Database dump and loader
+test_files: []