Making sure we return the right path for a rails engine that doesn't have additional namespaces

Author: nathanpalmer

lib/jsonapi/link_builder.rb

@@ -95,7 +95,12 @@ def engine_resources_path_name_from_class(klass)
       scopes         = module_scopes_from_class(klass)[1..-1]
       base_path_name = scopes.map { |scope| scope.underscore }.join("_")
       end_path_name  = klass._type.to_s
-      "#{ base_path_name }_#{ end_path_name }_path"
+
+      if base_path_name.blank?
+        "#{ end_path_name }_path"
+      else
+        "#{ base_path_name }_#{ end_path_name }_path"
+      end
     end
 
     def format_route(route)

test/fixtures/active_record.rb

@@ -1623,6 +1623,11 @@ class PersonResource < JSONAPI::Resource
   end
 end
 
+module ApiV2Engine
+  class PersonResource < JSONAPI::Resource
+  end
+end
+
 module Legacy
   class FlatPost < ActiveRecord::Base
     self.table_name = "posts"

test/test_helper.rb

@@ -65,6 +65,12 @@ class Engine < ::Rails::Engine
   end
 end
 
+module ApiV2Engine
+  class Engine < ::Rails::Engine
+    isolate_namespace ApiV2Engine
+  end
+end
+
 # Monkeypatch ActionController::TestCase to delete the RAW_POST_DATA on subsequent calls in the same test.
 if Rails::VERSION::MAJOR >= 5
   module ClearRawPostHeader
@@ -362,6 +368,7 @@ class CatResource < JSONAPI::Resource
   end
 
   mount MyEngine::Engine => "/boomshaka", as: :my_engine
+  mount ApiV2Engine::Engine => "/api_v2", as: :api_v2_engine
 end
 
 MyEngine::Engine.routes.draw do
@@ -384,6 +391,10 @@ class CatResource < JSONAPI::Resource
   end
 end
 
+ApiV2Engine::Engine.routes.draw do
+  jsonapi_resources :people
+end
+
 # Ensure backward compatibility with Minitest 4
 Minitest::Test = MiniTest::Unit::TestCase unless defined?(Minitest::Test)
 

test/unit/serializer/link_builder_test.rb

@@ -19,6 +19,10 @@ def test_engine_boolean
       primary_resource_klass: MyEngine::Api::V1::PersonResource
     ).engine?, "MyEngine should be considered an Engine"
 
+    assert JSONAPI::LinkBuilder.new(
+      primary_resource_klass: ApiV2Engine::PersonResource
+    ).engine?, "ApiV2 shouldn't be considered an Engine"
+
     refute JSONAPI::LinkBuilder.new(
       primary_resource_klass: Api::V1::PersonResource
     ).engine?, "Api shouldn't be considered an Engine"
@@ -30,6 +34,11 @@ def test_engine_name
         primary_resource_klass: MyEngine::Api::V1::PersonResource
     ).engine_name
 
+    assert_equal ApiV2Engine::Engine,
+      JSONAPI::LinkBuilder.new(
+        primary_resource_klass: ApiV2Engine::PersonResource
+    ).engine_name
+
     assert_equal nil,
       JSONAPI::LinkBuilder.new(
         primary_resource_klass: Api::V1::PersonResource
@@ -53,6 +62,22 @@ def test_self_link_regular_app
   end
 
   def test_self_link_with_engine_app
+    primary_resource_klass = ApiV2Engine::PersonResource
+
+    config = {
+      base_url: @base_url,
+      route_formatter: @route_formatter,
+      primary_resource_klass: primary_resource_klass,
+    }
+
+    builder = JSONAPI::LinkBuilder.new(config)
+    source  = primary_resource_klass.new(@steve, nil)
+    expected_link = "#{ @base_url }/api_v2/people/#{ source.id }"
+
+    assert_equal expected_link, builder.self_link(source)
+  end
+
+  def test_self_link_with_engine_namespaced_app
     primary_resource_klass = MyEngine::Api::V1::PersonResource
 
     config = {
@@ -98,6 +123,19 @@ def test_primary_resources_url_for_regular_app
   end
 
   def test_primary_resources_url_for_engine
+    config = {
+      base_url: @base_url,
+      route_formatter: @route_formatter,
+      primary_resource_klass: ApiV2Engine::PersonResource
+    }
+
+    builder = JSONAPI::LinkBuilder.new(config)
+    expected_link = "#{ @base_url }/api_v2/people"
+
+    assert_equal expected_link, builder.primary_resources_url
+  end
+
+  def test_primary_resources_url_for_namespaced_engine
     config = {
       base_url: @base_url,
       route_formatter: @route_formatter,
@@ -127,6 +165,22 @@ def test_relationships_self_link_for_regular_app
   end
 
   def test_relationships_self_link_for_engine
+    config = {
+      base_url: @base_url,
+      route_formatter: @route_formatter,
+      primary_resource_klass: ApiV2Engine::PersonResource
+    }
+
+    builder       = JSONAPI::LinkBuilder.new(config)
+    source        = ApiV2Engine::PersonResource.new(@steve, nil)
+    relationship  = JSONAPI::Relationship::ToMany.new("posts", {})
+    expected_link = "#{ @base_url }/api_v2/people/#{ @steve.id }/relationships/posts"
+
+    assert_equal expected_link,
+      builder.relationships_self_link(source, relationship)
+  end
+
+  def test_relationships_self_link_for_namespaced_engine
     config = {
       base_url: @base_url,
       route_formatter: @route_formatter,
@@ -159,6 +213,22 @@ def test_relationships_related_link_for_regular_app
   end
 
   def test_relationships_related_link_for_engine
+    config = {
+      base_url: @base_url,
+      route_formatter: @route_formatter,
+      primary_resource_klass: ApiV2Engine::PersonResource
+    }
+
+    builder       = JSONAPI::LinkBuilder.new(config)
+    source        = ApiV2Engine::PersonResource.new(@steve, nil)
+    relationship  = JSONAPI::Relationship::ToMany.new("posts", {})
+    expected_link = "#{ @base_url }/api_v2/people/#{ @steve.id }/posts"
+
+    assert_equal expected_link,
+      builder.relationships_related_link(source, relationship)
+  end
+
+  def test_relationships_related_link_for_namespaced_engine
     config = {
       base_url: @base_url,
       route_formatter: @route_formatter,
@@ -234,6 +304,20 @@ def test_query_link_for_regular_app_with_dasherized_scope
   end
 
   def test_query_link_for_engine
+    config = {
+      base_url: @base_url,
+      route_formatter: @route_formatter,
+      primary_resource_klass: ApiV2Engine::PersonResource
+    }
+
+    query         = { page: { offset: 0, limit: 12 } }
+    builder       = JSONAPI::LinkBuilder.new(config)
+    expected_link = "#{ @base_url }/api_v2/people?page%5Blimit%5D=12&page%5Boffset%5D=0"
+
+    assert_equal expected_link, builder.query_link(query)
+  end
+
+  def test_query_link_for_namespaced_engine
     config = {
       base_url: @base_url,
       route_formatter: @route_formatter,