fixtury 0.1.0.beta2 → 0.3.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac77ba24e99d487806a96c58c7b5dd9c1c29e785976b41813622afb71a39448d
-  data.tar.gz: f5ecbc8dd03ba11b7634014ebab0d565c743d038b45b439971f14d7a062f1984
+  metadata.gz: 965698b591633e500ea9a84c99f860e333abc4b43670adda323a39f156834971
+  data.tar.gz: 05157e6800473b9eb4d9a34d5f72572726db3318e1e415b5c9307b243c94e524
 SHA512:
-  metadata.gz: 51cd55345dd84189bfcdb84142a97352873f7dbc2ed35672b26e5c06a42b5f09b42ffb8664a2f1a95eb48c7c73762d5090bb88819f175fab79e56e46e45abf42
-  data.tar.gz: 1766220dca1b16385d59d3c4de48ea8e378fa3faa994da7f65e986fb596d37795a3b3c8215ba8485eddbd9c3d77cae65e339633a362d0bda7c7c1cb480b4c455
+  metadata.gz: 8cfe05cd9ee47eb81c70247ef902870bebeaa563035ab19ae920646fcf0421483f13ab0efd23a3ee2e0293092a70be7259b4088a3fbf56ebaf585788c8160993
+  data.tar.gz: 96797ae9dbf6b4ccc6d9e3149be61dc5b4cc57d7b4baec2f9355aff35f89d0b6a3fc25b3f11fc2c7198eabeaed0298f97e51c49f96fadce6a13709bf493a845c

data/Gemfile.lock

@@ -1,26 +1,26 @@
 PATH
   remote: .
   specs:
-    fixtury (0.1.0.alpha2)
+    fixtury (0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.1)
+    activesupport (6.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
     ansi (1.5.0)
     autotest (5.0.0)
       minitest-autotest (~> 1.0)
     builder (3.2.3)
     byebug (11.0.1)
-    concurrent-ruby (1.1.5)
+    concurrent-ruby (1.1.6)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    i18n (1.7.0)
+    i18n (1.8.2)
       concurrent-ruby (~> 1.0)
     metaclass (0.0.4)
     minitest (5.13.0)
@@ -37,13 +37,13 @@ GEM
     mocha (1.8.0)
       metaclass (~> 0.0.1)
     path_expander (1.1.0)
-    rake (10.5.0)
+    rake (13.0.1)
     ruby-progressbar (1.10.1)
     sqlite (1.0.2)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    zeitwerk (2.2.2)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
@@ -57,7 +57,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   minitest-reporters
   mocha
-  rake (~> 10.0)
+  rake (~> 13.0)
   sqlite
 
 BUNDLED WITH

data/fixtury.gemspec

@@ -34,6 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "minitest-reporters"
   spec.add_development_dependency "mocha"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "sqlite"
 end

data/lib/fixtury.rb

@@ -7,7 +7,6 @@ require "fixtury/version"
 require "fixtury/schema"
 require "fixtury/locator"
 require "fixtury/store"
-require "fixtury/execution_context"
 
 module Fixtury
 

data/lib/fixtury/definition.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "fixtury/definition_executor"
+
 module Fixtury
   class Definition
 
@@ -24,42 +26,23 @@ module Fixtury
       @enhancements.any?
     end
 
-    def call(store: nil, execution_context: nil)
-      maybe_set_store_context(store: store) do
-        value = run_callable(store: store, callable: callable, execution_context: execution_context, value: nil)
-        enhancements.each do |e|
-          value = run_callable(store: store, callable: e, execution_context: execution_context, value: value)
-        end
-        value
-      end
+    def info
+      {
+        name: name,
+        loc: location_from_callable(callable),
+        enhancements: enhancements.map { |e| location_from_callable(e) },
+      }
     end
 
-    protected
-
-    def maybe_set_store_context(store:)
-      return yield unless store
-
-      store.with_relative_schema(schema) do
-        yield
-      end
+    def call(store: nil, execution_context: nil)
+      executor = ::Fixtury::DefinitionExecutor.new(store: store, definition: self, execution_context: execution_context)
+      executor.__call
     end
 
-    def run_callable(store:, callable:, execution_context:, value:)
-      execution_context ||= self
-
-      args = []
-      args << value unless value.nil?
-      if callable.arity > args.length
-        raise ArgumentError, "A store store must be provided if the definition expects it." unless store
-
-        args << store
-      end
+    def location_from_callable(callable)
+      return nil unless callable.respond_to?(:source_location)
 
-      if args.length.positive?
-        execution_context.instance_exec(*args, &callable)
-      else
-        execution_context.instance_eval(&callable)
-      end
+      callable.source_location.join(":")
     end
 
   end

data/lib/fixtury/definition_executor.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Fixtury
+  class DefinitionExecutor
+
+    attr_reader :value, :execution_type, :definition, :store, :execution_context
+
+    def initialize(store: nil, execution_context: nil, definition:)
+      @store = store
+      @definition = definition
+      @execution_context = execution_context
+      @execution_type = nil
+      @value = nil
+    end
+
+    def __call
+      maybe_set_store_context do
+        provide_schema_hooks do
+          run_callable(callable: definition.callable, type: :definition)
+          definition.enhancements.each do |e|
+            run_callable(callable: e, type: :enhancement)
+          end
+        end
+      end
+
+      value
+    end
+
+    def get(name)
+      raise ArgumentError, "A store is required for #{definition.name}" unless store
+
+      store.get(name, execution_context: execution_context)
+    end
+    alias [] get
+
+    def method_missing(method_name, *args, &block)
+      return super unless execution_context
+
+      execution_context.send(method_name, *args, &block)
+    end
+
+    def respond_to_missing?(method_name)
+      return super unless execution_context
+
+      execution_context.respond_to?(method_name, true)
+    end
+
+    private
+
+    def run_callable(callable:, type:)
+      @execution_type = type
+
+      @value = if callable.arity.positive?
+        instance_exec(self, &callable)
+      else
+        instance_eval(&callable)
+      end
+    end
+
+    def maybe_set_store_context
+      return yield unless store
+
+      store.with_relative_schema(definition.schema) do
+        yield
+      end
+    end
+
+    def provide_schema_hooks
+      return yield unless definition.schema
+
+      @value = definition.schema.around_fixture_hook(self) do
+        yield
+        value
+      end
+    end
+
+  end
+end

data/lib/fixtury/locator.rb

@@ -24,6 +24,12 @@ module Fixtury
       @backend = backend
     end
 
+    def recognize?(ref)
+      raise ArgumentError, "Unable to recognize a nil ref" if ref.nil?
+
+      backend.recognized_reference?(ref)
+    end
+
     def load(ref)
       raise ArgumentError, "Unable to load a nil ref" if ref.nil?
 

data/lib/fixtury/schema.rb

@@ -9,16 +9,37 @@ require "fixtury/errors/schema_frozen_error"
 module Fixtury
   class Schema
 
-    attr_reader :definitions, :children, :name, :parent, :relative_name
+    attr_reader :definitions, :children, :name, :parent, :relative_name, :around_fixture_definition
 
     def initialize(parent:, name:)
       @name = name
       @parent = parent
       @relative_name = @name.split("/").last
+      @around_fixture_definition = nil
       @frozen = false
       reset!
     end
 
+    def around_fixture(&block)
+      @around_fixture_definition = block
+    end
+
+    def around_fixture_hook(executor, &definition)
+      maybe_invoke_parent_around_fixture_hook(executor) do
+        if around_fixture_definition.nil?
+          yield
+        else
+          around_fixture_definition.call(executor, definition)
+        end
+      end
+    end
+
+    def maybe_invoke_parent_around_fixture_hook(executor, &block)
+      return yield unless parent
+
+      parent.around_fixture_hook(executor, &block)
+    end
+
     def reset!
       @children = {}
       @definitions = {}
@@ -67,7 +88,7 @@ module Fixtury
       ensure_no_conflict!(name: name, definitions: true, namespaces: false)
 
       child = find_or_create_child_schema(name: name)
-      child.instance_eval(&block)
+      child.instance_eval(&block) if block_given?
       child
     end
 
@@ -99,6 +120,8 @@ module Fixtury
         end
       end
 
+      around_fixture(&other_ns.around_fixture_definition) if other_ns.around_fixture_definition
+
       self
     end
 
@@ -172,6 +195,7 @@ module Fixtury
           self.class.new(name: child_name, parent: self)
         end
       end
+      child
     end
 
     def find_child_definition(name:)
@@ -187,7 +211,7 @@ module Fixtury
     def build_child_name(name:)
       name = name&.to_s
       raise ArgumentError, "`name` must be provided" if name.nil?
-      raise ArgumentError, "#{name} is invalid. `name` must contain only a-z, A-Z, 0-9, and _." unless name.match(/^[a-zA-Z_0-9]+$/)
+      raise ArgumentError, "#{name} is invalid. `name` must contain only a-z, A-Z, 0-9, and _." unless /^[a-zA-Z_0-9]+$/.match?(name)
 
       arr = ["", self.name, name]
       arr.join("/").gsub(%r{/{2,}}, "/")

data/lib/fixtury/store.rb

@@ -5,33 +5,38 @@ require "singleton"
 require "yaml"
 require "fixtury/locator"
 require "fixtury/errors/circular_dependency_error"
-require "fixtury/execution_context"
 require "fixtury/reference"
 
 module Fixtury
   class Store
 
+    LOG_LEVELS = {
+      (LOG_LEVEL_NONE = :none) => 0,
+      (LOG_LEVEL_INFO = :info) => 1,
+      (LOG_LEVEL_DEBUG = :debug) => 2,
+    }.freeze
+
     cattr_accessor :instance
 
     attr_reader :filepath, :references, :ttl, :auto_refresh_expired
     attr_reader :schema, :locator
-    attr_reader :verbose
-    attr_reader :execution_context
+    attr_reader :log_level
 
     def initialize(
       filepath: nil,
       locator: ::Fixtury::Locator.instance,
-      verbose: false,
+      log_level: nil,
       ttl: nil,
       schema: nil,
       auto_refresh_expired: false
     )
       @schema = schema || ::Fixtury.schema
-      @verbose = verbose
+      @log_level = log_level.nil? ? ENV["FIXTURY_LOG_LEVEL"] : log_level
+      @log_level ||= LOG_LEVEL_NONE
+      @log_level = @log_level.to_s.to_sym
       @locator = locator
       @filepath = filepath
       @references = @filepath && ::File.file?(@filepath) ? ::YAML.load_file(@filepath) : {}
-      @execution_context = ::Fixtury::ExecutionContext.new
       @ttl = ttl ? ttl.to_i : ttl
       @auto_refresh_expired = !!auto_refresh_expired
       self.class.instance ||= self
@@ -53,8 +58,8 @@ module Fixtury
       return unless ttl
 
       references.delete_if do |name, ref|
-        is_expired = ref_expired?(ref)
-        log { "expiring #{name}" } if is_expired
+        is_expired = ref_invalid?(ref)
+        log(level: LOG_LEVEL_INFO) { "expiring #{name}" } if is_expired
         is_expired
       end
     end
@@ -72,11 +77,11 @@ module Fixtury
     def clear_cache!(pattern: nil)
       pattern ||= "*"
       pattern = "/" + pattern unless pattern.start_with?("/")
-      glob = pattern.ends_with?("*")
+      glob = pattern.end_with?("*")
       pattern = pattern[0...-1] if glob
       references.delete_if do |key, _value|
         hit = glob ? key.start_with?(pattern) : key == pattern
-        log(true) { "clearing #{key}" } if hit
+        log(level: LOG_LEVEL_INFO) { "clearing #{key}" } if hit
         hit
       end
       dump_to_file
@@ -95,11 +100,11 @@ module Fixtury
       full_name = dfn.name
       ref = references[full_name]
       result = ref&.real?
-      log { result ? "hit #{full_name}" : "miss #{full_name}" }
+      log(level: LOG_LEVEL_DEBUG) { result ? "hit #{full_name}" : "miss #{full_name}" }
       result
     end
 
-    def get(name)
+    def get(name, execution_context: nil)
       dfn = schema.get_definition!(name)
       full_name = dfn.name
       ref = references[full_name]
@@ -108,8 +113,8 @@ module Fixtury
         raise ::Fixtury::Errors::CircularDependencyError, full_name
       end
 
-      if ref && auto_refresh_expired && ref_expired?(ref)
-        log { "refreshing #{full_name}" }
+      if ref && auto_refresh_expired && ref_invalid?(ref)
+        log(level: LOG_LEVEL_INFO) { "refreshing #{full_name}" }
         clear_ref(full_name)
         ref = nil
       end
@@ -117,11 +122,11 @@ module Fixtury
       value = nil
 
       if ref
-        log { "hit #{full_name}" }
+        log(level: LOG_LEVEL_DEBUG) { "hit #{full_name}" }
         value = load_ref(ref.value)
         if value.nil?
           clear_ref(full_name)
-          log { "missing #{full_name}" }
+          log(level: LOG_LEVEL_DEBUG) { "missing #{full_name}" }
         end
       end
 
@@ -131,7 +136,7 @@ module Fixtury
 
         value = dfn.call(store: self, execution_context: execution_context)
 
-        log { "store #{full_name}" }
+        log(level: LOG_LEVEL_INFO) { "store #{full_name}" }
 
         ref = dump_ref(full_name, value)
         ref = ::Fixtury::Reference.new(full_name, ref)
@@ -154,16 +159,20 @@ module Fixtury
       references.delete(name)
     end
 
-    def ref_expired?(ref)
-      return false unless ttl
+    def ref_invalid?(ref)
+      return true if ttl && ref.created_at < (Time.now.to_i - ttl)
 
-      ref.created_at < (Time.now.to_i - ttl)
+      !locator.recognize?(ref.value)
     end
 
-    def log(local_verbose = false, &block)
-      return unless verbose || local_verbose
+    def log(level: LOG_LEVEL_DEBUG, name: "store")
+      desired_level = LOG_LEVELS.fetch(log_level) { LOG_LEVEL_NONE }
+      return if desired_level == LOG_LEVEL_NONE
+
+      message_level = LOG_LEVELS.fetch(level) { LOG_LEVEL_DEBUG }
+      return unless desired_level >= message_level
 
-      puts "[fixtury|store] #{block.call}"
+      puts "[fixtury|#{name}] #{yield}"
     end
 
   end

data/lib/fixtury/test_hooks.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+require "fixtury/store"
+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
+    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 = name.underscore
+
+          ns = ::Fixtury.schema
+
+          namespace.split("/").each do |ns_name|
+            ns = ns.namespace(ns_name){}
+          end
+
+          names.each do |fixture_name|
+            ns.fixture(fixture_name, &definition)
+            self.fixtury_dependencies += ["#{namespace}/#{fixture_name}"]
+          end
+
+        # otherwise, just record the dependency
+        else
+          self.fixtury_dependencies += names.flatten.compact.map(&:to_s)
+        end
+
+        accessor_option = opts.key?(:accessor) ? opts[:accessor] : true
+
+        if accessor_option
+
+          if accessor_option != true && names.length > 1
+            raise ArgumentError, "A named :accessor 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}"
+
+            class_eval <<-EV, __FILE__, __LINE__ + 1
+              def #{method_name}
+                return #{ivar} if defined?(#{ivar})
+
+                value = fixtury("#{fixture_name}")
+                #{ivar} = value
+              end
+            EV
+          end
+        end
+      end
+
+    end
+
+    def fixtury(name)
+      return nil unless fixtury_store
+
+      name = name.to_s
+
+      unless name.include?("/")
+        local_name = "#{self.class.name.underscore}/#{name}"
+        if self.fixtury_dependencies.include?(local_name)
+          return fixtury_store.get(local_name, execution_context: self)
+        end
+      end
+
+      unless self.fixtury_dependencies.include?(name)
+        raise ArgumentError, "Unrecognized fixtury dependency `#{name}` for #{self.class}"
+      end
+
+      fixtury_store.get(name, execution_context: self)
+    end
+
+    def fixtury_store
+      ::Fixtury::Store.instance
+    end
+
+    def fixtury_loaded?(name)
+      return false unless fixtury_store
+
+      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?
+        setup_fixtury_fixtures
+      else
+        super
+      end
+    end
+
+    # piggybacking activerecord fixture setup for now.
+    def teardown_fixtures(*args)
+      if fixtury_dependencies.any?
+        teardown_fixtury_fixtures
+      else
+        super
+      end
+    end
+
+    def setup_fixtury_fixtures
+      return unless use_transactional_fixtures
+
+      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
+      return unless use_transactional_fixtures
+
+      fixtury_database_connections.each(&:rollback_transaction)
+    end
+
+    def clear_expired_fixtury_fixtures!
+      return unless fixtury_store
+
+      fixtury_store.clear_expired_references!
+    end
+
+    def load_all_fixtury_fixtures!
+      fixtury_dependencies.each do |name|
+        fixtury(name) unless fixtury_loaded?(name)
+      end
+    end
+
+  end
+end

data/lib/fixtury/version.rb

@@ -2,6 +2,6 @@
 
 module Fixtury
 
-  VERSION = "0.1.0.beta2"
+  VERSION = "0.3.0.beta"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fixtury
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta2
+  version: 0.3.0.beta
 platform: ruby
 authors:
 - Mike Nelson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2020-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: autotest
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: sqlite
   requirement: !ruby/object:Gem::Requirement
@@ -155,13 +155,12 @@ files:
 - fixtury.gemspec
 - 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/schema_frozen_error.rb
 - lib/fixtury/errors/unrecognizable_locator_error.rb
-- lib/fixtury/execution_context.rb
-- lib/fixtury/hooks.rb
 - lib/fixtury/locator.rb
 - lib/fixtury/locator_backend/common.rb
 - lib/fixtury/locator_backend/globalid.rb
@@ -172,6 +171,7 @@ files:
 - lib/fixtury/schema.rb
 - lib/fixtury/store.rb
 - lib/fixtury/tasks.rake
+- lib/fixtury/test_hooks.rb
 - lib/fixtury/version.rb
 homepage: https://github.com/guideline-tech/fixtury
 licenses: []

data/lib/fixtury/execution_context.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-# a class made available so helper methods can be provided within the fixture dsl
-module Fixtury
-  class ExecutionContext
-
-  end
-end

data/lib/fixtury/hooks.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-require "fixtury/store"
-
-module Fixtury
-  module Hooks
-
-    extend ::ActiveSupport::Concern
-
-    included do
-      class_attribute :fixtury_dependencies
-      self.fixtury_dependencies = Set.new
-    end
-
-    module ClassMethods
-
-      def fixtury(*names)
-        self.fixtury_dependencies += names.flatten.compact.map(&:to_s)
-      end
-
-    end
-
-    def fixtury(name)
-      raise ArgumentError unless self.fixtury_dependencies.include?(name.to_s)
-      return nil unless ::Fixtury::Store.instance
-
-      ::Fixtury::Store.instance.get(name)
-    end
-
-    def fixtury_loaded?(name)
-      return false unless ::Fixtury::Store.instance
-
-      ::Fixtury::Store.instance.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?
-        setup_fixtury_fixtures
-      else
-        super
-      end
-    end
-
-    # piggybacking activerecord fixture setup for now.
-    def teardown_fixtures(*args)
-      if fixtury_dependencies.any?
-        teardown_fixtury_fixtures
-      else
-        super
-      end
-    end
-
-    def setup_fixtury_fixtures
-      return unless use_transactional_fixtures
-
-      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
-      return unless use_transactional_fixtures
-
-      fixtury_database_connections.each(&:rollback_transaction)
-    end
-
-    def clear_expired_fixtury_fixtures!
-      return unless ::Fixtury::Store.instance
-
-      ::Fixtury::Store.instance.clear_expired_references!
-    end
-
-    def load_all_fixtury_fixtures!
-      fixtury_dependencies.each do |name|
-        fixtury(name) unless fixtury_loaded?(name)
-      end
-    end
-
-  end
-end