kovyrin-db-charmer 1.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+/doc
+/pkg

data/LICENSE

@@ -0,0 +1,340 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+                       51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Library General
+Public License instead of this License.

data/Makefile

@@ -0,0 +1,2 @@
+doc/files/README_rdoc.html:	README.rdoc
+	rdoc README.rdoc

data/README.rdoc

@@ -0,0 +1,208 @@
+= DB Charmer - ActiveRecord Connection Magic Plugin
+
++DbCharmer+ is a simple yet powerful plugin for ActiveRecord that does a few things:
+
+1. Allows you to easily manage AR models' connections (+switch_connection_to+ method)
+2. Allows you to switch AR models' default connections to a separate servers/databases
+3. Allows you to easily choose where your query should go (<tt>Model.on_db</tt> methods)
+4. Allows you to automatically send read queries to your slaves while masters would handle all the updates.
+5. Adds multiple databases migrations to ActiveRecord
+
+
+== Installation ==
+
+There are two options when approaching db-charmer installation:
+* using gem (recommended)
+* install as a Rails plugin
+
+To install as a gem, add this to your environment.rb:
+
+  config.gem 'kovyrin-db-charmer', :lib => 'db_charmer',
+    :source => 'http://gems.github.com'
+
+And then run the command:
+
+  sudo rake gems:install
+
+To install db-charmer as a Rails plugin use this:
+
+  script/plugin install git://github.com/kovyrin/db-charmer.git
+
+
+== Easy ActiveRecord Connection Management
+
+As a part of this plugin we've added +switch_connection_to+ method that accepts many different kinds 
+of db connections and uses them on a model. We support:
+
+1. Strings and symbols as the names of connection configuration blocks in database.yml.
+2. ActiveRecord models (we'd use connection currently set up on a model).
+3. Database connections (<tt>Model.connection</tt>)
+4. Nil values to reset model to default connection.
+
+Sample code:
+
+  class Foo < ActiveRecord::Model; end
+	
+  Foo.switch_connection_to(:blah)
+  Foo.switch_connection_to('foo')
+  Foo.switch_connection_to(Bar)
+  Foo.switch_connection_to(Baz.connection)
+  Foo.switch_connection_to(nil)
+
+The +switch_connection_to+ method has an optional second parameter +should_exist+ which is true 
+by default. This parameter is used when the method is called with a string or a symbol connection 
+name and there is no such connection configuration in the database.yml file. If this parameter 
+is true, an exception would be raised, if it is false, the error would be ignored and no connection 
+change would happen. This is really useful when in development mode or in tests you do not want to 
+create many different databases on your local machine and just want to put all your tables in one 
+database.
+
+
+== Multiple DB Migrations
+
+In every application that works with many databases, there is need in convenient schema migrations mechanism. 
+
+All Rails users already have this mechanism - rails migrations. So in +DbCharmer+, we've made it possible 
+to seamlessly use multiple databases in Rails migrations.
+
+There are two methods available in migrations to operate on more than one database:
+
+1. Global connection change method - used to switch whole migration to a non-default database.
+2. Block-level connection change method - could be used to do only a part of a migration on a non-default db.
+
+Migration class example (global connection rewrite):
+
+  class MultiDbTest < ActiveRecord::Migration
+     db_magic :connection => :second_db
+   
+     def self.up
+       create_table :test_table, :force => true do |t|
+         t.string :test_string
+         t.timestamps
+       end
+     end
+   
+     def self.down
+       drop_table :test_table
+     end
+   end
+
+Migration class example (block-level connection rewrite):
+
+  class MultiDbTest < ActiveRecord::Migration
+    def self.up
+      on_db :second_db do
+        create_table :test_table, :force => true do |t|
+          t.string :test_string
+          t.timestamps
+        end
+      end
+    end
+  
+    def self.down
+      on_db :second_db { drop_table :test_table }
+    end
+  end
+
+
+By default in development and test environments you could skip this <tt>:second_db</tt> 
+connection from your database.yml files, but in production you'd specify it and 
+get the table created on a separate server and/or in a separate database.
+
+This behaviour is controlled by the <tt>DbCharmer.migration_connections_should_exist</tt> 
+configuration attribute which could be set from a rails initializer.
+
+
+== Using Models in Master-Slave Environments
+
+Master-slave replication is the most popular scale-out technique in medium and large 
+database applications today. There are some rails plugins out there that help rails 
+developers to use slave servers in their models but none of there were flexible enough 
+for us to start using them in a huge application we work on.
+
+So, we've been using ActsAsReadonlyable plugin for a long time and have developed a 
+lots of additions to its code over that time. Since that plugin has been abandoned 
+by its authors, we've decided to collect all of our master-slave code in one plugin 
+and release it for rails 2.2+. +DbCharmer+ adds the following features to Rails models:
+
+
+=== Auto-Switching all Reads to Slave(s)
+
+When you create a model, you could use <tt>db_magic :slave => :blah</tt> or 
+<tt>db_magic :slaves => [ :foo, :bar ]</tt> commands in your model to set up reads 
+redirection mode when all your find/count/exist/etc methods will be reading data 
+from your slave (or a bunch of slaves in a round-robin manner). Here is an example:
+
+  class Foo < ActiveRecord::Base
+    db_magic :slave => :slave01
+  end
+
+  class Bar < ActiveRecord::Base
+    db_magic :slaves => [ :slave01, :slave02 ]
+  end
+
+
+=== Default Connection Switching
+
+If you have more than one master-slave cluster (or simply more than one database) 
+in your database environment, then you might want to change the default database 
+connection of some of your models. You could do that by using 
+<tt>db_magic :connection => :foo</tt> call from your models. Example:
+
+  class Foo < ActiveRecord::Base
+    db_magic :connection => :foo
+  end
+
+Sample model on a separate master-slave cluster (so, separate main connection + 
+a slave connection):
+
+  class Bar < ActiveRecord::Base
+    db_magic :connection => :bar, :slave => :bar_slave
+  end
+
+=== Per-Query Connection Management
+
+Sometimes you have some select queries that you know you want to run on the master. 
+This could happen for example when you have just added some data and need to read 
+it back and not sure if it made it all the way to the slave yet or no. For this 
+situation an few others there are a few methods we've added to ActiveRecord models:
+
+1) +on_master+ - this method could be used in two forms: block form and proxy form. 
+In the block form you could force connection switch for a block of code:
+
+  User.on_master do
+    user = User.find_by_login('foo')
+    user.update_attributes!(:activated => true)
+  end
+
+In the proxy form this method could be used to force one query to be performed on 
+the master database server:
+
+  Comment.on_master.last(:limit => 5)
+  User.on_master.find_by_activation_code(code)
+  User.on_master.exists?(:login => login, :password => password)
+
+2) +on_slave+ - this method is used to force a query to be run on a slave even in 
+situations when it's been previously forced to use the master. If there is more 
+than one slave, one would be selected randomly. Tis method has two forms as 
+well: block and proxy.
+
+3) <tt>on_db(connection)</tt> - this method is what makes two previous methods possible. 
+It is used to switch a model's connection to some db for a short block of code 
+or even for one statement (two forms). It accepts the same range of values as 
+the +switch_connection_to+ method does.
+
+
+== Documentation
+
+For more information on the plugin internals, please check out the source code. All the plugin's code is covered with tests that were placed in a separate staging rails project located at http://github.com/kovyrin/db-charmer-sandbox. The project has unit tests for all or at least the most of the parts of plugin's code.
+
+
+== What Ruby and Rails implementations does it work for?
+
+We've tested the plugin on MRI 1.8.6 with Rails 2.3.3. After the initial testing phase we're going to deploy this code in production.
+
+
+== Who are the authors?
+
+This plugin has been created in Scribd.com for our internal use and then the sources were opened for other people to use. All the code in this package has been developed by Alexey Kovyrin for Scribd.com and is released under the GPLv2 license. For more details, see the LICENSE file.

data/Rakefile

@@ -0,0 +1,15 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = 'db-charmer'
+    gemspec.summary = 'db-charmer 1.0.1'
+    gemspec.description = 'ActiveRecord Connections Magic (slaves, multiple connections, etc)'
+    gemspec.email = 'alexey@kovyrin.net'
+    gemspec.homepage = 'http://github.com/kovyrin/db-charmer'
+    gemspec.authors = ['Alexey Kovyrin']
+
+    gemspec.add_dependency('rails', '>= 2.3.3')
+  end
+rescue LoadError
+  puts 'Jeweler not available. Install it with: sudo gem install jeweler'
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.1

data/db-charmer.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{db-charmer}
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alexey Kovyrin"]
+  s.date = %q{2009-08-26}
+  s.description = %q{ActiveRecord Connections Magic (slaves, multiple connections, etc)}
+  s.email = %q{alexey@kovyrin.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "Makefile",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "db-charmer.gemspec",
+     "init.rb",
+     "lib/db_charmer.rb",
+     "lib/db_charmer/active_record_extensions.rb",
+     "lib/db_charmer/connection_factory.rb",
+     "lib/db_charmer/connection_proxy.rb",
+     "lib/db_charmer/connection_switch.rb",
+     "lib/db_charmer/db_magic.rb",
+     "lib/db_charmer/finder_overrides.rb",
+     "lib/db_charmer/multi_db_migrations.rb",
+     "lib/db_charmer/multi_db_proxy.rb"
+  ]
+  s.homepage = %q{http://github.com/kovyrin/db-charmer}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{db-charmer 1.0.1}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, [">= 2.3.3"])
+    else
+      s.add_dependency(%q<rails>, [">= 2.3.3"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 2.3.3"])
+  end
+end

data/init.rb

@@ -0,0 +1,4 @@
+# Placeholder to satisfy Rails.
+#
+# Do NOT add any require statements to this file. Doing
+# so will cause Rails to load this plugin all of the time.

data/lib/db_charmer.rb

@@ -0,0 +1,44 @@
+module DbCharmer
+  @@migration_connections_should_exist = Rails.env.production?
+  mattr_accessor :migration_connections_should_exist
+
+  def self.migration_connections_should_exist?
+    !! migration_connections_should_exist
+  end
+
+  @@connections_should_exist = Rails.env.production?
+  mattr_accessor :connections_should_exist
+
+  def self.connections_should_exist?
+    !! connections_should_exist
+  end
+  
+  def self.logger
+    return Rails.logger if defined?(Rails)
+    @logger ||= Logger.new(STDERR)
+  end
+end
+
+require 'db_charmer/active_record_extensions'
+require 'db_charmer/connection_factory'
+require 'db_charmer/connection_proxy'
+require 'db_charmer/connection_switch'
+require 'db_charmer/db_magic'
+require 'db_charmer/finder_overrides'
+require 'db_charmer/multi_db_migrations'
+require 'db_charmer/multi_db_proxy'
+
+# Enable misc AR extensions
+ActiveRecord::Base.extend(DbCharmer::ActiveRecordExtensions::ClassMethods)
+
+# Enable connections switching in AR
+ActiveRecord::Base.extend(DbCharmer::ConnectionSwitch::ClassMethods)
+
+# Enable connection proxy in AR
+ActiveRecord::Base.extend(DbCharmer::MultiDbProxy::ClassMethods)
+
+# Enable multi-db migrations
+ActiveRecord::Migration.extend(DbCharmer::MultiDbMigrations::ClassMethods)
+
+# Enable the magic
+ActiveRecord::Base.extend(DbCharmer::DbMagic::ClassMethods)

data/lib/db_charmer/active_record_extensions.rb

@@ -0,0 +1,75 @@
+module DbCharmer
+  module ActiveRecordExtensions
+    module ClassMethods
+
+      def establish_real_connection_if_exists(name, should_exist = false)
+        config = configurations[RAILS_ENV][name.to_s]
+        if should_exist && !config
+          raise ArgumentError, "Invalid connection name (does not exist in database.yml): #{RAILS_ENV}/#{name}"
+        end
+        establish_connection(config) if config
+      end
+
+      #-----------------------------------------------------------------------------
+      @@db_charmer_opts = {}
+      def db_charmer_opts=(opts)
+        @@db_charmer_opts[self.to_s] = opts
+      end
+
+      def db_charmer_opts
+        @@db_charmer_opts[self.to_s] || {}
+      end
+
+      #-----------------------------------------------------------------------------
+      @@db_charmer_connection_proxies = {}
+      def db_charmer_connection_proxy=(proxy)
+        @@db_charmer_connection_proxies[self.to_s] = proxy
+      end
+
+      def db_charmer_connection_proxy
+        @@db_charmer_connection_proxies[self.to_s]
+      end
+
+      #-----------------------------------------------------------------------------
+      @@db_charmer_slaves = {}
+      def db_charmer_slaves=(slaves)
+        @@db_charmer_slaves[self.to_s] = slaves
+      end
+
+      def db_charmer_slaves
+        @@db_charmer_slaves[self.to_s] || []
+      end
+
+      def db_charmer_random_slave
+        return nil unless db_charmer_slaves.any?
+        db_charmer_slaves[rand(db_charmer_slaves.size)]
+      end
+
+      #-----------------------------------------------------------------------------
+      @@db_charmer_connection_levels = Hash.new(0)
+      def db_charmer_connection_level=(level)
+        @@db_charmer_connection_levels[self.to_s] = level
+      end
+
+      def db_charmer_connection_level
+        @@db_charmer_connection_levels[self.to_s] || 0
+      end
+
+      def db_charmer_top_level_connection?
+        db_charmer_connection_level.zero?
+      end
+
+      #-----------------------------------------------------------------------------
+      def hijack_connection!
+        # FIXME: make sure we do not do it more often then needed
+#        puts "DEBUG: Hijacking connection for #{self.to_s}"
+        class << self 
+          def connection
+            db_charmer_connection_proxy || super
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/db_charmer/connection_factory.rb

@@ -0,0 +1,38 @@
+module DbCharmer
+  class ConnectionFactory
+    @@connection_classes = {}
+
+    def self.reset!
+      @@connection_classes = {}
+    end
+
+    def self.connect(db_name, should_exist = false)
+      @@connection_classes[db_name.to_s] ||= establish_connection(db_name.to_s, should_exist)
+      DbCharmer.logger.warn("ConnectionFactory.connect(#{db_name}) = #{@@connection_classes[db_name.to_s]}")
+      return @@connection_classes[db_name.to_s]
+    end
+
+    def self.establish_connection(db_name, should_exist = false)
+      DbCharmer.logger.debug("Creating a connection proxy for #{db_name}")
+      abstract_class = generate_abstract_class(db_name, should_exist)
+      DbCharmer::ConnectionProxy.new(abstract_class)
+    end
+
+    def self.generate_abstract_class(db_name, should_exist = false)
+      DbCharmer.logger.info("Generating abstract connection class for #{db_name}: #{abstract_connection_class_name db_name}")
+
+      module_eval <<-EOF, __FILE__, __LINE__ + 1
+        class #{abstract_connection_class_name db_name} < ActiveRecord::Base
+          self.abstract_class = true
+          establish_real_connection_if_exists(:#{db_name}, #{!!should_exist})
+        end
+      EOF
+
+      abstract_connection_class_name(db_name).constantize
+    end
+
+    def self.abstract_connection_class_name(db_name)
+      "::AutoGeneratedAbstractConnectionClass#{db_name.camelize}"
+    end
+  end
+end

data/lib/db_charmer/connection_proxy.rb

@@ -0,0 +1,12 @@
+module DbCharmer
+  class ConnectionProxy < BlankSlate
+    def initialize(abstract_class)
+      @abstract_connection_class = abstract_class
+    end
+
+    def method_missing(meth, *args, &block)
+      DbCharmer.logger.debug("Proxying #{meth} call to #{@abstract_connection_class}")
+      @abstract_connection_class.retrieve_connection.send(meth, *args, &block)
+    end
+  end
+end

data/lib/db_charmer/connection_switch.rb

@@ -0,0 +1,29 @@
+module DbCharmer
+  module ConnectionSwitch
+    module ClassMethods
+      def coerce_to_connection_proxy(conn, should_exist = true)
+        return nil if conn.nil?
+
+        if conn.kind_of?(Symbol) || conn.kind_of?(String)
+          return DbCharmer::ConnectionFactory.connect(conn, should_exist)
+        end
+
+        if conn.respond_to?(:db_charmer_connection_proxy)
+          return conn.db_charmer_connection_proxy
+        end
+
+        if conn.kind_of?(ActiveRecord::ConnectionAdapters::AbstractAdapter)
+          return conn
+        end
+
+        raise "Unsupported connection type: #{conn.class}"
+      end
+
+      def switch_connection_to(conn, require_config_to_exist = true)
+#        puts "DEBUG: Assigning connection proxy for #{self}"
+        self.db_charmer_connection_proxy = coerce_to_connection_proxy(conn, require_config_to_exist)
+        self.hijack_connection!
+      end
+    end
+  end
+end

data/lib/db_charmer/db_magic.rb

@@ -0,0 +1,49 @@
+module DbCharmer
+  module DbMagic
+    module ClassMethods
+      def db_magic(opt = {})
+        # Make sure we could use our connections management here
+        hijack_connection!
+
+        # Should requested connections exist in the config?
+        should_exist = opt[:should_exist] || DbCharmer.connections_should_exist?
+
+        # Main connection management
+        db_magic_connection(opt[:connection], should_exist) if opt[:connection]
+
+        # Set up slaves pool
+        opt[:slaves] ||= []
+        opt[:slaves] << opt[:slave] if opt[:slave]
+        db_magic_slaves(opt[:slaves], should_exist) if opt[:slaves].any?
+        
+        # Setup inheritance magic
+        setup_children_magic(opt)
+      end
+
+    private
+
+      def setup_children_magic(opt)
+        self.db_charmer_opts = opt.clone
+        
+        def self.inherited(child)
+          child.db_magic(self.db_charmer_opts)
+          super
+        end
+      end
+
+      def db_magic_connection(conn, should_exist = false)
+        switch_connection_to(conn, should_exist)
+      end
+
+      def db_magic_slaves(slaves, should_exist = false)
+        self.db_charmer_slaves = slaves.collect do |slave|
+          coerce_to_connection_proxy(slave, should_exist)
+        end
+
+        self.extend(DbCharmer::FinderOverrides::ClassMethods)
+        self.send(:include, DbCharmer::FinderOverrides::InstanceMethods)
+        self.extend(DbCharmer::MultiDbProxy::MasterSlaveClassMethods)
+      end
+    end
+  end
+end

data/lib/db_charmer/finder_overrides.rb

@@ -0,0 +1,47 @@
+module DbCharmer
+  module FinderOverrides
+    module ClassMethods
+      SLAVE_METHODS = [ :find_by_sql, :count_by_sql, :calculate ]
+      MASTER_METHODS = [ :update, :create, :delete, :destroy, :delete_all, :destroy_all, :update_all, :update_counters ]
+
+      SLAVE_METHODS.each do |slave_method|
+        class_eval <<-EOF
+          def #{slave_method}(*args, &block)
+            first_level_on_slave do
+              super(*args, &block)
+            end
+          end
+        EOF
+      end
+
+      MASTER_METHODS.each do |master_method|
+        class_eval <<-EOF
+          def #{master_method}(*args, &block)
+            on_master do
+              super(*args, &block)
+            end
+          end
+        EOF
+      end
+
+    private
+
+      def first_level_on_slave
+        if db_charmer_top_level_connection?
+          on_slave { yield }
+        else
+          yield
+        end
+      end
+
+    end
+
+    module InstanceMethods
+      def reload(*args, &block)
+        self.class.on_master do
+          super(*args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/db_charmer/multi_db_migrations.rb

@@ -0,0 +1,42 @@
+module DbCharmer
+  module MultiDbMigrations
+    class MigrationAbstractClass < ActiveRecord::Base
+      abstract_class = true
+      hijack_connection!
+    end
+
+    module ClassMethods
+      def hijack_connection!
+        class << self
+          def connection
+            puts "DEBUG: Retrieving migration connection"
+            MigrationAbstractClass.connection
+          end
+        end
+      end
+
+      def on_db(db_name)
+        hijack_connection!
+        announce "Switching connection to #{db_name}"
+        old_proxy = MigrationAbstractClass.db_charmer_connection_proxy
+        MigrationAbstractClass.switch_connection_to(db_name, DbCharmer.migration_connections_should_exist?)
+        yield
+      ensure
+        announce "Checking all database connections"
+        ActiveRecord::Base.verify_active_connections!
+        announce "Switching connection back to default"
+        MigrationAbstractClass.switch_connection_to(old_proxy)
+      end
+
+      def works_on_db(db_name)
+        hijack_connection!
+        MigrationAbstractClass.switch_connection_to(db_name, DbCharmer.migration_connections_should_exist?)
+      end
+
+      def db_magic(opts = {})
+        raise ArgumentError, "No connection name - no magic!" unless opts[:connection]
+        works_on_db(opts[:connection])
+      end
+    end
+  end
+end

data/lib/db_charmer/multi_db_proxy.rb

@@ -0,0 +1,48 @@
+module DbCharmer
+  module MultiDbProxy
+    class OnDbProxy < BlankSlate
+      def initialize(model_class, slave)
+        @model = model_class
+        @slave = slave
+      end
+
+    private
+
+      def method_missing(meth, *args, &block)
+        @model.on_db(@slave) do |m|
+          m.__send__(meth, *args, &block)
+        end
+      end
+    end
+
+    module ClassMethods
+      def on_db(con)
+        # Chain call
+        return OnDbProxy.new(self, con) unless block_given?
+
+        # Block call
+        begin
+          self.db_charmer_connection_level += 1
+          old_proxy = db_charmer_connection_proxy
+          switch_connection_to(con, DbCharmer.migration_connections_should_exist?)
+          yield(self)
+        ensure
+          switch_connection_to(old_proxy)
+          self.db_charmer_connection_level -= 1
+        end
+      end
+    end
+    
+    module MasterSlaveClassMethods
+      def on_slave(con = nil, &block)
+        con ||= db_charmer_random_slave
+        raise ArgumentError, "No slaves found in the class and no slave connection given" unless con
+        on_db(con, &block)
+      end
+
+      def on_master(&block)
+        on_db(nil, &block)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: kovyrin-db-charmer
+version: !ruby/object:Gem::Version 
+  version: 1.0.1
+platform: ruby
+authors: 
+- Alexey Kovyrin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-26 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+description: ActiveRecord Connections Magic (slaves, multiple connections, etc)
+email: alexey@kovyrin.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- Makefile
+- README.rdoc
+- Rakefile
+- VERSION
+- db-charmer.gemspec
+- init.rb
+- lib/db_charmer.rb
+- lib/db_charmer/active_record_extensions.rb
+- lib/db_charmer/connection_factory.rb
+- lib/db_charmer/connection_proxy.rb
+- lib/db_charmer/connection_switch.rb
+- lib/db_charmer/db_magic.rb
+- lib/db_charmer/finder_overrides.rb
+- lib/db_charmer/multi_db_migrations.rb
+- lib/db_charmer/multi_db_proxy.rb
+has_rdoc: false
+homepage: http://github.com/kovyrin/db-charmer
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 3
+summary: db-charmer 1.0.1
+test_files: []
+