switch_point 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d470827ada389d47ee22e4956e6a45a42203abbb
+  data.tar.gz: 0b73cf90012e2fb62556830421c220cf01e59b21
+SHA512:
+  metadata.gz: 62fde9258b6d872a319643c32935cbeda95bf2ce80c56f1ca96a73a2bf519562b51fbdf22feb870be8538418f4c273ec828d1ca2279d4678fb6977a701821cd0
+  data.tar.gz: 296199d722f3dc08deb552f7258796f2d124346cc1268af7302f209f255cb5f8c2ba27a6fcec4ecfffc44c0a6ed7b193768e2d48c03641c26be33fe00345fe3b

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.1
+  - ruby-head
+gemfile:
+  - gemfiles/rails_3.2.gemfile
+  - gemfiles/rails_4.0.gemfile
+  - gemfiles/rails_4.1.gemfile
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Appraisals

@@ -0,0 +1,13 @@
+appraise 'rails-3.2' do
+  gem 'activerecord', '~> 3.2'
+end
+
+appraise 'rails-4.0' do
+  gem 'activerecord', '~> 4.0'
+end
+
+appraise 'rails-4.1' do
+  gem 'activerecord', '~> 4.1'
+end
+
+# vim: set ft=ruby:

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0 (2014-05-28)
+- Initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kohei Suzuki
+
+MIT License
+
+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,33 @@
+# SwitchPoint
+[![Build Status](https://travis-ci.org/eagletmt/switch_point.svg?branch=master)](https://travis-ci.org/eagletmt/switch_point)
+
+Switching database connection between readonly one and writable one.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'switch_point'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install switch_point
+
+## Usage
+
+See [spec/models](spec/models.rb).
+
+## TODO
+- Thread safety
+
+## Contributing
+
+1. Fork it ( https://github.com/eagletmt/switch_point/fork )
+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 a new Pull Request

data/Rakefile

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

data/gemfiles/rails_3.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.2"
+
+gemspec :path => "../"

data/gemfiles/rails_4.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.1"
+
+gemspec :path => "../"

data/lib/switch_point.rb

@@ -0,0 +1,41 @@
+require 'active_support/lazy_load_hooks'
+require 'switch_point/config'
+require 'switch_point/version'
+
+module SwitchPoint
+  module ClassMethods
+    def configure(&block)
+      block.call(config)
+    end
+
+    def config
+      @config ||= Config.new
+    end
+
+    def readonly_all!
+      config.keys.each do |name|
+        readonly!(name)
+      end
+    end
+
+    def readonly!(name)
+      ProxyRepository.find(name).readonly!
+    end
+
+    def writable_all!
+      config.keys.each do |name|
+        writable!(name)
+      end
+    end
+
+    def writable!(name)
+      ProxyRepository.find(name).writable!
+    end
+  end
+  extend ClassMethods
+end
+
+ActiveSupport.on_load(:active_record) do
+  require 'switch_point/model'
+  ActiveRecord::Base.send(:include, SwitchPoint::Model)
+end

data/lib/switch_point/config.rb

@@ -0,0 +1,35 @@
+module SwitchPoint
+  class Config
+    def define_switch_point(name, config)
+      assert_valid_config!(config)
+      @switch_points ||= {}
+      @switch_points[name] = config
+    end
+
+    def database_name(name, mode)
+      @switch_points[name][mode]
+    end
+
+    def model_name(name, mode)
+      "#{mode}_#{database_name(name, mode)}".camelize
+    end
+
+    def keys
+      @switch_points.keys
+    end
+
+    private
+
+    def assert_valid_config!(config)
+      [:readonly, :writable].each do |mode|
+        unless config.has_key?(mode)
+          raise ArgumentError.new("#{mode} key is required")
+        end
+        unless config[mode].is_a?(Symbol)
+          raise TypeError.new("#{mode}'s value must be Symbol")
+        end
+      end
+      nil
+    end
+  end
+end

data/lib/switch_point/model.rb

@@ -0,0 +1,42 @@
+require 'switch_point/proxy_repository'
+
+module SwitchPoint
+  module Model
+    def self.included(model)
+      model.singleton_class.class_eval do
+        include ClassMethods
+        prepend ConnectionHook
+      end
+    end
+
+    module ConnectionHook
+      def connection
+        if @switch_point_name
+          switch_point_proxy.connection
+        else
+          super
+        end
+      end
+    end
+
+    module ClassMethods
+      def with_readonly(&block)
+        switch_point_proxy.with_readonly(&block)
+      end
+
+      def with_writable(&block)
+        switch_point_proxy.with_writable(&block)
+      end
+
+      private
+
+      def use_switch_point(name)
+        @switch_point_name = name
+      end
+
+      def switch_point_proxy
+        @switch_point_proxy ||= ProxyRepository.find(@switch_point_name)
+      end
+    end
+  end
+end

data/lib/switch_point/proxy.rb

@@ -0,0 +1,55 @@
+require 'switch_point/writable_connection_hook'
+
+module SwitchPoint
+  class Proxy
+    def initialize(name)
+      @models = {}
+      [:readonly, :writable].each do |mode|
+        model = define_model(SwitchPoint.config.model_name(name, mode))
+        @models[mode] = model
+        model.establish_connection(SwitchPoint.config.database_name(name, mode))
+        memorize_switch_point_name(name, model.connection)
+      end
+      @models[:writable].connection.extend(WritableConnectionHook)
+      @mode = :readonly
+    end
+
+    def define_model(model_name)
+      model = Class.new(ActiveRecord::Base)
+      Proxy.const_set(model_name, model)
+      model
+    end
+
+    def memorize_switch_point_name(name, connection)
+      connection.instance_variable_set(:@switch_point_name, name)
+    end
+
+    def readonly!
+      @mode = :readonly
+    end
+
+    def writable!
+      @mode = :writable
+    end
+
+    def with_readonly(&block)
+      with_connection(:readonly, &block)
+    end
+
+    def with_writable(&block)
+      with_connection(:writable, &block)
+    end
+
+    def with_connection(mode, &block)
+      saved_mode = @mode
+      @mode = mode
+      block.call
+    ensure
+      @mode = saved_mode
+    end
+
+    def connection
+      @models[@mode].connection
+    end
+  end
+end

data/lib/switch_point/proxy_repository.rb

@@ -0,0 +1,20 @@
+require 'singleton'
+require 'switch_point/proxy'
+
+module SwitchPoint
+  class ProxyRepository
+    include Singleton
+
+    def self.find(name)
+      instance.find(name)
+    end
+
+    def find(name)
+      proxies[name] ||= Proxy.new(name)
+    end
+
+    def proxies
+      @proxies ||= {}
+    end
+  end
+end

data/lib/switch_point/version.rb

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

data/lib/switch_point/writable_connection_hook.rb

@@ -0,0 +1,17 @@
+require 'switch_point/proxy_repository'
+
+module SwitchPoint
+  # Propagate clear_query_cache in writable connection to readonly connection
+  module WritableConnectionHook
+    # See ActiveRecord::ConnectionAdapters::QueryCache
+    [:insert, :update, :delete].each do |method_name|
+      define_method(method_name) do |*args, &block|
+        proxy = ProxyRepository.find(@switch_point_name)
+        proxy.with_readonly do
+          proxy.connection.clear_query_cache
+        end
+        super(*args, &block)
+      end
+    end
+  end
+end

data/spec/models.rb

@@ -0,0 +1,41 @@
+SwitchPoint.configure do |config|
+  config.define_switch_point :main,
+    readonly: :main_readonly,
+    writable: :main_writable
+  config.define_switch_point :user,
+    readonly: :user,
+    writable: :user
+  config.define_switch_point :comment,
+    readonly: :comment_readonly,
+    writable: :comment_writable
+end
+
+class Book < ActiveRecord::Base
+  use_switch_point :main
+end
+
+class Publisher < ActiveRecord::Base
+  use_switch_point :main
+end
+
+class Comment < ActiveRecord::Base
+  use_switch_point :comment
+end
+
+class User < ActiveRecord::Base
+  use_switch_point :user
+end
+
+class Note < ActiveRecord::Base
+end
+
+base = { adapter: 'sqlite3' }
+ActiveRecord::Base.configurations = {
+  'main_readonly' => base.merge(database: 'main_readonly.sqlite3'),
+  'main_writable' => base.merge(database: 'main_writable.sqlite3'),
+  'user' => base.merge(database: 'user.sqlite3'),
+  'comment_readonly' => base.merge(database: 'comment_readonly.sqlite3'),
+  'comment_writable' => base.merge(database: 'comment_writable.sqlite3'),
+  'default' => base.merge(database: 'default.sqlite3')
+}
+ActiveRecord::Base.establish_connection(:default)

data/spec/spec_helper.rb

@@ -0,0 +1,60 @@
+require 'active_record'
+require 'switch_point'
+require 'models'
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  if config.files_to_run.one?
+    config.full_backtrace = true
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+
+  config.before(:suite) do
+    sql = 'CREATE TABLE books (id integer primary key autoincrement)'
+    Book.connection.execute(sql)
+    Book.with_writable do
+      Book.connection.execute(sql)
+    end
+  end
+
+  config.after(:suite) do
+    ActiveRecord::Base.configurations.each_value do |config|
+      FileUtils.rm_f(config[:database])
+    end
+  end
+
+  config.after(:each) do
+    Book.delete_all
+    Book.with_writable do
+      Book.delete_all
+    end
+  end
+end
+
+RSpec::Matchers.define :connect_to do |expected|
+  database_name = lambda do |model|
+    model.connection.pool.spec.config[:database]
+  end
+
+  match do |actual|
+    database_name.call(actual) == expected
+  end
+
+  failure_message do |actual|
+    "expected #{actual.name} to connect to #{expected} but connected to #{database_name.call(actual)}"
+  end
+end

data/spec/switch_point/model_spec.rb

@@ -0,0 +1,108 @@
+RSpec.describe SwitchPoint::Model do
+  describe '.connection' do
+    it 'returns readonly connection by default' do
+      expect(Book).to connect_to('main_readonly.sqlite3')
+      expect(Publisher).to connect_to('main_readonly.sqlite3')
+      expect(User).to connect_to('user.sqlite3')
+      expect(Comment).to connect_to('comment_readonly.sqlite3')
+      expect(Note).to connect_to('default.sqlite3')
+    end
+
+    context 'without switch_point configuration' do
+      it 'returns default connection' do
+        expect(Note.connection).to equal(ActiveRecord::Base.connection)
+      end
+    end
+
+    context 'with the same switch point name' do
+      it 'shares connection' do
+        expect(Book.connection).to equal(Publisher.connection)
+      end
+    end
+  end
+
+  describe '.with_writable' do
+    it 'changes connection locally' do
+      Book.with_writable do
+        expect(Book).to connect_to('main_writable.sqlite3')
+      end
+      expect(Book).to connect_to('main_readonly.sqlite3')
+    end
+
+    it 'affects to other models with the same switch point' do
+      Book.with_writable do
+        expect(Publisher).to connect_to('main_writable.sqlite3')
+      end
+      expect(Publisher).to connect_to('main_readonly.sqlite3')
+    end
+
+    it 'does not affect to other models with different switch point' do
+      Book.with_writable do
+        expect(Comment).to connect_to('comment_readonly.sqlite3')
+      end
+    end
+
+    context 'with the same switch point' do
+      it 'shares connection' do
+        Book.with_writable do
+          expect(Book.connection).to equal(Publisher.connection)
+        end
+      end
+    end
+
+    context 'with query cache' do
+      context 'when writable connection does only non-destructive operation' do
+        it 'keeps readable query cache' do
+          # Ensure ActiveRecord::Base.connected? to make Book.cache work
+          # See ActiveRecord::QueryCache::ClassMethods#cache
+          ActiveRecord::Base.connection
+          Book.cache do
+            expect(Book.count).to eq(0)
+            expect(Book.connection.query_cache.size).to eq(1)
+            Book.with_writable do
+              Book.count
+            end
+            expect(Book.connection.query_cache.size).to eq(1)
+          end
+        end
+      end
+
+      context 'when writable connection does destructive operation' do
+        it 'clears readable query cache' do
+          # Ensure ActiveRecord::Base.connected? to make Book.cache work
+          # See ActiveRecord::QueryCache::ClassMethods#cache
+          ActiveRecord::Base.connection
+          Book.cache do
+            expect(Book.count).to eq(0)
+            expect(Book.connection.query_cache.size).to eq(1)
+            Book.with_writable do
+              Book.create
+              FileUtils.cp('main_writable.sqlite3', 'main_readonly.sqlite3')  # XXX: emulate replication
+            end
+            expect(Book.connection.query_cache.size).to eq(0)
+            expect(Book.count).to eq(1)
+          end
+        end
+      end
+    end
+  end
+
+  describe '.with_readonly' do
+    context 'when writable! is called globally' do
+      before do
+        SwitchPoint.writable!(:main)
+      end
+
+      after do
+        SwitchPoint.readonly!(:main)
+      end
+
+      it 'locally overwrites global mode' do
+        Book.with_readonly do
+          expect(Book).to connect_to('main_readonly.sqlite3')
+        end
+        expect(Book).to connect_to('main_writable.sqlite3')
+      end
+    end
+  end
+end

data/spec/switch_point_spec.rb

@@ -0,0 +1,15 @@
+RSpec.describe SwitchPoint do
+  describe '.writable!' do
+    after do
+      SwitchPoint.readonly!(:main)
+    end
+
+    it 'changes connection globally' do
+      expect(Book).to connect_to('main_readonly.sqlite3')
+      expect(Publisher).to connect_to('main_readonly.sqlite3')
+      SwitchPoint.writable!(:main)
+      expect(Book).to connect_to('main_writable.sqlite3')
+      expect(Publisher).to connect_to('main_writable.sqlite3')
+    end
+  end
+end

data/switch_point.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'switch_point/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "switch_point"
+  spec.version       = SwitchPoint::VERSION
+  spec.authors       = ["Kohei Suzuki"]
+  spec.email         = ["eagletmt@gmail.com"]
+  spec.summary       = %q{Switching database connection between readonly one and writable one.}
+  spec.description   = %q{Switching database connection between readonly one and writable one.}
+  spec.homepage      = "https://github.com/eagletmt/switch_point"
+  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 "appraisal"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0.0.rc1"
+  spec.add_development_dependency "sqlite3"
+  spec.add_dependency "activerecord", ">= 3.2.0"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: switch_point
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kohei Suzuki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Switching database connection between readonly one and writable one.
+email:
+- eagletmt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/rails_3.2.gemfile
+- gemfiles/rails_4.0.gemfile
+- gemfiles/rails_4.1.gemfile
+- lib/switch_point.rb
+- lib/switch_point/config.rb
+- lib/switch_point/model.rb
+- lib/switch_point/proxy.rb
+- lib/switch_point/proxy_repository.rb
+- lib/switch_point/version.rb
+- lib/switch_point/writable_connection_hook.rb
+- spec/models.rb
+- spec/spec_helper.rb
+- spec/switch_point/model_spec.rb
+- spec/switch_point_spec.rb
+- switch_point.gemspec
+homepage: https://github.com/eagletmt/switch_point
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Switching database connection between readonly one and writable one.
+test_files:
+- spec/models.rb
+- spec/spec_helper.rb
+- spec/switch_point/model_spec.rb
+- spec/switch_point_spec.rb