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
data/test/test_fakes.rb DELETED
@@ -1,217 +0,0 @@
1
- class BasicActiveModel
2
- include ActiveModel::Serializers::JSON
3
- def initialize(hash = {})
4
- @attributes = hash
5
- end
6
-
7
- def serializable_hash(*)
8
- @attributes
9
- end
10
-
11
- def method_missing(method)
12
- if @attributes.key? method
13
- @attributes[method]
14
- else
15
- raise NoMethodError
16
- end
17
- end
18
- end
19
-
20
- class BasicSerializer < ActiveModel::Serializer
21
- attributes :name
22
- end
23
-
24
- class Model
25
- def initialize(hash={})
26
- @attributes = hash
27
- end
28
-
29
- def read_attribute_for_serialization(name)
30
- @attributes[name]
31
- end
32
-
33
- def as_json(*)
34
- { :model => "Model" }
35
- end
36
- end
37
-
38
- class User
39
- include ActiveModel::SerializerSupport
40
-
41
- attr_accessor :superuser
42
-
43
- def initialize(hash={})
44
- @attributes = hash.merge(:first_name => "Jose", :last_name => "Valim", :password => "oh noes yugive my password")
45
- end
46
-
47
- def read_attribute_for_serialization(name)
48
- @attributes[name]
49
- end
50
-
51
- def super_user?
52
- @superuser
53
- end
54
- end
55
-
56
- class Post < Model
57
- def initialize(attributes)
58
- super(attributes)
59
- self.comments ||= []
60
- self.comments_disabled = false
61
- self.author = nil
62
- end
63
-
64
- attr_accessor :comments, :comments_disabled, :author
65
- def active_model_serializer; PostSerializer; end
66
- end
67
-
68
- class Comment < Model
69
- def active_model_serializer; CommentSerializer; end
70
- end
71
-
72
- class UserSerializer < ActiveModel::Serializer
73
- attributes :first_name, :last_name
74
-
75
- def serializable_hash
76
- attributes.merge(:ok => true).merge(options[:scope])
77
- end
78
- end
79
-
80
- class UserAttributesWithKeySerializer < ActiveModel::Serializer
81
- attributes :first_name => :f_name, :last_name => :l_name
82
-
83
- def serializable_hash
84
- attributes.merge(:ok => true).merge(options[:scope])
85
- end
86
- end
87
-
88
- class UserAttributesWithSomeKeySerializer < ActiveModel::Serializer
89
- attributes :first_name, :last_name => :l_name
90
-
91
- def serializable_hash
92
- attributes.merge(:ok => true).merge(options[:scope])
93
- end
94
- end
95
-
96
- class UserAttributesWithUnsymbolizableKeySerializer < ActiveModel::Serializer
97
- attributes :first_name, :last_name => :"last-name"
98
-
99
- def serializable_hash
100
- attributes.merge(:ok => true).merge(options[:scope])
101
- end
102
- end
103
-
104
- class DefaultUserSerializer < ActiveModel::Serializer
105
- attributes :first_name, :last_name
106
- end
107
-
108
- class MyUserSerializer < ActiveModel::Serializer
109
- attributes :first_name, :last_name
110
-
111
- def serializable_hash
112
- hash = attributes
113
- hash = hash.merge(:super_user => true) if object.super_user?
114
- hash
115
- end
116
- end
117
-
118
- class CommentSerializer
119
- def initialize(comment, options={})
120
- @object = comment
121
- end
122
-
123
- attr_reader :object
124
-
125
- def serializable_hash
126
- { :title => @object.read_attribute_for_serialization(:title) }
127
- end
128
-
129
- def as_json(options=nil)
130
- options ||= {}
131
- if options[:root] == false
132
- serializable_hash
133
- else
134
- { :comment => serializable_hash }
135
- end
136
- end
137
- end
138
-
139
- class PostSerializer < ActiveModel::Serializer
140
- attributes :title, :body
141
- has_many :comments, :serializer => CommentSerializer
142
- end
143
-
144
- class PostWithConditionalCommentsSerializer < ActiveModel::Serializer
145
- root :post
146
- attributes :title, :body
147
- has_many :comments, :serializer => CommentSerializer
148
-
149
- def include_associations!
150
- include! :comments unless object.comments_disabled
151
- end
152
- end
153
-
154
- class PostWithMultipleConditionalsSerializer < ActiveModel::Serializer
155
- root :post
156
- attributes :title, :body, :author
157
- has_many :comments, :serializer => CommentSerializer
158
-
159
- def include_comments?
160
- !object.comments_disabled
161
- end
162
-
163
- def include_author?
164
- scope.super_user?
165
- end
166
- end
167
-
168
- class Blog < Model
169
- attr_accessor :author
170
- end
171
-
172
- class AuthorSerializer < ActiveModel::Serializer
173
- attributes :first_name, :last_name
174
- end
175
-
176
- class BlogSerializer < ActiveModel::Serializer
177
- has_one :author, :serializer => AuthorSerializer
178
- end
179
-
180
- class BlogWithRootSerializer < BlogSerializer
181
- root true
182
- end
183
-
184
- class CustomPostSerializer < ActiveModel::Serializer
185
- attributes :title
186
- end
187
-
188
- class CustomBlog < Blog
189
- attr_accessor :public_posts, :public_user
190
- end
191
-
192
- class CustomBlogSerializer < ActiveModel::Serializer
193
- has_many :public_posts, :key => :posts, :serializer => PostSerializer
194
- has_one :public_user, :key => :user, :serializer => UserSerializer
195
- end
196
-
197
- class SomeSerializer < ActiveModel::Serializer
198
- attributes :some
199
- end
200
-
201
- class SomeObject < Struct.new(:some)
202
- end
203
-
204
- # Set up some classes for polymorphic testing
205
- class Attachment < Model
206
- def attachable
207
- @attributes[:attachable]
208
- end
209
-
210
- def readable
211
- @attributes[:readable]
212
- end
213
-
214
- def edible
215
- @attributes[:edible]
216
- end
217
- end