rails_json_serializer 2.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4ed73e603bb8c02b8999399e76e1d3e359d502db69ede57a800229e1c9a12f9
-  data.tar.gz: 97cb1d7ac4a6b975d57f23406828783242121f0b3c63f57243e0ed125525733a
+  metadata.gz: d3fc5e7e81a63f10f7944eed51908b6b0c64b348398b78119a2cb5613a5624d5
+  data.tar.gz: 107b8bb149af177a79c96ed017b42ebe3008d1685811225de3b25209d01a780c
 SHA512:
-  metadata.gz: ea0aa2817b2c46c27ff246d0b6e9df2bfbab06ad429d2e99a53f75bb258e81bb3cf9c5f27038992b0ff0037a270815fe9bde69524d3f7ed741bed7ca64f3138a
-  data.tar.gz: 721fefb41c3ed4892a0899f370eff95e2fdda0d77810137e379fcc1eed3241001c22bda2ebc232d321c99f365479f2757b959c2386febafba965b8d470281663
+  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

@@ -23,6 +23,20 @@ module ModelSerializer
         # Inject class methods, will have access to those queries on the class.
         klass.send(:extend, serializer_klass)
 
+        # Class method to clear the cache of objects without having to instantiate them.
+        def self.clear_serializer_cache id_or_ids
+          if !id_or_ids.is_a?(Array)
+            id_or_ids = [id_or_ids]
+          end
+          id_or_ids.each do |object_id|
+            self::SERIALIZER_QUERY_KEYS_CACHE.each do |query_name|
+              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
+        end
+
         # no need to define it if inheriting class has defined it OR has been manually overridden.
         # CLASS METHODS
         klass.send(:define_singleton_method, :serializer) do |opts = {}|  
@@ -107,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
@@ -129,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)
@@ -153,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,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: rails_json_serializer
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - benjamin.dana.software.dev@gmail.com
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2020-04-22 00:00:00.000000000 Z
@@ -14,30 +14,44 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !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: '5.1'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -108,8 +122,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-description: 
-email: 
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -121,7 +135,7 @@ homepage: https://github.com/danabr75/rails_json_serializer
 licenses:
 - LGPL-3.0-only
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,8 +150,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: An ActiveRecord JSON Serializer with supported caching and eager-loading
 test_files: []