Add the ability to insert deferrable constraints after the table body

Author: kravcneger

lib/activerecord-clean-db-structure/clean_dump.rb

@@ -128,17 +128,29 @@ def clean_options
         dump.gsub!(/^(INSERT INTO schema_migrations .*)\n\n/, "\\1\n")
       end
 
-      if options[:indexes_after_tables] == true
-        # Extract indexes, remove comments and place them just after the respective tables
+      if options[:meta_tables_after_main] == true
+        # Extract indexes
         indexes =
           dump
             .scan(/^CREATE.+INDEX.+ON.+\n/)
             .group_by { |line| line.scan(/\b\w+\.\w+\b/).first }
             .transform_values(&:join)
 
+        # Extract deferrable constraints
+        deferrable_constraints =
+          dump
+            .scan(/^ALTER.+TABLE.+ONLY.+\n.+DEFERRABLE.+\n/)
+            .group_by { |line| line.scan(/\b\w+\.\w+\b/).first }
+            .transform_values(&:join)
+
+        # Remove indexes and deferrable constraints from the dump
         dump.gsub!(/^CREATE( UNIQUE)? INDEX \w+ ON .+\n+/, '')
         dump.gsub!(/^-- Name: \w+; Type: INDEX; Schema: \w+\n+/, '')
-        indexes.each do |table, indexes_for_table|
+
+        dump.gsub!(/^-- Name.+\n\nALTER.+TABLE.+ONLY.+\n.+DEFERRABLE.+\n+/, '')
+
+        indexes_and_constraints = indexes.merge(deferrable_constraints) { |_, v1, v2| v1 + v2 }
+        indexes_and_constraints.each do |table, indexes_for_table|
           dump.gsub!(/^(CREATE TABLE #{table}\b(:?[^;\n]*\n)+\);*\n(?:.*);*)/) { $1 + "\n\n" + indexes_for_table }
         end
       end

test/clean_dump_test.rb

@@ -17,8 +17,8 @@ def test_order_schema_migrations_values
     assert_cleans_dump "data/input.sql", "expectations/order_schema_migrations_values.sql", order_schema_migrations_values: true
   end
 
-  def test_indexes_after_tables
-    assert_cleans_dump "data/input.sql", "expectations/indexes_after_tables.sql", indexes_after_tables: true
+  def test_meta_tables_after_main
+    assert_cleans_dump "data/input.sql", "expectations/meta_tables_after_main.sql", meta_tables_after_main: true
   end
 
   def test_keep_extensions_all

test/data/input.sql

@@ -113,6 +113,11 @@ ALTER TABLE ONLY public.ar_internal_metadata
 ALTER TABLE ONLY public.delayed_jobs
     ADD CONSTRAINT delayed_jobs_pkey PRIMARY KEY (id);
 
+--
+-- Name: unique_locked_by_locked_at; Type: CONSTRAINT
+--
+ALTER TABLE ONLY public.delayed_jobs
+    ADD CONSTRAINT unique_locked_by_locked_at UNIQUE (locked_by, locked_at) DEFERRABLE INITIALLY DEFERRED;
 
 --
 -- Name: schema_migrations schema_migrations_pkey; Type: CONSTRAINT; Schema: public; Owner: -

test/expectations/default_props.sql

@@ -46,6 +46,11 @@ CREATE TABLE public.schema_migrations (
 ALTER TABLE ONLY public.ar_internal_metadata
     ADD CONSTRAINT ar_internal_metadata_pkey PRIMARY KEY (key);
 
+-- Name: unique_locked_by_locked_at; Type: CONSTRAINT
+
+ALTER TABLE ONLY public.delayed_jobs
+    ADD CONSTRAINT unique_locked_by_locked_at UNIQUE (locked_by, locked_at) DEFERRABLE INITIALLY DEFERRED;
+
 ALTER TABLE ONLY public.schema_migrations
     ADD CONSTRAINT schema_migrations_pkey PRIMARY KEY (version);
 

test/expectations/ignore_ids.sql

@@ -70,6 +70,11 @@ ALTER TABLE ONLY public.ar_internal_metadata
 ALTER TABLE ONLY public.delayed_jobs
     ADD CONSTRAINT delayed_jobs_pkey PRIMARY KEY (id);
 
+-- Name: unique_locked_by_locked_at; Type: CONSTRAINT
+
+ALTER TABLE ONLY public.delayed_jobs
+    ADD CONSTRAINT unique_locked_by_locked_at UNIQUE (locked_by, locked_at) DEFERRABLE INITIALLY DEFERRED;
+
 -- Name: schema_migrations schema_migrations_pkey; Type: CONSTRAINT
 
 ALTER TABLE ONLY public.schema_migrations

test/expectations/keep_extensions_all.sql

@@ -52,6 +52,11 @@ CREATE TABLE public.schema_migrations (
 ALTER TABLE ONLY public.ar_internal_metadata
     ADD CONSTRAINT ar_internal_metadata_pkey PRIMARY KEY (key);
 
+-- Name: unique_locked_by_locked_at; Type: CONSTRAINT
+
+ALTER TABLE ONLY public.delayed_jobs
+    ADD CONSTRAINT unique_locked_by_locked_at UNIQUE (locked_by, locked_at) DEFERRABLE INITIALLY DEFERRED;
+
 ALTER TABLE ONLY public.schema_migrations
     ADD CONSTRAINT schema_migrations_pkey PRIMARY KEY (version);
 

test/expectations/indexes_after_tables.sql renamed to test/expectations/meta_tables_after_main.sql

@@ -40,6 +40,8 @@ WITH (fillfactor='85');
 CREATE INDEX index_delayed_jobs_on_locked_by ON public.delayed_jobs USING btree (locked_by);
 CREATE INDEX index_delayed_jobs_on_queue ON public.delayed_jobs USING btree (queue);
 CREATE INDEX index_delayed_jobs_on_run_at ON public.delayed_jobs USING btree (run_at) WHERE (locked_at IS NULL);
+ALTER TABLE ONLY public.delayed_jobs
+    ADD CONSTRAINT unique_locked_by_locked_at UNIQUE (locked_by, locked_at) DEFERRABLE INITIALLY DEFERRED;
 
 -- Name: schema_migrations; Type: TABLE
 

test/expectations/order_column_definitions.sql

@@ -46,6 +46,11 @@ CREATE TABLE public.schema_migrations (
 ALTER TABLE ONLY public.ar_internal_metadata
     ADD CONSTRAINT ar_internal_metadata_pkey PRIMARY KEY (key);
 
+-- Name: unique_locked_by_locked_at; Type: CONSTRAINT
+
+ALTER TABLE ONLY public.delayed_jobs
+    ADD CONSTRAINT unique_locked_by_locked_at UNIQUE (locked_by, locked_at) DEFERRABLE INITIALLY DEFERRED;
+
 ALTER TABLE ONLY public.schema_migrations
     ADD CONSTRAINT schema_migrations_pkey PRIMARY KEY (version);
 

test/expectations/order_schema_migrations_values.sql

@@ -46,6 +46,11 @@ CREATE TABLE public.schema_migrations (
 ALTER TABLE ONLY public.ar_internal_metadata
     ADD CONSTRAINT ar_internal_metadata_pkey PRIMARY KEY (key);
 
+-- Name: unique_locked_by_locked_at; Type: CONSTRAINT
+
+ALTER TABLE ONLY public.delayed_jobs
+    ADD CONSTRAINT unique_locked_by_locked_at UNIQUE (locked_by, locked_at) DEFERRABLE INITIALLY DEFERRED;
+
 ALTER TABLE ONLY public.schema_migrations
     ADD CONSTRAINT schema_migrations_pkey PRIMARY KEY (version);