acts_as_readonlyable 0.0.3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Revolution Health Group LLC. All rights reserved.
+
+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

@@ -0,0 +1,75 @@
+== Introduction
+
+ActsAsReadonlyable adds support of multiple read-only slave databases to ActiveRecord models. When a model is marked with acts_as_readonlyable, some of AR finders are overridden to run against a slave DB. The supported finders are find, find_by_sql, count_by_sql, find_[all_]by_*, and reload.
+
+Finders can be forced to fall back to a default DB by passing the :readonly flag set to 'false'.
+
+== Disclaimer
+
+As our blog entry http://revolutiononrails.blogspot.com/2007/04/ActsAsReadonlyable-to-support-read-only.html points out, we wrote this plugin in preparation to using slave DBs but we are not going to have those until May 2007. So even though the code is covered with tests (see svn://rubyforge.org/var/svn/acts-as-with-ro/trunk/test/unit/read_write_model_test.rb), it has not been used outside of those. We would have a discovery period in May when the code is likely to be improved so for now you can use is at your own risk. Meanwhile, we would be happy to fix any issue revealed. Drop us a line at rails-trunk [ at ] revolution DOT com.
+
+Using this plugin should not be your first step in application optimization/scaling or even the second one. Before installing it make sure you understand the implication of leveraging multiple DBs (for example, the potential for cross DB joins).
+
+== Usage
+
+Add 'acts_as_readonlyable db_config_entry' to your models backed up by slave DBs. If you want to apply ActsAsReadonlyable to all models, add this or similar code at the end of config/environment.rb:
+
+class << ActiveRecord::Base
+  
+  def read_only_inherited(child)
+    child.acts_as_readonlyable :read_only
+    ar_inherited(child)
+  end
+  
+  alias_method :ar_inherited, :inherited
+  alias_method :inherited, :read_only_inherited
+
+end
+
+== Example
+
+=== Sample DB Config
+
+dbs:
+
+  database: master_db
+  host: master-host
+
+  read_only:
+    database: slave_db
+    host: slave-host
+
+
+Note:  There is no need for more than one read-only database configuration in your database.yml since you can leverage traditional load balancing solutions for slaves.
+
+=== Sample Model
+
+class Fruit < ActiveRecord::Base
+  acts_as_readonlyable :read_only
+end
+
+=== Usage
+
+r = Fruit.find(:first)  # executes against the read_only db
+r.field = 'value'
+r.save!  # executes against the read_write db
+
+r.reload  # executes against the read_only db
+r.reload(:readonly => false)  # executes against the read_write db
+
+
+== Installation
+
+As plugin: 
+script/plugin install svn://rubyforge.org/var/svn/acts-as-with-ro/trunk/vendor/plugins/acts_as_readonlyable
+
+
+== License
+
+ActsAsReadonlyable released under the MIT license.
+
+
+== Support
+
+The plugin RubyForge page is http://rubyforge.org/projects/acts-as-with-ro
+

data/init.rb

@@ -0,0 +1 @@
+require 'acts_as_readonlyable'

data/lib/acts_as_readonlyable.rb

@@ -0,0 +1,114 @@
+# Copyright (c) 2007 Revolution Health Group LLC. All rights reserved.
+
+module ActiveRecord; module Acts; end; end 
+
+module ActiveRecord::Acts::ActsAsReadonlyable
+  
+  def self.included(base)
+    base.extend(ClassMethods)  
+  end
+  
+  module ClassMethods
+    
+    def acts_as_readonlyable(readonly_db)
+      @readonly_db = readonly_db.to_s
+      @readonly_klass = def_class(@readonly_db)
+      self.extend(FinderClassOverrides)
+      self.send(:include, FinderObjectOverrides)
+    end
+    
+  private
+    
+    def def_class(readonly_db)
+      eval <<-CLASS_DEF
+        class ::Generated#{ readonly_db.camelize } < ActiveRecord::Base
+          self.abstract_class = true
+          establish_connection configurations[RAILS_ENV]['#{ readonly_db }']
+          self
+        end
+      CLASS_DEF
+    end
+    
+    module FinderClassOverrides
+      
+      def find_every(options)
+        run_on_db(options) { super }
+      end
+      
+      def find_by_sql(sql, options = nil) 
+        
+        # Called through construct_finder_sql
+        if sql.is_a?(Hash)
+          options = sql
+          sql = sql[:sql]
+        end
+        
+        run_on_db(options) { super(sql) }
+        
+      end
+      
+      def count_by_sql(sql, options = nil)
+        run_on_db(options) { super(sql) }
+      end
+      
+      def construct_finder_sql(options)
+        options.merge(:sql => super)
+      end
+      
+      def set_readonly_option!(options) #:nodoc:
+        # Inherit :readonly from finder scope if set.  Otherwise,
+        # if :joins is not blank then :readonly defaults to true.
+        unless options.has_key?(:readonly)
+          if scoped?(:find, :readonly)
+            options[:readonly] = true if scope(:find, :readonly)
+          elsif !options[:joins].blank? && !options[:select]
+            options[:readonly] = true
+          end
+        end
+      end
+      
+      private
+      
+      def run_on_db(options)
+        if with_readonly?(options)
+          run_on_readonly_db { yield }
+        else
+          yield
+        end
+      end
+
+      def with_readonly?(options)
+        (! options.is_a?(Hash)) || (! options.key?(:readonly)) || options[:readonly]
+      end
+      
+      def run_on_readonly_db
+        klass_conn = connection
+        begin
+          self.connection = @readonly_klass.connection
+          self.clear_active_connection_name
+          yield
+        ensure
+          self.connection = klass_conn
+          self.clear_active_connection_name
+        end
+      end
+      
+    end
+    
+    module FinderObjectOverrides
+      
+      # backport from 1.2.3 for 1.1.6
+      def reload(options = nil)
+        clear_aggregation_cache
+        clear_association_cache
+        @attributes.update(self.class.find(self.id, options).instance_variable_get('@attributes'))
+        self
+      end
+      
+    end
+    
+  end
+  
+end
+
+ActiveRecord::Base.send(:include, ActiveRecord::Acts::ActsAsReadonlyable)

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
+specification_version: 1
+name: acts_as_readonlyable
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+date: 2007-04-21 00:00:00 -04:00
+summary: acts_as_readonlyable allows to add read-only slaves DBs to models
+require_paths: 
+- lib
+email: rails-trunk@revolution.com
+homepage: 
+rubyforge_project: 
+description: 
+autorequire: acts_as_readonlyable
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- RHG Team
+files: 
+- init.rb
+- lib/acts_as_readonlyable.rb
+- README
+- MIT-LICENSE
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+- MIT-LICENSE
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+