web_translate_it 2.0.3 → 2.0.4

data/history.md

@@ -1,3 +1,9 @@
+## Version 2.0.4 / 2012-08-08
+
+* New: Add a throbber to indicate the project information is loading.
+* New: Display error message when pushing or pulling a language that doesn’t exist in a project.
+* Fixed: Compatibility problem with ruby 1.8.6.
+
 ## Version 2.0.3 / 2012-06-07
 
 * Fix: String#translation_for('xx') should not return an array of all translations. #88

data/lib/web_translate_it/command_line.rb

@@ -4,12 +4,28 @@ module WebTranslateIt
     require 'fileutils'
     require 'set'
     attr_accessor :configuration, :global_options, :command_options, :parameters
-    
+
     def initialize(command, command_options, global_options, parameters, project_path)
       self.command_options = command_options
       self.parameters = parameters
       unless command == 'init'
-        self.configuration = WebTranslateIt::Configuration.new(project_path, configuration_file_path)
+        case command
+        when 'pull'
+          message = "Pulling files"
+        when 'push'
+          message = "Pushing files"
+        when 'add'
+          message = "Creating master files"
+        when 'rm'
+          message = "Deleting files"
+        when 'addlocale'
+          message = "Adding locale"
+        when 'rmlocale'
+          message = "Deleting locale"
+        else
+          message = "Gathering information"
+        end
+        throb { print "  #{message}"; self.configuration = WebTranslateIt::Configuration.new(project_path, configuration_file_path) }
       end
       self.send(command)
     end
@@ -22,14 +38,13 @@ module WebTranslateIt
       fetch_locales_to_pull.each do |locale|
         files.concat configuration.files.find_all{ |file| file.locale == locale }
       end
-      if files.count == 0
+      if files.size == 0
         puts "No files to pull."
       else
         # Now actually pulling files
-        puts "# Pulling files"
         time = Time.now
         threads = []
-        n_threads = (files.count.to_f/3).ceil >= 20 ? 20 : (files.count.to_f/3).ceil
+        n_threads = (files.size.to_f/3).ceil >= 20 ? 20 : (files.size.to_f/3).ceil
         ArrayUtil.chunk(files, n_threads).each do |file_array|
           unless file_array.empty?
             threads << Thread.new(file_array) do |file_array|
@@ -43,7 +58,7 @@ module WebTranslateIt
         end
         threads.each { |thread| thread.join }
         time = Time.now - time
-        puts "Pulled #{files.count} files at #{(files.count/time).round} files/sec, using #{n_threads} threads."
+        puts "Pulled #{files.size} files at #{(files.size/time).round} files/sec, using #{n_threads} threads."
         `#{configuration.after_pull}` if configuration.after_pull
       end
     end
@@ -51,11 +66,15 @@ module WebTranslateIt
     def push
       STDOUT.sync = true
       `#{configuration.before_push}` if configuration.before_push
-      puts "# Pushing files"
       WebTranslateIt::Connection.new(configuration.api_key) do |http|
         fetch_locales_to_push(configuration).each do |locale|
-          configuration.files.find_all{ |file| file.locale == locale }.sort{|a,b| a.file_path <=> b.file_path} .each do |file|
-            file.upload(http, command_options[:merge], command_options.ignore_missing, command_options.label, command_options.low_priority, command_options[:minor], command_options.force)
+          files = configuration.files.find_all{ |file| file.locale == locale }.sort{|a,b| a.file_path <=> b.file_path}
+          if files.size == 0
+            puts "No files to push."
+          else
+            files.each do |file|
+              file.upload(http, command_options[:merge], command_options.ignore_missing, command_options.label, command_options.low_priority, command_options[:minor], command_options.force)
+            end
           end
         end
       end
@@ -64,7 +83,6 @@ module WebTranslateIt
     
     def add
       STDOUT.sync = true
-      puts "# Creating master files"
       if parameters == []
         puts StringUtil.failure("Error: You must provide the path to the master file to add.")
         puts "Usage: wti add path/to/master_file_1 path/to/master_file_2 ..."
@@ -146,7 +164,7 @@ module WebTranslateIt
       puts "# Initializing project"
       api_key = Util.ask(" Project API Key:")
       path = Util.ask(" Path to configuration file:", '.wti')
-      FileUtils.mkpath(path.split('/')[0..path.split('/').size-2].join('/')) unless path.split('/').count == 1
+      FileUtils.mkpath(path.split('/')[0..path.split('/').size-2].join('/')) unless path.split('/').size == 1
       project = YAML.load WebTranslateIt::Project.fetch_info(api_key)
       project_info = project['project']
       if File.exists?(path) && !File.writable?(path)
@@ -156,7 +174,7 @@ module WebTranslateIt
       File.open(path, 'w'){ |file| file << generate_configuration(api_key, project_info) }
       puts ""
       puts " Your project was successfully initialized."
-      if project_info["source_locale"]["code"].nil? || project_info["target_locales"].count <= 1 || project_info["project_files"].none?
+      if project_info["source_locale"]["code"].nil? || project_info["target_locales"].size <= 1 || project_info["project_files"].none?
         puts ""
         puts " There are a few more things to set up:"
         puts ""
@@ -166,7 +184,7 @@ module WebTranslateIt
         puts "    Add the source locale with: `wti addlocale <locale_code>`"
         puts ""
       end
-      if project_info["target_locales"].count <= 1
+      if project_info["target_locales"].size <= 1
         puts " *) You don't have a target locale setup."
         puts "    Add the first target locale with: `wti addlocale <locale_code>`"
         puts ""
@@ -213,6 +231,9 @@ module WebTranslateIt
                 
     def fetch_locales_to_pull
       if command_options.locale
+        command_options.locale.split.each do |locale|
+          puts "Locale #{locale} doesn't exist -- `wti addlocale #{locale}` to add it." unless configuration.target_locales.include?(locale)
+        end
         locales = command_options.locale.split
       else
         locales = configuration.target_locales
@@ -224,6 +245,9 @@ module WebTranslateIt
         
     def fetch_locales_to_push(configuration)
       if command_options.locale
+        command_options.locale.split.each do |locale|
+          puts "Locale #{locale} doesn't exist -- `wti addlocale #{locale}` to add it." unless configuration.target_locales.include?(locale)
+        end
         locales = command_options.locale.split
       else
         locales = [configuration.source_locale]
@@ -273,6 +297,27 @@ api_key: #{api_key}
 
 FILE
       return file
-    end    
-  end
+    end
+
+    def throb
+      throb = %w(⠋ ⠙ ⠹ ⠸ ⠼ ⠴ ⠦ ⠧ ⠇ ⠏)
+      throb.reverse! if rand > 0.5
+      i = rand throb.length
+
+      thread = Thread.new do
+        dot = lambda do
+          print "\r#{throb[i]}\e[?25l"
+          i = (i + 1) % throb.length
+          sleep 0.1 and dot.call
+        end
+        dot.call
+      end
+      yield
+      ensure
+        if thread
+          thread.kill
+          puts "\r\e[0G#\e[?25h"
+        end
+      end
+    end
 end

data/readme.md

@@ -1,46 +1,62 @@
-# Web Translate It
+# WebTranslateIt Synchronization Tool
 
-[Homepage](https://webtranslateit.com) | 
-[RDoc](http://yardoc.org/docs/AtelierConvivialite-webtranslateit) | 
+[RubyDoc](http://rubydoc.info/github/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)
+[Support](https://webtranslateit.com/support) |
+[WebTranslateIt.com Homepage](https://webtranslateit.com)
 
-`web_translate_it` is a tool to sync your language files with [WebTranslateIt.com](https://webtranslateit.com), a web-based translation software.
+`web_translate_it` is a tool to sync your language files with [WebTranslateIt.com](https://webtranslateit.com), a web-based tool to translation software.
 
-![Web Translate It](http://f.cl.ly/items/2X3m0h0g0I1O1U07163o/wti_example.jpg)
+![WebTranslateIt Synchronization Tool](http://f.cl.ly/items/2X3m0h0g0I1O1U07163o/wti_example.jpg)
 
 ## This rubygem provides:
 
-1. A command-line executable `wti` to sync your files between your computer/server and WebTranslateIt.com. It can run in a terminal (Linux, MacOS X) or in cmd.exe (Windows). This is what this page is all about.
-2. A synchronisation server to help your translation team update your language files from a web interface. To learn how to install it, go to [web_translate_it_server](https://github.com/AtelierConvivialite/web_translate_it_server).
-3. Ruby libraries to write programs connecting to WebTranslateIt.com’s API. For more information, go to [Extras](https://github.com/AtelierConvivialite/webtranslateit/wiki/Extras).
-4. A rack middleware you can use in your Rails app to automatically fetch new translations from Web Translate It.
-
-This readme focusses on the most commonly used functionality of this rubygem: the `wti` command-line executable.
+1. A Command-Line Interface, `wti`, to sync files between your computer/server and WebTranslateIt.com. It is cross-platform and runs in a terminal (Linux, MacOS X) or in cmd.exe (Windows).
+2. A synchronisation server which provides a web interface for your translation team to update your language files. [Learn more on the web_translate_it_server project page](https://github.com/AtelierConvivialite/web_translate_it_server).
+3. A library to help write programs to connect to WebTranslateIt.com’s API. See [Extras](https://github.com/AtelierConvivialite/webtranslateit/wiki/Extras).
+4. A rack middleware you can use in your Rails app to automatically fetch new translations from WebTranslateIt.
 
 ---
 
 ## Installation
 
-A dependency of wti needs gcc in order to install, so you will need build tools. With Linux, `apt-get install gcc` or `yum install gcc` should do it.
+A dependency of `wti` needs gcc, so you will need it. With Linux, `apt-get install build-essential` or `yum install gcc` should do it.
 
-You will also need ruby to run wti. On Linux or a Mac, it’s already installed. Install [RubyInstaller](http://rubyinstaller.org/) if you’re using Windows. [See detailed installation instructions for Windows users](https://github.com/AtelierConvivialite/webtranslateit/wiki/Install-wti-on-Windows).
+You will also need ruby to run `wti`. On Linux or a Mac, it’s already installed. Install [RubyInstaller](http://rubyinstaller.org/) if you’re using Windows. [See detailed installation instructions for Windows users](https://github.com/AtelierConvivialite/webtranslateit/wiki/Install-wti-on-Windows).
 
-    gem install web_translate_it
+``` bash
+$ gem install web_translate_it
+Fetching: web_translate_it-2.0.3.gem (100%)
+Successfully installed web_translate_it-2.0.3
+1 gem installed
+```
     
-At this point you should have the `wti` executable working.
+At this point you should have the `wti` executable working:
+
+``` bash
+$ wti -v
+wti version 2.0.3
+```
 
 ## Configuration
 
-Now that the tool is installed, you’ll have to configure your project:
+Now that the tool is installed, you’ll have to configure your project. Basically, `wti` is to be run on a project root directory, and looks for a `.wti` file containing your project information. The command `wti init` lets your create your `.wti` file.
+
+``` bash
+$ wti init
+# Initializing project
+ Project API Key:  55555abc1235555
+ Path to configuration file: (Default: .wti)  
 
-    wti init
+ Your project was successfully initialized.
+You can now use `wti` to push and pull your language files.
+Check `wti --help` for help.
+```
 
-The command will ask you to enter:
+The command asks you to enter your project API key (you can find it in your project settings) and where to save the configuration file (by default it will create a `.wti` in your project root directory).
 
-* Your Web Translate It API key. You can find it in your project settings,
-* Where to save the configuration file (by default it will create a `.wti` in your project root directory).
+Now you’re all set and you can use the `wti` commands on your project.
 
 ## Usage
 
@@ -128,7 +144,7 @@ Append `--help` for each command for more information. For instance:
   </tr>
   <tr>
     <td>wti pull --force</td>
-    <td>Force pull (to bypass Web Translate It’s HTTP caching)</td>
+    <td>Force pull (to bypass WebTranslateIt’s HTTP caching)</td>
   </tr>
   <tr>
     <td>wti addlocale fr</td>
@@ -144,7 +160,7 @@ Append `--help` for each command for more information. For instance:
   </tr>
   <tr>
     <td>wti match</td>
-    <td>Show matching between files on local computer and the ones in Web Translate It’s File Manager</td>
+    <td>Show matching between files on local computer and the ones in WebTranslateIt’s File Manager</td>
   </tr>
 </table>
 
@@ -161,7 +177,7 @@ There are 4 hooks:
 
 Check the [sample `.wti`](https://github.com/AtelierConvivialite/webtranslateit/blob/master/examples/.wti#L9..L13) file for implementation.
 
-## Web Translate It Server
+## WebTranslateIt Server
 
 This feature was extracted out to a separate gem. See [web_translate_it_server](https://github.com/AtelierConvivialite/web_translate_it_server).
 

data/version

@@ -1 +1 @@
-2.0.3
+2.0.4

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: web_translate_it
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-07 00:00:00.000000000 Z
+date: 2012-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post