web_translate_it 2.7.0 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cef77421b30d347178a38e6fe50300e44d41a2c47fe46736ad79d76bc891374
-  data.tar.gz: e3d93cec2762262b06a8eb5aa2f71a901eb5ba77ff09b1e2f85462f765617501
+  metadata.gz: 269b89b988031ffdaa8bb761411e0e93f12be4e415b48c4b6877d104ee241f06
+  data.tar.gz: 51706b4f7ed1d249d67050f32fd81de7c6ede08cf763ab7faaa33b5619aa9c9e
 SHA512:
-  metadata.gz: 154b48ea91ca07bc107ff3b551678bf152a791db84432be020d1e3f3444c7f0830f303f5a222947fdbf1178638648df973f1c2ff8755c8db30e22c8916808c75
-  data.tar.gz: 1bbf7533a388aeec98f9d0541c1839d95d18ed99d0cf2ccb4bb6400cb0852ddd8d98d04e4d29315b55c05790e70095db5d5a418ac47a1b47234ca84da495cf5b
+  metadata.gz: d36a9194b73e6b9fe21c720874c2e86308944b909901cdcbb72e2dd7978dd05f42d40bfa2a0dfbdd11439781b0bed0b069a72b72eb4f7089fd42398e1151c7a3
+  data.tar.gz: aa9e14cace635cc65b209be7d3e25a969d303ee79b47f64aebfd2572ba47a3531190f70286ca046e90c6210f20ecd7bca45c8c41a47a390dfcb2fd937d1a36bb

data/history.md

@@ -1,3 +1,8 @@
+## Version 2.7.1 / 2022-10-14
+
+* Potential fix potential for issue `uninitialized constant WebTranslateIt::TranslationFile::Multipart`.
+* Code refactoring.
+
 ## Version 2.7.0 / 2022-10-10
 
 * New: Ability to see translation statistics per file.

data/lib/web_translate_it/command_line.rb

@@ -2,8 +2,6 @@ module WebTranslateIt
 
   class CommandLine # rubocop:todo Metrics/ClassLength
 
-    require 'fileutils'
-    require 'set'
     attr_accessor :configuration, :global_options, :command_options, :parameters
 
     def initialize(command, command_options, _global_options, parameters, project_path) # rubocop:todo Metrics/CyclomaticComplexity, Metrics/MethodLength
@@ -418,7 +416,6 @@ module WebTranslateIt
       puts 'Warning: `config/translation.yml` is deprecated in favour of a `.wti` file.'
       return 'config/translation.yml' unless Util.ask_yes_no('Would you like to migrate your configuration now?', true)
 
-      require 'fileutils'
       return '.wti' if FileUtils.mv('config/translation.yml', '.wti')
 
       puts 'Couldn’t move `config/translation.yml`.'

data/lib/web_translate_it/configuration.rb

@@ -8,9 +8,6 @@ module WebTranslateIt
   #
   class Configuration
 
-    require 'yaml'
-    require 'fileutils'
-    require 'erb'
     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.
@@ -30,10 +27,11 @@ module WebTranslateIt
         else
           YAML.load WebTranslateIt::Project.fetch_info(api_key)
         end
-        set_locales_to_ignore(configuration)
-        set_locales_needed(configuration)
-        set_files(project_info['project'])
-        set_locales(project_info['project'])
+        self.ignore_locales = locales_to_ignore(configuration)
+        self.needed_locales = locales_needed(configuration)
+        self.files = files_from_project(project_info['project'])
+        self.source_locale = source_locale_from_project(project_info['project'])
+        self.target_locales = target_locales_from_project(project_info['project'])
         self.project_name = project_info['project']['name']
       else
         puts StringUtil.failure("\nNo configuration file found in #{File.expand_path(path_to_config_file, path)}")
@@ -43,23 +41,24 @@ module WebTranslateIt
 
     # Reload project data
     #
-    def reload
+    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'])
-      set_locales(project_info['project'])
+      self.ignore_locales = locales_to_ignore(configuration)
+      self.needed_locales = locales_needed(configuration)
+      self.files = files_from_project(project_info['project'])
+      self.source_locale = source_locale_from_project(project_info['project'])
+      self.target_locales = target_locales_from_project(project_info['project'])
       self.project_name = project_info['project']['name']
     end
 
-    # Set the project locales from the Project API.
-    # Implementation example:
-    #
-    #   configuration = WebTranslateIt::Configuration.new
-    #   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'] }
+    # Returns the source locale from the Project API.
+    def source_locale_from_project(project)
+      project['source_locale']['code']
+    end
+
+    # Returns the target locales from the Project API.
+    def target_locales_from_project(project)
+      project['target_locales'].map { |locale| locale['code'] }
     end
 
     # Set the project files from the Project API.
@@ -67,33 +66,34 @@ module WebTranslateIt
     #
     #   configuration = WebTranslateIt::Configuration.new
     #   files = configuration.files # returns an array of TranslationFile
-    def set_files(project) # rubocop:todo Metrics/AbcSize
-      self.files = []
+    def files_from_project(project) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
+      array_files = []
       project['project_files'].each do |project_file|
         if project_file['name'].nil? || (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
-          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'])
+          array_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
+      array_files
     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(&:to_s)
+    # Returns an array of locales to ignore from the configuration file, if set.
+    def locales_to_ignore(configuration)
+      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(&:to_s)
+    # Returns an array of locales to specifically pull from the configuration file, if set
+    def locales_needed(configuration)
+      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
+    # # Set files to ignore from the configuration file, if set.
+    # def ignore_files(configuration)
+    #   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

data/lib/web_translate_it/connection.rb

@@ -1,15 +1,9 @@
-require 'English'
 module WebTranslateIt
 
   class Connection
 
     attr_reader :api_key, :http_connection
 
-    require 'net/http'
-    require 'net/https'
-    require 'openssl'
-    require 'uri'
-
     @api_key = nil
     @http_connection = nil
     @debug = false
@@ -49,7 +43,7 @@ module WebTranslateIt
         http.verify_mode = OpenSSL::SSL::VERIFY_NONE
         @http_connection = http.start
         yield @http_connection if block_given?
-      rescue
+      rescue StandardError
         puts $ERROR_INFO
       end
     end

data/lib/web_translate_it/project.rb

@@ -1,4 +1,3 @@
-require 'English'
 module WebTranslateIt
 
   class Project
@@ -25,7 +24,7 @@ module WebTranslateIt
         else
           success = false
         end
-      rescue
+      rescue StandardError
         puts $ERROR_INFO.inspect
       end
       success

data/lib/web_translate_it/string.rb

@@ -2,8 +2,6 @@ module WebTranslateIt
 
   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
 

data/lib/web_translate_it/term.rb

@@ -2,9 +2,6 @@ module WebTranslateIt
 
   class Term # rubocop:todo Metrics/ClassLength
 
-    require 'net/https'
-    require 'multi_json'
-
     attr_accessor :id, :text, :description, :created_at, :updated_at, :translations, :new_record
 
     # Initialize a new WebTranslateIt::Term

data/lib/web_translate_it/term_translation.rb

@@ -2,9 +2,6 @@ module WebTranslateIt
 
   class TermTranslation
 
-    require 'net/https'
-    require 'multi_json'
-
     attr_accessor :id, :locale, :text, :description, :status, :new_record, :term_id
 
     # Initialize a new WebTranslateIt::TermTranslation

data/lib/web_translate_it/translation.rb

@@ -2,9 +2,6 @@ module WebTranslateIt
 
   class Translation
 
-    require 'net/https'
-    require 'multi_json'
-
     attr_accessor :id, :locale, :text, :status, :created_at, :updated_at, :version, :string_id
 
     # Initialize a new WebTranslateIt::Translation

data/lib/web_translate_it/translation_file.rb

@@ -8,11 +8,6 @@ module WebTranslateIt
   # manipulate a _target_ language file.
   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) # rubocop:todo Metrics/ParameterLists
@@ -65,7 +60,7 @@ module WebTranslateIt
             else
               success = false
             end
-          rescue
+          rescue StandardError
             display.push StringUtil.failure("An error occured: #{$ERROR_INFO}")
             success = false
           end
@@ -115,7 +110,7 @@ module WebTranslateIt
             else
               success = false
             end
-          rescue
+          rescue StandardError
             display.push StringUtil.failure("An error occured: #{$ERROR_INFO}")
             success = false
           end
@@ -164,7 +159,7 @@ module WebTranslateIt
           else
             success = false
           end
-        rescue
+        rescue StandardError
           display.push StringUtil.failure("An error occured: #{$ERROR_INFO}")
           success = false
         end
@@ -195,7 +190,7 @@ module WebTranslateIt
           else
             success = false
           end
-        rescue
+        rescue StandardError
           display.push StringUtil.failure("An error occured: #{$ERROR_INFO}")
           success = false
         end
@@ -234,12 +229,9 @@ module WebTranslateIt
     end
 
     def local_checksum
-      require 'digest/sha1'
-      begin
-        Digest::SHA1.hexdigest(File.read(file_path))
-      rescue
-        ''
-      end
+      Digest::SHA1.hexdigest(File.read(file_path))
+    rescue StandardError
+      ''
     end
 
   end

data/lib/web_translate_it/util.rb

@@ -3,8 +3,6 @@ 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

data/lib/web_translate_it.rb

@@ -1,3 +1,15 @@
+require 'fileutils'
+require 'yaml'
+require 'erb'
+require 'net/http'
+require 'net/https'
+require 'net/http/post/multipart'
+require 'openssl'
+require 'uri'
+require 'multi_json'
+require 'digest/sha1'
+require 'English'
+
 require 'web_translate_it/connection'
 require 'web_translate_it/util'
 require 'web_translate_it/util/array_util'
@@ -13,8 +25,6 @@ require 'web_translate_it/auto_fetch'
 require 'web_translate_it/command_line'
 require 'web_translate_it/project'
 
-require 'English'
-
 module WebTranslateIt
 
   def self.fetch_translations # rubocop:todo Metrics/AbcSize

data/readme.md

@@ -187,7 +187,11 @@ Append `--help` for each command for more information. For instance:
   </tr>
   <tr>
     <td>wti status</td>
-    <td>View project statistics</td>
+    <td>View project translation statistics</td>
+  </tr>
+  <tr>
+    <td>wti status config/locales/app/en.yml</td>
+    <td>View translation statistics on file config/locales/app/en.yml</td>
   </tr>
   <tr>
     <td>wti match</td>
@@ -210,7 +214,7 @@ Check the [sample `.wti`](https://github.com/webtranslateit/webtranslateit/blob/
 
 ## Exit codes
 
-Since version 1.4.0 `wti` returns exit codes on failure. The exit code is `0` if the command executed successfully and `1` if the command executed but encountered at least one error. This is useful to act upon errors if you use `wti` to pull files in an automated build process.
+`wti` returns exit codes on failure. The exit code is `0` if the command executed successfully and `1` if the command executed but encountered at least one error. This is useful to act upon errors if you use `wti` to pull files in an automated build process.
 
 ``` zsh
 ~/code/webtranslateit.com[master]% wti pull
@@ -239,7 +243,7 @@ Pulled 3 files at 3 files/sec, using 3 threads.
 1
 ```
 
-Since version 2.4.1 the `wti status` command also returns meaningful codes. It will exit with `0` if the project is 100% translated and proofread, `100` if the project is not 100% translated and `101` if the project is not 100% proofread. This could allow you to check if a project is 100% translated or completed before deploying a project.
+`wti status` command also returns meaningful codes. It will exit with `0` if the project is 100% translated and proofread, `100` if the project is not 100% translated and `101` if the project is not 100% proofread. This could allow you to check if a project is 100% translated or completed before deploying a project.
 
 ``` zsh
 ~/Desktop/test% wti status

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: web_translate_it
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.7.1
 platform: ruby
 authors:
 - Edouard Briere
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-10 00:00:00.000000000 Z
+date: 2022-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json