seed_dump 3.4.0 → 3.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 511098e751f9bc1761ba88f8fa017c354b70c88c98522ca9ae7cdcca10cedd18
-  data.tar.gz: b719e6cb717d0a50ef4c6c223da3a5a4f232cb762a56a56b27734c4d32da9c97
+  metadata.gz: e51de5d37ae0d9f14a4c6126a53e589e20ab504e6fb79bff59e61e4950bb4633
+  data.tar.gz: edfad4053c8dafa40d45de0a6b01fbf6dd97645945015d68887be0ee38ebb640
 SHA512:
-  metadata.gz: cfc449642cf4cc1d33665f2780a2021a49f4cad644beece695365ac7dc87af419dcca064298653d101d0daafb683cefa3539952de4a92ab583be9aae12091616
-  data.tar.gz: 22c058a82ecf0dd3d9b775b52de95f15efca5c14a3eb767a8a22f3cc4acd6a1d8f8696510a1f57fcd19c1fb2df959196c748b1620eec34e359428af247e25c53
+  metadata.gz: 4fa4f77d53981389543d97e2295cc0945effdc5360fdfce1d10beedfda43ca6116763b7f05105ba928d45e903bb568f78ae71ace57a5dbab9fcf3d23b919d590
+  data.tar.gz: 3cec4ce1c103182cb46f1c53e126c1563911efb7253bd783eb9d623c07d7efc9323072a51de8bd006002ebc347a163ce78a464d4a0a8660dc20781c8b4e3dd40

data/README.md

@@ -116,6 +116,10 @@ Options are common to both the Rake task and the console, except where noted.
 
 `file`: Write to the specified output file. The Rake task default is `db/seeds.rb`. The console returns the dump as a string by default if this option is omitted.
 
+`group_sti_by_class`: If `true`, Single Table Inheritance (STI) records are grouped by their actual class (e.g., `Dog`, `Cat`) instead of the base class (e.g., `Animal`). This is necessary when STI subclasses have different enum definitions or other class-specific attributes that would be lost if dumped via the base class. Default: `false`. Example: `rake db:seed:dump GROUP_STI_BY_CLASS=true` or `SeedDump.dump(Animal, group_sti_by_class: true)`. See the STI Handling section below for more details.
+
+`header`: If `true`, adds a comment header to the output file showing the seed_dump command and options used. If a string, uses that string as the header comment. Default: `false`. **Rake task only.** Example: `rake db:seed:dump HEADER=true` or `HEADER="Generated by seed_dump"`.
+
 `import`: If `true`, output will be in the format needed by the [activerecord-import](https://github.com/zdennis/activerecord-import) gem, rather than the default format. You can also pass a Hash of options which will be passed through to the `import` call (e.g., `IMPORT='{ "validate": false }'` for Rake, or `import: { validate: false }` for console). Default: `false`.
 
 `include_all`: If set to `true`, include all columns in the dump (including `id`, `created_at`, and `updated_at`). Equivalent to `EXCLUDE=""`. Default: `false`. **Rake task only.** Example: `rake db:seed:dump INCLUDE_ALL=true`
@@ -130,15 +134,13 @@ Options are common to both the Rake task and the console, except where noted.
 
 `models_exclude`: Exclude the specified comma-separated list of models from the dump. Default: no models excluded. **Rake task only.** Example: `rake db:seed:dump MODELS_EXCLUDE="User"`
 
-`header`: If `true`, adds a comment header to the output file showing the seed_dump command and options used. If a string, uses that string as the header comment. Default: `false`. **Rake task only.** Example: `rake db:seed:dump HEADER=true` or `HEADER="Generated by seed_dump"`.
-
 `upsert_all`: If `true`, output will use Rails 6+ [`upsert_all`](https://api.rubyonrails.org/classes/ActiveRecord/Persistence/ClassMethods.html#method-i-upsert_all) which preserves record IDs and handles conflicts by updating existing records. This is useful when you need to maintain foreign key relationships or want idempotent seed files. Automatically includes `id` in the dump. Default: `false`. Example: `rake db:seed:dump UPSERT_ALL=true` or `SeedDump.dump(User, upsert_all: true)`.
 
 ## Automatic Behaviors
 
 **Foreign Key Ordering**: Models are automatically dumped in dependency order based on foreign key relationships. This ensures that parent records are created before child records that reference them.
 
-**STI Handling**: Single Table Inheritance (STI) models are automatically deduplicated— only the base model is dumped, avoiding duplicate records.
+**STI Handling**: Single Table Inheritance (STI) models are automatically deduplicated. By default, only the base class is dumped to avoid duplicate records (e.g., `Animal.create!` for both `Dog` and `Cat` records). However, if your STI subclasses have different enum definitions or other class-specific attributes, use the `group_sti_by_class: true` option to dump each subclass separately (e.g., `Dog.create!` and `Cat.create!`). This ensures that subclass-specific type casting and validations are properly applied when the seed data is loaded.
 
 **HABTM Handling**: Has-and-belongs-to-many join tables are automatically detected and dumped without duplication.
 

data/lib/seed_dump/dump_methods.rb

@@ -22,6 +22,7 @@ class SeedDump
     # @option options [Boolean, Hash] :import Use activerecord-import format. If Hash, passed as options to import. Default: false.
     # @option options [Boolean] :insert_all Use Rails 6+ insert_all format for faster bulk inserts. Default: false.
     # @option options [Boolean] :upsert_all Use Rails 6+ upsert_all format to preserve IDs and fix foreign key issues (issue #104). Default: false.
+    # @option options [Boolean] :group_sti_by_class Group STI records by their actual class instead of base_class (issue #170). Default: false.
     # @return [String, nil] The dump string if :file is nil, otherwise nil.
     def dump(records, options = {})
       # Handle potential empty input gracefully
@@ -367,6 +368,24 @@ class SeedDump
           raise ArgumentError, "Could not determine model class from records."
       end
 
+      # Check if we should group STI models by their actual class (issue #170)
+      # This fixes the issue where STI models with different enum definitions
+      # lose data when dumped via the base class
+      if options[:group_sti_by_class] && model_klass.respond_to?(:base_class)
+        write_sti_records_grouped_by_class(records, io, options, model_klass)
+      else
+        write_records_for_single_model(records, io, options, model_klass)
+      end
+    end
+
+    # Writes records for a single model class.
+    #
+    # @param records [ActiveRecord::Relation, Class, Array<ActiveRecord::Base>] The records to write.
+    # @param io [IO] The IO object to write to.
+    # @param options [Hash] Dumping options.
+    # @param model_klass [Class] The model class to use for output.
+    # @return [void]
+    def write_records_for_single_model(records, io, options, model_klass)
       # Determine the method call ('import', 'insert_all', 'upsert_all', or 'create!')
       method = if options[:import]
                  'import'
@@ -402,6 +421,39 @@ class SeedDump
       end
     end
 
+    # Writes STI records grouped by their actual class (issue #170).
+    #
+    # When STI models have different enum definitions, dumping via the base class
+    # causes enum values to be lost. This method groups records by their actual
+    # class and dumps each group separately.
+    #
+    # @param records [ActiveRecord::Relation, Class] The records to write.
+    # @param io [IO] The IO object to write to.
+    # @param options [Hash] Dumping options.
+    # @param model_klass [Class] The base model class.
+    # @return [void]
+    def write_sti_records_grouped_by_class(records, io, options, model_klass)
+      # We need to fetch all records and group them by class
+      # This is necessary because we can't efficiently group via SQL
+      all_records = if records.is_a?(Class)
+                      records.all.to_a
+                    elsif records.is_a?(ActiveRecord::Relation)
+                      records.to_a
+                    else
+                      records
+                    end
+
+      # Group records by their actual class
+      records_by_class = all_records.group_by(&:class)
+
+      # Sort classes by name for consistent output
+      records_by_class.keys.sort_by(&:name).each do |klass|
+        class_records = records_by_class[klass]
+        # Write records for this specific class
+        write_records_for_single_model(class_records, io, options, klass)
+      end
+    end
+
     # Generates the string for activerecord-import options, if provided.
     #
     # @param options [Hash] Dumping options, potentially containing :import hash.

data/lib/seed_dump/environment.rb

@@ -27,6 +27,7 @@ class SeedDump
                       batch_size: retrieve_batch_size_value(env),
                       exclude: retrieve_exclude_value(env),
                       file: retrieve_file_value(env),
+                      group_sti_by_class: retrieve_group_sti_by_class_value(env),
                       header: retrieve_header_value(env),
                       import: retrieve_import_value(env),
                       insert_all: retrieve_insert_all_value(env),
@@ -289,6 +290,14 @@ class SeedDump
       parse_boolean_value(env['HEADER'])
     end
 
+    # Internal: Returns a Boolean indicating whether the value for the "GROUP_STI_BY_CLASS"
+    # key in the given Hash is equal to the String "true" (ignoring case),
+    # false if no value exists. GROUP_STI_BY_CLASS groups STI records by their actual
+    # class instead of base_class to fix enum issues (issue #170).
+    def retrieve_group_sti_by_class_value(env)
+      parse_boolean_value(env['GROUP_STI_BY_CLASS'])
+    end
+
     # Internal: Retrieves an Array of Class constants parsed from the value for
     # the "MODELS_EXCLUDE" key in the given Hash, and an empty Array if such
     # key exists.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seed_dump
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.4.1
 platform: ruby
 authors:
 - Rob Halff
@@ -9,10 +9,10 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2025-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -26,7 +26,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,20 +39,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4'
-- !ruby/object:Gem::Dependency
-  name: seed_dump
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -96,65 +82,146 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.28'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: mutex_m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Dump (parts) of your database to db/seeds.rb to get a headstart creating
   a meaningful seeds.rb file
 email: rroblak@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.md
+extra_rdoc_files: []
 files:
-- ".github/workflows/release.yml"
-- ".rspec"
-- Appraisals
-- Gemfile
 - MIT-LICENSE
 - README.md
-- Rakefile
-- VERSION
-- find_ruby_compat.sh
-- gemfiles/rails_6.1.gemfile
-- gemfiles/rails_6.1.gemfile.lock
-- gemfiles/rails_7.0.gemfile
-- gemfiles/rails_7.0.gemfile.lock
-- gemfiles/rails_7.1.gemfile
-- gemfiles/rails_7.1.gemfile.lock
-- gemfiles/rails_7.2.gemfile
-- gemfiles/rails_7.2.gemfile.lock
-- gemfiles/rails_8.0.gemfile
-- gemfiles/rails_8.0.gemfile.lock
 - lib/seed_dump.rb
 - lib/seed_dump/dump_methods.rb
 - lib/seed_dump/dump_methods/enumeration.rb
 - lib/seed_dump/environment.rb
 - lib/seed_dump/railtie.rb
 - lib/tasks/seed_dump.rake
-- seed_dump.gemspec
-- spec/dump_methods_spec.rb
-- spec/environment_spec.rb
-- spec/factories/another_samples.rb
-- spec/factories/authors.rb
-- spec/factories/base_users.rb
-- spec/factories/books.rb
-- spec/factories/bosses.rb
-- spec/factories/reviews.rb
-- spec/factories/samples.rb
-- spec/factories/yet_another_samples.rb
-- spec/helpers.rb
-- spec/spec_helper.rb
 homepage: https://github.com/rroblak/seed_dump
 licenses:
 - MIT
@@ -177,5 +244,5 @@ requirements: []
 rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
-summary: "{Seed Dumper for Rails}"
+summary: Seed Dumper for Rails
 test_files: []

data/.github/workflows/release.yml

@@ -1,38 +0,0 @@
-name: Release
-
-on:
-  push:
-    tags:
-      - 'v*'
-
-jobs:
-  release:
-    name: Release gem to RubyGems.org
-    runs-on: ubuntu-latest
-
-    permissions:
-      id-token: write   # Required for trusted publishing
-      contents: write   # Required for GitHub release creation
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.3'
-          bundler-cache: true
-
-      - name: Configure RubyGems credentials
-        uses: rubygems/configure-rubygems-credentials@v1.0.0
-
-      - name: Build gem
-        run: gem build seed_dump.gemspec
-
-      - name: Push to RubyGems
-        run: gem push seed_dump-*.gem
-
-      - name: Create GitHub Release
-        uses: softprops/action-gh-release@v2
-        with:
-          generate_release_notes: true

data/.rspec

@@ -1,2 +0,0 @@
---color
---format progress

data/Appraisals

@@ -1,47 +0,0 @@
-# Appraisals file for testing seed_dump against different Rails versions.
-# Gems defined here are combined with the main Gemfile.
-# Gems specified here take precedence over the Gemfile versions for that appraisal.
-
-# Appraisal for Rails 6.1.x
-appraise 'rails-6.1' do
-  # Specify gems specific to this appraisal scenario
-  gem 'activerecord', '~> 6.1.0'
-  gem 'activesupport', '~> 6.1.0'
-  gem 'sqlite3', '>= 1.3', '< 2.0' # Broadly compatible range
-end
-
-# Appraisal for Rails 7.0.x
-appraise 'rails-7.0' do
-  # Specify gems specific to this appraisal scenario
-  gem 'activerecord', '~> 7.0.0'
-  gem 'activesupport', '~> 7.0.0'
-  gem 'sqlite3', '>= 1.3', '< 2.0' # Broadly compatible range
-end
-
-# Appraisal for Rails 7.1.x
-appraise 'rails-7.1' do
-  # Specify gems specific to this appraisal scenario
-  gem 'activerecord', '~> 7.1.0'
-  gem 'activesupport', '~> 7.1.0'
-  gem 'sqlite3', '>= 1.3', '< 2.0' # Broadly compatible range
-end
-
-# Appraisal for Rails 7.2.x
-appraise 'rails-7.2' do
-  gem 'activerecord', '~> 7.2.0'
-  gem 'activesupport', '~> 7.2.0'
-  gem 'sqlite3', '>= 1.3', '< 2.0'
-end
-
-# Appraisal for Rails 8.0.x (Edge/Main)
-appraise 'rails-8.0' do
-  # Specify gems specific to this appraisal scenario
-  gem 'activerecord', '>= 8.0.0.alpha', '< 8.1'
-  gem 'activesupport', '>= 8.0.0.alpha', '< 8.1'
-
-  # Override sqlite3 constraint for Rails 8 compatibility
-  # Rails 8 requires sqlite3 >= 2.1
-  gem 'sqlite3', '>= 2.1'
-end
-
-# Common test gems (rspec, factory_bot, etc.) are inherited from the main Gemfile's :test group.

data/Gemfile

@@ -1,36 +0,0 @@
-source 'https://rubygems.org'
-
-# Runtime dependencies (also used in test appraisals)
-gem 'activesupport', '>= 4'
-gem 'activerecord', '>= 4'
-
-group :development, :test do
-  # Common development and test dependencies
-  gem 'byebug', '~> 11.1'
-  gem 'factory_bot', '~> 6.1'
-  # activerecord-import might be needed for tests if using :import option
-  gem 'activerecord-import', '~> 0.28'
-end
-
-group :development do
-  # Development-only dependencies
-  gem 'jeweler', '~> 2.3'
-end
-
-group :test do
-  # Test-only dependencies (common across all appraisals)
-  gem 'rspec', '~> 3.13.0'
-  gem 'database_cleaner-active_record', '~> 2.0'
-  gem 'appraisal', '~> 2.4'
-
-  # Add gems removed from Ruby stdlib/default but needed by older ActiveSupport
-  # Required for Ruby 3.4+
-  gem 'mutex_m'
-  # Recommended for Ruby 3.5+ (or to silence warning in 3.4)
-  gem 'logger'
-  # Add benchmark to silence Ruby 3.5+ warning
-  gem 'benchmark'
-end
-
-# Pull in dependencies specified in the gemspec
-gemspec

data/Rakefile

@@ -1,32 +0,0 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "seed_dump"
-    gem.summary = "{Seed Dumper for Rails}"
-    gem.description = %Q{Dump (parts) of your database to db/seeds.rb to get a headstart creating a meaningful seeds.rb file}
-    gem.email = 'rroblak@gmail.com'
-    gem.homepage = 'https://github.com/rroblak/seed_dump'
-    gem.authors = ['Rob Halff', 'Ryan Oblak']
-    gem.license = 'MIT'
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "seed_dump #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-task :default => :spec

data/VERSION

@@ -1 +0,0 @@
-3.4.0