activerecord-multi-tenant 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 47a1f8686348899edcbff39802df23196a67adae
+  data.tar.gz: aaf2bcf30117e8de2b7925400215e7f7990a997e
+SHA512:
+  metadata.gz: 60b61705874dfd045cc5dfea6ce5b2ce87e3be49fdf90c46ee97534c85be757a0b481c96a50842bff09917fb2823e01c342c8b57b8255f37f1f5ec9faa791bbd
+  data.tar.gz: 6bb2620d436d1cdd15d3c9daf40bf54eb9115cb76bcf29181c0befa5b258774fa5fdf1d9765b2b09a3db9f2c24b5dcbfc6fdb934731f33f50568f9bfb11fbf45

data/lib/activerecord-multi-tenant.rb

@@ -0,0 +1,6 @@
+require 'activerecord-multi-tenant/copy_from_client'
+require 'activerecord-multi-tenant/default_scope'
+require 'activerecord-multi-tenant/migrations'
+require 'activerecord-multi-tenant/multi_tenant'
+require 'activerecord-multi-tenant/referential_integrity'
+require 'activerecord-multi-tenant/version'

data/lib/activerecord-multi-tenant/copy_from_client.rb

@@ -0,0 +1,33 @@
+module MultiTenant
+  class CopyFromClientHelper
+    attr_reader :count
+
+    def initialize(conn, column_types)
+      @count = 0
+      @conn = conn
+      @column_types = column_types
+    end
+
+    def <<(row)
+      row = row.map.with_index { |val, idx| @column_types[idx].type_cast_for_database(val) }
+      @conn.put_copy_data(row)
+      @count += 1
+    end
+  end
+
+  module CopyFromClient
+    def self.copy_from_client(columns, &block)
+      conn         = connection.raw_connection
+      column_types = columns.map { |c| columns_hash[c.to_s] }
+      helper = MultiTenant::CopyFromClientHelper.new(conn, column_types)
+      conn.copy_data %{COPY #{quoted_table_name}("#{columns.join('","')}") FROM STDIN}, PG::TextEncoder::CopyRow.new do
+        block.call helper
+      end
+      helper.count
+    end
+  end
+end
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.send(:include, MultiTenant::CopyFromClient)
+end

data/lib/activerecord-multi-tenant/default_scope.rb

@@ -0,0 +1,12 @@
+class ActiveRecord::Base
+  class << self
+    alias :unscoped_orig :unscoped
+    def unscoped
+      if respond_to?(:scoped_by_tenant?) && MultiTenant.current_tenant_id
+        unscoped_orig.where(arel_table[MultiTenant.partition_key].eq(MultiTenant.current_tenant_id))
+      else
+        unscoped_orig
+      end
+    end
+  end
+end

data/lib/activerecord-multi-tenant/migrations.rb

@@ -0,0 +1,36 @@
+module MultiTenant
+  module MigrationExtensions
+    def create_distributed_table(table_name, partition_key)
+      execute "SELECT create_distributed_table($$#{table_name}$$, $$#{partition_key}$$)"
+    end
+
+    def execute_on_all_nodes(sql)
+      execute sql
+      execute "SELECT citus_run_on_all_workers($$#{sql}$$)"
+    end
+
+    def enable_extension_on_all_nodes(extension)
+      execute_on_all_nodes "CREATE EXTENSION IF NOT EXISTS \"#{extension}\""
+    end
+  end
+end
+
+if defined?(ActiveRecord::Migration)
+  ActiveRecord::Migration.send(:include, MultiTenant::MigrationExtensions)
+end
+
+module ActiveRecord
+  module ConnectionAdapters # :nodoc:
+    module SchemaStatements
+      alias :orig_create_table :create_table
+      def create_table(table_name, options = {}, &block)
+        ret = orig_create_table(table_name, options.except(:partition_key), &block)
+        if options[:partition_key] && options[:partition_key].to_s != 'id'
+          execute "ALTER TABLE #{table_name} DROP CONSTRAINT #{table_name}_pkey"
+          execute "ALTER TABLE #{table_name} ADD PRIMARY KEY(id, #{options[:partition_key]})"
+        end
+        ret
+      end
+    end
+  end
+end

data/lib/activerecord-multi-tenant/multi_tenant.rb

@@ -0,0 +1,72 @@
+# Note that the actual details here are subject to change, and you should avoid
+# calling acts_as_tenant methods directly as a user of this library
+require 'acts_as_tenant'
+
+module MultiTenant
+  def self.current_tenant
+    ActsAsTenant.current_tenant
+  end
+
+  def self.current_tenant=(tenant)
+    ActsAsTenant.current_tenant = tenant
+  end
+
+  def self.current_tenant_id
+    ActsAsTenant.current_tenant.try(:id)
+  end
+
+  def self.with(tenant, &block)
+    ActsAsTenant.with_tenant(tenant, &block)
+  end
+
+  def self.partition_key
+    ActsAsTenant.fkey
+  end
+
+  def self.with_id(tenant_id, &block)
+    MultiTenant.with(TenantIdWrapper.new(id: tenant_id), &block)
+  end
+
+  class TenantIdWrapper
+    attr_reader :id
+
+    def initialize(id:)
+      @id = id
+    end
+
+    def new_record?; true; end
+    def touch; nil; end
+  end
+
+  module ModelExtensions
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def multi_tenant(tenant, options = {})
+        # Provide fallback primary key setting to ease integration with the typical Rails app
+        self.primary_key = 'id' if primary_key.nil?
+
+        # Typically we don't need to run on the tenant model itself
+        if to_s.underscore.to_sym != tenant
+          belongs_to(tenant)
+          acts_as_tenant(tenant, options)
+
+          around_save -> (record, block) { persisted? ? MultiTenant.with_id(record.public_send(tenant.to_s + '_id')) { block.call } : block.call }
+          around_update -> (record, block) { MultiTenant.with_id(record.public_send(tenant.to_s + '_id')) { block.call } }
+          around_destroy -> (record, block) { MultiTenant.with_id(record.public_send(tenant.to_s + '_id')) { block.call } }
+        end
+
+        # Workaround for https://github.com/citusdata/citus/issues/687
+        if to_s.underscore.to_sym == tenant
+          before_create -> { self.id ||= self.class.connection.select_value("SELECT nextval('" + [self.class.table_name, self.class.primary_key, 'seq'].join('_') + "'::regclass)") }
+        end
+      end
+    end
+  end
+end
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.send(:include, MultiTenant::ModelExtensions)
+end

data/lib/activerecord-multi-tenant/referential_integrity.rb

@@ -0,0 +1,18 @@
+# Disable Rails trigger enable/disable mechanism used for test cases, since
+# DISABLE TRIGGER is not supported on distributed tables.
+
+module ActiveRecord
+  module ConnectionAdapters
+    module PostgreSQL
+      module ReferentialIntegrity
+        def supports_disable_referential_integrity?
+          false
+        end
+
+        def disable_referential_integrity
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/activerecord-multi-tenant/version.rb

@@ -0,0 +1,3 @@
+module MultiTenant
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-multi-tenant
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Citus Data
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: acts_as_tenant
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email: engage@citusdata.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/activerecord-multi-tenant.rb
+- lib/activerecord-multi-tenant/copy_from_client.rb
+- lib/activerecord-multi-tenant/default_scope.rb
+- lib/activerecord-multi-tenant/migrations.rb
+- lib/activerecord-multi-tenant/multi_tenant.rb
+- lib/activerecord-multi-tenant/referential_integrity.rb
+- lib/activerecord-multi-tenant/version.rb
+homepage: https://github.com/citusdata/activerecord-multi-tenant
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: ActiveRecord/Rails integration for multi-tenant databases, in particular
+  the Citus extension for PostgreSQL
+test_files: []