Implement custom url helpers and polymorphic mapping #23138

pixeltrix · 2016-01-20T15:26:51Z

Implement the features outlined in #22512.

Add support for defining custom url helpers in routes.rb
Add support for defining custom polymorphic mappings in routes.rb

pixeltrix · 2016-01-20T15:27:56Z

@rails/core pushing up a WIP for some feedback on method name and implementation.

rafaelfranca · 2016-01-20T18:56:35Z

actionpack/lib/action_dispatch/routing/route_set.rb

+          def call(t, args, options, outer_options = {})
+            url_options = eval_block(t, args, options)
+
+            case url_options


Is not this duplicated somewhere else?

It's similar to the behaviour in ActionDispatch::Routing::UrlFor but not exactly the same, mainly because of the options being needed to be combined into the arguments for url_for.

dhh · 2016-01-24T22:31:25Z

actionpack/lib/action_dispatch/routing/mapper.rb

+        #
+        # NOTE: It is the url helper's responsibility to return the correct
+        # set of options to be passed to the `url_for` call.
+        def url_helper(name, options = {}, &block)


Not liking the word url_helper for this. It doesn't fit well with the rest of the metaphor we're using with drawing etc. What didn't you like about direct from the original pitch?

direct :homepage do "http://www.rubyonrails.org" end direct :commentable do |model| [ model, anchor: model.dom_id ] end direct :main do { controller: 'pages', action: 'index', subdomain: 'www' } end

Looks and sounds great to me.

@pixeltrix Did you have any reservations about using direct? Would love to get this merged before rc1. Also, we can use lookup for the link_to @model change.

matthewd · 2017-02-20T20:55:37Z

actionpack/lib/action_dispatch/routing/mapper.rb

+        #
+        # NOTE: The `direct` method doesn't observe the current scope in routes.rb
+        # and because of this it's recommended to define them outside of any blocks
+        # such as `namespace` or `scope`.


Should we just make this raise?

Probably - I'm sure we can detect that

matthewd · 2017-02-20T20:57:11Z

actionpack/lib/action_dispatch/routing/polymorphic_routes.rb

@@ -156,6 +164,11 @@ def polymorphic_path_for_action(action, record_or_hash, options)
          polymorphic_path(record_or_hash, options.merge(action: action))
        end

+        def polymorphic_mapping(record)
+          return false unless record.respond_to?(:to_model)
+          _routes.polymorphic_mappings[record.to_model.model_name.name]


Consider allowing non-models to map through by falling back on record.class.name?

matthewd · 2017-02-20T20:59:15Z

actionpack/lib/action_dispatch/routing/route_set.rb

+            url_name = :"#{helper}_url"
+
+            if @path_helpers_module.method_defined?(path_name)
+              @path_helpers_module.send :undef_method, path_name


Should this (and the existing call above) be using remove_method instead?

Unsure - need to check why we used undef_method in the first place

It was changed in 0088b08 - @tenderlove any reason undef_method was used instead of removed_method ?

I'm going to assume that undef_method was used because remove_possible_method uses that internally for the reason outlined in 0244c0d

Given the fact that we should allow people to access inherited methods if they include url helpers and then change a conflicting route name then probably best to switch to remove_method

matthewd · 2017-02-20T21:03:03Z

actionpack/lib/action_dispatch/routing/mapper.rb

+        def direct(name_or_hash, options = nil, &block)
+          case name_or_hash
+          when Hash
+            @set.add_polymorphic_mapping(name_or_hash, &block)


Ensure options is nil, as we're ignoring it?

And what if it isn't - raise or just merge?

I'd say raise ArgumentError

Maybe we should always use a hash?, e.g:

direct(method: :rubyonrails) { "http://rubyonrails.org" } direct(class: "Basket") { "/basket" }

Helps to clear up some naming confusion - @dhh wdyt?

Not a fan of that. Then I'd rather we use two separate method names. We could use direct for the URL declaration and resolve for polymorphics. So it's:

direct(:rubyonrails) { "http://rubyonrails.org" } resolve("Basket") { "/basket" }

matthewd · 2017-02-20T21:04:42Z

actionpack/lib/action_dispatch/routing/route_set.rb

+
+          @path_helpers_module.module_eval do
+            define_method(:"#{name}_path") do |*args|
+              options = args.extract_options!


Is there any benefit to doing this extraction here? Seems like that could be call's problem, where it already does so for nested arrays.

matthewd · 2017-02-20T21:10:06Z

actionpack/lib/action_dispatch/routing/route_set.rb

+            if url_options.permitted?
+              t.url_for(url_options.to_h.merge(outer_options))
+            else
+              raise ArgumentError, "Generating an URL from non sanitized request parameters is insecure!"


matthewd · 2017-02-20T21:13:43Z

actionpack/lib/action_dispatch/routing/route_set.rb

+        def call(t, args, options, outer_options = {})
+          url_options = eval_block(t, args, options)
+
+          case url_options


Can we push this whole case back into t (that's the "real" route thingy, right?), by just adding a new url_for-like method that takes an explicit path_only parameter?

Isn't there a path_for we could use?

matthewd · 2017-02-20T21:49:59Z

actionpack/test/dispatch/routing/direct_url_helpers_test.rb

+
+    direct(class: "Basket") { |basket| [:basket] }
+    direct(class: "User", anchor: "details") { |user, options| [:profile, options] }
+    direct(class: "Video") { |video| [:media, { id: video.id }] }


Given a Model#to_param, this would work as [:media, video], right?

No, that would map to media_video_path(@video) which doesn't exist

Ah... ouch.

So there's no way to really delegate to another route helper directly.

Could we make media_path(video) work, and have that magically behave like media_url or media_path depending on whether we're doing video_url or video_path, a bit like ActionMailer already does by forcing a full URL even when you ask for just the path?

Could we make media_path(video) work, and have that magically behave like media_url or media_path depending on whether we're doing video_url or video_path, a bit like ActionMailer already does by forcing a full URL even when you ask for just the path?

Possibly, url_for takes a strategy argument but we'd have to intercept the call somehow

The easy option would seem to be to have two different objects we can do the instance_exec on.. I don't remember how AM achieves its version, though.

matthewd · 2017-02-20T21:58:54Z

actionpack/CHANGELOG.md

+        ```
+
+        This generates the correct singular URL for the form instead of the default
+        resources member url, e.g. `/basket` vs. `/basket/:id`.


IMO we should come up with a different example here -- something that uses a parent route, perhaps -- both because it's desirable to show an argument-using block, and because I think resource should be registering the singular URL automatically (with some conflict resolution to avoid an incompatible change if you define both singular and plural resources for the same class).

Sorry, not entirely sure what you mean by this - can you illustrate with an example? Do you mean that calling resource :basket should automatically do direct(class: 'Basket') { [:basket] } behind the scenes?

Do you mean that calling resource :basket should automatically do direct(class: 'Basket') { [:basket] } behind the scenes?

Yes.

I don't think this would be a good idea - if we add it via resource then we'd need to add an option to configure/disable it and the thought of touching that code again makes me 😱

The singleton url_for on Rails.application.routes.url_helpers isn't the same as the url_for you get when you include the module in your class as the latter has support for polymorphic style routes, etc. whereas the former accepts only a hash and is the underlying implementation defined on ActionDispatch::Routing::RouteSet. This commit changes the singleton method to call through a proxy instance so that it gets the full range of features specified in the documentation for url_for.

Allow the definition of custom url helpers that will be available automatically wherever standard url helpers are available. The current solution is to create helper methods in ApplicationHelper or some other helper module and this isn't a great solution since the url helper module can be called directly or included in another class which doesn't include the normal helper modules. Reference #22512.

Allow the use of `direct` to specify custom mappings for polymorphic_url, e.g: resource :basket direct(class: "Basket") { [:basket] } This will then generate the following: >> link_to "Basket", @Basket => <a href="/basket">Basket</a> More importantly it will generate the correct url when used with `form_for`. Fixes #1769.

Using `undef_method` means that when a route is removed any other implementations of that method in the ancestor chain are inaccessible so instead use `remove_method` which restores access to the ancestor.

Use a separate method called `resolve` for the custom polymorphic mapping to clarify the API.

The column information for the testings table was being cached so clear the cache in the test teardown.

jrochkind · 2017-02-25T14:13:26Z

actionpack/CHANGELOG.md

+    ``` ruby
+    resource :basket
+    direct(class: "Basket") { [:basket] }
+    ```


Is this a typo, it says "Add the resolve" method, but then the example uses direct not resolve. Not sure if the example is valid as it is and is demonstrating direct, or if it's a typo and the example is demonstrating resolve. Trying to figure out these new features.

It’s corrected in master.

It was almost fixed in master - it is now 😄

sunnyrjuneja · 2017-03-20T19:25:54Z

@pixeltrix Hey, great work on this PR. Was just reviewing the RC to see what's new in Rails 5.1. Personally, I found your direct example to be very easy to understand and illustrative. However, I wasn't able to totally grok why and when for resolve. Just some feedback. Thanks again for your hard work.

@pixeltrix

A long-standing bug has been fixed in Rails 5.1 by @pixeltrix See https://github.com/rails/rails/blame/5-1-stable/actionpack/CHANGELOG.md#L52-L64 This PR updates the guides accordingly. Before: <img width="799" alt="before" src="https://cloud.githubusercontent.com/assets/10076/24809105/4ec7066c-1b73-11e7-98c6-c709c3465306.png"> After: <img width="799" alt="after" src="https://cloud.githubusercontent.com/assets/10076/24809109/50b21188-1b73-11e7-8a1a-32c3d0ed512a.png">

adammiribyan · 2018-02-26T10:47:21Z

@sunnyrjuneja the tests contain a quite illustrative example for resolve.

rafaelfranca reviewed Jan 20, 2016
View reviewed changes

maclover7 added actionpack routing labels Jan 20, 2016

maclover7 added this to the 5.0.0 milestone Jan 20, 2016

dhh reviewed Jan 24, 2016
View reviewed changes

kaspth mentioned this pull request Feb 7, 2016

Add singular resource support for form_for #23535

Closed

dhh assigned pixeltrix Feb 10, 2016

rafaelfranca mentioned this pull request Feb 11, 2016

link_to / form_for doesn't work for singular resource #1769

Closed

pixeltrix force-pushed the custom-url-helpers-and-polymorphic-urls branch from 3c0ff72 to 419c715 Compare February 23, 2016 09:54

pixeltrix modified the milestones: 5.0.0 [temp], 5.0.0 Feb 23, 2016

rafaelfranca removed this from the 5.0.0 [temp] milestone Apr 5, 2016

pixeltrix force-pushed the custom-url-helpers-and-polymorphic-urls branch 4 times, most recently from 6499cdd to 03890f3 Compare February 20, 2017 13:02

pixeltrix changed the title ~~[WIP] Implement custom url helpers and polymorphic mapping~~ Implement custom url helpers and polymorphic mapping Feb 20, 2017

maclover7 added the needs feedback label Feb 20, 2017

pixeltrix added this to the 5.1.0 milestone Feb 20, 2017

matthewd reviewed Feb 20, 2017

View reviewed changes

pixeltrix and others added 9 commits February 21, 2017 15:30

Rename url_helper to direct

47a27e8

Only accept symbols and strings for Mapper#direct

e96da0a

Don't allocate a hash unnecessarily

7d1e738

Add test for calling a url helper in Mapper#direct

d67e252

Add CHANGELOG entry for direct method

960e73a

Raise an error if direct is inside a scope block

80dcfd0

pixeltrix added 6 commits February 21, 2017 15:30

Support mapping of non-model classes

81a6761

Prefer remove_method over undef_method

c116eaf

Using `undef_method` means that when a route is removed any other implementations of that method in the ancestor chain are inaccessible so instead use `remove_method` which restores access to the ancestor.

Removed model_name method to prevent warning

050d7b1

Fix typo in exception message

ef862c0

Push option extract into call method

fbda6b9

Split direct method into two

d7c1e62

Use a separate method called `resolve` for the custom polymorphic mapping to clarify the API.

pixeltrix force-pushed the custom-url-helpers-and-polymorphic-urls branch from 8d5b711 to d7c1e62 Compare February 21, 2017 15:31

Fix schema leakage from dirty_test.rb

de24b8c

The column information for the testings table was being cached so clear the cache in the test teardown.

pixeltrix merged commit f3d729f into master Feb 21, 2017

pixeltrix deleted the custom-url-helpers-and-polymorphic-urls branch February 21, 2017 20:00

jrochkind reviewed Feb 25, 2017

View reviewed changes

matthewd mentioned this pull request Jan 22, 2018

Routes.draw#direct #22512

Closed

varyonic mentioned this pull request Sep 27, 2018

Fix polymorphic path generation for a renamed resource with a belongs_to association activeadmin/activeadmin#5483

Closed

Implement custom url helpers and polymorphic mapping #23138

Implement custom url helpers and polymorphic mapping #23138

Conversation

pixeltrix commented Jan 20, 2016 • edited Loading

pixeltrix commented Jan 20, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sunnyrjuneja commented Mar 20, 2017

adammiribyan commented Feb 26, 2018

pixeltrix commented Jan 20, 2016 •

edited

Loading