deepl_diff 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 601d9219d37903d18d03a30e85fee9ce783522fbfb75d616f2873ef4ca6da950
-  data.tar.gz: a0b23c609b7f6f48b74a83a818d96d3bb13665568f3563a6e67fe2c16fb42f44
+  metadata.gz: 19d6f34da084b57edb1a50356fd34be56d93bd2a968aea99deb93f4233fb3620
+  data.tar.gz: a7ee76936e0cb0e19ad569b93f671967cec2285d9a656b76a2fbe6e93c9776a4
 SHA512:
-  metadata.gz: a739f33576f117fde32e6c6fd9527835a2f6aeb3fbdd4b3265aa4e0c913e519bc0f8bd536ed2abdcee50721823e75286aed909cbfc59fc889cea40538c83847c
-  data.tar.gz: 87beae80de1cf85db6308cc613e71b428b0008a4b797ef276ef4d16abd65f162aea2cfd09b454ddd6f2fb438ae3939af7c48c42e850f3f4772c2184be1c35839
+  metadata.gz: 3f966fa796638f71d87b565fe8d7db7de0f0902c05a4f0767566a2fb5a2a034e7f2920c20e562195e4449d99379ffb415209a1946401e1476cc98e7118264c07
+  data.tar.gz: fe7d3e2da279d6701c5c9ba92196517d6cdbfb93fd728cbd0370827de92fcc2d857945cf87c160ac16193f4698df1ef7402fbf895a990827cf27b8948e772a5f

data/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["3.2", "3.3", "3.4", "4.0"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - run: bundle exec rspec
+
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.4"
+          bundler-cache: true
+
+      - run: bundle exec rubocop

data/.github/workflows/release.yml

@@ -0,0 +1,28 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  push:
+    runs-on: ubuntu-latest
+
+    permissions:
+      # Push the version tag when `rake release` creates one.
+      contents: write
+      # Mint the OIDC token RubyGems trusted publishing authenticates with.
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.4"
+          bundler-cache: true
+
+      - run: bundle exec rspec
+
+      - uses: rubygems/release-gem@v1

data/.rubocop.yml

@@ -1,4 +1,8 @@
-Documentation:
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+
+Style/Documentation:
   Enabled: false
 
 Style/StringLiterals:
@@ -11,5 +15,12 @@ Metrics/BlockLength:
   Exclude:
     - spec/**/*
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+Metrics/ClassLength:
+  Exclude:
+    - lib/deepl_diff/tokenizer.rb

data/.ruby-version

@@ -0,0 +1 @@
+4.0.5

data/deepl_diff.gemspec

@@ -4,7 +4,7 @@ lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "deepl_diff/version"
 
-# rubocop:disable Metrics/BlockLength
+# rubocop:disable-next Metrics/BlockLength
 Gem::Specification.new do |spec|
   spec.name          = "deepl_diff"
   spec.version       = DeepLDiff::VERSION
@@ -21,12 +21,16 @@ DeepL API wrapper for Ruby which helps to translate only changes
 between revisions of long texts.
   )
   spec.homepage = "https://github.com/Halvanhelv/deepl_diff"
+  spec.required_ruby_version = ">= 3.2"
 
   if spec.respond_to?(:metadata)
     spec.metadata["allowed_push_host"] = "https://rubygems.org"
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    spec.metadata["rubygems_mfa_required"] = "true"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+          "public gem pushes."
   end
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
@@ -36,20 +40,17 @@ between revisions of long texts.
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "simplecov"
-
-  spec.add_dependency "connection_pool"
-  spec.add_dependency "deepl-rb"
-  spec.add_dependency "dry-initializer"
-  spec.add_dependency "ox"
-  spec.add_dependency "punkt-segmenter"
-  spec.add_dependency "ratelimit"
-  spec.add_dependency "redis"
-  spec.add_dependency "redis-namespace"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.13"
+  spec.add_development_dependency "rubocop", "~> 1.90"
+  spec.add_development_dependency "simplecov", "~> 1.2"
+
+  spec.add_dependency "connection_pool", ">= 2.4", "< 4.0"
+  spec.add_dependency "deepl-rb", "~> 3.9"
+  spec.add_dependency "dry-initializer", "~> 3.2"
+  spec.add_dependency "ox", "~> 2.14"
+  spec.add_dependency "punkt-segmenter", "~> 0.9"
+  spec.add_dependency "ratelimit", "~> 1.1"
+  spec.add_dependency "redis", ">= 5.0", "< 7.0"
+  spec.add_dependency "redis-namespace", "~> 1.11"
 end
-# rubocop:enable Metrics/BlockLength

data/lib/deepl_diff/chunker.rb

@@ -5,14 +5,17 @@ class DeepLDiff::Chunker
 
   class Error < StandardError; end
 
-  Chunk = Struct.new(:values, :size)
+  Chunk = Struct.new(:texts, :bytesize)
+
+  MAX_CHUNK_SIZE = 1700
+  COUNT_LIMIT = 300
 
   param :values
   option :limit, default: proc { MAX_CHUNK_SIZE }
   option :count_limit, default: proc { COUNT_LIMIT }
 
   def call
-    chunks.map(&:values)
+    chunks.map(&:texts)
   end
 
   def chunks
@@ -34,8 +37,8 @@ class DeepLDiff::Chunker
 
   def next_chunk?(tail, value)
     tail.nil? ||
-      (size(value) + tail.size > limit) ||
-      tail.values.size > count_limit
+      (size(value) + tail.bytesize > limit) ||
+      tail.texts.size > count_limit
   end
 
   def size(text)
@@ -43,14 +46,11 @@ class DeepLDiff::Chunker
   end
 
   def update_chunk(chunk, value)
-    chunk.values << value
-    chunk.size = chunk.size + value.size
+    chunk.texts << value
+    chunk.bytesize += value.size
   end
 
   def validate_value_size(value)
     raise Error, "Too long part #{value.size} > #{limit}" if value.size > limit
   end
-
-  MAX_CHUNK_SIZE = 1700
-  COUNT_LIMIT = 300
 end

data/lib/deepl_diff/linearizer.rb

@@ -5,7 +5,7 @@ class DeepLDiff::Linearizer
     def linearize(struct, array = [])
       case struct
       when Hash
-        struct.each { |_k, v| linearize(v, array) }
+        struct.each_value { |v| linearize(v, array) }
       when Array
         struct.each { |v| linearize(v, array) }
       else

data/lib/deepl_diff/request.rb

@@ -99,13 +99,13 @@ class DeepLDiff::Request
   # Restores indexes for translated tokens
   # => { ..., "1_1" => "Horoshiy", 1_3 => "Malchik", ... }
   def text_tokens_translated
-    @text_tokens_texts_translated ||=
+    @text_tokens_translated ||=
       restore(text_tokens, chunks_translated.flatten)
   end
 
   # Restores tokens translated + adds same spacing as in source token
   # => [[..., [ "Horoshiy", :text ], ...]]
-  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable-next Metrics/AbcSize
   def tokens_translated
     @tokens_translated ||= tokens.dup.tap do |tokens|
       text_tokens_translated.each do |index, value|
@@ -115,7 +115,6 @@ class DeepLDiff::Request
       end
     end
   end
-  # rubocop:enable Metrics/AbcSize
 
   def restore_spacing(source_value, value)
     DeepLDiff::Spacing.restore(source_value, value)
@@ -136,7 +135,7 @@ class DeepLDiff::Request
 
   def call_api(values)
     check_rate_limit(values)
-    [api.translate(values, from, to, **options)].flatten.map(&:text)
+    [api.translate(values, from, to, options)].flatten.map(&:text)
   end
 
   def cache

data/lib/deepl_diff/tokenizer.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
-class DeepLDiff::Tokenizer < ::Ox::Sax
+class DeepLDiff::Tokenizer < Ox::Sax
+  SKIP = %i[script style].freeze
+  INNER_SPANS = %i[notranslate span end_span end_notranslate].freeze
+  HTML_OPTIONS = { smart: true, skip: :skip_none }.freeze
+
+  # Ox::Sax provides no initializer to chain to.
+  # rubocop:disable-next Lint/MissingSuper
   def initialize(source)
     @pos = nil
     @source = source
@@ -38,7 +44,7 @@ class DeepLDiff::Tokenizer < ::Ox::Sax
     return if value == ""
 
     @sequence << (SKIP.include?(@context.last) ? :markup : :text)
-    @indicies << @pos - 1
+    @indicies << (@pos - 1)
   end
 
   def tokens
@@ -69,7 +75,7 @@ class DeepLDiff::Tokenizer < ::Ox::Sax
     tokens.concat(sentences(tokens.pop[0])) if tokens.last[1] == :text
   end
 
-  # rubocop: disable Metrics/MethodLength
+  # rubocop: disable-next Metrics/MethodLength
   def sentences(value)
     return [] if value.strip.empty?
 
@@ -87,7 +93,6 @@ class DeepLDiff::Tokenizer < ::Ox::Sax
       [value[left..right], :text]
     end
   end
-  # rubocop:enable Metrics/MethodLength
 
   # Whether the sequence is between `:notranslate` and `:end_notranslate`
   def notranslate?
@@ -129,7 +134,7 @@ class DeepLDiff::Tokenizer < ::Ox::Sax
                   else
                     :markup
                   end)
-    @indicies << @pos - 1
+    @indicies << (@pos - 1)
   end
 
   def end_markup(name)
@@ -139,7 +144,7 @@ class DeepLDiff::Tokenizer < ::Ox::Sax
                   else
                     :markup
                   end)
-    @indicies << @pos - 1 unless @pos == @source.bytesize
+    @indicies << (@pos - 1) unless @pos == @source.bytesize
   end
 
   class << self
@@ -152,8 +157,4 @@ class DeepLDiff::Tokenizer < ::Ox::Sax
       tokenizer.tokens
     end
   end
-
-  SKIP = %i[script style].freeze
-  INNER_SPANS = %i[notranslate span end_span end_notranslate].freeze
-  HTML_OPTIONS = { smart: true, skip: :skip_none }.freeze
 end

data/lib/deepl_diff/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeepLDiff
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/lib/deepl_diff.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+require "cgi/escape"
+require "digest/md5"
+require "forwardable"
+require "stringio"
+
 require "ox"
 require "punkt-segmenter"
 require "dry/initializer"
@@ -19,8 +24,8 @@ module DeepLDiff
   class << self
     attr_accessor :api, :cache_store, :rate_limiter
 
-    def translate(*args)
-      Request.new(*args).call
+    def translate(*)
+      Request.new(*).call
     end
   end
 

metadata

@@ -1,211 +1,194 @@
 --- !ruby/object:Gem::Specification
 name: deepl_diff
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Islam Gagiev
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-15 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.90'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.90'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: deepl-rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: dry-initializer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: ox
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: punkt-segmenter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: ratelimit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: redis-namespace
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.11'
 description: "\nDeepL API wrapper for Ruby which helps to translate only changes\nbetween
   revisions of long texts.\n  "
 email:
@@ -214,10 +197,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".ruby-version"
 - Gemfile
 - README.md
 - Rakefile
@@ -236,7 +221,9 @@ homepage: https://github.com/Halvanhelv/deepl_diff
 licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
+  homepage_uri: https://github.com/Halvanhelv/deepl_diff
+  source_code_uri: https://github.com/Halvanhelv/deepl_diff
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -244,15 +231,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: DeepL API wrapper for Ruby which helps to translate only changes between
   revisions of long texts.

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-sudo: false
-rvm:
-  - 2.3.3
-cache: bundler
-
-addons:
-  code_climate:
-    repo_token: "49b1afe0298c521f3d73377db0d20d1d4b9749ad533126bf3ed105fe9612eb0e"
-    
-after_success:
-  - bundle exec codeclimate-test-reporter