web_translate_it 2.5.3 → 2.6.1

data/lib/web_translate_it/translation_file.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module WebTranslateIt
   # A TranslationFile is the representation of a master language file
   # on Web Translate It.
@@ -6,15 +5,15 @@ module WebTranslateIt
   # This class allows to manipulate TranslationFiles, more specifically upload and download them.
   # If you pass a Locale to the master language file you will be able to
   # manipulate a _target_ language file.
-  class TranslationFile
+  class TranslationFile # rubocop:todo Metrics/ClassLength
     require 'net/https'
     require 'net/http/post/multipart'
     require 'time'
     require 'fileutils'
-    
+
     attr_accessor :id, :file_path, :locale, :api_key, :updated_at, :remote_checksum, :master_id, :fresh
-    
-    def initialize(id, file_path, locale, api_key, updated_at = nil, remote_checksum = "", master_id = nil, fresh = nil)
+
+    def initialize(id, file_path, locale, api_key, updated_at = nil, remote_checksum = '', master_id = nil, fresh = nil) # rubocop:todo Metrics/ParameterLists
       self.id         = id
       self.file_path  = file_path
       self.locale     = locale
@@ -24,7 +23,7 @@ module WebTranslateIt
       self.master_id  = master_id
       self.fresh      = fresh
     end
-    
+
     # Fetch a language file.
     # By default it will make a conditional GET Request, using the `If-Modified-Since` tag.
     # You can force the method to re-download your file by passing `true` as a second argument
@@ -37,45 +36,45 @@ module WebTranslateIt
     #   file.fetch # returns nothing, with a status 304 Not Modified
     #   file.fetch(true) # force to re-download the file, will return the content of the file with a 200 OK
     #
-    def fetch(http_connection, force = false)
+    def fetch(http_connection, force = false) # rubocop:todo Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
       success = true
       tries ||= 3
       display = []
-      if self.fresh
-        display.push(self.file_path)
+      if fresh
+        display.push(file_path)
       else
-        display.push("*#{self.file_path}")
+        display.push("*#{file_path}")
       end
-      display.push "#{StringUtil.checksumify(self.local_checksum.to_s)}..#{StringUtil.checksumify(self.remote_checksum.to_s)}"
-      if !File.exist?(self.file_path) or force or self.remote_checksum != self.local_checksum
+      display.push "#{StringUtil.checksumify(local_checksum.to_s)}..#{StringUtil.checksumify(remote_checksum.to_s)}"
+      if !File.exist?(file_path) || force || (remote_checksum != local_checksum)
         begin
           request = Net::HTTP::Get.new(api_url)
           WebTranslateIt::Util.add_fields(request)
-          FileUtils.mkpath(self.file_path.split('/')[0..-2].join('/')) unless File.exist?(self.file_path) or self.file_path.split('/')[0..-2].join('/') == ""
+          FileUtils.mkpath(file_path.split('/')[0..-2].join('/')) unless File.exist?(file_path) || (file_path.split('/')[0..-2].join('/') == '')
           begin
             response = http_connection.request(request)
-            File.open(self.file_path, 'wb'){ |file| file << response.body } if response.code.to_i == 200
+            File.open(file_path, 'wb') { |file| file << response.body } if response.code.to_i == 200
             display.push Util.handle_response(response)
           rescue Timeout::Error
-            puts StringUtil.failure("Request timeout. Will retry in 5 seconds.")
-            if (tries -= 1) > 0
+            puts StringUtil.failure('Request timeout. Will retry in 5 seconds.')
+            if (tries -= 1).positive?
               sleep(5)
               retry
             else
               success = false
             end
           rescue
-            display.push StringUtil.failure("An error occured: #{$!}")
+            display.push StringUtil.failure("An error occured: #{$ERROR_INFO}")
             success = false
           end
         end
       else
-        display.push StringUtil.success("Skipped")
+        display.push StringUtil.success('Skipped')
       end
       print ArrayUtil.to_columns(display)
-      return success
+      success
     end
-    
+
     # Update a language file to Web Translate It by performing a PUT Request.
     #
     # Example of implementation:
@@ -87,45 +86,51 @@ module WebTranslateIt
     #
     # Note that the request might or might not eventually be acted upon, as it might be disallowed when processing
     # actually takes place. This is due to the fact that language file imports are handled by background processing.
-    def upload(http_connection, merge=false, ignore_missing=false, label=nil, low_priority=false, minor_changes=false, force=false, rename_others=false, destination_path=nil)
+    # rubocop:todo Metrics/PerceivedComplexity
+    # rubocop:todo Metrics/ParameterLists
+    # rubocop:todo Metrics/MethodLength
+    # rubocop:todo Metrics/AbcSize
+    def upload(http_connection, merge = false, ignore_missing = false, label = nil, low_priority = false, minor_changes = false, force = false, rename_others = false, destination_path = nil) # rubocop:todo Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength, Metrics/ParameterLists, Metrics/PerceivedComplexity
       success = true
       tries ||= 3
       display = []
-      display.push(self.file_path)
-      display.push "#{StringUtil.checksumify(self.local_checksum.to_s)}..#{StringUtil.checksumify(self.remote_checksum.to_s)}"
-      if File.exists?(self.file_path)
-	      if force or self.remote_checksum != self.local_checksum
-          File.open(self.file_path) do |file|
-            begin
-              params = {"file" => UploadIO.new(file, "text/plain", file.path), "merge" => merge, "ignore_missing" => ignore_missing, "label" => label, "low_priority" => low_priority, "minor_changes" => minor_changes }
-              params["name"] = destination_path unless destination_path.nil?
-              params["rename_others"] = rename_others
-              request = Net::HTTP::Put::Multipart.new(api_url, params)
-              WebTranslateIt::Util.add_fields(request)
-              display.push Util.handle_response(http_connection.request(request))
-            rescue Timeout::Error
-              puts StringUtil.failure("Request timeout. Will retry in 5 seconds.")
-              if (tries -= 1) > 0
-                sleep(5)
-                retry
-              else
-                success = false
-              end
-            rescue
-              display.push StringUtil.failure("An error occured: #{$!}")
+      display.push(file_path)
+      display.push "#{StringUtil.checksumify(local_checksum.to_s)}..#{StringUtil.checksumify(remote_checksum.to_s)}"
+      if File.exist?(file_path)
+        if force || (remote_checksum != local_checksum)
+          File.open(file_path) do |file|
+            params = { 'file' => UploadIO.new(file, 'text/plain', file.path), 'merge' => merge, 'ignore_missing' => ignore_missing, 'label' => label, 'low_priority' => low_priority, 'minor_changes' => minor_changes }
+            params['name'] = destination_path unless destination_path.nil?
+            params['rename_others'] = rename_others
+            request = Net::HTTP::Put::Multipart.new(api_url, params)
+            WebTranslateIt::Util.add_fields(request)
+            display.push Util.handle_response(http_connection.request(request))
+          rescue Timeout::Error
+            puts StringUtil.failure('Request timeout. Will retry in 5 seconds.')
+            if (tries -= 1).positive? # rubocop:todo Metrics/BlockNesting
+              sleep(5)
+              retry
+            else
               success = false
             end
+          rescue
+            display.push StringUtil.failure("An error occured: #{$ERROR_INFO}")
+            success = false
           end
         else
-          display.push StringUtil.success("Skipped")
+          display.push StringUtil.success('Skipped')
         end
         puts ArrayUtil.to_columns(display)
       else
-        puts StringUtil.failure("Can't push #{self.file_path}. File doesn't exist locally.")
+        puts StringUtil.failure("Can't push #{file_path}. File doesn't exist locally.")
       end
-      return success
+      success
     end
-    
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/ParameterLists
+    # rubocop:enable Metrics/PerceivedComplexity
+
     # Create a master language file to Web Translate It by performing a POST Request.
     #
     # Example of implementation:
@@ -137,104 +142,102 @@ module WebTranslateIt
     # Note that the request might or might not eventually be acted upon, as it might be disallowed when processing
     # actually takes place. This is due to the fact that language file imports are handled by background processing.
     #
-    def create(http_connection, low_priority=false)
+    def create(http_connection, low_priority = false) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
       success = true
       tries ||= 3
       display = []
       display.push file_path
-      display.push "#{StringUtil.checksumify(self.local_checksum.to_s)}..[     ]"
-      if File.exists?(self.file_path)
-        File.open(self.file_path) do |file|
-          begin
-            request = Net::HTTP::Post::Multipart.new(api_url_for_create, { "name" => self.file_path, "file" => UploadIO.new(file, "text/plain", file.path), "low_priority" => low_priority })
-            WebTranslateIt::Util.add_fields(request)
-            display.push Util.handle_response(http_connection.request(request))
-            puts ArrayUtil.to_columns(display)
-          rescue Timeout::Error
-            puts StringUtil.failure("Request timeout. Will retry in 5 seconds.")
-            if (tries -= 1) > 0
-              sleep(5)
-              retry
-            else
-              success = false
-            end
-          rescue
-            display.push StringUtil.failure("An error occured: #{$!}")
+      display.push "#{StringUtil.checksumify(local_checksum.to_s)}..[     ]"
+      if File.exist?(file_path)
+        File.open(file_path) do |file|
+          request = Net::HTTP::Post::Multipart.new(api_url_for_create, { 'name' => file_path, 'file' => UploadIO.new(file, 'text/plain', file.path), 'low_priority' => low_priority })
+          WebTranslateIt::Util.add_fields(request)
+          display.push Util.handle_response(http_connection.request(request))
+          puts ArrayUtil.to_columns(display)
+        rescue Timeout::Error
+          puts StringUtil.failure('Request timeout. Will retry in 5 seconds.')
+          if (tries -= 1).positive?
+            sleep(5)
+            retry
+          else
             success = false
           end
+        rescue
+          display.push StringUtil.failure("An error occured: #{$ERROR_INFO}")
+          success = false
         end
       else
-        puts StringUtil.failure("\nFile #{self.file_path} doesn't exist locally!")
+        puts StringUtil.failure("\nFile #{file_path} doesn't exist locally!")
       end
-      return success
+      success
     end
-    
+
     # Delete a master language file from Web Translate It by performing a DELETE Request.
     #
-    def delete(http_connection)
+    def delete(http_connection) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
       success = true
       tries ||= 3
       display = []
       display.push file_path
-      if File.exists?(self.file_path)
+      if File.exist?(file_path)
         begin
           request = Net::HTTP::Delete.new(api_url_for_delete)
           WebTranslateIt::Util.add_fields(request)
           display.push Util.handle_response(http_connection.request(request))
           puts ArrayUtil.to_columns(display)
         rescue Timeout::Error
-          puts StringUtil.failure("Request timeout. Will retry in 5 seconds.")
-          if (tries -= 1) > 0
+          puts StringUtil.failure('Request timeout. Will retry in 5 seconds.')
+          if (tries -= 1).positive?
             sleep(5)
             retry
           else
             success = false
           end
         rescue
-          display.push StringUtil.failure("An error occured: #{$!}")
+          display.push StringUtil.failure("An error occured: #{$ERROR_INFO}")
           success = false
         end
       else
-        puts StringUtil.failure("\nMaster file #{self.file_path} doesn't exist locally!")
+        puts StringUtil.failure("\nMaster file #{file_path} doesn't exist locally!")
       end
-      return success
+      success
     end
 
     def exists?
-      File.exists?(file_path)
+      File.exist?(file_path)
     end
-    
+
     def modified_remotely?
-      fetch == "200 OK"
+      fetch == '200 OK'
     end
-         
+
     protected
-      
-      # Convenience method which returns the date of last modification of a language file.
-      def last_modification
-        File.mtime(File.new(self.file_path, 'r'))
-      end
-      
-      # Convenience method which returns the URL of the API endpoint for a locale.
-      def api_url
-        "/api/projects/#{self.api_key}/files/#{self.id}/locales/#{self.locale}"
-      end
-      
-      def api_url_for_create
-        "/api/projects/#{self.api_key}/files"
-      end
-      
-      def api_url_for_delete
-        "/api/projects/#{self.api_key}/files/#{self.id}"
-      end
-      
-      def local_checksum
-        require 'digest/sha1'
-        begin
-          Digest::SHA1.hexdigest(File.open(file_path) { |f| f.read })
-        rescue
-          ""
-        end
+
+    # Convenience method which returns the date of last modification of a language file.
+    def last_modification
+      File.mtime(File.new(file_path, 'r'))
+    end
+
+    # Convenience method which returns the URL of the API endpoint for a locale.
+    def api_url
+      "/api/projects/#{api_key}/files/#{id}/locales/#{locale}"
+    end
+
+    def api_url_for_create
+      "/api/projects/#{api_key}/files"
+    end
+
+    def api_url_for_delete
+      "/api/projects/#{api_key}/files/#{id}"
+    end
+
+    def local_checksum
+      require 'digest/sha1'
+      begin
+        Digest::SHA1.hexdigest(File.read(file_path))
+      rescue
+        ''
       end
+    end
   end
 end

data/lib/web_translate_it/util/array_util.rb

@@ -1,22 +1,22 @@
 class ArrayUtil
   def self.to_columns(arr)
-    if arr[0][0] == "*"
+    if arr[0][0] == '*'
       "*#{StringUtil.backward_truncate(arr[0][1..-1])} | #{arr[1]}  #{arr[2]}\n"
     else
       " #{StringUtil.backward_truncate(arr[0])} | #{arr[1]}  #{arr[2]}\n"
     end
   end
 
-  def self.chunk(arr, pieces=2)
-    len = arr.length;
-    mid = (len/pieces)
+  def self.chunk(arr, pieces = 2) # rubocop:todo Metrics/MethodLength
+    len = arr.length
+    mid = (len / pieces)
     chunks = []
     start = 0
     1.upto(pieces) do |i|
-      last = start+mid
-      last = last-1 unless len%pieces >= i
-      chunks << arr[start..last] || []
-      start = last+1
+      last = start + mid
+      last -= 1 unless len % pieces >= i
+      chunks << (arr[start..last] || [])
+      start = last + 1
     end
     chunks
   end

data/lib/web_translate_it/util/hash_util.rb

@@ -1,18 +1,18 @@
 class HashUtil
-  def self.to_params(hash)
+  def self.to_params(hash) # rubocop:todo Metrics/MethodLength
     params = ''
     stack = []
 
     hash.each do |k, v|
       if v.is_a?(Hash)
-        stack << [k,v]
+        stack << [k, v]
       else
         params << "#{k}=#{v}&"
       end
     end
 
-    stack.each do |parent, hash|
-      hash.each do |k, v|
+    stack.each do |parent, h|
+      h.each do |k, v|
         if v.is_a?(Hash)
           stack << ["#{parent}[#{k}]", v]
         else
@@ -34,4 +34,4 @@ class Hash
     end
     self
   end
-end
+end

data/lib/web_translate_it/util/string_util.rb

@@ -1,13 +1,10 @@
 class StringUtil
-
   def self.backward_truncate(str)
-    if str.length <= 50
-      spaces = ""
-      (50-str.length).times{ spaces << " " }
-      return str.dup << spaces
-    else
-      return "..." << str[str.length-50+3..str.length]
-    end
+    return '...' << str[str.length - 50 + 3..str.length] if str.length > 50
+
+    spaces = ''
+    (50 - str.length).times { spaces << ' ' }
+    str.dup << spaces
   end
 
   def self.success(str)

data/lib/web_translate_it/util.rb

@@ -1,55 +1,55 @@
-# encoding: utf-8
 module WebTranslateIt
-  
   # A few useful functions
   class Util
-    
     require 'multi_json'
-    
+
     # Return a string representing the gem version
     # For example "1.8.3"
     def self.version
       Gem.loaded_specs['web_translate_it'].version
     end
-            
+
     def self.calculate_percentage(processed, total)
-      return 0 if total == 0
-      ((processed*10)/total).to_f.ceil*10
+      return 0 if total.zero?
+
+      ((processed * 10) / total).to_f.ceil * 10
     end
-    
-    def self.handle_response(response, return_response = false, raise_exception = false)
-      if response.code.to_i >= 400 and response.code.to_i < 500
-        if raise_exception
-          raise "Error: #{MultiJson.load(response.body)['error']}"
-        else
-          puts StringUtil.failure(MultiJson.load(response.body)['error'])
-        end
+
+    # rubocop:todo Metrics/PerceivedComplexity
+    # rubocop:todo Metrics/MethodLength
+    # rubocop:todo Metrics/AbcSize
+    def self.handle_response(response, return_response = false, raise_exception = false) # rubocop:todo Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
+      if (response.code.to_i >= 400) && (response.code.to_i < 500)
+        raise "Error: #{MultiJson.load(response.body)['error']}" if raise_exception
+
+        puts StringUtil.failure(MultiJson.load(response.body)['error'])
       elsif response.code.to_i == 500
-        if raise_exception
-          raise "Error: Server temporarily unavailable (Error 500)."
-        else
-          puts StringUtil.failure("Error: Server temporarily unavailable (Error 500).")
-        end
+        raise 'Error: Server temporarily unavailable (Error 500).' if raise_exception
+
+        puts StringUtil.failure('Error: Server temporarily unavailable (Error 500).')
       else
         return response.body if return_response
-        return StringUtil.success("OK") if response.code.to_i == 200
-        return StringUtil.success("Created") if response.code.to_i == 201
-        return StringUtil.success("Accepted") if response.code.to_i == 202
-        return StringUtil.success("Not Modified") if response.code.to_i == 304
+        return StringUtil.success('OK') if response.code.to_i == 200
+        return StringUtil.success('Created') if response.code.to_i == 201
+        return StringUtil.success('Accepted') if response.code.to_i == 202
+        return StringUtil.success('Not Modified') if response.code.to_i == 304
         return StringUtil.failure("Locked\n                                                    (another import in progress)") if response.code.to_i == 503
       end
     end
-    
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/PerceivedComplexity
+
     def self.add_fields(request)
-      request.add_field("X-Client-Name", "web_translate_it")
-      request.add_field("X-Client-Version", version)
-      request.add_field("Content-Type", "application/json")
+      request.add_field('X-Client-Name', 'web_translate_it')
+      request.add_field('X-Client-Version', version)
+      request.add_field('Content-Type', 'application/json')
     end
-    
+
     ##
     # Ask a question. Returns a true for yes, false for no, default for nil.
-    
-    def self.ask_yes_no(question, default=nil)
+
+    def self.ask_yes_no(question, default = nil) # rubocop:todo Metrics/MethodLength
       qstr = case default
              when nil
                'yn'
@@ -64,40 +64,37 @@ module WebTranslateIt
       while result.nil?
         result = ask("#{question} [#{qstr}]")
         result = case result
-        when /^[Yy].*/
-          true
-        when /^[Nn].*/
-          false
-        when /^$/
-        when nil
-          default
-        else
-          nil
-        end
+                 when /^[Yy].*/
+                   true
+                 when /^[Nn].*/
+                   false
+                 when '', nil
+                   default
+                 end
       end
 
-      return result
+      result
     end
-    
+
     ##
     # Ask a question. Returns an answer.
 
-    def self.ask(question, default=nil)
-      question = question + " (Default: #{default})" unless default.nil?
-      print(question + "  ")
-      STDOUT.flush
+    def self.ask(question, default = nil)
+      question += " (Default: #{default})" unless default.nil?
+      print("#{question}  ")
+      $stdout.flush
 
-      result = STDIN.gets
-      result.chomp! if result
-      result = default if result.nil? or result == ''
+      result = $stdin.gets
+      result&.chomp!
+      result = default if result.nil? || (result == '')
       result
     end
-    
+
     ##
     # Returns whether a terminal can display ansi colors
-    
+
     def self.can_display_colors?
-      !RUBY_PLATFORM.downcase.include?("mingw32")
+      !RUBY_PLATFORM.downcase.include?('mingw32')
     end
   end
-end
+end

data/lib/web_translate_it.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'web_translate_it/connection'
 require 'web_translate_it/util'
 require 'web_translate_it/util/array_util'
@@ -15,16 +13,18 @@ require 'web_translate_it/auto_fetch'
 require 'web_translate_it/command_line'
 require 'web_translate_it/project'
 
-module WebTranslateIt
+require 'English'
 
-  def self.fetch_translations
+module WebTranslateIt
+  def self.fetch_translations # rubocop:todo Metrics/AbcSize
     config = Configuration.new
     locale = I18n.locale.to_s
     return if config.ignore_locales.include?(locale)
-    config.logger.debug { "   Fetching #{locale} language file(s) from WebTranslateIt" } if config.logger
+
+    config.logger&.debug { "   Fetching #{locale} language file(s) from WebTranslateIt" }
     WebTranslateIt::Connection.new(config.api_key) do |http|
-      config.files.find_all{ |file| file.locale.in?([locale, I18n.locale]) }.each do |file|
-        response = file.fetch(http)
+      config.files.find_all { |file| file.locale.in?([locale, I18n.locale]) }.each do |file|
+        file.fetch(http)
       end
     end
   end

data/readme.md

@@ -1,9 +1,9 @@
 # WebTranslateIt Synchronization Tool : wti
 
-[RubyDoc](https://rubydoc.info/github/webtranslateit/webtranslateit/master) | 
-[Report a bug](https://github.com/webtranslateit/webtranslateit/issues) | 
-[Support](https://webtranslateit.com/en/support) |
-[WebTranslateIt.com Homepage](https://webtranslateit.com/en)
+[RubyDoc](https://rubydoc.info/github/webtranslateit/webtranslateit/master) |
+[Report a bug](https://github.com/webtranslateit/webtranslateit/issues) |
+[Support](https://webtranslateit.com/support) |
+[WebTranslateIt.com Homepage](https://webtranslateit.com)
 
 wti lets you easily sync your language files with [WebTranslateIt.com](https://webtranslateit.com), a web-based tool to translation software.
 
@@ -32,7 +32,7 @@ Fetching: web_translate_it-2.1.3.gem (100%)
 Successfully installed web_translate_it-2.1.3
 1 gem installed
 ```
-    
+
 At this point you should have the `wti` executable working:
 
 ``` bash
@@ -74,14 +74,18 @@ If you’d like to specify another path for your configuration file, you can use
 
 Now you’re all set and you can use the `wti` commands on your project.
 
+## Using on multiple projects
+
+Please refer to [our documentation about syncing multiple projects](https://github.com/webtranslateit/webtranslateit/wiki/Using-wti-with-multiple-projects).
+
 ## Usage
 
 Execute `wti --help` to see the usage:
 
     Usage: wti <command> [options]+
-  
+
     The most commonly used wti commands are:
-  
+
       pull        Pull target language file(s)
       push        Push master language file(s)
       match       Display matching of local files with File Manager
@@ -92,7 +96,7 @@ Execute `wti --help` to see the usage:
       init        Configure your project to sync      
 
     See `wti <command> --help` for more information on a specific command.
-  
+
     [options] are:
       --config, -c <s>:   Path to a translation.yml file (default: .wti)
          --version, -v:   Print version and exit
@@ -213,7 +217,7 @@ There are 4 hooks:
 * `before_push`
 * `after_push`
 
-Check the [sample `.wti`](https://github.com/webtranslateit/webtranslateit/blob/master/examples/.wti#L9..L13) file for implementation.
+Check the [sample `.wti`](https://github.com/webtranslateit/webtranslateit/blob/master/examples/.wti#L16-L21) file for implementation.
 
 ## Exit codes