fixtury 0.3.2 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11c65dc0db10367bf67f7d421ccc76e7b647a5bf73357431bc85dbd788667b00
-  data.tar.gz: 7042ed9b891e4fd0e2bdcade6cc0145160e5fb1dd6394d2bcd8de612ecceb1f8
+  metadata.gz: 35c4db20425a837221a7c979e51371b77e00790cded54b182b31e62f7f57d8c2
+  data.tar.gz: cbdb024ba301b393b97604879594c1d9d53bfe1ffd4f24959824e8f41e1fe4e2
 SHA512:
-  metadata.gz: ed2b328ac82a6506a9c0d4fb26e049ee249cae994dd4406d2896c0b4be8e270dc54fef1a5f94a887077abc5a9a964a6412bea23bccce7ead21c600c70c2f4374
-  data.tar.gz: 18888bd37fdd508552353f5aa4d076f5bedd4ccf4420d7fc914450dcbaf5ea0c1cb29b428af3c94c3c617fd64359831f43594f65e3e9d300166329e0155e3b11
+  metadata.gz: 4748b476b6683ac9275a0c62ebca36f346f5d2bea208d47f55dfd836b521283c383aee7847961ffc90726292fd187389fc65b650dd508f9c67288fa32ae88c6c
+  data.tar.gz: bc765697630a9780752ab2ab9512dbe6bd92cee4f612dfa1ba11437d1f59f3e0c58a7d5a107576704d0018507ce989bf2e8726c165f244bf8757676c301a4f4d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fixtury (0.3.2)
+    fixtury (0.4.1)
 
 GEM
   remote: https://rubygems.org/

data/lib/fixtury.rb

@@ -8,8 +8,18 @@ require "fixtury/schema"
 require "fixtury/locator"
 require "fixtury/store"
 
+# Top level namespace of the gem
 module Fixtury
 
+  LOG_LEVELS = {
+    (LOG_LEVEL_NONE = :none) => 0,
+    (LOG_LEVEL_INFO = :info) => 1,
+    (LOG_LEVEL_DEBUG = :debug) => 2,
+    (LOG_LEVEL_ALL = :all) => 3,
+  }.freeze
+
+  DEFAULT_LOG_LEVEL = LOG_LEVEL_INFO
+
   # Shortcut for opening the top level schema.
   def self.define(&block)
     schema.define(&block)
@@ -19,7 +29,31 @@ module Fixtury
   # 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
-    @top_level_schema ||= ::Fixtury::Schema.new(parent: nil, name: "")
+    @schema ||= ::Fixtury::Schema.new(parent: nil, name: "")
+  end
+
+  def self.log_level
+    return @log_level if @log_level
+
+    @log_level = ENV["FIXTURY_LOG_LEVEL"]
+    @log_level ||= DEFAULT_LOG_LEVEL
+    @log_level = @log_level.to_s.to_sym
+    @log_level
+  end
+
+  def self.log(text = nil, level: LOG_LEVEL_DEBUG, name: nil)
+    desired_level = LOG_LEVELS.fetch(log_level) { DEFAULT_LOG_LEVEL }
+    return if desired_level == LOG_LEVEL_NONE
+
+    message_level = LOG_LEVELS.fetch(level) { LOG_LEVEL_DEBUG }
+    return unless desired_level >= message_level
+
+    msg = +"[fixtury"
+    msg << "|#{name}" if name
+    msg << "]"
+    msg << " #{text}" if text
+    msg << " #{yield}" if block_given?
+    puts msg
   end
 
 end

data/lib/fixtury/definition.rb

@@ -7,14 +7,17 @@ module Fixtury
 
     attr_reader :name
     attr_reader :schema
+    alias parent schema
+    attr_reader :options
 
     attr_reader :callable
     attr_reader :enhancements
 
-    def initialize(schema: nil, name:, &block)
+    def initialize(schema: nil, name:, options: {}, &block)
       @name = name
       @schema = schema
       @callable = block
+      @options = options
       @enhancements = []
     end
 

data/lib/fixtury/errors/option_collision_error.rb

@@ -0,0 +1,13 @@
+# 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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fixtury
   module Errors
     class SchemaFrozenError < ::StandardError

data/lib/fixtury/reference.rb

@@ -9,12 +9,17 @@ module Fixtury
       new(name, HOLDER_VALUE)
     end
 
-    attr_reader :name, :value, :created_at
+    def self.create(name, value)
+      new(name, value)
+    end
+
+    attr_reader :name, :value, :created_at, :options
 
-    def initialize(name, value)
+    def initialize(name, value, options = {})
       @name = name
       @value = value
       @created_at = Time.now.to_i
+      @options = options
     end
 
     def holder?

data/lib/fixtury/schema.rb

@@ -5,21 +5,33 @@ require "fixtury/path"
 require "fixtury/errors/already_defined_error"
 require "fixtury/errors/fixture_not_defined_error"
 require "fixtury/errors/schema_frozen_error"
+require "fixtury/errors/option_collision_error"
 
 module Fixtury
   class Schema
 
-    attr_reader :definitions, :children, :name, :parent, :relative_name, :around_fixture_definition
+    attr_reader :definitions, :children, :name, :parent, :relative_name, :around_fixture_definition, :options
 
     def initialize(parent:, name:)
       @name = name
       @parent = parent
       @relative_name = @name.split("/").last
       @around_fixture_definition = nil
+      @options = {}
       @frozen = false
       reset!
     end
 
+    def merge_options(opts = {})
+      opts.each_pair do |k, v|
+        if options.key?(k) && options[k] != v
+          raise ::Fixtury::Errors::OptionCollisionError.new(name, k, options[k], v)
+        end
+
+        options[k] = v
+      end
+    end
+
     def around_fixture(&block)
       @around_fixture_definition = block
     end
@@ -83,19 +95,19 @@ module Fixtury
       out.join("\n")
     end
 
-    def namespace(name, &block)
+    def namespace(name, options = {}, &block)
       ensure_not_frozen!
       ensure_no_conflict!(name: name, definitions: true, namespaces: false)
 
-      child = find_or_create_child_schema(name: name)
+      child = find_or_create_child_schema(name: name, options: options)
       child.instance_eval(&block) if block_given?
       child
     end
 
-    def fixture(name, &block)
+    def fixture(name, options = {}, &block)
       ensure_not_frozen!
       ensure_no_conflict!(name: name, definitions: true, namespaces: true)
-      create_child_definition(name: name, &block)
+      create_child_definition(name: name, options: options, &block)
     end
 
     def enhance(name, &block)
@@ -108,14 +120,14 @@ module Fixtury
     def merge(other_ns)
       ensure_not_frozen!
       other_ns.definitions.each_pair do |name, dfn|
-        fixture(name, &dfn.callable)
+        fixture(name, dfn.options, &dfn.callable)
         dfn.enhancements.each do |e|
           enhance(name, &e)
         end
       end
 
       other_ns.children.each_pair do |name, other_ns_child|
-        namespace(name) do
+        namespace(name, other_ns_child.options) do
           merge(other_ns_child)
         end
       end
@@ -186,7 +198,7 @@ module Fixtury
       children[name.to_s]
     end
 
-    def find_or_create_child_schema(name:)
+    def find_or_create_child_schema(name:, options:)
       name = name.to_s
       child = find_child_schema(name: name)
       child ||= begin
@@ -195,6 +207,7 @@ module Fixtury
           self.class.new(name: child_name, parent: self)
         end
       end
+      child.merge_options(options)
       child
     end
 
@@ -202,9 +215,9 @@ module Fixtury
       definitions[name.to_s]
     end
 
-    def create_child_definition(name:, &block)
+    def create_child_definition(name:, options:, &block)
       child_name = build_child_name(name: name)
-      definition = ::Fixtury::Definition.new(name: child_name, schema: self, &block)
+      definition = ::Fixtury::Definition.new(name: child_name, schema: self, options: options, &block)
       definitions[name.to_s] = definition
     end
 

data/lib/fixtury/store.rb

@@ -10,12 +10,6 @@ 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
@@ -25,15 +19,11 @@ module Fixtury
     def initialize(
       filepath: nil,
       locator: ::Fixtury::Locator.instance,
-      log_level: nil,
       ttl: nil,
       schema: nil,
       auto_refresh_expired: false
     )
       @schema = schema || ::Fixtury.schema
-      @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) : {}
@@ -59,7 +49,7 @@ module Fixtury
 
       references.delete_if do |name, ref|
         is_expired = ref_invalid?(ref)
-        log(level: LOG_LEVEL_INFO) { "expiring #{name}" } if is_expired
+        log("expiring #{name}", level: LOG_LEVEL_DEBUG) if is_expired
         is_expired
       end
     end
@@ -81,7 +71,7 @@ module Fixtury
       pattern = pattern[0...-1] if glob
       references.delete_if do |key, _value|
         hit = glob ? key.start_with?(pattern) : key == pattern
-        log(level: LOG_LEVEL_INFO) { "clearing #{key}" } if hit
+        log("clearing #{key}", level: LOG_LEVEL_DEBUG) if hit
         hit
       end
       dump_to_file
@@ -100,7 +90,7 @@ module Fixtury
       full_name = dfn.name
       ref = references[full_name]
       result = ref&.real?
-      log(level: LOG_LEVEL_DEBUG) { result ? "hit #{full_name}" : "miss #{full_name}" }
+      log(result ? "hit #{full_name}" : "miss #{full_name}", level: LOG_LEVEL_ALL)
       result
     end
 
@@ -114,7 +104,7 @@ module Fixtury
       end
 
       if ref && auto_refresh_expired && ref_invalid?(ref)
-        log(level: LOG_LEVEL_INFO) { "refreshing #{full_name}" }
+        log("refreshing #{full_name}", level: LOG_LEVEL_DEBUG)
         clear_ref(full_name)
         ref = nil
       end
@@ -122,11 +112,11 @@ module Fixtury
       value = nil
 
       if ref
-        log(level: LOG_LEVEL_DEBUG) { "hit #{full_name}" }
+        log("hit #{full_name}", level: LOG_LEVEL_ALL)
         value = load_ref(ref.value)
         if value.nil?
           clear_ref(full_name)
-          log(level: LOG_LEVEL_DEBUG) { "missing #{full_name}" }
+          log("missing #{full_name}", level: LOG_LEVEL_ALL)
         end
       end
 
@@ -136,7 +126,7 @@ module Fixtury
 
         value = dfn.call(store: self, execution_context: execution_context)
 
-        log(level: LOG_LEVEL_INFO) { "store #{full_name}" }
+        log("store #{full_name}", level: LOG_LEVEL_DEBUG)
 
         ref = dump_ref(full_name, value)
         ref = ::Fixtury::Reference.new(full_name, ref)
@@ -165,14 +155,8 @@ module Fixtury
       !locator.recognize?(ref.value)
     end
 
-    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|#{name}] #{yield}"
+    def log(msg, level:)
+      ::Fixtury.log(msg, level: level, name: "store")
     end
 
   end

data/lib/fixtury/test_hooks.rb

@@ -33,9 +33,11 @@ module Fixtury
             ns = ns.namespace(ns_name){}
           end
 
-          names.each do |fixture_name|
+          names.map! do |fixture_name|
             ns.fixture(fixture_name, &definition)
-            self.local_fixtury_dependencies += ["/#{namespace}/#{fixture_name}"]
+            new_name = "/#{namespace}/#{fixture_name}"
+            self.local_fixtury_dependencies += [new_name]
+            new_name
           end
 
         # otherwise, just record the dependency
@@ -43,12 +45,14 @@ module Fixtury
           self.fixtury_dependencies += names.flatten.compact.map(&:to_s)
         end
 
-        accessor_option = opts.key?(:accessor) ? opts[:accessor] : true
+        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
-            raise ArgumentError, "A named :accessor option is only available when providing one fixture"
+            raise ArgumentError, "A named :as option is only available when providing one fixture"
           end
 
           names.each do |fixture_name|
@@ -78,12 +82,15 @@ module Fixtury
 
       name = name.to_s
 
-      local_alias = "/#{self.class.fixtury_namespace}/#{name}"
-      if self.local_fixtury_dependencies.include?(local_alias)
-        return fixtury_store.get(local_alias, execution_context: self)
+      # 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
 
-      unless self.fixtury_dependencies.include?(name)
+      unless fixtury_dependencies.include?(name) || local_fixtury_dependencies.include?(name)
         raise ArgumentError, "Unrecognized fixtury dependency `#{name}` for #{self.class}"
       end
 
@@ -123,7 +130,7 @@ module Fixtury
     end
 
     def setup_fixtury_fixtures
-      return unless use_transactional_fixtures
+      return unless fixtury_use_transactions?
 
       clear_expired_fixtury_fixtures!
       load_all_fixtury_fixtures!
@@ -134,7 +141,7 @@ module Fixtury
     end
 
     def teardown_fixtury_fixtures
-      return unless use_transactional_fixtures
+      return unless fixtury_use_transactions?
 
       fixtury_database_connections.each(&:rollback_transaction)
     end
@@ -147,9 +154,19 @@ module Fixtury
 
     def load_all_fixtury_fixtures!
       (fixtury_dependencies | local_fixtury_dependencies).each do |name|
-        fixtury(name) unless fixtury_loaded?(name)
+        unless fixtury_loaded?(name)
+          ::Fixtury.log("preloading #{name.inspect}", name: "test", level: ::Fixtury::LOG_LEVEL_INFO)
+          fixtury(name)
+        end
       end
     end
 
+    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 = "0.3.2"
+  VERSION = "0.4.1"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fixtury
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.1
 platform: ruby
 authors:
 - Mike Nelson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-21 00:00:00.000000000 Z
+date: 2020-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: autotest
@@ -159,6 +159,7 @@ files:
 - 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/locator.rb