dumpdb 1.1.0 → 2.0.0

data/README.md

@@ -10,10 +10,23 @@ require 'dumpdb'
 class MysqlFullRestore
   include Dumpdb
 
-  databases { '/path/to/database.yml'}
   dump_file { "dump.bz2" }
-  source { db('production',  :output_root => '/some/source/dir') }
-  target { db('development', :output_root => '/some/target/dir') }
+  source do
+    { :host        => 'production.example.com',
+      :port        => 1234,
+      :user        => 'admin',
+      :pw          => 'secret',
+      :db          => 'myapp_db',
+      :output_root => '/some/source/dir'
+    }
+  end
+  target do
+    { :host        => 'localhost',
+      :user        => 'admin',
+      :db          => 'myapp_db',
+      :output_root => '/some/target/dir'
+    }
+  end
 
   dump    { "mysqldump -u :user -p\":pw\" :db | bzip2 > :dump_file" }
   restore { "mysqladmin -u :user -p\":pw\" -f -b DROP :db; true" }
@@ -152,17 +165,17 @@ class MysqlFullRestore
   include Dumpdb
 
   source do
-    { 'user' => 'something',
-      'pw'   => 'secret',
-      'db'   => 'something_production',
-      'something' => 'else'
+    { :user      => 'something',
+      :pw        => 'secret',
+      :db        => 'something_production',
+      :something => 'else'
     }
   end
 
   target do
-    { 'user' => 'root',
-      'pw'   => 'supersecret',
-      'db'   => 'something_development'
+    { :user => 'root',
+      :pw   => 'supersecret',
+      :db   => 'something_development'
     }
   end
 
@@ -172,43 +185,6 @@ end
 
 Any settings keys can be used as command placeholders in dump and restore commands.
 
-**Note:** When reading source and target settings, Dumpdb takes common keys like 'hostname', 'username', 'password', and 'database' and exposes them with the more succinct 'host', 'user', 'pw', and 'db'.
-
-### Lookup settings from YAML
-
-Since many ORMs allow you to configure db connections using yaml files, Dumpdb supports specifying your databases from a yaml file.
-
-```ruby
-class MysqlFullRestore
-  include Dumpdb
-
-  databases { '/path/to/database.yml' }
-
-  # ...
-end
-```
-
-Now you can lookup your source and target settings using the `db` method.
-
-```ruby
-databases { '/path/to/database.yml' }
-source { db('production') }
-target { db('development') }
-```
-
-You can merge in additional settings by passing them to the `db` command:
-
-```ruby
-class MysqlFullRestore
-  include Dumpdb
-
-  databases { '/path/to/database.yml' }
-  source { db('produciton', :something => 'else') }
-
-  # ...
-end
-```
-
 ### Building Commands
 
 As you may have noticed, the script DSL settings methods all take a proc as their argument.  This is because the procs are lazy-eval'd in the scope of the script instance.  This allows you to use interpolation to help build commands with dynamic data.
@@ -231,7 +207,7 @@ class MysqlIgnoredTablesRestore
   end
 
   def ignored_tables
-    @opts[:ignored_tables].collect {|t| "--ignore-table=#{source.db}.#{t}"}.join(' ')
+    @opts[:ignored_tables].map{ |t| "--ignore-table=#{source.db}.#{t}" }.join(' ')
   end
 end
 ```

data/lib/dumpdb/db.rb

@@ -2,42 +2,57 @@ module Dumpdb
 
   class Db
 
-    def initialize(dump_file_name, values=nil)
-      @dump_file_name = dump_file_name || 'dump.output'
-      @values = (values || {}).inject({}) do |vals, (k, v)|
-        # stringify keys
-        vals.merge(k.to_s => v)
-      end
+    DEFAULT_VALUE = ''.freeze
+
+    def initialize(dump_file_name = nil, values = nil)
+      dump_file_name = dump_file_name || 'dump.output'
+      @values        = dumpdb_symbolize_keys(values)
 
-      @values['host']        ||= (@values['hostname'] || '')
-      @values['user']        ||= (@values['username'] || '')
-      @values['pw']          ||= (@values['password'] || '')
-      @values['db']          ||= (@values['database'] || '')
-      @values['output_root'] ||= ''
+      [:host, :port, :user, :pw, :db, :output_root].each do |key|
+        @values[key] ||= DEFAULT_VALUE
+      end
 
-      @values['output_dir'] = output_dir(self.output_root, "#{self.host}__#{self.db}")
-      @values['dump_file']  = File.join(self.output_dir, @dump_file_name)
+      @values[:output_dir] = dumpdb_build_output_dir(
+        self.output_root,
+        self.host,
+        self.db
+      )
+      @values[:dump_file] = File.join(self.output_dir, dump_file_name)
     end
 
     def to_hash; @values; end
 
     def method_missing(meth, *args, &block)
-      if @values.has_key?(meth.to_s)
-        @values[meth.to_s]
+      if @values.has_key?(meth.to_sym)
+        @values[meth.to_sym]
       else
         super
       end
     end
 
     def respond_to?(meth)
-      @values.has_key?(meth.to_s) || super
+      @values.has_key?(meth.to_sym) || super
     end
 
     private
 
-    def output_dir(root, name)
-      name_time = "#{name}__#{Time.now.to_f}"
-      root && !root.empty? ? File.join(root, name_time) : name_time
+    def dumpdb_build_output_dir(output_root, host, database)
+      dir_name = dumpdb_build_output_dir_name(host, database)
+      if output_root && !output_root.to_s.empty?
+        File.join(output_root, dir_name)
+      else
+        dir_name
+      end
+    end
+
+    def dumpdb_build_output_dir_name(host, database)
+      [host, database, Time.now.to_f].map(&:to_s).reject(&:empty?).join("__")
+    end
+
+    def dumpdb_symbolize_keys(values)
+      (values || {}).inject({}) do |h, (k, v)|
+        h.merge(k.to_sym => v)
+      end
     end
 
   end

data/lib/dumpdb/settings.rb

@@ -1,4 +1,3 @@
-require 'yaml'
 require 'dumpdb/db'
 
 module Dumpdb::Settings
@@ -19,27 +18,13 @@ module Dumpdb::Settings
 
   class Ssh < Base; end
 
-  class Databases < Base
-
-    def value(script)
-      val = super
-      val.kind_of?(::String) ? load_yaml(val) : val
-    end
-
-    private
-
-    def load_yaml(file_path)
-      YAML.load(File.read(File.expand_path(file_path)))
-    end
-  end
-
   class DumpFile < Base; end
 
   class SourceTarget < Base
 
     def value(script)
-      val = super
-      val.kind_of?(Dumpdb::Db) ? val : Dumpdb::Db.new(script.dump_file, val)
+      hash = super
+      Dumpdb::Db.new(script.dump_file, hash)
     end
 
   end
@@ -53,7 +38,7 @@ module Dumpdb::Settings
     private
 
     def hsub(string, hash)
-      hash.inject(string) {|new_str, (k, v)| new_str.gsub(":#{k}", v.to_s)}
+      hash.inject(string){ |new_str, (k, v)| new_str.gsub(":#{k}", v.to_s) }
     end
 
   end
@@ -94,7 +79,7 @@ module Dumpdb::Settings
   class CmdList < ::Array
 
     def value(script, placeholder_vals={})
-      self.map{|cmd| cmd.value(script, placeholder_vals)}
+      self.map{ |cmd| cmd.value(script, placeholder_vals) }
     end
 
   end

data/lib/dumpdb/version.rb

@@ -1,3 +1,3 @@
 module Dumpdb
-  VERSION = "1.1.0"
+  VERSION = "2.0.0"
 end

data/lib/dumpdb.rb

@@ -13,7 +13,6 @@ module Dumpdb
       include NsOptions
       options :settings do
         option 'ssh',          Settings::Ssh,          :default => ''
-        option 'databases',    Settings::Databases,    :default => {}
         option 'dump_file',    Settings::DumpFile,     :default => ''
         option 'source',       Settings::SourceTarget, :default => {}
         option 'target',       Settings::SourceTarget, :default => {}
@@ -34,7 +33,6 @@ module Dumpdb
   module SettingsDslMethods
 
     def ssh(&block);       settings.ssh       = Settings::Ssh.new(block);          end
-    def databases(&block); settings.databases = Settings::Databases.new(block);    end
     def dump_file(&block); settings.dump_file = Settings::DumpFile.new(block);     end
     def source(&block);    settings.source    = Settings::SourceTarget.new(block); end
     def target(&block);    settings.target    = Settings::SourceTarget.new(block); end
@@ -49,7 +47,6 @@ module Dumpdb
     def settings; self.class.settings; end
 
     def ssh;       @ssh       ||= settings.ssh.value(self);       end
-    def databases; @databases ||= settings.databases.value(self); end
     def dump_file; @dump_file ||= settings.dump_file.value(self); end
     def source;    @source    ||= settings.source.value(self);    end
     def target;    @target    ||= settings.target.value(self);    end
@@ -60,13 +57,6 @@ module Dumpdb
 
   end
 
-  def db(database_name, other_vals=nil)
-    if (db_vals = self.databases[database_name]).nil?
-      raise BadDatabaseName, "no database named `#{database_name}'."
-    end
-    Db.new(self.dump_file, db_vals.merge(other_vals || {}))
-  end
-
   def dump_cmd(&block);   Settings::DumpCmd.new(block).value(self);    end
   def restore_cmd(&block) Settings::RestoreCmd.new(block).value(self); end
 

data/test/helper.rb

@@ -8,3 +8,5 @@ $LOAD_PATH.unshift(ROOT_PATH)
 # require pry for debugging (`binding.pry`)
 require 'pry'
 
+require 'test/support/factory'
+

data/test/support/factory.rb

@@ -0,0 +1,6 @@
+require 'assert/factory'
+
+module Factory
+  extend Assert::Factory
+
+end

data/test/support/test_scripts.rb

@@ -3,10 +3,22 @@ require 'dumpdb'
 class LocalScript
   include Dumpdb
 
-  databases { File.join(ROOT_PATH, 'test/support/database.yaml') }
   dump_file { "dump.#{type}" }
-  source    { db('development', :another => 'value') }
-  target    { db('test') }
+  source do
+    { :host     => 'devhost',
+      :user     => 'devuser',
+      :pw       => 'devpw',
+      :db       => 'devdb',
+      :another  => 'value'
+    }
+  end
+  target do
+    { :host => 'testhost',
+      :user => 'testuser',
+      :pw   => 'testpw',
+      :db   => 'testdb'
+    }
+  end
 
   def type; "local"; end
 end
@@ -15,10 +27,21 @@ class RemoteScript
   include Dumpdb
 
   ssh       { 'user@example.com' }
-  databases { File.join(ROOT_PATH, 'test/support/database.yaml') }
   dump_file { "dump.#{type}" }
-  source    { db('development') }
-  target    { db('test') }
+  source do
+    { :host     => 'devhost',
+      :user     => 'devuser',
+      :pw       => 'devpw',
+      :db       => 'devdb',
+    }
+  end
+  target do
+    { :host => 'testhost',
+      :user => 'testuser',
+      :pw   => 'testpw',
+      :db   => 'testdb'
+    }
+  end
 
   def type; "remote"; end
 end

data/test/unit/db_tests.rb

@@ -1,33 +1,84 @@
 require 'assert'
 require 'dumpdb/db'
 
-module Dumpdb
+class Dumpdb::Db
 
-  class DbTests < Assert::Context
-    desc "the Db helper class"
+  class UnitTests < Assert::Context
+    desc "Dumpdb::Db"
     setup do
-      @db = Db.new(nil)
+      @db_class = Dumpdb::Db
+    end
+    subject{ @db_class }
+
+    should "know its default value" do
+      assert_equal '', DEFAULT_VALUE
+    end
+
+  end
+
+  class InitTests < UnitTests
+    desc "when init"
+    setup do
+      @dump_file_name = Factory.file_name
+      @host           = Factory.string
+      @port           = Factory.integer
+      @user           = Factory.string
+      @pw             = Factory.string
+      @db_name        = Factory.string
+      @output_root    = Factory.dir_path
+      @custom_value   = Factory.string
+
+      @current_time = Factory.time
+      Assert.stub(Time, :now){ @current_time }
+
+      @db = @db_class.new(@dump_file_name, {
+        :host         => @host,
+        :port         => @port,
+        :user         => @user,
+        :pw           => @pw,
+        :db           => @db_name,
+        :output_root  => @output_root,
+        :custom_value => @custom_value
+      })
     end
     subject { @db }
 
-    should have_imeths :host, :user, :pw, :db, :output_root, :output_dir, :dump_file
+    should have_imeths :host, :port, :user, :pw, :db
+    should have_imeths :output_root, :output_dir, :dump_file
+    should have_imeths :to_hash
 
-    should "default its values" do
-      [:host, :user, :pw, :db, :output_root].each do |val|
-        assert_equal '', subject.send(val)
-      end
-      assert_match '____',        subject.output_dir
-      assert_match 'dump.output', subject.dump_file
+    should "know its attributes" do
+      assert_equal @host,        subject.host
+      assert_equal @port,        subject.port
+      assert_equal @user,        subject.user
+      assert_equal @pw,          subject.pw
+      assert_equal @db_name,     subject.db
+      assert_equal @output_root, subject.output_root
+      exp = File.join(@output_root, "#{@host}__#{@db_name}__#{@current_time.to_f}")
+      assert_equal exp, subject.output_dir
+      exp = File.join(subject.output_dir, @dump_file_name)
+      assert_equal exp, subject.dump_file
     end
 
-    should "set values" do
-      db = Db.new('dump.file', :host => 'h', :db => 'd', :something => 'else')
+    should "allow custom attributes" do
+      assert_true subject.respond_to?(:custom_value)
+      assert_equal @custom_value, subject.custom_value
+    end
+
+    should "default its attributes" do
+      db = @db_class.new
 
-      assert_equal 'h',         db.host
-      assert_equal 'd',         db.db
-      assert_match 'h__d__',    db.output_dir
-      assert_match 'dump.file', db.dump_file
+      assert_equal DEFAULT_VALUE, db.host
+      assert_equal DEFAULT_VALUE, db.port
+      assert_equal DEFAULT_VALUE, db.user
+      assert_equal DEFAULT_VALUE, db.pw
+      assert_equal DEFAULT_VALUE, db.db
+      assert_equal DEFAULT_VALUE, db.output_root
+      assert_equal @current_time.to_f.to_s, db.output_dir
+      exp = File.join(db.output_dir, 'dump.output')
+      assert_equal exp, db.dump_file
     end
+
   end
 
 end

data/test/unit/script_tests.rb

@@ -12,10 +12,11 @@ module Dumpdb
     subject { @script }
 
     should have_cmeths :settings
-    should have_imeths :settings, :db, :dump_cmd, :restore_cmd, :ssh?, :ssh_opts, :run
+    should have_imeths :settings, :dump_cmd, :restore_cmd
+    should have_imeths :ssh?, :ssh_opts, :run
 
-    should have_cmeths :ssh, :databases, :dump_file, :source, :target
-    should have_imeths :ssh, :databases, :dump_file, :source, :target
+    should have_cmeths :ssh, :dump_file, :source, :target
+    should have_imeths :ssh, :dump_file, :source, :target
 
     should have_cmeths :dump, :restore
     should have_imeths :dump_cmds, :restore_cmds, :copy_dump_cmd
@@ -32,7 +33,6 @@ module Dumpdb
 
     should "store off the settings for the script" do
       assert_kind_of Settings::Ssh,          subject.settings.ssh
-      assert_kind_of Settings::Databases,    subject.settings.databases
       assert_kind_of Settings::DumpFile,     subject.settings.dump_file
       assert_kind_of Settings::SourceTarget, subject.settings.source
       assert_kind_of Settings::SourceTarget, subject.settings.target
@@ -42,31 +42,6 @@ module Dumpdb
 
   end
 
-  class DbMethTests < ScriptTests
-    desc "`db' method"
-    setup do
-      @script = LocalScript.new
-    end
-
-    should "build a Db based on the named database values" do
-      assert_kind_of Db, subject.target
-      assert_equal 'testhost', subject.target.host
-    end
-
-    should "build a Db based on the named database values plus additional values" do
-      assert_kind_of Db, subject.source
-      assert_equal 'devhost', subject.source.host
-      assert_equal 'value', subject.source.another
-    end
-
-    should "complain if looking up a db not in the `databases` collection" do
-      assert_raises BadDatabaseName do
-        subject.db('does_not_exist')
-      end
-    end
-
-  end
-
   class CmdMethsTests < ScriptTests
 
     should "build dump command strings" do

data/test/unit/settings_tests.rb

@@ -38,34 +38,6 @@ module Dumpdb
 
   end
 
-  class DatabasesSettingTests < SettingsTests
-    desc "`databases` setting"
-    setup do
-      @from_hash = {
-        'db1' => {'db' => 'one'},
-        'db2' => {'db' => 'two'},
-      }
-    end
-
-    should "be available" do
-      assert Settings::Databases
-    end
-
-    should "come from a hash" do
-      databases = Settings::Databases.new(@from_hash)
-      assert_equal @from_hash, databases.value(@script)
-    end
-
-    should "come from a yaml file" do
-      databases = Settings::Databases.new(File.join(ROOT_PATH, 'test/support/test.yaml'))
-      assert_equal({
-        'db-one' => {'db' => 1},
-        'db-two' => {'db' => 2},
-      }, databases.value(@script))
-    end
-
-  end
-
   class DumpFileSettingTests < SettingsTests
     desc "`dump_file` setting"
 
@@ -92,13 +64,6 @@ module Dumpdb
       assert_equal 'from_hash', db.host
     end
 
-    should "come from a Db obj" do
-      db = Settings::Databases.new(Db.new('dump.file', {'host' => 'from_db'})).value(@script)
-
-      assert_kind_of Db, db
-      assert_equal 'from_db', db.host
-    end
-
   end
 
   class CmdTests < SettingsTests

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dumpdb
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: 
   segments: 
-  - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  - 0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2015-10-13 00:00:00 Z
+date: 2015-12-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -84,7 +84,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - dumpdb.gemspec
@@ -95,9 +95,8 @@ files:
 - lib/dumpdb/version.rb
 - log/.gitkeep
 - test/helper.rb
-- test/support/database.yaml
+- test/support/factory.rb
 - test/support/fake_cmd_runner.rb
-- test/support/test.yaml
 - test/support/test_scripts.rb
 - test/unit/db_tests.rb
 - test/unit/runner_tests.rb
@@ -139,9 +138,8 @@ specification_version: 3
 summary: Dump and restore your databases.
 test_files: 
 - test/helper.rb
-- test/support/database.yaml
+- test/support/factory.rb
 - test/support/fake_cmd_runner.rb
-- test/support/test.yaml
 - test/support/test_scripts.rb
 - test/unit/db_tests.rb
 - test/unit/runner_tests.rb

data/test/support/database.yaml

@@ -1,12 +0,0 @@
----
-test:
-  hostname: testhost
-  username: testuser
-  password: testpw
-  database: testdb
-
-development:
-  hostname: devhost
-  username: devuser
-  password: devpw
-  database: devdb

data/test/support/test.yaml

@@ -1,6 +0,0 @@
----
-"db-one":
-  db: 1
-
-"db-two":
-  db: 2