fixtury 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 514698ec587a7323fdc0cb3c81c93dd9666e16c87d7f5f2aa867d1cd6ac95ee3
-  data.tar.gz: dd34ff54006e203bef96d6fce2c4c1dd2c97f9143d2d29d5e022c496600e0aff
+  metadata.gz: 03e33235b7dd547261eea486aee6d6ed0351157a11d1c76757d49b27c93b1b39
+  data.tar.gz: 8bd05c9be267d73b48b55fd7f20a4f6164ea22b41ba3ec889a8fd63026240e2c
 SHA512:
-  metadata.gz: 0d1b1f1222fb51994a2ce522fcdec21b8b7bb3198eaecac72d7924d59996e5f0200c00a90dca5dbc75efded7292f26593bff266844bfb41ffd8214d9f25ae469
-  data.tar.gz: e3bc71e4a40c3a40f12e23895e55cee83fa34b93d5db13e486c62a2e004671e64f775712dd71ba68ed4441de622ce667d2a43529ea2dacb47dafcfd3b1fb0119
+  metadata.gz: a1a4e6331284da0e92b6af11567dd8d8e35ac079ddb8029a2c10ddc42538bce1157964dd923dda9a42819aedfc765d7095711863714d2490ed05759090ee0bc4
+  data.tar.gz: fa19480c1a11de53003580bf1a328561c00b11922c2aaeb34925961e8ab2a173a0185cbbd9db4ff60735ea2d013da16c914ae7e4e4f7df706d86289f15fa69a2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fixtury (1.0.1)
+    fixtury (2.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -99,7 +99,7 @@ CHECKSUMS
   concurrent-ruby (1.3.4) sha256=d4aa926339b0a86b5b5054a0a8c580163e6f5dcbdfd0f4bb916b1a2570731c32
   connection_pool (2.4.1) sha256=0f40cf997091f1f04ff66da67eabd61a9fe0d4928b9a3645228532512fab62f4
   drb (2.2.1) sha256=e9d472bf785f558b96b25358bae115646da0dbfd45107ad858b0bc0d935cb340
-  fixtury (1.0.1)
+  fixtury (2.0.0)
   globalid (1.2.1) sha256=70bf76711871f843dbba72beb8613229a49429d1866828476f9c9d6ccc327ce9
   i18n (1.14.6) sha256=dc229a74f5d181f09942dd60ab5d6e667f7392c4ee826f35096db36d1fe3614c
   logger (1.6.4) sha256=b627b91c922231050932e7bf8ee886fe54790ba2238a468ead52ba21911f2ee7

data/README.md

@@ -21,7 +21,7 @@ class MyTest < ::Minitest::Test
 end
 ```
 
-Loading this file would ensure `users/fresh` is loaded into the fixture set before the suite is run. In the context of Minitest::Test, the Fixtury::MinitestHooks file will ensure the database records are present prior to your suite running. If you're using ActiveRecord `use_transactional_fixtures` and `use_transactional_tests` will be respected.
+Loading this file would ensure `users/fresh` is loaded into the fixture set before the suite is run. In the context of Minitest::Test, the Fixtury::MinitestHooks file will ensure the fixtures are present prior to your suite running.
 
 ## Configuration
 
@@ -109,3 +109,5 @@ end
 
 When installed with the railtie, a MutationObserver module is prepended into ActiveRecord::Base. It observes record mutations and ensures a record is not mutated outside of the declared isolation level. If you're not using ActiveRecord check out Fixtury::MutationObserver to see how you could hook into other frameworks.
 
+In your test suite when utilizing the Fixtury::MinitestHooks records will be loaded before ActiveRecord's transactional fixtures transaction is opened. This means the you can define all your fixtures in your tests, they will be prebuilt and, as long as the fixtury references are preserved, all your fixtures are cached across runs. The fixtures in each file are loaded on demand which means only the fixtures necessary for the test to run are prebuilt (and cached for reuse). Standard transactional fixture rollback occurs after each test run so any mutation to fixtures will not be persisted.
+

data/lib/fixtury/minitest_hooks.rb

@@ -7,8 +7,7 @@ module Fixtury
   # MinitestHooks is a module designed to hook into a Minitest test case, and
   # provide a way to load fixtures into the test case. It is designed to be
   # prepended into the test case class, and will automatically load fixtures
-  # before the test case is setup, and rollback any changes after the test
-  # case is torn down.
+  # before the test case is setup.
   #
   # The module also provides a way to define fixture dependencies, and will
   # automatically load those dependencies before the test case is setup.
@@ -44,14 +43,15 @@ module Fixtury
   #
   #   end
   #
+  # Use `as: false` if you do not want an accessor created.
+  #
   # A Set object named fixtury_dependencies is made available on the test class.
   # This allows you to load all Minitest runnables and analyze what fixtures are
   # needed. This is very helpful in CI pipelines when you want to prepare all fixtures
   # ahead of time to share between multiple processes.
   #
-  # The setup and teardown attempt to manage a transaction for each registered database
-  # connection if ActiveRecord::Base is present. If use_transaction_tests or use_transactional_fixtures
-  # are present, those settings will be respected. If neither are present, a transaction will be used.
+  # It is the responsibility of the suite to manage the snapshot or rollback of the database. Generally
+  # something like ActiveRecord's use_transactional_fixtures will work just fine.
   module MinitestHooks
 
     def self.prepended(klass)
@@ -67,8 +67,7 @@ module Fixtury
     module ClassMethods
 
       # Declare fixtury dependencies for this test case. This will automatically
-      # load the fixtures before the test case is setup, and rollback any changes
-      # after the test case is torn down.
+      # load the fixtures before the test case is setup.
       #
       # @param searches [Array<String>] A list of fixture names to load. These should be resolvable paths relative to Fixtury.schema (root).
       # @param opts [Hash] A list of options to customize the behavior of the fixtures.
@@ -115,12 +114,6 @@ module Fixtury
       super
     end
 
-    # Minitest after_teardown hook. This will rollback any changes made to the fixtures after the test.
-    def after_teardown(...)
-      super
-      fixtury_teardown if fixtury_dependencies.any?
-    end
-
     # Access a fixture via a search term. This will access the fixture from the Fixtury store.
     # If the fixture was not declared as a dependency, an error will be raised.
     #
@@ -138,44 +131,10 @@ module Fixtury
       Fixtury.store.get(dfn.pathname)
     end
 
-    # Retrieve all database connections that are currently registered with a writing role.
-    #
-    # @return [Array<ActiveRecord::ConnectionAdapters::AbstractAdapter>] The list of database connections.
-    def fixtury_database_connections
-      return [] unless defined?(ActiveRecord::Base)
-
-      pools = ActiveRecord::Base.connection_handler.connection_pool_list(:writing)
-      pools.map { |pool| pool.respond_to?(:lease_connection) ? pool.lease_connection : pool.connection }
-    end
-
     # Load all dependenct fixtures and begin a transaction for each database connection.
     def fixtury_setup
       Fixtury.store.clear_stale_references!
       fixtury_load_all_fixtures!
-      return unless fixtury_use_transactions?
-
-      fixtury_database_connections.each do |conn|
-        conn.begin_transaction joinable: false
-        if conn.pool.respond_to?(:lock_thread=)
-          conn.pool.lock_thread = true
-        elsif conn.pool.respond_to?(:pin_connection!)
-          conn.pool.pin_connection!(true)
-        end
-      end
-    end
-
-    # Rollback any changes made to the fixtures
-    def fixtury_teardown
-      return unless fixtury_use_transactions?
-
-      fixtury_database_connections.each do |conn|
-        conn.rollback_transaction if conn.open_transactions.positive?
-        if conn.pool.respond_to?(:lock_thread=)
-          conn.pool.lock_thread = false
-        elsif conn.pool.respond_to?(:unpin_connection!)
-          conn.pool.unpin_connection!
-        end
-      end
     end
 
     # Load all fixture dependencies that have not previously been loaded into the store.
@@ -190,13 +149,5 @@ module Fixtury
       end
     end
 
-    # Adhere to common Rails test transaction settings.
-    def fixtury_use_transactions?
-      return use_transactional_tests if respond_to?(:use_transactional_tests)
-      return use_transactional_fixtures if respond_to?(:use_transactional_fixtures)
-
-      true
-    end
-
   end
 end

data/lib/fixtury/version.rb

@@ -2,6 +2,6 @@
 
 module Fixtury
 
-  VERSION = "1.0.1"
+  VERSION = "2.0.0"
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fixtury
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Mike Nelson