fast_schema_dumper 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d00d757f9b258b9b438f8166e9eb8f20fffbdf85ff3c2ca0f139d3869569f46
-  data.tar.gz: e84597beb407fc62ac5a2befcc958de139e749ad450721dab80f85df1b98ed6c
+  metadata.gz: c7ef2b48990a434194a1ac9ddd7394fbef2a5ad40befb705209ccf01edb19c4a
+  data.tar.gz: 6360a00616008fea6f45913597ce0fc9ebbca688243bb1a204fb0abb33922ea7
 SHA512:
-  metadata.gz: 3caede5f1ffbababb0bcdb98c6c12ca7fe2abaaed60abb9b9cc2faffb125e23303a16b733cd3e5c0049d434397ed13eedda4bd7e0b5266cd349514ff0832267a
-  data.tar.gz: 1fb86fe0fed6f402817d9716c7e2180da3618a31a5388888bf9b9762be10671c37046e0908cee3a3c4488d53a9787bced38aa24459948495aea7a1589c27d403
+  metadata.gz: 6a701f24b8eacb312ad56c60c96edd12aa795fa27ecf8e59e511455e55ff36efca84e6ecb9598d7ec197c0f3120a33fd487f3b1d59d34098cf469637c37aec85
+  data.tar.gz: 06cd91e908371c31c24bf90ba9d21c8f359d8a0007ceb2698a7e5712280bf191d010edf90360c72b2975b72d8df7a001bf1776591d4c23b1d9a0252301bd307c

data/README.md

@@ -1,8 +1,29 @@
-# FastSchemaDumper
+# fast_schema_dumper
 
-TODO: Delete this and the text below, and describe your gem
+A super fast alternative to ActiveRecord::SchemaDumper. Currently only MySQL is supported.
+
+## Usage
+
+### Ridgepole integration
+
+Requiring `fast_schema_dumper/ridgepole` will overwrite `Ridgepole::Dumper.dump`, which will force Ridgepole to use fast_schema_dumper.
+
+```
+RUBYOPT='-rridgepole -rfast_schema_dumper' ridgepole ... --apply
+```
+
+#### Environment variables for Ridgepole
+
+The Ridgepole integration is configurable via envionment variables.
+
+- `FAST_SCHEMA_DUMPER_MODE`:
+  - `disabled`: Use the original ActiveRecord dumper
+  - `verify`: Run both dumpers and verify output matches (useful for testing)
+  - Any other value or unset: Use FastSchemaDumper (default)
+- `FAST_SCHEMA_DUMPER_SUPPRESS_MESSAGE=1`: Suppress the warning message when FastSchemaDumper is enabled
+
+I recommend using only fast_schema_dumper in local development environments, and configuring `FAST_SCHEMA_DUMPER_MODE=verify` in CI setups.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fast_schema_dumper`. To experiment with that code, run `bin/console` for an interactive prompt.
 
 ## Installation
 
@@ -18,10 +39,6 @@ If bundler is not being used to manage dependencies, install the gem by executin
 gem install fast_schema_dumper
 ```
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/fast_schema_dumper/fast_dumper.rb

@@ -121,6 +121,39 @@ module FastSchemaDumper
       ORDER BY kcu.TABLE_NAME, kcu.CONSTRAINT_NAME
     ")
 
+      # Get CHECK constraints (MySQL 8.0.16+)
+      result = conn.exec_query("
+      SELECT COUNT(*) as count
+      FROM INFORMATION_SCHEMA.TABLES
+      WHERE TABLE_SCHEMA = 'information_schema'
+        AND TABLE_NAME = 'CHECK_CONSTRAINTS'
+    ")
+      check_constraints_data = if result.first['count'] > 0
+        conn.exec_query("
+        SELECT
+          tc.CONSTRAINT_NAME,
+          tc.TABLE_NAME,
+          cc.CHECK_CLAUSE
+        FROM INFORMATION_SCHEMA.TABLE_CONSTRAINTS tc
+        JOIN INFORMATION_SCHEMA.CHECK_CONSTRAINTS cc
+          ON tc.CONSTRAINT_SCHEMA = cc.CONSTRAINT_SCHEMA
+          AND tc.CONSTRAINT_NAME = cc.CONSTRAINT_NAME
+        WHERE tc.TABLE_SCHEMA = DATABASE()
+          AND tc.CONSTRAINT_TYPE = 'CHECK'
+        ORDER BY tc.TABLE_NAME, tc.CONSTRAINT_NAME
+      ")
+      else
+        []
+      end
+
+      check_constraints_by_table = check_constraints_data.each_with_object({}) do |ck, hash|
+        hash[ck['TABLE_NAME']] ||= []
+        hash[ck['TABLE_NAME']] << {
+          constraint_name: ck['CONSTRAINT_NAME'],
+          check_clause: ck['CHECK_CLAUSE']
+        }
+      end
+
       # Organize columns by table
       columns_by_table = columns_data.each_with_object({}) do |col, hash|
         hash[col['TABLE_NAME']] ||= []
@@ -133,6 +166,7 @@ module FastSchemaDumper
           table_name,
           columns: columns_by_table[table_name] || [],
           indexes: indexes_by_table[table_name] || {},
+          check_constraints: check_constraints_by_table[table_name] || {},
           options: table_options[table_name]
         )
         @output << ""
@@ -218,7 +252,7 @@ module FastSchemaDumper
       end
     end
 
-    def dump_table(table_name, columns:, indexes:, options:)
+    def dump_table(table_name, columns:, indexes:, check_constraints:, options:)
       table_def = "create_table \"#{table_name}\""
 
       # id (primary key)
@@ -296,6 +330,31 @@ module FastSchemaDumper
         @output << "  #{format_index(index_name, index_data)}"
       end
 
+      # Respect the CHECK constraint
+      #
+      # NOTE: original dumper sorts it according to the clause
+      # ref: https://github.com/rails/rails/blob/cddcba97c369e12e2573af5af9eda16e6f530a29/activerecord/lib/active_record/schema_dumper.rb#L284
+      check_constraints.sort_by { |c| c[:check_clause] }.each do |constraint|
+        check_clause = constraint[:check_clause]
+
+        # drop redundant parentheses at the most outer level for compatibility with the original dumper
+        if check_clause.start_with?("(") && check_clause.end_with?(")")
+          check_clause = check_clause[1..-2]
+        end
+
+        check_clause.gsub!(/\\'/, "'") # don't escape single quotes for compatibility with the original dumper
+
+        ck_line = "  t.check_constraint \"#{check_clause}\""
+
+        # Check if constraint name is custom (doesn't start with "chk_rails_")
+        # Rails generates constraint names starting with "chk_rails_" followed by a hash
+        if !constraint[:constraint_name].start_with?("chk_rails_")
+          ck_line += ", name: \"#{constraint[:constraint_name]}\""
+        end
+
+        @output << ck_line
+      end
+
       @output << "end"
     end
 
@@ -449,7 +508,13 @@ module FastSchemaDumper
         end
 
         unless order_hash.empty?
-          idx_def += ", order: { #{order_hash.map { |k, v| "#{k}: :#{v}" }.join(', ')} }"
+          if index_data[:columns].size == 1
+            # For single column index, use simplified syntax
+            idx_def += ", order: :#{order_hash.values.first}"
+          else
+            # For compound index, use hash syntax
+            idx_def += ", order: { #{order_hash.map { |k, v| "#{k}: :#{v}" }.join(', ')} }"
+          end
         end
       end
 

data/lib/fast_schema_dumper/ridgepole.rb

@@ -17,9 +17,9 @@ module Ridgepole
         puts "Warning: fast_schema_dumper is enabled in verify mode" unless ENV['FAST_SCHEMA_DUMPER_SUPPRESS_MESSAGE'] == '1'
         original_results = original_dump
         fast_results = fast_dump
+        File.write("orig.txt", original_results)
+        File.write("fast.txt", fast_results)
         if original_results != fast_results
-          File.write("orig.txt", original_results)
-          File.write("fast.txt", fast_results)
           raise "Dumped schema do not match between ActiveRecord::SchemaDumper and fast_schema_dumper. This is a fast_schema_dumper bug."
         end
         fast_results

data/lib/fast_schema_dumper/version.rb

@@ -1,3 +1,3 @@
 module FastSchemaDumper
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fast_schema_dumper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Daisuke Aritomo
@@ -58,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.0.dev
+rubygems_version: 3.8.0.dev
 specification_version: 4
 summary: A fast alternative to ActiveRecord::SchemaDumper
 test_files: []