twine 1.0.6 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f6d46a283d86aa50c84b7b229f2e3159edd72816
-  data.tar.gz: c412942ce007dbd236cc32b4b9ceadf99734cbe4
+SHA256:
+  metadata.gz: d8667f50ad7147b8b7edac0d82ce542c2ecc973604c8334e878513b6acaa9a14
+  data.tar.gz: 1ceb2b2b18dea8a3585bd91a1b427b30ebd9c888817dcf7140b3d211cd9e157c
 SHA512:
-  metadata.gz: b44a73df4eb789f78cbec2a37cbe496f7cda95ea62b7e56c2eb189d5f26b5c0a5ef497b7c185a78961ba263df64e386a7efc2b58a58dab540eb0ea9a81b68922
-  data.tar.gz: c9814e961ac0c8eb36c61122c89b3d9bd321133dd8b0441e2cfdd352a65e71d74cf8cae31d0da9903988e80c524fef332dd5fc56c2d4dc622e3f581364770636
+  metadata.gz: a961953ec7b74510c10e17114b84c227bac43117a869ba4254d7410a16ea9413e4133a2c9f099c3d67922fd6e1632d841f366e79d28687e61f73861721dea43a
+  data.tar.gz: 954b69b0d6e0fadec38cf145e0e1772eb1fde0259337b45ffac172d41b6f6c031b33373c768cfbb48ad3e9cfb1565dc9e91db8e825023421fdc30098439a4d86

data/lib/twine/cli.rb

@@ -45,6 +45,14 @@ module Twine
           files are UTF-16 without BOM, you need to specify if it's UTF-16LE or UTF16-BE.
         DESC
       },
+      escape_all_tags: {
+        switch: ['--[no-]escape-all-tags'],
+        description: <<-DESC,
+          Always escape all HTML tags. By default the Android formatter will ONLY escape styling tags, if a 
+          string also contains placeholders. This flag enforces that styling tags are escaped regardless of
+          placeholders.
+        DESC
+      },
       file_name: {
         switch: ['-n', '--file-name FILE_NAME'],
         description: 'This flag may be used to overwrite the default file name of the format.'
@@ -111,6 +119,7 @@ module Twine
         optional_options: [
           :developer_language,
           :encoding,
+          :escape_all_tags,
           :format,
           :include,
           :languages,
@@ -133,6 +142,7 @@ module Twine
           :create_folders,
           :developer_language,
           :encoding,
+          :escape_all_tags,
           :file_name,
           :format,
           :include,
@@ -152,6 +162,7 @@ module Twine
         optional_options: [
           :developer_language,
           :encoding,
+          :escape_all_tags,
           :include,
           :quiet,
           :tags,

data/lib/twine/formatters/android.rb

@@ -125,7 +125,7 @@ module Twine
         # 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
-        if number_of_twine_placeholders(value) > 0
+        if number_of_twine_placeholders(value) > 0 or @options[:escape_all_tags]
           # matches all `<` but <![CDATA
           angle_bracket = /<(?!(\/?(\!\[CDATA)))/
         else

data/lib/twine/formatters/django.rb

@@ -1,5 +1,6 @@
 module Twine
   module Formatters
+    # For a description of the .po file format, see https://www.gnu.org/software/gettext/manual/html_node/PO-Files.html
     class Django < Abstract
       def format_name
         'django'
@@ -14,9 +15,9 @@ module Twine
       end
 
       def read(io, lang)
-        comment_regex = /#\. *"?(.*)"?$/
-        key_regex = /msgid *"(.*)"$/
-        value_regex = /msgstr *"(.*)"$/m
+        comment_regex = /^\s*#\. *"?(.*)"?$/
+        key_regex = /^msgid *"(.*)"$/
+        value_regex = /^msgstr *"(.*)"$/m
 
         while line = io.gets          
           comment_match = comment_regex.match(line)
@@ -53,11 +54,12 @@ module Twine
       end
 
       def format_header(lang)
-        "##\n # Django Strings File\n # Generated by Twine #{Twine::VERSION}\n # Language: #{lang}\nmsgid \"\"\nmsgstr \"\"\n\"Content-Type: text/plain; charset=UTF-8\\n\""
+        # see https://www.gnu.org/software/trans-coord/manual/gnun/html_node/PO-Header.html for details
+        "# Django Strings File\n# Generated by Twine #{Twine::VERSION}\n# Language: #{lang}\nmsgid \"\"\nmsgstr \"\"\n\"Content-Type: text/plain; charset=UTF-8\\n\""
       end
 
       def format_section_header(section)
-        "#--------- #{section.name} ---------#\n"
+        "# --------- #{section.name} --------- #\n"
       end
 
       def format_definition(definition, lang)

data/lib/twine/placeholders.rb

@@ -72,5 +72,11 @@ module Twine
     def convert_placeholders_from_flash_to_twine(input)
       input.gsub /\{\d+\}/, '%@'
     end
+
+    # Python supports placeholders in the form of `%(amount)03d`
+    # see https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting
+    def contains_python_specific_placeholder(input)
+      /%\([a-zA-Z0-9_-]+\)#{PLACEHOLDER_PARAMETER_FLAGS_WIDTH_PRECISION_LENGTH}#{PLACEHOLDER_TYPES}/.match(input) != nil
+    end
   end
 end

data/lib/twine/runner.rb

@@ -241,6 +241,7 @@ module Twine
       duplicate_keys = Set.new
       keys_without_tags = Set.new
       invalid_keys = Set.new
+      keys_with_python_only_placeholders = Set.new
       valid_key_regex = /^[A-Za-z0-9_]+$/
 
       @twine_file.sections.each do |section|
@@ -253,6 +254,8 @@ module Twine
           keys_without_tags.add(definition.key) if definition.tags == nil or definition.tags.length == 0
 
           invalid_keys << definition.key unless definition.key =~ valid_key_regex
+
+          keys_with_python_only_placeholders << definition.key if definition.translations.values.any? { |v| Placeholders.contains_python_specific_placeholder(v) }
         end
       end
 
@@ -275,6 +278,10 @@ module Twine
         errors << "Found key(s) with invalid characters:\n#{join_keys.call(invalid_keys)}"
       end
 
+      unless keys_with_python_only_placeholders.empty?
+        errors << "Found key(s) with placeholders that are only supported by Python:\n#{join_keys.call(keys_with_python_only_placeholders)}"
+      end
+
       raise Twine::Error.new errors.join("\n\n") unless errors.empty?
 
       Twine::stdout.puts "#{@options[:twine_file]} is valid."

data/lib/twine/version.rb

@@ -1,3 +1,3 @@
 module Twine
-  VERSION = '1.0.6'
+  VERSION = '1.1'
 end

data/test/fixtures/formatter_django.po

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

data/test/test_cli.rb

@@ -48,6 +48,13 @@ class CLITest < TwineTest
     assert_equal 'UTF16', @options[:encoding]
   end
 
+  def assert_option_escape_all_tags
+    parse_with "--escape-all-tags"
+    assert @options[:escape_all_tags]
+    parse_with "--no-escape-all-tags"
+    refute @options[:escape_all_tags]
+  end
+
   def assert_option_format
     random_format = Twine::Formatters.formatters.sample.format_name.downcase
     parse_with "--format #{random_format}"
@@ -177,6 +184,7 @@ class TestGenerateLocalizationFileCLI < CLITest
     assert_help
     assert_option_developer_language
     assert_option_encoding
+    assert_option_escape_all_tags
     assert_option_format
     assert_option_include
     assert_option_single_language
@@ -217,6 +225,7 @@ class TestGenerateAllLocalizationFilesCLI < CLITest
     assert_help
     assert_option_developer_language
     assert_option_encoding
+    assert_option_escape_all_tags
     assert_option_format
     assert_option_include
     assert_option_quiet
@@ -268,6 +277,7 @@ class TestGenerateLocalizationArchiveCLI < CLITest
     assert_help
     assert_option_developer_language
     assert_option_encoding
+    assert_option_escape_all_tags
     assert_option_include
     assert_option_quiet
     assert_option_tags

data/test/test_formatters.rb

@@ -138,6 +138,11 @@ class TestAndroidFormatter < FormatterTest
       '<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>'
     }
+    @escape_all_test_values = {
+      '<b>bold</b>'               => '&lt;b>bold&lt;/b>',
+      '<i>italic</i>'             => '&lt;i>italic&lt;/i>',
+      '<u>underline</u>'          => '&lt;u>underline&lt;/u>'      
+    }
   end
 
   def test_read_format
@@ -217,6 +222,11 @@ class TestAndroidFormatter < FormatterTest
       @formatter.set_translation_for_key 'key1', 'en', input
       assert_equal expected, @empty_twine_file.definitions_by_key['key1'].translations['en']
     end
+
+    @escape_all_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
@@ -245,6 +255,11 @@ class TestAndroidFormatter < FormatterTest
     @escape_test_values.each do |input, expected|
       assert_equal expected, @formatter.format_value(input)
     end
+
+    @formatter.options.merge!({ escape_all_tags: true })
+    @escape_all_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
@@ -539,6 +554,19 @@ class TestDjangoFormatter < FormatterTest
     language = %w(en-GB de fr).sample
     assert_equal language, @formatter.determine_language_given_path("/output/#{language}/#{@formatter.default_file_name}")
   end
+
+  def test_ignores_commented_out_strings
+    content = <<-EOCONTENT
+      #~ msgid "foo"
+      #~ msgstr "This should be ignored"
+    EOCONTENT
+
+    io = StringIO.new(content)
+
+    @formatter.read io, 'en'
+
+    assert_nil @empty_twine_file.definitions_by_key["foo"]
+  end
 end
 
 class TestFlashFormatter < FormatterTest

data/test/test_placeholders.rb

@@ -122,4 +122,21 @@ class PlaceholderTest < TwineTest
       assert_equal "some %@ more %@ text %@", from_flash("some {0} more {1} text {2}")
     end
   end
+
+  class PythonPlaceholder < PlaceholderTest
+    def test_negative_for_regular_placeholders
+      assert_equal false, Twine::Placeholders.contains_python_specific_placeholder(placeholder)
+    end
+
+    def test_positive_for_named_placeholders
+      inputs = [
+        "%(language)s has",
+        "For %(number)03d quotes",
+        "bought on %(app_name)s"
+      ]
+      inputs.each do |input|
+        assert_equal true, Twine::Placeholders.contains_python_specific_placeholder(input)
+      end
+    end
+  end
 end

data/test/test_validate_twine_file.rb

@@ -58,4 +58,12 @@ class TestValidateTwineFile < CommandTest
       Twine::Runner.new(@options.merge(pedantic: true), @twine_file).validate_twine_file
     end
   end
+
+  def test_reports_python_specific_placeholders
+    random_definition.translations["en"] = "%(python_only)s"
+
+    assert_raises Twine::Error do
+      Twine::Runner.new(@options, @twine_file).validate_twine_file
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twine
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: '1.1'
 platform: ruby
 authors:
 - Sebastian Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-28 00:00:00.000000000 Z
+date: 2020-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: safe_yaml
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -158,7 +158,7 @@ files:
 - test/test_validate_twine_file.rb
 - test/twine_file_dsl.rb
 - test/twine_test.rb
-homepage: https://github.com/mobiata/twine
+homepage: https://github.com/scelis/twine
 licenses:
 - BSD-3-Clause
 metadata: {}
@@ -170,15 +170,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Manage strings and their translations for your iOS, Android and other projects.