twine 0.2.2 → 0.3.0

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 as well as Android `.xml` 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, 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
 
@@ -68,6 +68,16 @@ Whitepace in this file is mostly ignored. If you absolutely need to put spaces a
 			tags = myothertag
 			comment = This string will evaluate to `%@`.
 
+## Supported Output Formats
+
+Twine currently supports the following formats for outputting strings:
+
+* [iOS and OS X String Resources][applestrings] (format: apple)
+* [Android String Resources][androidstrings] (format: android)
+* [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`.
+
 ## Usage
 
 	Usage: twine COMMAND STRINGS_FILE [INPUT_OR_OUTPUT_PATH] [--lang LANG1,LANG2...] [--tags TAG1,TAG2,TAG3...] [--format FORMAT]
@@ -149,3 +159,6 @@ Now, whenever you build your application, Xcode will automatically invoke Twine
 [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
+[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 iOS and Android string files to ship with our products.'
+        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 ''
         opts.separator 'Commands:'
         opts.separator ''

data/lib/twine/formatters.rb

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

data/lib/twine/formatters/apple.rb

@@ -100,19 +100,21 @@ module Twine
                 key = key.gsub('"', '\\\\"')
 
                 value = row.translated_string_for_lang(lang, default_lang)
-                value = value.gsub('"', '\\\\"')
+                if value
+                  value = value.gsub('"', '\\\\"')
 
-                comment = row.comment
-                if comment
-                  comment = comment.gsub('*/', '* /')
-                end
+                  comment = row.comment
+                  if comment
+                    comment = comment.gsub('*/', '* /')
+                  end
 
-                if comment && comment.length > 0
-                  f.print "/* #{comment} */\n"
-                end
+                  if comment && comment.length > 0
+                    f.print "/* #{comment} */\n"
+                  end
 
-                f.print "\"#{key}\" = \"#{value}\";\n"
-             end
+                  f.print "\"#{key}\" = \"#{value}\";\n"
+                end
+              end
             end
           end
         end

data/lib/twine/formatters/jquery.rb

@@ -0,0 +1,96 @@
+module Twine
+  module Formatters
+    class JQuery < Abstract
+      FORMAT_NAME = 'jquery'
+      EXTENSION = '.json'
+      DEFAULT_FILE_NAME = 'localize.json'
+
+      def self.can_handle_directory?(path)
+        Dir.entries(path).any? { |item| /^.+\.json$/.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 = /^((.+)-)?([^-]+)\.json$/.match(segment)
+          if match
+            return match[3]
+          end
+        end
+
+        return
+      end
+
+      def read_file(path, lang)
+        begin
+          require "json"
+        rescue LoadError
+          raise Twine::Error.new "You must run 'gem install json' in order to read or write jquery-localize files."
+        end
+
+        open(path) do |io|
+          json = JSON.load(io)
+          json.each do |key, value|
+            set_translation_for_key(key, lang, value)
+          end
+        end
+      end
+
+      def write_file(path, lang)
+        begin
+          require "json"
+        rescue LoadError
+          raise Twine::Error.new "You must run 'gem install json' in order to read or write jquery-localize files."
+        end
+
+        default_lang = @strings.language_codes[0]
+        encoding = @options[:output_encoding] || 'UTF-8'
+        File.open(path, "w:#{encoding}") do |f|
+          f.puts "/**\n * JQuery Language File\n * Generated by Twine\n * Language: #{lang}\n */"
+          f.puts "{"
+
+          @strings.sections.each_with_index do |section, si|
+            printed_section = false
+            section.rows.each_with_index do |row, ri|
+              if row.matches_tags?(@options[:tags], @options[:untagged])
+                if !printed_section
+                  f.puts ''
+                  if section.name && section.name.length > 0
+                    f.puts "/* #{section.name} */"
+                  end
+                  printed_section = true
+                end
+
+                key = row.key
+                key = key.gsub('"', '\\\\"')
+
+                value = row.translated_string_for_lang(lang, default_lang)
+                value = value.gsub('"', '\\\\"')
+
+                comment = row.comment
+                if comment
+                  comment = comment.gsub('*/', '* /')
+                end
+
+                f.print "\"#{key}\":\"#{value}\","
+
+                if comment && comment.length > 0
+                  f.print "  /* #{comment} */\n"
+                else
+                  f.print "\n"
+                end
+              end
+            end
+          end
+          f.seek(-2, IO::SEEK_CUR)
+          f.puts "\n}"
+
+        end
+      end
+    end
+  end
+end

data/lib/twine/runner.rb

@@ -148,7 +148,7 @@ module Twine
       begin
         require 'zip/zip'
       rescue LoadError
-        raise Twine::Error.new "You must 'gem install rubyzip' in order to create or consume localization drops."
+        raise Twine::Error.new "You must run 'gem install rubyzip' in order to create or consume localization drops."
       end
 
       if File.file?(@options[:output_path])
@@ -181,7 +181,7 @@ module Twine
       begin
         require 'zip/zip'
       rescue LoadError
-        raise Twine::Error.new "You must 'gem install rubyzip' in order to create or consume localization drops."
+        raise Twine::Error.new "You must run 'gem install rubyzip' in order to create or consume localization drops."
       end
 
       Dir.mktmpdir do |dir|

data/lib/twine/version.rb

@@ -1,3 +1,3 @@
 module Twine
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/test/fixtures/en-1.json

@@ -0,0 +1,12 @@
+/**
+ * JQuery Language File
+ * Generated by Twine
+ * Language: en
+ */
+{
+
+/* My Strings */
+"key1":"key1-english",
+"key3":"key3-english",
+"key5":"A new string"
+}

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

@@ -0,0 +1,11 @@
+/**
+ * JQuery Language File
+ * Generated by Twine
+ * Language: en
+ */
+{
+
+/* My Strings */
+"key1":"key1-english",
+"key3":"key3-english"
+}

data/test/twine_test.rb

@@ -1,4 +1,5 @@
 require 'ERB'
+require 'rubygems'
 require 'test/unit'
 require 'twine'
 
@@ -19,6 +20,14 @@ class TwineTest < Test::Unit::TestCase
     end
   end
 
+  def test_generate_string_file_3
+    Dir.mktmpdir do |dir|
+      output_path = File.join(dir, 'en.json')
+      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-5.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')
@@ -35,6 +44,14 @@ class TwineTest < Test::Unit::TestCase
     end
   end
 
+  def test_consume_string_file_3
+    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.json -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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twine
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-16 00:00:00.000000000 Z
+date: 2012-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -44,7 +44,7 @@ dependencies:
       - !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"
+  translations.\n\n  It is geared toward Mac OS X, iOS, and Android developers.\n"
 email: twine@mobiata.com
 executables:
 - twine
@@ -59,12 +59,14 @@ files:
 - lib/twine/formatters/abstract.rb
 - lib/twine/formatters/android.rb
 - lib/twine/formatters/apple.rb
+- lib/twine/formatters/jquery.rb
 - lib/twine/formatters.rb
 - lib/twine/runner.rb
 - lib/twine/stringsfile.rb
 - lib/twine/version.rb
 - lib/twine.rb
 - bin/twine
+- test/fixtures/en-1.json
 - test/fixtures/en-1.strings
 - test/fixtures/fr-1.xml
 - test/fixtures/strings-1.txt
@@ -72,6 +74,7 @@ files:
 - 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/twine_test.rb
 homepage: https://github.com/mobiata/twine
 licenses: []
@@ -93,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.18
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Manage strings and their translations for your iOS and Android projects.