translatomatic 0.1.3 → 0.2.0

data/lib/translatomatic/resource_file/plist.rb

@@ -1,153 +1,148 @@
-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
+module Translatomatic
+  module 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 />
+
+      # (see Base.extensions)
+      def self.extensions
+        %w[plist]
+      end
 
-    # (see Translatomatic::ResourceFile::Base.is_key_value?)
-    def self.is_key_value?
-      true
-    end
+      # (see Base.key_value?)
+      def self.key_value?
+        true
+      end
 
-    private
+      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_nodemap
+        result = Parser.new.parse(@doc)
+        # puts "parser result:"
+        # p result
+        @flattened_data = flatten(result)
+        @nodemap = @flattened_data.transform_values(&:node)
+        # puts "nodemap:"
+        # p @nodemap
+      end
 
-    def init_properties
-      @properties = @flattened_data.transform_values { |i| i.content }
-    end
+      def init_properties
+        @properties = @flattened_data.transform_values(&: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 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
+      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">
+      EMPTY_DOC = <<EOM.strip_heredoc.freeze
+  <?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>
+  </plist>
 EOM
 
-    PlistNode = Struct.new(:node, :content) do
-      def inspect
-        "PlistNode:#{content}"
+      # @private
+      PlistNode = Struct.new(:node, :content) do
+        def inspect
+          "PlistNode:#{content}"
+        end
       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
+      # Adapted from nokogiri-plist parser
+      # @see https://github.com/caseyhoward/nokogiri-plist
+      # @private
+      class Parser
+        def parse(xml, options = {})
+          @converters = {
+            'integer' => proc { |node| node.content.to_i },
+            'real'    => proc { |node| node.content.to_f },
+            'string'  => proc { |node| node.content.to_s },
+            # DateTime.parse(node.content)
+            'date'    => proc { |node| node.content.to_s },
+            'true'    => proc { |_node| true },
+            'false'   => proc { |_node| false },
+            'dict'    => proc { |node| parse_dict(node) },
+            'array'   => proc { |node| parse_array(node) },
+            'data'    => proc { |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 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_type?(type)
+          @converters.key? type
+        end
 
-      def valid_node?(node)
-        valid_type?(node.name) or node.name == "key"
-      end
+        def valid_node?(node)
+          valid_type?(node.name) || 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
+        def parse_dict(node)
+          node.xpath('./key').each_with_object(@dict_class.new) do |k, v|
+            plist_node = parse_value_node(next_valid_sibling(k))
+            value = plist_node_value(plist_node)
+            v[k.content] = value
+          end
         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
+        # 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.is_a?(Array) || content.is_a?(Hash)
+            content
+          else
+            plist_node
+          end
         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)
+        def parse_array(node)
+          node.children.each_with_object([]) do |child, result|
+            if valid_node?(child)
+              plist_node = parse_value_node(child)
+              result << plist_node_value(plist_node)
+            end
           end
-          result
         end
-      end
 
-      def next_valid_sibling(node)
-        until node.nil? or valid_type? node.name
-          node = node.next_sibling
+        def next_valid_sibling(node)
+          node = node.next_sibling until node.nil? || valid_type?(node.name)
+          node
         end
-        node
       end
-
     end
-
-  end # class
-end   # module
+  end
+end

data/lib/translatomatic/resource_file/po.rb

@@ -1,107 +1,129 @@
 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
+module Translatomatic
+  module ResourceFile
+    # Property list resource file
+    # @see https://en.wikipedia.org/wiki/Property_list
+    class PO < Base
+      # (see Base.extensions)
+      def self.extensions
+        %w[po pot]
+      end
 
-    # (see Translatomatic::ResourceFile::Base.is_key_value?)
-    def self.is_key_value?
-      true
-    end
+      # (see Base.key_value?)
+      def self.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
+      # (see Base#set)
+      def set(key, value)
+        super(key, value)
+
+        if @pomap.include?(key)
+          po_property = @pomap[key]
+          entry = po_property.entry
+          if entry.plural?
+            msgstr = entry.msgstr || []
+            msgstr[po_property.msgstr_index] = value
+            entry.msgstr = msgstr
+          else
+            entry.msgstr = value
+          end
         else
-          entry.msgstr = value
+          # new key, create po entry
+          @po << {
+            msgid: key,
+            msgstr: value
+          }
+          entry = @po.entries[-1]
+          add_entry(entry, :msgid, 0)
         end
       end
-    end
 
-    # (see Translatomatic::ResourceFile::Base#save)
-    def save(target = path, options = {})
-      if @po
+      # (see Base#save)
+      def save(target = path, options = {})
+        return unless @po
         add_created_by unless options[:no_created_by]
         target.write(@po.to_s)
       end
-    end
 
-    private
+      private
 
-    class PoProperty
-      attr_reader :entry
-      attr_reader :value_index
+      PO_DATE_FORMAT = '%Y-%M-%d %HH:%MM%Z'.freeze
 
-      def initialize(entry, value_index)
-        @entry = entry
-        @value_index = value_index
-      end
+      # used to index into PO msgstr[]
+      # @private
+      class PoProperty
+        attr_reader :entry
+        attr_reader :msgstr_index
 
-      def value
-        if entry.plural?
-          entry.msgstr[value_index]
-        else
-          entry.msgstr
+        def initialize(entry, msgstr_index)
+          @entry = entry
+          @msgstr_index = msgstr_index
+        end
+
+        def value
+          if entry.plural?
+            entry.msgstr[msgstr_index]
+          else
+            entry.msgstr
+          end
         end
       end
-    end
 
-    def init
-      @po = PoParser.parse('')
-      @pomap = {}
-    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 load
+        @metadata.reset
+        content = read_contents(@path)
+        @po = PoParser.parse(content)
+        init_pomap(@po)
+        @properties = pomap_to_properties
+      end
 
-    def add_created_by
-      # TODO
-    end
+      def add_created_by
+        header = po_header
+        header['PO-RevisionDate'] = Time.now.strftime(PO_DATE_FORMAT)
+        header['Last-Translator'] = 'Translatomatic ' + VERSION
+      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?
+      def po_header
+        # TODO: get or create header entry
+        {}
       end
-      pomap
-    end
 
-    def pomap_to_properties
-      @pomap.transform_values { |i| i.value }
-    end
+      # create mapping from key to PoProperty
+      def init_pomap(po)
+        po.entries.each_with_index do |entry, i|
+          # skip PO file header if present
+          # TODO: update PO-Revision-Date, Last-Provider ?
+          next if entry.msgid == '' && i.zero?
+
+          if entry.extracted_comment
+            @metadata.parse_comment(entry.extracted_comment.value)
+          end
+          add_entry(entry, :msgid, 0)
+          add_entry(entry, :msgid_plural, 1) if entry.plural?
+          @metadata.clear_context
+        end
+      end
 
-    def add_entry(entry, key, index)
-      untranslated = entry.send(key)
-      @pomap[untranslated] = PoProperty.new(entry, index) if untranslated
-    end
+      def pomap_to_properties
+        @pomap.transform_values { |i| i.value.to_s }
+      end
 
-  end # class
-end   # module
+      def add_entry(entry, key, msgstr_index)
+        map_key = entry.send(key).to_s
+        return unless map_key
+
+        msg_context = entry.msgctxt
+        map_key = map_key + '.' + msg_context.to_s if msg_context
+        @pomap[map_key] = PoProperty.new(entry, msgstr_index)
+        @metadata.assign_key(map_key, keep_context: true)
+      end
+    end
+  end
+end