rails_json_serializer 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3fc5e7e81a63f10f7944eed51908b6b0c64b348398b78119a2cb5613a5624d5
-  data.tar.gz: 107b8bb149af177a79c96ed017b42ebe3008d1685811225de3b25209d01a780c
+  metadata.gz: 4a17108258803bac91fbf2506e02b2953fe1d49c4ae3758acea6a6b8671a5cf0
+  data.tar.gz: f8e2ad23101fe3ba7a9253d6dbeec9d82b1c5f9392ce2df8c47db74326921858
 SHA512:
-  metadata.gz: '083495f8ec6a05a677273d64d86ac31920d6f37b4b55cb81995812d7f24520630562cfce1905d87cb91bc8c31284a60430aef164dc9826b19f435eff24b1ac2b'
-  data.tar.gz: 1feb1b497f6e4d5ab03f9ff7e9de02f672990b5555606fe896c58351656f4c3937b75e8334404c87b309a5cd300ec213bb0e556c7f3a686d0601e9137f835495
+  metadata.gz: f95e665cd9adfc8c9900ba981d75af1b2448cb8c23baa41454b63aaeaf49e5fc04846ab60d18bbc2991491d3a7b310666a863ba830fad71fee18225a88db0f38
+  data.tar.gz: 8f7b66cce88ba721b58ce24a76d7a75791f61054ab0da38de23a495aa1f1d20c1d93b344cc4b393dc2479727c9d589bdfd4de807563ad8cf3465239aa4011901

data/lib/serializer/model_serializer.rb

@@ -4,6 +4,8 @@ module ModelSerializer
     # START CLASS EVAL
     klass.class_eval do
 
+
+      # I don't think we need to check for classname + serialiers. We are now including via: `include ModelSerializer` in classes
       # Rails 5 has autoloading issues with modules. They will show as not defined, when available.
       if Rails.env.development?
         begin
@@ -38,9 +40,16 @@ module ModelSerializer
         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 = {}|  
+        # CLASS METHOD - :serializer
+        klass.send(:define_singleton_method, :serializer) do |opts = {}|
+          # puts "CLASS METHOD - SERIALIZER - OPTS: #{opts.inspect}"
           query = opts[:json_query_override].present? ? self.send(opts[:json_query_override], opts) : serializer_query(opts)
+          
+          # if as_json arg, then add to as_json query
+          if opts[:disable_caching] == true
+            query[:disable_caching] = true
+          end
+          
           if Serializer.configuration.enable_includes && query[:include].present? && !opts[:skip_eager_loading]
             includes(generate_includes_from_json_query(query)).as_json(query)
           else
@@ -126,8 +135,9 @@ module ModelSerializer
           if !Serializer.configuration.disable_model_caching && self.id && options[:cache_key].present? && !(options.key?(:cache_for) && options[:cache_for].nil?)
             cache_key = Serializer.configuration.cache_key.call(self.class.name, options[:cache_key], self.id)
 
-            if Rails.cache.exist?(cache_key)
+            if Rails.cache.exist?(cache_key) && options[:disable_caching] != true
               Rails.logger.debug "Serializer: Cache reading #{cache_key}" if Serializer.configuration.debug
+              # Rails.logger.debug(options.inspect) 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)
@@ -137,21 +147,25 @@ module ModelSerializer
               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)
+              if options[:disable_caching] != true
+                # 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.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
+                    Rails.logger.error e.message
+                    Rails.logger.error e.backtrace
+                end
+              else
+                Rails.logger.debug "Serializer: Cache reading/writing for #{cache_key} is disabled" if Serializer.configuration.debug
               end
 
-              begin
-                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
-                Rails.logger.error e.message
-                Rails.logger.error e.backtrace
-              end
               return data
             end
           else
@@ -164,9 +178,17 @@ module ModelSerializer
           end
         end
 
+        # INSTANCE METHOD - :serializer
         if !klass.method_defined?(:serializer)
           klass.send(:define_method, :serializer) do |opts = {}|
+            # puts "INSTANCE METHOD - SERIALIZER - OPTS: #{opts.inspect}"
             query = opts[:json_query_override].present? ? self.class.send(opts[:json_query_override], opts) : self.class.serializer_query(opts)
+            
+            # if as_json arg, then add to as_json query
+            if opts[:disable_caching] == true
+              query[:disable_caching] = true
+            end
+
             if Serializer.configuration.enable_includes && query[:include].present? && self.class.column_names.include?('id') && self.id.present? && !opts[:skip_eager_loading] && self.respond_to?(:persisted?) && self.persisted?
               # It's an extra SQL call, but most likely worth it to pre-load associations
               self.class.includes(self.class.generate_includes_from_json_query(query)).find(self.id).as_json(query)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_json_serializer
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - benjamin.dana.software.dev@gmail.com
@@ -150,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: An ActiveRecord JSON Serializer with supported caching and eager-loading