fixture_seed 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b756a4004e83e2c69aac4a24fc69391e646fafa774d79b547b65b8d6fa58df7
+  data.tar.gz: 7790869a088bd54a43a5881da34885c7b79c9ea0360c6601ef0314e34d925067
+SHA512:
+  metadata.gz: 70a2b5e3514bef02dccec7ad3ecb97b7cc7742236838531ba7688b8f54884c3b57cd796dbea9828ac261453ba896c308088b9a308f2cdbc49fce1e406247961e
+  data.tar.gz: 469c9859bd06c963550e6426df5c6cf2805f795abacf3a56863b6b695302d5a2fb8edc07b1c4d87770f2f51e5721693a1e5e530ba6cd8efec36e7afcf6168294

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-05-11
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Devin AI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# FixtureSeed
+
+FixtureSeed is a Rails gem that automatically loads YAML fixture files from the `db/fixtures/` directory when running `rails db:seed`. It loads the fixtures in alphabetical order and handles foreign key constraint errors by retrying failed inserts after all other fixtures are loaded.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fixture_seed'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+Once the gem is installed, it will automatically hook into Rails' `db:seed` task. You don't need to modify your `seeds.rb` file.
+
+### Directory Structure
+
+Place your YAML fixture files in the `db/fixtures/` directory:
+
+```
+db/
+  fixtures/
+    posts.yml
+    users.yml
+```
+
+### Fixture Format
+
+The fixture files should be named after the table they correspond to (e.g., `users.yml` for the `users` table).
+
+The content of the fixture files should follow this format:
+
+```yaml
+# users.yml
+user1:
+  id: 1
+  name: "John Doe"
+  email: "john@example.com"
+
+user2:
+  id: 2
+  name: "Jane Smith"
+  email: "jane@example.com"
+```
+
+The labels (e.g., `user1`, `user2`) should follow the pattern of the table name in singular form followed by a number.
+
+### Loading Order
+
+Fixtures are loaded in alphabetical order by filename. However, if a fixture fails to load due to foreign key constraints, it will be retried after all other fixtures have been processed.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/komagata/fixture_seed.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/fixture_seed/railtie.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module FixtureSeed
+  class Railtie < Rails::Railtie
+    initializer "fixture_seed.initialize" do
+      Rails.logger.info "[FixtureSeed] Railtie initialized"
+    end
+
+    rake_tasks do
+      if Rake::Task.task_defined?("db:seed")
+        Rake::Task["db:seed"].enhance do
+          Rails.logger.info "[FixtureSeed] Starting to load fixtures through db:seed enhancement"
+          FixtureSeed.load_fixtures
+          Rails.logger.info "[FixtureSeed] Finished loading fixtures"
+        end
+      else
+        Rails.logger.warn "[FixtureSeed] db:seed task not found, fixture loading enhancement not applied"
+      end
+    end
+  end
+end

data/lib/fixture_seed/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FixtureSeed
+  VERSION = "0.1.0"
+end

data/lib/fixture_seed.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require_relative "fixture_seed/version"
+require_relative "fixture_seed/railtie" if defined?(Rails::Railtie)
+
+module FixtureSeed
+  class Error < StandardError; end
+
+  class << self
+    def load_fixtures
+      fixture_dir = Rails.root.join("db/fixtures").to_s
+      files_to_load = Dir.glob(File.join(fixture_dir, "*.yml")).sort
+
+      file_names = files_to_load.map { |f| File.basename(f) }.join(", ")
+      Rails.logger.info "[FixtureSeed] Found #{files_to_load.size} fixture files in #{fixture_dir}: #{file_names}"
+
+      # Load all fixtures with retry logic
+      unloaded_files = process_fixtures(fixture_dir, files_to_load)
+
+      # Report any fixtures that still failed
+      if unloaded_files.empty?
+        Rails.logger.info "[FixtureSeed] All fixtures loaded successfully."
+      else
+        message = "The following fixtures could not be loaded: #{unloaded_files.join(', ')}"
+        Rails.logger.warn "[FixtureSeed] #{message}"
+      end
+    end
+
+    private
+
+    def process_fixtures(fixture_dir, files)
+      remaining_files = files.dup
+      previous_count = remaining_files.size + 1
+
+      # Continue until all fixtures are loaded or no progress is made
+      while !remaining_files.empty? && remaining_files.size < previous_count
+        previous_count = remaining_files.size
+        remaining_files = process_batch(fixture_dir, files, remaining_files)
+      end
+
+      remaining_files
+    end
+
+    def process_batch(fixture_dir, original_files, current_files)
+      still_failed = []
+
+      current_files.each do |file|
+        log_loading(file)
+        load_single_fixture(fixture_dir, file)
+        log_success(file, original_files, current_files)
+      rescue ActiveRecord::InvalidForeignKey, ActiveRecord::StatementInvalid => e
+        log_failure(file, e, original_files, current_files)
+        still_failed << file
+      end
+
+      still_failed
+    end
+
+    def load_single_fixture(_fixture_dir, file)
+      table_name = File.basename(file, ".yml")
+      yaml_data = YAML.load_file(file)
+
+      model_class = begin
+        table_name.classify.constantize
+      rescue StandardError
+        nil
+      end
+
+      if model_class
+        yaml_data.each do |_fixture_name, attributes|
+          model_class.create!(attributes)
+        rescue StandardError => e
+          raise ActiveRecord::InvalidForeignKey, e.message
+        end
+      else
+        Rails.logger.warn "[FixtureSeed] Model for table #{table_name} not found"
+      end
+    end
+
+    def log_loading(file)
+      table_name = File.basename(file, ".yml")
+      Rails.logger.info "[FixtureSeed] Loading fixture #{File.basename(file)}..."
+    end
+
+    def log_success(file, original_files, current_files)
+      is_retry = original_files.size != current_files.size
+      if is_retry
+        Rails.logger.info "[FixtureSeed] Successfully loaded fixture #{File.basename(file)} on retry."
+      else
+        Rails.logger.info "[FixtureSeed] Loaded fixture #{File.basename(file)}"
+      end
+    end
+
+    def log_failure(file, error, original_files, current_files)
+      is_retry = original_files.size != current_files.size
+      filename = File.basename(file)
+      if is_retry
+        Rails.logger.warn "[FixtureSeed] Still failed to load fixture #{filename}: " \
+                          "#{error.message}. Will retry later."
+      else
+        Rails.logger.warn "[FixtureSeed] Failed to load fixture #{filename}: " \
+                          "#{error.message}. Will retry later."
+      end
+    end
+  end
+end

data/sig/fixture_seed.rbs

@@ -0,0 +1,4 @@
+module FixtureSeed
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: fixture_seed
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masaki Komagata
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: fixture_seed is a Rails gem that automatically loads YAML fixtures from
+  db/fixtures directory in alphabetical order when running rails db:seed, with error
+  handling for foreign key constraints.
+email:
+- komagata@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/fixture_seed.rb
+- lib/fixture_seed/railtie.rb
+- lib/fixture_seed/version.rb
+- sig/fixture_seed.rbs
+homepage: https://github.com/komagata/fixture_seed
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/komagata/fixture_seed
+  source_code_uri: https://github.com/komagata/fixture_seed
+  changelog_uri: https://github.com/komagata/fixture_seed/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: A Rails gem to automatically load fixtures from db/fixtures directory during
+  db:seed
+test_files: []