closes #65 - generated code compiles and leaves more informative comment

Author: bckohan

doc/requirements.txt

@@ -6,4 +6,4 @@ sphinxcontrib-htmlhelp==2.0.0; python_version >= "3.5"
 sphinxcontrib-jsmath==1.0.1; python_version >= "3.5"
 sphinxcontrib-qthelp==1.0.3; python_version >= "3.5"
 sphinxcontrib-serializinghtml==1.1.5; python_version >= "3.5"
-django-render-static==1.1.3
+django-render-static==1.1.4

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "django-render-static"
-version = "1.1.3"
+version = "1.1.4"
 description = "Use Django's template engine to render static files at deployment time. Extend Django's url reverse mechanism to JavaScript."
 authors = ["Brian Kohan <[email protected]>"]
 license = "MIT"

render_static/__init__.py

@@ -10,7 +10,7 @@
 from .resource import resource
 from .url_tree import ClassURLWriter, SimpleURLWriter, URLTreeVisitor
 
-VERSION = (1, 1, 3)
+VERSION = (1, 1, 4)
 
 __title__ = 'Django Render Static'
 __version__ = '.'.join(str(i) for i in VERSION)

render_static/tests/tests.py

@@ -3385,3 +3385,59 @@ def test_generate_examples(self):
     def tearDown(self):
         pass
 """
+
+
+@override_settings(
+    ROOT_URLCONF='render_static.tests.urls_bug_65',
+    STATIC_TEMPLATES={
+        'ENGINES': [{
+            'BACKEND': 'render_static.backends.StaticDjangoTemplates',
+            'OPTIONS': {
+                'loaders': [
+                    ('render_static.loaders.StaticLocMemLoader', {
+                        'urls.js': (
+                            '{% urls_to_js '
+                            'visitor="render_static.ClassURLWriter" %}'
+                        )
+                    })
+                ],
+                'builtins': ['render_static.templatetags.render_static']
+            },
+        }],
+        'templates': {'urls.js': {'context': {}}}
+    }
+)
+class Bug65TestCase(URLJavascriptMixin, BaseTestCase):
+
+    def setUp(self):
+        self.clear_placeholder_registries()
+
+    def tearDown(self):
+        pass
+
+    def test_bug_65_compiles(self):
+        """
+        Tests: https://github.com/bckohan/django-render-static/issues/65
+        Just test that urls_to_js spits out code that compiles now.
+        This issue will be further addressed by
+        https://github.com/bckohan/django-render-static/issues/66
+        """
+        self.es6_mode = True
+        self.url_js = None
+        self.class_mode = ClassURLWriter.class_name_
+
+        call_command('renderstatic', 'urls.js')
+
+        from django.urls import reverse
+        for kwargs in [
+            {},
+            # {'url_param': 3},
+            # {'url_param': 1, 'kwarg_param': '1'},
+            # {'url_param': 2, 'kwarg_param': '2'},
+            # {'url_param': 4, 'kwarg_param': '4'},
+            # {'url_param': 4, 'kwarg_param': 1}
+        ]:
+            self.assertEqual(
+                reverse('bug65', kwargs=kwargs),
+                self.get_url_from_js('bug65', kwargs)
+            )

render_static/tests/urls_bug_65.py

@@ -0,0 +1,40 @@
+"""
+Reproduce: https://github.com/bckohan/django-render-static/issues/65
+"""
+from .views import TestView
+from django.urls import path
+
+
+urlpatterns = [
+    path(
+        'prefix/<int:url_param>/postfix',
+        TestView.as_view(),
+        kwargs={'kwarg_param': '1'},
+        name='bug65'
+    ),
+    path(
+        'prefix/<int:url_param>/postfix/value1',
+        TestView.as_view(),
+        kwargs={'kwarg_param': '1'},
+        name='bug65'
+    ),
+    path(
+        'prefix/<int:url_param>/postfix/value2',
+        TestView.as_view(),
+        kwargs={'kwarg_param': '2'},
+        name='bug65'
+    ),
+    path(
+        'prefix',
+        TestView.as_view(),
+        kwargs={'kwarg_param': '2'},
+        name='bug65'
+    ),
+    path(
+        'prefix_int/<int:url_param>/postfix_int/<int:kwarg_param>',
+        TestView.as_view(),
+        # kwargs={'kwarg_param': 1},  adding this default breaks reversal
+        name='bug65'
+    ),
+]
+

render_static/url_tree.py

@@ -411,11 +411,28 @@ def visit_pattern(  # pylint: disable=R0914, R0915, R0912
                         # patterns where the only difference is between the use of kwargs and args
                         # we leave a comment breadcrumb in this event so as not to fail the larger
                         # URL reversal but to leave an indication as to what is wrong with the URLs
-                        yield (
-                            '/* Django reverse matched unexpected pattern for '
-                            f'args={unnamed} */' if unnamed else f'kwargs={params} */'
-                        )  # pragma: no cover
-                        return  # pragma: no cover
+                        unexpected_default_args = set(
+                            endpoint.default_args
+                        ).difference(set(params.keys()))
+                        if unexpected_default_args:
+                            yield '/**'
+                            yield " * Default kwargs, " \
+                                f"{unexpected_default_args}, are not named " \
+                                f"parameters on pattern {endpoint.pattern}."
+                            yield f" * This can cause unexpected behavior " \
+                                  f"and is not currently supported for " \
+                                  f"reversal."
+                            yield '**/'
+                        else:
+                            yield (
+                                '/* Django reverse matched unexpected pattern '
+                                'for ' +
+                                (
+                                    f'args={unnamed} */' if unnamed
+                                    else f'kwargs={list(params.keys())} */'
+                                )
+                            )  # pragma: no cover
+                        return
 
                     # there might be group matches that aren't part of our kwargs, we go
                     # through this extra work to make sure we aren't subbing spans that