web_translate_it 2.5.4 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc4a1374f3018354d15fea035305984fa839a6786526cc88e8d3151f176d8f79
-  data.tar.gz: fbc8868713a8d691169eea12318bb0c288853c25cedf24ddaaac10b44b461d09
+  metadata.gz: fe142160ce726176d6463e38dff4cbabe3c65a2629e537afd070aa9a273e44c2
+  data.tar.gz: 447cc0c48efca6fbf66588f4426c1583f6945f59118593b5d8be5a7c81db40a4
 SHA512:
-  metadata.gz: c8ec5eae4ac2941ca048cc798fb4ae5cb5c539345d11286d9aa35a68dca5e35cc3e138cbcb95c0ebf5d8adaffda69938cf41613762612a9ba33836e6f95f2871
-  data.tar.gz: 20af38470f30300f01d260e17d15d16ef90597b72d5e1e5f5d9869cf70a192c65d84f3dc9771ada30264f65c75ebfb0855da9b9f0e94e966cfc908cc872b3eda
+  metadata.gz: 11cc21a06894851d8ead43d573ef69c197e0132f1b38b0c65b27c29541ce5409e0a076147f323f61d1fc1e8f0d89f91050d4011e421e5907e5d7d493a4939806
+  data.tar.gz: 9b8bad87f54a5ff65265b34e71523fbd3bb6aca4f95293d8c59bb970d8bc6de7fae9ea7d2cf3078a0004ffdd4720c03bc0f9ca59a3198390585698a73b6f08bb

data/bin/wti

@@ -5,28 +5,28 @@ $PROGRAM_NAME = 'wti'
 require 'optimist'
 require 'web_translate_it'
 
-show_commands = <<-EOS
-Usage: wti <command> [options]+ <filename>
+show_commands = <<~COMMANDS
+  Usage: wti <command> [options]+ <filename>
 
-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
-   add         Create and push a new master language file
-   rm          Delete a master language file from a project
-   mv          Moves a file both locally and from a project
-   addlocale   Add a new locale to the project
-   rmlocale    Delete a locale from a project
-   status      Fetch and display project statistics
-   init        Configure your project to sync
+  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
+     add         Create and push a new master language file
+     rm          Delete a master language file from a project
+     mv          Moves a file both locally and from a project
+     addlocale   Add a new locale to the project
+     rmlocale    Delete a locale from a project
+     status      Fetch and display project statistics
+     init        Configure your project to sync
 
-See `wti <command> --help` for more information on a specific command.
+  See `wti <command> --help` for more information on a specific command.
 
-[options] are:
-EOS
+  [options] are:
+COMMANDS
 
-SUB_COMMANDS = %w(pull push match add rm mv addlocale rmlocale status st init)
-global_options = Optimist::options do
+SUB_COMMANDS = %w[pull push match add rm mv addlocale rmlocale status st init].freeze
+global_options = Optimist.options do
   stop_on SUB_COMMANDS
   banner show_commands
   version "wti version #{WebTranslateIt::Util.version}"
@@ -34,98 +34,98 @@ end
 
 command = ARGV.shift # get the subcommand
 command_options = case command
-  when "pull"
-    Optimist::options do
-      banner <<-EOS
-wti pull [filename] - Pull target language file(s)
-[options] are:
-EOS
-      opt :locale, "ISO code of locale(s) to pull, space-separated", type: :string
-      opt :all,    "Pull all files"
-      opt :force,  "Force pull (bypass conditional requests to WTI)"
-      opt :config, "Path to a configuration file", short: "-c", default: ".wti"
-      opt :debug,  "Display debug information"
-    end
-  when "push"
-    Optimist::options do
-      banner <<-EOS
-wti push [filename] - Push master language file(s)
-[options] are:
-EOS
-      opt :locale, "ISO code of locale(s) to push, space-separated", type: :string
-      opt :target, "Upload all target files"
-      opt :force,  "Force push (bypass conditional requests to WTI)"
-      opt :low_priority, "WTI will process this file with a low priority"
-      opt :merge,  "Force WTI to merge this file"
-      opt :ignore_missing, "Force WTI to not obsolete missing strings"
-      opt :minor, "Minor Changes. When pushing a master file, prevents target translations to be flagged as `to_verify`."
-      opt :label,  "Apply a label to the changes", type: :string
-      opt :config, "Path to a configuration file", short: "-c", default: ".wti"
-      opt :all,    "DEPRECATED -- See `wti push --target` instead"
-      opt :debug,  "Display debug information"
-    end
-  when "add"
-    Optimist::options do
-      banner "wti add filename - Create and push a new master language file"
-      opt :low_priority, "WTI will process this file with a low priority"
-      opt :config, "Path to a configuration file", short: "-c", default: ".wti"
-      opt :debug,  "Display debug information"
-    end
-  when "rm"
-    Optimist::options do
-      banner "wti rm filename - Delete a master language file"
-      opt :config, "Path to a configuration file", short: "-c", default: ".wti"
-      opt :debug,  "Display debug information"
-    end
-  when "mv"
-    Optimist::options do
-      banner "wti mv filename - Moves a master language file and its target files"
-      opt :config, "Path to a configuration file", short: "-c", default: ".wti"
-      opt :debug, "Display debug information"
-    end
-  when "addlocale"
-    Optimist::options do
-      banner "wti addlocale localename - Add a new locale to the project"
-      opt :config, "Path to a configuration file", short: "-c", default: ".wti"
-      opt :debug,  "Display debug information"
-    end
-  when "rmlocale"
-    Optimist::options do
-      banner "wti rmlocale localename Delete a locale from the project"
-      opt :config, "Path to a configuration file", short: "-c", default: ".wti"
-      opt :debug,  "Display debug information"
-    end
-  when "status"
-    Optimist::options do
-      banner "wti status - Fetch and display project statistics.\nReturns 100 if untranslated segments exist in project\nReturns 101 if unproofread segments exist in project."
-      opt :config, "Path to a configuration file", short: "-c", default: ".wti"
-      opt :debug,  "Display debug information"
-    end
-  when "init"
-    Optimist::options do
-      banner "wti init [api_token] - Configure your project to sync"
-      opt :config, "Path to a configuration file", short: "-c", default: ".wti"
-      opt :debug,  "Display debug information"
-    end
-  when "match"
-    Optimist::options do
-      banner "wti match - Display matching of local files with File Manager"
-      opt :config, "Path to a configuration file", short: "-c", default: ".wti"
-      opt :debug,  "Display debug information"
-    end
-  else
-    if command.nil?
-      puts show_commands
-      exit
-    else
-      Optimist::die "Unknown subcommand #{command.inspect}"
-    end
-  end
+                  when 'pull'
+                    Optimist.options do
+                      banner <<~BANNER
+                        wti pull [filename] - Pull target language file(s)
+                        [options] are:
+                      BANNER
+                      opt :locale, 'ISO code of locale(s) to pull, space-separated', type: :string
+                      opt :all,    'Pull all files'
+                      opt :force,  'Force pull (bypass conditional requests to WTI)'
+                      opt :config, 'Path to a configuration file', short: '-c', default: '.wti'
+                      opt :debug,  'Display debug information'
+                    end
+                  when 'push'
+                    Optimist.options do
+                      banner <<~BANNER
+                        wti push [filename] - Push master language file(s)
+                        [options] are:
+                      BANNER
+                      opt :locale, 'ISO code of locale(s) to push, space-separated', type: :string
+                      opt :target, 'Upload all target files'
+                      opt :force,  'Force push (bypass conditional requests to WTI)'
+                      opt :low_priority, 'WTI will process this file with a low priority'
+                      opt :merge, 'Force WTI to merge this file'
+                      opt :ignore_missing, 'Force WTI to not obsolete missing strings'
+                      opt :minor, 'Minor Changes. When pushing a master file, prevents target translations to be flagged as `to_verify`.'
+                      opt :label,  'Apply a label to the changes', type: :string
+                      opt :config, 'Path to a configuration file', short: '-c', default: '.wti'
+                      opt :all,    'DEPRECATED -- See `wti push --target` instead'
+                      opt :debug,  'Display debug information'
+                    end
+                  when 'add'
+                    Optimist.options do
+                      banner 'wti add filename - Create and push a new master language file'
+                      opt :low_priority, 'WTI will process this file with a low priority'
+                      opt :config, 'Path to a configuration file', short: '-c', default: '.wti'
+                      opt :debug,  'Display debug information'
+                    end
+                  when 'rm'
+                    Optimist.options do
+                      banner 'wti rm filename - Delete a master language file'
+                      opt :config, 'Path to a configuration file', short: '-c', default: '.wti'
+                      opt :debug,  'Display debug information'
+                    end
+                  when 'mv'
+                    Optimist.options do
+                      banner 'wti mv filename - Moves a master language file and its target files'
+                      opt :config, 'Path to a configuration file', short: '-c', default: '.wti'
+                      opt :debug, 'Display debug information'
+                    end
+                  when 'addlocale'
+                    Optimist.options do
+                      banner 'wti addlocale localename - Add a new locale to the project'
+                      opt :config, 'Path to a configuration file', short: '-c', default: '.wti'
+                      opt :debug,  'Display debug information'
+                    end
+                  when 'rmlocale'
+                    Optimist.options do
+                      banner 'wti rmlocale localename Delete a locale from the project'
+                      opt :config, 'Path to a configuration file', short: '-c', default: '.wti'
+                      opt :debug,  'Display debug information'
+                    end
+                  when 'status'
+                    Optimist.options do
+                      banner "wti status - Fetch and display project statistics.\nReturns 100 if untranslated segments exist in project\nReturns 101 if unproofread segments exist in project."
+                      opt :config, 'Path to a configuration file', short: '-c', default: '.wti'
+                      opt :debug,  'Display debug information'
+                    end
+                  when 'init'
+                    Optimist.options do
+                      banner 'wti init [api_token] - Configure your project to sync'
+                      opt :config, 'Path to a configuration file', short: '-c', default: '.wti'
+                      opt :debug,  'Display debug information'
+                    end
+                  when 'match'
+                    Optimist.options do
+                      banner 'wti match - Display matching of local files with File Manager'
+                      opt :config, 'Path to a configuration file', short: '-c', default: '.wti'
+                      opt :debug,  'Display debug information'
+                    end
+                  else
+                    if command.nil?
+                      puts show_commands
+                      exit
+                    else
+                      Optimist.die "Unknown subcommand #{command.inspect}"
+                    end
+                  end
 
 begin
   WebTranslateIt::Connection.turn_debug_on if command_options.debug
-  WebTranslateIt::CommandLine.new(command, command_options, global_options, ARGV, File.expand_path("."))
-rescue Interrupt => e
+  WebTranslateIt::CommandLine.new(command, command_options, global_options, ARGV, File.expand_path('.'))
+rescue Interrupt
   puts StringUtil.failure("\nQuitting...")
   exit 1
 end

data/generators/webtranslateit/lib/insert_commands.rb

@@ -9,11 +9,11 @@ end
 Rails::Generator::Commands::Create.class_eval do
   def append_to(file, line)
     logger.insert "#{line} appended to #{file}"
-    unless options[:pretend] || file_contains?(file, line)
-      File.open(file, "a") do |file|
-        file.puts
-        file.puts line
-      end
+    return if options[:pretend] || file_contains?(file, line)
+
+    File.open(file, 'a') do |f|
+      f.puts
+      f.puts line
     end
   end
 end
@@ -21,9 +21,7 @@ end
 Rails::Generator::Commands::Destroy.class_eval do
   def append_to(file, line)
     logger.remove "#{line} removed from #{file}"
-    unless options[:pretend]
-      gsub_file file, "\n#{line}", ''
-    end
+    gsub_file file, "\n#{line}", '' unless options[:pretend]
   end
 end
 

data/generators/webtranslateit/webtranslateit_generator.rb

@@ -1,26 +1,26 @@
-require File.expand_path(File.dirname(__FILE__) + "/lib/insert_commands.rb")
+require File.expand_path("#{File.dirname(__FILE__)}/lib/insert_commands.rb")
 
 class WebtranslateitGenerator < Rails::Generator::Base
   def add_options!(opt)
-    opt.on('-k', '--api-key=key', String, "Your Web Translate It API key") {|v| options[:api_key] = v}
+    opt.on('-k', '--api-key=key', String, 'Your Web Translate It API key') { |v| options[:api_key] = v }
   end
 
-  def manifest
+  def manifest # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
     if !api_key_configured? && !options[:api_key]
-      puts "You must pass --api-key or create config/translations.yml"
+      puts 'You must pass --api-key or create config/translations.yml'
       exit
     end
     record do |m|
       if options[:api_key]
         project_details = YAML.load WebTranslateIt::Project.fetch_info(options[:api_key])
         m.template '.wti', '.wti',
-          :assigns => { :api_key => options[:api_key], :project => project_details["project"] }
+                   assigns: { api_key: options[:api_key], project: project_details['project'] }
         m.append_to 'Rakefile', "require 'web_translate_it' rescue LoadError"
       end
     end
   end
 
   def api_key_configured?
-    File.exists?('config/translations.yml')
+    File.exist?('config/translations.yml')
   end
 end

data/history.md

@@ -1,3 +1,9 @@
+## Version 2.6.0 / 2022-03-08
+
+* Code cleaning using Rubocop.
+* Add ability to ignore files from pulls with a setting in the `.wti` file. Example:
+  `ignore_files: ['**/fr.yml', 'config/locales/js/*.yml', 'config/locales/app/fr.yml']`
+
 ## Version 2.5.4 / 2022-03-08
 
 * Better support for `before_pull`, `after_pull`, `before_push`, `after_push` hooks. They now display the command output, and write an error message if the exit status of the command was not successful.
@@ -19,7 +25,7 @@
 * Display files that are being updated on WebTranslateIt but are not ready to be downloaded by a `*`.
 
 ``` bash
-~/Desktop/test% wti pull 
+~/Desktop/test% wti pull
 # Pulling files on test 3
 *cs-CZ.de.yml                                       | 65a7fc8..65a7fc8  Skipped
  en.yml                                             | ffd8096..ffd8096  Skipped
@@ -246,7 +252,7 @@
 
 ## Version 2.0.0.rc1 / 2012-04-16 (yanked)
 
-**Important**: This release candidate introduce breaking changes in the String, Translation, Term and TermTranslation APIs. See [Extras](https://github.com/AtelierConvivialite/webtranslateit/wiki/Extras) if you use the String, Translation, Term and TermTranslation APIs to programmatically manage strings, translations and terms. 
+**Important**: This release candidate introduce breaking changes in the String, Translation, Term and TermTranslation APIs. See [Extras](https://github.com/AtelierConvivialite/webtranslateit/wiki/Extras) if you use the String, Translation, Term and TermTranslation APIs to programmatically manage strings, translations and terms.
 
 * Remove undeclared dependency on ActiveSupport. ActiveSupport was required to use the `WebTranslateIt::String`, `Translation`, `Term` and `TermTranslation` classes. #84
 * Refactor `WebTranslateIt::String` and `WebTranslateIt::Translation` classes and add specs. #85
@@ -294,9 +300,9 @@
 * Fix `wti status` command.
 * Improvement: truncate `wti pull` performance statistics (`Pulled 10 files in 0.7 seconds at 13.4 files/sec`).
 * Fix: Configuration file lookup improvements. Configuration files can now be located in another directory, and `wti` commands don’t have to be executed in the root directory. It is now possible to execute:
-  
+
   ```
-  wti pull 
+  wti pull
   wti pull -c /Users/edouard/code/test/.wti
   wti pull -c ../.wti
   wti pull -c ~/code/.wti
@@ -311,7 +317,7 @@
 
 ## Version 1.9.0 / 2011-11-23
 
-* Deprecate `wti server`. This feature was introducing a hard dependency on Sinatra, which is not desirable when embedding `web_translate_it` on a Rails application. `wti server` now lives in a separate gem, `web_translate_it_server`, which depends on the `web_translate_it` gem. To keep using `wti server`, execute: `gem install web_translate_it_server` and run: `wti-server`. 
+* Deprecate `wti server`. This feature was introducing a hard dependency on Sinatra, which is not desirable when embedding `web_translate_it` on a Rails application. `wti server` now lives in a separate gem, `web_translate_it_server`, which depends on the `web_translate_it` gem. To keep using `wti server`, execute: `gem install web_translate_it_server` and run: `wti-server`.
 
 ## Version 1.8.4 / 2011-11-14
 
@@ -348,7 +354,7 @@
 ## Version 1.8.2.0 / 2011-09-12
 
 * `wti pull` downloads files in parallel, using up to 20 threads.
-  This makes syncing much faster for projects containing many files (up to 65 files/sec). 
+  This makes syncing much faster for projects containing many files (up to 65 files/sec).
 * Default configuration file was renamed `.wti`. #67.
   The upgrade process should be seamless. Config file will be renamed if a `config/translation.yml` file is detected.
 
@@ -597,7 +603,7 @@ Warning, some deprecations in this version.
 * Add deprecation warning for `wti --upload`, `wti -u`. These commands will be deprecated in favour of `wti push`.
 * Add -c parameter to specify a configuration file at a custom location.
 * Add -l parameter to specify a specific language file to pull or push (only works with `wti pull` and `wti push`).
-* Add --force parameter to force Web Translate It to send the language files again, regardless if the current 
+* Add --force parameter to force Web Translate It to send the language files again, regardless if the current
   language file version is current (this makes `wti pull` very much slower).
 * Add `wti autoconf` command to automatically configure your project for Web Translate It.
 

data/lib/web_translate_it/auto_fetch.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
 module WebTranslateIt
-
   # Class to automatically fetch the last translations from Web Translate It
   # for every page requested.
   # This can be used as a rack middleware.
@@ -19,7 +17,7 @@ module WebTranslateIt
       @app.call(env)
     end
 
-  private
+    private
 
     def update_translations
       WebTranslateIt.fetch_translations
@@ -27,7 +25,7 @@ module WebTranslateIt
     end
 
     def valid_request?(env)
-      !(env['PATH_INFO'] =~ /\.(js|css|jpeg|jpg|gif|png|woff)$/)
+      env['PATH_INFO'] !~ /\.(js|css|jpeg|jpg|gif|png|woff)$/
     end
   end
 end