secondbase 0.6.0 → 1.0.0

data/lib/second_base/forced.rb

@@ -0,0 +1,21 @@
+module SecondBase
+  module Forced
+
+    def connection_pool
+      SecondBase::Base.connection_pool
+    end
+
+    def retrieve_connection
+      SecondBase::Base.retrieve_connection
+    end
+
+    def connected?
+      SecondBase::Base.connected?
+    end
+
+    def remove_connection(klass = self)
+      SecondBase::Base.remove_connection
+    end
+
+  end
+end

data/lib/second_base/on_base.rb

@@ -0,0 +1,36 @@
+module SecondBase
+
+  mattr_accessor :is_on_base, instance_accessor: false
+  self.is_on_base = false
+
+  def self.on_base
+    already_on_base = is_on_base
+    if already_on_base
+      yield
+      return
+    end
+    original_config = ActiveRecord::Tasks::DatabaseTasks.current_config
+    original_configurations = ActiveRecord::Base.configurations
+    original_migrations_path = ActiveRecord::Tasks::DatabaseTasks.migrations_paths
+    original_db_dir = ActiveRecord::Tasks::DatabaseTasks.db_dir
+    ActiveRecord::Tasks::DatabaseTasks.current_config = config
+    ActiveRecord::Base.configurations = original_configurations[Railtie.config_key]
+    ActiveRecord::Base.establish_connection(config)
+    ActiveRecord::Tasks::DatabaseTasks.migrations_paths = SecondBase::Railtie.fullpath('migrate')
+    ActiveRecord::Tasks::DatabaseTasks.db_dir = SecondBase::Railtie.fullpath
+    ActiveRecord::Migrator.migrations_paths = ActiveRecord::Tasks::DatabaseTasks.migrations_paths
+    self.is_on_base = true
+    yield
+  ensure
+    unless already_on_base
+      ActiveRecord::Base.configurations = original_configurations
+      ActiveRecord::Tasks::DatabaseTasks.migrations_paths = original_migrations_path
+      ActiveRecord::Tasks::DatabaseTasks.db_dir = original_db_dir
+      ActiveRecord::Migrator.migrations_paths = ActiveRecord::Tasks::DatabaseTasks.migrations_paths
+      ActiveRecord::Tasks::DatabaseTasks.current_config = original_config
+      ActiveRecord::Base.establish_connection(original_config)
+      self.is_on_base = false
+    end
+  end
+
+end

data/lib/second_base/railtie.rb

@@ -0,0 +1,40 @@
+module SecondBase
+  class Railtie < Rails::Railtie
+
+    config.second_base = ActiveSupport::OrderedOptions.new
+    config.second_base.path = 'db/secondbase'
+    config.second_base.config_key = 'secondbase'
+
+    config.after_initialize do |app|
+      secondbase_dir = app.root.join(config.second_base.path)
+      FileUtils.mkdir(secondbase_dir) unless File.directory?(secondbase_dir)
+    end
+
+    rake_tasks do
+      load 'second_base/databases.rake'
+    end
+
+    generators do
+      require 'rails/second_base/generators/migration_generator'
+    end
+
+    initializer 'second_base.add_watchable_files' do |app|
+      secondbase_dir = app.root.join(config.second_base.path)
+      config.watchable_files.concat ["#{secondbase_dir}/schema.rb", "#{secondbase_dir}/structure.sql"]
+    end
+
+    def config_path
+      config.second_base.path
+    end
+
+    def config_key
+      config.second_base.config_key
+    end
+
+    def fullpath(extra=nil)
+      path = Rails.root.join(config.second_base.path)
+      (extra ? path.join(path, extra) : path).to_s
+    end
+
+  end
+end

data/lib/second_base/test_help.rb

@@ -0,0 +1,11 @@
+if defined?(ActiveRecord::Base)
+
+  # Support test schema sync for Rails 4.2.x and up.
+  if ActiveRecord::Migration.respond_to? :maintain_test_schema!
+    SecondBase.on_base do
+      ActiveRecord::Migration.maintain_test_schema!
+    end
+  end
+
+
+end

data/lib/second_base/version.rb

@@ -0,0 +1,3 @@
+module SecondBase
+  VERSION = File.read(File.expand_path("../../../VERSION", __FILE__)).chomp
+end

data/lib/secondbase.rb

@@ -1,46 +1 @@
-require 'active_record'
-require 'secondbase/active_record/patches'
-
-module SecondBase
-  CONNECTION_PREFIX = 'secondbase'
-  
-  require 'secondbase/railtie'
-  require 'secondbase/rake_method_chain'
-  
-  def self.do
-    "You have just gotten to SecondBase, my friend."
-  end
-  
-  def self.has_runner(env)
-    ActiveRecord::Base.establish_connection(SecondBase::config(env))
-    reset_visitor_cache
-  end
-
-  def self.config(env)
-    ActiveRecord::Base.configurations[SecondBase::CONNECTION_PREFIX][env]
-  end
-
-  # TODO: We should really look at faking out the connection used by ActiveRecord
-  # during migrations, this would prevent us from digging around Arel internals.
-  # Arel caches the SQL translator based on the engine (ActiveRecord::Base).  This 
-  # means that if we swap out the base connection we risk the SQL translator being wrong.
-  # This is an ugly hack that resets the adapter.  See Line 27 of Arel's visitors.rb class.
-  def self.reset_visitor_cache
-    if Rails.version.to_i >= 3
-      engine = ActiveRecord::Base
-      adapter = engine.connection_pool.spec.config[:adapter]
-      Arel::Visitors::ENGINE_VISITORS[engine] = (Arel::Visitors::VISITORS[adapter] || Arel::Visitors::ToSql).new(engine)
-    end
-  end
-end
-
-module FirstBase
-  def self.config(env)
-    ActiveRecord::Base.configurations[env]
-  end
-  
-  def self.has_runner(env)
-    ActiveRecord::Base.establish_connection(FirstBase::config(env))
-    SecondBase.reset_visitor_cache
-  end
-end
+require 'second_base'

data/secondbase.gemspec

@@ -1,78 +1,28 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'second_base/version'
 
 Gem::Specification.new do |s|
-  s.name = %q{secondbase}
-  s.version = "0.6.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["karledurante"]
-  s.date = %q{2012-08-31}
-  s.description = %q{Secondbase provides support to Rails to create a homogeneous environment for a dual database project.  Using the rake tasks already familiar to you, this gem enables Rails to work with two primary databases, instead of just one.}
-  s.email = %q{kdurante@customink.com}
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-    "CHANGELOG.md",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "lib/generators/secondbase/USAGE",
-    "lib/generators/secondbase/migration_generator.rb",
-    "lib/generators/secondbase/templates/migration.rb",
-    "lib/secondbase.rb",
-    "lib/secondbase/active_record/associations/has_and_belongs_to_many_association.rb",
-    "lib/secondbase/active_record/base.rb",
-    "lib/secondbase/active_record/fixtures.rb",
-    "lib/secondbase/active_record/patches.rb",
-    "lib/secondbase/active_record/test_fixtures.rb",
-    "lib/secondbase/model.rb",
-    "lib/secondbase/railtie.rb",
-    "lib/secondbase/rake_method_chain.rb",
-    "lib/secondbase/tasks.rb",
-    "rails_generators/secondbase/USAGE",
-    "rails_generators/secondbase/secondbase_migration_generator.rb",
-    "rails_generators/secondbase/templates/migration.rb",
-    "secondbase.gemspec",
-    "test/helper.rb",
-    "test/test_secondbase.rb"
-  ]
-  s.homepage = %q{http://github.com/karledurante/secondbase}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.4.2}
-  s.summary = %q{Allow Rails manage second database in your projects}
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8.2"])
-      s.add_development_dependency(%q<activerecord>, ["~> 3.0.0"])
-      s.add_development_dependency(%q<activerecord>, ["~> 3.0.0"])
-    else
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, [">= 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8.2"])
-      s.add_dependency(%q<activerecord>, ["~> 3.0.0"])
-      s.add_dependency(%q<activerecord>, ["~> 3.0.0"])
-    end
-  else
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, [">= 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8.2"])
-    s.add_dependency(%q<activerecord>, ["~> 3.0.0"])
-    s.add_dependency(%q<activerecord>, ["~> 3.0.0"])
-  end
+  s.name          = 'secondbase'
+  s.version       = SecondBase::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = ['Karle Durante', 'Hunter Madison', 'Ken Collins']
+  s.email         = ['kdurante@customink.com', 'hunterglenmadison@icloud.com', 'ken@metaskills.net']
+  s.homepage      = 'http://github.com/customink/secondbase'
+  s.summary       = 'Seamless second database integration for Rails.'
+  s.description   = "SecondBase provides support for Rails to manage dual databases by focusing on ActiveRecord tasks that create, migrate, and test your databases."
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+  s.rdoc_options  = ['--charset=UTF-8']
+  s.license       = 'MIT'
+  s.add_runtime_dependency     'rails', '~> 4.0'
+  s.add_development_dependency 'appraisal'
+  s.add_development_dependency 'guard'
+  s.add_development_dependency 'guard-minitest'
+  s.add_development_dependency 'mysql'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'yard'
 end
-

data/test/cases/dbtask_test.rb

@@ -0,0 +1,225 @@
+require 'test_helper'
+
+class DbTaskTest < SecondBase::TestCase
+
+  def test_db_create
+    refute_dummy_databases
+    run_db :create
+    assert_dummy_databases
+  end
+
+  def test_db_create_all
+    refute_dummy_databases
+    run_db 'create:all'
+    assert_dummy_databases
+  end
+
+  def test_db_setup
+    run_db :create
+    run_db :migrate
+    assert_dummy_databases
+    run_db :drop
+    refute_dummy_databases
+    run_db :setup
+    assert_dummy_databases
+  end
+
+  def test_db_drop
+    run_db :create
+    run_db :drop
+    refute_dummy_databases
+  end
+
+  def test_db_drop_all
+    run_db :create
+    run_db 'drop:all'
+    refute_dummy_databases
+  end
+
+  def test_db_purge_all
+    skip 'Rails 4.2 & Up' unless rails_42_up?
+    run_db :create
+    run_db :migrate
+    assert_dummy_databases
+    run_db 'purge:all'
+    establish_connection
+    assert_equal [], ActiveRecord::Base.connection.tables
+    assert_equal [], SecondBase::Base.connection.tables
+  end
+
+  def test_db_purge
+    skip 'Rails 4.2 & Up' unless rails_42_up?
+    run_db :create
+    run_db :migrate
+    assert_dummy_databases
+    run_db :purge
+    establish_connection
+    assert_equal [], ActiveRecord::Base.connection.tables
+    assert_equal [], SecondBase::Base.connection.tables
+  end
+
+  def test_db_migrate
+    run_db :create
+    run_db :migrate
+    # First database and schema.
+    schema = File.read(dummy_schema)
+    assert_match %r{version: 20141214142700}, schema
+    assert_match %r{create_table "users"}, schema
+    assert_match %r{create_table "posts"}, schema
+    refute_match %r{create_table "comments"}, schema
+    assert_connection_tables ActiveRecord::Base, ['users', 'posts']
+    # Second database and schema.
+    secondbase_schema = File.read(dummy_secondbase_schema)
+    assert_match %r{version: 20151202075826}, secondbase_schema
+    refute_match %r{create_table "users"}, secondbase_schema
+    refute_match %r{create_table "posts"}, secondbase_schema
+    assert_match %r{create_table "comments"}, secondbase_schema
+    assert_connection_tables SecondBase::Base, ['comments']
+  end
+
+  def test_secondbase_migrate_updown
+    run_db :create
+    run_db :migrate
+    assert_match /no migration.*20151202075826/i, run_db('migrate:down VERSION=20151202075826', :stderr)
+    run_secondbase 'migrate:down VERSION=20151202075826'
+    secondbase_schema = File.read(dummy_secondbase_schema)
+    refute_match %r{version: 20151202075826}, secondbase_schema
+    refute_match %r{create_table "comments"}, secondbase_schema
+    assert_match /no migration.*20151202075826/i, run_db('migrate:up VERSION=20151202075826', :stderr)
+    run_secondbase 'migrate:up VERSION=20151202075826'
+    secondbase_schema = File.read(dummy_secondbase_schema)
+    assert_match %r{version: 20151202075826}, secondbase_schema
+    assert_match %r{create_table "comments"}, secondbase_schema
+  end
+
+  def test_secondbase_migrate_reset
+    run_db :create
+    run_db :migrate
+    secondbase_schema = File.read(dummy_secondbase_schema)
+    assert_match %r{version: 20151202075826}, secondbase_schema
+    assert_match %r{create_table "comments"}, secondbase_schema
+    FileUtils.rm_rf dummy_secondbase_schema
+    run_secondbase 'migrate:reset'
+    secondbase_schema = File.read(dummy_secondbase_schema)
+    assert_match %r{version: 20151202075826}, secondbase_schema
+    assert_match %r{create_table "comments"}, secondbase_schema
+  end
+
+  def test_secondbase_migrate_redo
+    run_db :create
+    run_db :migrate
+    secondbase_schema = File.read(dummy_secondbase_schema)
+    assert_match %r{version: 20151202075826}, secondbase_schema
+    assert_match %r{create_table "comments"}, secondbase_schema
+    FileUtils.rm_rf dummy_secondbase_schema
+    run_secondbase 'migrate:redo'
+    secondbase_schema = File.read(dummy_secondbase_schema)
+    assert_match %r{version: 20151202075826}, secondbase_schema
+    assert_match %r{create_table "comments"}, secondbase_schema
+    # Can redo latest SecondBase migration using previous VERSION env.
+    version = dummy_migration[:version]
+    run_db :migrate
+    assert_match %r{version: #{version}}, File.read(dummy_secondbase_schema)
+    establish_connection
+    Comment.create! body: 'test', user_id: 420
+    run_secondbase 'migrate:redo VERSION=20151202075826'
+    secondbase_schema = File.read(dummy_secondbase_schema)
+    assert_match %r{version: #{version}}, secondbase_schema
+    assert_match %r{create_table "comments"}, secondbase_schema
+    establish_connection
+    assert_nil Comment.first
+  end
+
+  def test_secondbase_migrate_status
+    run_db :create
+    stream = rails_42_up? ? :stderr : :stdout
+    assert_match %r{migrations table does not exist}, run_secondbase('migrate:status', stream)
+    run_db :migrate
+    assert_match %r{up.*20151202075826}, run_secondbase('migrate:status')
+    version = dummy_migration[:version]
+    status = run_secondbase('migrate:status')
+    assert_match %r{up.*20151202075826}, status
+    assert_match %r{down.*#{version}}, status
+  end
+
+  def test_secondbase_forward_and_rollback
+    run_db :create
+    run_db :migrate
+    secondbase_schema = File.read(dummy_secondbase_schema)
+    assert_match %r{version: 20151202075826}, secondbase_schema
+    refute_match %r{create_table "foos"}, secondbase_schema
+    version = dummy_migration[:version] # ActiveRecord does not support start index 0.
+    run_secondbase :forward
+    secondbase_schema = File.read(dummy_secondbase_schema)
+    assert_match %r{version: #{version}}, secondbase_schema
+    assert_match %r{create_table "foos"}, secondbase_schema
+    run_secondbase :rollback
+    secondbase_schema = File.read(dummy_secondbase_schema)
+    assert_match %r{version: 20151202075826}, secondbase_schema
+    refute_match %r{create_table "foos"}, secondbase_schema
+  end
+
+  def test_db_test_purge
+    run_db :create
+    assert_dummy_databases
+    run_db 'test:purge'
+    establish_connection
+    assert_equal [], ActiveRecord::Base.connection.tables
+    assert_equal [], SecondBase::Base.connection.tables
+  end
+
+  def test_db_test_load_schema
+    run_db :create
+    assert_dummy_databases
+    run_db 'test:purge'
+    run_db :migrate
+    Dir.chdir(dummy_root) { `rake db:test:load_schema` }
+    establish_connection
+    assert_connection_tables ActiveRecord::Base, ['users', 'posts']
+    assert_connection_tables SecondBase::Base, ['comments']
+  end
+
+  def test_abort_if_pending
+    run_db :create
+    run_db :migrate
+    assert_equal "", run_db(:abort_if_pending_migrations, :stderr)
+    version = dummy_migration[:version]
+    capture(:stderr) do
+      stdout = run_db :abort_if_pending_migrations
+      assert_match /1 pending migration/, stdout
+      assert_match /#{version}/, stdout
+    end
+  end
+
+  def test_db_test_load_structure
+    run_db :create
+    assert_dummy_databases
+    run_db 'test:purge'
+    Dir.chdir(dummy_root) { `env SCHEMA_FORMAT=sql rake db:migrate` }
+    Dir.chdir(dummy_root) { `rake db:test:load_structure` }
+    establish_connection
+    assert_connection_tables ActiveRecord::Base, ['users', 'posts']
+    assert_connection_tables SecondBase::Base, ['comments']
+  end
+
+  def test_secondbase_version
+    run_db :create
+    assert_match /version: 0/, run_secondbase(:version)
+    run_db :migrate
+    assert_match /version: 20141214142700/, run_db(:version)
+    assert_match /version: 20151202075826/, run_secondbase(:version)
+  end
+
+
+  private
+
+  def assert_connection_tables(model, expected_tables)
+    establish_connection
+    tables = model.connection.tables
+    expected_tables.each do |table|
+      message = "Expected #{model.name} tables #{tables.inspect} to include #{table.inspect}"
+      assert tables.include?(table), message
+    end
+  end
+
+end