rails_json_serializer 1.0.0 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1a107c67b6ae1ccb5ad9abcd8f13b1255e46b07d48726c44b89e2e41186a2bb
-  data.tar.gz: be454318e55f60ca236b4fbb1ecb9a68fe144e636e13deb43587f94385f7c0cf
+  metadata.gz: b6b2c3e2e7b905079dce0ddbbf0b48028a36d68b10da5ab4278d597eaf70713a
+  data.tar.gz: 9e730e031d3b73eaa9fb27f838fb4f6761256755281257cb99db9b3b15659ded
 SHA512:
-  metadata.gz: 7af60e8a27c62b336d31ec574aa5b3321ec7d73e3097c90d4027763f71148dc587d5113c9ae36576ea8869f4908d40145997c657ce2d5f4321fa9695df56128b
-  data.tar.gz: 4b3e8f9aebd58d53de0dc13688fdfb3d0b8f4ffdf0015d688e8329fc0d50b3dc8d81cc69dda3e16e51c08fbc82fb35fd2755c984cd8de53f9ea0c59650c8cd7c
+  metadata.gz: 70bba5bd544d0d2e95ae9bec6b5c4762eec9b036fe750a0777ef7663903b9894e05f8c2fcb703f2d021023594132ab2d6d6cecea4a1d8e2c12a3b72dd1c1d7e2
+  data.tar.gz: 27594e6cb05baefffd863555b226f2b672a3c84dcebbb661672266cba0ede47181efe39e702b7a44872582b0a873d5957e91200b4e8a1c6ef34aaf3f76abba98

data/lib/serializer.rb

@@ -1,8 +1,8 @@
 require 'active_support/concern'
-require 'serializer/application_serializer'
+require_relative 'serializer/application_serializer'
 Dir[File.join(Rails.root, 'app', 'serializers', '**', '*.rb')].each {|file| require file }
-require 'serializer/configuration'
-require 'serializer/concern'
+require_relative 'serializer/configuration'
+require_relative 'serializer/concern'
 
 module Serializer
   # config src: http://lizabinante.com/blog/creating-a-configurable-ruby-gem/

data/lib/serializer/concern.rb

@@ -1,20 +1,30 @@
 module Serializer
+  DELETE_MATCHED_SUPPORTED_CACHE_TYPES = [:memory_store, :file_store]
   module Concern
     # ActiveSupport extend src: https://stackoverflow.com/questions/2328984/rails-extending-activerecordbase
     extend ActiveSupport::Concern
 
     # START MODEL INSTANCE METHODS
     def clear_serializer_cache
-      if self.class.const_defined?("#{self.class.name}Serializer")
-        serializer_klass = "#{self.class.name}Serializer".constantize
-        serializer_klass.public_instance_methods.each do |query_name|
+      if self.class.const_defined?("SERIALIZER_QUERY_KEYS_CACHE")
+        
+        # list_of_serializer_query_names = "#{self.class.name}::SERIALIZER_QUERY_KEYS_CACHE".constantize
+        self.class.get_cumulatively_inherited_serializer_query_list.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
           Rails.cache.delete(cache_key)
         end
         return true
       else
-        Rails.logger.info "Serializer: Class #{self.class.name} does not have the serializer module #{self.class.name}Serializer defined." if Serializer.configuration.debug
+        # if Serializer.configuration.debug
+          Rails.logger.error(
+            """
+              ERROR. COULD NOT CLEAR SERIALIZER CACHE FOR: Class #{self.class.name}
+              Serializer: Class #{self.class.name} may not have the serializer module #{self.class.name}Serializer defined.
+              Nor was it defined on an inheriting class.
+            """
+          )
+        # end
         return nil
       end
     end
@@ -69,11 +79,23 @@ module Serializer
           serializer_klass = "#{subclass.name}Serializer".constantize
 
           if serializer_klass.class == Module
-            if !serializer_klass.const_defined?("SerializerMethods")
-              serializer_klass.const_set('SerializerMethods', Module.new {})
+            if !serializer_klass.const_defined?("SerializerClassAndInstanceMethods")
+              serializer_klass.const_set('SerializerClassAndInstanceMethods', Module.new {})
             end
+            if !serializer_klass.const_defined?("SerializerClassMethods")
+              serializer_klass.const_set('SerializerClassMethods', Module.new {})
+              serializer_klass::SerializerClassMethods.send(:define_method, :get_cumulatively_inherited_serializer_query_list) do |opts = {}|    
+                if defined?(super)
+                  return (subclass::SERIALIZER_QUERY_KEYS_CACHE + superclass.get_cumulatively_inherited_serializer_query_list).uniq
+                else
+                  return subclass::SERIALIZER_QUERY_KEYS_CACHE
+                end
+              end
+            end
+
+            serializer_query_names = serializer_klass.public_instance_methods
 
-            serializer_klass.public_instance_methods.each do |query_name|
+            serializer_query_names.each do |query_name|
               serializer_name = query_name[/(?<name>.+)_query/, :name]
               if serializer_name.nil?
                 Rails.logger.info "Serializer: #{serializer_klass.name} method #{query_name} does not end in '(.+)_query', as is expected of serializers" if Serializer.configuration.debug
@@ -82,22 +104,43 @@ module Serializer
               # Skip if chosen to override it.
               next if serializer_klass.respond_to?(serializer_name)
               if serializer_name == 'serializer'
-                serializer_klass::SerializerMethods.send(:define_method, serializer_name) do |opts = {}|    
+                serializer_klass::SerializerClassAndInstanceMethods.send(:define_method, serializer_name) do |opts = {}|    
                   super({json_query_override: query_name}.merge(opts))
                 end
               else
-                serializer_klass::SerializerMethods.send(:define_method, serializer_name) do |opts = {}|    
+                serializer_klass::SerializerClassAndInstanceMethods.send(:define_method, serializer_name) do |opts = {}|    
                   serializer({json_query_override: query_name}.merge(opts))
                 end
               end
             end
+            if serializer_query_names.any?
+              # Inject instance methods
+              subclass.send(:include, serializer_klass::SerializerClassAndInstanceMethods)
+              # Inject class methods
+              subclass.send(:extend, serializer_klass::SerializerClassAndInstanceMethods)
+              # Inject class methods that has queries
+              if Serializer.configuration.debug
+                Rails.logger.info "Injecting queries: #{serializer_klass.public_instance_methods} into class: #{subclass}"
+              end
+              puts "Injecting queries: #{serializer_klass.public_instance_methods} into class: #{subclass}"
+              subclass.send(:extend, serializer_klass)
+              # Injecting the Serializer Methods as a namespaced class of the rails class, so we can have
+              #   access to the list of methods to clear their cache.
+              #   'Class Name + Serializer' does not work with inheritence.
+              subclass.const_set('SERIALIZER_QUERY_KEYS_CACHE', serializer_query_names)
+              # Inject class methods
+              subclass.send(:extend, serializer_klass::SerializerClassMethods)
 
-            # Inject instance methods
-            subclass.send(:include, serializer_klass::SerializerMethods)
-            # Inject class methods
-            subclass.send(:extend, serializer_klass::SerializerMethods)
-            # Inject class methods that has queries
-            subclass.send(:extend, serializer_klass)
+              # Issue with inheritting classes caching the serializer data from queries in super classes.
+              # Only on the rails server, not the console strangely.
+              if DELETE_MATCHED_SUPPORTED_CACHE_TYPES.include?(Rails.configuration.cache_store)
+                serializer_query_names.each do |query_name|
+                  cache_key_prefix = /#{subclass.name}_____#{query_name}___(\d+)/
+                  puts "Deleting cache here: Rails.cache.delete_matched(#{cache_key_prefix})"
+                  Rails.cache.delete_matched(cache_key_prefix)
+                end
+              end
+            end
           else
             Rails.logger.info "Serializer: #{serializer_klass.name} was not a Module as expected" if Serializer.configuration.debug
           end
@@ -105,6 +148,23 @@ module Serializer
         super(subclass)
       end
 
+      # Class defined clear serializer
+      if DELETE_MATCHED_SUPPORTED_CACHE_TYPES.include?(Rails.configuration.cache_store)
+        def clear_serializer_cache
+          self.get_cumulatively_inherited_serializer_query_list.each do |query_name|
+            cache_key_prefix = /#{self.name}_____#{query_name}___(\d+)/
+            Rails.logger.info "Serializer: CLEARING CACHE KEY Prefix: #{cache_key_prefix}" if Serializer.configuration.debug
+            Rails.cache.delete_matched(cache_key_prefix)
+          end
+          return true
+        end
+      else
+        def clear_serializer_cache
+          puts "Not supported by rails cache store: #{Rails.configuration.cache_store}. Supported: #{DELETE_MATCHED_SUPPORTED_CACHE_TYPES}"
+          return false
+        end
+      end
+
       # Can override the query, using the options. ex: {json_query_override: :tiny_children_serializer_query}
       def serializer opts = {}
         query = opts[:json_query_override].present? ? self.send(opts[:json_query_override], opts) : serializer_query(opts)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_json_serializer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.4
 platform: ruby
 authors:
 - benjamin.dana.software.dev@gmail.com
@@ -14,16 +14,100 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 description: 
 email: 
 executables: []
@@ -36,7 +120,7 @@ files:
 - lib/serializer/configuration.rb
 homepage: https://github.com/danabr75/rails_json_serializer
 licenses:
-- GNU
+- LGPL-3.0-only
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -53,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: An ActiveRecord JSON Serializer with supported caching and eager-loading