translate_self 0.4.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd77e2863ae0072d53dfee777def3764849c33bdeeab16a67e1065f5dce879f7
-  data.tar.gz: 239bdf82ef13b4b862eae068b36a97ce0c11abd4d4d8dacb0bd5e6147fa3acd8
+  metadata.gz: 06cd6e728398f95604296576f5f3712addcaf0f80d35f1ec9a1a0fd85a8f0f12
+  data.tar.gz: a0e2990e3b04699338dc65330e8468c126f5b8a06a4aaf8dd858f28307c75b9b
 SHA512:
-  metadata.gz: b66c9bad32762a845c6aa417f672b98a6c11a17cc88d09d6cd404aefac2d7500baab438bbbeb1e99f743b1dfa3d0d173ae89cc69084f521268de793facab2304
-  data.tar.gz: 3d70dd2c9a5394d2f08a436a79b22ee6e257ac6646d93cb570089537b80c6308957816eeff7d64794fe3dadda8f6459f61a81a903b942ca0f6c0d0650bcae8be
+  metadata.gz: 87cd44608ef643c1e449c558cccf36772fed93a6427872ea1741c035e6e43c50c8cb26baca94414fd11910ef867a791860289870a6c6b3d3a439c0d816fadd52
+  data.tar.gz: bf6cc3feef26ee424b329ab88ee152fd7004608817fa91b3a5789e62e3fcc77097da98f7efadcf463b011d270c6a158e964ae4803ae7f20fe9c7f25dd56775d9

data/.gitignore

@@ -7,6 +7,7 @@
 /spec/reports/
 /tmp/
 /.idea/
+.byebug_history
 
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -17,4 +17,26 @@ 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
+
+## [0.7.0] - 2021-06-08
+
+- Get rid of duplicated code. Update `benchmark.rb`.
+
+## [0.8.0] - 2021-06-08
+
+- Add option to use the shorter `t_to_language_code` alias. 
+
+## [0.9.0] - 2021-06-08
+
+# Breaking change from 0.8!
+- `t_to_language_code` was too much typing, so changed it to `to_language_code`. 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    translate_self (0.4.0)
+    translate_self (0.9.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
@@ -27,6 +31,13 @@ Now you can translate it to your language of chose with this gem!
 # 世界よ、ハローだ
 ```
 
+What's even better is that you can also save some typing by using the shortened alias such as below:
+
+```ruby
+"hello world".to_ja # or to_fi, to_ru... endless possibilities!
+# 世界よ、ハローだ
+```
+
 This gem uses the wonderful DeepL for Ruby as its backend.
 
 https://github.com/wikiti/deepl-rb
@@ -77,9 +88,42 @@ finn.translate
 # I am a Finn
 ```
 
-## Beware!
+## Using with `# frozen_string_literal: true`
+
+~~Does not work if you freeze the strings.~~ 
+
+Now it does! 
+Just use the classes `TranslatableString` (aliased to `TString`). 
+So even if you have a magic comment making all your strings frozen, 
+you can still use the `translate` method like below:
+
+```ruby
+hello = TranslatableString.new('hello', language: 'en', to_language: 'fi')
+hello.translate
+# "Moi"
+```
+
+## Benchmark
 
-Does not work if you freeze the strings. 
+Create a string 5000000 times. 
+
+```shell
+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

@@ -0,0 +1,22 @@
+require 'benchmark'
+
+n = 5000000
+Benchmark.bmbm do |x|
+  x.report("normal string") do
+    n.times do
+      'hello'
+    end
+  end
+  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

@@ -1,14 +1,13 @@
 require_relative 'translate_self/version'
 require_relative 'translate_self/translation'
+require_relative 'translate_self/translatable_string'
 require 'ext/string'
 require 'deepl'
 
 # Dangerously include translation methods to strings!
 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/translatable_string.rb

@@ -0,0 +1,11 @@
+# A class that let's you translate strings with
+# the language and to_language params even if you happen to
+# freeze them. Aliased to TString.
+class TranslatableString < String
+  def initialize(str, language: nil, to_language: nil)
+    super str
+    self.language = language
+    self.to_language = to_language
+  end
+end
+TString = TranslatableString

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. \
@@ -32,17 +33,18 @@ module Translation
     replace translate
   end
 
-  # Translates the string itself to a language the user wants to translate it to. \
+  # Translates the string itself to a language the user wants to translate it to.
   # Sample usage:
   # 'hello'.translate_to_fi
   # # Hei
   #
   # @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
+    alias_method "to_#{lan}", "translate_to_#{lan}"
   end
 
   private
@@ -51,7 +53,7 @@ module Translation
     warn 'No language given!' and return if to_lan.nil?
 
     response = DeepL.translate text, language, to_lan
-    self.language = response.detected_source_language.downcase if self.language.nil?
+    self.language = response.detected_source_language.downcase if self.language.nil? && !frozen?
     actual_translation = response.text
     actual_translation.language = to_lan
     actual_translation

data/lib/translate_self/version.rb

@@ -1,3 +1,3 @@
 module TranslateSelf
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.9.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: translate_self
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Sampo Kuokkanen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-05 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deepl-rb
@@ -75,7 +75,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".byebug_history"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
@@ -87,10 +86,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmark.rb
 - bin/console
 - bin/setup
 - lib/ext/string.rb
 - lib/translate_self.rb
+- lib/translate_self/translatable_string.rb
 - lib/translate_self/translation.rb
 - lib/translate_self/version.rb
 - translate_self.gemspec

data/.byebug_history

@@ -1,48 +0,0 @@
-c
-@language
-c
-@language
-self
-c
-self
-c
-self
-c
-self
-c
-suomalainen.language
-suomalainen.language = 'fi'
-suomalainen.language
-c
-suomalainen.language
-c
-self.language
-c
-self.language
-self.language = 'fi'
-response.detected_source_language
-self.language.nil?
-self.language
-self
-c
-available_languages.include?(name.to_s[-2..-1])
-available_languages.include?(name.to_s[-2..-1].to_sym)
-exit
-c
-available_languages.include?(name.to_s[-2..-1].to_sym)
-available_languages.include?(name.to_s[-2..-1])
-name.to_s[-2..-1]
-name
-c
-languages.map(&:code).map(&:downcase)
-languages.map(&:code)
-languages.map(&:code.downcase.to_sym)
-languages = DeepL.languages
-c
-self
-self.replace 'kon'
-self.instance_methods(false)
-self.attributes
-self = 'kon'
-language
-self