translatomatic 0.1.1 → 0.1.2

data/lib/translatomatic/resource_file/properties.rb

@@ -1,6 +1,8 @@
 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)
@@ -21,7 +23,7 @@ module Translatomatic::ResourceFile
       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")  # convert newlines to \n
+        value = value.gsub("\n", "\\n") if value  # convert newlines to \n
         out += "#{key} = #{value}\n"
       end
       # escape unicode characters
@@ -29,6 +31,21 @@ module Translatomatic::ResourceFile
       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
@@ -52,16 +69,17 @@ module Translatomatic::ResourceFile
         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?
+        elsif equal_idx.nil? && colon_idx.nil?
           @valid = false
           return {}
         end
-        name, value = line.split(/\s*=\s*/, 2)
+        name, value = line.split(/\s*[=:]\s*/, 2)
         value = value.gsub("\\n", "\n")      # convert \n to newlines
         result[name] = value
       end

data/lib/translatomatic/resource_file/resw.rb

@@ -1,4 +1,5 @@
 module Translatomatic::ResourceFile
+  # Windows resources file (XML)
   class RESW < XML
 
     # (see Translatomatic::ResourceFile::Base.extensions)

data/lib/translatomatic/resource_file/text.rb

@@ -1,4 +1,5 @@
 module Translatomatic::ResourceFile
+  # Text resource file
   class Text < Base
 
     # (see Translatomatic::ResourceFile::Base.extensions)

data/lib/translatomatic/resource_file/xcode_strings.rb

@@ -1,8 +1,26 @@
 module Translatomatic::ResourceFile
 
-  # XCode strings file
+  # @!visibility private
+  module XCodeStringsLocalePath
+
+    # (see Translatomatic::ResourceFile::Base#locale_path)
+    # @note localization files in XCode use the following file name
+    #   convention: Project/locale.lproj/filename
+    def locale_path(locale)
+      if path.to_s.match(/\/([-\w]+).lproj\/.+$/)
+        # xcode style
+        filename = path.basename
+        path.parent.parent + (locale.to_s + ".lproj") + filename
+      else
+        super(locale)
+      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
 
     # (see Translatomatic::ResourceFile::Base.extensions)
     def self.extensions
@@ -16,19 +34,6 @@ module Translatomatic::ResourceFile
       @properties = @path.exist? ? read(@path) : {}
     end
 
-    # (see Translatomatic::ResourceFile::Base#locale_path)
-    # @note localization files in XCode use the following file name
-    #   convention: Project/locale.lproj/filename
-    def locale_path(locale)
-      if path.to_s.match(/\/([-\w]+).lproj\/.+.strings$/)
-        # xcode style
-        filename = path.basename
-        path.parent.parent + (locale.to_s + ".lproj") + filename
-      else
-        super(locale)
-      end
-    end
-
     # (see Translatomatic::ResourceFile::Base#save)
     def save(target = path, options = {})
       out = ""
@@ -56,6 +61,10 @@ module Translatomatic::ResourceFile
         key, value = entry
         result[unescape(key)] = unescape(value)
       end
+
+      if uncommented.strip.length > 0 && key_values.length == 0
+        @valid = false
+      end
       result
     end
 

data/lib/translatomatic/resource_file/xml.rb

@@ -1,4 +1,5 @@
 module Translatomatic::ResourceFile
+  # XML resource file
   class XML < Base
 
     # (see Translatomatic::ResourceFile::Base.extensions)
@@ -9,7 +10,8 @@ module Translatomatic::ResourceFile
     # (see Translatomatic::ResourceFile::Base#initialize)
     def initialize(path, locale = nil)
       super(path, locale)
-      @valid = true
+      @valid = true
+      @nodemap = {}
       @properties = @path.exist? ? read(@path) : {}
     end
 
@@ -20,26 +22,36 @@ module Translatomatic::ResourceFile
     end
 
     # (see Translatomatic::ResourceFile::Base#save)
-    def save(target = path, options = {})
-      if @doc
+    def save(target = path, options = {})
+      if @doc
         add_created_by unless options[:no_created_by]
-        target.write(@doc.to_xml)
+        target.write(@doc.to_xml)
       end
     end
 
-    private
-
-    def comment(text)
-      @doc.create_comment(text)
+    private
+
+    def comment(text)
+      @doc.create_comment(text)
     end
+
+    def add_created_by
+      @created_by ||= @doc.root.add_previous_sibling(comment(created_by))
+    end
 
     # initialize nodemap from nokogiri document
     # returns property hash
-    def init_nodemap(doc)
-      # map of key1 => node, key2 => node, ...
-      @nodemap = create_nodemap(doc)
-      # map of key => node content
-      @nodemap.transform_values { |v| v.content }
+    def init_nodemap(doc)
+      if !doc.errors.empty?
+        log.error(doc.errors)
+        @valid = false
+        {}
+      else
+        # map of key1 => node, key2 => node, ...
+        @nodemap = create_nodemap(doc)
+        # map of key => node content
+        @nodemap.transform_values { |v| v.content }
+      end
     end
 
     # parse xml
@@ -47,9 +59,9 @@ module Translatomatic::ResourceFile
       begin
         # parse xml with nokogiri
         @doc = read_doc(path)
-        init_nodemap(@doc)
+        init_nodemap(@doc)
       rescue Exception => e
-        log.error(e.message)
+        log.error t("resource.error", message: e.message)
         @valid = false
         {}
       end
@@ -63,11 +75,11 @@ module Translatomatic::ResourceFile
 
     def create_nodemap(doc)
       result = {}
-      text_nodes = doc.search(text_nodes_xpath)
+      text_nodes = doc.search(text_nodes_xpath)
       idx = 1
-      text_nodes.each do |node|
+      text_nodes.each do |node|
         next if whitespace?(node.content)
-        result["key#{idx}"] = node
+        result["key#{idx}"] = node
         idx += 1
       end
       result
@@ -75,10 +87,10 @@ module Translatomatic::ResourceFile
 
     def text_nodes_xpath
       '//text()'
-    end
-
-    def whitespace?(text)
-      text == nil || text.strip.length == 0
+    end
+
+    def whitespace?(text)
+      text == nil || text.strip.length == 0
     end
   end # class
 end   # module

data/lib/translatomatic/resource_file/yaml.rb

@@ -1,6 +1,8 @@
 require 'yaml'
 
 module Translatomatic::ResourceFile
+  # YAML resource file
+  # @see http://www.yaml.org/
   class YAML < Base
 
     # (see Translatomatic::ResourceFile::Base.extensions)
@@ -34,7 +36,7 @@ module Translatomatic::ResourceFile
       super(key, value)
 
       hash = @data
-      path = key.split(/\./)
+      path = key.to_s.split(/\./)
       last_key = path.pop
       path.each { |i| hash = (hash[i] ||= {}) }
       hash[last_key] = value
@@ -42,19 +44,51 @@ module Translatomatic::ResourceFile
 
     # (see Translatomatic::ResourceFile::Base#save)
     def save(target = path, options = {})
-      out = @data.to_yaml
-      out.sub!(/^---\n/m, '')
-      target.write(out)
+      if @data
+        data = @data
+        data = data.transform_keys { locale.language } if ruby_i18n?
+        out = data.to_yaml
+        out.sub!(/^---\n/m, '')
+        out = comment(created_by) + "\n" + out unless options[:no_created_by]
+        target.write(out)
+      end
+    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
+      /\%\s*\{.*?\}/
     end
 
     private
 
+    # 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
+
+    def comment(text)
+      "# #{text}\n"
+    end
+
     def read
       begin
         @data = ::YAML.load_file(@path) || {}
         flatten_data(@data)
       rescue Exception => e
-        log.error(e.message)
+        log.error t("resource.error", message: e.message)
         @valid = false
         {}
       end

data/lib/translatomatic/resource_file.rb

@@ -1,5 +1,6 @@
 
 module Translatomatic
+  # Provides methods to create resource files of various types.
   module ResourceFile
     class << self
       include Translatomatic::Util
@@ -8,8 +9,8 @@ module Translatomatic
     # Load a resource file. If locale is not specified, the locale of the
     # file will be determined from the filename, or else the current default
     # locale will be used.
-    # @param [String] path Path to the resource file
-    # @param [String] locale Locale of the resource file
+    # @param path [String] Path to the resource file
+    # @param locale [String] Locale of the resource file
     # @return [Translatomatic::ResourceFile::Base] The resource file, or nil
     #   if the file type is unsupported.
     def self.load(path, locale = nil)
@@ -17,7 +18,8 @@ module Translatomatic
       modules.each do |mod|
         # match on entire filename to support extensions containing locales
         if extension_match(mod, path)
-          log.debug("attempting to load #{path.to_s} using #{mod.name.demodulize}")
+          log.debug(t("resource.loading", file: path,
+            name: mod.name.demodulize))
           file = mod.new(path, locale)
           return file if file.valid?
         end
@@ -26,7 +28,7 @@ module Translatomatic
     end
 
     # Find all resource files under the given directory. Follows symlinks.
-    # @param [String, Pathname] path The path to search from
+    # @param path [String, Pathname] The path to search from
     # @return [Array<Translatomatic::ResourceFile>] Resource files found
     def self.find(path, options = {})
       files = []
@@ -71,6 +73,6 @@ require 'translatomatic/resource_file/text'
 require 'translatomatic/resource_file/xml'
 require 'translatomatic/resource_file/html'
 require 'translatomatic/resource_file/markdown'
+require 'translatomatic/resource_file/xcode_strings'
 require 'translatomatic/resource_file/plist'
 require 'translatomatic/resource_file/resw'
-require 'translatomatic/resource_file/xcode_strings'

data/lib/translatomatic/string.rb

@@ -1,4 +1,5 @@
 module Translatomatic
+  # A string object with an associated locale.
   class String
 
     # @return [String] The string
@@ -16,7 +17,7 @@ module Translatomatic
     attr_reader :offset
 
     def initialize(value, locale, options = {})
-      @value = value || ''
+      @value = value.to_s || ''
       @locale = Translatomatic::Locale.parse(locale)
       @offset = options[:offset] || 0
       @parent = options[:parent]
@@ -27,16 +28,21 @@ module Translatomatic
       @value
     end
 
+    # @return [Number] The length of the string
     def length
       @value.length
     end
 
+    # @return [boolean] True if the string is empty
     def empty?
       @value.empty?
     end
 
-    def match(regex)
-      @value.match(regex)
+    # Invokes value.match
+    # @param pattern [Regexp,String] The regex pattern to match
+    # @return [MatchData] Object describing the match, or nil if no match
+    def match(pattern)
+      @value.match(pattern)
     end
 
     # @return [boolean] true if this string is a substring of another string
@@ -58,38 +64,49 @@ module Translatomatic
     # Find all sentences in the string
     # @return [Array<Translatomatic::String] List of sentences
     def sentences
-      sentences = @value.scan(sentence_regex)
+      substrings(sentence_regex)
+    end
+
+    # Find all substrings matching the given regex
+    # @return [Array<Translatomatic::String] List of substrings
+    def substrings(regex)
+      matches = matches(@value, regex)
       strings = []
-      offset = 0
-      sentences.each do |sentence|
+      matches.each do |match|
+        substring = match.to_s
         # find leading and trailing whitespace
-        next if sentence.length == 0
+        next if substring.length == 0
 
-        parts = sentence.match(/^(\s*)(.*?)(\s*)$/).to_a
+        parts = substring.match(/\A(\s*)(.*?)(\s*)\z/m).to_a
         value = parts[2]
+        offset = match.offset(0)[0]
         offset += parts[1].length  # leading whitespace
         strings << self.class.new(value, locale, offset: offset, parent: self)
-        offset += value.length + parts[3].length
       end
 
-      # return [self] if there's only one sentence and it's equal to self
+      # return [self] if there's only one substring and it's equal to self
       strings.length == 1 && strings[0].eql?(self) ? [self] : strings
     end
 
+    # @return [boolean] true if other is a {Translatomatic::String} with
+    #   the same value and locale.
     def eql?(other)
       other.kind_of?(Translatomatic::String) && other.hash == hash
     end
 
+    # (see #eql?)
     def ==(other)
       eql?(other)
     end
 
+    # @!visibility private
     def hash
       [value, locale].hash
     end
 
     private
 
+    # @!visibility private
     class Script
       attr_reader :language
       attr_reader :delimiter      # sentence delimiter
@@ -141,13 +158,24 @@ module Translatomatic
       @script_data = script_data
     end
 
+    def matches(s, re)
+      start_at = 0
+      matches = []
+      while(m = s.match(re, start_at))
+        break if m.to_s.empty?
+        matches.push(m)
+        start_at = m.end(0)
+      end
+      matches
+    end
+
     def sentence_regex
       script = script_data
       if script.trailing_space
-        regex = /.*?(?:#{script.delimiter}\s+|$)/
+        regex = /.*?(?:#{script.delimiter}\s+|\z)/m
       else
         # no trailing space after delimiter
-        regex = /.*?(?:#{script.delimiter}|$)/
+        regex = /.*?(?:#{script.delimiter}|\z)/m
       end
     end
 

data/lib/translatomatic/tmx/document.rb

@@ -3,14 +3,13 @@ module Translatomatic::TMX
   class Document
 
     # Create a new instance
-    # @param [Array<TranslationUnit>] A list of translation units
-    # @param [Locale] Source locale
-    # @return A new TMX object
-    def initialize(units, source_locale, origin)
+    # @param units [Array<TranslationUnit>] A list of translation units
+    # @param source_locale [Locale] Source locale
+    # @return [Translatomatic::TMX::Document] a new TMX object
+    def initialize(units, source_locale)
       units = [units] unless units.kind_of?(Array)
       @units = units
       @source_locale = source_locale
-      @origin = origin
     end
 
     # @return [String] An XML string
@@ -25,7 +24,7 @@ module Translatomatic::TMX
             segtype: "phrase",  # default segtype
             adminlang: @source_locale.to_s,
             srclang: @source_locale.to_s,
-            "o-tmx": @origin
+            "o-tmf": DEFAULT_OTMF
           )
           xml.body { tmx_body(xml) }
         end
@@ -34,20 +33,18 @@ module Translatomatic::TMX
     end
 
     # Create a TMX document from the given converter
-    # @param [Array<Translatomatic::Model::Text>] List of texts
+    # @param texts [Array<Translatomatic::Model::Text>] List of texts
     # @return [Translatomatic::TMX::Document] TMX document
     def self.from_texts(texts)
       # group texts by from_text_id to create units
       # source_locale: use from_text.locale
       # origin: use text.translator
-      origins = texts.collect { |i| i.translator }.compact.uniq
-      raise "Multiple origins in texts" if origins.length > 1
       sources = texts.select { |i| i.from_text.nil? }
       source_locales = sources.collect { |i| i.locale }.uniq
-      raise "Multiple source locales in texts" if source_locales.length > 1
+      raise t("tmx.multiple_locales") if source_locales.length > 1
       units = units_from_texts(texts)
 
-      return new(units, source_locales[0], origins[0])
+      return new(units, source_locales[0])
     end
 
     def self.valid?(xml)
@@ -63,6 +60,7 @@ module Translatomatic::TMX
     end
 
     TMX_DTD = "http://www.ttt.org/oscarstandards/tmx/tmx14.dtd"
+    DEFAULT_OTMF = "Translatomatic"
 
     def tmx_body(xml)
       @units.each do |unit|
@@ -88,7 +86,8 @@ module Translatomatic::TMX
 
       # create list of Translation Units
       texts_by_from_id.values.collect do |list|
-        tmx_unit(list.uniq.collect { |i| string(i.value, i.locale) })
+        strings = list.uniq.collect { |i| string(i.value, i.locale) }
+        tmx_unit(strings)
       end
     end
 

data/lib/translatomatic/tmx/translation_unit.rb

@@ -1,10 +1,14 @@
 module Translatomatic::TMX
+  # A TMX Translation Unit.
+  # A translation unit contains a list of strings, and is part of a TMX
+  # document.
+  # @see Translatomatic::TMX::Document
   class TranslationUnit
 
     # @return [Array<Translatomatic::String>] Strings in this translation unit
     attr_reader :strings
 
-    # @param [Array<Translatomatic::String>] list of strings
+    # @param strings [Array<Translatomatic::String>] List of strings
     def initialize(strings)
       @strings = strings || []
     end

data/lib/translatomatic/tmx.rb

@@ -1,3 +1,5 @@
+# Translation Memory Exchange
+# @see https://en.wikipedia.org/wiki/Translation_Memory_eXchange
 module Translatomatic::TMX; end
 
 require 'translatomatic/tmx/translation_unit'

data/lib/translatomatic/translation.rb

@@ -0,0 +1,30 @@
+module Translatomatic
+  # Data object describing a text translation
+  class Translation
+    # @return [Translatomatic::String] original string
+    attr_reader :original
+
+    # @return [Translatomatic::String] translated string
+    attr_accessor :result
+
+    # @return [Symbol] The name of the translator
+    attr_reader :translator
+
+    # @return [boolean] True if this translation came from the database
+    attr_reader :from_database
+
+    def initialize(original, result, translator = nil, from_database = false)
+      @original = original
+      @result = result
+      @translator = translator
+      @from_database = from_database
+    end
+
+    private
+
+    def string(string)
+      string.kind_of?(Translatomatic::String) ? string : Translatomatic::String.new(string)
+    end
+
+  end
+end