standard_procedure_has_attributes 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fd9d76cb1b8d6eca0e2be02212fb237a1f49c1c014010dc71ddca9678ea247a
-  data.tar.gz: f66ffafac490c8ad1d0915b20bcd56caa2be7eb0a622134785f00c0c4d6f779b
+  metadata.gz: 95b72e89130c7a9ae47a13d0494fc1db6e226270afd199d485784b00a0d8c1d9
+  data.tar.gz: 74bb291b713e6411ec4beafc93037b3c820f5a43679a2ed14dbf002cbf241e1a
 SHA512:
-  metadata.gz: bf4fe8a2fd19fadd3a8f6838e1ff2df9798a4880049cf36f46be7a39402abe5bc9fd0d7f7c940deb13d22aa6661c902dea5c38dd97bb4826de8812883787c40a
-  data.tar.gz: 7527db1e32925575be31abd9f887231245782d31f86df335d543cc62924d304724d1c84552ae22131c193c751257da228f3080cfc96ccafceed6e36165534bef
+  metadata.gz: 454619f884749f7b3574ab27849b7a05af02fb2771fd7da1b23659929ac74387e3e1e4ca3a86d758036e2e46c0fa7d8b25b550d6cc1140a9ff558a923d8f8c04
+  data.tar.gz: 7c637ddb9731fd644075fcee07f62130037cf51bd70b64fce1cf53ceb45402a776ee10687b2579d9595ef07803d3eccf9a77c739f35ec50aefcf00ae78d0be81

data/README.md

@@ -71,10 +71,16 @@ Apart from storage, the attribute behaves just like any other attribute on your
 
 ### Defining models 
 
-You can also store references to other models using the `has_model` declaration.  This stores a [GlobalID](https://github.com/rails/globalid) inside the data field, converting the reference back to a real model when needed.  The actual GlobalID is mangled slightly before it is stored, to provide compatibility with the [GlobalIdSerialiser](https://github.com/standard-procedure/global_id_serialiser), which also uses GlobalIDs to store references to models.  The difference with `has_model` is `has_model` reloads the model on-demand, whereas `GlobalIdSerialiser` loads all models from the data field when the record is loaded.  GlobalIdSerialiser also allows you to store your models within arrays or nested inside hashes - but you need to be careful about the performance implications if lots of models are stored.  
+You can also store references to other models using the `has_model` declaration.  This stores a [GlobalID](https://github.com/rails/globalid) inside the data field, converting the reference back to a real model when needed.  `has_model` reloads the model on-demand so there is no database request until you actually try to access the stored model.  However, because of the way this works, you cannot eager-load stored models, so be careful when trying to display large numbers of records, as you will end up with N+1 queries.  
 
 When using `has_model` you can optionally specify a class name (as a string).  If given, the model will be tested to make sure it is that class (or a subclass of it) and, if not the record is marked as invalid.  
 
+### Defining arrays of models
+
+Similarly, you can store arrays of models using the `has_models` declaration.  Internally this stores a comma separated list of GlobalIDs inside the data field, using `GlobalID::Locator.locate_many` to convert the array back to models as efficiently as possible.  Again, eager loading is not possible so watch out for N+1 queries.  
+
+Like `has_model` you can optionally specify a class name (as a string), which then validates the provided models to make sure they are valid classes or subclasses.  
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/checksums/standard_procedure_has_attributes-0.2.0.gem.sha512

@@ -0,0 +1 @@
+a81ee1c0a59142295d6bbfddefd39697884c3de3b911836c49d8f51ffa75b73c21ffe2efa1a7ac90235b640ce5aa07d378d09f4f4b76371a416885704d1a184a

data/lib/has_attributes/version.rb

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

data/lib/has_attributes.rb

@@ -3,7 +3,7 @@
 require_relative "has_attributes/version"
 require "active_support/concern"
 require "active_support/core_ext/string/inflections"
-require "global_id_serialiser"
+require "global_id"
 
 module HasAttributes
   extend ActiveSupport::Concern
@@ -12,7 +12,7 @@ module HasAttributes
   class_methods do
     def has_attribute name, cast_type = :string, field_name: :data, **options
       field_name = field_name.to_sym
-      name = name.to_sym
+      name = name.to_s
       typecaster = cast_type.nil? ? nil : ActiveRecord::Type.lookup(cast_type)
       typecast_value = ->(value) { typecaster.nil? ? value : typecaster.cast(value) }
       define_attribute_method name
@@ -38,7 +38,7 @@ module HasAttributes
       validate :"#{name}_class_name", if: -> { send(name).present? } if class_name.present?
 
       define_method(name.to_sym) do
-        model_id = send id_attribute
+        model_id = send id_attribute.to_sym
         model_id.nil? ? nil : GlobalID::Locator.locate(model_id.sub("modelid-", ""))
       rescue ActiveRecord::RecordNotFound
         nil
@@ -53,5 +53,32 @@ module HasAttributes
         errors.add name, :invalid unless send(name).is_a?(class_name.constantize)
       end
     end
+
+    def has_models name, class_name = nil, field_name: :data, **options
+      name = name.to_sym
+      array_attribute = "#{name}_array"
+      has_attribute array_attribute, field_name:, **options
+      validate :"#{name}_class_names", if: -> { send(name).any? } if class_name.present?
+
+      define_method(name.to_sym) do
+        model_ids = send(array_attribute).to_s.split(",").map do |model_id|
+          model_id.to_s.sub("modelid-", "")
+        end
+        GlobalID::Locator.locate_many(model_ids)
+      rescue ActiveRecord::RecordNotFound
+        []
+      end
+
+      define_method(:"#{name}=") do |models|
+        model_ids = Array.wrap(models).map do |model|
+          model.nil? ? nil : "modelid-#{model.to_global_id}"
+        end.compact
+        send :"#{array_attribute}=", model_ids.join(",")
+      end
+
+      define_method :"#{name}_class_names" do
+        errors.add name, :invalid if send(name).any? { |model| !model.is_a?(class_name.constantize) }
+      end
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: standard_procedure_has_attributes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Rahoul Baruah
 bindir: exe
 cert_chain: []
-date: 2025-06-13 00:00:00.000000000 Z
+date: 2025-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -23,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: globalid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 description: Store Rails attributes in a serialized JSON field, with support for GlobalIDs
   and indexes
 email:
@@ -38,6 +52,7 @@ files:
 - README.md
 - Rakefile
 - checksums/standard_procedure_has_attributes-0.1.0.gem.sha512
+- checksums/standard_procedure_has_attributes-0.2.0.gem.sha512
 - lib/has_attributes.rb
 - lib/has_attributes/version.rb
 - sig/has_attributes.rbs