simply_serializable 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0f8989f2a8520c25271107350edf070e2274d1fb17c48068f7c90394a907df4
-  data.tar.gz: 9a65b5876a365b43b469e874a9429524e2dd5685207376e3ee4541bcf3c59047
+  metadata.gz: ed7754c68910d4556534b53f8475b8c36d1ad9259408508523c3bbd5463d0157
+  data.tar.gz: 39eb74d95beb65aee78582fba369bbe5bd76ef082ad9d5a5cedf28f5d738ceb3
 SHA512:
-  metadata.gz: 5e7ea38a315a6d758ec707c99216f61b860252a47fbf0c93fa700967b331a0cefd9d3686b5397605322310d87e6b2dc4880ec7f6354139afbb0b43f0a514d700
-  data.tar.gz: 2485f4b6be1560e14644fc6bfc03be00e65d6690202d3237af00f3ac0b6e0b2722a175cc1decbda2c106cd4870b7deef4f104b5c5bb879a991681e659e49d084
+  metadata.gz: 90156f91281bb1fdf486351962b3380ee430866feea4418f2644d72e07d4f60c3346459b7125e81e3141bdcd488e626be0aa4f9572782a9eb1b3dbd6d6f09f03
+  data.tar.gz: 455a807775db2e60c18f670e2c8ed080cd8995d3164c356e33897919c3af71315c26d21cdd038831f07246ca1c22acb1fe3873db1803d72f69420665392c0ab9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simply_serializable (1.2.2)
+    simply_serializable (1.3.0)
       fingerprintable (>= 1.2.1)
 
 GEM

data/lib/simply_serializable/mixin.rb

@@ -35,13 +35,15 @@ module SimplySerializable
       base.extend(ClassMethods)
     end
 
-    def serialize(cache: {})
-      serializer(cache: cache).serialize
+    def serialize(cache: {}, **options)
+      serializer(cache: cache, **options).serialize
     end
 
-    def serializer(cache: {})
+    def serializer(cache: {}, **options)
       Serializer.new(
         **self.class.serializable_config.merge(
+          options
+        ).merge(
           cache: cache,
           object: self
         )
@@ -49,11 +51,7 @@ module SimplySerializable
     end
 
     def serializable_id
-      "#{serializable_type}/#{fingerprint}"
-    end
-
-    def serializable_type
-      self.class.name
+      serializer.id
     end
   end
 end

data/lib/simply_serializable/serializer.rb

@@ -17,47 +17,57 @@ module SimplySerializable
       only: nil
     )
       @object = object
+      @id = id
       @attributes = attributes
       @include_readable_instance_variables = include_readable_instance_variables
       @except = except&.map(&:to_sym)
       @only = only&.map(&:to_sym)
       @method_prefix = method_prefix
-      @cache = cache
-      @cache[cache_key] = nil
-      @serialized = false
+      @local_cache = cache
+      @local_cache[cache_key] = nil
 
       populate_attributes
     end
 
     def cache
-      serialize unless @serialized
-      @cache
+      @cache ||= begin
+        serialize
+        @local_cache
+      end
     end
 
-    def deep_serialize(obj)
-      case obj
-      when FalseClass, Float, nil, Integer, String, Symbol, TrueClass
-        obj
-      when Array
-        obj.map { |v| deep_serialize(v) }
-      when Hash
-        Hash[obj.map { |k, v| [deep_serialize(k), deep_serialize(v)] }]
-      when Module
-        obj.name
-      else
-        serialize_object(obj)
+    def id
+      @id ||= cache_key
+    end
+
+    def nestable?
+      return @nestable unless @nestable.nil?
+
+      serialize
+      @nestable
+    end
+
+    def nested
+      @nested ||= begin
+        deep_nest(serialize[:root])
       end
     end
 
     def serialize
       @serialize ||= begin
-        @serialized = true
+        @nestable = true
         ret = deep_serialize(object_value_hash)
 
-        cache[cache_key] = ret
+        @local_cache[cache_key] = {
+          id: cache_key,
+          object: object.class.name,
+          fingeprint: fingerprint,
+          data: ret
+        }
+
         {
           root: cache_key,
-          objects: cache
+          objects: @local_cache
         }
       end
     end
@@ -68,6 +78,50 @@ module SimplySerializable
 
     private
 
+    def cache_key
+      @cache_key ||= cache_key_for(object)
+    end
+
+    def cache_key_for(obj)
+      "#{obj.class.name}/#{fingerprint_for(obj)}"
+    end
+
+    def deep_nest(obj_id)
+      raise Error::CircularDependencyError unless @nestable
+
+      Hash[@local_cache[obj_id][:data].map do |k, v|
+        v = deep_nest(v.dig(:id)) if v.is_a?(Hash) && v.dig(:object) == :reference
+        [k, v]
+      end]
+    end
+
+    def deep_serialize(obj)
+      case obj
+      when FalseClass, Float, nil, Integer, String, Symbol, TrueClass
+        obj
+      when Array
+        obj.map { |v| deep_serialize(v) }
+      when Hash
+        Hash[obj.map { |k, v| [deep_serialize(k), deep_serialize(v)] }]
+      when Module
+        obj.name
+      else
+        serialize_object(obj)
+      end
+    end
+
+    def fingerprint
+      @fingerprint ||= fingerprint_for(object)
+    end
+
+    def fingerprint_for(obj)
+      if obj.respond_to?(:fingerprint)
+        obj.fingerprint
+      else
+        Fingerprintable::Fingerprinter.new(object: obj).fingerprint
+      end
+    end
+
     def instance_vars_with_readers
       instance_variables = Hash[object.instance_variables.map { |e| [e, 1] }]
       ret = object.class.instance_methods.select do |method|
@@ -76,18 +130,18 @@ module SimplySerializable
       ret.map(&:to_sym)
     end
 
-    def serialize_object(use_object)
-      use_object_cache_key = cache_key(use_object)
-      return use_object_cache_key if cache.key?(use_object_cache_key)
-      raise "#{use_object.class.name} does not respond to serialize.  Did you mean to include Serializable in this class?" unless use_object.respond_to?(:serialize)
-
-      serializer = use_object.serializer(cache: cache)
-      cache.merge!(serializer.cache)
-      use_object_cache_key
+    def method_for_attribute(attr)
+      if object.class.instance_methods.include?("#{@method_prefix}_#{attr}".to_sym)
+        "#{@method_prefix}_#{attr}"
+      else
+        attr
+      end
     end
 
-    def cache_key(obj = object)
-      obj.serializable_id
+    def object_value_hash
+      Hash[attributes.map do |attr|
+        [attr, object.send(method_for_attribute(attr))]
+      end]
     end
 
     def populate_attributes
@@ -100,18 +154,32 @@ module SimplySerializable
       attributes
     end
 
-    def method_for_attribute(attr)
-      if object.class.instance_methods.include?("#{@method_prefix}_#{attr}".to_sym)
-        "#{@method_prefix}_#{attr}"
-      else
-        attr
+    def serialize_object(use_object)
+      use_object_cache_key = cache_key_for(use_object)
+      if @local_cache.key?(use_object_cache_key)
+        @nestable = false
+        return reference_to(use_object_cache_key)
       end
+      serializer =  unless use_object.respond_to?(:serialize)
+                      raise "#{use_object.class.name} does not respond to serialize.  Did you mean to include Serializable in this class?" unless @include_readable_instance_variables
+
+                      Serializer.new(
+                        cache: @local_cache,
+                        object: use_object
+                      )
+                    else
+                      use_object.serializer(cache: @local_cache)
+                    end
+      serializer
+      @local_cache.merge!(serializer.cache)
+      reference_to(use_object_cache_key)
     end
 
-    def object_value_hash
-      Hash[attributes.map do |attr|
-        [attr, object.send(method_for_attribute(attr))]
-      end]
+    def reference_to(key)
+      {
+        object: :reference,
+        id: key
+      }
     end
   end
 end

data/lib/simply_serializable/version.rb

@@ -1,3 +1,3 @@
 module SimplySerializable
-  VERSION = "1.2.2"
+  VERSION = "1.3.0"
 end

data/lib/simply_serializable.rb

@@ -4,4 +4,22 @@ require "simply_serializable/version"
 require "simply_serializable/serializer"
 require "simply_serializable/mixin"
 
-module SimplySerializable; end
+module SimplySerializable
+  class Error < StandardError
+    attr_reader :type
+
+    def initialize(message, type:)
+      @type = type
+      super(message)
+    end
+
+    class CircularDependencyError < Error
+      def initialize
+        super(
+          'Circular dependency detected',
+          type: :circular_dependency
+        )
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simply_serializable
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Ryan Jackson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-17 00:00:00.000000000 Z
+date: 2019-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fingerprintable
@@ -103,7 +103,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".byebug_history"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"

data/.byebug_history

@@ -1,21 +0,0 @@
-exit
-c
-serializable_config
-n
-serializable_config
-attributes
-c
-attributes
-pdb
-c
-attributes
-n
-except
-n
-only
-attributes
-n
-attributes
-n
-instance_vars_with_readers
-attributes