organicmaps/twine
Archived
13
Fork 0
Code Issues 1 Pull requests 2 Projects Releases Wiki Activity Actions

Replaced unit tests with more targeted tests aimed to test the functionality thoroghly. Closes #91.

Browse source
This commit is contained in:
Sebastian Ludwig 2015-11-27 15:02:58 +01:00
parent c0cff7d0dc
commit d3128cdbd9
62 changed files with 804 additions and 615 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
Rakefile
View file

@ -3,7 +3,6 @@ require 'rake/testtask'
Rake::TestTask.new do |t|
t.libs = ['lib', 'test']
t.pattern = 'test/**/*_test.rb'
end
task :default => :test

5
lib/twine/runner.rb
View file

@ -7,9 +7,10 @@ module Twine
VALID_COMMANDS = ['generate-string-file', 'generate-all-string-files', 'consume-string-file', 'consume-all-string-files', 'generate-loc-drop', 'consume-loc-drop', 'validate-strings-file']
class Runner
def initialize(args)
@options = {}
def initialize(args, options = nil)
@options = options || {}
@args = args
@strings = StringsFile.new
end
def self.run(args)

19
test/command_test_case.rb Normal file
View file

@ -0,0 +1,19 @@
require 'twine_test_case'
class CommandTestCase < TwineTestCase
def prepare_mock_formatter(formatter_class)
formatter = formatter_class.new(@mock_strings, {})
formatter_class.stubs(:new).returns(formatter)
formatter
end
def setup
super
@known_languages = %w(en fr de es)
@mock_strings = Twine::StringsFile.new
@mock_strings.language_codes.concat @known_languages
Twine::StringsFile.stubs(:new).returns(@mock_strings)
end
end

5
test/fixtures/en-1.json vendored
View file

@ -1,5 +0,0 @@
{
"key1":"key1-english",
"key3":"key3-english",
"key5":"A new string"
}

16
test/fixtures/en-1.po vendored
View file

@ -1,16 +0,0 @@
msgid ""
msgstr ""
"Language: en\n"
"X-Generator: Twine\n"
msgctxt "key1"
msgid "key1-english"
msgstr "key1-english"
msgctxt "key3"
msgid "key3-english"
msgstr ""
msgctxt "key5"
msgid "A new string"
msgstr "A new string"

10
test/fixtures/en-1.strings vendored
View file

@ -1,10 +0,0 @@
/**
* iOS Strings File
* Generated by Twine
* Language: en
*/
/* My Strings */
"key1" = "key1-english";
"key3" = "key3-english";
"key5" = "A new string";

23
test/fixtures/en-2.po vendored
View file

@ -1,23 +0,0 @@
msgid ""
msgstr ""
"Language: en\n"
"X-Generator: Twine\n"
msgctxt "key1"
msgid "key1-english"
msgstr "key1-english"
msgctxt "key3"
msgid "key3-english"
msgstr ""
msgctxt "key4"
msgid "key4"
"multiline"
msgstr "A multi"
"line string\n"
"can occur"
msgctxt "key5"
msgid "A new string"
msgstr "A new string"

8
test/fixtures/en-3.xml vendored
View file

@ -1,8 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Android Strings File -->
<!-- Generated by Twine 0.5.0 -->
<!-- Language: en -->
<resources>
<!-- SECTION: My Strings -->
<string name="string_with_spaces">\u0020string with spaces\u0020\u0020</string>
</resources>

15
test/fixtures/formatter_android.xml vendored Normal file
View file

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Android Strings File -->
<!-- Generated by Twine <%= Twine::VERSION %> -->
<!-- Language: en -->
<resources>
<!-- SECTION: Section 1 -->
<!-- comment key1 -->
<string name="key1">value1-english</string>
<string name="key2">value2-english</string>
<!-- SECTION: Section 2 -->
<string name="key3">value3-english</string>
<!-- comment key4 -->
<string name="key4">value4-english</string>
</resources>

20
test/fixtures/formatter_apple.strings vendored Normal file
View file

@ -0,0 +1,20 @@
/**
* Apple Strings File
* Generated by Twine <%= Twine::VERSION %>
* Language: en
*/
/********** Section 1 **********/
/* comment key1 */
"key1" = "value1-english";
"key2" = "value2-english";
/********** Section 2 **********/
"key3" = "value3-english";
/* comment key4 */
"key4" = "value4-english";

27
test/fixtures/formatter_gettext.po vendored Normal file
View file

@ -0,0 +1,27 @@
msgid ""
msgstr ""
"Language: en\n"
"X-Generator: Twine <%= Twine::VERSION %>\n"
# SECTION: Section 1
#. "comment key1"
msgctxt "key1"
msgid "value1-english"
msgstr "value1-english"
msgctxt "key2"
msgid "value2-english"
msgstr "value2-english"
# SECTION: Section 2
msgctxt "key3"
msgid "value3-english"
msgstr "value3-english"
#. "comment key4"
msgctxt "key4"
msgid "value4-english"
msgstr "value4-english"

7
test/fixtures/formatter_jquery.json vendored Normal file
View file

@ -0,0 +1,7 @@
{
"key1":"value1-english",
"key2":"value2-english",
"key3":"value3-english",
"key4":"value4-english"
}

15
test/fixtures/formatter_tizen.xml vendored Normal file
View file

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Tizen Strings File -->
<!-- Generated by Twine <%= Twine::VERSION %> -->
<!-- Language: en -->
<string_table Bversion="2.0.0.201311071819" Dversion="20120315">
<!-- SECTION: Section 1 -->
<!-- comment key1 -->
<text id="IDS_KEY1">value1-english</text>
<text id="IDS_KEY2">value2-english</text>
<!-- SECTION: Section 2 -->
<text id="IDS_KEY3">value3-english</text>
<!-- comment key4 -->
<text id="IDS_KEY4">value4-english</text>
</string_table>

10
test/fixtures/fr-1.xml vendored
View file

@ -1,10 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Android Strings File -->
<!-- Generated by Twine -->
<!-- Language: fr -->
<resources>
<!-- This is a comment -->
<string name="key1">key1-french</string>
<string name="key2">key2-french</string>
<string name="key3">key3-french</string>
</resources>

10
test/fixtures/gettext_multiline.po vendored Normal file
View file

@ -0,0 +1,10 @@
msgid ""
msgstr ""
"Language: en\n"
"X-Generator: Twine\n"
msgctxt "key1"
msgid "key1"
msgstr "multi"
"line\n"
"string"

17
test/fixtures/strings-1.txt vendored
View file

@ -1,17 +0,0 @@
[[My Strings]]
[key1]
en = key1-english
tags = tag1
comment = This is a comment
es = key1-spanish
fr = key1-french
[key2]
en = key2-english
tags = tag2
fr = key2-french
[key3]
en = key3-english
tags = tag1,tag2
es = key3-spanish
[key4]
en = key4-english

5
test/fixtures/strings-2.txt vendored
View file

@ -1,5 +0,0 @@
[[My Strings]]
[key with space ]
en = `string with space `
tags = tag1
comment = String ends with space

5
test/fixtures/strings-3.txt vendored
View file

@ -1,5 +0,0 @@
[[My Strings]]
[parameterized_string]
en = The %@ brown fox jumps over the %@ dog %d times.
[percentage_string]
en = This product is %d%% off.

20
test/fixtures/strings-4-references.txt vendored
View file

@ -1,20 +0,0 @@
[[General]]
[key1]
en = key1-english
tags = tag1
comment = This is a comment
es = key1-spanish
fr = key1-french
[[My Strings]]
[key2]
ref = key1
[key3]
ref = key1
fr = key3-french
[key4]
ref = key1
comment = Different comment
[key5]
ref = [key1]
tags = tag2

5
test/fixtures/test-json-line-breaks/consumed.txt vendored
View file

@ -1,5 +0,0 @@
[[Line Break Strings]]
[line_breaking]
en = This\nstring\ncontains\nline\nbreaks
tags = tag1
fr = This\nstring\nalso\ncontains\nline\nbreaks

3
test/fixtures/test-json-line-breaks/generated.json vendored
View file

@ -1,3 +0,0 @@
{
"line_breaking":"This\nstring\ncontains\nline\nbreaks"
}

3
test/fixtures/test-json-line-breaks/line-breaks.json vendored
View file

@ -1,3 +0,0 @@
{
"line_breaking":"This\nstring\nalso\ncontains\nline\nbreaks"
}

4
test/fixtures/test-json-line-breaks/line-breaks.txt vendored
View file

@ -1,4 +0,0 @@
[[Line Break Strings]]
[line_breaking]
en = This\nstring\ncontains\nline\nbreaks
tags = tag1

12
test/fixtures/test-output-1.txt vendored
View file

@ -1,12 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Android Strings File -->
<!-- Generated by Twine <%= Twine::VERSION %> -->
<!-- Language: fr -->
<resources>
<!-- SECTION: My Strings -->
<!-- This is a comment -->
<string name="key1">key1-french</string>
<string name="key2">key2-french</string>
<string name="key3">key3-english</string>
<string name="key4">key4-english</string>
</resources>

9
test/fixtures/test-output-10.txt vendored
View file

@ -1,9 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Android Strings File -->
<!-- Generated by Twine <%= Twine::VERSION %> -->
<!-- Language: en -->
<resources>
<!-- SECTION: My Strings -->
<!-- String ends with space -->
<string name="key with space ">string with space\u0020</string>
</resources>

9
test/fixtures/test-output-11.txt vendored
View file

@ -1,9 +0,0 @@
[[Uncategorized]]
[string_with_spaces]
en = ` string with spaces `
[[My Strings]]
[key with space ]
en = `string with space `
tags = tag1
comment = String ends with space

12
test/fixtures/test-output-12.txt vendored
View file

@ -1,12 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Tizen Strings File -->
<!-- Generated by Twine <%= Twine::VERSION %> -->
<!-- Language: fr -->
<string_table Bversion="2.0.0.201311071819" Dversion="20120315">
<!-- SECTION: My Strings -->
<!-- This is a comment -->
<text id="IDS_KEY1">key1-french</text>
<text id="IDS_KEY2">key2-french</text>
<text id="IDS_KEY3">key3-english</text>
<text id="IDS_KEY4">key4-english</text>
</string_table>

10
test/fixtures/test-output-13.txt vendored
View file

@ -1,10 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Android Strings File -->
<!-- Generated by Twine <%= Twine::VERSION %> -->
<!-- Language: fr -->
<resources>
<!-- SECTION: My Strings -->
<!-- This is a comment -->
<string name="key1">key1-french</string>
<string name="key2">key2-french</string>
</resources>

17
test/fixtures/test-output-14-references.txt vendored
View file

@ -1,17 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Android Strings File -->
<!-- Generated by Twine <%= Twine::VERSION %> -->
<!-- Language: fr -->
<resources>
<!-- SECTION: General -->
<!-- This is a comment -->
<string name="key1">key1-french</string>
<!-- SECTION: My Strings -->
<!-- This is a comment -->
<string name="key2">key1-french</string>
<!-- This is a comment -->
<string name="key3">key3-french</string>
<!-- Different comment -->
<string name="key4">key1-french</string>
</resources>

9
test/fixtures/test-output-14.txt vendored
View file

@ -1,9 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Android Strings File -->
<!-- Generated by Twine <%= Twine::VERSION %> -->
<!-- Language: fr -->
<resources>
<!-- SECTION: My Strings -->
<string name="key3">key3-english</string>
<string name="key4">key4-english</string>
</resources>

12
test/fixtures/test-output-2.txt vendored
View file

@ -1,12 +0,0 @@
/**
* Apple Strings File
* Generated by Twine <%= Twine::VERSION %>
* Language: en
*/
/********** My Strings **********/
/* This is a comment */
"key1" = "key1-english";
"key3" = "key3-english";

18
test/fixtures/test-output-3.txt vendored
View file

@ -1,18 +0,0 @@
[[My Strings]]
[key1]
en = key1-english
tags = tag1
comment = This is a comment
es = key1-spanish
fr = key1-french
[key2]
en = key2-english
tags = tag2
fr = key2-french
[key3]
en = key3-english
tags = tag1,tag2
es = key3-spanish
fr = key3-french
[key4]
en = key4-english

21
test/fixtures/test-output-4.txt vendored
View file

@ -1,21 +0,0 @@
[[Uncategorized]]
[key5]
en = A new string
[[My Strings]]
[key1]
en = key1-english
tags = tag1
comment = This is a comment
es = key1-spanish
fr = key1-french
[key2]
en = key2-english
tags = tag2
fr = key2-french
[key3]
en = key3-english
tags = tag1,tag2
es = key3-spanish
[key4]
en = key4-english

4
test/fixtures/test-output-5.txt vendored
View file

@ -1,4 +0,0 @@
{
"key1":"key1-english",
"key3":"key3-english"
}

10
test/fixtures/test-output-6.txt vendored
View file

@ -1,10 +0,0 @@
/**
* Apple Strings File
* Generated by Twine <%= Twine::VERSION %>
* Language: en
*/
/********** My Strings **********/
/* String ends with space */
"key with space " = "string with space ";

16
test/fixtures/test-output-7.txt vendored
View file

@ -1,16 +0,0 @@
msgid ""
msgstr ""
"Language: en\n"
"X-Generator: Twine <%= Twine::VERSION %>\n"
# SECTION: My Strings
#. "This is a comment"
msgctxt "key1"
msgid "key1-english"
msgstr "key1-english"
msgctxt "key3"
msgid "key3-english"
msgstr "key3-english"

9
test/fixtures/test-output-8.txt vendored
View file

@ -1,9 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Android Strings File -->
<!-- Generated by Twine <%= Twine::VERSION %> -->
<!-- Language: en -->
<resources>
<!-- SECTION: My Strings -->
<string name="parameterized_string">The %1$s brown fox jumps over the %2$s dog %3$d times.</string>
<string name="percentage_string">This product is %d%% off.</string>
</resources>

21
test/fixtures/test-output-9.txt vendored
View file

@ -1,21 +0,0 @@
[[Uncategorized]]
[key5]
en = A new string
[[My Strings]]
[key1]
en = key1-english
tags = tag1
comment = This is a comment
es = key1-spanish
fr = key1-french
[key2]
en = key2-english
tags = tag2
fr = key2-french
[key3]
en = key3-english
tags = tag1,tag2
es = key3-spanish
[key4]
en = A multiline string\ncan occur

13
test/fixtures/twine_accent_values.txt vendored Normal file
View file

@ -0,0 +1,13 @@
[[Section]]
[value_with_leading_accent]
en = `value
[value_with_trailing_accent]
en = value`
[value_with_leading_space]
en = ` value`
[value_with_trailing_space]
en = `value `
[value_wrapped_by_spaces]
en = ` value `
[value_wrapped_by_accents]
en = ``value``

8
test/references/fixtures/different_comment.xml
View file

@ -1,8 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Android Strings File -->
<!-- Generated by Twine -->
<!-- Language: en -->
<resources>
<!-- Different comment -->
<string name="key2">key2-english</string>
</resources>

7
test/references/fixtures/different_value.xml
View file

@ -1,7 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Android Strings File -->
<!-- Generated by Twine -->
<!-- Language: en -->
<resources>
<string name="key2">key2-english</string>
</resources>

6
test/references/fixtures/empty.xml
View file

@ -1,6 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Android Strings File -->
<!-- Generated by Twine -->
<!-- Language: en -->
<resources>
</resources>

8
test/references/fixtures/same_comment.xml
View file

@ -1,8 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Android Strings File -->
<!-- Generated by Twine -->
<!-- Language: en -->
<resources>
<!-- Simple comment -->
<string name="key2">key2-english</string>
</resources>

7
test/references/fixtures/same_value.xml
View file

@ -1,7 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Android Strings File -->
<!-- Generated by Twine -->
<!-- Language: en -->
<resources>
<string name="key2">key1-english</string>
</resources>

7
test/references/fixtures/twine_comment_reference.txt
View file

@ -1,7 +0,0 @@
[[General]]
[key1]
en = key1-english
comment = Simple comment
[key2]
en = key2-english
ref = key1

7
test/references/fixtures/twine_tag_reference.txt
View file

@ -1,7 +0,0 @@
[[General]]
[key1]
en = key1-english
tags = tag1
[key2]
en = key2-english
ref = key1

8
test/references/fixtures/twine_updated_comment.txt
View file

@ -1,8 +0,0 @@
[[General]]
[key1]
en = key1-english
comment = Simple comment
[key2]
en = key2-english
ref = key1
comment = Different comment

6
test/references/fixtures/twine_updated_value.txt
View file

@ -1,6 +0,0 @@
[[General]]
[key1]
en = key1-english
[key2]
en = key2-english
ref = key1

5
test/references/fixtures/twine_value_reference.txt
View file

@ -1,5 +0,0 @@
[[General]]
[key1]
en = key1-english
[key2]
ref = key1

47
test/references/references_test.rb
View file

@ -1,47 +0,0 @@
require 'twine_test_case'
class ReferencesTest < TwineTestCase
def fixture_path
'references/fixtures'
end
def test_consumption_preserves_references
input = 'twine_value_reference.txt'
execute "consume-string-file #{f input} #{f 'empty.xml'} -l en"
assert_equal content(input), output_content
end
def test_consumption_does_not_add_unchanged_translation
input = 'twine_value_reference.txt'
execute "consume-string-file #{f input} #{f 'same_value.xml'} -l en"
assert_equal content(input), output_content
end
def test_consumption_adds_changed_translation
execute "consume-string-file #{f 'twine_value_reference.txt'} #{f 'different_value.xml'} -l en"
assert_equal content('twine_updated_value.txt'), output_content
end
def test_consuption_does_not_add_comment
input = 'twine_comment_reference.txt'
execute "consume-string-file #{f input} #{f 'empty.xml'} -l en"
assert_equal content(input), output_content
end
def test_consumption_does_not_add_unchanged_comment
input = 'twine_comment_reference.txt'
execute "consume-string-file #{f input} #{f 'same_comment.xml'} -l en -c"
assert_equal content(input), output_content
end
def test_consumption_adds_changed_comment
execute "consume-string-file #{f 'twine_comment_reference.txt'} #{f 'different_comment.xml'} -l en -c"
assert_equal content('twine_updated_comment.txt'), output_content
end
def test_consumption_does_not_add_tags
input = 'twine_tag_reference.txt'
execute "consume-string-file #{f input} #{f 'empty.xml'} -l en -c"
assert_equal content(input), output_content
end
end

130
test/test_abstract_formatter.rb Normal file
View file

@ -0,0 +1,130 @@
require 'twine_test_case'
class TestAbstractFormatter < TwineTestCase
class SetTranslation < TwineTestCase
def setup
super
@strings = build_twine_file 'en', 'fr' do
add_section 'Section' do
add_row key1: 'value1-english'
add_row key2: { en: 'value2-english', fr: 'value2-french' }
end
end
@formatter = Twine::Formatters::Abstract.new(@strings, {})
end
def test_set_translation_updates_existing_value
@formatter.set_translation_for_key 'key1', 'en', 'value1-english-updated'
assert_equal 'value1-english-updated', @strings.strings_map['key1'].translations['en']
end
def test_set_translation_does_not_alter_other_language
@formatter.set_translation_for_key 'key2', 'en', 'value2-english-updated'
assert_equal 'value2-french', @strings.strings_map['key2'].translations['fr']
end
def test_set_translation_adds_translation_to_existing_key
@formatter.set_translation_for_key 'key1', 'fr', 'value1-french'
assert_equal 'value1-french', @strings.strings_map['key1'].translations['fr']
end
def test_set_translation_does_not_add_new_key
@formatter.set_translation_for_key 'new-key', 'en', 'new-key-english'
assert_nil @strings.strings_map['new-key']
end
def test_set_translation_consume_all_adds_new_key
formatter = Twine::Formatters::Abstract.new(@strings, { consume_all: true })
formatter.set_translation_for_key 'new-key', 'en', 'new-key-english'
assert_equal 'new-key-english', @strings.strings_map['new-key'].translations['en']
end
def test_set_translation_consume_all_adds_tags
random_tag = SecureRandom.uuid
formatter = Twine::Formatters::Abstract.new(@strings, { consume_all: true, tags: [random_tag] })
formatter.set_translation_for_key 'new-key', 'en', 'new-key-english'
assert_equal [random_tag], @strings.strings_map['new-key'].tags
end
def test_set_translation_adds_new_keys_to_category_uncategoriezed
formatter = Twine::Formatters::Abstract.new(@strings, { consume_all: true })
formatter.set_translation_for_key 'new-key', 'en', 'new-key-english'
assert_equal 'Uncategorized', @strings.sections[0].name
assert_equal 'new-key', @strings.sections[0].rows[0].key
end
end
class ValueReference < TwineTestCase
def setup
super
@strings = build_twine_file 'en', 'fr' do
add_section 'Section' do
add_row refkey: 'ref-value'
add_row key: :refkey
end
end
@formatter = Twine::Formatters::Abstract.new(@strings, {})
end
def test_set_translation_does_not_add_unchanged_translation
@formatter.set_translation_for_key 'key', 'en', 'ref-value'
assert_nil @strings.strings_map['key'].translations['en']
end
def test_set_translation_adds_changed_translation
@formatter.set_translation_for_key 'key', 'en', 'changed value'
assert_equal 'changed value', @strings.strings_map['key'].translations['en']
end
end
class SetComment < TwineTestCase
def test_set_comment_for_key_does_not_update_comment
skip 'not supported by current implementation - see #97'
end
def test_set_comment_for_key_updates_comment_with_update_comments
skip 'not supported by current implementation - see #97'
end
end
class CommentReference < TwineTestCase
def setup
super
@strings = build_twine_file 'en', 'fr' do
add_section 'Section' do
add_row refkey: 'ref-value', comment: 'reference comment'
add_row key: 'value', ref: :refkey
end
end
@formatter = Twine::Formatters::Abstract.new(@strings, {})
end
def test_set_comment_does_not_add_unchanged_comment
@formatter.set_comment_for_key 'key', 'reference comment'
assert_nil @strings.strings_map['key'].raw_comment
end
def test_set_comment_adds_changed_comment
@formatter.set_comment_for_key 'key', 'changed comment'
assert_equal 'changed comment', @strings.strings_map['key'].raw_comment
end
end
end

50
test/test_consume_string_file.rb Normal file
View file

@ -0,0 +1,50 @@
require 'command_test_case'
class TestConsumeStringFile < CommandTestCase
def new_runner(language, file)
options = {}
options[:output_path] = File.join(@output_dir, file) if file
options[:input_path] = File.join(@output_dir, file) if file
FileUtils.touch options[:input_path]
options[:languages] = language if language
Twine::Runner.new(nil, options)
end
def prepare_mock_read_file_formatter(formatter_class)
formatter = prepare_mock_formatter(formatter_class)
formatter.expects(:read_file)
end
def test_deducts_android_format_from_output_path
prepare_mock_read_file_formatter Twine::Formatters::Android
new_runner('fr', 'fr.xml').consume_string_file
end
def test_deducts_apple_format_from_output_path
prepare_mock_read_file_formatter Twine::Formatters::Apple
new_runner('fr', 'fr.strings').consume_string_file
end
def test_deducts_jquery_format_from_output_path
prepare_mock_read_file_formatter Twine::Formatters::JQuery
new_runner('fr', 'fr.json').consume_string_file
end
def test_deducts_gettext_format_from_output_path
prepare_mock_read_file_formatter Twine::Formatters::Gettext
new_runner('fr', 'fr.po').consume_string_file
end
def test_deducts_language_from_input_path
random_language = @known_languages.sample
formatter = prepare_mock_formatter Twine::Formatters::Android
formatter.expects(:read_file).with(anything, random_language)
new_runner(nil, "#{random_language}.xml").consume_string_file
end
end

9
test/create_folders_test.rb → test/test_create_folders.rb
View file

@ -1,16 +1,15 @@
require 'twine_test_case'
class CreateFoldersTest < TwineTestCase
class TestCreateFolders < TwineTestCase
def test_generate_all_fails_if_output_folder_does_not_exist
assert_raise Twine::Error do
assert_raises Twine::Error do
execute "generate-all-string-files #{f 'twine_key1_en_es.txt'} #{@output_dir} -f apple"
end
end
def test_generate_all_creates_output_folder
assert_nothing_raised do
execute "generate-all-string-files #{f 'twine_key1_en_es.txt'} #{@output_dir} -f apple --create-folders"
end
# implicitly assert nothing raised
execute "generate-all-string-files #{f 'twine_key1_en_es.txt'} #{@output_dir} -f apple --create-folders"
end
def test_generate_all_does_not_create_folders

196
test/test_formatters.rb Normal file
View file

@ -0,0 +1,196 @@
require 'twine_test_case'
class FormatterTest < TwineTestCase
def setup(formatter_class)
super()
@twine_file = build_twine_file 'en' do
add_section 'Section 1' do
add_row key1: 'value1-english', comment: 'comment key1'
add_row key2: 'value2-english'
end
add_section 'Section 2' do
add_row key3: 'value3-english'
add_row key4: 'value4-english', comment: 'comment key4'
end
end
@strings = Twine::StringsFile.new
@formatter = formatter_class.new @strings, { consume_all: true }
end
end
class TestAndroidFormatter < FormatterTest
def setup
super Twine::Formatters::Android
end
def test_read_file_format
@formatter.read_file fixture('formatter_android.xml'), 'en'
1.upto(4) do |i|
assert_equal "value#{i}-english", @strings.strings_map["key#{i}"].translations['en']
end
end
def test_set_translation_transforms_leading_spaces
@formatter.set_translation_for_key 'key1', 'en', "\u0020value"
assert_equal ' value', @strings.strings_map['key1'].translations['en']
end
def test_set_translation_transforms_trailing_spaces
@formatter.set_translation_for_key 'key1', 'en', "value\u0020\u0020"
assert_equal 'value ', @strings.strings_map['key1'].translations['en']
end
def test_write_file_output_format
formatter = Twine::Formatters::Android.new @twine_file, {}
formatter.write_file @output_path, 'en'
assert_equal content('formatter_android.xml'), output_content
end
def test_format_key_with_space
assert_equal 'key ', @formatter.format_key('key ')
end
def test_format_value_with_leading_space
assert_equal "\\u0020value", @formatter.format_value(' value')
end
def test_format_value_with_trailing_space
assert_equal "value\\u0020", @formatter.format_value('value ')
end
def test_format_value_escapes_single_quotes
skip 'not working with ruby 2.0'
# http://stackoverflow.com/questions/18735608/cgiescapehtml-is-escaping-single-quote
assert_equal "not \\'so\\' easy", @formatter.format_value("not 'so' easy")
end
def test_format_value_transforms_string_placeholder
assert_equal '%s', @formatter.format_value('%@')
end
def test_format_value_transforms_ordered_string_placeholder
assert_equal '%1s', @formatter.format_value('%1@')
end
def test_format_value_transforming_ordered_placeholders_maintains_order
assert_equal '%2s %1d', @formatter.format_value('%2@ %1d')
end
def test_format_value_does_not_alter_double_percent
assert_equal '%%d%%', @formatter.format_value('%%d%%')
end
end
class TestAppleFormatter < FormatterTest
def setup
super Twine::Formatters::Apple
end
def test_read_file_format
@formatter.read_file fixture('formatter_apple.strings'), 'en'
1.upto(4) do |i|
assert_equal "value#{i}-english", @strings.strings_map["key#{i}"].translations['en']
end
end
def test_write_file_output_format
formatter = Twine::Formatters::Apple.new @twine_file, {}
formatter.write_file @output_path, 'en'
assert_equal content('formatter_apple.strings'), output_content
end
def test_format_key_with_space
assert_equal 'key ', @formatter.format_key('key ')
end
def test_format_value_with_leading_space
assert_equal ' value', @formatter.format_value(' value')
end
def test_format_value_with_trailing_space
assert_equal 'value ', @formatter.format_value('value ')
end
end
class TestJQueryFormatter < FormatterTest
def setup
super Twine::Formatters::JQuery
end
def test_read_file_format
@formatter.read_file fixture('formatter_jquery.json'), 'en'
1.upto(4) do |i|
assert_equal "value#{i}-english", @strings.strings_map["key#{i}"].translations['en']
end
end
def test_write_file_output_format
formatter = Twine::Formatters::JQuery.new @twine_file, {}
formatter.write_file @output_path, 'en'
assert_equal content('formatter_jquery.json'), output_content
end
def test_format_value_with_newline
skip 'this test will only work once the JQuery formatter is modularized'
# assert_equal "value\nwith\nline\nbreaks", @formatter.format_value("value\nwith\nline\nbreaks")
end
end
class TestGettextFormatter < FormatterTest
def setup
super Twine::Formatters::Gettext
end
def test_read_file_format
@formatter.read_file fixture('formatter_gettext.po'), 'en'
1.upto(4) do |i|
assert_equal "value#{i}-english", @strings.strings_map["key#{i}"].translations['en']
end
end
def test_read_file_with_multiple_line_value
@formatter.read_file fixture('gettext_multiline.po'), 'en'
assert_equal 'multiline\nstring', @strings.strings_map['key1'].translations['en']
end
def test_write_file_output_format
formatter = Twine::Formatters::Gettext.new @twine_file, {}
formatter.write_file @output_path, 'en'
assert_equal content('formatter_gettext.po'), output_content
end
end
class TestTizenFormatter < FormatterTest
def setup
super Twine::Formatters::Tizen
end
def test_read_file_format
skip 'the current implementation of Tizen formatter does not support read_file'
@formatter.read_file fixture('formatter_tizen.xml'), 'en'
1.upto(4) do |i|
assert_equal "value#{i}-english", @strings.strings_map["key#{i}"].translations['en']
end
end
def test_write_file_output_format
formatter = Twine::Formatters::Tizen.new @twine_file, {}
formatter.write_file @output_path, 'en'
assert_equal content('formatter_tizen.xml'), output_content
end
end

48
test/test_generate_string_file.rb Normal file
View file

@ -0,0 +1,48 @@
require 'command_test_case'
class TestGenerateStringFile < CommandTestCase
def new_runner(language, file)
options = {}
options[:output_path] = File.join(@output_dir, file) if file
options[:languages] = language if language
Twine::Runner.new(nil, options)
end
def prepare_mock_write_file_formatter(formatter_class)
formatter = prepare_mock_formatter(formatter_class)
formatter.expects(:write_file)
end
def test_deducts_android_format_from_output_path
prepare_mock_write_file_formatter Twine::Formatters::Android
new_runner('fr', 'fr.xml').generate_string_file
end
def test_deducts_apple_format_from_output_path
prepare_mock_write_file_formatter Twine::Formatters::Apple
new_runner('fr', 'fr.strings').generate_string_file
end
def test_deducts_jquery_format_from_output_path
prepare_mock_write_file_formatter Twine::Formatters::JQuery
new_runner('fr', 'fr.json').generate_string_file
end
def test_deducts_gettext_format_from_output_path
prepare_mock_write_file_formatter Twine::Formatters::Gettext
new_runner('fr', 'fr.po').generate_string_file
end
def test_deducts_language_from_output_path
random_language = @known_languages.sample
formatter = prepare_mock_formatter Twine::Formatters::Android
formatter.expects(:write_file).with(anything, random_language)
new_runner(nil, "#{random_language}.xml").generate_string_file
end
end

85
test/test_output_processor.rb Normal file
View file

@ -0,0 +1,85 @@
require 'twine_test_case'
class TestOutputProcessor < TwineTestCase
def setup
super
@strings = build_twine_file 'en', 'fr' do
add_section 'Section' do
add_row key1: 'value1', tags: ['tag1']
add_row key2: 'value2', tags: ['tag1', 'tag2']
add_row key3: 'value3', tags: ['tag2']
add_row key4: { en: 'value4-en', fr: 'value4-fr' }
end
end
end
def test_includes_all_keys_by_default
processor = Twine::Processors::OutputProcessor.new(@strings, {})
result = processor.process('en')
assert_equal %w(key1 key2 key3 key4), result.strings_map.keys.sort
end
def test_filter_by_tag
processor = Twine::Processors::OutputProcessor.new(@strings, { tags: ['tag1'] })
result = processor.process('en')
assert_equal %w(key1 key2), result.strings_map.keys.sort
end
def test_filter_by_multiple_tags
processor = Twine::Processors::OutputProcessor.new(@strings, { tags: ['tag1', 'tag2'] })
result = processor.process('en')
assert_equal %w(key1 key2 key3), result.strings_map.keys.sort
end
def test_filter_untagged
processor = Twine::Processors::OutputProcessor.new(@strings, { tags: ['tag1'], untagged: true })
result = processor.process('en')
assert_equal %w(key1 key2 key4), result.strings_map.keys.sort
end
def test_include_translated
processor = Twine::Processors::OutputProcessor.new(@strings, { include: 'translated' })
result = processor.process('fr')
assert_equal %w(key4), result.strings_map.keys.sort
end
def test_include_untranslated
processor = Twine::Processors::OutputProcessor.new(@strings, { include: 'untranslated' })
result = processor.process('fr')
assert_equal %w(key1 key2 key3), result.strings_map.keys.sort
end
class TranslationFallback < TwineTestCase
def setup
super
@strings = build_twine_file 'en', 'fr', 'de' do
add_section 'Section' do
add_row key1: { en: 'value1-en', fr: 'value1-fr' }
end
end
end
def test_fallback_to_default_language
processor = Twine::Processors::OutputProcessor.new(@strings, {})
result = processor.process('de')
assert_equal 'value1-en', result.strings_map['key1'].translations['de']
end
def test_fallback_to_developer_language
processor = Twine::Processors::OutputProcessor.new(@strings, {developer_language: 'fr'})
result = processor.process('de')
assert_equal 'value1-fr', result.strings_map['key1'].translations['de']
end
end
end

58
test/test_strings_file.rb Normal file
View file

@ -0,0 +1,58 @@
require 'twine_test_case'
class TestStringsFile < TwineTestCase
class Reading < TwineTestCase
def setup
super
@strings = Twine::StringsFile.new
@strings.read fixture('twine_accent_values.txt')
end
def test_reading_keeps_leading_accent
assert_equal '`value', @strings.strings_map['value_with_leading_accent'].translations['en']
end
def test_reading_keeps_trailing_accent
assert_equal 'value`', @strings.strings_map['value_with_trailing_accent'].translations['en']
end
def test_reading_keeps_leading_space
assert_equal ' value', @strings.strings_map['value_with_leading_space'].translations['en']
end
def test_reading_keeps_trailing_space
assert_equal 'value ', @strings.strings_map['value_with_trailing_space'].translations['en']
end
def test_reading_keeps_wrapping_spaces
assert_equal ' value ', @strings.strings_map['value_wrapped_by_spaces'].translations['en']
end
def test_reading_keeps_wrapping_accents
assert_equal '`value`', @strings.strings_map['value_wrapped_by_accents'].translations['en']
end
end
class Writing < TwineTestCase
def test_accent_wrapping
@strings = build_twine_file 'en' do
add_section 'Section' do
add_row value_with_leading_accent: '`value'
add_row value_with_trailing_accent: 'value`'
add_row value_with_leading_space: ' value'
add_row value_with_trailing_space: 'value '
add_row value_wrapped_by_spaces: ' value '
add_row value_wrapped_by_accents: '`value`'
end
end
@strings.write @output_path
assert_equal content('twine_accent_values.txt'), output_content
end
end
end

47
test/test_strings_row.rb Normal file
View file

@ -0,0 +1,47 @@
require 'twine_test_case'
class TestStringsRow < TwineTestCase
def setup
super
@reference = Twine::StringsRow.new 'reference-key'
@reference.comment = 'reference comment'
@reference.tags = ['ref1']
@reference.translations['en'] = 'ref-value'
@row = Twine::StringsRow.new 'key'
@row.reference_key = @reference.key
@row.reference = @reference
end
def test_reference_comment_used
assert_equal 'reference comment', @row.comment
end
def test_reference_comment_override
@row.comment = 'row comment'
assert_equal 'row comment', @row.comment
end
def test_reference_tags_used
assert @row.matches_tags?(['ref1'], false)
end
def test_reference_tags_override
@row.tags = ['tag1']
refute @row.matches_tags?(['ref1'], false)
assert @row.matches_tags?(['tag1'], false)
end
def test_reference_translation_used
assert_equal 'ref-value', @row.translated_string_for_lang('en')
end
def test_reference_translation_override
@row.translations['en'] = 'value'
assert_equal 'value', @row.translated_string_for_lang('en')
end
end

46
test/twine_file_dsl.rb Normal file
View file

@ -0,0 +1,46 @@
module TwineFileDSL
def build_twine_file(*languages)
@currently_built_twine_file = Twine::StringsFile.new
@currently_built_twine_file.language_codes.concat languages
yield
result = @currently_built_twine_file
@currently_built_twine_file = nil
return result
end
def add_section(name)
return unless @currently_built_twine_file
@currently_built_twine_file_section = Twine::StringsSection.new name
@currently_built_twine_file.sections << @currently_built_twine_file_section
yield
@currently_built_twine_file_section = nil
end
def add_row(parameters)
return unless @currently_built_twine_file
return unless @currently_built_twine_file_section
# this relies on Ruby 1.9 preserving the order of hash elements
key, value = parameters.first
row = Twine::StringsRow.new(key.to_s)
if value.is_a? Hash
value.each do |language, translation|
row.translations[language.to_s] = translation
end
elsif !value.is_a? Symbol
language = @currently_built_twine_file.language_codes.first
row.translations[language] = value
end
row.comment = parameters[:comment] if parameters[:comment]
row.tags = parameters[:tags] if parameters[:tags]
if parameters[:ref] || value.is_a?(Symbol)
reference_key = (parameters[:ref] || value).to_s
row.reference_key = reference_key
row.reference = @currently_built_twine_file.strings_map[reference_key]
end
@currently_built_twine_file_section.rows << row
@currently_built_twine_file.strings_map[row.key] = row
end
end

158
test/twine_test.rb
View file

@ -1,158 +0,0 @@
require 'erb'
require 'rubygems'
require 'test/unit'
require 'twine'
class TwineTest < Test::Unit::TestCase
def test_generate_string_file_1
Dir.mktmpdir do |dir|
output_path = File.join(dir, 'fr.xml')
Twine::Runner.run(%W(generate-string-file test/fixtures/strings-1.txt #{output_path}))
assert_equal(ERB.new(File.read('test/fixtures/test-output-1.txt')).result, File.read(output_path))
end
end
def test_generate_string_file_2
Dir.mktmpdir do |dir|
output_path = File.join(dir, 'en.strings')
Twine::Runner.run(%W(generate-string-file test/fixtures/strings-1.txt #{output_path} -t tag1))
assert_equal(ERB.new(File.read('test/fixtures/test-output-2.txt')).result, File.read(output_path))
end
end
def test_generate_string_file_3
Dir.mktmpdir do |dir|
output_path = File.join(dir, 'en.json')
Twine::Runner.run(%W(generate-string-file test/fixtures/strings-1.txt #{output_path} -t tag1))
assert_equal(ERB.new(File.read('test/fixtures/test-output-5.txt')).result, File.read(output_path))
end
end
def test_generate_string_file_4
Dir.mktmpdir do |dir|
output_path = File.join(dir, 'en.strings')
Twine::Runner.run(%W(generate-string-file test/fixtures/strings-2.txt #{output_path} -t tag1))
assert_equal(ERB.new(File.read('test/fixtures/test-output-6.txt')).result, File.read(output_path))
end
end
def test_generate_string_file_5
Dir.mktmpdir do |dir|
output_path = File.join(dir, 'en.po')
Twine::Runner.run(%W(generate-string-file test/fixtures/strings-1.txt #{output_path} -t tag1))
assert_equal(ERB.new(File.read('test/fixtures/test-output-7.txt')).result, File.read(output_path))
end
end
def test_generate_string_file_6
Dir.mktmpdir do |dir|
output_path = File.join(dir, 'en.xml')
Twine::Runner.run(%W(generate-string-file test/fixtures/strings-3.txt #{output_path}))
assert_equal(ERB.new(File.read('test/fixtures/test-output-8.txt')).result, File.read(output_path))
end
end
def test_generate_string_file_7
Dir.mktmpdir do |dir|
output_path = File.join(dir, 'en.xml')
Twine::Runner.run(%W(generate-string-file test/fixtures/strings-2.txt #{output_path} -t tag1))
assert_equal(ERB.new(File.read('test/fixtures/test-output-10.txt')).result, File.read(output_path))
end
end
def test_generate_string_file_8
Dir.mktmpdir do |dir|
output_path = File.join(dir, 'fr.xml')
Twine::Runner.run(%W(generate-string-file --format tizen test/fixtures/strings-1.txt #{output_path}))
assert_equal(ERB.new(File.read('test/fixtures/test-output-12.txt')).result, File.read(output_path))
end
end
def test_include_translated
Dir.mktmpdir do |dir|
output_path = File.join(dir, 'fr.xml')
Twine::Runner.run(%W(generate-string-file test/fixtures/strings-1.txt #{output_path} --include translated))
assert_equal(ERB.new(File.read('test/fixtures/test-output-13.txt')).result, File.read(output_path))
end
end
def test_consume_string_file_1
Dir.mktmpdir do |dir|
output_path = File.join(dir, 'strings.txt')
Twine::Runner.run(%W(consume-string-file test/fixtures/strings-1.txt test/fixtures/fr-1.xml -o #{output_path} -l fr))
assert_equal(File.read('test/fixtures/test-output-3.txt'), File.read(output_path))
end
end
def test_consume_string_file_2
Dir.mktmpdir do |dir|
output_path = File.join(dir, 'strings.txt')
Twine::Runner.run(%W(consume-string-file test/fixtures/strings-1.txt test/fixtures/en-1.strings -o #{output_path} -l en -a))
assert_equal(File.read('test/fixtures/test-output-4.txt'), File.read(output_path))
end
end
def test_consume_string_file_3
Dir.mktmpdir do |dir|
output_path = File.join(dir, 'strings.txt')
Twine::Runner.run(%W(consume-string-file test/fixtures/strings-1.txt test/fixtures/en-1.json -o #{output_path} -l en -a))
assert_equal(File.read('test/fixtures/test-output-4.txt'), File.read(output_path))
end
end
def test_consume_string_file_4
Dir.mktmpdir do |dir|
output_path = File.join(dir, 'strings.txt')
Twine::Runner.run(%W(consume-string-file test/fixtures/strings-1.txt test/fixtures/en-1.po -o #{output_path} -l en -a))
assert_equal(File.read('test/fixtures/test-output-4.txt'), File.read(output_path))
end
end
def test_consume_string_file_5
Dir.mktmpdir do |dir|
output_path = File.join(dir, 'strings.txt')
Twine::Runner.run(%W(consume-string-file test/fixtures/strings-1.txt test/fixtures/en-2.po -o #{output_path} -l en -a))
assert_equal(File.read('test/fixtures/test-output-9.txt'), File.read(output_path))
end
end
def test_consume_string_file_6
Dir.mktmpdir do |dir|
output_path = File.join(dir, 'strings.txt')
Twine::Runner.run(%W(consume-string-file test/fixtures/strings-2.txt test/fixtures/en-3.xml -o #{output_path} -l en -a))
assert_equal(File.read('test/fixtures/test-output-11.txt'), File.read(output_path))
end
end
def test_json_line_breaks_consume
Dir.mktmpdir do |dir|
output_path = File.join(dir, 'strings.txt')
Twine::Runner.run(%W(consume-string-file test/fixtures/test-json-line-breaks/line-breaks.txt test/fixtures/test-json-line-breaks/line-breaks.json -l fr -o #{output_path}))
assert_equal(File.read('test/fixtures/test-json-line-breaks/consumed.txt'), File.read(output_path))
end
end
def test_json_line_breaks_generate
Dir.mktmpdir do |dir|
output_path = File.join(dir, 'en.json')
Twine::Runner.run(%W(generate-string-file test/fixtures/test-json-line-breaks/line-breaks.txt #{output_path}))
assert_equal(File.read('test/fixtures/test-json-line-breaks/generated.json'), File.read(output_path))
end
end
def test_generate_string_file_14_include_untranslated
Dir.mktmpdir do |dir|
output_path = File.join(dir, 'include_untranslated.xml')
Twine::Runner.run(%W(generate-string-file test/fixtures/strings-1.txt #{output_path} --include untranslated -l fr))
assert_equal(ERB.new(File.read('test/fixtures/test-output-14.txt')).result, File.read(output_path))
end
end
def test_generate_string_file_14_references
Dir.mktmpdir do |dir|
output_path = File.join(dir, 'references.xml')
Twine::Runner.run(%W(generate-string-file test/fixtures/strings-4-references.txt #{output_path} -l fr -t tag1))
assert_equal(ERB.new(File.read('test/fixtures/test-output-14-references.txt')).result, File.read(output_path))
end
end
end

17
test/twine_test_case.rb
View file

@ -1,10 +1,13 @@
require 'erb'
require 'rubygems'
require 'test/unit'
require 'minitest/autorun'
require "mocha/mini_test"
require 'securerandom'
require 'twine'
require 'twine_file_dsl'
class TwineTestCase < Test::Unit::TestCase
class TwineTestCase < Minitest::Test
include TwineFileDSL
def setup
super
@output_dir = Dir.mktmpdir
@ -16,10 +19,6 @@ class TwineTestCase < Test::Unit::TestCase
super
end
def fixture_path
'fixtures'
end
def output_content
File.read @output_path
end
@ -30,11 +29,11 @@ class TwineTestCase < Test::Unit::TestCase
end
def fixture(filename)
File.join __dir__, fixture_path, filename
File.join __dir__, 'fixtures', filename
end
alias :f :fixture
def content(filename)
File.read fixture(filename)
ERB.new(File.read fixture(filename)).result
end
end

4
twine.gemspec
View file

@ -15,12 +15,14 @@ Gem::Specification.new do |s|
s.files += Dir.glob("lib/**/*")
s.files += Dir.glob("bin/**/*")
s.files += Dir.glob("test/**/*")
s.test_file = 'test/twine_test.rb'
s.test_files = Dir.glob("test/test_*")
s.required_ruby_version = ">= 1.8.7"
s.add_runtime_dependency('rubyzip', "~> 0.9.5")
s.add_runtime_dependency('safe_yaml', "~> 1.0.3")
s.add_development_dependency('rake', "~> 0.9.2")
s.add_development_dependency('minitest', "> 5.5")
s.add_development_dependency('mocha', ">= 1.1")
s.executables = %w( twine )
s.description = <<desc