web_translate_it 1.7.1.7 → 1.7.2.0

data/README.md

@@ -4,19 +4,17 @@
 [RDocs](http://yardoc.org/docs/AtelierConvivialite-webtranslateit) | 
 [Example app](http://github.com/AtelierConvivialite/rails_example_app) | 
 [Report a bug](http://github.com/AtelierConvivialite/webtranslateit/issues) | 
-[Support](http://help.webtranslateit.com) | 
-[Documentation](http://docs.webtranslateit.com/web_translate_it_client/)
+[Support](http://help.webtranslateit.com)
 
 `web_translate_it` is a rubygem providing tools to sync your language files with [Web Translate It](https://webtranslateit.com), a web-based computer-aided translation tool.
 
 ![Web Translate It](http://s3.amazonaws.com:80/edouard.baconfile.com/web_translate_it%2Fwti2.png)
 
-This gem provides 4 tools:
+This gem provides:
 
-* an executable, `wti`, that will help you to upload and download language files from the command line,
-* a synchronisation server to help your translation team update your language files from a web-based interface,
-* a handful of rake task you can use with your Ruby on Rails application,
-* a rack middleware to automatically fetch new translations from Web Translate It.
+* a command-line executable `wti`, to sync your files between your computer/server and WebTranslateIt.com,
+* a synchronisation server to help your translation team update your language files from a web interface,
+* a rack middleware you can use within your Rails app to automatically fetch new translations from Web Translate It.
 
 ## Installation
 
@@ -25,168 +23,142 @@ These instructions are for Linux and Mac OS X system. Follow [these instructions
     gem install web_translate_it
     
 At this point you should have the `wti` executable working.
-If your project if already set up on Web Translate It, open a terminal and type `wti autoconf` to generate the configuration file.
-
-Execute `wti --help` to see the usage:
-
-    Usage: wti [-lcphhv]
-            pull                         Pull target language file(s)
-            push                         Push master language file(s)
-            add                          Create and push a new master language file
-            addlocale                    Add a new locale to the project
-            server                       Start a synchronisation server
-            stats                        Fetch and display project statistics
-            autoconf                     Configure your project to sync
-
-    Synchronization options: 
-        -l, --locale                     ISO code of a locale to pull or push
-        -c, --config                     Path to a translation.yml file
-                                         (default: config/translation.yml)
-            --all                        Download or upload all files
-            --force                      Force wti pull to download files
-            --merge                      Force WTI to merge this file
-            --ignore_missing             Force WTI to not obsolete missing strings
-            --low_priority               Tells WTI to process this command with a low priority
-            --label                      Apply a label to the changes
-
-    Server options: 
-        -p, --port                       Run server on a specific port
-                                         (default: 4000)
-        -h, --host                       Run server on a specific host
-                                         (default: localhost)
-
-    Other options: 
-        -h, --help                       Show this message
-        -v, --version                    Show version
 
 ## Configuration
 
 Now that the tool is installed, you’ll have to configure your project:
 
-    wti autoconf
+    wti init
 
-It will ask for your Web Translate It API key, and where to save its configuration file. Letting it put in `config/translations.yml` makes everything easier.
+The tool will prompt for:
 
-## Usage
+* your Web Translate It API key (you can find it in your project settings),
+* where to save the configuration file (by default in `config/translations.yml`).
 
-### Uploading your first language file
+## Usage
 
-If you have no file on Web Translate It yet, you need to send us your master language files. You can do it from the web interface, or from the command line:
+Execute `wti --help` to see the usage:
 
-    wti add path/to/master/file.po
+    wti is a command line tool to sync your local translation files
+    with the WebTranslateIt.com service.
 
-You can also add several files at once:
+    Usage:
+           wti <command> [options]+
+  
+    <command> is one of: pull push add addlocale server stats status st autoconf init
+    [options] are:
+    --config, -c <s>:   Path to a translation.yml file (default:
+                        config/translation.yml)
+       --version, -v:   Print version and exit
+          --help, -h:   Show this message
+
+Here’s more explanation about the commands.
+
+    pull          Pull target language file(s)
+    push          Push master language file(s)
+    add           Create and push a new master language file
+    addlocale     Add a new locale to the project
+    server        Start a synchronisation server
+    status        Fetch and display project statistics
+    init          Configure your project to sync
+
+You can get more information by appending `--help` after each command. For instance:
+
+    $ wti push --help
+    Options:
+          --locale, -l <s>:   ISO code of a locale to push
+                 --all, -a:   Upload all files
+        --low-priority, -o:   WTI will process this file with a low priority
+               --merge, -m:   Force WTI to merge this file
+      --ignore-missing, -i:   Force WTI to not obsolete missing strings
+           --label, -b <s>:   Apply a label to the changes
+                --help, -h:   Show this message
 
-    wti add file1.po file2.po file3.xml
+## Web Translate It Synchronisation Console
 
-Or
+![Web Translate It](http://s3.amazonaws.com:80/edouard.baconfile.com/web_translate_it%2Fadmin_console2.png)
 
-    wti add *.po
+The `wti` gem integrates since its version 1.7.0 a sinatra app that provides you with a friendly web interface to sync your translations. It allows a translation team to refresh the language files on a staging server without asking the developers to manually `wti pull`.
 
-After receiving your master language files, Web Translate It will automatically create the corresponding, empty target files. If you have already some translations for these files, use `wti push --all` to synchronise them to Web Translate It.
+To get started, go to the directory of the application you want to sync and do:
 
-### Updating a master language file
+    wti server
 
-    wti push
+By default, it starts an application on localhost on the port 4000. You will find the tool on `http://localhost:4000`.
 
-### Updating a target language file
+Should you need to use another host or port, you can use the `-h` and `-p` options. For example: `wti server -p 1234`.
 
-    wti push -l fr
-   
-where `fr` should be replaced by the locale code of your file.
+You may want to run some commands before or after syncing translations. To do so, add in the `translation.yml` file the following:
 
-### Updating all language files
+    before_pull: "echo 'some unix command'"
+    after_pull:  "touch tmp/restart.txt"
 
-    wti push --all
+`before_pull` and `after_pull` are respectively executed before and after pulling language files.
 
-### Download target language files
+## Use Cases
 
-    wti pull
-    
-### Download a specific language file
+Here are some example commands for the most common scenarios.
 
-    wti pull -l fr
-    
-### Download all the language files
+### Upload a new master language file
 
-    wti pull --all
-    
-### Force pull (bypass Web Translate It’s HTTP caching)
+    wti add path/to/master/file.po
 
-    wti pull --force
+Create several master language files at once:
 
-### View project stats
+    wti add file1.po file2.po file3.xml
 
-    wti stats
-    
-## Web Translate It Synchronisation Console
+Or:
 
-![Web Translate It](http://s3.amazonaws.com:80/edouard.baconfile.com/web_translate_it%2Fadmin_console2.png)
+    wti add *.po
 
-The `wti` gem integrates since its version 1.7.0 a sinatra back-end that allow you to sync your translations directly from a friendly web interface. It allows a translation team to refresh the language files on a staging server without having to ask the developers to manually `wti pull`.
+After receiving your master language files, Web Translate It will automatically create the corresponding target files. If you have already some translations for these files, use `wti push --all` to synchronise them to Web Translate It.
 
-To get started, go to the directory of the application you want to sync and do:
+### Update a master language file
 
-    wti server
-    
-By default, it starts an application on localhost on the port 4000. You will find the tool on `http://localhost:4000`.
+    wti push
 
-Should you need to use another host or port, you can use the `-h` and `-p` options. For example: `wti server -p 1234`.
+### Update a target language file
 
-You may want to run some commands before or after synching translations. To do so, add in the `translation.yml` file the following:
+Update the french language file:
 
-    before_pull: "echo 'some unix command'"
-    after_pull:  "touch tmp/restart.txt"
+    wti push -l fr
     
-`before_pull` and `after_pull` will respectively be executed before and after pulling your language files.
+Or several languages at once:
 
-## Rake tasks
+    wti push -l "fr en da sv"
+   
+### Update all language files at once
 
-This gem includes some rake tasks and a rack middleware you could use to integrate Web Translate It with Ruby on Rails. The rake tasks are significantly slower than the executable, since it has to load the whole rails stack.
+    wti push --all
 
-* Add to your config/environments.rb:
+### Download target language files
 
-    `config.gem 'web_translate_it'`
+    wti pull
     
-* Then, run:
-
-    `rake gems:install`
+### Download a specific language file
 
-* If you did not already did `wti autoconf`, copy your API key from Web Translate It and run:
+    wti pull -l fr
+    
+### Download all language files, including source
 
-    `script/generate webtranslateit --api-key your_key_here`
+    wti pull --all
     
-  The generator does two things:
-  
-  - It adds a auto-configured `config/translation.yml` file using Web Translate It’s API.
-  - It adds `require 'web_translate_it/tasks' rescue LoadError` to your `Rakefile`
-  
-There are 3 rake tasks.
+### Force pull (to bypass Web Translate It’s HTTP caching)
 
-    rake trans:fetch:all
-  
-Fetch the latest translations for all your files for all languages defined in Web Translate It’s interface, except for the languages set in `ignore_locales`.
+    wti pull --force
 
-    rake trans:fetch[fr_FR]
-  
-Fetch the latest translations for all the languages defined in Web Translate It’s interface. It takes the locale name as a parameter
+### Add a new locale to the project
 
-    rake trans:upload[fr_FR]
+    wti addlocale fr
     
-Upload to Web Translate It your files in a specific locale defined in Web Translate It’s interface.
-
-Read more about [Rails integration in the wiki](http://wiki.github.com/AtelierConvivialite/webtranslateit/).
+Or add several locales at once:
 
-### Supported Rails Versions
+    wti addlocale fr da sv
 
-The gem currently has been tested against the following versions of Rails:
-
-* 2.3.4
-* 2.3.5
-* 2.3.10
+### View project stats
 
-Please open a discussion on [our support site](http://help.webtranslateit.com) if you're using a version of Rails that is not listed above and the gem is not working properly.
+    wti status
 
 # License
 
-Copyright (c) 2009-2011 Atelier Convivialité, and released under the MIT License.
+Copyright (c) 2009-2011 Atelier Convivialité, released under the MIT License.

data/bin/wti

@@ -1,136 +1,56 @@
 #!/usr/bin/env ruby
 
-require 'choice'
+require 'trollop'
 require 'web_translate_it'
 
-Choice.options do
-
-  option :pull do
-    long 'pull'
-    desc "Pull target language file(s)"
-  end
-
-  option :push do
-    long 'push'
-    desc "Push master language file(s)"
-  end
-
-  option :add do
-    long 'add'
-    desc "Create and push a new master language file"
-  end
-  
-  option :addlocale do
-    long 'addlocale'
-    desc "Add a new locale to the project"
-  end
-  
-  option :server do
-    long 'server'
-    desc "Start a synchronisation server"
-  end
-
-  option :stats do
-    long 'stats'
-    desc "Fetch and display project statistics"
-  end
-
-  option :autoconf do
-    long 'autoconf'
-    desc "Configure your project to sync"
-  end
-
-  separator ''
-  separator 'Synchronization options: '
-  
-  option :locale do
-    short '-l'
-    long  '--locale'
-    desc  "ISO code of a locale to pull or push"
-  end
-  
-  option :config do
-    short '-c'
-    long  '--config'
-    desc  "Path to a translation.yml file"
-    desc  "(default: config/translation.yml)"
-    default "config/translation.yml"
-  end
-  
-  option :all do
-    long  '--all'
-    desc  "Download or upload all files"
-  end
-  
-  option :force do
-    long  '--force'
-    desc  "Force wti pull to download files"
-  end
-  
-  option :merge do
-    long  '--merge'
-    desc  "Force WTI to merge this file"
-  end
-  
-  option :ignore_missing do
-    long  '--ignore_missing'
-    desc  "Force WTI to not obsolete missing strings"
-  end
-  
-  option :low_priority do
-    long '--low_priority'
-    desc "Tells WTI to process this command with a low priority"
-  end
-  
-  option :label do
-    long  '--label'
-    desc  "Apply a label to the changes"
-  end
-  
-  separator ''
-  separator 'Server options: '
-  
-  option :port do
-    short '-p'
-    long  '--port'
-    desc  "Run server on a specific port"
-    desc  "(default: 4000)"
-    cast  Integer
-    default '4000'
-  end
-  
-  option :host do
-    short '-h'
-    long  '--host'
-    desc  "Run server on a specific host"
-    desc  "(default: localhost)"
-    default '0.0.0.0'
-  end
-  
-  separator ''
-  separator 'Other options: '
-  
-  option :help do
-    short '-h'
-    long  '--help'
-    desc  'Show this message'
-  end
+SUB_COMMANDS = %w(pull push add addlocale server stats status st autoconf init)
+global_options = Trollop::options do
+  banner <<-EOS
+  wti is a command line tool to sync your local translation files
+  with the WebTranslateIt.com service.
+
+  Usage:
+         wti <command> [options]+
+  
+  <command> is one of: #{SUB_COMMANDS.join(" ")}
+  [options] are:
+  EOS
+  version "Web Translate It v#{WebTranslateIt::Util.version}"
+  opt :config, "Path to a translation.yml file", :short => "-c", :default => "config/translation.yml"
+  stop_on SUB_COMMANDS
+end
 
-  option :version do
-    short '-v'
-    long '--version'
-    desc 'Show version'
-    action do
-      puts ""
-      puts "Web Translate It #{WebTranslateIt::Util.version}"
-      exit
+command = ARGV.shift # get the subcommand
+command_options = case command
+  when "pull"
+    Trollop::options do
+      opt :locale, "ISO code of locale(s) to pull", :type => :string
+      opt :all,    "Pull all files"
+      opt :force,  "Force pull (bypass conditional requests to WTI)"
+    end
+  when "push"
+    Trollop::options do
+      opt :locale, "ISO code of locale(s) to push", :type => :string
+      opt :all,    "Upload all files"
+      opt :low_priority, "WTI will process this file with a low priority"
+      opt :merge,  "Force WTI to merge this file"
+      opt :ignore_missing, "Force WTI to not obsolete missing strings"
+      opt :label,  "Apply a label to the changes", :type => :string
     end
+  when "add"
+  when "addlocale"
+  when "server"
+    Trollop::options do
+      opt :port, "Run server on a specific port", :default => 4000, :short => "-p"
+      opt :host, "Run server on a specific host", :default => "0.0.0.0", :short => "-h"
+    end
+  when "stats"
+  when "status"
+  when "st"
+  when "autoconf"
+  when "init"
+  else
+    Trollop::die "unknown subcommand #{command.inspect}"
   end
-end
 
-options = Choice.choices
-$project_path = File.expand_path(".")
-$command = Choice.rest[0]
-$parameters = Choice.rest[1..-1]
-Choice.help if $command.nil?
-WebTranslateIt::CommandLine.new($command, options, $project_path, $parameters)
+WebTranslateIt::CommandLine.new(command, command_options, global_options, ARGV, File.expand_path("."))

data/examples/en.yml

@@ -0,0 +1,38 @@
+en:
+  activerecord:
+    errors:
+      templates:
+        header:
+          one: "1 error prohibited this {{model}} from being saved"
+          other: "{{count}} errors prohibited this {{model}} from being saved"
+          body: "there were problems with the following fields:"
+          messages:
+            accepted: "must be accepted"
+            blank: "can't be blank"
+            confirmation: "doesn't match confirmation"
+            empty: "can't be empty"
+            equal_to: "must be equal to {{count}}"
+            even: "must be even"
+            exclusion: "is reserved"
+            greater_than: "must be greater than {{count}}"
+            greater_than_or_equal_to: "must be greater than or equal to {{count}}"
+            inclusion: "is not included in the list"
+            invalid: "is invalid"
+            less_than: "must be less than {{count}}"
+            less_than_or_equal_to: "must be less than or equal to {{count}}"
+            not_a_number: "is not a number"
+            odd: "must be odd"
+            taken: "is already taken"
+            too_long: "is too long (maximum is {{count}} characters)"
+            too_short: "is too short (minimum is {{count}} characters)"
+            wrong_length: "is the wrong length (should be {{count}} characters)" 
+      models:
+        invitation:
+          attributes:
+            email:
+              user_already_invited: "This user has already been invited"
+              user_already_member: "This user is already a member"
+        project_file:
+          attributes:
+            file:
+              file_format_not_supported: "Sorry, we currenly support only Gettext .pot/.po, .yml/.yaml and .strings"

data/examples/translation.yml

@@ -4,3 +4,10 @@ api_key: SECRET
 # Optional: locales not to sync with Web Translate It.
 # eg. [:en, :fr] or just 'en'
 # ignore_locales: :en
+
+# Optional
+# before_pull: "echo 'some unix command'"   # Command executed before pulling files
+# after_pull:  "touch tmp/restart.txt"      # Command executed after pulling files
+#
+# before_push: "echo 'some unix command'"   # Command executed before pushing files
+# after_push:  "touch tmp/restart.txt"      # Command executed after pushing files

data/history.md

@@ -1,3 +1,16 @@
+## Version 1.7.2.0 / 2011-03-10
+
+* Deprecate `wti autoconf` in favour of `wti init`.
+* Deprecate `wti stats` in favour of `wti status` and its alias `wti st`.
+* Better help and options. Replaced option parser from Choice to Trollop.
+* `wti pull -l` can now take several locales separated by spaces.
+  For instance: `wti pull -l "en fr ja"`
+* `wti push -l` can now take several locales separated by spaces.
+  For instance: `wti push -l "en fr"`
+* New: Coloured terminal output.
+* New: `before_pull` and `after_pull` hooks now work for all kind of `wti pull` (not only within `wti server`).
+* New: Added 2 new hooks: `before_push` and `after_push`.
+
 ## Version 1.7.1.7 / 2011-03-07
 
 * New: `wti unknow_command` explains how to get help.