ar-octopus 0.0.5 → 0.0.6

data/Rakefile

@@ -29,7 +29,7 @@ begin
     gem.authors = ["Thiago Pradi", "Mike Perham", "Amit Agarwal"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.add_dependency('activerecord')
-    gem.version = "0.0.5"
+    gem.version = "0.0.6"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/ar-octopus.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ar-octopus}
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Thiago Pradi", "Mike Perham", "Amit Agarwal"]
@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
      "lib/octopus/has_and_belongs_to_many_association.rb",
      "lib/octopus/migration.rb",
      "lib/octopus/model.rb",
+     "lib/octopus/persistence.rb",
      "lib/octopus/proxy.rb",
      "rails/init.rb",
      "spec/config/shards.yml",

data/lib/octopus.rb

@@ -19,6 +19,7 @@ end
 require "octopus/proxy"
 require "octopus/migration"
 require "octopus/model"
+require "octopus/persistence"
 require "octopus/controller"
 require "octopus/association"
 require "octopus/association_collection"

data/lib/octopus/association.rb

@@ -1,4 +1,28 @@
 module Octopus::Association
+  def has_many(association_id, options = {}, &extension)
+    default_octopus_opts(options)
+    super(association_id, options, &extension)
+  end
+
+  def has_and_belongs_to_many(association_id, options = {}, &extension)
+    default_octopus_opts(options)
+    super(association_id, options, &extension)    
+  end
+
+  def default_octopus_opts(options)
+    if options[:before_add].is_a?(Array)
+      options[:before_add] << :set_connection
+    else
+      options[:before_add] = :set_connection
+    end
+
+    if options[:before_remove].is_a?(Array)
+      options[:before_remove] << :set_connection
+    else
+      options[:before_remove] = :set_connection
+    end
+  end
+  
   def collection_reader_method(reflection, association_proxy_class)
     define_method(reflection.name) do |*params|
       force_reload = params.first unless params.empty?
@@ -60,13 +84,13 @@ module Octopus::Association
 
   def association_accessor_methods(reflection, association_proxy_class)
     define_method(reflection.name) do |*params|
-      force_reload = true
       reload_connection() 
+      force_reload = params.first unless params.empty?
       association = association_instance_get(reflection.name)
 
       if association.nil? || force_reload
         association = association_proxy_class.new(self, reflection)
-        retval = have_a_valid_shard? ? reflection.klass.uncached { self.class.connection_proxy.run_query_on_shard(self.current_shard) { association.reload } } : association.reload
+        retval = have_a_valid_shard? ? reflection.klass.uncached { self.class.connection_proxy.run_queries_on_shard(self.current_shard) { association.reload } } : association.reload
         if retval.nil? and association_proxy_class == ActiveRecord::Associations::BelongsToAssociation
           association_instance_set(reflection.name, nil)
           return nil

data/lib/octopus/controller.rb

@@ -1,6 +1,6 @@
 module Octopus::Controller
   def using(shard, &block)
-    ActiveRecord::Base.connection_proxy.run_query_on_shard(shard, &block)
+    ActiveRecord::Base.connection.run_queries_on_shard(shard, &block)
   end
 end
 

data/lib/octopus/model.rb

@@ -1,34 +1,30 @@
 module Octopus::Model  
   def self.extended(base) 
     base.send(:include, InstanceMethods)
+    base.extend(ClassMethods)
     base.hijack_connection()
   end
 
-  module InstanceMethods
-    def reload_connection()
-      set_connection() if have_a_valid_shard?
-    end
-
-    def update_attribute(name, value)
-      reload_connection()
-      super(name, value)
-    end
-
-    def update_attributes(attributes)
-      reload_connection()
-      super(attributes)
+  module SharedMethods
+    def clean_table_name
+      self.reset_table_name() if self != ActiveRecord::Base && self.respond_to?(:reset_table_name)
     end
+    
+    def using(shard, &block)
+      hijack_connection()  
+      clean_table_name()
 
-    def update_attributes!(attributes)
-      reload_connection()
-      super(attributes)
-    end
+      if block_given?
+        self.connection.run_queries_on_shard(shard, &block)
+      else
+        hijack_initializer()  
+        self.connection.current_shard = shard
+        self.connection.using_enabled = true
 
-    def reload
-      reload_connection()
-      super
+        return self
+      end
     end
-
+    
     def hijack_initializer()
       attr_accessor :current_shard
       after_initialize :set_current_shard
@@ -36,12 +32,10 @@ module Octopus::Model
       before_destroy :set_connection
 
       def set_current_shard
-        if self.class.respond_to?(:connection_proxy) && self.respond_to?(:current_shard)
-          if self.new_record?
-            self.current_shard = self.class.connection_proxy.current_shard    
-          else
-            self.current_shard = self.class.connection_proxy.last_current_shard  
-          end
+        if new_record?
+          self.current_shard = self.class.connection_proxy.current_shard    
+        else
+          self.current_shard = self.class.connection_proxy.last_current_shard  
         end
       end    
     end
@@ -58,67 +52,30 @@ module Octopus::Model
         end
       end
     end
+  end
 
-    def using(shard, &block)
-      hijack_connection()  
-      clean_table_name()
-
-      if block_given?
-        self.connection_proxy.run_query_on_shard(shard, &block)
-      else
-        hijack_initializer()  
-        self.connection_proxy.current_shard = shard
-        self.connection_proxy.using_enabled = true
-
-        return self
-      end
-    end
-
-    def have_a_valid_shard?
-      self.respond_to?(:current_shard) && self.current_shard != nil
-    end
-
+  module InstanceMethods
+    include SharedMethods
+    
     def set_connection(*args)
       if(args.size == 1)
         arg = args.first
         arg.current_shard = self.current_shard if arg.respond_to?(:current_shard) && have_a_valid_shard?
       end
 
-      self.class.connection_proxy.current_shard = self.current_shard if have_a_valid_shard?
+      self.connection.current_shard = self.current_shard if have_a_valid_shard?
     end
-
-    def clean_table_name
-      self.reset_table_name() if self != ActiveRecord::Base && self.respond_to?(:reset_table_name)
+    
+    def have_a_valid_shard?
+      self.respond_to?(:current_shard) && self.current_shard != nil
     end
   end
 
-  include InstanceMethods
-
-  def replicated_model()
-    write_inheritable_attribute(:replicated, true)
-  end
-
-  def has_many(association_id, options = {}, &extension)
-    default_octopus_opts(options)
-    super(association_id, options, &extension)
-  end
-
-  def has_and_belongs_to_many(association_id, options = {}, &extension)
-    default_octopus_opts(options)
-    super(association_id, options, &extension)    
-  end
-
-  def default_octopus_opts(options)
-    if options[:before_add].is_a?(Array)
-      options[:before_add] << :set_connection
-    else
-      options[:before_add] = :set_connection
-    end
+  module ClassMethods
+    include SharedMethods
 
-    if options[:before_remove].is_a?(Array)
-      options[:before_remove] << :set_connection
-    else
-      options[:before_remove] = :set_connection
+    def replicated_model()
+      write_inheritable_attribute(:replicated, true)
     end
   end
 end

data/lib/octopus/persistence.rb

@@ -0,0 +1,27 @@
+module Octopus::Persistence
+  def reload_connection()
+    set_connection() if have_a_valid_shard?
+  end
+
+  def update_attribute(name, value)
+    reload_connection()
+    super(name, value)
+  end
+
+  def update_attributes(attributes)
+    reload_connection()
+    super(attributes)
+  end
+
+  def update_attributes!(attributes)
+    reload_connection()
+    super(attributes)
+  end
+
+  def reload
+    reload_connection()
+    super
+  end
+end
+
+ActiveRecord::Base.send(:include, Octopus::Persistence)

data/lib/octopus/proxy.rb

@@ -1,25 +1,17 @@
-require "set"
-
 class Octopus::Proxy
-  attr_accessor :shards, :block, :current_model, :current_shard, :groups, :current_group, :replicated, :slaves_list, :using_enabled, :last_current_shard
-
-  delegate :increment_open_transactions, :decrement_open_transactions,  :to => :select_connection
+  attr_accessor :current_model, :current_shard, :current_group, :block, :using_enabled, :last_current_shard
 
   def initialize(config)
+    initialize_shards(config)
+    initialize_replication() if config[Octopus.env()]["replicated"]
+  end
+  
+  def initialize_shards(config)
     @shards = {}
     @groups = {}
-    @replicated = config[Octopus.env()]["replicated"]
     @shards[:master] = ActiveRecord::Base.connection_pool()
     @current_shard = :master
     
-    initialize_shards(config)
-    
-    if @replicated
-      initialize_replication()
-    end
-  end
-  
-  def initialize_shards(config)
     config[Octopus.env()]["shards"].each do |key, value|
       if value.has_key?("adapter")
         initialize_adapter(value['adapter'])
@@ -38,11 +30,10 @@ class Octopus::Proxy
   end
   
   def initialize_replication()
-    @slaves_list = @shards.keys
-    @slaves_list.delete(:master)
-    @slaves_list = @slaves_list.map {|sym| sym.to_s}.sort    
+    @replicated = true
+    @slaves_list = @shards.keys.map {|sym| sym.to_s}.sort 
+    @slaves_list.delete('master')   
   end
-
   
   def current_shard=(shard_symbol)
     if shard_symbol.is_a?(Array)
@@ -58,18 +49,14 @@ class Octopus::Proxy
     if group_symbol.is_a?(Array)
       group_symbol.each {|symbol| raise "Nonexistent Group Name: #{symbol}" if @groups[symbol].nil? }
     else
-      raise "Nonexistent Group Name: #{group_symbol}" if @groups[group_symbol].nil? && !group_symbol.nil?
+      raise "Nonexistent Group Name: #{group_symbol}" if @groups[group_symbol].nil?
     end
 
     @current_group = group_symbol
   end
   
   def current_model=(model)
-    if model.is_a?(ActiveRecord::Base)
-      @current_model = model.class
-    else
-      @current_model = model
-    end
+    @current_model = model.is_a?(ActiveRecord::Base) ? model.class : model
   end
   
   def select_connection()
@@ -77,11 +64,7 @@ class Octopus::Proxy
   end
 
   def shard_name
-    if(current_shard.is_a?(Array))
-      current_shard.first
-    else
-      current_shard
-    end
+    current_shard.is_a?(Array) ? current_shard.first : current_shard
   end
     
   def add_transaction_record(record)
@@ -97,7 +80,7 @@ class Octopus::Proxy
       self.send_transaction_to_multiple_groups(options, &block)
     elsif should_send_queries_to_a_group_of_shards?
       self.send_transaction_to_multiple_shards(@groups[current_group], options, &block)
-      self.current_group = nil      
+      @current_group = nil      
     else
       select_connection.transaction(options, &block) 
     end
@@ -123,10 +106,11 @@ class Octopus::Proxy
     end
   end
   
-  def run_query_on_shard(shard, &block)
+  def run_queries_on_shard(shard, &block)
     older_shard = self.current_shard
     self.block = true
     self.current_shard = shard
+    
     begin
       yield
     ensure
@@ -142,7 +126,6 @@ class Octopus::Proxy
 
   def initialize_adapter(adapter)
     begin
-      require 'rubygems'
       gem "activerecord-#{adapter}-adapter"
       require "active_record/connection_adapters/#{adapter}_adapter"
     rescue LoadError
@@ -155,7 +138,7 @@ class Octopus::Proxy
   end
 
   def should_clean_connection?(method)
-    method.to_s =~ /insert|select/ && !should_send_queries_to_multiple_shards? && !self.current_group && !replicated
+    method.to_s =~ /insert|select/ && !should_send_queries_to_multiple_shards? && !self.current_group && !@replicated
   end
 
   def should_send_queries_to_multiple_shards?
@@ -199,8 +182,8 @@ class Octopus::Proxy
     
     if current_model.read_inheritable_attribute(:replicated)
       if !using_enabled
-        self.current_shard = slaves_list.shift.to_sym
-        slaves_list << self.current_shard
+        self.current_shard = @slaves_list.shift.to_sym
+        @slaves_list << self.current_shard
       end
     else
       self.current_shard = :master

data/spec/database_connection.rb

@@ -1,5 +1,4 @@
 require 'rubygems'
 require 'active_record'
-require "pg"
 
 ActiveRecord::Base.establish_connection(:adapter => "mysql", :database => "octopus_shard1", :username => "root", :password => "")

data/spec/octopus/model_spec.rb

@@ -145,7 +145,7 @@ describe Octopus::Model do
   describe "#replicated_model method" do
     it "should be replicated" do
       using_enviroment :production_replicated do 
-        ActiveRecord::Base.connection_proxy.replicated.should be_true
+        ActiveRecord::Base.connection_proxy.instance_variable_get(:@replicated).should be_true
       end
     end
 

data/spec/octopus/proxy_spec.rb

@@ -7,15 +7,15 @@ describe Octopus::Proxy do
 
   describe "creating a new instance" do    
     it "should initialize all shards and groups" do
-      @proxy.shards.keys.to_set.should == [:postgresql_shard, :alone_shard, :aug2011, :canada, :brazil, :aug2009, :russia, :aug2010, :master].to_set
-      @proxy.groups.should == {:country_shards=>[:canada, :brazil, :russia], :history_shards=>[:aug2009, :aug2010, :aug2011]}
+      @proxy.instance_variable_get(:@shards).keys.to_set.should == [:postgresql_shard, :alone_shard, :aug2011, :canada, :brazil, :aug2009, :russia, :aug2010, :master].to_set
+      @proxy.instance_variable_get(:@groups).should == {:country_shards=>[:canada, :brazil, :russia], :history_shards=>[:aug2009, :aug2010, :aug2011]}
     end
 
     it "should initialize the block attribute as false" do
       @proxy.block.should be_false
     end    
     it "should initialize replicated attribute as false" do
-      @proxy.replicated.should be_false      
+      @proxy.instance_variable_get(:@replicated).should be_false      
     end
 
     describe "should raise error if you have duplicated shard names" do
@@ -48,12 +48,12 @@ describe Octopus::Proxy do
 
     describe "should return the connection based on shard_name" do
       it "when current_shard is empty" do
-        @proxy.select_connection().should == @proxy.shards[:master].connection()        
+        @proxy.select_connection().should == @proxy.instance_variable_get(:@shards)[:master].connection()        
       end
 
       it "when current_shard is a single shard" do
         @proxy.current_shard = :canada
-        @proxy.select_connection().should == @proxy.shards[:canada].connection()       
+        @proxy.select_connection().should == @proxy.instance_variable_get(:@shards)[:canada].connection()       
       end
     end
   end

data/spec/octopus/replication_specs.rb

@@ -10,7 +10,7 @@ describe "when the database is replicated" do
   end
 
   it "should initialize the list of shards" do
-    @proxy.slaves_list.should == ["slave1", "slave2", "slave3", "slave4"]
+    @proxy.instance_variable_get(:@slaves_list).should == ["slave1", "slave2", "slave3", "slave4"]
   end
 
   it "should send all writes/reads queries to master when you have a replicated model" do

data/spec/octopus_helper.rb

@@ -1,5 +1,5 @@
 def clean_all_shards()
-  ActiveRecord::Base.using(:master).connection.shards.keys.each do |shard_symbol|
+  ActiveRecord::Base.using(:master).connection.instance_variable_get(:@shards).keys.each do |shard_symbol|
     ['schema_migrations', 'users', 'clients', 'cats', 'items', 'keyboards', 'computers', 'permissions_roles', 'roles', 'permissions', 'assignments', 'projects', 'programmers'].each do |tables|
       ActiveRecord::Base.using(shard_symbol).connection.execute("DELETE FROM #{tables};") 
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ar-octopus
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Thiago Pradi
@@ -75,6 +75,7 @@ files:
 - lib/octopus/has_and_belongs_to_many_association.rb
 - lib/octopus/migration.rb
 - lib/octopus/model.rb
+- lib/octopus/persistence.rb
 - lib/octopus/proxy.rb
 - rails/init.rb
 - spec/config/shards.yml