plucker_serializer 0.2.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b8f9afc9f1301b0b3d66270d02332a3c561f154e812c14473d82b26455da90e
-  data.tar.gz: 9081e6e37b2ae439c167774d58b35702e4bc6d8ba5daea474496feae8bcd7835
+  metadata.gz: 3b74f3d1f2fee4bfa2fd0fc3e6968f35f6d1bbe852b69c6fda56ad63bdbe8ada
+  data.tar.gz: c9daa990c9d467958e6f30dd2faba3a69aa81dfa0708a6289243026504f88351
 SHA512:
-  metadata.gz: 831adf15e780f90a1ee9f64811f7a8bf0a684e929a2030884daac8496fafb645473c4d4633d061463f4ca99afb3134bed70b5d22bc691d0103a2f831bf23af68
-  data.tar.gz: 03fc6353497d3abb9668fe4c36e8d68cade203310e2b2bd20afaf21baa09ad6caf9f16de434b30aec6c168573525a6c5e7d05daa15f0d570402d26352a412fbb
+  metadata.gz: f051ad0a434f02690092cdeb7481db0fc606b780574d8109251746f99b3f1888842c906231321f82ba896e9615939461a93ad95245082086235cb670fc27710b
+  data.tar.gz: b05c2e4c4f327a32c0c9faeae82fc017265f316e41f5f111a709577801862a70d481f7545b226b8cb848a8a83d705702a963851e9582ba2fbc72ec670ba3ccb3

data/lib/plucker/attribute.rb

@@ -1,5 +1,48 @@
 # frozen_string_literal: true
 module Plucker
-    class Attribute < Plucker::Field
+    class Attribute
+        attr_reader :name, :block, :condition
+       
+        def initialize(name, options = {}, block)
+            @name = name
+            @block = block
+            @condition = options[:if]
+        end
+
+        def value(serializer)
+            block_value = instance_exec(serializer.object, &@block) if @block
+            if @block && block_value != :nil
+                block_value
+            else
+                if serializer.respond_to?(@name)
+                    serializer.send(@name)
+                else
+                    serializer.object.send(@name)
+                end
+            end
+        end
+
+        def is_pluckable?
+            @block.blank?
+        end
+
+        def should_include?(serializer)
+            case @condition
+            when nil
+                true
+            when Symbol
+                serializer.public_send(@condition)
+            when String
+                serializer.instance_eval(@condition)
+            when Proc
+                if @condition.arity.zero?
+                    serializer.instance_exec(&@condition)
+                else
+                    serializer.instance_exec(serializer, &@condition)
+                end
+            else
+                nil
+            end
+        end
     end
 end

data/lib/plucker/base.rb

@@ -4,6 +4,7 @@ require_relative 'descriptor'
 require_relative 'has_many'
 require_relative 'belongs_to'
 require_relative 'has_one'
+require "oj"
 require 'active_support/all'
 
 module Plucker
@@ -26,9 +27,9 @@ module Plucker
             self.object = object
         end
 
-        def serializable_hash
-            if self.class.cache_enabled?
-                fetch do
+        def serializable_hash(use_cache: true)
+            if use_cache && self.class.cache_enabled?
+                fetch(adapter: :hash) do
                     get_hash
                 end
             else
@@ -38,27 +39,35 @@ module Plucker
         alias to_hash serializable_hash
         alias to_h serializable_hash
 
-        def get_hash
-            attributes_hash.merge! associations_hash
+        def as_json(options = nil)
+            serializable_hash
         end
 
-        def as_json(options = nil)
-            to_h.as_json(options)
+        def to_json(options = {}, use_cache: true)
+            if use_cache && self.class.cache_enabled?
+                fetch(adapter: :json) do
+                    Oj.dump(get_hash, mode: :rails)
+                end
+            else
+                Oj.dump(get_hash, mode: :rails)
+            end
+        end
+
+        def get_hash
+            attributes_hash.merge! associations_hash
         end
 
         def associations_hash
-            hash = {}
-            self.class._descriptor._relationships.each do |(key, relationship)|
-                next if relationship.excluded?(self)
-                hash[key] = relationship.value(self)
+            self.class._descriptor._relationships.each_with_object({}) do |(key, relationship), hash|
+                next if !relationship.should_include?(self)
+                hash[key.to_s] = relationship.value(self)
             end
-            hash
         end
 
         def attributes_hash
             self.class._descriptor._attributes.each_with_object({}) do |(key, attr), hash|
-                next if attr.excluded?(self)
-                hash[key] = attr.value(self)
+                next if !attr.should_include?(self)
+                hash[key.to_s] = attr.value(self)
             end
         end
 

data/lib/plucker/collection.rb

@@ -1,16 +1,19 @@
 # frozen_string_literal: true
 require_relative 'concerns/caching'
+require "oj"
+require "pluck_all"
 
 module Plucker
   class Collection
     include Enumerable
     include Caching
 
-    attr_reader :objects, :serializer_class, :options
+    attr_reader :objects, :cache_type, :serializer_class, :options
 
     def initialize(objects, options = {})
       @objects = objects
       @options = options
+      @cache_type = options[:cache] == :multi ? :multi : :collection
       @serializer_class = get_serialized_model(objects)
     end
 
@@ -21,23 +24,15 @@ module Plucker
         end.compact
       else
         if serializer_class.cache_enabled?
-          fetch do
-            if serializer_class.is_pluckable?
-              associated_hash
-            else
-              objects.map do |object|
-                serializer_class.new(object).serializable_hash
-              end.compact
+          if @cache_type == :collection
+            fetch(adapter: :hash) do
+              get_hash(use_cache: false)
             end
+          elsif @cache_type == :multi
+            get_hash(use_cache: true)
           end
         else
-          if serializer_class.is_pluckable?
-            associated_hash
-          else
-            objects.map do |object|
-              serializer_class.new(object).serializable_hash
-            end.compact
-          end
+          get_hash(use_cache: false)
         end
       end
     end
@@ -45,7 +40,41 @@ module Plucker
     alias to_h serializable_hash
 
     def as_json(options = nil)
-      to_h.as_json(options)
+      serializable_hash
+    end
+
+    def to_json(options = {})
+      if serializer_class.cache_enabled?
+        if @cache_type == :collection
+          fetch(adapter: :json) do
+            Oj.dump(get_collection_json(use_cache: false), mode: :rails)
+          end
+        elsif @cache_type == :multi
+          Oj.dump(get_collection_json(use_cache: true), mode: :rails)
+        end
+      else
+        Oj.dump(get_collection_json(use_cache: false), mode: :rails)
+      end
+    end
+
+    def get_collection_json(use_cache: false)
+      if serializer_class.is_pluckable?
+        associated_hash
+      else
+        objects.map do |object|
+          Oj.load(serializer_class.new(object).to_json(use_cache: use_cache))
+        end
+      end
+    end
+
+    def get_hash(use_cache: false)
+      if serializer_class.is_pluckable?
+        associated_hash
+      else
+        objects.map do |object|
+          serializer_class.new(object).serializable_hash(use_cache: use_cache)
+        end.compact
+      end
     end
 
     def cache_version
@@ -53,9 +82,8 @@ module Plucker
       @cache_version = objects.cache_version
     end
 
-    def cache_key
-      return @cache_key if defined?(@cache_key)
-      @cache_key = objects.cache_key + '/' + serializer_class._cache_digest
+    def cache_key(adapter: :json)
+      objects.cache_key + '/' + serializer_class._cache_digest + "/" + adapter.to_s
     end
 
     private
@@ -63,9 +91,9 @@ module Plucker
       pluck_to_hash(objects, serializer_class.pluckable_columns.to_a)
     end
 
-    def pluck_to_hash(object, attrs)
-      namespaced_attrs = attrs.map { |attr| object.model.table_name.to_s + "." + attr.to_s }
-      object.pluck(Arel.sql(namespaced_attrs.join(','))).map { |el| attrs.zip(el).to_h }
+    def pluck_to_hash(objects, attrs)
+      namespaced_attrs = attrs.map { |attr| objects.model.table_name.to_s + "." + attr.to_s }
+      objects.pluck_all(namespaced_attrs.join(','))
     end
 
     def get_serialized_model(objects)

data/lib/plucker/concerns/caching.rb

@@ -30,9 +30,9 @@ module Plucker
       end
     end
 
-    def fetch
+    def fetch(adapter: :json)
       if serializer_class.cache_enabled?
-        serializer_class._cache_store.fetch(cache_key, version: cache_version, options: serializer_class._cache_options) do
+        serializer_class._cache_store.fetch(cache_key(adapter: adapter), version: cache_version, options: serializer_class._cache_options) do
           yield
         end
       else
@@ -45,9 +45,8 @@ module Plucker
       @cache_version = object.cache_version
     end
 
-    def cache_key
-      return @cache_key if defined?(@cache_key)
-      @cache_key = object.cache_key + "/" + serializer_class._cache_digest
+    def cache_key(adapter: :json)
+      object.cache_key + "/" + serializer_class._cache_digest + "/" + adapter.to_s
     end
 
     def serializer_class

data/lib/plucker/descriptor.rb

@@ -7,12 +7,12 @@ module Plucker
             self._serialized_model = get_serialized_model(serializer_class)
             self._attributes = {}
             self._relationships = {}
-            self._pluckable_columns = Set.new([:updated_at])
+            self._pluckable_columns = Set.new
             self._is_pluckable = true
         end
 
         def is_pluckable?
-            self._is_pluckable && !self._relationships.present?
+            self._is_pluckable
         end
 
         def add_attribute(key, attr)

data/lib/plucker/relationship.rb

@@ -1,15 +1,42 @@
 # frozen_string_literal: true
 require_relative 'collection'
-require_relative "field"
 
 module Plucker
-    class Relationship < Plucker::Field
+    class Relationship
+        attr_reader :name, :block, :options, :condition
+       
+        def initialize(name, options = {}, block)
+            @name = name
+            @block = block
+            @options = options
+            @condition = options[:if]
+        end
+
+        def should_include?(serializer)
+            case @condition
+            when nil
+                true
+            when Symbol
+                serializer.public_send(@condition)
+            when String
+                serializer.instance_eval(@condition)
+            when Proc
+                if @condition.arity.zero?
+                    serializer.instance_exec(&@condition)
+                else
+                    serializer.instance_exec(serializer, &@condition)
+                end
+            else
+                nil
+            end
+        end
+
         def associated_object(serializer)
-            block_value = instance_exec(serializer.object, &block) if block
-            if block && block_value != :nil
+            block_value = instance_exec(serializer.object, &@block) if @block
+            if @block && block_value != :nil
                 block_value
             else
-                serializer.object.send(name)
+                serializer.object.send(@name)
             end
         end
 
@@ -19,15 +46,15 @@ module Plucker
 
         private
         def relationship_serializer(serializer, relationship_object=nil)
-            if self.options[:serializer].blank?
+            if @options[:serializer].blank?
                 if relationship_object.present?
                     association_class = relationship_object.class.name
                 else
-                    association_class = serializer.object.class.reflect_on_association(self.name.to_sym).class_name
+                    association_class = serializer.object.class.reflect_on_association(@name.to_sym).class_name
                 end
                 "#{association_class.demodulize.camelize}Serializer".constantize
             else
-                self.options[:serializer]
+                @options[:serializer]
             end
         end
     end

data/lib/plucker/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Plucker
-    VERSION = "0.2.2"
+    VERSION = "0.5.0"
 end

data/lib/plucker_serializer.rb

@@ -7,7 +7,6 @@ require "plucker/relationship"
 require "plucker/belongs_to"
 require "plucker/has_one"
 require "plucker/has_many"
-require "plucker/field"
 require "plucker/descriptor"
 require "plucker/concerns/caching"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plucker_serializer
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Henry Boisgibault
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-01 00:00:00.000000000 Z
+date: 2022-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pluck_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A blazing fast JSON serializer for ActiveRecord & Ruby objects
 email: henry@logora.fr
 executables: []
@@ -37,7 +65,6 @@ files:
 - lib/plucker/concerns/caching.rb
 - lib/plucker/configuration.rb
 - lib/plucker/descriptor.rb
-- lib/plucker/field.rb
 - lib/plucker/has_many.rb
 - lib/plucker/has_one.rb
 - lib/plucker/relationship.rb

data/lib/plucker/field.rb

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-module Plucker
-    Field = Struct.new(:name, :options, :block) do
-        def initialize(*)
-            super
-            validate_condition!
-        end
-
-        def value(serializer)
-            block_value = instance_exec(serializer.object, &block) if block
-            if block && block_value != :nil
-                block_value
-            else
-                if serializer.respond_to?(name)
-                    serializer.send(name)
-                else
-                    serializer.object.send(name)
-                end
-            end
-        end
-
-        def is_pluckable?
-            block.blank?
-        end
-
-        def excluded?(serializer)
-            case condition_type
-            when :if
-                !evaluate_condition(serializer)
-            when :unless
-                evaluate_condition(serializer)
-            else
-                false
-            end
-        end
-
-        private
-        def validate_condition!
-            return if condition_type == :none
-
-            case condition
-            when Symbol, String, Proc
-                # noop
-            else
-                fail TypeError, "#{condition_type.inspect} should be a Symbol, String or Proc"
-            end
-        end
-
-        def evaluate_condition(serializer)
-            case condition
-            when Symbol
-                serializer.public_send(condition)
-            when String
-                serializer.instance_eval(condition)
-            when Proc
-                if condition.arity.zero?
-                    serializer.instance_exec(&condition)
-                else
-                    serializer.instance_exec(serializer, &condition)
-                end
-            else
-                nil
-            end
-        end
-
-        def condition_type
-            @condition_type ||=
-                if options.key?(:if)
-                    :if
-                elsif options.key?(:unless)
-                    :unless
-                else
-                    :none
-                end
-        end
-
-        def condition
-            options[condition_type]
-        end
-    end
-end