yury-twine 0.9.1

data/lib/twine/version.rb

@@ -0,0 +1,3 @@
+module Twine
+  VERSION = '0.9.1'
+end

data/test/command_test.rb

@@ -0,0 +1,14 @@
+require 'twine_test'
+
+class CommandTest < TwineTest
+  def prepare_mock_formatter(formatter_class)
+    twine_file = Twine::TwineFile.new
+    twine_file.language_codes.concat KNOWN_LANGUAGES
+
+    formatter = formatter_class.new
+    formatter.twine_file = twine_file
+    Twine::Formatters.formatters.clear
+    Twine::Formatters.formatters << formatter
+    formatter
+  end
+end

data/test/fixtures/enc_utf8.dummy

@@ -0,0 +1,2 @@
+Üß`
+da

data/test/fixtures/formatter_android.xml

@@ -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>

data/test/fixtures/formatter_apple.strings

@@ -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";

data/test/fixtures/formatter_django.po

@@ -0,0 +1,30 @@
+##
+ # Django Strings File
+ # Generated by Twine <%= Twine::VERSION %>
+ # Language: en
+msgid ""
+msgstr ""
+"Content-Type: text/plain; charset=UTF-8\n"
+
+#--------- Section 1 ---------#
+
+#. comment key1
+# base translation: "value1-english"
+msgid "key1"
+msgstr "value1-english"
+
+# base translation: "value2-english"
+msgid "key2"
+msgstr "value2-english"
+
+
+#--------- Section 2 ---------#
+
+# base translation: "value3-english"
+msgid "key3"
+msgstr "value3-english"
+
+#. comment key4
+# base translation: "value4-english"
+msgid "key4"
+msgstr "value4-english"

data/test/fixtures/formatter_flash.properties

@@ -0,0 +1,15 @@
+## Flash 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

data/test/fixtures/formatter_gettext.po

@@ -0,0 +1,26 @@
+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"

data/test/fixtures/formatter_jquery.json

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

data/test/fixtures/formatter_tizen.xml

@@ -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>

data/test/fixtures/gettext_multiline.po

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

data/test/fixtures/twine_accent_values.txt

@@ -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``

data/test/test_abstract_formatter.rb

@@ -0,0 +1,165 @@
+require 'twine_test'
+
+class TestAbstractFormatter < TwineTest
+  class SetTranslation < TwineTest
+    def setup
+      super
+
+      @twine_file = build_twine_file 'en', 'fr' do
+        add_section 'Section' do
+          add_definition key1: 'value1-english'
+          add_definition key2: { en: 'value2-english', fr: 'value2-french' }
+        end
+      end
+
+      @formatter = Twine::Formatters::Abstract.new
+      @formatter.twine_file = @twine_file
+    end
+
+    def test_set_translation_updates_existing_value
+      @formatter.set_translation_for_key 'key1', 'en', 'value1-english-updated'
+
+      assert_equal 'value1-english-updated', @twine_file.definitions_by_key['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', @twine_file.definitions_by_key['key2'].translations['fr']
+    end
+
+    def test_set_translation_escapes_newlines
+      @formatter.set_translation_for_key 'key1', 'en', "new\nline"
+
+      assert_equal 'new\nline', @twine_file.definitions_by_key['key1'].translations['en']
+    end
+
+    def test_set_translation_adds_translation_to_existing_key
+      @formatter.set_translation_for_key 'key1', 'fr', 'value1-french'
+
+      assert_equal 'value1-french', @twine_file.definitions_by_key['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 @twine_file.definitions_by_key['new-key']
+    end
+
+    def test_set_translation_consume_all_adds_new_key
+      formatter = Twine::Formatters::Abstract.new
+      formatter.twine_file = @twine_file
+      formatter.options = { consume_all: true }
+      formatter.set_translation_for_key 'new-key', 'en', 'new-key-english'
+
+      assert_equal 'new-key-english', @twine_file.definitions_by_key['new-key'].translations['en']
+    end
+
+    def test_set_translation_consume_all_adds_tags
+      random_tag = SecureRandom.uuid
+      formatter = Twine::Formatters::Abstract.new
+      formatter.twine_file = @twine_file
+      formatter.options = { consume_all: true, tags: [random_tag] }
+      formatter.set_translation_for_key 'new-key', 'en', 'new-key-english'
+
+      assert_equal [random_tag], @twine_file.definitions_by_key['new-key'].tags
+    end
+
+    def test_set_translation_adds_new_keys_to_category_uncategoriezed
+      formatter = Twine::Formatters::Abstract.new
+      formatter.twine_file = @twine_file
+      formatter.options = { consume_all: true }
+      formatter.set_translation_for_key 'new-key', 'en', 'new-key-english'
+
+      assert_equal 'Uncategorized', @twine_file.sections[0].name 
+      assert_equal 'new-key', @twine_file.sections[0].definitions[0].key
+    end
+  end
+
+  class ValueReference < TwineTest
+    def setup
+      super
+
+      @twine_file = build_twine_file 'en', 'fr' do
+        add_section 'Section' do
+          add_definition refkey: 'ref-value'
+          add_definition key: :refkey
+        end
+      end
+
+      @formatter = Twine::Formatters::Abstract.new
+      @formatter.twine_file = @twine_file
+    end
+
+    def test_set_translation_does_not_add_unchanged_translation
+      @formatter.set_translation_for_key 'key', 'en', 'ref-value'
+
+      assert_nil @twine_file.definitions_by_key['key'].translations['en']
+    end
+
+    def test_set_translation_adds_changed_translation
+      @formatter.set_translation_for_key 'key', 'en', 'changed value'
+
+      assert_equal 'changed value', @twine_file.definitions_by_key['key'].translations['en']
+    end
+  end
+
+  class SetComment < TwineTest
+    def setup
+      super
+
+      @twine_file = build_twine_file 'en' do
+        add_section 'Section' do
+          add_definition key: 'value'
+        end
+      end
+    end
+
+    def test_set_comment_for_key_does_not_update_comment
+      formatter = Twine::Formatters::Abstract.new
+      formatter.twine_file = @twine_file
+      formatter.set_comment_for_key('key', 'comment')
+
+      assert_nil formatter.twine_file.definitions_by_key['key'].comment
+    end
+
+    def test_set_comment_for_key_updates_comment_with_update_comments
+      formatter = Twine::Formatters::Abstract.new
+      formatter.twine_file = @twine_file
+      formatter.options = { consume_comments: true }
+      formatter.set_comment_for_key('key', 'comment')
+
+      assert_equal 'comment', formatter.twine_file.definitions_by_key['key'].comment
+    end
+  end
+
+  class CommentReference < TwineTest
+    def setup
+      super
+
+      @twine_file = build_twine_file 'en' do
+        add_section 'Section' do
+          add_definition refkey: 'ref-value', comment: 'reference comment'
+          add_definition key: 'value', ref: :refkey
+        end
+      end
+
+      @formatter = Twine::Formatters::Abstract.new
+      @formatter.twine_file = @twine_file
+      @formatter.options = { consume_comments: true }
+    end
+
+    def test_set_comment_does_not_add_unchanged_comment
+      @formatter.set_comment_for_key 'key', 'reference comment'
+      
+      assert_nil @twine_file.definitions_by_key['key'].raw_comment
+    end
+
+    def test_set_comment_adds_changed_comment
+      @formatter.set_comment_for_key 'key', 'changed comment'
+
+      assert_equal 'changed comment', @twine_file.definitions_by_key['key'].raw_comment
+    end
+  end
+
+end

data/test/test_cli.rb

@@ -0,0 +1,304 @@
+require 'twine_test'
+
+class CLITest < TwineTest
+  def setup
+    super
+
+    @twine_file_path = File.join @output_dir, SecureRandom.uuid
+    @input_path = File.join @output_dir, SecureRandom.uuid
+    @input_dir = @output_dir
+  end
+
+  def parse(command)
+    @options = Twine::CLI::parse command.split
+  end
+
+  class TestValidateTwineFile < CLITest
+    def test_command
+      parse "validate-twine-file #{@twine_file_path}"
+
+      assert_equal 'validate-twine-file', @options[:command]
+      assert_equal @twine_file_path, @options[:twine_file]
+    end
+
+    def test_pedantic
+      parse "validate-twine-file #{@twine_file_path} --pedantic"
+      assert @options[:pedantic]
+    end
+
+    def test_missing_parameter
+      assert_raises Twine::Error do
+        parse 'validate-twine-file'
+      end
+    end
+
+    def test_extra_parameter
+      assert_raises Twine::Error do
+        parse 'validate-twine-file twine_file extra'
+      end
+    end
+  end
+
+  class TestGenerateLocalizationFile < CLITest
+    def test_command
+      parse "generate-localization-file #{@twine_file_path} #{@output_path}"
+
+      assert_equal 'generate-localization-file', @options[:command]
+      assert_equal @twine_file_path, @options[:twine_file]
+      assert_equal @output_path, @options[:output_path]
+    end
+
+    def test_missing_parameter
+      assert_raises Twine::Error do
+        parse 'generate-localization-file twine_file'
+      end
+    end
+
+    def test_validate
+      parse "generate-localization-file #{@twine_file_path} #{@output_path} --validate"
+      assert @options[:validate]
+    end
+
+    def test_extra_parameter
+      assert_raises Twine::Error do
+        parse 'generate-localization-file twine_file output extra'
+      end
+    end
+
+    def test_only_allows_one_language
+      assert_raises Twine::Error do
+        parse "generate-localization-file twine_file output --lang en,fr"
+      end
+    end
+  end
+
+  class TestGenerateAllLocalizationFiles < CLITest
+    def test_command
+      parse "generate-all-localization-files #{@twine_file_path} #{@output_dir}"
+
+      assert_equal 'generate-all-localization-files', @options[:command]
+      assert_equal @twine_file_path, @options[:twine_file]
+      assert_equal @output_dir, @options[:output_path]
+    end
+
+    def test_missing_parameter
+      assert_raises Twine::Error do
+        parse "generate-all-localization-files twine_file"
+      end
+    end
+
+    def test_validate
+      parse "generate-all-localization-files #{@twine_file_path} #{@output_dir} --validate"
+      assert @options[:validate]
+    end
+
+    def test_extra_parameter
+      assert_raises Twine::Error do
+        parse "generate-all-localization-files twine_file output extra"
+      end
+    end
+  end
+
+  class TestConsumeLocalizationFile < CLITest
+    def test_command
+      parse "consume-localization-file #{@twine_file_path} #{@input_path}"
+
+      assert_equal 'consume-localization-file', @options[:command]
+      assert_equal @twine_file_path, @options[:twine_file]
+      assert_equal @input_path, @options[:input_path]
+    end
+
+    def test_missing_parameter
+      assert_raises Twine::Error do
+        parse "consume-localization-file twine_file"
+      end
+    end
+
+    def test_extra_parameter
+      assert_raises Twine::Error do
+        parse "consume-localization-file twine_file output extra"
+      end
+    end
+
+    def test_only_allows_one_language
+      assert_raises Twine::Error do
+        parse "consume-localization-file twine_file output --lang en,fr"
+      end
+    end
+  end
+
+  class TestConsumeAllLocalizationFiles < CLITest
+    def test_command
+      parse "consume-all-localization-files #{@twine_file_path} #{@input_dir}"
+
+      assert_equal 'consume-all-localization-files', @options[:command]
+      assert_equal @twine_file_path, @options[:twine_file]
+      assert_equal @input_dir, @options[:input_path]
+    end
+
+    def test_missing_parameter
+      assert_raises Twine::Error do
+        parse "consume-all-localization-files twine_file"
+      end
+    end
+
+    def test_extra_parameter
+      assert_raises Twine::Error do
+        parse "consume-all-localization-files twine_file output extra"
+      end
+    end
+  end
+
+  class TestGenerateLocDrop < CLITest
+    def test_command
+      parse "generate-loc-drop #{@twine_file_path} #{@output_path} --format apple"
+
+      assert_equal 'generate-loc-drop', @options[:command]
+      assert_equal @twine_file_path, @options[:twine_file]
+      assert_equal @output_path, @options[:output_path]
+    end
+
+    def test_missing_parameter
+      assert_raises Twine::Error do
+        parse "generate-loc-drop twine_file --format apple"
+      end
+    end
+
+    def test_validate
+      parse "generate-loc-drop #{@twine_file_path} #{@output_path} --format apple --validate"
+      assert @options[:validate]
+    end
+
+    def test_extra_parameter
+      assert_raises Twine::Error do
+        parse "generate-loc-drop twine_file output extra --format apple"
+      end
+    end
+
+    def test_format_needed
+      assert_raises Twine::Error do
+        parse "generate-loc-drop twine_file output"
+      end
+    end
+  end
+
+  class TestConsumeLocDrop < CLITest
+    def test_command
+      parse "consume-loc-drop #{@twine_file_path} #{@input_path}"
+
+      assert_equal 'consume-loc-drop', @options[:command]
+      assert_equal @twine_file_path, @options[:twine_file]
+      assert_equal @input_path, @options[:input_path]
+    end
+
+    def test_missing_parameter
+      assert_raises Twine::Error do
+        parse "consume-loc-drop twine_file"
+      end
+    end
+
+    def test_extra_parameter
+      assert_raises Twine::Error do
+        parse "consume-loc-drop twine_file input extra"
+      end
+    end
+  end
+
+  class TestParameters < CLITest
+    def parse_with(parameter)
+      parse 'validate-twine-file input.txt ' + parameter
+    end
+
+    def test_default_options
+      parse_with ''
+      expected = {command: 'validate-twine-file', twine_file: 'input.txt', include: :all}
+      assert_equal expected, @options
+    end
+
+    def test_create_folders
+      parse_with '--create-folders'
+      assert @options[:create_folders]
+    end
+
+    def test_consume_all
+      parse_with '--consume-all'
+      assert @options[:consume_all]
+    end
+
+    def test_consume_comments
+      parse_with '--consume-comments'
+      assert @options[:consume_comments]
+    end
+
+    def test_untagged
+      parse_with '--untagged'
+      assert @options[:untagged]
+    end
+
+    def test_developer_language
+      random_language = KNOWN_LANGUAGES.sample
+      parse_with "--developer-lang #{random_language}"
+      assert_equal random_language, @options[:developer_language]
+    end
+
+    def test_single_language
+      random_language = KNOWN_LANGUAGES.sample
+      parse_with "--lang #{random_language}"
+      assert_equal [random_language], @options[:languages]
+    end
+
+    def test_multiple_languages
+      random_languages = KNOWN_LANGUAGES.shuffle[0, 3]
+      parse_with "--lang #{random_languages.join(',')}"
+      assert_equal random_languages.sort, @options[:languages].sort
+    end
+
+    def test_single_tag
+      random_tag = "tag#{rand(100)}"
+      parse_with "--tags #{random_tag}"
+      assert_equal [[random_tag]], @options[:tags]
+    end
+
+    def test_multiple_OR_tags
+      random_tags = ["tag#{rand(100)}", "tag#{rand(100)}", "tag#{rand(100)}"]
+      parse_with "--tags #{random_tags.join(',')}"
+      sorted_tags = @options[:tags].map { |tags| tags.sort }
+      assert_equal [random_tags.sort], sorted_tags
+    end
+
+    def test_multiple_AND_tags
+      random_tag_1 = "tag#{rand(100)}"
+      random_tag_2 = "tag#{rand(100)}"
+      parse_with "--tags #{random_tag_1} --tags #{random_tag_2}"
+      assert_equal [[random_tag_1], [random_tag_2]], @options[:tags]
+    end
+
+    def test_format
+      random_format = Twine::Formatters.formatters.sample.format_name.downcase
+      parse_with "--format #{random_format}"
+      assert_equal random_format, @options[:format]
+    end
+
+    def test_include
+      random_set = [:all, :translated, :untranslated].sample
+      parse_with "--include #{random_set}"
+      assert_equal random_set, @options[:include]
+    end
+
+    def test_output_path
+      parse_with "--output-file #{@output_path}"
+      assert_equal @output_path, @options[:output_path]
+    end
+
+    def test_file_name
+      random_filename = "#{rand(10000)}"
+      parse_with "--file-name #{random_filename}"
+      assert_equal random_filename, @options[:file_name]
+    end
+
+    def test_encoding
+      parse_with '--encoding UTF16'
+      assert_equal 'UTF16', @options[:output_encoding]
+    end
+  end
+end