deepl_diff 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19d6f34da084b57edb1a50356fd34be56d93bd2a968aea99deb93f4233fb3620
-  data.tar.gz: a7ee76936e0cb0e19ad569b93f671967cec2285d9a656b76a2fbe6e93c9776a4
+  metadata.gz: ca22132db1cfc83ab8e56a9a17bd635ca3648e9d7fde32a2df13dce21991f946
+  data.tar.gz: '018f598439a77db2e229d2c95f7b8ff0c14c0f17ba7130e19cbdf3f897b716a6'
 SHA512:
-  metadata.gz: 3f966fa796638f71d87b565fe8d7db7de0f0902c05a4f0767566a2fb5a2a034e7f2920c20e562195e4449d99379ffb415209a1946401e1476cc98e7118264c07
-  data.tar.gz: fe7d3e2da279d6701c5c9ba92196517d6cdbfb93fd728cbd0370827de92fcc2d857945cf87c160ac16193f4698df1ef7402fbf895a990827cf27b8948e772a5f
+  metadata.gz: 0144f0c5d615c25036d0f2f2b41238667e6ab045442714e45235c8192f49c70fdeeb92753c6e7ec5f0e1189de3064191bdbb2014108a5715942ee1455f6ae76f
+  data.tar.gz: 71a0a99b3f5869bec1f2383f8d212c6ead9bd63f9e5eb5a9f8ad98ed2aa93f0701d5775b9de3764c21aad7ac96f11afe2a506e674056f9a97a80ed5d357c65b6

data/.github/workflows/ci.yml

@@ -21,7 +21,7 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
 
-      - run: bundle exec rspec
+      - run: bundle exec rake test
 
   lint:
     runs-on: ubuntu-latest

data/.github/workflows/release.yml

@@ -23,6 +23,6 @@ jobs:
           ruby-version: "3.4"
           bundler-cache: true
 
-      - run: bundle exec rspec
+      - run: bundle exec rake test
 
       - uses: rubygems/release-gem@v1

data/.gitignore

@@ -5,9 +5,7 @@
 /coverage/
 /doc/
 /pkg/
-/spec/reports/
+/test/reports/
 /tmp/
 
-# rspec failure tracking
-.rspec_status
 test.rb

data/.rubocop.yml

@@ -13,7 +13,7 @@ Style/ClassAndModuleChildren:
 
 Metrics/BlockLength:
   Exclude:
-    - spec/**/*
+    - test/**/*
 
 Layout/LineLength:
   Max: 120
@@ -24,3 +24,6 @@ Gemspec/DevelopmentDependencies:
 Metrics/ClassLength:
   Exclude:
     - lib/deepl_diff/tokenizer.rb
+    - lib/deepl_diff/request.rb
+    # Test classes are mostly tables of cases.
+    - test/**/*

data/README.md

@@ -17,6 +17,16 @@ If your user changes a single word within the long description, you will be char
 
 Much better approach is to try to translate every repeated structural element (sentence) in your texts array just once to save money. This gem helps to make it done.
 
+## Dependencies
+
+This gem loads two: [`ox`](https://github.com/ohler55/ox) to walk the HTML, and
+[`punkt-segmenter`](https://github.com/lfcipriani/punkt-segmenter) to split text
+into sentences.
+
+Everything else is duck typed and supplied by you: `DeepLDiff.api` is anything
+answering to `#translate`, and both `RedisCacheStore` and `RedisRateLimiter`
+take anything answering to `#with`. Bring your own client, pool and store.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -38,11 +48,14 @@ Or install it yourself as:
 ```ruby
 require "deepl_diff"
 
-# This dependencies are not included, as you might need to roll your own cache based on different store
+# None of these are dependencies of this gem. It loads only `ox` and
+# `punkt-segmenter`; the API client, the connection pool, and whatever backs
+# the cache and the rate limiter are yours to choose and to require.
+require "deepl"
 require "redis"
 require "connection_pool"
 require "redis-namespace"
-require "ratelimit" # Optional, if you will use
+require "ratelimit" # Optional, only if you use the rate limiter
 
 # Setup https://github.com/wikiti/deepl-rb
 DeepL.configure do |config|
@@ -108,10 +121,10 @@ DeepL API has a limitation: query can not be longer than approximately 128 KB. I
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/wikiti/deepl-rb.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Halvanhelv/deepl_diff.

data/Rakefile

@@ -1,8 +1,14 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require "rake/testtask"
 
-RSpec::Core::RakeTask.new(:spec)
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  # The dependencies are noisy under -w; their warnings drown out our own.
+  t.warning = false
+end
 
-task default: :spec
+task default: :test

data/deepl_diff.gemspec

@@ -40,17 +40,14 @@ between revisions of long texts.
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_development_dependency "minitest", "~> 6.0"
   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"
+  # The only two gems this one loads. Everything else -- the DeepL client, the
+  # connection pool, and whatever backs the cache and the rate limiter -- is
+  # supplied by the application and duck typed, so it stays out of the gemspec.
   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

data/lib/deepl_diff/cache.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 class DeepLDiff::Cache
-  extend Dry::Initializer
-
-  param :from
-  param :to
+  def initialize(from, to)
+    @from = from
+    @to = to
+  end
 
   def cached_and_missing(values)
     keys = values.map { |v| key(v) }
@@ -22,6 +22,8 @@ class DeepLDiff::Cache
 
   private
 
+  attr_reader :from, :to
+
   def store_value(value, translation)
     cache_store.write(key(value), translation)
     translation

data/lib/deepl_diff/chunker.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 class DeepLDiff::Chunker
-  extend ::Dry::Initializer
-
   class Error < StandardError; end
 
   Chunk = Struct.new(:texts, :bytesize)
@@ -10,9 +8,11 @@ class DeepLDiff::Chunker
   MAX_CHUNK_SIZE = 1700
   COUNT_LIMIT = 300
 
-  param :values
-  option :limit, default: proc { MAX_CHUNK_SIZE }
-  option :count_limit, default: proc { COUNT_LIMIT }
+  def initialize(values, limit: MAX_CHUNK_SIZE, count_limit: COUNT_LIMIT)
+    @values = values
+    @limit = limit
+    @count_limit = count_limit
+  end
 
   def call
     chunks.map(&:texts)
@@ -35,6 +35,8 @@ class DeepLDiff::Chunker
 
   private
 
+  attr_reader :values, :limit, :count_limit
+
   def next_chunk?(tail, value)
     tail.nil? ||
       (size(value) + tail.bytesize > limit) ||

data/lib/deepl_diff/redis_cache_store.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
 class DeepLDiff::RedisCacheStore
-  extend Dry::Initializer
+  ONE_WEEK = 60 * 60 * 24 * 7
 
-  param :connection_pool
-
-  option :timeout, default: proc { 60 * 60 * 24 * 7 }
-  option :namespace, default: proc { DeepLDiff::CACHE_NAMESPACE }
+  # `connection_pool` is anything answering to #with, and what it yields is
+  # anything Redis::Namespace accepts. Neither gem is a dependency of this one.
+  def initialize(connection_pool, timeout: ONE_WEEK, namespace: DeepLDiff::CACHE_NAMESPACE)
+    @connection_pool = connection_pool
+    @timeout = timeout
+    @namespace = namespace
+  end
 
   def read_multi(keys)
     redis { |redis| redis.mget(*keys) }
@@ -18,6 +21,8 @@ class DeepLDiff::RedisCacheStore
 
   private
 
+  attr_reader :connection_pool, :timeout, :namespace
+
   def redis
     connection_pool.with do |redis|
       yield Redis::Namespace.new(namespace, redis: redis)

data/lib/deepl_diff/redis_rate_limiter.rb

@@ -1,15 +1,22 @@
 # frozen_string_literal: true
 
 class DeepLDiff::RedisRateLimiter
-  extend Dry::Initializer
-
   class RateLimitExceeded < StandardError; end
 
-  param :connection_pool
-  param :threshold, default: proc { 8000 }
-  param :interval,  default: proc { 60 }
+  DEFAULT_THRESHOLD = 8000
+  DEFAULT_INTERVAL = 60
 
-  option :namespace, default: proc { DeepLDiff::CACHE_NAMESPACE }
+  # `connection_pool` is anything answering to #with, and what it yields is
+  # anything Ratelimit accepts. Neither gem is a dependency of this one.
+  def initialize(connection_pool,
+                 threshold: DEFAULT_THRESHOLD,
+                 interval: DEFAULT_INTERVAL,
+                 namespace: DeepLDiff::CACHE_NAMESPACE)
+    @connection_pool = connection_pool
+    @threshold = threshold
+    @interval = interval
+    @namespace = namespace
+  end
 
   def check(size)
     connection_pool.with do |redis|
@@ -19,4 +26,8 @@ class DeepLDiff::RedisRateLimiter
       rate_limit.add size
     end
   end
+
+  private
+
+  attr_reader :connection_pool, :threshold, :interval, :namespace
 end

data/lib/deepl_diff/request.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
 class DeepLDiff::Request
-  extend Dry::Initializer
   extend Forwardable
 
-  param :values
-  param :options
-
   def_delegators :DeepLDiff, :api, :cache_store, :rate_limiter
   def_delegators :"DeepLDiff::Linearizer", :linearize, :restore
 
+  def initialize(values, options)
+    @values = values
+    @options = options
+  end
+
   def call
     validate_globals
 
@@ -20,6 +21,8 @@ class DeepLDiff::Request
 
   private
 
+  attr_reader :values, :options
+
   def from
     @from ||= options.delete(:from) || detect_language
   end

data/lib/deepl_diff/version.rb

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

data/lib/deepl_diff.rb

@@ -7,8 +7,6 @@ require "stringio"
 
 require "ox"
 require "punkt-segmenter"
-require "dry/initializer"
-require "deepl"
 
 require "deepl_diff/version"
 require "deepl_diff/tokenizer"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deepl_diff
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Islam Gagiev
@@ -10,33 +10,33 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -65,54 +65,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: connection_pool
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        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: '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: '3.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: dry-initializer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: ox
   requirement: !ruby/object:Gem::Requirement
@@ -141,54 +93,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: ratelimit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: redis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        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: '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: '1.11'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
 description: "\nDeepL API wrapper for Ruby which helps to translate only changes\nbetween
   revisions of long texts.\n  "
 email:
@@ -200,7 +104,6 @@ files:
 - ".github/workflows/ci.yml"
 - ".github/workflows/release.yml"
 - ".gitignore"
-- ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
 - Gemfile

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color