multiverse 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 365e44dc02e354cb81a8d5e8962c51ec0873e208e35be402d24ce5826aee5a54
-  data.tar.gz: 262ca4346fcb9a9800cc5d8016860f64d9e88f0318cdde986626a09310a9a783
+  metadata.gz: 795bc91f0bfa9e597a580449331ac77509fdba477a0313b1c83e06b7f45d6ab0
+  data.tar.gz: 9d21f5ab4e0e6bcf1095e2d23d0f24cfd8e12ec8b7c4a2a2f0af04e5172f75b5
 SHA512:
-  metadata.gz: aa190b450724f9aa7d2c0fbe21618eb2fe8acb4169886129a018a1d20bf2e888884f33d604cff01c9d60c0599f6c33453a900eb2e81067a3d7788ea904183819
-  data.tar.gz: dde00c42005d41c515d0519719c7287d7bdd74fdbe66244167d772096928193a2d3cef51b057ba2af8695e00de8f98e6754784a1397ebb9448e0044c1e958738
+  metadata.gz: 90d731497ca6a7514321ee25ec50690b61132e514f1b7e26c38b7df6c4fc082a74ab9af662717e5c6e729ce11d19c74349856b92ffed0ab947f382ffea1a91e8
+  data.tar.gz: bc0bc7446fe753dcb4c64fabf3c557bab8aac44899283c713d33d17020e709c6eb87b2ef7606096821b73811d30eb0c85ca649eb36e1b51aaf4ea236048d751e

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.2
+
+- Raise error when DB specified not in `database.yml`
+
 ## 0.2.1
 
 - Added support for `config.paths["db"]`

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017 Andrew Kane
+Copyright (c) 2017-2019 Andrew Kane
 
 MIT License
 

data/README.md

@@ -2,7 +2,9 @@
 
 :fire: Multiple databases for Rails
 
-One of the easiest ways to scale your database is to move large, infrequently-joined tables to a separate database. **ActiveRecord supports multiple databases, but Rails doesn’t provide a way to manage them.** Multiverse changes this.
+**ActiveRecord supports multiple databases, but Rails < 6 doesn’t provide a way to manage them.** Multiverse changes this.
+
+Plus, it’s easy to [upgrade to Rails 6](#upgrading-to-rails-6) when you get there.
 
 Works with Rails 4.2+
 
@@ -71,6 +73,8 @@ end
 
 ## Web Servers
 
+*Only necessary in Rails < 5.2*
+
 For web servers that fork, be sure to reconnect after forking (just like you do with `ActiveRecord::Base`)
 
 ### Puma
@@ -99,7 +103,17 @@ CatalogRecord.establish_connection :"catalog_#{Rails.env}"
 
 ### Fixtures
 
-[Rails fixtures](http://guides.rubyonrails.org/testing.html#the-low-down-on-fixtures) work automatically.
+[Rails fixtures](https://guides.rubyonrails.org/testing.html#the-low-down-on-fixtures) work automatically.
+
+**Note:** Referential integrity is not disabled on additional databases when fixtures are loaded, so you may run into issues if you use foreign keys. Also, you may run into errors with fixtures if the additional databases aren’t the same type as the primary.
+
+### RSpec
+
+After running migrations for additional databases, run:
+
+```sh
+DB=catalog rails db:test:prepare
+```
 
 ### Database Cleaner
 
@@ -115,6 +129,89 @@ end
 
 [Read more here](https://github.com/DatabaseCleaner/database_cleaner#how-to-use-with-multiple-orms)
 
+## Limitations
+
+There are a few features that aren’t supported on additional databases.
+
+- Pending migration check
+- `schema_cache.yml`
+
+Also note that `ActiveRecord::Migration.maintain_test_schema!` doesn’t affect additional databases.
+
+## Upgrading to Rails 6
+
+Rails 6 provides a way to manage multiple databases :tada:
+
+To upgrade from Multiverse, nest your database configuration in `config/database.yml`:
+
+```yml
+# this should be similar to default, but with migrations_paths
+catalog_default: &catalog_default
+  adapter: ...
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  migrations_paths: db/catalog_migrate
+
+development:
+  primary:
+    <<: *default
+    database: ...
+  catalog:
+    <<: *catalog_default
+    database: ...
+
+test:
+  primary:
+    <<: *default
+    database: ...
+  catalog:
+    <<: *catalog_default
+    database: ...
+
+production:
+  primary:
+    <<: *default
+    database: ...
+  catalog:
+    <<: *catalog_default
+    database: ...
+```
+
+Then change `establish_connection` in `app/models/catalog_record.rb` to:
+
+```rb
+class CatalogRecord < ActiveRecord::Base
+  establish_connection :catalog
+end
+```
+
+And move:
+
+- `db/catalog/migrate` to `db/catalog_migrate`
+- `db/catalog/schema.rb` to `db/catalog_schema.rb` (or `db/catalog/structure.sql` to `db/catalog_structure.sql`).
+
+Then remove `multiverse` from your Gemfile. :tada:
+
+Now you can use the updated commands:
+
+```sh
+rails db:migrate          # run all
+rails db:migrate:catalog  # runs catalog only
+```
+
+Generate migrations with:
+
+```sh
+rails generate migration add_name_to_products --database=catalog
+```
+
+And models with:
+
+```sh
+rails generate model Product --database=catalog --parent=CatalogRecord
+```
+
+Happy scaling!
+
 ## History
 
 View the [changelog](https://github.com/ankane/multiverse/blob/master/CHANGELOG.md)

data/lib/multiverse/railtie.rb

@@ -36,7 +36,8 @@ module Multiverse
                   new_config[env.sub("#{Multiverse.db}_", "")] = config
                 end
               end
-              ActiveRecord::Tasks::DatabaseTasks.database_configuration.merge!(new_config)
+              abort "Unknown DB: #{Multiverse.db}" if new_config.empty?
+              ActiveRecord::Tasks::DatabaseTasks.database_configuration = new_config
             end
 
             # load config

data/lib/multiverse/version.rb

@@ -1,3 +1,3 @@
 module Multiverse
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multiverse
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-08-23 00:00:00.000000000 Z
+date: 2019-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -109,28 +109,23 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: 
-email:
-- andrew@chartkick.com
+email: andrew@chartkick.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/generators/multiverse/db_generator.rb
 - lib/generators/multiverse/templates/record.rb.tt
 - lib/multiverse.rb
 - lib/multiverse/generators.rb
 - lib/multiverse/railtie.rb
 - lib/multiverse/version.rb
-- multiverse.gemspec
 homepage: https://github.com/ankane/multiverse
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -140,15 +135,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Multiple databases for Rails

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.lock

data/.travis.yml

@@ -1,20 +0,0 @@
-language: ruby
-rvm: 2.5.1
-gemfile:
-  - Gemfile
-sudo: false
-before_install:
-  - gem install bundler
-  - unset RAILS_ENV
-  - unset RACK_ENV
-script: bundle exec rake test
-notifications:
-  email:
-    on_success: never
-    on_failure: change
-env:
-  - RAILS_VERSION=5.2.1
-  - RAILS_VERSION=5.2.1 API=t
-  - RAILS_VERSION=5.1.6
-  - RAILS_VERSION=5.0.7
-  - RAILS_VERSION=4.2.10

data/Gemfile

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in multiverse.gemspec
-gemspec

data/Rakefile

@@ -1,10 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-task :default => :test

data/multiverse.gemspec

@@ -1,30 +0,0 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "multiverse/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "multiverse"
-  spec.version       = Multiverse::VERSION
-  spec.authors       = ["Andrew Kane"]
-  spec.email         = ["andrew@chartkick.com"]
-
-  spec.summary       = "Multiple databases for Rails"
-  spec.homepage      = "https://github.com/ankane/multiverse"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "activesupport", ">= 4.2"
-  spec.add_dependency "activerecord", ">= 4.2"
-  spec.add_dependency "railties", ">= 4.2"
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "sqlite3"
-end