fast_schema_dumper 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfd997d65329c763b3d9a2947bc4729bf705353b670ed92e3c6aeeb4e5a57274
-  data.tar.gz: 3997c70bf8503357745c8ade27fd29d07853ab45bf9f992171102f9b5e79baed
+  metadata.gz: 67356310ddf238f27066fb0980ea10ff37b9ffcb5307f89c661fe81a1dc1a6c4
+  data.tar.gz: 8a5c15d6dff1209cd439dabf036ee3333bd08bee49e3481d7dd3ef233b07a679
 SHA512:
-  metadata.gz: 3d1182a9edbe7099fcb22c9d40cb0548e6a261d2e1239e840d5f5e9bf96d44f7c23d2014ad534a561fca2e4b28fc0b309b9025cc4571d19581c932f6014e5e43
-  data.tar.gz: a6007f94ad89cfd25efe63ad78037a9aa8cfc861e547c90fea76e4453321025dc1ab0c5acd960b67a5376aac17da738bb47840e15fe6de509b442c0371dee477
+  metadata.gz: ad7aa63eaae977b3fa65e210e3a66a6074d8a0ceb31a6e21c35c3f4a97dcd3a0658afd1c64fc46e3bab3e0cac198a26fdad8df1c14846aa35936b2e9feac573e
+  data.tar.gz: 858e4903f02a8b12a0fc153c577bc137418b56be1ae4bc522c65920c5fc8774f00598e55e8086b60e769e7959cfd94ae1408cd41f12ba8823ee350587bd6b794

data/.standard.yml

@@ -0,0 +1,5 @@
+ruby_version: 3.2
+ignore:
+  - "**/*":
+      - Style/StringLiterals
+      - Style/StringLiteralsInInterpolation

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [0.5.0] - 2026-04-09
+
+- Handle generated columns in fast dumper. [#23](https://github.com/smartbank-inc/fast_schema_dumper/pull/23)
+- Add frozen string literal pragmas and update README. [#25](https://github.com/smartbank-inc/fast_schema_dumper/pull/25)
+- Add RubyGems version badge to README. [#17](https://github.com/smartbank-inc/fast_schema_dumper/pull/17)
+
+## [0.4.3] - 2026-03-11
+
+- Introduce StandardRB for code linting. [#9](https://github.com/smartbank-inc/fast_schema_dumper/pull/9)
+- Test setup. [#10](https://github.com/smartbank-inc/fast_schema_dumper/pull/10)
+- Add `.github/dependabot.yml`. [#12](https://github.com/smartbank-inc/fast_schema_dumper/pull/12)
+
 ## [0.4.0] - 2025-11-06
 
 ## [0.3.0] - 2025-10-31

data/README.md

@@ -1,15 +1,25 @@
+[![Test](https://github.com/smartbank-inc/fast_schema_dumper/actions/workflows/test.yml/badge.svg)](https://github.com/smartbank-inc/fast_schema_dumper/actions/workflows/test.yml)
+[![Gem Version](https://badge.fury.io/rb/fast_schema_dumper.svg)](https://badge.fury.io/rb/fast_schema_dumper)
+
 # fast_schema_dumper
 
-A super fast alternative to ActiveRecord::SchemaDumper. Currently only MySQL is supported.
+A super fast alternative to `ActiveRecord::SchemaDumper`. Currently only MySQL is supported.
+
+## What It Does
+
+- Reads schema metadata directly from `INFORMATION_SCHEMA`
+- Emits Rails-style `schema.rb` output
+- Works as a standalone executable
+- Can override `Ridgepole::Dumper.dump`
 
 ## Usage
 
 ### Ridgepole integration
 
-Requiring `fast_schema_dumper/ridgepole` will overwrite `Ridgepole::Dumper.dump`, which will force Ridgepole to use fast_schema_dumper.
+Require `fast_schema_dumper/ridgepole` after loading `ridgepole` to replace `Ridgepole::Dumper.dump` with `fast_schema_dumper`.
 
-```
-RUBYOPT='-rridgepole -rfast_schema_dumper' ridgepole ... --apply
+```bash
+RUBYOPT='-rridgepole -rfast_schema_dumper/ridgepole' ridgepole --apply
 ```
 
 #### Environment variables for Ridgepole

data/Rakefile

@@ -1,4 +1,13 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-task default: %i[]
+require "rake/testtask"
+require "standard/rake"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/lib/fast_schema_dumper/cli.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'erb'
 require 'active_record'
 require 'active_record/database_configurations'
 
-require_relative './fast_dumper'
+require_relative 'fast_dumper'
 
 module FastSchemaDumper
   class CLI
@@ -10,9 +12,7 @@ module FastSchemaDumper
       new.run(...)
     end
 
-    def run(argv)
-      argv = argv.dup
-
+    def run(_argv)
       env = ENV['RAILS_ENV'] || 'development'
 
       database_yml_path = File.join(Dir.pwd, 'config', 'database.yml')
@@ -27,7 +27,7 @@ module FastSchemaDumper
 
       SchemaDumper.dump
 
-      return 0
+      0
     end
   end
 end

data/lib/fast_schema_dumper/fast_dumper.rb

@@ -38,6 +38,7 @@ module FastSchemaDumper
           , NUMERIC_SCALE
           , COLUMN_TYPE
           , EXTRA
+          , GENERATION_EXPRESSION
           , COLUMN_COMMENT
           , DATETIME_PRECISION
           , COLLATION_NAME
@@ -77,7 +78,7 @@ module FastSchemaDumper
           # include
           # nulls_not_distinct
           # type
-          comment: idx['INDEX_COMMENT'],
+          comment: idx['INDEX_COMMENT']
           # enabled
         }
         hash[idx['TABLE_NAME']][idx['INDEX_NAME']][:columns] << idx['COLUMN_NAME']
@@ -99,7 +100,7 @@ module FastSchemaDumper
     ").each_with_object({}) do |row, hash|
         hash[row['TABLE_NAME']] = {
           collation: row['TABLE_COLLATION'],
-          comment: row['TABLE_COMMENT'],
+          comment: row['TABLE_COMMENT']
         }
       end
 
@@ -187,7 +188,7 @@ module FastSchemaDumper
           column: fk['COLUMN_NAME'],
           referenced_table: fk['REFERENCED_TABLE_NAME'],
           referenced_column: fk['REFERENCED_COLUMN_NAME'],
-          constraint_name: fk['CONSTRAINT_NAME'],
+          constraint_name: fk['CONSTRAINT_NAME']
         }
       end
 
@@ -197,7 +198,7 @@ module FastSchemaDumper
           all_foreign_keys << {
             table_name: table_name,
             constraint_name: constraint_name,
-            fk_data: fk_data,
+            fk_data: fk_data
           }
         end
       end
@@ -217,12 +218,10 @@ module FastSchemaDumper
         if fk[:fk_data][:column] != inferred_column
           # Column name is custom, need to specify it
           fk_line += ", column: \"#{fk[:fk_data][:column]}\""
-        else
+        elsif !fk[:fk_data][:constraint_name].start_with?("fk_rails_")
           # Column matches default, check if constraint name is custom
           # Rails generates constraint names starting with "fk_rails_"
-          if !fk[:fk_data][:constraint_name].start_with?("fk_rails_")
-            fk_line += ", name: \"#{fk[:fk_data][:constraint_name]}\""
-          end
+          fk_line += ", name: \"#{fk[:fk_data][:constraint_name]}\""
         end
 
         @output << fk_line
@@ -231,7 +230,7 @@ module FastSchemaDumper
       stream.print @output.join("\n")
     end
 
-  private
+    private
 
     def escape_string(str)
       str.gsub("\\", "\\\\\\\\").gsub('"', '\"').gsub("\n", "\\n").gsub("\r", "\\r").gsub("\t", "\\t")
@@ -317,7 +316,7 @@ module FastSchemaDumper
       # Indexes
       # Rails orders indexes lexicographically by their column arrays
       # Example: ["a", "b"] < ["a"] < ["b", "c"] < ["b"] < ["d"]
-      sorted_indexes = indexes.reject { |name, _| name == 'PRIMARY' }.sort_by do |index_name, index_data|
+      sorted_indexes = indexes.except('PRIMARY').sort_by do |index_name, index_data|
         # Create an array padded with high values for comparison
         # This ensures that missing columns sort after existing ones
         max_cols = indexes.values.map { |data| data[:columns].size }.max || 1
@@ -349,7 +348,7 @@ module FastSchemaDumper
           end
         end
 
-        check_clause.gsub!(/\\'/, "'") # don't escape single quotes for compatibility with the original dumper
+        check_clause.gsub!("\\'", "'") # don't escape single quotes for compatibility with the original dumper
 
         ck_line = "  t.check_constraint \"#{check_clause}\""
 
@@ -366,11 +365,13 @@ module FastSchemaDumper
     end
 
     def format_column(column)
+      return format_generated_column(column) if generated_column?(column)
+
       col_def = "t.#{map_column_type(column)} \"#{column['COLUMN_NAME']}\""
 
       # limit (varchar, char)
       if ['varchar', 'char'].include?(column['DATA_TYPE']) && column['CHARACTER_MAXIMUM_LENGTH'] &&
-         column['CHARACTER_MAXIMUM_LENGTH'] != 255
+          column['CHARACTER_MAXIMUM_LENGTH'] != 255
         col_def += ", limit: #{column['CHARACTER_MAXIMUM_LENGTH']}"
       end
 
@@ -435,6 +436,21 @@ module FastSchemaDumper
       col_def
     end
 
+    def format_generated_column(column)
+      col_def = "t.virtual \"#{column['COLUMN_NAME']}\", type: :#{map_column_type(column)}, as: \"#{escape_string(column['GENERATION_EXPRESSION'])}\""
+      col_def += ", stored: true" if stored_generated_column?(column)
+      col_def += ", comment: \"#{escape_string(column['COLUMN_COMMENT'])}\"" if column['COLUMN_COMMENT'] && !column['COLUMN_COMMENT'].empty?
+      col_def
+    end
+
+    def generated_column?(column)
+      column['EXTRA'].include?(' GENERATED')
+    end
+
+    def stored_generated_column?(column)
+      column['EXTRA'].include?('STORED GENERATED')
+    end
+
     def map_column_type(column)
       # Check for boolean (tinyint(1))
       if column['COLUMN_TYPE'] == 'tinyint(1)'
@@ -476,7 +492,7 @@ module FastSchemaDumper
 
       # Special handling for boolean (tinyint(1))
       if column_type == 'tinyint(1)'
-        return default == '1' ? 'true' : 'false'
+        return (default == '1') ? 'true' : 'false'
       end
 
       case data_type
@@ -495,19 +511,19 @@ module FastSchemaDumper
         # MySQL double is mapped to Type::Float in Rails
         default.to_f.inspect
       when 'json'
-        default == "'[]'" ? '[]' : '{}'
+        (default == "'[]'") ? '[]' : '{}'
       else
-        default =~ /^'.*'$/ ? "\"#{default[1..-2]}\"" : default
+        /^'.*'$/.match?(default) ? "\"#{default[1..-2]}\"" : default
       end
     end
 
     def format_index(index_name, index_data)
       idx_def = "t.index "
 
-      if index_data[:columns].size == 1
-        idx_def += "[\"#{index_data[:columns].first}\"]"
+      idx_def += if index_data[:columns].size == 1
+        "[\"#{index_data[:columns].first}\"]"
       else
-        idx_def += "[#{index_data[:columns].map { |c| "\"#{c}\"" }.join(', ')}]"
+        "[#{index_data[:columns].map { |c| "\"#{c}\"" }.join(', ')}]"
       end
 
       idx_def += ", name: \"#{index_name}\""
@@ -522,12 +538,12 @@ module FastSchemaDumper
         end
 
         unless order_hash.empty?
-          if index_data[:columns].size == 1
+          idx_def += if index_data[:columns].size == 1
             # For single column index, use simplified syntax
-            idx_def += ", order: :#{order_hash.values.first}"
+            ", order: :#{order_hash.values.first}"
           else
             # For compound index, use hash syntax
-            idx_def += ", order: { #{order_hash.map { |k, v| "#{k}: :#{v}" }.join(', ')} }"
+            ", order: { #{order_hash.map { |k, v| "#{k}: :#{v}" }.join(', ')} }"
           end
         end
       end

data/lib/fast_schema_dumper/ridgepole.rb

@@ -1,4 +1,6 @@
-require_relative './fast_dumper'
+# frozen_string_literal: true
+
+require_relative 'fast_dumper'
 
 # Loading this file will overwrite `Ridgepole::Dumper.dump`.
 

data/lib/fast_schema_dumper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FastSchemaDumper
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

data/lib/fast_schema_dumper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "fast_schema_dumper/version"
 
 module FastSchemaDumper

data/test/fast_schema_dumper_test.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "fast_schema_dumper/fast_dumper"
+
+class FastSchemaDumperTest < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::FastSchemaDumper::VERSION
+  end
+
+  def test_format_generated_column
+    dumper = FastSchemaDumper::SchemaDumper.new
+    column = {
+      'COLUMN_NAME' => 'active_unique_key',
+      'DATA_TYPE' => 'int',
+      'COLUMN_TYPE' => 'int',
+      'EXTRA' => 'STORED GENERATED',
+      'GENERATION_EXPRESSION' => 'if((`deleted_at` is null),1,NULL)',
+      'COLUMN_COMMENT' => '',
+      'IS_NULLABLE' => 'YES'
+    }
+
+    actual = dumper.send(:format_column, column)
+
+    assert_equal(
+      't.virtual "active_unique_key", type: :integer, as: "if((`deleted_at` is null),1,NULL)", stored: true',
+      actual
+    )
+  end
+
+  def test_format_generated_column_with_comment
+    dumper = FastSchemaDumper::SchemaDumper.new
+    column = {
+      'COLUMN_NAME' => 'full_name',
+      'DATA_TYPE' => 'varchar',
+      'COLUMN_TYPE' => 'varchar(255)',
+      'EXTRA' => 'VIRTUAL GENERATED',
+      'GENERATION_EXPRESSION' => 'concat(`first_name`,`last_name`)',
+      'COLUMN_COMMENT' => 'generated name',
+      'IS_NULLABLE' => 'YES'
+    }
+
+    actual = dumper.send(:format_column, column)
+
+    assert_equal(
+      't.virtual "full_name", type: :string, as: "concat(`first_name`,`last_name`)", comment: "generated name"',
+      actual
+    )
+  end
+
+  def test_generated_column_detection_does_not_match_default_generated
+    dumper = FastSchemaDumper::SchemaDumper.new
+    column = {
+      'COLUMN_NAME' => 'created_at',
+      'DATA_TYPE' => 'datetime',
+      'COLUMN_TYPE' => 'datetime',
+      'EXTRA' => 'DEFAULT_GENERATED',
+      'COLUMN_DEFAULT' => 'CURRENT_TIMESTAMP',
+      'COLUMN_COMMENT' => '',
+      'IS_NULLABLE' => 'NO',
+      'COLUMN_KEY' => '',
+      'CHARACTER_MAXIMUM_LENGTH' => nil,
+      'NUMERIC_PRECISION' => nil,
+      'NUMERIC_SCALE' => nil,
+      'DATETIME_PRECISION' => nil,
+      'COLLATION_NAME' => nil
+    }
+
+    actual = dumper.send(:format_column, column)
+
+    assert_equal('t.datetime "created_at", default: -> { "CURRENT_TIMESTAMP" }, null: false', actual)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "fast_schema_dumper"
+
+require "minitest/autorun"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fast_schema_dumper
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Daisuke Aritomo
@@ -46,6 +46,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".standard.yml"
 - CHANGELOG.md
 - README.md
 - Rakefile
@@ -55,6 +56,8 @@ files:
 - lib/fast_schema_dumper/fast_dumper.rb
 - lib/fast_schema_dumper/ridgepole.rb
 - lib/fast_schema_dumper/version.rb
+- test/fast_schema_dumper_test.rb
+- test/test_helper.rb
 homepage: https://github.com/osyoyu/fast_schema_dumper
 licenses: []
 metadata: