active_model_serializers 0.10.7 → 0.10.10

Sign up to get free protection for your applications and to get access to all the features.
Files changed (212) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +45 -1
  3. data/README.md +2 -2
  4. data/lib/action_controller/serialization.rb +11 -1
  5. data/lib/active_model/serializable_resource.rb +2 -0
  6. data/lib/active_model/serializer/adapter/attributes.rb +2 -0
  7. data/lib/active_model/serializer/adapter/base.rb +2 -0
  8. data/lib/active_model/serializer/adapter/json.rb +2 -0
  9. data/lib/active_model/serializer/adapter/json_api.rb +2 -0
  10. data/lib/active_model/serializer/adapter/null.rb +2 -0
  11. data/lib/active_model/serializer/adapter.rb +2 -0
  12. data/lib/active_model/serializer/array_serializer.rb +2 -0
  13. data/lib/active_model/serializer/association.rb +2 -0
  14. data/lib/active_model/serializer/attribute.rb +2 -0
  15. data/lib/active_model/serializer/belongs_to_reflection.rb +2 -0
  16. data/lib/active_model/serializer/collection_serializer.rb +6 -6
  17. data/lib/active_model/serializer/concerns/caching.rb +5 -1
  18. data/lib/active_model/serializer/error_serializer.rb +2 -0
  19. data/lib/active_model/serializer/errors_serializer.rb +2 -0
  20. data/lib/active_model/serializer/field.rb +2 -0
  21. data/lib/active_model/serializer/fieldset.rb +2 -0
  22. data/lib/active_model/serializer/has_many_reflection.rb +2 -0
  23. data/lib/active_model/serializer/has_one_reflection.rb +2 -0
  24. data/lib/active_model/serializer/lazy_association.rb +6 -2
  25. data/lib/active_model/serializer/link.rb +23 -0
  26. data/lib/active_model/serializer/lint.rb +2 -0
  27. data/lib/active_model/serializer/null.rb +2 -0
  28. data/lib/active_model/serializer/reflection.rb +5 -0
  29. data/lib/active_model/serializer/version.rb +3 -1
  30. data/lib/active_model/serializer.rb +32 -16
  31. data/lib/active_model_serializers/adapter/attributes.rb +23 -0
  32. data/lib/active_model_serializers/adapter/base.rb +2 -0
  33. data/lib/active_model_serializers/adapter/json.rb +2 -0
  34. data/lib/active_model_serializers/adapter/json_api/deserialization.rb +2 -0
  35. data/lib/active_model_serializers/adapter/json_api/error.rb +2 -0
  36. data/lib/active_model_serializers/adapter/json_api/jsonapi.rb +2 -0
  37. data/lib/active_model_serializers/adapter/json_api/link.rb +2 -0
  38. data/lib/active_model_serializers/adapter/json_api/meta.rb +2 -0
  39. data/lib/active_model_serializers/adapter/json_api/pagination_links.rb +2 -0
  40. data/lib/active_model_serializers/adapter/json_api/relationship.rb +2 -0
  41. data/lib/active_model_serializers/adapter/json_api/resource_identifier.rb +3 -1
  42. data/lib/active_model_serializers/adapter/json_api.rb +14 -9
  43. data/lib/active_model_serializers/adapter/null.rb +2 -0
  44. data/lib/active_model_serializers/adapter.rb +3 -1
  45. data/lib/active_model_serializers/callbacks.rb +2 -0
  46. data/lib/active_model_serializers/deprecate.rb +2 -0
  47. data/lib/active_model_serializers/deserialization.rb +2 -0
  48. data/lib/active_model_serializers/json_pointer.rb +2 -0
  49. data/lib/active_model_serializers/logging.rb +2 -0
  50. data/lib/active_model_serializers/lookup_chain.rb +2 -0
  51. data/lib/active_model_serializers/model.rb +2 -0
  52. data/lib/active_model_serializers/railtie.rb +4 -0
  53. data/lib/active_model_serializers/register_jsonapi_renderer.rb +2 -0
  54. data/lib/active_model_serializers/serializable_resource.rb +4 -2
  55. data/lib/active_model_serializers/serialization_context.rb +2 -0
  56. data/lib/active_model_serializers/test/schema.rb +2 -0
  57. data/lib/active_model_serializers/test/serializer.rb +2 -0
  58. data/lib/active_model_serializers/test.rb +2 -0
  59. data/lib/active_model_serializers.rb +20 -10
  60. data/lib/generators/rails/resource_override.rb +2 -0
  61. data/lib/generators/rails/serializer_generator.rb +2 -0
  62. data/lib/grape/active_model_serializers.rb +2 -0
  63. data/lib/grape/formatters/active_model_serializers.rb +2 -0
  64. data/lib/grape/helpers/active_model_serializers.rb +2 -0
  65. data/lib/tasks/rubocop.rake +2 -0
  66. metadata +64 -290
  67. data/.github/ISSUE_TEMPLATE.md +0 -29
  68. data/.github/PULL_REQUEST_TEMPLATE.md +0 -15
  69. data/.gitignore +0 -35
  70. data/.rubocop.yml +0 -105
  71. data/.simplecov +0 -110
  72. data/.travis.yml +0 -52
  73. data/CODE_OF_CONDUCT.md +0 -74
  74. data/CONTRIBUTING.md +0 -105
  75. data/Gemfile +0 -72
  76. data/Rakefile +0 -74
  77. data/active_model_serializers.gemspec +0 -63
  78. data/appveyor.yml +0 -28
  79. data/bin/bench +0 -171
  80. data/bin/bench_regression +0 -316
  81. data/bin/rubocop +0 -38
  82. data/bin/serve_benchmark +0 -39
  83. data/docs/README.md +0 -41
  84. data/docs/STYLE.md +0 -58
  85. data/docs/general/adapters.md +0 -269
  86. data/docs/general/caching.md +0 -58
  87. data/docs/general/configuration_options.md +0 -185
  88. data/docs/general/deserialization.md +0 -100
  89. data/docs/general/fields.md +0 -31
  90. data/docs/general/getting_started.md +0 -133
  91. data/docs/general/instrumentation.md +0 -40
  92. data/docs/general/key_transforms.md +0 -40
  93. data/docs/general/logging.md +0 -21
  94. data/docs/general/rendering.md +0 -293
  95. data/docs/general/serializers.md +0 -483
  96. data/docs/how-open-source-maintained.jpg +0 -0
  97. data/docs/howto/add_pagination_links.md +0 -138
  98. data/docs/howto/add_relationship_links.md +0 -140
  99. data/docs/howto/add_root_key.md +0 -62
  100. data/docs/howto/grape_integration.md +0 -42
  101. data/docs/howto/outside_controller_use.md +0 -66
  102. data/docs/howto/passing_arbitrary_options.md +0 -27
  103. data/docs/howto/serialize_poro.md +0 -73
  104. data/docs/howto/test.md +0 -154
  105. data/docs/howto/upgrade_from_0_8_to_0_10.md +0 -265
  106. data/docs/integrations/ember-and-json-api.md +0 -147
  107. data/docs/integrations/grape.md +0 -19
  108. data/docs/jsonapi/errors.md +0 -56
  109. data/docs/jsonapi/schema/schema.json +0 -366
  110. data/docs/jsonapi/schema.md +0 -151
  111. data/docs/rfcs/0000-namespace.md +0 -106
  112. data/docs/rfcs/template.md +0 -15
  113. data/test/action_controller/adapter_selector_test.rb +0 -62
  114. data/test/action_controller/explicit_serializer_test.rb +0 -135
  115. data/test/action_controller/json/include_test.rb +0 -246
  116. data/test/action_controller/json_api/deserialization_test.rb +0 -112
  117. data/test/action_controller/json_api/errors_test.rb +0 -40
  118. data/test/action_controller/json_api/fields_test.rb +0 -66
  119. data/test/action_controller/json_api/linked_test.rb +0 -202
  120. data/test/action_controller/json_api/pagination_test.rb +0 -124
  121. data/test/action_controller/json_api/transform_test.rb +0 -189
  122. data/test/action_controller/lookup_proc_test.rb +0 -49
  123. data/test/action_controller/namespace_lookup_test.rb +0 -232
  124. data/test/action_controller/serialization_scope_name_test.rb +0 -235
  125. data/test/action_controller/serialization_test.rb +0 -472
  126. data/test/active_model_serializers/adapter_for_test.rb +0 -208
  127. data/test/active_model_serializers/json_pointer_test.rb +0 -22
  128. data/test/active_model_serializers/logging_test.rb +0 -77
  129. data/test/active_model_serializers/model_test.rb +0 -142
  130. data/test/active_model_serializers/railtie_test_isolated.rb +0 -68
  131. data/test/active_model_serializers/register_jsonapi_renderer_test_isolated.rb +0 -161
  132. data/test/active_model_serializers/serialization_context_test_isolated.rb +0 -71
  133. data/test/active_model_serializers/test/schema_test.rb +0 -131
  134. data/test/active_model_serializers/test/serializer_test.rb +0 -62
  135. data/test/active_record_test.rb +0 -9
  136. data/test/adapter/attributes_test.rb +0 -40
  137. data/test/adapter/deprecation_test.rb +0 -100
  138. data/test/adapter/json/belongs_to_test.rb +0 -45
  139. data/test/adapter/json/collection_test.rb +0 -104
  140. data/test/adapter/json/has_many_test.rb +0 -53
  141. data/test/adapter/json/transform_test.rb +0 -93
  142. data/test/adapter/json_api/belongs_to_test.rb +0 -155
  143. data/test/adapter/json_api/collection_test.rb +0 -96
  144. data/test/adapter/json_api/errors_test.rb +0 -76
  145. data/test/adapter/json_api/fields_test.rb +0 -96
  146. data/test/adapter/json_api/has_many_explicit_serializer_test.rb +0 -96
  147. data/test/adapter/json_api/has_many_test.rb +0 -173
  148. data/test/adapter/json_api/has_one_test.rb +0 -80
  149. data/test/adapter/json_api/include_data_if_sideloaded_test.rb +0 -213
  150. data/test/adapter/json_api/json_api_test.rb +0 -33
  151. data/test/adapter/json_api/linked_test.rb +0 -413
  152. data/test/adapter/json_api/links_test.rb +0 -95
  153. data/test/adapter/json_api/pagination_links_test.rb +0 -206
  154. data/test/adapter/json_api/parse_test.rb +0 -137
  155. data/test/adapter/json_api/relationship_test.rb +0 -397
  156. data/test/adapter/json_api/resource_meta_test.rb +0 -100
  157. data/test/adapter/json_api/toplevel_jsonapi_test.rb +0 -82
  158. data/test/adapter/json_api/transform_test.rb +0 -512
  159. data/test/adapter/json_api/type_test.rb +0 -193
  160. data/test/adapter/json_test.rb +0 -46
  161. data/test/adapter/null_test.rb +0 -22
  162. data/test/adapter/polymorphic_test.rb +0 -218
  163. data/test/adapter_test.rb +0 -67
  164. data/test/array_serializer_test.rb +0 -22
  165. data/test/benchmark/app.rb +0 -65
  166. data/test/benchmark/benchmarking_support.rb +0 -67
  167. data/test/benchmark/bm_active_record.rb +0 -81
  168. data/test/benchmark/bm_adapter.rb +0 -38
  169. data/test/benchmark/bm_caching.rb +0 -119
  170. data/test/benchmark/bm_lookup_chain.rb +0 -83
  171. data/test/benchmark/bm_transform.rb +0 -45
  172. data/test/benchmark/config.ru +0 -3
  173. data/test/benchmark/controllers.rb +0 -83
  174. data/test/benchmark/fixtures.rb +0 -219
  175. data/test/cache_test.rb +0 -651
  176. data/test/collection_serializer_test.rb +0 -127
  177. data/test/fixtures/active_record.rb +0 -113
  178. data/test/fixtures/poro.rb +0 -225
  179. data/test/generators/scaffold_controller_generator_test.rb +0 -24
  180. data/test/generators/serializer_generator_test.rb +0 -75
  181. data/test/grape_test.rb +0 -196
  182. data/test/lint_test.rb +0 -49
  183. data/test/logger_test.rb +0 -20
  184. data/test/poro_test.rb +0 -9
  185. data/test/serializable_resource_test.rb +0 -79
  186. data/test/serializers/association_macros_test.rb +0 -37
  187. data/test/serializers/associations_test.rb +0 -468
  188. data/test/serializers/attribute_test.rb +0 -153
  189. data/test/serializers/attributes_test.rb +0 -52
  190. data/test/serializers/caching_configuration_test_isolated.rb +0 -170
  191. data/test/serializers/configuration_test.rb +0 -32
  192. data/test/serializers/fieldset_test.rb +0 -14
  193. data/test/serializers/meta_test.rb +0 -202
  194. data/test/serializers/options_test.rb +0 -32
  195. data/test/serializers/read_attribute_for_serialization_test.rb +0 -79
  196. data/test/serializers/reflection_test.rb +0 -427
  197. data/test/serializers/root_test.rb +0 -21
  198. data/test/serializers/serialization_test.rb +0 -55
  199. data/test/serializers/serializer_for_test.rb +0 -136
  200. data/test/serializers/serializer_for_with_namespace_test.rb +0 -88
  201. data/test/support/custom_schemas/active_model_serializers/test/schema_test/my/index.json +0 -6
  202. data/test/support/isolated_unit.rb +0 -84
  203. data/test/support/rails5_shims.rb +0 -53
  204. data/test/support/rails_app.rb +0 -38
  205. data/test/support/schemas/active_model_serializers/test/schema_test/my/index.json +0 -6
  206. data/test/support/schemas/active_model_serializers/test/schema_test/my/show.json +0 -6
  207. data/test/support/schemas/custom/show.json +0 -7
  208. data/test/support/schemas/hyper_schema.json +0 -93
  209. data/test/support/schemas/render_using_json_api.json +0 -43
  210. data/test/support/schemas/simple_json_pointers.json +0 -10
  211. data/test/support/serialization_testing.rb +0 -79
  212. data/test/test_helper.rb +0 -70
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # Adapted from
2
4
  # https://github.com/rails/rails/blob/7f18ea14c8/activejob/lib/active_job/callbacks.rb
3
5
  require 'active_support/callbacks'
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  ##
2
4
  # Provides a single method +deprecate+ to be used to declare when
3
5
  # something is going away.
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  module ActiveModelSerializers
2
4
  module Deserialization
3
5
  module_function
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  module ActiveModelSerializers
2
4
  module JsonPointer
3
5
  module_function
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  ##
2
4
  # ActiveModelSerializers::Logging
3
5
  #
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  module ActiveModelSerializers
2
4
  module LookupChain
3
5
  # Standard appending of Serializer to the resource name.
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # ActiveModelSerializers::Model is a convenient superclass for making your models
2
4
  # from Plain-Old Ruby Objects (PORO). It also serves as a reference implementation
3
5
  # that satisfies ActiveModel::Serializer::Lint::Tests.
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  require 'rails/railtie'
2
4
  require 'action_controller'
3
5
  require 'action_controller/railtie'
@@ -5,6 +7,8 @@ require 'action_controller/serialization'
5
7
 
6
8
  module ActiveModelSerializers
7
9
  class Railtie < Rails::Railtie
10
+ config.eager_load_namespaces << ActiveModelSerializers
11
+
8
12
  config.to_prepare do
9
13
  ActiveModel::Serializer.serializers_cache.clear
10
14
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # Based on discussion in https://github.com/rails/rails/pull/23712#issuecomment-184977238,
2
4
  # the JSON API media type will have its own format/renderer.
3
5
  #
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  require 'set'
2
4
 
3
5
  module ActiveModelSerializers
@@ -14,8 +16,8 @@ module ActiveModelSerializers
14
16
  # @return the serializable_resource, ready for #as_json/#to_json/#serializable_hash.
15
17
  def initialize(resource, options = {})
16
18
  @resource = resource
17
- @adapter_opts, @serializer_opts =
18
- options.partition { |k, _| ADAPTER_OPTION_KEYS.include? k }.map { |h| Hash[h] }
19
+ @adapter_opts = options.select { |k, _| ADAPTER_OPTION_KEYS.include? k }
20
+ @serializer_opts = options.reject { |k, _| ADAPTER_OPTION_KEYS.include? k }
19
21
  end
20
22
 
21
23
  def serialization_scope=(scope)
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  require 'active_support/core_ext/array/extract_options'
2
4
  module ActiveModelSerializers
3
5
  class SerializationContext
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  module ActiveModelSerializers
2
4
  module Test
3
5
  module Schema
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  require 'set'
2
4
  module ActiveModelSerializers
3
5
  module Test
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  module ActiveModelSerializers
2
4
  module Test
3
5
  extend ActiveSupport::Autoload
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  require 'active_model'
2
4
  require 'active_support'
3
5
  require 'active_support/core_ext/object/with_options'
@@ -5,16 +7,19 @@ require 'active_support/core_ext/string/inflections'
5
7
  require 'active_support/json'
6
8
  module ActiveModelSerializers
7
9
  extend ActiveSupport::Autoload
8
- autoload :Model
9
- autoload :Callbacks
10
- autoload :Deserialization
11
- autoload :SerializableResource
12
- autoload :Logging
13
- autoload :Test
14
- autoload :Adapter
15
- autoload :JsonPointer
16
- autoload :Deprecate
17
- autoload :LookupChain
10
+ eager_autoload do
11
+ autoload :Model
12
+ autoload :Callbacks
13
+ autoload :SerializableResource
14
+ autoload :SerializationContext
15
+ autoload :Logging
16
+ autoload :Test
17
+ autoload :Adapter
18
+ autoload :JsonPointer
19
+ autoload :Deprecate
20
+ autoload :LookupChain
21
+ autoload :Deserialization
22
+ end
18
23
 
19
24
  class << self; attr_accessor :logger; end
20
25
  self.logger = ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT))
@@ -46,6 +51,11 @@ module ActiveModelSerializers
46
51
  $VERBOSE = original_verbose
47
52
  end
48
53
 
54
+ def self.eager_load!
55
+ super
56
+ ActiveModel::Serializer.eager_load!
57
+ end
58
+
49
59
  require 'active_model/serializer/version'
50
60
  require 'active_model/serializer'
51
61
  require 'active_model/serializable_resource'
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  require 'rails/generators'
2
4
  require 'rails/generators/rails/resource/resource_generator'
3
5
 
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  module Rails
2
4
  module Generators
3
5
  class SerializerGenerator < NamedBase
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # To add Grape support, require 'grape/active_model_serializers' in the base of your Grape endpoints
2
4
  # Then add 'include Grape::ActiveModelSerializers' to enable the formatter and helpers
3
5
  require 'active_model_serializers'
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # A Grape response formatter that can be used as 'formatter :json, Grape::Formatters::ActiveModelSerializers'
2
4
  #
3
5
  # Serializer options can be passed as a hash from your Grape endpoint using env[:active_model_serializer_options],
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # Helpers can be included in your Grape endpoint as: helpers Grape::Helpers::ActiveModelSerializers
2
4
 
3
5
  module Grape
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  begin
2
4
  require 'rubocop'
3
5
  require 'rubocop/rake_task'