standard_procedure_fabrik 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 473c93f4575e1ac907de0db91f5e306c9f38b2bd8d8c67c0147d0ffffb1ac6cc
-  data.tar.gz: 7aea538f381c7cb6d7898c460d6c989d959fe4e1220ea3043a15f15f60d6db35
+  metadata.gz: fc634b02a078fda169f5f93bc1bd4c607b1245d3d5d866a9224ced85fb3576a1
+  data.tar.gz: e57ba5a0e6cc50cd061fee1608e2fb096e7fab885e6389a3fd819c63530880bd
 SHA512:
-  metadata.gz: 6a78111d8b8b26e318399cceb97b6e701db06286c65f70977be7766bbc6ad099e9fa934b9f3e779b05c78dbdf92021450fd1144d9cad4f2106c7e3ebac87745f
-  data.tar.gz: c1f2c5996540d5bc694732d848fbf7922f4c8698b2f1d33d0a0f430dee16c94bf965e5387ba42681150339e5d7047d55a461216eb5b3ee9e5962cd3b61d8529d
+  metadata.gz: 51e2f129f76aa9a3f08b8cd53b54891d8a5d6fdefb41baa03462c8227bea30a0c9497c716a620805e242dfcfff4f54e9b95e180cb4811b9e2915c5ca3a07ef44
+  data.tar.gz: 964e3ceab133674e4366d98b36243d5d9c9e5b0642253a4a7c43e3300150560aa8c8f218ed87eec902c9136f3ca1e169e01c451dbab9f3cc9a5e82891457a581

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.1.1] - 2024-12-29
+
+- Pass the database through to defaults (so you can create dependent models)
+
 ## [0.1.0] - 2024-12-19
 
 - Initial release

data/README.md

@@ -1,66 +1,66 @@
 # Fabrik
 
-## Simplify your database seeds and test fixtures.  
+## Simplify your database seeds and test fixtures.
 
-Fabrik is a factory for your ActiveRecord models.  
+Fabrik is a factory for your ActiveRecord models.
 
-It's designed to be used in both your test cases and in your database seeds.  
+It's designed to be used in both your test cases and in your database seeds.
+
+And I think the API is pretty nice and the code is pretty simple.
 
-And I think the API is pretty nice and the code is pretty simple.  
- 
 ## Database seeds
 
-Database seeds are great.  
+Database seeds are great.
 
-Screwed up your development database?  Just drop it, rebuild it and load in your starting data.  
+Screwed up your development database?  Just drop it, rebuild it and load in your starting data.
 
-Added a new feature and want to show people what it looks like?  Add some new records into your seeds, run them, then you've got a nice set of demo data, all pre-loaded.  
+Added a new feature and want to show people what it looks like?  Add some new records into your seeds, run them, then you've got a nice set of demo data, all pre-loaded.
 
-For this to work, seeds need to be idempotent.  When you run your seeds against a database with existing data, it should only insert the new stuff, leaving the old untouched.  
+For this to work, seeds need to be idempotent.  When you run your seeds against a database with existing data, it should only insert the new stuff, leaving the old untouched.
 
-Fabrik does this.  
+Fabrik does this.
 
 ## Specs and tests
 
-I love RSpec.  Other test frameworks (cough; minitest) are available.  
+I love RSpec.  Other test frameworks (cough; minitest) are available.
 
-And if you're writing Rails apps, your tests or specs are, most likely, going to be using ActiveRecord models which end up hitting the database.  That's just how Rails works, no matter what the isolationists say.  
+And if you're writing Rails apps, your tests or specs are, most likely, going to be using ActiveRecord models which end up hitting the database.  That's just how Rails works, no matter what the isolationists say.
 
-So, when setting up your test fixtures, you want to set up the smallest amount of data to prove your case.  
+So, when setting up your test fixtures, you want to set up the smallest amount of data to prove your case.
 
-And, because tests are documentation, you want that setup to be there, next to the test code, so anyone reading it can understand how everything hangs together.  
+And, because tests are documentation, you want that setup to be there, next to the test code, so anyone reading it can understand how everything hangs together.
 
-Fabrik does this.  
+Fabrik does this.
 
 ## Configuration
 
-Fabrik allows you to configure three aspects of how you create your objects.  
+Fabrik allows you to configure three aspects of how you create your objects.
 
 ### Default attributes
 
-When you're writing a spec, you probably only care about one aspect of the model involved.  
+When you're writing a spec, you probably only care about one aspect of the model involved.
 
-So Fabrik allows you to set default attributes; then when you're creating a model, you can specify the ones you're interested in and ignore all the rest.  
+So Fabrik allows you to set default attributes; then when you're creating a model, you can specify the ones you're interested in and ignore all the rest.
 
 ```ruby
 db.configure do
   with Person do
-    defaults first_name: -> { "Alice" }, last_name: -> { Faker::Name.last_name }, age: -> { 33 }
+    defaults first_name: ->(db) { "Alice" }, last_name: ->(db) { Faker::Name.last_name }, age: ->(db) { 33 }
   end
 end
 
 @alice = db.people.create last_name: "Anteater"
 
-puts @alice.first_name # => Alice 
-puts @alice.last_name # => Anteater 
+puts @alice.first_name # => Alice
+puts @alice.last_name # => Anteater
 puts @alice.age # => 33
 ```
 
 ### Uniqueness
 
-When you've got a database packed with existing data, you don't want your seeds to fail because of a uniqueness constraint.  Or your tests to fail because suddenly they're finding two records when they were only expecting one.  
+When you've got a database packed with existing data, you don't want your seeds to fail because of a uniqueness constraint.  Or your tests to fail because suddenly they're finding two records when they were only expecting one.
 
-So Fabrik lets you define what makes a model unique.  Then when you create it, it checks for an existing record first and only creates a new one if the original is not found.  
+So Fabrik lets you define what makes a model unique.  Then when you create it, it checks for an existing record first and only creates a new one if the original is not found.
 
 ```ruby
 db.configure do
@@ -71,25 +71,25 @@ end
 @alice = db.people.create first_name: "Alice", last_name: "Aardvark", email: "alice@example.com"
 @zac = db.people.create first_name: "Zac", last_name: "Zebra", email: "alice@example.com"
 
-@alice == @zac # => true 
+@alice == @zac # => true
 puts @zac.first_name # => Alice
 ```
 
 ### Special processing
 
-Some models are special.  They can't live on their own.  Their invariants won't let them.  Maybe a `Company` cannot exist without a `CEO`.  While your main application logic can ensure that's always the case, when you're writing your tests, it becomes a pain specifying it over and over again.  
+Some models are special.  They can't live on their own.  Their invariants won't let them.  Maybe a `Company` cannot exist without a `CEO`.  While your main application logic can ensure that's always the case, when you're writing your tests, it becomes a pain specifying it over and over again.
 
-So Fabrik lets you define specific processing that happens after a new record is created.  
+So Fabrik lets you define specific processing that happens after a new record is created.
 
 ```ruby
 db.configure do
-  with Company do 
+  with Company do
     defaults name: -> { Faker::Company.name }
     after_create do |company, db|
       db.employees.create company: company, role: "CEO"
     end
-  end 
-  with Employee do 
+  end
+  with Employee do
     defaults first_name: -> { Faker::Name.first_name }, last_name: -> { Faker::Name.last_name }, role: -> { "Cleaner" }
   end
 end
@@ -99,9 +99,9 @@ puts Company.find_by(name: "MegaCorp").employees.size # => 1
 
 ## References
 
-You've created a load of models.  And you need to reference them to create more models.  You could search for them by hand, but that's for chumps.  
+You've created a load of models.  And you need to reference them to create more models.  You could search for them by hand, but that's for chumps.
 
-So Fabrik let's you give your models a label.  And then refer back to that model using the label.  
+So Fabrik let's you give your models a label.  And then refer back to that model using the label.
 
 ```ruby
 db.people.create :alice, first_name: "Alice"
@@ -113,7 +113,7 @@ puts db.people[:alice] # => Alice
 
 You've got a load of models in your application.  Fabrik allows you to configure some rules for each one.  But not all of them need special processing.  Why waste your time telling Fabrik about all these classes when you've got more important things to do?
 
-So Fabrik takes a guess at any names you give it and tries its best to figure out which class you mean.  
+So Fabrik takes a guess at any names you give it and tries its best to figure out which class you mean.
 
 ```ruby
 class Intergalactic::Spaceship < ApplicationRecord
@@ -125,18 +125,18 @@ db.intergalactic_spaceships.create :ufo
 puts Intergalactic::Spaceship.count # => 1
 ```
 
-Or maybe you're writing a Rails engine and all your classes are namespaced.  Typing long names is so _boring_.  
+Or maybe you're writing a Rails engine and all your classes are namespaced.  Typing long names is so _boring_.
 
-So Fabrik lets you register an alternative name for your classes.  
+So Fabrik lets you register an alternative name for your classes.
 
 ```ruby
-db.configure do 
-  with MyAccountsPackageEngine::Invoice, as: :invoice do 
-    defaults due_date: -> { 7.days.from_now }
+db.configure do
+  with MyAccountsPackageEngine::Invoice, as: :invoice do
+    defaults due_date: ->(db) { 7.days.from_now }
   end
-end 
+end
 
-db.invoices.create :overdue_invoice, due_date: 1.day.ago 
+db.invoices.create :overdue_invoice, due_date: 1.day.ago
 ```
 
 ## Installation
@@ -147,59 +147,59 @@ Add `standard_procedure_fabrik` to your `Gemfile`
 bundle add standard_procedure_fabrik
 ```
 
-If you're only using it for tests, add it to your `test` group.  If you're using it for seeds, add it with all your other gems.  While you're at it, add [Faker](https://github.com/faker-ruby/faker) as well - at the very least, it will probably make you smile with some of the stuff it generates for your test data.  
+If you're only using it for tests, add it to your `test` group.  If you're using it for seeds, add it with all your other gems.  While you're at it, add [Faker](https://github.com/faker-ruby/faker) as well - at the very least, it will probably make you smile with some of the stuff it generates for your test data.
 
 ## Usage
 
 ### Localised (for tests)
 
-Create an instance of a [Fabrik::Database](/lib/fabrik/database.rb), configure it and use it.  
+Create an instance of a [Fabrik::Database](/lib/fabrik/database.rb), configure it and use it.
 
 ```ruby
-db = Fabrik::Database.new 
-db.configure do 
-  with Person do 
-    defaults first_name: -> { Faker::Name.first_name }, last_name: -> { Faker::Name.last_name }, email: -> { Faker::Internet.email }
+db = Fabrik::Database.new
+db.configure do
+  with Person do
+    defaults first_name: ->(db) { Faker::Name.first_name }, last_name: ->(db) { Faker::Name.last_name }, email: ->(db) { Faker::Internet.email }
   end
 end
 
 db.people.create :alice, first_name: "Alice"
 ```
 
-In an RSpec: 
+In an RSpec:
 
 ```ruby
-RSpec.describe "Whatever" do 
+RSpec.describe "Whatever" do
   let(:db) { Fabrik::Database.new }
-  before do 
-    db.configure do 
+  before do
+    db.configure do
       # ... whatever
     end
   end
 end
 ```
 
-In a minitest ... I don't know, I've not used minitest in years but I'm sure it's easy enough.  
+In a minitest ... I don't know, I've not used minitest in years but I'm sure it's easy enough.
 
 ### Global (for seeds and generally creating stuff)
 
-Configure the global `Fabrik::Database`, then use it.  
+Configure the global `Fabrik::Database`, then use it.
 
 ```ruby
-Fabrik.configure do  
-  with Person do 
-    defaults first_name: -> { Faker::Name.first_name }, last_name: -> { Faker::Name.last_name }, email: -> { Faker::Internet.email }
+Fabrik.configure do
+  with Person do
+    defaults first_name: ->(db) { Faker::Name.first_name }, last_name: ->(db) { Faker::Name.last_name }, email: ->(db) { Faker::Internet.email }
   end
 end
 
 Fabrik.db.people.create :alice, first_name: "Alice"
 ```
 
-Watch out - because this uses a global instance, it's not thread-safe.  That's not an issue if you're just using it for database seeds or in most test runners(single-threaded or parallelised with multiple processes).  But it *might* cause problems if you're using threads to parallelise your tests, or you're reconfiguring while your application is running.  
+Watch out - because this uses a global instance, it's not thread-safe.  That's not an issue if you're just using it for database seeds or in most test runners(single-threaded or parallelised with multiple processes).  But it *might* cause problems if you're using threads to parallelise your tests, or you're reconfiguring while your application is running.
 
 ## Development
 
-Important note: this gem is not under the MIT Licence - it's under the [LGPL](/LICENSE).  This may or may not make it suitable for your use.  I have reasons for this, which don't belong in a README.  But the net result is, this library is open-source, it's free software and you can license *your own* code any way you want.  But if you change *this code*, you have to publish those changes under the same rules.  
+Important note: this gem is not under the MIT Licence - it's under the [LGPL](/LICENSE).  This may or may not make it suitable for your use.  I have reasons for this, which don't belong in a README.  But the net result is, this library is open-source, it's free software and you can license *your own* code any way you want.  But if you change *this code*, you have to publish those changes under the same rules.
 
 So, fork the repo, bundle install, add RSpecs for the changes you want to make and `rake spec` to run the tests. Then send me a pull request.  You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
@@ -212,8 +212,8 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/standa
 
 ### Code of Conduct
 
-Don't be a dick.  
+Don't be a dick.
 
-If you think you're being reasonable but most people think you're being a dick, then you're not being reasonable, you're actually being a dick.  
+If you think you're being reasonable but most people think you're being a dick, then you're not being reasonable, you're actually being a dick.
 
-We're not computers - we're human beings.  And human beings are soft, squishy and emotional.  That's just how it is.  
+We're not computers - we're human beings.  And human beings are soft, squishy and emotional.  That's just how it is.

data/checksums/standard_procedure_fabrik-0.1.1.gem.sha512

@@ -0,0 +1 @@
+7946813b20b9d8a66c9fa421ead1466b55cd64170be817bd9f49c23aa69e9c9390a5d3b161640b0a5058669a0435c8431ca33a448c43ac42ae2f1c6cbaffc4e3

data/lib/fabrik/database.rb

@@ -91,7 +91,9 @@ module Fabrik
 
     private def default_attributes = @blueprint.default_attributes
 
-    private def find_or_create_record(attributes) = klass.find_by(**attributes.slice(*search_keys)) || create_record(attributes)
+    private def find_or_create_record(attributes) = find_record(attributes) || create_record(attributes)
+
+    private def find_record(attributes) = attributes.slice(*search_keys).empty? ? nil : klass.find_by(**attributes.slice(*search_keys))
 
     private def create_record(attributes)
       klass.create(**attributes_with_defaults(attributes)).tap do |record|
@@ -101,7 +103,7 @@ module Fabrik
 
     private def attributes_with_defaults attributes
       attributes_to_generate = default_attributes.keys - attributes.keys
-      attributes_to_generate.each_with_object({}) { |name, generated_attributes| generated_attributes[name] = default_attributes[name].call }.merge(attributes)
+      attributes_to_generate.each_with_object({}) { |name, generated_attributes| generated_attributes[name] = default_attributes[name].call(@db) }.merge(attributes)
     end
   end
 end

data/lib/fabrik/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fabrik
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standard_procedure_fabrik
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Rahoul Baruah
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-20 00:00:00.000000000 Z
+date: 2024-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,7 @@ files:
 - README.md
 - Rakefile
 - checksums/standard_procedure_fabrik-0.1.0.gem.sha512
+- checksums/standard_procedure_fabrik-0.1.1.gem.sha512
 - lib/fabrik.rb
 - lib/fabrik/database.rb
 - lib/fabrik/version.rb