Change API for multiple serializers about surrealist HOT 6 CLOSED

@AlessandroMinali @nulldef what do you think would be the best option here?

from surrealist.

Personally I prefer via or format.

from surrealist.

We can try using for keyword.
format is terrible I think. And about via - maybe It will be more semantically correct in some cases, but not in mostly cases.

from surrealist.

Yes, maybe you are right and for is a good option since the most cases where one would need multiple serializers would be a web application with a number of presentation points of some models. Something like

class Post < ActiveRecord::Base
  include Surrealist
  
  surrealize_with PostSerializer
  surrealize_with PostPreviewSerializer, tag: :preview
  surrealize_with PostApiSerializer, tag: :api
  surrealize_with PostFrontendSerializer, tag: :frontend
end

In this case the most appropriate way to specify serialiser would be to specify the goal of serialization.

Post.find(42).surrealize(for: :preview)
Post.find(42).surrealize(for: :api)
Post.find(42).surrealize(for: :frontend)

Post.find(42).surrealize(via: :preview) doesn't seem quite right in this case. So the question is whether this kind of context would be primary for the most of the use cases of this feature. @AlessandroMinali what do you think?

from surrealist.

:for seems fine to me.

I guess one way to cover all use cases is to be pedantic and just call the option :serializer. That leaves nothing to the imagination and is pretty dry about what is going on/being passed. In that case I'd still argue for :as to set the alias.

If the user sets a tag but then still wants to be explicit and call the actual serializer by the constant are we going to allow that?
i.e.:

Something.new.surrealize(tag: :short)
Something.new.surrealize(tag: SomethingShortSerializer) 

from surrealist.

I guess we will provide the option to specify the serialiser class with
Post.find(42).surrealize(serializer: PostPreviewSerializer). And for symbols let's leave for:
Post.find(42).surrealize(for: :preview)

from surrealist.