fixtury 0.3.0 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8026933c72e6773550464325733bf9c31c7fc601c00aabcc6fa18dd384439d6
-  data.tar.gz: a96c566602765f01a949814362022d687e5b06e794d1c09ecbef8dd5fd254a34
+  metadata.gz: d422110eda024f73368d6d4e244f909fcbc0b288a223df00e7b527c18f551b13
+  data.tar.gz: 440dd84ef120db60bd9cad4bcdac952e43c61c915199801c27023c95775725c5
 SHA512:
-  metadata.gz: 7b95b7af4242c7e90f29f913be405a4a50163c66b8d363b2187ca04e4f71ff59b9cfdf88acbf6c4754c226321f8663c6d54b02472fe9c49342a49b9f98a1e2b2
-  data.tar.gz: 7b78291b5980f5dc3a854e31f15668ee6765a7173869d68b09a19d8e58cc06e60240c293fa7984afd7271c3d31e8977d5d1e0d96cf71bfd018ada973fe3cf75f
+  metadata.gz: 8b7c93a1dc5781514337168f86407a0db1c05b0697df2cfb2a595b7766f02f7fcf762b5a1102984e1b18bfcaaaa02d756128c6af4bbb2072a99c13f99809d068
+  data.tar.gz: 2fad96dd5f9aa75f8af8f0bfc62e15864d3fd70289dc353b8431fee1362bcd53842261b37b5fcba58d583177f9ef7aa0bea4426d81ddd8ab13b097ab76ff03d0

data/Gemfile.lock

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

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/lib/fixtury.rb

@@ -8,15 +8,19 @@ require "fixtury/schema"
 require "fixtury/locator"
 require "fixtury/store"
 
+# Top level namespace of the gem
 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: "")
+    @schema ||= ::Fixtury::Schema.new(parent: nil, name: "")
   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/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

@@ -9,13 +9,14 @@ require "fixtury/errors/schema_frozen_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:)
+    def initialize(parent:, name:, options: {})
       @name = name
       @parent = parent
       @relative_name = @name.split("/").last
       @around_fixture_definition = nil
+      @options = options
       @frozen = false
       reset!
     end
@@ -83,19 +84,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)
@@ -186,13 +187,13 @@ 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
         children[name] = begin
           child_name = build_child_name(name: name)
-          self.class.new(name: child_name, parent: self)
+          self.class.new(name: child_name, parent: self, options: options)
         end
       end
       child
@@ -202,9 +203,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/test_hooks.rb

@@ -11,6 +11,9 @@ module Fixtury
     included do
       class_attribute :fixtury_dependencies
       self.fixtury_dependencies = Set.new
+
+      class_attribute :local_fixtury_dependencies
+      self.local_fixtury_dependencies = Set.new
     end
 
     module ClassMethods
@@ -22,7 +25,7 @@ module Fixtury
         if block_given?
           raise ArgumentError, "A fixture cannot be defined in an anonymous class" if name.nil?
 
-          namespace = name.underscore
+          namespace = fixtury_namespace
 
           ns = ::Fixtury.schema
 
@@ -30,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.fixtury_dependencies += ["#{namespace}/#{fixture_name}"]
+            new_name = "/#{namespace}/#{fixture_name}"
+            self.local_fixtury_dependencies += [new_name]
+            new_name
           end
 
         # otherwise, just record the dependency
@@ -40,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|
@@ -64,6 +71,10 @@ module Fixtury
         end
       end
 
+      def fixtury_namespace
+        name.underscore
+      end
+
     end
 
     def fixtury(name)
@@ -71,14 +82,15 @@ module Fixtury
 
       name = name.to_s
 
+      # 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.name.underscore}/#{name}"
-        if self.fixtury_dependencies.include?(local_name)
+        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
 
@@ -101,7 +113,7 @@ module Fixtury
 
     # piggybacking activerecord fixture setup for now.
     def setup_fixtures(*args)
-      if fixtury_dependencies.any?
+      if fixtury_dependencies.any? || local_fixtury_dependencies.any?
         setup_fixtury_fixtures
       else
         super
@@ -110,7 +122,7 @@ module Fixtury
 
     # piggybacking activerecord fixture setup for now.
     def teardown_fixtures(*args)
-      if fixtury_dependencies.any?
+      if fixtury_dependencies.any? || local_fixtury_dependencies.any?
         teardown_fixtury_fixtures
       else
         super
@@ -118,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!
@@ -129,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
@@ -141,10 +153,17 @@ module Fixtury
     end
 
     def load_all_fixtury_fixtures!
-      fixtury_dependencies.each do |name|
+      (fixtury_dependencies | local_fixtury_dependencies).each do |name|
         fixtury(name) unless fixtury_loaded?(name)
       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.0"
+  VERSION = "0.3.5"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fixtury
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.5
 platform: ruby
 authors:
 - Mike Nelson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2020-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: autotest