sin_lru_redux 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62aedb1e0b7730269fe2f336ae70bdfd158cf38efd0827c8fae3bd4810e4b0dc
-  data.tar.gz: db0572e99799e265c3d6b8d52072c779574e1cc29e6ca73ce24fe982768d90ce
+  metadata.gz: a205e8ba667a41a33f3b7fdb9d86e6ab3cc5623aff0998a31e00899db3069535
+  data.tar.gz: 6b3cad6832644bdc3c8ec26e821f7ff855f1591c99be6a127ba55b048943f1e2
 SHA512:
-  metadata.gz: bd3b6ab784cf9318ce46aa572b4e0c3c7e316147e1a56404a8c316a104a67c4b12f5e3805c6f349b0e98fa54773ba53ba7fa532d6e7f6f91a1c442dc10a436ca
-  data.tar.gz: 34126e658fce4a4c1ee29587ee598d72e2068c1c99cec359d0c373c13a0d271aefe53119b22ddda3e055b78b6e75c3c1d02964ea7301a76c45457216a68b4fe2
+  metadata.gz: 63f527c1469a8cc98b48be9c9248bd6406d75db63443930368e328106048d4aafaba3f9f560d63ab4e535c832d9485b90e69039c5b496999fd91535411116a1e
+  data.tar.gz: f10d3bb3ec140660b562f8246eaa89acf1bbe6b497b5d283d5494b4ac57cce1621ab932fc4f55cc70dc995fd933ba12fa71d72311683e31c93a2bd37d184fe4b

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [2.3.0] - 2025-1-1
+
+- New: Add alias method `length` and `size` for `count`
+- Refactor: Improve implementation
+- Test: Update tests
+- Other: Improve README.md
+
 ## [2.2.1] - 2024-12-31
 
 - Refactor: Improve implementation

data/README.md

@@ -49,7 +49,7 @@ cache[:a] # a pushed to front
 cache.to_a
 # [[:a, '1'], [:b, '2']]
 cache.delete(:a)
-cache.each { |k, v| puts "#{k} #{v}"}
+cache.each { |key, value| puts "#{key} #{value}"}
 # b 2
 
 cache.max_size = 200 # cache now stores 200 items
@@ -145,10 +145,13 @@ cache = LruRedux::TTL::ThreadSafeCache.new(100, 5 * 60)
 - `#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).
+- `#each_unsafe` Alias for `#each`.
 - `#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.
+- `#length` Alias for `#count`.
+- `#size` Alias for `#count`.
 - `#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.

data/lib/lru_redux/cache.rb

@@ -14,7 +14,7 @@ class LruRedux::Cache
 
     @max_size = max_size
     @ignore_nil = ignore_nil
-    @data = {}
+    @data_lru = {}
   end
 
   def max_size=(new_max_size)
@@ -37,10 +37,10 @@ class LruRedux::Cache
 
   def getset(key)
     key_found = true
-    value = @data.delete(key) { key_found = false }
+    value = @data_lru.delete(key) { key_found = false }
 
     if key_found
-      @data[key] = value
+      @data_lru[key] = value
     else
       result = yield
       store_item(key, result)
@@ -50,10 +50,10 @@ class LruRedux::Cache
 
   def fetch(key)
     key_found = true
-    value = @data.delete(key) { key_found = false }
+    value = @data_lru.delete(key) { key_found = false }
 
     if key_found
-      @data[key] = value
+      @data_lru[key] = value
     else
       yield if block_given? # rubocop:disable Style/IfInsideElse
     end
@@ -61,10 +61,10 @@ class LruRedux::Cache
 
   def [](key)
     key_found = true
-    value = @data.delete(key) { key_found = false }
+    value = @data_lru.delete(key) { key_found = false }
     return unless key_found
 
-    @data[key] = value
+    @data_lru[key] = value
   end
 
   def []=(key, val)
@@ -72,36 +72,38 @@ class LruRedux::Cache
   end
 
   def each(&block)
-    @data.to_a.reverse_each(&block)
+    @data_lru.to_a.reverse_each(&block)
   end
   # Used further up the chain, non thread safe each
   alias_method :each_unsafe, :each
 
   def to_a
-    @data.to_a.reverse
+    @data_lru.to_a.reverse
   end
 
   def values
-    @data.values.reverse
+    @data_lru.values.reverse
   end
 
   def delete(key)
-    @data.delete(key)
+    @data_lru.delete(key)
   end
   alias_method :evict, :delete
 
   def key?(key)
-    @data.key?(key)
+    @data_lru.key?(key)
   end
   alias_method :has_key?, :key?
 
   def clear
-    @data.clear
+    @data_lru.clear
   end
 
   def count
-    @data.size
+    @data_lru.size
   end
+  alias_method :length, :count
+  alias_method :size, :count
 
   private
 
@@ -135,26 +137,26 @@ class LruRedux::Cache
   end
 
   def evict_excess
-    @data.shift while @data.size > @max_size
+    @data_lru.shift while @data_lru.size > @max_size
   end
 
   if RUBY_VERSION >= '2.6.0'
     def evict_nil
       return unless @ignore_nil
 
-      @data.compact!
+      @data_lru.compact!
     end
   else
     def evict_nil
       return unless @ignore_nil
 
-      @data.reject! { |_key, value| value.nil? }
+      @data_lru.reject! { |_key, value| value.nil? }
     end
   end
 
   def store_item(key, val)
-    @data.delete(key)
-    @data[key] = val if !val.nil? || !@ignore_nil
+    @data_lru.delete(key)
+    @data_lru[key] = val if !val.nil? || !@ignore_nil
     evict_excess
     val
   end

data/lib/lru_redux/ttl/cache.rb

@@ -137,6 +137,8 @@ module LruRedux
       def count
         @data_lru.size
       end
+      alias_method :length, :count
+      alias_method :size, :count
 
       def expire
         evict_expired

data/lib/lru_redux/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LruRedux
-  VERSION = '2.2.1'
+  VERSION = '2.3.0'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sin_lru_redux
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Masahiro
 bindir: exe
 cert_chain: []
-date: 2024-12-31 00:00:00.000000000 Z
+date: 2025-01-01 00:00:00.000000000 Z
 dependencies: []
 description: |
   Efficient and thread-safe LRU cache.
@@ -33,15 +33,15 @@ files:
 - lib/lru_redux/util.rb
 - lib/lru_redux/util/safe_sync.rb
 - lib/lru_redux/version.rb
-homepage: https://github.com/cadenza-tech/sin_lru_redux/tree/v2.2.1
+homepage: https://github.com/cadenza-tech/sin_lru_redux/tree/v2.3.0
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/cadenza-tech/sin_lru_redux/tree/v2.2.1
-  source_code_uri: https://github.com/cadenza-tech/sin_lru_redux/tree/v2.2.1
-  changelog_uri: https://github.com/cadenza-tech/sin_lru_redux/blob/v2.2.1/CHANGELOG.md
+  homepage_uri: https://github.com/cadenza-tech/sin_lru_redux/tree/v2.3.0
+  source_code_uri: https://github.com/cadenza-tech/sin_lru_redux/tree/v2.3.0
+  changelog_uri: https://github.com/cadenza-tech/sin_lru_redux/blob/v2.3.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/cadenza-tech/sin_lru_redux/issues
-  documentation_uri: https://rubydoc.info/gems/sin_lru_redux/2.2.1
+  documentation_uri: https://rubydoc.info/gems/sin_lru_redux/2.3.0
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: