Move meta/meta_key handling inside adapter.

[beauby]

The (toplevel) meta handling is clearly an adapter concern.

[beauby]

Those readers simply do not exist anymore.

[NullVoxPopuli]

👍

[NullVoxPopuli]

formatting?

.as_json

feels so lonely

[beauby]

How would you rather have it?

[NullVoxPopuli]

ActiveModel::SerializableResource.new(
  [@blog],
  adapter: :attributes,
  meta: { total: 10 }
).as_json

[beauby]

I could live with that. Will update.

[beauby]

Done.

[NullVoxPopuli]

can you rebase?

[NullVoxPopuli]

thanks!

[beauby]

Wait, I'll rebase.

[beauby]

Rebased.

[NullVoxPopuli]

woo!

[joaomdmoura]

👍

[trek]

Did this break existing examples for supplying meta from with a CollectionSerializer? It doesn't seem like that's possible now. Should those be updated to show to override the adapter for this behavior?

[beauby]

@trek Not sure I understand what you meant. Could you sketch some code to show what you have in mind?

[trek]

The pagination example here doesn't work after moving meta to the Adapter (where it does obviously better fit).

It looks like we didn't also add the documentation for centrally overriding serialization to include meta. The JSON API Adapter, for example, will include links automatically but the only way we could figure out how to get extra keys into the top level object (in this case for pagination) was creating our own adapter and overriding serializable_hash_for_collection

class JsonApiWithMetaAdapter < ActiveModel::Serializer::Adapter::JsonApi
  def serializable_hash_for_collection(options)
    hash = super
    object = serializer.object # object here is a collection, using CollectionSerializer

    if serializer.paginated?
      hash[:meta] = hash[:meta] || {}
      hash[:meta][:pagination] = {
        current_page: object.current_page,
        total_pages: object.total_pages,
        total_entries: object.total_entries
      }
    end

    hash
  end
end

There might be a better way, but we couldn't find an interface for it on master. It'd be good to document getting keys into the top level hash.

[beauby]

@trek You are right. Note that, in master, you can always provide the meta option to your render call, which will be forwarded to the adapter, and included in the response document (render json: posts, meta: my_pagination_hash). It is probably worth thinking about the possibility of including a resource/serializer-level meta directive for the Json adapter, but the example in the docs was clearly a hack.