translate_self 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48a0238d6e09ae494d46da95732914c18c77882cc8a077d1c522a124c985cd62
-  data.tar.gz: 84a3fe6ae48a310dabe1fa8952773dd6234cebd03f7b370fd57b1aca44e8add7
+  metadata.gz: 680f027a575420fab6eb29bbdb7a49a0410e8b6e51adb0775c6dc884539d84bc
+  data.tar.gz: 51afe0c1d56642d3a9b0d6b2578de001da729a10f8c05b2f61a8ed04f383d639
 SHA512:
-  metadata.gz: 13d585250ec562d77cd50d7d175c214ae136069d806d0b584e919a020f7769c1b2df09e7610639d18fd3909065173d02fd44f062f0f6f25636c64b019d4345fc
-  data.tar.gz: cf6a84eb4c137084fa8b96f3c6e5dbab24e88499da2b638280eceaef615818b175d363d8de9d70529c82f243760a2750a3d8b7081f69a2e56bf583f7553d72a8
+  metadata.gz: ead7740d0183cb4959789c62ebebd6ed2bc5a3f528d1b1a4b1e97e71e3607b30dbf52686878dc5bb60e566be3516bcbdd23cfc7e9237cc2ddf0647ac0405a9f2
+  data.tar.gz: 42b7fa5b9d7c68b98fd6884c24808834287c2b0ec63b252970c43bb3fe4083bd5c3a6c3aff5d474fac478ae7b33d8de59dc735c9ad42c9014d1f11167682e65b

data/CHANGELOG.md

@@ -26,4 +26,8 @@ Seems like you need to update it by hand!
 
 ## [0.6.0] - 2021-06-08
 
-- Add option to use ENV variable DEEPL_HOST
+- Add option to use ENV variable DEEPL_HOST
+
+## [0.7.0] - 2021-06-08
+
+- Get rid of duplicated code. Update `benchmark.rb`.

data/Gemfile.lock

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

data/README.md

@@ -101,17 +101,22 @@ hello.translate
 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)
+C:\home\sampo\translate_self> ruby benchmark.rb 
+Rehearsal --------------------------------------------------------
+normal string          0.221517   0.000101   0.221618 (  0.221677)
+monkeypatched string   0.267748   0.000000   0.267748 (  0.267865)
+translatable string    1.878466   0.000000   1.878466 (  1.878497)
+----------------------------------------------- total: 2.367832sec
+
+                           user     system      total        real
+normal string          0.225292   0.000000   0.225292 (  0.225289)
+monkeypatched string   0.225690   0.000000   0.225690 (  0.225740)
+translatable string    1.886653   0.000000   1.886653 (  1.886735)
+
 ```
 So... the overhead might be surprisingly low!
+If you use the TranslatableString class, there is some overhead. 
+But if you just hack string it's pretty fast! See `benchmark.rb`.
 
 ## Development
 

data/benchmark.rb

@@ -2,15 +2,21 @@ require 'benchmark'
 
 n = 5000000
 Benchmark.bmbm do |x|
-  x.report("string") do
+  x.report("normal string") do
     n.times do
       'hello'
     end
   end
-  x.report('translatable string') do
+  x.report('monkeypatched string') do
     require 'translate_self'
     n.times do
       'hello'
     end
   end
+  x.report('translatable string') do
+    require 'translate_self'
+    n.times do
+      TranslatableString.new('hello')
+    end
+  end
 end

data/lib/translate_self.rb

@@ -6,11 +6,8 @@ require 'deepl'
 
 # Dangerously include translation methods to strings!
 module TranslateSelf
-  include Translation
-  class Error < StandardError; end
   DeepL.configure do |config|
     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/translatable_string.rb

@@ -3,7 +3,7 @@
 # freeze them. Aliased to TString.
 class TranslatableString < String
   def initialize(str, language: nil, to_language: nil)
-    replace str
+    super str
     self.language = language
     self.to_language = to_language
   end

data/lib/translate_self/translation.rb

@@ -2,10 +2,11 @@ require 'deepl'
 
 # The part where the actual translation happens.
 module Translation
+  @@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
   attr_accessor :language, :to_language
 
   def available_languages
-    TranslateSelf::AVAILABLE_LANGUAGES
+    @@languages
   end
 
   # Translates self to the desired language. \
@@ -39,7 +40,7 @@ module Translation
   #
   # @param [String] the language to translate to, e.g. "fi"
   # @return [String] the contents translated to another language
-  %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].each do |lan|
+  @@languages.each do |lan|
     define_method("translate_to_#{lan}") do |language = lan|
       call_deepl(self, self.language, language)
     end

data/lib/translate_self/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: translate_self
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Sampo Kuokkanen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-07 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deepl-rb