Improve readability of WITH expressions #45

This add a new render_as_readable() function that will wrap the WITH
expression in parens (unless this is only a simple WITH expression)

Signed-off-by: Philippe Ombredanne <[email protected]>

Author: pombredanne

src/license_expression/__init__.py

@@ -827,6 +827,19 @@ def render(self, template='{symbol.key}', *args, **kwargs):
         """
         return NotImplementedError
 
+    def render_as_readable(self, template='{symbol.key}', *args, **kwargs):
+        """
+        Return a formatted string rendering for this expression using the
+        `template` format string to render each symbol.  Add extra parenthesis
+        around WITH sub-expressions for improved readbility. See `render()` for
+        other arguments.
+        """
+        if isinstance(self, LicenseWithExceptionSymbol):
+            return self.render(
+                template=template, wrap_in_parens=False, *args, **kwargs)
+        else:
+            return self.render(template=template, wrap_with_in_parens=True, *args, **kwargs)
+
 
 class BaseSymbol(Renderable, boolean.Symbol):
     """
@@ -1075,10 +1088,17 @@ def decompose(self):
         yield self.license_symbol
         yield self.exception_symbol
 
-    def render(self, template='{symbol.key}', *args, **kwargs):
+    def render(self, template='{symbol.key}', wrap_with_in_parens=False, *args, **kwargs):
+        """
+        Return a formatted WITH expression. If `wrap_in_parens`, wrap in parens.
+        """
         lic = self.license_symbol.render(template, *args, **kwargs)
         exc = self.exception_symbol.render(template, *args, **kwargs)
-        return '%(lic)s WITH %(exc)s' % locals()
+        if wrap_with_in_parens:
+            temp = '(%(lic)s WITH %(exc)s)'
+        else:
+            temp = '%(lic)s WITH %(exc)s'
+        return temp % locals()
 
     def __hash__(self, *args, **kwargs):
         return hash((self.license_symbol, self.exception_symbol,))

tests/test_license_expression.py

@@ -1665,6 +1665,30 @@ def test_primary_license_symbol_and_primary_license_key(self):
         assert expected == licensing.primary_license_symbol(
             parsed, decompose=False).render('{symbol.key}')
 
+    def test_render_plain(self):
+        l = Licensing()
+        result = l.parse('gpl-2.0 WITH exception-gpl-2.0-plus or MIT').render()
+        expected = 'gpl-2.0 WITH exception-gpl-2.0-plus OR MIT'
+        assert expected == result
+
+    def test_render_as_readable_does_not_wrap_in_parens_single_with(self):
+        l = Licensing()
+        result = l.parse('gpl-2.0 WITH exception-gpl-2.0-plus').render_as_readable()
+        expected = 'gpl-2.0 WITH exception-gpl-2.0-plus'
+        assert expected == result
+
+    def test_render_as_readable_wraps_in_parens_with_and_other_subexpressions(self):
+        l = Licensing()
+        result = l.parse('mit AND gpl-2.0 WITH exception-gpl-2.0-plus').render_as_readable()
+        expected = 'mit AND (gpl-2.0 WITH exception-gpl-2.0-plus)'
+        assert expected == result
+
+    def test_render_as_readable_does_not_wrap_in_parens_if_no_with(self):
+        l = Licensing()
+        result1 = l.parse('gpl-2.0 and exception OR that').render_as_readable()
+        result2 = l.parse('gpl-2.0 and exception OR that').render()
+        assert result1 == result2
+
 
 class SplitAndTokenizeTest(TestCase):