Scope related route names in a similar manner to relationship routes

This dodges an issue where the related route names might conflict with
index routes (e.g. a List that `has_many :items, class_name: 'ListItem'`
would have previously used `list_items` for the related resources and
conflict with the `list_items` index route for the ListItem class`)

Author: reidab

lib/jsonapi/link_builder.rb

@@ -150,12 +150,14 @@ def resource_url_helper_name_from_source(source)
 
     def related_url_helper_name(relationship)
       relationship_parts = resource_path_parts_from_class(relationship.parent_resource)
+      relationship_parts << "related"
       relationship_parts << relationship.name
       url_helper_name_from_parts(relationship_parts)
     end
 
     def singleton_related_url_helper_name(relationship)
       relationship_parts = []
+      relationship_parts << "related"
       relationship_parts << relationship.name
       relationship_parts += resource_path_parts_from_class(relationship.parent_resource)
       url_helper_name_from_parts(relationship_parts)

lib/jsonapi/routing_ext.rb

@@ -235,7 +235,7 @@ def jsonapi_related_resource(*relationship)
           match formatted_relationship_name, controller: options[:controller],
                 relationship: relationship.name, source: resource_type_with_module_prefix(source._type),
                 action: 'get_related_resource', via: [:get],
-                as: relationship_name
+                as: "related/#{relationship_name}"
         end
 
         def jsonapi_related_resources(*relationship)
@@ -253,7 +253,7 @@ def jsonapi_related_resources(*relationship)
                 controller: options[:controller],
                 relationship: relationship.name, source: resource_type_with_module_prefix(source._type),
                 action: 'get_related_resources', via: [:get],
-                as: relationship_name
+                as: "related/#{relationship_name}"
         end
 
         protected

test/fixtures/active_record.rb

@@ -330,6 +330,14 @@
     t.string :name
     t.belongs_to :painting
   end
+
+  create_table :lists, force: true do |t|
+    t.string :name
+  end
+
+  create_table :list_items, force: true do |t|
+    t.belongs_to :list
+  end
   # special cases
 end
 
@@ -687,6 +695,15 @@ class Painting < ActiveRecord::Base
 class Collector < ActiveRecord::Base
   belongs_to :painting
 end
+
+class List < ActiveRecord::Base
+  has_many :items, class_name: 'ListItem', inverse_of: :list
+end
+
+class ListItem < ActiveRecord::Base
+  belongs_to :list, inverse_of: :items
+end
+
 ### CONTROLLERS
 class AuthorsController < JSONAPI::ResourceControllerMetal
 end
@@ -994,6 +1011,12 @@ class DoctorsController < JSONAPI::ResourceController
 class RespondentController < JSONAPI::ResourceController
 end
 
+class ListsController < JSONAPI::ResourceController
+end
+
+class ListItemsController < JSONAPI::ResourceController
+end
+
 ### RESOURCES
 class BaseResource < JSONAPI::Resource
   abstract
@@ -2081,6 +2104,14 @@ class RespondentResource < JSONAPI::Resource
   abstract
 end
 
+class ListResource < JSONAPI::Resource
+  has_many :items, class_name: 'ListItem'
+end
+
+class ListItemResource < JSONAPI::Resource
+  has_one :list
+end
+
 ### PORO Data - don't do this in a production app
 $breed_data = BreedData.new
 $breed_data.add(Breed.new(0, 'persian'))

test/integration/routes/routes_test.rb

@@ -191,6 +191,20 @@ def test_routing_author_links_posts_create_not_acts_as_set
                    {controller: 'api/v5/authors', action: 'create_relationship', author_id: '1', relationship: 'posts'})
   end
 
+  def test_routing_list_items_index
+    assert_routing({path: '/list_items', method: :get},
+                   {controller: 'list_items', action: 'index'})
+  end
+
+  def test_routing_list_related_items
+    assert_routing({path: '/lists/1/items', method: :get},
+                   {controller: 'list_items', action: 'get_related_resources', relationship: 'items', list_id: '1', source: 'lists'})
+  end
+
+  def test_list_items_route_helper_name
+    assert_equal(list_items_path, '/list_items')
+  end
+
   #primary_key
   def test_routing_primary_key_jsonapi_resources
     assert_routing({path: '/iso_currencies/USD', method: :get},

test/test_helper.rb

@@ -268,6 +268,9 @@ class CatResource < JSONAPI::Resource
   jsonapi_resources :employees
   jsonapi_resources :web_pages
 
+  jsonapi_resources :lists
+  jsonapi_resources :list_items
+
   jsonapi_resources :person_with_even_and_odd_posts
 
   namespace :api do