web_translate_it 2.6.4 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 186304899ba3932f5c4152b0a02bc34fbdb47d0392c88d8931e30976e66ea916
-  data.tar.gz: 90cdef9f2d193d4d00a34a2362a7af85e2f7fb010d0455f47c1991935d7e0b85
+  metadata.gz: 6cef77421b30d347178a38e6fe50300e44d41a2c47fe46736ad79d76bc891374
+  data.tar.gz: e3d93cec2762262b06a8eb5aa2f71a901eb5ba77ff09b1e2f85462f765617501
 SHA512:
-  metadata.gz: 9d78a7788bec607b0722bce91668ea89bfb6c05c6c2c5a1baaeb34fbfbc446f16817ac84f5a902c7edb6860fe626f6de2fd03dde9dd6cb96076c3f703fccb1a0
-  data.tar.gz: 22ae36a655963dfc12092951c2aee41fa29612e1a69ae05ce0bb79b9361ce1eb81755cdaf3a7b53152e46971d5af322989424f22ff6eb9428f7b961fb1dcbcd0
+  metadata.gz: 154b48ea91ca07bc107ff3b551678bf152a791db84432be020d1e3f3444c7f0830f303f5a222947fdbf1178638648df973f1c2ff8755c8db30e22c8916808c75
+  data.tar.gz: 1bbf7533a388aeec98f9d0541c1839d95d18ed99d0cf2ccb4bb6400cb0852ddd8d98d04e4d29315b55c05790e70095db5d5a418ac47a1b47234ca84da495cf5b

data/bin/wti

@@ -97,7 +97,7 @@ when 'rmlocale'
   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."
+    banner "wti status [filename] - 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

data/history.md

@@ -1,3 +1,11 @@
+## Version 2.7.0 / 2022-10-10
+
+* New: Ability to see translation statistics per file.
+  - `wti status` gives the whole translation project statistics.
+  - `wti status path/to/file` gives the file translation statistics.
+* Update readme file (installation instructions and add link to Docker package).
+* Fix Rspec ExampleWording offences.
+
 ## Version 2.6.4 / 2022-09-22
 
 * Move development dependencies to Gemfile and commit Gemfile.lock to version control.

data/lib/web_translate_it/command_line.rb

@@ -353,8 +353,15 @@ module WebTranslateIt
       true
     end
 
-    def status # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
-      stats = YAML.load(Project.fetch_stats(configuration.api_key))
+    def status # rubocop:todo Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      if parameters.any?
+        file = configuration.files.find { |f| parameters.first.strip == f.file_path }
+        abort "File '#{parameters.first}' not found." unless file
+
+        file_id = file.master_id || file.id
+        puts "Statistics for '#{parameters.first}':"
+      end
+      stats = YAML.load(Project.fetch_stats(configuration.api_key, file_id))
       completely_translated = true
       completely_proofread  = true
       stats.each do |locale, values|

data/lib/web_translate_it/project.rb

@@ -31,12 +31,13 @@ module WebTranslateIt
       success
     end
 
-    def self.fetch_stats(api_key) # rubocop:todo Metrics/MethodLength
+    def self.fetch_stats(api_key, file_id = nil) # rubocop:todo Metrics/MethodLength
+      url = file_id.nil? ? "/api/projects/#{api_key}/stats.yaml" : "/api/projects/#{api_key}/stats.yaml?file=#{file_id}"
       success = true
       tries ||= 3
       begin
         WebTranslateIt::Connection.new(api_key) do |http|
-          request = Net::HTTP::Get.new("/api/projects/#{api_key}/stats.yaml")
+          request = Net::HTTP::Get.new(url)
           WebTranslateIt::Util.add_fields(request)
           return Util.handle_response(http.request(request), true)
         end

data/readme.md

@@ -3,7 +3,8 @@
 [RubyDoc](https://www.rubydoc.info/gems/web_translate_it/) |
 [Report a bug](https://github.com/webtranslateit/webtranslateit/issues) |
 [Support](https://webtranslateit.com/support) |
-[WebTranslateIt.com Homepage](https://webtranslateit.com)
+[WebTranslateIt.com Homepage](https://webtranslateit.com) |
+[Docker Package](https://github.com/webtranslateit/wti-docker/pkgs/container/wti-docker)
 
 wti lets you easily sync your language files with [WebTranslateIt.com](https://webtranslateit.com), a web-based tool to translation software.
 
@@ -11,7 +12,7 @@ wti lets you easily sync your language files with [WebTranslateIt.com](https://w
 
 ### wti...
 
-* wti is a **command-line tool**. It works on all operating systems: Windows, Linux, MacOS X...
+* wti is a **command-line tool**. It works on all operating systems: Windows, Linux, MacOS X, ... It is also available as a [Docker package](https://github.com/webtranslateit/wti-docker/pkgs/container/wti-docker).
 * wti is really easy to use. It was inspired by git. Use `wti push` and `wti pull` to sync your language files with WebTranslateIt.com.
 
 ### Optionally, wti does...
@@ -24,12 +25,12 @@ wti lets you easily sync your language files with [WebTranslateIt.com](https://w
 
 ## Installation
 
-You will also need ruby to run `wti`. On Linux or a Mac, it’s already installed. Install [RubyInstaller](http://rubyinstaller.org/) if you’re using Windows. [See detailed installation instructions for Windows users](https://github.com/webtranslateit/webtranslateit/wiki/Install-wti-on-Windows).
+You will also need ruby to run `wti`. We require ruby version 2.6 or newer. On Linux or a Mac, it’s already installed. Install [RubyInstaller](http://rubyinstaller.org/) if you’re using Windows. [See detailed installation instructions for Windows users](https://github.com/webtranslateit/webtranslateit/wiki/Install-wti-on-Windows).
 
 ``` bash
 $ gem install web_translate_it
-Fetching: web_translate_it-2.1.3.gem (100%)
-Successfully installed web_translate_it-2.1.3
+Fetching: web_translate_it-2.6.4.gem (100%)
+Successfully installed web_translate_it-2.6.4
 1 gem installed
 ```
 
@@ -37,26 +38,14 @@ At this point you should have the `wti` executable working:
 
 ``` bash
 $ wti -v
-wti version 2.2.1
+wti version 2.6.4
 ```
 
-On some Linux distributions you may get the following error:
-
-``` bash
-$ wti
-If 'wti' is not a typo you can use command-not-found to lookup the package that contains it, like this:
-    cnf wti
-```
-
-The reason is that the wti file is named in another way: `/usr/bin/wti.ruby2.1` so you will have to create a symlink to make wti run.
-
-``` bash
-# ln -s /usr/bin/wti.ruby2.1 /usr/bin/wti
-```
+We also provide `wti` as a Docker packages. [See our packages and instructions to install](https://github.com/webtranslateit/wti-docker/pkgs/container/wti-docker).
 
 ## Configuration
 
-Now that the tool is installed, you’ll have to configure your project. Basically, `wti` is to be run on a project root directory, and looks for a `.wti` file containing your project information. The command `wti init` lets your create your `.wti` file.
+Now that `wti` is installed, you’ll have to configure your project. Basically, `wti` is to be run on a project root directory, and looks for a `.wti` file containing your project information. The command `wti init` lets your create your `.wti` file.
 
 ``` bash
 $ wti init proj_pvt_V8skdjsdDDA4

metadata

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