firm 0.9.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70fc573f0deb51e97747caf3a36ccfabb8e93a0ff8cb72f0de16e877eeb9713b
-  data.tar.gz: 66811b4933baeaa1e555223fa554292339534a5de8d4de66bbd2fe4d26db1633
+  metadata.gz: 0ebb1f6594b3ecc4e56863a0f04ce3eb44fc5bfad0218a183298b44e56e9cf8e
+  data.tar.gz: 4e2349b45ae0479c968406fcd2eafb7ac4e76c8317cbbeeea20ecb784e998115
 SHA512:
-  metadata.gz: a37bb0eb3d1aaffed3531979640070f7048e899c93206c61f2e9377bf256f923b4c70f19d1cd8bedc486a94b124803e6f7cd2b42419a65c2746e8f19ca1db432
-  data.tar.gz: 8fe43c7d9828632f27c0e12271250c85b06662ffd9969d3feefb4c9e78f653fc993c42361fcb38dc8e719c2c75601e9da603b26c8ee83736b9d3d991750ef963
+  metadata.gz: 247ca7e7c9eb24fc5ca31c8cfb3f06ec9e4c3779627f3e35722d2c51a630c255cc4d182d434d35da7207f112b0905635a5717fd767f3c904a251b7ab84873cbd
+  data.tar.gz: 2953c510c88ed9078f777a0c8e23399f48339ef5f6c85fcf264fe025de795ecc187407d7d7bddf77b89dbb182eb158123e62aad909c91fbfffc04f613cf8280f

data/README.md

@@ -8,11 +8,11 @@
 
 ## Introduction
 
-FIRM is a pure Ruby library that works across different Ruby implementations like MRI Ruby and JRuby providing output 
-format independent object (de-)serialization support.
+FIRM is a pure Ruby library that works across different Ruby implementations like MRI Ruby and JRuby providing format 
+independent object (de-)serialization support.
 
 FIRM is explicitly **NOT** intended as a non-discriminative marshaling library (dumping any object's attributes)
-but rather as structured and safe serialization library requiring users to think about what state they want
+but rather as a structured and safe serialization library requiring users to think about what state they want
 persisted (and possibly in what form) and what not.
 Straightforward attribute serialization is simple with minimal intrusion on user code.
 In addition various customization options are available to tweak (de-)serialization for a perfect fit if needed. 
@@ -39,20 +39,21 @@ FIRM supports (de-)serializing many core Ruby objects out of the box including:
 - `Time`
 - `Struct`
 - `Set`
-- `OpenStruct`
+- `OpenStruct` (optional starting from Ruby 3.5 which removes this class from the standard library)
 - `Date`
 - `DateTime`
 
-For security reasons FIRM does **not** support direct (de-)serializing of `Class` objects but will rather
+For simplicity and security reasons FIRM does **not** support direct (de-)serializing of `Class` objects but will rather
 serialize (and deserialize) these as their scoped string names. Customized property setters can be used to
 resolve Class objects from these names if really needed.
 
-FIRM also supports a simple scheme to provide (de-)serialization support for user defined classes. 
+Serialization support for user defined classes is available through a simple DSL scheme.
 
 FIRM provides object aliasing support for JSON and XML in a similar fashion as the standard support provided
-by YAML.
+by YAML.<br>
+In addition FIRM automatically recognizes and handles cyclic references of aliasable objects.
 
-FIRM also automatically recognizes and handles cyclic references of aliasable objects.
+FIRM serialization is also thread safe and supports re-entrancy (i.e. nested serialization).
 
 ## Installing FIRM
 

data/lib/firm/serialize/core.rb

@@ -32,12 +32,20 @@ module FIRM
 end
 
 require 'set'
-require 'ostruct'
+# from Ruby 3.5.0 OpenStruct will not be available by default anymore
+begin
+  require 'ostruct'
+rescue LoadError
+end
 
-[::Array, ::Hash, ::Struct, ::Range, ::Rational, ::Complex, ::Regexp, ::Set, ::OpenStruct, ::Time, ::Date, ::DateTime].each do |c|
+[::Array, ::Hash, ::Struct, ::Range, ::Rational, ::Complex, ::Regexp, ::Set, ::Time, ::Date, ::DateTime].each do |c|
   c.include FIRM::Serializable::CoreExt
 end
 
+if ::Object.const_defined?(:OpenStruct)
+  ::OpenStruct.include FIRM::Serializable::CoreExt
+end
+
 if ::Object.const_defined?(:BigDecimal)
   ::BigDecimal.include FIRM::Serializable::CoreExt
 end

data/lib/firm/serializer/json.rb

@@ -14,7 +14,12 @@ require 'json/add/bigdecimal' if ::Object.const_defined?(:BigDecimal)
 require 'json/add/rational'
 require 'json/add/complex'
 require 'json/add/set'
-require 'json/add/ostruct'
+# from Ruby 3.5.0 OpenStruct will not be available by default anymore
+begin
+  require 'ostruct'
+  require 'json/add/ostruct'
+rescue LoadError
+end
 
 module FIRM
 
@@ -22,6 +27,8 @@ module FIRM
 
     module JSON
 
+      CREATE_ID = 'rbklass'.freeze
+
       # Derived Hash class to use for deserialized JSON object data which
       # supports using Symbol keys.
       class ObjectHash < ::Hash
@@ -107,7 +114,8 @@ module FIRM
       class << self
         def serializables
           set = ::Set.new( [::NilClass, ::TrueClass, ::FalseClass, ::Integer, ::Float, ::String, ::Array, ::Hash,
-                     ::Date, ::DateTime, ::Range, ::Rational, ::Complex, ::Regexp, ::Struct, ::Symbol, ::Time, ::Set, ::OpenStruct])
+                     ::Date, ::DateTime, ::Range, ::Rational, ::Complex, ::Regexp, ::Struct, ::Symbol, ::Time, ::Set])
+          set << ::OpenStruct if ::Object.const_defined?(:OpenStruct)
           set << ::BigDecimal if ::Object.const_defined?(:BigDecimal)
           set
         end
@@ -156,6 +164,8 @@ module FIRM
         begin
           # initialize anchor registry
           Serializable::Aliasing.start_anchor_object_registry
+          # set custom (more compact) create_id
+          ::JSON.create_id = Serializable::JSON::CREATE_ID
           for_json = obj.respond_to?(:as_json) ? obj.as_json : obj
           if pretty
             if io || io.respond_to?(:write)
@@ -179,6 +189,8 @@ module FIRM
           Serializable::Aliasing.start_anchor_references
           # enable safe deserializing
           self.start_safe_deserialize
+          # set custom (more compact) create_id
+          ::JSON.create_id = Serializable::JSON::CREATE_ID
           ::JSON.parse!(source,
                         create_additions: true,
                         object_class: Serializable::JSON::ObjectHash)
@@ -407,21 +419,23 @@ class ::Struct
   end
 end
 
-class ::OpenStruct
-  include FIRM::Serializable::JSON::ContainerPatch
+if ::Object.const_defined?(:OpenStruct)
+  class ::OpenStruct
+    include FIRM::Serializable::JSON::ContainerPatch
 
-  class << self
-    # Create a new OpenStruct instance from deserialized JSON data.
-    # @param [Hash] object deserialized JSON object
-    # @return [OpenStruct] restored OpenStruct instance
-    def json_create(object)
-        json_new(object) { |instance| object['t'].each { |k,v| instance[k] = v } }
+    class << self
+      # Create a new OpenStruct instance from deserialized JSON data.
+      # @param [Hash] object deserialized JSON object
+      # @return [OpenStruct] restored OpenStruct instance
+      def json_create(object)
+          json_new(object) { |instance| object['t'].each { |k,v| instance[k] = v } }
+      end
     end
-  end
 
-  def as_json(*)
-    build_json do |json_data|
-      json_data['t'] = table.collect { |k,v| [k.respond_to?(:as_json) ? k.as_json : k, v.respond_to?(:as_json) ? v.as_json : v] }
+    def as_json(*)
+      build_json do |json_data|
+        json_data['t'] = table.collect { |k,v| [k.respond_to?(:as_json) ? k.as_json : k, v.respond_to?(:as_json) ? v.as_json : v] }
+      end
     end
   end
 end

data/lib/firm/serializer/xml.rb

@@ -3,7 +3,11 @@
 
 
 require 'set'
-require 'ostruct'
+# from Ruby 3.5.0 OpenStruct will not be available by default anymore
+begin
+  require 'ostruct'
+rescue LoadError
+end
 require 'date'
 
 module FIRM
@@ -60,7 +64,7 @@ module FIRM
             def to_xml(_, _)
               raise Serializable::Exception, "Missing serialization method for #{klass} XML handler"
             end
-            def from_xml(xml)
+            def from_xml(_xml)
               raise Serializable::Exception, "Missing serialization method for #{klass} XML handler"
             end
           end
@@ -181,7 +185,7 @@ module FIRM
             create_type_node(xml).add_child(Nokogiri::XML::CDATA.new(xml.document, value.name))
             xml
           end
-          def from_xml(xml)
+          def from_xml(_xml)
             # should never be called
             raise Serializable::Exception, 'Unsupported Class deserialization'
           end
@@ -291,10 +295,9 @@ module FIRM
           end
           def from_xml(xml)
             create_from_xml(xml) do |instance|
-              xml.elements.inject(instance) do |hash, pair|
+              xml.elements.each do |pair|
                 k, v = pair.elements
                 instance[Serializable::XML.from_xml(k)] = Serializable::XML.from_xml(v)
-                instance
               end
             end
           end
@@ -434,22 +437,23 @@ module FIRM
           end
         end
 
-        define_xml_handler(::OpenStruct, aliasable: true) do
-          def to_xml(xml, value)
-            build_xml(xml, value) do |node|
-              value.each_pair do |k,v|
-                pair = node.add_child(Nokogiri::XML::Node.new('P', node.document))
-                Serializable::XML.to_xml(pair, k)
-                Serializable::XML.to_xml(pair, v)
+        if ::Object.const_defined?(:OpenStruct)
+          define_xml_handler(::OpenStruct, aliasable: true) do
+            def to_xml(xml, value)
+              build_xml(xml, value) do |node|
+                value.each_pair do |k,v|
+                  pair = node.add_child(Nokogiri::XML::Node.new('P', node.document))
+                  Serializable::XML.to_xml(pair, k)
+                  Serializable::XML.to_xml(pair, v)
+                end
               end
             end
-          end
-          def from_xml(xml)
-            create_from_xml(xml) do |instance|
-              xml.elements.inject(::OpenStruct.new) do |hash, pair|
-                k, v = pair.elements
-                instance[Serializable::XML.from_xml(k)] = Serializable::XML.from_xml(v)
-                instance
+            def from_xml(xml)
+              create_from_xml(xml) do |instance|
+                xml.elements.each do |pair|
+                  k, v = pair.elements
+                  instance[Serializable::XML.from_xml(k)] = Serializable::XML.from_xml(v)
+                end
               end
             end
           end

data/lib/firm/serializer/yaml.rb

@@ -5,7 +5,11 @@
 require 'yaml'
 require 'date'
 require 'set'
-require 'ostruct'
+# from Ruby 3.5.0 OpenStruct will not be available by default anymore
+begin
+  require 'ostruct'
+rescue LoadError
+end
 
 module FIRM
 
@@ -15,7 +19,8 @@ module FIRM
 
       class << self
         def serializables
-          list = [::Date, ::DateTime, ::Range, ::Rational, ::Complex, ::Regexp, ::Struct, ::Symbol, ::Time, ::Set, ::OpenStruct]
+          list = [::Date, ::DateTime, ::Range, ::Rational, ::Complex, ::Regexp, ::Struct, ::Symbol, ::Time, ::Set]
+          list.push(::OpenStruct) if ::Object.const_defined?(:OpenStruct)
           list.push(::BigDecimal) if ::Object.const_defined?(:BigDecimal)
           list
         end

data/lib/firm/version.rb

@@ -4,6 +4,6 @@
 module FIRM
 
   # FIRM version
-  VERSION = "0.9.8"
+  VERSION = "1.0.0"
 
 end

data/tests/serializer_tests.rb

@@ -1084,4 +1084,62 @@ module SerializerTestMixin
     assert_equal(obj.symbol, obj_new.symbol)
   end
 
+  def run_test_threads
+    data = { list: ::Array.new(5, [ PropTest.new, Point.new(0, 0), Point.new(10, 10), Point.new(100, 400), Rect.new(20, 20, 40, 40) ]) }
+    results = []
+    threads = ::Array.new(10) do
+      Thread.new do
+        results << run_test_fibers(data)
+      end
+    end
+    threads.each { |t| t.join }
+    results
+  end
+
+  def run_test_fibers(data)
+    fibers = ::Array.new(100) do |_|
+      Fiber.new do
+        s = assert_nothing_raised { data.serialize }
+        Fiber.yield nil
+        new_data = assert_nothing_raised { FIRM.deserialize(s) }
+        Fiber.yield nil
+        assert_instance_of(::Hash, new_data)
+        assert_instance_of(::Array, new_data[:list])
+        assert_equal(5, new_data[:list].size)
+        assert_true(new_data[:list].all? { |e| e.is_a?(::Array) && e.size == 5 })
+        5.times { |i| assert_equal(data[:list].first[i], new_data[:list].first[i]) }
+        4.times do |n|
+          5.times { |i| assert_equal(new_data[:list].first[i].object_id, new_data[:list][n+1][i].object_id) }
+        end
+        new_data
+      end
+    end
+    results = []
+    begin
+      fibers = fibers.select do |fiber|
+        if (rc = fiber.resume)
+          results << rc
+          false
+        else
+          true
+        end
+      end
+    end until fibers.empty?
+    results
+  end
+
+  def test_threading
+
+    results = run_test_threads
+
+    set = results.inject(::Set.new) do |set, fiber_results|
+      fiber_results.inject(set) { |set_, fiber_result| set_.merge(fiber_result[:list][1].collect { |o| o.object_id }) }
+    end
+
+    # although we started with a single unique dataset, distributing that through 10 threads * 100 fibers
+    # to serialize and deserialize should result in 1000 distinct datasets with each 5 distinct data instances
+    assert_equal(5000, set.size)
+
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firm
 version: !ruby/object:Gem::Version
-  version: 0.9.8
+  version: 1.0.0
 platform: ruby
 authors:
 - Martin Corino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-23 00:00:00.000000000 Z
+date: 2024-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake