Add Rails url_helpers

[remear]

Purpose

Add Rails url_helpers to Link so helpers are available in the evaluation context for the block. This allows link(:link_name) { resource_url(object) }

Changes

• Prepares Rails url_helpers and default_url_options in SerializationContext via the railtie.

Caveats

• Rails.application.routes.default_url_options must be set as the Rails url helpers need them to build urls.

Related GitHub issues

#1454

[remear]

The tests need some fixing but I'd like to start getting eyes on this.

[bf4]

💯

[bf4]

Also ref:

• SerializationContext: request url info, content type, query params, api version, namespace, etc #1269
  • rename context to serialization_context and add url helpers #1289 (comment)
    • JsonApi PaginationLinks doesn't work outside of ActionController #1268 (comment)
  • Auto-include url_helpers for Rails-apps. Fixes #563 #666
  • Closes JSONAPI resource relation urls #834

[bf4]

• Should also add a /howto/ for configuring the Support::UrlHelpers (after the meat of the PR is reviewed)

[bf4]

• would be good to have url_for example and maybe default_url_options?

which might go in the configuration docs

[remear]

Since having revised this PR to use SerializationContext I think we need:

• Docs for configuring Rails.application.routes.default_url_options
• Docs that give an example of url_for. (as previously mentioned)

Anything else?

[bf4]

Tests w grape adapter?

B mobile phone

On Mar 3, 2016, at 12:14 PM, Ben Mills [email protected] wrote:

Since having revised this PR to use SerializationContext I think we need:

Docs for configuring Rails.application.routes.default_url_options
Docs that give an example of url_for. (as previously mentioned)
Anything else?

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

[remear]

I figured when Grape is used with Rails, the Railtie would load and SerializationContext would be available and include the url helpers. When Grape is used without Rails, the railtie would not load, SerializationContext would not be available, and no url helpers would be available. Are you wanting more of an explicit test? It doesn't look like links are even tested under Grape.

[bf4]

We have a grape impl, but let's not delay this pr

B mobile phone

On Mar 3, 2016, at 2:41 PM, Ben Mills [email protected] wrote:

In docs/general/rendering.md:

@@ -144,6 +144,32 @@ That's the result:

This feature is specific to JsonApi, so you have to use the use the JsonApi Adapter

+##### Resource-level
+
+In your serializer, define each link in one of the following methods:
+
+As a static string
+
+ruby +link :link_name, 'https://example.com/resource' +
+
+As a block to be evaluated. When using Rails, URL helpers are available.
I figured when Grape is used with Rails, the Railtie would load and SerializationContext would be available and include the url helpers. When Grape is used without Rails, the railtie would not load, SerializationContext would not be available, and no url helpers would be available. Are you wanting more of an explicit test? It doesn't look like links are even tested under Grape.

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

[bf4]

Yeah, sorry for a little yagni i introduced

B mobile phone

On Mar 3, 2016, at 2:41 PM, Ben Mills [email protected] wrote:

In docs/general/rendering.md:

@@ -144,6 +144,32 @@ That's the result:

This feature is specific to JsonApi, so you have to use the use the JsonApi Adapter

+##### Resource-level
+
+In your serializer, define each link in one of the following methods:
+
+As a static string
+
+ruby +link :link_name, 'https://example.com/resource' +
+
+As a block to be evaluated. When using Rails, URL helpers are available.
I figured when Grape is used with Rails, the Railtie would load and SerializationContext would be available and include the url helpers. When Grape is used without Rails, the railtie would not load, SerializationContext would not be available, and no url helpers would be available. Are you wanting more of an explicit test? It doesn't look like links are even tested under Grape.

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

[janvarljen]

I agree with @bf4 that SerializationContext approach would be better than including ActionMailer

[remear]

I strongly prefer the SerializationContext method of handling this. Revising this PR.

[bf4]

Dup text maybe instead link one to other?

[remear]

I don't know. I was thinking it would be easy to miss this in several places if it just linked to once section.

[bf4]

jsonapi only true for resource-level, also, right?

Might it be helpful to just refer to json_api/links.md or how_to/links.md for most of the text here to keep the rendering.md slimmer and more general?

ok for followup pr

[bf4]

💯 ok to merge

[mecampbellsoup]

@remear I'm wondering how the these default URL options can be set/mutated specifically in the case of PaginationLinks? Using Kaminari + AMS 10.6. Thanks and great work 😄

So far I've tried setting:

• Rails.application.routes.default_url_options
• ActiveModel::Serializer.default_host_options[:host] = '127.0.0.1:3000'

[remear]

@mecampbellsoup I configure this from config/application.rb with the example below, which has worked well for my pagination links managed by Kaminari.

Rails.application.routes.default_url_options = {
  host: ENV['EXTERNAL_HOST'] || 'localhost:3000',
  protocol: ENV['EXTERNAL_HOST_PROTOCOL'] || 'http'
}