lru_qache 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11dd210b06332d830d3f6d469f13309b4a56fd62ad3bc769c1a336c6b8e9c084
-  data.tar.gz: 2d622b4f930b5720095e4ecd8229bc765dec5898e23cc048b3a4e154fdccb8af
+  metadata.gz: ce54ab1353d2238480ec292912794f944f54346c01ef056e09b0d423b0a4b523
+  data.tar.gz: 3a7717a5d6c8d3b59a4c1a153b2d5b2748a44c356bf76a02e7cae5acc9cd8abb
 SHA512:
-  metadata.gz: ae6fe8df75d35676d7690825f1e5a3b6557ae23668103c1ed5ba7257fd4a5756dfb5642c60fab82cd2ed6c9cc7f49bd6b874ce7ada5a0f14f86cd2703ea00402
-  data.tar.gz: 6e510d47e587a9aa18bc5ae8320d3fb7b539c61d47e8bedd3c7b93aaed2a890c083b405fe96bf9fecde8328f240372b194447dc8b0fbf388566dd8336018d1a2
+  metadata.gz: 29cc291ab8a88eb1de5d07217a632de206e3d9ecda03a4ea86bcb0b12e8c46254999d5dc3be8527c838f55b4b536cf2b802e664f8fad31722edb4f825b1b613f
+  data.tar.gz: c37522b2aefa7c9b6aecde01472db8c46b05677572425f33b73e4e6fa6d8079f856d02ed53210968523fa9e1ed596b8f34de7ac97aaad1d0dcb4959f227935d6

data/README.md

@@ -1,6 +1,6 @@
 # LRUQache
 
-The LRU(least recently used) caching scheme is to remove the least recently used item when the cache reaches it's defined capacity. This gem implements this cache using a simple customised implementation of queue. So the gem is LRU Qache i.e. LRU Queue Cache.
+The LRU(least recently used) caching scheme is to remove the least recently used item when the cache reaches it's defined capacity. This gem implements this cache using a core Hash which is [ordered hash](https://www.igvita.com/2009/02/04/ruby-19-internals-ordered-hash/). But this will work only if Ruby version is greater than 1.9.
 
 ## Installation
 

data/lib/lru_qache.rb

@@ -1,13 +1,12 @@
-require "lru_qache/lru_queue"
-
-class LRUQache # LRU cache is caching technique based on recently used data.
+# require "lru_qache/lru_queue"
+class LruQache # LRU cache is caching technique based on recently used data.
   MAX_CAPACITY = 5
   DEFAULT_VAL = -1
 
   InvalidCapacityError = Class.new RuntimeError
   INVALID_CAPACITY = 'Capacity must be valid number'.freeze
 
-  attr_reader :options, :cache
+  attr_reader :options, :cache, :capacity
 
   # @param capacity [Integer] Takes a number as an input and
   # @param options [Hash] optional hash for some settings like custom value if \
@@ -17,7 +16,7 @@ class LRUQache # LRU cache is caching technique based on recently used data.
     raise InvalidLimitError, INVALID_CAPACITY unless capacity.is_a?(Integer)
     @cache = {}
     @options = options
-    @lru_queue = LRUQueue.new(capacity)
+    @capacity = capacity
   end
 
   # This gets the value based on the key is provided, updates the key usage
@@ -26,9 +25,9 @@ class LRUQache # LRU cache is caching technique based on recently used data.
   # @return value [Object] if key is present
   # @example get(x)
   def get(key)
-    return options[:default_val] if cache[key].nil?
-    update_queue(key)
-    retrieve(key)
+    value = retrieve(key)
+    update_lru(key) unless value == options[:default_val]
+    value
   end
 
   # Sets the value of cache's key
@@ -36,46 +35,41 @@ class LRUQache # LRU cache is caching technique based on recently used data.
   # @param key any valid object
   # @param key any valid object
   # @example set('a', 1)
-
   # @todo Add validation to the key e.g. only Symbol, String or Integer etc.
   def set(key, val)
-    remove_lru_if_needed(key)
+    @cache.delete(key) if cache.has_key?(key)
     @cache[key] = val
+    remove_lru_if_needed
+    val
   end
 
   alias [] get
   alias []= set
 
   private
-
-  # Logic to handle whether to set a key, now it only checks if key present
-  #
-  # @param Takes key the input, it can be any valid Object needed for hash
-  def need_to_set?(key)
-    retrieve(key).nil?
-  end
-
   # This is used for not modifying the 'last_used' key when using internal logic
   #
   # @param key input parameter
   # @return value [Object] if key is present
   def retrieve(key)
-    cache[key]
+    cache.fetch(key) { options[:default_val] }
   end
 
   # This removes the least recently used key from cache and also updates queue
   #
   # @param key input parameter
-  def remove_lru_if_needed(key)
-    update_queue(key)  # update the queue with new key
-    @cache.delete(@lru_queue.last_popped) if @lru_queue.full?
+  def remove_lru_if_needed
+    # update the queue with new key
     # remove LRU key if capacity is full.
+    cache.shift if cache.size > capacity
   end
 
-  # Updates the queue with the key
+  # Updates the lru with the key, removes key and sets again so key goes
+  # to the last
   #
   # @param Takes key the input, it can be any valid Object needed for hash
-  def update_queue(key)
-    @lru_queue.push(key)
+  def update_lru(key)
+    val = cache.delete(key)
+    cache[key] = val
   end
 end

data/lib/lru_qache/version.rb

@@ -1,3 +1,3 @@
 module LRUQache
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lru_qache.gemspec

@@ -5,15 +5,15 @@ Gem::Specification.new do |spec|
   spec.version     = LRUQache::VERSION
   spec.date        = '2020-08-03'
   spec.summary     = 'LRU Cache using a queue.'
-  spec.description = 'A simple LRU(Least Recently Used) Cache implementation using a custom queue.'
+  spec.description = 'A simple LRU(Least Recently Used) Cache implementation using Ruby Hash'
   spec.authors     = ['Datt Dongare']
   spec.email       = 'duttdongare30@gmail.com'
   spec.homepage = 'https://rubygems.org/gems/lru-qache'
-  spec.metadata['homepage_uri'] = 'https://rubygems.org/gems/lru-qache'
+  spec.metadata['homepage_uri'] = 'https://rubygems.org/gems/lru_qache'
   spec.metadata['source_code_uri'] = 'https://github.com/datt/lru_qache'
   spec.require_paths = ['lib']
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 1.9')
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lru_qache
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Datt Dongare
@@ -38,8 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.25
-description: A simple LRU(Least Recently Used) Cache implementation using a custom
-  queue.
+description: A simple LRU(Least Recently Used) Cache implementation using Ruby Hash
 email: duttdongare30@gmail.com
 executables: []
 extensions: []
@@ -53,14 +52,13 @@ files:
 - bin/console
 - bin/setup
 - lib/lru_qache.rb
-- lib/lru_qache/lru_queue.rb
 - lib/lru_qache/version.rb
 - lru_qache.gemspec
 homepage: https://rubygems.org/gems/lru-qache
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://rubygems.org/gems/lru-qache
+  homepage_uri: https://rubygems.org/gems/lru_qache
   source_code_uri: https://github.com/datt/lru_qache
 post_install_message: 
 rdoc_options: []
@@ -70,7 +68,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/lru_qache/lru_queue.rb

@@ -1,34 +0,0 @@
-class LRUQueue # Maintains a fixed size queue with unique keys
-  attr_reader :max_size, :last_popped
-  attr_accessor :queue
-  ARG_ERROR = 'ArgError:: Passing Max Size is mandatory and must be a number' \
-                 .freeze
-
-  # @param max_size [Integer] Takes a number as an input, for queue size
-  def initialize(max_size)
-    raise ARG_ERROR if max_size.nil? || !max_size.is_a?(Integer)
-    @max_size = max_size
-    @queue = []
-    @last_popped = nil
-  end
-
-  # removes last item from the queue
-  def pop
-    @last_popped = queue.pop
-  end
-
-  # Pushes item in the queue based on some conditions
-  # 1. If item is repeated it pushed at first, removes duplicate
-  # 2. If full, remove least used item i.e. last item and push
-  # @param item [Object] takes any object and pushes in queue
-  def push(item)
-    queue.delete(item) if queue.include?(item) # deletes the key if present
-    pop if full? # delete last item if queue is full
-    queue.unshift(item) # insert at the start
-  end
-
-  # tells whether the queue is full or not
-  def full?
-    max_size == queue.size
-  end
-end