twine 0.7.0 → 0.8.0

data/lib/twine/stringsfile.rb

@@ -14,6 +14,8 @@ module Twine
     attr_accessor :comment
     attr_accessor :tags
     attr_reader :translations
+    attr_accessor :reference
+    attr_accessor :reference_key
 
     def initialize(key)
       @key = key
@@ -22,37 +24,36 @@ module Twine
       @translations = {}
     end
 
+    def comment
+      raw_comment || (reference.comment if reference)
+    end
+
+    def raw_comment
+      @comment
+    end
+
     def matches_tags?(tags, include_untagged)
-      if tags == nil || tags.length == 0
+      if tags == nil || tags.empty?
         # The user did not specify any tags. Everything passes.
         return true
-      elsif @tags == nil || @tags.length == 0
+      elsif @tags == nil
         # This row has no tags.
-        return (include_untagged) ? true : false
+        return reference ? reference.matches_tags?(tags, include_untagged) : include_untagged
+      elsif @tags.empty?
+        return include_untagged
       else
-        tags.each do |tag|
-          if @tags.include? tag
-            return true
-          end
-        end
+        return !(tags & @tags).empty?
       end
 
       return false
     end
 
-    def translated_string_for_lang(lang, default_lang=nil)
-      if @translations[lang]
-        return @translations[lang]
-      elsif default_lang.respond_to?("each")
-        default_lang.each do |def_lang|
-          if @translations[def_lang]
-            return @translations[def_lang]
-          end
-        end
-        return nil
-      else
-        return @translations[default_lang]
-      end
+    def translated_string_for_lang(lang)
+      translation = [lang].flatten.map { |l| @translations[l] }.first
+
+      translation = reference.translated_string_for_lang(lang) if translation.nil? && reference
+
+      return translation
     end
   end
 
@@ -61,12 +62,38 @@ module Twine
     attr_reader :strings_map
     attr_reader :language_codes
 
+    private
+
+    def match_key(text)
+      match = /^\[(.+)\]$/.match(text)
+      return match[1] if match
+    end
+
+    public
+
     def initialize
       @sections = []
       @strings_map = {}
       @language_codes = []
     end
 
+    def add_language_code(code)
+      if @language_codes.length == 0
+        @language_codes << code
+      elsif !@language_codes.include?(code)
+        dev_lang = @language_codes[0]
+        @language_codes << code
+        @language_codes.delete(dev_lang)
+        @language_codes.sort!
+        @language_codes.insert(0, dev_lang)
+      end
+    end
+
+    def set_developer_language_code(code)
+      @language_codes.delete(code)
+      @language_codes.insert(0, code)
+    end
+
     def read(path)
       if !File.file?(path)
         raise Twine::Error.new("File does not exist: #{path}")
@@ -93,9 +120,9 @@ module Twine
               parsed = true
             end
           elsif line.length > 2 && line[0, 1] == '['
-            match = /^\[(.+)\]$/.match(line)
-            if match
-              current_row = StringsRow.new(match[1])
+            key = match_key(line)
+            if key
+              current_row = StringsRow.new(key)
               @strings_map[current_row.key] = current_row
               if !current_section
                 current_section = StringsSection.new('')
@@ -109,15 +136,16 @@ module Twine
             if match
               key = match[1].strip
               value = match[2].strip
-              if value[0,1] == '`' && value[-1,1] == '`'
-                value = value[1..-2]
-              end
+              
+              value = value[1..-2] if value[0] == '`' && value[-1] == '`'
 
               case key
-              when "comment"
+              when 'comment'
                 current_row.comment = value
               when 'tags'
                 current_row.tags = value.split(',')
+              when 'ref'
+                current_row.reference_key = value if value
               else
                 if !@language_codes.include? key
                   add_language_code(key)
@@ -133,6 +161,12 @@ module Twine
           end
         end
       end
+
+      # resolve_references
+      @strings_map.each do |key, row|
+        next unless row.reference_key
+        row.reference = @strings_map[row.reference_key]
+      end
     end
 
     def write(path)
@@ -148,54 +182,43 @@ module Twine
 
           section.rows.each do |row|
             f.puts "\t[#{row.key}]"
-            value = row.translations[dev_lang]
-            if !value
+
+            value = write_value(row, dev_lang, f)
+            if !value && !row.reference_key
               puts "Warning: #{row.key} does not exist in developer language '#{dev_lang}'"
-            else
-              if value[0,1] == ' ' || value[-1,1] == ' ' || (value[0,1] == '`' && value[-1,1] == '`')
-                value = '`' + value + '`'
-              end
-              f.puts "\t\t#{dev_lang} = #{value}"
             end
-
+            
+            if row.reference_key
+              f.puts "\t\tref = #{row.reference_key}"
+            end
             if row.tags && row.tags.length > 0
               tag_str = row.tags.join(',')
               f.puts "\t\ttags = #{tag_str}"
             end
-            if row.comment && row.comment.length > 0
-              f.puts "\t\tcomment = #{row.comment}"
+            if row.raw_comment and row.raw_comment.length > 0
+              f.puts "\t\tcomment = #{row.raw_comment}"
             end
             @language_codes[1..-1].each do |lang|
-              value = row.translations[lang]
-              if value
-                if value[0,1] == ' ' || value[-1,1] == ' ' || (value[0,1] == '`' && value[-1,1] == '`')
-                  value = '`' + value + '`'
-                end
-                f.puts "\t\t#{lang} = #{value}"
-              end
+              write_value(row, lang, f)
             end
           end
         end
       end
     end
 
-    def add_language_code(code)
-      if @language_codes.length == 0
-        @language_codes << code
-      elsif !@language_codes.include?(code)
-        dev_lang = @language_codes[0]
-        @language_codes << code
-        @language_codes.delete(dev_lang)
-        @language_codes.sort!
-        @language_codes.insert(0, dev_lang)
-      end
-    end
+    private
 
-    def set_developer_language_code(code)
-      if @language_codes.include?(code)
-        @language_codes.delete(code)
+    def write_value(row, language, file)
+      value = row.translations[language]
+      return nil unless value
+
+      if value[0] == ' ' || value[-1] == ' ' || (value[0] == '`' && value[-1] == '`')
+        value = '`' + value + '`'
       end
-      @language_codes.insert(0, code)
+
+      file.puts "\t\t#{language} = #{value}"
+      return value
     end
+
   end
 end

data/lib/twine/version.rb

@@ -1,3 +1,3 @@
 module Twine
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

data/test/command_test_case.rb

@@ -0,0 +1,12 @@
+require 'twine_test_case'
+
+class CommandTestCase < TwineTestCase
+  def prepare_mock_formatter(formatter_class)
+    strings = Twine::StringsFile.new
+    strings.language_codes.concat KNOWN_LANGUAGES
+
+    formatter = formatter_class.new(strings, {})
+    formatter_class.stubs(:new).returns(formatter)
+    formatter
+  end
+end

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,28 @@
+##
+ # Django Strings File
+ # Generated by Twine 0.7.0
+ # Language: en
+
+
+#--------- 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 0.7.0
+## 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,152 @@
+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_escapes_newlines
+      @formatter.set_translation_for_key 'key1', 'en', "new\nline"
+
+      assert_equal 'new\nline', @strings.strings_map['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', @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 setup
+      super
+
+      @strings = build_twine_file 'en' do
+        add_section 'Section' do
+          add_row key: 'value'
+        end
+      end
+    end
+
+    def test_set_comment_for_key_does_not_update_comment
+      formatter = Twine::Formatters::Abstract.new(@strings, {})
+      formatter.set_comment_for_key('key', 'comment')
+
+      assert_nil formatter.strings.strings_map['key'].comment
+    end
+
+    def test_set_comment_for_key_updates_comment_with_update_comments
+      formatter = Twine::Formatters::Abstract.new(@strings, { consume_comments: true })
+      formatter.set_comment_for_key('key', 'comment')
+
+      assert_equal 'comment', formatter.strings.strings_map['key'].comment
+    end
+  end
+
+  class CommentReference < TwineTestCase
+    def setup
+      super
+
+      @strings = build_twine_file 'en' 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, { consume_comments: true })
+    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