activerecord-clean-db-structure 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: d36c390340cb86023df909cb5566610d47881767c746a118307f64c697e1153d
-  data.tar.gz: bc70ca9657712e25e5b925cc4184142831a83ffd36e103df6043c3713168005e
+SHA1:
+  metadata.gz: 6ee2c62ab134b71d0ccce4e02928038c983c4403
+  data.tar.gz: 6264e28734c7ca2066fefbd2a6ef3dc68e68c1c1
 SHA512:
-  metadata.gz: ffa80995355e8d0e5404ea8f51eb82646e3b41a6c9ab95bd29db194a5fbbcdedce3e71c9f1da67f9ab8f6ca8b32ee336dc701e9f6a732e63b3c86e2a885ec8a7
-  data.tar.gz: b810eecc4cae33f4a1c0785188282264e0ad43a6975b28bf0bde9a3d1594e624f78f327ec343b9e679debe726d72856b323aef4a3004fb448e5683889d4f512b
+  metadata.gz: bf88f74415c68337f2b9f409a358085d4d71c64be4696a942b973a2d34c420024f9bde791f3edb120c1df26357d8c3d0f5d47ed94892437b63ef72b388ae5175
+  data.tar.gz: 1b086ae9152601942d7999ab0491c2d5d4e812e34208688f5bd8d8437530d74c868b0ca6a5639b237b2cb9cdd80c3caa1cd7871c601100b586ee748a86fe5def

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.3.0    2019-05-07
+
+* Add "ignore_ids" option to allow disabling of primary key substitution logic [#12](https://github.com/lfittl/activerecord-clean-db-structure/pull/12) [Vladimir Dementyev](https://github.com/palkan)
+* Compatibility with Rails 6 multi-database configuration
+
+
 ## 0.2.6    2018-03-11
 
 * Fix regular expressions to support schema qualification changes in 10.3

data/Gemfile.lock

@@ -1,26 +1,26 @@
 PATH
   remote: .
   specs:
-    activerecord-clean-db-structure (0.2.6)
+    activerecord-clean-db-structure (0.3.0)
       activerecord (>= 4.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.1.5)
-      activesupport (= 5.1.5)
-    activerecord (5.1.5)
-      activemodel (= 5.1.5)
-      activesupport (= 5.1.5)
-      arel (~> 8.0)
-    activesupport (5.1.5)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activesupport (5.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (8.0.0)
-    concurrent-ruby (1.0.5)
-    i18n (0.9.5)
+    arel (9.0.0)
+    concurrent-ruby (1.1.5)
+    i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     minitest (5.11.3)
     rake (0.9.6)

data/README.md

@@ -30,7 +30,13 @@ Currently the library assumes all your `id` columns are either SERIAL, BIGSERIAL
 
 Multi-column primary keys, as well as tables that don't have `id` as the primary key are not supported right now, and might lead to wrong output.
 
-Patches and test cases welcome!
+You can disable this part of the _cleaning_ process in your `config/environments/<environment>.rb` (or `config/application.rb`):
+
+```ruby
+Rails.application.configure do
+  config.activerecord_clean_db_structure.ignore_ids = true
+end
+```
 
 ## Authors
 

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

@@ -1,8 +1,10 @@
 module ActiveRecordCleanDbStructure
   class CleanDump
-    attr_reader :dump
-    def initialize(dump)
+    attr_reader :dump, :options
+
+    def initialize(dump, options = {})
       @dump = dump
+      @options = options
     end
 
     def run
@@ -33,20 +35,22 @@ module ActiveRecordCleanDbStructure
       # Remove useless comment lines
       dump.gsub!(/^--$/, '')
 
-      # Reduce noise for id fields by making them SERIAL instead of integer+sequence stuff
-      #
-      # 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 (public\.)?uuid_generate_v4\(\) NOT NULL(,)?$/, '    id uuid DEFAULT \1uuid_generate_v4() PRIMARY KEY\2')
-      dump.gsub!(/^    id uuid DEFAULT (public\.)?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\);$/, '')
-      dump.gsub!(/^ALTER TABLE ONLY [\w\.]+\s+ADD CONSTRAINT [\w\.]+_pkey PRIMARY KEY \(id\);$/, '')
-      dump.gsub!(/^-- Name: (\w+\s+)?id; Type: DEFAULT$/, '')
-      dump.gsub!(/^-- .*_id_seq; Type: SEQUENCE.*/, '')
-      dump.gsub!(/^-- Name: (\w+\s+)?\w+_pkey; Type: CONSTRAINT$/, '')
+      unless options[:ignore_ids] == true
+        # Reduce noise for id fields by making them SERIAL instead of integer+sequence stuff
+        #
+        # 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 (public\.)?uuid_generate_v4\(\) NOT NULL(,)?$/, '    id uuid DEFAULT \1uuid_generate_v4() PRIMARY KEY\2')
+        dump.gsub!(/^    id uuid DEFAULT (public\.)?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\);$/, '')
+        dump.gsub!(/^ALTER TABLE ONLY [\w\.]+\s+ADD CONSTRAINT [\w\.]+_pkey PRIMARY KEY \(id\);$/, '')
+        dump.gsub!(/^-- Name: (\w+\s+)?id; Type: DEFAULT$/, '')
+        dump.gsub!(/^-- .*_id_seq; Type: SEQUENCE.*/, '')
+        dump.gsub!(/^-- Name: (\w+\s+)?\w+_pkey; Type: CONSTRAINT$/, '')
+      end
 
       # Remove inherited tables
       inherited_tables_regexp = /-- Name: ([\w_\.]+); Type: TABLE\n\n[^;]+?INHERITS \([\w_\.]+\);/m
@@ -62,6 +66,27 @@ module ActiveRecordCleanDbStructure
         dump.gsub!(index_regexp, '')
       end
 
+      # Remove partitioned tables
+      partitioned_tables_regexp = /-- Name: ([\w_\.]+); Type: TABLE\n\n[^;]+?PARTITION OF [\w_\.]+\n[^;]+?;/m
+      partitioned_tables = dump.scan(partitioned_tables_regexp).map(&:first)
+      dump.gsub!(partitioned_tables_regexp, '')
+      partitioned_tables.each do |partitioned_table|
+        dump.gsub!(/ALTER TABLE ONLY (public\.)?#{partitioned_table}[^;]+;/, '')
+        dump.gsub!(/-- Name: #{partitioned_table} [^;]+; Type: DEFAULT/, '')
+
+        index_regexp = /CREATE INDEX ([\w_]+) ON (public\.)?#{partitioned_table}[^;]+;/m
+        dump.scan(index_regexp).map(&:first).each do |partitioned_table_index|
+          dump.gsub!("-- Name: #{partitioned_table_index}; Type: INDEX ATTACH", '')
+          dump.gsub!("-- Name: #{partitioned_table_index}; Type: INDEX", '')
+          dump.gsub!(/ALTER INDEX ([\w_\.]+) ATTACH PARTITION (public\.)?#{partitioned_table_index};/, '')
+        end
+        dump.gsub!(index_regexp, '')
+
+        dump.gsub!(/-- Name: #{partitioned_table}_pkey; Type: INDEX ATTACH\n\n[^;]+?ATTACH PARTITION (public\.)?#{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')
+
       # Remove whitespace between schema migration INSERTS to make editing easier
       dump.gsub!(/^(INSERT INTO schema_migrations .*)\n\n/, "\\1\n")
 

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

@@ -1,5 +1,7 @@
 module ActiveRecordCleanDbStructure
   class Railtie < Rails::Railtie
+    config.activerecord_clean_db_structure = ActiveSupport::OrderedOptions.new
+
     rake_tasks do
       load 'activerecord-clean-db-structure/tasks/clean_db_structure.rake'
     end

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

@@ -2,12 +2,24 @@ require 'activerecord-clean-db-structure/clean_dump'
 
 Rake::Task['db:structure:dump'].enhance do
   filenames = ENV['DB_STRUCTURE']
+
+  if ActiveRecord::VERSION::MAJOR >= 6
+    ActiveRecord::Tasks::DatabaseTasks.for_each do |spec_name|
+      filenames ||= Rails.application.config.paths['db'].map do |path|
+        File.join(path, spec_name + '_structure.sql')
+      end
+    end
+  end
+
   filenames ||= Rails.application.config.paths['db'].map do |path|
     File.join(path, 'structure.sql')
   end
 
   filenames.each do |filename|
-    cleaner = ActiveRecordCleanDbStructure::CleanDump.new(File.read(filename))
+    cleaner = ActiveRecordCleanDbStructure::CleanDump.new(
+      File.read(filename),
+      **Rails.application.config.activerecord_clean_db_structure
+    )
     cleaner.run
     File.write(filename, cleaner.dump)
   end

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

@@ -1,3 +1,3 @@
 module ActiveRecordCleanDbStructure
-  VERSION = '0.2.6'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-clean-db-structure
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Lukas Fittl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-12 00:00:00.000000000 Z
+date: 2019-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -77,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Automatic cleanup for the Rails db/structure.sql file (ActiveRecord/PostgreSQL)