translatomatic 0.1.3 → 0.2.0

data/lib/translatomatic/resource_file/text.rb

@@ -1,24 +1,24 @@
-module Translatomatic::ResourceFile
-  # Text resource file
-  class Text < Base
+module Translatomatic
+  module ResourceFile
+    # Text resource file
+    class Text < Base
+      # (see Base.extensions)
+      def self.extensions
+        %w[txt text]
+      end
 
-    # (see Translatomatic::ResourceFile::Base.extensions)
-    def self.extensions
-      %w{txt text}
-    end
-
-    # (see Translatomatic::ResourceFile::Base#save)
-    def save(target = path, options = {})
-      values = @properties.values.collect { |i| i.strip + "\n" }
-      target.write(values.join)
-    end
+      # (see Base#save)
+      def save(target = path, options = {})
+        values = @properties.values.compact.collect { |i| i.strip + "\n" }
+        target.write(values.join)
+      end
 
-    private
+      private
 
-    def load
-      text = read_contents(@path)
-      @properties = { "text" => text }
+      def load
+        text = read_contents(@path)
+        @properties = { 'text' => text }
+      end
     end
-
   end
 end

data/lib/translatomatic/resource_file/xcode_strings.rb

@@ -1,75 +1,44 @@
-module Translatomatic::ResourceFile
-
-  # @!visibility private
-  module XCodeStringsLocalePath
-
-    # (see Translatomatic::ResourceFile::Base#locale_path)
-    # @note localization files in XCode use the following file name
-    #   convention: locale.lproj/filename
-    def locale_path(locale)
-      if path.to_s.match(/\b([-\w]+).lproj\/.+$/)
-        # xcode style
-        filename = path.basename
-        path.parent.parent + (locale.to_s + ".lproj") + filename
-      else
-        super(locale)
+require 'treetop'
+
+module Translatomatic
+  module ResourceFile
+    # XCode strings resource file
+    # @see https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/LoadingResources/Strings/Strings.html
+    class XCodeStrings < Base
+      include KeyValueSupport
+
+      # (see Base.extensions)
+      def self.extensions
+        %w[strings]
       end
-    end
-  end
 
-  # XCode strings resource file
-  # @see https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/LoadingResources/Strings/Strings.html
-  class XCodeStrings < Base
-    include Translatomatic::ResourceFile::XCodeStringsLocalePath
+      private
 
-    # (see Translatomatic::ResourceFile::Base.extensions)
-    def self.extensions
-      %w{strings}
-    end
+      Treetop.load(File.join(__dir__, 'xcode_strings.treetop'))
+      # @private
+      class Parser < XCodeStringsParser; end
 
-    # (see Translatomatic::ResourceFile::Base.is_key_value?)
-    def self.is_key_value?
-      true
-    end
-
-    # (see Translatomatic::ResourceFile::Base#save)
-    def save(target = path, options = {})
-      out = ""
-      out += comment(created_by) unless options[:no_created_by]
-      properties.each do |key, value|
-        key = escape(key)
-        value = escape(value)
-        out += %Q{"#{key}" = "#{value}";\n}
+      def parse_doc(content)
+        Parser.new.parse(content)
       end
-      target.write(out)
-    end
-
-    private
 
-    def load
-      result = {}
-      content = read_contents(@path)
-      uncommented = content.gsub(/\/\*.*?\*\//, '')
-      key_values = uncommented.scan(/"(.*?[^\\])"\s*=\s*"(.*?[^\\])"\s*;/m)
-      key_values.each do |entry|
-        key, value = entry
-        result[unescape(key)] = unescape(value)
+      def definition_to_s(key, value)
+        format(%("%<key>s" = "%<value>s";\n\n), key: escape(key),
+                                                value: escape(value))
       end
 
-      @properties = result
-    end
-
-    def comment(text)
-      "/* #{text} */\n"
-    end
-
-    def unescape(string)
-      string ? string.gsub(/\\(["'])/) { |i| i } : ''
-    end
+      def comment_to_s(text)
+        comment = text && text.start_with?(' ') ? text : " #{text} "
+        "/*#{comment}*/\n"
+      end
 
-    def escape(string)
-      string ? string.gsub(/["']/) { |i| "\\#{i}" } : ''
+      def render_element(element)
+        if element.is_a? Comment
+          comment_to_s(element.text)
+        elsif element.is_a? Definition
+          definition_to_s(element.key, element.value)
+        end
+      end
     end
-
   end
 end

data/lib/translatomatic/resource_file/xcode_strings.treetop

@@ -0,0 +1,85 @@
+grammar XCodeStrings
+  rule document
+    (whitespace / comment / definition)* {
+      def content
+        elements.collect { |i| i.content }.select { |i| i[0] != :whitespace }
+      end
+    }
+  end
+
+  rule comment
+    start_comment comment_content end_comment {
+      def content
+        [:comment, elements[1].text_value]
+      end
+    }
+  end
+
+  rule comment_content
+    (!end_comment character)+
+  end
+
+  rule definition
+    key assignment value end_definition {
+      def content
+        [:definition, elements[0].content, elements[2].content]
+      end
+    }
+  end
+
+  rule end_definition
+    whitespace* ';'
+  end
+
+  rule assignment
+    whitespace* '=' whitespace*
+  end
+
+  rule key
+    quoted_string
+  end
+
+  rule value
+    quoted_string
+  end
+
+  rule whitespace
+    [ \t\r\n] {
+      def content
+        [:whitespace, text_value]
+      end
+    }
+  end
+
+  rule start_comment
+    '/*'
+  end
+
+  rule end_comment
+    '*/'
+  end
+
+  rule character
+    .
+  end
+
+  rule string_content
+    (escaped_double_quote / !double_quote character)*
+  end
+
+  rule escaped_double_quote
+    '\\' double_quote
+  end
+
+  rule double_quote
+    '"'
+  end
+
+  rule quoted_string
+    double_quote string_content double_quote {
+      def content
+        elements[1].text_value
+      end
+    }
+  end
+end

data/lib/translatomatic/resource_file/xml.rb

@@ -1,103 +1,116 @@
-module Translatomatic::ResourceFile
-  # XML resource file
-  class XML < Base
-
-    # (see Translatomatic::ResourceFile::Base.extensions)
-    def self.extensions
-      %w{xml}
-    end
+module Translatomatic
+  module ResourceFile
+    # XML resource file
+    class XML < Base
+      # (see Base.extensions)
+      def self.extensions
+        %w[xml]
+      end
 
-    # (see Translatomatic::ResourceFile::Base#set)
-    def set(key, value)
-      super(key, value)
-      if @nodemap.include?(key)
-        @nodemap[key].content = value
-      else
-        create_node(key, value)
+      # (see Base#set)
+      def set(key, value)
+        super(key, value)
+        if @nodemap.include?(key)
+          @nodemap[key].content = value
+        else
+          create_node(key, value)
+        end
       end
-    end
 
-    # (see Translatomatic::ResourceFile::Base#save)
-    def save(target = path, options = {})
-      if @doc
-        add_created_by unless options[:no_created_by]
+      # (see Base#save)
+      def save(target = path, options = {})
+        return unless @doc
+        add_created_by unless options[:no_created_by] || created_by?
         target.write(@doc.to_xml(indent: 2))
       end
-    end
 
-    private
+      private
 
-    def init
-      @nodemap = {}
-      @doc = empty_doc
-    end
+      TM_NS = 'http://www.smugglys.com/2018/translatomatic'.freeze
 
-    def load
-      # parse xml with nokogiri
-      @doc = read_doc
-      init_nodemap
-      init_properties
-    end
+      def init
+        @nodemap = {}
+        @doc = empty_doc
+      end
 
-    def comment(text)
-      @doc.create_comment(text)
-    end
+      def load
+        # parse xml with nokogiri
+        @metadata.reset
+        @doc = read_doc
+        init_nodemap
+        init_properties
+      end
 
-    def add_created_by
-      @created_by ||= @doc.root.add_previous_sibling(comment(created_by))
-    end
+      def comment(text)
+        @doc.create_comment(text)
+      end
 
-    def init_properties
-      @properties = @nodemap.transform_values { |i| i ? i.content : nil }
-    end
+      def add_created_by
+        @created_by ||= @doc.root.add_previous_sibling(comment(created_by))
+      end
 
-    # initialize nodemap and properties hash from nokogiri document
-    def init_nodemap
-      # map of key1 => node, key2 => node, ...
-      @keynum = 1
-      text_nodes = @doc.search(text_nodes_xpath)
-      text_nodes.each { |node| add_node(node) }
-    end
+      def init_properties
+        @properties = @nodemap.transform_values { |i| i ? i.content : nil }
+      end
 
-    def read_doc
-      doc = Nokogiri::XML(@path.open) do |config|
-        config.noblanks
+      # initialize nodemap and properties hash from nokogiri document
+      def init_nodemap
+        # map of key1 => node, key2 => node, ...
+        @keynum = 1
+        text_nodes = @doc.search(text_nodes_xpath, tm: TM_NS)
+        text_nodes.each { |node| add_node(node) }
       end
-      parsing_error(doc.errors[0]) if doc.errors.present?
-      doc
-    end
 
-    def create_node(key, value)
-      # separate nodes by whitespace
-      text_node = Nokogiri::XML::Text.new("\n", @doc)
-      @doc.root.add_child(text_node)
+      def read_doc
+        doc = Nokogiri::XML(@path.open, &:noblanks)
+        parsing_error(doc.errors[0]) if doc.errors.present?
+        doc
+      end
 
-      # create the key/value node
-      node = Nokogiri::XML::Node.new(key, @doc)
-      node.content = value
-      @doc.root.add_child(node)
+      def create_node(key, value)
+        # separate nodes by whitespace
+        text_node = Nokogiri::XML::Text.new("\n", @doc)
+        @doc.root.add_child(text_node)
 
-      @nodemap[key] = node
-      @properties[key] = node.content
-    end
+        # create the key/value node
+        node = Nokogiri::XML::Node.new(key, @doc)
+        node.content = value
+        @doc.root.add_child(node)
 
-    def add_node(node)
-      return if whitespace?(node.content)
-      key = "key#{@keynum}"
-      @nodemap[key] = node
-      @keynum += 1
-    end
+        @nodemap[key] = node
+        @properties[key] = node.content
+      end
 
-    def empty_doc
-      Nokogiri::XML("<root />")
-    end
+      def add_node(node)
+        return if whitespace?(node.content)
+        if node.comment?
+          @metadata.parse_comment(node.content)
+        elsif context_attribute?(node)
+          @metadata.add_context(node.content)
+        else
+          key = "key#{@keynum}"
+          @nodemap[key] = node
+          @keynum += 1
+          @metadata.assign_key(key)
+        end
+      end
 
-    def text_nodes_xpath
-      '//text()'
-    end
+      def context_attribute?(node)
+        node.name == 'context' && node.namespace &&
+          node.namespace.href == TM_NS
+      end
+
+      def empty_doc
+        Nokogiri::XML('<root />')
+      end
 
-    def whitespace?(text)
-      text == nil || text.strip.length == 0
+      def text_nodes_xpath
+        '//text()|//comment()|//@tm:context'
+      end
+
+      def whitespace?(text)
+        text.nil? || text.strip.empty?
+      end
     end
-  end # class
-end   # module
+  end
+end

data/lib/translatomatic/resource_file/yaml.rb

@@ -1,52 +1,39 @@
 require 'yaml'
 
-module Translatomatic::ResourceFile
-  # YAML resource file
-  # @see http://www.yaml.org/
-  class YAML < Base
-
-    # (see Translatomatic::ResourceFile::Base.extensions)
-    def self.extensions
-      %w{yml yaml}
-    end
-
-    # (see Translatomatic::ResourceFile::Base.is_key_value?)
-    def self.is_key_value?
-      true
-    end
+module Translatomatic
+  module ResourceFile
+    # YAML resource file
+    # @see http://www.yaml.org/
+    class YAML < Base
+      # (see Base.extensions)
+      def self.extensions
+        %w[yml yaml]
+      end
 
-    # (see Translatomatic::ResourceFile::Base.supports_variable_interpolation?)
-    def self.supports_variable_interpolation?
-      true
-    end
+      # (see Base.key_value?)
+      def self.key_value?
+        true
+      end
 
-    # (see Translatomatic::ResourceFile::Base#locale_path)
-    # @note localization files in rails use the following file name
-    #   convention: config/locales/en.yml.
-    def locale_path(locale)
-      if path.to_s.match(/config\/locales\/[-\w]+.yml$/)
-        # rails style
-        filename = locale.to_s + path.extname
-        path.dirname + filename
-      else
-        super(locale)
+      # (see Base.supports_variable_interpolation?)
+      def self.supports_variable_interpolation?
+        true
       end
-    end
 
-    # (see Translatomatic::ResourceFile::Base#set)
-    def set(key, value)
-      super(key, value)
+      # (see Base#set)
+      def set(key, value)
+        super(key, value)
 
-      hash = @data
-      path = key.to_s.split(/\./)
-      last_key = path.pop
-      path.each { |i| hash = (hash[i] ||= {}) }
-      hash[last_key] = value
-    end
+        hash = @data
+        path = key.to_s.split(/\./)
+        last_key = path.pop
+        path.each { |i| hash = (hash[i] ||= {}) }
+        hash[last_key] = value
+      end
 
-    # (see Translatomatic::ResourceFile::Base#save)
-    def save(target = path, options = {})
-      if @data
+      # (see Base#save)
+      def save(target = path, options = {})
+        return unless @data
         data = @data
         data = data.transform_keys { locale.language } if ruby_i18n?
         out = data.to_yaml
@@ -54,41 +41,40 @@ module Translatomatic::ResourceFile
         out = comment(created_by) + "\n" + out unless options[:no_created_by]
         target.write(out)
       end
-    end
 
-    # (see Translatomatic::ResourceFile::Base#create_variable)
-    def create_variable(name)
-      return "%{#{name}}"
-    end
+      # (see Base#create_variable)
+      def create_variable(name)
+        "%{#{name}}"
+      end
 
-    # (see Translatomatic::ResourceFile::Base#variable_regex)
-    def variable_regex
-      /\%\s*\{.*?\}/
-    end
+      # (see Base#variable_regex)
+      def variable_regex
+        /\%\s*\{.*?\}/
+      end
 
-    private
+      private
 
-    def init
-      # yaml data
-      @data = {}
-    end
+      def init
+        # yaml data
+        @data = {}
+      end
 
-    def load
-      @data = ::YAML.load_file(path.to_s) || {}
-      @properties = flatten(@data)
-    end
+      def load
+        @data = ::YAML.load_file(path.to_s) || {}
+        @properties = flatten(@data)
+      end
 
-    # true if this resource file looks like a ruby i18n data file.
-    def ruby_i18n?
-      if @data && @data.length == 1
-        lang = @data.keys[0]
-        Translatomatic::Locale.new(lang).valid?
+      # true if this resource file looks like a ruby i18n data file.
+      def ruby_i18n?
+        if @data && @data.length == 1
+          lang = @data.keys[0]
+          Translatomatic::Locale.new(lang).valid?
+        end
       end
-    end
 
-    def comment(text)
-      "# #{text}\n"
+      def comment(text)
+        "# #{text}\n"
+      end
     end
-
   end
 end