multi-database-9000 0.1.0

data/features/step_definitions/test_migration_steps.rb

@@ -0,0 +1,84 @@
+Given(/^A development database with a "([^"]*)" table with columns "([^"]*)", "([^"]*)" and "([^"]*)"$/) do |table, column1, column2, column3|
+  write_single_db_migration
+  run_task_in_single_db_app "bundle exec rake db:migrate"
+end
+
+When(/^I run a model test$/) do
+  test_file = <<-TEST_FILE_END
+    require 'test_helper'
+
+    class UserTest < ActiveSupport::TestCase
+      test "should save" do
+        user = User.new
+        assert user.save
+      end
+    end
+  TEST_FILE_END
+
+  write_file "../../single-db-dummy/test/models/user_test.rb", test_file
+
+  run_task_in_single_db_app "bundle exec rake test"
+end
+
+Then(/^I should see the created users table in the default test database$/) do
+  table_exists? :app => "single-db-dummy", :database => "test.sqlite3", :table => "users"
+end
+
+Then(/^I should see the correct columns in the users table in the default test database$/) do
+  columns_exist? app: "single-db-dummy", :database => "test.sqlite3", :table => "users", :columns => ["name", "email", "age"]
+end
+
+Given(/^A "([^"]*)" development database with a "([^"]*)" table with columns "([^"]*)", "([^"]*)" and "([^"]*)"$/) do |database, table, column1, column2, column3|
+  write_migration_for_default_db
+  write_migration_for_users_db
+  write_migration_for_widgets_db
+  run_task_in_multi_db_app "bundle exec rake db:migrate"
+end
+
+When(/^I run a model test in the multi\-database app$/) do
+  test_file = <<-TEST_FILE_END
+    require 'test_helper'
+
+    class GadgetTest < ActiveSupport::TestCase
+      test "should save" do
+        gadget = Gadget.new
+        assert gadget.save
+      end
+    end
+  TEST_FILE_END
+
+  write_file "../../multi-db-dummy/test/models/gadget_test.rb", test_file
+
+  run_task_in_multi_db_app "bundle exec rake test"
+end
+
+Then(/^I should see the created "([^"]*)" table in the "([^"]*)" test database$/) do |table, database|
+  if database == "default"
+    database_file = "test"
+  else
+    database_file = "#{database}_test"
+  end
+  table_exists? :app => "multi-db-dummy", :database => "#{database_file}.sqlite3", :table => table
+end
+
+
+# helpers
+
+def table_exists?(app:, database:, table:)
+  SQLite3::Database.new( "#{app}/db/#{database}" ) do |db|
+    table_query = db.execute( "SELECT name FROM sqlite_master WHERE type='table' AND name='#{table}'" )
+    expect(table_query[0][0]).to eq table
+  end
+end
+
+def columns_exist?(app:, database:, table:, columns:)
+  SQLite3::Database.new( "#{app}/db/#{database}" ) do |db|
+    users_columns = db.execute( "PRAGMA table_info(#{table})" )
+    column_names = users_columns.map do |column|
+      column[1]
+    end
+    columns.each do |test_column|
+      expect(column_names).to include test_column
+    end
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,2 @@
+require 'aruba/cucumber'
+ 

data/features/test_app.feature

@@ -0,0 +1,6 @@
+Feature: Testing the test app
+  Scenario: running rake in the test app
+    When I cd to "../../multi-db-dummy"
+    And I run `rake -T`
+    Then the exit status should be 0
+    And the output should match /rake db:create/

data/features/test_migrations.feature

@@ -0,0 +1,24 @@
+Feature: Running migrations and test preparation for all database in the app
+
+Background:
+  Given empty databases have been created for the app
+
+  Scenario: Test database is correctly set up in a single-database app
+    Given A development database with a "users" table with columns "name", "age" and "email"
+    When I run a model test
+    Then I should see the created users table in the default test database
+    And I should see the correct columns in the users table in the default test database
+
+  Scenario: Test database is correctly set up in a multi-database app
+    Given A "default" development database with a "posts" table with columns "title", "text" and "author"
+    And A "users" development database with a "accounts" table with columns "user_id", "expenses" and "total"
+    And A "widgets" development database with a "gadgets" table with columns "doobry", "wotsit" and "thingy"
+    When I run a model test in the multi-database app
+    Then I should see the created "posts" table in the "default" test database
+    Then I should see the created "accounts" table in the "users" test database
+    Then I should see the created "gadgets" table in the "widgets" test database
+    And I should see the "title", "text" and "author" columns in the "posts" table in the "default" database
+    And I should see the "expense", "user_id" and "total" columns in the "accounts" table in the "users" database
+    And I should see the "doobry", "wotsit" and "thingy" columns in the "gadgets" table in the "widgets" database
+
+

data/lib/multi-database-9000/multi-database-9000.rb

@@ -0,0 +1,12 @@
+module MultiDatabase9000
+  def self.maintain_all_test_schemas! # :nodoc:
+    # Roundrip to Rake to allow plugins to hook into database initialization.
+    FileUtils.cd Rails.root do
+      current_config = ActiveRecord::Base.connection_config
+      ActiveRecord::Base.clear_all_connections!
+      system("bin/rake db:test:prepare")
+      # Establish a new connection, the old database may be gone (db:test:prepare uses purge)
+      ActiveRecord::Base.establish_connection(current_config)
+    end
+  end
+end

data/lib/multi-database-9000/tasks/multi-database-9000_tasks.rake

@@ -0,0 +1,143 @@
+require 'pry'
+
+def database_connections(database: nil, rails_envs: nil)
+  connections = connections_for_environment(rails_envs)
+  if database.present?
+    connections.keep_if {|key, _| key.match Regexp.new(database)}
+  end
+  return connections
+end
+
+def connections_for_environment(rails_envs)
+  rails_envs = Array(rails_envs)
+  matcher = ->(key, value){rails_envs.any?{|env| key.match Regexp.new(env)}}
+  return ActiveRecord::Base.configurations.keep_if &matcher
+end
+
+def database_name(connection_key)
+  if connection_key.match /\w+_\w+/
+    return connection_key.split('_').first
+  else
+    return "default"
+  end
+end
+
+def migration_directory(connection_key)
+  if ['test','development','staging','cucumber','production'].include? connection_key
+    return "db/migrate/"
+  else
+    return "db/#{database_name(connection_key)}_migrate/"
+  end
+end
+
+def schema_file_name(connection_key)
+  if ['test','development','staging','cucumber','production'].include? connection_key
+    return "schema.rb"
+  else
+    return "#{database_name(connection_key)}_schema.rb"
+  end
+end
+
+Rake::Task['db:create'].clear
+Rake::Task['db:migrate'].clear
+Rake::Task['db:schema:dump'].clear
+Rake::Task['db:migrate:status'].clear
+
+Rake::Task["db:test:load_schema"].enhance do
+  begin
+    should_reconnect = ActiveRecord::Base.connection_pool.active_connection?
+    connections_for_environment("test").each do |connection_key, connection|
+      ActiveRecord::Tasks::DatabaseTasks.load_schema_for connection, :ruby, "db/#{schema_file_name(connection_key)}"
+    end
+  ensure
+    if should_reconnect
+      ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations[ActiveRecord::Tasks::DatabaseTasks.env])
+    end
+  end
+end
+
+Rake::Task["db:test:purge"].enhance do
+  connections_for_environment("test").values.each do |connection|
+    ActiveRecord::Tasks::DatabaseTasks.purge connection
+  end
+end
+
+db_namespace = namespace :db do
+  desc "Creates all databases from config/database.yml, or the database specified by DATABASE for the current RAILS_ENV"
+  task :create => [:load_config] do
+    if ENV["RAILS_ENV"] == "development" || ENV["RAILS_ENV"].nil?
+      rails_envs = ["development", "test"]
+    else
+      rails_envs = ENV["RAILS_ENV"]
+    end
+    database_connections(:database => ENV["DATABASE"], :rails_envs => rails_envs).values.each do |database_connection|
+      ActiveRecord::Tasks::DatabaseTasks.create database_connection
+    end
+  end
+
+  task :migrate => :environment do
+    rails_env = ENV["RAILS_ENV"] || "development"
+    database_connections(:database => ENV["DATABASE"], :rails_envs => rails_env).keys.each do |connection_key|
+      ActiveRecord::Base.establish_connection(connection_key)
+      ActiveRecord::Migrator.migrate(migration_directory(connection_key) , ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+    end
+    db_namespace['_dump'].invoke
+  end
+
+  namespace :migrate do
+    desc 'Display status of migrations'
+    task :status => [:environment] do
+      migrations_list = []
+
+      database_connections(:database => ENV["DATABASE"], :rails_envs => "development" || ENV["RAILS_ENV"]).keys.each do |connection_key|
+        ActiveRecord::Base.establish_connection(connection_key)
+
+        abort 'Schema migrations table does not exist yet.' unless ActiveRecord::SchemaMigration.table_exists?
+
+        db_list = ActiveRecord::SchemaMigration.normalized_versions
+
+        file_list =
+            Dir.foreach(migration_directory(connection_key)).grep(/^(\d{3,})_(.+)\.rb$/) do
+              version = ActiveRecord::SchemaMigration.normalize_migration_number($1)
+              status = db_list.delete(version) ? 'up' : 'down'
+              [status, version, database_name(connection_key), $2.humanize]
+            end
+
+        db_list.map! do |version|
+          ['up', version, database_name(connection_key), '********** NO FILE **********']
+        end
+
+        migrations_list += db_list + file_list
+      end
+
+      # output
+      puts "#{'Status'.center(8)}  #{'Migration ID'.ljust(14)}  #{'Database'.ljust(14)}  Migration Name"
+      puts "-" * 50
+      (migrations_list).sort_by { |_, version, _, _| version }.each do |status, version, database, name|
+        puts "#{status.center(8)}  #{version.ljust(14)}  #{database.ljust(14)}  #{name}"
+      end
+      puts
+    end
+  end
+
+  namespace :schema do
+    desc 'Create a db/schema.rb file for each database, that is portable against any DB supported by AR'
+    task :dump => [:environment] do
+      require 'active_record/schema_dumper'
+
+      if ENV["RAILS_ENV"] == "development" || ENV["RAILS_ENV"].nil?
+        rails_envs = ["development", "test"]
+      else
+        rails_envs = ENV["RAILS_ENV"]
+      end
+      database_connections(:database => ENV["DATABASE"], :rails_envs => rails_envs).keys.each do |connection_key|
+        ActiveRecord::Base.establish_connection(connection_key)
+        filename = ENV['SCHEMA'] || File.join(ActiveRecord::Tasks::DatabaseTasks.db_dir, schema_file_name(connection_key))
+        File.open(filename, "w:utf-8") do |file|
+          ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, file)
+        end
+      end
+      db_namespace['schema:dump'].reenable
+    end
+  end
+end

data/lib/multi-database-9000/version.rb

@@ -0,0 +1,3 @@
+module MultiDatabase9000
+  VERSION = "0.1.0"
+end

data/lib/multi-database-9000.rb

@@ -0,0 +1,10 @@
+require "multi-database-9000/version"
+require "multi-database-9000/multi-database-9000"
+
+module MultiDatabase9000
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "multi-database-9000/tasks/multi-database-9000_tasks.rake"
+    end
+  end
+end

data/multi-database-9000.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multi-database-9000/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "multi-database-9000"
+  spec.version       = MultiDatabase9000::VERSION
+  spec.authors       = ["Mark Weston", "Stefania Cardenas", "Colin Frankish"]
+  spec.email         = ["mark@markweston.me.uk"]
+  spec.summary       = %q{Enables Rails apps with multiple databases to handle migrations and rake tasks transparently}
+  spec.description   = %q{See README.md for details}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", ">= 3.0"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "aruba"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "pry"
+  spec.add_runtime_dependency "rails", ">= 4.0"
+end

data/multi-db-dummy/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.2.4'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+
+gem 'multi-database-9000', :path => ".."
+
+group :development, :test do
+  gem 'pry'
+end
+
+

data/multi-db-dummy/Gemfile.lock

@@ -0,0 +1,115 @@
+PATH
+  remote: ..
+  specs:
+    multi-database-9000 (0.0.1)
+      rails (>= 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.4)
+      actionpack (= 4.2.4)
+      actionview (= 4.2.4)
+      activejob (= 4.2.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.4)
+      actionview (= 4.2.4)
+      activesupport (= 4.2.4)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.4)
+      activesupport (= 4.2.4)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.4)
+      activesupport (= 4.2.4)
+      globalid (>= 0.3.0)
+    activemodel (4.2.4)
+      activesupport (= 4.2.4)
+      builder (~> 3.1)
+    activerecord (4.2.4)
+      activemodel (= 4.2.4)
+      activesupport (= 4.2.4)
+      arel (~> 6.0)
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    builder (3.2.2)
+    coderay (1.1.0)
+    erubis (2.7.0)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    method_source (0.8.2)
+    mime-types (2.6.2)
+    mini_portile (0.6.2)
+    minitest (5.8.1)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.4)
+      actionmailer (= 4.2.4)
+      actionpack (= 4.2.4)
+      actionview (= 4.2.4)
+      activejob (= 4.2.4)
+      activemodel (= 4.2.4)
+      activerecord (= 4.2.4)
+      activesupport (= 4.2.4)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.4)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    railties (4.2.4)
+      actionpack (= 4.2.4)
+      activesupport (= 4.2.4)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    slop (3.6.0)
+    sprockets (3.3.5)
+      rack (> 1, < 3)
+    sprockets-rails (2.3.3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    sqlite3 (1.3.10)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  multi-database-9000!
+  pry
+  rails (= 4.2.4)
+  sqlite3

data/multi-db-dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/multi-db-dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/multi-db-dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/multi-db-dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/multi-db-dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/multi-db-dummy/app/models/gadget.rb

@@ -0,0 +1,3 @@
+class Gadget < ActiveRecord::Base
+  establish_connection "widgets_#{Rails.env}".to_sym
+end

data/multi-db-dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>MultiDbDummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all' %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/multi-db-dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/multi-db-dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/multi-db-dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/multi-db-dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/multi-db-dummy/config/application.rb

@@ -0,0 +1,35 @@
+require File.expand_path('../boot', __FILE__)
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+require "active_job/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+# require "sprockets/railtie"
+require "rails/test_unit/railtie"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module MultiDbDummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end

data/multi-db-dummy/config/boot.rb

@@ -0,0 +1,3 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
+require 'bundler/setup' # Set up gems listed in the Gemfile.