Test the i18n tags.

Author: nedbat

README.rst

@@ -40,6 +40,9 @@ Caveats
 
 The `{% ssi %}` tag does not trace the files it includes.
 
+Coverage can't tell whether a `{% blocktrans %}` tag used the singular or
+plural text, so both are marked as used if the tag is used.
+
 
 What the? How?
 --------------

django_coverage_plugin/plugin.py

@@ -13,6 +13,7 @@
     Lexer, TextNode,
     TOKEN_BLOCK, TOKEN_MAPPING, TOKEN_TEXT, TOKEN_VAR,
     )
+from django.templatetags.i18n import BlockTranslateNode
 try:
     from django.template.defaulttags import VerbatimNode
 except ImportError:
@@ -62,8 +63,7 @@ def sys_info(self):
 
     def file_tracer(self, filename):
         if filename.startswith(self.django_template_dir):
-            if "templatetags" not in filename:
-                return self
+            return self
         return None
 
     def file_reporter(self, filename):
@@ -111,6 +111,12 @@ def line_number_range(self, frame):
             # to the end of the {% verbatim %} opening tag, not the entire
             # content. Adjust it to cover all of it.
             s_end += len(render_self.content)
+        elif isinstance(render_self, BlockTranslateNode):
+            # BlockTranslateNode has a list of text and variable tokens.
+            # Get the end of the contents by looking at the last token,
+            # and use its endpoint.
+            last_tokens = render_self.plural or render_self.singular
+            s_end = last_tokens[-1].source[1][1]
         line_map = self.get_line_map(source[0].name)
         start = get_line_number(line_map, s_start)
         end = get_line_number(line_map, s_end-1)

tests/test_i18n.py

@@ -0,0 +1,50 @@
+"""Tests of i18n tags for django_coverage_plugin."""
+
+from .plugin_test import DjangoPluginTestCase
+
+
+class I18nTest(DjangoPluginTestCase):
+
+    def test_trans(self):
+        self.make_template("""\
+            {% load i18n %}
+            Hello
+            {% trans "World" %}
+            done.
+            """)
+        text = self.run_django_coverage()
+        self.assertEqual(text, "\nHello\nWorld\ndone.\n")
+        self.assert_analysis([1, 2, 3, 4])
+
+    def test_blocktrans(self):
+        self.make_template("""\
+            {% load i18n %}
+            Hello
+            {% blocktrans with where="world" %}
+            to {{ where }}.
+            {% endblocktrans %}
+            bye.
+            """)
+        text = self.run_django_coverage()
+        self.assertEqual(text, "\nHello\n\nto world.\n\nbye.\n")
+        self.assert_analysis([1, 2, 3, 4, 6])
+
+    def test_blocktrans_plural(self):
+        self.make_template("""\
+            {% load i18n %}
+            {% blocktrans count counter=cats|length %}
+            There is one cat.
+            {% plural %}
+            There are {{ counter }} cats.
+            {% endblocktrans %}
+            bye.
+            """)
+        # It doesn't make a difference whether you use the plural or not, we
+        # can't tell, so the singluar and plural are always marked as used.
+        text = self.run_django_coverage(context={'cats': ['snowy']})
+        self.assertEqual(text, "\n\nThere is one cat.\n\nbye.\n")
+        self.assert_analysis([1, 2, 3, 4, 5, 7])
+
+        text = self.run_django_coverage(context={'cats': ['snowy', 'coaly']})
+        self.assertEqual(text, "\n\nThere are 2 cats.\n\nbye.\n")
+        self.assert_analysis([1, 2, 3, 4, 5, 7])