Add support for nested serializers. #1157

beauby · 2015-09-16T06:07:21Z

Following discussion on #1113.
This adds support for defining serializers inside other serializers, so that when serializing a nested resource, the most nested serializer is used in priority.

NullVoxPopuli · 2015-09-17T11:48:21Z

ya have a lot of chained PRs :-p

beauby · 2015-09-21T06:05:19Z

lib/active_model/serializer/adapter/attributes.rb

@@ -9,40 +9,12 @@ def initialize(serializer, options = {})



This whole file is not required for this PR.

…ption.

NullVoxPopuli · 2015-09-21T16:14:07Z

lib/active_model/serializer/utils.rb

+module ActiveModel::Serializer::Utils
+  module_function
+
+  def nested_lookup_paths(klass)


can you add some yardoc?

bf4 · 2015-09-21T16:39:43Z

test/fixtures/poro.rb

+  belongs_to :author
+  class AuthorSerializer < ActiveModel::Serializer
+    attributes :id
+  end


How is this different from belongs_to: :author, serializer: TweetAuthorSerializer?

One thing is that the namespacing makes it so that you don't have to use funky adapter names that you then have to specify manually.

So, this PR is more a syntactic sugar than a new feature?

that's sorta how I see it as well. But for me, the biggest benefit would be to greatly reduce the number of top level serializers that actually have VERY specific purposes

It is, indeed syntactic sugar. However, I could see in the future having, say the Json adapter default to including all nested relationships (default to ** instead of * currently), in a kind of safe way since the user would provide all the subsequent serializers to make the graph explicit (maybe with a warning when there is an undefined serializer and possibly when using a fallback serializer).

bf4 · 2015-09-21T17:07:19Z

lib/active_model/serializer/utils.rb

+  # @param [Object] klass
+  # @return [Array<Symbol>]
+  def nested_lookup_paths(klass)
+    paths = klass.to_s.split('::').reverse.reduce([]) { |a, e| a + [[e] + Array(a.last)] }.reverse


Would you mind helping me read this code?

TweetSerializer::AuthorSerializer.to_s.split('::').reverse #=> ['AuthorSerializer', 'TweetSerializer']

_.reduce([]) {|result, element| result + [[element] + Array(result.last)] }.reverse

paths = []

paths = [] + [['AuthorSerializer'] + Array([]) ] #=> [['AuthorSerializer']]

paths = [['AuthorSerializer']] + [ ['TweetSerializer'] + Array(['AuthorSerializer']) ] #=> [ ["AuthorSerializer"], ["TweetSerializer", "AuthorSerializer"] ]

paths.reverse #=> ["TweetSerializer", "AuthorSerializer"], ["AuthorSerializer"]]

["TweetSerializer", "AuthorSerializer"], ["AuthorSerializer"]].map! {|path| path.join('::') } #=> ["TweetSerializer::AuthorSerializer", "AuthorSerializer"]

[TweetSerializer::AuthorSerializer", "AuthorSerializer"].select! {|path| Object.const_defined?(path, false) }.map! {|path| Object.const_get(path) }.push(Object) #=> [TweetSerializer::AuthorSerializer, AuthorSerializer, Object]

Is that right?

It is indeed. I admit that part was slightly cryptic.

So that as the test says

Utils.nested_lookup_paths(TweetSerializer::ShareSerializer::AuthorSerializer) #=> [::TweetSerializer::ShareSerializer::AuthorSerializer, ::ShareSerializer::AuthorSerializer, ::AuthorSerializer, ::Object]

And
Utils.nested_lookup([::TweetSerializer, ::Object], 'ShareSerializer') #=> ::TweetSerializer::ShareSerializer ?

I believe so.

So that

@share1 = Share.new TweetSerializer.serializer_for(@share1) #=> TweetSerializer::ShareSerializer ActiveModel::Serializer.serializer_for(@share1) #=> ShareSerializer

So that you can build associations on tweet.author using serializer: TweetSerializer::AuthorSerializer?

Yes, exactly, if available, and safely fallback to any less specialized serializer that can handle an Author.

NullVoxPopuli · 2015-09-22T13:00:38Z

lib/active_model/serializer/utils.rb

+  def nested_lookup_paths(klass)
+    paths = klass.to_s.split('::').reverse.reduce([]) { |a, e| a + [[e] + Array(a.last)] }.reverse
+    paths.map! { |path| "#{path.join('::')}" }
+    paths.map! do |path|


@beauby can you add comments after each line, explaining what it does -- so that if debugging of this needs to happen in the future, we don't need to go through the exercise you and @bf4 went through?

I'll comment the first line, which might be pretty cryptic. The rest is pretty much self-explanatory, no?

beauby · 2015-09-22T14:20:43Z

The tests currently fail because ruby <= 2.0.0 does not allow namespaced constants to be checked via namespace.const_defined?.

NullVoxPopuli · 2015-09-22T14:37:48Z

how long is < ruby 2.0 supported for?

beauby · 2015-09-22T15:16:49Z

@NullVoxPopuli Official support for 1.9.3 has ended in Feb 2015 (so we could probably drop support for 1.9.3 as well...). However, this issue still arises with ruby 2.0.0... I believe it was fixed in 2.0.1.

beauby · 2015-09-23T17:51:56Z

Closing this in favor of #1193.

joaomdmoura · 2015-10-02T23:55:06Z

Nice! #1193 looks awesome and way more mature

beauby force-pushed the nested-serializers branch 2 times, most recently from a1da4c5 to a922fc3 Compare September 16, 2015 07:41

NullVoxPopuli added the V: 0.10.x label Sep 16, 2015

beauby mentioned this pull request Sep 16, 2015

[RFC]Thoughts on an explicit way to define nested relationships? #1113

Closed

beauby force-pushed the nested-serializers branch from 885bc1d to 3d86c95 Compare September 16, 2015 16:20

beauby added the C: Feature label Sep 16, 2015

beauby force-pushed the nested-serializers branch from d224918 to 777b5a1 Compare September 21, 2015 05:56

beauby reviewed Sep 21, 2015
View reviewed changes

beauby changed the title ~~[WIP] Add support for nested serializers.~~ Add support for nested serializers. Sep 21, 2015

beauby mentioned this pull request Sep 21, 2015

Support nested associations for Json and Attributes adapters + Refactor Attributes adapter #1127

Merged

beauby added 9 commits September 21, 2015 17:38

Move expand_includes to Serializer class.

69b26d2

Refactor Json adapter to work with adapter JSON API style include o…

8dfef17

…ption.

Add support for nested serializers lookup.

6bcb84b

Factor nested_lookup.

4b50f01

Fix nesting on ArraySerializers.

dd580cb

Add tests.

b3c12ec

Add support for Json adapter.

61035bc

Finish Attributes refactor.

3f00e79

Fix inject/reduce.

273f0a7

beauby force-pushed the nested-serializers branch from 28750fa to 273f0a7 Compare September 21, 2015 15:48

Remove stale methods.

ef6577d

beauby force-pushed the nested-serializers branch from daf1334 to ef6577d Compare September 21, 2015 15:50

beauby self-assigned this Sep 21, 2015

Fix tests for ruby 2.0.0.

508ba34

NullVoxPopuli reviewed Sep 21, 2015
View reviewed changes

Add yarddoc to lookup methods.

597ae65

bf4 reviewed Sep 21, 2015
View reviewed changes

Fix rebase foul.

3ef1149

bf4 reviewed Sep 21, 2015
View reviewed changes

beauby added 2 commits September 21, 2015 20:53

Fix rubocop warning.

71816a5

Use constantize to handle ruby < 2.0.1.

db24432

lautis mentioned this pull request Sep 21, 2015

Attribute filtering for 0.10.x #1141

Closed

NullVoxPopuli reviewed Sep 22, 2015
View reviewed changes

beauby mentioned this pull request Sep 22, 2015

Nested serializers/attributes #1190

Closed

This was referenced Sep 22, 2015

JSON-API includes #1164

Closed

Nested Associations #1077

Closed

beauby mentioned this pull request Sep 23, 2015

Inline nested serializers #1193

Closed

beauby closed this Sep 23, 2015

NullVoxPopuli mentioned this pull request Aug 16, 2016

(WIP) Fix Serializer Lookup Chain for Namespaces #1883

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for nested serializers. #1157

Add support for nested serializers. #1157

beauby commented Sep 16, 2015

NullVoxPopuli commented Sep 17, 2015

beauby Sep 21, 2015

NullVoxPopuli Sep 21, 2015

beauby Sep 21, 2015

bf4 Sep 21, 2015

beauby Sep 21, 2015

bf4 Sep 21, 2015

NullVoxPopuli Sep 21, 2015

beauby Sep 21, 2015

bf4 Sep 21, 2015

beauby Sep 21, 2015

bf4 Sep 21, 2015

beauby Sep 21, 2015

bf4 Sep 21, 2015

beauby Sep 21, 2015

bf4 Sep 21, 2015

beauby Sep 21, 2015

bf4 Sep 21, 2015

beauby Sep 21, 2015

NullVoxPopuli Sep 22, 2015

beauby Sep 22, 2015

beauby commented Sep 22, 2015

NullVoxPopuli commented Sep 22, 2015

beauby commented Sep 22, 2015

beauby commented Sep 23, 2015

joaomdmoura commented Oct 2, 2015

Add support for nested serializers. #1157

Add support for nested serializers. #1157

Conversation

beauby commented Sep 16, 2015

NullVoxPopuli commented Sep 17, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

beauby commented Sep 22, 2015

NullVoxPopuli commented Sep 22, 2015

beauby commented Sep 22, 2015

beauby commented Sep 23, 2015

joaomdmoura commented Oct 2, 2015