oaken 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d441d9ce6156b7fa0f30b188f1f1e09a065292fb520c8415e8eae3e3b3f6aef
-  data.tar.gz: b69bc4be147d5dca48ded82969b8abee63f10fd81b53015bf3c236d2abfcaadc
+  metadata.gz: 81f5e7a3ea1f5236b6e2726d1ecd24dee5698b59dc5e73f80ce618181b1dffe1
+  data.tar.gz: 6c4628800cdc44acd516a8e51a708fdee3d63ce506679fa5bc742b337da5c725
 SHA512:
-  metadata.gz: 22c8eb550e6564429fed5302807d5586b77f8e19c2a5c097d168d23dec0bec25f8595db8a79ee654cdc24f67b7c1dbcb8c758c0dab38ffb03ccb823374e5ce94
-  data.tar.gz: 7dcd270301eb5994cdfac1c2630e9a0c27ba45df0bf851f54dc78e47273625e8500bf357649eab7f04481ae8bb4bc68144813eb831229bc66814df0196defe33
+  metadata.gz: 5257b630ef4ac76db5b9fceb161df47d71e1df3481d1fdcd45fb1ac35319a72568d084f6e48a158cca3217512382890d5919111f329b08798f388e46d4ff5014
+  data.tar.gz: 2b91b6caeede127715691ecdeab3b8355ba273d9105b11f52579f7c4da2dcfefb7bfbc243ee4cc7b7de2af6401e95e195b4c377d31502ddd0162043e243c07aa

data/README.md

@@ -64,6 +64,23 @@ Oaken has some chosen directory conventions to help strengthen your understandin
 - `db/seeds/data` for any data tables, like the plans a SaaS app has.
 - `db/seeds/tests/cases` for any specific cases that are only used in some tests, like `pagination.rb`.
 
+### Using default attributes
+
+You can set up default attributes that's applied to created/inserted records at different levels, like this:
+
+```ruby
+Oaken.prepare do
+  # Assign broad global defaults for every type.
+  defaults name: -> { Faker::Name.name }, public_key: -> { SecureRandom.hex }
+
+  # Assign a more specific default on one type, which overrides the global default above.
+  accounts.defaults name: -> { Faker::Business.name }
+end
+```
+
+> [!TIP]
+> `defaults` are particularly well suited for assigning generated data with [Faker](https://github.com/faker-ruby/faker).
+
 ### Reusing data in tests
 
 With the setup above, Oaken can reuse the same data in tests like this:
@@ -77,6 +94,12 @@ end
 
 Now tests have access to `accounts.kaspers_donuts` and `users.kasper` etc. that were setup in the data scripts.
 
+> [!NOTE]
+> For RSpec, you can put this in `spec/rails_helper.rb`:
+> ```ruby
+> require "oaken/rspec_setup"
+> ```
+
 You can also load a specific seed, like this:
 
 ```ruby
@@ -113,7 +136,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `cd test/dummy` and `bin/rails test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rails test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/lib/oaken/rspec_setup.rb

@@ -1,9 +1,8 @@
 RSpec.configure do |config|
-  config.include(Oaken::Seeds)
-
+  config.include Oaken::Seeds
   config.use_transactional_fixtures = true
 
-  config.before(:suite) do
+  config.before :suite do
     # Mimic fixtures by truncating before inserting.
     ActiveRecord::Tasks::DatabaseTasks.truncate_all
     Oaken.load_seed

data/lib/oaken/seeds.rb

@@ -1,16 +1,43 @@
 module Oaken::Seeds
   extend self
 
-  def self.method_missing(name, ...)
-    if type = name.to_s.classify.safe_constantize
+  # Allow assigning defaults across different types.
+  def self.defaults(**defaults) = attributes.merge!(**defaults)
+  def self.defaults_for(*keys) = attributes.slice(*keys)
+  def self.attributes = @attributes ||= {}.with_indifferent_access
+
+  # Oaken's main auto-registering logic.
+  #
+  # So when you first call e.g. `accounts.create`, we'll hit `method_missing` here
+  # and automatically call `register Account`.
+  #
+  # We'll also match partial and full nested namespaces like in this order:
+  #
+  #   accounts => Account
+  #   account_jobs => AccountJob | Account::Job
+  #   account_job_tasks => AccountJobTask | Account::JobTask | Account::Job::Task
+  #
+  # If you have classes that don't follow this naming convention, you must call `register` manually.
+  def self.method_missing(meth, ...)
+    name = meth.to_s.classify
+    name = name.sub!(/(?<=[a-z])(?=[A-Z])/, "::") until name.nil? or type = name.safe_constantize
+
+    if type
       register type
-      public_send(name, ...)
+      public_send(meth, ...)
     else
       super
     end
   end
   def self.respond_to_missing?(name, ...) = name.to_s.classify.safe_constantize || super
 
+  # Register a model class to be accessible as an instance method via `include Oaken::Seeds`.
+  # Note: Oaken's auto-register via `method_missing` means it's less likely you need to call this manually.
+  #
+  #   register Account, Account::Job, Account::Job::Task
+  #
+  # Oaken uses the `table_name` of the passed classes for the method names, e.g. here they'd be
+  # `accounts`, `account_jobs`, and `account_job_tasks`, respectively.
   def self.register(*types)
     types.each do |type|
       stored = provider.new(type) and define_method(stored.key) { stored }

data/lib/oaken/stored/active_record.rb

@@ -1,7 +1,7 @@
 class Oaken::Stored::ActiveRecord
   def initialize(type)
     @type, @key = type, type.table_name
-    @attributes = {}
+    @attributes = Oaken::Seeds.defaults_for(*type.column_names)
   end
   attr_reader :type, :key
   delegate :transaction, to: :type # For multi-db setups to help open a transaction on secondary connections.

data/lib/oaken/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Oaken
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/lib/oaken.rb

@@ -18,17 +18,12 @@ module Oaken
 
   class Loader
     def initialize(path)
-      @entries = Pathname.glob("#{path}{,/**/*}.{rb,sql}").sort
+      @entries = Pathname.glob("#{path}{,/**/*}.rb").sort
     end
 
-    def load_onto(seeds)
-      @entries.each do |path|
-        ActiveRecord::Base.transaction do
-          case path.extname
-          when ".rb"  then seeds.class_eval path.read, path.to_s
-          when ".sql" then ActiveRecord::Base.connection.execute path.read
-          end
-        end
+    def load_onto(seeds) = @entries.each do |path|
+      ActiveRecord::Base.transaction do
+        seeds.class_eval path.read, path.to_s
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oaken
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Kasper Timm Hansen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-13 00:00:00.000000000 Z
+date: 2024-06-30 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -53,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.10
 signing_key:
 specification_version: 4
 summary: Oaken aims to blend your Fixtures/Factories and levels up your database seeds.