revolutionhealth-masochism 0.0.1

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2007 Rick Olson
+
+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.markdown

@@ -0,0 +1,154 @@
+masochism
+=========
+
+<div style="width:240px; padding:2px; border:1px solid silver; float:right; margin:0 0 1em 2em; background:white">
+  <img src="http://farm1.static.flickr.com/111/295426387_a39c5c8954_m.jpg" alt="Scream" />
+  <p style="text-align:center">photo by <a href="http://flickr.com/people/alphadesigner/" title="Flickr: ArtWerk">ArtWerk</a></p>
+</div>
+
+The masochism plugin provides an easy solution for Ruby on Rails applications to work in a
+replicated database environment. It works by replacing the `connection` object accessed by
+ActiveRecord models by ConnectionProxy that chooses between master and slave when
+executing queries. Generally all writes go to master.
+
+
+Quick setup
+-----------
+
+First, setup your database.yml:
+
+    # default configuration (slave)
+    production: &defaults
+      adapter: mysql
+      database: app_production
+      username: webapp
+      password: ********
+      host: localhost
+
+    # setup for masochism (master)
+    master_database:
+      <<: *defaults
+      host: master.example.com
+
+To enable masochism, this is required:
+
+    # enable masochism
+    ActiveReload::ConnectionProxy.setup!
+
+Example usage:
+    
+    # in environment.rb
+    config.after_initialize do
+      if Rails.env.production?
+        ActiveReload::ConnectionProxy::setup!
+      end
+    end
+
+
+Considerations
+--------------
+
+### Thinking Sphinx
+
+Thinking Sphinx inspects the `connection` object to determine the database adapter.
+Because masochism works by putting the connection proxy in its place, TS will be confused
+about `ActiveReload::ConnectionProxy` and abort. A possible workaround is to monkeypatch TS right to **hardcode** our adapter after masochism has been enabled:
+
+    # ConnectionProxy from masochism confuses TS
+    ThinkingSphinx::Index.class_eval do
+      def adapter() :mysql end
+    end
+
+    ThinkingSphinx::AbstractAdapter.class_eval do
+      def self.detect(model)
+        ThinkingSphinx::MysqlAdapter
+      end
+    end
+
+### Litespeed web server or Phusion Passenger (mod\_rails)
+
+If you are using the Litespeed web server or Passenger (mod\_rails), child processes are initialized on creation,
+which means any setup done in an environment file will be effectively ignored. [A brief
+discussion of the problem is posted here](http://litespeedtech.com/support/wiki/doku.php?id=litespeed_wiki:rails:memcache).
+
+One solution for Litespeed/Passenger users is to check the connection at your first request and do
+the `setup!` call if your connection hasn't been initialized, like:
+
+    # in ApplicationController
+    prepend_before_filter do |controller|
+      unless ActiveRecord::Base.connection.is_a? ActiveReload::ConnectionProxy
+        ActiveReload::ConnectionProxy.setup!
+      end
+    end
+
+
+Advanced
+--------
+
+The ActiveReload::MasterDatabase model uses a 'master\_database' setting that can either be
+defined for all of your environments, or for each environment as a nested declaration.
+
+The ActiveReload::SlaveDatabase model uses a 'slave\_database' setting that can only be
+defined per environment.
+
+Example:
+
+    login: &login
+      adapter: postgresql
+      host: localhost
+      port: 5432
+    
+    production:
+      database: production_slave_database_name
+      <<: *login
+    
+    master_database:
+      database: production_master_database_name
+      <<: *login
+    
+    staging:
+      database: staging_database_name
+      host: slave-db-pool.local
+      <<: *login
+      master_database: 
+        database: staging_database_name
+        host: master-db-server.local
+        <<: *login
+    
+    qa:
+      database: qa_master_database_name
+      host: qa-master
+      <<: *login
+      slave_database:
+        database: qa_slave_database_name
+        host: qa-slave
+        <<: *login
+    
+    development: # Does not use masochism
+      database: development_database_name
+      <<: *login
+ 
+If you want a model to always use the Master database, you can inherit
+`ActiveReload::MasterDatabase`. Any models with their own database connection will not be
+affected.
+
+### More control at setup
+
+By default, masochism `setup!` is a shorthand for this:
+
+    ActiveReload::ConnectionProxy.setup_for ActiveReload::MasterDatabase, ActiveRecord::Base
+
+The first argument is the model that has the master database connection established; the
+second argument is the model whose `connection` gets hijacked by ConnectionProxy. But we
+don't have to touch `ActiveRecord::Base` at all:
+
+    # set up MyMaster's connection as the master database connection for User:
+    ActiveReload::ConnectionProxy.setup_for MyMaster, User
+
+### The controller filter
+
+If you have any actions you know require the master database for both reads and writes,
+simply do the following:
+
+    # in a controller:
+    around_filter ActiveReload::MasterFilter, :only => [:show, :edit, :update]

data/lib/active_reload/connection_proxy.rb

@@ -0,0 +1,141 @@
+module ActiveReload
+  class MasterDatabase < ActiveRecord::Base
+    self.abstract_class = true
+    establish_connection configurations[Rails.env]['master_database'] || configurations['master_database'] || Rails.env
+  end
+
+  class SlaveDatabase < ActiveRecord::Base
+    self.abstract_class = true
+    def self.name
+      ActiveRecord::Base.name
+    end
+    establish_connection configurations[Rails.env]['slave_database'] || Rails.env
+  end
+
+  class ConnectionProxy
+    
+    def initialize(master_class, slave_class)
+      @master  = master_class
+      @slave   = slave_class
+      @current = :slave
+    end
+    
+    def master
+      @slave.connection_handler.retrieve_connection(@master)
+    end
+    
+    def slave
+      @slave.retrieve_connection
+    end
+    
+    def current
+      send @current
+    end
+    
+    def self.setup!
+      if slave_defined?
+        setup_for ActiveReload::MasterDatabase, ActiveReload::SlaveDatabase
+      else
+        setup_for ActiveReload::MasterDatabase
+      end
+    end
+
+    def self.slave_defined?
+      ActiveRecord::Base.configurations[Rails.env]['slave_database']
+    end
+
+    def self.setup_for(master, slave = nil)
+      slave ||= ActiveRecord::Base
+      slave.send :include, ActiveRecordConnectionMethods
+      ActiveRecord::Observer.send :include, ActiveReload::ObserverExtensions
+      slave.connection_proxy = new(master, slave)
+    end
+
+    def with_master(to_slave = true)
+      set_to_master!
+      yield
+    ensure
+      set_to_slave! if to_slave
+    end
+
+    def set_to_master!
+      unless @current == :master
+#        @slave.logger.info caller.inspect
+        @slave.logger.info "Switching to Master"
+        @current = :master
+      end
+    end
+
+    def set_to_slave!
+      unless @current == :slave
+#        @master.logger.info caller.inspect
+        @master.logger.info "Switching to Slave"
+        @current = :slave
+      end
+    end
+
+    delegate :insert, :update, :delete, :create_table, :rename_table, :drop_table, :add_column, :remove_column,
+      :change_column, :change_column_default, :rename_column, :add_index, :remove_index, :initialize_schema_migrations_table, :select_values,
+      :dump_schema_information, :execute, :columns, :to => :master
+
+    def transaction(start_db_transaction = true, &block)
+      with_master(start_db_transaction) do
+        master.transaction(start_db_transaction, &block)
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      val = current.send(method, *args, &block)
+      val
+    end
+  end
+
+  module ActiveRecordConnectionMethods
+    def self.included(base)
+      base.alias_method_chain :reload, :master
+      
+      class << base
+        def connection_proxy=(proxy)
+          @@connection_proxy = proxy
+        end
+        
+        # hijack the original method
+        #only return if current is defined
+        #calling retrieve_connection thru current also trigger code that 
+        #raises a ConnectionError if the db is not created, this fixes the 
+        #problem with running rake db:create in rails 2.2.2
+        def connection
+          @@connection_proxy if @@connection_proxy.current
+        end
+      end
+    end
+
+    def reload_with_master(*args, &block)
+      if connection.class.name == "ActiveReload::ConnectionProxy"
+        connection.with_master { reload_without_master }
+      else
+        reload_without_master
+      end
+    end
+  end
+
+  # extend observer to always use the master database
+  # observers only get triggered on writes, so shouldn't be a performance hit
+  # removes a race condition if you are using conditionals in the observer
+  module ObserverExtensions
+    def self.included(base)
+      base.alias_method_chain :update, :masterdb
+    end
+
+    # Send observed_method(object) if the method exists.
+    def update_with_masterdb(observed_method, object) #:nodoc:
+      if object.class.connection.respond_to?(:with_master)
+        object.class.connection.with_master do
+          update_without_masterdb(observed_method, object)
+        end
+      else
+        update_without_masterdb(observed_method, object)
+      end
+    end
+  end
+end

data/lib/active_reload/master_filter.rb

@@ -0,0 +1,12 @@
+module ActiveReload
+  # MasterFilter should be used as an around filter in your controllers that require certain actions to use the Master DB for reads as well as writes
+  class MasterFilter
+    def self.filter(controller, &block)
+      if ActiveRecord::Base.connection.respond_to?(:with_master)
+        ActiveRecord::Base.connection.with_master(&block)
+      else
+        yield block
+      end
+    end
+  end
+end

data/lib/masochism.rb

@@ -0,0 +1,12 @@
+require 'rake'
+
+namespace :db do
+  task :create => :environment do
+    create_database(ActiveRecord::Base.configurations[RAILS_ENV]["master_database"])
+  end
+end
+
+require 'active_reload/connection_proxy'
+require 'active_reload/master_filter'
+
+#ActiveReload::ConnectionProxy.setup!

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: revolutionhealth-masochism
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Revolution Health
+autorequire: masochism
+bindir: bin
+cert_chain: []
+
+date: 2009-01-23 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: ActiveRecord connection proxy for master/slave connections
+email: rails@revolutionhealth.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- README.markdown
+- lib/active_reload/connection_proxy.rb
+- lib/active_reload/master_filter.rb
+- lib/masochism.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/revolutionhealth/masochism/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 1
+summary: ActiveRecord connection proxy for master/slave connections
+test_files: []
+