ardb 0.28.1 → 0.29.2

data/test/helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # this file is automatically required when you run `assert`
 # put any test helpers here
 
@@ -7,19 +9,10 @@ $LOAD_PATH.unshift(File.expand_path("../..", __FILE__))
 TEST_SUPPORT_PATH = File.expand_path("../support", __FILE__)
 TMP_PATH          = File.expand_path("../../tmp", __FILE__)
 
-require 'logger'
+require "logger"
 log_path = File.expand_path("../../log/test.log", __FILE__)
-TEST_LOGGER = Logger.new(File.open(log_path, 'w'))
+TEST_LOGGER = Logger.new(File.open(log_path, "w"))
 
 # require pry for debugging (`binding.pry`)
-require 'pry'
-require 'test/support/factory'
-
-# 1.8.7 backfills
-
-# Array#sample
-if !(a = Array.new).respond_to?(:sample) && a.respond_to?(:choice)
-  class Array
-    alias_method :sample, :choice
-  end
-end
+require "pry"
+require "test/support/factory"

data/test/support/factory.rb

@@ -1,10 +1,12 @@
-require 'assert/factory'
+# frozen_string_literal: true
+
+require "assert/factory"
 
 module Factory
   extend Assert::Factory
 
   def self.migration_id
-    # identifiers need to be plural b/c af activesupport's pluralize
+    # identifiers need to be plural b/c af activesupport"s pluralize
     "#{Factory.string}_things"
   end
 
@@ -22,5 +24,4 @@ module Factory
       c.min_messages     = Factory.string
     end
   end
-
 end

data/test/support/fake_schema.rb

@@ -1,4 +1,6 @@
-if !defined?(FAKE_SCHEMA)
+# frozen_string_literal: true
+
+unless defined?(FAKE_SCHEMA)
   fake_schema_class = Struct.new(:load_count)
   FAKE_SCHEMA = fake_schema_class.new(0)
 end

data/test/support/postgresql/schema.rb

@@ -1,3 +1,4 @@
-ActiveRecord::Schema.define(:version => 0) do
+# frozen_string_literal: true
 
+ActiveRecord::Schema.define(version: 0) do
 end

data/test/support/postgresql/setup_test_db.rb

@@ -1,24 +1,26 @@
-require 'assert'
-require 'ardb'
+# frozen_string_literal: true
+
+require "assert"
+require "ardb"
 
 class PostgresqlDbTests < Assert::Context
   setup do
-    @orig_env_ardb_db_file    = ENV['ARDB_DB_FILE']
+    @orig_env_ardb_db_file    = ENV["ARDB_DB_FILE"]
     ActiveRecord::Base.logger = @orig_ar_loggerF
 
-    # no-op, we're manually configuring ardb so we don't need this to do anything
-    ENV['ARDB_DB_FILE'] = File.join(TEST_SUPPORT_PATH, 'require_test_db_file')
+    # we"re manually configuring ardb so we don"t need this to do anything
+    ENV["ARDB_DB_FILE"] = File.join(TEST_SUPPORT_PATH, "require_test_db_file")
 
     @ardb_config = Ardb::Config.new.tap do |c|
-      c.adapter      = 'postgresql'
-      c.database     = 'redding_ardb_test'
-      c.encoding     = 'unicode'
-      c.min_messages = 'WARNING'
+      c.adapter      = "postgresql"
+      c.database     = "redding_ardb_test"
+      c.encoding     = "unicode"
+      c.min_messages = "WARNING"
 
       c.logger          = TEST_LOGGER
-      c.root_path       = File.join(TEST_SUPPORT_PATH, 'postgresql')
-      c.migrations_path = 'migrations'
-      c.schema_path     = 'schema'
+      c.root_path       = File.join(TEST_SUPPORT_PATH, "postgresql")
+      c.migrations_path = "migrations"
+      c.schema_path     = "schema"
       c.schema_format   = :ruby
     end
     Assert.stub(Ardb, :config){ @ardb_config }
@@ -31,8 +33,9 @@ class PostgresqlDbTests < Assert::Context
     Ardb.adapter.connect_db
   end
   teardown do
+    Ardb.reset_adapter
     ActiveRecord::Base.logger = @orig_ar_logger
-    ENV['ARDB_DB_FILE']       = @orig_env_ardb_db_file
+    ENV["ARDB_DB_FILE"]       = @orig_env_ardb_db_file
   end
 
   private
@@ -40,12 +43,11 @@ class PostgresqlDbTests < Assert::Context
   # useful when testing creating/dropping/migrating DBs
   def silence_stdout
     current_stdout = $stdout.dup
-    $stdout = File.new('/dev/null', 'w')
+    $stdout = File.new("/dev/null", "w")
     begin
       yield
     ensure
       $stdout = current_stdout
     end
   end
-
 end

data/test/support/relative_require_test_db_file.rb

@@ -1,2 +1,3 @@
+# frozen_string_literal: true
 # this file is used to test that Ardb will relatively require a db file when
 # init

data/test/support/require_test_db_file.rb

@@ -1 +1,2 @@
+# frozen_string_literal: true
 # this file is used to test that Ardb will require a db file when init

data/test/unit/adapter/base_tests.rb

@@ -1,14 +1,16 @@
-require 'assert'
-require 'ardb/adapter/base'
+# frozen_string_literal: true
 
-require 'ardb'
+require "assert"
+require "ardb/adapter/base"
+
+require "active_record/migration"
+require "ardb"
 # This is needed by the schema dumper but it doesn't handle requiring it so we
 # have to manually, otherwise this errors when you try to run the adapter base
 # tests by themselves
-require 'active_support/core_ext/class/attribute_accessors'
+require "active_support/core_ext/class/attribute_accessors"
 
 class Ardb::Adapter::Base
-
   class UnitTests < Assert::Context
     desc "Ardb::Adapter::Base"
     setup do
@@ -21,7 +23,6 @@ class Ardb::Adapter::Base
     should have_imeths :connect_hash, :database, :migrations_path
     should have_imeths :schema_format, :ruby_schema_path, :sql_schema_path
     should have_imeths :escape_like_pattern
-    should have_imeths :foreign_key_add_sql, :foreign_key_drop_sql
     should have_imeths :create_db, :drop_db, :drop_tables
     should have_imeths :connect_db, :migrate_db
     should have_imeths :load_schema, :load_ruby_schema, :load_sql_schema
@@ -49,12 +50,15 @@ class Ardb::Adapter::Base
                 "#{Factory.string}\\" \
                 "#{Factory.string} " \
                 "#{Factory.string}"
-      exp = pattern.gsub("\\"){ "\\\\" }.gsub('%', "\\%").gsub('_', "\\_")
+      exp = pattern.gsub("\\"){ "\\\\" }.gsub("%", "\\%").gsub("_", "\\_")
       assert_equal exp, subject.escape_like_pattern(pattern)
+
+      pattern = Factory.string
+      assert_equal pattern, subject.escape_like_pattern(pattern)
     end
 
     should "allow using a custom escape char when escaping like patterns" do
-      escape_char = '#'
+      escape_char = "#"
       pattern = "#{Factory.string}%" \
                 "#{Factory.string}_" \
                 "#{Factory.string}\\" \
@@ -62,15 +66,10 @@ class Ardb::Adapter::Base
                 "#{Factory.string} " \
                 "#{Factory.string}"
       exp = pattern.gsub(escape_char, "#{escape_char}#{escape_char}")
-      exp = exp.gsub('%', "#{escape_char}%").gsub('_', "#{escape_char}_")
+      exp = exp.gsub("%", "#{escape_char}%").gsub("_", "#{escape_char}_")
       assert_equal exp, subject.escape_like_pattern(pattern, escape_char)
     end
 
-    should "not implement the foreign key sql meths" do
-      assert_raises(NotImplementedError){ subject.foreign_key_add_sql }
-      assert_raises(NotImplementedError){ subject.foreign_key_drop_sql }
-    end
-
     should "not implement the create and drop db methods" do
       assert_raises(NotImplementedError){ subject.create_db }
       assert_raises(NotImplementedError){ subject.drop_db }
@@ -92,7 +91,6 @@ class Ardb::Adapter::Base
       non_matching_adapter = Ardb::Adapter::Base.new(Factory.ardb_config)
       assert_not_equal non_matching_adapter, subject
     end
-
   end
 
   class ConnectDbTests < UnitTests
@@ -111,58 +109,64 @@ class Ardb::Adapter::Base
         @ar_with_connection_called = true
       end
 
-      @adapter.connect_db
+      subject.connect_db
     end
 
     should "use activerecord to establish and then checkout a connection" do
       assert_equal subject.connect_hash, @ar_establish_connection_called_with
       assert_true @ar_with_connection_called
     end
-
   end
 
-  class MigrateDbTests < UnitTests
-    desc "`migrate_db`"
+  class MigrateTests < UnitTests
     setup do
-      @orig_migrate_version_env_var = ENV['MIGRATE_VERSION']
-      @orig_migrate_query_env_var   = ENV['MIGRATE_QUIET']
-
-      ENV["MIGRATE_VERSION"] = Factory.integer.to_s if Factory.boolean
-      ENV["MIGRATE_QUIET"]   = Factory.boolean.to_s if Factory.boolean
-
-      @migrator_called_with = []
-      Assert.stub(ActiveRecord::Migrator, :migrate) do |*args|
-        @migrator_called_with = args
+      Assert.stub(ActiveRecord::MigrationContext, :new) do |*args|
+        @fake_migration_context ||= FakeMigrationContext.new(*args)
       end
-
-      @adapter.migrate_db
-    end
-    teardown do
-      ENV['MIGRATE_VERSION'] = @orig_migrate_version_env_var
-      ENV['MIGRATE_QUIET']   = @orig_migrate_query_env_var
     end
 
-    should "add the ardb migration helper recorder to activerecord's command recorder" do
-      exp = Ardb::MigrationHelpers::RecorderMixin
-      assert_includes exp, ActiveRecord::Migration::CommandRecorder
+    should "migrate the db with `migrate_db`" do
+      subject.migrate_db
+
+      assert_equal [subject.migrations_path], @fake_migration_context.init_with
+      assert_equal [nil], @fake_migration_context.up_called_with
     end
 
-    should "set the activerecord migrator's migrations path" do
-      exp = subject.migrations_path
-      assert_equal exp, ActiveRecord::Migrator.migrations_path
+    should "migrate the db with `migrate_db_up`" do
+      subject.migrate_db_up
+      assert_equal [nil], @fake_migration_context.up_called_with
+
+      target = Factory.string
+      subject.migrate_db_up(target)
+      assert_equal [target], @fake_migration_context.up_called_with
     end
 
-    should "set the activerecord migration's verbose attr" do
-      exp = ENV["MIGRATE_QUIET"].nil?
-      assert_equal exp, ActiveRecord::Migration.verbose
+    should "migrate the db with `migrate_db_down`" do
+      subject.migrate_db_down
+      assert_equal [nil], @fake_migration_context.down_called_with
+
+      target = Factory.string
+      subject.migrate_db_down(target)
+      assert_equal [target], @fake_migration_context.down_called_with
     end
 
-    should "call the activerecord migrator's migrate method" do
-      version = ENV.key?("MIGRATE_VERSION") ? ENV["MIGRATE_VERSION"].to_i : nil
-      exp = [subject.migrations_path, version]
-      assert_equal exp, @migrator_called_with
+    should "migrate the db with `migrate_db_forward`" do
+      subject.migrate_db_forward
+      assert_equal [1], @fake_migration_context.forward_called_with
+
+      steps = Factory.integer(3)
+      subject.migrate_db_forward(steps)
+      assert_equal [steps], @fake_migration_context.forward_called_with
     end
 
+    should "migrate the db with `migrate_db_backward`" do
+      subject.migrate_db_backward
+      assert_equal [1], @fake_migration_context.rollback_called_with
+
+      steps = Factory.integer(3)
+      subject.migrate_db_backward(steps)
+      assert_equal [steps], @fake_migration_context.rollback_called_with
+    end
   end
 
   class LoadAndDumpSchemaTests < UnitTests
@@ -235,12 +239,11 @@ class Ardb::Adapter::Base
       subject.load_schema
       assert_empty @captured_stdout
     end
-
   end
 
   class LoadRubySchemaTests < UnitTests
     setup do
-      @config.schema_path = File.join(TEST_SUPPORT_PATH, 'fake_schema')
+      @config.schema_path = File.join(TEST_SUPPORT_PATH, "fake_schema")
       @adapter = Ardb::Adapter::Base.new(@config)
     end
 
@@ -252,12 +255,12 @@ class Ardb::Adapter::Base
       subject.load_ruby_schema
       assert_equal 2, FAKE_SCHEMA.load_count
     end
-
   end
 
   class DumpRubySchemaTests < UnitTests
     setup do
-      @config.schema_path = File.join(TMP_PATH, 'testdb', 'test_dump_ruby_schema')
+      @config.schema_path =
+        File.join(TMP_PATH, "testdb", "test_dump_ruby_schema")
       FileUtils.rm_rf(File.dirname(@config.schema_path))
 
       @schema_dumper_connection, @schema_dumper_file = [nil, nil]
@@ -276,14 +279,13 @@ class Ardb::Adapter::Base
     end
 
     should "dump a ruby schema file using `dump_ruby_schema`" do
-      assert_false File.exists?(subject.ruby_schema_path)
+      assert_false File.exist?(subject.ruby_schema_path)
       subject.dump_ruby_schema
-      assert_true File.exists?(subject.ruby_schema_path)
+      assert_true File.exist?(subject.ruby_schema_path)
       assert_equal @fake_connection, @schema_dumper_connection
       assert_instance_of File, @schema_dumper_file
       assert_equal subject.ruby_schema_path, @schema_dumper_file.path
     end
-
   end
 
   class FakeConnection; end
@@ -322,7 +324,33 @@ class Ardb::Adapter::Base
   end
 
   class FakeConnectionPool
-    def with_connection(&block); end
+    def with_connection(&block)
+    end
   end
 
+  class FakeMigrationContext
+    attr_reader :init_with
+    attr_reader :up_called_with, :down_called_with
+    attr_reader :forward_called_with, :rollback_called_with
+
+    def initialize(*args)
+      @init_with = args
+    end
+
+    def up(*args)
+      @up_called_with = args
+    end
+
+    def down(*args)
+      @down_called_with = args
+    end
+
+    def forward(*args)
+      @forward_called_with = args
+    end
+
+    def rollback(*args)
+      @rollback_called_with = args
+    end
+  end
 end

data/test/unit/adapter/mysql_tests.rb

@@ -1,8 +1,9 @@
-require 'assert'
-require 'ardb/adapter/mysql'
+# frozen_string_literal: true
 
-class Ardb::Adapter::Mysql
+require "assert"
+require "ardb/adapter/mysql"
 
+class Ardb::Adapter::Mysql
   class UnitTests < Assert::Context
     desc "Ardb::Adapter::Mysql"
     setup do
@@ -11,20 +12,6 @@ class Ardb::Adapter::Mysql
     end
     subject{ @adapter }
 
-    should "know its foreign key add sql" do
-      exp_add_sql = "ALTER TABLE :from_table"\
-                    " ADD CONSTRAINT :name"\
-                    " FOREIGN KEY (:from_column)"\
-                    " REFERENCES :to_table (:to_column)"
-      assert_equal exp_add_sql, subject.foreign_key_add_sql
-    end
-
-    should "know its foreign key drop sql" do
-      exp_drop_sql = "ALTER TABLE :from_table"\
-                     " DROP FOREIGN KEY :name"
-      assert_equal exp_drop_sql, subject.foreign_key_drop_sql
-    end
-
     # not currently implemented, see: https://github.com/redding/ardb/issues/13
     should "not implement the create and drop db methods" do
       assert_raises(NotImplementedError){ subject.create_db }
@@ -35,7 +22,5 @@ class Ardb::Adapter::Mysql
     should "not implement the drop tables method" do
       assert_raises(NotImplementedError){ subject.drop_tables }
     end
-
   end
-
 end

data/test/unit/adapter/postgresql_tests.rb

@@ -1,10 +1,11 @@
-require 'assert'
-require 'ardb/adapter/postgresql'
+# frozen_string_literal: true
 
-require 'scmd'
+require "assert"
+require "ardb/adapter/postgresql"
 
-class Ardb::Adapter::Postgresql
+require "scmd"
 
+class Ardb::Adapter::Postgresql
   class UnitTests < Assert::Context
     desc "Ardb::Adapter::Postgresql"
     setup do
@@ -17,52 +18,42 @@ class Ardb::Adapter::Postgresql
 
     should "know its public connect hash" do
       exp = subject.connect_hash.merge({
-        'database' => 'postgres',
-        'schema_search_path' => 'public'
+        "database" => "postgres",
+        "schema_search_path" => "public",
       })
       assert_equal exp, subject.public_connect_hash
     end
 
-    should "know its foreign key add sql" do
-      exp_add_sql = "ALTER TABLE :from_table"\
-                    " ADD CONSTRAINT :name"\
-                    " FOREIGN KEY (:from_column)"\
-                    " REFERENCES :to_table (:to_column)"
-      assert_equal exp_add_sql, subject.foreign_key_add_sql
+    should "complain if given a database name with non-word characters" do
+      @config.database = "#{Factory.string}-#{Factory.string}"
+      assert_raises(Ardb::ConfigurationError) do
+        Ardb::Adapter::Postgresql.new(@config)
+      end
     end
-
-    should "know its foreign key drop sql" do
-      exp_drop_sql = "ALTER TABLE :from_table"\
-                     " DROP CONSTRAINT :name"
-      assert_equal exp_drop_sql, subject.foreign_key_drop_sql
-    end
-
   end
 
   class SQLSchemaTests < UnitTests
     setup do
       @env = {
-        'PGHOST'     => @adapter.connect_hash['host'],
-        'PGPORT'     => @adapter.connect_hash['port'],
-        'PGUSER'     => @adapter.connect_hash['username'],
-        'PGPASSWORD' => @adapter.connect_hash['password']
+        "PGHOST" => @adapter.connect_hash["host"],
+        "PGPORT" => @adapter.connect_hash["port"],
+        "PGUSER" => @adapter.connect_hash["username"],
+        "PGPASSWORD" => @adapter.connect_hash["password"],
       }
     end
-
   end
 
   class LoadSQLSchemaTests < SQLSchemaTests
     setup do
       cmd_str = "psql -f \"#{@adapter.sql_schema_path}\" #{@adapter.database}"
       @cmd_spy = CmdSpy.new
-      Assert.stub(Scmd, :new).with(cmd_str, :env => @env){ @cmd_spy }
+      Assert.stub(Scmd, :new).with(cmd_str, env: @env){ @cmd_spy }
     end
 
     should "run a command for loading a SQL schema using `load_sql_schema`" do
       subject.load_sql_schema
       assert_true @cmd_spy.run_called
     end
-
   end
 
   class DumpSQLSchemaTests < SQLSchemaTests
@@ -70,14 +61,13 @@ class Ardb::Adapter::Postgresql
       cmd_str = "pg_dump -i -s -x -O -f " \
                 "\"#{@adapter.sql_schema_path}\" #{@adapter.database}"
       @cmd_spy = CmdSpy.new
-      Assert.stub(Scmd, :new).with(cmd_str, :env => @env){ @cmd_spy }
+      Assert.stub(Scmd, :new).with(cmd_str, env: @env){ @cmd_spy }
     end
 
     should "run a command for dumping a SQL schema using `dump_sql_schema`" do
       subject.dump_sql_schema
       assert_true @cmd_spy.run_called
     end
-
   end
 
   class CmdSpy
@@ -91,7 +81,8 @@ class Ardb::Adapter::Postgresql
       @run_called = true
     end
 
-    def success?; true; end
+    def success?
+      true
+    end
   end
-
 end