brood 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4e77bbe38670ca8538b982351d8b074d5d0b628c27f451dca1c2ecc9f074c12
-  data.tar.gz: 4cadd8c0f9469654e10d5f421f995e5775293839676d0da43c9dd24d955377a8
+  metadata.gz: 67a821f02646dcebab0406b3d433d07684aa885e15b0d4afaf949266b566e1b8
+  data.tar.gz: 90d006c03c5d65347e13054a049bc5fd72aeb504739253feb75cfb40b8c8eccb
 SHA512:
-  metadata.gz: d5c211f84b89a85ec0b4ce3fd7636daee7fac38e84c0273aaa7b0c95a36c9df64c35ff9987a1a6b45df5e3b4a30d2dece4e6099b4dae1f71b25e8636d84aab6a
-  data.tar.gz: 7e5da72bfcfbe387d21fec9847a13ce83d007612ef49013817696eed44aae7d3bfea0817cedb7ffe9405e9c34d47dc8b002baa87aa183a9f6f9f8117009d025b
+  metadata.gz: 1ad830243d5546ab2fc48fb399219d075b97b1f416d3f8b39bfb9dd2d4eb2468f402a8e30cacc8b30d1b730cd7ec93ccbfe5572656230dd3b92e49325dec0b91
+  data.tar.gz: e91dc6348451eb1d3f05707ccba10e18c155a76682b97e62306b49c9854c1c9c96a7cc624bf235f1d122ea93476fb532f97db21a99c893c34d9eb67f1c7a8586

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [0.2.0] - 2024-07-18
+### Replace method :set with :create and :build
+
+Features:
+
+* Add method `Brood#create` (calls `Fabricate`)
+* Add method `Brood#build` (calls `Fabricate.build`)
+
+Breaking changes:
+
+* Remove method `Brood#set`
+
+Misc:
+
+* Update README.md
+
 ## [0.1.0] - 2024-07-18
 ### Initial release
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brood (0.1.0)
+    brood (0.2.0)
       fabrication (~> 2)
 
 GEM

data/README.md

@@ -50,20 +50,27 @@ end
 @brood = Brood.new
 
 # Fabricate objects:
-gizmos = @brood.set([:department, :gizmos], {name: "Gizmos"}) # => Department instance
-@brood.set([:user, :bar], {id: 12, name: "Bar"}) # => User instance
-@brood.set([:user, :baaz], {name: "Baaz"}) # => User instance
+gizmos = @brood.create([:department, :gizmos], {name: "Gizmos"}) # => Department instance
+@brood.create([:user, :bar], {id: 12, name: "Bar"}) # => User instance
+@brood.create([:user, :baaz], {name: "Baaz"}) # => User instance
 
 # Pass a block to customize the object (forwarded to the Fabricator block argument):
-@brood.set([:user, :baar], {name: "Baar"}) do |user|
+@brood.create([:user, :baar], {name: "Baar"}) do |user|
   user.department = gizmos
 end
 
+# Skip persistence (calls Fabricate.build)
+gadgets = @brood.build([:department, :gadgets], {name: "Gadgets"}) # => Department instance
+foobar = @brood.build([:user, :foobar], {name: "Foobar"}) do |user|
+  user.department = gadgets
+end # => User instance
+
 # Retrieve objects:
 @brood.get([:user, :bar]) # => User instance
 @brood.get([:user, :baaz]) # => User instance
+@brood.get([:user, :foobar]) # => User instance
+@brood.get([:bogus, :bar]) # raises Brood::UnknownObjectTypeError
 @brood.get([:user, :quux]) # raises Brood::ObjectNotFoundError
-@brood.get([:bogus, :bar]) # raises ArgumentError
 
 # Pass a block to customize and lock the object:
 @brood.get([:user, :bar]) do |user|

data/lib/brood/version.rb

@@ -5,5 +5,5 @@
 ## SPDX-License-Identifier: Apache-2.0
 
 class Brood
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/brood.rb

@@ -16,15 +16,12 @@ class Brood
   # Error raised when attempting to re-define an object for the given key.
   class ObjectAlreadyDefinedError < Error; end
 
-  # Error raised when an object is not found for the given key.
-  class ObjectNotFoundError < Error; end
-
-  # Error raised when an object does not match its specified type.
-  class ObjectTypeError < Error; end
-
   # Error raised when attempting to retrieve an unknown object-type.
   class UnknownObjectTypeError < Error; end
 
+  # Error raised when an object is not found for the given key.
+  class ObjectNotFoundError < Error; end
+
   def initialize
     @store = {}
     @object_mutexes = {}
@@ -38,18 +35,34 @@ class Brood
   # @raise [ArgumentError] If the arguments are invalid.
   # @raise [ObjectAlreadyDefinedError] If an object is already defined for the key.
   # @return [Object] The fabricated object.
-  def set(key, attributes, &)
+  def create(key, attributes, &)
     object_type, object_name = key
     validate_arguments(object_type, object_name)
 
     create_object(object_type, object_name, attributes, &)
   end
 
+  # Adds an object to the store, skipping persistence.
+  #
+  # @param key [Array<Symbol, Symbol>] The key representing the object type and name.
+  # @param attributes [Hash] Optional attributes for the object.
+  # @yield Optional block to customize the object.
+  # @raise [ArgumentError] If the arguments are invalid.
+  # @raise [ObjectAlreadyDefinedError] If an object is already defined for the key.
+  # @return [Object] The fabricated object.
+  def build(key, attributes, &)
+    object_type, object_name = key
+    validate_arguments(object_type, object_name)
+
+    build_object(object_type, object_name, attributes, &)
+  end
+
   # Retrieves an object from the store.
   #
   # @param key [Array<Symbol, Symbol>] The key representing the object type and name.
-  # @yield Optional block to customize the object; the object is locked.
+  # @yield Optional block to customize the object; access to the object is protected by a thread lock.
   # @raise [ArgumentError] If the arguments are invalid.
+  # @raise [UnknownObjectTypeError] If the object-type keyword has no entries.
   # @raise [ObjectNotFoundError] If the object is not found.
   # @return [Object] The fabricated object.
   def get(key, &block)
@@ -89,6 +102,18 @@ class Brood
     )
   end
 
+  def build_object(object_type, object_name, attributes, &)
+    @store[object_type] ||= {}
+    @store[object_type][:objects] ||= {}
+    if @store[object_type][:objects].key?(object_name)
+      raise ObjectAlreadyDefinedError,
+        "A object is already defined: (#{object_type} #{object_name})"
+    end
+    @store[object_type][:objects][object_name] = Fabricate.build(
+      object_type, **attributes, &
+    )
+  end
+
   def retrieve_object(object_type, object_name, &block)
     unless @store.key?(object_type)
       raise UnknownObjectTypeError,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brood
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - John Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-18 00:00:00.000000000 Z
+date: 2024-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fabrication