database_exporter 0.0.2

data/README.md

@@ -0,0 +1,32 @@
+# Database Exporter
+
+Experimental project to gain access to system-level database import, export and copy capabilities. It's build to handle Rail's database configuration conventions.
+
+# Database Support
+
+Current support is for MySQL only.
+
+# Installation & Usage
+
+To install, add `gem 'database_exporter'` to your Gemfile or do `gem install database_exporter`.
+
+Specs are a good example of how to use this library, here's some more:
+
+## Export
+    db = DatabaseExporter.new({'adapter' => 'mysql2', 'username' => 'root', 'database' => 'some_database'})
+    db.export #=> Native MySQL database dump
+
+## Import
+    db = DatabaseExporter.new({'adapter' => 'mysql2', 'username' => 'root', 'database' => 'some_database'})
+    db.import('CREATE TABLE IF NOT EXISTS some_new_table;')
+
+## Copy
+    # Database to copy from
+    db = DatabaseExporter.new({'adapter' => 'mysql2', 'username' => 'root', 'database' => 'source_database'})
+
+    # Database to copy to
+    db.copy({'adapter' => 'mysql2', 'username' => 'root', 'database' => 'destination_database'})
+
+# License
+
+Database Exporter is released under the MIT license

data/database_exporter.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'bundler'
+
+Gem::Specification.new do |s|
+  s.name        = "database_exporter"
+  s.version     = '0.0.2'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Mike Pack"]
+  s.email       = ["mikepackdev@gmail.com"]
+  s.homepage    = "http://www.mikepackdev.com"
+  s.summary     = %q{Access to system-level database import, export and copy capabilities.}
+  s.description = %q{Experimental project to gain access to system-level database import, export and copy capabilities. It's build to handle Rail's database configuration conventions.}
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.files = %w( README.md database_exporter.gemspec ) + Dir["lib/**/*.rb"]
+  s.test_files = Dir["spec/**/*.rb"]
+  s.require_paths = ["lib"]
+end

data/lib/adapters/mysql_adapter.rb

@@ -0,0 +1,25 @@
+class MysqlAdapter
+  def initialize(config)
+    @config = config
+  end
+
+  def export
+    ensure_db_exists
+    Kernel.` "mysqldump -h #{@config['host']} -u #{@config['username']} #{'-p' + @config['password'] if @config['password']} #{@config['database']}"
+  end
+
+  def import(sql)
+    ensure_db_exists
+    Kernel.` "echo \"#{sql}\" | mysql -h #{@config['host']} -u #{@config['username']} #{'-p' + @config['password'] if @config['password']} #{@config['database']}"
+  end
+
+  def copy(new_db_config)
+    ensure_db_exists
+    ensure_db_exists(new_db_config['database'])
+    Kernel.` "mysqldump -h #{@config['host']} -u #{@config['username']} #{'-p' + @config['password'] if @config['password']} #{@config['database']} | mysql -h #{new_db_config['host']} -u #{new_db_config['username']} #{'-p' + new_db_config['password'] if new_db_config['password']} #{new_db_config['database']}"
+  end
+
+  def ensure_db_exists(name = @config['database'])
+    `echo "CREATE DATABASE IF NOT EXISTS #{name}" | mysql -h #{@config['host']} -u #{@config['username']} #{'-p' + @config['password'] if @config['password']}`
+  end
+end

data/lib/database_exporter.rb

@@ -0,0 +1,14 @@
+require 'forwardable'
+
+class DatabaseExporter
+  extend Forwardable
+
+  def initialize(config)
+    @datbase = case config['adapter']
+    when /mysql/
+      MysqlAdapter.new(config)
+    end
+  end
+
+  def_delegators :@database, :export, :import, :copy
+end

data/spec/lib/adapters/mysql_adapter_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe MysqlAdapter do
+  context 'with a MySQL database' do
+    let(:adapter) { MysqlAdapter.new({"database"=>"some_mysql_db", "host"=>"localhost", "username"=>"root", "password"=>nil}) }
+
+    describe '#export' do
+      it 'ensures the database exists' do
+        adapter.should_receive(:ensure_db_exists)
+        adapter.export
+      end
+
+      it 'executes the mysqdldump command' do
+        Kernel.should_receive(:`).with(/mysqldump/)
+        adapter.export
+      end
+
+      it 'returns the database dump' do
+        adapter.export.should =~ /Database: some_mysql_db/
+      end
+    end
+
+    describe '#import' do
+      it 'ensures the database exists' do
+        adapter.should_receive(:ensure_db_exists)
+        adapter.import('SHOW DATABASES;')
+      end
+
+      it 'executes the mysql command' do
+        Kernel.should_receive(:`).with(/mysql\s/)
+        adapter.import('SHOW DATABASES;')
+      end
+
+      it 'imports the desired SQL' do
+        sql = <<-SQL
+          CREATE TABLE my_new_database_table (
+                   id INT,
+                   data VARCHAR(100)
+                 );
+        SQL
+        adapter.import(sql)
+        adapter.export.should =~ /my_new_database_table/
+        
+        # Remove the table so it doesn't disrupt future-run specs
+        sql = <<-SQL
+          DROP TABLE my_new_database_table;
+        SQL
+        adapter.import(sql)
+      end
+    end
+
+    describe '#copy' do
+      it 'executes the mysqldump and pipes to the mysql command' do
+        Kernel.should_receive(:`).with(/mysqldump.*\|\s+mysql/)
+        adapter.copy({"database"=>"new_mysql_db", "host"=>"localhost", "username"=>"root", "password"=>nil})
+      end
+
+      it 'copies one database to another' do
+        # Create a new table to check that it was duplicated to the new database
+        adapter.import('CREATE TABLE some_new_database_table ( id INT );')
+        adapter.copy({"database"=>"new_mysql_db", "host"=>"localhost", "username"=>"root", "password"=>nil})
+
+        # Load the new database and check that the table exists
+        new_adapter = MysqlAdapter.new({"database"=>"new_mysql_db", "host"=>"localhost", "username"=>"root", "password"=>nil})
+        new_adapter.export.should =~ /some_new_database_table/
+
+        `echo "DROP DATABASE some_mysql_db" | mysql -u root`
+        `echo "DROP DATABASE new_mysql_db" | mysql -u root`
+      end
+    end
+
+    describe '#ensure_db_exists' do
+      it 'creates the database if it does not exist' do
+        `mysqldump -u root some_db_that_does_not_exist`
+        $?.success?.should be_false
+
+        adapter.ensure_db_exists('some_db_that_does_not_exist')
+
+        `mysqldump -u root some_db_that_does_not_exist`
+        $?.success?.should be_true
+
+        `echo "DROP DATABASE some_db_that_does_not_exist" | mysql -u root`
+      end
+    end
+  end
+end

data/spec/lib/database_exporter_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe DatabaseExporter do
+  describe '#initialize' do
+    it 'initializes the MysqlAdapter when passed a MySQL config' do
+      MysqlAdapter.should_receive(:new).with({'adapter' => 'mysql2'})
+      DatabaseExporter.new({'adapter' => 'mysql2'})
+    end
+  end
+
+  describe '#export, #import, #copy' do
+    it 'all exist (and are delegated to the adapter)' do
+      exporter = DatabaseExporter.new({'adapter' => 'mysql2'})
+      [:export, :import, :copy].each do |method|
+        exporter.respond_to?(method).should be_true
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require File.join(File.dirname(__FILE__), '../lib/database_exporter')
+require File.join(File.dirname(__FILE__), '../lib/adapters/mysql_adapter')

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: database_exporter
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Mike Pack
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-18 00:00:00.000000000Z
+dependencies: []
+description: Experimental project to gain access to system-level database import,
+  export and copy capabilities. It's build to handle Rail's database configuration
+  conventions.
+email:
+- mikepackdev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- database_exporter.gemspec
+- lib/adapters/mysql_adapter.rb
+- lib/database_exporter.rb
+- spec/lib/adapters/mysql_adapter_spec.rb
+- spec/lib/database_exporter_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.mikepackdev.com
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Access to system-level database import, export and copy capabilities.
+test_files:
+- spec/lib/adapters/mysql_adapter_spec.rb
+- spec/lib/database_exporter_spec.rb
+- spec/spec_helper.rb