db-switch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9386730abb6a43273dde21685ba599dd5f2a03f0
+  data.tar.gz: c7dfcffd2a19423dc4de0b761c813407566ac297
+SHA512:
+  metadata.gz: c5dcd0b3f043f0be5f1bfb3d6fbf04f3013c216bdaa4f356a9034f4c127a56a03dee1ca464530a62b5c08b48bd376e0fdcc56df9b0ea09c08c183896c7d499ba
+  data.tar.gz: e93b14b1cb755b13b9af46176b45dd492db6e944ddb47c7284770007ca939b649268d1ffdcd946d849903e5a772f823a8beed44cb99563181bf4a24af91f6b66

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/
+*.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.4

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Anjlab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# Db Switch
+
+[![Build Status](https://travis-ci.org/anjlab/db-switch.svg?branch=master)](https://travis-ci.org/anjlab/db-switch)
+
+This is a Rails 5 gem which allows you to use different database connections in your projects
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'db-switch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install db-switch
+
+## Usage
+
+**First**, you need to define your databases. In Rails, you define databases in `database.yml`. This is also the place where you can add your custom connections:
+
+```yaml
+development:
+  adapter: postgresql
+  database: dev_database
+  host: localhost
+  pool: 5
+
+test:
+  adapter: sqlite3
+  database: test_db_1.sqlite3
+  pool: 5
+
+replica_one:
+  development:
+    adapter: postgresql
+    database: dev_replica
+    host: localhost
+    pool: 5
+
+  test:
+    adapter: sqlite3
+    database: test_db_2.sqlite3
+    pool: 5
+```
+
+In the above sample we have defined `replica_one` alternative database connection, for both development and test environments.
+
+**Second**, specify connection in your code:
+
+```ruby
+ActiveRecord::Base.connect_to(:replica_one) do
+  @products = Product.where('created_at > ?', 1.day.ago).to_a
+end
+
+# or somewhere inside your ActiveRecord model
+
+def load_products
+  connect_to(:replica_one) do
+    Product.where('created_at > ?', 1.day.ago).to_a
+  end  
+end
+
+```
+
+This will query data from the `replica_one` database specified above.
+
+**That's it! Use it!**
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/db-switch.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'db-switch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'db-switch'
+  spec.version       = DbSwitch::VERSION
+  spec.authors       = ['Anjlab']
+  spec.email         = ['sergey.glukhov@gmail.com']
+
+  spec.summary       = 'Simple database connection switcher for Rails 5'
+  spec.description   = 'Dead-simple gem for Rails 5 that allows to switch between database connections on-the-fly'
+  spec.homepage      = 'https://github.com/anjlab/db-switch'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pg', '~> 0.19'
+
+  # Rails 5 dependencies
+  spec.add_runtime_dependency 'activerecord', '~> 5.0'
+  spec.add_runtime_dependency 'railties', '~> 5.0'
+end

data/lib/db-switch.rb

@@ -0,0 +1,2 @@
+require 'db-switch/version'
+require 'db-switch/railtie'

data/lib/db-switch/active_record_base.rb

@@ -0,0 +1,26 @@
+module DbSwitch::ActiveRecordBase
+  include DbSwitch::ThreadVariables
+
+  def connect_to(connection_name)
+    begin
+      self.db_switch_connection_name = connection_name.to_s
+      if ActiveRecord::Base.connection_handler.connected?(connection_name.to_s).nil?
+        db_config = ActiveRecord::Base.configurations[connection_name.to_s]
+        if db_config && db_config[Rails.env.to_s]
+          resolver = ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(db_config)
+          spec = resolver.spec(Rails.env.to_sym, connection_name.to_s)
+          ActiveRecord::Base.connection_handler.establish_connection spec
+        else
+          self.db_switch_connection_name = nil
+        end
+      end
+      yield if block_given?
+    ensure
+      self.db_switch_connection_name = nil
+    end
+  end
+
+  def connection_specification_name
+    db_switch_connection_name || super
+  end
+end

data/lib/db-switch/log_subscriber.rb

@@ -0,0 +1,15 @@
+module DbSwitch::LogSubscriber
+  include DbSwitch::ThreadVariables
+
+  attr_accessor :color_value
+
+  def colorize_payload_name(name, payload_name)
+    self.color_value = payload_name.blank? || payload_name == 'SQL' ? :MAGENTA : :CYAN if db_switch_connection_name
+    super
+  end
+
+  def debug(msg)
+    msg = color("[#{db_switch_connection_name}]", color_value || :CYAN, true) + msg if db_switch_connection_name
+    super(msg)
+  end
+end

data/lib/db-switch/railtie.rb

@@ -0,0 +1,18 @@
+require 'db-switch/thread_variables'
+require 'db-switch/active_record_base'
+require 'db-switch/log_subscriber'
+
+require 'rails'
+
+module DbSwitch
+  class Railtie < ::Rails::Railtie
+    initializer 'db-switch->active_record' do
+      ActiveSupport.on_load(:active_record) do
+        # extend AR functionality
+        ActiveRecord::Base.send(:extend, DbSwitch::ActiveRecordBase)
+        # extend SQL query logger
+        ActiveRecord::LogSubscriber.send(:prepend, DbSwitch::LogSubscriber)
+      end
+    end
+  end
+end

data/lib/db-switch/thread_variables.rb

@@ -0,0 +1,10 @@
+module DbSwitch::ThreadVariables
+  def db_switch_connection_name
+    Thread.current[:db_switch_connection_name]
+  end
+
+  def db_switch_connection_name=(value)
+    Thread.current[:db_switch_connection_name] = value
+  end
+  # attr_accessor :db_switch_connection_name # notice: this is not thread safe! (just for testing purposes)
+end

data/lib/db-switch/version.rb

@@ -0,0 +1,3 @@
+module DbSwitch
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: db-switch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anjlab
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Dead-simple gem for Rails 5 that allows to switch between database connections
+  on-the-fly
+email:
+- sergey.glukhov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- db-switch.gemspec
+- lib/db-switch.rb
+- lib/db-switch/active_record_base.rb
+- lib/db-switch/log_subscriber.rb
+- lib/db-switch/railtie.rb
+- lib/db-switch/thread_variables.rb
+- lib/db-switch/version.rb
+homepage: https://github.com/anjlab/db-switch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Simple database connection switcher for Rails 5
+test_files: []