firm 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f36086871785c4f7a5db75ed9e4b9272a4285c80c76335c7e09bd4eccdb2c939
-  data.tar.gz: 9936ecd659270cedddfd0d0d18fac176783b97aa7f9c52739fbe45abf1a107d8
+  metadata.gz: 9bde55f78b14c4b8c8cac20c709c2826391616cf5d30972bcdeff2613d9389f5
+  data.tar.gz: f4e7a9b3269ea524699693968c88d75372f6bf51dbe54c7e61b3bee349da3b71
 SHA512:
-  metadata.gz: d4800195157b45b817aa2a700113c126b466b9ec53c342fb6e4473ae4bf6d9b463fe05b839ef65f1aa12db1d4e0a128d7026b10b6eacf5bb5e31c4891de1349b
-  data.tar.gz: 6893d0692e160627a8a2e1f5ed32de5181dde889778874d05955469e12074c90d7a3f377321dea7b25dd2178e3a97eddf55986f5ea65d6fe4e64f0130e9f0c4b
+  metadata.gz: 3768d2dda3e137c33b54ecfe27eda8f052c9eb8e21809e9e8f82eb434f9ce381fdf5cd430d9d118aacb75a6047c4db2bd175d2e9937be3fccc6b587f8cc0b683
+  data.tar.gz: 329dff1413b582f472b099181769c16afc91aeaa9fe6b827b1cb753be68df14d6dbda11e5d60f3da77e97feb22833b7b78db0a231b09a605c5f78d79845f16e0

data/lib/firm/serializable.rb

@@ -11,6 +11,7 @@ module FIRM
 
     class Exception < RuntimeError; end
 
+    # This class encapsulates a serializable property definition.
     class Property
       def initialize(klass, prop, proc=nil, force: false, handler: nil, optional: false, &block)
         ::Kernel.raise ArgumentError, "Invalid property id [#{prop}]" unless ::String === prop || ::Symbol === prop
@@ -70,6 +71,11 @@ module FIRM
 
       attr_reader :id
 
+      # Serializes the defined property for the given object and inserts the serialized data
+      # into the given data object unless included in the given excludes list.
+      # @param [Object] obj
+      # @param [Object] data hash-like object
+      # @param [Array<Symbol>] excludes
       def serialize(obj, data, excludes)
         unless excludes.include?(@id)
           val = getter.call(obj)
@@ -86,6 +92,17 @@ module FIRM
         end
       end
 
+      # Returns the (unserialized) property value for the given object.
+      # @param [Object] obj
+      def get(obj)
+        getter.call(obj)
+      end
+
+      # Restores the defined property for the given object using the deserialized data
+      # extracted from the given data object.
+      # @param [Object] obj
+      # @param [Object] data hash-like object
+      # @return [void]
       def deserialize(obj, data)
         if data.has_key?(@id)
           setter.call(obj, data[@id])

data/lib/firm/version.rb

@@ -4,6 +4,6 @@
 module FIRM
 
   # FIRM version
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firm
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Martin Corino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-05 00:00:00.000000000 Z
+date: 2024-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake