recordables 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7355a9bfb7d1440a8b7746b13b4fa810304eb837c97d8dc850011d12091241b6
-  data.tar.gz: 4f13296e03d0467244273af7f96566d21129d48013ec3279d2967236806181a5
+  metadata.gz: 2a183a373143cdec754a8704fb66131ddc8980930ebb3a6e16d7a42309bcdd1f
+  data.tar.gz: eb62d04c3f09067fa95221810da3cdcb4acdf704052ddd88059893735e7b521d
 SHA512:
-  metadata.gz: 8053edc2e2c5cfa59c71c19658f2faba977bbc29e48b933d6eccd3086a548bb5d76ebcb6a0f65e8e8468f60694587a9c47b76ce2ee8c47a286f3fb631318868b
-  data.tar.gz: 504f8827f44890f43442e17f3af80874feb8dcdd88685f362e7e6bd78a00266e2e7710c387ad331480bc67e741facffdc897d97b9bc66eba13749f80b306fcab
+  metadata.gz: 33f79c5525fce7dc3cf40c345c77f38d99f7a511cafca9c7be1b5412b5177ca6dd3722346e7b3365ca7e2c71eb1fbc1d9c8c70ca03de34d6a78f0faacb3c2158
+  data.tar.gz: 60c51aa0167f1ac34132cab455cbace4275635f8be85157ac183f5394b26062e3e6506373c8fa7e9d59b6ec6b59bda517f5f1203fd14a8fada865b1e66a90eab

data/CHANGELOG.md

@@ -8,6 +8,18 @@ All notable changes to this project are documented here. The format follows
 
 ### Added
 
+- `nested_recordable_attributes_for` accepts `recording_attributes:`, an optional proc
+  called once per new child (with the parent record) to build extra attributes for that
+  child's Recording. Without it, `apply_#{plural}_attributes!` creating a new child had
+  no way to set anything beyond `actor:` and the child's own fields — any host app whose
+  Recording has its own required columns (an `account_id` or similar tenant column is
+  the common case) hit a hard `NOT NULL` failure the moment a form actually submitted a
+  new child row.
+
+## [0.2.0]
+
+### Added
+
 - `trashable` — `default_scope` + `with_trashed` for a recordable type whose Recording
   can be trashed, so a trashed row stops showing up in normal queries. Paired with
   `Recording.active` and `Recording#trash!`.

data/lib/recordables/macros.rb

@@ -81,12 +81,17 @@ module Recordables
     #   class RoutineTemplate < ApplicationRecord
     #     recordable
     #     has_children :task_templates, class_name: "TaskTemplate"
-    #     nested_recordable_attributes_for :task_templates, class_name: "TaskTemplate"
+    #     nested_recordable_attributes_for :task_templates, class_name: "TaskTemplate",
+    #       recording_attributes: ->(template) { { account: template.account } }
     #   end
-    def nested_recordable_attributes_for(plural_name, class_name: nil)
+    #
+    # recording_attributes: only needed if the host app's Recording has its
+    # own required columns (an account_id or similar tenant column is the
+    # common case) — see Recordables::NestedRecordableAttributes.
+    def nested_recordable_attributes_for(plural_name, class_name: nil, recording_attributes: nil)
       include Recordables::NestedRecordableAttributes
       target_class_name = class_name&.to_s || plural_name.to_s.classify
-      __recordables_define_nested_attributes(plural_name, class_name: target_class_name)
+      __recordables_define_nested_attributes(plural_name, class_name: target_class_name, recording_attributes: recording_attributes)
     end
 
     # A belongs_to whose target is trashable, resolved through the append-only

data/lib/recordables/nested_recordable_attributes.rb

@@ -7,9 +7,17 @@ module Recordables
   #   class RoutineTemplate < ApplicationRecord
   #     recordable
   #     has_children :task_templates, class_name: "TaskTemplate"
-  #     nested_recordable_attributes_for :task_templates, class_name: "TaskTemplate"
+  #     nested_recordable_attributes_for :task_templates, class_name: "TaskTemplate",
+  #       recording_attributes: ->(template) { { account: template.account } }
   #   end
   #
+  # recording_attributes: is only needed if the host app's Recording has its
+  # own required columns beyond what the gem's own template generates (an
+  # account_id or similar tenant column is the common case) — a new child's
+  # Recording needs those set too, and there's no attribute on the
+  # submitted form row itself to read them from. Called once per new child,
+  # with the parent record, right before creating it.
+  #
   # accepts_nested_attributes_for can't work here: it writes at
   # assign_attributes time, straight to a real association's rows — but
   # task_templates isn't a real has_many (see HasChildren), and a child
@@ -30,7 +38,7 @@ module Recordables
     extend ActiveSupport::Concern
 
     class_methods do
-      def __recordables_define_nested_attributes(plural_name, class_name:)
+      def __recordables_define_nested_attributes(plural_name, class_name:, recording_attributes:)
         singular_name = plural_name.to_s.singularize
         target_class_name = class_name.to_s
         pending_ivar = :"@pending_#{plural_name}_attributes"
@@ -88,7 +96,8 @@ module Recordables
                 child.recording.revise(actor: actor, **changes)
               end
             elsif !destroy && changes.present?
-              public_send(:"add_#{singular_name}", actor: actor, **changes)
+              extra_recording_attrs = recording_attributes ? recording_attributes.call(self) : {}
+              public_send(:"add_#{singular_name}", actor: actor, recording: extra_recording_attrs, **changes)
             end
           end
 

data/lib/recordables/version.rb

@@ -1,3 +1,3 @@
 module Recordables
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: recordables
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jonas Medeiros