slavery 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 844d663a8d247cdb698ca1e17d781749372d980c
-  data.tar.gz: 7fb134582dfa4eb45971cd1afb35f08286aef10f
+  metadata.gz: 5346c12e4fcf3eaad7b55ce70ca0ffea79f33fe0
+  data.tar.gz: 74b684b645a28770ecb4d8ae08f6bd5b8daaf7b3
 SHA512:
-  metadata.gz: a227e3ba41594385d60c96692969dbbd59d16c5e952ccfa54daf423526025b25dcc99464f9f7eee4458e8f941db1873d3f57d66d9548f9d80625e7b6c600f241
-  data.tar.gz: 1321abb5bd5394ac032bd5531117a707873251c4fd9026456ad08e3c27fb9383e45f1cdfdc4a6aad4f9080c8bf4de3270432854cfef96d5bb2395c70eb724595
+  metadata.gz: 7b9d823e65b28450161595daaef467bc96dc819ed38c4f2d8e9ea663958fca628dd59942700ad829a36903b415088c3ee07ac0df80f3b81e52fd463f588862b2
+  data.tar.gz: ff44e84b3580ce6bccafe3d42ca0b00a07dfb6d83bce83be21bce320c3c2df1b3ab2b4de430612332a0136d072f64ffea0b1ca52cac0d0ac7e41a631efcdffcb

data/.gitignore

@@ -4,6 +4,7 @@
 .config
 .yardoc
 Gemfile.lock
+gemfiles/*.lock
 InstalledFiles
 _yardoc
 coverage

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+
+rvm:
+ - 2.2.2
+ - 2.3.3
+
+gemfile:
+  - Gemfile
+  - gemfiles/rails3.2.gemfile
+  - gemfiles/rails4.gemfile
+  - gemfiles/rails4.2.gemfile
+
+script: bundle exec rspec spec

data/README.md

@@ -1,5 +1,7 @@
 # Slavery - Simple, conservative slave reads for ActiveRecord
 
+[![Build Status](https://travis-ci.org/kenn/slavery.svg)](https://travis-ci.org/kenn/slavery)
+
 Slavery is a simple, easy to use gem for ActiveRecord that enables conservative slave reads, which means it doesn't automatically redirect all SELECTs to slaves.
 
 Instead, you can do `Slavery.on_slave { User.count }` to send a particular query to a slave.
@@ -49,6 +51,13 @@ development_slave:
   <<: *common
 ```
 
+Optionally, you can use a database url for your connections:
+
+```yaml
+development: postgres://root:@localhost:5432/myapp_development
+development_slave: postgres://root:@localhost:5432/myapp_development_slave
+```
+
 At this point, Slavery does nothing. Run tests and confirm that nothing is broken.
 
 ## Usage
@@ -101,6 +110,12 @@ With this user, writes on slave should raise an exception.
 Slavery.on_slave { User.create } 	# => ActiveRecord::StatementInvalid: Mysql2::Error: INSERT command denied...
 ```
 
+With Postgres you can set the entire database to be readonly:
+
+```SQL
+ALTER DATABASE myapp_development_slave SET default_transaction_read_only = true;
+```
+
 It is a good idea to confirm this behavior in your test code as well.
 
 ## Disable temporarily
@@ -139,4 +154,5 @@ Slavery.spec_key = "slave" #instead of production_slave
 
 ## Changelog
 
+* v2.1.0: Debug log support / Database URL support / Rails 3.2 & 4.0 compatibility (Thanks to [@citrus](https://github.com/citrus))
 * v2.0.0: Rails 5 support

data/bin/console

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative "../spec/spec_helper"
+require "irb"
+IRB.start

data/gemfiles/rails3.2.gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem 'activerecord', '~> 3.2'
+
+group :development, :test do
+  gem 'test-unit', '~> 3.0'
+end
+
+gemspec :path => '../'

data/gemfiles/rails4.2.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'activerecord', '~> 4.2'
+
+gemspec :path => '../'

data/gemfiles/rails4.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'activerecord', '~> 4.0.0'
+
+gemspec :path => '../'

data/lib/slavery.rb

@@ -1,10 +1,13 @@
 require 'active_record'
+require 'slavery/version'
 require 'slavery/base'
 require 'slavery/error'
-require 'slavery/slave_connection_holder'
-require 'slavery/version'
+require 'slavery/connection_holder'
+require 'slavery/transaction'
 require 'slavery/active_record/base'
+require 'slavery/active_record/connection_handling'
 require 'slavery/active_record/relation'
+require 'slavery/active_record/log_subscriber'
 
 module Slavery
   class << self
@@ -12,10 +15,7 @@ module Slavery
     attr_writer :spec_key
 
     def spec_key
-      case @spec_key
-      when String   then @spec_key
-      when NilClass then @spec_key = "#{ActiveRecord::ConnectionHandling::RAILS_ENV.call}_slave"
-      end
+      @spec_key ||= "#{ActiveRecord::ConnectionHandling::RAILS_ENV.call}_slave"
     end
 
     def on_slave(&block)
@@ -25,25 +25,5 @@ module Slavery
     def on_master(&block)
       Base.new(:master).run &block
     end
-
-    def slave_connection_holder
-      @slave_connection_holder ||= begin
-        SlaveConnectionHolder.activate
-        SlaveConnectionHolder
-      end
-    end
-
-    def base_transaction_depth
-      @base_transaction_depth ||= begin
-        testcase = ActiveSupport::TestCase
-        if defined?(testcase) &&
-            testcase.respond_to?(:use_transactional_fixtures) &&
-            testcase.try(:use_transactional_fixtures)
-          1
-        else
-          0
-        end
-      end
-    end
   end
 end

data/lib/slavery/active_record/base.rb

@@ -6,7 +6,7 @@ module ActiveRecord
       def connection
         case Thread.current[:slavery]
         when :slave
-          Slavery.slave_connection_holder.connection_without_slavery
+          Slavery.connection_holder.connection_without_slavery
         when :master, NilClass
           connection_without_slavery
         else

data/lib/slavery/active_record/connection_handling.rb

@@ -0,0 +1,6 @@
+module ActiveRecord
+  module ConnectionHandling
+    # Already defined in Rails 4.1+
+    RAILS_ENV ||= -> { (Rails.env if defined?(Rails.env)) || ENV["RAILS_ENV"] || ENV["RACK_ENV"] }
+  end
+end

data/lib/slavery/active_record/log_subscriber.rb

@@ -0,0 +1,12 @@
+module ActiveRecord
+  class LogSubscriber
+
+    alias_method :debug_without_slavery, :debug
+
+    def debug(msg)
+      db = Slavery.disabled ? "" : color("[#{Thread.current[:slavery] || "master"}]", ActiveSupport::LogSubscriber::GREEN, true)
+      debug_without_slavery(db + msg)
+    end
+
+  end
+end

data/lib/slavery/base.rb

@@ -22,7 +22,7 @@ module Slavery
 
     def inside_transaction?
       open_transactions = run_on(:master) { ActiveRecord::Base.connection.open_transactions }
-      open_transactions > Slavery.base_transaction_depth
+      open_transactions > Slavery::Transaction.base_depth
     end
 
     def run_on(target)

data/lib/slavery/connection_holder.rb

@@ -0,0 +1,23 @@
+module Slavery
+  class ConnectionHolder < ActiveRecord::Base
+    self.abstract_class = true
+
+    class << self
+      # for delayed activation
+      def activate
+        spec = ActiveRecord::Base.configurations[Slavery.spec_key]
+        raise Error.new('Slavery.spec_key invalid!') if spec.nil?
+        establish_connection spec
+      end
+    end
+  end
+
+  class << self
+    def connection_holder
+      @connection_holder ||= begin
+        ConnectionHolder.activate
+        ConnectionHolder
+      end
+    end
+  end
+end

data/lib/slavery/transaction.rb

@@ -0,0 +1,18 @@
+module Slavery
+  class Transaction
+    class << self
+      def base_depth
+        @base_depth ||= begin
+          testcase = ActiveSupport::TestCase
+          if defined?(testcase) &&
+              testcase.respond_to?(:use_transactional_fixtures) &&
+              testcase.try(:use_transactional_fixtures)
+            1
+          else
+            0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slavery/version.rb

@@ -1,3 +1,3 @@
 module Slavery
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/spec/active_record/log_subscriber_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'logger'
+
+describe ActiveRecord::LogSubscriber do
+
+  describe 'logging' do
+
+    let(:log) { StringIO.new }
+    let(:logger) { Logger.new(log) }
+
+    before do
+      ActiveRecord::Base.logger = logger
+    end
+
+    after do
+      Slavery.disabled = false
+    end
+
+    it 'it prefixes log messages with master' do
+      User.count
+      log.rewind
+      expect(log.read).to include('[master]')
+    end
+
+    it 'it prefixes log messages with the slave connection' do
+      User.on_slave.count
+      log.rewind
+      expect(log.read).to include('[slave]')
+    end
+
+    it 'it does nothing when slavery is disabled' do
+      Slavery.disabled = true
+      User.count
+      log.rewind
+      expect(log.read).to_not include('[master]')
+    end
+
+  end
+
+end

data/spec/slavery_spec.rb

@@ -95,15 +95,15 @@ describe Slavery do
   describe 'configuration' do
     before do
       # Backup connection and configs
-      @backup_conn = Slavery.instance_variable_get :@slave_connection_holder
+      @backup_conn = Slavery.instance_variable_get :@connection_holder
       @backup_config = ActiveRecord::Base.configurations.dup
       @backup_disabled = Slavery.disabled
-      Slavery.instance_variable_set :@slave_connection_holder, nil
+      Slavery.instance_variable_set :@connection_holder, nil
     end
 
     after do
       # Restore connection and configs
-      Slavery.instance_variable_set :@slave_connection_holder, @backup_conn
+      Slavery.instance_variable_set :@connection_holder, @backup_conn
       ActiveRecord::Base.configurations = @backup_config
       Slavery.disabled = @backup_disabled
     end
@@ -120,5 +120,29 @@ describe Slavery do
 
       expect(Slavery.on_slave { User.count }).to be 2
     end
+
+    it 'connects to slave when specified as a hash' do
+      Slavery.spec_key = 'test_slave'
+      hash = ActiveRecord::Base.configurations['test_slave']
+      expect(Slavery::ConnectionHolder).to receive(:establish_connection).with(hash)
+      Slavery::ConnectionHolder.activate
+    end
+
+    it 'connects to slave when specified as a url' do
+      expected = if Gem::Version.new(ActiveRecord::VERSION::STRING) < Gem::Version.new('4.1.0')
+        'postgres://root:@localhost:5432/test_slave'
+      else
+        {
+          'adapter'  => 'postgresql',
+          'username' => 'root',
+          'port'     => 5432,
+          'database' => 'test_slave',
+          'host'     => 'localhost'
+        }
+      end
+      Slavery.spec_key = 'test_slave_url'
+      expect(Slavery::ConnectionHolder).to receive(:establish_connection).with(expected)
+      Slavery::ConnectionHolder.activate
+    end
   end
 end

data/spec/spec_helper.rb

@@ -6,8 +6,9 @@ ENV['RACK_ENV'] = 'test'
 require 'slavery'
 
 ActiveRecord::Base.configurations = {
-  'test' =>        { adapter: 'sqlite3', database: 'test_db' },
-  'test_slave' =>  { adapter: 'sqlite3', database: 'test_slave_db' }
+  'test' =>            { adapter: 'sqlite3', database: 'test_db' },
+  'test_slave'     =>  { adapter: 'sqlite3', database: 'test_slave_db' },
+  'test_slave_url' => "postgres://root:@localhost:5432/test_slave"
 }
 
 # Prepare databases

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slavery
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Kenn Ejima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-04 00:00:00.000000000 Z
+date: 2016-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -55,24 +55,34 @@ dependencies:
 description: Simple, conservative slave reads for ActiveRecord
 email:
 - kenn.ejima@gmail.com
-executables: []
+executables:
+- console
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- gemfiles/rails3.2.gemfile
+- gemfiles/rails4.2.gemfile
+- gemfiles/rails4.gemfile
 - lib/slavery.rb
 - lib/slavery/active_record/base.rb
+- lib/slavery/active_record/connection_handling.rb
+- lib/slavery/active_record/log_subscriber.rb
 - lib/slavery/active_record/relation.rb
 - lib/slavery/base.rb
+- lib/slavery/connection_holder.rb
 - lib/slavery/error.rb
-- lib/slavery/slave_connection_holder.rb
+- lib/slavery/transaction.rb
 - lib/slavery/version.rb
 - slavery.gemspec
+- spec/active_record/log_subscriber_spec.rb
 - spec/slavery_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/kenn/slavery
@@ -94,10 +104,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Simple, conservative slave reads for ActiveRecord
 test_files:
+- spec/active_record/log_subscriber_spec.rb
 - spec/slavery_spec.rb
 - spec/spec_helper.rb

data/lib/slavery/slave_connection_holder.rb

@@ -1,13 +0,0 @@
-module Slavery
-  class SlaveConnectionHolder < ActiveRecord::Base
-    self.abstract_class = true
-
-    class << self
-      # for delayed activation
-      def activate
-        raise Error.new('Slavery.spec_key invalid!') unless ActiveRecord::Base.configurations[Slavery.spec_key]
-        establish_connection Slavery.spec_key.to_sym
-      end
-    end
-  end
-end