Merge cc5859e2be into d404597e0b

rest_framework/routers.py

@@ -217,16 +217,18 @@ class SimpleRouter(BaseRouter):
 
         https://github.com/alanjds/drf-nested-routers
         """
-        base_regex = '(?P<{lookup_prefix}{lookup_url_kwarg}>{lookup_value})'
+        base_regex = '{pre_lookup_prefix}(?P<{lookup_prefix}{lookup_url_kwarg}>{lookup_value})'
         # Use `pk` as default field, unset set.  Default regex should not
         # consume `.json` style suffixes and should break at '/' boundaries.
         lookup_field = getattr(viewset, 'lookup_field', 'pk')
         lookup_url_kwarg = getattr(viewset, 'lookup_url_kwarg', None) or lookup_field
         lookup_value = getattr(viewset, 'lookup_value_regex', '[^/.]+')
+        pre_lookup_prefix = getattr(viewset, 'pre_lookup_prefix', '')
         return base_regex.format(
             lookup_prefix=lookup_prefix,
             lookup_url_kwarg=lookup_url_kwarg,
-            lookup_value=lookup_value
+            lookup_value=lookup_value,
+            pre_lookup_prefix=pre_lookup_prefix
         )
 
     def get_urls(self):

tests/test_routers.py

@@ -47,6 +47,22 @@ class MockViewSet(viewsets.ModelViewSet):
     serializer_class = None
 
 
+class SomeActionViewSet(viewsets.ModelViewSet):
+    queryset = RouterTestModel.objects.all()
+    serializer_class = NoteSerializer
+    lookup_field = 'text'
+
+    @list_route()
+    def some_action(self, request, *args, **kwargs):
+        return Response({
+            'view_name': 'some_action'
+        })
+
+
+class PrefixedLookupViewSet(SomeActionViewSet):
+    pre_lookup_prefix = '~'
+
+
 notes_router = SimpleRouter()
 notes_router.register(r'notes', NoteViewSet)
 
@@ -56,11 +72,26 @@ kwarged_notes_router.register(r'notes', KWargedNoteViewSet)
 namespaced_router = DefaultRouter()
 namespaced_router.register(r'example', MockViewSet, base_name='example')
 
+prefixed_lookups_router = DefaultRouter()
+prefixed_lookups_router.register(r'clashing', SomeActionViewSet)
+prefixed_lookups_router.register(r'example', PrefixedLookupViewSet)
+
+reordered_router = DefaultRouter()
+reordered_router.routes = [
+    SimpleRouter.routes[0],
+    SimpleRouter.routes[2],  # detail route place before dynamic list routes
+    SimpleRouter.routes[1],  # dynamic list route place after detail route
+    SimpleRouter.routes[3],
+]
+reordered_router.register(r'clashing', SomeActionViewSet)
+
 urlpatterns = [
     url(r'^non-namespaced/', include(namespaced_router.urls)),
     url(r'^namespaced/', include(namespaced_router.urls, namespace='example')),
     url(r'^example/', include(notes_router.urls)),
     url(r'^example2/', include(kwarged_notes_router.urls)),
+    url(r'^prefixed/', include(prefixed_lookups_router.urls)),
+    url(r'^reordered/', include(reordered_router.urls)),
 ]
 
 
@@ -215,6 +246,70 @@ class TestLookupUrlKwargs(TestCase):
         )
 
 
+class TestPreLookupPrefixes(TestCase):
+
+    urls = 'tests.test_routers'
+
+    def setUp(self):
+        self.obj = RouterTestModel.objects.create(
+            uuid='123',
+            text='some_action'
+        )
+
+    def test_clashing_with_routes_order_as_is(self):
+        """
+        Demonstrates that we cannot access instance.
+        """
+        response = self.client.get('/prefixed/clashing/some_action/')
+        self.assertEqual(
+            response.data,
+            {
+                'view_name': 'some_action'
+            }
+        )
+
+    def test_clashing_with_routes_reordered(self):
+        """
+        Demonstrates that we cannot access view.
+        """
+        response = self.client.get('/reordered/clashing/some_action/')
+        self.assertEqual(
+            response.data,
+            {
+                "url": "http://testserver/example/notes/123/",
+                "uuid": "123", "text": "some_action"
+            }
+        )
+        self.obj.delete()
+        response = self.client.get('/reordered/clashing/some_action/')
+        self.assertEqual(
+            response.data,
+            {
+                'detail': 'Not found.'
+            }
+        )
+
+    def test_prefixed_lookup(self):
+        """
+        Demonstrates how prefixing helps to get rid of clashing
+        """
+        response = self.client.get('/prefixed/example/~some_action/')
+        self.assertEqual(
+            response.data,
+            {
+                "url": "http://testserver/example/notes/123/",
+                "uuid": "123", "text": "some_action"
+            }
+        )
+        response = self.client.get('/prefixed/clashing/some_action/')
+        self.assertEqual(
+            response.data,
+            {
+                'view_name': 'some_action'
+            }
+        )
+
+
 class TestTrailingSlashIncluded(TestCase):
     def setUp(self):
         class NoteViewSet(viewsets.ModelViewSet):