twine 0.2.0 → 0.2.1

data/README.md

@@ -29,7 +29,7 @@ Each grouping section contains N string definitions. These string definitions st
 
 ### Tags
 
-Tags are used by Twine as a way to only work with a subset of your strings at any given point in time. Each string can be assigned zero or more tags which are separated by commas. When a string has no tags, that string will never be selected by Twine. You can get a list of all strings currently missing tags by executing the `generate-report` command.
+Tags are used by Twine as a way to only work with a subset of your strings at any given point in time. Each string can be assigned zero or more tags which are separated by commas. Tags are optional, though highly recommended. You can get a list of all strings currently missing tags by executing the `generate-report` command.
 
 ### Whitespace
 

data/lib/twine/cli.rb

@@ -25,7 +25,7 @@ module Twine
         opts.separator ''
         opts.separator 'consume-string-file -- Slurps all of the strings from a translated strings file into the specified STRINGS_FILE. If you have some files returned to you by your translators you can use this command to incorporate all of their changes. This script will attempt to guess both the language and the format given the filename and extension. For example, "ja.strings" will assume that the file is a Japanese iOS strings file.'
         opts.separator ''
-        opts.separator 'generate-loc-drop -- Generates a zip archive of strings files in any format. The purpose of this command is to create a very simple archive that can be handed off to a translation team. The translation team can unzip the archive, translate all of the strings in the archived files, zip everything back up, and then hand that final archive back to be consumed by the consume-loc-drop command. This command assumes that --all has been specified on the command line.'
+        opts.separator 'generate-loc-drop -- Generates a zip archive of strings files in any format. The purpose of this command is to create a very simple archive that can be handed off to a translation team. The translation team can unzip the archive, translate all of the strings in the archived files, zip everything back up, and then hand that final archive back to be consumed by the consume-loc-drop command. This command assumes that --include-untranslated has been specified on the command line.'
         opts.separator ''
         opts.separator 'consume-loc-drop -- Consumes an archive of translated files. This archive should be in the same format as the one created by the generate-loc-drop command.'
         opts.separator ''
@@ -36,25 +36,31 @@ module Twine
         opts.on('-l', '--lang LANGUAGES', Array, 'The language code(s) to use for the specified action.') do |langs|
           @options[:languages] = langs
         end
-        opts.on('-t', '--tags TAGS', Array, 'The tag(s) to use for the specified action. Only strings with that tag will be processed.') do |tags|
+        opts.on('-t', '--tags TAGS', Array, 'The tag(s) to use for the specified action. Only strings with that tag will be processed. Do not specify any tags to match all strings in the strings data file.') do |tags|
           @options[:tags] = tags
         end
-        opts.on('-f', '--format FORMAT', 'The file format to read or write (iOS, Android). Additional formatters can be placed in the formats/ directory.') do |format|
+        opts.on('-u', '--untagged', 'If you have specified tags using the --tags flag, then only those tags will be selected. If you also want to select all strings that are untagged, then you can specify this option to do so.') do |u|
+          @options[:untagged] = true
+        end
+        formats = []
+        Formatters::FORMATTERS.each do |formatter|
+          formats << formatter::FORMAT_NAME
+        end
+        opts.on('-f', '--format FORMAT', "The file format to read or write (#{formats.join(', ')}). Additional formatters can be placed in the formats/ directory.") do |format|
           lformat = format.downcase
-          found_format = false
-          Formatters::FORMATTERS.each do |formatter|
-            if formatter::FORMAT_NAME == lformat
-              found_format = true
-              break
-            end
-          end
-          if !found_format
+          if !formats.include?(lformat)
             STDERR.puts "Invalid format: #{format}"
           end
           @options[:format] = lformat
         end
-        opts.on('-a', '--all', 'Normally, when consuming a string file, Twine will ignore any string keys that do not exist in your master file. This flag will also cause any Android string files that are generated to include strings that have not yet been translated for the current language.') do |a|
-          @options[:consume_generate_all] = true
+        opts.on('-a', '--consume-all', 'Normally, when consuming a string file, Twine will ignore any string keys that do not exist in your master file.') do |a|
+          @options[:consume_all] = true
+        end
+        opts.on('-s', '--include-untranslated', 'This flag will cause any Android string files that are generated to include strings that have not yet been translated for the current language.') do |s|
+          @options[:include_untranslated] = true
+        end
+        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('-e', '--encoding ENCODING', 'Twine defaults to encoding all output files in UTF-8. This flag will tell Twine to use an alternate encoding for these files. For example, you could use this to write Apple .strings files in UTF-16. This flag currently only works with Apple .strings files and is currently only supported in Ruby 1.9.3 or greater.') do |e|
           if !"".respond_to?(:encode)
@@ -62,9 +68,6 @@ module Twine
           end
           @options[:output_encoding] = e
         end
-        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('-h', '--help', 'Show this message.') do |h|
           puts opts.help
           exit
@@ -134,7 +137,7 @@ module Twine
           raise Twine::Error.new 'Please only specify a single language for the consume-string-file command.'
         end
       when 'generate-loc-drop'
-        @options[:consume_generate_all] = true
+        @options[:include_untranslated] = true
         if @args.length == 3
           @options[:output_path] = @args[2]
         elsif @args.length > 3

data/lib/twine/formatters/abstract.rb

@@ -16,7 +16,7 @@ module Twine
       def set_translation_for_key(key, lang, value)
         if @strings.strings_map.include?(key)
           @strings.strings_map[key].translations[lang] = value
-        elsif @options[:consume_generate_all]
+        elsif @options[:consume_all]
           STDERR.puts "Adding new string '#{key}' to strings data file."
           arr = @strings.sections.select { |s| s.name == 'Uncategorized' }
           current_section = arr ? arr[0] : nil

data/lib/twine/formatters/android.rb

@@ -77,7 +77,7 @@ module Twine
           @strings.sections.each do |section|
             printed_section = false
             section.rows.each do |row|
-              if row.matches_tags?(@options[:tags])
+              if row.matches_tags?(@options[:tags], @options[:untagged])
                 if !printed_section
                   f.puts ''
                   if section.name && section.name.length > 0
@@ -90,7 +90,7 @@ module Twine
                 key = row.key
 
                 value = row.translated_string_for_lang(lang, default_lang)
-                if !value && @options[:consume_generate_all]
+                if !value && @options[:include_untranslated]
                   value = row.translated_string_for_lang(@strings.language_codes[0])
                 end
 

data/lib/twine/formatters/apple.rb

@@ -75,7 +75,7 @@ module Twine
           @strings.sections.each do |section|
             printed_section = false
             section.rows.each do |row|
-              if row.matches_tags?(@options[:tags])
+              if row.matches_tags?(@options[:tags], @options[:untagged])
                 if !printed_section
                   f.puts ''
                   if section.name && section.name.length > 0

data/lib/twine/runner.rb

@@ -216,7 +216,9 @@ module Twine
         end
       end
 
-      if keys_without_tags.length > 0
+      if keys_without_tags.length == total_strings
+        puts "\nNone of your strings have tags."
+      elsif keys_without_tags.length > 0
         puts "\nStrings without tags:"
         keys_without_tags.each do |key|
           puts key

data/lib/twine/stringsfile.rb

@@ -22,13 +22,13 @@ module Twine
       @translations = {}
     end
     
-    def matches_tags?(tags)
-      if @tags == nil || @tags.length == 0
-        # This row has no tags. Never match
-        return false
-      elsif tags == nil || tags.length == 0
+    def matches_tags?(tags, include_untagged)
+      if tags == nil || tags.length == 0
         # The user did not specify any tags. Everything passes.
         return true
+      elsif @tags == nil || @tags.length == 0
+        # This row has no tags.
+        return (include_untagged) ? true : false
       else
         tags.each do |tag|
           if @tags.include? tag

data/lib/twine/version.rb

@@ -1,3 +1,3 @@
 module Twine
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

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

@@ -7,4 +7,5 @@
 	<string name="key1">key1-french</string>
 	<string name="key2">key2-french</string>
 	<string name="key3">key3-english</string>
+	<string name="key4">key4-english</string>
 </resources>

data/test/twine_test.rb

@@ -5,7 +5,7 @@ class TwineTest < Test::Unit::TestCase
   def test_generate_string_file_1
     Dir.mktmpdir do |dir|
       output_path = File.join(dir, 'fr.xml')
-      Twine::Runner.run(%W(generate-string-file test/fixtures/strings-1.txt #{output_path} --all))
+      Twine::Runner.run(%W(generate-string-file test/fixtures/strings-1.txt #{output_path} --include-untranslated))
       assert_equal(File.read('test/fixtures/test-output-1.txt'), File.read(output_path))
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twine
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-27 00:00:00.000000000 Z
+date: 2012-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
-  requirement: &70216088301260 !ruby/object:Gem::Requirement
+  requirement: &70104222129900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.9.5
   type: :runtime
   prerelease: false
-  version_requirements: *70216088301260
+  version_requirements: *70104222129900
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70216088300680 !ruby/object:Gem::Requirement
+  requirement: &70104222128800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70216088300680
+  version_requirements: *70104222128800
 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"
 email: twine@mobiata.com