connection_manager 0.0.1 → 0.1.0

data/.gitignore

@@ -1,5 +1,6 @@
 pkg/*
 *.gem
+*.sqlite3
 .bundle
 .DS_Store
 

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activerecord-connection_manager (0.0.1)
+    connection_manager (0.1.0)
       activerecord (~> 3.0)
 
 GEM
@@ -24,11 +24,13 @@ GEM
       ZenTest (>= 4.4.1)
     builder (3.0.0)
     diff-lcs (1.1.3)
+    factory_girl (2.3.2)
+      activesupport
     i18n (0.6.0)
     metaclass (0.0.1)
     mocha (0.10.0)
       metaclass (~> 0.0.1)
-    multi_json (1.0.3)
+    multi_json (1.0.4)
     rspec (2.7.0)
       rspec-core (~> 2.7.0)
       rspec-expectations (~> 2.7.0)
@@ -37,13 +39,16 @@ GEM
     rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.7.0)
+    sqlite3 (1.3.4)
     tzinfo (0.3.31)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord-connection_manager!
   autotest
+  connection_manager!
+  factory_girl
   mocha
   rspec
+  sqlite3

data/README.md

@@ -1,23 +1,23 @@
-# connection_manager
+# ConnectionManager
 Replication and Multi-Database ActiveRecord add on.
 
 ## Goals
 * Take the lib I've been using finally make something out of it ;)
-* Use connection classes instead of establish_connection on every model to ensure connection pooling
-* Focus connection management at the model level
+* Use connection classes, instead of establish_connection on every model, to ensure connection pooling
+* Use non-adapter specific code.
 * Use the default database.yml as single point for all database configurations (no extra .yml files)
-* When slave objects are used in html helpers like link_to and form_for the created urls that match the master
+* When slave objects are used in html helpers like link_to and form_for the created urls match those created using a master object
 
 ## Installation
 
-connection_manager is available through [Rubygems](https://rubygems.org/gems/connection_manager) and can be installed via:
+ConnectionManager is available through [Rubygems](https://rubygems.org/gems/connection_manager) and can be installed via:
 
     $ gem install connection_manager
 
 ## Rails 3 setup (Rails 2 untested at this time please let me know if it works for you )
 
-connection_manager assumes the primary connection for the model is the master. For standard
-models using the default connection this means the main rails database connection is the master.
+ConnectionManager assumes the primary connection for the model is the master. For standard
+models using the default connection this means the main Rails database connection is the master.
 
 Example database.yml
 
@@ -37,7 +37,7 @@ Example database.yml
 
     slave_1_test_app_development:
       <<: *common
-      database: portal_production
+      database: test_app
   
     slave_2_test_app_development:
       <<: *common
@@ -62,33 +62,32 @@ is the databases name and finally the "development" is the environment. (Of cour
 each slave would have a different connection to is replication :)
 
 
-### Setup Multiple Databases
+## Multiple Databases
 
-At startup connection_manager builds connection classes  to ConnectionManager::Connections
+At startup ConnectionManager builds connection classes  to ConnectionManager::Connections
 using the connections described in your database.yml based on the current rails environment.
 
 You can use a different master by having the model inherit from one of your ConnectionManager::Connections.
 
 To view your ConnectionManager::Connections, at the Rails console type:
 
-    ruby-1.9.2-p290 :001 > ConnectionManager::Connections.all => ["TestAppConnection", "Slave1TestAppConnection", "Slave2TestAppConnection"]
+   ConnectionManager::Connections.all => ["TestAppConnection", "Slave1TestAppConnection", "Slave2TestAppConnection"]
 
 If your using the example database.yml your array would look like this:
     ["TestAppConnection", "Slave1TestAppConnection", "Slave2TestAppConnection", 
     "UserDataConnection", "Slave1UserDataConnection", "Slave2UserDataConnection"]
 
 
-
 To use one of your ConnectionManager::Connections for your models default/master database
-setup you model like the following
+setup your model like the following
     
     class User < ConnectionManager::Connections::UserDataConnection
         # model code ...
     end
 
-### Replication
+## Replication
 
-simply add 'replicated' to you model beneath any defined associations
+Simply add 'replicated' to your model beneath any defined associations
     
     class User < ConnectionManager::Connections::UserDataConnection
         has_one :job
@@ -101,30 +100,31 @@ The replicated method addeds subclass whose names match the replication connecti
 Based on the above example database.yml User class would now have User::Slave1 and User::Slave2. 
 
 You can treat your subclass like normal activerecord objects.
-    User::Slave1.first => returns results from slave_1_use_data_development 
-    User::Slave2.where(['created_at BETWEEN ? and ?',Time.now - 3.hours, Time.now]).all => returns results from slave_2_use_data_development
+    
+    User::Slave1.first => returns results from slave_1_user_data_development 
+    User::Slave2.where(['created_at BETWEEN ? and ?',Time.now - 3.hours, Time.now]).all => returns results from slave_2_user_data_development
 
-For a more elegant implementation, connection_manager also add class methods to you main model following the
+For a more elegant implementation, ConnectionManager also add class methods to your main model following the
 same naming standard as the subclass creation.
-    User.slave_1.first  => returns results from slave_1_use_data_development 
-    User.slave_2.where(['created_at BETWEEN ? and ?',Time.now - 3.hours, Time.now]).all  => returns results from slave_2_use_data_development 
+    
+    User.slave_1.first  => returns results from slave_1_user_data_development 
+    User.slave_2.where(['created_at BETWEEN ? and ?',Time.now - 3.hours, Time.now]).all  => returns results from slave_2_user_data_development 
 
-Finally connection_manager creates an addional class method that shifts through your 
+Finally, ConnectionManager creates an addional class method that shifts through your 
 available slave connections each time it is called using a different connection on each action.
+    
     User.slave.first  => returns results from slave_1_use_data_development 
     User.slave.last =>  => returns results from slave_2_use_data_development 
-    User.slave.where(['created_at BETWEEN ? and ?',Time.now - 3.hours, Time.now]).all  => returns results from slave_1_use_data_development 
-    User.slave.where(['created_at BETWEEN ? and ?',Time.now - 5.days, Time.now]).all  => returns results from slave_2_use_data_development 
+    User.slave.where(['created_at BETWEEN ? and ?',Time.now - 3.hours, Time.now]).all  => returns results from slave_1_user_data_development 
+    User.slave.where(['created_at BETWEEN ? and ?',Time.now - 5.days, Time.now]).all  => returns results from slave_2_user_data_development 
 
 ## TODO's
-* add more to readme
-* more specs
 * sharding
 
 ## Other activerecord Connection gems
 * [Octopus](https://github.com/tchandy/octopus)
 
-## Contributing to connection_manager
+## Contributing to ConnectionManager
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it

data/connection_manager.gemspec

@@ -18,7 +18,9 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   s.add_runtime_dependency 'activerecord', '~> 3.0'
+  s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'autotest'
   s.add_development_dependency 'mocha'
+  s.add_development_dependency 'factory_girl'
 end

data/lib/connection_manager.rb

@@ -1,6 +1,7 @@
 require "connection_manager/version"
 
 module ConnectionManager
+  require 'active_record'
   require 'connection_manager/connections'
   require 'connection_manager/associations'
   require 'connection_manager/replication_builder'

data/lib/connection_manager/connections.rb

@@ -40,44 +40,49 @@ module ConnectionManager
     
       # Returns the database value given a connection key from the database.yml
       def database_name_from_yml(name_from_yml)
-        ActiveRecord::Base.configurations[name_from_yml]['database'].to_s
+        ActiveRecord::Base.configurations[name_from_yml]['database']
       end
     
+      def clean_sqlite_db_name(name)
+        new_name = "#{name}".gsub(/(\.sqlite3$)/,'')  
+        new_name = new_name.split("/").last 
+        new_name.gsub!(Regexp.new("(\_#{env}$)"),'')
+        new_name
+      end
+      
+      def clean_bd_name(name)
+        new_name = "#{name}".gsub(Regexp.new("#{env}$"),'')
+        if new_name.blank?
+          new_name = "#{database_name_from_yml(name)}"
+        end  
+        new_name = clean_sqlite_db_name(new_name)
+        new_name.gsub(/\_$/,'')
+      end
+      
       # Given an connection key name from the database.yml, returns the string 
       # equivelent of the class name for that entry.
       def connection_class_name(name_from_yml)
-        name_from_yml = name_from_yml #clean up sqlite database names
-        new_class_name = name_from_yml.gsub(Regexp.new("#{env}$"),'')
-        new_class_name = database_name_from_yml(name_from_yml) if new_class_name.blank?
-      
-        #cleanup sqlite database names
-        if new_class_name.gsub!(/(^db\/)|(\.sqlite3$)/,'')  
-          new_class_name.gsub!(Regexp.new("(\\_#{env}$)"),'')
-        end
-      
+        new_class_name = clean_bd_name(name_from_yml)  
         new_class_name = new_class_name.gsub(/\_/,' ').titleize.gsub(/ /,'')
         new_class_name << "Connection"
         new_class_name
       end 
      
-   
+      def replication_key(name_from_yml)
+        rep_name = clean_bd_name(name_from_yml)
+        rep_name.gsub!(/(\_)+(\d+)/,'')
+        rep_name.to_sym   
+      end
     
       def add_replication_connection(name_from_yml,new_connection)    
-        rep_name = name_from_yml.split("_")[0]
-        db_name = database_name_from_yml(name_from_yml)
-        if db_name.gsub!(/(^db\/)|(\.sqlite3$)/,'')  
-          db_name.gsub!(Regexp.new("(\\_#{env}$)"),'')
-        end
-        rep_name << "_#{db_name}"
-        rep_name = rep_name.to_sym
-        replication_connections[rep_name] ||= []
-        replication_connections[rep_name] << new_connection
+        key = replication_key(name_from_yml)
+        replication_connections[key] ||= []
+        replication_connections[key] << new_connection
         replication_connections
       end
     
-    
       def connections_for_replication(rep_collection_key)
-        replication_connections[rep_collection_key.to_sym]
+        replication_connections[(rep_collection_key.gsub(Regexp.new("(\_#{env}$)"),'')).to_sym]
       end
     
       # Sets class instance attributes, then builds connection classes, while populating
@@ -87,11 +92,15 @@ module ConnectionManager
           send("#{k.to_s}=",v)
         end     
         connection_keys.each do |connection|
-          new_connection = connection_class_name(connection)     
+          #puts ActiveRecord::Base.configurations["test"]
+          new_connection = connection_class_name(connection)  
+          #puts ActiveRecord::Base.configurations["test"]
           add_replication_connection(connection,new_connection)
-          build_connection_class(new_connection,connection)       
+          #puts ActiveRecord::Base.configurations["test"]
+          build_connection_class(new_connection,connection) 
+          #puts ActiveRecord::Base.configurations["test"]
         end
-       all
+        all
       end 
     
       # Addes a conneciton subclass to AvailableConnections using the supplied

data/lib/connection_manager/replication_builder.rb

@@ -1,11 +1,8 @@
 module ConnectionManager
   module ReplicationBuilder
     
-    def database_name(db_name=nil)
-      db_name = "#{connection.instance_variable_get(:@config)[:database].to_s}" if db_name.blank?
-      db_name.gsub!(/(\.sqlite3$)/,'')
-      db_name = db_name.split("/").last
-      db_name
+    def database_name
+      "#{connection.instance_variable_get(:@config)[:database].to_s}"
     end
     
     def replication_association_options(method,association,class_name,options={})
@@ -39,12 +36,14 @@ module ConnectionManager
     
     def replication_connection_classes(options)
       if options[:using] && options[:using].is_a?(Array)
-        connection_classes = options[:using].collection{|c| Connections.connection_class_name(c)}
+        connection_classes = options[:using].collect{|c| Connections.connection_class_name(c)}
       else  
-        connection_classes = Connections.connections_for_replication("#{options[:name].to_s}_#{database_name}") 
+        rep_name = "#{options[:name].to_s}_#{Connections.clean_sqlite_db_name(database_name)}"
+        connection_classes = Connections.connections_for_replication(rep_name) 
       end
       connection_classes
     end
+
     
     # Adds subclass with the class name of the type provided in the options, which 
     # defaults to 'slave' if blank, that uses the connection from a connection class.
@@ -80,8 +79,8 @@ module ConnectionManager
     # overrides the rails "readonly?" method to ensure saves are prevented. 
     # Replication class can be called directly for operaitons.
     # Usage: 
-    # => User::Slave1.where(:id => 1).first => returns results from slave_1 database
-    # => User::Slave2.where(:id => 2).first => returns results from slave_1 database
+    #   User::Slave1.where(:id => 1).first => returns results from slave_1 database
+    #   User::Slave2.where(:id => 2).first => returns results from slave_1 database
     def build_replication_class(class_name,connection_name,options)
       class_eval <<-STR, __FILE__, __LINE__
       class #{class_name} < #{self.name}
@@ -99,8 +98,8 @@ module ConnectionManager
     
     # Adds as class method to call a specific replication conneciton.
     # Usage:
-    # => User.slave_1.where(:id => 2).first => returns results from slave_1 database
-    # => User.slave_2.where(:id => 2).first => returns results from slave_1 database
+    #   User.slave_1.where(:id => 2).first => returns results from slave_1 database
+    #   User.slave_2.where(:id => 2).first => returns results from slave_2 database
     def build_single_replication_method(method_name,class_name)
       class_eval <<-STR, __FILE__, __LINE__
         class << self
@@ -114,7 +113,7 @@ module ConnectionManager
     # add a class method that shifts through available connections methods
     # on each call.
     # Usage:
-    # => User.slave.where(:id => 2).first => can return results from slave_1 or slave_2 
+    #   User.slave.where(:id => 2).first => can return results from slave_1 or slave_2 
     def build_full_replication_method(options,connection_methods)
       class_eval <<-STR, __FILE__, __LINE__
       @connection_methods = #{connection_methods}

data/lib/connection_manager/version.rb

@@ -1,4 +1,4 @@
 module ConnectionManager
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
 end
 

data/spec/database.yml

@@ -0,0 +1,20 @@
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: spec/cm_test.sqlite3
+  pool: 5
+  timeout: 5000
+  
+slave_1_cm_test:
+  adapter: sqlite3
+  database: spec/cm_test.sqlite3
+  pool: 5
+  timeout: 5000
+  
+slave_2_cm_test:
+  adapter: sqlite3
+  database: spec/cm_test.sqlite3
+  pool: 5
+  timeout: 5000 

data/spec/factories.rb

@@ -0,0 +1,31 @@
+FactoryGirl.define do
+  factory :basket do
+    name "MyString"
+  end
+end
+
+FactoryGirl.define do
+  factory :fruit_basket do
+    fruit
+    basket
+  end
+end
+
+FactoryGirl.define do
+  factory :fruit do
+    name "MyString"
+    region
+  end
+end
+
+FactoryGirl.define do
+  factory :region do
+    name "MyString"
+  end
+end
+
+FactoryGirl.define do
+  factory :type do
+    name "MyString"
+  end
+end

data/spec/helpers/database_spec_helper.rb

@@ -0,0 +1,68 @@
+class TestDB
+  def self.connect
+    ActiveRecord::Base.configurations = YAML::load(File.open(File.join(File.dirname(__FILE__),'..','database.yml')))
+    ActiveRecord::Base.establish_connection('test') 
+  end
+  def self.clean
+    [:foos,:fruits,:baskets,:fruit_baskets,:regions,:types].each do |t|
+      DBSpecManagement.connection.execute("DELETE FROM #{t.to_s}")
+    end
+  end
+  #Class to clean tables
+  class DBSpecManagement < ActiveRecord::Base
+  end
+end
+
+
+#Put all the test migrations here
+class TestMigrations < ActiveRecord::Migration  
+  
+  # all the ups
+  def self.up  
+    begin
+      create_table :foos do |t|
+        t.string :name
+      end 
+      create_table :fruits do |t|
+        t.string :name
+        t.integer :region_id
+        t.timestamps
+      end
+      create_table :baskets do |t|
+        t.string :name
+        t.timestamps
+      end
+      create_table :fruit_baskets do |t|
+        t.integer :fruit_id
+        t.integer :basket_id
+        t.timestamps
+      end
+      create_table :regions do |t|
+        t.string :name
+
+        t.timestamps
+      end
+      create_table :types do |t|
+        t.string :name
+        t.timestamps
+      end
+    rescue => e
+      puts "tables failed to create: #{e}"
+    end
+  
+  end
+  
+ 
+  # all the downs
+  def self.down 
+    begin
+      [:foos,:fruits,:baskets,:fruit_baskets,:regions,:types].each do |t|
+        drop_table t 
+      end
+    rescue => e
+      puts "tables were not dropped: #{e}"
+    end
+  end 
+  
+  
+end