lru_qache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 11dd210b06332d830d3f6d469f13309b4a56fd62ad3bc769c1a336c6b8e9c084
+  data.tar.gz: 2d622b4f930b5720095e4ecd8229bc765dec5898e23cc048b3a4e154fdccb8af
+SHA512:
+  metadata.gz: ae6fe8df75d35676d7690825f1e5a3b6557ae23668103c1ed5ba7257fd4a5756dfb5642c60fab82cd2ed6c9cc7f49bd6b874ce7ada5a0f14f86cd2703ea00402
+  data.tar.gz: 6e510d47e587a9aa18bc5ae8320d3fb7b539c61d47e8bedd3c7b93aaed2a890c083b405fe96bf9fecde8328f240372b194447dc8b0fbf388566dd8336018d1a2

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in lru_qache.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Datt Dongare
+
+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,54 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lru_qache'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install lru_qache
+
+## Usage
+```ruby
+require "lru_qache"
+
+# create a new cache with a 100 items capacity.
+cache = LRUQache.new(100)
+
+# set an item in cache
+cache.set('key', 'your_value')
+
+cache.get('key')
+# returns 'your_value'
+
+```
+
+### Documentation
+
+`YARD` is used for generating documentation
+Generate documentation using yardoc `lib/**/*.rb` and open doc/index.html in browser.
+
+
+### Test
+To run the test cases
+
+`rspec spec/*`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/datt/lru_qache.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lru_qache"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/lru_qache.rb

@@ -0,0 +1,81 @@
+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
+
+  # @param capacity [Integer] Takes a number as an input and
+  # @param options [Hash] optional hash for some settings like custom value if \
+  # key is not present
+  # @option options [Integer] :default_val
+  def initialize(capacity = MAX_CAPACITY, options = { default_val: DEFAULT_VAL })
+    raise InvalidLimitError, INVALID_CAPACITY unless capacity.is_a?(Integer)
+    @cache = {}
+    @options = options
+    @lru_queue = LRUQueue.new(capacity)
+  end
+
+  # This gets the value based on the key is provided, updates the key usage
+  #
+  # @param key input parameter
+  # @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)
+  end
+
+  # Sets the value of cache's key
+  #
+  # @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[key] = 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]
+  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?
+    # remove LRU key if capacity is full.
+  end
+
+  # Updates the queue with the key
+  #
+  # @param Takes key the input, it can be any valid Object needed for hash
+  def update_queue(key)
+    @lru_queue.push(key)
+  end
+end

data/lib/lru_qache/lru_queue.rb

@@ -0,0 +1,34 @@
+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

data/lib/lru_qache/version.rb

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

data/lru_qache.gemspec

@@ -0,0 +1,24 @@
+require_relative 'lib/lru_qache/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = "lru_qache"
+  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.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['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')
+  # 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
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'yard', '~> 0.9.25'
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: lru_qache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Datt Dongare
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+description: A simple LRU(Least Recently Used) Cache implementation using a custom
+  queue.
+email: duttdongare30@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- 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
+  source_code_uri: https://github.com/datt/lru_qache
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: LRU Cache using a queue.
+test_files: []