rails_multisite 0.0.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e45ef95202698ebf603b6442abf02eba8f6a25e2
-  data.tar.gz: c47de25e43b5a8c01d8a3643bcff11592075dc4c
+  metadata.gz: 0fd46e714ed81aade7bf750d0229ec1a96cb3f9f
+  data.tar.gz: 9ea4c386f993da1f6648acdf33ff854a51d3af79
 SHA512:
-  metadata.gz: 87c49b6fdd43d33155168227cf94949d8e114a6b440bf0c53e3233e19c1cd78f42e7057c17d2752920225b050b2effc4b7cf29e2715f452283392bcbf1aca0cd
-  data.tar.gz: 4ef167a5687c24657d69a1744a1d9c18d07593f7fc1546bca98bce24996056fa2b92abe58c843b4070b6e6af95464ea0a2cb0574ed6cff17eeda914632d236e6
+  metadata.gz: 7e3c52ff6e9120af35e0b2e5677296d85d453d2d68520682846dcf0c1ff1ee24afe2039b91420ddb8907dc9480ab69a7c66fbcaed3086df909bf8d672b60f053
+  data.tar.gz: cb516155225e1db227abfb0f36b67d86f8767d47e331e693a25c98d73612964ed2c64ec0e3d19a242f49920e261370e2e365f2903e09d57a7a44f3792f5f8f9f

data/README.md

@@ -1,6 +1,12 @@
-# RailsMultisite
+# Rails Multisite
 
-TODO: Write a gem description
+This gem provides multi-db support for Rails applications.
+
+Using its middleware you can partition your app so each hostname has its own db.
+
+It provides a series of helper for working with multiple database, and some additional rails tasks for working with them.
+
+It was extracted from Discourse. http://discourse.org
 
 ## Installation
 
@@ -18,7 +24,26 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Configuration requires a file called: `config/multisite.yml` that specifies connection specs for all dbs.
+
+
+### Exectue a query on each connection
+
+```
+RailsMultisite::ConnectionManagement.each_connection do |db|
+  # run query in context of db
+  # eg: User.find(1)
+end
+```
+
+```
+RailsMultisite::ConnectionManagement.each_connection(threads: 5) do |db|
+  # run query in context of db, will do so in a thread pool of 5 threads
+  # if any query fails an exception will be raised
+  # eg: User.find(1)
+end
+```
+
 
 ## Contributing
 

data/lib/rails_multisite/connection_management.rb

@@ -1,13 +1,19 @@
 module RailsMultisite
   class ConnectionManagement
     CONFIG_FILE = 'config/multisite.yml'
+    DEFAULT = 'default'.freeze
+
+    def self.has_db?(db)
+      return true if db == DEFAULT
+      (defined? @@db_spec_cache) && @@db_spec_cache && @@db_spec_cache[db]
+    end
 
     def self.rails4?
       !!(Rails.version =~ /^4/)
     end
 
     def self.establish_connection(opts)
-      if opts[:db] == "default" && (!defined?(@@default_spec) || !@@default_spec)
+      if opts[:db] == DEFAULT && (!defined?(@@default_spec) || !@@default_spec)
         # don't do anything .. handled implicitly
       else
         spec = connection_spec(opts) || @@default_spec
@@ -16,35 +22,116 @@ module RailsMultisite
           handler = @@connection_handlers[spec]
           unless handler
             handler = ActiveRecord::ConnectionAdapters::ConnectionHandler.new
-            if rails4?
-              handler.establish_connection(ActiveRecord::Base, spec)
-            end
+            handler.establish_connection(ActiveRecord::Base, spec)
             @@connection_handlers[spec] = handler
           end
         else
           handler = @@default_connection_handler
-          if rails4? && !@@established_default
+          if !@@established_default
             handler.establish_connection(ActiveRecord::Base, spec)
             @@established_default = true
           end
         end
 
         ActiveRecord::Base.connection_handler = handler
+      end
+    end
 
-        unless rails4?
-          handler.establish_connection("ActiveRecord::Base", spec)
-        end
+    def self.with_hostname(hostname)
+
+      unless defined? @@db_spec_cache
+        # just fake it for non multisite
+        yield hostname
+        return
+      end
+
+      old = current_hostname
+      connected = ActiveRecord::Base.connection_pool.connected?
+
+      establish_connection(:host => hostname) unless connected && hostname == old
+      rval = yield hostname
+
+      unless connected && hostname == old
+        ActiveRecord::Base.connection_handler.clear_active_connections!
+
+        establish_connection(:host => old)
+        ActiveRecord::Base.connection_handler.clear_active_connections! unless connected
       end
+
+      rval
     end
 
-    def self.each_connection
+    def self.with_connection(db = "default")
       old = current_db
       connected = ActiveRecord::Base.connection_pool.connected?
-      all_dbs.each do |db|
-        establish_connection(:db => db)
-        yield db
+
+      establish_connection(:db => db) unless connected && db == old
+      rval = yield db
+
+      unless connected && db == old
         ActiveRecord::Base.connection_handler.clear_active_connections!
+
+        establish_connection(:db => old)
+        ActiveRecord::Base.connection_handler.clear_active_connections! unless connected
+      end
+
+      rval
+    end
+
+    def self.each_connection(opts=nil, &blk)
+
+      old = current_db
+      connected = ActiveRecord::Base.connection_pool.connected?
+
+      queue = nil
+      threads = nil
+
+      if (opts && (threads = opts[:threads]))
+        queue = Queue.new
+        all_dbs.each{|db| queue << db}
       end
+
+      errors = nil
+
+      if queue
+        threads.times.map do
+          Thread.new do
+
+            while true
+              begin
+                db = queue.deq(true)
+              rescue ThreadError
+                db = nil
+              end
+
+              break unless db
+
+              establish_connection(:db => db)
+              # no choice but to rescue, should probably log
+
+              begin
+                blk.call(db)
+              rescue => e
+                (errors ||= []) << e
+              end
+              ActiveRecord::Base.connection_handler.clear_active_connections!
+            end
+          end
+        end.map(&:join)
+      else
+        all_dbs.each do |db|
+          establish_connection(:db => db)
+          blk.call(db)
+          ActiveRecord::Base.connection_handler.clear_active_connections!
+        end
+      end
+
+      if errors && errors.length > 0
+        raise StandardError, "Failed to run queries #{errors.inspect}"
+      end
+
+
+    ensure
       establish_connection(:db => old)
       ActiveRecord::Base.connection_handler.clear_active_connections! unless connected
     end
@@ -59,7 +146,7 @@ module RailsMultisite
     end
 
     def self.current_db
-      db = ActiveRecord::Base.connection_pool.spec.config[:db_key] || "default"
+      ActiveRecord::Base.connection_pool.spec.config[:db_key] || "default"
     end
 
     def self.config_filename=(config_filename)
@@ -75,7 +162,6 @@ module RailsMultisite
       config[:host_names].nil? ? config[:host] : config[:host_names].first
     end
 
-
     def self.clear_settings!
       @@db_spec_cache = nil
       @@host_spec_cache = nil
@@ -83,7 +169,7 @@ module RailsMultisite
     end
 
     def self.load_settings!
-      spec_klass = rails4? ? ActiveRecord::ConnectionAdapters::ConnectionSpecification : ActiveRecord::Base::ConnectionSpecification
+      spec_klass = ActiveRecord::ConnectionAdapters::ConnectionSpecification
       configs = YAML::load(File.open(self.config_filename))
       configs.each do |k,v|
         raise ArgumentError.new("Please do not name any db default!") if k == "default"
@@ -91,7 +177,7 @@ module RailsMultisite
       end
 
       @@db_spec_cache = Hash[*configs.map do |k, data|
-        [k, spec_klass::Resolver.new(k, configs).spec]
+        [k, spec_klass::Resolver.new(configs).spec(k)]
       end.flatten]
 
       @@host_spec_cache = {}
@@ -102,54 +188,36 @@ module RailsMultisite
         end
       end
 
-      @@default_spec = spec_klass::Resolver.new(Rails.env, ActiveRecord::Base.configurations).spec
+      @@default_spec = spec_klass::Resolver.new(ActiveRecord::Base.configurations).spec(Rails.env)
       ActiveRecord::Base.configurations[Rails.env]["host_names"].each do |host|
         @@host_spec_cache[host] = @@default_spec
       end
 
       @@default_connection_handler = ActiveRecord::Base.connection_handler
 
-      # inject our connection_handler pool
-      # WARNING MONKEY PATCH
-      #
-      # see: https://github.com/rails/rails/issues/8344#issuecomment-10800848
-      if ActiveRecord::VERSION::MAJOR == 3
-        ActiveRecord::Base.send :include, NewConnectionHandler
-        ActiveRecord::Base.connection_handler = @@default_connection_handler
-      end
-
       @@connection_handlers = {}
       @@established_default = false
     end
 
-    module NewConnectionHandler
-      def self.included(klass)
-        klass.class_eval do
-          define_singleton_method :connection_handler do
-            Thread.current[:connection_handler] || @connection_handler
-          end
-          define_singleton_method :connection_handler= do |handler|
-            @connection_handler ||= handler
-            Thread.current[:connection_handler] = handler
-          end
-        end
-      end
-    end
-
 
     def initialize(app, config = nil)
       @app = app
     end
 
-    def call(env)
+    def self.host(env)
       request = Rack::Request.new(env)
+      request['__ws'] || request.host
+    end
+
+    def call(env)
+      host = self.class.host(env)
       begin
 
         #TODO: add a callback so users can simply go to a domain to register it, or something
-        return [404, {}, ["not found"]] unless @@host_spec_cache[request.host]
+        return [404, {}, ["not found"]] unless @@host_spec_cache[host]
 
         ActiveRecord::Base.connection_handler.clear_active_connections!
-        self.class.establish_connection(:host => request['__ws'] || request.host)
+        self.class.establish_connection(:host => host)
         @app.call(env)
       ensure
         ActiveRecord::Base.connection_handler.clear_active_connections!

data/lib/rails_multisite/railtie.rb

@@ -5,7 +5,9 @@ module RailsMultisite
     end
 
     initializer "RailsMultisite.init" do |app|
+      Rails.configuration.multisite = false
       if File.exists?(ConnectionManagement.config_filename)
+        Rails.configuration.multisite = true
         ConnectionManagement.load_settings!
         app.middleware.insert_after(ActiveRecord::ConnectionAdapters::ConnectionManagement, RailsMultisite::ConnectionManagement)
         app.middleware.delete(ActiveRecord::ConnectionAdapters::ConnectionManagement)

data/lib/rails_multisite/version.rb

@@ -1,3 +1,3 @@
 module RailsMultisite
-  VERSION = "0.0.1"
+  VERSION = "1.0.1"
 end

data/lib/tasks/db.rake

@@ -0,0 +1,31 @@
+desc "migrate all sites in tier"
+task "multisite:migrate" => :environment do
+  RailsMultisite::ConnectionManagement.each_connection do |db|
+    puts "Migrating #{db}"
+    puts "---------------------------------\n"
+    t = Rake::Task["db:migrate"]
+    t.reenable
+    t.invoke
+  end
+end
+
+task "multisite:seed_fu" => :environment do
+  RailsMultisite::ConnectionManagement.each_connection do |db|
+    puts "Seeding #{db}"
+    puts "---------------------------------\n"
+    t = Rake::Task["db:seed_fu"]
+    t.reenable
+    t.invoke
+  end
+end
+
+desc "rollback migrations for all sites in tier"
+task "multisite:rollback" => :environment do
+  RailsMultisite::ConnectionManagement.each_connection do |db|
+    puts "Rollback #{db}"
+    puts "---------------------------------\n"
+    t = Rake::Task["db:rollback"]
+    t.reenable
+    t.invoke
+  end
+end

data/lib/tasks/generators.rake

@@ -0,0 +1,26 @@
+desc "generate multisite config file (if missing)"
+task "multisite:generate:config" => :environment do
+  filename =  RailsMultisite::ConnectionManagement.config_filename
+
+  if File.exists?(filename)
+    puts "Config is already generated at #{RailsMultisite::ConnectionManagement::CONFIG_FILE}"
+  else
+    puts "Generated config file at #{RailsMultisite::ConnectionManagement::CONFIG_FILE}"
+    File.open(filename, 'w') do |f|
+      f.write <<-CONFIG
+# site_name:
+#   adapter: postgresql
+#   database: db_name
+#   host: localhost
+#   pool: 5
+#   timeout: 5000
+#   db_id: 1           # optionally include other settings you need
+#   host_names:
+#     - www.mysite.com
+#     - www.anothersite.com
+CONFIG
+
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_multisite
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-29 00:00:00.000000000 Z
+date: 2015-10-13 00:00:00.000000000 Z
 dependencies: []
 description: Multi tenancy support for Rails
 email:
@@ -23,6 +23,8 @@ files:
 - lib/rails_multisite/connection_management.rb
 - lib/rails_multisite/railtie.rb
 - lib/rails_multisite/version.rb
+- lib/tasks/db.rake
+- lib/tasks/generators.rake
 homepage: ''
 licenses: []
 metadata: {}
@@ -32,19 +34,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Multi tenancy support for Rails
 test_files: []
-has_rdoc: