web_translate_it 2.5.2 → 2.6.0

data/lib/web_translate_it/configuration.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
 module WebTranslateIt
-  
   # Handles the configuration of your project, both via the the configuration file
   # and via the API.
   # Implementation example, assuming you have a valid .wti file:
@@ -11,25 +9,25 @@ module WebTranslateIt
     require 'yaml'
     require 'fileutils'
     require 'erb'
-    attr_accessor :path, :api_key, :source_locale, :target_locales, :files, :ignore_locales, :needed_locales
-    attr_accessor :logger, :before_pull, :after_pull, :before_push, :after_push, :project_name, :path_to_config_file
-    
+    attr_accessor :path, :api_key, :source_locale, :target_locales, :files, :ignore_locales, :needed_locales, :logger, :before_pull, :after_pull, :before_push, :after_push, :project_name, :path_to_config_file, :ignore_files
+
     # Load configuration file from the path.
-    def initialize(root_path = Rails.root, path_to_config_file = ".wti")
+    def initialize(root_path = Rails.root, path_to_config_file = '.wti') # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
       self.path_to_config_file = path_to_config_file
       self.path           = root_path
       self.logger         = logger
-      if File.exists?(File.expand_path(path_to_config_file, self.path))
-        self.api_key        = ENV["WTI_PROJECT_API_KEY"] || configuration['api_key']
+      if File.exist?(File.expand_path(path_to_config_file, path))
+        self.api_key        = ENV['WTI_PROJECT_API_KEY'] || configuration['api_key']
         self.before_pull    = configuration['before_pull']
         self.after_pull     = configuration['after_pull']
         self.before_push    = configuration['before_push']
         self.after_push     = configuration['after_push']
-        project_info = if RUBY_VERSION >= 3.1
-          YAML.safe_load WebTranslateIt::Project.fetch_info(api_key), permitted_classes: [Time]
-        else
-          YAML.load WebTranslateIt::Project.fetch_info(api_key)
-        end
+        self.ignore_files   = configuration['ignore_files']
+        project_info = if RUBY_VERSION >= '3.1.0'
+                         YAML.safe_load WebTranslateIt::Project.fetch_info(api_key), permitted_classes: [Time]
+                       else
+                         YAML.load WebTranslateIt::Project.fetch_info(api_key)
+                       end
         set_locales_to_ignore(configuration)
         set_locales_needed(configuration)
         set_files(project_info['project'])
@@ -37,15 +35,15 @@ module WebTranslateIt
         WebTranslateIt::Connection.turn_silent_on if configuration['silence_errors']
         self.project_name = project_info['project']['name']
       else
-        puts StringUtil.failure("\nNo configuration file found in #{File.expand_path(path_to_config_file, self.path)}")
+        puts StringUtil.failure("\nNo configuration file found in #{File.expand_path(path_to_config_file, path)}")
         exit(1)
       end
     end
-    
+
     # Reload project data
     #
-    def reload
-      project_info = YAML.load WebTranslateIt::Project.fetch_info(self.api_key)
+    def reload # rubocop:todo Metrics/AbcSize
+      project_info = YAML.load WebTranslateIt::Project.fetch_info(api_key)
       set_locales_to_ignore(configuration)
       set_locales_needed(configuration)
       set_files(project_info['project'])
@@ -53,7 +51,7 @@ module WebTranslateIt
       WebTranslateIt::Connection.turn_silent_on if configuration['silence_errors']
       self.project_name = project_info['project']['name']
     end
-    
+
     # Set the project locales from the Project API.
     # Implementation example:
     #
@@ -61,40 +59,47 @@ module WebTranslateIt
     #   locales = configuration.locales # returns an array of locales: ['en', 'fr', 'es', ...]
     def set_locales(project)
       self.source_locale  = project['source_locale']['code']
-      self.target_locales = project['target_locales'].map{|locale| locale['code']}
+      self.target_locales = project['target_locales'].map { |locale| locale['code'] }
     end
-    
+
     # Set the project files from the Project API.
     # Implementation example:
     #
     #   configuration = WebTranslateIt::Configuration.new
     #   files = configuration.files # returns an array of TranslationFile
-    def set_files(project)
+    def set_files(project) # rubocop:todo Metrics/AbcSize
       self.files = []
       project['project_files'].each do |project_file|
         if project_file['name'].nil? or project_file['name'].strip == ''
           puts "File #{project_file['id']} not set up"
+        elsif ignore_files&.any? { |glob| File.fnmatch(glob, project_file['name']) }
+          puts "Ignoring #{project_file['name']}"
         else
-          self.files.push TranslationFile.new(project_file['id'], project_file['name'], project_file['locale_code'], self.api_key, project_file['updated_at'], project_file['hash_file'], project_file['master_project_file_id'], project_file['fresh'])
+          files.push TranslationFile.new(project_file['id'], project_file['name'], project_file['locale_code'], api_key, project_file['updated_at'], project_file['hash_file'], project_file['master_project_file_id'], project_file['fresh'])
         end
       end
     end
-    
+
     # Set locales to ignore from the configuration file, if set.
     def set_locales_to_ignore(configuration)
-      self.ignore_locales = Array(configuration['ignore_locales']).map{ |locale| locale.to_s }
+      self.ignore_locales = Array(configuration['ignore_locales']).map(&:to_s)
     end
 
     # Set locales to specifically pull from the configuration file, if set
     def set_locales_needed(configuration)
-      self.needed_locales = Array(configuration['needed_locales']).map{ |locale| locale.to_s }
+      self.needed_locales = Array(configuration['needed_locales']).map(&:to_s)
+    end
+
+    # Set files to ignore from the configuration file, if set.
+    def set_ignore_files(configuration)
+      self.ignore_files = Array(configuration['ignore_files']).map(&:to_s)
     end
-    
+
     # Convenience method which returns the endpoint for fetching a list of locales for a project.
     def api_url
       "/api/projects/#{api_key}.yaml"
     end
-        
+
     # Returns a logger. If RAILS_DEFAULT_LOGGER is defined, use it, else, define a new logger.
     def logger
       if defined?(Rails.logger)
@@ -111,7 +116,7 @@ module WebTranslateIt
     private
 
     def parse_erb_in_configuration
-      ERB.new(File.read(File.expand_path(path_to_config_file, self.path))).result
+      ERB.new(File.read(File.expand_path(path_to_config_file, path))).result
     end
   end
 end

data/lib/web_translate_it/connection.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module WebTranslateIt
   class Connection
     require 'net/http'
@@ -6,12 +5,12 @@ module WebTranslateIt
     require 'openssl'
     require 'uri'
     require 'ostruct'
-    
+
     @@api_key = nil
     @@http_connection = nil
     @@debug = false
     @@silent = false
-    
+
     #
     # Initialize and yield a HTTPS Keep-Alive connection to WebTranslateIt.com
     #
@@ -27,7 +26,7 @@ module WebTranslateIt
     #   http_connection.request(request)
     # end
     #
-    def initialize(api_key)
+    def initialize(api_key) # rubocop:todo Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength
       @@api_key = api_key
       proxy = ENV['http_proxy'] ? URI.parse(ENV['http_proxy']) : OpenStruct.new
       http = Net::HTTP::Proxy(proxy.host, proxy.port, proxy.user, proxy.password).new('webtranslateit.com', 443)
@@ -39,7 +38,7 @@ module WebTranslateIt
         @@http_connection = http.start
         yield @@http_connection if block_given?
       rescue OpenSSL::SSL::SSLError
-        puts "Unable to verify SSL certificate." unless @@silent
+        puts 'Unable to verify SSL certificate.' unless @@silent
         http = Net::HTTP::Proxy(proxy.host, proxy.port, proxy.user, proxy.password).new('webtranslateit.com', 443)
         http.set_debug_output($stderr) if @@debug
         http.use_ssl      = true
@@ -51,7 +50,7 @@ module WebTranslateIt
         puts $!
       end
     end
-    
+
     def self.http_connection
       @@http_connection
     end
@@ -59,11 +58,11 @@ module WebTranslateIt
     def self.turn_debug_on
       @@debug = true
     end
-    
+
     def self.turn_silent_on
       @@silent = true
     end
-    
+
     def self.api_key
       @@api_key
     end

data/lib/web_translate_it/project.rb

@@ -1,8 +1,6 @@
-# encoding: utf-8
 module WebTranslateIt
   class Project
-    
-    def self.fetch_info(api_key)
+    def self.fetch_info(api_key) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
       success = true
       tries ||= 3
       begin
@@ -10,16 +8,14 @@ module WebTranslateIt
           request = Net::HTTP::Get.new("/api/projects/#{api_key}.yaml")
           WebTranslateIt::Util.add_fields(request)
           response = http.request(request)
-          if response.is_a?(Net::HTTPSuccess)
-            return response.body
-          else
-            puts "An error occured while fetching the project information:"
-            puts StringUtil.failure(response.body)
-            exit 1
-          end
+          return response.body if response.is_a?(Net::HTTPSuccess)
+
+          puts 'An error occured while fetching the project information:'
+          puts StringUtil.failure(response.body)
+          exit 1
         end
       rescue Timeout::Error
-        puts "Request timeout. Will retry in 5 seconds."
+        puts 'Request timeout. Will retry in 5 seconds.'
         if (tries -= 1) > 0
           sleep(5)
           retry
@@ -31,8 +27,8 @@ module WebTranslateIt
       end
       success
     end
-    
-    def self.fetch_stats(api_key)
+
+    def self.fetch_stats(api_key) # rubocop:todo Metrics/MethodLength
       success = true
       tries ||= 3
       begin
@@ -42,7 +38,7 @@ module WebTranslateIt
           return Util.handle_response(http.request(request), true)
         end
       rescue Timeout::Error
-        puts "Request timeout. Will retry in 5 seconds."
+        puts 'Request timeout. Will retry in 5 seconds.'
         if (tries -= 1) > 0
           sleep(5)
           retry
@@ -52,8 +48,8 @@ module WebTranslateIt
       end
       success
     end
-    
-    def self.create_locale(locale_code)
+
+    def self.create_locale(locale_code) # rubocop:todo Metrics/MethodLength
       success = true
       tries ||= 3
       begin
@@ -62,7 +58,7 @@ module WebTranslateIt
         request.set_form_data({ 'id' => locale_code }, ';')
         Util.handle_response(Connection.http_connection.request(request), true)
       rescue Timeout::Error
-        puts "Request timeout. Will retry in 5 seconds."
+        puts 'Request timeout. Will retry in 5 seconds.'
         if (tries -= 1) > 0
           sleep(5)
           retry
@@ -72,8 +68,8 @@ module WebTranslateIt
       end
       success
     end
-    
-    def self.delete_locale(locale_code)
+
+    def self.delete_locale(locale_code) # rubocop:todo Metrics/MethodLength
       success = true
       tries ||= 3
       begin
@@ -81,7 +77,7 @@ module WebTranslateIt
         WebTranslateIt::Util.add_fields(request)
         Util.handle_response(Connection.http_connection.request(request), true)
       rescue Timeout::Error
-        puts "Request timeout. Will retry in 5 seconds."
+        puts 'Request timeout. Will retry in 5 seconds.'
         if (tries -= 1) > 0
           sleep(5)
           retry

data/lib/web_translate_it/string.rb

@@ -1,11 +1,10 @@
-# encoding: utf-8
 module WebTranslateIt
-  class String
+  class String # rubocop:todo Metrics/ClassLength
     require 'multi_json'
-    
+
     attr_accessor :id, :key, :plural, :type, :dev_comment, :word_count, :status, :category, :labels, :file,
                   :created_at, :updated_at, :translations, :new_record
-    
+
     # Initialize a new WebTranslateIt::String
     #
     # Implementation Example:
@@ -19,25 +18,25 @@ module WebTranslateIt
     #   WebTranslateIt::String.new({ :key => "product_name_123", :translations => [translation_en, translation_fr]})
     #
     # to instantiate a new String with a source and target translation.
-    
-    def initialize(params = {})
+
+    def initialize(params = {}) # rubocop:todo Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
       params.stringify_keys!
-      self.id           = params["id"] || nil
-      self.key          = params["key"] || nil
-      self.plural       = params["plural"] || nil
-      self.type         = params["type"] || nil
-      self.dev_comment  = params["dev_comment"] || nil
-      self.word_count   = params["word_count"] || nil
-      self.status       = params["status"] || nil
-      self.category     = params["category"] || nil
-      self.labels       = params["labels"] || nil
-      self.file         = params["file"] || nil
-      self.created_at   = params["created_at"] || nil
-      self.updated_at   = params["updated_at"] || nil
-      self.translations = params["translations"] || []
+      self.id           = params['id'] || nil
+      self.key          = params['key'] || nil
+      self.plural       = params['plural'] || nil
+      self.type         = params['type'] || nil
+      self.dev_comment  = params['dev_comment'] || nil
+      self.word_count   = params['word_count'] || nil
+      self.status       = params['status'] || nil
+      self.category     = params['category'] || nil
+      self.labels       = params['labels'] || nil
+      self.file         = params['file'] || nil
+      self.created_at   = params['created_at'] || nil
+      self.updated_at   = params['updated_at'] || nil
+      self.translations = params['translations'] || []
       self.new_record   = true
     end
-    
+
     # Find a String based on filters
     #
     # Implementation Example:
@@ -49,27 +48,27 @@ module WebTranslateIt
     #   puts strings.inspect #=> An array of WebTranslateIt::String objects
     #
     # to find and instantiate an array of String which key is like `product_name_123`.
-    
-    def self.find_all(params = {})
+
+    def self.find_all(params = {}) # rubocop:todo Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
       success = true
       tries ||= 3
       params.stringify_keys!
       url = "/api/projects/#{Connection.api_key}/strings.yaml"
-      url += '?' + HashUtil.to_params("filters" => params) unless params.empty?
+      url += "?#{HashUtil.to_params('filters' => params)}" unless params.empty?
 
       request = Net::HTTP::Get.new(url)
       WebTranslateIt::Util.add_fields(request)
       begin
         strings = []
-        while(request) do
+        while request
           response = Connection.http_connection.request(request)
           YAML.load(response.body).each do |string_response|
             string = WebTranslateIt::String.new(string_response)
             string.new_record = false
             strings.push(string)
           end
-          if response["Link"] && response["Link"].include?("rel=\"next\"")
-            url = response["Link"].match(/<(.*)>; rel="next"/)[1]
+          if response['Link']&.include?('rel="next"')
+            url = response['Link'].match(/<(.*)>; rel="next"/)[1]
             request = Net::HTTP::Get.new(url)
             WebTranslateIt::Util.add_fields(request)
           else
@@ -78,7 +77,7 @@ module WebTranslateIt
         end
         return strings
       rescue Timeout::Error
-        puts "Request timeout. Will retry in 5 seconds."
+        puts 'Request timeout. Will retry in 5 seconds.'
         if (tries -= 1) > 0
           sleep(5)
           retry
@@ -88,7 +87,7 @@ module WebTranslateIt
       end
       success
     end
-    
+
     # Find a String based on its ID
     # Return a String object, or nil if not found.
     #
@@ -102,8 +101,8 @@ module WebTranslateIt
     #
     # to find and instantiate the String which ID is `1234`.
     #
-    
-    def self.find(id)
+
+    def self.find(id) # rubocop:todo Metrics/MethodLength
       success = true
       tries ||= 3
       request = Net::HTTP::Get.new("/api/projects/#{Connection.api_key}/strings/#{id}.yaml")
@@ -111,11 +110,12 @@ module WebTranslateIt
       begin
         response = Connection.http_connection.request(request)
         return nil if response.code.to_i == 404
+
         string = WebTranslateIt::String.new(YAML.load(response.body))
         string.new_record = false
         return string
       rescue Timeout::Error
-        puts "Request timeout. Will retry in 5 seconds."
+        puts 'Request timeout. Will retry in 5 seconds.'
         if (tries -= 1) > 0
           sleep(5)
           retry
@@ -125,7 +125,7 @@ module WebTranslateIt
       end
       success
     end
-    
+
     # Update or create a String to WebTranslateIt.com
     #
     # Implementation Example:
@@ -136,11 +136,11 @@ module WebTranslateIt
     #     string.save
     #   end
     #
-    
+
     def save
-      self.new_record ? self.create : self.update
+      new_record ? create : update
     end
-    
+
     # Delete a String on WebTranslateIt.com
     #
     # Implementation Example:
@@ -150,16 +150,16 @@ module WebTranslateIt
     #     string.delete
     #   end
     #
-    
-    def delete
+
+    def delete # rubocop:todo Metrics/MethodLength
       success = true
       tries ||= 3
-      request = Net::HTTP::Delete.new("/api/projects/#{Connection.api_key}/strings/#{self.id}")
+      request = Net::HTTP::Delete.new("/api/projects/#{Connection.api_key}/strings/#{id}")
       WebTranslateIt::Util.add_fields(request)
       begin
         Util.handle_response(Connection.http_connection.request(request), true, true)
       rescue Timeout::Error
-        puts "Request timeout. Will retry in 5 seconds."
+        puts 'Request timeout. Will retry in 5 seconds.'
         if (tries -= 1) > 0
           sleep(5)
           retry
@@ -169,7 +169,7 @@ module WebTranslateIt
       end
       success
     end
-    
+
     # Gets a Translation for a String
     #
     # Implementation Example:
@@ -179,24 +179,25 @@ module WebTranslateIt
     #     puts string.translation_for("fr") #=> A Translation object
     #   end
     #
-    
-    def translation_for(locale)
+
+    def translation_for(locale) # rubocop:todo Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
       success = true
       tries ||= 3
-      translation = self.translations.detect{ |t| t.locale == locale }
+      translation = translations.detect { |t| t.locale == locale }
       return translation if translation
-      return nil if self.new_record
-      request = Net::HTTP::Get.new("/api/projects/#{Connection.api_key}/strings/#{self.id}/locales/#{locale}/translations.yaml")
+      return nil if new_record
+
+      request = Net::HTTP::Get.new("/api/projects/#{Connection.api_key}/strings/#{id}/locales/#{locale}/translations.yaml")
       WebTranslateIt::Util.add_fields(request)
       begin
         response = Util.handle_response(Connection.http_connection.request(request), true, true)
         hash = YAML.load(response)
         return nil if hash.empty?
+
         translation = WebTranslateIt::Translation.new(hash)
         return translation
-        
       rescue Timeout::Error
-        puts "Request timeout. Will retry in 5 seconds."
+        puts 'Request timeout. Will retry in 5 seconds.'
         if (tries -= 1) > 0
           sleep(5)
           retry
@@ -206,28 +207,28 @@ module WebTranslateIt
       end
       success
     end
-    
+
     protected
-    
+
     # Save the changes made to a String to WebTranslateIt.com
     #
-    
-    def update
+
+    def update # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
       success = true
       tries ||= 3
-      request = Net::HTTP::Put.new("/api/projects/#{Connection.api_key}/strings/#{self.id}.yaml")
+      request = Net::HTTP::Put.new("/api/projects/#{Connection.api_key}/strings/#{id}.yaml")
       WebTranslateIt::Util.add_fields(request)
-      request.body = self.to_json
-      
-      self.translations.each do |translation|
-        translation.string_id = self.id
+      request.body = to_json
+
+      translations.each do |translation|
+        translation.string_id = id
         translation.save
       end
-      
+
       begin
         Util.handle_response(Connection.http_connection.request(request), true, true)
       rescue Timeout::Error
-        puts "Request timeout. Will retry in 5 seconds."
+        puts 'Request timeout. Will retry in 5 seconds.'
         if (tries -= 1) > 0
           sleep(5)
           retry
@@ -237,23 +238,23 @@ module WebTranslateIt
       end
       success
     end
-    
+
     # Create a new String to WebTranslateIt.com
     #
-    
-    def create
+
+    def create # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
       success = true
       tries ||= 3
       request = Net::HTTP::Post.new("/api/projects/#{Connection.api_key}/strings")
       WebTranslateIt::Util.add_fields(request)
-      request.body = self.to_json(true)
+      request.body = to_json(true)
       begin
         response = YAML.load(Util.handle_response(Connection.http_connection.request(request), true, true))
-        self.id = response["id"]
+        self.id = response['id']
         self.new_record = false
         return true
       rescue Timeout::Error
-        puts "Request timeout. Will retry in 5 seconds."
+        puts 'Request timeout. Will retry in 5 seconds.'
         if (tries -= 1) > 0
           sleep(5)
           retry
@@ -263,23 +264,23 @@ module WebTranslateIt
       end
       success
     end
-    
-    def to_json(with_translations = false)
+
+    def to_json(with_translations = false) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
       hash = {
-        "id" => id,
-        "key" => key,
-        "plural" => plural,
-        "type" => type,
-        "dev_comment" => dev_comment,
-        "status" => status,
-        "labels" => labels,
-        "category" => category,
-        "file" => file
+        'id' => id,
+        'key' => key,
+        'plural' => plural,
+        'type' => type,
+        'dev_comment' => dev_comment,
+        'status' => status,
+        'labels' => labels,
+        'category' => category,
+        'file' => file
       }
-      if self.translations.any? && with_translations
-        hash.update({ "translations" => [] })
+      if translations.any? && with_translations
+        hash.update({ 'translations' => [] })
         translations.each do |translation|
-          hash["translations"].push(translation.to_hash)
+          hash['translations'].push(translation.to_hash)
         end
       end
       MultiJson.dump(hash)