rails_json_serializer 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1979a6763434dbcb97197b96e8b6d063e57e7a1e1661f73aff7669ad0014d0e3
-  data.tar.gz: '0280285eefc66726612611b12df19d190a7ed1421393394a6c669a93ab33fd15'
+  metadata.gz: dc8a9ac788966e52d712b4927d9ec959015aeec7c401ed04741d34faeb315786
+  data.tar.gz: 2ef1b797adfa346886d437cd8b5322418ddd96d1f06f1bf80d68bf59f9d589e6
 SHA512:
-  metadata.gz: 681b0f1e1b1856859676747640f6829437cc613987ffb1a60939254f4492c1c83bbe49ebb96f8eba764d3b5da8bf47b337c44e2ffe9b0893188d97c3316ff999
-  data.tar.gz: 48152e760af615c8ec8b399e7a8a8ea72cdb0d663d85bfac9d242d1df01a4c2c0cba95f0629664e01cb0213c2ce82d321c3cb33ff5ee217b426cc296cc16d0fc
+  metadata.gz: 66ee9df244dd1e8317aab9013fe4ae6dc83dd77963660c8700e268f70bcb795b907299b88a1b5b1b7259ff663b5200122eda6a75d2a6d78763b6530e87ffb285
+  data.tar.gz: 5923bb6172eb2a3bd8306035517cee75c975bbc6f2e4fa49922ccf206ef7042115377365f30887550a89f2e55905bc5623aa04975dd98daebcf681161d03d881

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,27 +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?("SerializerMethods")
-        serializer_klass = "#{self.class.name}::SerializerMethods".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
-        if Serializer.configuration.debug
-          Rails.logger.info(
+        # if Serializer.configuration.debug
+          Rails.logger.error(
             """
-              Serializer: Class #{self.class.name} does not have the serializer module #{self.class.name}Serializer defined.
+              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
+        # end
         return nil
       end
     end
@@ -76,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_klass.public_instance_methods.each do |query_name|
+            serializer_query_names = serializer_klass.public_instance_methods
+
+            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
@@ -89,26 +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)
-            # 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('SerializerMethods', serializer_klass::SerializerMethods.dup)
+              # 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
@@ -116,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)
@@ -164,6 +213,7 @@ module Serializer
         klass = self if klass.nil?
         if options[:include].present? && !options[:skip_eager_loading]
           options[:include].each do |include_key, include_hash|
+            next if include_hash[:skip_eager_loading] == true
             # Will 'next' if there is a scope that takes arguments, an instance-dependent scope.
             # Can't eager load when assocation has a instance condition for it's associative scope.
             # Might not be a real assocation
@@ -174,6 +224,17 @@ module Serializer
             query_filter[include_key] = generate_includes_from_json_query(include_hash, klass.reflect_on_association(include_key).klass)
           end
         end
+        # Does not include data, just eager-loads. Useful when methods need assocations, but you don't need association data.
+        if options[:eager_include].present?
+          options[:eager_include].each do |include_key|
+            # Will 'next' if there is a scope that takes arguments, an instance-dependent scope.
+            # Can't eager load when assocation has a instance condition for it's associative scope.
+            # Might not be a real assocation
+            next if klass.reflect_on_association(include_key).nil?
+            next if klass.reflect_on_association(include_key).scope&.arity&.nonzero?
+            query_filter[include_key] ||= {}
+          end
+        end
         return query_filter
       end
       # END MODEL CLASS METHODS

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_json_serializer
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 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