secondbase 0.6.0 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8690f339e1891e3267b5ffee18a8f13033d42a8
+  data.tar.gz: 6055c37a690ddb03905c4eb59ebeac874f1cf0d1
+SHA512:
+  metadata.gz: 4c3bc5947e3dd04c8ac368a274ca88a35c8a27940fb19f33ae7567c3c521cd040d8f6c4e94064879e867564d0cf3e350f36f00d1bbce6207108d631e745c0549
+  data.tar.gz: b9623cbadc8d55f518cd3e57d783b748c92b3bfac11b97c9fc7cf323df9faf824218aced9aac922d751db218557781a31a4adb70156ef7b9baa06540f5c41a56

data/.gitignore

@@ -0,0 +1,9 @@
+doc/
+yard/
+.yardoc/
+vendor/
+pkg/
+.bundle/
+Gemfile.lock
+*.gemfile.lock
+*.log

data/.travis.yml

@@ -0,0 +1,16 @@
+sudo: false
+cache: bundler
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2.3
+gemfile:
+  - gemfiles/rails40.gemfile
+  - gemfiles/rails41.gemfile
+  - gemfiles/rails42.gemfile
+install:
+  - gem install bundler
+  - bundle --version
+  - bundle install
+script:
+  - bundle exec rake test

data/.yardopts

@@ -0,0 +1 @@
+--exclude test/**/*.rb

data/Appraisals

@@ -0,0 +1,12 @@
+
+appraise 'rails40' do
+  gem 'rails', '~> 4.0.0'
+end
+
+appraise 'rails41' do
+  gem 'rails', '~> 4.1.0'
+end
+
+appraise 'rails42' do
+  gem 'rails', '~> 4.2.0'
+end

data/CHANGELOG.md

@@ -1,8 +1,20 @@
-# CHANGELOG
 
-## 0.6
+# Change Log
 
- * This version of the gem ONLY SUPPORTS Rails 3.x.  For 2.x support, check out the branch 'rails_2_3' (or version .5 of the gem)
- * patched has_and_belongs_to_many associations, for secondbase models, so that ActiveRecord understands that the join table is in the secondbase.
- * patched ActiveRecord::TestFixtures so that transactional fixture support is respected for the SecondBase.
- * reorganized monkey patches to make it easier to work in fixes for different versions of rails.
+Please follow the format set down in http://keepachangelog.com
+
+
+## v1.0
+
+Initial re-write supporting Rails 4.x. Please see README.md for full details.
+
+
+## v0.6
+
+Support for Rails 3.x. For 2.x support, check out the branch `rails_2_3` or version v0.5 of the gem.
+
+#### Fixed
+
+ * The `has_and_belongs_to_many` associations, for SecondBase models.
+ * Patched `ActiveRecord::TestFixtures` so that transactional fixture support is respected for the SecondBase.
+ * Reorganized monkey patches to make it easier to work in fixes for different versions of Rails.

data/Gemfile

@@ -1,13 +1,4 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
+source "https://rubygems.org"
+gemspec
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "shoulda", ">= 0"
-  gem "bundler", ">= 1.0.0"
-  gem "jeweler", "~> 1.8.2"
-  gem "activerecord", "~> 3.0.0"
-end
+gem 'terminal-notifier-guard' if RUBY_PLATFORM =~ /darwin/

data/Guardfile

@@ -0,0 +1,16 @@
+clearing :on
+notification :terminal_notifier if defined?(TerminalNotifier)
+ignore!([
+  /test\/dummy_app/,
+  /byebug/
+])
+
+guard :minitest, {
+  all_on_start: true,
+  autorun: false,
+  include: ['lib', 'test'],
+  test_folders: ['test'],
+  test_file_patterns: ["*_test.rb"]
+} do
+  watch(%r{.*}) { 'test' }
+end

data/LICENSE.txt

@@ -1,4 +1,5 @@
-Copyright (c) 2010 karledurante
+Copyright (c) 2010 Karle Durante
+Copyright (c) 2016 CustomInk.com
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,144 @@
+
+![SecondBase Logo](https://cloud.githubusercontent.com/assets/2381/12219457/5a5aab4e-b712-11e5-92e1-de6487aa0809.png)
+<hr>
+Seamless second database integration for Rails. SecondBase provides support for Rails to manage dual databases by focusing on ActiveRecord tasks that create, migrate, and test your databases.
+
+[![Gem Version](https://badge.fury.io/rb/secondbase.png)](http://badge.fury.io/rb/secondbase)
+[![Build Status](https://secure.travis-ci.org/customink/secondbase.png)](http://travis-ci.org/customink/secondbase)
+
+
+## Usage
+
+To get started with your new second database, update your database.yml to include a `secondbase` config key. All SecondBase configurations per Rails environment go under this config key.
+
+```yaml
+# Default configurations:
+development:
+  adapter: sqlserver
+  database: myapp_development
+test:
+  adapter: sqlserver
+  database: myapp_test
+# SecondBase configurations:
+secondbase:
+  development:
+    adapter: mysql
+    database: myapp_development
+  test:
+    adapter: mysql
+    database: myapp_test
+```
+
+#### Database Tasks
+
+SecondBase aims to work seamlessly within your Rails application. When it makes sense, we run a mirrored `db:second_base` task for matching ActiveRecord base database task. For example:
+
+```shell
+$ rake db:create
+```
+
+This will not only create your base development database, but it will also create your second database as specified by the configuration within the `:secondbase` section of your database.yml. Below is a complete list of `:db` tasks that automatically run a mirrored `:db:second_base` task. Some private or over lapping tasks, like schema dump/loading or `db:setup`, are not listed.
+
+* db:create
+* db:create:all
+* db:drop
+* db:drop:all
+* db:purge
+* db:purge:all
+* db:migrate
+* db:test:purge
+* db:test:prepare
+
+Not all base database tasks make sense to run a mirrored SecondBase task. These include tasks that move a single migration up/down, reporting on your database's current status/version, and others. These tasks have to be run explicitly and only operate on your SecondBase database. Each support any feature that their matching `:db` task has. For example, using `VERSION=123` to target a specific migration.
+
+* db:second_base:migrate:up
+* db:second_base:migrate:down
+* db:second_base:migrate:reset
+* db:second_base:migrate:redo
+* db:second_base:migrate:status
+* db:second_base:rollback
+* db:second_base:forward
+* db:second_base:version
+
+#### Migration Generator
+
+SecondBase migrations are stored in your application's `db/secondbase/migrate` directory. Likewise, SecondBase will also dump your schema/structure file into the `db/secondbase` directory. Full support for ActiveRecord's schema format being set to either `:ruby` or `:sql` is supported.
+
+Migrations can be generated using the `second_base:migration` name. Our generator is a subclass of ActiveRecord's. This means the SecondBase migration generator supports whatever features and arguments are supported by your current Rails version. For example:
+
+```shell
+$ rails generate second_base:migration CreateWidgetsTable
+$ rails generate second_base:migration AddTitleBodyToPost title:string body:text
+```
+
+#### Models
+
+Any model who's table resides in your second database needs to inherit from `SecondBase::Base`. ActiveRecord associations will still work between your base ActiveRecord and SecondBase models!
+
+```ruby
+class Widget < SecondBase::Base
+
+end
+
+class User < ActiveRecord::Base
+  has_many :widgets
+end
+```
+
+#### Forced Connections
+
+Sometimes you want to force a model that inherits from `ActiveRecord::Base` to use the `SecondBase::Base` connection. Using the `SecondBase::Forced` module is a great way to accomplish this. By using this module, we do all the work to ensure the connection, management, and pool are properly freedom patched.
+
+We recomend forcing modules using a Rails initializer. This example below forces both the [DelayedJob ActiveRecord Backend](https://github.com/collectiveidea/delayed_job_active_record) and ActiveRecord session store to use your SecondBase database.
+
+```ruby
+# In config/initializers/second_base.rb
+Delayed::Backend::ActiveRecord::Job.extend SecondBase::Forced
+ActiveRecord::SessionStore::Session.extend SecondBase::Forced
+```
+
+#### Testing & DB Synchronization
+
+Rails 4.2 brought about a new way to keep your test database in sync by checking schema migrations. Where previously forcing a full test database schema load, Rails 4.2 and up is able to run your tests much faster. In order for SecondBase to take advantage of this, you will need to include our test help file directly following the Rails one. Open your `test_helper.rb` and add our `second_base/test_help` after `rails/test_help`.
+
+```ruby
+ENV["RAILS_ENV"] = "test"
+require File.expand_path('../../config/environment', __FILE__)
+require 'rails/test_help'
+require 'second_base/test_help'
+```
+
+#### Configurations
+
+All SecondBase railtie settings are best done in a `config/initializers/secondbase.rb` file. We support the following configurations:
+
+```ruby
+config.second_base.path        # Default: 'db/secondbase'
+config.second_base.config_key  # Default: 'secondbase'
+```
+
+* `path` - Used as location for migrations & schema. Path is relative to application root.
+* `config_key` - The key to in database.yml/configurations to search for SecondBase configs.
+
+
+## Versions
+
+The current master branch is for Rails v4.0.0 and up and. We have older work in previous v1.0 releases which partial work for Rails 3.2 or lower. These old versions are feature incomplete and are not supported.
+
+
+## Contributing
+
+We use the [Appraisal](https://github.com/thoughtbot/appraisal) gem from Thoughtbot to help us test different versions of Rails. The `rake appraisal test` command actually runs our test suite against all Rails versions in our `Appraisal` file. So after cloning the repo, running the following commands.
+
+```shell
+$ bundle install
+$ bundle exec appraisal update
+$ bundle exec appraisal rake test
+```
+
+If you want to run the tests for a specific Rails version, use one of the appraisal names found in our `Appraisals` file. For example, the following will run our tests suite for Rails 4.1.x.
+
+```shell
+$ bundle exec appraisal rails41 rake test
+```
+

data/Rakefile

@@ -1,47 +1,24 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "secondbase"
-  gem.homepage = "http://github.com/karledurante/secondbase"
-  gem.license = "MIT"
-  gem.summary = %Q{Allow Rails manage second database in your projects}
-  gem.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.}
-  gem.email = "kdurante@customink.com"
-  gem.authors = ["karledurante"]
-  gem.add_development_dependency 'activerecord', '~> 3.0.0'
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
-  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+Rake::TestTask.new do |t|
+  t.libs = ['lib','test']
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
 end
-Jeweler::RubygemsDotOrgTasks.new
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+desc "Bootstrap development/test DB setup."
+task :bootstrap do
+  # ENV['DATBASE_URL'] = 'mysql://root@localhost/secondbase_url'
+  require_relative './test/dummy_app/init'
+  require_relative './test/test_helpers/dummy_app_helpers'
+  include SecondBase::DummyAppHelpers
+  # dummy_root = File.expand_path "#{__dir__}/test/dummy_app"
+  Dir.chdir(dummy_root) { `rake db:create` }
+  delete_dummy_files
 end
 
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "secondbase #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+task :default do
+  Kernel.system 'appraisal update'
+  Kernel.system 'appraisal rake test'
 end

data/VERSION

@@ -1 +1 @@
-0.6.0
+1.0.0

data/gemfiles/rails40.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "terminal-notifier-guard"
+gem "rails", "~> 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails41.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "terminal-notifier-guard"
+gem "rails", "~> 4.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails42.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "terminal-notifier-guard"
+gem "rails", "~> 4.2.0"
+
+gemspec :path => "../"

data/lib/rails/second_base/generators/migration_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators'
+require 'rails/generators/rails/migration/migration_generator'
+require 'rails/generators/active_record'
+require 'rails/generators/active_record/migration/migration_generator'
+
+module SecondBase
+  class MigrationGenerator < ActiveRecord::Generators::MigrationGenerator
+
+    source_root ActiveRecord::Generators::MigrationGenerator.source_root
+
+    def self.desc
+      Rails::Generators::MigrationGenerator.desc
+    end
+
+    include(Module.new{
+
+      def migration_template(*args)
+        args[1].sub! 'db/migrate', "#{Railtie.config_path}/migrate" if args[1]
+        super(*args)
+      end
+
+    })
+
+  end
+end

data/lib/second_base.rb

@@ -0,0 +1,20 @@
+require 'rails'
+require 'active_record'
+require 'active_record/railtie'
+require 'second_base/version'
+require 'second_base/railtie'
+require 'second_base/on_base'
+require 'second_base/forced'
+
+module SecondBase
+
+  extend ActiveSupport::Autoload
+
+  autoload :Base
+
+  def self.config(env = nil)
+    config = ActiveRecord::Base.configurations[Railtie.config_key]
+    config ? config[env || Rails.env] : nil
+  end
+
+end

data/lib/second_base/base.rb

@@ -0,0 +1,8 @@
+module SecondBase
+  class Base < ActiveRecord::Base
+
+    self.abstract_class = true
+    establish_connection SecondBase.config
+
+  end
+end

data/lib/second_base/databases.rake

@@ -0,0 +1,127 @@
+namespace :db do
+  namespace :second_base do
+
+    namespace :create do
+      task :all do
+        SecondBase.on_base { Rake::Task['db:create:all'].execute }
+      end
+    end
+
+    task :create do
+      SecondBase.on_base { Rake::Task['db:create'].execute }
+    end
+
+    namespace :drop do
+      task :all do
+        SecondBase.on_base { Rake::Task['db:drop:all'].execute }
+      end
+    end
+
+    task :drop do
+      SecondBase.on_base { Rake::Task['db:drop'].execute }
+    end
+
+    namespace :purge do
+      task :all do
+        SecondBase.on_base { Rake::Task['db:purge:all'].execute }
+      end
+    end
+
+    task :purge do
+      SecondBase.on_base { Rake::Task['db:purge'].execute }
+    end
+
+    task :migrate do
+      SecondBase.on_base { Rake::Task['db:migrate'].execute }
+    end
+
+    namespace :migrate do
+
+      task :redo => ['db:load_config'] do
+        SecondBase.on_base { Rake::Task['db:migrate:redo'].execute }
+      end
+
+      task :reset => ['db:second_base:drop', 'db:second_base:create', 'db:second_base:migrate']
+
+      task :up => ['db:load_config'] do
+        SecondBase.on_base { Rake::Task['db:migrate:up'].execute }
+      end
+
+      task :down => ['db:load_config'] do
+        SecondBase.on_base { Rake::Task['db:migrate:down'].execute }
+      end
+
+      task :status => ['db:load_config'] do
+        SecondBase.on_base { Rake::Task['db:migrate:status'].execute }
+      end
+
+    end
+
+    task :rollback => ['db:load_config'] do
+      SecondBase.on_base { Rake::Task['db:rollback'].execute }
+    end
+
+    task :forward => ['db:load_config'] do
+      SecondBase.on_base { Rake::Task['db:forward'].execute }
+    end
+
+    task :abort_if_pending_migrations do
+      SecondBase.on_base { Rake::Task['db:abort_if_pending_migrations'].execute }
+    end
+
+    task :version => ['db:load_config'] do
+      SecondBase.on_base { Rake::Task['db:version'].execute }
+    end
+
+    namespace :schema do
+
+      task :load do
+        SecondBase.on_base { Rake::Task['db:schema:load'].execute }
+      end
+
+    end
+
+    namespace :structure do
+
+      task :load do
+        SecondBase.on_base { Rake::Task['db:structure:load'].execute }
+      end
+
+    end
+
+    namespace :test do
+
+      task :purge do
+        SecondBase.on_base { Rake::Task['db:test:purge'].execute }
+      end
+
+      task :load_schema do
+        SecondBase.on_base { Rake::Task['db:test:load_schema'].execute }
+      end
+
+      task :load_structure do
+        SecondBase.on_base { Rake::Task['db:test:load_structure'].execute }
+      end
+
+      task :prepare do
+        SecondBase.on_base { Rake::Task['db:test:prepare'].execute }
+      end
+
+    end
+
+  end
+end
+
+%w{
+  create:all create drop drop:all purge:all purge
+  migrate abort_if_pending_migrations
+  schema:load structure:load
+  test:purge test:load_schema test:load_structure test:prepare
+}.each do |name|
+  task = Rake::Task["db:#{name}"] rescue nil
+  next unless task
+  task.enhance do
+    Rake::Task["db:load_config"].invoke
+    Rake::Task["db:second_base:#{name}"].invoke
+  end
+end