ardb 0.0.1 → 0.1.0

data/lib/ardb/runner/create_command.rb

@@ -0,0 +1,21 @@
+require 'active_record'
+require 'ardb/runner'
+
+class Ardb::Runner::CreateCommand
+
+  def initialize
+    @adapter = Ardb::Adapter.send(Ardb.config.db.adapter)
+  end
+
+  def run
+    begin
+      @adapter.create_db
+      $stdout.puts "created #{Ardb.config.db.adapter} db `#{Ardb.config.db.database}`"
+    rescue Ardb::Runner::CmdError => e
+      raise e
+    rescue Exception => e
+      raise Ardb::Runner::CmdFail
+    end
+  end
+
+end

data/lib/ardb/runner/drop_command.rb

@@ -0,0 +1,21 @@
+require 'active_record'
+require 'ardb/runner'
+
+class Ardb::Runner::DropCommand
+
+  def initialize
+    @adapter = Ardb::Adapter.send(Ardb.config.db.adapter)
+  end
+
+  def run
+    begin
+      @adapter.drop_db
+      $stdout.puts "dropped #{Ardb.config.db.adapter} db `#{Ardb.config.db.database}`"
+    rescue Ardb::Runner::CmdError => e
+      raise e
+    rescue Exception => e
+      raise Ardb::Runner::CmdFail
+    end
+  end
+
+end

data/lib/ardb/runner/generate_command.rb

@@ -0,0 +1,64 @@
+require 'fileutils'
+require 'active_support/core_ext/string'
+require 'ardb/runner'
+
+class Ardb::Runner::GenerateCommand
+
+  def initialize(args)
+    @item = args.shift
+    @args = args
+  end
+
+  def run
+    if @item.nil?
+      raise Ardb::Runner::CmdError, "specify an item to generate"
+    end
+    if !self.respond_to?("#{@item}_cmd")
+      raise Ardb::Runner::CmdError, "can't generate #{@item}"
+    end
+
+    begin
+      self.send("#{@item}_cmd")
+    rescue Ardb::Runner::CmdError => e
+      raise e
+    rescue Exception => e
+      $stderr.puts e, *(e.backtrace)
+      $stderr.puts "error generating #{@item}."
+      raise Ardb::Runner::CmdFail
+    end
+  end
+
+  def migration_cmd
+    MigrationCommand.new(@args.first).run
+  end
+
+  class MigrationCommand
+    attr_reader :identifier, :class_name, :file_name, :template
+
+    def initialize(identifier)
+      if identifier.nil?
+        raise Ardb::Runner::CmdError, "specify a name for the migration"
+      end
+
+      @identifier = identifier
+      @class_name = @identifier.classify.pluralize
+      @file_name  = begin
+        "#{Time.now.strftime("%Y%m%d%H%M%S")}_#{@identifier.underscore}"
+      end
+      @template = "require 'ardb/migration_helpers'\n\n"\
+                  "class #{@class_name} < ActiveRecord::Migration\n"\
+                  "  include Ardb::MigrationHelpers\n\n"\
+                  "  def change\n"\
+                  "  end\n\n"\
+                  "end\n"
+    end
+
+    def run
+      FileUtils.mkdir_p Ardb.config.migrations_path
+      file_path = File.join(Ardb.config.migrations_path, "#{@file_name}.rb")
+      File.open(file_path, "w"){ |f| f.write(@template) }
+      $stdout.puts file_path
+    end
+  end
+
+end

data/lib/ardb/runner/migrate_command.rb

@@ -0,0 +1,48 @@
+require 'fileutils'
+require 'active_record'
+require 'ardb/runner'
+require 'ardb/migration_helpers'
+
+class Ardb::Runner::MigrateCommand
+
+  attr_reader :migrations_path, :schema_file_path, :version, :verbose
+
+  def initialize
+    @migrations_path = Ardb.config.migrations_path
+    @schema_file_path = Ardb.config.schema_path
+    @version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
+    @verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
+  end
+
+  def run
+    begin
+      Ardb.init
+      migrate_the_db
+    rescue Ardb::Runner::CmdError => e
+      raise e
+    rescue Exception => e
+      $stderr.puts e, *(e.backtrace)
+      $stderr.puts "error migrating #{Ardb.config.db.database.inspect} database"
+      raise Ardb::Runner::CmdFail
+    end
+  end
+
+  def migrate_the_db
+    if defined?(ActiveRecord::Migration::CommandRecorder)
+      ActiveRecord::Migration::CommandRecorder.send(:include, Ardb::MigrationHelpers::RecorderMixin)
+    end
+
+    ActiveRecord::Migrator.migrations_path = @migrations_path
+    ActiveRecord::Migration.verbose = @verbose
+    ActiveRecord::Migrator.migrate(@migrations_path, @version) do |migration|
+      ENV["SCOPE"].blank? || (ENV["SCOPE"] == migration.scope)
+    end
+
+    require 'active_record/schema_dumper'
+    FileUtils.mkdir_p File.dirname(@schema_file_path)
+    File.open(@schema_file_path, "w:utf-8") do |file|
+      ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, file)
+    end
+  end
+
+end

data/lib/ardb/test_helpers.rb

@@ -0,0 +1,24 @@
+require 'active_record'
+require 'ardb'
+
+# Use theses helpers in your test suite.  They all generally assume Ardb has
+# already been initialized by calling `Ardb.init`.
+
+module Ardb; end
+module Ardb::TestHelpers
+  module_function
+
+  def drop_tables
+    Ardb.adapter.drop_tables
+  end
+
+  def load_schema
+    # silence STDOUT
+    current_stdout = $stdout.dup
+    $stdout = File.new('/dev/null', 'w')
+    load Ardb.config.schema_path
+    $stdout = current_stdout
+  end
+
+end
+

data/lib/ardb/version.rb

@@ -1,3 +1,3 @@
 module Ardb
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/test/helper.rb

@@ -2,7 +2,23 @@
 # put any test helpers here
 
 # add the root dir to the load path
-$LOAD_PATH.unshift(File.expand_path("../..", __FILE__))
+ROOT_PATH = File.expand_path("../..", __FILE__)
+$LOAD_PATH.unshift(ROOT_PATH)
 
 # require pry for debugging (`binding.pry`)
 require 'pry'
+
+require 'fileutils'
+TESTDB_PATH = File.join(ROOT_PATH, 'tmp', 'testdb')
+FileUtils.mkdir_p TESTDB_PATH
+
+require 'logger'
+require 'ardb'
+Ardb.configure do |c|
+  c.root_path = TESTDB_PATH
+  c.logger = Logger.new($stdout)
+
+  c.db.adapter  'postgresql'
+  c.db.database 'ardbtest'
+
+end

data/test/unit/adapter/base_tests.rb

@@ -0,0 +1,41 @@
+require 'assert'
+require 'ardb/adapter/base'
+
+class Ardb::Adapter::Base
+
+  class BaseTests < Assert::Context
+    desc "Ardb::Adapter::Base"
+    setup do
+      @adapter = Ardb::Adapter::Base.new
+    end
+    subject { @adapter }
+
+    should have_reader :config_settings, :database
+    should have_imeths :foreign_key_add_sql, :foreign_key_drop_sql
+    should have_imeths :create_db, :drop_db
+
+    should "use the config's db settings " do
+      assert_equal Ardb.config.db.to_hash, subject.config_settings
+    end
+
+    should "use the config's database" do
+      assert_equal Ardb.config.db.database, subject.database
+    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 }
+    end
+
+    should "not implement the drop table methods" do
+      assert_raises(NotImplementedError) { subject.drop_tables }
+    end
+
+  end
+
+end

data/test/unit/adapter/mysql_tests.rb

@@ -0,0 +1,40 @@
+require 'assert'
+require 'ardb/adapter/mysql'
+
+class Ardb::Adapter::Mysql
+
+  class BaseTests < Assert::Context
+    desc "Ardb::Adapter::Mysql"
+    setup do
+      @adapter = Ardb::Adapter::Mysql.new
+    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 }
+      assert_raises(NotImplementedError) { subject.drop_db }
+    end
+
+    # not currently implemented, see: https://github.com/redding/ardb/issues/28
+    should "not implement the drop tables method" do
+      assert_raises(NotImplementedError) { subject.drop_tables }
+    end
+
+  end
+
+end

data/test/unit/adapter/postgresql_tests.rb

@@ -0,0 +1,39 @@
+require 'assert'
+require 'ardb/adapter/postgresql'
+
+class Ardb::Adapter::Postgresql
+
+  class BaseTests < Assert::Context
+    desc "Ardb::Adapter::Postgresql"
+    setup do
+      @adapter = Ardb::Adapter::Postgresql.new
+    end
+    subject { @adapter }
+
+    should have_instance_method :public_schema_settings
+
+    should "know it's public schema connection settings" do
+      exp_settings = subject.config_settings.merge({
+        :database => 'postgres',
+        :schema_search_path => 'public'
+      })
+      assert_equal exp_settings, subject.public_schema_settings
+    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
+    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
+
+end

data/test/unit/adapter/sqlite_tests.rb

@@ -0,0 +1,39 @@
+require 'assert'
+require 'ardb/adapter/sqlite'
+
+class Ardb::Adapter::Sqlite
+
+  class BaseTests < Assert::Context
+    desc "Ardb::Adapter::Sqlite"
+    setup do
+      @adapter = Ardb::Adapter::Sqlite.new
+    end
+    subject { @adapter }
+
+    should have_imeths :db_file_path, :validate!
+
+    should "complain if the db file already exists" do
+      FileUtils.mkdir_p(File.dirname(subject.db_file_path))
+      FileUtils.touch(subject.db_file_path)
+      assert_raises(Ardb::Runner::CmdError) { subject.validate! }
+      FileUtils.rm(subject.db_file_path)
+    end
+
+    should "know its db_file_path" do
+      exp_path = Ardb.config.root_path.join(Ardb.config.db.database).to_s
+      assert_equal exp_path, subject.db_file_path
+    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
+
+    # not currently implemented, see: https://github.com/redding/ardb/issues/29
+    should "not implement the drop tables method" do
+      assert_raises(NotImplementedError) { subject.drop_tables }
+    end
+
+  end
+
+end

data/test/unit/ardb_tests.rb

@@ -0,0 +1,55 @@
+require 'assert'
+require 'ardb'
+
+module Ardb
+
+  class BaseTests < Assert::Context
+    desc "Ardb"
+    subject{ Ardb }
+    setup do
+      @orig_ar_logger = ActiveRecord::Base.logger
+    end
+    teardown do
+      Adapter.reset
+      ActiveRecord::Base.logger = @orig_ar_logger
+    end
+
+    should have_imeths :config, :configure, :adapter, :validate!, :init
+
+    should "return its `Config` class with the `config` method" do
+      assert_same Config, subject.config
+    end
+
+    should "complain if init'ing and not all configs are set" do
+      orig_adapter = Ardb.config.db.adapter
+      Ardb.config.db.adapter = nil
+      assert_raises(NotConfiguredError) { subject.init }
+      Ardb.config.db.adapter = orig_adapter
+    end
+
+    should "init the adapter on init" do
+      assert_nil Adapter.current
+      begin
+        subject.init
+      rescue LoadError
+      end
+
+      assert_not_nil Adapter.current
+      exp_adapter = Adapter.send(subject.config.db.adapter)
+      assert_equal exp_adapter, Adapter.current
+      assert_same Adapter.current, subject.adapter
+    end
+
+    should "establish an AR connection on init" do
+      assert_raises(LoadError) do
+        # not going to test this b/c I don't want to bring in all the crap it
+        # takes to actually establish a connection with AR (adapters, etc)
+        # plus, most of this should be handled by AR, ns-options, and the above
+        # tests anyway
+        subject.init
+      end
+    end
+
+  end
+
+end

data/test/unit/config_tests.rb

@@ -0,0 +1,42 @@
+require 'assert'
+require 'ns-options/assert_macros'
+require 'ardb'
+
+class Ardb::Config
+
+  class BaseTests < Assert::Context
+    include NsOptions::AssertMacros
+    desc "Ardb::Config"
+    subject{ Ardb::Config }
+
+    should have_namespace :db
+    should have_option  :root_path, Pathname, :required => true
+    should have_option  :logger, :required => true
+    should have_options :migrations_path, :schema_path
+
+    should "should use `db/migrations` as the default migrations path" do
+      exp_path = Pathname.new(TESTDB_PATH).join("db/migrations").to_s
+      assert_equal exp_path, subject.migrations_path
+    end
+
+    should "should use `db/schema.rb` as the default schema path" do
+      exp_path = Pathname.new(TESTDB_PATH).join("db/schema.rb").to_s
+      assert_equal exp_path, subject.schema_path
+    end
+
+  end
+
+  class DbTests < BaseTests
+    desc "db namespace"
+    subject{ Ardb::Config.db }
+
+    should have_option :adapter,  String, :required => true
+    should have_option :database, String, :required => true
+    should have_option :encoding, String, :required => false
+    should have_option :url,      String, :required => false
+    should have_option :username, String, :required => false
+    should have_option :password, String, :required => false
+
+  end
+
+end