postamt 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34ca7a878f7cd7eb35c89e13148ff5bcc1ee9902
-  data.tar.gz: 019233a57d48dcddfefd6ea65025e4a98d59ee78
+  metadata.gz: 0735b7ec645e87e9007592822f3e14bca2f4e810
+  data.tar.gz: 8b3f02abb5439a16c536fd3608c8d53147bc5f3d
 SHA512:
-  metadata.gz: 40034cd7b4e0016401f4a98893b2e70a48556a340b9fe541e7693369eb039ea02f1e1c104ec9a81bb2a0b6becbb0e53f06fa1af3145ce4b993eb9bd4c348258b
-  data.tar.gz: 2f7f090a657609cd192b44add07d8dd28e88773d299f6e8f792500f62f997d9917dfee86fa0192e2128f54381d6b126a108902a141919786169896c98cc87b55
+  metadata.gz: 0cf4b7e33e840638afa19a8fe57c49d4221f4974ff4407119fb7811d9b5b53eec0936298f9669dd34f38819a4c6b4d4b15afacfa8746eded03b505d75916bf25
+  data.tar.gz: a1cd70c63e0565966c399bdd52faecec71cfa932fd6948e4b491f76efb457713f3c02b5ef2df13102c864ed089c457ca684a2d40b8fc7b57f0790241edce516f

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.9.1
+
+Add support and test app for Rails 4.1.0.beta1.
+
+## 0.9.0
+
+Initial release

data/README.md

@@ -1,12 +1,31 @@
 # Postamt
 
-Performs (some of) your read-only queries on a hot standby.
+[![Gem Version](https://badge.fury.io/rb/postamt.png)](http://rubygems.org/gems/postamt)
+
+Postamt is a sane, Rails-4-ready solution for performing database
+reads against a hot standby server.
+
+Choose per model and/or controller&action whether a read-only query
+should be sent to master or a hot standby.<br />
+Inside a transaction reads always happen against master.
+
+Care has been taken to avoid [common performance
+pitfalls](http://charlie.bz/blog/things-that-clear-rubys-method-cache).
+It's been battle tested in production at
+[sauspiel.de](https://www.sauspiel.de/).
+
+Monkey-patching is kept to an absolute minimum, the hard work happens
+through [officially-supported Rails
+APIs](https://github.com/rails/rails/commit/ba1544d71628abff2777c9c514142d7e9a159111#commitcomment-2106059).
+That's why there's so little code compared to similar gems.
+
+Postamt requires Rails 3.2+ and works with Rails 4.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'pg_charmer'
+    gem 'postamt'
 
 ## Example usage
 
@@ -81,6 +100,37 @@ end
 Postamt.force_connection = :master
 ```
 
+## Tests
+
+Create the DB `postamt_test` and ensure the users `master` and
+`slave` exist:
+
+```
+$ createdb postamt_test
+$ createuser -s master # -s => superuser
+$ createuser -s slave # better to restrict slave to be read-only
+```
+
+Migrate the DB in the Rails 4 app:
+
+```
+$ cd testapp # Rails 4
+$ RAILS_ENV=test bundle exec rake db:migrate
+```
+
+Run the tests on Rails 3.2 and Rails 4:
+
+```
+$ cd testapp # Rails 4
+$ bundle exec ruby -Itest test/integration/postamt_test.rb
+$ cd testapp32 # Rails 3.2
+$ bundle exec ruby -Itest test/integration/postamt_test.rb
+```
+
+You can't run the tests via a simple `rake` because Postamt deactivates
+itself when it detects that a task starting with 'db' is run (like
+`db:test:prepare`)
+
 ## Contributing
 
 1. Fork it
@@ -88,3 +138,4 @@ Postamt.force_connection = :master
 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
+

data/lib/postamt.rb

@@ -42,7 +42,7 @@ module Postamt
     Thread.current[:postamt_overwritten_default_connections] ||= {}
   end
 
-  if Rails::VERSION::MAJOR == 4 and Rails::VERSION::MINOR == 0
+  if Rails::VERSION::MAJOR == 4 and Rails::VERSION::MINOR <= 1
     Postamt::ConnectionSpecificationResolver = ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver
   elsif Rails::VERSION::MAJOR == 3 and Rails::VERSION::MINOR == 2
     Postamt::ConnectionSpecificationResolver = ActiveRecord::Base::ConnectionSpecification::Resolver
@@ -52,7 +52,7 @@ module Postamt
 
   # Called by Postamt::Railtie
   def self.hook!
-    if Rails::VERSION::MAJOR == 4 and Rails::VERSION::MINOR == 0
+    if Rails::VERSION::MAJOR == 4 and Rails::VERSION::MINOR <= 1
       ActiveRecord::Base.default_connection_handler = Postamt::ConnectionHandler.new
     elsif Rails::VERSION::MAJOR == 3 and Rails::VERSION::MINOR == 2
       ActiveRecord::Base.connection_handler = Postamt::ConnectionHandler.new
@@ -96,16 +96,40 @@ module Postamt
       alias_method_chain :update_all, :postamt
     end
 
+    ActiveRecord::LogSubscriber.class_eval do
+      attr_accessor :connection_name
+
+      def sql_with_connection_name(event)
+        self.connection_name = ObjectSpace._id2ref(event.payload[:connection_id]).instance_variable_get(:@config)[:username]
+        sql_without_connection_name(event)
+      end
+
+      def debug_with_connection_name(msg)
+        conn = connection_name ? color("  [#{connection_name}]", ActiveSupport::LogSubscriber::BLUE, true) : ''
+        debug_without_connection_name(conn + msg)
+      end
+
+      # TODO: Switch to Module#prepend once we are Ruby-2.0.0-onlhy
+      alias_method_chain :sql, :connection_name
+      alias_method_chain :debug, :connection_name
+    end
+
     ActionController::Base.instance_eval do
       def use_db_connection(connection, args)
-        default_connections = {}
         klass_names = args.delete(:for)
-        klass_names.each do |klass_name|
-          default_connections[klass_name] = connection
-        end
-
-        before_filter(args) do |controller|
-          Postamt.overwritten_default_connections.merge!(default_connections)
+        if klass_names == :all
+          around_filter(args) do |controller|
+            Postamt.on(connection) { yield }
+          end
+        else
+          default_connections = {}
+          klass_names.each do |klass_name|
+            default_connections[klass_name] = connection
+          end
+
+          before_filter(args) do |controller|
+            Postamt.overwritten_default_connections.merge!(default_connections)
+          end
         end
       end
 

data/lib/postamt/railtie.rb

@@ -2,8 +2,13 @@ module Postamt
   class Railtie < Rails::Railtie
     railtie_name "postamt"
 
+    attr_accessor :running_in_rake
+    rake_tasks do
+      self.running_in_rake = true
+    end
+
     initializer "postamt.hook", before: "active_record.initialize_database" do |app|
-      if (defined?($rails_rake_task) && $rails_rake_task)
+      if self.running_in_rake
         # We mustn't hook into AR when db:migrate or db:test:load_schema
         # run, but user-defined Rake tasks still need us
         task_names = []
@@ -13,7 +18,17 @@ module Postamt
           task_names << task.name
           tasks_to_examine += task.prerequisite_tasks
         end
-        next if task_names.any? { |task_name| task_name.start_with? "db:" }
+        if task_names.any? { |task_name| task_name.start_with? "db:" }
+          # Stub out Postamt's monkeypatches if we're running in a Rake task
+          ActionController::Base.instance_eval do
+            def use_db_connection(connection, args)
+            end
+          end
+          ActiveRecord::Base.instance_eval do
+            class_attribute :default_connection
+          end
+          next
+        end
       end
       Postamt.hook!
     end

data/lib/postamt/version.rb

@@ -1,3 +1,3 @@
 module Postamt
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

data/postamt.gemspec

@@ -6,8 +6,8 @@ require 'postamt/version'
 Gem::Specification.new do |spec|
   spec.name          = "postamt"
   spec.version       = Postamt::VERSION
-  spec.authors       = ["Martin Schürrer"]
-  spec.email         = ["martin@schuerrer.org"]
+  spec.authors       = ["Martin Schürrer", "Martin Kavalar"]
+  spec.email         = ["martin@schuerrer.org", "martin@sauspiel.de"]
   spec.description   = %q{Choose per model and/or controller&action whether a read-only query should be sent to master or a hot standby. Or just use Postamt.on(:slave) { ... }. }
   spec.summary       = %q{Performs (some of) your read-only queries on a hot standby}
   spec.homepage      = "https://github.com/sauspiel/postamt"
@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "thread_safe", "~> 0.1"
-  spec.add_dependency "railties", [">= 3.2.0", "< 4.1.0"]
+  spec.add_dependency "railties", [">= 3.2.0", "<= 4.1.0"]
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: postamt
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Martin Schürrer
+- Martin Kavalar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-16 00:00:00.000000000 Z
+date: 2014-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thread_safe
@@ -31,7 +32,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.0
-    - - <
+    - - <=
       - !ruby/object:Gem::Version
         version: 4.1.0
   type: :runtime
@@ -41,7 +42,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.0
-    - - <
+    - - <=
       - !ruby/object:Gem::Version
         version: 4.1.0
 - !ruby/object:Gem::Dependency
@@ -77,11 +78,13 @@ description: 'Choose per model and/or controller&action whether a read-only quer
   }. '
 email:
 - martin@schuerrer.org
+- martin@sauspiel.de
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -111,9 +114,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Performs (some of) your read-only queries on a hot standby
 test_files: []
-has_rdoc: