translate_self 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 423e2804c606db8a6f62a91f8e0458f9d59ab2dde91db01a21e6ed6af6cec07b
-  data.tar.gz: b351c1eb545ae152158ae9903e1f367cae4a87196f35a303f05817306c65b295
+  metadata.gz: 48a0238d6e09ae494d46da95732914c18c77882cc8a077d1c522a124c985cd62
+  data.tar.gz: 84a3fe6ae48a310dabe1fa8952773dd6234cebd03f7b370fd57b1aca44e8add7
 SHA512:
-  metadata.gz: dbff90c881adbc6c32996efb968eb9988121529fcdf60931575f1a4f6088e4d474c07244985d6c6ba108b1a1105e0200c5fa11f79040cbbed5cbe4c6c0b10261
-  data.tar.gz: cc7500f06cd47d90142fb7ff2483890d3d51c2f70c1c8ad8f8e0cd1ff72fbd85fc7e1d60ed231a13cc00b9289b8c9630a27dd6d37d913ba0c393e10209f1060a
+  metadata.gz: 13d585250ec562d77cd50d7d175c214ae136069d806d0b584e919a020f7769c1b2df09e7610639d18fd3909065173d02fd44f062f0f6f25636c64b019d4345fc
+  data.tar.gz: cf6a84eb4c137084fa8b96f3c6e5dbab24e88499da2b638280eceaef615818b175d363d8de9d70529c82f243760a2750a3d8b7081f69a2e56bf583f7553d72a8

data/CHANGELOG.md

@@ -17,4 +17,13 @@ Seems like you need to update it by hand!
 
 ## [0.4.0] - 2021-06-05
 
-- The translated new string now knows what language it is. 
+- The translated new string now knows what language it is. 
+
+## [0.5.0] - 2021-06-06
+
+- Add TranslatableString class to work around frozen string literal magic comment. 
+  Also will not crash with frozen strings now. 
+
+## [0.6.0] - 2021-06-08
+
+- Add option to use ENV variable DEEPL_HOST

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    translate_self (0.5.0)
+    translate_self (0.6.0)
       deepl-rb
 
 GEM

data/README.md

@@ -19,7 +19,11 @@ Just get a DeepL auth key and export it as follows:
 export DEEPL_AUTH_KEY="your-api-token"
 ```
 
-This gem currently hardcodes the free DeepL servers. # TODO 
+By default this gem uses the free DeepL servers, but you can also configure your own:
+
+```sh
+export DEEPL_HOST="non-free-host"
+```
 
 Now you can translate it to your language of chose with this gem!
 ```ruby
@@ -92,6 +96,23 @@ hello.translate
 # "Moi"
 ```
 
+## Benchmark
+
+Create a string 5000000 times. 
+
+```shell
+C:\home\sampo\translate_self> ruby benchmark.rb
+Rehearsal -------------------------------------------------------
+normal string         0.252435   0.000000   0.252435 (  0.252490)
+translatable string   0.299736   0.000000   0.299736 (  0.299789)
+---------------------------------------------- total: 0.552171sec
+
+                          user     system      total        real
+normal string         0.237091   0.000000   0.237091 (  0.237091)
+translatable string   0.237607   0.000000   0.237607 (  0.237611)
+```
+So... the overhead might be surprisingly low!
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/benchmark.rb

@@ -0,0 +1,16 @@
+require 'benchmark'
+
+n = 5000000
+Benchmark.bmbm do |x|
+  x.report("string") do
+    n.times do
+      'hello'
+    end
+  end
+  x.report('translatable string') do
+    require 'translate_self'
+    n.times do
+      'hello'
+    end
+  end
+end

data/lib/translate_self.rb

@@ -9,7 +9,8 @@ module TranslateSelf
   include Translation
   class Error < StandardError; end
   DeepL.configure do |config|
-    config.host = 'https://api-free.deepl.com' # Default value is 'https://api.deepl.com'
+    config.auth_key = ENV['DEEPL_AUTH_KEY']
+    config.host = ENV['DEEPL_HOST'] || 'https://api-free.deepl.com' # Default value is 'https://api.deepl.com'
   end
   AVAILABLE_LANGUAGES = %w[bg cs da de el en es et fi fr hu it ja lt lv nl pl pt ro ru sk sl sv zh].freeze
 end

data/lib/translate_self/version.rb

@@ -1,3 +1,3 @@
 module TranslateSelf
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.6.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: translate_self
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Sampo Kuokkanen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-06 00:00:00.000000000 Z
+date: 2021-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deepl-rb
@@ -86,6 +86,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmark.rb
 - bin/console
 - bin/setup
 - lib/ext/string.rb