crowdin-cli 0.0.17 → 0.0.18

data/README.md

@@ -1,9 +1,16 @@
 # Crowdin-CLI
 
+[Crowdin Integration Utility Homepage](http://crowdin.net/page/cli-tool) | 
+[Support](http://crowdin.net/contacts) | 
+[Crowdin.net Homepage](http://crowdin.net) | 
+[crowdin-api RubyDoc](http://rubydoc.info/github/crowdin/crowdin-api/)
+
 A Command-Line Interface to sync files between your computer/server and [Crowdin](crowdin.net).
 
 It is cross-platform and runs in a terminal (Linux, MacOS X) or in cmd.exe (Windows).
 
+![ScreenShot](https://raw.github.com/crowdin/crowdin-cli/master/screenshot.png)
+
 > **WARNING**: This is a development version: It contains the latest changes, but may also have severe known issues, including crashes and data loss situations. In fact, it may not work at all.
 
 ## Installation
@@ -74,7 +81,21 @@ files:
 
 Also you can add and upload all directories mathing the pattern including all nested files and localizable files.
 
-Create a `crowdin.yaml` YAML file in your root project directory with the following structure:
+Example configuration provided above has 'source' and 'translation' attributes containing standard wildcards (also known as globbing patterns) to make it easier to work with multiple files. 
+
+Here's patterns you can use: 
+
+* `*` (asterisk)
+
+ This wildcard represents any character in file or directory name. If you specified a `*.json` it will include all files like `messages.json`, `about_us.json` and anything that ends with `.json`. 
+
+* `**` (doubled asterisk)
+
+ Matches any string recursively (including sub-directories). Note that you can use `**` in `source` and in `translation` pattern. When using `**` in `translation` pattern it will always contain sub-path from `source` for certain file.
+
+ Say, you can have source: `/en/**/*.po` to upload all `*.po` files to Crowdin recursively. `translation` pattern will be `/%two_letters_code%/**/%original_file_name%'`.
+
+See sample configuration below::
 ```
 ---
 project_identifier: test
@@ -88,7 +109,11 @@ files:
     translation: /locale/%two_letters_code%/**/%original_file_name%
 ```
 
-Languages mapping.
+### Languages mapping
+
+Often software projects have custom names for locale directories. `crowdin-cli` allows you to map your own languages to understandable by Crowdin. 
+
+Let's say your locale directories named 'en', 'uk', 'fr', 'de'. All of them can be represented by `%two_letters_code%` placeholder. Still, you have one directory named 'zh_CH'. In order to make it work with `crowdin-cli` without changes in your project you can add `languages_mapping` section to your files set. See sample configuration below:
 
 ```
 ---
@@ -107,7 +132,54 @@ files:
         ru: ros
         uk: ukr
 ```
-See Also: all available [Crowdin Language Codes](http://crowdin.net/page/api/language-codes)
+Mapping format is the following: `crowdin_language_code : code_use_use`.
+
+Check [complete list of Crowdin language codes](http://crowdin.net/page/api/language-codes) that can be used for mapping. 
+
+You can also override language codes for other placeholders like `%android_code%`, `%locale%` etc...
+
+## Example Configurations
+
+### GetText Project
+
+```
+---
+project_identifier: test
+api_key: KeepTheAPIkeySecret
+base_url: http://api.crowdin.net
+base_path: /path/to/your/project
+
+files:
+  -
+    source: '/locale/en/**/*.po'
+    translation: '/locale/%two_letters_code%/LC_MESSAGES/%original_file_name%'
+    languages_mapping:
+      two_letters_code:
+        'zh-CN': 'zh_CH'
+        'fr-QC': 'fr'
+```
+
+### Android Project
+
+```
+---
+project_identifier: test
+api_key: KeepTheAPIkeySecret
+base_url: http://api.crowdin.net
+base_path: /path/to/your/project
+
+files:
+  - 
+   source: '/res/values/*.xml'
+   translation: '/res/values-%android_code%/%original_file_name%'
+   languages_mapping:
+     android_code:
+       # we need this mapping since Crowdin expects directories
+       # to be named like "values-uk-rUA"
+       # acording to specification instead of just "uk"
+       de: de 
+       ru: ru
+```
 
 ## Usage
 
@@ -158,6 +230,10 @@ Tested with the following Ruby versions:
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-## License
+## License and Author
+
+Author: Anton Maminov (anton.maminov@gmail.com)
+
+Copyright: 2012 [Crowdin.net](http://crowdin.net/)
 
 This library is distributed under the MIT license.  Please see the LICENSE file.

data/bin/crowdin-cli

@@ -99,7 +99,7 @@ def get_invalid_placeholders(export_pattern)
     '%original_file_name%',
     '%original_path%',
     '%file_extension%',
-    '%file_name%'
+    '%file_name%',
   ]
 
   all_placeholders = export_pattern.scan(/%[a-z0-9_]*?%/)
@@ -216,10 +216,10 @@ EOS
             local_files << { dest: dest, source: source, export_pattern: export_pattern }
           end
 
-        end
-      end
+        end # if
+      end # @config['files']
 
-      if local_files.empty?
+      if dest_files.empty?
         exit_now!("Warning: nothing to upload. See http://crowdin.net/page/cli-client#configuration-file for more details.")
       end
 
@@ -294,6 +294,11 @@ EOS
 
 
     c.action do |global_options, options, args|
+      params = {}
+      params[:import_duplicates]     = options['import-dublicates']     ? 1 : 0
+      params[:import_eq_suggestions] = options['import-eq-suggestions'] ? 1 : 0
+      params[:auto_approve_imported] = options['auto-approve-imported'] ? 1 : 0
+
       language = options[:language]
 
       project_info = @crowdin.project_info
@@ -353,16 +358,12 @@ EOS
         exit_now!("Warning: nothing to upload. See http://crowdin.net/page/cli-client#configuration-file for more details.")
       end
 
-      params = {}
-      params[:import_duplicates]     = options['import-dublicates']     ? 1 : 0
-      params[:import_eq_suggestions] = options['import-eq-suggestions'] ? 1 : 0
-      params[:auto_approve_imported] = options['auto-approve-imported'] ? 1 : 0
-
       common_dir = find_common_directory_path(dest_files)
 
       translated_files.each do |language, files|
         files.each do |file|
           file[:dest].sub!(common_dir, '')
+
           if remote_project_tree[:files].include?(file[:dest])
             if File.exist?(file[:source])
               print "Uploading `#{file[:source].sub(@base_path, '')}'"
@@ -375,6 +376,7 @@ EOS
             # if source file not exist, don't upload translation
             puts "Warning: Skip `#{file[:source].sub(@base_path, '')}'"
           end
+
         end
       end
 
@@ -513,12 +515,19 @@ EOS
     end
   else
     @base_path = Dir.pwd
+    puts <<EOS
+Warning: Configuration file misses optional section `base_path`.
+Set the working directory - `#{@base_path}`
+
+EOS
   end
 
   Crowdin::API.log = Logger.new($stderr) if global[:v]
   @crowdin = Crowdin::API.new(api_key: @config['api_key'], project_id: @config['project_identifier'], base_url: @config['base_url'] || 'http://api.crowdin.net')
   begin
     @crowdin.project_info
+  rescue Crowdin::API::Errors::Error => err
+    raise err
   rescue
     exit_now!("Seems Crowdin server API URL is not valid. Please check the `base_url` parameter in the configuration file.")
   end

data/lib/crowdin-cli/version.rb

@@ -1,5 +1,5 @@
 module Crowdin
   module CLI
-    VERSION = '0.0.17'
+    VERSION = '0.0.18'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-30 00:00:00.000000000 Z
+date: 2012-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake