rails_json_serializer 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 661c8d4dea0b016447621acbca1c536e3274e4e70a272e3a67610f380f987833
-  data.tar.gz: 642499c67e8e2b7814bc1e550f95f841edfc7895178b3f5483626b2978ea3ba2
+  metadata.gz: d3fc5e7e81a63f10f7944eed51908b6b0c64b348398b78119a2cb5613a5624d5
+  data.tar.gz: 107b8bb149af177a79c96ed017b42ebe3008d1685811225de3b25209d01a780c
 SHA512:
-  metadata.gz: 0e5964304d7d90cef99365f2df5279ef2edaa3983879f07bcac983ae69ebc94baab7d987be66ef4b578060e147f2c9c294f2144f208c3376d7531d714e4c6b55
-  data.tar.gz: ca7f0b5465661b46b985c12797c559e7d795ebebce684331835a7b5a2def49b5cbe88fe72c649f42eb5258cc353698f28007021ee703fb7be9491668ac6fca81
+  metadata.gz: '083495f8ec6a05a677273d64d86ac31920d6f37b4b55cb81995812d7f24520630562cfce1905d87cb91bc8c31284a60430aef164dc9826b19f435eff24b1ac2b'
+  data.tar.gz: 1feb1b497f6e4d5ab03f9ff7e9de02f672990b5555606fe896c58351656f4c3937b75e8334404c87b309a5cd300ec213bb0e556c7f3a686d0601e9137f835495

data/lib/serializer/configuration.rb

@@ -1,12 +1,26 @@
+require "zlib"
+
 module Serializer
   class Configuration
-    attr_accessor :enable_includes, :default_cache_time, :disable_model_caching, :debug
+    attr_accessor :enable_includes, :default_cache_time, :disable_model_caching, :debug, :cache_key
+    attr_accessor :compress, :compressor, :decompressor
 
     def initialize
       @enable_includes = true
       @default_cache_time = 360
       @disable_model_caching = false
       @debug = false
+      @compress = false
+      @cache_key = Proc.new { |class_name, query_name, object_id| "#{class_name}_____#{query_name}___#{object_id}" }
+      @compressor = Proc.new { |incoming_data| Base64.encode64(Zlib::Deflate.deflate(incoming_data.to_json)) }
+
+      # have to use 'temp_val', or else there's an issue with the libraries. Won't work as a 1-liner
+      @decompressor = Proc.new do |outgoing_data|
+        temp_val1 = Base64.decode64(outgoing_data)
+        temp_val2 = Zlib::Inflate.inflate(temp_val1)
+        JSON.parse(temp_val2)
+      end
+
     end
   end
 end

data/lib/serializer/model_serializer.rb

@@ -30,8 +30,8 @@ module ModelSerializer
           end
           id_or_ids.each do |object_id|
             self::SERIALIZER_QUERY_KEYS_CACHE.each do |query_name|
-              cache_key = "#{self.name}_____#{query_name}___#{object_id}"
-              puts "(class) CLEARING SERIALIZER CACHE: #{cache_key}" if Rails.env.development?
+              cache_key = Serializer.configuration.cache_key.call(self.name, query_name, object_id)
+              Rails.logger.debug "(class) CLEARING SERIALIZER CACHE: #{cache_key}" if Serializer.configuration.debug
               Rails.cache.delete(cache_key)
             end
           end
@@ -121,18 +121,31 @@ module ModelSerializer
             return super(options)
           end
           options[:ran_serialization] = true
+
           # Not caching records that don't have IDs.
           if !Serializer.configuration.disable_model_caching && self.id && options[:cache_key].present? && !(options.key?(:cache_for) && options[:cache_for].nil?)
-            cache_key = "#{self.class.name}_____#{options[:cache_key]}___#{self.id}"
+            cache_key = Serializer.configuration.cache_key.call(self.class.name, options[:cache_key], self.id)
+
             if Rails.cache.exist?(cache_key)
-              Rails.logger.info "Serializer: Cache reading #{cache_key}" if Serializer.configuration.debug
-              return Rails.cache.read(cache_key)
+              Rails.logger.debug "Serializer: Cache reading #{cache_key}" if Serializer.configuration.debug
+              outgoing_data = Rails.cache.read(cache_key)
+              if (options.key?(:compress) && options[:compress] == true) || (!options.key?(:compress) && Serializer.configuration.compress)
+                outgoing_data = Serializer.configuration.decompressor.call(outgoing_data)
+              end
+              return outgoing_data
             else
               data = super(options)
               data = self.class.as_json_associations_alias_fix(options, data)
+
+              # compress data
+              cachable_data = data
+              if (options.key?(:compress) && options[:compress] == true) || (!options.key?(:compress) && Serializer.configuration.compress)
+                cachable_data = Serializer.configuration.compressor.call(data)
+              end
+
               begin
-                Rails.logger.info "Serializer: Caching #{cache_key} for #{(options[:cache_for] || Serializer.configuration.default_cache_time)} minutes." if Serializer.configuration.debug
-                Rails.cache.write(cache_key, data, expires_in: (options[:cache_for] || Serializer.configuration.default_cache_time).minute)
+                Rails.logger.debug "Serializer: Caching #{cache_key} for #{(options[:cache_for] || Serializer.configuration.default_cache_time)} minutes." if Serializer.configuration.debug
+                Rails.cache.write(cache_key, cachable_data, expires_in: (options[:cache_for] || Serializer.configuration.default_cache_time).minute)
               rescue Exception => e
                 Rails.logger.error "Serializer: Internal Server Error on #{self.class}#as_json ID: #{self.id} for cache key: #{cache_key}"
                 Rails.logger.error e.class
@@ -143,7 +156,7 @@ module ModelSerializer
             end
           else
             if Serializer.configuration.debug && !Serializer.configuration.disable_model_caching && self.id && options[:cache_key].present? && options.key?(:cache_for) && options[:cache_for].nil?
-              Rails.logger.info "Serializer: Caching #{cache_key} NOT caching due to `cache_for: nil`"
+              Rails.logger.debug "Serializer: Caching #{cache_key} NOT caching due to `cache_for: nil`"
             end
             data = super(options)
             data = self.class.as_json_associations_alias_fix(options, data)
@@ -167,8 +180,8 @@ module ModelSerializer
         klass.send(:define_method, :clear_serializer_cache) do
           if self.class.const_defined?("SERIALIZER_QUERY_KEYS_CACHE")
             self.class::SERIALIZER_QUERY_KEYS_CACHE.each do |query_name|
-              cache_key = "#{self.class.name}_____#{query_name}___#{self.id}"
-              Rails.logger.info "Serializer: CLEARING CACHE KEY: #{cache_key}" if Serializer.configuration.debug
+              cache_key = Serializer.configuration.cache_key.call(self.class.name, query_name, self.id)
+              Rails.logger.debug "Serializer: CLEARING CACHE KEY: #{cache_key}" if Serializer.configuration.debug
               Rails.cache.delete(cache_key)
             end
             return true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_json_serializer
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - benjamin.dana.software.dev@gmail.com
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: zlib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement