seed_fixtures 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a3b2f17ba33d7339f567a27880b5d61d2f088aa98e1f1897c39336cdde951235
+  data.tar.gz: 2243b6f740b5ade12981754fb84e76429cb47c2a2de970dc5027eaf98e28cf14
+SHA512:
+  metadata.gz: 76450f3299478c7dab95719f7c7ca7f636b70116f2b5a2ff5d1c05631223f47d5ffbf8a6ae6a3f6a3d54383816f65bff086029bf95f6da156f88f51fd0a6b07a
+  data.tar.gz: aace060b83430c20e8297019d6c4ea4d5bec3aaf435df4af77ca828c8201d7b2169b5ce8597d84fde40de292d0e49528414b53e066f70bc4d1d18f149517d4a4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Alex Ghiculescu
+
+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,75 @@
+# seed_fixtures
+
+[![Gem Version](https://badge.fury.io/rb/seed_fixtures.svg)](https://rubygems.org/gems/seed_fixtures)
+[![CI](https://github.com/ghiculescu/seed-fixtures/actions/workflows/ci.yml/badge.svg)](https://github.com/ghiculescu/seed-fixtures/actions/workflows/ci.yml)
+[![Code Climate](https://codeclimate.com/github/ghiculescu/seed-fixtures/badges/gpa.svg)](https://codeclimate.com/github/ghiculescu/seed-fixtures)
+
+Use your `seeds.rb` as fixtures when running tests.
+
+Currently only Rails 7 is supported. PRs to support older Rails versions are welcome!
+
+## Quick start
+
+1. Add `seed_fixtures` to the `test` group of your Gemfile, then run `bundle install`.
+
+2. In your `test_helper.rb`:
+
+```ruby
+class ActiveSupport::TestCase
+  # Add this line:
+  fixtures_from_seeds
+
+  # Comment out or remove this line:
+  # fixtures :all
+end
+```
+
+Notes:
+
+- You cannot use standard Rails fixtures if you are using this gem. Make sure you remove the `fixtures` call that's included in `test_helper.rb` by default!
+- Ensure your `test_helper.rb` includes this: `require "rails/test_help"`.
+
+3. Add `.seeds_hash` to your `.gitignore` file.
+
+## What it does
+
+- When tests run, the contents of `db/seeds.rb` will be loaded into the test database.
+- To improve performance, keeps a hash of everything your app's `db/` folder in the `.seeds_hash` file. This way, seeds are only reloaded into the database if you change your seeds file or your schema.
+- Adds a `parallel_setup` hook, so if you run parallel tests, seeds will be loaded correctly. (This is needed because parallel databases [are truncated before each run](https://github.com/rails/rails/issues/46820).)
+
+## How do I access seed data in my test?
+
+Just like anything else in the database...
+
+```ruby
+user = User.find_by(name: "Alex")
+```
+
+Or if you like, define helper methods for easy lookup.
+
+```ruby
+module SeedFixtureLookups
+  def user_alex
+    @user_alex ||= User.find_by(name: "Alex")
+  end
+end
+
+class ActiveSupport::TestCase
+  include SeedFixtureLookups
+end
+
+# in a test...
+test "alex exists" do
+  assert_not_nil user_alex
+end
+```
+
+## I thought seeds are for development, not testing!?
+
+Not everyone agrees this is a good idea. And for many apps, it's not! But for some apps it is a very neat way of writing a robust test suite. If your app is one of those, give this a try.
+
+If you're interested, [here's a discusion that touches on pros and cons of this approach](https://discuss.rubyonrails.org/t/should-dbprepare-also-call-db-seed-by-default/74835).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).

data/lib/seed_fixtures/core.rb

@@ -0,0 +1,17 @@
+require "active_support/concern"
+
+module SeedFixtures
+  module Core
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def fixtures_from_seeds
+        ActiveSupport.on_load(:active_support_test_case) do
+          prepend SeedFixtures::Implementation
+        end
+
+        parallelize_setup { SeedFixtures::Implementation.truncate_and_seed }
+      end
+    end
+  end
+end

data/lib/seed_fixtures/implementation.rb

@@ -0,0 +1,45 @@
+require "active_support/concern"
+
+module SeedFixtures
+  module Implementation
+    class << self
+      def truncate_and_seed
+        ActiveRecord::Tasks::DatabaseTasks.truncate_all
+        Rails.application.load_seed
+      end
+    end
+
+    def load_fixtures(*)
+      return if defined?(@@has_loaded_fixtures)
+
+      unless_seeds_in_db_match_files do
+        SeedFixtures::Implementation.truncate_and_seed
+      end
+
+      @@has_loaded_fixtures = true
+    end
+
+    private
+
+    def unless_seeds_in_db_match_files
+      File.write(hash_file_path, "") unless File.exist?(hash_file_path)
+
+      expected_hash = File.read(hash_file_path).strip
+      if expected_hash == calculate_seeds_hash
+        Rails.logger.debug "Seeds not changed since last run, skipping seeds generation. Delete #{hash_file_path} to force seeds to generate."
+      else
+        Rails.logger.debug "Generating seeds!"
+        yield
+        File.write(hash_file_path, calculate_seeds_hash)
+      end
+    end
+
+    def hash_file_path
+      ".seeds_hash"
+    end
+
+    def calculate_seeds_hash
+      `find db* -type f | perl -e 'print sort <>' - | xargs md5sum | cut -c1-32 | md5sum | cut -c1-32`.strip
+    end
+  end
+end

data/lib/seed_fixtures/version.rb

@@ -0,0 +1,3 @@
+module SeedFixtures
+  VERSION = "1.0.0".freeze
+end

data/lib/seed_fixtures.rb

@@ -0,0 +1,9 @@
+require "active_support/test_case"
+
+module SeedFixtures
+  autoload :VERSION, "seed_fixtures/version"
+  autoload :Core, "seed_fixtures/core"
+  autoload :Implementation, "seed_fixtures/implementation"
+end
+
+ActiveSupport::TestCase.include SeedFixtures::Core

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: seed_fixtures
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alex Ghiculescu
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+description:
+email:
+- alexghiculescu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/seed_fixtures.rb
+- lib/seed_fixtures/core.rb
+- lib/seed_fixtures/implementation.rb
+- lib/seed_fixtures/version.rb
+homepage: https://github.com/ghiculescu/seed-fixtures
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/ghiculescu/seed-fixtures/issues
+  changelog_uri: https://github.com/ghiculescu/seed-fixtures/releases
+  source_code_uri: https://github.com/ghiculescu/seed-fixtures
+  homepage_uri: https://github.com/ghiculescu/seed-fixtures
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Use seeds.rb as test fixtures
+test_files: []