translatomatic 0.1.2 → 0.1.3

data/lib/translatomatic/resource_file/markdown.rb

@@ -1,55 +1,50 @@
-require 'kramdown'
-require 'reverse_markdown'
-
-module Translatomatic::ResourceFile
-  # Markdown resource file
-  class Markdown < HTML
-
-    # (see Translatomatic::ResourceFile::Base.extensions)
-    def self.extensions
-      %w{md}
-    end
-
-    # (see Translatomatic::ResourceFile::Base#save)
-    def save(target = path, options = {})
-      if @doc
-        begin
-          add_created_by unless options[:no_created_by]
-          html = @doc.to_html
-          # convert html back to markdown
-          markdown = ReverseMarkdown.convert(html, unknown_tags: :bypass)
-          target.write(markdown.chomp)
-        rescue Exception => e
-          log.error t("resource.error", message: e.message)
-        end
-      end
-    end
-
-    private
-
-    def add_created_by
-      @created_by ||= begin
-        body = @doc.at('body')
-        body.add_child("<p><i>#{created_by}</i></p>")
-      end
-    end
-
-    def read(path)
-      begin
-        # read markdown and convert to html
-        markdown = path.read
-        html = Kramdown::Document.new(markdown).to_html
-        # parse html with nokogiri
-        @doc = Nokogiri::HTML(html) do |config|
-          config.noblanks
-        end
-        init_nodemap(@doc)
-      rescue Exception => e
-        log.error t("resource.error", message: e.message)
-        @valid = false
-        {}
-      end
-    end
-
-  end  # class
-end    # module
+require 'kramdown'
+require 'reverse_markdown'
+
+module Translatomatic::ResourceFile
+  # Markdown resource file
+  class Markdown < HTML
+
+    # (see Translatomatic::ResourceFile::Base.extensions)
+    def self.extensions
+      %w{md}
+    end
+
+    # (see Translatomatic::ResourceFile::Base#save)
+    def save(target = path, options = {})
+      if @doc
+        add_created_by unless options[:no_created_by]
+        html = @doc.to_html
+        # convert html back to markdown
+        markdown = ReverseMarkdown.convert(html, unknown_tags: :bypass)
+        target.write(markdown.chomp)
+      end
+    end
+
+    private
+
+    def add_created_by
+      @created_by ||= begin
+        body = @doc.at('body')
+        body.add_child("<p><i>#{created_by}</i></p>")
+      end
+    end
+
+    def read_doc
+      # read markdown and convert to html
+      markdown = read_contents(@path)
+      if markdown.blank?
+        empty_doc
+      else
+        html = Kramdown::Document.new(markdown).to_html
+        # parse html with nokogiri
+        doc = Nokogiri::HTML(html) do |config|
+          config.noblanks
+        end
+        parse_error(doc.errors[0]) if doc.errors.present?
+        doc
+      end
+    end
+
+  end  # class
+end    # module

data/lib/translatomatic/resource_file/plist.rb

@@ -1,19 +1,153 @@
-module Translatomatic::ResourceFile
-  # Property list resource file
-  # @see https://en.wikipedia.org/wiki/Property_list
-  class Plist < XML
-    include Translatomatic::ResourceFile::XCodeStringsLocalePath
-
-    # (see Translatomatic::ResourceFile::Base.extensions)
-    def self.extensions
-      %w{plist}
-    end
-
-    private
-
-    def text_nodes_xpath
-      '//*[not(self::key)]/text()'
-    end
-
-  end # class
-end   # module
+module Translatomatic::ResourceFile
+  # Property list resource file
+  # @see https://en.wikipedia.org/wiki/Property_list
+  class Plist < XML
+    # property list types:
+    # array, dict, string, data, date, integer, real, boolean
+    # boolean is <true /> or <false />
+
+    include Translatomatic::ResourceFile::XCodeStringsLocalePath
+
+    # (see Translatomatic::ResourceFile::Base.extensions)
+    def self.extensions
+      %w{plist}
+    end
+
+    # (see Translatomatic::ResourceFile::Base.is_key_value?)
+    def self.is_key_value?
+      true
+    end
+
+    private
+
+    def init_nodemap
+      result = Parser.new.parse(@doc)
+      #puts "parser result:"
+      #p result
+      @flattened_data = flatten(result)
+      @nodemap = @flattened_data.transform_values { |i| i.node }
+      #puts "nodemap:"
+      #p @nodemap
+    end
+
+    def init_properties
+      @properties = @flattened_data.transform_values { |i| i.content }
+    end
+
+    def create_node(key, value)
+      # add properties to first dict found
+      dict = @doc.xpath("//dict")
+      # TODO: not sure sure what to do if dict is missing
+      raise "missing top level dictionary" unless dict.present?
+      dict = dict[0]
+
+      # add xml: <data name="key"><value>value</value></data>
+      key_node = Nokogiri::XML::Node.new("key", @doc)
+      key_node.content = key
+      value_node = Nokogiri::XML::Node.new("string", @doc)
+      value_node.content = value
+      dict.add_child(key_node)
+      dict.add_child(value_node)
+
+      @nodemap[key] = value_node
+      @properties[key] = value
+    end
+
+    def empty_doc
+      Nokogiri::XML(EMPTY_DOC)
+    end
+
+    EMPTY_DOC=<<EOM
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+  <dict>
+  </dict>
+</plist>
+EOM
+
+    PlistNode = Struct.new(:node, :content) do
+      def inspect
+        "PlistNode:#{content}"
+      end
+    end
+
+    # Adapted from nokogiri-plist parser
+    # @see https://github.com/caseyhoward/nokogiri-plist
+    class Parser
+
+      def parse(xml, options = {})
+        @converters = {
+          'integer' => Proc.new { |node| node.content.to_i },
+          'real'    => Proc.new { |node| node.content.to_f },
+          'string'  => Proc.new { |node| node.content.to_s },
+          # DateTime.parse(node.content)
+          'date'    => Proc.new { |node| node.content.to_s },
+          'true'    => Proc.new { |node| true },
+          'false'   => Proc.new { |node| false },
+          'dict'    => Proc.new { |node| parse_dict(node) },
+          'array'   => Proc.new { |node| parse_array(node) },
+          'data'    => Proc.new { |node| node.content.to_s }
+        }.merge(options[:converters] || {})
+
+        @dict_class = options[:dict_class] || Hash
+        plist = xml.root
+        plist = plist.children.first if plist.name == "plist"
+        result = parse_value_node(next_valid_sibling plist)
+        plist_node_value(result)
+      end
+
+      def parse_value_node(value_node)
+        value = @converters[value_node.name].call(value_node)
+        PlistNode.new(value_node, value)
+      end
+
+      def valid_type?(type)
+        @converters.has_key? type
+      end
+
+      def valid_node?(node)
+        valid_type?(node.name) or node.name == "key"
+      end
+
+      def parse_dict(node)
+        node.xpath('./key').inject(@dict_class.new) do |result, key_node|
+          plist_node = parse_value_node(next_valid_sibling key_node)
+          value = plist_node_value(plist_node)
+          result[key_node.content] = value
+          result
+        end
+      end
+
+      # if the PlistNode value is an array or hash, use that directly
+      # instead of the PlistNode.
+      def plist_node_value(plist_node)
+        content = plist_node.content
+        if content.kind_of?(Array) || content.kind_of?(Hash)
+          content
+        else
+          plist_node
+        end
+      end
+
+      def parse_array(node)
+        node.children.inject([]) do |result, child|
+          if valid_node?(child)
+            plist_node = parse_value_node(child)
+            result << plist_node_value(plist_node)
+          end
+          result
+        end
+      end
+
+      def next_valid_sibling(node)
+        until node.nil? or valid_type? node.name
+          node = node.next_sibling
+        end
+        node
+      end
+
+    end
+
+  end # class
+end   # module

data/lib/translatomatic/resource_file/po.rb

@@ -0,0 +1,107 @@
+require 'poparser'
+
+module Translatomatic::ResourceFile
+  # Property list resource file
+  # @see https://en.wikipedia.org/wiki/Property_list
+  class PO < Base
+
+    # (see Translatomatic::ResourceFile::Base.extensions)
+    def self.extensions
+      %w{po pot}
+    end
+
+    # (see Translatomatic::ResourceFile::Base.is_key_value?)
+    def self.is_key_value?
+      true
+    end
+
+    # (see Translatomatic::ResourceFile::Base#set)
+    def set(key, value)
+      super(key, value)
+
+      unless @pomap.include?(key)
+        # new key, create po entry
+        po << {
+          msgid: key,
+          msgstr: value
+        }
+        entry = po.entries[-1]
+        add_entry(entry, :msgid, 0)
+      else
+        po_property = @pomap[key]
+        entry = po_property.entry
+        if entry.plural?
+          msgstr = entry.msgstr || []
+          msgstr[po_property.index] = value
+          entry.msgstr = msgstr
+        else
+          entry.msgstr = value
+        end
+      end
+    end
+
+    # (see Translatomatic::ResourceFile::Base#save)
+    def save(target = path, options = {})
+      if @po
+        add_created_by unless options[:no_created_by]
+        target.write(@po.to_s)
+      end
+    end
+
+    private
+
+    class PoProperty
+      attr_reader :entry
+      attr_reader :value_index
+
+      def initialize(entry, value_index)
+        @entry = entry
+        @value_index = value_index
+      end
+
+      def value
+        if entry.plural?
+          entry.msgstr[value_index]
+        else
+          entry.msgstr
+        end
+      end
+    end
+
+    def init
+      @po = PoParser.parse('')
+      @pomap = {}
+    end
+
+    def load
+      content = read_contents(@path)
+      @po = PoParser.parse(content)
+      @pomap = init_pomap(@po)
+      @properties = pomap_to_properties
+    end
+
+    def add_created_by
+      # TODO
+    end
+
+    # create mapping from key to PoProperty
+    def init_pomap(po)
+      pomap = {}
+      po.entries.each do |entry|
+        add_entry(entry, :msgid, 0)
+        add_entry(entry, :msgid_plural, 1) if entry.plural?
+      end
+      pomap
+    end
+
+    def pomap_to_properties
+      @pomap.transform_values { |i| i.value }
+    end
+
+    def add_entry(entry, key, index)
+      untranslated = entry.send(key)
+      @pomap[untranslated] = PoProperty.new(entry, index) if untranslated
+    end
+
+  end # class
+end   # module

data/lib/translatomatic/resource_file/properties.rb

@@ -1,90 +1,91 @@
-require 'date'
-
-module Translatomatic::ResourceFile
-  # Properties resource file
-  # @see https://docs.oracle.com/javase/tutorial/essential/environment/properties.html
-  class Properties < Base
-
-    # (see Translatomatic::ResourceFile::Base.extensions)
-    def self.extensions
-      %w{properties}
-    end
-
-    # (see Translatomatic::ResourceFile::Base#initialize)
-    def initialize(path, locale = nil)
-      super(path, locale)
-      @valid = true
-      @properties = @path.exist? ? read(@path) : {}
-    end
-
-    # (see Translatomatic::ResourceFile::Base#save)
-    def save(target = path, options = {})
-      out = ""
-      out += add_created_by unless options[:no_created_by]
-      properties.each do |key, value|
-        # TODO: maintain original line ending format?
-        value = value.gsub("\n", "\\n") if value  # convert newlines to \n
-        out += "#{key} = #{value}\n"
-      end
-      # escape unicode characters
-      out = Translatomatic::EscapedUnicode.escape(out)
-      target.write(out)
-    end
-
-    # (see Translatomatic::ResourceFile::Base#supports_variable_interpolation?)
-    def supports_variable_interpolation?
-      true
-    end
-
-    # (see Translatomatic::ResourceFile::Base#create_variable)
-    def create_variable(name)
-      return "{#{name}}"
-    end
-
-    # (see Translatomatic::ResourceFile::Base#variable_regex)
-    def variable_regex
-      /\{.*?\}/
-    end
-
-    private
-
-    def add_created_by
-      comment(created_by)
-    end
-
-    def comment(text)
-      "# #{text}\n"
-    end
-
-    # parse key = value property file
-    def read(path)
-      contents = path.read
-      # convert escaped unicode characters into unicode
-      contents = Translatomatic::EscapedUnicode.unescape(contents)
-      result = {}
-      contents.gsub!(/\\\s*\n\s*/m, '')  # put multi line strings on one line
-      lines = contents.split("\n")
-
-      lines.each do |line|
-        line.strip!
-        next if line.length == 0
-        equal_idx = line.index("=")
-        colon_idx = line.index(":")
-
-        if line[0] == ?! || line[0] == ?#
-          # comment
-          # TODO: translate comments or keep originals?
-          next
-        elsif equal_idx.nil? && colon_idx.nil?
-          @valid = false
-          return {}
-        end
-        name, value = line.split(/\s*[=:]\s*/, 2)
-        value = value.gsub("\\n", "\n")      # convert \n to newlines
-        result[name] = value
-      end
-      result
-    end
-
-  end
-end
+require 'date'
+
+module Translatomatic::ResourceFile
+  # Properties resource file
+  # @see https://docs.oracle.com/javase/tutorial/essential/environment/properties.html
+  class Properties < Base
+
+    # (see Translatomatic::ResourceFile::Base.extensions)
+    def self.extensions
+      %w{properties}
+    end
+
+    # (see Translatomatic::ResourceFile::Base.is_key_value?)
+    def self.is_key_value?
+      true
+    end
+
+    # (see Translatomatic::ResourceFile::Base.supports_variable_interpolation?)
+    def self.supports_variable_interpolation?
+      true
+    end
+
+    # (see Translatomatic::ResourceFile::Base#save)
+    def save(target = path, options = {})
+      out = ""
+      out += add_created_by unless options[:no_created_by]
+      properties.each do |key, value|
+        # TODO: maintain original line ending format?
+        value = value.gsub("\n", "\\n") if value  # convert newlines to \n
+        out += "#{key} = #{value}\n"
+      end
+      # escape unicode characters
+      out = Translatomatic::EscapedUnicode.escape(out)
+      target.write(out)
+    end
+
+    # (see Translatomatic::ResourceFile::Base#create_variable)
+    def create_variable(name)
+      return "{#{name}}"
+    end
+
+    # (see Translatomatic::ResourceFile::Base#variable_regex)
+    def variable_regex
+      /\{.*?\}/
+    end
+
+    private
+
+    def load
+      @properties = read_properties
+    end
+
+    def add_created_by
+      comment(created_by)
+    end
+
+    def comment(text)
+      "# #{text}\n"
+    end
+
+    def read_properties
+      contents = read_contents(@path)
+      # convert escaped unicode characters into unicode
+      contents = Translatomatic::EscapedUnicode.unescape(contents)
+      result = {}
+      contents.gsub!(/\\\s*\n\s*/m, '')  # put multi line strings on one line
+      lines = contents.split("\n")
+
+      lines.each do |line|
+        line.strip!
+        next if line.length == 0
+        equal_idx = line.index("=")
+        colon_idx = line.index(":")
+
+        if line[0] == ?! || line[0] == ?#
+          # comment
+          # TODO: translate comments or keep originals?
+          next
+        elsif equal_idx.nil? && colon_idx.nil?
+          # TODO: throw exception here?
+          return {}
+        end
+        name, value = line.split(/\s*[=:]\s*/, 2)
+        value = value.gsub("\\n", "\n")      # convert \n to newlines
+        result[name] = value
+      end
+      result
+    end
+
+  end
+end

data/lib/translatomatic/resource_file/resw.rb

@@ -1,31 +1,51 @@
-module Translatomatic::ResourceFile
+module Translatomatic::ResourceFile
   # Windows resources file (XML)
-  class RESW < XML
-
-    # (see Translatomatic::ResourceFile::Base.extensions)
-    def self.extensions
-      %w{resw}
-    end
-
-    # (see Translatomatic::ResourceFile::Base#locale_path)
-    def locale_path(locale)
-      # e.g. strings/en-US/resources.resw
-      dir = path.dirname
-      dir.parent + locale.to_s + path.basename
-    end
-
-    private
-
-    def create_nodemap(doc)
-      result = {}
-      key_values = doc.search('//data/@name|//text()')
-      key_values.each_slice(2) do |key, value|
-        key = key.value
-        value = value
-        result[key] = value
-      end
-      result
-    end
-
-  end # class
-end   # module
+  class RESW < XML
+
+    # (see Translatomatic::ResourceFile::Base.extensions)
+    def self.extensions
+      %w{resw resx}
+    end
+
+    # (see Translatomatic::ResourceFile::Base.is_key_value?)
+    def self.is_key_value?
+      true
+    end
+
+    # (see Translatomatic::ResourceFile::Base#locale_path)
+    def locale_path(locale)
+      # e.g. strings/en-US/resources.resw
+      dir = path.dirname
+      dir.parent + locale.to_s + path.basename
+    end
+
+    private
+
+    def init_nodemap
+      result = {}
+      key_values = @doc.search('//data/@name|//text()')
+      key_values.each_slice(2) do |key, value|
+        key = key.value
+        value = value
+        result[key] = value
+      end
+      @nodemap = result
+    end
+
+    def create_node(key, value)
+      # add xml: <data name="key"><value>value</value></data>
+      data_node = Nokogiri::XML::Node.new("data", @doc)
+      data_node["name"] = key
+      value_node = Nokogiri::XML::Node.new("value", @doc)
+      text_node = Nokogiri::XML::Text.new(value, @doc)
+      value_node.add_child(text_node)
+      data_node.add_child(value_node)
+
+      @doc.root.add_child(data_node)
+
+      @nodemap[key] = text_node
+      @properties[key] = value
+    end
+
+  end # class
+end   # module