Merge pull request #37 from stasm/terms

Rename private messages to Terms

Author: stasm

fluent/syntax/ast.py

@@ -176,6 +176,15 @@ def __init__(self, id, value=None, attributes=None,
         self.attributes = attributes or []
         self.comment = comment
 
+class Term(Entry):
+    def __init__(self, id, value, attributes=None,
+                 comment=None, **kwargs):
+        super(Term, self).__init__(**kwargs)
+        self.id = id
+        self.value = value
+        self.attributes = attributes or []
+        self.comment = comment
+
 class Pattern(SyntaxNode):
     def __init__(self, elements, **kwargs):
         super(Pattern, self).__init__(**kwargs)

fluent/syntax/errors.py

@@ -18,10 +18,11 @@ def get_error_message(code, args):
     if code == 'E0004':
         return 'Expected a character from range: "{}"'.format(args[0])
     if code == 'E0005':
-        msg = 'Expected entry "{}" to have a value or attributes'
+        msg = 'Expected message "{}" to have a value or attributes'
         return msg.format(args[0])
     if code == 'E0006':
-        return 'Expected field: "{}"'.format(args[0])
+        msg = 'Expected term "{}" to have a value'
+        return msg.format(args[0])
     if code == 'E0007':
         return 'Keyword cannot end with a whitespace'
     if code == 'E0008':
@@ -32,6 +33,8 @@ def get_error_message(code, args):
         return 'Expected one of the variants to be marked as default (*)'
     if code == 'E0011':
         return 'Expected at least one variant after "->"'
+    if code == 'E0012':
+        return 'Expected value'
     if code == 'E0013':
         return 'Expected variant key'
     if code == 'E0014':
@@ -43,9 +46,9 @@ def get_error_message(code, args):
     if code == 'E0017':
         return 'Variants cannot be used as selectors'
     if code == 'E0018':
-        return 'Attributes of public messages cannot be used as selectors'
+        return 'Attributes of messages cannot be used as selectors'
     if code == 'E0019':
-        return 'Attributes of private messages cannot be used as placeables'
+        return 'Attributes of terms cannot be used as placeables'
     if code == 'E0020':
         return 'Unterminated string expression'
     return code

fluent/syntax/ftlstream.py

@@ -88,7 +88,7 @@ def is_char_id_start(self, ch=None):
         return (cc >= 97 and cc <= 122) or \
                (cc >= 65 and cc <= 90)
 
-    def is_message_id_start(self):
+    def is_entry_id_start(self):
         if self.current_is('-'):
             self.peek()
 
@@ -240,15 +240,15 @@ def skip_to_next_entry_start(self):
                 self.next()
 
                 if self.ch is None or \
-                   self.is_message_id_start() or \
+                   self.is_entry_id_start() or \
                    self.current_is('#') or \
                    (self.current_is('/') and self.peek_char_is('/')) or \
                    (self.current_is('[') and self.peek_char_is('[')):
                     break
             self.next()
 
-    def take_id_start(self, allow_private):
-        if allow_private and self.current_is('-'):
+    def take_id_start(self, allow_term):
+        if allow_term and self.current_is('-'):
             self.next()
             return '-'
 
@@ -257,7 +257,7 @@ def take_id_start(self, allow_private):
             self.next()
             return ret
 
-        allowed_range = 'a-zA-Z-' if allow_private else 'a-zA-Z'
+        allowed_range = 'a-zA-Z-' if allow_term else 'a-zA-Z'
         raise ParseError('E0004', allowed_range)
 
     def take_id_char(self):

fluent/syntax/parser.py

@@ -106,7 +106,7 @@ def get_entry(self, ps):
                 return ast.GroupComment(comment.content)
             return None
 
-        if ps.is_message_id_start() \
+        if ps.is_entry_id_start() \
            and (comment is None or isinstance(comment, ast.Comment)):
             return self.get_message(ps, comment)
 
@@ -200,7 +200,7 @@ def skip_section(self, ps):
 
     @with_span
     def get_message(self, ps, comment):
-        id = self.get_private_identifier(ps)
+        id = self.get_entry_identifier(ps)
 
         ps.skip_inline_ws()
 
@@ -215,9 +215,15 @@ def get_message(self, ps, comment):
                 ps.skip_indent()
                 pattern = self.get_pattern(ps)
 
+        if id.name.startswith('-') and pattern is None:
+            raise ParseError('E0006', id.name)
+
         if ps.is_peek_next_line_attribute_start():
             attrs = self.get_attributes(ps)
 
+        if id.name.startswith('-'):
+            return ast.Term(id, pattern, attrs, comment)
+
         if pattern is None and attrs is None:
             raise ParseError('E0005', id.name)
 
@@ -228,7 +234,7 @@ def get_attribute(self, ps):
         ps.expect_indent()
         ps.expect_char('.')
 
-        key = self.get_public_identifier(ps)
+        key = self.get_identifier(ps)
 
         ps.skip_inline_ws()
         ps.expect_char('=')
@@ -238,7 +244,7 @@ def get_attribute(self, ps):
             value = self.get_pattern(ps)
             return ast.Attribute(key, value)
 
-        raise ParseError('E0006', 'value')
+        raise ParseError('E0012')
 
     def get_attributes(self, ps):
         attrs = []
@@ -251,18 +257,14 @@ def get_attributes(self, ps):
                 break
         return attrs
 
-    @with_span
-    def get_private_identifier(self, ps):
+    def get_entry_identifier(self, ps):
         return self.get_identifier(ps, True)
 
     @with_span
-    def get_public_identifier(self, ps):
-        return self.get_identifier(ps, False)
-
-    def get_identifier(self, ps, allow_private):
+    def get_identifier(self, ps, allow_term=False):
         name = ''
 
-        name += ps.take_id_start(allow_private)
+        name += ps.take_id_start(allow_term)
 
         ch = ps.take_id_char()
         while ch:
@@ -306,7 +308,7 @@ def get_variant(self, ps, has_default):
             value = self.get_pattern(ps)
             return ast.Variant(key, value, default_index)
 
-        raise ParseError('E0006', 'value')
+        raise ParseError('E0012')
 
     def get_variants(self, ps):
         variants = []
@@ -501,7 +503,7 @@ def get_selector_expression(self, ps):
 
         if (ch == '.'):
             ps.next()
-            attr = self.get_public_identifier(ps)
+            attr = self.get_identifier(ps)
             return ast.AttributeExpression(literal.id, attr)
 
         if (ch == '['):
@@ -574,7 +576,7 @@ def get_arg_val(self, ps):
             return self.get_number(ps)
         elif ps.current_is('"'):
             return self.get_string(ps)
-        raise ParseError('E0006', 'value')
+        raise ParseError('E0012')
 
     @with_span
     def get_string(self, ps):
@@ -603,10 +605,10 @@ def get_literal(self, ps):
 
         if ch == '$':
             ps.next()
-            name = self.get_public_identifier(ps)
+            name = self.get_identifier(ps)
             return ast.ExternalArgument(name)
-        elif ps.is_message_id_start():
-            name = self.get_private_identifier(ps)
+        elif ps.is_entry_id_start():
+            name = self.get_entry_identifier(ps)
             return ast.MessageReference(name)
         elif ps.is_number_start():
             return self.get_number(ps)

fluent/syntax/serializer.py

@@ -39,6 +39,8 @@ def serialize(self, resource):
     def serialize_entry(self, entry, state=0):
         if isinstance(entry, ast.Message):
             return serialize_message(entry)
+        if isinstance(entry, ast.Term):
+            return serialize_message(entry)
         if isinstance(entry, ast.Comment):
             if state & self.HAS_ENTRIES:
                 return "\n{}\n\n".format(serialize_comment(entry))

tests/syntax/fixtures_behavior/attribute_with_empty_pattern.ftl

@@ -1,3 +1,3 @@
 key = Value
     .label =
-//~ ERROR E0006, pos 24, args "value"
+//~ ERROR E0012, pos 24

tests/syntax/fixtures_behavior/call_expression_with_wrong_value_type.ftl

@@ -1,2 +1,2 @@
 key = { BUILTIN(key: foo) }
-//~ ERROR E0006, pos 21, args "value"
+//~ ERROR E0012, pos 21

tests/syntax/fixtures_behavior/private_message.ftl renamed to tests/syntax/fixtures_behavior/term.ftl

@@ -23,3 +23,10 @@ err2 = { $-foo }
 
 err4 = { -brand() }
 //~ ERROR E0008, pos 340
+
+-err5 =
+//~ ERROR E0006, pos 351, args "-err5"
+
+-err6 =
+    .attr = Attribute
+//~ ERROR E0006, pos 360, args "-err6"

tests/syntax/fixtures_behavior/variant_with_empty_pattern.ftl

@@ -5,4 +5,4 @@ key1 = {
 err1 = {
     *[one]
     }
-//~ ERROR E0006, pos 51, args "value"
+//~ ERROR E0012, pos 51

tests/syntax/fixtures_structure/attribute_with_empty_pattern.json

@@ -6,11 +6,9 @@
       "annotations": [
         {
           "type": "Annotation",
-          "code": "E0006",
-          "args": [
-            "value"
-          ],
-          "message": "Expected field: \"value\"",
+          "code": "E0012",
+          "args": [],
+          "message": "Expected value",
           "span": {
             "type": "Span",
             "start": 26,
@@ -30,11 +28,9 @@
       "annotations": [
         {
           "type": "Annotation",
-          "code": "E0006",
-          "args": [
-            "value"
-          ],
-          "message": "Expected field: \"value\"",
+          "code": "E0012",
+          "args": [],
+          "message": "Expected value",
           "span": {
             "type": "Span",
             "start": 46,
@@ -54,11 +50,9 @@
       "annotations": [
         {
           "type": "Annotation",
-          "code": "E0006",
-          "args": [
-            "value"
-          ],
-          "message": "Expected field: \"value\"",
+          "code": "E0012",
+          "args": [],
+          "message": "Expected value",
           "span": {
             "type": "Span",
             "start": 87,
@@ -78,11 +72,9 @@
       "annotations": [
         {
           "type": "Annotation",
-          "code": "E0006",
-          "args": [
-            "value"
-          ],
-          "message": "Expected field: \"value\"",
+          "code": "E0012",
+          "args": [],
+          "message": "Expected value",
           "span": {
             "type": "Span",
             "start": 108,
@@ -102,11 +94,9 @@
       "annotations": [
         {
           "type": "Annotation",
-          "code": "E0006",
-          "args": [
-            "value"
-          ],
-          "message": "Expected field: \"value\"",
+          "code": "E0012",
+          "args": [],
+          "message": "Expected value",
           "span": {
             "type": "Span",
             "start": 149,