Merge pull request #9 from alerque/place-for-placables

Author: alerque

fluent/parser.lua

@@ -48,12 +48,12 @@ local ftl_grammar = epnf.define(function (_ENV)
   Variant = line_end * blank^-1 * V"VariantKey" * blank_inline^-1 * V"Pattern"
   DefaultVariant = line_end * blank^-1 * P"*" * V"VariantKey" * blank_inline^-1 * V"Pattern"
   VariantKey = P"[" * blank^-1 * (V"NumberLiteral" + V"Identifier") * blank^-1 * P"]"
-  NumberLiteral = P"-"^-1 * digits * (P"." * digits)^-1
+  NumberLiteral = Cg(C(P"-"^-1 * digits * (P"." * digits)^-1), "value")
   local inline_placeable = P"{" * blank^-1 * (V"SelectExpression" + V"InlineExpression") * blank^-1 * P"}"
   local block_placeable = blank_block * blank_inline^-1 * inline_placeable
   local inline_text = text_char^1
   local block_text = blank_block * blank_inline * indented_char * inline_text^-1
-  StringLiteral = P'"' * quoted_char^0 * P'"'
+  StringLiteral = P'"' * Cg(C(quoted_char^0), "value") * P'"'
   FunctionReference = V"Identifier" * V"CallArguments"
   MessageReference = V"Identifier" * V"AttributeAccessor"^-1
   TermReference = P"-" * V"Identifier" * V"AttributeAccessor"^-1 * V"CallArguments"^-1
@@ -65,10 +65,10 @@ local ftl_grammar = epnf.define(function (_ENV)
   CallArguments = blank^-1 * P"(" * blank^-1 * argument_list * blank^-1 * P")"
   SelectExpression = V"InlineExpression" * blank^-1 * P"->" * blank_inline^-1 * variant_list
   InlineExpression = V"StringLiteral" + V"NumberLiteral" + V"FunctionReference" + V"MessageReference" + V"TermReference" + V"VariableReference" + inline_placeable
-  PatternElement = Cg(C(inline_text + block_text + inline_placeable + block_placeable), "value")
+  PatternElement = Cg(C(inline_text + block_text), "value") + Cg(inline_placeable + block_placeable, "expression")
   Pattern = V"PatternElement"^1
   Attribute = line_end * blank^-1 * P"." * V"Identifier" * blank_inline^-1 * "=" * blank_inline^-1 * V"Pattern"
-  local junk_line =  (1-line_end)^0 * (P"\n" + P(nulleof))
+  local junk_line = (1-line_end)^0 * (P"\n" + P(nulleof))
   Junk = Cg(junk_line * (junk_line - P"#" - P"-" - R("az","AZ"))^0, "content")
   local comment_char = any_char - line_end
   CommentLine = Cg(P"###" + P"##" + P"#", "sigil") * (" " * Cg(C(comment_char^0), "content"))^-1 * line_end

fluent/resource.lua

@@ -22,39 +22,33 @@ local FluentNode = class({
           end
         end
       end
-      if (node[1] and #node > 0) then
-        self.elements = {}
-        tablex.insertvalues(self.elements, tablex.imap(node_to_type, node))
+      tablex.foreachi(node, function (n) self:insert(node_to_type(n)) end)
+    end,
+
+    insert = function (self, node)
+      if type(node) ~= "table" then return nil end
+      if node:is_a(node_types.Identifier) then
+        self.id = node
+      elseif node:is_a(node_types.Pattern) then
+        self.value = node
+      else
+        if not self.elements then self.elements = {} end
+        table.insert(self.elements, node)
       end
     end,
 
     dump_ast = function (self)
       local ast = { type = self.type }
       for k, v in pairs(self) do ast[k] = v end
-      ast.identifier = nil
       return ast
     end,
 
     append = function (self, node)
-      if type(self.__add) == "function"
-          and self.appendable
-          and node.appendable
-          and self:is_a(node:is_a())
-        then
-        return self + node
-      else
-        return false
-      end
+      return node and type(node.__add) == "function" and self + node
     end,
 
     attach = function (self, node)
-      if node and
-          type(node.__mul) == "function"
-        then
-        return node * self
-      else
-        return false
-      end
+      return node and type(node.__mul) == "function" and self * node
     end
 
   })
@@ -84,17 +78,6 @@ node_types.Message = class({
     _base = FluentNode,
     _init = function (self, node)
       self:super(node)
-      for key, value in ipairs(self.elements) do
-        if value:is_a(node_types.Identifier) then
-          self.identifier = value.name
-          self.id = value
-          self.elements[key] = nil
-        elseif value:is_a(node_types.Pattern) then
-          self.value = value
-          self.elements[key] = nil
-        end
-      end
-      if #self.elements == 0 then self.elements = nil end
       self.attributes = {}
     end,
     format = function (self, parameters)
@@ -145,24 +128,63 @@ node_types.TextElement = class({
     appendable = true,
     _base = FluentNode,
     _init = function (self, node)
+      node.id = "TextElement"
       self:super(node)
     end
   })
 
+node_types.Placeable = class({
+    appendable = true,
+    _base = FluentNode,
+    _init = function (self, node)
+      node.id = "Placeable"
+      self:super(node)
+      if node.expression then
+        self.expression = node_to_type(node.expression[1])
+      end
+    end
+  })
+
 node_types.PatternElement = function (node)
-  node.id = "TextElement"
-  return node_types.TextElement(node)
+  if node.value then
+    return node_types.TextElement(node)
+  else
+    return node_types.Placeable(node)
+  end
 end
 
+node_types.StringLiteral = class({
+    _base = FluentNode,
+    _init = function (self, node)
+      self:super(node)
+    end
+  })
+
+node_types.NumberLiteral = class({
+    _base = FluentNode,
+    _init = function (self, node)
+      self:super(node)
+    end
+  })
+
+node_types.VariableReference = class({
+    _base = FluentNode,
+    _init = function (self, node)
+      self:super(node)
+    end
+  })
+
 node_types.Comment = class({
     appendable = true,
     _base = FluentNode,
     _init = function (self, node)
       self:super(node)
     end,
     __add = function (self, node)
-      self.content = (self.content or "") .. "\n" .. (node.content or "")
-      return self
+      if self:is_a(node:is_a()) and self.appendable and node.appendable then
+        self.content = (self.content or "") .. "\n" .. (node.content or "")
+        return self
+      end
     end,
     __mul = function (self, node)
       if self:is_a(node_types.Message) then
@@ -208,8 +230,9 @@ node_types.CommentLine = function(node)
 end
 
 node_to_type = function (node)
-  if type(node.id) ~= "string" then return nil end
-  return node_types[node.id](node)
+  if type(node) == "table" and type(node.id) == "string" then
+    return node_types[node.id](node)
+  end
 end
 
 dedent = function (content)
@@ -273,7 +296,7 @@ local FluentResource = class({
     insert = function (self, node)
       table.insert(self.body, node)
       if node:is_a(node_types.Message) then
-        self.index[node.identifier] = #self.body
+        self.index[node.id.name] = #self.body
       end
     end,
 
@@ -288,6 +311,7 @@ local FluentResource = class({
     end,
 
     __add = function (self, resource)
+      if not self:is_a(resource:is_a()) then error("Cannot merge unlike types") end
       for _, node in ipairs(resource.body) do
         self:insert(node)
       end

spec/fixtures_spec.lua

@@ -36,7 +36,7 @@ describe('upstream reference fixture', function ()
         -- or fname:match("/escaped_characters.ftl$")
         or fname:match("/junk.ftl$")
         -- or fname:match("/leading_dots.ftl$")
-        -- or fname:match("/literal_expressions.ftl$")
+        or fname:match("/literal_expressions.ftl$")
         -- or fname:match("/member_expressions.ftl$")
         -- or fname:match("/messages.ftl$")
         -- or fname:match("/mixed_entries.ftl$")
@@ -51,7 +51,7 @@ describe('upstream reference fixture', function ()
         or fname:match("/tab.ftl$")
         -- or fname:match("/term_parameters.ftl$")
         -- or fname:match("/terms.ftl$")
-        -- or fname:match("/variables.ftl$")
+        or fname:match("/variables.ftl$")
         -- or fname:match("/variant_keys.ftl$")
         -- or fname:match("/whitespace_in_value.ftl$")
         or fname:match("/zero_length.ftl$")
@@ -143,7 +143,7 @@ describe('upstream structure fixture', function ()
         -- or fname:match("/term.ftl")
         or fname:match("/term_with_empty_pattern.ftl")
         or fname:match("/unclosed_empty_placeable_error.ftl")
-        -- or fname:match("/unclosed.ftl")
+        -- -- or fname:match("/unclosed.ftl") -- see https://github.com/projectfluent/fluent/issues/296
         or fname:match("/unknown_entry_start.ftl")
         or fname:match("/variant_ends_abruptly.ftl")
         -- or fname:match("/variant_keys.ftl")

spec/fluent_syntax_spec.lua

@@ -49,15 +49,29 @@ describe('fluent.syntax', function ()
       assert.equals("Pattern", foobaz.body[1].value.type)
     end)
 
-    it('should handle complex term entries', function ()
+    it('should handle multiline entries', function ()
       local foo = syntax:parsestring("foo = türkçe\n görüşürüz")
       assert.equals("Pattern", foo.body[1].value.type)
     end)
 
+    it('should handle literal string placables', function ()
+      local foo = syntax:parsestring('foo = bar {"baz"}')
+      assert.equals(2, #foo.body[1].value.elements)
+      assert.equals("TextElement", foo.body[1].value.elements[1].type)
+      assert.equals("Placeable", foo.body[1].value.elements[2].type)
+    end)
+
+    it('should handle literal number placables', function ()
+      local foo = syntax:parsestring('foo = bar {-54.3}')
+      assert.equals(2, #foo.body[1].value.elements)
+      assert.equals("TextElement", foo.body[1].value.elements[1].type)
+      assert.equals("Placeable", foo.body[1].value.elements[2].type)
+    end)
+
     it('should handle simple comments', function ()
-      assert.same("Comment", syntax:parsestring("# foo").body[1].type)
-      assert.same("GroupComment", syntax:parsestring("## foo").body[1].type)
-      assert.same("ResourceComment", syntax:parsestring("### foo").body[1].type)
+      assert.equals("Comment", syntax:parsestring("# foo").body[1].type)
+      assert.equals("GroupComment", syntax:parsestring("## foo").body[1].type)
+      assert.equals("ResourceComment", syntax:parsestring("### foo").body[1].type)
     end)
 
     it('should handle junk', function ()