1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
|
require 'tmpdir'
require 'fileutils'
Twine::Plugin.new # Initialize plugins first in Runner.
module Twine
class Runner
def self.run(args)
options = CLI.parse(args)
return unless options
twine_file = TwineFile.new
twine_file.read options[:twine_file]
runner = new(options, twine_file)
case options[:command]
when 'generate-localization-file'
runner.generate_localization_file
when 'generate-all-localization-files'
runner.generate_all_localization_files
when 'consume-localization-file'
runner.consume_localization_file
when 'consume-all-localization-files'
runner.consume_all_localization_files
when 'generate-localization-archive'
runner.generate_localization_archive
when 'consume-localization-archive'
runner.consume_localization_archive
when 'validate-twine-file'
runner.validate_twine_file
end
end
def initialize(options = {}, twine_file = TwineFile.new)
@options = options
@twine_file = twine_file
end
def write_twine_data(path)
if @options[:developer_language]
@twine_file.set_developer_language_code(@options[:developer_language])
end
@twine_file.write(path)
end
def generate_localization_file
validate_twine_file if @options[:validate]
lang = nil
lang = @options[:languages][0] if @options[:languages]
formatter, lang = prepare_read_write(@options[:output_path], lang)
output = formatter.format_file(lang)
raise Twine::Error.new "Nothing to generate! The resulting file would not contain any translations." unless output
IO.write(@options[:output_path], output, encoding: output_encoding)
end
def generate_all_localization_files
validate_twine_file if @options[:validate]
if !File.directory?(@options[:output_path])
if @options[:create_folders]
FileUtils.mkdir_p(@options[:output_path])
else
raise Twine::Error.new("Directory does not exist: #{@options[:output_path]}")
end
end
formatter_for_directory = find_formatter { |f| f.can_handle_directory?(@options[:output_path]) }
formatter = formatter_for_format(@options[:format]) || formatter_for_directory
unless formatter
raise Twine::Error.new "Could not determine format given the contents of #{@options[:output_path]}"
end
file_name = @options[:file_name] || formatter.default_file_name
if @options[:create_folders]
@twine_file.language_codes.each do |lang|
output_path = File.join(@options[:output_path], formatter.output_path_for_language(lang))
FileUtils.mkdir_p(output_path)
file_path = File.join(output_path, file_name)
output = formatter.format_file(lang)
unless output
Twine::stderr.puts "Skipping file at path #{file_path} since it would not contain any translations."
next
end
IO.write(file_path, output, encoding: output_encoding)
end
else
language_found = false
Dir.foreach(@options[:output_path]) do |item|
next if item == "." or item == ".."
output_path = File.join(@options[:output_path], item)
next unless File.directory?(output_path)
lang = formatter.determine_language_given_path(output_path)
next unless lang
language_found = true
file_path = File.join(output_path, file_name)
output = formatter.format_file(lang)
unless output
Twine::stderr.puts "Skipping file at path #{file_path} since it would not contain any translations."
next
end
IO.write(file_path, output, encoding: output_encoding)
end
unless language_found
raise Twine::Error.new("Failed to generate any files: No languages found at #{@options[:output_path]}")
end
end
end
def generate_localization_archive
validate_twine_file if @options[:validate]
require_rubyzip
if File.file?(@options[:output_path])
File.delete(@options[:output_path])
end
Dir.mktmpdir do |temp_dir|
Zip::File.open(@options[:output_path], Zip::File::CREATE) do |zipfile|
zipfile.mkdir('Locales')
formatter = formatter_for_format(@options[:format])
@twine_file.language_codes.each do |lang|
if @options[:languages] == nil || @options[:languages].length == 0 || @options[:languages].include?(lang)
file_name = lang + formatter.extension
temp_path = File.join(temp_dir, file_name)
zip_path = File.join('Locales', file_name)
output = formatter.format_file(lang)
unless output
Twine::stderr.puts "Skipping file #{file_name} since it would not contain any translations."
next
end
IO.write(temp_path, output, encoding: output_encoding)
zipfile.add(zip_path, temp_path)
end
end
end
end
end
def consume_localization_file
lang = nil
if @options[:languages]
lang = @options[:languages][0]
end
read_localization_file(@options[:input_path], lang)
output_path = @options[:output_path] || @options[:twine_file]
write_twine_data(output_path)
end
def consume_all_localization_files
if !File.directory?(@options[:input_path])
raise Twine::Error.new("Directory does not exist: #{@options[:input_path]}")
end
Dir.glob(File.join(@options[:input_path], "**/*")) do |item|
if File.file?(item)
begin
read_localization_file(item)
rescue Twine::Error => e
Twine::stderr.puts "#{e.message}"
end
end
end
output_path = @options[:output_path] || @options[:twine_file]
write_twine_data(output_path)
end
def consume_localization_archive
require_rubyzip
if !File.file?(@options[:input_path])
raise Twine::Error.new("File does not exist: #{@options[:input_path]}")
end
Dir.mktmpdir do |temp_dir|
Zip::File.open(@options[:input_path]) do |zipfile|
zipfile.each do |entry|
next if entry.name.end_with? '/' or File.basename(entry.name).start_with? '.'
real_path = File.join(temp_dir, entry.name)
FileUtils.mkdir_p(File.dirname(real_path))
zipfile.extract(entry.name, real_path)
begin
read_localization_file(real_path)
rescue Twine::Error => e
Twine::stderr.puts "#{e.message}"
end
end
end
end
output_path = @options[:output_path] || @options[:twine_file]
write_twine_data(output_path)
end
def validate_twine_file
total_definitions = 0
all_keys = Set.new
duplicate_keys = Set.new
keys_without_tags = Set.new
invalid_keys = Set.new
valid_key_regex = /^[A-Za-z0-9_]+$/
@twine_file.sections.each do |section|
section.definitions.each do |definition|
total_definitions += 1
duplicate_keys.add(definition.key) if all_keys.include? definition.key
all_keys.add(definition.key)
keys_without_tags.add(definition.key) if definition.tags == nil or definition.tags.length == 0
invalid_keys << definition.key unless definition.key =~ valid_key_regex
end
end
errors = []
join_keys = lambda { |set| set.map { |k| " " + k }.join("\n") }
unless duplicate_keys.empty?
errors << "Found duplicate key(s):\n#{join_keys.call(duplicate_keys)}"
end
if @options[:pedantic]
if keys_without_tags.length == total_definitions
errors << "None of your definitions have tags."
elsif keys_without_tags.length > 0
errors << "Found definitions without tags:\n#{join_keys.call(keys_without_tags)}"
end
end
unless invalid_keys.empty?
errors << "Found key(s) with invalid characters:\n#{join_keys.call(invalid_keys)}"
end
raise Twine::Error.new errors.join("\n\n") unless errors.empty?
Twine::stdout.puts "#{@options[:twine_file]} is valid."
end
private
def output_encoding
@options[:encoding] || 'UTF-8'
end
def require_rubyzip
begin
require 'zip'
rescue LoadError
raise Twine::Error.new "You must run 'gem install rubyzip' in order to create or consume localization archives."
end
end
def determine_language_given_path(path)
code = File.basename(path, File.extname(path))
return code if @twine_file.language_codes.include? code
end
def formatter_for_format(format)
find_formatter { |f| f.format_name == format }
end
def find_formatter(&block)
formatters = Formatters.formatters.select &block
if formatters.empty?
return nil
elsif formatters.size > 1
raise Twine::Error.new("Unable to determine format. Candidates are: #{formatters.map(&:format_name).join(', ')}. Please specify the format you want using '--format'")
end
formatter = formatters.first
formatter.twine_file = @twine_file
formatter.options = @options
formatter
end
def read_localization_file(path, lang = nil)
unless File.file?(path)
raise Twine::Error.new("File does not exist: #{path}")
end
formatter, lang = prepare_read_write(path, lang)
external_encoding = @options[:encoding] || Twine::Encoding.encoding_for_path(path)
IO.open(IO.sysopen(path, 'rb'), 'rb', external_encoding: external_encoding, internal_encoding: 'UTF-8') do |io|
io.read(2) if Twine::Encoding.has_bom?(path)
formatter.read(io, lang)
end
end
def prepare_read_write(path, lang)
formatter_for_path = find_formatter { |f| f.extension == File.extname(path) }
formatter = formatter_for_format(@options[:format]) || formatter_for_path
unless formatter
raise Twine::Error.new "Unable to determine format of #{path}"
end
lang = lang || determine_language_given_path(path) || formatter.determine_language_given_path(path)
unless lang
raise Twine::Error.new "Unable to determine language for #{path}"
end
@twine_file.language_codes << lang unless @twine_file.language_codes.include? lang
return formatter, lang
end
end
end
|