class Twine::Formatters::Android

Public Instance Methods

can_handle_directory?(path) click to toggle source
# File lib/twine/formatters/android.rb, line 18
def can_handle_directory?(path)
  Dir.entries(path).any? { |item| /^values.*$/.match(item) }
end
default_file_name() click to toggle source
# File lib/twine/formatters/android.rb, line 22
def default_file_name
  'strings.xml'
end
determine_language_given_path(path) click to toggle source
# File lib/twine/formatters/android.rb, line 26
def determine_language_given_path(path)
  path_arr = path.split(File::SEPARATOR)
  path_arr.each do |segment|
    if segment == 'values'
      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)

      return match[1].sub('-r', '-') if match
    end
  end

  return super
end
escape_value(value) click to toggle source

developer.android.com/guide/topics/resources/string-resource.html#FormattingAndStyling

# File lib/twine/formatters/android.rb, line 116
def escape_value(value)
  inside_cdata = /<\!\[CDATA\[((?!\]\]>).)*$/              # opening CDATA tag ('<![CDATA[') not followed by a closing tag (']]>')
  inside_opening_tag = /<(a|font|span|p)\s?((?!>).)*$/     # tag start ('<a ', '<font ', '<span ' or '<p ') not followed by a '>'

  # escape double and single quotes and & signs
  value = gsub_unless(value, '"', '\\"') { |substring| substring =~ inside_cdata || substring =~ inside_opening_tag }
  value = gsub_unless(value, "'", "\\'") { |substring| substring =~ inside_cdata }
  value = gsub_unless(value, /&/, '&amp;') { |substring| substring =~ inside_cdata || substring =~ inside_opening_tag }

  # if `value` contains a placeholder, escape all angle brackets
  # if not, escape opening angle brackes unless it's a supported styling tag
  # https://github.com/scelis/twine/issues/212
  # https://stackoverflow.com/questions/3235131/#18199543
  if number_of_twine_placeholders(value) > 0 or @options[:escape_all_tags]
    # matches all `<` but <![CDATA
    angle_bracket = /<(?!(\/?(\!\[CDATA)))/
  else
    # matches all '<' but <b>, <em>, <i>, <cite>, <dfn>, <big>, <small>, <font>, <tt>, <s>,
    # <strike>, <del>, <u>, <super>, <sub>, <ul>, <li>, <br>, <div>, <span>, <p>, <a>
    # and <![CDATA
    angle_bracket = /<(?!(\/?(b|em|i|cite|dfn|big|small|font|tt|s|strike|del|u|super|sub|ul|li|br|div|span|p|a|\!\[CDATA)))/
  end
  value = gsub_unless(value, angle_bracket, '&lt;') { |substring| substring =~ inside_cdata }

  # 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, '\@')
end
extension() click to toggle source
# File lib/twine/formatters/android.rb, line 14
def extension
  '.xml'
end
format_comment(definition, lang) click to toggle source
# File lib/twine/formatters/android.rb, line 100
def format_comment(definition, lang)
  "\t<!-- #{definition.comment.gsub('--', '—')} -->\n" if definition.comment
end
format_header(lang) click to toggle source
# File lib/twine/formatters/android.rb, line 84
def format_header(lang)
  "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<!-- Android Strings File -->\n<!-- Generated by Twine #{Twine::VERSION} -->\n<!-- Language: #{lang} -->"
end
format_name() click to toggle source
# File lib/twine/formatters/android.rb, line 10
def format_name
  'android'
end
format_section_header(section) click to toggle source
# File lib/twine/formatters/android.rb, line 96
def format_section_header(section)
  "\t<!-- SECTION: #{section.name} -->"
end
format_sections(twine_file, lang) click to toggle source
# File lib/twine/formatters/android.rb, line 88
def format_sections(twine_file, lang)
  result = '<resources>'
  
  result += super + "\n"

  result += "</resources>\n"
end
format_value(value) click to toggle source

see developer.android.com/guide/topics/resources/string-resource.html#FormattingAndStyling however unescaped HTML markup like in “Welcome to Android!” is stripped when retrieved with getString() (stackoverflow.com/questions/9891996/)

# File lib/twine/formatters/android.rb, line 147
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
gsub_unless(text, pattern, replacement) { |text| ... } click to toggle source
# File lib/twine/formatters/android.rb, line 108
def gsub_unless(text, pattern, replacement)
  text.gsub(pattern) do |match|
    match_start_position = Regexp.last_match.offset(0)[0]
    yield(text[0, match_start_position]) ? match : replacement
  end
end
key_value_pattern() click to toggle source
# File lib/twine/formatters/android.rb, line 104
def key_value_pattern
  "\t<string name=\"%{key}\">%{value}</string>"
end
output_path_for_language(lang) click to toggle source
# File lib/twine/formatters/android.rb, line 43
def output_path_for_language(lang)
  if lang == @twine_file.language_codes[0]
    "values"
  else
    "values-#{lang}".gsub(/-(\p{Lu})/, '-r\1')
  end
end
read(io, lang) click to toggle source
# File lib/twine/formatters/android.rb, line 61
def read(io, lang)
  document = REXML::Document.new io, :compress_whitespace => %w{ string }
  document.context[:attribute_quote] = :quote
  comment = nil
  document.root.children.each do |child|
    if child.is_a? REXML::Comment
      content = child.string.strip
      content.gsub!(/[\s]+/, ' ')
      comment = content if content.length > 0 and not content.start_with?("SECTION:")
    elsif child.is_a? REXML::Element
      next unless child.name == 'string'

      key = child.attributes['name']

      content = child.children.map(&:to_s).join
      set_translation_for_key(key, lang, content)
      set_comment_for_key(key, comment) if comment

      comment = nil
    end 
  end
end
set_translation_for_key(key, lang, value) click to toggle source
# File lib/twine/formatters/android.rb, line 51
def set_translation_for_key(key, lang, value)
  value = CGI.unescapeHTML(value)
  value.gsub!('\\\'', '\'')
  value.gsub!('\\"', '"')
  value = convert_placeholders_from_android_to_twine(value)
  value.gsub!('\@', '@')
  value.gsub!(/(\\u0020)*|(\\u0020)*\z/) { |spaces| ' ' * (spaces.length / 6) }
  super(key, lang, value)
end