zache 0.13.2 → 0.14.0

data/Gemfile.lock

@@ -6,72 +6,110 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
+    ansi (1.5.0)
+    ast (2.4.3)
     backtrace (0.4.0)
-    concurrent-ruby (1.3.3)
-    docile (1.4.0)
-    json (2.7.2)
-    language_server-protocol (3.17.0.3)
-    minitest (5.24.1)
-    parallel (1.25.1)
-    parser (3.3.4.0)
+    builder (3.3.0)
+    concurrent-ruby (1.3.5)
+    docile (1.4.1)
+    elapsed (0.0.1)
+      loog (> 0)
+      tago (> 0)
+    json (2.10.2)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    loog (0.6.0)
+    minitest (5.25.5)
+    minitest-reporters (1.7.1)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    os (1.1.4)
+    parallel (1.26.3)
+    parser (3.3.7.4)
       ast (~> 2.4.1)
       racc
-    psych (5.1.2)
-      stringio
-    racc (1.8.0)
+    prism (1.4.0)
+    qbash (0.4.0)
+      backtrace (> 0)
+      elapsed (> 0)
+      loog (> 0)
+      tago (> 0)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
-    rdoc (6.7.0)
-      psych (>= 4.0.0)
-    regexp_parser (2.9.2)
-    rexml (3.3.2)
-      strscan
-    rubocop (1.65.0)
+    regexp_parser (2.10.0)
+    rexml (3.4.1)
+    rubocop (1.75.2)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.4, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
-      parser (>= 3.3.1.0)
-    rubocop-rspec (3.0.3)
-      rubocop (~> 1.61)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-minitest (0.38.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-performance (1.25.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
+    simplecov-cobertura (2.1.0)
+      rexml
+      simplecov (~> 0.19)
+    simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    stringio (3.1.1)
-    strscan (3.1.0)
-    threads (0.4.0)
+    tago (0.1.0)
+    threads (0.4.1)
       backtrace (~> 0)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    yard (0.9.37)
 
 PLATFORMS
   arm64-darwin-22
+  arm64-darwin-23
+  arm64-darwin-24
+  x64-mingw-ucrt
   x86_64-darwin-20
   x86_64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
-  concurrent-ruby (= 1.3.3)
-  minitest (= 5.24.1)
-  rake (= 13.2.1)
-  rdoc (= 6.7.0)
-  rubocop (= 1.65.0)
-  rubocop-rspec (= 3.0.3)
-  simplecov (= 0.22.0)
-  threads (= 0.4.0)
+  concurrent-ruby (~> 1.3)
+  minitest (~> 5.25)
+  minitest-reporters (~> 1.7)
+  os (> 0)
+  qbash (> 0)
+  rake (~> 13.2)
+  rubocop (~> 1.75)
+  rubocop-minitest (> 0)
+  rubocop-performance (> 0)
+  rubocop-rake (> 0)
+  simplecov (~> 0.22)
+  simplecov-cobertura (~> 2.1)
+  threads (~> 0.4)
+  yard (~> 0.9)
   zache!
 
 BUNDLED WITH
-   2.5.6
+   2.5.16

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018-2024 Yegor Bugayenko
+Copyright (c) 2018-2025 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

data/LICENSES/MIT.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018-2025 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 NON-INFRINGEMENT. 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.

data/README.md

@@ -1,20 +1,20 @@
 # In Memory Cache for Ruby
 
 [![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)
-[![DevOps By Rultor.com](http://www.rultor.com/b/yegor256/zache)](http://www.rultor.com/p/yegor256/zache)
+[![DevOps By Rultor.com](https://www.rultor.com/b/yegor256/zache)](https://www.rultor.com/p/yegor256/zache)
 [![We recommend RubyMine](https://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)
 
 [![rake](https://github.com/yegor256/zache/actions/workflows/rake.yml/badge.svg)](https://github.com/yegor256/zache/actions/workflows/rake.yml)
-[![Gem Version](https://badge.fury.io/rb/zache.svg)](http://badge.fury.io/rb/zache)
+[![Gem Version](https://badge.fury.io/rb/zache.svg)](https://badge.fury.io/rb/zache)
 [![Maintainability](https://api.codeclimate.com/v1/badges/c136afe340fa94f14696/maintainability)](https://codeclimate.com/github/yegor256/zache/maintainability)
-[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/yegor256/zache/master/frames)
+[![Yard Docs](https://img.shields.io/badge/yard-docs-blue.svg)](https://rubydoc.info/github/yegor256/zache/master/frames)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/zache/blob/master/LICENSE.txt)
 [![Test Coverage](https://img.shields.io/codecov/c/github/yegor256/zache.svg)](https://codecov.io/github/yegor256/zache?branch=master)
 [![Hits-of-Code](https://hitsofcode.com/github/yegor256/zache)](https://hitsofcode.com/view/github/yegor256/zache)
 
-It's a simple Ruby gem for in-memory cache.
+This is a simple Ruby gem for in-memory caching.
 Read [this blog post](https://www.yegor256.com/2019/02/05/zache.html)
-to understand what Zache is for.
+to understand what Zache is designed for.
 
 First, install it:
 
@@ -22,41 +22,67 @@ First, install it:
 gem install zache
 ```
 
-Then, use it like this
+Then, use it like this:
 
 ```ruby
 require 'zache'
 zache = Zache.new
 # Expires in 5 minutes
-v = zache.get(:count, lifetime: 5 * 60) { expensive() }
+v = zache.get(:count, lifetime: 5 * 60) { expensive_calculation() }
 ```
 
+If you omit the `lifetime` parameter, the key will never expire.
+
 By default `Zache` is thread-safe. It locks the entire cache on each
-`get` call. You turn that off by using `sync` argument:
+`get` call. You can turn that off by using the `sync` argument:
 
 ```ruby
 zache = Zache.new(sync: false)
-v = zache.get(:count) { expensive() }
+v = zache.get(:count) { expensive_calculation() }
 ```
 
-You may use "dirty" mode, which will return you an expired value, while
-calculation is waiting. Say, you have something in the cache, but it's
-expired. Then, you call `get` with a long running block. The thread waits,
-while another one calls `get` again. That second thread won't wait, but will
-receive what's left in the cache. This is a very convenient mode for situations
-when you don't really care about data accuracy, but performance is an issue.
+You may use "dirty" mode, which will return an expired value while
+calculation is in progress. For example, if you have a value in the cache that's
+expired, and you call `get` with a long-running block, the thread waits.
+If another thread calls `get` again, that second thread won't wait, but will
+receive the expired value from the cache. This is a very convenient mode for situations
+where absolute data accuracy is less important than performance:
+
+```ruby
+zache = Zache.new(dirty: true)
+# Or enable dirty mode for a specific get call
+value = zache.get(:key, dirty: true) { expensive_calculation() }
+```
 
 The entire API is documented
-[here](https://www.rubydoc.info/github/yegor256/zache/master/Zache)
-(there are many other convenient methods).
+[here](https://www.rubydoc.info/github/yegor256/zache/master/Zache).
+Here are some additional useful methods:
+
+```ruby
+# Check if a key exists
+zache.exists?(:key)
 
-That's it.
+# Remove a key
+zache.remove(:key)
+
+# Remove all keys
+zache.remove_all
+
+# Remove keys that match a condition
+zache.remove_by { |key| key.to_s.start_with?('temp_') }
+
+# Clean up expired keys
+zache.clean
+
+# Check if cache is empty
+zache.empty?
+```
 
 ## How to contribute
 
 Read
 [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
-Make sure you build is green before you contribute
+Make sure your build is green before you contribute
 your pull request. You will need to have
 [Ruby](https://www.ruby-lang.org/en/) 2.3+ and
 [Bundler](https://bundler.io/) installed. Then:

data/REUSE.toml

@@ -0,0 +1,31 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+version = 1
+[[annotations]]
+path = [
+    "**/*.csv",
+    "**/*.jpg",
+    "**/*.json",
+    "**/*.md",
+    "**/*.pdf",
+    "**/*.png",
+    "**/*.svg",
+    "**/*.txt",
+    "**/*.vm",
+    "**/.DS_Store",
+    "**/.gitignore",
+    "**/.pdd",
+    "**/CNAME",
+    "**/Gemfile.lock",
+    ".DS_Store",
+    ".gitattributes",
+    ".gitignore",
+    ".pdd",
+    "Gemfile.lock",
+    "README.md",
+    "renovate.json",
+]
+precedence = "override"
+SPDX-FileCopyrightText = "Copyright (c) 2018-2025 Yegor Bugayenko"
+SPDX-License-Identifier = "MIT"

data/Rakefile

@@ -1,25 +1,10 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2018-2024 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 'os'
+require 'qbash'
 require 'rubygems'
 require 'rake'
 require 'rake/clean'
@@ -34,7 +19,7 @@ def version
   Gem::Specification.load(Dir['*.gemspec'].first).version
 end
 
-task default: %i[clean test rubocop copyright]
+task default: %i[clean test picks rubocop yard]
 
 require 'rake/testtask'
 desc 'Run all unit tests'
@@ -44,24 +29,24 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = false
 end
 
-require 'rdoc/task'
-RDoc::Task.new do |rdoc|
-  rdoc.main = 'README.md'
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
+desc 'Run them via Ruby, one by one'
+task :picks do
+  next if OS.windows?
+  %w[test lib].each do |d|
+    Dir["#{d}/**/*.rb"].each do |f|
+      qbash("bundle exec ruby #{Shellwords.escape(f)}", log: $stdout, env: { 'PICKS' => 'yes' })
+    end
+  end
+end
+
+require 'yard'
+desc 'Build Yard documentation'
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
 end
 
 require 'rubocop/rake_task'
 desc 'Run RuboCop on all directories'
 RuboCop::RakeTask.new(:rubocop) do |task|
   task.fail_on_error = true
-  task.requires << 'rubocop-rspec'
-end
-
-task :copyright do
-  sh "grep -q -r '2018-#{Date.today.strftime('%Y')}' \
-    --include '*.rb' \
-    --include '*.txt' \
-    --include 'Rakefile' \
-    ."
 end