fixtury 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a4447982d6e785c9158850f3d158b07e1226f6a05d85917d41307c5455d41d9
-  data.tar.gz: c7fac4726892a1851ca7b7f0d3ff8abfe2bbedf4d2706b2c3ae6443d6be863f1
+  metadata.gz: 28d8d17251e3c566a77365c589274b5f28f6cfac17c3b126a0047e6b696368ec
+  data.tar.gz: 8dab12b727161634b90ed49e56a025bfe72aade50c90509ee08ebfd4faac2d17
 SHA512:
-  metadata.gz: 6c5858894f02eb54b555df7ee182e81e3741cbd278e37bbd0a3250b9cfea62a00341d3ff95a75adb0d5f56cfd3abcdb036877bee28601b87ff060c3e9bf6f43c
-  data.tar.gz: 0e99678f39920cd68026905ddd202ea8b9f9648c3bef9e941e7fd084fb2daa1ed843b5d2839fc10cbf13f1cc27c224ac212d7cd01173b2f3f8692706cadde2cb
+  metadata.gz: fb5841b70b7ae8cac95e6f8cc6a1c32c47d71f356c3be0275dc463f1d6c1b5f88447e51807d48632bdb68b425e7bc9ead3293519085cc9416d45a027cf1c7abc
+  data.tar.gz: 662570f9d0adcea15b6198eed3deb5fb4aab0639d206941687ea9a230f121ab7d1c82da895ac7c39e6459262ad3c3562cbfcfcb6d3ba7839a90a6380549776ba

data/Gemfile.lock

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

@@ -1,11 +1,14 @@
 # Fixtury
 
-The goal of this library is to provide an interface for accessing fixture data on-demand rather than having to manage all resources up front. By centralizing and wrapping the definitions of data generation, we can preload and optimize how we load data, yet allow deferred behaviors when desired.
+Fixtury aims to provide an interface for creating, managing, and accessing test data in a simple and efficient way. It has no opinion on how you generate the data, it simply provides efficient ways to access it.
 
-For example, if a developer is running a test locally, there's no reason to build all fixtures for your suite.
+Often, fixture frameworks require you to either heavily maintain static fixtures or generate all your fixtures at runtime. Fixtury attempts to find a middle ground that enables a faster and more effecient development process.
 
-```
-class MyTest < ::Test
+For example, if a developer is running a test locally in their development environment there's no reason to build all fixtures for your suite of 30k tests. Instead, if we're able to track the fixture dependencies of the tests that are running we can build (and cache) the data relevant for the specific tests that are run.
+
+```ruby
+class MyTest < ::ActiveSupport::TestCase
+  include ::Fixtury::TestHooks
 
   fixtury "users.fresh"
   let(:user) { fixtury("users.fresh") }
@@ -15,7 +18,6 @@ class MyTest < ::Test
   end
 
 end
-
 ```
 
 Loading this file would ensure `users.fresh` is loaded into the fixture set before the suite is run. In the context of ActiveSupport::TestCase, the Fixtury::Hooks file will ensure the database records are present prior to your suite running. Setting `use_transactional_fixtures` ensures all records are rolled back prior to running another test.

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,15 +7,17 @@ require "fixtury/version"
 require "fixtury/schema"
 require "fixtury/locator"
 require "fixtury/store"
-require "fixtury/execution_context"
 
 module Fixtury
 
+  # Shortcut for opening the top level schema.
   def self.define(&block)
     schema.define(&block)
     schema
   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
     @top_level_schema ||= ::Fixtury::Schema.new(parent: nil, name: "")
   end

data/lib/fixtury/definition.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "fixtury/definition_executor"
+
 module Fixtury
   class Definition
 
@@ -24,55 +26,23 @@ module Fixtury
       @enhancements.any?
     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|
-          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:)
-      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
-
-      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 location_from_callable(callable)
+      return nil unless callable.respond_to?(:source_location)
 
-    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
-        yield
-      end
-      execution_context.after_fixture(self, value) if execution_context.respond_to?(:after_fixture)
-      value
+      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/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 = {}
@@ -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,7 +5,6 @@ require "singleton"
 require "yaml"
 require "fixtury/locator"
 require "fixtury/errors/circular_dependency_error"
-require "fixtury/execution_context"
 require "fixtury/reference"
 
 module Fixtury
@@ -22,7 +21,6 @@ module Fixtury
     attr_reader :filepath, :references, :ttl, :auto_refresh_expired
     attr_reader :schema, :locator
     attr_reader :log_level
-    attr_reader :execution_context
 
     def initialize(
       filepath: nil,
@@ -30,7 +28,6 @@ module Fixtury
       log_level: nil,
       ttl: nil,
       schema: nil,
-      execution_context: nil,
       auto_refresh_expired: false
     )
       @schema = schema || ::Fixtury.schema
@@ -40,7 +37,6 @@ module Fixtury
       @locator = locator
       @filepath = filepath
       @references = @filepath && ::File.file?(@filepath) ? ::YAML.load_file(@filepath) : {}
-      @execution_context = execution_context || ::Fixtury::ExecutionContext.new
       @ttl = ttl ? ttl.to_i : ttl
       @auto_refresh_expired = !!auto_refresh_expired
       self.class.instance ||= self
@@ -81,7 +77,7 @@ 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
@@ -108,7 +104,7 @@ module Fixtury
       result
     end
 
-    def get(name)
+    def get(name, execution_context: nil)
       dfn = schema.get_definition!(name)
       full_name = dfn.name
       ref = references[full_name]

data/lib/fixtury/test_hooks.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "fixtury/store"
+require "active_support/core_ext/class/attribute"
 
 module Fixtury
   module TestHooks
@@ -14,50 +15,86 @@ module Fixtury
 
     module ClassMethods
 
-      def fixtury(*names)
-        self.fixtury_dependencies += names.flatten.compact.map(&:to_s)
-      end
+      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
 
-      def define_fixture(name, &block)
-        fixture_name = name
-        namespace_names = self.name.underscore.split("/")
+          namespace.split("/").each do |ns_name|
+            ns = ns.namespace(ns_name){}
+          end
 
-        ns = ::Fixtury.schema
+          names.each do |fixture_name|
+            ns.fixture(fixture_name, &definition)
+            self.fixtury_dependencies += ["/#{namespace}/#{fixture_name}"]
+          end
 
-        namespace_names.each do |ns_name|
-          ns = ns.namespace(ns_name){}
+        # otherwise, just record the dependency
+        else
+          self.fixtury_dependencies += names.flatten.compact.map(&:to_s)
         end
 
-        ns.fixture(fixture_name, &block)
+        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}"
 
-        fixtury("#{namespace_names.join("/")}/#{fixture_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
+
+      def fixtury_namespace
+        name.underscore
       end
 
     end
 
     def fixtury(name)
-      return nil unless ::Fixtury::Store.instance
+      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.instance.get(local_name)
-        end
+      local_alias = "/#{self.class.fixtury_namespace}/#{name}"
+      if self.fixtury_dependencies.include?(local_alias)
+        return fixtury_store.get(local_alias, execution_context: self)
       end
 
       unless self.fixtury_dependencies.include?(name)
         raise ArgumentError, "Unrecognized fixtury dependency `#{name}` for #{self.class}"
       end
 
-      ::Fixtury::Store.instance.get(name)
+      fixtury_store.get(name, execution_context: self)
+    end
+
+    def fixtury_store
+      ::Fixtury::Store.instance
     end
 
     def fixtury_loaded?(name)
-      return false unless ::Fixtury::Store.instance
+      return false unless fixtury_store
 
-      ::Fixtury::Store.instance.loaded?(name)
+      fixtury_store.loaded?(name)
     end
 
     def fixtury_database_connections
@@ -100,9 +137,9 @@ module Fixtury
     end
 
     def clear_expired_fixtury_fixtures!
-      return unless ::Fixtury::Store.instance
+      return unless fixtury_store
 
-      ::Fixtury::Store.instance.clear_expired_references!
+      fixtury_store.clear_expired_references!
     end
 
     def load_all_fixtury_fixtures!

data/lib/fixtury/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fixtury
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Mike Nelson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-07 00:00:00.000000000 Z
+date: 2020-10-21 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,12 +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/locator.rb
 - lib/fixtury/locator_backend/common.rb
 - lib/fixtury/locator_backend/globalid.rb

data/lib/fixtury/execution_context.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-# a class made available so helper methods can be provided within the fixture dsl
-module Fixtury
-  class ExecutionContext
-
-    def before_fixture(_dfn); end
-
-    def around_fixture(_dfn)
-      yield
-    end
-
-    def after_fixture(_dfn, _value); end
-
-  end
-end