fixtury 0.1.0.beta → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c10251ee2040482092e648cbc213a75973795905fb754997cfb20976cc38e27
-  data.tar.gz: 8df04d1c19509a793a8450959672cce0c8fcb5c80d50ea868fcb6a77c400a822
+  metadata.gz: 9090092db55914068c6478939047d638ee8bb678ee53a41f0d36380bf2df7dea
+  data.tar.gz: 4e58164635a72d63e059a5622b1c867556235ba09537e127b5498f94a3bf8e60
 SHA512:
-  metadata.gz: 27632388a2ad2432b194f8241986f3d2f4aaf7a6fb4c902be2341ffbec8522abe77485b8d2fed4ab0f70f302158ab29d9d110987a496ce151a021623e49f85b3
-  data.tar.gz: cbd8e9dda57f5d2d6243d171fd25e6a207b4a5ede455dab3230593a1a525b6ee3596090d36d6da9809c007264651a7f53e278a05e05b1806bb7f0d7611532103
+  metadata.gz: 05e1ddd158beafe83cbe9e9d32abf10a49dcdb59709cc372f31a29a1a52c3eafe0b802eba8015ccdb429444678d94941db42dedb6202396b958c8d53d2e6f9d2
+  data.tar.gz: 70e2abc1abc6324e3523631a6f2caf936d0b0859eeb14b41fec843b766bf648d047b1e09e9d9bb6da60131f06be23e7e02c1adcf86be30910387581b7e191d3e

data/Gemfile.lock

@@ -1,26 +1,26 @@
 PATH
   remote: .
   specs:
-    fixtury (0.1.0.alpha2)
+    fixtury (0.2.1)
 
 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

@@ -44,9 +44,7 @@ module Fixtury
       end
     end
 
-    def run_callable(store:, callable:, execution_context:, value:)
-      execution_context ||= self
-
+    def run_callable(store:, callable:, execution_context: nil, value:)
       args = []
       args << value unless value.nil?
       if callable.arity > args.length
@@ -55,11 +53,26 @@ module Fixtury
         args << store
       end
 
-      if args.length.positive?
-        execution_context.instance_exec(*args, &callable)
+      provide_execution_context_hooks(execution_context) do |ctxt|
+        if args.length.positive?
+          ctxt.instance_exec(*args, &callable)
+        else
+          ctxt.instance_eval(&callable)
+        end
+      end
+    end
+
+    def provide_execution_context_hooks(execution_context)
+      return yield self unless 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 execution_context }
       else
-        execution_context.instance_eval(&callable)
+        yield execution_context
       end
+      execution_context.after_fixture(self, value) if execution_context.respond_to?(:after_fixture)
+      value
     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

@@ -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

@@ -5,33 +5,41 @@ 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 :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
       @ttl = ttl ? ttl.to_i : ttl
       @auto_refresh_expired = !!auto_refresh_expired
       self.class.instance ||= self
@@ -53,8 +61,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 +80,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,7 +103,7 @@ 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
 
@@ -108,8 +116,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 +125,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 +139,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 +162,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,148 @@
+# 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
+
+        if opts[:accessor]
+
+          if opts[:accessor] != 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 = opts[:accessor] == true ? fixture_name.split("/").last : opts[:accessor]
+            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)
+        end
+      end
+
+      unless self.fixtury_dependencies.include?(name)
+        raise ArgumentError, "Unrecognized fixtury dependency `#{name}` for #{self.class}"
+      end
+
+      fixtury_store.get(name)
+    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.beta"
+  VERSION = "0.2.1"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fixtury
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta
+  version: 0.2.1
 platform: ruby
 authors:
 - Mike Nelson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2020-10-13 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
@@ -160,8 +160,6 @@ files:
 - 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 +170,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 +190,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: 

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,83 +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)
-
-      ::Fixtury::Store.instance.get(name)
-    end
-
-    def fixtury_loaded?(name)
-      ::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!
-      ::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