rename context to serialization_context and add url helpers

[tchak]

No description provided.

[tchak]

I am not sure about the best way to include url_helpers in the context object. If some people with more knowledge about rails internals have a better idea I am all 👂 :)

[tchak]

I also feel that in the end serialization_context should be exposed just like scope directly on the serializer instances. I would like to add serialization_context_name just like for scope and expose it as context by default.

[bf4]

I'd rather not include the url helpers and instead stick 'em in a url_helpers method

We could probably set it and default_url_iptions in the railtie.

Also, i don't believe we include action mailer nor do we need it. There should be a similar methid on the controller

[bf4]

Let's also add a context test

[tchak]

Oh sorry about ActionMailer this is me trying things by copy/pasting from SO in a hurry :( Will look in to how do it from the railtie!

[bf4]

Awesome work!

[beauby]

Pretty cool 👍

[NullVoxPopuli]

LGTM 👍

[NullVoxPopuli]

@tchak I'm good with merging this, unless you think serialization_context_name should be included in this PR.. maybe a different PR? All tests pass, so... :-)

[tchak]

@NullVoxPopuli let me add a few more tests tonight. Yes serialization_context_name will go in a separate PR.

[NullVoxPopuli]

cool. thanks!

[bf4]

I think I'd rather have url_helpers a class method on the Context. It feels more natural here. Also, no need to include them. you could just

class Context
  class << self
    attr_accessor :url_helpers, :default_url_options
  end
end

and in the Railtie

Context.url_helpers = Rails.application.routes.url_helpers # for now, later would like to encapsulate it to control the boundary e.g. UrlHelpers.new(Rails.application.routes.url_helpers)
Context.default_url_options =  ActionController::Base.default_url_options

I'm trying to keep in mind how someone using grape would configure this. If we keep a good interface, the details of the implementation don't matter as much. That means more composition and less just mixing things in. Alternatively, there could be a UrlHelpers module that you mix in to the Context when the railtie is called, which allows others to mix in a different helper object

[tchak]

hmm as far as I understand default_url_options needs to be defined on the same object where url_helpers are included in order to be taken in to account. Am I not understanding it correctly?

[tchak]

also I usually use url helpers in serialisers a lot, so I am thinking that at some point I would like to be able to do in some serializer code something like this:

def validation_url
  context.validation_url(object)
end

or at least

def validation_url
  context.url_helpers.validation_url(object)
end

Are we on the same page here? Or do you see the usage differently?

[tchak]

I am trying to add some tests to url_helpers thing and I feel a bit confused :) I am going to need a better understanding of how rails routes works and compose with everything else... I hope to be able to figure it out in the next few days.

[beauby]

In my opinion this PR is worth merging without url_helpers (that we could add later).

[NullVoxPopuli]

I agree, @beauby

[beauby]

Wait, it wasn't ready though (there were references to url_helpers and stuff). Could you revert the merge until we clear it for merging?

[NullVoxPopuli]

that's what I get for not re-reviewing. ha

[bf4]

@tchak would you mind re-submitting this PR, referencing it, and referring to the comments in #1289 (comment) ? Maybe skip the do it in two parts, without the url helpers, then adding them

[beauby]

So in the end, how does one access the url_helpers from within an attribute definition in a serializer?
As follows?

attribute :url do
  serialization_context.url_helpers.posts_route
end

[bf4]

I think I left this open for the uri templates

The serialization context url helpers are mixed into Link. Examples in docs

B mobile phone

On Apr 20, 2016, at 8:22 AM, Lucas Hosseini notifications@github.com wrote:

So in the end, how does one access the url_helpers from within an attribute definition in a serializer?
As follows?

attribute :url do
serialization_context.url_helpers.posts_route
end
—
You are receiving this because you commented.
Reply to this email directly or view it on GitHub