agi_active_model_serializers 0.10.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.github/ISSUE_TEMPLATE.md +29 -0
- data/.github/PULL_REQUEST_TEMPLATE.md +15 -0
- data/.gitignore +35 -0
- data/.rubocop.yml +102 -0
- data/.simplecov +110 -0
- data/.travis.yml +51 -0
- data/CHANGELOG.md +612 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/CONTRIBUTING.md +105 -0
- data/Gemfile +56 -0
- data/MIT-LICENSE +22 -0
- data/README.md +307 -0
- data/Rakefile +103 -0
- data/active_model_serializers.gemspec +63 -0
- data/appveyor.yml +24 -0
- data/bin/bench +171 -0
- data/bin/bench_regression +316 -0
- data/bin/serve_benchmark +39 -0
- data/docs/README.md +41 -0
- data/docs/STYLE.md +58 -0
- data/docs/general/adapters.md +247 -0
- data/docs/general/caching.md +58 -0
- data/docs/general/configuration_options.md +169 -0
- data/docs/general/deserialization.md +100 -0
- data/docs/general/fields.md +31 -0
- data/docs/general/getting_started.md +133 -0
- data/docs/general/instrumentation.md +40 -0
- data/docs/general/key_transforms.md +40 -0
- data/docs/general/logging.md +14 -0
- data/docs/general/rendering.md +279 -0
- data/docs/general/serializers.md +461 -0
- data/docs/how-open-source-maintained.jpg +0 -0
- data/docs/howto/add_pagination_links.md +138 -0
- data/docs/howto/add_relationship_links.md +137 -0
- data/docs/howto/add_root_key.md +55 -0
- data/docs/howto/grape_integration.md +42 -0
- data/docs/howto/outside_controller_use.md +65 -0
- data/docs/howto/passing_arbitrary_options.md +27 -0
- data/docs/howto/serialize_poro.md +32 -0
- data/docs/howto/test.md +154 -0
- data/docs/howto/upgrade_from_0_8_to_0_10.md +265 -0
- data/docs/integrations/ember-and-json-api.md +144 -0
- data/docs/integrations/grape.md +19 -0
- data/docs/jsonapi/errors.md +56 -0
- data/docs/jsonapi/schema.md +151 -0
- data/docs/jsonapi/schema/schema.json +366 -0
- data/docs/rfcs/0000-namespace.md +106 -0
- data/docs/rfcs/template.md +15 -0
- data/lib/action_controller/serialization.rb +66 -0
- data/lib/active_model/serializable_resource.rb +11 -0
- data/lib/active_model/serializer.rb +231 -0
- data/lib/active_model/serializer/adapter.rb +24 -0
- data/lib/active_model/serializer/adapter/attributes.rb +15 -0
- data/lib/active_model/serializer/adapter/base.rb +18 -0
- data/lib/active_model/serializer/adapter/json.rb +15 -0
- data/lib/active_model/serializer/adapter/json_api.rb +15 -0
- data/lib/active_model/serializer/adapter/null.rb +15 -0
- data/lib/active_model/serializer/array_serializer.rb +12 -0
- data/lib/active_model/serializer/association.rb +34 -0
- data/lib/active_model/serializer/attribute.rb +25 -0
- data/lib/active_model/serializer/belongs_to_reflection.rb +7 -0
- data/lib/active_model/serializer/collection_reflection.rb +7 -0
- data/lib/active_model/serializer/collection_serializer.rb +87 -0
- data/lib/active_model/serializer/concerns/associations.rb +102 -0
- data/lib/active_model/serializer/concerns/attributes.rb +82 -0
- data/lib/active_model/serializer/concerns/caching.rb +292 -0
- data/lib/active_model/serializer/concerns/configuration.rb +59 -0
- data/lib/active_model/serializer/concerns/links.rb +35 -0
- data/lib/active_model/serializer/concerns/meta.rb +29 -0
- data/lib/active_model/serializer/concerns/type.rb +25 -0
- data/lib/active_model/serializer/error_serializer.rb +14 -0
- data/lib/active_model/serializer/errors_serializer.rb +32 -0
- data/lib/active_model/serializer/field.rb +90 -0
- data/lib/active_model/serializer/fieldset.rb +31 -0
- data/lib/active_model/serializer/has_many_reflection.rb +7 -0
- data/lib/active_model/serializer/has_one_reflection.rb +7 -0
- data/lib/active_model/serializer/lint.rb +150 -0
- data/lib/active_model/serializer/null.rb +17 -0
- data/lib/active_model/serializer/reflection.rb +163 -0
- data/lib/active_model/serializer/singular_reflection.rb +7 -0
- data/lib/active_model/serializer/version.rb +5 -0
- data/lib/active_model_serializers.rb +53 -0
- data/lib/active_model_serializers/adapter.rb +98 -0
- data/lib/active_model_serializers/adapter/attributes.rb +13 -0
- data/lib/active_model_serializers/adapter/base.rb +83 -0
- data/lib/active_model_serializers/adapter/json.rb +21 -0
- data/lib/active_model_serializers/adapter/json_api.rb +517 -0
- data/lib/active_model_serializers/adapter/json_api/deserialization.rb +213 -0
- data/lib/active_model_serializers/adapter/json_api/error.rb +96 -0
- data/lib/active_model_serializers/adapter/json_api/jsonapi.rb +49 -0
- data/lib/active_model_serializers/adapter/json_api/link.rb +83 -0
- data/lib/active_model_serializers/adapter/json_api/meta.rb +37 -0
- data/lib/active_model_serializers/adapter/json_api/pagination_links.rb +69 -0
- data/lib/active_model_serializers/adapter/json_api/relationship.rb +63 -0
- data/lib/active_model_serializers/adapter/json_api/resource_identifier.rb +51 -0
- data/lib/active_model_serializers/adapter/null.rb +9 -0
- data/lib/active_model_serializers/callbacks.rb +55 -0
- data/lib/active_model_serializers/deprecate.rb +54 -0
- data/lib/active_model_serializers/deserialization.rb +15 -0
- data/lib/active_model_serializers/json_pointer.rb +14 -0
- data/lib/active_model_serializers/logging.rb +122 -0
- data/lib/active_model_serializers/lookup_chain.rb +80 -0
- data/lib/active_model_serializers/model.rb +71 -0
- data/lib/active_model_serializers/railtie.rb +48 -0
- data/lib/active_model_serializers/register_jsonapi_renderer.rb +78 -0
- data/lib/active_model_serializers/serializable_resource.rb +82 -0
- data/lib/active_model_serializers/serialization_context.rb +39 -0
- data/lib/active_model_serializers/test.rb +7 -0
- data/lib/active_model_serializers/test/schema.rb +138 -0
- data/lib/active_model_serializers/test/serializer.rb +125 -0
- data/lib/generators/rails/USAGE +6 -0
- data/lib/generators/rails/resource_override.rb +10 -0
- data/lib/generators/rails/serializer_generator.rb +36 -0
- data/lib/generators/rails/templates/serializer.rb.erb +15 -0
- data/lib/grape/active_model_serializers.rb +16 -0
- data/lib/grape/formatters/active_model_serializers.rb +32 -0
- data/lib/grape/helpers/active_model_serializers.rb +17 -0
- data/test/action_controller/adapter_selector_test.rb +53 -0
- data/test/action_controller/explicit_serializer_test.rb +135 -0
- data/test/action_controller/json/include_test.rb +246 -0
- data/test/action_controller/json_api/deserialization_test.rb +112 -0
- data/test/action_controller/json_api/errors_test.rb +40 -0
- data/test/action_controller/json_api/fields_test.rb +66 -0
- data/test/action_controller/json_api/linked_test.rb +202 -0
- data/test/action_controller/json_api/pagination_test.rb +116 -0
- data/test/action_controller/json_api/transform_test.rb +189 -0
- data/test/action_controller/lookup_proc_test.rb +49 -0
- data/test/action_controller/namespace_lookup_test.rb +232 -0
- data/test/action_controller/serialization_scope_name_test.rb +229 -0
- data/test/action_controller/serialization_test.rb +472 -0
- data/test/active_model_serializers/adapter_for_test.rb +208 -0
- data/test/active_model_serializers/json_pointer_test.rb +22 -0
- data/test/active_model_serializers/logging_test.rb +77 -0
- data/test/active_model_serializers/model_test.rb +69 -0
- data/test/active_model_serializers/railtie_test_isolated.rb +63 -0
- data/test/active_model_serializers/register_jsonapi_renderer_test_isolated.rb +161 -0
- data/test/active_model_serializers/serialization_context_test_isolated.rb +71 -0
- data/test/active_model_serializers/test/schema_test.rb +131 -0
- data/test/active_model_serializers/test/serializer_test.rb +62 -0
- data/test/active_record_test.rb +9 -0
- data/test/adapter/attributes_test.rb +43 -0
- data/test/adapter/deprecation_test.rb +100 -0
- data/test/adapter/json/belongs_to_test.rb +45 -0
- data/test/adapter/json/collection_test.rb +104 -0
- data/test/adapter/json/has_many_test.rb +45 -0
- data/test/adapter/json/transform_test.rb +93 -0
- data/test/adapter/json_api/belongs_to_test.rb +155 -0
- data/test/adapter/json_api/collection_test.rb +96 -0
- data/test/adapter/json_api/errors_test.rb +76 -0
- data/test/adapter/json_api/fields_test.rb +96 -0
- data/test/adapter/json_api/has_many_embed_ids_test.rb +43 -0
- data/test/adapter/json_api/has_many_explicit_serializer_test.rb +96 -0
- data/test/adapter/json_api/has_many_test.rb +165 -0
- data/test/adapter/json_api/has_one_test.rb +80 -0
- data/test/adapter/json_api/include_data_if_sideloaded_test.rb +168 -0
- data/test/adapter/json_api/json_api_test.rb +33 -0
- data/test/adapter/json_api/linked_test.rb +413 -0
- data/test/adapter/json_api/links_test.rb +95 -0
- data/test/adapter/json_api/pagination_links_test.rb +193 -0
- data/test/adapter/json_api/parse_test.rb +137 -0
- data/test/adapter/json_api/relationship_test.rb +397 -0
- data/test/adapter/json_api/resource_identifier_test.rb +110 -0
- data/test/adapter/json_api/resource_meta_test.rb +100 -0
- data/test/adapter/json_api/toplevel_jsonapi_test.rb +82 -0
- data/test/adapter/json_api/transform_test.rb +512 -0
- data/test/adapter/json_api/type_test.rb +61 -0
- data/test/adapter/json_test.rb +46 -0
- data/test/adapter/null_test.rb +22 -0
- data/test/adapter/polymorphic_test.rb +171 -0
- data/test/adapter_test.rb +67 -0
- data/test/array_serializer_test.rb +22 -0
- data/test/benchmark/app.rb +65 -0
- data/test/benchmark/benchmarking_support.rb +67 -0
- data/test/benchmark/bm_active_record.rb +81 -0
- data/test/benchmark/bm_adapter.rb +38 -0
- data/test/benchmark/bm_caching.rb +119 -0
- data/test/benchmark/bm_lookup_chain.rb +83 -0
- data/test/benchmark/bm_transform.rb +45 -0
- data/test/benchmark/config.ru +3 -0
- data/test/benchmark/controllers.rb +83 -0
- data/test/benchmark/fixtures.rb +219 -0
- data/test/cache_test.rb +595 -0
- data/test/collection_serializer_test.rb +123 -0
- data/test/fixtures/active_record.rb +113 -0
- data/test/fixtures/poro.rb +232 -0
- data/test/generators/scaffold_controller_generator_test.rb +24 -0
- data/test/generators/serializer_generator_test.rb +74 -0
- data/test/grape_test.rb +178 -0
- data/test/lint_test.rb +49 -0
- data/test/logger_test.rb +20 -0
- data/test/poro_test.rb +9 -0
- data/test/serializable_resource_test.rb +79 -0
- data/test/serializers/association_macros_test.rb +37 -0
- data/test/serializers/associations_test.rb +383 -0
- data/test/serializers/attribute_test.rb +153 -0
- data/test/serializers/attributes_test.rb +52 -0
- data/test/serializers/caching_configuration_test_isolated.rb +170 -0
- data/test/serializers/configuration_test.rb +32 -0
- data/test/serializers/fieldset_test.rb +14 -0
- data/test/serializers/meta_test.rb +202 -0
- data/test/serializers/options_test.rb +32 -0
- data/test/serializers/read_attribute_for_serialization_test.rb +79 -0
- data/test/serializers/root_test.rb +21 -0
- data/test/serializers/serialization_test.rb +55 -0
- data/test/serializers/serializer_for_test.rb +136 -0
- data/test/serializers/serializer_for_with_namespace_test.rb +88 -0
- data/test/support/custom_schemas/active_model_serializers/test/schema_test/my/index.json +6 -0
- data/test/support/isolated_unit.rb +82 -0
- data/test/support/rails5_shims.rb +53 -0
- data/test/support/rails_app.rb +36 -0
- data/test/support/schemas/active_model_serializers/test/schema_test/my/index.json +6 -0
- data/test/support/schemas/active_model_serializers/test/schema_test/my/show.json +6 -0
- data/test/support/schemas/custom/show.json +7 -0
- data/test/support/schemas/hyper_schema.json +93 -0
- data/test/support/schemas/render_using_json_api.json +43 -0
- data/test/support/schemas/simple_json_pointers.json +10 -0
- data/test/support/serialization_testing.rb +71 -0
- data/test/test_helper.rb +58 -0
- metadata +602 -0
@@ -0,0 +1,32 @@
|
|
1
|
+
require 'active_model/serializer/error_serializer'
|
2
|
+
|
3
|
+
module ActiveModel
|
4
|
+
class Serializer
|
5
|
+
class ErrorsSerializer
|
6
|
+
include Enumerable
|
7
|
+
delegate :each, to: :@serializers
|
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_class = options.fetch(:serializer) { ActiveModel::Serializer::ErrorSerializer }
|
15
|
+
serializer_class.new(resource, options.except(:serializer))
|
16
|
+
end
|
17
|
+
end
|
18
|
+
|
19
|
+
def success?
|
20
|
+
false
|
21
|
+
end
|
22
|
+
|
23
|
+
def json_key
|
24
|
+
nil
|
25
|
+
end
|
26
|
+
|
27
|
+
protected
|
28
|
+
|
29
|
+
attr_reader :serializers
|
30
|
+
end
|
31
|
+
end
|
32
|
+
end
|
@@ -0,0 +1,90 @@
|
|
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
|
+
def initialize(*)
|
8
|
+
super
|
9
|
+
|
10
|
+
validate_condition!
|
11
|
+
end
|
12
|
+
|
13
|
+
# Compute the actual value of a field for a given serializer instance.
|
14
|
+
# @param [Serializer] The serializer instance for which the value is computed.
|
15
|
+
# @return [Object] value
|
16
|
+
#
|
17
|
+
# @api private
|
18
|
+
#
|
19
|
+
def value(serializer)
|
20
|
+
if block
|
21
|
+
serializer.instance_eval(&block)
|
22
|
+
else
|
23
|
+
serializer.read_attribute_for_serialization(name)
|
24
|
+
end
|
25
|
+
end
|
26
|
+
|
27
|
+
# Decide whether the field should be serialized by the given serializer instance.
|
28
|
+
# @param [Serializer] The serializer instance
|
29
|
+
# @return [Bool]
|
30
|
+
#
|
31
|
+
# @api private
|
32
|
+
#
|
33
|
+
def excluded?(serializer)
|
34
|
+
case condition_type
|
35
|
+
when :if
|
36
|
+
!evaluate_condition(serializer)
|
37
|
+
when :unless
|
38
|
+
evaluate_condition(serializer)
|
39
|
+
else
|
40
|
+
false
|
41
|
+
end
|
42
|
+
end
|
43
|
+
|
44
|
+
private
|
45
|
+
|
46
|
+
def validate_condition!
|
47
|
+
return if condition_type == :none
|
48
|
+
|
49
|
+
case condition
|
50
|
+
when Symbol, String, Proc
|
51
|
+
# noop
|
52
|
+
else
|
53
|
+
fail TypeError, "#{condition_type.inspect} should be a Symbol, String or Proc"
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
def evaluate_condition(serializer)
|
58
|
+
case condition
|
59
|
+
when Symbol
|
60
|
+
serializer.public_send(condition)
|
61
|
+
when String
|
62
|
+
serializer.instance_eval(condition)
|
63
|
+
when Proc
|
64
|
+
if condition.arity.zero?
|
65
|
+
serializer.instance_exec(&condition)
|
66
|
+
else
|
67
|
+
serializer.instance_exec(serializer, &condition)
|
68
|
+
end
|
69
|
+
else
|
70
|
+
nil
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
def condition_type
|
75
|
+
@condition_type ||=
|
76
|
+
if options.key?(:if)
|
77
|
+
:if
|
78
|
+
elsif options.key?(:unless)
|
79
|
+
:unless
|
80
|
+
else
|
81
|
+
:none
|
82
|
+
end
|
83
|
+
end
|
84
|
+
|
85
|
+
def condition
|
86
|
+
options[condition_type]
|
87
|
+
end
|
88
|
+
end
|
89
|
+
end
|
90
|
+
end
|
@@ -0,0 +1,31 @@
|
|
1
|
+
module ActiveModel
|
2
|
+
class Serializer
|
3
|
+
class Fieldset
|
4
|
+
def initialize(fields)
|
5
|
+
@raw_fields = fields || {}
|
6
|
+
end
|
7
|
+
|
8
|
+
def fields
|
9
|
+
@fields ||= parsed_fields
|
10
|
+
end
|
11
|
+
|
12
|
+
def fields_for(type)
|
13
|
+
fields[type.singularize.to_sym] || fields[type.pluralize.to_sym]
|
14
|
+
end
|
15
|
+
|
16
|
+
protected
|
17
|
+
|
18
|
+
attr_reader :raw_fields
|
19
|
+
|
20
|
+
private
|
21
|
+
|
22
|
+
def parsed_fields
|
23
|
+
if raw_fields.is_a?(Hash)
|
24
|
+
raw_fields.each_with_object({}) { |(k, v), h| h[k.to_sym] = v.map(&:to_sym) }
|
25
|
+
else
|
26
|
+
{}
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
31
|
+
end
|
@@ -0,0 +1,150 @@
|
|
1
|
+
module ActiveModel
|
2
|
+
class Serializer
|
3
|
+
module Lint
|
4
|
+
# == Active \Model \Serializer \Lint \Tests
|
5
|
+
#
|
6
|
+
# You can test whether an object is compliant with the Active \Model \Serializers
|
7
|
+
# API by including <tt>ActiveModel::Serializer::Lint::Tests</tt> in your TestCase.
|
8
|
+
# It will include tests that tell you whether your object is fully compliant,
|
9
|
+
# or if not, which aspects of the API are not implemented.
|
10
|
+
#
|
11
|
+
# Note an object is not required to implement all APIs in order to work
|
12
|
+
# with Active \Model \Serializers. This module only intends to provide guidance in case
|
13
|
+
# you want all features out of the box.
|
14
|
+
#
|
15
|
+
# These tests do not attempt to determine the semantic correctness of the
|
16
|
+
# returned values. For instance, you could implement <tt>serializable_hash</tt> to
|
17
|
+
# always return +{}+, and the tests would pass. It is up to you to ensure
|
18
|
+
# that the values are semantically meaningful.
|
19
|
+
module Tests
|
20
|
+
# Passes if the object responds to <tt>serializable_hash</tt> and if it takes
|
21
|
+
# zero or one arguments.
|
22
|
+
# Fails otherwise.
|
23
|
+
#
|
24
|
+
# <tt>serializable_hash</tt> returns a hash representation of a object's attributes.
|
25
|
+
# Typically, it is implemented by including ActiveModel::Serialization.
|
26
|
+
def test_serializable_hash
|
27
|
+
assert_respond_to resource, :serializable_hash, 'The resource should respond to serializable_hash'
|
28
|
+
resource.serializable_hash
|
29
|
+
resource.serializable_hash(nil)
|
30
|
+
end
|
31
|
+
|
32
|
+
# Passes if the object responds to <tt>read_attribute_for_serialization</tt>
|
33
|
+
# and if it requires one argument (the attribute to be read).
|
34
|
+
# Fails otherwise.
|
35
|
+
#
|
36
|
+
# <tt>read_attribute_for_serialization</tt> gets the attribute value for serialization
|
37
|
+
# Typically, it is implemented by including ActiveModel::Serialization.
|
38
|
+
def test_read_attribute_for_serialization
|
39
|
+
assert_respond_to resource, :read_attribute_for_serialization, 'The resource should respond to read_attribute_for_serialization'
|
40
|
+
actual_arity = resource.method(:read_attribute_for_serialization).arity
|
41
|
+
# using absolute value since arity is:
|
42
|
+
# 1 for def read_attribute_for_serialization(name); end
|
43
|
+
# -1 for alias :read_attribute_for_serialization :send
|
44
|
+
assert_equal 1, actual_arity.abs, "expected #{actual_arity.inspect}.abs to be 1 or -1"
|
45
|
+
end
|
46
|
+
|
47
|
+
# Passes if the object responds to <tt>as_json</tt> and if it takes
|
48
|
+
# zero or one arguments.
|
49
|
+
# Fails otherwise.
|
50
|
+
#
|
51
|
+
# <tt>as_json</tt> returns a hash representation of a serialized object.
|
52
|
+
# It may delegate to <tt>serializable_hash</tt>
|
53
|
+
# Typically, it is implemented either by including ActiveModel::Serialization
|
54
|
+
# which includes ActiveModel::Serializers::JSON.
|
55
|
+
# or by the JSON gem when required.
|
56
|
+
def test_as_json
|
57
|
+
assert_respond_to resource, :as_json
|
58
|
+
resource.as_json
|
59
|
+
resource.as_json(nil)
|
60
|
+
end
|
61
|
+
|
62
|
+
# Passes if the object responds to <tt>to_json</tt> and if it takes
|
63
|
+
# zero or one arguments.
|
64
|
+
# Fails otherwise.
|
65
|
+
#
|
66
|
+
# <tt>to_json</tt> returns a string representation (JSON) of a serialized object.
|
67
|
+
# It may be called on the result of <tt>as_json</tt>.
|
68
|
+
# Typically, it is implemented on all objects when the JSON gem is required.
|
69
|
+
def test_to_json
|
70
|
+
assert_respond_to resource, :to_json
|
71
|
+
resource.to_json
|
72
|
+
resource.to_json(nil)
|
73
|
+
end
|
74
|
+
|
75
|
+
# Passes if the object responds to <tt>cache_key</tt>
|
76
|
+
# Fails otherwise.
|
77
|
+
#
|
78
|
+
# <tt>cache_key</tt> returns a (self-expiring) unique key for the object,
|
79
|
+
# and is part of the (self-expiring) cache_key, which is used by the
|
80
|
+
# adapter. It is not required unless caching is enabled.
|
81
|
+
def test_cache_key
|
82
|
+
assert_respond_to resource, :cache_key
|
83
|
+
actual_arity = resource.method(:cache_key).arity
|
84
|
+
assert_includes [-1, 0], actual_arity, "expected #{actual_arity.inspect} to be 0 or -1"
|
85
|
+
end
|
86
|
+
|
87
|
+
# Passes if the object responds to <tt>updated_at</tt> and if it takes no
|
88
|
+
# arguments.
|
89
|
+
# Fails otherwise.
|
90
|
+
#
|
91
|
+
# <tt>updated_at</tt> returns a Time object or iso8601 string and
|
92
|
+
# is part of the (self-expiring) cache_key, which is used by the adapter.
|
93
|
+
# It is not required unless caching is enabled.
|
94
|
+
def test_updated_at
|
95
|
+
assert_respond_to resource, :updated_at
|
96
|
+
actual_arity = resource.method(:updated_at).arity
|
97
|
+
assert_equal 0, actual_arity
|
98
|
+
end
|
99
|
+
|
100
|
+
# Passes if the object responds to <tt>id</tt> and if it takes no
|
101
|
+
# arguments.
|
102
|
+
# Fails otherwise.
|
103
|
+
#
|
104
|
+
# <tt>id</tt> returns a unique identifier for the object.
|
105
|
+
# It is not required unless caching is enabled.
|
106
|
+
def test_id
|
107
|
+
assert_respond_to resource, :id
|
108
|
+
assert_equal 0, resource.method(:id).arity
|
109
|
+
end
|
110
|
+
|
111
|
+
# Passes if the object's class responds to <tt>model_name</tt> and if it
|
112
|
+
# is in an instance of +ActiveModel::Name+.
|
113
|
+
# Fails otherwise.
|
114
|
+
#
|
115
|
+
# <tt>model_name</tt> returns an ActiveModel::Name instance.
|
116
|
+
# It is used by the serializer to identify the object's type.
|
117
|
+
# It is not required unless caching is enabled.
|
118
|
+
def test_model_name
|
119
|
+
resource_class = resource.class
|
120
|
+
assert_respond_to resource_class, :model_name
|
121
|
+
assert_instance_of resource_class.model_name, ActiveModel::Name
|
122
|
+
end
|
123
|
+
|
124
|
+
def test_active_model_errors
|
125
|
+
assert_respond_to resource, :errors
|
126
|
+
end
|
127
|
+
|
128
|
+
def test_active_model_errors_human_attribute_name
|
129
|
+
assert_respond_to resource.class, :human_attribute_name
|
130
|
+
assert_equal(-2, resource.class.method(:human_attribute_name).arity)
|
131
|
+
end
|
132
|
+
|
133
|
+
def test_active_model_errors_lookup_ancestors
|
134
|
+
assert_respond_to resource.class, :lookup_ancestors
|
135
|
+
assert_equal 0, resource.class.method(:lookup_ancestors).arity
|
136
|
+
end
|
137
|
+
|
138
|
+
private
|
139
|
+
|
140
|
+
def resource
|
141
|
+
@resource or fail "'@resource' must be set as the linted object"
|
142
|
+
end
|
143
|
+
|
144
|
+
def assert_instance_of(result, name)
|
145
|
+
assert result.instance_of?(name), "#{result} should be an instance of #{name}"
|
146
|
+
end
|
147
|
+
end
|
148
|
+
end
|
149
|
+
end
|
150
|
+
end
|
@@ -0,0 +1,163 @@
|
|
1
|
+
require 'active_model/serializer/field'
|
2
|
+
|
3
|
+
module ActiveModel
|
4
|
+
class Serializer
|
5
|
+
# Holds all the meta-data about an association as it was specified in the
|
6
|
+
# ActiveModel::Serializer class.
|
7
|
+
#
|
8
|
+
# @example
|
9
|
+
# class PostSerializer < ActiveModel::Serializer
|
10
|
+
# has_one :author, serializer: AuthorSerializer
|
11
|
+
# has_many :comments
|
12
|
+
# has_many :comments, key: :last_comments do
|
13
|
+
# object.comments.last(1)
|
14
|
+
# end
|
15
|
+
# has_many :secret_meta_data, if: :is_admin?
|
16
|
+
#
|
17
|
+
# def is_admin?
|
18
|
+
# current_user.admin?
|
19
|
+
# end
|
20
|
+
# end
|
21
|
+
#
|
22
|
+
# Specifically, the association 'comments' is evaluated two different ways:
|
23
|
+
# 1) as 'comments' and named 'comments'.
|
24
|
+
# 2) as 'object.comments.last(1)' and named 'last_comments'.
|
25
|
+
#
|
26
|
+
# PostSerializer._reflections #=>
|
27
|
+
# # [
|
28
|
+
# # HasOneReflection.new(:author, serializer: AuthorSerializer),
|
29
|
+
# # HasManyReflection.new(:comments)
|
30
|
+
# # HasManyReflection.new(:comments, { key: :last_comments }, #<Block>)
|
31
|
+
# # HasManyReflection.new(:secret_meta_data, { if: :is_admin? })
|
32
|
+
# # ]
|
33
|
+
#
|
34
|
+
# So you can inspect reflections in your Adapters.
|
35
|
+
#
|
36
|
+
class Reflection < Field
|
37
|
+
def initialize(*)
|
38
|
+
super
|
39
|
+
@_links = {}
|
40
|
+
@_include_data = Serializer.config.include_data_default
|
41
|
+
@_meta = nil
|
42
|
+
end
|
43
|
+
|
44
|
+
def link(name, value = nil, &block)
|
45
|
+
@_links[name] = block || value
|
46
|
+
:nil
|
47
|
+
end
|
48
|
+
|
49
|
+
def meta(value = nil, &block)
|
50
|
+
@_meta = block || value
|
51
|
+
:nil
|
52
|
+
end
|
53
|
+
|
54
|
+
def include_data(value = true)
|
55
|
+
@_include_data = value
|
56
|
+
:nil
|
57
|
+
end
|
58
|
+
|
59
|
+
# @param serializer [ActiveModel::Serializer]
|
60
|
+
# @yield [ActiveModel::Serializer]
|
61
|
+
# @return [:nil, associated resource or resource collection]
|
62
|
+
# @example
|
63
|
+
# has_one :blog do |serializer|
|
64
|
+
# serializer.cached_blog
|
65
|
+
# end
|
66
|
+
#
|
67
|
+
# def cached_blog
|
68
|
+
# cache_store.fetch("cached_blog:#{object.updated_at}") do
|
69
|
+
# Blog.find(object.blog_id)
|
70
|
+
# end
|
71
|
+
# end
|
72
|
+
def value(serializer, include_slice)
|
73
|
+
@object = serializer.object
|
74
|
+
@scope = serializer.scope
|
75
|
+
|
76
|
+
block_value = instance_exec(serializer, &block) if block
|
77
|
+
return unless include_data?(include_slice)
|
78
|
+
|
79
|
+
if block && block_value != :nil
|
80
|
+
block_value
|
81
|
+
else
|
82
|
+
serializer.read_attribute_for_serialization(name)
|
83
|
+
end
|
84
|
+
end
|
85
|
+
|
86
|
+
# Build association. This method is used internally to
|
87
|
+
# build serializer's association by its reflection.
|
88
|
+
#
|
89
|
+
# @param [Serializer] parent_serializer for given association
|
90
|
+
# @param [Hash{Symbol => Object}] parent_serializer_options
|
91
|
+
#
|
92
|
+
# @example
|
93
|
+
# # Given the following serializer defined:
|
94
|
+
# class PostSerializer < ActiveModel::Serializer
|
95
|
+
# has_many :comments, serializer: CommentSummarySerializer
|
96
|
+
# end
|
97
|
+
#
|
98
|
+
# # Then you instantiate your serializer
|
99
|
+
# post_serializer = PostSerializer.new(post, foo: 'bar') #
|
100
|
+
# # to build association for comments you need to get reflection
|
101
|
+
# comments_reflection = PostSerializer._reflections.detect { |r| r.name == :comments }
|
102
|
+
# # and #build_association
|
103
|
+
# comments_reflection.build_association(post_serializer, foo: 'bar')
|
104
|
+
#
|
105
|
+
# @api private
|
106
|
+
#
|
107
|
+
def build_association(parent_serializer, parent_serializer_options, include_slice = {})
|
108
|
+
reflection_options = options.dup
|
109
|
+
|
110
|
+
# Pass the parent's namespace onto the child serializer
|
111
|
+
reflection_options[:namespace] ||= parent_serializer_options[:namespace]
|
112
|
+
|
113
|
+
association_value = value(parent_serializer, include_slice)
|
114
|
+
serializer_class = parent_serializer.class.serializer_for(association_value, reflection_options)
|
115
|
+
reflection_options[:include_data] = include_data?(include_slice)
|
116
|
+
reflection_options[:links] = @_links
|
117
|
+
reflection_options[:meta] = @_meta
|
118
|
+
|
119
|
+
if serializer_class
|
120
|
+
serializer = catch(:no_serializer) do
|
121
|
+
serializer_class.new(
|
122
|
+
association_value,
|
123
|
+
serializer_options(parent_serializer, parent_serializer_options, reflection_options)
|
124
|
+
)
|
125
|
+
end
|
126
|
+
if serializer.nil?
|
127
|
+
reflection_options[:virtual_value] = association_value.try(:as_json) || association_value
|
128
|
+
else
|
129
|
+
reflection_options[:serializer] = serializer
|
130
|
+
end
|
131
|
+
elsif !association_value.nil? && !association_value.instance_of?(Object)
|
132
|
+
reflection_options[:virtual_value] = association_value
|
133
|
+
end
|
134
|
+
|
135
|
+
block = nil
|
136
|
+
Association.new(name, reflection_options, block)
|
137
|
+
end
|
138
|
+
|
139
|
+
protected
|
140
|
+
|
141
|
+
attr_accessor :object, :scope
|
142
|
+
|
143
|
+
private
|
144
|
+
|
145
|
+
def include_data?(include_slice)
|
146
|
+
if @_include_data == :if_sideloaded
|
147
|
+
include_slice.key?(name)
|
148
|
+
else
|
149
|
+
@_include_data
|
150
|
+
end
|
151
|
+
end
|
152
|
+
|
153
|
+
def serializer_options(parent_serializer, parent_serializer_options, reflection_options)
|
154
|
+
serializer = reflection_options.fetch(:serializer, nil)
|
155
|
+
|
156
|
+
serializer_options = parent_serializer_options.except(:serializer)
|
157
|
+
serializer_options[:serializer] = serializer if serializer
|
158
|
+
serializer_options[:serializer_context_class] = parent_serializer.class
|
159
|
+
serializer_options
|
160
|
+
end
|
161
|
+
end
|
162
|
+
end
|
163
|
+
end
|