twine 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c52c16544077b748fb773dd7cd3f8d7f88172eeb
-  data.tar.gz: a4db219ebbef41d69c00a59e46d09971be26ba4a
+  metadata.gz: dd42325c94b784158be7dd018af67a02fb3099b0
+  data.tar.gz: 7ee4dae663a07911d402a236fb1f40692b58cc43
 SHA512:
-  metadata.gz: 18423f5df5e0feda3ebd2e5e74c65ccb1bea506022ec79ee0d180f609e7acb2402348e1c37f78e02e00eee02933e6f6ba0f308b23e846d7e5e4e8896ad49b9c3
-  data.tar.gz: 010dca262cae3a0766d99d5a34aede2c05dba4ad5489d03c4798808cea3902fe3c5c443302e38712af26be12c3f8dedc442f3a25da2d483fc00adce9f5c36b4a
+  metadata.gz: 54345a2371c8717af7b2285b7fee737b082695501da2e5ecaaee04f76762b6aa2a31eefc0c42c5a95d15ae06af38d1e8b31dfb34b6a20b56c86417044667255e
+  data.tar.gz: 681b338e4b3f9efc9af0659c785b8fcaabb3878e6b3080b8fce7aca0856094e52f0414f25591c27c7d2688c82c45e671ddd6bbb2d25c59afdadb16858005d427

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. Tags are optional, though highly recommended. 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 `validate-strings-file` command.
 
 ### Whitespace
 
@@ -47,7 +47,7 @@ Whitepace in this file is mostly ignored. If you absolutely need to put spaces a
 			en = No
 			fr = Non
 			ja = いいえ
-	
+
 	[[Errors]]
 		[path_not_found_error]
 			en = The file '%@' could not be found.
@@ -57,7 +57,7 @@ Whitepace in this file is mostly ignored. If you absolutely need to put spaces a
 			en = The network is currently unavailable.
 			tags = app1
 			comment = An error describing when the device can not connect to the internet.
-	
+
 	[[Escaping Example]]
 		[list_item_separator]
 			en = `, `
@@ -84,7 +84,7 @@ If you would like to enable twine to create language files in another format, cr
 ## Usage
 
 	Usage: twine COMMAND STRINGS_FILE [INPUT_OR_OUTPUT_PATH] [--lang LANG1,LANG2...] [--tags TAG1,TAG2,TAG3...] [--format FORMAT]
-	
+
 ### Commands
 
 #### `generate-string-file`
@@ -128,11 +128,11 @@ This command is a convenient way of taking a zip file and executing the `consume
 
 	$ twine consume-loc-drop /path/to/strings.txt LocDrop2.zip
 
-#### `generate-report`
+#### `validate-strings-file`
 
-This command gives you useful information about your strings. It will tell you how many strings you have, how many have been translated into each language, and whether your master strings data file has any duplicate string keys.
+This command validates that the strings file can be parsed, contains no duplicate keys, and that all strings have at least one tag. It will exit with a non-zero status code if any of those criteria are not met.
 
-	$ twine generate-report /path/to/strings.txt
+	$ twine validate-strings-file /path/to/strings.txt
 
 ## Creating Your First strings.txt File
 
@@ -143,6 +143,8 @@ The easiest way to create your first strings.txt file is to run the `consume-all
 
 ## Twine and Your Build Process
 
+### Xcode
+
 It is easy to incorporate Twine right into your iOS and OS X app build processes.
 
 1. In your project folder, create all of the `.lproj` directories that you need. It does not really matter where they are. We tend to put them in `Resources/Locales/`.
@@ -159,6 +161,22 @@ 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.
 
+### Android Studio/Gradle
+
+Add the following task at the top level in app/build.gradle:
+```
+task generateStrings {
+    String script = 'if hash twine 2>/dev/null; then twine generate-string-file strings.txt ./src/main/res/values/generated_strings.xml; fi'
+    exec {
+        executable "sh"
+        args '-c', script
+    }
+}
+```
+
+Now every time you build your app the strings are generated from the twine file.
+
+
 ## User Interface
 
 * [Twine TextMate 2 Bundle](https://github.com/mobiata/twine.tmbundle) — This [TextMate 2](https://github.com/textmate/textmate) bundle will make it easier for you to work with Twine strings files. In particular, it lets you use code folding to easily collapse and expand both strings and sections.
@@ -191,6 +209,7 @@ gems: [appium_twine, some_other_plugin]
 Many thanks to all of the contributors to the Twine project, including:
 
 * [Blake Watters](https://github.com/blakewatters)
+* [bootstraponline](https://github.com/bootstraponline)
 * [Ishitoya Kentaro](https://github.com/kent013)
 * [Joseph Earl](https://github.com/JosephEarl)
 * [Kevin Everets](https://github.com/keverets)

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, gettext, 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, and 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 ''
@@ -31,7 +31,7 @@ module Twine
         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 ''
-        opts.separator 'generate-report -- Generates a report containing data about your strings. For example, it will tell you if you have any duplicate strings or if any of your strings are missing tags. In addition, it will tell you how many strings you have and how many of those strings have been translated into each language.'
+        opts.separator 'validate-strings-file -- Validates that the given strings file is parseable, contains no duplicates, and that every string has a tag. Exits with a non-zero exit code if those criteria are not met.'
         opts.separator ''
         opts.separator 'General Options:'
         opts.separator ''
@@ -96,7 +96,7 @@ module Twine
         opts.separator '> twine consume-all-string-files strings.txt Resources/Locales/ --developer-language en --tags DefaultTag1,DefaultTag2'
         opts.separator '> twine generate-loc-drop strings.txt LocDrop5.zip --tags FT,FB --format android --lang de,en,en-GB,ja,ko'
         opts.separator '> twine consume-loc-drop strings.txt LocDrop5.zip'
-        opts.separator '> twine generate-report strings.txt'
+        opts.separator '> twine validate-strings-file strings.txt'
       end
       parser.parse! @args
 
@@ -176,7 +176,7 @@ module Twine
         else
           raise Twine::Error.new 'Not enough arguments.'
         end
-      when 'generate-report'
+      when 'validate-strings-file'
         if @args.length > 2
           raise Twine::Error.new "Unknown argument: #{@args[2]}"
         end

data/lib/twine/formatters/apple.rb

@@ -18,7 +18,9 @@ module Twine
         path_arr.each do |segment|
           match = /^(.+)\.lproj$/.match(segment)
           if match
-            return match[1]
+            if match[1] != "Base"
+              return match[1]
+            end
           end
         end
 

data/lib/twine/runner.rb

@@ -3,7 +3,7 @@ require 'tmpdir'
 Twine::Plugin.new # Initialize plugins first in Runner.
 
 module Twine
-  VALID_COMMANDS = ['generate-string-file', 'generate-all-string-files', 'consume-string-file', 'consume-all-string-files', 'generate-loc-drop', 'consume-loc-drop', 'generate-report']
+  VALID_COMMANDS = ['generate-string-file', 'generate-all-string-files', 'consume-string-file', 'consume-all-string-files', 'generate-loc-drop', 'consume-loc-drop', 'validate-strings-file']
 
   class Runner
     def initialize(args)
@@ -48,8 +48,8 @@ module Twine
         generate_loc_drop
       when 'consume-loc-drop'
         consume_loc_drop
-      when 'generate-report'
-        generate_report
+      when 'validate-strings-file'
+        validate_strings_file
       end
     end
 
@@ -207,15 +207,12 @@ module Twine
       write_strings_data(output_path)
     end
 
-    def generate_report
+    def validate_strings_file
       total_strings = 0
-      strings_per_lang = {}
       all_keys = Set.new
       duplicate_keys = Set.new
       keys_without_tags = Set.new
-      @strings.language_codes.each do |code|
-        strings_per_lang[code] = 0
-      end
+      errors = []
 
       @strings.sections.each do |section|
         section.rows.each do |row|
@@ -227,37 +224,29 @@ module Twine
             all_keys.add(row.key)
           end
 
-          row.translations.each_key do |code|
-            strings_per_lang[code] += 1
-          end
-
           if row.tags == nil || row.tags.length == 0
             keys_without_tags.add(row.key)
           end
         end
       end
 
-      # Print the report.
-      puts "Total number of strings = #{total_strings}"
-      @strings.language_codes.each do |code|
-        puts "#{code}: #{strings_per_lang[code]}"
-      end
-
       if duplicate_keys.length > 0
-        puts "\nDuplicate string keys:"
-        duplicate_keys.each do |key|
-          puts key
-        end
+        error_body = duplicate_keys.to_a.join("\n  ")
+        errors << "Found duplicate string key(s):\n  #{error_body}"
       end
 
       if keys_without_tags.length == total_strings
-        puts "\nNone of your strings have tags."
+        errors << "None of your strings have tags."
       elsif keys_without_tags.length > 0
-        puts "\nStrings without tags:"
-        keys_without_tags.each do |key|
-          puts key
-        end
+        error_body = keys_without_tags.to_a.join("\n  ")
+        errors << "Found strings(s) without tags:\n  #{error_body}"
       end
+
+      if errors.length > 0
+        raise Twine::Error.new errors.join("\n\n")
+      end
+
+      puts "#{@options[:strings_file]} is valid."
     end
 
     def determine_language_given_path(path)

data/lib/twine/version.rb

@@ -1,3 +1,3 @@
 module Twine
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

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

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- Android Strings File -->
-<!-- Generated by Twine 0.5.0 -->
+<!-- Generated by Twine <%= Twine::VERSION %> -->
 <!-- Language: en -->
 <resources>
 	<!-- SECTION: My Strings -->

data/test/twine_test.rb

@@ -116,10 +116,6 @@ class TwineTest < Test::Unit::TestCase
     end
   end
 
-  def test_generate_report_1
-    Twine::Runner.run(%w(generate-report test/fixtures/strings-1.txt))
-  end
-
   def test_json_line_breaks_consume
     Dir.mktmpdir do |dir|
       output_path = File.join(dir, 'strings.txt')

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: twine
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Sebastian Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-20 00:00:00.000000000 Z
+date: 2015-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.5
 - !ruby/object:Gem::Dependency
   name: safe_yaml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.2
 description: |2
@@ -63,10 +63,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
@@ -75,13 +78,10 @@ files:
 - lib/twine/formatters/gettext.rb
 - lib/twine/formatters/jquery.rb
 - lib/twine/formatters/tizen.rb
-- lib/twine/formatters.rb
 - lib/twine/plugin.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.po
 - test/fixtures/en-1.strings
@@ -117,17 +117,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Manage strings and their translations for your iOS and Android projects.