plucker_serializer 0.4.0 → 0.5.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/plucker/attribute.rb +44 -1
- data/lib/plucker/base.rb +14 -10
- data/lib/plucker/collection.rb +33 -10
- data/lib/plucker/concerns/caching.rb +4 -5
- data/lib/plucker/relationship.rb +35 -8
- data/lib/plucker/version.rb +1 -1
- data/lib/plucker_serializer.rb +0 -1
- metadata +2 -3
- data/lib/plucker/field.rb +0 -81
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3b74f3d1f2fee4bfa2fd0fc3e6968f35f6d1bbe852b69c6fda56ad63bdbe8ada
|
4
|
+
data.tar.gz: c9daa990c9d467958e6f30dd2faba3a69aa81dfa0708a6289243026504f88351
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f051ad0a434f02690092cdeb7481db0fc606b780574d8109251746f99b3f1888842c906231321f82ba896e9615939461a93ad95245082086235cb670fc27710b
|
7
|
+
data.tar.gz: b05c2e4c4f327a32c0c9faeae82fc017265f316e41f5f111a709577801862a70d481f7545b226b8cb848a8a83d705702a963851e9582ba2fbc72ec670ba3ccb3
|
data/lib/plucker/attribute.rb
CHANGED
@@ -1,5 +1,48 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
module Plucker
|
3
|
-
class Attribute
|
3
|
+
class Attribute
|
4
|
+
attr_reader :name, :block, :condition
|
5
|
+
|
6
|
+
def initialize(name, options = {}, block)
|
7
|
+
@name = name
|
8
|
+
@block = block
|
9
|
+
@condition = options[:if]
|
10
|
+
end
|
11
|
+
|
12
|
+
def value(serializer)
|
13
|
+
block_value = instance_exec(serializer.object, &@block) if @block
|
14
|
+
if @block && block_value != :nil
|
15
|
+
block_value
|
16
|
+
else
|
17
|
+
if serializer.respond_to?(@name)
|
18
|
+
serializer.send(@name)
|
19
|
+
else
|
20
|
+
serializer.object.send(@name)
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
|
25
|
+
def is_pluckable?
|
26
|
+
@block.blank?
|
27
|
+
end
|
28
|
+
|
29
|
+
def should_include?(serializer)
|
30
|
+
case @condition
|
31
|
+
when nil
|
32
|
+
true
|
33
|
+
when Symbol
|
34
|
+
serializer.public_send(@condition)
|
35
|
+
when String
|
36
|
+
serializer.instance_eval(@condition)
|
37
|
+
when Proc
|
38
|
+
if @condition.arity.zero?
|
39
|
+
serializer.instance_exec(&@condition)
|
40
|
+
else
|
41
|
+
serializer.instance_exec(serializer, &@condition)
|
42
|
+
end
|
43
|
+
else
|
44
|
+
nil
|
45
|
+
end
|
46
|
+
end
|
4
47
|
end
|
5
48
|
end
|
data/lib/plucker/base.rb
CHANGED
@@ -27,9 +27,9 @@ module Plucker
|
|
27
27
|
self.object = object
|
28
28
|
end
|
29
29
|
|
30
|
-
def serializable_hash
|
31
|
-
if self.class.cache_enabled?
|
32
|
-
fetch do
|
30
|
+
def serializable_hash(use_cache: true)
|
31
|
+
if use_cache && self.class.cache_enabled?
|
32
|
+
fetch(adapter: :hash) do
|
33
33
|
get_hash
|
34
34
|
end
|
35
35
|
else
|
@@ -43,8 +43,14 @@ module Plucker
|
|
43
43
|
serializable_hash
|
44
44
|
end
|
45
45
|
|
46
|
-
def to_json(options = {})
|
47
|
-
|
46
|
+
def to_json(options = {}, use_cache: true)
|
47
|
+
if use_cache && self.class.cache_enabled?
|
48
|
+
fetch(adapter: :json) do
|
49
|
+
Oj.dump(get_hash, mode: :rails)
|
50
|
+
end
|
51
|
+
else
|
52
|
+
Oj.dump(get_hash, mode: :rails)
|
53
|
+
end
|
48
54
|
end
|
49
55
|
|
50
56
|
def get_hash
|
@@ -52,17 +58,15 @@ module Plucker
|
|
52
58
|
end
|
53
59
|
|
54
60
|
def associations_hash
|
55
|
-
|
56
|
-
|
57
|
-
next if relationship.excluded?(self)
|
61
|
+
self.class._descriptor._relationships.each_with_object({}) do |(key, relationship), hash|
|
62
|
+
next if !relationship.should_include?(self)
|
58
63
|
hash[key.to_s] = relationship.value(self)
|
59
64
|
end
|
60
|
-
hash
|
61
65
|
end
|
62
66
|
|
63
67
|
def attributes_hash
|
64
68
|
self.class._descriptor._attributes.each_with_object({}) do |(key, attr), hash|
|
65
|
-
next if attr.
|
69
|
+
next if !attr.should_include?(self)
|
66
70
|
hash[key.to_s] = attr.value(self)
|
67
71
|
end
|
68
72
|
end
|
data/lib/plucker/collection.rb
CHANGED
@@ -23,12 +23,16 @@ module Plucker
|
|
23
23
|
serializer_class.new(object).serializable_hash
|
24
24
|
end.compact
|
25
25
|
else
|
26
|
-
if
|
27
|
-
|
28
|
-
|
26
|
+
if serializer_class.cache_enabled?
|
27
|
+
if @cache_type == :collection
|
28
|
+
fetch(adapter: :hash) do
|
29
|
+
get_hash(use_cache: false)
|
30
|
+
end
|
31
|
+
elsif @cache_type == :multi
|
32
|
+
get_hash(use_cache: true)
|
29
33
|
end
|
30
34
|
else
|
31
|
-
get_hash
|
35
|
+
get_hash(use_cache: false)
|
32
36
|
end
|
33
37
|
end
|
34
38
|
end
|
@@ -40,15 +44,35 @@ module Plucker
|
|
40
44
|
end
|
41
45
|
|
42
46
|
def to_json(options = {})
|
43
|
-
|
47
|
+
if serializer_class.cache_enabled?
|
48
|
+
if @cache_type == :collection
|
49
|
+
fetch(adapter: :json) do
|
50
|
+
Oj.dump(get_collection_json(use_cache: false), mode: :rails)
|
51
|
+
end
|
52
|
+
elsif @cache_type == :multi
|
53
|
+
Oj.dump(get_collection_json(use_cache: true), mode: :rails)
|
54
|
+
end
|
55
|
+
else
|
56
|
+
Oj.dump(get_collection_json(use_cache: false), mode: :rails)
|
57
|
+
end
|
44
58
|
end
|
45
59
|
|
46
|
-
def
|
60
|
+
def get_collection_json(use_cache: false)
|
47
61
|
if serializer_class.is_pluckable?
|
48
62
|
associated_hash
|
49
63
|
else
|
50
64
|
objects.map do |object|
|
51
|
-
serializer_class.new(object).
|
65
|
+
Oj.load(serializer_class.new(object).to_json(use_cache: use_cache))
|
66
|
+
end
|
67
|
+
end
|
68
|
+
end
|
69
|
+
|
70
|
+
def get_hash(use_cache: false)
|
71
|
+
if serializer_class.is_pluckable?
|
72
|
+
associated_hash
|
73
|
+
else
|
74
|
+
objects.map do |object|
|
75
|
+
serializer_class.new(object).serializable_hash(use_cache: use_cache)
|
52
76
|
end.compact
|
53
77
|
end
|
54
78
|
end
|
@@ -58,9 +82,8 @@ module Plucker
|
|
58
82
|
@cache_version = objects.cache_version
|
59
83
|
end
|
60
84
|
|
61
|
-
def cache_key
|
62
|
-
|
63
|
-
@cache_key = objects.cache_key + '/' + serializer_class._cache_digest
|
85
|
+
def cache_key(adapter: :json)
|
86
|
+
objects.cache_key + '/' + serializer_class._cache_digest + "/" + adapter.to_s
|
64
87
|
end
|
65
88
|
|
66
89
|
private
|
@@ -30,9 +30,9 @@ module Plucker
|
|
30
30
|
end
|
31
31
|
end
|
32
32
|
|
33
|
-
def fetch
|
33
|
+
def fetch(adapter: :json)
|
34
34
|
if serializer_class.cache_enabled?
|
35
|
-
serializer_class._cache_store.fetch(cache_key, version: cache_version, options: serializer_class._cache_options) do
|
35
|
+
serializer_class._cache_store.fetch(cache_key(adapter: adapter), version: cache_version, options: serializer_class._cache_options) do
|
36
36
|
yield
|
37
37
|
end
|
38
38
|
else
|
@@ -45,9 +45,8 @@ module Plucker
|
|
45
45
|
@cache_version = object.cache_version
|
46
46
|
end
|
47
47
|
|
48
|
-
def cache_key
|
49
|
-
|
50
|
-
@cache_key = object.cache_key + "/" + serializer_class._cache_digest
|
48
|
+
def cache_key(adapter: :json)
|
49
|
+
object.cache_key + "/" + serializer_class._cache_digest + "/" + adapter.to_s
|
51
50
|
end
|
52
51
|
|
53
52
|
def serializer_class
|
data/lib/plucker/relationship.rb
CHANGED
@@ -1,15 +1,42 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
require_relative 'collection'
|
3
|
-
require_relative "field"
|
4
3
|
|
5
4
|
module Plucker
|
6
|
-
class Relationship
|
5
|
+
class Relationship
|
6
|
+
attr_reader :name, :block, :options, :condition
|
7
|
+
|
8
|
+
def initialize(name, options = {}, block)
|
9
|
+
@name = name
|
10
|
+
@block = block
|
11
|
+
@options = options
|
12
|
+
@condition = options[:if]
|
13
|
+
end
|
14
|
+
|
15
|
+
def should_include?(serializer)
|
16
|
+
case @condition
|
17
|
+
when nil
|
18
|
+
true
|
19
|
+
when Symbol
|
20
|
+
serializer.public_send(@condition)
|
21
|
+
when String
|
22
|
+
serializer.instance_eval(@condition)
|
23
|
+
when Proc
|
24
|
+
if @condition.arity.zero?
|
25
|
+
serializer.instance_exec(&@condition)
|
26
|
+
else
|
27
|
+
serializer.instance_exec(serializer, &@condition)
|
28
|
+
end
|
29
|
+
else
|
30
|
+
nil
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
7
34
|
def associated_object(serializer)
|
8
|
-
block_value = instance_exec(serializer.object,
|
9
|
-
if block && block_value != :nil
|
35
|
+
block_value = instance_exec(serializer.object, &@block) if @block
|
36
|
+
if @block && block_value != :nil
|
10
37
|
block_value
|
11
38
|
else
|
12
|
-
serializer.object.send(name)
|
39
|
+
serializer.object.send(@name)
|
13
40
|
end
|
14
41
|
end
|
15
42
|
|
@@ -19,15 +46,15 @@ module Plucker
|
|
19
46
|
|
20
47
|
private
|
21
48
|
def relationship_serializer(serializer, relationship_object=nil)
|
22
|
-
if
|
49
|
+
if @options[:serializer].blank?
|
23
50
|
if relationship_object.present?
|
24
51
|
association_class = relationship_object.class.name
|
25
52
|
else
|
26
|
-
association_class = serializer.object.class.reflect_on_association(
|
53
|
+
association_class = serializer.object.class.reflect_on_association(@name.to_sym).class_name
|
27
54
|
end
|
28
55
|
"#{association_class.demodulize.camelize}Serializer".constantize
|
29
56
|
else
|
30
|
-
|
57
|
+
@options[:serializer]
|
31
58
|
end
|
32
59
|
end
|
33
60
|
end
|
data/lib/plucker/version.rb
CHANGED
data/lib/plucker_serializer.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: plucker_serializer
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.5.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Henry Boisgibault
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-08-
|
11
|
+
date: 2022-08-05 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: activesupport
|
@@ -65,7 +65,6 @@ files:
|
|
65
65
|
- lib/plucker/concerns/caching.rb
|
66
66
|
- lib/plucker/configuration.rb
|
67
67
|
- lib/plucker/descriptor.rb
|
68
|
-
- lib/plucker/field.rb
|
69
68
|
- lib/plucker/has_many.rb
|
70
69
|
- lib/plucker/has_one.rb
|
71
70
|
- lib/plucker/relationship.rb
|
data/lib/plucker/field.rb
DELETED
@@ -1,81 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
module Plucker
|
3
|
-
Field = Struct.new(:name, :options, :block) do
|
4
|
-
def initialize(*)
|
5
|
-
super
|
6
|
-
validate_condition!
|
7
|
-
end
|
8
|
-
|
9
|
-
def value(serializer)
|
10
|
-
block_value = instance_exec(serializer.object, &block) if block
|
11
|
-
if block && block_value != :nil
|
12
|
-
block_value
|
13
|
-
else
|
14
|
-
if serializer.respond_to?(name)
|
15
|
-
serializer.send(name)
|
16
|
-
else
|
17
|
-
serializer.object.send(name)
|
18
|
-
end
|
19
|
-
end
|
20
|
-
end
|
21
|
-
|
22
|
-
def is_pluckable?
|
23
|
-
block.blank?
|
24
|
-
end
|
25
|
-
|
26
|
-
def excluded?(serializer)
|
27
|
-
case condition_type
|
28
|
-
when :if
|
29
|
-
!evaluate_condition(serializer)
|
30
|
-
when :unless
|
31
|
-
evaluate_condition(serializer)
|
32
|
-
else
|
33
|
-
false
|
34
|
-
end
|
35
|
-
end
|
36
|
-
|
37
|
-
private
|
38
|
-
def validate_condition!
|
39
|
-
return if condition_type == :none
|
40
|
-
|
41
|
-
case condition
|
42
|
-
when Symbol, String, Proc
|
43
|
-
# noop
|
44
|
-
else
|
45
|
-
fail TypeError, "#{condition_type.inspect} should be a Symbol, String or Proc"
|
46
|
-
end
|
47
|
-
end
|
48
|
-
|
49
|
-
def evaluate_condition(serializer)
|
50
|
-
case condition
|
51
|
-
when Symbol
|
52
|
-
serializer.public_send(condition)
|
53
|
-
when String
|
54
|
-
serializer.instance_eval(condition)
|
55
|
-
when Proc
|
56
|
-
if condition.arity.zero?
|
57
|
-
serializer.instance_exec(&condition)
|
58
|
-
else
|
59
|
-
serializer.instance_exec(serializer, &condition)
|
60
|
-
end
|
61
|
-
else
|
62
|
-
nil
|
63
|
-
end
|
64
|
-
end
|
65
|
-
|
66
|
-
def condition_type
|
67
|
-
@condition_type ||=
|
68
|
-
if options.key?(:if)
|
69
|
-
:if
|
70
|
-
elsif options.key?(:unless)
|
71
|
-
:unless
|
72
|
-
else
|
73
|
-
:none
|
74
|
-
end
|
75
|
-
end
|
76
|
-
|
77
|
-
def condition
|
78
|
-
options[condition_type]
|
79
|
-
end
|
80
|
-
end
|
81
|
-
end
|