standard_procedure_fabrik 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2742aab097f1a8977498b4b654829b4a6b9d54e98320a4e56a2c1419aeeb53ad
-  data.tar.gz: 34394ab7faa6707a2afcd4fa03d24fedc5ae84471c0f461b37ac70de5ef51ca5
+  metadata.gz: 60c8bb1ad20f4486e99e2ce3e3ef51895d30ddae6d64aa4f66e88dc27462cfe6
+  data.tar.gz: a1e4156f37806ead8bf2212a927192a851749abb16b55aac671ca7a99d42e2ec
 SHA512:
-  metadata.gz: c049dacfdaa1a044e70510216f244d3008e441f3cf950439e7862c7ed165a915e0f6b42787a3afdcca4d50be3bfd1408668308c6cab176196ffc26cad5053481
-  data.tar.gz: e814649e75c6cd9ea0a69d6705205b62ef91bc34b4bf545d093c616924bebe2ee84bfea09df4d0298dc294c759d44c7f4fdb7f6ee752c2a9b568e0dd7bcbdb04
+  metadata.gz: ad07c2c432fc4f59d1b01df21c8f71c41384bb4d99b53e8d2ad34fa8796724b4f12140fd5a49369a38b0624095272b79b6a15c35091b9adaee988c7a47e63f68
+  data.tar.gz: caca476f05265786a15ccdb16ed280236a0d5177d647ca5e2d18826bb05026442c7c0d4d48fcadc3aa5789b67a7380938ddf53d41199ebcc388b0f6cae1711f9

data/.devcontainer/devcontainer.json

@@ -0,0 +1,31 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+  "name": "Ruby",
+  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+  "image": "mcr.microsoft.com/devcontainers/ruby:1-3.3-bullseye",
+  // Features to add to the dev container. More info: https://containers.dev/features.
+  // "features": {},
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
+  // Use 'postCreateCommand' to run commands after the container is created.
+  // "postCreateCommand": "ruby --version",
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "Shopify.ruby-extensions-pack",
+        "testdouble.vscode-standard-ruby",
+        "manuelpuyol.erb-linter",
+        "Shopify.ruby-lsp",
+        "aki77.rails-db-schema",
+        "miguel-savignano.ruby-symbols",
+        "sibiraj-s.vscode-scss-formatter",
+        "Thadeu.vscode-run-rspec-file",
+        "Cronos87.yaml-symbols",
+        "aliariff.vscode-erb-beautify"
+      ]
+    }
+  }
+  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+  // "remoteUser": "root"
+}

data/Guardfile

@@ -0,0 +1,22 @@
+group :development do
+  guard :rspec, cmd: "bundle exec rspec" do
+    watch(%r{^spec/.+_spec.rb$})
+    watch(%r{^lib/(.+).rb$}) { "spec" }
+  end
+
+  guard :bundler do
+    require "guard/bundler"
+    require "guard/bundler/verify"
+    helper = Guard::Bundler::Verify.new
+
+    files = ["Gemfile"]
+    files += Dir["*.gemspec"] if files.any? { |f| helper.uses_gemspec?(f) }
+
+    # Assume files are symlinked from somewhere
+    files.each { |file| watch(helper.real_path(file)) }
+  end
+end
+
+guard :standardrb, fix: true, all_on_start: true, progress: true do
+  watch(/.+.rb$/)
+end

data/README.md

@@ -43,19 +43,30 @@ When you're writing a spec, you probably only care about one aspect of the model
 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
+@db = Fabrik.db
+@db.configure do
   with Person do
-    defaults first_name: ->(db) { "Alice" }, last_name: ->(db) { Faker::Name.last_name }, age: ->(db) { 33 }
+    first_name { Faker::Name.first_name }
+    last_name { Faker::Name.last_name }
+    email { |person| Faker::Internet.email(name: person.first_name) }
+    age 33
   end
 end
 
-@alice = db.people.create last_name: "Anteater"
+@alice = @db.people.create first_name: "Alice"
 
 puts @alice.first_name # => Alice
-puts @alice.last_name # => Anteater
+puts @alice.last_name # => Hermann
+puts @alice.email # => alice@some-domain.com
 puts @alice.age # => 33
 ```
 
+When specifying a default, you can either use a fixed value - for example `age 33`.  
+
+Or you can pass a block and use a dynamic value - for example `last_name { Faker::Name.last_name }`.
+
+If you pass a block, you can also access any attributes that have been generated so far - in this case we are accessing `person.first_name`.  Whilst attributes that were supplied in the call to `create` are generally safe, relying on values that were generated dynamically may not be.  The default value generators _should_ be called in the order of declaration, giving you access to dynamic values declared beforehand - but this is not guaranteed.  It's generally safer to avoid references when generating default values.  
+
 ### 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.
@@ -63,16 +74,17 @@ When you've got a database packed with existing data, you don't want your seeds
 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
+@db.configure do
   with Person do
-    search_using :email
+    unique :email
   end
 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 = @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
 puts @zac.first_name # => Alice
+puts @zac.last_name # => Aardvark
 ```
 
 ### Special processing
@@ -82,18 +94,18 @@ Some models are special.  They can't live on their own.  Their invariants won't
 So Fabrik lets you define specific processing that happens after a new record is created.
 
 ```ruby
-db.configure do
+@db.configure do
   with Company do
-    defaults name: -> { Faker::Company.name }
-    after_create do |company, db|
-      db.employees.create company: company, role: "CEO"
-    end
+    name { Faker::Company.name }
+    after_create { |company| employees.create company: company, role: "CEO" }
   end
   with Employee do
-    defaults first_name: -> { Faker::Name.first_name }, last_name: -> { Faker::Name.last_name }, role: -> { "Cleaner" }
+    first_name { Faker::Name.first_name }
+    last_name  { Faker::Name.last_name }
+    role "Cleaner"
   end
 end
-db.companies.create name: "MegaCorp"
+@db.companies.create name: "MegaCorp"
 puts Company.find_by(name: "MegaCorp").employees.size # => 1
 ```
 
@@ -104,9 +116,9 @@ You've created a load of models.  And you need to reference them to create more
 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"
+@db.people.create :alice, first_name: "Alice"
 
-puts db.people[:alice] # => Alice
+puts @db.people.alice # => Alice
 ```
 
 ## Classes and naming
@@ -120,7 +132,7 @@ class Intergalactic::Spaceship < ApplicationRecord
   # whatever
 end
 
-db.intergalactic_spaceships.create :ufo
+@db.intergalactic_spaceships.create :ufo
 
 puts Intergalactic::Spaceship.count # => 1
 ```
@@ -130,13 +142,13 @@ Or maybe you're writing a Rails engine and all your classes are namespaced.  Typ
 So Fabrik lets you register an alternative name for your classes.
 
 ```ruby
-db.configure do
+@db.configure do
   with MyAccountsPackageEngine::Invoice, as: :invoice do
-    defaults due_date: ->(db) { 7.days.from_now }
+    due_date { 7.days.from_now }
   end
 end
 
-db.invoices.create :overdue_invoice, due_date: 1.day.ago
+@invoice = @db.invoices.create
 ```
 
 ## Installation
@@ -151,15 +163,34 @@ If you're only using it for tests, add it to your `test` group.  If you're using
 
 ## Usage
 
-### Localised (for tests)
+### Global
+
+Most of the time, you can use the global `Fabrik.db` instance.  
+
+```ruby
+Fabrik.configure do
+  with Person do
+    first_name { Faker::Name.first_name }
+    last_name { Faker::Name.last_name }
+    email { 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.
+
+### Localised
 
 Create an instance of a [Fabrik::Database](/lib/fabrik/database.rb), configure it and use it.
 
 ```ruby
-db = Fabrik::Database.new
-db.configure do
+db = Fabrik::Database.new do
   with Person do
-    defaults first_name: ->(db) { Faker::Name.first_name }, last_name: ->(db) { Faker::Name.last_name }, email: ->(db) { Faker::Internet.email }
+    first_name { Faker::Name.first_name }
+    last_name { Faker::Name.last_name }
+    email { Faker::Internet.email }
   end
 end
 
@@ -170,9 +201,8 @@ In an RSpec:
 
 ```ruby
 RSpec.describe "Whatever" do
-  let(:db) { Fabrik::Database.new }
-  before do
-    db.configure do
+  let(:db) do 
+    Fabrik::Database.new do 
       # ... whatever
     end
   end
@@ -181,21 +211,6 @@ end
 
 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.
-
-```ruby
-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.
 
 ## Development
 

data/checksums/standard_procedure_fabrik-0.2.0.gem.sha512

@@ -0,0 +1 @@
+8d4ca660ab0691aa90bf0a3c61e8ef85765b746d5d575eeec1225bc6dc3c4fbb8fe8945e7020ec037f46f0d3a5fe6dc0f34b55bc1c0a364d949684220a7a15e9

data/checksums/standard_procedure_fabrik-0.2.1.gem.sha512

@@ -0,0 +1 @@
+0809cf506fe2cbf6b519100fb12c6799380f14991374e6cd2508fc33a6a1141e35f70d9e8b5d01a525df1cec660f99dc1e0f65c1e737c4001c482e76ed2f9553

data/lib/fabrik/database.rb

@@ -2,6 +2,7 @@
 
 require "active_support/core_ext/string"
 require "delegate"
+require "ostruct"
 
 module Fabrik
   class Database
@@ -9,7 +10,9 @@ module Fabrik
 
     def register(klass, as: nil, &block)
       blueprint_name = (as.nil? ? blueprint_name_for(klass) : as.to_s.pluralize).to_sym
-      @blueprints[blueprint_name] = Blueprint.new(klass, &block)
+      blueprint = Blueprint.new(klass, &block)
+      @blueprints[blueprint_name] = blueprint
+      @blueprints[klass] = blueprint
 
       define_singleton_method blueprint_name do
         proxy_for(blueprint_name)
@@ -19,25 +22,24 @@ module Fabrik
     end
     alias_method :with, :register
 
-    def defaults_for(klass) = blueprint_for(klass).default_attributes
+    def defaults_for(klass) = @blueprints[klass].default_attributes
 
-    def search_keys_for(klass) = blueprint_for(klass).search_keys
+    def unique_keys_for(klass) = @blueprints[klass].unique_keys
 
-    def after_create_for(klass) = blueprint_for(klass).callback
+    def after_create_for(klass) = @blueprints[klass].callback
 
     def method_missing(method_name, *, &block) = (klass = class_from(method_name)).nil? ? super : register(klass)
 
     def respond_to_missing?(method_name, include_private = false) = !class_from(method_name).nil? || super
 
-    def initialize
+    def initialize &config
       @blueprints = {}
       @records = {}
+      instance_eval(&config) unless config.nil?
     end
 
     private def blueprint_name_for(klass) = klass.name.split("::").map(&:underscore).join("_").pluralize
 
-    private def blueprint_for(klass) = @blueprints.values.find { |bp| bp.klass == klass }
-
     private def proxy_for(blueprint_name)
       @records[blueprint_name] ||= Proxy.new(self, @blueprints[blueprint_name])
     end
@@ -51,32 +53,42 @@ module Fabrik
   end
 
   class Blueprint
-    attr_reader :klass, :default_attributes, :search_keys, :callback
+    attr_reader :klass, :default_attributes, :unique_keys, :callback
 
     def defaults(**default_attributes) = @default_attributes = default_attributes
 
-    def search_using(*keys) = @search_keys = keys
+    def unique(*keys) = @unique_keys = keys
 
     def after_create(&block) = @callback = block
 
-    def call_after_create(record, db) = @callback&.call(record, db)
+    def call_after_create(record, db) = @callback.nil? ? nil : db.instance_exec(record, &@callback)
+
+    def method_missing(method_name, *args, &block)
+      @default_attributes[method_name.to_sym] = args.first.nil? ? block : ->(_) { args.first }
+    end
+
+    def respond_to_missing?(method_name, include_private = false) = @default_attributes.key?(method_name.to_sym) || super
 
     def initialize(klass, &block)
       @klass = klass
       @default_attributes = {}
-      @search_keys = []
-      instance_eval(&block) if block_given?
+      @unique_keys = []
+      instance_eval(&block) unless block.nil?
     end
   end
 
   class Proxy < SimpleDelegator
     def create(label = nil, **attributes)
-      (@blueprint.search_keys.any? ? find_or_create_record(attributes) : create_record(attributes)).tap do |record|
+      (@blueprint.unique_keys.any? ? find_or_create_record(attributes) : create_record(attributes)).tap do |record|
         @records[label.to_sym] = record if label
       end
     end
 
-    def [](label) = @records[label.to_sym]
+    def method_missing(method_name, *args, &block)
+      @records[method_name.to_sym]
+    end
+
+    def respond_to_missing?(method_name, include_private = false) = @@records.key?(label.to_sym) || super
 
     def initialize(db, blueprint)
       @db = db
@@ -85,7 +97,7 @@ module Fabrik
       super(klass)
     end
 
-    private def search_keys = @blueprint.search_keys
+    private def unique_keys = @blueprint.unique_keys
 
     private def klass = @blueprint.klass
 
@@ -96,7 +108,7 @@ module Fabrik
       find_record(attributes) || create_record(attributes)
     end
 
-    private def find_record(attributes) = attributes.slice(*search_keys).empty? ? nil : klass.find_by(**attributes.slice(*search_keys))
+    private def find_record(attributes) = attributes.slice(*unique_keys).empty? ? nil : klass.find_by(**attributes.slice(*unique_keys))
 
     private def create_record(attributes)
       klass.create(**attributes_with_defaults(attributes)).tap do |record|
@@ -106,7 +118,9 @@ 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(@db) }.merge(attributes)
+      attributes_to_generate.each_with_object(OpenStruct.new(**attributes)) do |name, generated_attributes|
+        generated_attributes[name] = default_attributes[name].nil? ? nil : @db.instance_exec(generated_attributes, &default_attributes[name])
+      end.to_h.merge(attributes)
     end
   end
 end

data/lib/fabrik/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: standard_procedure_fabrik
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Rahoul Baruah
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-29 00:00:00.000000000 Z
+date: 2025-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,7 +24,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 6.0.0
 - !ruby/object:Gem::Dependency
-  name: standard-procedure-plumbing
+  name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -45,15 +44,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devcontainer/devcontainer.json"
 - ".rspec"
 - ".standard.yml"
 - CHANGELOG.md
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
 - checksums/standard_procedure_fabrik-0.1.0.gem.sha512
 - checksums/standard_procedure_fabrik-0.1.1.gem.sha512
 - checksums/standard_procedure_fabrik-0.1.2.gem.sha512
+- checksums/standard_procedure_fabrik-0.2.0.gem.sha512
+- checksums/standard_procedure_fabrik-0.2.1.gem.sha512
 - lib/fabrik.rb
 - lib/fabrik/database.rb
 - lib/fabrik/version.rb
@@ -66,7 +69,6 @@ metadata:
   homepage_uri: https://www.theartandscienceofruby.com
   source_code_uri: https://github.com/standard-procedure/fabrik
   changelog_uri: https://github.com/standard-procedure/fabrik/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -81,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Fabrik
 test_files: []