active_record_slave 0.1.0

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2012 Clarity Services, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,148 @@
+active_record_slave
+===================
+
+* http://github.com/ClarityServices/active_record_slave
+
+### Introduction
+
+active_record_slave allows all database reads to go to a slave while ensuring
+that all writes go to the master database. Also, active_record_slave ensures that
+any reads that are performed in a transaction will always go to the master
+database to ensure data consistency.
+
+### Features
+
+* Redirecting reads to a single slave database
+* Supports all Rails 3 read apis, including dynamic finders, AREL, and ActiveRecord::Base.select
+* Transaction aware. Detects when a query is inside of a transaction and sends
+  those reads to the master
+* Lightweight footprint
+* No overhead when a slave is not configured
+* Minimal overhead when redirecting reads to the slave
+* Connection Pools to both databases are retained and maintained independently by ActiveRecord
+* The master and slave databases do not have to be of the same type.
+  For example one can be MySQL and the other Oracle if required.
+* Debug logs include 'Slave: ' prefix to indicate which SQL statements are going
+  to the slave database
+
+# For Example the following code:
+    r = Role.where(:name => "manager").first
+    r.description = 'Manager'
+    r.save!
+
+Results in:
+    03-13-12 05:56:05 pm,[2608],b[0],[0],  Slave: Role Load (3.0ms)  SELECT `roles`.* FROM `roles` WHERE `roles`.`name` = 'manager' LIMIT 1
+    03-13-12 05:56:22 pm,[2608],b[0],[0],  AREL (12.0ms)  UPDATE `roles` SET `description` = 'Manager' WHERE `roles`.`id` = 5
+
+# Example code showing use of a transaction and reads going to the master:
+    Role.transaction do
+      r = Role.where(:name => "manager").first
+      r.description = 'Manager'
+      r.save!
+    end
+
+Results in:
+    03-13-12 06:02:09 pm,[2608],b[0],[0],  Role Load (2.0ms)  SELECT `roles`.* FROM `roles` WHERE `roles`.`name` = 'manager' LIMIT 1
+    03-13-12 06:02:09 pm,[2608],b[0],[0],  AREL (2.0ms)  UPDATE `roles` SET `description` = 'Manager' WHERE `roles`.`id` = 4
+
+### Requirements
+
+* Rails 3 or greater
+
+May also work with Rails 2. Anyone want to give it a try and let me know?
+Happy to make it work with Rails 2 if anyone needs it
+
+### Note
+
+ActiveRecord::Base.execute is commonly used to perform custom SQL calls against
+the database that bypasses ActiveRecord. It is necessary to replace these calls
+with the standard ActiveRecord::Base.select call for them to be picked up by
+active_record_slave and redirected to the slave.
+
+This is because ActiveRecord::Base.execute can also be used for database updates
+which we do not want redirected to the slave
+
+### Install
+
+  gem install active_record_slave
+
+### Configuration
+
+To enable slave reads for any environment just add a _slave:_ entry to database.yml
+along with all the usual ActiveRecord database configuration options.
+
+For Example:
+
+    development:
+      database: clarity_development
+      username: root
+      password:
+      encoding: utf8
+      adapter:  mysql
+      host:     127.0.0.1
+      pool:     20
+      slave:
+        database: clarity_development_replica
+        username: root
+        password:
+        encoding: utf8
+        adapter:  mysql
+        host:     127.0.0.1
+        pool:     20
+
+Sometimes it is useful to turn on slave reads per host, for example to activate
+slave reads only on the linux host 'batch':
+    development:
+      database: clarity_development
+      username: root
+      password:
+      encoding: utf8
+      adapter:  mysql
+      host:     127.0.0.1
+      pool:     20
+    <% if `hostname`.strip == 'batch' %>
+      slave:
+        database: clarity_development_replica
+        username: root
+        password:
+        encoding: utf8
+        adapter:  mysql
+        host:     127.0.0.1
+        pool:     20
+    <% end %>
+
+### Possible Future Enhancements
+
+* Support multiple slaves (ask for it by submitting a ticket)
+
+Meta
+----
+
+* Code: `git clone git://github.com/ClarityServices/active_record_slave.git`
+* Home: <https://github.com/ClarityServices/active_record_slave>
+* Bugs: <http://github.com/reidmorrison/active_record_slave/issues>
+* Gems: <http://rubygems.org/gems/active_record_slave>
+
+This project uses [Semantic Versioning](http://semver.org/).
+
+Authors
+-------
+
+Reid Morrison :: reidmo@gmail.com :: @reidmorrison
+
+License
+-------
+
+Copyright 2012 Clarity Services, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,36 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'rake/clean'
+require 'rake/testtask'
+require 'date'
+require 'active_record_slave/version'
+
+desc "Build gem"
+task :gem  do |t|
+  gemspec = Gem::Specification.new do |s|
+    s.name        = 'active_record_slave'
+    s.version     = ActiveRecordSlave::VERSION
+    s.platform    = Gem::Platform::RUBY
+    s.authors     = ['Reid Morrison']
+    s.email       = ['reidmo@gmail.com']
+    s.homepage    = 'https://github.com/ClarityServices/active_record_slave'
+    s.date        = Date.today.to_s
+    s.summary     = "ActiveRecord read from slave"
+    s.description = "ActiveRecordSlave is a library to seamlessly enable reading from database slaves in a Rails 3 project, written in Ruby."
+    s.files       = FileList["./**/*"].exclude('*.gem', 'nbproject').map{|f| f.sub(/^\.\//, '')}
+    s.has_rdoc    = true
+    #s.add_dependency 'activerecord', '>= 3.0.0'
+  end
+  Gem::Builder.new(gemspec).build
+end
+
+desc "Run Test Suite"
+task :test do
+  Rake::TestTask.new(:functional) do |t|
+    t.test_files = FileList['test/*_test.rb']
+    t.verbose    = true
+  end
+
+  Rake::Task['functional'].invoke
+end

data/lib/active_record_slave/active_record_slave.rb

@@ -0,0 +1,22 @@
+#
+# ActiveRecord read from a slave
+#
+module ActiveRecordSlave
+
+  # Install ActiveRecord::Slave into ActiveRecord to redirect reads to the slave
+  # By default, only the default Database adapter (ActiveRecord::Base.connection.class)
+  # is extended with slave read capabilities
+  def self.install!(adapter_class = nil)
+    if slave_config = ActiveRecord::Base.connection.config[:slave]
+      Rails.logger.info "ActiveRecordSlave.install! v#{ActiveRecordSlave::VERSION} Establishing connection to slave database"
+      Slave.establish_connection(slave_config)
+
+      # Inject a new #select method into the ActiveRecord Database adapter
+      base = adapter_class || ActiveRecord::Base.connection.class
+      base.send(:include, InstanceMethods)
+      base.alias_method_chain :select, :slave_reader
+    end
+  end
+
+end
+

data/lib/active_record_slave/instance_methods.rb

@@ -0,0 +1,17 @@
+module ActiveRecordSlave
+  module InstanceMethods
+
+    # Database Adapter method #select is called for every select call
+    # Replace #select with one that calls the slave connection instead
+    def select_with_slave_reader(sql, name = nil)
+      # Only read from slave when not in a transaction and when this is not already the slave connection
+      if (open_transactions == 0) && !(name && name.starts_with?('Slave: '))
+        Slave.connection.select(sql, "Slave: #{name || 'SQL'}")
+      else
+        select_without_slave_reader(sql, name)
+      end
+    end
+
+  end
+end
+

data/lib/active_record_slave/railtie.rb

@@ -0,0 +1,10 @@
+module ActiveRecordSlave #:nodoc:
+  class Railtie < Rails::Railtie #:nodoc:
+
+    # Initialize ActiveRecordSlave
+    initializer "load active_record_slave" , :after=>"active_record.initialize_database" do
+      ActiveRecordSlave.install!
+    end
+
+  end
+end

data/lib/active_record_slave/slave.rb

@@ -0,0 +1,6 @@
+module ActiveRecordSlave
+  # Class to hold slave connection pool
+  class Slave < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/lib/active_record_slave/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordSlave #:nodoc
+  VERSION = "0.1.0"
+end

data/lib/active_record_slave.rb

@@ -0,0 +1,10 @@
+require 'active_record'
+require 'active_record/base'
+require 'active_record_slave/version'
+require 'active_record_slave/slave'
+require 'active_record_slave/instance_methods'
+require 'active_record_slave/active_record_slave'
+
+if defined?(Rails)
+  require 'active_record_slave/railtie'
+end

data/nbproject/private/private.properties

@@ -0,0 +1,3 @@
+file.reference.activerecord_slave-lib=/Users/rmorrison/Sandbox/activerecord_slave/lib
+file.reference.activerecord_slave-test=/Users/rmorrison/Sandbox/activerecord_slave/test
+platform.active=JRuby_0

data/nbproject/private/private.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project-private xmlns="http://www.netbeans.org/ns/project-private/1">
+    <editor-bookmarks xmlns="http://www.netbeans.org/ns/editor-bookmarks/1"/>
+</project-private>

data/nbproject/private/rake-d.txt

@@ -0,0 +1,4 @@
+clean=
+clobber=
+gem=
+test=

data/nbproject/project.properties

@@ -0,0 +1,8 @@
+file.reference.activerecord_slave-lib=lib
+file.reference.activerecord_slave-test=test
+javac.classpath=
+main.file=
+platform.active=JRuby_0
+source.encoding=UTF-8
+src.lib.dir=lib
+test.test.dir=test

data/nbproject/project.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://www.netbeans.org/ns/project/1">
+    <type>org.netbeans.modules.ruby.rubyproject</type>
+    <configuration>
+        <data xmlns="http://www.netbeans.org/ns/ruby-project/1">
+            <name>active_record_slave</name>
+            <source-roots>
+                <root id="src.lib.dir" name="Source Files"/>
+            </source-roots>
+            <test-roots>
+                <root id="test.test.dir" name="Test Files"/>
+            </test-roots>
+        </data>
+    </configuration>
+</project>

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: active_record_slave
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+  - Reid Morrison
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-13 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: ActiveRecordSlave is a library to seamlessly enable reading from database slaves in a Rails 3 project, written in Ruby.
+email: 
+  - reidmo@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - active_record_slave-0.1.0.gem
+  - LICENSE.txt
+  - Rakefile
+  - README.md
+  - lib/active_record_slave.rb
+  - lib/active_record_slave/active_record_slave.rb
+  - lib/active_record_slave/instance_methods.rb
+  - lib/active_record_slave/railtie.rb
+  - lib/active_record_slave/slave.rb
+  - lib/active_record_slave/version.rb
+  - nbproject/project.properties
+  - nbproject/project.xml
+  - nbproject/private/config.properties
+  - nbproject/private/private.properties
+  - nbproject/private/private.xml
+  - nbproject/private/rake-d.txt
+has_rdoc: true
+homepage: https://github.com/ClarityServices/active_record_slave
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.1
+signing_key: 
+specification_version: 3
+summary: ActiveRecord read from slave
+test_files: []
+