activerecord-clean-db-structure 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 412a73ec5fd32ea8373d0fdc86dfd290f4a8524d1e7f3fbf3611fd5c4f75fefa
-  data.tar.gz: b5020420e5d3b258e252306411f09cdb82e2c57dfc41dcd81775b0e866f28470
+  metadata.gz: '08c48e1dbdf0558fcbcb0f93982dafd1ac7d58063fa445cc10dd0473dc6a9d27'
+  data.tar.gz: bcc6aa3df97244977fad69c275f1ee815ceb706fd5674f2832644f4f119e44c0
 SHA512:
-  metadata.gz: e9f21da42eecc194ae9dbbfc5289d2733d115e7ddfe9a7bdea651bc8171cc15514af85e5825386f8bba14d73d3b58136433b92c9fcc94ed8a35d8dfae306cc5e
-  data.tar.gz: 16988f199aff2f875dc0513e18da004d2b6ed4d09fbda5d0de05e914f69ae69ca6c685a408c6393a5467a5e957eac4b13da4f207283650b08fb786f4c4a3a535
+  metadata.gz: 21277622911894dd05ab07bdf320bc59b467e9c29c9aa5d24f22b0e463e24af7d3804d15b4eb66647eea98be94400f45ec519a55776211a14ff9ea95c6fb9ba2
+  data.tar.gz: 515d4fae0ddb8588e8426e8a5a932a6c8c116586f53bcc7c2020f3ae6b45444f57a4a9aebefd3957ba55f2e011ca0c54dc7c0321f8ce3f4467f8f0db9f8dd034

data/.github/workflows/ci.yml

@@ -0,0 +1,16 @@
+name: CI
+on:
+  pull_request:
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["3.1", "3.2"]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake test

data/CHANGELOG.md

@@ -4,6 +4,16 @@
 
 * ...
 
+## 0.4.3    2024-09-22
+
+* Fix additional regexp warnings from "rake test". [#50](https://github.com/lfittl/activerecord-clean-db-structure/pull/50)
+
+## 0.4.2    2024-09-22
+
+* Add an option to not remove extensions [#43](https://github.com/lfittl/activerecord-clean-db-structure/pull/43)
+* Fix incorrect primary structure.sql filename in the case of multi-database setup [#44](https://github.com/lfittl/activerecord-clean-db-structure/pull/44)
+* Fix regexp warnings [#49](https://github.com/lfittl/activerecord-clean-db-structure/pull/49)
+
 ## 0.4.1    2024-08-28
 
 * Fix Rake task name for 6.1+ [#32](https://github.com/lfittl/activerecord-clean-db-structure/pull/32)

data/Gemfile.lock

@@ -1,31 +1,46 @@
 PATH
   remote: .
   specs:
-    activerecord-clean-db-structure (0.4.1)
+    activerecord-clean-db-structure (0.4.3)
       activerecord (>= 4.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.4.3)
-      activesupport (= 7.0.4.3)
-    activerecord (7.0.4.3)
-      activemodel (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
-    activesupport (7.0.4.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+    activemodel (7.2.1)
+      activesupport (= 7.2.1)
+    activerecord (7.2.1)
+      activemodel (= 7.2.1)
+      activesupport (= 7.2.1)
+      timeout (>= 0.4.0)
+    activesupport (7.2.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    concurrent-ruby (1.3.3)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    concurrent-ruby (1.3.4)
+    connection_pool (2.4.1)
+    drb (2.2.1)
     i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    minitest (5.24.1)
-    rake (13.0.6)
+    logger (1.6.1)
+    minitest (5.25.1)
+    rake (13.2.1)
+    securerandom (0.3.1)
+    timeout (0.4.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
 
 PLATFORMS
+  arm64-darwin-22
   ruby
 
 DEPENDENCIES
@@ -33,4 +48,4 @@ DEPENDENCIES
   rake (~> 13)
 
 BUNDLED WITH
-   1.17.3
+   2.5.18

data/README.md

@@ -87,6 +87,17 @@ INSERT INTO "schema_migrations" (version) VALUES
 ;
 ```
 
+By default the gem will remove [some extensions](https://github.com/ghiculescu/activerecord-clean-db-structure/blob/c9551391476a5e7a08ff314501af89baddcf669a/lib/activerecord-clean-db-structure/clean_dump.rb#L24) that typically aren't needed in structure dumps. You can choose to keep all, or just some, of those extensions:
+
+```ruby
+Rails.application.configure do
+  config.activerecord_clean_db_structure.keep_extensions = :all
+
+  # This does the same thing as :all. You can choose which optional extensions to keep.
+  config.activerecord_clean_db_structure.keep_extensions = ["pg_stat_statements", "pg_buffercache"]
+end
+```
+
 ## Authors
 
 * [Lukas Fittl](https://github.com/lfittl)

data/Rakefile

@@ -1,3 +1,12 @@
 require 'rubygems'
 require 'bundler/setup'
 require 'bundler/gem_tasks'
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: %i[test]

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

@@ -21,19 +21,22 @@ module ActiveRecordCleanDbStructure
       dump.gsub!(/^SET xmloption = content;\n/m, '') # 12
       dump.gsub!(/^SET default_table_access_method = heap;\n/m, '') # 12
 
-      # Remove pg_stat_statements extension (its not relevant to the code)
-      dump.gsub!(/^CREATE EXTENSION IF NOT EXISTS pg_stat_statements.*/, '')
-      dump.gsub!(/^-- Name: (EXTENSION )?pg_stat_statements;.*/, '')
-
-      # Remove pg_buffercache extension (its not relevant to the code)
-      dump.gsub!(/^CREATE EXTENSION IF NOT EXISTS pg_buffercache.*/, '')
-      dump.gsub!(/^-- Name: (EXTENSION )?pg_buffercache;.*/, '')
+      extensions_to_remove = ["pg_stat_statements", "pg_buffercache"]
+      if options[:keep_extensions] == :all
+        extensions_to_remove = [] 
+      elsif options[:keep_extensions]
+        extensions_to_remove -= Array(options[:keep_extensions])
+      end
+      extensions_to_remove.each do |ext|
+        dump.gsub!(/^CREATE EXTENSION IF NOT EXISTS #{ext}.*/, '')
+        dump.gsub!(/^-- Name: (EXTENSION )?#{ext};.*/, '')
+      end
 
       # Remove comments on extensions, they create problems if the extension is owned by another user
       dump.gsub!(/^COMMENT ON EXTENSION .*/, '')
 
       # Remove useless, version-specific parts of comments
-      dump.gsub!(/^-- (.*); Schema: ([\w_\.]+|-); Owner: -.*/, '-- \1')
+      dump.gsub!(/^-- (.*); Schema: ([\w\.]+|-); Owner: -.*/, '-- \1')
 
       # Remove useless comment lines
       dump.gsub!(/^--$/, '')
@@ -44,8 +47,8 @@ module ActiveRecordCleanDbStructure
         # This is a bit optimistic, but works as long as you don't have an id field thats not a sequence/uuid
         dump.gsub!(/^    id integer NOT NULL(,)?$/, '    id SERIAL PRIMARY KEY\1')
         dump.gsub!(/^    id bigint NOT NULL(,)?$/, '    id BIGSERIAL PRIMARY KEY\1')
-        dump.gsub!(/^    id uuid DEFAULT ([\w_]+\.)?uuid_generate_v4\(\) NOT NULL(,)?$/, '    id uuid DEFAULT \1uuid_generate_v4() PRIMARY KEY\2')
-        dump.gsub!(/^    id uuid DEFAULT ([\w_]+\.)?gen_random_uuid\(\) NOT NULL(,)?$/, '    id uuid DEFAULT \1gen_random_uuid() PRIMARY KEY\2')
+        dump.gsub!(/^    id uuid DEFAULT ([\w]+\.)?uuid_generate_v4\(\) NOT NULL(,)?$/, '    id uuid DEFAULT \1uuid_generate_v4() PRIMARY KEY\2')
+        dump.gsub!(/^    id uuid DEFAULT ([\w]+\.)?gen_random_uuid\(\) NOT NULL(,)?$/, '    id uuid DEFAULT \1gen_random_uuid() PRIMARY KEY\2')
         dump.gsub!(/^CREATE SEQUENCE [\w\.]+_id_seq\s+(AS integer\s+)?START WITH 1\s+INCREMENT BY 1\s+NO MINVALUE\s+NO MAXVALUE\s+CACHE 1;$/, '')
         dump.gsub!(/^ALTER SEQUENCE [\w\.]+_id_seq OWNED BY .*;$/, '')
         dump.gsub!(/^ALTER TABLE ONLY [\w\.]+ ALTER COLUMN id SET DEFAULT nextval\('[\w\.]+_id_seq'::regclass\);$/, '')
@@ -56,7 +59,7 @@ module ActiveRecordCleanDbStructure
       end
 
       # Remove inherited tables
-      inherited_tables_regexp = /-- Name: ([\w_\.]+); Type: TABLE\n\n[^;]+?INHERITS \([\w_\.]+\);/m
+      inherited_tables_regexp = /-- Name: ([\w\.]+); Type: TABLE\n\n[^;]+?INHERITS \([\w\.]+\);/m
       inherited_tables = dump.scan(inherited_tables_regexp).map(&:first)
       dump.gsub!(inherited_tables_regexp, '')
       inherited_tables.each do |inherited_table|
@@ -73,15 +76,15 @@ module ActiveRecordCleanDbStructure
       partitioned_tables = []
 
       # Postgres 12 pg_dump will output separate ATTACH PARTITION statements (even when run against an 11 or older server)
-      partitioned_tables_regexp1 = /ALTER TABLE ONLY [\w_\.]+ ATTACH PARTITION ([\w_\.]+)/
+      partitioned_tables_regexp1 = /ALTER TABLE ONLY [\w\.]+ ATTACH PARTITION ([\w\.]+)/
       partitioned_tables += dump.scan(partitioned_tables_regexp1).map(&:last)
 
       # Earlier versions use an inline PARTITION OF
-      partitioned_tables_regexp2 = /-- Name: ([\w_\.]+); Type: TABLE\n\n[^;]+?PARTITION OF [\w_\.]+\n[^;]+?;/m
+      partitioned_tables_regexp2 = /-- Name: ([\w\.]+); Type: TABLE\n\n[^;]+?PARTITION OF [\w\.]+\n[^;]+?;/m
       partitioned_tables += dump.scan(partitioned_tables_regexp2).map(&:first)
 
       partitioned_tables.each do |partitioned_table|
-        partitioned_schema_name, partitioned_table_name_only = partitioned_table.split('.', 2)
+        _partitioned_schema_name, partitioned_table_name_only = partitioned_table.split('.', 2)
         dump.gsub!(/-- Name: #{partitioned_table_name_only}; Type: TABLE/, '')
         dump.gsub!(/CREATE TABLE #{partitioned_table} \([^;]+;/m, '')
         dump.gsub!(/ALTER TABLE ONLY ([\w_\.]+) ATTACH PARTITION #{partitioned_table}[^;]+;/m, '')
@@ -101,7 +104,7 @@ module ActiveRecordCleanDbStructure
         dump.gsub!(/-- Name: #{partitioned_table}_pkey; Type: INDEX ATTACH\n\n[^;]+?ATTACH PARTITION ([\w_]+\.)?#{partitioned_table}_pkey;/, '')
       end
       # This is mostly done to allow restoring Postgres 11 output on Postgres 10
-      dump.gsub!(/CREATE INDEX ([\w_]+) ON ONLY/, 'CREATE INDEX \\1 ON')
+      dump.gsub!(/CREATE INDEX ([\w]+) ON ONLY/, 'CREATE INDEX \\1 ON')
 
       if options[:order_schema_migrations_values] == true
         schema_migrations_cleanup
@@ -121,7 +124,7 @@ module ActiveRecordCleanDbStructure
         dump.gsub!(/^CREATE( UNIQUE)? INDEX \w+ ON .+\n+/, '')
         dump.gsub!(/^-- Name: \w+; Type: INDEX\n+/, '')
         indexes.each do |table, indexes_for_table|
-          dump.gsub!(/^(CREATE TABLE #{table}\b(:?[^;\n]*\n)+\);\n)/) { $1 + "\n" + indexes_for_table }
+          dump.gsub!(/^(CREATE TABLE #{table}\b(:?[^;\n]*\n)+\);*\n(?:.*);*)/) { $1 + "\n\n" + indexes_for_table }
         end
       end
 
@@ -148,7 +151,7 @@ module ActiveRecordCleanDbStructure
           inside_table = true
           columns = []
           result << source_line
-        elsif source_line.start_with?(");")
+        elsif source_line.start_with?(")")
           if inside_table
             inside_table = false
             columns.sort_by!(&:first)

data/lib/activerecord-clean-db-structure/tasks/clean_db_structure.rake

@@ -9,7 +9,8 @@ Rake::Task[ActiveRecord.version >= Gem::Version.new('6.1') ? 'db:schema:dump' :
     databases = ActiveRecord::Tasks::DatabaseTasks.setup_initial_database_yaml
     ActiveRecord::Tasks::DatabaseTasks.for_each(databases) do |spec_name|
       Rails.application.config.paths['db'].each do |path|
-        filenames << File.join(path, spec_name + '_structure.sql')
+        filename = spec_name == 'primary' ? 'structure.sql' : spec_name + '_structure.sql'
+        filenames << File.join(path, filename)
       end
     end
   end

data/lib/activerecord-clean-db-structure/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordCleanDbStructure
-  VERSION = '0.4.1'
+  VERSION = '0.4.3'
 end

data/test/clean_dump_test.rb

@@ -0,0 +1,35 @@
+require "test_helper"
+
+class CleanDumpTest < Minitest::Test
+  def test_basic_case
+    assert_cleans_dump "expectations/default_props.sql", {}
+  end
+
+  def test_ignore_ids
+    assert_cleans_dump "expectations/ignore_ids.sql", { ignore_ids: true }
+  end
+
+  def test_order_column_definitions
+    assert_cleans_dump "expectations/order_column_definitions.sql", { order_column_definitions: true }
+  end
+
+  def test_order_schema_migrations_values
+    assert_cleans_dump "expectations/order_schema_migrations_values.sql", { order_schema_migrations_values: true }
+  end
+
+  def test_indexes_after_tables
+    assert_cleans_dump "expectations/indexes_after_tables.sql", { indexes_after_tables: true }
+  end
+
+  def test_keep_extensions_all
+    assert_cleans_dump "expectations/keep_extensions_all.sql", { keep_extensions: :all }
+  end
+
+  private
+
+  def assert_cleans_dump(expected_output_path, props)
+    cleaner = ActiveRecordCleanDbStructure::CleanDump.new(File.read(File.join(__dir__, "data/input.sql")), props)
+    cleaner.run
+    assert_equal File.read(File.join(__dir__, expected_output_path)), cleaner.dump
+  end
+end

data/test/data/input.sql

@@ -0,0 +1,162 @@
+SET statement_timeout = 0;
+SET lock_timeout = 0;
+SET idle_in_transaction_session_timeout = 0;
+SET client_encoding = 'UTF8';
+SET standard_conforming_strings = on;
+SELECT pg_catalog.set_config('search_path', '', false);
+SET check_function_bodies = false;
+SET xmloption = content;
+SET client_min_messages = warning;
+SET row_security = off;
+
+--
+-- Name: pg_stat_statements; Type: EXTENSION; Schema: -; Owner: -
+--
+
+CREATE EXTENSION IF NOT EXISTS pg_stat_statements WITH SCHEMA public;
+
+
+--
+-- Name: EXTENSION pg_stat_statements; Type: COMMENT; Schema: -; Owner: -
+--
+
+COMMENT ON EXTENSION pg_stat_statements IS 'track execution statistics of all SQL statements executed';
+
+
+SET default_tablespace = '';
+
+SET default_table_access_method = heap;
+
+--
+-- Name: ar_internal_metadata; Type: TABLE; Schema: public; Owner: -
+--
+
+CREATE TABLE public.ar_internal_metadata (
+    key character varying NOT NULL,
+    value character varying,
+    created_at timestamp(6) without time zone NOT NULL,
+    updated_at timestamp(6) without time zone NOT NULL
+);
+
+
+--
+-- Name: delayed_jobs; Type: TABLE; Schema: public; Owner: -
+--
+
+CREATE TABLE public.delayed_jobs (
+    id bigint NOT NULL,
+    priority integer DEFAULT 0,
+    attempts integer DEFAULT 0,
+    handler text,
+    last_error text,
+    run_at timestamp without time zone,
+    locked_at timestamp without time zone,
+    failed_at timestamp without time zone,
+    locked_by character varying(255),
+    queue character varying(255),
+    created_at timestamp without time zone NOT NULL,
+    updated_at timestamp without time zone NOT NULL,
+    metadata jsonb DEFAULT '{}'::jsonb,
+    whodunnit text
+)
+WITH (fillfactor='85');
+
+
+--
+-- Name: delayed_jobs_id_seq; Type: SEQUENCE; Schema: public; Owner: -
+--
+
+CREATE SEQUENCE public.delayed_jobs_id_seq
+    START WITH 1
+    INCREMENT BY 1
+    NO MINVALUE
+    NO MAXVALUE
+    CACHE 1;
+
+
+--
+-- Name: delayed_jobs_id_seq; Type: SEQUENCE OWNED BY; Schema: public; Owner: -
+--
+
+ALTER SEQUENCE public.delayed_jobs_id_seq OWNED BY public.delayed_jobs.id;
+
+
+--
+-- Name: schema_migrations; Type: TABLE; Schema: public; Owner: -
+--
+
+CREATE TABLE public.schema_migrations (
+    version character varying NOT NULL
+);
+
+
+--
+-- Name: delayed_jobs id; Type: DEFAULT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY public.delayed_jobs ALTER COLUMN id SET DEFAULT nextval('public.delayed_jobs_id_seq'::regclass);
+
+
+--
+-- Name: ar_internal_metadata ar_internal_metadata_pkey; Type: CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY public.ar_internal_metadata
+    ADD CONSTRAINT ar_internal_metadata_pkey PRIMARY KEY (key);
+
+
+--
+-- Name: delayed_jobs delayed_jobs_pkey; Type: CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY public.delayed_jobs
+    ADD CONSTRAINT delayed_jobs_pkey PRIMARY KEY (id);
+
+
+--
+-- Name: schema_migrations schema_migrations_pkey; Type: CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY public.schema_migrations
+    ADD CONSTRAINT schema_migrations_pkey PRIMARY KEY (version);
+
+
+--
+-- Name: index_delayed_jobs_on_locked_by; Type: INDEX; Schema: public; Owner: -
+--
+
+CREATE INDEX index_delayed_jobs_on_locked_by ON public.delayed_jobs USING btree (locked_by);
+
+
+--
+-- Name: index_delayed_jobs_on_queue; Type: INDEX; Schema: public; Owner: -
+--
+
+CREATE INDEX index_delayed_jobs_on_queue ON public.delayed_jobs USING btree (queue);
+
+
+--
+-- Name: index_delayed_jobs_on_run_at; Type: INDEX; Schema: public; Owner: -
+--
+
+CREATE INDEX index_delayed_jobs_on_run_at ON public.delayed_jobs USING btree (run_at) WHERE (locked_at IS NULL);
+
+
+--
+-- PostgreSQL database dump complete
+--
+
+SET search_path TO "$user", public;
+
+INSERT INTO "schema_migrations" (version) VALUES
+('20240822225012'),
+('20240822224954'),
+('20240725043656'),
+('20240621041110'),
+('20240621020038'),
+('20220802204003'),
+('20211125055031'),
+('20211012054749'),
+('20210923052631'),
+('20210903003251');
+

data/test/expectations/default_props.sql

@@ -0,0 +1,78 @@
+SET statement_timeout = 0;
+SET lock_timeout = 0;
+SET client_encoding = 'UTF8';
+SET standard_conforming_strings = on;
+SELECT pg_catalog.set_config('search_path', '', false);
+SET check_function_bodies = false;
+SET client_min_messages = warning;
+
+SET default_tablespace = '';
+
+-- Name: ar_internal_metadata; Type: TABLE
+
+CREATE TABLE public.ar_internal_metadata (
+    key character varying NOT NULL,
+    value character varying,
+    created_at timestamp(6) without time zone NOT NULL,
+    updated_at timestamp(6) without time zone NOT NULL
+);
+
+-- Name: delayed_jobs; Type: TABLE
+
+CREATE TABLE public.delayed_jobs (
+    id BIGSERIAL PRIMARY KEY,
+    priority integer DEFAULT 0,
+    attempts integer DEFAULT 0,
+    handler text,
+    last_error text,
+    run_at timestamp without time zone,
+    locked_at timestamp without time zone,
+    failed_at timestamp without time zone,
+    locked_by character varying(255),
+    queue character varying(255),
+    created_at timestamp without time zone NOT NULL,
+    updated_at timestamp without time zone NOT NULL,
+    metadata jsonb DEFAULT '{}'::jsonb,
+    whodunnit text
+)
+WITH (fillfactor='85');
+
+-- Name: schema_migrations; Type: TABLE
+
+CREATE TABLE public.schema_migrations (
+    version character varying NOT NULL
+);
+
+ALTER TABLE ONLY public.ar_internal_metadata
+    ADD CONSTRAINT ar_internal_metadata_pkey PRIMARY KEY (key);
+
+ALTER TABLE ONLY public.schema_migrations
+    ADD CONSTRAINT schema_migrations_pkey PRIMARY KEY (version);
+
+-- Name: index_delayed_jobs_on_locked_by; Type: INDEX
+
+CREATE INDEX index_delayed_jobs_on_locked_by ON public.delayed_jobs USING btree (locked_by);
+
+-- Name: index_delayed_jobs_on_queue; Type: INDEX
+
+CREATE INDEX index_delayed_jobs_on_queue ON public.delayed_jobs USING btree (queue);
+
+-- Name: index_delayed_jobs_on_run_at; Type: INDEX
+
+CREATE INDEX index_delayed_jobs_on_run_at ON public.delayed_jobs USING btree (run_at) WHERE (locked_at IS NULL);
+
+-- PostgreSQL database dump complete
+
+SET search_path TO "$user", public;
+
+INSERT INTO "schema_migrations" (version) VALUES
+('20240822225012'),
+('20240822224954'),
+('20240725043656'),
+('20240621041110'),
+('20240621020038'),
+('20220802204003'),
+('20211125055031'),
+('20211012054749'),
+('20210923052631'),
+('20210903003251');

data/test/expectations/ignore_ids.sql

@@ -0,0 +1,104 @@
+SET statement_timeout = 0;
+SET lock_timeout = 0;
+SET client_encoding = 'UTF8';
+SET standard_conforming_strings = on;
+SELECT pg_catalog.set_config('search_path', '', false);
+SET check_function_bodies = false;
+SET client_min_messages = warning;
+
+SET default_tablespace = '';
+
+-- Name: ar_internal_metadata; Type: TABLE
+
+CREATE TABLE public.ar_internal_metadata (
+    key character varying NOT NULL,
+    value character varying,
+    created_at timestamp(6) without time zone NOT NULL,
+    updated_at timestamp(6) without time zone NOT NULL
+);
+
+-- Name: delayed_jobs; Type: TABLE
+
+CREATE TABLE public.delayed_jobs (
+    id bigint NOT NULL,
+    priority integer DEFAULT 0,
+    attempts integer DEFAULT 0,
+    handler text,
+    last_error text,
+    run_at timestamp without time zone,
+    locked_at timestamp without time zone,
+    failed_at timestamp without time zone,
+    locked_by character varying(255),
+    queue character varying(255),
+    created_at timestamp without time zone NOT NULL,
+    updated_at timestamp without time zone NOT NULL,
+    metadata jsonb DEFAULT '{}'::jsonb,
+    whodunnit text
+)
+WITH (fillfactor='85');
+
+-- Name: delayed_jobs_id_seq; Type: SEQUENCE
+
+CREATE SEQUENCE public.delayed_jobs_id_seq
+    START WITH 1
+    INCREMENT BY 1
+    NO MINVALUE
+    NO MAXVALUE
+    CACHE 1;
+
+-- Name: delayed_jobs_id_seq; Type: SEQUENCE OWNED BY
+
+ALTER SEQUENCE public.delayed_jobs_id_seq OWNED BY public.delayed_jobs.id;
+
+-- Name: schema_migrations; Type: TABLE
+
+CREATE TABLE public.schema_migrations (
+    version character varying NOT NULL
+);
+
+-- Name: delayed_jobs id; Type: DEFAULT
+
+ALTER TABLE ONLY public.delayed_jobs ALTER COLUMN id SET DEFAULT nextval('public.delayed_jobs_id_seq'::regclass);
+
+-- Name: ar_internal_metadata ar_internal_metadata_pkey; Type: CONSTRAINT
+
+ALTER TABLE ONLY public.ar_internal_metadata
+    ADD CONSTRAINT ar_internal_metadata_pkey PRIMARY KEY (key);
+
+-- Name: delayed_jobs delayed_jobs_pkey; Type: CONSTRAINT
+
+ALTER TABLE ONLY public.delayed_jobs
+    ADD CONSTRAINT delayed_jobs_pkey PRIMARY KEY (id);
+
+-- Name: schema_migrations schema_migrations_pkey; Type: CONSTRAINT
+
+ALTER TABLE ONLY public.schema_migrations
+    ADD CONSTRAINT schema_migrations_pkey PRIMARY KEY (version);
+
+-- Name: index_delayed_jobs_on_locked_by; Type: INDEX
+
+CREATE INDEX index_delayed_jobs_on_locked_by ON public.delayed_jobs USING btree (locked_by);
+
+-- Name: index_delayed_jobs_on_queue; Type: INDEX
+
+CREATE INDEX index_delayed_jobs_on_queue ON public.delayed_jobs USING btree (queue);
+
+-- Name: index_delayed_jobs_on_run_at; Type: INDEX
+
+CREATE INDEX index_delayed_jobs_on_run_at ON public.delayed_jobs USING btree (run_at) WHERE (locked_at IS NULL);
+
+-- PostgreSQL database dump complete
+
+SET search_path TO "$user", public;
+
+INSERT INTO "schema_migrations" (version) VALUES
+('20240822225012'),
+('20240822224954'),
+('20240725043656'),
+('20240621041110'),
+('20240621020038'),
+('20220802204003'),
+('20211125055031'),
+('20211012054749'),
+('20210923052631'),
+('20210903003251');

data/test/expectations/indexes_after_tables.sql

@@ -0,0 +1,70 @@
+SET statement_timeout = 0;
+SET lock_timeout = 0;
+SET client_encoding = 'UTF8';
+SET standard_conforming_strings = on;
+SELECT pg_catalog.set_config('search_path', '', false);
+SET check_function_bodies = false;
+SET client_min_messages = warning;
+
+SET default_tablespace = '';
+
+-- Name: ar_internal_metadata; Type: TABLE
+
+CREATE TABLE public.ar_internal_metadata (
+    key character varying NOT NULL,
+    value character varying,
+    created_at timestamp(6) without time zone NOT NULL,
+    updated_at timestamp(6) without time zone NOT NULL
+);
+
+-- Name: delayed_jobs; Type: TABLE
+
+CREATE TABLE public.delayed_jobs (
+    id BIGSERIAL PRIMARY KEY,
+    priority integer DEFAULT 0,
+    attempts integer DEFAULT 0,
+    handler text,
+    last_error text,
+    run_at timestamp without time zone,
+    locked_at timestamp without time zone,
+    failed_at timestamp without time zone,
+    locked_by character varying(255),
+    queue character varying(255),
+    created_at timestamp without time zone NOT NULL,
+    updated_at timestamp without time zone NOT NULL,
+    metadata jsonb DEFAULT '{}'::jsonb,
+    whodunnit text
+)
+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);
+
+-- Name: schema_migrations; Type: TABLE
+
+CREATE TABLE public.schema_migrations (
+    version character varying NOT NULL
+);
+
+ALTER TABLE ONLY public.ar_internal_metadata
+    ADD CONSTRAINT ar_internal_metadata_pkey PRIMARY KEY (key);
+
+ALTER TABLE ONLY public.schema_migrations
+    ADD CONSTRAINT schema_migrations_pkey PRIMARY KEY (version);
+
+-- PostgreSQL database dump complete
+
+SET search_path TO "$user", public;
+
+INSERT INTO "schema_migrations" (version) VALUES
+('20240822225012'),
+('20240822224954'),
+('20240725043656'),
+('20240621041110'),
+('20240621020038'),
+('20220802204003'),
+('20211125055031'),
+('20211012054749'),
+('20210923052631'),
+('20210903003251');

data/test/expectations/keep_extensions_all.sql

@@ -0,0 +1,84 @@
+SET statement_timeout = 0;
+SET lock_timeout = 0;
+SET client_encoding = 'UTF8';
+SET standard_conforming_strings = on;
+SELECT pg_catalog.set_config('search_path', '', false);
+SET check_function_bodies = false;
+SET client_min_messages = warning;
+
+-- Name: pg_stat_statements; Type: EXTENSION
+
+CREATE EXTENSION IF NOT EXISTS pg_stat_statements WITH SCHEMA public;
+
+-- Name: EXTENSION pg_stat_statements; Type: COMMENT
+
+SET default_tablespace = '';
+
+-- Name: ar_internal_metadata; Type: TABLE
+
+CREATE TABLE public.ar_internal_metadata (
+    key character varying NOT NULL,
+    value character varying,
+    created_at timestamp(6) without time zone NOT NULL,
+    updated_at timestamp(6) without time zone NOT NULL
+);
+
+-- Name: delayed_jobs; Type: TABLE
+
+CREATE TABLE public.delayed_jobs (
+    id BIGSERIAL PRIMARY KEY,
+    priority integer DEFAULT 0,
+    attempts integer DEFAULT 0,
+    handler text,
+    last_error text,
+    run_at timestamp without time zone,
+    locked_at timestamp without time zone,
+    failed_at timestamp without time zone,
+    locked_by character varying(255),
+    queue character varying(255),
+    created_at timestamp without time zone NOT NULL,
+    updated_at timestamp without time zone NOT NULL,
+    metadata jsonb DEFAULT '{}'::jsonb,
+    whodunnit text
+)
+WITH (fillfactor='85');
+
+-- Name: schema_migrations; Type: TABLE
+
+CREATE TABLE public.schema_migrations (
+    version character varying NOT NULL
+);
+
+ALTER TABLE ONLY public.ar_internal_metadata
+    ADD CONSTRAINT ar_internal_metadata_pkey PRIMARY KEY (key);
+
+ALTER TABLE ONLY public.schema_migrations
+    ADD CONSTRAINT schema_migrations_pkey PRIMARY KEY (version);
+
+-- Name: index_delayed_jobs_on_locked_by; Type: INDEX
+
+CREATE INDEX index_delayed_jobs_on_locked_by ON public.delayed_jobs USING btree (locked_by);
+
+-- Name: index_delayed_jobs_on_queue; Type: INDEX
+
+CREATE INDEX index_delayed_jobs_on_queue ON public.delayed_jobs USING btree (queue);
+
+-- Name: index_delayed_jobs_on_run_at; Type: INDEX
+
+CREATE INDEX index_delayed_jobs_on_run_at ON public.delayed_jobs USING btree (run_at) WHERE (locked_at IS NULL);
+
+-- PostgreSQL database dump complete
+
+SET search_path TO "$user", public;
+
+INSERT INTO "schema_migrations" (version) VALUES
+('20240822225012'),
+('20240822224954'),
+('20240725043656'),
+('20240621041110'),
+('20240621020038'),
+('20220802204003'),
+('20211125055031'),
+('20211012054749'),
+('20210923052631'),
+('20210903003251');

data/test/expectations/order_column_definitions.sql

@@ -0,0 +1,78 @@
+SET statement_timeout = 0;
+SET lock_timeout = 0;
+SET client_encoding = 'UTF8';
+SET standard_conforming_strings = on;
+SELECT pg_catalog.set_config('search_path', '', false);
+SET check_function_bodies = false;
+SET client_min_messages = warning;
+
+SET default_tablespace = '';
+
+-- Name: ar_internal_metadata; Type: TABLE
+
+CREATE TABLE public.ar_internal_metadata (
+    created_at timestamp(6) without time zone NOT NULL,
+    key character varying NOT NULL,
+    updated_at timestamp(6) without time zone NOT NULL,
+    value character varying
+);
+
+-- Name: delayed_jobs; Type: TABLE
+
+CREATE TABLE public.delayed_jobs (
+    attempts integer DEFAULT 0,
+    created_at timestamp without time zone NOT NULL,
+    failed_at timestamp without time zone,
+    handler text,
+    id BIGSERIAL PRIMARY KEY,
+    last_error text,
+    locked_at timestamp without time zone,
+    locked_by character varying(255),
+    metadata jsonb DEFAULT '{}'::jsonb,
+    priority integer DEFAULT 0,
+    queue character varying(255),
+    run_at timestamp without time zone,
+    updated_at timestamp without time zone NOT NULL,
+    whodunnit text
+)
+WITH (fillfactor='85');
+
+-- Name: schema_migrations; Type: TABLE
+
+CREATE TABLE public.schema_migrations (
+    version character varying NOT NULL
+);
+
+ALTER TABLE ONLY public.ar_internal_metadata
+    ADD CONSTRAINT ar_internal_metadata_pkey PRIMARY KEY (key);
+
+ALTER TABLE ONLY public.schema_migrations
+    ADD CONSTRAINT schema_migrations_pkey PRIMARY KEY (version);
+
+-- Name: index_delayed_jobs_on_locked_by; Type: INDEX
+
+CREATE INDEX index_delayed_jobs_on_locked_by ON public.delayed_jobs USING btree (locked_by);
+
+-- Name: index_delayed_jobs_on_queue; Type: INDEX
+
+CREATE INDEX index_delayed_jobs_on_queue ON public.delayed_jobs USING btree (queue);
+
+-- Name: index_delayed_jobs_on_run_at; Type: INDEX
+
+CREATE INDEX index_delayed_jobs_on_run_at ON public.delayed_jobs USING btree (run_at) WHERE (locked_at IS NULL);
+
+-- PostgreSQL database dump complete
+
+SET search_path TO "$user", public;
+
+INSERT INTO "schema_migrations" (version) VALUES
+('20240822225012'),
+('20240822224954'),
+('20240725043656'),
+('20240621041110'),
+('20240621020038'),
+('20220802204003'),
+('20211125055031'),
+('20211012054749'),
+('20210923052631'),
+('20210903003251');

data/test/expectations/order_schema_migrations_values.sql

@@ -0,0 +1,80 @@
+SET statement_timeout = 0;
+SET lock_timeout = 0;
+SET client_encoding = 'UTF8';
+SET standard_conforming_strings = on;
+SELECT pg_catalog.set_config('search_path', '', false);
+SET check_function_bodies = false;
+SET client_min_messages = warning;
+
+SET default_tablespace = '';
+
+-- Name: ar_internal_metadata; Type: TABLE
+
+CREATE TABLE public.ar_internal_metadata (
+    key character varying NOT NULL,
+    value character varying,
+    created_at timestamp(6) without time zone NOT NULL,
+    updated_at timestamp(6) without time zone NOT NULL
+);
+
+-- Name: delayed_jobs; Type: TABLE
+
+CREATE TABLE public.delayed_jobs (
+    id BIGSERIAL PRIMARY KEY,
+    priority integer DEFAULT 0,
+    attempts integer DEFAULT 0,
+    handler text,
+    last_error text,
+    run_at timestamp without time zone,
+    locked_at timestamp without time zone,
+    failed_at timestamp without time zone,
+    locked_by character varying(255),
+    queue character varying(255),
+    created_at timestamp without time zone NOT NULL,
+    updated_at timestamp without time zone NOT NULL,
+    metadata jsonb DEFAULT '{}'::jsonb,
+    whodunnit text
+)
+WITH (fillfactor='85');
+
+-- Name: schema_migrations; Type: TABLE
+
+CREATE TABLE public.schema_migrations (
+    version character varying NOT NULL
+);
+
+ALTER TABLE ONLY public.ar_internal_metadata
+    ADD CONSTRAINT ar_internal_metadata_pkey PRIMARY KEY (key);
+
+ALTER TABLE ONLY public.schema_migrations
+    ADD CONSTRAINT schema_migrations_pkey PRIMARY KEY (version);
+
+-- Name: index_delayed_jobs_on_locked_by; Type: INDEX
+
+CREATE INDEX index_delayed_jobs_on_locked_by ON public.delayed_jobs USING btree (locked_by);
+
+-- Name: index_delayed_jobs_on_queue; Type: INDEX
+
+CREATE INDEX index_delayed_jobs_on_queue ON public.delayed_jobs USING btree (queue);
+
+-- Name: index_delayed_jobs_on_run_at; Type: INDEX
+
+CREATE INDEX index_delayed_jobs_on_run_at ON public.delayed_jobs USING btree (run_at) WHERE (locked_at IS NULL);
+
+-- PostgreSQL database dump complete
+
+SET search_path TO "$user", public;
+
+INSERT INTO "schema_migrations" (version) VALUES
+ ('20210903003251')
+,('20210923052631')
+,('20211012054749')
+,('20211125055031')
+,('20220802204003')
+,('20240621020038')
+,('20240621041110')
+,('20240725043656')
+,('20240822224954')
+,('20240822225012')
+;
+

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "activerecord-clean-db-structure"
+require 'activerecord-clean-db-structure/clean_dump'
+
+require "minitest/autorun"
+Dir[File.expand_path("support/**/*.rb", __dir__)].sort.each { |rb| require(rb) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-clean-db-structure
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Lukas Fittl
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-29 00:00:00.000000000 Z
+date: 2024-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -44,6 +44,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - CHANGELOG.md
 - Gemfile
@@ -57,11 +58,20 @@ files:
 - lib/activerecord-clean-db-structure/railtie.rb
 - lib/activerecord-clean-db-structure/tasks/clean_db_structure.rake
 - lib/activerecord-clean-db-structure/version.rb
+- test/clean_dump_test.rb
+- test/data/input.sql
+- test/expectations/default_props.sql
+- test/expectations/ignore_ids.sql
+- test/expectations/indexes_after_tables.sql
+- test/expectations/keep_extensions_all.sql
+- test/expectations/order_column_definitions.sql
+- test/expectations/order_schema_migrations_values.sql
+- test/test_helper.rb
 homepage: https://github.com/lfittl/activerecord-clean-db-structure
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -76,8 +86,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Automatic cleanup for the Rails db/structure.sql file (ActiveRecord/PostgreSQL)
 test_files: []