cell 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 688c58ded30105abbc900e3b92d524549b860812
-  data.tar.gz: e176f9fc293ad7027e53052a09561e26e11f1091
+SHA256:
+  metadata.gz: bb2eae73c6d15e47ad6f4ea4a75c768d354f34f93f8e68c7d5c873a8dc8ed7d6
+  data.tar.gz: 43176f41eb4872ee5d963066f666873d1264a7e8e7b20d10a2467190ada19bae
 SHA512:
-  metadata.gz: ec3f3baee67fa98496dabaf50554f5bcfe4b230d0ae6c5d5eba21d00635e5cfeaed3156e233cce8e31289ae73a012df07090649c93e7d7b23bbc8aa95384901d
-  data.tar.gz: 89ef969c710585e9afb2b43ae8ef8eecc343213586e38eaae9a6a463aef45fdf4033f044781243e949fec595821c8ac2f0466c8e00d3af30ef65c182e227ed16
+  metadata.gz: a4fe6e8dc968592539f0eeeaecd2584f61c7b2ffc3f3ab6fe6b69d0fd834cbc1745776f1038b04b34d3be8e38e3394dc79fccb624550100c4c0a0f8e9c1e5cfe
+  data.tar.gz: 45b12e68c347eb6a72ef77093227b838b38fcb7a3ba24309927657b31ee85df95896ea155a9289b5dd996d796a8b89eba0da19b4d4d6552c1cf9362cd0c03b99

data/README.md

@@ -13,7 +13,7 @@ particular job adapter), except for one place: PostgreSQL.  I think PostgreSQL i
 deployed database with the features required to make a reasonable implementation (namely: schemas,
 roles, row and column level security.)
 
-**Cell aggressively uses Ruby 2.3, PostgreSQL 9.6 and Rails 5**.  This means it's probably more
+**Cell aggressively uses Ruby 2.5, PostgreSQL 10.5 and Rails 5.2**.  This means it's probably more
 appropriate for greenfield projects than bolting on to an existing application on an older stack.
 
 Cell moves forward quickly: Don't expect to be able to hang back on an old version of Rails and get

data/cell.gemspec

@@ -26,12 +26,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # The parts of the Rails stack we care about
-  spec.add_dependency "rails",   "~> 5.0.0", ">= 5.0.0.1"
+  spec.add_dependency "rails",   "~> 5.2.0"
 
   # Our hard dependency on PostgreSQL
-  spec.add_dependency "pg", "~> 0.18.4"
+  spec.add_dependency "pg", "~> 1.1.3"
 
-  spec.add_development_dependency "minitest", "~> 5.9.0"
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake",    "~> 11.0"
+  spec.add_development_dependency "minitest", "~> 5.11"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake",    "~> 12.3"
 end

data/lib/cell/clone_schema.rb

@@ -36,200 +36,203 @@ module Cell
 
 
     def self.function_definition
-      File.read(__FILE__).split(/^__END__$/, 2)[-1]
+      FUNCTION_DEFINITION
     end
   end
 end
 
-# The following function was written by Melvin Davidson, originally based on
-# the work of Emanuel '3manuek', posted at:
-#   https://wiki.postgresql.org/wiki/Clone_schema
-__END__
--- Function: clone_schema(text, text)
-
--- DROP FUNCTION clone_schema(text, text);
-
-CREATE OR REPLACE FUNCTION public.clone_schema(
-    source_schema text,
-    dest_schema text,
-    include_recs boolean)
-  RETURNS void AS
-$BODY$
-
---  This function will clone all sequences, tables, data, views & functions from any existing schema to a new one
--- SAMPLE CALL:
--- SELECT clone_schema('public', 'new_schema', TRUE);
-
-DECLARE
-  src_oid          oid;
-  tbl_oid          oid;
-  func_oid         oid;
-  object           text;
-  buffer           text;
-  srctbl           text;
-  default_         text;
-  column_          text;
-  qry              text;
-  dest_qry         text;
-  v_def            text;
-  seqval           bigint;
-  sq_last_value    bigint;
-  sq_max_value     bigint;
-  sq_start_value   bigint;
-  sq_increment_by  bigint;
-  sq_min_value     bigint;
-  sq_cache_value   bigint;
-  sq_log_cnt       bigint;
-  sq_is_called     boolean;
-  sq_is_cycled     boolean;
-  sq_cycled        char(10);
-
-BEGIN
-
--- Check that source_schema exists
-  SELECT oid INTO src_oid
-    FROM pg_namespace
-   WHERE nspname = quote_ident(source_schema);
-  IF NOT FOUND
-    THEN
-    RAISE NOTICE 'source schema % does not exist!', source_schema;
-    RETURN ;
-  END IF;
-
-  -- Check that dest_schema does not yet exist
-  PERFORM nspname
-    FROM pg_namespace
-   WHERE nspname = quote_ident(dest_schema);
-  IF FOUND
-    THEN
-    RAISE NOTICE 'dest schema % already exists!', dest_schema;
-    RETURN ;
-  END IF;
-
-  EXECUTE 'CREATE SCHEMA ' || quote_ident(dest_schema) ;
-
-  -- Create sequences
-  -- TODO: Find a way to make this sequence's owner is the correct table.
-  FOR object IN
-    SELECT sequence_name::text
-      FROM information_schema.sequences
-     WHERE sequence_schema = quote_ident(source_schema)
-  LOOP
-    EXECUTE 'CREATE SEQUENCE ' || quote_ident(dest_schema) || '.' || quote_ident(object);
-    srctbl := quote_ident(source_schema) || '.' || quote_ident(object);
-
-    EXECUTE 'SELECT last_value, max_value, start_value, increment_by, min_value, cache_value, log_cnt, is_cycled, is_called
-              FROM ' || quote_ident(source_schema) || '.' || quote_ident(object) || ';'
-              INTO sq_last_value, sq_max_value, sq_start_value, sq_increment_by, sq_min_value, sq_cache_value, sq_log_cnt, sq_is_cycled, sq_is_called ;
-
-    IF sq_is_cycled
-      THEN
-        sq_cycled := 'CYCLE';
-    ELSE
-        sq_cycled := 'NO CYCLE';
-    END IF;
-
-    EXECUTE 'ALTER SEQUENCE '   || quote_ident(dest_schema) || '.' || quote_ident(object)
-            || ' INCREMENT BY ' || sq_increment_by
-            || ' MINVALUE '     || sq_min_value
-            || ' MAXVALUE '     || sq_max_value
-            || ' START WITH '   || sq_start_value
-            || ' RESTART '      || sq_min_value
-            || ' CACHE '        || sq_cache_value
-            || sq_cycled || ' ;' ;
-
-    buffer := quote_ident(dest_schema) || '.' || quote_ident(object);
-    IF include_recs
+unless Cell::CloneSchema.const_defined?(:FUNCTION_DEFINITION)
+  # The following function was written by Melvin Davidson, originally based on the work of '3manuek',
+  #   posted at: https://wiki.postgresql.org/wiki/Clone_schema
+
+  Cell::CloneSchema.const_set :FUNCTION_DEFINITION, <<~PGSQL
+    -- Function: clone_schema(text, text)
+
+    -- DROP FUNCTION clone_schema(text, text);
+
+    CREATE OR REPLACE FUNCTION public.clone_schema(
+        source_schema text,
+        dest_schema text,
+        include_recs boolean)
+      RETURNS void AS
+    $BODY$
+
+    --  This function will clone all sequences, tables, data, views & functions from any existing schema to a new one
+    -- SAMPLE CALL:
+    -- SELECT clone_schema('public', 'new_schema', TRUE);
+
+    DECLARE
+      src_oid          oid;
+      tbl_oid          oid;
+      func_oid         oid;
+      object           text;
+      buffer           text;
+      srctbl           text;
+      default_         text;
+      column_          text;
+      qry              text;
+      dest_qry         text;
+      v_def            text;
+      seqval           bigint;
+      sq_last_value    bigint;
+      sq_max_value     bigint;
+      sq_start_value   bigint;
+      sq_increment_by  bigint;
+      sq_min_value     bigint;
+      sq_cache_value   bigint;
+      sq_log_cnt       bigint;
+      sq_is_called     boolean;
+      sq_is_cycled     boolean;
+      sq_cycled        char(10);
+
+    BEGIN
+
+    -- Check that source_schema exists
+      SELECT oid INTO src_oid
+        FROM pg_namespace
+       WHERE nspname = quote_ident(source_schema);
+      IF NOT FOUND
         THEN
-            EXECUTE 'SELECT setval( ''' || buffer || ''', ' || sq_last_value || ', ' || sq_is_called || ');' ;
-    ELSE
-            EXECUTE 'SELECT setval( ''' || buffer || ''', ' || sq_start_value || ', ' || sq_is_called || ');' ;
-    END IF;
-
-  END LOOP;
-
--- Create tables
-  FOR object IN
-    SELECT TABLE_NAME::text
-      FROM information_schema.tables
-     WHERE table_schema = quote_ident(source_schema)
-       AND table_type = 'BASE TABLE'
-
-  LOOP
-    buffer := quote_ident(dest_schema) || '.' || quote_ident(object);
-    EXECUTE 'CREATE TABLE ' || buffer || ' (LIKE ' || quote_ident(source_schema) || '.' || quote_ident(object)
-        || ' INCLUDING ALL)';
-
-    IF include_recs
-      THEN
-      -- Insert records from source table
-      EXECUTE 'INSERT INTO ' || buffer || ' SELECT * FROM ' || quote_ident(source_schema) || '.' || quote_ident(object) || ';';
-    END IF;
-
-    FOR column_, default_ IN
-      SELECT column_name::text,
-             REPLACE(column_default::text, source_schema, dest_schema)
-        FROM information_schema.COLUMNS
-       WHERE table_schema = dest_schema
-         AND TABLE_NAME = object
-         AND column_default LIKE 'nextval(%' || quote_ident(source_schema) || '%::regclass)'
-    LOOP
-      EXECUTE 'ALTER TABLE ' || buffer || ' ALTER COLUMN ' || column_ || ' SET DEFAULT ' || default_;
-    END LOOP;
-
-  END LOOP;
-
---  add FK constraint
-  FOR qry IN
-    SELECT 'ALTER TABLE ' || quote_ident(dest_schema) || '.' || quote_ident(rn.relname)
-                          || ' ADD CONSTRAINT ' || quote_ident(ct.conname) || ' ' || pg_get_constraintdef(ct.oid) || ';'
-      FROM pg_constraint ct
-      JOIN pg_class rn ON rn.oid = ct.conrelid
-     WHERE connamespace = src_oid
-       AND rn.relkind = 'r'
-       AND ct.contype = 'f'
-
-    LOOP
-      EXECUTE qry;
-
-    END LOOP;
-
-
--- Create views
-  FOR object IN
-    SELECT table_name::text,
-           view_definition
-      FROM information_schema.views
-     WHERE table_schema = quote_ident(source_schema)
-
-  LOOP
-    buffer := dest_schema || '.' || quote_ident(object);
-    SELECT view_definition INTO v_def
-      FROM information_schema.views
-     WHERE table_schema = quote_ident(source_schema)
-       AND table_name = quote_ident(object);
-
-    EXECUTE 'CREATE OR REPLACE VIEW ' || buffer || ' AS ' || v_def || ';' ;
-
-  END LOOP;
-
--- Create functions
-  FOR func_oid IN
-    SELECT oid
-      FROM pg_proc
-     WHERE pronamespace = src_oid
-
-  LOOP
-    SELECT pg_get_functiondef(func_oid) INTO qry;
-    SELECT replace(qry, source_schema, dest_schema) INTO dest_qry;
-    EXECUTE dest_qry;
-
-  END LOOP;
-
-  RETURN;
-
-END;
-
-$BODY$
-  LANGUAGE plpgsql VOLATILE
-  COST 100;
+        RAISE NOTICE 'source schema % does not exist!', source_schema;
+        RETURN ;
+      END IF;
+
+      -- Check that dest_schema does not yet exist
+      PERFORM nspname
+        FROM pg_namespace
+       WHERE nspname = quote_ident(dest_schema);
+      IF FOUND
+        THEN
+        RAISE NOTICE 'dest schema % already exists!', dest_schema;
+        RETURN ;
+      END IF;
+
+      EXECUTE 'CREATE SCHEMA ' || quote_ident(dest_schema) ;
+
+      -- Create sequences
+      -- TODO: Find a way to make this sequence's owner is the correct table.
+      FOR object IN
+        SELECT sequence_name::text
+          FROM information_schema.sequences
+         WHERE sequence_schema = quote_ident(source_schema)
+      LOOP
+        EXECUTE 'CREATE SEQUENCE ' || quote_ident(dest_schema) || '.' || quote_ident(object);
+        srctbl := quote_ident(source_schema) || '.' || quote_ident(object);
+
+        EXECUTE 'SELECT last_value, max_value, start_value, increment_by, min_value, cache_value, log_cnt, is_cycled, is_called
+                  FROM ' || quote_ident(source_schema) || '.' || quote_ident(object) || ';'
+                  INTO sq_last_value, sq_max_value, sq_start_value, sq_increment_by, sq_min_value, sq_cache_value, sq_log_cnt, sq_is_cycled, sq_is_called ;
+
+        IF sq_is_cycled
+          THEN
+            sq_cycled := 'CYCLE';
+        ELSE
+            sq_cycled := 'NO CYCLE';
+        END IF;
+
+        EXECUTE 'ALTER SEQUENCE '   || quote_ident(dest_schema) || '.' || quote_ident(object)
+                || ' INCREMENT BY ' || sq_increment_by
+                || ' MINVALUE '     || sq_min_value
+                || ' MAXVALUE '     || sq_max_value
+                || ' START WITH '   || sq_start_value
+                || ' RESTART '      || sq_min_value
+                || ' CACHE '        || sq_cache_value
+                || sq_cycled || ' ;' ;
+
+        buffer := quote_ident(dest_schema) || '.' || quote_ident(object);
+        IF include_recs
+            THEN
+                EXECUTE 'SELECT setval( ''' || buffer || ''', ' || sq_last_value || ', ' || sq_is_called || ');' ;
+        ELSE
+                EXECUTE 'SELECT setval( ''' || buffer || ''', ' || sq_start_value || ', ' || sq_is_called || ');' ;
+        END IF;
+
+      END LOOP;
+
+    -- Create tables
+      FOR object IN
+        SELECT TABLE_NAME::text
+          FROM information_schema.tables
+         WHERE table_schema = quote_ident(source_schema)
+           AND table_type = 'BASE TABLE'
+
+      LOOP
+        buffer := quote_ident(dest_schema) || '.' || quote_ident(object);
+        EXECUTE 'CREATE TABLE ' || buffer || ' (LIKE ' || quote_ident(source_schema) || '.' || quote_ident(object)
+            || ' INCLUDING ALL)';
+
+        IF include_recs
+          THEN
+          -- Insert records from source table
+          EXECUTE 'INSERT INTO ' || buffer || ' SELECT * FROM ' || quote_ident(source_schema) || '.' || quote_ident(object) || ';';
+        END IF;
+
+        FOR column_, default_ IN
+          SELECT column_name::text,
+                 REPLACE(column_default::text, source_schema, dest_schema)
+            FROM information_schema.COLUMNS
+           WHERE table_schema = dest_schema
+             AND TABLE_NAME = object
+             AND column_default LIKE 'nextval(%' || quote_ident(source_schema) || '%::regclass)'
+        LOOP
+          EXECUTE 'ALTER TABLE ' || buffer || ' ALTER COLUMN ' || column_ || ' SET DEFAULT ' || default_;
+        END LOOP;
+
+      END LOOP;
+
+    --  add FK constraint
+      FOR qry IN
+        SELECT 'ALTER TABLE ' || quote_ident(dest_schema) || '.' || quote_ident(rn.relname)
+                              || ' ADD CONSTRAINT ' || quote_ident(ct.conname) || ' ' || pg_get_constraintdef(ct.oid) || ';'
+          FROM pg_constraint ct
+          JOIN pg_class rn ON rn.oid = ct.conrelid
+         WHERE connamespace = src_oid
+           AND rn.relkind = 'r'
+           AND ct.contype = 'f'
+
+        LOOP
+          EXECUTE qry;
+
+        END LOOP;
+
+
+    -- Create views
+      FOR object IN
+        SELECT table_name::text,
+               view_definition
+          FROM information_schema.views
+         WHERE table_schema = quote_ident(source_schema)
+
+      LOOP
+        buffer := dest_schema || '.' || quote_ident(object);
+        SELECT view_definition INTO v_def
+          FROM information_schema.views
+         WHERE table_schema = quote_ident(source_schema)
+           AND table_name = quote_ident(object);
+
+        EXECUTE 'CREATE OR REPLACE VIEW ' || buffer || ' AS ' || v_def || ';' ;
+
+      END LOOP;
+
+    -- Create functions
+      FOR func_oid IN
+        SELECT oid
+          FROM pg_proc
+         WHERE pronamespace = src_oid
+
+      LOOP
+        SELECT pg_get_functiondef(func_oid) INTO qry;
+        SELECT replace(qry, source_schema, dest_schema) INTO dest_qry;
+        EXECUTE dest_qry;
+
+      END LOOP;
+
+      RETURN;
+
+    END;
+
+    $BODY$
+      LANGUAGE plpgsql VOLATILE
+      COST 100;
+  PGSQL
+end

data/lib/cell/console.rb

@@ -2,18 +2,25 @@ module Cell
   module Console
     def self.default_console_tenant
       if ENV['T'].present?
-        Cell::Model.cell_find!(ENV['T'])
+        Model.cell_find!(ENV['T'])
       elsif Rails.env.development? && ENV['T'] != ''
-        Cell::Model.first
+        Model.first
       end
+    # These are so 'rails c' still works before the DB has been created, or the
+    # Model class's table does not exist before db:migrate.
+    rescue ::ActiveRecord::NoDatabaseError
+      nil
+    rescue ::ActiveRecord::StatementInvalid => e
+      raise unless e.cause.is_a?(::PG::UndefinedTable)
+      nil
     end
 
     def self.configure!
       if (t = default_console_tenant)
-        ::Cell::Model.set!(t)
+        Model.set!(t)
       end
     end
   end
 end
 
-::Cell::Console.configure!
+Cell::Console.configure!

data/lib/cell/context.rb

@@ -7,7 +7,7 @@ module Cell
 
     module ClassMethods
       def self.extended(cls)
-        cls.include ActiveSupport::Callbacks
+        cls.include ::ActiveSupport::Callbacks
         cls.define_callbacks :set_tenant, :use_tenant
       end
 
@@ -24,7 +24,7 @@ module Cell
       end
 
       def set!(tenant, exclusive: false)
-        ::Cell::Meta.with_schema(tenant.schema_name, exclusive: exclusive)
+        Meta.with_schema(tenant.schema_name, exclusive: exclusive)
         set_current(tenant)
         tenant.run_callbacks :set_tenant
         tenant
@@ -35,14 +35,14 @@ module Cell
         saved_tenant = current
 
         if tenant
-          ::Cell::Meta.with_schema(tenant.schema_name, exclusive: exclusive) do
+          Meta.with_schema(tenant.schema_name, exclusive: exclusive) do
             set_current(tenant)
             tenant.run_callbacks :use_tenant do
-              yield Cell::Model.current
+              yield Model.current
             end
           end
         else
-          ::Cell::Meta.with_global_schema do
+          Meta.with_global_schema do
             set_current(nil)
             yield nil
           end
@@ -55,7 +55,7 @@ module Cell
 
       private
       def set_current(tenant)
-        unless tenant.nil? || tenant.is_a?(Cell::Model)
+        unless tenant.nil? || tenant.is_a?(Model)
           fail ArgumentError, "Invalid tenant: #{tenant.inspect}"
         end
 
@@ -68,7 +68,7 @@ module Cell
     end
 
     def set!(tenant)
-      Cell::Model.set!(tenant)
+      Model.set!(tenant)
     end
 
     def current?

data/lib/cell/ext/active_job.rb

@@ -0,0 +1,33 @@
+module Cell
+  module Ext
+    module ActiveJob
+      KEY = :'Cell.cell_id'
+
+      def serialize
+        if (current_id = Model.current&.cell_id)
+          super.merge(KEY => current_id)
+        else
+          super
+        end
+      end
+
+      def deserialize(job_data)
+        if job_data.key?(KEY)
+          self.cell_tenant = Model.cell_find(job_data[KEY])
+        end
+        super
+      end
+
+      def self.prepended(cls)
+        cls.send(:attr_accessor, :cell_tenant)
+        cls.around_perform do |job, block|
+          Model.use(job.cell_tenant, &block)
+        end
+      end
+    end
+  end
+end
+
+ActiveSupport::on_load(:active_job) do
+  ActiveJob::Base.prepend(Cell::Ext::ActiveJob)
+end

data/lib/cell/ext/active_record.rb

@@ -0,0 +1,81 @@
+# These are added to ActiveRecord::Base, regardless if they're the tenant model or not.
+
+# There are two big tricks here:
+#  1. Assigning a "tenant" attribute to every model that is loaded from the db, or created while a
+#     tenant is active.
+#  2. Making sure the object is validated and saved with the proper tenant activated, even if the
+#     tenant has changed since the object was created
+#
+# So you can load an object from "tenant_a", switch to "tenant_b", and if you save or validate the
+# object, it'll do so while switched to "tenant_a", and then restore.
+
+require 'cell/meta'
+
+module Cell
+  module Ext
+    module ActiveRecord
+      # Say we have a model 'u', that is from an old Tenant, loading an association like 'u.books'
+      # should swap into u.tenant while fetching.
+      module Association
+        def load_target
+          owner._activate_tenant do
+            super
+          end
+        end
+      end
+
+      module ClassMethods
+        def global_model?
+          Meta.global_model?(self)
+        end
+
+        # When a model's schema is lazy-loaded, we want to make sure our view of the DB allows us
+        # to get introspection data.
+        def load_schema!
+          Meta.with_structural_schema do
+            return super
+          end
+        end
+      end
+
+      attr_reader :tenant
+
+      def _assign_tenant
+        unless self.class.global_model?
+          @tenant = Model.current
+        end
+      end
+
+      def _activate_tenant(&block)
+        if tenant && tenant != Model.current
+          tenant.use(&block)
+        else
+          yield
+        end
+      end
+
+      # undocumented, but makes sure validations are ran in the context of the object's tenant,
+      # e.g., uniqueness.
+      def run_validations!
+        _activate_tenant do
+          super
+        end
+      end
+
+      def self.prepended(cls)
+        class << cls
+          prepend ClassMethods
+        end
+
+        cls.after_initialize :_assign_tenant
+        cls.around_save :_activate_tenant
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Base.prepend(Cell::Ext::ActiveRecord)
+  ActiveRecord::Associations::Association.prepend(Cell::Ext::ActiveRecord::Association)
+  ActiveRecord::Associations::CollectionAssociation.prepend(Cell::Ext::ActiveRecord::Association)
+end