sin_lru_redux 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e3321a712e82f58a5a56395d60775b0ca747408656e82accb07fe9a6a9a3b0d4
+  data.tar.gz: 83da0216f823ae497b57957c2f267d79d08299e59fba4735ba10e43018a72773
+SHA512:
+  metadata.gz: 5cb2a8d0c6b9e66e20c72f88c12c578aff52f6e07a70450969e1f2ec9fc209fb95afd63627630dac1d6c459d5723ffaa7001aa1525ac384491625df4a6b81a8b
+  data.tar.gz: ef5f5c33c8a24d3769bbfa0bf7fa64c9ef1c01465d48d4119242b727b4b01a4b8f545f880d80be30796de819270dcc069336936b6dc2ecf2ad6dab47ec79c767

data/.github/workflows/lint.yml

@@ -0,0 +1,18 @@
+name: Lint
+on:
+  pull_request:
+    paths:
+      - '**/*.rb'
+permissions:
+  contents: read
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - name: RuboCop
+        run: bundle exec rake rubocop

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Test
+on:
+  pull_request:
+permissions:
+  contents: read
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: [2.3, 2.4, 2.5, 2.6, 2.7, 3.0, 3.1, 3.2, 3.3, 3.4]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake test

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+*.swp
+.bundle
+.config
+.vscode
+.yardoc
+_yardoc
+coverage
+doc/
+Gemfile.lock
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rubocop.yml

@@ -0,0 +1,202 @@
+require:
+  - rubocop-minitest
+  - rubocop-performance
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.4
+  NewCops: enable
+
+# https://docs.rubocop.org/rubocop/cops_gemspec.html#gemspecrequiredrubyversion
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+# https://docs.rubocop.org/rubocop/cops_layout.html#layoutfirstarrayelementindentation
+Layout/FirstArrayElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+# https://docs.rubocop.org/rubocop/cops_layout.html#layoutlinelength
+Layout/LineLength:
+  Enabled: true
+  Max: 150
+  AllowURI: false
+
+# https://docs.rubocop.org/rubocop/cops_lint.html#lintmissingsuper
+Lint/MissingSuper:
+  Enabled: true
+  Exclude:
+    - 'app/views/components/**/component.rb'
+
+# https://docs.rubocop.org/rubocop/cops_metrics.html#metricsabcsize
+Metrics/AbcSize:
+  Enabled: true
+  Max: 30
+
+# https://docs.rubocop.org/rubocop/cops_metrics.html#metricsblocklength
+Metrics/BlockLength:
+  Enabled: true
+  Max: 30
+  Exclude:
+    - 'config/routes.rb'
+    - 'db/seeds.rb'
+    - 'spec/**/*_spec.rb'
+
+# https://docs.rubocop.org/rubocop/cops_metrics.html#metricsblocknesting
+Metrics/BlockNesting:
+  Enabled: true
+  Max: 3
+
+# https://docs.rubocop.org/rubocop/cops_metrics.html#metricsclasslength
+Metrics/ClassLength:
+  Enabled: true
+  CountComments: false
+  Max: 400
+
+# https://docs.rubocop.org/rubocop/cops_metrics.html#metricscyclomaticcomplexity
+Metrics/CyclomaticComplexity:
+  Enabled: true
+  Max: 20
+
+# https://docs.rubocop.org/rubocop/cops_metrics.html#metricsmethodlength
+Metrics/MethodLength:
+  Enabled: true
+  CountComments: false
+  Max: 25
+
+# https://docs.rubocop.org/rubocop/cops_metrics.html#metricsmodulelength
+Metrics/ModuleLength:
+  Enabled: true
+  Max: 200
+
+# https://docs.rubocop.org/rubocop/cops_metrics.html#metricsparameterlists
+Metrics/ParameterLists:
+  Enabled: true
+  Max: 5
+  CountKeywordArgs: true
+
+# https://docs.rubocop.org/rubocop/cops_metrics.html#metricsperceivedcomplexity
+Metrics/PerceivedComplexity:
+  Enabled: true
+  Max: 20
+
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingaccessormethodname
+Naming/AccessorMethodName:
+  Enabled: false
+
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingblockforwarding
+Naming/BlockForwarding:
+  Enabled: true
+  EnforcedStyle: explicit
+
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingmemoizedinstancevariablename
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+# https://docs.rubocop.org/rubocop/cops_style.html#styleaccessmodifierdeclarations
+Style/AccessModifierDeclarations:
+  Enabled: true
+  AllowModifiersOnSymbols: false
+
+# https://docs.rubocop.org/rubocop/cops_style.html#stylealias
+Style/Alias:
+  Enabled: true
+  EnforcedStyle: prefer_alias_method
+
+# https://docs.rubocop.org/rubocop/cops_style.html#styleargumentsforwarding
+Style/ArgumentsForwarding:
+  Enabled: true
+  UseAnonymousForwarding: false
+
+# https://docs.rubocop.org/rubocop/cops_style.html#styleasciicomments
+Style/AsciiComments:
+  Enabled: false
+
+# https://docs.rubocop.org/rubocop/cops_style.html#styleblockcomments
+Style/BlockComments:
+  Enabled: true
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+# https://docs.rubocop.org/rubocop/cops_style.html#styleclassandmodulechildren
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# https://docs.rubocop.org/rubocop/cops_style.html#stylecollectionmethods
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    detect: 'detect'
+    find: 'detect'
+    inject: 'inject'
+    reduce: 'inject'
+
+# https://docs.rubocop.org/rubocop/cops_style.html#styleconditionalassignment
+Style/ConditionalAssignment:
+  Enabled: true
+  EnforcedStyle: assign_inside_condition
+
+# https://docs.rubocop.org/rubocop/cops_style.html#styledocumentation
+Style/Documentation:
+  Enabled: false
+
+# https://docs.rubocop.org/rubocop/cops_style.html#styleemptymethod
+Style/EmptyMethod:
+  Enabled: true
+  EnforcedStyle: expanded
+
+# https://docs.rubocop.org/rubocop/cops_style.html#stylehashsyntax
+Style/HashSyntax:
+  Enabled: true
+  EnforcedStyle: ruby19_no_mixed_keys
+  EnforcedShorthandSyntax: never
+
+# https://docs.rubocop.org/rubocop/cops_style.html#stylelambda
+Style/Lambda:
+  Enabled: true
+  EnforcedStyle: literal
+
+# https://docs.rubocop.org/rubocop/cops_style.html#stylelineendconcatenation
+Style/LineEndConcatenation:
+  Enabled: false
+
+# https://docs.rubocop.org/rubocop/cops_style.html#stylenumericliterals
+Style/NumericLiterals:
+  Enabled: false
+
+# https://docs.rubocop.org/rubocop/cops_style.html#stylenumericpredicate
+Style/NumericPredicate:
+  Enabled: true
+  EnforcedStyle: comparison
+
+# https://docs.rubocop.org/rubocop/cops_style.html#styleraiseargs
+Style/RaiseArgs:
+  Enabled: true
+  EnforcedStyle: compact
+
+# https://docs.rubocop.org/rubocop/cops_style.html#stylesuperarguments
+Style/SuperArguments:
+  Enabled: false
+
+# https://docs.rubocop.org/rubocop/cops_style.html#stylesymbolarray
+Style/SymbolArray:
+  Enabled: true
+  EnforcedStyle: brackets
+
+# https://docs.rubocop.org/rubocop/cops_style.html#styleternaryparentheses
+Style/TernaryParentheses:
+  Enabled: true
+  EnforcedStyle: require_parentheses_when_complex
+  AllowSafeAssignment: false
+
+# https://docs.rubocop.org/rubocop/cops_style.html#styletrailingunderscorevariable
+Style/TrailingUnderscoreVariable:
+  Enabled: false
+
+# https://docs.rubocop.org/rubocop/cops_style.html#styleunpackfirst
+Style/UnpackFirst:
+  Enabled: false
+
+# https://docs.rubocop.org/rubocop/cops_style.html#stylewordarray
+Style/WordArray:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'bundler'
+  gem 'guard'
+  gem 'guard-minitest'
+  gem 'minitest'
+  gem 'rake'
+  gem 'rb-inotify'
+  gem 'rubocop'
+  gem 'rubocop-minitest'
+  gem 'rubocop-performance'
+  gem 'rubocop-rake'
+  gem 'timecop'
+end

data/Guardfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+guard 'minitest', focus_on_failed: true do
+  watch(%r{^test/.+_test\.rb$})
+  watch(%r{^lib/lru_redux/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2013 Sam Saffron
+Copyright (c) 2024 Masahiro
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,288 @@
+# SinLruRedux [![Gem Version](https://badge.fury.io/rb/sin_lru_redux.svg)](http://badge.fury.io/rb/sin_lru_redux)
+
+An efficient, thread safe LRU cache.
+
+Forked from [LruRedux](https://github.com/SamSaffron/lru_redux).
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [TTL Cache](#ttl-cache)
+- [Cache Methods](#cache-methods)
+- [Benchmarks](#benchmarks)
+- [Other Caches](#other-caches)
+- [Contributing](#contributing)
+- [Changelog](#changelog)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sin_lru_redux'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sin_lru_redux
+
+## Usage
+
+```ruby
+require 'lru_redux'
+
+# non thread safe
+cache = LruRedux::Cache.new(100)
+cache[:a] = '1'
+cache[:b] = '2'
+
+cache.to_a
+# [[:b, '2'], [:a, '1']]
+# note the order matters here, last accessed is first
+
+cache[:a] # a pushed to front
+# '1'
+
+cache.to_a
+# [[:a, '1'], [:b, '2']]
+cache.delete(:a)
+cache.each { |k, v| puts "#{k} #{v}"}
+# b 2
+
+cache.max_size = 200 # cache now stores 200 items
+cache.clear # cache has no items
+
+cache.getset(:a) { 1 }
+cache.to_a
+#[[:a, 1]]
+
+# already set so don't call block
+cache.getset(:a) { 99 }
+cache.to_a
+#[[:a, 1]]
+
+# for thread safe access, all methods on cache
+# are protected with a mutex
+cache = LruRedux::ThreadSafeCache.new(100)
+```
+
+#### TTL Cache
+
+The TTL cache extends the functionality of the LRU cache with a Time To Live eviction strategy. TTL eviction occurs on every access and takes precedence over LRU eviction, meaning a 'live' value will never be evicted over an expired one.
+
+```ruby
+# Timecop is gem that allows us to change Time.now
+# and is used for demonstration purposes.
+require 'lru_redux'
+require 'timecop'
+
+# Create a TTL cache with a size of 100 and TTL of 5 minutes.
+# The first argument is the size and
+# the second optional argument is the TTL in seconds.
+cache = LruRedux::TTL::Cache.new(100, 5 * 60)
+
+Timecop.freeze(Time.now)
+
+cache[:a] = '1'
+cache[:b] = '2'
+
+cache.to_a
+# => [[:b, '2'], [:a, '1']]
+
+# Now we advance time 5 min 30 sec into the future.
+Timecop.freeze(Time.now + 330)
+
+# And we see that the expired values have been evicted.
+cache.to_a
+# => []
+
+# The TTL can be updated on a live cache using #ttl=.
+# Currently cached items will be evicted under the new TTL.
+cache[:a] = '1'
+cache[:b] = '2'
+
+Timecop.freeze(Time.now + 330)
+
+cache.ttl = 10 * 60
+
+# Since ttl eviction is triggered by access,
+# the items are still cached when the ttl is changed and
+# are now under the 10 minute TTL.
+cache.to_a
+# => [[:b, '2'], [:a, '1']]
+
+# TTL eviction can be triggered manually with the #expire method.
+Timecop.freeze(Time.now + 330)
+
+cache.expire
+cache.to_a
+# => []
+
+Timecop.return
+
+# The behavior of a TTL cache with the TTL set to `:none`
+# is identical to the LRU cache.
+
+cache = LruRedux::TTL::Cache.new(100, :none)
+
+# The TTL argument is optional and defaults to `:none`.
+cache = LruRedux::TTL::Cache.new(100)
+
+# A thread safe version is available.
+cache = LruRedux::TTL::ThreadSafeCache.new(100, 5 * 60)
+```
+
+## Cache Methods
+
+- `#getset` Takes a key and block.  Will return a value if cached, otherwise will execute the block and cache the resulting value.
+- `#fetch` Takes a key and optional block.  Will return a value if cached, otherwise will execute the block and return the resulting value or return nil if no block is provided.
+- `#[]` Takes a key.  Will return a value if cached, otherwise nil.
+- `#[]=` Takes a key and value. Will cache the value under the key.
+- `#delete` Takes a key.  Will return the deleted value, otherwise nil.
+- `#evict` Alias for `#delete`.
+- `#clear` Clears the cache. Returns nil.
+- `#each` Takes a block.  Executes the block on each key-value pair in LRU order (most recent first).
+- `#to_a` Return an array of key-value pairs (arrays) in LRU order (most recent first).
+- `#key?` Takes a key.  Returns true if the key is cached, otherwise false.
+- `#has_key?` Alias for `#key?`.
+- `#count` Return the current number of items stored in the cache.
+- `#max_size` Returns the current maximum size of the cache.
+- `#max_size=` Takes a positive number.  Changes the current max_size and triggers a resize.  Also triggers TTL eviction on the TTL cache.
+- `#ignore_nil` Returns the current ignore nil setting.
+- `#ignore_nil=` Takes true or false.  Changes the current ignore nil setting.
+
+#### TTL Cache Specific
+
+- `#ttl` Returns the current TTL of the cache.
+- `#ttl=` Takes `:none` or a positive number.  Changes the current ttl and triggers a TTL eviction.
+- `#expire` Triggers a TTL eviction.
+
+## Benchmarks
+
+see: benchmark directory (a million random lookup / store)
+
+#### LRU
+
+##### Ruby 2.2.1
+
+```shell
+$ ruby ./bench/bench.rb
+
+Rehearsal -------------------------------------------------------------
+ThreadSafeLru               4.500000   0.030000   4.530000 (  4.524213)
+LRU                         2.250000   0.000000   2.250000 (  2.249670)
+LRUCache                    1.720000   0.010000   1.730000 (  1.728243)
+LruRedux::Cache             0.960000   0.000000   0.960000 (  0.961292)
+LruRedux::ThreadSafeCache   2.180000   0.000000   2.180000 (  2.187714)
+--------------------------------------------------- total: 11.650000sec
+
+                                user     system      total        real
+ThreadSafeLru               4.390000   0.020000   4.410000 (  4.415703)
+LRU                         2.140000   0.010000   2.150000 (  2.149626)
+LRUCache                    1.680000   0.010000   1.690000 (  1.688564)
+LruRedux::Cache             0.910000   0.000000   0.910000 (  0.913108)
+LruRedux::ThreadSafeCache   2.200000   0.010000   2.210000 (  2.212108)
+```
+
+#### TTL
+
+##### Ruby 2.2.1
+
+```shell
+$ ruby ./bench/bench_ttl.rb
+Rehearsal -----------------------------------------------------------------------
+FastCache                             6.240000   0.070000   6.310000 (  6.302569)
+LruRedux::TTL::Cache                  4.700000   0.010000   4.710000 (  4.712858)
+LruRedux::TTL::ThreadSafeCache        6.300000   0.010000   6.310000 (  6.319032)
+LruRedux::TTL::Cache (TTL disabled)   2.460000   0.010000   2.470000 (  2.470629)
+------------------------------------------------------------- total: 19.800000sec
+
+                                          user     system      total        real
+FastCache                             6.470000   0.070000   6.540000 (  6.536193)
+LruRedux::TTL::Cache                  4.640000   0.010000   4.650000 (  4.661793)
+LruRedux::TTL::ThreadSafeCache        6.310000   0.020000   6.330000 (  6.328840)
+LruRedux::TTL::Cache (TTL disabled)   2.440000   0.000000   2.440000 (  2.446269)
+```
+
+## Other Caches
+
+This is a list of the caches that are used in the benchmarks.
+
+#### LRU
+
+- RubyGems: https://rubygems.org/gems/lru
+- Homepage: http://lru.rubyforge.org/
+
+#### LRUCache
+
+- RubyGems: https://rubygems.org/gems/lru_cache
+- Homepage: https://github.com/brendan/lru_cache
+
+#### ThreadSafeLru
+
+- RubyGems: https://rubygems.org/gems/threadsafe-lru
+- Homepage: https://github.com/draganm/threadsafe-lru
+
+#### FastCache
+
+- RubyGems: https://rubygems.org/gems/fast_cache
+- Homepage: https://github.com/swoop-inc/fast_cache
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Changelog
+
+### version 2.0.0 - 28-Dec-2024
+
+- New: Add ignore_nil argument to cache initialize arguments.  If true, blocks called by getset yielding nil values will be returned but not stored in the cache.
+- Fix: Fix LruRedux::TTL::ThreadSafeCache#delete to return deleted value.
+- Ruby Support: Drop runtime support for Ruby 2.3 and below and JRuby.
+
+### version 1.1.0 - 30-Mar-2015
+
+- New: TTL cache added.  This cache is LRU like with the addition of time-based eviction.  Check the Usage -> TTL Cache section in README.md for details.
+
+### version 1.0.0 - 26-Mar-2015
+
+- Ruby Support: Ruby 1.9+ is now required by LruRedux.  If you need to use LruRedux in Ruby 1.8, please specify gem version 0.8.4 in your Gemfile.  v0.8.4 is the last 1.8 compatible release and included a number of fixes and performance improvements for the Ruby 1.8 implementation. @Seberius
+- Perf: improve performance in Ruby 2.1+ on the MRI @Seberius
+
+### version 0.8.4 - 20-Feb-2015
+
+- Fix: regression of ThreadSafeCache under JRuby 1.7 @Seberius
+
+### version 0.8.3 - 20-Feb-2015
+
+- Perf: improve ThreadSafeCache performance @Seberius
+
+### version 0.8.2 - 16-Feb-2015
+
+- Perf: use #size instead of #count when checking length @Seberius
+- Fix: Cache could grow beyond its size in Ruby 1.8 @Seberius
+- Fix: #each could deadlock in Ruby 1.8 @Seberius
+
+### version 0.8.1 - 7-Sep-2013
+
+- Fix #each implementation
+- Fix deadlocks with ThreadSafeCache
+- Version jump is because its been used in production for quite a while now
+
+### version 0.0.6 - 24-April-2013
+
+- Fix bug in getset, overflow was not returning the yeilded val
+
+### version 0.0.5 - 23-April-2013
+
+- Added getset and fetch
+- Optimised implementation so it 20-30% faster on Ruby 1.9+
+
+### version 0.0.4 - 23-April-2013
+
+- Initial version

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+end
+
+RuboCop::RakeTask.new

data/bench/bench.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'bundler'
+require 'benchmark'
+require 'lru'
+require 'lru_cache'
+require 'threadsafe-lru'
+
+Bundler.require
+
+# Lru
+lru = Cache::LRU.new(max_elements: 1_000)
+
+# LruCache
+lru_cache = LRUCache.new(1_000)
+
+# ThreadSafeLru
+thread_safe_lru = ThreadSafeLru::LruCache.new(1_000)
+
+# LruRedux
+redux = LruRedux::Cache.new(1_000)
+redux_thread_safe = LruRedux::ThreadSafeCache.new(1_000)
+
+puts '** LRU Benchmarks **'
+
+Benchmark.bmbm do |bm|
+  bm.report 'ThreadSafeLru' do
+    1_000_000.times { thread_safe_lru.get(rand(2_000)) { :value } }
+  end
+
+  bm.report 'LRU' do
+    1_000_000.times { lru[rand(2_000)] ||= :value }
+  end
+
+  bm.report 'LRUCache' do
+    1_000_000.times { lru_cache[rand(2_000)] ||= :value }
+  end
+
+  bm.report 'LruRedux::Cache' do
+    1_000_000.times { redux.getset(rand(2_000)) { :value } }
+  end
+
+  bm.report 'LruRedux::ThreadSafeCache' do
+    1_000_000.times { redux_thread_safe.getset(rand(2_000)) { :value } }
+  end
+end