active_model_serializers 0.8.3 → 0.10.0.rc4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (184) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +6 -0
  3. data/.rubocop.yml +86 -0
  4. data/.rubocop_todo.yml +240 -0
  5. data/.simplecov +111 -0
  6. data/.travis.yml +33 -22
  7. data/CHANGELOG.md +358 -6
  8. data/CONTRIBUTING.md +220 -0
  9. data/Gemfile +46 -1
  10. data/{MIT-LICENSE.txt → LICENSE.txt} +3 -2
  11. data/README.md +81 -591
  12. data/Rakefile +68 -11
  13. data/active_model_serializers.gemspec +57 -23
  14. data/appveyor.yml +27 -0
  15. data/docs/ARCHITECTURE.md +120 -0
  16. data/docs/DESIGN.textile +8 -0
  17. data/docs/README.md +35 -0
  18. data/docs/general/adapters.md +162 -0
  19. data/docs/general/caching.md +52 -0
  20. data/docs/general/configuration_options.md +27 -0
  21. data/docs/general/getting_started.md +98 -0
  22. data/docs/general/instrumentation.md +40 -0
  23. data/docs/general/logging.md +14 -0
  24. data/docs/general/rendering.md +153 -0
  25. data/docs/general/serializers.md +207 -0
  26. data/docs/how-open-source-maintained.jpg +0 -0
  27. data/docs/howto/add_pagination_links.md +121 -0
  28. data/docs/howto/add_root_key.md +51 -0
  29. data/docs/howto/outside_controller_use.md +58 -0
  30. data/docs/howto/test.md +152 -0
  31. data/docs/integrations/ember-and-json-api.md +112 -0
  32. data/docs/integrations/grape.md +19 -0
  33. data/docs/jsonapi/schema/schema.json +366 -0
  34. data/docs/jsonapi/schema.md +140 -0
  35. data/lib/action_controller/serialization.rb +41 -37
  36. data/lib/active_model/serializable_resource.rb +72 -0
  37. data/lib/active_model/serializer/adapter/attributes.rb +66 -0
  38. data/lib/active_model/serializer/adapter/base.rb +58 -0
  39. data/lib/active_model/serializer/adapter/cached_serializer.rb +45 -0
  40. data/lib/active_model/serializer/adapter/fragment_cache.rb +111 -0
  41. data/lib/active_model/serializer/adapter/json/fragment_cache.rb +13 -0
  42. data/lib/active_model/serializer/adapter/json.rb +21 -0
  43. data/lib/active_model/serializer/adapter/json_api/deserialization.rb +207 -0
  44. data/lib/active_model/serializer/adapter/json_api/fragment_cache.rb +21 -0
  45. data/lib/active_model/serializer/adapter/json_api/link.rb +44 -0
  46. data/lib/active_model/serializer/adapter/json_api/pagination_links.rb +58 -0
  47. data/lib/active_model/serializer/adapter/json_api.rb +223 -0
  48. data/lib/active_model/serializer/adapter/null.rb +11 -0
  49. data/lib/active_model/serializer/adapter.rb +91 -0
  50. data/lib/active_model/serializer/array_serializer.rb +9 -0
  51. data/lib/active_model/serializer/association.rb +20 -0
  52. data/lib/active_model/serializer/associations.rb +87 -220
  53. data/lib/active_model/serializer/attribute.rb +25 -0
  54. data/lib/active_model/serializer/attributes.rb +82 -0
  55. data/lib/active_model/serializer/belongs_to_reflection.rb +10 -0
  56. data/lib/active_model/serializer/caching.rb +100 -0
  57. data/lib/active_model/serializer/collection_reflection.rb +7 -0
  58. data/lib/active_model/serializer/collection_serializer.rb +47 -0
  59. data/lib/active_model/serializer/configuration.rb +28 -0
  60. data/lib/active_model/serializer/field.rb +56 -0
  61. data/lib/active_model/serializer/fieldset.rb +31 -0
  62. data/lib/active_model/serializer/has_many_reflection.rb +10 -0
  63. data/lib/active_model/serializer/has_one_reflection.rb +10 -0
  64. data/lib/active_model/serializer/include_tree.rb +111 -0
  65. data/lib/active_model/serializer/links.rb +33 -0
  66. data/lib/active_model/serializer/lint.rb +142 -0
  67. data/lib/active_model/serializer/reflection.rb +91 -0
  68. data/lib/active_model/serializer/singular_reflection.rb +7 -0
  69. data/lib/active_model/serializer/type.rb +25 -0
  70. data/lib/active_model/{serializers → serializer}/version.rb +1 -1
  71. data/lib/active_model/serializer.rb +99 -479
  72. data/lib/active_model_serializers/callbacks.rb +55 -0
  73. data/lib/active_model_serializers/deserialization.rb +13 -0
  74. data/lib/active_model_serializers/logging.rb +119 -0
  75. data/lib/active_model_serializers/model.rb +39 -0
  76. data/lib/active_model_serializers/railtie.rb +38 -0
  77. data/lib/active_model_serializers/serialization_context.rb +10 -0
  78. data/lib/active_model_serializers/test/schema.rb +103 -0
  79. data/lib/active_model_serializers/test/serializer.rb +125 -0
  80. data/lib/active_model_serializers/test.rb +7 -0
  81. data/lib/active_model_serializers.rb +20 -92
  82. data/lib/generators/rails/USAGE +6 -0
  83. data/lib/generators/rails/resource_override.rb +10 -0
  84. data/lib/generators/rails/serializer_generator.rb +36 -0
  85. data/lib/generators/rails/templates/serializer.rb.erb +8 -0
  86. data/lib/grape/active_model_serializers.rb +14 -0
  87. data/lib/grape/formatters/active_model_serializers.rb +15 -0
  88. data/lib/grape/helpers/active_model_serializers.rb +16 -0
  89. data/test/action_controller/adapter_selector_test.rb +53 -0
  90. data/test/action_controller/explicit_serializer_test.rb +134 -0
  91. data/test/action_controller/json/include_test.rb +167 -0
  92. data/test/action_controller/json_api/deserialization_test.rb +59 -0
  93. data/test/action_controller/json_api/linked_test.rb +196 -0
  94. data/test/action_controller/json_api/pagination_test.rb +116 -0
  95. data/test/{serialization_scope_name_test.rb → action_controller/serialization_scope_name_test.rb} +11 -15
  96. data/test/action_controller/serialization_test.rb +435 -0
  97. data/test/active_model_serializers/logging_test.rb +77 -0
  98. data/test/active_model_serializers/model_test.rb +9 -0
  99. data/test/active_model_serializers/railtie_test_isolated.rb +57 -0
  100. data/test/active_model_serializers/serialization_context_test.rb +18 -0
  101. data/test/active_model_serializers/test/schema_test.rb +128 -0
  102. data/test/active_model_serializers/test/serializer_test.rb +63 -0
  103. data/test/active_record_test.rb +9 -0
  104. data/test/adapter/fragment_cache_test.rb +38 -0
  105. data/test/adapter/json/belongs_to_test.rb +47 -0
  106. data/test/adapter/json/collection_test.rb +92 -0
  107. data/test/adapter/json/has_many_test.rb +47 -0
  108. data/test/adapter/json_api/belongs_to_test.rb +157 -0
  109. data/test/adapter/json_api/collection_test.rb +97 -0
  110. data/test/adapter/json_api/fields_test.rb +89 -0
  111. data/test/adapter/json_api/has_many_embed_ids_test.rb +45 -0
  112. data/test/adapter/json_api/has_many_explicit_serializer_test.rb +98 -0
  113. data/test/adapter/json_api/has_many_test.rb +145 -0
  114. data/test/adapter/json_api/has_one_test.rb +81 -0
  115. data/test/adapter/json_api/json_api_test.rb +37 -0
  116. data/test/adapter/json_api/linked_test.rb +394 -0
  117. data/test/adapter/json_api/links_test.rb +68 -0
  118. data/test/adapter/json_api/pagination_links_test.rb +115 -0
  119. data/test/adapter/json_api/parse_test.rb +139 -0
  120. data/test/adapter/json_api/resource_type_config_test.rb +71 -0
  121. data/test/adapter/json_api/toplevel_jsonapi_test.rb +84 -0
  122. data/test/adapter/json_test.rb +47 -0
  123. data/test/adapter/null_test.rb +25 -0
  124. data/test/adapter_test.rb +42 -0
  125. data/test/array_serializer_test.rb +36 -73
  126. data/test/collection_serializer_test.rb +100 -0
  127. data/test/fixtures/active_record.rb +56 -0
  128. data/test/fixtures/poro.rb +229 -0
  129. data/test/generators/scaffold_controller_generator_test.rb +24 -0
  130. data/test/generators/serializer_generator_test.rb +57 -0
  131. data/test/grape_test.rb +82 -0
  132. data/test/include_tree/from_include_args_test.rb +26 -0
  133. data/test/include_tree/from_string_test.rb +94 -0
  134. data/test/include_tree/include_args_to_hash_test.rb +64 -0
  135. data/test/lint_test.rb +40 -0
  136. data/test/logger_test.rb +18 -0
  137. data/test/poro_test.rb +9 -0
  138. data/test/serializable_resource_test.rb +27 -0
  139. data/test/serializers/adapter_for_test.rb +166 -0
  140. data/test/serializers/association_macros_test.rb +36 -0
  141. data/test/serializers/associations_test.rb +267 -0
  142. data/test/serializers/attribute_test.rb +123 -0
  143. data/test/serializers/attributes_test.rb +52 -0
  144. data/test/serializers/cache_test.rb +209 -0
  145. data/test/serializers/configuration_test.rb +32 -0
  146. data/test/serializers/fieldset_test.rb +14 -0
  147. data/test/serializers/meta_test.rb +130 -0
  148. data/test/serializers/options_test.rb +21 -0
  149. data/test/serializers/root_test.rb +21 -0
  150. data/test/serializers/serializer_for_test.rb +134 -0
  151. data/test/support/custom_schemas/active_model_serializers/test/schema_test/my/index.json +6 -0
  152. data/test/support/isolated_unit.rb +77 -0
  153. data/test/support/rails5_shims.rb +29 -0
  154. data/test/support/rails_app.rb +25 -0
  155. data/test/support/schemas/active_model_serializers/test/schema_test/my/index.json +6 -0
  156. data/test/support/schemas/active_model_serializers/test/schema_test/my/show.json +6 -0
  157. data/test/support/schemas/custom/show.json +7 -0
  158. data/test/support/schemas/hyper_schema.json +93 -0
  159. data/test/support/schemas/render_using_json_api.json +43 -0
  160. data/test/support/schemas/simple_json_pointers.json +10 -0
  161. data/test/support/serialization_testing.rb +53 -0
  162. data/test/support/simplecov.rb +6 -0
  163. data/test/support/stream_capture.rb +50 -0
  164. data/test/support/test_case.rb +19 -0
  165. data/test/test_helper.rb +55 -24
  166. metadata +358 -42
  167. data/DESIGN.textile +0 -586
  168. data/Gemfile.edge +0 -9
  169. data/bench/perf.rb +0 -43
  170. data/cruft.md +0 -19
  171. data/lib/active_model/array_serializer.rb +0 -104
  172. data/lib/active_record/serializer_override.rb +0 -16
  173. data/lib/generators/resource_override.rb +0 -13
  174. data/lib/generators/serializer/USAGE +0 -9
  175. data/lib/generators/serializer/serializer_generator.rb +0 -42
  176. data/lib/generators/serializer/templates/serializer.rb +0 -19
  177. data/test/association_test.rb +0 -592
  178. data/test/caching_test.rb +0 -96
  179. data/test/generators_test.rb +0 -85
  180. data/test/no_serialization_scope_test.rb +0 -34
  181. data/test/serialization_test.rb +0 -392
  182. data/test/serializer_support_test.rb +0 -51
  183. data/test/serializer_test.rb +0 -1465
  184. data/test/test_fakes.rb +0 -217
@@ -1,230 +1,97 @@
1
1
  module ActiveModel
2
2
  class Serializer
3
- module Associations #:nodoc:
4
- class Config #:nodoc:
5
- class_attribute :options
6
-
7
- def self.refine(name, class_options)
8
- current_class = self
9
-
10
- Class.new(self) do
11
- singleton_class.class_eval do
12
- define_method(:to_s) do
13
- "(subclass of #{current_class.name})"
14
- end
15
-
16
- alias inspect to_s
17
- end
18
-
19
- self.options = class_options
20
-
21
- # cache the root so we can reuse it without falling back on a per-instance basis
22
- begin
23
- self.options[:root] ||= self.new(name, nil).root
24
- rescue
25
- # this could fail if it needs a valid source, for example a polymorphic association
26
- end
27
-
28
- end
29
- end
30
-
31
- self.options = {}
32
-
33
- def initialize(name, source, options={})
34
- @name = name
35
- @source = source
36
- @options = options
37
- end
38
-
39
- def option(key, default=nil)
40
- if @options.key?(key)
41
- @options[key]
42
- elsif self.class.options.key?(key)
43
- self.class.options[key]
44
- else
45
- default
46
- end
47
- end
48
-
49
- def target_serializer
50
- serializer = option(:serializer)
51
- serializer.is_a?(String) ? serializer.constantize : serializer
52
- end
53
-
54
- def source_serializer
55
- @source
56
- end
57
-
58
- def key
59
- option(:key) || @name
60
- end
61
-
62
- def root
63
- option(:root) || @name
64
- end
65
-
66
- def name
67
- option(:name) || @name
68
- end
69
-
70
- def associated_object
71
- option(:value) || source_serializer.send(name)
72
- end
73
-
74
- def embed_ids?
75
- [:id, :ids].include? option(:embed, source_serializer._embed)
76
- end
77
-
78
- def embed_objects?
79
- [:object, :objects].include? option(:embed, source_serializer._embed)
80
- end
81
-
82
- def embed_in_root?
83
- option(:include, source_serializer._root_embed)
84
- end
85
-
86
- def embeddable?
87
- !associated_object.nil?
88
- end
89
-
90
- protected
91
-
92
- def find_serializable(object)
93
- if target_serializer
94
- target_serializer.new(object, source_serializer.options)
95
- elsif object.respond_to?(:active_model_serializer) && (ams = object.active_model_serializer)
96
- ams.new(object, source_serializer.options)
97
- else
98
- object
99
- end
100
- end
3
+ # Defines an association in the object should be rendered.
4
+ #
5
+ # The serializer object should implement the association name
6
+ # as a method which should return an array when invoked. If a method
7
+ # with the association name does not exist, the association name is
8
+ # dispatched to the serialized object.
9
+ #
10
+ module Associations
11
+ extend ActiveSupport::Concern
12
+
13
+ DEFAULT_INCLUDE_TREE = ActiveModel::Serializer::IncludeTree.from_string('*')
14
+
15
+ included do
16
+ with_options instance_writer: false, instance_reader: true do |serializer|
17
+ serializer.class_attribute :_reflections
18
+ self._reflections ||= []
19
+ end
20
+
21
+ extend ActiveSupport::Autoload
22
+ autoload :Association
23
+ autoload :Reflection
24
+ autoload :SingularReflection
25
+ autoload :CollectionReflection
26
+ autoload :BelongsToReflection
27
+ autoload :HasOneReflection
28
+ autoload :HasManyReflection
101
29
  end
102
30
 
103
- class HasMany < Config #:nodoc:
104
- def key
105
- if key = option(:key)
106
- key
107
- elsif embed_ids?
108
- "#{@name.to_s.singularize}_ids".to_sym
109
- else
110
- @name
111
- end
112
- end
113
-
114
- def embed_key
115
- if key = option(:embed_key)
116
- key
117
- else
118
- :id
119
- end
120
- end
121
-
122
- def serialize
123
- associated_object.map do |item|
124
- find_serializable(item).serializable_hash
125
- end
126
- end
127
-
128
- def serializables
129
- associated_object.map do |item|
130
- find_serializable(item)
131
- end
132
- end
133
-
134
- def serialize_ids
135
- ids_key = "#{@name.to_s.singularize}_ids".to_sym
136
- if !option(:embed_key) && !source_serializer.respond_to?(@name.to_s) && source_serializer.object.respond_to?(ids_key)
137
- source_serializer.object.read_attribute_for_serialization(ids_key)
138
- else
139
- associated_object.map do |item|
140
- item.read_attribute_for_serialization(embed_key)
141
- end
142
- end
31
+ module ClassMethods
32
+ def inherited(base)
33
+ super
34
+ base._reflections = _reflections.dup
35
+ end
36
+
37
+ # @param [Symbol] name of the association
38
+ # @param [Hash<Symbol => any>] options for the reflection
39
+ # @return [void]
40
+ #
41
+ # @example
42
+ # has_many :comments, serializer: CommentSummarySerializer
43
+ #
44
+ def has_many(name, options = {}, &block)
45
+ associate(HasManyReflection.new(name, options, block))
46
+ end
47
+
48
+ # @param [Symbol] name of the association
49
+ # @param [Hash<Symbol => any>] options for the reflection
50
+ # @return [void]
51
+ #
52
+ # @example
53
+ # belongs_to :author, serializer: AuthorSerializer
54
+ #
55
+ def belongs_to(name, options = {}, &block)
56
+ associate(BelongsToReflection.new(name, options, block))
57
+ end
58
+
59
+ # @param [Symbol] name of the association
60
+ # @param [Hash<Symbol => any>] options for the reflection
61
+ # @return [void]
62
+ #
63
+ # @example
64
+ # has_one :author, serializer: AuthorSerializer
65
+ #
66
+ def has_one(name, options = {}, &block)
67
+ associate(HasOneReflection.new(name, options, block))
68
+ end
69
+
70
+ private
71
+
72
+ # Add reflection and define {name} accessor.
73
+ # @param [ActiveModel::Serializer::Reflection] reflection
74
+ # @return [void]
75
+ #
76
+ # @api private
77
+ #
78
+ def associate(reflection)
79
+ self._reflections << reflection
143
80
  end
144
81
  end
145
82
 
146
- class HasOne < Config #:nodoc:
147
- def embeddable?
148
- if polymorphic? && associated_object.nil?
149
- false
150
- else
151
- true
152
- end
153
- end
154
-
155
- def polymorphic?
156
- option :polymorphic
157
- end
158
-
159
- def root
160
- if root = option(:root)
161
- root
162
- elsif polymorphic?
163
- associated_object.class.to_s.pluralize.demodulize.underscore.to_sym
164
- else
165
- @name.to_s.pluralize.to_sym
166
- end
167
- end
168
-
169
- def key
170
- if key = option(:key)
171
- key
172
- elsif embed_ids? && !polymorphic?
173
- "#{@name}_id".to_sym
174
- else
175
- @name
176
- end
177
- end
178
-
179
- def embed_key
180
- if key = option(:embed_key)
181
- key
182
- else
183
- :id
184
- end
185
- end
186
-
187
- def polymorphic_key
188
- associated_object.class.to_s.demodulize.underscore.to_sym
189
- end
190
-
191
- def serialize
192
- object = associated_object
193
-
194
- if object && polymorphic?
195
- {
196
- :type => polymorphic_key,
197
- polymorphic_key => find_serializable(object).serializable_hash
198
- }
199
- elsif object
200
- find_serializable(object).serializable_hash
201
- end
202
- end
203
-
204
- def serializables
205
- object = associated_object
206
- value = object && find_serializable(object)
207
- value ? [value] : []
208
- end
209
-
210
- def serialize_ids
211
- id_key = "#{@name}_id".to_sym
212
-
213
- if polymorphic?
214
- if associated_object
215
- {
216
- :type => polymorphic_key,
217
- :id => associated_object.read_attribute_for_serialization(embed_key)
218
- }
219
- else
220
- nil
221
- end
222
- elsif !option(:embed_key) && !source_serializer.respond_to?(@name.to_s) && source_serializer.object.respond_to?(id_key)
223
- source_serializer.object.read_attribute_for_serialization(id_key)
224
- elsif associated_object
225
- associated_object.read_attribute_for_serialization(embed_key)
226
- else
227
- nil
83
+ # @param [IncludeTree] include_tree (defaults to all associations when not provided)
84
+ # @return [Enumerator<Association>]
85
+ #
86
+ def associations(include_tree = DEFAULT_INCLUDE_TREE)
87
+ return unless object
88
+
89
+ Enumerator.new do |y|
90
+ self.class._reflections.each do |reflection|
91
+ next if reflection.excluded?(self)
92
+ key = reflection.options.fetch(:key, reflection.name)
93
+ next unless include_tree.key?(key)
94
+ y.yield reflection.build_association(self, instance_options)
228
95
  end
229
96
  end
230
97
  end
@@ -0,0 +1,25 @@
1
+ require 'active_model/serializer/field'
2
+
3
+ module ActiveModel
4
+ class Serializer
5
+ # Holds all the meta-data about an attribute as it was specified in the
6
+ # ActiveModel::Serializer class.
7
+ #
8
+ # @example
9
+ # class PostSerializer < ActiveModel::Serializer
10
+ # attribute :content
11
+ # attribute :name, key: :title
12
+ # attribute :email, key: :author_email, if: :user_logged_in?
13
+ # attribute :preview do
14
+ # truncate(object.content)
15
+ # end
16
+ #
17
+ # def user_logged_in?
18
+ # current_user.logged_in?
19
+ # end
20
+ # end
21
+ #
22
+ class Attribute < Field
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,82 @@
1
+ module ActiveModel
2
+ class Serializer
3
+ module Attributes
4
+ extend ActiveSupport::Concern
5
+
6
+ included do
7
+ with_options instance_writer: false, instance_reader: false do |serializer|
8
+ serializer.class_attribute :_attributes_data # @api private
9
+ self._attributes_data ||= {}
10
+ end
11
+
12
+ extend ActiveSupport::Autoload
13
+ autoload :Attribute
14
+
15
+ # Return the +attributes+ of +object+ as presented
16
+ # by the serializer.
17
+ def attributes(requested_attrs = nil, reload = false)
18
+ @attributes = nil if reload
19
+ @attributes ||= self.class._attributes_data.each_with_object({}) do |(key, attr), hash|
20
+ next if attr.excluded?(self)
21
+ next unless requested_attrs.nil? || requested_attrs.include?(key)
22
+ hash[key] = attr.value(self)
23
+ end
24
+ end
25
+ end
26
+
27
+ module ClassMethods
28
+ def inherited(base)
29
+ super
30
+ base._attributes_data = _attributes_data.dup
31
+ end
32
+
33
+ # @example
34
+ # class AdminAuthorSerializer < ActiveModel::Serializer
35
+ # attributes :id, :name, :recent_edits
36
+ def attributes(*attrs)
37
+ attrs = attrs.first if attrs.first.class == Array
38
+
39
+ attrs.each do |attr|
40
+ attribute(attr)
41
+ end
42
+ end
43
+
44
+ # @example
45
+ # class AdminAuthorSerializer < ActiveModel::Serializer
46
+ # attributes :id, :recent_edits
47
+ # attribute :name, key: :title
48
+ #
49
+ # attribute :full_name do
50
+ # "#{object.first_name} #{object.last_name}"
51
+ # end
52
+ #
53
+ # def recent_edits
54
+ # object.edits.last(5)
55
+ # end
56
+ def attribute(attr, options = {}, &block)
57
+ key = options.fetch(:key, attr)
58
+ _attributes_data[key] = Attribute.new(attr, options, block)
59
+ end
60
+
61
+ # @api private
62
+ # keys of attributes
63
+ # @see Serializer::attribute
64
+ def _attributes
65
+ _attributes_data.keys
66
+ end
67
+
68
+ # @api private
69
+ # maps attribute value to explict key name
70
+ # @see Serializer::attribute
71
+ # @see Adapter::FragmentCache#fragment_serializer
72
+ def _attributes_keys
73
+ _attributes_data
74
+ .each_with_object({}) do |(key, attr), hash|
75
+ next if key == attr.name
76
+ hash[attr.name] = { key: key }
77
+ end
78
+ end
79
+ end
80
+ end
81
+ end
82
+ end
@@ -0,0 +1,10 @@
1
+ module ActiveModel
2
+ class Serializer
3
+ # @api private
4
+ class BelongsToReflection < SingularReflection
5
+ def macro
6
+ :belongs_to
7
+ end
8
+ end
9
+ end
10
+ end
@@ -0,0 +1,100 @@
1
+ module ActiveModel
2
+ class Serializer
3
+ module Caching
4
+ extend ActiveSupport::Concern
5
+
6
+ included do
7
+ with_options instance_writer: false, instance_reader: false do |serializer|
8
+ serializer.class_attribute :_cache # @api private : the cache object
9
+ serializer.class_attribute :_fragmented # @api private : @see ::fragmented
10
+ serializer.class_attribute :_cache_key # @api private : when present, is first item in cache_key
11
+ serializer.class_attribute :_cache_only # @api private : when fragment caching, whitelists cached_attributes. Cannot combine with except
12
+ serializer.class_attribute :_cache_except # @api private : when fragment caching, blacklists cached_attributes. Cannot combine with only
13
+ serializer.class_attribute :_cache_options # @api private : used by CachedSerializer, passed to _cache.fetch
14
+ # _cache_options include:
15
+ # expires_in
16
+ # compress
17
+ # force
18
+ # race_condition_ttl
19
+ # Passed to ::_cache as
20
+ # serializer._cache.fetch(cache_key, @klass._cache_options)
21
+ serializer.class_attribute :_cache_digest # @api private : Generated
22
+ end
23
+ end
24
+
25
+ # Matches
26
+ # "c:/git/emberjs/ember-crm-backend/app/serializers/lead_serializer.rb:1:in `<top (required)>'"
27
+ # AND
28
+ # "/c/git/emberjs/ember-crm-backend/app/serializers/lead_serializer.rb:1:in `<top (required)>'"
29
+ # AS
30
+ # c/git/emberjs/ember-crm-backend/app/serializers/lead_serializer.rb
31
+ CALLER_FILE = /
32
+ \A # start of string
33
+ .+ # file path (one or more characters)
34
+ (?= # stop previous match when
35
+ :\d+ # a colon is followed by one or more digits
36
+ :in # followed by a colon followed by in
37
+ )
38
+ /x
39
+
40
+ module ClassMethods
41
+ def inherited(base)
42
+ super
43
+ caller_line = caller[1]
44
+ base._cache_digest = digest_caller_file(caller_line)
45
+ end
46
+
47
+ # Hashes contents of file for +_cache_digest+
48
+ def digest_caller_file(caller_line)
49
+ serializer_file_path = caller_line[CALLER_FILE]
50
+ serializer_file_contents = IO.read(serializer_file_path)
51
+ Digest::MD5.hexdigest(serializer_file_contents)
52
+ rescue TypeError, Errno::ENOENT
53
+ warn <<-EOF.strip_heredoc
54
+ Cannot digest non-existent file: '#{caller_line}'.
55
+ Please set `::_cache_digest` of the serializer
56
+ if you'd like to cache it.
57
+ EOF
58
+ ''.freeze
59
+ end
60
+
61
+ # @api private
62
+ # Used by FragmentCache on the CachedSerializer
63
+ # to call attribute methods on the fragmented cached serializer.
64
+ def fragmented(serializer)
65
+ self._fragmented = serializer
66
+ end
67
+
68
+ # Enables a serializer to be automatically cached
69
+ #
70
+ # Sets +::_cache+ object to <tt>ActionController::Base.cache_store</tt>
71
+ # when Rails.configuration.action_controller.perform_caching
72
+ #
73
+ # @params options [Hash] with valid keys:
74
+ # key : @see ::_cache_key
75
+ # only : @see ::_cache_only
76
+ # except : @see ::_cache_except
77
+ # skip_digest : does not include digest in cache_key
78
+ # all else : @see ::_cache_options
79
+ #
80
+ # @example
81
+ # class PostSerializer < ActiveModel::Serializer
82
+ # cache key: 'post', expires_in: 3.hours
83
+ # attributes :title, :body
84
+ #
85
+ # has_many :comments
86
+ # end
87
+ #
88
+ # @todo require less code comments. See
89
+ # https://github.com/rails-api/active_model_serializers/pull/1249#issuecomment-146567837
90
+ def cache(options = {})
91
+ self._cache = ActiveModelSerializers.config.cache_store if ActiveModelSerializers.config.perform_caching
92
+ self._cache_key = options.delete(:key)
93
+ self._cache_only = options.delete(:only)
94
+ self._cache_except = options.delete(:except)
95
+ self._cache_options = (options.empty?) ? nil : options
96
+ end
97
+ end
98
+ end
99
+ end
100
+ end
@@ -0,0 +1,7 @@
1
+ module ActiveModel
2
+ class Serializer
3
+ # @api private
4
+ class CollectionReflection < Reflection
5
+ end
6
+ end
7
+ end
@@ -0,0 +1,47 @@
1
+ module ActiveModel
2
+ class Serializer
3
+ class CollectionSerializer
4
+ NoSerializerError = Class.new(StandardError)
5
+ include Enumerable
6
+ delegate :each, to: :@serializers
7
+
8
+ attr_reader :object, :root
9
+
10
+ def initialize(resources, options = {})
11
+ @root = options[:root]
12
+ @object = resources
13
+ @serializers = resources.map do |resource|
14
+ serializer_context_class = options.fetch(:serializer_context_class, ActiveModel::Serializer)
15
+ serializer_class = options.fetch(:serializer) { serializer_context_class.serializer_for(resource) }
16
+
17
+ if serializer_class.nil?
18
+ fail NoSerializerError, "No serializer found for resource: #{resource.inspect}"
19
+ else
20
+ serializer_class.new(resource, options.except(:serializer))
21
+ end
22
+ end
23
+ end
24
+
25
+ def json_key
26
+ root || derived_root
27
+ end
28
+
29
+ def paginated?
30
+ object.respond_to?(:current_page) &&
31
+ object.respond_to?(:total_pages) &&
32
+ object.respond_to?(:size)
33
+ end
34
+
35
+ protected
36
+
37
+ attr_reader :serializers
38
+
39
+ private
40
+
41
+ def derived_root
42
+ key = serializers.first.try(:json_key) || object.try(:name).try(:underscore)
43
+ key.try(:pluralize)
44
+ end
45
+ end
46
+ end
47
+ end
@@ -0,0 +1,28 @@
1
+ module ActiveModel
2
+ class Serializer
3
+ module Configuration
4
+ include ActiveSupport::Configurable
5
+ extend ActiveSupport::Concern
6
+
7
+ # Configuration options may also be set in
8
+ # Serializers and Adapters
9
+ included do |base|
10
+ config = base.config
11
+ config.collection_serializer = ActiveModel::Serializer::CollectionSerializer
12
+ config.serializer_lookup_enabled = true
13
+
14
+ def config.array_serializer=(collection_serializer)
15
+ self.collection_serializer = collection_serializer
16
+ end
17
+
18
+ def config.array_serializer
19
+ collection_serializer
20
+ end
21
+
22
+ config.adapter = :attributes
23
+ config.jsonapi_resource_type = :plural
24
+ config.schema_path = 'test/support/schemas'
25
+ end
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,56 @@
1
+ module ActiveModel
2
+ class Serializer
3
+ # Holds all the meta-data about a field (i.e. attribute or association) as it was
4
+ # specified in the ActiveModel::Serializer class.
5
+ # Notice that the field block is evaluated in the context of the serializer.
6
+ Field = Struct.new(:name, :options, :block) do
7
+ # Compute the actual value of a field for a given serializer instance.
8
+ # @param [Serializer] The serializer instance for which the value is computed.
9
+ # @return [Object] value
10
+ #
11
+ # @api private
12
+ #
13
+ def value(serializer)
14
+ if block
15
+ serializer.instance_eval(&block)
16
+ else
17
+ serializer.read_attribute_for_serialization(name)
18
+ end
19
+ end
20
+
21
+ # Decide whether the field should be serialized by the given serializer instance.
22
+ # @param [Serializer] The serializer instance
23
+ # @return [Bool]
24
+ #
25
+ # @api private
26
+ #
27
+ def excluded?(serializer)
28
+ case condition_type
29
+ when :if
30
+ !serializer.public_send(condition)
31
+ when :unless
32
+ serializer.public_send(condition)
33
+ else
34
+ false
35
+ end
36
+ end
37
+
38
+ private
39
+
40
+ def condition_type
41
+ @condition_type ||=
42
+ if options.key?(:if)
43
+ :if
44
+ elsif options.key?(:unless)
45
+ :unless
46
+ else
47
+ :none
48
+ end
49
+ end
50
+
51
+ def condition
52
+ options[condition_type]
53
+ end
54
+ end
55
+ end
56
+ end