From 1a49852a6e65dcca9bbde8834408eb16de157161 Mon Sep 17 00:00:00 2001
From: Sebastian Ludwig <sebastian@lurado.de>
Date: Sat, 5 Dec 2015 15:33:21 +0100
Subject: [PATCH] Added Placeholders module and added methods to convert from
 twine format to android and vice versa.

---
 lib/twine.rb                    |  1 +
 lib/twine/formatters/android.rb |  4 +-
 lib/twine/placeholders.rb       | 52 ++++++++++++++++++++
 test/test_formatters.rb         | 26 +++-------
 test/test_placeholders.rb       | 86 +++++++++++++++++++++++++++++++++
 5 files changed, 148 insertions(+), 21 deletions(-)
 create mode 100644 lib/twine/placeholders.rb
 create mode 100644 test/test_placeholders.rb

diff --git a/lib/twine.rb b/lib/twine.rb
index 3f9e5e0..2c51685 100644
--- a/lib/twine.rb
+++ b/lib/twine.rb
@@ -7,6 +7,7 @@ module Twine
   require 'twine/encoding'
   require 'twine/output_processor'
   require 'twine/formatters'
+  require 'twine/placeholders'
   require 'twine/runner'
   require 'twine/stringsfile'
   require 'twine/version'
diff --git a/lib/twine/formatters/android.rb b/lib/twine/formatters/android.rb
index ff32e7f..a07a43b 100644
--- a/lib/twine/formatters/android.rb
+++ b/lib/twine/formatters/android.rb
@@ -49,7 +49,7 @@ module Twine
         value = CGI.unescapeHTML(value)
         value.gsub!('\\\'', '\'')
         value.gsub!('\\"', '"')
-        value = iosify_substitutions(value)
+        value = Placeholders.from_android_to_twine(value)
         value.gsub!(/(\\u0020)*|(\\u0020)*\z/) { |spaces| ' ' * (spaces.length / 6) }
         super(key, lang, value)
       end
@@ -121,7 +121,7 @@ module Twine
         #  2) HTML escape the string
         value = CGI.escapeHTML(value)
         #  3) fix substitutions (e.g. %s/%@)
-        value = androidify_substitutions(value)
+        value = Placeholders.from_twine_to_android(value)
         #  4) replace beginning and end spaces with \0020. Otherwise Android strips them.
         value.gsub(/\A *| *\z/) { |spaces| '\u0020' * spaces.length }
       end
diff --git a/lib/twine/placeholders.rb b/lib/twine/placeholders.rb
new file mode 100644
index 0000000..e17a8a6
--- /dev/null
+++ b/lib/twine/placeholders.rb
@@ -0,0 +1,52 @@
+module Twine
+  module Placeholders
+    PLACEHOLDER_FLAGS_WIDTH_PRECISION_LENGTH = '([-+ 0#])?(\d+|\*)?(\.(\d+|\*))?(hh?|ll?|L|z|j|t)?'
+    PLACEHOLDER_PARAMETER_FLAGS_WIDTH_PRECISION_LENGTH = '(\d+\$)?' + PLACEHOLDER_FLAGS_WIDTH_PRECISION_LENGTH
+
+    # http://developer.android.com/guide/topics/resources/string-resource.html#FormattingAndStyling
+    # http://stackoverflow.com/questions/4414389/android-xml-percent-symbol
+    # https://github.com/mobiata/twine/pull/106
+    def self.from_twine_to_android(input)
+      placeholder_types = '[diufFeEgGxXoscpaA]'
+
+      # %@ -> %s
+      value = input.gsub(/(%#{PLACEHOLDER_PARAMETER_FLAGS_WIDTH_PRECISION_LENGTH})@/, '\1s')
+
+      placeholder_syntax = PLACEHOLDER_PARAMETER_FLAGS_WIDTH_PRECISION_LENGTH + placeholder_types
+      placeholder_regex = /%#{placeholder_syntax}/
+
+      number_of_placeholders = value.scan(placeholder_regex).size
+
+      return value if number_of_placeholders == 0
+
+      # got placeholders -> need to double single percent signs
+      # % -> %% (but %% -> %%, %d -> %d)
+      single_percent_regex = /([^%])(%)(?!(%|#{placeholder_syntax}))/
+      value.gsub! single_percent_regex, '\1%%'
+
+      return value if number_of_placeholders < 2
+
+      # number placeholders
+      non_numbered_placeholder_regex = /%(#{PLACEHOLDER_FLAGS_WIDTH_PRECISION_LENGTH}#{placeholder_types})/
+
+      number_of_non_numbered_placeholders = value.scan(non_numbered_placeholder_regex).size
+
+      return value if number_of_non_numbered_placeholders == 0
+
+      raise Twine::Error.new("The value \"#{input}\" contains numbered and non-numbered placeholders") if number_of_placeholders != number_of_non_numbered_placeholders
+
+      # %d -> %$1d
+      index = 0
+      value.gsub!(non_numbered_placeholder_regex) { "%#{index += 1}$#{$1}" }
+
+      value
+    end
+
+    def self.from_android_to_twine(input)
+      placeholder_regex = /(%#{PLACEHOLDER_PARAMETER_FLAGS_WIDTH_PRECISION_LENGTH})s/
+
+      # %s -> %@
+      input.gsub(placeholder_regex, '\1@')
+    end
+  end
+end
diff --git a/test/test_formatters.rb b/test/test_formatters.rb
index 6727329..b0bec82 100644
--- a/test/test_formatters.rb
+++ b/test/test_formatters.rb
@@ -34,16 +34,21 @@ class TestAndroidFormatter < FormatterTest
     end
   end
 
-  def test_set_translation_transforms_leading_spaces
+  def test_set_translation_converts_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
+  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']
   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']
+  end
+
   def test_write_file_output_format
     formatter = Twine::Formatters::Android.new @twine_file, {}
     formatter.write_file @output_path, 'en'
@@ -67,23 +72,6 @@ class TestAndroidFormatter < FormatterTest
     # 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
diff --git a/test/test_placeholders.rb b/test/test_placeholders.rb
new file mode 100644
index 0000000..3376130
--- /dev/null
+++ b/test/test_placeholders.rb
@@ -0,0 +1,86 @@
+require 'twine_test_case'
+
+class PlaceholderTestCase < TwineTestCase
+  def assert_starts_with(prefix, value)
+    msg = message(nil) { "Expected #{mu_pp(value)} to start with #{mu_pp(prefix)}" }
+    assert value.start_with?(prefix), msg
+  end
+
+  def placeholder(type = nil)
+    # %[parameter][flags][width][.precision][length]type (see https://en.wikipedia.org/wiki/Printf_format_string#Format_placeholder_specification)
+    lucky = lambda { rand > 0.5 }
+    placeholder = '%'
+    placeholder += (rand * 20).to_i.to_s + '$' if lucky.call
+    placeholder += '-+ 0#'.chars.to_a.sample if lucky.call
+    placeholder += (0.upto(20).map(&:to_s) << "*").sample if lucky.call
+    placeholder += '.' + (0.upto(20).map(&:to_s) << "*").sample if lucky.call
+    placeholder += %w(h hh l ll L z j t).sample if lucky.call
+    placeholder += type || 'diufFeEgGxXocpaA'.chars.to_a.sample # this does not contain s or @ because strings are a special case
+  end
+end
+
+class PlaceholderTest < TwineTestCase
+  class ToAndroid < PlaceholderTestCase
+    def to_android(value)
+      Twine::Placeholders.from_twine_to_android(value)
+    end
+
+    def test_replaces_string_placeholder
+      placeholder = placeholder('@')
+      expected = placeholder
+      expected[-1] = 's'
+      assert_equal "some #{expected} value", to_android("some #{placeholder} value")
+    end
+
+    def test_does_not_change_regular_at_signs
+      input = "some @ more @@ signs @"
+      assert_equal input, to_android(input)
+    end
+
+    def test_does_not_modify_single_percent_signs
+      assert_equal "some % value", to_android("some % value")
+    end
+
+    def test_escapes_single_percent_signs_if_placeholder_present
+      assert_starts_with "some %% v", to_android("some % value #{placeholder}")
+    end
+
+    def test_does_not_modify_double_percent_signs
+      assert_equal "some %% value", to_android("some %% value")
+    end
+
+    def test_does_not_modify_double_percent_signs_if_placeholder_present
+      assert_starts_with "some %% v", to_android("some %% value #{placeholder}")
+    end
+
+    def test_does_not_modify_single_placeholder
+      input = "some #{placeholder} text"
+      assert_equal input, to_android(input)
+    end
+
+    def test_numbers_multiple_placeholders
+      assert_equal "first %1$d second %2$f", to_android("first %d second %f")
+    end
+
+    def test_does_not_modify_numbered_placeholders
+      input = "second %2$f first %1$d"
+      assert_equal input, to_android(input)
+    end
+
+    def test_raises_an_error_when_mixing_numbered_and_non_numbered_placeholders
+      assert_raises Twine::Error do
+        to_android("some %d second %2$f")
+      end
+    end
+  end
+
+  class FromAndroid < PlaceholderTestCase
+    def from_android(value)
+      Twine::Placeholders.from_android_to_twine(value)
+    end
+
+    def test_replaces_string_placeholder
+      assert_equal "some %@ value", from_android("some %s value")
+    end
+  end
+end