upgrade doc

[shicholas]

I recently upgraded my .8 ams app to the latest and found the following helpful. Hope someone can find this useful too.

I also feel I'm missing something when it comes to creating an ArraySerializer Adapter and would appreciate some help.

[beauby]

Thanks @shicholas, that's really helpful! It might even make sense to provide a legacy json_08 adapter in 0.10 to make the migration even easier. I know this is something that has been talked about, but I don't think anyone has taken a crack at it as of yet.
We could discuss about the ArraySerializer on our Slack.

[shicholas]

do I need to an invite to join slack?

[joaomdmoura]

@shicholas: https://amserializers.herokuapp.com/ (auto invite)

[bf4]

typo serializable

[bf4]

This would be fantastic as code with a PR and tests. If we can version APIs, why not adapters?

[shicholas]

I don't know about version .9, but maybe for .8 we could have these adapters:

• Version8::BaseAdapter (with a root element)
• Version8::BaseAdapterWithoutRoot
• Version8::CollectionAdapter
• Version8::CollectionAdapterWithoutRoot

I feel most apps I've worked with use version .8 with the root adapter, and since root shouldn't be defined per serializer anymore, I chose these four adapters.

EDIT: After talking to @beauby, I realize that I shouldn't distinguish between Collection and Base adapters b/c serializable_hash has a check if the serializer responds_to :each?. I updated the doc consequently.

[bf4]

typo: ;:. why not try adding this code with tests?

I'm thinking

# lib/active_model_serializers/v08/serializer.rb
# lib/active_model_serializers/v08/collection_serializer.rb
# lib/active_model_serializers/v08/adapter.rb
module ActiveModelSerializers::V08
  # Serializer might not need anything, but good to have defined
  Serializer = ActiveModel::Serializer
  CollectionSerializer = ActiveModel::Serializer::CollectionSerializer # well, it's Array now, but hopefully we'll get that renaming pr soon
  class Adapter < ActiveModel::Serializer::Adapter::Base
    # whatever methods you need
  end
end

And test like the other serializers and adapters

adapter = :'v08/adapter'
serializer = :'v08/array_serializer'
each_serializer = :'v08/serializer'
collection_resource = Post.all
expected_response = [{ something }]
assert ActiveModel::SerializableResource.new(collection_resource, serializer: serializer, each_serializer: each_serializer, adapter: adapter).as_json, expected_response

# and

adapter = :'v08/adapter'
serializer = :'v08/serializer'
resource = Post.first
expected_response = { something }
assert ActiveModel::SerializableResource.new(collection_resource, serializer: serializer, adapter: adapter).as_json, expected_response

[bf4]

Though after clicking comment, I realized the options definitions are wrong, should be:

adapter = ActiveModelSerializers::V08::Adapter
serializer = ActiveModelSerializers::V08::ArraySerializer
each_serializer = ActiveModelSerializers::V08::Serializer

[bf4]

@rails-api/ams thoughts on naming, folder etc?

[NullVoxPopuli]

anything specific? looks ok to me :-\ (except for the crazy long asserts)

[shicholas]

the API for the serializer itself changes (namely the root option). How should I address that?

[shicholas]

@bf4:

typo: ;:. why not try adding this code with tests?

sorry I must be blind, I don't see the typo.

[bf4]

Code blind
Semicolon in place of colon

Way i wrote was ambiguous

B mobile phone

On Oct 22, 2015, at 12:02 PM, Nick notifications@github.com wrote:

In docs/howto/UPGRADING.md:

+# How to upgrade from previous versions
+
+### Creating a Custom Base Adapter
+
+You can upgrade to ams .10 by creating a custom Base Adapter to
+emulate the response that your application currently serves.
+
+###### Base Adapter
+
+A base adapter takes a ActiveModel::Serializer or
+ActiveModel::Serializer::ArraySerializer instance, and creates a hash
+used for serialization in its serializable_hash method. A base adapter
+could look like this:
+
+```ruby
+class MyApp::BaseAdapter < ActiveModel::Serializer::Adapter::Base
@bf4:

typo: ;:. why not try adding this code with tests?

sorry I must be blind, I don't see the typo.

—
Reply to this email directly or view it on GitHub.

[shicholas]

closing, I think a V8 adapter is a good idea (though still would like to know how to deal with the issue of the root option) and I feel the docs that will result from #1317 will trump this PR.

Also, I feel with the code somewhat in flux, e.g. the namespacing changes I have been reading, maybe the v8 adapter should be written after the api stabilizes?