twine 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 303ce6c7d8bab093ca71941fe800a657fb809ef3
-  data.tar.gz: 429d906f86a7f7bd566ffc4eb8590f8157a000e0
+  metadata.gz: 0e7971931654800b4d398dd6c3d9e86b96e4f5ba
+  data.tar.gz: 64a1eccc6c604439e10c82bded869527b123f8db
 SHA512:
-  metadata.gz: 5998ed4a6f39b0d09bcfd33d404239ccf2b7f6523aeae9fd36cd3af3b0c897ab589575ae91f365e77629718eba457ffaf6915d0965b12f40a097fb06cc054472
-  data.tar.gz: 0659ce0901ebef294dd81b59a08a1467d1f7399e04d84b4e303900a10ffbbf9252234d059fa1ec143fcacbf93b3ef857708c3e00b7fe55166be83464ffafa0e5
+  metadata.gz: 808d4045076dfef7fcba6d26797eb05d7638fd3c2adc964c24059a20f378beb8c5d978f1598d651e1117a13a1fbdbdf102d21c767aee3a68c7eb5699fae7215a
+  data.tar.gz: a63755c14cbadb14c0bba2960ff178a5785280bbb72e300dba5dc449ea510c823c6e248a1b848306f7c5de532c658ef8d4f034e80347f58ec2a4525673cf1ab6

data/README.md

@@ -78,7 +78,12 @@ Twine currently supports the following output formats:
 
 * [iOS and OS X String Resources][applestrings] (format: apple)
 * [Android String Resources][androidstrings] (format: android)
-    * Supports [basic styling][androidstyling] with \<b\>, \<i\>, \<u\> and \<a\> links. These tags will *not* be escaped. Use [`getText()`](https://developer.android.com/reference/android/content/res/Resources.html#getText(int)) to read these strings. Also tags inside `<![CDATA[` won't be escaped. See [\#212](https://github.com/scelis/twine/issues/212) for details.
+    * HTML tags will be escaped by replacing `<` with `&lt`
+    * Tags inside `<![CDATA[` won't be escaped.
+    * Supports [basic styling][androidstyling] with `<b>`, `<i>`, `<u>` and `<a>` links.
+	    * These tags will *not* be escaped if the string doesn't contain placeholders. You can reference them directly in your layouts or by using [`getText()`](https://developer.android.com/reference/android/content/res/Resources.html#getText(int)) to read them programatically.
+	    * These tags *will* be escaped if the string contains placeholders. You can use [`getString()`](https://developer.android.com/reference/android/content/res/Resources.html#getString(int,%20java.lang.Object...)) combined with [`fromHtml`](https://developer.android.com/reference/android/text/Html.html#fromHtml(java.lang.String)) as shown in the [documentation][androidstyling] to display them.
+	* See [\#212](https://github.com/scelis/twine/issues/212) for details.
 * [Gettext PO Files][gettextpo] (format: gettext)
 * [jquery-localize Language Files][jquerylocalize] (format: jquery)
 * [Django PO Files][djangopo] (format: django)
@@ -211,7 +216,7 @@ Many thanks to all of the contributors to the Twine project, including:
 [rubyzip]: http://rubygems.org/gems/rubyzip
 [git]: http://git-scm.org/
 [INI]: http://en.wikipedia.org/wiki/INI_file
-[applestrings]: http://developer.apple.com/documentation/Cocoa/Conceptual/LoadingResources/Strings/Strings.html
+[applestrings]: https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/LoadingResources/Strings/Strings.html
 [androidstrings]: http://developer.android.com/guide/topics/resources/string-resource.html
 [androidstyling]: http://developer.android.com/guide/topics/resources/string-resource.html#FormattingAndStyling
 [gettextpo]: http://www.gnu.org/savannah-checkouts/gnu/gettext/manual/html_node/PO-Files.html

data/lib/twine/formatters/android.rb

@@ -116,10 +116,15 @@ module Twine
         value = gsub_unless(value, "'", "\\'") { |substring| substring =~ inside_cdata }
         value = gsub_unless(value, /&/, '&') { |substring| substring =~ inside_cdata || substring =~ inside_opening_anchor_tag }
 
-        # escape opening angle brackes unless it's a supported styling tag
+        # if `value` contains a placeholder, escape all angle brackets
+        # if not, escape opening angle brackes unless it's a supported styling tag
         # https://github.com/scelis/twine/issues/212
         # https://stackoverflow.com/questions/3235131/#18199543
-        angle_bracket = /<(?!(\/?(b|u|i|a|\!\[CDATA)))/   # matches all `<` but <b>, <u>, <i>, <a> and <![CDATA
+        if number_of_twine_placeholders(value) > 0
+          angle_bracket = /<(?!(\/?(\!\[CDATA)))/           # matches all `<` but <![CDATA
+        else  
+          angle_bracket = /<(?!(\/?(b|u|i|a|\!\[CDATA)))/   # matches all `<` but <b>, <u>, <i>, <a> and <![CDATA
+        end
         value = gsub_unless(value, angle_bracket, '&lt;') { |substring| substring =~ inside_cdata }
 
         # escape non resource identifier @ signs (http://developer.android.com/guide/topics/resources/accessing-resources.html#ResourcesFromXml)

data/lib/twine/placeholders.rb

@@ -6,6 +6,11 @@ module Twine
     PLACEHOLDER_FLAGS_WIDTH_PRECISION_LENGTH = '([-+0#])?(\d+|\*)?(\.(\d+|\*))?(hh?|ll?|L|z|j|t|q)?'
     PLACEHOLDER_PARAMETER_FLAGS_WIDTH_PRECISION_LENGTH = '(\d+\$)?' + PLACEHOLDER_FLAGS_WIDTH_PRECISION_LENGTH
     PLACEHOLDER_TYPES = '[diufFeEgGxXoscpaA]'
+    PLACEHOLDER_REGEX = /%#{PLACEHOLDER_PARAMETER_FLAGS_WIDTH_PRECISION_LENGTH}#{PLACEHOLDER_TYPES}/
+
+    def number_of_twine_placeholders(input)
+      input.scan(PLACEHOLDER_REGEX).size
+    end
 
     def convert_twine_string_placeholder(input)
       # %@ -> %s
@@ -19,15 +24,13 @@ module Twine
       # %@ -> %s
       value = convert_twine_string_placeholder(input)
 
-      placeholder_syntax = PLACEHOLDER_PARAMETER_FLAGS_WIDTH_PRECISION_LENGTH + PLACEHOLDER_TYPES
-      placeholder_regex = /%#{placeholder_syntax}/
-
-      number_of_placeholders = value.scan(placeholder_regex).size
+      number_of_placeholders = number_of_twine_placeholders(input)
 
       return value if number_of_placeholders == 0
 
       # got placeholders -> need to double single percent signs
       # % -> %% (but %% -> %%, %d -> %d)
+      placeholder_syntax = PLACEHOLDER_PARAMETER_FLAGS_WIDTH_PRECISION_LENGTH + PLACEHOLDER_TYPES
       single_percent_regex = /([^%])(%)(?!(%|#{placeholder_syntax}))/
       value.gsub! single_percent_regex, '\1%%'
 
@@ -61,8 +64,7 @@ module Twine
     def convert_placeholders_from_twine_to_flash(input)
       value = convert_twine_string_placeholder(input)
 
-      placeholder_regex = /%#{PLACEHOLDER_PARAMETER_FLAGS_WIDTH_PRECISION_LENGTH}#{PLACEHOLDER_TYPES}/
-      value.gsub(placeholder_regex).each_with_index do |match, index|
+      value.gsub(PLACEHOLDER_REGEX).each_with_index do |match, index|
         "{#{index}}"
       end
     end

data/lib/twine/version.rb

@@ -1,3 +1,3 @@
 module Twine
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/test/test_formatters.rb

@@ -50,6 +50,10 @@ class TestAndroidFormatter < FormatterTest
       '<i>italic</i>'             => '<i>italic</i>',
       '<u>underline</u>'          => '<u>underline</u>',
 
+      '<b>%@</b>'                 => '&lt;b>%s&lt;/b>',
+      '<i>%@</i>'                 => '&lt;i>%s&lt;/i>',
+      '<u>%@</u>'                 => '&lt;u>%s&lt;/u>',
+
       '<span>inline</span>'       => '&lt;span>inline&lt;/span>',
       '<p>paragraph</p>'          => '&lt;p>paragraph&lt;/p>',
 
@@ -58,9 +62,10 @@ class TestAndroidFormatter < FormatterTest
       '<a href="target"></a>"out"'    => '<a href="target"></a>\"out\"',
       '<a href="http://url.com?param=1&param2=3&param3=%20">link</a>'   =>   '<a href="http://url.com?param=1&param2=3&param3=%20">link</a>',
 
-      '<p>escaped</p><![CDATA[]]>'    => '&lt;p>escaped&lt;/p><![CDATA[]]>',
-      '<![CDATA[]]><p>escaped</p>'    => '<![CDATA[]]>&lt;p>escaped&lt;/p>',
-      '<![CDATA[<p>unescaped</p>]]>'  => '<![CDATA[<p>unescaped</p>]]>',
+      '<p>escaped</p><![CDATA[]]>'                => '&lt;p>escaped&lt;/p><![CDATA[]]>',
+      '<![CDATA[]]><p>escaped</p>'                => '<![CDATA[]]>&lt;p>escaped&lt;/p>',
+      '<![CDATA[<p>unescaped</p>]]>'              => '<![CDATA[<p>unescaped</p>]]>',
+      '<![CDATA[<p>unescaped with %@</p>]]>'      => '<![CDATA[<p>unescaped with %s</p>]]>',
       '<![CDATA[]]><![CDATA[<p>unescaped</p>]]>'  => '<![CDATA[]]><![CDATA[<p>unescaped</p>]]>',
 
       '<![CDATA[&]]>'  => '<![CDATA[&]]>',

data/test/test_generate_all_localization_files.rb

@@ -1,11 +1,13 @@
 require 'command_test'
 
 class TestGenerateAllLocalizationFiles < CommandTest
-  def new_runner(create_folders, twine_file = nil)
-    options = {}
-    options[:output_path] = @output_dir
-    options[:format] = 'apple'
-    options[:create_folders] = create_folders
+  def new_runner(create_folders, twine_file = nil, options = {})
+    default_options = {}
+    default_options[:output_path] = @output_dir
+    default_options[:format] = 'apple'
+    default_options[:create_folders] = create_folders
+
+    options = default_options.merge options
 
     unless twine_file
       twine_file = build_twine_file 'en', 'es' do
@@ -18,6 +20,32 @@ class TestGenerateAllLocalizationFiles < CommandTest
     Twine::Runner.new(options, twine_file)
   end
 
+  class TestFormatterSelection < TestGenerateAllLocalizationFiles
+    def setup
+      super
+      Dir.mkdir File.join @output_dir, 'values-en'
+
+      # both Android and Tizen can handle folders containing `values-en`
+      android_formatter = prepare_mock_formatter(Twine::Formatters::Android)
+      tizen_formatter = prepare_mock_formatter(Twine::Formatters::Tizen, false)
+    end
+
+    def new_runner(options = {})
+      super(true, nil, options)
+    end
+
+    def test_returns_error_for_ambiguous_output_path
+      assert_raises Twine::Error do
+        new_runner(format: nil).generate_all_localization_files
+      end
+    end
+
+    def test_uses_specified_formatter_to_resolve_ambiguity
+      # implicit assert that this call doesn't raise an exception
+      new_runner(format: 'android').generate_all_localization_files
+    end
+  end
+
   class TestDoNotCreateFolders < TestGenerateAllLocalizationFiles
     def new_runner(twine_file = nil)
       super(false, twine_file)

data/test/test_generate_localization_file.rb

@@ -1,8 +1,7 @@
 require 'command_test'
 
 class TestGenerateLocalizationFile < CommandTest
-  def new_runner(language, file)
-    options = {}
+  def new_runner(language, file, options = {})
     options[:output_path] = File.join(@output_dir, file) if file
     options[:languages] = language if language
 
@@ -59,6 +58,17 @@ class TestGenerateLocalizationFile < CommandTest
     end
   end
 
+  def test_uses_specified_formatter_to_resolve_ambiguity
+    # both Android and Tizen use .xml
+    android_formatter = prepare_mock_formatter(Twine::Formatters::Android)
+    android_formatter.stubs(:format_file).returns(true)
+    tizen_formatter = prepare_mock_formatter(Twine::Formatters::Tizen, false)
+    tizen_formatter.stubs(:format_file).returns(true)
+
+    # implicit assert that this call doesn't raise an exception
+    new_runner('fr', 'fr.xml', format: 'android').generate_localization_file
+  end
+
   def test_deducts_language_from_output_path
     random_language = KNOWN_LANGUAGES.sample
     formatter = prepare_mock_formatter Twine::Formatters::Android

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: twine
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Sebastian Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-18 00:00:00.000000000 Z
+date: 2018-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
   name: safe_yaml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.4'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.5'
 - !ruby/object:Gem::Dependency
   name: minitest-ci
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
 description: |2
@@ -105,10 +105,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- README.md
 - LICENSE
+- README.md
+- bin/twine
+- lib/twine.rb
 - lib/twine/cli.rb
 - lib/twine/encoding.rb
+- lib/twine/formatters.rb
 - lib/twine/formatters/abstract.rb
 - lib/twine/formatters/android.rb
 - lib/twine/formatters/apple.rb
@@ -117,15 +120,12 @@ files:
 - lib/twine/formatters/gettext.rb
 - lib/twine/formatters/jquery.rb
 - lib/twine/formatters/tizen.rb
-- lib/twine/formatters.rb
 - lib/twine/output_processor.rb
 - lib/twine/placeholders.rb
 - lib/twine/plugin.rb
 - lib/twine/runner.rb
 - lib/twine/twine_file.rb
 - lib/twine/version.rb
-- lib/twine.rb
-- bin/twine
 - test/command_test.rb
 - test/fixtures/consume_localization_archive.zip
 - test/fixtures/enc_utf16be.dummy
@@ -167,17 +167,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Manage strings and their translations for your iOS, Android and other projects.