web_translate_it 2.5.3 → 2.6.1

data/lib/web_translate_it/command_line.rb

@@ -1,213 +1,260 @@
-# encoding: utf-8
 module WebTranslateIt
-  class CommandLine
+  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)
+    def initialize(command, command_options, global_options, parameters, project_path) # rubocop:todo Metrics/CyclomaticComplexity, Metrics/MethodLength
       self.command_options = command_options
       self.parameters = parameters
       unless command == 'init'
-        case command
-        when 'pull'
-          message = "Pulling files"
-        when 'push'
-          message = "Pushing files"
-        when 'add'
-          message = "Creating master files"
-        when 'rm'
-          message = "Deleting files"
-        when 'mv'
-          message = "Moving files"
-        when 'addlocale'
-          message = "Adding locale"
-        when 'rmlocale'
-          message = "Deleting locale"
-        else
-          message = "Gathering information"
+        message = case command
+                  when 'pull'
+                    'Pulling files'
+                  when 'push'
+                    'Pushing files'
+                  when 'add'
+                    'Creating master files'
+                  when 'rm'
+                    'Deleting files'
+                  when 'mv'
+                    'Moving files'
+                  when 'addlocale'
+                    'Adding locale'
+                  when 'rmlocale'
+                    'Deleting locale'
+                  else
+                    'Gathering information'
+                  end
+        throb do
+          print "  #{message}"
+          self.configuration = WebTranslateIt::Configuration.new(project_path, configuration_file_path)
+          print " #{message} on #{configuration.project_name}"
         end
-        throb { print "  #{message}"; self.configuration = WebTranslateIt::Configuration.new(project_path, configuration_file_path); print " #{message} on #{self.configuration.project_name}"; }
       end
-      success = self.send(command)
-      exit 1 if !success
+      success = send(command)
+      exit 1 unless success
     end
-    
-    def pull
+
+    def pull # rubocop:todo Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
       complete_success = true
-      STDOUT.sync = true
-      `#{configuration.before_pull}` if configuration.before_pull
+      $stdout.sync = true
+      before_pull_hook
       # Selecting files to pull
       files = []
       fetch_locales_to_pull.each do |locale|
-        files |= configuration.files.find_all{ |file| file.locale == locale }
+        files |= configuration.files.find_all { |file| file.locale == locale }
       end
       found_files = []
       parameters.each do |parameter|
-        found_files += files.find_all{ |file| File.fnmatch(parameter, file.file_path) }
+        found_files += files.find_all { |file| File.fnmatch(parameter, file.file_path) }
       end
       files = found_files if parameters.any?
-      files = files.uniq.sort{ |a,b| a.file_path <=> b.file_path }
-      if files.size == 0
-        puts "No files to pull."
+      files = files.uniq.sort { |a, b| a.file_path <=> b.file_path }
+      if files.empty?
+        puts 'No files to pull.'
       else
         # Now actually pulling files
         time = Time.now
         threads = []
-        n_threads = (files.size.to_f/3).ceil >= 10 ? 10 : (files.size.to_f/3).ceil
+        n_threads = (files.size.to_f / 3).ceil >= 10 ? 10 : (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|
-              WebTranslateIt::Connection.new(configuration.api_key) do |http|
-                file_array.each do |file|
-                  success = file.fetch(http, command_options.force)
-                  complete_success = false if !success
-                end
+          next if file_array.empty?
+
+          threads << Thread.new(file_array) do |f_array|
+            WebTranslateIt::Connection.new(configuration.api_key) do |http|
+              f_array.each do |file|
+                success = file.fetch(http, command_options.force)
+                complete_success = false unless success
               end
             end
           end
         end
-        threads.each { |thread| thread.join }
+        threads.each(&:join)
         time = Time.now - time
-        puts "Pulled #{files.size} files at #{(files.size/time).round} files/sec, using #{n_threads} threads."
-        `#{configuration.after_pull}` if configuration.after_pull
+        puts "Pulled #{files.size} files at #{(files.size / time).round} files/sec, using #{n_threads} threads."
+        after_pull_hook
         complete_success
       end
     end
-    
-    def push
+
+    def before_pull_hook
+      return unless configuration.before_pull
+
+      output = `#{configuration.before_pull}`
+      if $CHILD_STATUS.success?
+        puts output
+      else
+        abort "Error: before_pull command exited with: #{output}"
+      end
+    end
+
+    def after_pull_hook
+      return unless configuration.after_pull
+
+      output = `#{configuration.after_pull}`
+      if $CHILD_STATUS.success?
+        puts output
+      else
+        abort "Error: after_pull command exited with: #{output}"
+      end
+    end
+
+    def push # rubocop:todo Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
       complete_success = true
-      STDOUT.sync = true
-      `#{configuration.before_push}` if configuration.before_push
+      $stdout.sync = true
+      before_push_hook
       WebTranslateIt::Connection.new(configuration.api_key) do |http|
         fetch_locales_to_push(configuration).each do |locale|
-          if parameters.any?
-            files = configuration.files.find_all{ |file| parameters.include?(file.file_path) }.sort{|a,b| a.file_path <=> b.file_path}
-          else
-            files = configuration.files.find_all{ |file| file.locale == locale }.sort{|a,b| a.file_path <=> b.file_path}
-          end
-          if files.size == 0
+          files = if parameters.any?
+                    configuration.files.find_all { |file| parameters.include?(file.file_path) }.sort { |a, b| a.file_path <=> b.file_path }
+                  else
+                    configuration.files.find_all { |file| file.locale == locale }.sort { |a, b| a.file_path <=> b.file_path }
+                  end
+          if files.empty?
             puts "Couldn't find any local files registered on WebTranslateIt to push."
           else
             files.each do |file|
               success = file.upload(http, command_options[:merge], command_options.ignore_missing, command_options.label, command_options.low_priority, command_options[:minor], command_options.force)
-              complete_success = false if !success
+              complete_success = false unless success
             end
           end
         end
       end
-      `#{configuration.after_push}` if configuration.after_push
+      after_push_hook
       complete_success
     end
-    
-    def add
+
+    def before_push_hook
+      return unless configuration.before_push
+
+      output = `#{configuration.before_push}`
+      if $CHILD_STATUS.success?
+        puts output
+      else
+        abort "Error: before_push command exited with: #{output}"
+      end
+    end
+
+    def after_push_hook
+      return unless configuration.after_push
+
+      output = `#{configuration.after_push}`
+      if $CHILD_STATUS.success?
+        puts output
+      else
+        abort "Error: after_push command exited with: #{output}"
+      end
+    end
+
+    def add # rubocop:todo Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
       complete_success = true
-      STDOUT.sync = true
+      $stdout.sync = true
       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 ..."
+        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 ...'
         exit
       end
       WebTranslateIt::Connection.new(configuration.api_key) do |http|
-	      added = configuration.files.find_all{ |file| file.locale == configuration.source_locale}.collect {|file| File.expand_path(file.file_path) }.to_set
-        to_add = parameters.reject{ |param| added.include?(File.expand_path(param))}
+        added = configuration.files.find_all { |file| file.locale == configuration.source_locale }.collect { |file| File.expand_path(file.file_path) }.to_set
+        to_add = parameters.reject { |param| added.include?(File.expand_path(param)) }
         if to_add.any?
           to_add.each do |param|
-            file = TranslationFile.new(nil, param.gsub(/ /, "\\ "), nil, configuration.api_key)
+            file = TranslationFile.new(nil, param.gsub(/ /, '\\ '), nil, configuration.api_key)
             success = file.create(http, command_options.low_priority)
-            complete_success = false if !success
+            complete_success = false unless success
           end
         else
-          puts "No new master file to add."
+          puts 'No new master file to add.'
         end
       end
       complete_success
     end
 
-    def rm
+    def rm # rubocop:todo Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
       complete_success = true
-      STDOUT.sync = true
+      $stdout.sync = true
       if parameters == []
-        puts StringUtil.failure("Error: You must provide the path to the master file to remove.")
-        puts "Usage: wti rm path/to/master_file_1 path/to/master_file_2 ..."
+        puts StringUtil.failure('Error: You must provide the path to the master file to remove.')
+        puts 'Usage: wti rm path/to/master_file_1 path/to/master_file_2 ...'
         exit
       end
-      WebTranslateIt::Connection.new(configuration.api_key) do |http|
+      WebTranslateIt::Connection.new(configuration.api_key) do |http| # rubocop:todo Metrics/BlockLength
         parameters.each do |param|
-          if Util.ask_yes_no("Are you sure you want to delete the master file #{param}?\nThis will also delete its target files and translations.", false)
-            files = configuration.files.find_all{ |file| file.file_path == param }
-            if files.any?
-              files.each do |master_file|
-                master_file.delete(http)
-                # delete files
-                if File.exists?(master_file.file_path)
-                  success = File.delete(master_file.file_path)
-                  puts StringUtil.success("Deleted master file #{master_file.file_path}.") if success
-                end
-                complete_success = false if !success
-                configuration.files.find_all{ |file| file.master_id == master_file.id }.each do |target_file|
-                  if File.exists?(target_file.file_path)
-                    success = File.delete(target_file.file_path)
-                    puts StringUtil.success("Deleted target file #{target_file.file_path}.") if success
-                  else
-                    puts StringUtil.failure("Target file #{target_file.file_path} doesn’t exist locally")
-                  end
-                  complete_success = false if !success
+          next unless Util.ask_yes_no("Are you sure you want to delete the master file #{param}?\nThis will also delete its target files and translations.", false)
+
+          files = configuration.files.find_all { |file| file.file_path == param }
+          if files.any?
+            files.each do |master_file|
+              master_file.delete(http)
+              # delete files
+              if File.exist?(master_file.file_path)
+                success = File.delete(master_file.file_path)
+                puts StringUtil.success("Deleted master file #{master_file.file_path}.") if success
+              end
+              complete_success = false unless success
+              configuration.files.find_all { |file| file.master_id == master_file.id }.each do |target_file|
+                if File.exist?(target_file.file_path)
+                  success = File.delete(target_file.file_path)
+                  puts StringUtil.success("Deleted target file #{target_file.file_path}.") if success
+                else
+                  puts StringUtil.failure("Target file #{target_file.file_path} doesn’t exist locally")
                 end
+                complete_success = false unless success
               end
-              puts StringUtil.success("All done.") if complete_success
-            else
-              puts StringUtil.failure("#{param}: File doesn’t exist on project.")
             end
+            puts StringUtil.success('All done.') if complete_success
+          else
+            puts StringUtil.failure("#{param}: File doesn’t exist on project.")
           end
         end
       end
       complete_success
     end
-    
-    def mv
+
+    def mv # rubocop:todo Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
       complete_success = true
-      STDOUT.sync = true
+      $stdout.sync = true
       if parameters.count != 2
-        puts StringUtil.failure("Error: You must provide the source path and destination path of the master file to move.")
-        puts "Usage: wti mv path/to/master_file_old_path path/to/master_file_new_path ..."
+        puts StringUtil.failure('Error: You must provide the source path and destination path of the master file to move.')
+        puts 'Usage: wti mv path/to/master_file_old_path path/to/master_file_new_path ...'
         exit
       end
       source = parameters[0]
       destination = parameters[1]
       WebTranslateIt::Connection.new(configuration.api_key) do |http|
         if Util.ask_yes_no("Are you sure you want to move the master file #{source} and its target files?", true)
-          configuration.files.find_all{ |file| file.file_path == source }.each do |master_file|
+          configuration.files.find_all { |file| file.file_path == source }.each do |master_file|
             master_file.upload(http, false, false, nil, false, false, true, true, destination)
             # move master file
-            if File.exists?(source)
-              success = File.rename(source, destination) if File.exists?(source)
+            if File.exist?(source)
+              success = File.rename(source, destination) if File.exist?(source)
               puts StringUtil.success("Moved master file #{master_file.file_path}.") if success
             end
-            complete_success = false if !success
-            configuration.files.find_all{ |file| file.master_id == master_file.id }.each do |target_file|
-              if File.exists?(target_file.file_path)
+            complete_success = false unless success
+            configuration.files.find_all { |file| file.master_id == master_file.id }.each do |target_file|
+              if File.exist?(target_file.file_path)
                 success = File.delete(target_file.file_path)
-                complete_success = false if !success
+                complete_success = false unless success
               end
             end
             configuration.reload
-            configuration.files.find_all{ |file| file.master_id == master_file.id }.each do |target_file|
+            configuration.files.find_all { |file| file.master_id == master_file.id }.each do |target_file|
               success = target_file.fetch(http)
-              complete_success = false if !success
+              complete_success = false unless success
             end
-            puts StringUtil.success("All done.") if complete_success
+            puts StringUtil.success('All done.') if complete_success
           end
         end
       end
       complete_success
     end
-    
-    def addlocale
-      STDOUT.sync = true
+
+    def addlocale # rubocop:todo Metrics/MethodLength
+      $stdout.sync = true
       if parameters == []
-        puts StringUtil.failure("Locale code missing.")
-        puts "Usage: wti addlocale fr es ..."
+        puts StringUtil.failure('Locale code missing.')
+        puts 'Usage: wti addlocale fr es ...'
         exit 1
       end
       parameters.each do |param|
@@ -215,94 +262,93 @@ module WebTranslateIt
         WebTranslateIt::Connection.new(configuration.api_key) do
           WebTranslateIt::Project.create_locale(param)
         end
-        puts "Done."
+        puts 'Done.'
       end
     end
-    
-    def rmlocale
-      STDOUT.sync = true
+
+    def rmlocale # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
+      $stdout.sync = true
       if parameters == []
-        puts StringUtil.failure("Error: You must provide the locale code to remove.")
-        puts "Usage: wti rmlocale fr es ..."
+        puts StringUtil.failure('Error: You must provide the locale code to remove.')
+        puts 'Usage: wti rmlocale fr es ...'
         exit 1
       end
       parameters.each do |param|
-        if Util.ask_yes_no("Are you certain you want to delete the locale #{param.upcase}?\nThis will also delete its files and translations.", false)
-          print StringUtil.success("Deleting locale #{param.upcase}... ")
-          WebTranslateIt::Connection.new(configuration.api_key) do |http|
-            WebTranslateIt::Project.delete_locale(param)
-          end
-          puts "Done."
+        next unless Util.ask_yes_no("Are you certain you want to delete the locale #{param.upcase}?\nThis will also delete its files and translations.", false)
+
+        print StringUtil.success("Deleting locale #{param.upcase}... ")
+        WebTranslateIt::Connection.new(configuration.api_key) do
+          WebTranslateIt::Project.delete_locale(param)
         end
+        puts 'Done.'
       end
     end
-        
-    def init
-      puts "# Initializing project"
+
+    def init # rubocop:todo Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
+      puts '# Initializing project'
       if parameters.any?
         api_key = parameters[0]
         path = '.wti'
       else
-        api_key = Util.ask(" Project API Key:")
-        path = Util.ask(" Path to configuration file:", '.wti')
+        api_key = Util.ask(' Project API Key:')
+        path = Util.ask(' Path to configuration file:', '.wti')
       end
-      FileUtils.mkpath(path.split('/')[0..path.split('/').size-2].join('/')) unless path.split('/').size == 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)
+      if File.exist?(path) && !File.writable?(path)
         puts StringUtil.failure("Error: `#{path}` file is not writable.")
         exit 1
       end
-      File.open(path, 'w'){ |file| file << generate_configuration(api_key, project_info) }
-      puts ""
+      File.open(path, 'w') { |file| file << generate_configuration(api_key, project_info) }
+      puts ''
       puts " The project #{project_info['name']} was successfully initialized."
-      puts ""
-      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 ""
+      puts ''
+      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 ''
       end
-      if project_info["source_locale"]["code"].nil?
+      if project_info['source_locale']['code'].nil?
         puts " *) You don't have a source locale setup."
-        puts "    Add the source locale with: `wti addlocale <locale_code>`"
-        puts ""
+        puts '    Add the source locale with: `wti addlocale <locale_code>`'
+        puts ''
       end
-      if project_info["target_locales"].size <= 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 ""
+        puts '    Add the first target locale with: `wti addlocale <locale_code>`'
+        puts ''
       end
-      if project_info["project_files"].none?
+      if project_info['project_files'].none?
         puts " *) You don't have linguistic files setup."
-        puts "    Add a master file with: `wti add <path/to/file.xml>`"
-        puts ""
+        puts '    Add a master file with: `wti add <path/to/file.xml>`'
+        puts ''
       end
-      puts "You can now use `wti` to push and pull your language files."
-      puts "Check `wti --help` for help."
-      return true
+      puts 'You can now use `wti` to push and pull your language files.'
+      puts 'Check `wti --help` for help.'
+      true
     end
-    
-    def match
-      configuration.files.find_all{ |mf| mf.locale == configuration.source_locale }.each do |master_file|
-        if !File.exists?(master_file.file_path)
-          puts StringUtil.failure(master_file.file_path) + " (#{master_file.locale})"
-        else
+
+    def match # rubocop:todo Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
+      configuration.files.find_all { |mf| mf.locale == configuration.source_locale }.each do |master_file|
+        if File.exist?(master_file.file_path)
           puts StringUtil.important(master_file.file_path) + " (#{master_file.locale})"
+        else
+          puts StringUtil.failure(master_file.file_path) + " (#{master_file.locale})"
         end
-        configuration.files.find_all{ |f| f.master_id == master_file.id }.each do |file|
-          if !File.exists?(file.file_path)
-            puts StringUtil.failure("- #{file.file_path}") + " (#{file.locale})"
-          else
+        configuration.files.find_all { |f| f.master_id == master_file.id }.each do |file|
+          if File.exist?(file.file_path)
             puts "- #{file.file_path}" + " (#{file.locale})"
+          else
+            puts StringUtil.failure("- #{file.file_path}") + " (#{file.locale})"
           end
         end
       end
-      return true
+      true
     end
-        
-    def status
+
+    def status # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
       stats = YAML.load(Project.fetch_stats(configuration.api_key))
-      stale = false
       completely_translated = true
       completely_proofread  = true
       stats.each do |locale, values|
@@ -312,32 +358,28 @@ module WebTranslateIt
         completely_proofread  = false if percent_completed  != 100
         puts "#{locale}: #{percent_translated}% translated, #{percent_completed}% completed."
       end
-      exit 100 if !completely_translated
-      exit 101 if !completely_proofread
-      return true
+      exit 100 unless completely_translated
+      exit 101 unless completely_proofread
+      true
     end
-                
-    def fetch_locales_to_pull
+
+    def fetch_locales_to_pull # rubocop:todo Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
       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
+      elsif configuration.needed_locales.any?
+        locales = configuration.needed_locales
       else
-        if configuration.needed_locales.any?
-          locales = configuration.needed_locales
-        else
-          locales = configuration.target_locales
-          if configuration.ignore_locales.any?
-            configuration.ignore_locales.each{ |locale_to_delete| locales.delete(locale_to_delete) }
-          end
-        end
+        locales = configuration.target_locales
+        configuration.ignore_locales.each { |locale_to_delete| locales.delete(locale_to_delete) } if configuration.ignore_locales.any?
       end
       locales.push(configuration.source_locale) if command_options.all
-      return locales.uniq
+      locales.uniq
     end
-        
-    def fetch_locales_to_push(configuration)
+
+    def fetch_locales_to_push(configuration) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
       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)
@@ -347,65 +389,57 @@ module WebTranslateIt
         locales = [configuration.source_locale]
       end
       if command_options.all
-        puts "`wti push --all` was deprecated in wti 2.3. Use `wti push --target` instead."
+        puts '`wti push --all` was deprecated in wti 2.3. Use `wti push --target` instead.'
         return []
       elsif command_options.target
-        locales = configuration.target_locales.reject{ |locale| locale == configuration.source_locale }
+        locales = configuration.target_locales.reject { |locale| locale == configuration.source_locale }
       end
-      return locales.uniq
+      locales.uniq
     end
-    
+
     def configuration_file_path
-      if self.command_options.config
-        return self.command_options.config
-      else
-        if File.exists?('config/translation.yml')
-          puts "Warning: `config/translation.yml` is deprecated in favour of a `.wti` file."
-          if Util.ask_yes_no("Would you like to migrate your configuration now?", true)
-            require 'fileutils'
-            if FileUtils.mv('config/translation.yml', '.wti')
-              return '.wti'
-            else
-              puts "Couldn’t move `config/translation.yml`."
-              return false
-            end
-          else
-            return 'config/translation.yml'
-          end
-        else
-          return '.wti'
-        end
-      end
+      return command_options.config if command_options.config
+
+      return '.wti' unless File.exist?('config/translation.yml')
+
+      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`.'
+      false
     end
-    
+
     def generate_configuration(api_key, project_info)
-      file = <<-FILE
-api_key: #{api_key}
+      <<~FILE
+        api_key: #{api_key}
 
-# Optional: locales not to sync with WebTranslateIt.
-# Takes a string, a symbol, or an array of string or symbol.
-# More information here: https://github.com/AtelierConvivialite/webtranslateit/wiki
-# ignore_locales: '#{project_info["source_locale"]["code"]}'
+        # Optional: locales not to sync with WebTranslateIt.
+        # Takes a string, a symbol, or an array of string or symbol.
+        # More information here: https://github.com/AtelierConvivialite/webtranslateit/wiki
+        # ignore_locales: '#{project_info['source_locale']['code']}'
 
-# Or if you prefer a list of locales to sync with WebTranslateIt:
-# needed_locales: #{project_info["target_locales"].map {|locale| locale["code"]}.to_s}
+        # Or if you prefer a list of locales to sync with WebTranslateIt:
+        # needed_locales: #{project_info['target_locales'].map { |locale| locale['code'] }}
 
-# Optional
-# before_pull: "echo 'some unix command'"   # Command executed before pulling files
-# after_pull:  "touch tmp/restart.txt"      # Command executed after pulling files
-#
-# before_push: "echo 'some unix command'"   # Command executed before pushing files
-# after_push:  "touch tmp/restart.txt"      # Command executed after pushing files
+        # Optional: files not to sync with WebTranslateIt.
+        # Takes an array of globs.
+        # ignore_files: ['somefile*.csv']
 
-# Silence SSL errors
-# silence_errors: true
+        # Optional
+        # before_pull: "echo 'some unix command'"   # Command executed before pulling files
+        # after_pull:  "touch tmp/restart.txt"      # Command executed after pulling files
+        #
+        # before_push: "echo 'some unix command'"   # Command executed before pushing files
+        # after_push:  "touch tmp/restart.txt"      # Command executed after pushing files
 
-FILE
-      return file
+      FILE
     end
 
-    def throb
-      throb = %w(⠋ ⠙ ⠹ ⠸ ⠼ ⠴ ⠦ ⠧ ⠇ ⠏)
+    def throb # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
+      throb = %w[⠋ ⠙ ⠹ ⠸ ⠼ ⠴ ⠦ ⠧ ⠇ ⠏]
       throb.reverse! if rand > 0.5
       i = rand throb.length
 
@@ -418,11 +452,11 @@ FILE
         dot.call
       end
       yield
-      ensure
-        if thread
-          thread.kill
-          puts "\r\e[0G#\e[?25h"
-        end
+    ensure
+      if thread
+        thread.kill
+        puts "\r\e[0G#\e[?25h"
       end
     end
+  end
 end