fixtury 0.4.1 → 1.0.0.beta1

data/lib/fixtury/test_hooks.rb

@@ -1,159 +1,130 @@
 # frozen_string_literal: true
 
-require "fixtury/store"
+require "fixtury"
 require "active_support/core_ext/class/attribute"
 
 module Fixtury
   module TestHooks
 
-    extend ::ActiveSupport::Concern
-
-    included do
-      class_attribute :fixtury_dependencies
-      self.fixtury_dependencies = Set.new
+    def self.prepended(klass)
+      klass.class_attribute :fixtury_dependencies
+      klass.fixtury_dependencies = Set.new
+      klass.extend ClassMethods
+    end
 
-      class_attribute :local_fixtury_dependencies
-      self.local_fixtury_dependencies = Set.new
+    def self.included(klass)
+      raise ArgumentError, "#{name} should be prepended, not included"
     end
 
     module ClassMethods
 
-      def fixtury(*names, &definition)
-        opts = names.extract_options!
-
-        # define fixtures if blocks are given
-        if block_given?
-          raise ArgumentError, "A fixture cannot be defined in an anonymous class" if name.nil?
-
-          namespace = fixtury_namespace
-
-          ns = ::Fixtury.schema
-
-          namespace.split("/").each do |ns_name|
-            ns = ns.namespace(ns_name){}
-          end
+      def fixtury_store
+        ::Fixtury.store
+      end
 
-          names.map! do |fixture_name|
-            ns.fixture(fixture_name, &definition)
-            new_name = "/#{namespace}/#{fixture_name}"
-            self.local_fixtury_dependencies += [new_name]
-            new_name
-          end
+      def fixtury_schema
+        ::Fixtury.schema
+      end
 
-        # otherwise, just record the dependency
-        else
-          self.fixtury_dependencies += names.flatten.compact.map(&:to_s)
+      def fixtury(*searches, **opts)
+        pathnames = searches.map do |search|
+          dfn = fixtury_schema.get!(search)
+          dfn.pathname
         end
 
+        self.fixtury_dependencies += pathnames
+
         accessor_option = opts[:as]
         accessor_option = opts[:accessor] if accessor_option.nil? # old version, backwards compatability
         accessor_option = accessor_option.nil? ? true : accessor_option
 
         if accessor_option
 
-          if accessor_option != true && names.length > 1
+          if accessor_option != true && pathnames.length > 1
             raise ArgumentError, "A named :as option is only available when providing one fixture"
           end
 
-          names.each do |fixture_name|
-            method_name = accessor_option == true ? fixture_name.split("/").last : accessor_option
-            ivar = :"@#{method_name}"
+          pathnames.each do |pathname|
+            method_name = (accessor_option == true ? pathname.split("/").last : accessor_option).to_sym
+
+            if method_defined?(method_name)
+              raise ArgumentError, "A method by the name of #{method_name} already exists in #{self}"
+            end
+
+            ivar = :"@fixtury_#{method_name}"
 
             class_eval <<-EV, __FILE__, __LINE__ + 1
               def #{method_name}
                 return #{ivar} if defined?(#{ivar})
 
-                value = fixtury("#{fixture_name}")
-                #{ivar} = value
+                #{ivar} = fixtury("#{pathname}")
               end
             EV
           end
         end
       end
 
-      def fixtury_namespace
-        name.underscore
-      end
+    end
 
+    def before_setup(...)
+      fixtury_setup if fixtury_dependencies.any?
+      super
     end
 
-    def fixtury(name)
-      return nil unless fixtury_store
+    def after_teardown(...)
+      super
+      fixtury_teardown if fixtury_dependencies.any?
+    end
 
-      name = name.to_s
 
-      # in the case that we're looking for a relative fixture, see if it's registered relative to the test's namespace.
-      unless name.include?("/")
-        local_name = "/#{self.class.fixtury_namespace}/#{name}"
-        if local_fixtury_dependencies.include?(local_name)
-          return fixtury_store.get(local_name, execution_context: self)
-        end
-      end
+    def fixtury(name)
+      return nil unless self.class.fixtury_store
 
-      unless fixtury_dependencies.include?(name) || local_fixtury_dependencies.include?(name)
-        raise ArgumentError, "Unrecognized fixtury dependency `#{name}` for #{self.class}"
-      end
+      dfn = self.class.fixtury_schema.get!(name)
 
-      fixtury_store.get(name, execution_context: self)
-    end
+      unless fixtury_dependencies.include?(dfn.pathname)
+        raise Errors::UnknownTestDependencyError, "Unrecognized fixtury dependency `#{dfn.pathname}` for #{self.class}"
+      end
 
-    def fixtury_store
-      ::Fixtury::Store.instance
+      self.class.fixtury_store.get(dfn.pathname)
     end
 
     def fixtury_loaded?(name)
-      return false unless fixtury_store
+      return false unless self.class.fixtury_store
 
-      fixtury_store.loaded?(name)
+      self.class.fixtury_store.loaded?(name)
     end
 
     def fixtury_database_connections
-      ActiveRecord::Base.connection_handler.connection_pool_list.map(&:connection)
-    end
-
-    # piggybacking activerecord fixture setup for now.
-    def setup_fixtures(*args)
-      if fixtury_dependencies.any? || local_fixtury_dependencies.any?
-        setup_fixtury_fixtures
-      else
-        super
-      end
-    end
-
-    # piggybacking activerecord fixture setup for now.
-    def teardown_fixtures(*args)
-      if fixtury_dependencies.any? || local_fixtury_dependencies.any?
-        teardown_fixtury_fixtures
-      else
-        super
-      end
+      ActiveRecord::Base.connection_handler.connection_pool_list(:writing).map(&:connection)
     end
 
-    def setup_fixtury_fixtures
+    def fixtury_setup
+      fixtury_clear_stale_fixtures!
+      fixtury_load_all_fixtures!
       return unless fixtury_use_transactions?
 
-      clear_expired_fixtury_fixtures!
-      load_all_fixtury_fixtures!
-
       fixtury_database_connections.each do |conn|
         conn.begin_transaction joinable: false
       end
     end
 
-    def teardown_fixtury_fixtures
+    def fixtury_teardown
       return unless fixtury_use_transactions?
 
-      fixtury_database_connections.each(&:rollback_transaction)
+      fixtury_database_connections.each do |conn|
+        conn.rollback_transaction if conn.open_transactions.positive?
+      end
     end
 
-    def clear_expired_fixtury_fixtures!
-      return unless fixtury_store
+    def fixtury_clear_stale_fixtures!
+      return unless self.class.fixtury_store
 
-      fixtury_store.clear_expired_references!
+      self.class.fixtury_store.clear_stale_references!
     end
 
-    def load_all_fixtury_fixtures!
-      (fixtury_dependencies | local_fixtury_dependencies).each do |name|
+    def fixtury_load_all_fixtures!
+      fixtury_dependencies.each do |name|
         unless fixtury_loaded?(name)
           ::Fixtury.log("preloading #{name.inspect}", name: "test", level: ::Fixtury::LOG_LEVEL_INFO)
           fixtury(name)

data/lib/fixtury/version.rb

@@ -2,6 +2,6 @@
 
 module Fixtury
 
-  VERSION = "0.4.1"
+  VERSION = "1.0.0.beta1"
 
 end

data/lib/fixtury.rb

@@ -1,14 +1,32 @@
 # frozen_string_literal: true
 
 require "active_support/concern"
+require "active_support/core_ext/array/extract_options"
 require "active_support/core_ext/module/attribute_accessors"
 require "active_support/core_ext/module/delegation"
+require "active_support/core_ext/object/acts_like"
+require "active_support/core_ext/object/blank"
+
 require "fixtury/version"
-require "fixtury/schema"
+
+require "fixtury/definition_executor"
+require "fixtury/dependency"
+require "fixtury/dependency_store"
+require "fixtury/errors"
+require "fixtury/hooks"
 require "fixtury/locator"
+require "fixtury/path_resolver"
+require "fixtury/reference"
 require "fixtury/store"
 
-# Top level namespace of the gem
+require "fixtury/schema_node"
+require "fixtury/definition"
+require "fixtury/schema"
+
+
+# Top level namespace of the gem. The accessors provided on the Fixtury namespace are meant to be shared
+# across the entire application. The Fixtury::Schema instance is the primary interface for defining and
+# accessing fixtures and can be accessed via Fixtury.schema.
 module Fixtury
 
   LOG_LEVELS = {
@@ -26,10 +44,28 @@ module Fixtury
     schema
   end
 
+  # Global hooks accessor. Fixtury will call these hooks at various points in the lifecycle of a fixture or setup.
+  def self.hooks
+    @hooks ||= ::Fixtury::Hooks.new
+  end
+
   # The default top level schema. Fixtury::Schema instances can be completely self-contained but most
   # usage would be through this shared definition.
   def self.schema
-    @schema ||= ::Fixtury::Schema.new(parent: nil, name: "")
+    @schema ||= ::Fixtury::Schema.new
+  end
+
+  def self.schema=(schema)
+    @schema = schema
+  end
+
+  # Default store for fixtures. This is a shared store that can be used across the application.
+  def self.store
+    @store ||= ::Fixtury::Store.new(schema: schema)
+  end
+
+  def self.store=(store)
+    @store = store
   end
 
   def self.log_level
@@ -41,7 +77,7 @@ module Fixtury
     @log_level
   end
 
-  def self.log(text = nil, level: LOG_LEVEL_DEBUG, name: nil)
+  def self.log(text = nil, level: LOG_LEVEL_DEBUG, name: nil, newline: true)
     desired_level = LOG_LEVELS.fetch(log_level) { DEFAULT_LOG_LEVEL }
     return if desired_level == LOG_LEVEL_NONE
 
@@ -53,7 +89,10 @@ module Fixtury
     msg << "]"
     msg << " #{text}" if text
     msg << " #{yield}" if block_given?
-    puts msg
+    msg << "\n" if newline
+
+    print msg
+    msg
   end
 
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: fixtury
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 1.0.0.beta1
 platform: ruby
 authors:
 - Mike Nelson
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-05 00:00:00.000000000 Z
+date: 2024-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: autotest
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,21 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: globalid
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: globalid
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,21 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: m
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -112,18 +112,18 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,7 +136,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - mike@guideline.com
 executables: []
@@ -156,20 +156,20 @@ files:
 - lib/fixtury.rb
 - lib/fixtury/definition.rb
 - lib/fixtury/definition_executor.rb
-- lib/fixtury/errors/already_defined_error.rb
-- lib/fixtury/errors/circular_dependency_error.rb
-- lib/fixtury/errors/fixture_not_defined_error.rb
-- lib/fixtury/errors/option_collision_error.rb
-- lib/fixtury/errors/schema_frozen_error.rb
-- lib/fixtury/errors/unrecognizable_locator_error.rb
+- lib/fixtury/dependency.rb
+- lib/fixtury/dependency_store.rb
+- lib/fixtury/errors.rb
+- lib/fixtury/hooks.rb
 - lib/fixtury/locator.rb
 - lib/fixtury/locator_backend/common.rb
 - lib/fixtury/locator_backend/globalid.rb
 - lib/fixtury/locator_backend/memory.rb
-- lib/fixtury/path.rb
+- lib/fixtury/mutation_observer.rb
+- lib/fixtury/path_resolver.rb
 - lib/fixtury/railtie.rb
 - lib/fixtury/reference.rb
 - lib/fixtury/schema.rb
+- lib/fixtury/schema_node.rb
 - lib/fixtury/store.rb
 - lib/fixtury/tasks.rake
 - lib/fixtury/test_hooks.rb
@@ -181,7 +181,7 @@ metadata:
   homepage_uri: https://github.com/guideline-tech/fixtury
   source_code_uri: https://github.com/guideline-tech/fixtury
   changelog_uri: https://github.com/guideline-tech/fixtury
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -196,8 +196,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.5.6
+signing_key:
 specification_version: 4
 summary: Treat fixtures like factories and factories like fixtures
 test_files: []

data/lib/fixtury/errors/already_defined_error.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Fixtury
-  module Errors
-    class AlreadyDefinedError < ::StandardError
-
-      def initialize(name)
-        super("An element identified by `#{name}` already exists.")
-      end
-
-    end
-  end
-end

data/lib/fixtury/errors/circular_dependency_error.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Fixtury
-  module Errors
-    class CircularDependencyError < ::StandardError
-
-      def initialize(name)
-        super("One of the dependencies of #{name} is dependent on #{name}.")
-      end
-
-    end
-  end
-end

data/lib/fixtury/errors/fixture_not_defined_error.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Fixtury
-  module Errors
-    class FixtureNotDefinedError < ::StandardError
-
-      def initialize(name)
-        super("A fixture identified by `#{name}` does not exist.")
-      end
-
-    end
-  end
-end

data/lib/fixtury/errors/option_collision_error.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Fixtury
-  module Errors
-    class OptionCollisionError < ::StandardError
-
-      def initialize(schema_name, option_key, old_value, new_value)
-        super("The #{schema_name.inspect} schema #{option_key.inspect} option value of #{old_value.inspect} conflicts with the new value #{new_value.inspect}.")
-      end
-
-    end
-  end
-end

data/lib/fixtury/errors/schema_frozen_error.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Fixtury
-  module Errors
-    class SchemaFrozenError < ::StandardError
-
-      def initialize
-        super("Schema is frozen. New namespaces, definitions, and enhancements are not allowed.")
-      end
-
-    end
-  end
-end

data/lib/fixtury/errors/unrecognizable_locator_error.rb

@@ -1,11 +0,0 @@
-module Fixtury
-  module Errors
-    class UnrecognizableLocatorError < ::StandardError
-
-      def initialize(action, thing)
-        super("Locator did not reognize #{thing} during #{action}")
-      end
-
-    end
-  end
-end

data/lib/fixtury/path.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Fixtury
-  class Path
-
-    def initialize(namespace:, path:)
-      @namespace = namespace.to_s
-      @path = path.to_s
-      @full_path = (
-        @path.start_with?("/") ?
-        @path :
-        File.expand_path(::File.join(@namespace, @path), "/")
-      )
-      @segments = @full_path.split("/")
-    end
-
-    def top_level_namespace
-      return "" if @segments.size == 1
-
-      @segments.first
-    end
-
-    def relative?
-      @path.start_with?(".")
-    end
-
-    def possible_absolute_paths
-      @possible_absolute_paths ||= begin
-        out = [@full_path]
-        out << @path unless relative?
-        out
-      end
-    end
-
-  end
-end