wye 0.0.1 → 0.0.2

data/README.rdoc

@@ -5,10 +5,59 @@ contextual execution of database queries on alternative database connections.
 Wye's patterns are most useful to applications making use of either replicated
 or federated databases.
 
+== Configuration
+
+Alternate connections are defined under the main connection's configuration
+entry. An example Rails +database.yml+ might look like the following in an
+environment where the MySQL database on +master-db.example+ is being
+replicated to +slave-db1.example+ and +slave-db2.example+.
+
+    production:
+      adapter: mysql2
+      username: 'username'
+      password: 'main password'
+      database: 'database'
+      host: 'master-db.example'
+      alternates:
+        slave1:
+          host: 'slave-db1.example'
+          password: 'slave password'
+        slave2:
+          host: 'slave-db2.example'
+          password: 'slave password'
+
+Each alternate entry is merged with that of its parent entry. In this same
+example, the resulting configuration for +slave1+ would be the following.
+
+    adapter: mysql2
+    username: 'username'
+    password: 'slave password'
+    database: 'database'
+    host: 'slave-db1.example'
+
 == Basic Usage Patterns
 
-(Documentation is forthcoming.)
+    class Model < ActiveRecord::Base; end
 
-== Configuration
+    # Calling .on executes the block on the given alternate connection
+    Model.on(:slave1) do
+      Model.find(1) # find Model 1 on the slave1 connection pool
+    end
+
+    # Class inheritance is respected
+    class DerivedModel < Model; end
+
+    Model.on(:slave1) do
+      Model.find(1)         # on slave1 pool
+      DerivedModel.find(1)  # on slave1 pool
+    end
+
+    DerivedModel.on(:slave1) do
+      Model.find(1)         # on main pool
+      DerivedModel.find(1)  # on slave1 pool
+    end
 
-(Documentation is forthcoming.)
+    # Execute everything that shares the base connection pool on slave1
+    ActiveRecord::Base.on(:slave1) do
+      # ...
+    end

data/lib/wye/active_record/base.rb

@@ -0,0 +1,15 @@
+require 'active_record'
+
+module Wye
+  module ActiveRecord
+    module Base
+      module ClassMethods
+        def on(alternate, &blk)
+          connection_handler.switch.on(alternate, &blk)
+        end
+      end
+    end
+  end
+end
+
+::ActiveRecord::Base.extend(Wye::ActiveRecord::Base::ClassMethods)

data/lib/wye/active_record.rb

@@ -1,5 +1,6 @@
 module Wye
   module ActiveRecord
     autoload :ConnectionHandler, 'wye/active_record/connection_handler'
+    autoload :Base, 'wye/active_record/base'
   end
 end

data/lib/wye/version.rb

@@ -1,3 +1,3 @@
 module Wye
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wye
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-07 00:00:00.000000000 Z
+date: 2012-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -53,6 +53,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/wye/active_record/base.rb
 - lib/wye/active_record/connection_handler.rb
 - lib/wye/active_record.rb
 - lib/wye/railtie.rb