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

NullVoxPopuli · 2015-09-07T16:34:52Z

Refactor of Attributes adapter
Make Json and Attributes adapter handle nested serialization via adapter include option

Note: the serializer-level include option has been dropped for now (i.e. doing has_many :comments, include: 'author, posts' is still not possible).

NullVoxPopuli · 2015-09-07T16:35:49Z

Rebased as of now

beauby · 2015-09-07T16:51:17Z

lib/active_model/serializer/adapter/json.rb

@@ -7,37 +7,13 @@ class Json < Adapter
        def serializable_hash(options = nil)
          options ||= {}
          if serializer.respond_to?(:each)
-            @result = serializer.map { |s| FlattenJson.new(s).serializable_hash(options) }


Is there a reason for not using a local variable for result here?

I think because a superclass or subclass may use @result, e.g. FlattenJson currently does

Also, result is very generic. hash might not be the best, but at least it's slightly more precise (and given the method name is serializable_hash it does make sense).

@bf4 Well, in this case better not rename it at all and keep @hash.

re @result.... at least until #1117 is merged.. it's bad OO in any case, for sure.

I didn't like the way multiple methods were modifying the same instance variable. :-/

@NullVoxPopuli I agree on that, neither do I. But my question was why not get rid of the instance variable altogether and simply use a local variable?

Oh OK. Sorry. Yeah, I'd prefer that. I'll take care of that in my next push

NullVoxPopuli · 2015-09-08T14:55:27Z

Nested Associations Usage

Associations defined on a serializer (via has_many, belongs_to, etc) may optionally include the associations' associations by using the include key in the association definition.

Example:

BlogSerializer < ActiveModel::Serializer
  attributes :id, :title

  has_many :posts, include: { author: [:bio], comments: [:author]] }
end

This will provide nested json for each post that includes the post's author and comments as well as associations nested on both the author and each comment.

resulting json may look something like the following:

{
  blog: {
    id: 1,
    title: 'My First Blog',
    posts: [
      {
        title: 'There and back again',
        author: {
          id: 1
          name: 'Bilbo Baggins',
          bio: {
            age: 111,
            location: 'Hobbiton, The Shire'
          }
        },
        comments: [
          {  
             id: 1
             text: 'Great read! A+++ Would read again',
             author: {
               id: 2,
               name: 'Frodo Baggins'
             } 
          }
        ]
      }
    ]
  }
}

Nested associations must each be explicitly provided, or only the attributes will be rendered (no associations)

Example:

BlogSerializer < ActiveModel::Serializer
  attributes :id, :title

  has_many :posts, include: :author
end

Would result in this:

{
  blog: {
    id: 1,
    title: 'My First Blog',
    posts: [
      {
        title: 'There and back again',
        author: {
          id: 1
          name: 'Bilbo Baggins'
        }
      }
    ]
  }
}

Defining the include options

The simplest include of one nested association

has_many :posts, include: :author

Because posts could have multiple associations, a list of a association names may be provided

has_many :posts, include: [:author]
# or
has_many :posts, include: [:author, :comments]

These two are also equivalent, and include the author of each comment on each post

has_many :posts, include: [:author, comments: :author]
# or 
has_many :posts include: [:author, comments: [:author]]

willcosgrove · 2015-09-09T05:09:10Z

How difficult would it be to port this over to the :flatten_json adapter? I've got a use case where that would be great to have. If it's difficult or unwanted, it wouldn't be hard to grab the value of the lone key in the resulting hash from the :json adapter. So no big deal if that's not in the cards, just curious.

Also great work with this 👍 can't wait to use it!

NullVoxPopuli · 2015-09-09T09:48:52Z

Would that just function the same as json, but without the root?

I think it would be better to wait until a few PRs are merged, cause I think something is changing with FlattenJson

willcosgrove · 2015-09-09T22:17:03Z

Would that just function the same as json, but without the root?

Yeah, that's what I was thinking.

I think it would be better to wait until a few PRs are merged, cause I think something is changing with FlattenJson

Good to know. I'm currently dependent on the way FlattenJson is working. So I should probably start using the Json adapter, and just remove the root manually...

Thanks!

NullVoxPopuli · 2015-09-10T01:05:58Z

Updated include syntax translator to only use a hash of hashes.
Related to #1131

beauby · 2015-09-10T01:06:38Z

lib/active_model/serializer/adapter/json.rb

+          end
+
+          # TODO: remove usage of result instance variable from other flows / tests
+          @result = serialized_hash


Where exactly is @Result used?

I think a super class or something -- tests unrelated to my stuff fail if I get rid of it.

Faire enough. I think @bf4 issued a PR to remove that dependency, but let's leave it like that for now.

yeah, if his gets merged first, I'll change this

NullVoxPopuli · 2015-09-10T11:50:29Z

this is the failed build. for some reason a gem didn't install correctly: https://travis-ci.org/rails-api/active_model_serializers/jobs/79579984

joaomdmoura · 2015-09-11T08:27:48Z

Hey @NullVoxPopuli finally checking this for real! Look awesome and great! There are some room for improvement but most of thing were already mentioned.

I merged the Adapter PR from Benjamin so you can already rebase yours and update it to use any new feature he might have added that would help you.

After review this I had some ideas, I don't think it need to be implemented on this PR but it's something we would need on 0.10.x. About this specifically:

As I mentioned on the comment above, right now we have an include options on render that handles nested association on json-api. This PR implements a include option on the association declaration that also handles nested associations.
Would be awesome if we could use both includes in both adapters, so you can handle nested association on json-api and json/flatten_json with the same way enabling you to define it on the serializer os specify on a render call.

NullVoxPopuli · 2015-09-11T10:18:22Z

Thanks for the comments! I'll work on those soon!

bf4 · 2015-09-11T14:42:12Z

lib/active_model/serializer/adapter/json.rb

@@ -1,47 +1,128 @@
 class ActiveModel::Serializer::Adapter::Json < ActiveModel::Serializer::Adapter
-        extend ActiveSupport::Autoload


weird that this isn't indented since it is on master https://github.com/rails-api/active_model_serializers/blob/4399c1ad1af2da9dabac327ebf4cb23ff7354e83/lib/active_model/serializer/adapter/json.rb

need help rebasing?

in master, the indentation is incorrect. :-\

I'll rebase. I just forgot :-(

(reason is it makes the diff easier to read, and we'll hopefully go back to a more standard class definition when we make Adapter a module and Adapter::Base the superclass

It's like that in master on purpose.. to make the diffs easier to read.. previous comment

aight, I'll fix

I totally agree it looks weird, but it makes the diff so much easier, and I do intend to get it back to sane soon enough

…ns-for-json-adapter Support nested associations for Json and Attributes adapters + Refactor Attributes adapter

yoda · 2015-10-02T06:49:16Z

Thanks heaps for this

beauby · 2015-10-02T12:35:29Z

@philipgiuliani Good question. @NullVoxPopuli?

NullVoxPopuli · 2015-10-02T12:54:48Z

That is a good question. I haven't done anything with the cache, so I am not sure.

kalinchuk · 2016-04-29T15:31:48Z

Any way to include all associations by default like it was in previous versions?

NullVoxPopuli · 2016-04-29T15:38:02Z

include: '*' :-)

NullVoxPopuli · 2016-04-29T15:38:15Z

oh... default

uhh. nope

bf4 · 2016-04-29T18:24:44Z

There's an open issue and a stale pr to add default includes. But let's not discuss that here :)

pinglamb · 2016-05-03T08:47:47Z

Thanks for the PR. Just realize that include: '**' will include associations of associations recursively.

cgmckeever · 2016-05-03T12:39:54Z

@pinglamb Nice find!!!! That solves one of my issues. Still cant get the polymorphic RELATION_id RELATION_type of appear in the data ... may need to open up an issue when I have some time .. again, nice find!

plicjo · 2016-06-15T19:09:50Z

The first post says "the serializer-level include option has been dropped for now", which is true!

The provided example a few posts down is implemented at the serializer level, which doesn't work.

In order to use the stuff in this commit, you'll need to apply the include at the render level: render @posts, include: [author: :bio]

Hopefully this helps someone in the future.

steverob · 2016-07-19T11:33:59Z

Thanks @plicjo :)

Is there a way to set include: '**' as the default across the app? It bit me when I was upgrading too and we're using this stuff extensively. I dont want to go through all my serializers and find out where the nested stuff is being used in the front end and update my controller endpoints :(

Update - found it :)

ActiveModelSerializers.config.default_includes = "**"

brendon · 2016-09-19T23:49:35Z

Is there a way to have unlimited recursion? In my case it's a tree structure with no chance of circular dependency, but arbitrary depth that I can't know in advance.

NullVoxPopuli · 2016-09-19T23:51:03Z

there is include: '**'

brendon · 2016-09-19T23:55:43Z

Thanks @NullVoxPopuli, lol is that inspired by Dir.glob? :) I'll update my doc PR to mention it.

brendon · 2016-09-20T00:27:52Z

With regard to setting this globally. I've added the following to an initialiser file in a Rails project. It runs but seems to be ignored:

ActiveModelSerializers.config.default_includes = "**"

Is there a better way to set the default?

NullVoxPopuli · 2016-09-20T00:36:38Z

what adapter are you using?

brendon · 2016-09-20T00:46:22Z

The default: :attributes

NullVoxPopuli mentioned this pull request Sep 7, 2015

Nested associations for json adapter #1124

Closed

beauby reviewed Sep 7, 2015
View reviewed changes

NullVoxPopuli mentioned this pull request Sep 8, 2015

JSON API nicer include syntax #1128

Closed

beauby mentioned this pull request Sep 10, 2015

Nicer syntax for jsonapi include #1131

Merged

beauby reviewed Sep 10, 2015
View reviewed changes

NullVoxPopuli mentioned this pull request Sep 10, 2015

JSON adapter does not handle nested associations #835

Closed

joaomdmoura mentioned this pull request Sep 11, 2015

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

Closed

bf4 reviewed Sep 11, 2015
View reviewed changes

beauby assigned NullVoxPopuli and unassigned beauby Sep 21, 2015

beauby added a commit that referenced this pull request Sep 21, 2015

Merge pull request #1127 from NullVoxPopuli/support-nested-associatio…

606e2ae

…ns-for-json-adapter Support nested associations for Json and Attributes adapters + Refactor Attributes adapter

beauby merged commit 606e2ae into rails-api:master Sep 21, 2015

NullVoxPopuli mentioned this pull request Sep 21, 2015

Create NestedJson adapter. #1073

Closed

This was referenced Sep 22, 2015

Nested serializers/attributes #1190

Closed

Load associations to one level while conditionally sideloading associations in Active model serializers #927

Closed

givigier mentioned this pull request Sep 23, 2015

Include does not work on nested associations #1194

Closed

iMacTia mentioned this pull request Nov 18, 2015

Include option for associations in serializers #1333

Open

andrewhavens mentioned this pull request Feb 19, 2016

undefined method `embed' #938

Closed

bf4 mentioned this pull request Jun 1, 2016

Side loading doesn't work in 0.10.0.rc1 (non-JSONAPI) #899

Closed

brendon mentioned this pull request Sep 19, 2016

Update upgrade_from_0_8_to_0_10.md #1933

Merged

dnt294 mentioned this pull request Nov 12, 2016

Include doesn't work on nested associations in serializer #1972

Closed

		@@ -1,47 +1,128 @@
		class ActiveModel::Serializer::Adapter::Json < ActiveModel::Serializer::Adapter
		extend ActiveSupport::Autoload

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

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

Conversation

NullVoxPopuli commented Sep 7, 2015

NullVoxPopuli commented Sep 7, 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

NullVoxPopuli commented Sep 8, 2015

Nested Associations Usage

Defining the include options

willcosgrove commented Sep 9, 2015

NullVoxPopuli commented Sep 9, 2015

willcosgrove commented Sep 9, 2015

NullVoxPopuli commented Sep 10, 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

NullVoxPopuli commented Sep 10, 2015

joaomdmoura commented Sep 11, 2015

NullVoxPopuli commented Sep 11, 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

yoda commented Oct 2, 2015

beauby commented Oct 2, 2015

NullVoxPopuli commented Oct 2, 2015

kalinchuk commented Apr 29, 2016

NullVoxPopuli commented Apr 29, 2016

NullVoxPopuli commented Apr 29, 2016

bf4 commented Apr 29, 2016

pinglamb commented May 3, 2016

cgmckeever commented May 3, 2016

plicjo commented Jun 15, 2016 • edited Loading

steverob commented Jul 19, 2016 • edited Loading

brendon commented Sep 19, 2016

NullVoxPopuli commented Sep 19, 2016

brendon commented Sep 19, 2016

brendon commented Sep 20, 2016

NullVoxPopuli commented Sep 20, 2016

brendon commented Sep 20, 2016

plicjo commented Jun 15, 2016 •

edited

Loading

steverob commented Jul 19, 2016 •

edited

Loading