twine 0.9.1 → 0.10.0

data/lib/twine/formatters.rb

@@ -18,8 +18,3 @@ module Twine
     end
   end
 end
-
-require File.join(File.dirname(__FILE__), 'formatters', 'abstract.rb')
-Dir[File.join(File.dirname(__FILE__), 'formatters', '*.rb')].each do |file|
-  require file
-end

data/lib/twine/formatters/abstract.rb

@@ -3,11 +3,11 @@ require 'fileutils'
 module Twine
   module Formatters
     class Abstract
-      attr_accessor :strings
+      attr_accessor :twine_file
       attr_accessor :options
 
       def initialize
-        @strings = StringsFile.new
+        @twine_file = TwineFile.new
         @options = {}
       end
 
@@ -20,7 +20,7 @@ module Twine
       end
 
       def can_handle_directory?(path)
-        raise NotImplementedError.new("You must implement can_handle_directory? in your formatter class.")
+        Dir.entries(path).any? { |item| /^.+#{Regexp.escape(extension)}$/.match(item) }
       end
 
       def default_file_name
@@ -30,47 +30,47 @@ module Twine
       def set_translation_for_key(key, lang, value)
         value = value.gsub("\n", "\\n")
 
-        if @strings.strings_map.include?(key)
-          row = @strings.strings_map[key]
-          reference = @strings.strings_map[row.reference_key] if row.reference_key
+        if @twine_file.definitions_by_key.include?(key)
+          definition = @twine_file.definitions_by_key[key]
+          reference = @twine_file.definitions_by_key[definition.reference_key] if definition.reference_key
 
           if !reference or value != reference.translations[lang]
-            row.translations[lang] = value
+            definition.translations[lang] = value
           end
         elsif @options[:consume_all]
-          Twine::stderr.puts "Adding new string '#{key}' to strings data file."
-          current_section = @strings.sections.find { |s| s.name == 'Uncategorized' }
+          Twine::stderr.puts "Adding new definition '#{key}' to twine file."
+          current_section = @twine_file.sections.find { |s| s.name == 'Uncategorized' }
           unless current_section
-            current_section = StringsSection.new('Uncategorized')
-            @strings.sections.insert(0, current_section)
+            current_section = TwineSection.new('Uncategorized')
+            @twine_file.sections.insert(0, current_section)
           end
-          current_row = StringsRow.new(key)
-          current_section.rows << current_row
+          current_definition = TwineDefinition.new(key)
+          current_section.definitions << current_definition
           
           if @options[:tags] && @options[:tags].length > 0
-            current_row.tags = @options[:tags]            
+            current_definition.tags = @options[:tags]            
           end
           
-          @strings.strings_map[key] = current_row
-          @strings.strings_map[key].translations[lang] = value
+          @twine_file.definitions_by_key[key] = current_definition
+          @twine_file.definitions_by_key[key].translations[lang] = value
         else
-          Twine::stderr.puts "Warning: '#{key}' not found in strings data file."
+          Twine::stderr.puts "Warning: '#{key}' not found in twine file."
         end
-        if !@strings.language_codes.include?(lang)
-          @strings.add_language_code(lang)
+        if !@twine_file.language_codes.include?(lang)
+          @twine_file.add_language_code(lang)
         end
       end
 
       def set_comment_for_key(key, comment)
         return unless @options[:consume_comments]
         
-        if @strings.strings_map.include?(key)
-          row = @strings.strings_map[key]
+        if @twine_file.definitions_by_key.include?(key)
+          definition = @twine_file.definitions_by_key[key]
           
-          reference = @strings.strings_map[row.reference_key] if row.reference_key
+          reference = @twine_file.definitions_by_key[definition.reference_key] if definition.reference_key
 
           if !reference or comment != reference.raw_comment
-            row.comment = comment
+            definition.comment = comment
           end
         end
       end
@@ -88,35 +88,35 @@ module Twine
       end
 
       def format_file(lang)
-        output_processor = Processors::OutputProcessor.new(@strings, @options)
-        processed_strings = output_processor.process(lang)
+        output_processor = Processors::OutputProcessor.new(@twine_file, @options)
+        processed_twine_file = output_processor.process(lang)
 
-        return nil if processed_strings.strings_map.empty?
+        return nil if processed_twine_file.definitions_by_key.empty?
 
         header = format_header(lang)
         result = ""
         result += header + "\n" if header
-        result += format_sections(processed_strings, lang)
+        result += format_sections(processed_twine_file, lang)
       end
 
       def format_header(lang)
       end
 
-      def format_sections(strings, lang)
-        sections = strings.sections.map { |section| format_section(section, lang) }
+      def format_sections(twine_file, lang)
+        sections = twine_file.sections.map { |section| format_section(section, lang) }
         sections.compact.join("\n")
       end
 
       def format_section_header(section)
       end
 
-      def should_include_row(row, lang)
-        row.translated_string_for_lang(lang)
+      def should_include_definition(definition, lang)
+        return !definition.translation_for_lang(lang).nil?
       end
 
       def format_section(section, lang)
-        rows = section.rows.select { |row| should_include_row(row, lang) }
-        return if rows.empty?
+        definitions = section.definitions.select { |definition| should_include_definition(definition, lang) }
+        return if definitions.empty?
 
         result = ""
 
@@ -125,22 +125,22 @@ module Twine
           result += "\n#{section_header}" if section_header
         end
 
-        rows.map! { |row| format_row(row, lang) }
-        rows.compact! # remove nil entries
-        rows.map! { |row| "\n#{row}" }  # prepend newline
-        result += rows.join
+        definitions.map! { |definition| format_definition(definition, lang) }
+        definitions.compact! # remove nil definitions
+        definitions.map! { |definition| "\n#{definition}" }  # prepend newline
+        result += definitions.join
       end
 
-      def format_row(row, lang)
-        [format_comment(row, lang), format_key_value(row, lang)].compact.join
+      def format_definition(definition, lang)
+        [format_comment(definition, lang), format_key_value(definition, lang)].compact.join
       end
 
-      def format_comment(row, lang)
+      def format_comment(definition, lang)
       end
 
-      def format_key_value(row, lang)
-        value = row.translated_string_for_lang(lang)
-        key_value_pattern % { key: format_key(row.key.dup), value: format_value(value.dup) }
+      def format_key_value(definition, lang)
+        value = definition.translation_for_lang(lang)
+        key_value_pattern % { key: format_key(definition.key.dup), value: format_value(value.dup) }
       end
 
       def key_value_pattern

data/lib/twine/formatters/android.rb

@@ -7,16 +7,6 @@ module Twine
     class Android < Abstract
       include Twine::Placeholders
 
-      LANG_MAPPINGS = Hash[
-        'zh-rCN' => 'zh-Hans',
-        'zh-rHK' => 'zh-Hant',
-        'en-rGB' => 'en-UK',
-        'zh' => 'zh-Hans',
-        'in' => 'id',
-        'nb' => 'no'
-        # TODO: spanish
-      ]
-
       def format_name
         'android'
       end
@@ -30,24 +20,20 @@ module Twine
       end
 
       def default_file_name
-        return 'strings.xml'
+        'strings.xml'
       end
 
       def determine_language_given_path(path)
         path_arr = path.split(File::SEPARATOR)
         path_arr.each do |segment|
           if segment == 'values'
-            return @strings.language_codes[0]
+            return @twine_file.language_codes[0]
           else
             # The language is defined by a two-letter ISO 639-1 language code, optionally followed by a two letter ISO 3166-1-alpha-2 region code (preceded by lowercase "r").
             # see http://developer.android.com/guide/topics/resources/providing-resources.html#AlternativeResources
             match = /^values-([a-z]{2}(-r[a-z]{2})?)$/i.match(segment)
-            if match
-              lang = match[1]
-              lang = LANG_MAPPINGS.fetch(lang, lang)
-              lang.sub!('-r', '-')
-              return lang
-            end
+            
+            return match[1].sub('-r', '-') if match
           end
         end
 
@@ -55,7 +41,7 @@ module Twine
       end
 
       def output_path_for_language(lang)
-        "values-" + (LANG_MAPPINGS.key(lang) || lang)
+        "values-#{lang}"
       end
 
       def set_translation_for_key(key, lang, value)
@@ -69,35 +55,23 @@ module Twine
       end
 
       def read(io, lang)
-        resources_regex = /<resources(?:[^>]*)>(.*)<\/resources>/m
-        key_regex = /<string name="(\w+)">/
-        comment_regex = /<!-- (.*) -->/
-        value_regex = /<string name="\w+">(.*)<\/string>/
-        key = nil
-        value = nil
+        document = REXML::Document.new io, :compress_whitespace => %w{ string }
+
         comment = nil
+        document.root.children.each do |child|
+          if child.is_a? REXML::Comment
+            content = child.string.strip
+            comment = content if content.length > 0 and not content.start_with?("SECTION:")
+          elsif child.is_a? REXML::Element
+            next unless child.name == 'string'
 
-        content_match = resources_regex.match(io.read)
-        if content_match
-          for line in content_match[1].split(/\r?\n/)
-            key_match = key_regex.match(line)
-            if key_match
-              key = key_match[1]
-              value_match = value_regex.match(line)
-              value = value_match ? value_match[1] : ""
-              
-              set_translation_for_key(key, lang, value)
-              if comment and comment.length > 0 and !comment.start_with?("SECTION:")
-                set_comment_for_key(key, comment)
-              end
-              comment = nil
-            end
-            
-            comment_match = comment_regex.match(line)
-            if comment_match
-              comment = comment_match[1]
-            end
-          end
+            key = child.attributes['name']
+
+            set_translation_for_key(key, lang, child.text)
+            set_comment_for_key(key, comment) if comment
+
+            comment = nil
+          end 
         end
       end
 
@@ -105,7 +79,7 @@ module Twine
         "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<!-- Android Strings File -->\n<!-- Generated by Twine #{Twine::VERSION} -->\n<!-- Language: #{lang} -->"
       end
 
-      def format_sections(strings, lang)
+      def format_sections(twine_file, lang)
         result = '<resources>'
         
         result += super + "\n"
@@ -117,27 +91,52 @@ module Twine
         "\t<!-- SECTION: #{section.name} -->"
       end
 
-      def format_comment(row, lang)
-        "\t<!-- #{row.comment.gsub('--', '—')} -->\n" if row.comment
+      def format_comment(definition, lang)
+        "\t<!-- #{definition.comment.gsub('--', '—')} -->\n" if definition.comment
       end
 
       def key_value_pattern
         "\t<string name=\"%{key}\">%{value}</string>"
       end
 
-      def format_value(value)
-        # Android enforces the following rules on the values
-        #  1) apostrophes and quotes must be escaped with a backslash
+      def escape_value(value)
+        # escape double and single quotes, & signs and tags
         value = escape_quotes(value)
         value.gsub!("'", "\\\\'")
-        #  2) HTML escape the string
-        value = CGI.escapeHTML(value)
-        #  3) convert placeholders (e.g. %@ -> %s)
-        value = convert_placeholders_from_twine_to_android(value)
-        #  4) escape non resource identifier @ signs (http://developer.android.com/guide/topics/resources/accessing-resources.html#ResourcesFromXml)
+        value.gsub!(/&/, '&amp;')
+        value.gsub!('<', '&lt;')
+
+        # escape non resource identifier @ signs (http://developer.android.com/guide/topics/resources/accessing-resources.html#ResourcesFromXml)
         resource_identifier_regex = /@(?!([a-z\.]+:)?[a-z+]+\/[a-zA-Z_]+)/   # @[<package_name>:]<resource_type>/<resource_name>
-        value.gsub!(resource_identifier_regex, '\@')
-        #  5) replace beginning and end spaces with \0020. Otherwise Android strips them.
+        value.gsub(resource_identifier_regex, '\@')
+      end
+
+      # see http://developer.android.com/guide/topics/resources/string-resource.html#FormattingAndStyling
+      # however unescaped HTML markup like in "Welcome to <b>Android</b>!" is stripped when retrieved with getString() (http://stackoverflow.com/questions/9891996/)
+      def format_value(value)
+        value = value.dup
+
+        # convert placeholders (e.g. %@ -> %s)
+        value = convert_placeholders_from_twine_to_android(value)
+
+        # capture xliff tags and replace them with a placeholder
+        xliff_tags = []
+        value.gsub! /<xliff:g.+?<\/xliff:g>/ do
+          xliff_tags << $&
+          'TWINE_XLIFF_TAG_PLACEHOLDER'
+        end
+
+        # escape everything outside xliff tags
+        value = escape_value(value)
+
+        # put xliff tags back into place
+        xliff_tags.each do |xliff_tag|
+          # escape content of xliff tags
+          xliff_tag.gsub! /(<xliff:g.*?>)(.*)(<\/xliff:g>)/ do "#{$1}#{escape_value($2)}#{$3}" end
+          value.sub! 'TWINE_XLIFF_TAG_PLACEHOLDER', xliff_tag
+        end
+        
+        # replace beginning and end spaces with \u0020. Otherwise Android strips them.
         value.gsub(/\A *| *\z/) { |spaces| '\u0020' * spaces.length }
       end
 

data/lib/twine/formatters/apple.rb

@@ -14,7 +14,7 @@ module Twine
       end
 
       def default_file_name
-        return 'Localizable.strings'
+        'Localizable.strings'
       end
 
       def determine_language_given_path(path)
@@ -73,8 +73,8 @@ module Twine
         "\"%{key}\" = \"%{value}\";\n"
       end
 
-      def format_comment(row, lang)
-        "/* #{row.comment.gsub('*/', '* /')} */\n" if row.comment
+      def format_comment(definition, lang)
+        "/* #{definition.comment.gsub('*/', '* /')} */\n" if definition.comment
       end
 
       def format_key(key)

data/lib/twine/formatters/django.rb

@@ -9,23 +9,17 @@ module Twine
         '.po'
       end
 
-      def can_handle_directory?(path)
-        Dir.entries(path).any? { |item| /^.+\.po$/.match(item) }
-      end
-
       def default_file_name
-        return 'strings.po'
+        'strings.po'
       end
 
       def determine_language_given_path(path)
-          path_arr = path.split(File::SEPARATOR)
-          path_arr.each do |segment|
-              match = /(..)\.po$/.match(segment)
-              if match
-                  return match[1]
-              end
-          end
-          
+        path_arr = path.split(File::SEPARATOR)
+        path_arr.each do |segment|
+          match = /(..)\.po$/.match(segment)
+          return match[1] if match
+        end
+        
         return
       end
 
@@ -63,26 +57,26 @@ module Twine
       end
 
       def format_file(lang)
-        @default_lang = @strings.language_codes[0]
+        @default_lang = @twine_file.language_codes[0]
         result = super
         @default_lang = nil
         result
       end
 
       def format_header(lang)
-        "##\n # Django Strings File\n # Generated by Twine #{Twine::VERSION}\n # Language: #{lang}\n"
+        "##\n # Django Strings File\n # Generated by Twine #{Twine::VERSION}\n # Language: #{lang}\nmsgid \"\"\nmsgstr \"\"\n\"Content-Type: text/plain; charset=UTF-8\\n\""
       end
 
       def format_section_header(section)
         "#--------- #{section.name} ---------#\n"
       end
 
-      def format_row(row, lang)
-        [format_comment(row, lang), format_base_translation(row), format_key_value(row, lang)].compact.join
+      def format_definition(definition, lang)
+        [format_comment(definition, lang), format_base_translation(definition), format_key_value(definition, lang)].compact.join
       end
 
-      def format_base_translation(row)
-        base_translation = row.translations[@default_lang]
+      def format_base_translation(definition)
+        base_translation = definition.translations[@default_lang]
         "# base translation: \"#{base_translation}\"\n" if base_translation
       end
 
@@ -91,8 +85,8 @@ module Twine
         "msgstr \"%{value}\"\n"
       end
 
-      def format_comment(row, lang)
-        "#. #{escape_quotes(row.comment)}\n" if row.comment
+      def format_comment(definition, lang)
+        "#. #{escape_quotes(definition.comment)}\n" if definition.comment
       end
 
       def format_key(key)

data/lib/twine/formatters/flash.rb

@@ -1,6 +1,8 @@
 module Twine
   module Formatters
     class Flash < Abstract
+      include Twine::Placeholders
+
       def format_name
         'flash'
       end
@@ -9,16 +11,18 @@ module Twine
         '.properties'
       end
 
-      def can_handle_directory?(path)
-        return false
-      end
-
       def default_file_name
-        return 'resources.properties'
+        'resources.properties'
       end
 
       def determine_language_given_path(path)
-        return
+        # match two-letter language code, optionally followed by a two letter region code
+        path.split(File::SEPARATOR).reverse.find { |segment| segment =~ /^([a-z]{2}(-[a-z]{2})?)$/i }
+      end
+
+      def set_translation_for_key(key, lang, value)
+        value = convert_placeholders_from_flash_to_twine(value)
+        super(key, lang, value)
       end
 
       def read(io, lang)
@@ -28,23 +32,17 @@ module Twine
           if match
             key = match[1]
             value = match[2].strip
-            value.gsub!(/\{[0-9]\}/, '%@')
+
             set_translation_for_key(key, lang, value)
-            if last_comment
-              set_comment_for_key(key, last_comment)
-            end
+            set_comment_for_key(key, last_comment) if last_comment
           end
           
           match = /# *(.*)/.match(line)
-          if match
-            last_comment = match[1]
-          else
-            last_comment = nil
-          end
+          last_comment = match ? match[1] : nil
         end
       end
 
-      def format_sections(strings, lang)
+      def format_sections(twine_file, lang)
         super + "\n"
       end
 
@@ -56,8 +54,8 @@ module Twine
         "## #{section.name} ##\n"
       end
 
-      def format_comment(row, lang)
-        "# #{row.comment}\n" if row.comment
+      def format_comment(definition, lang)
+        "# #{definition.comment}\n" if definition.comment
       end
 
       def key_value_pattern
@@ -65,8 +63,7 @@ module Twine
       end
 
       def format_value(value)
-        placeHolderNumber = -1
-        value.gsub(/%[d@]/) { placeHolderNumber += 1; '{%d}' % placeHolderNumber }
+        convert_placeholders_from_twine_to_flash(value)
       end
     end
   end