translatomatic 0.1.0 → 0.1.1

data/lib/translatomatic/resource_file/base.rb

@@ -1,137 +1,169 @@
-# @abstract Subclasses implement different types of resource files
-class Translatomatic::ResourceFile::Base
-
-  attr_accessor :locale
-  attr_accessor :path
-
-  # @return [Hash<String,String>] key -> value properties
-  attr_reader :properties
-
-  # Create a new resource file.
-  # If locale is unspecified, attempts to determine the locale of the file
-  # automatically, and if that fails, uses the default locale.
-  # @param [String] path Path to the file
-  # @param [String] locale Locale of the file contents
-  # @return [Translatomatic::ResourceFile::Base] the resource file.
-  def initialize(path, locale = nil)
-    @path = path.kind_of?(Pathname) ? path : Pathname.new(path)
-    @locale = locale || detect_locale || parse_locale(I18n.default_locale)
-    raise "unable to determine locale" unless @locale && @locale.language
-    @valid = false
-    @properties = {}
-  end
-
-  def format
-    self.class.name.demodulize.downcase.to_sym
-  end
-
-  # Create a path for the current resource file with a given locale
-  # @param [String] locale for the path
-  # @return [Pathname] The path of this resource file modified for the given locale
-  def locale_path(locale)
-    basename = path.sub_ext('').basename.to_s
-
-    extlist = extension_list
-    if extlist.length >= 2 && loc_idx = find_locale(extlist)
-      extlist[loc_idx] = locale.to_s
-    elsif valid_locale?(basename)
-      path.dirname + (locale.to_s + path.extname)
-    else
-      deunderscored = basename.sub(/_.*?$/, '')
-      filename = deunderscored + "_" + locale.to_s + path.extname
-      path.dirname + filename
-    end
-  end
-
-  # Set all properties
-  # @param [Hash<String,String>] properties New properties
-  def properties=(properties)
-    # use set rather that set @properties directly as subclasses override set()
-    properties.each do |key, value|
-      set(key, value)
-    end
-  end
-
-  # Get the value of a property
-  # @param [String] name The name of the property
-  # @return [String] The value of the property
-  def get(name)
-    @properties[name]
-  end
-
-  # Set a property
-  # @param [String] key The name of the property
-  # @param [String] value The new value of the property
-  # @return [String] The new value of the property
-  def set(name, value)
-    @properties[name] = value
-  end
-
-  # Test if the current resource file is valid
-  # @return true if the current file is valid
-  def valid?
-    @valid
-  end
-
-  # Save the resource file.
-  # @param [Pathname] target The destination path
-  # @return [void]
-  def save(target = path)
-    raise "save(path) must be implemented by subclass"
-  end
-
-  # @return [String] String representation of this file
-  def to_s
-    "#{path.basename.to_s} (#{locale})"
-  end
-
-  private
-
-  include Translatomatic::Util
-
-  # detect locale from filename
-  def detect_locale
-    tag = nil
-    basename = path.sub_ext('').basename.to_s
-    directory = path.dirname.basename.to_s
-    extlist = extension_list
-
-    if basename.match(/_([-\w]{2,})$/i)
-      # locale after underscore in filename
-      tag = $1
-    elsif directory.match(/^([-\w]+)\.lproj$/)
-      # xcode localized strings
-      tag = $1
-    elsif extlist.length >= 2 && loc_idx = find_locale(extlist)
-      # multiple parts to extension, e.g. index.html.en
-      tag = extlist[loc_idx]
-    elsif valid_locale?(basename)
-      # try to match on entire basename
-      # (support for rails en.yml)
-      tag = basename
-    end
-
-    tag ? parse_locale(tag, true) : nil
-  end
-
-  # test if the list of strings contains a valid locale
-  # return the index to the locale, or nil if no locales found
-  def find_locale(list)
-    list.find_index { |i| valid_locale?(i) }
-  end
-
-  # ext_sub() only removes the last extension
-  def strip_extensions
-    filename = path.basename.to_s
-    filename.sub!(/\..*$/, '')
-    path.parent + filename
-  end
-
-  # for index.html.de, returns ['html', 'de']
-  def extension_list
-    filename = path.basename.to_s
-    idx = filename.index('.')
-    idx && idx < filename.length - 1 ? filename[idx + 1..-1].split('.') : []
-  end
-
-end
+# @abstract Subclasses implement different types of resource files
+class Translatomatic::ResourceFile::Base
+
+  attr_accessor :locale
+  attr_accessor :path
+
+  # @return [Hash<String,String>] key -> value properties
+  attr_reader :properties
+
+  # @return [Array<String>] File extensions supported by this resource file
+  def self.extensions
+    raise "extensions must be implemented by subclass"
+  end
+
+  # Create a new resource file.
+  # If locale is unspecified, attempts to determine the locale of the file
+  # automatically, and if that fails, uses the default locale.
+  # @param [String] path Path to the file
+  # @param [String] locale Locale of the file contents
+  # @return [Translatomatic::ResourceFile::Base] the resource file.
+  def initialize(path, locale = nil)
+    @path = path.kind_of?(Pathname) ? path : Pathname.new(path)
+    @locale = locale || detect_locale || Translatomatic::Locale.default
+    raise "unable to determine locale" unless @locale && @locale.language
+    @valid = false
+    @properties = {}
+  end
+
+  # @return [String] The format of this resource file, e.g. "Properties"
+  def format
+    self.class.name.demodulize.downcase.to_sym
+  end
+
+  # Create a path for the current resource file with a given locale
+  # @param [String] locale for the path
+  # @return [Pathname] The path of this resource file modified for the given locale
+  def locale_path(locale)
+    basename = path.sub_ext('').basename.to_s
+
+    extlist = extension_list
+    if extlist.length >= 2 && loc_idx = find_locale(extlist)
+      # extension(s) contains locale, replace it
+      extlist[loc_idx] = locale.to_s
+    elsif valid_locale?(basename)
+      # basename is a locale name, replace it
+      path.dirname + (locale.to_s + path.extname)
+    else
+      # remove any underscore and trailing text from basename
+      deunderscored = basename.sub(/_.*?$/, '')
+      # add _locale.ext
+      filename = deunderscored + "_" + locale.to_s + path.extname
+      path.dirname + filename
+    end
+  end
+
+  # Set all properties
+  # @param [Hash<String,String>] properties New properties
+  def properties=(properties)
+    # use set rather that set @properties directly as subclasses override set()
+    properties.each do |key, value|
+      set(key, value)
+    end
+  end
+
+  # Get the value of a property
+  # @param [String] name The name of the property
+  # @return [String] The value of the property
+  def get(name)
+    @properties[name]
+  end
+
+  # Set a property
+  # @param [String] key The name of the property
+  # @param [String] value The new value of the property
+  # @return [String] The new value of the property
+  def set(name, value)
+    @properties[name] = value
+  end
+
+  # Test if the current resource file is valid
+  # @return true if the current file is valid
+  def valid?
+    @valid
+  end
+
+  # Save the resource file.
+  # @param [Pathname] target The destination path
+  # @param [Hash<Symbol, Object>] options Output format options
+  # @return [void]
+  def save(target = path, options = {})
+    raise "save(path) must be implemented by subclass"
+  end
+
+  # @return [String] String representation of this file
+  def to_s
+    "#{path.basename.to_s} (#{locale})"
+  end
+
+  def sentences
+    sentences = []
+    properties.values.each do |value|
+      string = Translatomatic::String.new(value, locale)
+      sentences += string.sentences
+    end
+    sentences
+  end
+
+  private
+
+  include Translatomatic::Util
+
+  def created_by
+    date = DateTime.now.strftime("%Y-%m-%d %H:%M")
+    "Created by Translatomatic #{Translatomatic::VERSION} #{date}"
+  end
+
+  # detect locale from filename
+  def detect_locale
+    tag = nil
+    basename = path.sub_ext('').basename.to_s
+    directory = path.dirname.basename.to_s
+    extlist = extension_list
+
+    if basename.match(/_([-\w]{2,})$/i)
+      # locale after underscore in filename
+      tag = $1
+    elsif directory.match(/^([-\w]+)\.lproj$/)
+      # xcode localized strings
+      tag = $1
+    elsif extlist.length >= 2 && loc_idx = find_locale(extlist)
+      # multiple parts to extension, e.g. index.html.en
+      tag = extlist[loc_idx]
+    elsif valid_locale?(basename)
+      # try to match on entire basename
+      # (support for rails en.yml)
+      tag = basename
+    elsif valid_locale?(path.parent.basename)
+      # try to match on parent directory, e.g. strings/en-US/text.resw
+      tag = path.parent.basename
+    end
+
+    tag ? Translatomatic::Locale.parse(tag, true) : nil
+  end
+
+  def valid_locale?(tag)
+    Translatomatic::Locale.new(tag).valid?
+  end
+
+  # test if the list of strings contains a valid locale
+  # return the index to the locale, or nil if no locales found
+  def find_locale(list)
+    list.find_index { |i| valid_locale?(i) }
+  end
+
+  # ext_sub() only removes the last extension
+  def strip_extensions
+    filename = path.basename.to_s
+    filename.sub!(/\..*$/, '')
+    path.parent + filename
+  end
+
+  # for index.html.de, returns ['html', 'de']
+  def extension_list
+    filename = path.basename.to_s
+    idx = filename.index('.')
+    idx && idx < filename.length - 1 ? filename[idx + 1..-1].split('.') : []
+  end
+
+end

data/lib/translatomatic/resource_file/html.rb

@@ -1,33 +1,51 @@
-module Translatomatic::ResourceFile
-  class HTML < XML
-
-    def self.extensions
-      %w{html htm shtml}
-    end
-
-    # (see Translatomatic::ResourceFile::Base#locale_path)
-    def locale_path(locale)
-      extlist = extension_list
-      if extlist.length >= 2 && loc_idx = find_locale(extlist)
-        # part of the extension is the locale
-        # replace that part with the new locale
-        extlist[loc_idx] = locale.to_s
-        new_extension = extlist.join(".")
-        return strip_extensions.sub_ext("." + new_extension)
-      else
-        # add locale extension
+module Translatomatic::ResourceFile
+  class HTML < XML
+
+    # (see Translatomatic::ResourceFile::Base.extensions)
+    def self.extensions
+      %w{html htm shtml}
+    end
+
+    # (see Translatomatic::ResourceFile::Base#locale_path)
+    def locale_path(locale)
+      extlist = extension_list
+      if extlist.length >= 2 && loc_idx = find_locale(extlist)
+        # part of the extension is the locale
+        # replace that part with the new locale
+        extlist[loc_idx] = locale.to_s
+        new_extension = extlist.join(".")
+        return strip_extensions.sub_ext("." + new_extension)
+      else
+        # add locale extension
         ext = path.extname
-        path.sub_ext("#{ext}." + locale.to_s)
-      end
+        # TODO: need configurable order for locale & ext here?
+        #path.sub_ext("#{ext}." + locale.to_s)
+        path.sub_ext("." + locale.to_s + ext)
+      end
+    end
+
+    # (see Translatomatic::ResourceFile::Base#save)
+    def save(target = path, options = {})
+      if @doc
+        add_created_by unless options[:no_created_by]
+        target.write(@doc.to_html)
+      end
+    end
+
+    private
 
-      # fall back to base functionality
-      #super(locale)
+    def text_nodes_xpath
+      '//*[not(self::code)]/text()'
     end
 
-    # (see Translatomatic::ResourceFile::Base#save(path))
-    def save(target = path)
-      target.write(@doc.to_html) if @doc
+    def add_created_by
+      @created_by ||= @doc.root.add_previous_sibling(comment(created_by))
     end
-
-  end
-end
+
+    def read_doc(path)
+      Nokogiri::HTML(path.open) do |config|
+        config.noblanks
+      end
+    end
+  end
+end

data/lib/translatomatic/resource_file/markdown.rb

@@ -0,0 +1,54 @@
+require 'kramdown'
+require 'reverse_markdown'
+
+module Translatomatic::ResourceFile
+  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
+          puts "error: #{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(e.message)
+        @valid = false
+        {}
+      end
+    end
+
+  end  # class
+end    # module

data/lib/translatomatic/resource_file/plist.rb

@@ -1,29 +1,30 @@
-module Translatomatic::ResourceFile
-  class Plist < XML
-
-    def self.extensions
-      %w{plist}
-    end
-
-    # (see Translatomatic::ResourceFile::Base#locale_path)
-    # @note localization files in XCode use the following file name
-    #   convention: Project/locale.lproj/filename
-    # @todo refactor this and xcode_strings.rb to use the same code
-    def locale_path(locale)
-      if path.to_s.match(/\/([-\w]+).lproj\/.+.plist$/)
-        # xcode style
-        filename = path.basename
-        path.parent.parent + (locale.to_s + ".lproj") + filename
-      else
-        super(locale)
-      end
-    end
-
-    private
-
-    def text_nodes_xpath
-      '//*[not(self::key)]/text()'
-    end
-
-  end # class
-end   # module
+module Translatomatic::ResourceFile
+  class Plist < XML
+
+    # (see Translatomatic::ResourceFile::Base.extensions)
+    def self.extensions
+      %w{plist}
+    end
+
+    # (see Translatomatic::ResourceFile::Base#locale_path)
+    # @note localization files in XCode use the following file name
+    #   convention: Project/locale.lproj/filename
+    # @todo refactor this and xcode_strings.rb to use the same code
+    def locale_path(locale)
+      if path.to_s.match(/\/([-\w]+).lproj\/.+.plist$/)
+        # xcode style
+        filename = path.basename
+        path.parent.parent + (locale.to_s + ".lproj") + filename
+      else
+        super(locale)
+      end
+    end
+
+    private
+
+    def text_nodes_xpath
+      '//*[not(self::key)]/text()'
+    end
+
+  end # class
+end   # module

data/lib/translatomatic/resource_file/properties.rb

@@ -1,60 +1,72 @@
-module Translatomatic::ResourceFile
-  class Properties < Base
-
-    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(target))
-    def save(target = path)
-      out = ""
-      properties.each do |key, value|
-        # TODO: maintain original line ending format?
-        value = value.gsub("\n", "\\n")  # convert newlines to \n
-        out += "#{key} = #{value}\n"
-      end
-      # escape unicode characters
-      out = Translatomatic::EscapedUnicode.escape(out)
-      target.write(out)
-    end
-
-    private
-
-    # 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("=")
-
-        if line[0] == ?! || line[0] == ?#
-          # comment
-          # TODO: translate comments or keep originals?
-          next
-        elsif equal_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
+  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")  # convert newlines to \n
+        out += "#{key} = #{value}\n"
+      end
+      # escape unicode characters
+      out = Translatomatic::EscapedUnicode.escape(out)
+      target.write(out)
+    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("=")
+
+        if line[0] == ?! || line[0] == ?#
+          # comment
+          # TODO: translate comments or keep originals?
+          next
+        elsif equal_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