firm 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f36086871785c4f7a5db75ed9e4b9272a4285c80c76335c7e09bd4eccdb2c939
-  data.tar.gz: 9936ecd659270cedddfd0d0d18fac176783b97aa7f9c52739fbe45abf1a107d8
+  metadata.gz: 744672f26853b28ea94b9a5cdc57c154784210f5bc845628dcdf874e54712db1
+  data.tar.gz: 759c1c816f8118589c56849a819f550a5b423653c262b7c5d802f7cfbe80065b
 SHA512:
-  metadata.gz: d4800195157b45b817aa2a700113c126b466b9ec53c342fb6e4473ae4bf6d9b463fe05b839ef65f1aa12db1d4e0a128d7026b10b6eacf5bb5e31c4891de1349b
-  data.tar.gz: 6893d0692e160627a8a2e1f5ed32de5181dde889778874d05955469e12074c90d7a3f377321dea7b25dd2178e3a97eddf55986f5ea65d6fe4e64f0130e9f0c4b
+  metadata.gz: d4c6b8e5073c818e434e947e915cfb0e02ab5c17606129398968715e0337d710ddcb9ae4f2c4237cb2a7dead4cd73897d7e6fe38e033fccd492fdbe6faa958af
+  data.tar.gz: e4ec51d139746ea55a389de5e9c93cbf16b52e4ae4357599719736613228902530b2a14d54546e5cdd0da3150fe70290184572f1954f8b32c6a1ea566cdae0e3

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])
@@ -93,7 +110,7 @@ module FIRM
       end
 
       def optional?(obj, val)
-        @optional && val == (Proc === @default ? @default.call(obj, @id) : @default)
+        @optional && (Proc === @default ? @default.call(obj, @id) : @default) == val
       end
       private :optional?
 

data/lib/firm/version.rb

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

metadata

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