twine 0.3.2 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c61dcacafc740f0edf24674f331c77c83b1d94b
+  data.tar.gz: e45d63d180e8d396194d1f86d408acefb6813886
+SHA512:
+  metadata.gz: 05f6f055d5eb781de1173a0556921e286381a0effbe328a8be5d586405fc10b0a25fc2e1c235f58a9ddbd96264f3fd3a1f27bc965386302e9522c1806184b961
+  data.tar.gz: ef330b79c5c17f265823e2646b04f30e7a415cf39569148968f5708cee40c7b2108dc9de64f5facfced1d8ec35d6e7a1ed129d3677234ab38f5a6b10126cfb4f

data/README.md

@@ -1,6 +1,6 @@
 # Twine
 
-Twine is a command line tool for managing your strings and their translations. These strings are all stored in a master text file and then Twine uses this file to import and export strings in a variety of file types, including iOS and Mac OS X `.strings` files, Android `.xml` files, and [jquery-localize][jquerylocalize] `.json` files. This allows individuals and companies to easily share strings across multiple projects, as well as export strings in any format the user wants.
+Twine is a command line tool for managing your strings and their translations. These strings are all stored in a master text file and then Twine uses this file to import and export strings in a variety of file types, including iOS and Mac OS X `.strings` files, Android `.xml` files, gettext `.po` files, and [jquery-localize][jquerylocalize] `.json` files. This allows individuals and companies to easily share strings across multiple projects, as well as export strings in any format the user wants.
 
 ## Install
 
@@ -74,6 +74,7 @@ Twine currently supports the following formats for outputting strings:
 
 * [iOS and OS X String Resources][applestrings] (format: apple)
 * [Android String Resources][androidstrings] (format: android)
+* [Gettext PO Files][gettextpo] (format: gettext)
 * [jquery-localize Language Files][jquerylocalize] (format: jquery)
 
 If you would like to enable twine to create language files in another format, create an appropriate formatter in `lib/twine/formatters`.
@@ -156,9 +157,21 @@ It is easy to incorporate Twine right into your iOS and OS X app build processes
 
 Now, whenever you build your application, Xcode will automatically invoke Twine to make sure that your `.strings` files are up-to-date.
 
+## Contributors
+
+Many thanks to all of the contributors to the Twine project, including:
+
+* [Ishitoya Kentaro](https://github.com/kent013)
+* [Kevin Everets](https://github.com/keverets)
+* [Kevin Wood](https://github.com/kwood)
+* [Mohammad Hejazi](https://github.com/MohammadHejazi)
+* [Robert Guo](http://www.robertguo.me/)
+
+
 [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
 [androidstrings]: http://developer.android.com/guide/topics/resources/string-resource.html
+[gettextpo]: http://www.gnu.org/savannah-checkouts/gnu/gettext/manual/html_node/PO-Files.html
 [jquerylocalize]: https://github.com/coderifous/jquery-localize

data/lib/twine/cli.rb

@@ -15,7 +15,7 @@ module Twine
       parser = OptionParser.new do |opts|
         opts.banner = 'Usage: twine COMMAND STRINGS_FILE [INPUT_OR_OUTPUT_PATH] [--lang LANG1,LANG2...] [--tags TAG1,TAG2,TAG3...] [--format FORMAT]'
         opts.separator ''
-        opts.separator 'The purpose of this script is to convert back and forth between multiple data formats, allowing us to treat our strings (and translations) as data stored in a text file. We can then use the data file to create drops for the localization team, consume similar drops returned by the localization team, generate reports on the strings, as well as create formatted string files to ship with your products. Twine currently supports iOS, OS X, Android, and jquery-localize string files.'
+        opts.separator 'The purpose of this script is to convert back and forth between multiple data formats, allowing us to treat our strings (and translations) as data stored in a text file. We can then use the data file to create drops for the localization team, consume similar drops returned by the localization team, generate reports on the strings, as well as create formatted string files to ship with your products. Twine currently supports iOS, OS X, Android, gettext, and jquery-localize string files.'
         opts.separator ''
         opts.separator 'Commands:'
         opts.separator ''
@@ -64,6 +64,9 @@ module Twine
         opts.on('-o', '--output-file OUTPUT_FILE', 'Write the new strings database to this file instead of replacing the original file. This flag is only useful when running the consume-string-file or consume-loc-drop commands.') do |o|
           @options[:output_path] = o
         end
+        opts.on('-n', '--file-name FILE_NAME', 'When running the generate-all-string-files command, this flag may be used to overwrite the default file name of the format.') do |n|
+          @options[:file_name] = n
+        end
         opts.on('-d', '--developer-language LANG', 'When writing the strings data file, set the specified language as the "developer language". In practice, this just means that this language will appear first in the strings data file.') do |d|
           @options[:developer_language] = d
         end

data/lib/twine/formatters.rb

@@ -1,10 +1,12 @@
 require 'twine/formatters/abstract'
 require 'twine/formatters/android'
 require 'twine/formatters/apple'
+require 'twine/formatters/flash'
+require 'twine/formatters/gettext'
 require 'twine/formatters/jquery'
 
 module Twine
   module Formatters
-    FORMATTERS = [Formatters::Apple, Formatters::Android, Formatters::JQuery]
+    FORMATTERS = [Formatters::Apple, Formatters::Android, Formatters::Gettext, Formatters::JQuery, Formatters::Flash]
   end
 end

data/lib/twine/formatters/abstract.rb

@@ -57,6 +57,9 @@ module Twine
         # 1) use "s" instead of "@" for substituting strings
         str.gsub!(/%([0-9\$]*)@/, '%\1s')
 
+        # 1a) escape strings that begin with a lone "@"
+        str.sub!(/^@ /, '\\@ ')
+
         # 2) if there is more than one substitution in a string, make sure they are numbered
         substituteCount = 0
         startFound = false
@@ -148,10 +151,11 @@ module Twine
           raise Twine::Error.new("Directory does not exist: #{path}")
         end
 
+        file_name = @options[:file_name] || default_file_name
         Dir.foreach(path) do |item|
           lang = determine_language_given_path(item)
           if lang
-            write_file(File.join(path, item, default_file_name), lang)
+            write_file(File.join(path, item, file_name), lang)
           end
         end
       end

data/lib/twine/formatters/android.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-require 'CGI'
+require 'cgi'
 require 'rexml/document'
 
 module Twine
@@ -74,9 +74,6 @@ module Twine
                 else
                   value = ""
                 end
-                if @options[:tags]
-                  set_tags_for_key(key, @options[:tags])
-                end
                 set_translation_for_key(key, lang, value)
                 if comment and comment.length > 0 and !comment.start_with?("SECTION:")
                   set_comment_for_key(key, comment)

data/lib/twine/formatters/flash.rb

@@ -0,0 +1,110 @@
+module Twine
+  module Formatters
+    class Flash < Abstract
+      FORMAT_NAME = 'flash'
+      EXTENSION = '.properties'
+      DEFAULT_FILE_NAME = 'resources.properties'
+
+      def self.can_handle_directory?(path)
+        return false
+      end
+
+      def default_file_name
+        return DEFAULT_FILE_NAME
+      end
+
+      def determine_language_given_path(path)
+        return
+      end
+
+      def read_file(path, lang)
+        encoding = Twine::Encoding.encoding_for_path(path)
+        sep = nil
+        if !encoding.respond_to?(:encode)
+          # This code is not necessary in 1.9.3 and does not work as it did in 1.8.7.
+          if encoding.end_with? 'LE'
+            sep = "\x0a\x00"
+          elsif encoding.end_with? 'BE'
+            sep = "\x00\x0a"
+          else
+            sep = "\n"
+          end
+        end
+
+        if encoding.index('UTF-16')
+          mode = "rb:#{encoding}"
+        else
+          mode = "r:#{encoding}"
+        end
+
+        File.open(path, mode) do |f|
+          last_comment = nil
+          while line = (sep) ? f.gets(sep) : f.gets
+            if encoding.index('UTF-16')
+              if line.respond_to? :encode!
+                line.encode!('UTF-8')
+              else
+                require 'iconv'
+                line = Iconv.iconv('UTF-8', encoding, line).join
+              end
+            end
+            match = /((?:[^"\\]|\\.)+)\s*=\s*((?:[^"\\]|\\.)*)/.match(line)
+            if match
+              key = match[1]
+              value = match[2]
+              value.gsub!(/\{[0-9]\}/, '%@')
+              set_translation_for_key(key, lang, value)
+              if last_comment
+                set_comment_for_key(key, last_comment)
+              end
+            end
+            if @options[:consume_comments]
+              match = /#(.*)/.match(line)
+              if match
+                last_comment = match[1]
+              else
+                last_comment = nil
+              end
+            end
+          end
+        end
+      end
+
+      def write_file(path, lang)
+        default_lang = @strings.language_codes[0]
+        encoding = @options[:output_encoding] || 'UTF-8'
+        File.open(path, "w:#{encoding}") do |f|
+          f.puts "## Flash Strings File\n## Generated by Twine #{Twine::VERSION}\n## Language: #{lang}\n"
+          @strings.sections.each do |section|
+            printed_section = false
+            section.rows.each do |row|
+              if row.matches_tags?(@options[:tags], @options[:untagged])
+                f.puts ''
+                if !printed_section
+                  if section.name && section.name.length > 0
+                    f.print "## #{section.name} ##\n\n"
+                  end
+                  printed_section = true
+                end
+
+                key = row.key
+                value = row.translated_string_for_lang(lang, default_lang)
+                if value
+                  placeHolderNumber = -1
+                  value = value.gsub(/%[d@]/) { placeHolderNumber += 1; '{%d}' % placeHolderNumber }
+                  
+                  comment = row.comment
+                  if comment && comment.length > 0
+                    f.print "# #{comment}\n"
+                  end
+
+                  f.print "#{key}=#{value}"
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twine/formatters/gettext.rb

@@ -0,0 +1,100 @@
+module Twine
+  module Formatters
+    class Gettext < Abstract
+      FORMAT_NAME = 'gettext'
+      EXTENSION = '.po'
+      DEFAULT_FILE_NAME = 'strings.po'
+
+      def self.can_handle_directory?(path)
+        Dir.entries(path).any? { |item| /^.+\.po$/.match(item) }
+      end
+
+      def default_file_name
+        return DEFAULT_FILE_NAME
+      end
+
+      def determine_language_given_path(path)
+        path_arr = path.split(File::SEPARATOR)
+        path_arr.each do |segment|
+          match = /(..)\.po$/.match(segment)
+          if match
+            return match[1]
+          end
+        end
+
+        return
+      end
+
+      def read_file(path, lang)
+        comment_regex = /#.? *"(.*)"$/
+        key_regex = /msgctxt *"(.*)"$/
+        value_regex = /msgstr *"(.*)"$/m
+        File.open(path, 'r:UTF-8') do |f|
+          while item = f.gets("\n\n")
+            key = nil
+            value = nil
+            comment = nil
+
+            for line in item.split(/\r?\n/)
+              comment_match = comment_regex.match(line)
+              if comment_match
+                comment = comment_match[1]
+              end
+              key_match = key_regex.match(line)
+              if key_match
+                key = key_match[1].gsub('\\"', '"')
+              end
+              value_match = value_regex.match(line)
+              if value_match
+                value = value_match[1].gsub('\\"', '"')
+              end
+            end
+            if key and key.length > 0 and value and value.length > 0
+              set_translation_for_key(key, lang, value)
+              if comment and comment.length > 0
+                set_comment_for_key(key, comment)
+              end
+            end
+          end
+        end
+      end
+
+      def write_file(path, lang)
+        default_lang = @strings.language_codes[0]
+        encoding = @options[:output_encoding] || 'UTF-8'
+        File.open(path, "w:#{encoding}") do |f|
+          f.puts "msgid \"\"\nmsgstr \"\"\n\"Language: #{lang}\\n\"\n\"X-Generator: Twine #{Twine::VERSION}\\n\"\n\n"
+          @strings.sections.each do |section|
+            printed_section = false
+            section.rows.each do |row|
+              if row.matches_tags?(@options[:tags], @options[:untagged])
+                basetrans = row.translated_string_for_lang(default_lang)
+
+                if basetrans
+                  key = row.key
+                  key = key.gsub('"', '\\\\"')
+
+                  comment = row.comment
+                  if comment
+                    comment = comment.gsub('"', '\\\\"')
+                  end
+
+                  if comment && comment.length > 0
+                    f.print "#. \"#{comment}\"\n"
+                  end
+
+                  f.print "msgctxt \"#{key}\"\nmsgid \"#{basetrans}\"\n"
+                  value = row.translated_string_for_lang(lang)
+                  if value
+                    value = value.gsub('"', '\\\\"')
+                  end
+                  f.print "msgstr \"#{value}\"\n\n"
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twine/version.rb

@@ -1,3 +1,3 @@
 module Twine
-  VERSION = '0.3.2'
+  VERSION = '0.4.0'
 end

data/test/fixtures/en-1.po

@@ -0,0 +1,16 @@
+msgid ""
+msgstr ""
+"Language: en\n"
+"X-Generator: Twine\n"
+
+msgctxt "key1"
+msgid "key1-english"
+msgstr "key1-english"
+
+msgctxt "key3"
+msgid "key3-english"
+msgstr ""
+
+msgctxt "key5"
+msgid "A new string"
+msgstr "A new string"

data/test/fixtures/strings-3.txt

@@ -0,0 +1,5 @@
+[[My Strings]]
+    [parameterized_string]
+        en = The %@ brown fox jumps over the %@ dog %d times.
+    [percentage_string]
+        en = This product is %d%% off.

data/test/fixtures/test-output-7.txt

@@ -0,0 +1,14 @@
+msgid ""
+msgstr ""
+"Language: en\n"
+"X-Generator: Twine <%= Twine::VERSION %>\n"
+
+#. "This is a comment"
+msgctxt "key1"
+msgid "key1-english"
+msgstr "key1-english"
+
+msgctxt "key3"
+msgid "key3-english"
+msgstr "key3-english"
+

data/test/fixtures/test-output-8.txt

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Android Strings File -->
+<!-- Generated by Twine <%= Twine::VERSION %> -->
+<!-- Language: en -->
+<resources>
+	<!-- SECTION: My Strings -->
+	<string name="parameterized_string">The %1$s brown fox jumps over the %2$s dog %3$d times.</string>
+	<string name="percentage_string">This product is %d%% off.</string>
+</resources>

data/test/twine_test.rb

@@ -1,4 +1,4 @@
-require 'ERB'
+require 'erb'
 require 'rubygems'
 require 'test/unit'
 require 'twine'
@@ -36,6 +36,22 @@ class TwineTest < Test::Unit::TestCase
     end
   end
 
+  def test_generate_string_file_5
+    Dir.mktmpdir do |dir|
+      output_path = File.join(dir, 'en.po')
+      Twine::Runner.run(%W(generate-string-file test/fixtures/strings-1.txt #{output_path} -t tag1))
+      assert_equal(ERB.new(File.read('test/fixtures/test-output-7.txt')).result, File.read(output_path))
+    end
+  end
+
+  def test_generate_string_file_6
+    Dir.mktmpdir do |dir|
+      output_path = File.join(dir, 'en.xml')
+      Twine::Runner.run(%W(generate-string-file test/fixtures/strings-3.txt #{output_path}))
+      assert_equal(ERB.new(File.read('test/fixtures/test-output-8.txt')).result, File.read(output_path))
+    end
+  end
+
   def test_consume_string_file_1
     Dir.mktmpdir do |dir|
       output_path = File.join(dir, 'strings.txt')
@@ -60,6 +76,14 @@ class TwineTest < Test::Unit::TestCase
     end
   end
 
+  def test_consume_string_file_4
+    Dir.mktmpdir do |dir|
+      output_path = File.join(dir, 'strings.txt')
+      Twine::Runner.run(%W(consume-string-file test/fixtures/strings-1.txt test/fixtures/en-1.po -o #{output_path} -l en -a))
+      assert_equal(File.read('test/fixtures/test-output-4.txt'), File.read(output_path))
+    end
+  end
+
   def test_generate_report_1
     Twine::Runner.run(%w(generate-report test/fixtures/strings-1.txt))
   end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: twine
 version: !ruby/object:Gem::Version
-  version: 0.3.2
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Sebastian Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-13 00:00:00.000000000 Z
+date: 2013-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,13 +34,14 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.2
-description: ! "  Twine is a command line tool for managing your strings and their
-  translations.\n\n  It is geared toward Mac OS X, iOS, and Android developers.\n"
+description: |2
+    Twine is a command line tool for managing your strings and their translations.
+
+    It is geared toward Mac OS X, iOS, and Android developers.
 email: twine@mobiata.com
 executables:
 - twine
@@ -59,6 +56,8 @@ files:
 - lib/twine/formatters/abstract.rb
 - lib/twine/formatters/android.rb
 - lib/twine/formatters/apple.rb
+- lib/twine/formatters/flash.rb
+- lib/twine/formatters/gettext.rb
 - lib/twine/formatters/jquery.rb
 - lib/twine/formatters.rb
 - lib/twine/runner.rb
@@ -67,40 +66,43 @@ files:
 - lib/twine.rb
 - bin/twine
 - test/fixtures/en-1.json
+- test/fixtures/en-1.po
 - test/fixtures/en-1.strings
 - test/fixtures/fr-1.xml
 - test/fixtures/strings-1.txt
 - test/fixtures/strings-2.txt
+- test/fixtures/strings-3.txt
 - test/fixtures/test-output-1.txt
 - test/fixtures/test-output-2.txt
 - test/fixtures/test-output-3.txt
 - test/fixtures/test-output-4.txt
 - test/fixtures/test-output-5.txt
 - test/fixtures/test-output-6.txt
+- test/fixtures/test-output-7.txt
+- test/fixtures/test-output-8.txt
 - test/twine_test.rb
 homepage: https://github.com/mobiata/twine
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Manage strings and their translations for your iOS and Android projects.
 test_files:
 - test/twine_test.rb