translate_self 1.0.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2f3c2abce98a2adee409991a78dd742815c7e0b1bfb380505180d4f5c52a5b9
-  data.tar.gz: 3feb43446a4549581992be68d65389e9d3e9ca2f55381a7a5d2e56df6f1573ea
+  metadata.gz: 3440e7e27417b8402613c3b0a8b9ffefbbe3af690a6dc9600a847a56266c77b3
+  data.tar.gz: fa0310235e61ef1dc3571ef737d124743ef6d85560e8cc5777624e1e9d67c008
 SHA512:
-  metadata.gz: 5518f3c6d39c0d8a2b3e79fbd9c4302c85c714d12a075de90b59fd647444e08902bd317e3e90d20e99d50ed94280833aa75e5beb381498f5f04636f4f63cb7ef
-  data.tar.gz: 5266142227b3bccaffb4a1d9bee31f7ac27b3d8f8f5779c0a1efd99ed9d9a80b5ced3a1b463a4db373717c34a237d9aa016c6cef12bcbb0d59bfcb383482fea4
+  metadata.gz: 8473f84cbb40f018afce32d74ed4bf4a57a51de31d7f893debd079eb36f733bbdbfa2aa5eb2230afa977609b0ee11479a1e7f7b518f25eec3f02d0a59f91bc1c
+  data.tar.gz: 9d1d285395839950a413c38b94723392d281701ca1eb3986d5a39f5839bb559d865b85a3c7f78268af55ed5c80cadad63787baebecca42a48ab64f3bca8306b0

data/.rubocop.yml

@@ -1,3 +1,5 @@
+require: rubocop-rspec
+
 AllCops:
   TargetRubyVersion: 2.5
   NewCops: enable
@@ -13,8 +15,22 @@ Style/StringLiteralsInInterpolation:
 Style/FrozenStringLiteralComment:
   Enabled: false
 
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - 'spec/**/*'
+
 Layout/LineLength:
   Max: 120
 
 Style/AsciiComments:
   Enabled: false
+
+RSpec/ExpectActual:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false

data/CHANGELOG.md

@@ -1,54 +1,57 @@
-## [Unreleased]
-- Nothing new yet. 
+## [2.0.1] - 2021-11-07
+- Finally a way to get around those pesky frozen strings! 
+- By default, [defrost](https://github.com/tenderlove/defrost) is not loaded. You can turn this off by setting `TranslateSelf.defrosting = true`.
+- See `spec/frozen_strings_spec.rb` for more details and exciting ways of using it.
+- Using with frozen_string_literal: true is a great way to troll your coworkers. 
 
-## [0.1.0] - 2021-06-02
+## [1.0.1] - 2021-07-13
 
-- Initial release!
-You can now translate strings! Be free!
+- I'm reading Polished Ruby, and I just learned that it's faster to pass symbols than strings sometimes, 
+so as this library is very performance-oriented, symbols it is! 
 
-## [0.2.0] - 2021-06-03
+## [1.0.0] - 2021-06-11
 
-- Commentation and cleanup of unneeded files.
+- Refactored the translation part a bit. 
+- Now you can translate strings that are over 30 kilobyte! 
+  I couldn't test this too much because of the limits on the free plan, 
+  but if you can test this feature, I'd be really happy to hear how it is working for you. 
 
-## [0.3.0] - 2021-06-03
 
-- Gemfile.lock was not automatically updated, testing it a bit.
-Seems like you need to update it by hand! 
-
-## [0.4.0] - 2021-06-05
+## [0.9.0] - 2021-06-08
 
-- The translated new string now knows what language it is. 
+## [0.8.0] - 2021-06-08
 
-## [0.5.0] - 2021-06-06
+- Add option to use the shorter `t_to_language_code` alias. 
+## [0.7.0] - 2021-06-08
 
-- Add TranslatableString class to work around frozen string literal magic comment. 
-  Also will not crash with frozen strings now. 
+- Get rid of duplicated code. Update `benchmark.rb`.
 
 ## [0.6.0] - 2021-06-08
 
 - Add option to use ENV variable DEEPL_HOST
 
-## [0.7.0] - 2021-06-08
+# Breaking change from 0.8!
+- `t_to_language_code` was too much typing, so changed it to `to_language_code`. 
 
-- Get rid of duplicated code. Update `benchmark.rb`.
+## [0.5.0] - 2021-06-06
 
-## [0.8.0] - 2021-06-08
+- Add TranslatableString class to work around frozen string literal magic comment. 
+  Also will not crash with frozen strings now. 
 
-- Add option to use the shorter `t_to_language_code` alias. 
+## [0.4.0] - 2021-06-05
 
-## [0.9.0] - 2021-06-08
+- The translated new string now knows what language it is. 
+## [0.3.0] - 2021-06-03
 
-# Breaking change from 0.8!
-- `t_to_language_code` was too much typing, so changed it to `to_language_code`. 
+- Gemfile.lock was not automatically updated, testing it a bit.
+Seems like you need to update it by hand! 
 
-## [1.0.0] - 2021-06-11
 
-- Refactored the translation part a bit. 
-- Now you can translate strings that are over 30 kilobyte! 
-  I couldn't test this too much because of the limits on the free plan, 
-  but if you can test this feature, I'd be really happy to hear how it is working for you. 
+## [0.2.0] - 2021-06-03
 
-## [1.0.1] - 2021-07-13
+- Commentation and cleanup of unneeded files.
 
-- I'm reading Polished Ruby, and I just learned that it's faster to pass symbols than strings sometimes, 
-so as this library is very performance-oriented, symbols it is! 
+## [0.1.0] - 2021-06-02
+
+- Initial release!
+You can now translate strings! Be free!

data/Gemfile.lock

@@ -1,20 +1,27 @@
 PATH
   remote: .
   specs:
-    translate_self (1.0.1)
+    translate_self (2.0.1)
       deepl-rb
+      defrost (~> 1.0)
+      dry-configurable (~> 0.1.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    deepl-rb (2.3.0)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.9)
+    deepl-rb (2.3.1)
+    defrost (1.0.0)
     diff-lcs (1.4.4)
-    parallel (1.20.1)
-    parser (3.0.1.1)
+    dry-configurable (0.1.7)
+      concurrent-ruby (~> 1.0)
+    parallel (1.21.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (13.0.3)
+    rake (13.0.6)
     regexp_parser (2.1.1)
     rexml (3.2.5)
     rspec (3.10.0)
@@ -29,29 +36,33 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.16.0)
+    rspec-support (3.10.3)
+    rubocop (1.22.3)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.7.0)
+    rubocop-ast (1.12.0)
       parser (>= 3.0.1.1)
+    rubocop-rspec (2.5.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  byebug
   rake (~> 13.0)
   rspec (~> 3.2)
   rubocop (~> 1.7)
+  rubocop-rspec
   translate_self!
 
 BUNDLED WITH
-   2.2.17
+   2.2.22

data/README.md

@@ -104,6 +104,13 @@ hello.translate
 # "Moi"
 ```
 
+OR!
+Use it with [defrost](https://github.com/tenderlove/defrost)!
+By default, defrost is not loaded. You can turn this on by setting `TranslateSelf.defrosting = true`, and after that, no need to worry about frozen strings!
+This will defrost strings if they're frozen. 
+Might be a bit slower, but it's worth it!
+Interesting debug sessions guaranteed. 
+
 ## Benchmark
 
 Create a string 5000000 times. 

data/lib/ext/string.rb

@@ -1,5 +1,5 @@
 require_relative '../translate_self/translation'
-
+# String extension used by TranslateSelf
 class String
   include Translation
 end

data/lib/translate_self/translation.rb

@@ -2,11 +2,20 @@ 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
+  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
+
+  def to_language
+    @to_language || 'fi'
+  end
+
+  def to_language=(language)
+    defroster if needs_defrosting?
+    @to_language = LANGUAGES.include?(language) ? language : 'fi'
+  end
 
   def available_languages
-    @@languages
+    LANGUAGES
   end
 
   # Translates self to the desired language. \
@@ -30,6 +39,7 @@ module Translation
   # # 'Hei'
   # @return [String] self replaced with the new translation
   def translate!
+    defroster if needs_defrosting?
     replace translate
   end
 
@@ -40,7 +50,7 @@ module Translation
   #
   # @param [String] the language to translate to, e.g. "fi"
   # @return [String] the contents translated to another language
-  @@languages.each do |lan|
+  LANGUAGES.each do |lan|
     define_method("translate_to_#{lan}".to_sym) do |language = lan|
       call_deepl(self.language, language)
     end
@@ -49,6 +59,15 @@ module Translation
 
   private
 
+  def needs_defrosting?
+    frozen? && TranslateSelf.config.defrosting
+  end
+
+  def defroster
+    require 'defrost'
+    defrost
+  end
+
   def break_up(to_lan)
     sentences = break_text_into_sentences
     sentences.length.times.map.with_index do |_i, i|
@@ -57,11 +76,7 @@ module Translation
   end
 
   def break_text_into_sentences
-    last_letter = if self[-1] == '.'
-                    '.'
-                  else
-                    ''
-                  end
+    last_letter = last_letter_of_self
     tr_count = (bytesize / 25_000.to_f).ceil
     sentences = split('.')
     number_of_sentences = sentences.length / tr_count
@@ -69,16 +84,24 @@ module Translation
     tr_count.times.map do |num|
       txt = sentences[current_count..(current_count + number_of_sentences)].join('.')
       current_count += number_of_sentences.next
-      txt + last_letter if num == tr_count.pred
+      if num == tr_count.pred
+        txt + last_letter
+      else
+        txt
+      end
     end
   end
 
+  def last_letter_of_self
+    end_with?('.') ? '.' : ''
+  end
+
   def call_deepl(language = self.language, to_lan = to_language)
     warn 'No language given!' and return if to_lan.nil?
     return break_up(to_lan) if bytesize > 30_000
 
     response = DeepL.translate self, language, to_lan
-    self.language = response.detected_source_language.downcase if self.language.nil? && !frozen?
+    self.language = response.detected_source_language.downcase if !frozen? || (needs_defrosting? && defroster)
     actual_translation = response.text
     actual_translation.language = to_lan
     actual_translation

data/lib/translate_self/version.rb

@@ -1,3 +1,3 @@
 module TranslateSelf
-  VERSION = '1.0.1'.freeze
+  VERSION = '2.0.1'.freeze
 end

data/lib/translate_self.rb

@@ -3,9 +3,12 @@ require_relative 'translate_self/translation'
 require_relative 'translate_self/translatable_string'
 require 'ext/string'
 require 'deepl'
+require 'dry-configurable'
 
 # Dangerously include translation methods to strings!
 module TranslateSelf
+  extend Dry::Configurable
+  setting :defrosting, default: false
   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'

data/translate_self.gemspec

@@ -29,9 +29,13 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   spec.add_dependency 'deepl-rb'
+  spec.add_dependency 'defrost', '~> 1.0'
+  spec.add_dependency 'dry-configurable', '~> 0.1.3'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.2'
   spec.add_development_dependency 'rubocop', '~> 1.7'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'byebug'
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: translate_self
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.1
 platform: ruby
 authors:
 - Sampo Kuokkanen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-13 00:00:00.000000000 Z
+date: 2021-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deepl-rb
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: defrost
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
   Let the strings do the job for you. No need to do any of the manual work! \
                           The strings translate themselves!! Translate to Japanese, English, Finnish...
@@ -118,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: TranslateSelf lets strings translate themselves.