zache 0.13.1 → 0.14.0

data/test/test_zache.rb

@@ -1,147 +1,138 @@
 # frozen_string_literal: true
 
-# (The MIT License)
-#
-# Copyright (c) 2018-2023 Yegor Bugayenko
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the 'Software'), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
+# SPDX-FileCopyrightText: Copyright (c) 2018-2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
 
+require 'concurrent'
 require 'minitest/autorun'
+require 'securerandom'
 require 'threads'
 require 'timeout'
-require 'concurrent'
 require_relative '../lib/zache'
+require_relative 'test__helper'
 
 Thread.report_on_exception = true
 
 # Cache test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2018-2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2018-2025 Yegor Bugayenko
 # License:: MIT
 class ZacheTest < Minitest::Test
   def test_caches
     cache = Zache.new(sync: false)
-    first = cache.get(:hey, lifetime: 5) { Random.rand }
-    second = cache.get(:hey) { Random.rand }
-    assert(first == second)
+    first = cache.get(:hey, lifetime: 5) { rand }
+    second = cache.get(:hey) { rand }
+    assert_equal(first, second)
     assert_equal(1, cache.size)
   end
 
   def test_caches_and_expires
     cache = Zache.new
-    first = cache.get(:hey, lifetime: 0.01) { Random.rand }
+    first = cache.get(:hey, lifetime: 0.01) { rand }
     sleep 0.1
-    second = cache.get(:hey) { Random.rand }
-    assert(first != second)
+    second = cache.get(:hey) { rand }
+    refute_equal(first, second)
   end
 
   def test_calculates_age
     cache = Zache.new
-    cache.get(:hey) { Random.rand }
+    cache.get(:hey) { rand }
     sleep 0.1
-    assert(cache.mtime(:hey) < Time.now - 0.05)
+    assert_operator(cache.mtime(:hey), :<, Time.now - 0.05)
   end
 
   def test_caches_in_threads
     cache = Zache.new
     Threads.new(10).assert(100) do
-      cache.get(:hey, lifetime: 0.0001) { Random.rand }
+      cache.get(:hey, lifetime: 0.0001) { rand }
     end
   end
 
   def test_key_exists
     cache = Zache.new
-    cache.get(:hey) { Random.rand }
+    cache.get(:hey) { rand }
     exists_result = cache.exists?(:hey)
     not_exists_result = cache.exists?(:bye)
-    assert(exists_result == true)
-    assert(not_exists_result == false)
+    assert(exists_result)
+    refute(not_exists_result)
   end
 
   def test_put_and_exists
     cache = Zache.new
     cache.put(:hey, 'hello', lifetime: 0.1)
     sleep 0.2
-    assert(!cache.exists?(:hey))
+    refute(cache.exists?(:hey))
   end
 
   def test_remove_key
     cache = Zache.new
-    cache.get(:hey) { Random.rand }
-    cache.get(:wey) { Random.rand }
-    assert(cache.exists?(:hey) == true)
-    assert(cache.exists?(:wey) == true)
+    cache.get(:hey) { rand }
+    cache.get(:wey) { rand }
+    assert(cache.exists?(:hey))
+    assert(cache.exists?(:wey))
     cache.remove(:hey)
-    assert(cache.exists?(:hey) == false)
-    assert(cache.exists?(:wey) == true)
+    refute(cache.exists?(:hey))
+    assert(cache.exists?(:wey))
   end
 
   def test_remove_by_block
     cache = Zache.new
-    cache.get('first') { Random.rand }
-    cache.get('second') { Random.rand }
+    cache.get('first') { rand }
+    cache.get('second') { rand }
     cache.remove_by { |k| k == 'first' }
-    assert(cache.exists?('first') == false)
-    assert(cache.exists?('second') == true)
+    refute(cache.exists?('first'))
+    assert(cache.exists?('second'))
   end
 
   def test_remove_key_with_sync_false
     cache = Zache.new(sync: false)
-    cache.get(:hey) { Random.rand }
-    cache.get(:wey) { Random.rand }
-    assert(cache.exists?(:hey) == true)
-    assert(cache.exists?(:wey) == true)
+    cache.get(:hey) { rand }
+    cache.get(:wey) { rand }
+    assert(cache.exists?(:hey))
+    assert(cache.exists?(:wey))
     cache.remove(:hey)
-    assert(cache.exists?(:hey) == false)
-    assert(cache.exists?(:wey) == true)
+    refute(cache.exists?(:hey))
+    assert(cache.exists?(:wey))
   end
 
   def test_clean_with_threads
     cache = Zache.new
     Threads.new(300).assert(3000) do
-      cache.get(:hey) { Random.rand }
-      cache.get(:bye, lifetime: 0.01) { Random.rand }
+      cache.get(:hey) { rand }
+      cache.get(:bye, lifetime: 0.01) { rand }
       sleep 0.1
       cache.clean
     end
-    assert(cache.exists?(:hey) == true)
-    assert(cache.exists?(:bye) == false)
+    assert(cache.exists?(:hey))
+    refute(cache.exists?(:bye))
   end
 
   def test_clean
     cache = Zache.new
-    cache.get(:hey) { Random.rand }
-    cache.get(:bye, lifetime: 0.01) { Random.rand }
+    cache.get(:hey) { rand }
+    cache.get(:bye, lifetime: 0.01) { rand }
+    sleep 0.1
+    cache.clean
+    assert(cache.exists?(:hey))
+    refute(cache.exists?(:bye))
+  end
+
+  def test_clean_size
+    cache = Zache.new
+    cache.get(:hey, lifetime: 0.01) { rand }
     sleep 0.1
     cache.clean
-    assert(cache.exists?(:hey) == true)
-    assert(cache.exists?(:bye) == false)
+    assert_empty(cache)
   end
 
   def test_clean_with_sync_false
     cache = Zache.new(sync: false)
-    cache.get(:hey) { Random.rand }
-    cache.get(:bye, lifetime: 0.01) { Random.rand }
+    cache.get(:hey) { rand }
+    cache.get(:bye, lifetime: 0.01) { rand }
     sleep 0.1
     cache.clean
-    assert(cache.exists?(:hey) == true)
-    assert(cache.exists?(:bye) == false)
+    assert(cache.exists?(:hey))
+    refute(cache.exists?(:bye))
   end
 
   def test_remove_absent_key
@@ -151,43 +142,43 @@ class ZacheTest < Minitest::Test
 
   def test_check_and_remove
     cache = Zache.new
-    cache.get(:hey, lifetime: 0) { Random.rand }
-    assert(!cache.exists?(:hey))
+    cache.get(:hey, lifetime: 0) { rand }
+    refute(cache.exists?(:hey))
   end
 
   def test_remove_all_with_threads
     cache = Zache.new
     Threads.new(10).assert(100) do |i|
-      cache.get("hey#{i}".to_sym) { Random.rand }
-      assert(cache.exists?("hey#{i}".to_sym) == true)
+      cache.get(:"hey#{i}") { rand }
+      assert(cache.exists?(:"hey#{i}"))
       cache.remove_all
     end
     10.times do |i|
-      assert(cache.exists?("hey#{i}".to_sym) == false)
+      refute(cache.exists?(:"hey#{i}"))
     end
   end
 
   def test_remove_all_with_sync
     cache = Zache.new
-    cache.get(:hey) { Random.rand }
-    cache.get(:bye) { Random.rand }
+    cache.get(:hey) { rand }
+    cache.get(:bye) { rand }
     cache.remove_all
-    assert(cache.exists?(:hey) == false)
-    assert(cache.exists?(:bye) == false)
+    refute(cache.exists?(:hey))
+    refute(cache.exists?(:bye))
   end
 
   def test_remove_all_without_sync
     cache = Zache.new(sync: false)
-    cache.get(:hey) { Random.rand }
-    cache.get(:bye) { Random.rand }
+    cache.get(:hey) { rand }
+    cache.get(:bye) { rand }
     cache.remove_all
-    assert(cache.exists?(:hey) == false)
-    assert(cache.exists?(:bye) == false)
+    refute(cache.exists?(:hey))
+    refute(cache.exists?(:bye))
   end
 
   def test_puts_something_in
     cache = Zache.new(sync: false)
-    cache.get(:hey) { Random.rand }
+    cache.get(:hey) { rand }
     cache.put(:hey, 123)
     assert_equal(123, cache.get(:hey))
   end
@@ -208,19 +199,19 @@ class ZacheTest < Minitest::Test
       end
     end
     sleep 0.1
-    assert(cache.locked?)
+    assert_predicate(cache, :locked?)
     cache.get(:x) { 'second' }
-    assert(!cache.locked?)
+    refute_predicate(cache, :locked?)
     long.kill
   end
 
   def test_checks_locked_status_from_inside
     cache = Zache.new
     cache.get(:x) do
-      assert(cache.locked?)
+      assert_predicate(cache, :locked?)
       'done'
     end
-    assert(!cache.locked?)
+    refute_predicate(cache, :locked?)
   end
 
   def test_returns_dirty_result
@@ -285,4 +276,22 @@ class ZacheTest < Minitest::Test
       cache.get(:hey) { raise 'intentional' }
     end
   end
+
+  def test_returns_placeholder_in_eager_mode
+    cache = Zache.new
+    a = cache.get(:me, placeholder: 42, eager: true) do
+      sleep 0.1
+      43
+    end
+    assert_equal(42, a)
+    sleep 0.2
+    b = cache.get(:me)
+    assert_equal(43, b)
+  end
+
+  private
+
+  def rand
+    SecureRandom.uuid
+  end
 end

data/zache.gemspec

@@ -1,39 +1,20 @@
 # frozen_string_literal: true
 
-# (The MIT License)
-#
-# Copyright (c) 2018-2023 Yegor Bugayenko
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the 'Software'), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
+# SPDX-FileCopyrightText: Copyright (c) 2018-2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
 
 require 'English'
 Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
-  s.required_ruby_version = '>=2.5'
+  s.required_ruby_version = '>= 2.5'
   s.name = 'zache'
-  s.version = '0.13.1'
+  s.version = '0.14.0' # Version should be updated before release
   s.license = 'MIT'
   s.summary = 'In-memory Cache'
   s.description = 'Zero-footprint in-memory thread-safe cache'
   s.authors = ['Yegor Bugayenko']
   s.email = 'yegor256@gmail.com'
-  s.homepage = 'http://github.com/yegor256/zache'
+  s.homepage = 'https://github.com/yegor256/zache'
   s.files = `git ls-files`.split($RS)
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = ['README.md']

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: zache
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Yegor Bugayenko
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-01 00:00:00.000000000 Z
+date: 2025-04-12 00:00:00.000000000 Z
 dependencies: []
 description: Zero-footprint in-memory thread-safe cache
 email: yegor256@gmail.com
@@ -18,17 +17,26 @@ extra_rdoc_files:
 - README.md
 files:
 - ".0pdd.yml"
+- ".github/workflows/actionlint.yml"
 - ".github/workflows/codecov.yml"
+- ".github/workflows/copyrights.yml"
+- ".github/workflows/license.yml"
+- ".github/workflows/markdown-lint.yml"
 - ".github/workflows/pdd.yml"
 - ".github/workflows/rake.yml"
+- ".github/workflows/reuse.yml"
 - ".github/workflows/xcop.yml"
+- ".github/workflows/yamllint.yml"
 - ".gitignore"
 - ".pdd"
 - ".rubocop.yml"
 - ".rultor.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
+- LICENSES/MIT.txt
 - README.md
+- REUSE.toml
 - Rakefile
 - lib/zache.rb
 - logo.svg
@@ -36,12 +44,11 @@ files:
 - test/test__helper.rb
 - test/test_zache.rb
 - zache.gemspec
-homepage: http://github.com/yegor256/zache
+homepage: https://github.com/yegor256/zache
 licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -57,8 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: In-memory Cache
 test_files: []