twine 0.9.1 → 0.10.0

data/test/test_consume_localization_archive.rb

@@ -0,0 +1,27 @@
+require 'command_test'
+
+class TestConsumeLocalizationArchive < CommandTest
+  def setup
+    super
+
+    options = {}
+    options[:input_path] = fixture_path 'consume_localization_archive.zip'
+    options[:output_path] = @output_path
+    options[:format] = 'apple'
+
+    @twine_file = build_twine_file 'en', 'es' do
+      add_section 'Section' do
+        add_definition key1: 'value1'
+      end
+    end
+
+    @runner = Twine::Runner.new(options, @twine_file)
+  end
+
+  def test_consumes_zip_file
+    @runner.consume_localization_archive
+
+    assert @twine_file.definitions_by_key['key1'].translations['en'], 'value1-english'
+    assert @twine_file.definitions_by_key['key1'].translations['es'], 'value1-spanish'
+  end
+end

data/test/{test_consume_string_file.rb → test_consume_localization_file.rb}

@@ -1,6 +1,6 @@
-require 'command_test_case'
+require 'command_test'
 
-class TestConsumeStringFile < CommandTestCase
+class TestConsumeLocalizationFile < CommandTest
   def new_runner(language, file)
     options = {}
     options[:output_path] = File.join(@output_dir, file) if file
@@ -8,10 +8,10 @@ class TestConsumeStringFile < CommandTestCase
     FileUtils.touch options[:input_path]
     options[:languages] = language if language
 
-    @strings = Twine::StringsFile.new
-    @strings.language_codes.concat KNOWN_LANGUAGES
+    @twine_file = Twine::TwineFile.new
+    @twine_file.language_codes.concat KNOWN_LANGUAGES
 
-    Twine::Runner.new(options, @strings)
+    Twine::Runner.new(options, @twine_file)
   end
 
   def prepare_mock_read_formatter(formatter_class)
@@ -22,25 +22,25 @@ class TestConsumeStringFile < CommandTestCase
   def test_deducts_android_format_from_output_path
     prepare_mock_read_formatter Twine::Formatters::Android
 
-    new_runner('fr', 'fr.xml').consume_string_file
+    new_runner('fr', 'fr.xml').consume_localization_file
   end
 
   def test_deducts_apple_format_from_output_path
     prepare_mock_read_formatter Twine::Formatters::Apple
 
-    new_runner('fr', 'fr.strings').consume_string_file
+    new_runner('fr', 'fr.strings').consume_localization_file
   end
 
   def test_deducts_jquery_format_from_output_path
     prepare_mock_read_formatter Twine::Formatters::JQuery
 
-    new_runner('fr', 'fr.json').consume_string_file
+    new_runner('fr', 'fr.json').consume_localization_file
   end
 
   def test_deducts_gettext_format_from_output_path
     prepare_mock_read_formatter Twine::Formatters::Gettext
 
-    new_runner('fr', 'fr.po').consume_string_file
+    new_runner('fr', 'fr.po').consume_localization_file
   end
 
   def test_deducts_language_from_input_path
@@ -48,10 +48,10 @@ class TestConsumeStringFile < CommandTestCase
     formatter = prepare_mock_formatter Twine::Formatters::Android
     formatter.expects(:read).with(anything, random_language)
 
-    new_runner(nil, "#{random_language}.xml").consume_string_file
+    new_runner(nil, "#{random_language}.xml").consume_localization_file
   end
 
-  class TestEncodings < CommandTestCase
+  class TestEncodings < CommandTest
     class DummyFormatter < Twine::Formatters::Abstract
       attr_reader :content
 
@@ -75,10 +75,10 @@ class TestConsumeStringFile < CommandTestCase
       options[:encoding] = encoding if encoding
       options[:languages] = 'en'
 
-      @strings = Twine::StringsFile.new
-      @strings.language_codes.concat KNOWN_LANGUAGES
+      @twine_file = Twine::TwineFile.new
+      @twine_file.language_codes.concat KNOWN_LANGUAGES
 
-      Twine::Runner.new(options, @strings)
+      Twine::Runner.new(options, @twine_file)
     end
 
     def setup
@@ -88,31 +88,31 @@ class TestConsumeStringFile < CommandTestCase
 
     def test_reads_utf8
       formatter = prepare_mock_formatter DummyFormatter
-      new_runner(fixture_path('enc_utf8.dummy')).consume_string_file
+      new_runner(fixture_path('enc_utf8.dummy')).consume_localization_file
       assert_equal @expected_content, formatter.content
     end
 
     def test_reads_utf16le_bom
       formatter = prepare_mock_formatter DummyFormatter
-      new_runner(fixture_path('enc_utf16le_bom.dummy')).consume_string_file
+      new_runner(fixture_path('enc_utf16le_bom.dummy')).consume_localization_file
       assert_equal @expected_content, formatter.content
     end
 
     def test_reads_utf16be_bom
       formatter = prepare_mock_formatter DummyFormatter
-      new_runner(fixture_path('enc_utf16be_bom.dummy')).consume_string_file
+      new_runner(fixture_path('enc_utf16be_bom.dummy')).consume_localization_file
       assert_equal @expected_content, formatter.content
     end
 
     def test_reads_utf16le
       formatter = prepare_mock_formatter DummyFormatter
-      new_runner(fixture_path('enc_utf16le.dummy'), 'UTF-16LE').consume_string_file
+      new_runner(fixture_path('enc_utf16le.dummy'), 'UTF-16LE').consume_localization_file
       assert_equal @expected_content, formatter.content
     end
 
     def test_reads_utf16be
       formatter = prepare_mock_formatter DummyFormatter
-      new_runner(fixture_path('enc_utf16be.dummy'), 'UTF-16BE').consume_string_file
+      new_runner(fixture_path('enc_utf16be.dummy'), 'UTF-16BE').consume_localization_file
       assert_equal @expected_content, formatter.content
     end
   end

data/test/test_formatters.rb

@@ -1,44 +1,58 @@
-require 'twine_test_case'
+require 'twine_test'
 
-class FormatterTest < TwineTestCase
+class FormatterTest < TwineTest
   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'
+        add_definition key1: 'value1-english', comment: 'comment key1'
+        add_definition key2: 'value2-english'
       end
 
       add_section 'Section 2' do
-        add_row key3: 'value3-english'
-        add_row key4: 'value4-english', comment: 'comment key4'
+        add_definition key3: 'value3-english'
+        add_definition key4: 'value4-english', comment: 'comment key4'
       end
     end
 
-    @strings = Twine::StringsFile.new
+    @empty_twine_file = Twine::TwineFile.new
     @formatter = formatter_class.new
-    @formatter.strings = @strings
+    @formatter.twine_file = @empty_twine_file
     @formatter.options = { consume_all: true, consume_comments: true }
   end
 
   def assert_translations_read_correctly
     1.upto(4) do |i|
-      assert_equal "value#{i}-english", @strings.strings_map["key#{i}"].translations['en']
+      assert_equal "value#{i}-english", @empty_twine_file.definitions_by_key["key#{i}"].translations['en']
     end
   end
 
   def assert_file_contents_read_correctly
     assert_translations_read_correctly
 
-    assert_equal "comment key1", @strings.strings_map["key1"].comment
-    assert_equal "comment key4", @strings.strings_map["key4"].comment
+    assert_equal "comment key1", @empty_twine_file.definitions_by_key["key1"].comment
+    assert_equal "comment key4", @empty_twine_file.definitions_by_key["key4"].comment
   end
 end
 
 class TestAndroidFormatter < FormatterTest
   def setup
     super Twine::Formatters::Android
+    
+    @escape_test_values = {
+      'this & that'               => 'this &amp; that',
+      'this < that'               => 'this &lt; that',
+      "it's complicated"          => "it\\'s complicated",
+      'a "good" way'              => 'a \"good\" way',
+      '<b>bold</b>'               => '&lt;b>bold&lt;/b>',
+      '<a href="target">link</a>' => '&lt;a href=\"target\">link&lt;/a>',
+
+      '<xliff:g></xliff:g>' => '<xliff:g></xliff:g>',
+      '<xliff:g>untouched</xliff:g>' => '<xliff:g>untouched</xliff:g>',
+      '<xliff:g id="42">untouched</xliff:g>' => '<xliff:g id="42">untouched</xliff:g>',
+      '<xliff:g id="1">first</xliff:g> inbetween <xliff:g id="2">second</xliff:g>' => '<xliff:g id="1">first</xliff:g> inbetween <xliff:g id="2">second</xliff:g>'
+    }
   end
 
   def test_read_format
@@ -47,29 +61,52 @@ class TestAndroidFormatter < FormatterTest
     assert_file_contents_read_correctly
   end
 
+  def test_read_multiline_translation
+    content = <<-EOCONTENT
+      <?xml version="1.0" encoding="utf-8"?>
+      <resources>
+        <string name="foo">This is
+     a string</string>
+      </resources>
+    EOCONTENT
+
+    io = StringIO.new(content)
+
+    @formatter.read io, 'en'
+
+    assert_equal 'This is\n a string', @empty_twine_file.definitions_by_key["foo"].translations['en']
+  end
+
   def test_set_translation_converts_leading_spaces
     @formatter.set_translation_for_key 'key1', 'en', "\u0020value"
-    assert_equal ' value', @strings.strings_map['key1'].translations['en']
+    assert_equal ' value', @empty_twine_file.definitions_by_key['key1'].translations['en']
   end
 
   def test_set_translation_coverts_trailing_spaces
     @formatter.set_translation_for_key 'key1', 'en', "value\u0020\u0020"
-    assert_equal 'value  ', @strings.strings_map['key1'].translations['en']
+    assert_equal 'value  ', @empty_twine_file.definitions_by_key['key1'].translations['en']
   end
 
   def test_set_translation_converts_string_placeholders
     @formatter.set_translation_for_key 'key1', 'en', "value %s"
-    assert_equal 'value %@', @strings.strings_map['key1'].translations['en']
+    assert_equal 'value %@', @empty_twine_file.definitions_by_key['key1'].translations['en']
   end
 
   def test_set_translation_unescapes_at_signs
     @formatter.set_translation_for_key 'key1', 'en', '\@value'
-    assert_equal '@value', @strings.strings_map['key1'].translations['en']
+    assert_equal '@value', @empty_twine_file.definitions_by_key['key1'].translations['en']
+  end
+
+  def test_set_translation_unescaping
+    @escape_test_values.each do |expected, input|
+      @formatter.set_translation_for_key 'key1', 'en', input
+      assert_equal expected, @empty_twine_file.definitions_by_key['key1'].translations['en']
+    end
   end
 
   def test_format_file
     formatter = Twine::Formatters::Android.new
-    formatter.strings = @twine_file
+    formatter.twine_file = @twine_file
     assert_equal content('formatter_android.xml'), formatter.format_file('en')
   end
 
@@ -85,10 +122,14 @@ class TestAndroidFormatter < FormatterTest
     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")
+  def test_format_value_string_placeholder
+    assert_equal "The file %s could not be found.", @formatter.format_value("The file %@ could not be found.")
+  end
+
+  def test_format_value_escaping
+    @escape_test_values.each do |input, expected|
+      assert_equal expected, @formatter.format_value(input)
+    end
   end
 
   def test_format_value_escapes_non_resource_identifier_at_signs
@@ -109,10 +150,6 @@ class TestAndroidFormatter < FormatterTest
     assert_equal 'de-AT', @formatter.determine_language_given_path("res/values-de-rAT")
   end
 
-  def test_maps_laguage_deducted_from_resource_folder
-    assert_equal 'zh-Hans', @formatter.determine_language_given_path("res/values-zh-rCN")
-  end
-
   def test_does_not_deduct_language_from_device_capability_resource_folder
     assert_nil @formatter.determine_language_given_path('res/values-w820dp')
   end
@@ -120,10 +157,6 @@ class TestAndroidFormatter < FormatterTest
   def test_output_path_is_prefixed
     assert_equal 'values-en', @formatter.output_path_for_language('en')
   end
-
-  def test_output_path_language_mappings
-    assert_equal 'values-zh-rCN', @formatter.output_path_for_language('zh-Hans')
-  end
 end
 
 class TestAppleFormatter < FormatterTest
@@ -139,47 +172,47 @@ class TestAppleFormatter < FormatterTest
 
   def test_reads_quoted_keys
     @formatter.read StringIO.new('"key" = "value"'), 'en'
-    assert_equal 'value', @strings.strings_map['key'].translations['en']
+    assert_equal 'value', @empty_twine_file.definitions_by_key['key'].translations['en']
   end
 
   def test_reads_unquoted_keys
     @formatter.read StringIO.new('key = "value"'), 'en'
-    assert_equal 'value', @strings.strings_map['key'].translations['en']
+    assert_equal 'value', @empty_twine_file.definitions_by_key['key'].translations['en']
   end
 
   def test_ignores_leading_whitespace_before_quoted_keys
     @formatter.read StringIO.new("\t  \"key\" = \"value\""), 'en'
-    assert_equal 'value', @strings.strings_map['key'].translations['en']
+    assert_equal 'value', @empty_twine_file.definitions_by_key['key'].translations['en']
   end
 
   def test_ignores_leading_whitespace_before_unquoted_keys
     @formatter.read StringIO.new("\t  key = \"value\""), 'en'
-    assert_equal 'value', @strings.strings_map['key'].translations['en']
+    assert_equal 'value', @empty_twine_file.definitions_by_key['key'].translations['en']
   end
 
   def test_allows_quotes_in_quoted_keys
     @formatter.read StringIO.new('"ke\"y" = "value"'), 'en'
-    assert_equal 'value', @strings.strings_map['ke"y'].translations['en']
+    assert_equal 'value', @empty_twine_file.definitions_by_key['ke"y'].translations['en']
   end
 
   def test_does_not_allow_quotes_in_quoted_keys
     @formatter.read StringIO.new('ke"y = "value"'), 'en'
-    assert_nil @strings.strings_map['key']
+    assert_nil @empty_twine_file.definitions_by_key['key']
   end
 
   def test_allows_equal_signs_in_quoted_keys
     @formatter.read StringIO.new('"k=ey" = "value"'), 'en'
-    assert_equal 'value', @strings.strings_map['k=ey'].translations['en']
+    assert_equal 'value', @empty_twine_file.definitions_by_key['k=ey'].translations['en']
   end
 
   def test_does_not_allow_equal_signs_in_unquoted_keys
     @formatter.read StringIO.new('k=ey = "value"'), 'en'
-    assert_nil @strings.strings_map['key']
+    assert_nil @empty_twine_file.definitions_by_key['key']
   end
 
   def test_format_file
     formatter = Twine::Formatters::Apple.new
-    formatter.strings = @twine_file
+    formatter.twine_file = @twine_file
     assert_equal content('formatter_apple.strings'), formatter.format_file('en')
   end
 
@@ -210,10 +243,24 @@ class TestJQueryFormatter < FormatterTest
 
   def test_format_file
     formatter = Twine::Formatters::JQuery.new
-    formatter.strings = @twine_file
+    formatter.twine_file = @twine_file
     assert_equal content('formatter_jquery.json'), formatter.format_file('en')
   end
 
+  def test_empty_sections_are_removed
+    @twine_file = build_twine_file 'en' do
+      add_section 'Section 1' do
+      end
+
+      add_section 'Section 2' do
+        add_definition key: 'value'
+      end
+    end
+    formatter = Twine::Formatters::JQuery.new
+    formatter.twine_file = @twine_file
+    refute_includes formatter.format_file('en'), ','
+  end
+
   def test_format_value_with_newline
     assert_equal "value\nwith\nline\nbreaks", @formatter.format_value("value\nwith\nline\nbreaks")
   end
@@ -234,12 +281,12 @@ class TestGettextFormatter < FormatterTest
   def test_read_with_multiple_line_value
     @formatter.read content_io('gettext_multiline.po'), 'en'
 
-    assert_equal 'multiline\nstring', @strings.strings_map['key1'].translations['en']
+    assert_equal 'multiline\nstring', @empty_twine_file.definitions_by_key['key1'].translations['en']
   end
 
   def test_format_file
     formatter = Twine::Formatters::Gettext.new
-    formatter.strings = @twine_file
+    formatter.twine_file = @twine_file
     assert_equal content('formatter_gettext.po'), formatter.format_file('en')
   end
 
@@ -260,7 +307,7 @@ class TestTizenFormatter < FormatterTest
 
   def test_format_file
     formatter = Twine::Formatters::Tizen.new
-    formatter.strings = @twine_file
+    formatter.twine_file = @twine_file
     assert_equal content('formatter_tizen.xml'), formatter.format_file('en')
   end
 
@@ -279,7 +326,7 @@ class TestDjangoFormatter < FormatterTest
 
   def test_format_file
     formatter = Twine::Formatters::Django.new
-    formatter.strings = @twine_file
+    formatter.twine_file = @twine_file
     assert_equal content('formatter_django.po'), formatter.format_file('en')
   end
 end
@@ -295,9 +342,27 @@ class TestFlashFormatter < FormatterTest
     assert_file_contents_read_correctly
   end
 
+  def test_set_translation_converts_placeholders
+    @formatter.set_translation_for_key 'key1', 'en', "value {#{rand(10)}}"
+    assert_equal 'value %@', @empty_twine_file.definitions_by_key['key1'].translations['en']
+  end
+
   def test_format_file
     formatter = Twine::Formatters::Flash.new
-    formatter.strings = @twine_file
+    formatter.twine_file = @twine_file
     assert_equal content('formatter_flash.properties'), formatter.format_file('en')
   end
+
+  def test_format_value_converts_placeholders
+    assert_equal "value {0}", @formatter.format_value('value %d')
+  end
+
+  def test_deducts_language_from_resource_folder
+    language = %w(en de fr).sample
+    assert_equal language, @formatter.determine_language_given_path("locale/#{language}")
+  end
+
+  def test_deducts_language_and_region_from_resource_folder
+    assert_equal 'de-AT', @formatter.determine_language_given_path("locale/de-AT")
+  end
 end