fixtury 0.1.0.alpha → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73b1b15d6ac9941d265b535f8510cc2896eb4c3fc711af20339b045228e8a888
-  data.tar.gz: ca6171cdfc7c721a88dc6e4055db600e10897894295b40022e45e7a55c5c5497
+  metadata.gz: 7a4447982d6e785c9158850f3d158b07e1226f6a05d85917d41307c5455d41d9
+  data.tar.gz: c7fac4726892a1851ca7b7f0d3ff8abfe2bbedf4d2706b2c3ae6443d6be863f1
 SHA512:
-  metadata.gz: d892685cc0b8a4f54c09c188d1afc0dcc8928008f072c76bf18f0fed7ace0c49d194070d61b65dc4653c528b321f08e4ba3adb59cd2d33a192b4e3f984c09776
-  data.tar.gz: cceeab65fe5c416067a7be5ae8fd3c9dc65d73fcf5c812ffc89ba695d60fcae5790414baeea1e43d9c098279e8dddc8a87eede66f275eeb02bfaf11fb1c447f3
+  metadata.gz: 6c5858894f02eb54b555df7ee182e81e3741cbd278e37bbd0a3250b9cfea62a00341d3ff95a75adb0d5f56cfd3abcdb036877bee28601b87ff060c3e9bf6f43c
+  data.tar.gz: 0e99678f39920cd68026905ddd202ea8b9f9648c3bef9e941e7fd084fb2daa1ed843b5d2839fc10cbf13f1cc27c224ac212d7cd01173b2f3f8692706cadde2cb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fixtury (0.1.0.alpha)
+    fixtury (0.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -61,4 +61,4 @@ DEPENDENCIES
   sqlite
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/lib/fixtury/definition.rb

@@ -25,6 +25,8 @@ module Fixtury
     end
 
     def call(store: nil, execution_context: nil)
+      execution_context ||= ::Fixtury::ExecutionContext.new
+
       maybe_set_store_context(store: store) do
         value = run_callable(store: store, callable: callable, execution_context: execution_context, value: nil)
         enhancements.each do |e|
@@ -45,8 +47,6 @@ module Fixtury
     end
 
     def run_callable(store:, callable:, execution_context:, value:)
-      execution_context ||= self
-
       args = []
       args << value unless value.nil?
       if callable.arity > args.length
@@ -55,11 +55,24 @@ module Fixtury
         args << store
       end
 
-      if args.length.positive?
-        execution_context.instance_exec(*args, &callable)
+      execution_context_hooks(execution_context) do
+        if args.length.positive?
+          execution_context.instance_exec(*args, &callable)
+        else
+          execution_context.instance_eval(&callable)
+        end
+      end
+    end
+
+    def execution_context_hooks(execution_context)
+      execution_context.before_fixture(self) if execution_context.respond_to?(:before_fixture)
+      value = if execution_context.respond_to?(:around_fixture)
+        execution_context.around_fixture(self) { yield }
       else
-        execution_context.instance_eval(&callable)
+        yield
       end
+      execution_context.after_fixture(self, value) if execution_context.respond_to?(:after_fixture)
+      value
     end
 
   end

data/lib/fixtury/errors/circular_dependency_error.rb

@@ -5,7 +5,7 @@ module Fixtury
     class CircularDependencyError < ::StandardError
 
       def initialize(name)
-        super("One of the depdencies of #{name} is dependent on #{name}.")
+        super("One of the dependencies of #{name} is dependent on #{name}.")
       end
 
     end

data/lib/fixtury/execution_context.rb

@@ -4,5 +4,13 @@
 module Fixtury
   class ExecutionContext
 
+    def before_fixture(_dfn); end
+
+    def around_fixture(_dfn)
+      yield
+    end
+
+    def after_fixture(_dfn, _value); 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/reference.rb

@@ -1,6 +1,14 @@
+# frozen_string_literal: true
+
 module Fixtury
   class Reference
 
+    HOLDER_VALUE = "__BUILDING_FIXTURE__"
+
+    def self.holder(name)
+      new(name, HOLDER_VALUE)
+    end
+
     attr_reader :name, :value, :created_at
 
     def initialize(name, value)
@@ -9,5 +17,13 @@ module Fixtury
       @created_at = Time.now.to_i
     end
 
+    def holder?
+      value == HOLDER_VALUE
+    end
+
+    def real?
+      !holder?
+    end
+
   end
 end

data/lib/fixtury/schema.rb

@@ -67,7 +67,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
 

data/lib/fixtury/store.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "fileutils"
 require "singleton"
 require "yaml"
 require "fixtury/locator"
@@ -10,29 +11,36 @@ require "fixtury/reference"
 module Fixtury
   class Store
 
-    cattr_accessor :instance
+    LOG_LEVELS = {
+      (LOG_LEVEL_NONE = :none) => 0,
+      (LOG_LEVEL_INFO = :info) => 1,
+      (LOG_LEVEL_DEBUG = :debug) => 2,
+    }.freeze
 
-    HOLDER = "__BUILDING_FIXTURE__"
+    cattr_accessor :instance
 
     attr_reader :filepath, :references, :ttl, :auto_refresh_expired
     attr_reader :schema, :locator
-    attr_reader :verbose
+    attr_reader :log_level
     attr_reader :execution_context
 
     def initialize(
       filepath: nil,
       locator: ::Fixtury::Locator.instance,
-      verbose: false,
+      log_level: nil,
       ttl: nil,
       schema: nil,
+      execution_context: 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
+      @execution_context = execution_context || ::Fixtury::ExecutionContext.new
       @ttl = ttl ? ttl.to_i : ttl
       @auto_refresh_expired = !!auto_refresh_expired
       self.class.instance ||= self
@@ -41,15 +49,21 @@ module Fixtury
     def dump_to_file
       return unless filepath
 
-      ::File.open(filepath, "wb") { |io| io.write(references.to_yaml) }
+      ::FileUtils.mkdir_p(File.dirname(filepath))
+
+      writable = references.each_with_object({}) do |(full_name, ref), h|
+        h[full_name] = ref if ref.real?
+      end
+
+      ::File.open(filepath, "wb") { |io| io.write(writable.to_yaml) }
     end
 
     def clear_expired_references!
       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
@@ -59,7 +73,7 @@ module Fixtury
         get(dfn.name)
       end
 
-      schema.schemas.each_pair do |_key, ns|
+      schema.children.each_pair do |_key, ns|
         load_all(ns)
       end
     end
@@ -71,7 +85,7 @@ module Fixtury
       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
@@ -89,8 +103,8 @@ module Fixtury
       dfn = schema.get_definition!(name)
       full_name = dfn.name
       ref = references[full_name]
-      result = ref && ref != HOLDER
-      log { result ? "hit #{full_name}" : "miss #{full_name}" }
+      result = ref&.real?
+      log(level: LOG_LEVEL_DEBUG) { result ? "hit #{full_name}" : "miss #{full_name}" }
       result
     end
 
@@ -99,34 +113,34 @@ module Fixtury
       full_name = dfn.name
       ref = references[full_name]
 
-      if ref == HOLDER
+      if ref&.holder?
         raise ::Fixtury::Errors::CircularDependencyError, full_name
       end
 
-      if ref && auto_refresh_expired && ref_expired?(ref)
-        log { "refreshing #{full_name}" }
-        clear_ref(ref)
+      if ref && auto_refresh_expired && ref_invalid?(ref)
+        log(level: LOG_LEVEL_INFO) { "refreshing #{full_name}" }
+        clear_ref(full_name)
         ref = nil
       end
 
       value = nil
 
       if ref
-        log { "hit #{full_name}" }
+        log(level: LOG_LEVEL_DEBUG) { "hit #{full_name}" }
         value = load_ref(ref.value)
-        unless value
+        if value.nil?
           clear_ref(full_name)
-          log { "missing #{full_name}" }
+          log(level: LOG_LEVEL_DEBUG) { "missing #{full_name}" }
         end
       end
 
       if value.nil?
-        # set the references to HOLDER so any recursive behavior ends up hitting a circular dependency error if the same fixture load is attempted
-        references[full_name] = HOLDER
+        # set the references to a holder value so any recursive behavior ends up hitting a circular dependency error if the same fixture load is attempted
+        references[full_name] = ::Fixtury::Reference.holder(full_name)
 
         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)
@@ -149,16 +163,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/{hooks.rb → test_hooks.rb}

@@ -3,7 +3,7 @@
 require "fixtury/store"
 
 module Fixtury
-  module Hooks
+  module TestHooks
 
     extend ::ActiveSupport::Concern
 
@@ -18,15 +18,45 @@ module Fixtury
         self.fixtury_dependencies += names.flatten.compact.map(&:to_s)
       end
 
+      def define_fixture(name, &block)
+        fixture_name = name
+        namespace_names = self.name.underscore.split("/")
+
+        ns = ::Fixtury.schema
+
+        namespace_names.each do |ns_name|
+          ns = ns.namespace(ns_name){}
+        end
+
+        ns.fixture(fixture_name, &block)
+
+        fixtury("#{namespace_names.join("/")}/#{fixture_name}")
+      end
+
     end
 
     def fixtury(name)
-      raise ArgumentError unless self.fixtury_dependencies.include?(name.to_s)
+      return nil unless ::Fixtury::Store.instance
+
+      name = name.to_s
+
+      unless name.include?("/")
+        local_name = "#{self.class.name.underscore}/#{name}"
+        if self.fixtury_dependencies.include?(local_name)
+          return ::Fixtury::Store.instance.get(local_name)
+        end
+      end
+
+      unless self.fixtury_dependencies.include?(name)
+        raise ArgumentError, "Unrecognized fixtury dependency `#{name}` for #{self.class}"
+      end
 
       ::Fixtury::Store.instance.get(name)
     end
 
     def fixtury_loaded?(name)
+      return false unless ::Fixtury::Store.instance
+
       ::Fixtury::Store.instance.loaded?(name)
     end
 
@@ -70,6 +100,8 @@ module Fixtury
     end
 
     def clear_expired_fixtury_fixtures!
+      return unless ::Fixtury::Store.instance
+
       ::Fixtury::Store.instance.clear_expired_references!
     end
 

data/lib/fixtury/version.rb

@@ -2,6 +2,6 @@
 
 module Fixtury
 
-  VERSION = "0.1.0.alpha"
+  VERSION = "0.1.0"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fixtury
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha
+  version: 0.1.0
 platform: ruby
 authors:
 - Mike Nelson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-07 00:00:00.000000000 Z
+date: 2020-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: autotest
@@ -161,7 +161,6 @@ files:
 - 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: []
@@ -191,9 +191,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.6
 signing_key: