web_translate_it 1.7.0.2 → 1.7.0.3

data/README.md

@@ -7,15 +7,15 @@
 [Support](http://help.webtranslateit.com)
 [Documentation](http://docs.webtranslateit.com/web_translate_it_client/)
 
-This is a gem providing tools to sync your software’s language files with [Web Translate It](https://webtranslateit.com), a web-based computer-aided translation tool.
+`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%2Fwti.png)
 
-This gem provides your app with:
+This gem provides 4 tools:
 
-* an executable, `wti`, that will help you to upload and download language files from the command line (or in whatever else you want to execute it),
-* a handful of rake task to fetch and upload your translations,
-* a Sinatra app to help you download your translations from a web-based interface,
+* 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.
 
 ## Installation
@@ -25,41 +25,60 @@ This gem provides your app with:
 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.
 
-Run `wti --help` to see the usage:
+Execute `wti --help` to see the usage:
 
-    pull            Pull target language file(s) from Web Translate It.
-    push            Push master language file(s) to Web Translate It.
-    autoconf        Configure your project to sync with Web Translate It.
-    stats           Fetch and display your project statistics.
+    Usage: wti [-lcphv]
+            pull                         Pull target language file(s).
+            push                         Push master language file(s).
+            add                          Create and push a new master language file.
+            server                       Start a synchronisation server
+            stats                        Fetch and display project statistics.
+            autoconf                     Configure your project to sync.
 
-    OPTIONAL PARAMETERS:
-    --------------------
-    -l --locale     The ISO code of a specific locale to pull or push.
-    -c --config     Path to a translation.yml file. If this option
-                    is absent, looks for config/translation.yml.
-    --all           Respectively download or upload all files.
-    --force         Force wti pull to re-download the language file,
-                    regardless if local version is current.
-    OTHER:
-    ------
-    -v --version    Show version.
-    -h --help       This page.
+    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.
 
-## Generalities
+    Server options: 
+        -p, --port                       Run server on a specific port
+                                         (default: 4000).
+        -h, --host                       Run server on a specific host
+                                         (default: localhost).
 
-The first time, you’ll have to configure your project:
+    Other options: 
+            --help                       Show this message
+        -v, --version                    Show version
+
+## Configuration
+
+Now that the tool is installed, you’ll have to configure your project:
 
     wti autoconf
-    
+
 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.
 
+## Usage
+
 ### Uploading your first language file
 
 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:
 
     wti add path/to/master/file.po
 
-That’s it! Web Translate It will automatically create the corresponding target files.
+You can also add several files at once:
+
+    wti add file1.po file2.po file3.xml
+
+Or
+
+    wti add *.po
+
+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.
 
 ### Updating a master language file
 
@@ -69,7 +88,11 @@ That’s it! Web Translate It will automatically create the corresponding target
 
     wti push -l fr
    
-where fr should be replaced by the locale code of your file.
+where `fr` should be replaced by the locale code of your file.
+
+### Updating all language files
+
+    wti push --all
 
 ### Download target language files
 
@@ -108,7 +131,7 @@ Should you need to use another host or port, you can use the -h and -p options.
 You may want to run some commands before or after synching translations. To do so, add in the `translation.yml` file the following:
 
     before_pull: "echo 'some unix command'"
-    after_pull:  "touch public/restart.txt"
+    after_pull:  "touch tmp/restart.txt"
     
 `before_pull` and `after_pull` will respectively be executed before and after pulling your language files.
 
@@ -167,7 +190,7 @@ Please open a discussion on [our support site](http://help.webtranslateit.com) i
 
 # What is Web Translate It anyway?
 
-Web Translate It is a web-based translation tool to collaboratively translate software.
+[Web Translate It](https://webtranslateit.com) is a web-based computer-aided translation tool to collaboratively translate software.
 
 To learn more about it, please visit our [tour page](https://webtranslateit.com/tour).
 

data/bin/wti

@@ -1,4 +1,121 @@
 #!/usr/bin/env ruby
 
+require 'choice'
 require 'web_translate_it'
-WebTranslateIt::CommandLine.run
+
+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 :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
+    
+  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
+
+  option :version do
+    short '-v'
+    long '--version'
+    desc 'Show version'
+    action do
+      puts ""
+      puts "Web Translate It #{WebTranslateIt::Util.version}"
+      exit
+    end
+  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)

data/history.md

@@ -1,3 +1,9 @@
+## Version 1.7.0.3 / 2010-06-08
+
+* New: ability to add several master files at once
+  `wti add file1 file2 file3 …`
+  `wti add *.yml`.
+
 ## Version 1.7.0.2 / 2010-05-31
 
 * Fix bug with file permissions.

data/lib/web_translate_it/command_line.rb

@@ -2,62 +2,22 @@
 module WebTranslateIt
   class CommandLine
     require 'fileutils'
-    
-    OPTIONS = <<-OPTION
-pull             Pull target language file(s) from Web Translate It.
-push             Push master language file(s) to Web Translate It.
-add              Create a new master language file to Web Translate It.
-autoconf         Configure your project to sync with Web Translate It.
-stats            Fetch and display your project statistics.
-server           Launch web-based synchronisation console.
-
-OPTIONAL PARAMETERS:
---------------------
--l --locale      The ISO code of a specific locale to pull or push.
--c --config      Path to a translation.yml file. If this option
-                 is absent, looks for config/translation.yml.
--h --host        Set server host when using `wti server` (default 0.0.0.0).
--p --port        Set server port when using `wti server` (default 4000).
---all            Respectively download or upload all files.
---force          Force wti pull to re-download the language file,
-                 regardless if local version is current.
---merge          Force WTI to perform a merge of this file with its database.
---ignore_missing Force WTI to not obsolete missing strings.
-
-OTHER:
-------
--v --version     Show version.
--h --help        This page.
-OPTION
-    
-    def self.run
-      case ARGV[0]
-      when 'pull'
-        pull
-      when 'push'
-        push
-      when 'add'
-        add
-      when 'autoconf'
+    attr_accessor :configuration, :options, :parameters
+        
+    def initialize(command, options, path, parameters)
+      self.options = options
+      self.parameters = parameters
+      if command == 'autoconf'
         autoconf
-      when 'stats'
-        stats
-      when 'server'
-        server
-      when '-v', '--version'
-        show_version
-      when '-h', '--help'
-        show_options
-      else
-        puts "Command not found"
-        show_options
+        exit
       end
+      self.configuration = WebTranslateIt::Configuration.new(path, options.config)
+      self.send(command)
     end
         
-    def self.pull
+    def pull
       STDOUT.sync = true
-      configuration = fetch_configuration
-      fetch_locales_to_pull(configuration).each do |locale|
+      fetch_locales_to_pull.each do |locale|
         configuration.files.find_all{ |file| file.locale == locale }.each do |file|
           print "Pulling #{file.file_path}… "
           puts file.fetch(ARGV.index('--force'))
@@ -65,9 +25,8 @@ OPTION
       end
     end
     
-    def self.push
+    def push
       STDOUT.sync = true
-      configuration = fetch_configuration
       fetch_locales_to_push(configuration).each do |locale|
         merge = !(ARGV.index('--merge')).nil?
         ignore_missing = !(ARGV.index('--ignore_missing')).nil?
@@ -78,16 +37,21 @@ OPTION
       end
     end
     
-    def self.add
+    def add
       STDOUT.sync = true
-      configuration = fetch_configuration
-      file_path = fetch_file_to_add(configuration)
-      file = TranslationFile.new(nil, file_path, nil, configuration.api_key)
-      print "Creating #{file.file_path}… "
-      puts file.create
+      if parameters.nil?
+        puts "Usage: wti add file1 file2"
+        exit
+      end
+      parameters.each do |param|
+        file = TranslationFile.new(nil, param, nil, configuration.api_key)
+        print "Creating #{file.file_path}… "
+        puts file.create
+      end
+      puts "Master file added! Use `wti push --all` to send your existing translations."
     end
     
-    def self.autoconf
+    def autoconf
       puts "We will attempt to configure your project automagically"
       api_key = Util.ask("Please enter your project API Key")
       path = Util.ask("Where should we create the configuration file?", 'config/translation.yml')
@@ -117,8 +81,7 @@ OPTION
       end
     end
     
-    def self.stats
-      configuration = fetch_configuration
+    def stats
       stats = YAML.load(Project.fetch_stats(configuration.api_key))
       stale = false
       stats.each do |locale, values|
@@ -128,84 +91,47 @@ OPTION
         stale = true if values['stale']
       end
       if stale
-        CommandLine.stats if Util.ask_yes_no("Some statistics displayed above are stale. Would you like to refresh?", true)
+        self.stats if Util.ask_yes_no("Some statistics displayed above are stale. Would you like to refresh?", true)
       end
     end
     
-    def self.server
-      host_port = fetch_server_host_and_port
-      WebTranslateIt::Server.start(host_port[0], host_port[1])
-    end
-    
-    def self.show_options
-      puts ""
-      puts "Web Translate It Help:"
-      puts "**********************"
-      $stdout.puts OPTIONS
-    end
-    
-    def self.show_version
-      puts ""
-      puts "Web Translate It #{WebTranslateIt::Util.version}"
-    end
-    
-    def self.fetch_configuration
-      if (index = ARGV.index('-c') || ARGV.index('--config')).nil?
-        configuration = WebTranslateIt::Configuration.new('.')
-      else
-        configuration = WebTranslateIt::Configuration.new('.', ARGV[index+1])
-      end
-      return configuration
+    def server
+      WebTranslateIt::Server.start(options.host, options.port)
     end
-    
-    def self.fetch_server_host_and_port
-      if (index = ARGV.index('-h') || ARGV.index('--host')).nil?
-        host = "0.0.0.0"
-      else
-        host = ARGV[index+1]
-      end
-      if (index = ARGV.index('-p') || ARGV.index('--port')).nil?
-        port = "4000"
+        
+    def fetch_locales_to_pull
+      if options.locale
+        locales = [options.locale]
       else
-        port = ARGV[index+1]
-      end
-      return [host,port]
-    end
-    
-    def self.fetch_locales_to_pull(configuration)
-      if (index = ARGV.index('-l') || ARGV.index('--locale')).nil?
         locales = configuration.target_locales
         configuration.ignore_locales.each{ |locale_to_delete| locales.delete(locale_to_delete) }
-      else
-        locales = [ARGV[index+1]]
       end
-      locales.push(configuration.source_locale) if ARGV.index('--all')
+      locales.push(configuration.source_locale) if options.all
       return locales.uniq
     end
-    
-    def self.fetch_file_to_add(configuration)
-      index = ARGV.index('add')
-      file_path = ARGV[index+1].strip
-      return file_path
-    end
-    
-    def self.fetch_locales_to_push(configuration)
-      if (index = ARGV.index('-l') || ARGV.index('--locale')).nil?
-        locales = [configuration.source_locale]
+        
+    def fetch_locales_to_push(configuration)
+      if options.locale
+        locales = [options.locale]
       else
-        locales = [ARGV[index+1]]
+        locales = [configuration.source_locale]
       end
-      locales += configuration.target_locales if ARGV.index('--all')
+      locales += configuration.target_locales if options.all
       return locales.uniq
     end
     
-    def self.generate_configuration(api_key, project_info)
+    def generate_configuration(api_key, project_info)
       file = <<-FILE
 api_key: #{api_key}
 
 # Optional: locales not to sync with Web Translate It.
 # eg. [:en, :fr] or just 'en'
 # ignore_locales: '#{project_info["source_locale"]["code"]}'
+
+# Optional, only used by wti server
+# before_pull: "echo 'some unix command'"   # Command executed before pulling files
+# after_pull:  "touch tmp/restart.txt"      # Command executed after pulling files
+
 FILE
       return file
     end

data/lib/web_translate_it/server.rb

@@ -32,7 +32,7 @@ module WebTranslateIt
     
     post '/pull' do
       `#{config.before_pull}` if config.before_pull
-      WebTranslateIt::CommandLine.pull
+      `wti pull`
       `#{config.after_pull}` if config.after_pull
       redirect "/"
     end
@@ -45,6 +45,5 @@ module WebTranslateIt
     def self.start(host, port)
       WebTranslateIt::Server.run! :host => host, :port => port
     end
-    
   end
 end

data/lib/web_translate_it/views/index.erb

@@ -52,7 +52,7 @@
         </div>
         <div class="contact">
           <p>
-            <code>wti</code> v.<%= WebTranslateIt::Util.version %><br/>
+            wti v.<%= WebTranslateIt::Util.version %><br/>
             Built with <a href="http://sinatrarb.com/">Sinatra</a>
           </p>
         </div>        

data/version.yml

@@ -2,4 +2,4 @@
 :major: 1
 :minor: 7
 :tiny: 0
-:patch: 2
+:patch: 3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: web_translate_it
 version: !ruby/object:Gem::Version 
-  hash: 99
+  hash: 97
   prerelease: false
   segments: 
   - 1
   - 7
   - 0
-  - 2
-  version: 1.7.0.2
+  - 3
+  version: 1.7.0.3
 platform: ruby
 authors: 
 - "\xC3\x89douard Bri\xC3\xA8re"
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-31 00:00:00 +02:00
+date: 2010-06-08 00:00:00 +02:00
 default_executable: wti
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,9 +35,25 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: sinatra
+  name: choice
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 1
+        - 4
+        version: 0.1.4
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -48,11 +64,11 @@ dependencies:
         - 0
         version: "1.0"
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -64,7 +80,7 @@ dependencies:
         - 9
         version: 1.2.9
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 description: An ruby executable, a sinatra app and a handful of rake tasks to sync your translations between your app and webtranslateit.com.
 email: edouard@atelierconvivialite.com
 executables: 
@@ -79,7 +95,6 @@ files:
 - MIT-LICENSE
 - README.md
 - version.yml
-- examples/en.yml
 - examples/locale.rb
 - examples/translation.yml
 - lib/web_translate_it/auto_fetch.rb

data/examples/en.yml

@@ -1,38 +0,0 @@
-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"