Class: Twine::Formatters::Android

Inherits:
Abstract
  • Object
show all
Includes:
Placeholders
Defined in:
lib/twine/formatters/android.rb

Constant Summary collapse

FORMAT_NAME = 
'android'
EXTENSION = 
'.xml'
DEFAULT_FILE_NAME = 
'strings.xml'
LANG_CODES = 
Hash[
  'zh' => 'zh-Hans',
  'zh-rCN' => 'zh-Hans',
  'zh-rHK' => 'zh-Hant',
  'en-rGB' => 'en-UK',
  'in' => 'id',
  'nb' => 'no'
  # TODO: spanish
]

Constants included from Placeholders

Placeholders::PLACEHOLDER_FLAGS_WIDTH_PRECISION_LENGTH, Placeholders::PLACEHOLDER_PARAMETER_FLAGS_WIDTH_PRECISION_LENGTH

Instance Attribute Summary

Attributes inherited from Abstract

#options, #strings

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Placeholders

#convert_placeholders_from_android_to_twine, #convert_placeholders_from_twine_to_android

Methods inherited from Abstract

#escape_quotes, #format_file, #format_key, #format_key_value, #format_row, #format_section, #initialize, #output_path_for_language, #row_pattern, #set_comment_for_key, #write_all_files, #write_file

Constructor Details

This class inherits a constructor from Twine::Formatters::Abstract

Class Method Details

.can_handle_directory?(path) ⇒ Boolean

Returns:

  • (Boolean) 


23
24
25
 
# File 'lib/twine/formatters/android.rb', line 23

def self.can_handle_directory?(path)
  Dir.entries(path).any? { |item| /^values.*$/.match(item) }
end

Instance Method Details

#default_file_name ⇒ Object 



27
28
29
 
# File 'lib/twine/formatters/android.rb', line 27

def default_file_name
  return DEFAULT_FILE_NAME
end

#determine_language_given_path(path) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/twine/formatters/android.rb', line 31

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]
    else
      match = /^values-(.*)$/.match(segment)
      if match
        lang = match[1]
        lang = LANG_CODES.fetch(lang, lang)
        lang.sub!('-r', '-')
        return lang
      end
    end
  end

  return
end

#format_comment(row, lang) ⇒ Object 



111
112
113
 
# File 'lib/twine/formatters/android.rb', line 111

def format_comment(row, lang)
  "\t<!-- #{row.comment.gsub('--', '—')} -->\n" if row.comment
end

#format_header(lang) ⇒ Object 



95
96
97
 
# File 'lib/twine/formatters/android.rb', line 95

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_section_header(section) ⇒ Object 



107
108
109
 
# File 'lib/twine/formatters/android.rb', line 107

def format_section_header(section)
  "\t<!-- SECTION: #{section.name} -->"
end

#format_sections(strings, lang) ⇒ Object 



99
100
101
102
103
104
105
 
# File 'lib/twine/formatters/android.rb', line 99

def format_sections(strings, lang)
  result = '<resources>'
  
  result += super + "\n"

  result += '</resources>'
end

#format_value(value) ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/twine/formatters/android.rb', line 119

def format_value(value)
  # Android enforces the following rules on the values
  #  1) apostrophes and quotes must be escaped with a backslash
  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)
  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(/\A *| *\z/) { |spaces| '\u0020' * spaces.length }
end

#key_value_pattern ⇒ Object 



115
116
117
 
# File 'lib/twine/formatters/android.rb', line 115

def key_value_pattern
  "\t<string name=\"%{key}\">%{value}</string>"
end

#read_file(path, lang) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/twine/formatters/android.rb', line 60

def read_file(path, lang)
  resources_regex = /<resources(?:[^>]*)>(.*)<\/resources>/m
  key_regex = /<string name="(\w+)">/
  comment_regex = /<!-- (.*) -->/
  value_regex = /<string name="\w+">(.*)<\/string>/
  key = nil
  value = nil
  comment = nil

  File.open(path, 'r:UTF-8') do |f|
    content_match = resources_regex.match(f.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
    end
  end
end

#set_translation_for_key(key, lang, value) ⇒ Object 



50
51
52
53
54
55
56
57
58
 
# File 'lib/twine/formatters/android.rb', line 50

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