libcache 0.2.1 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e232a3aa9df9f7a70ad86b19452416d1e790f20
-  data.tar.gz: 5d1ee8e05c3ca4977852bdcb792e2aee3073c59a
+  metadata.gz: 1745f8dfa5166c285d38f5a9303350590e1aae2f
+  data.tar.gz: e54f0dabd6ac9874078e89494d3ff32a3b79e53a
 SHA512:
-  metadata.gz: 95130eb3de3a114fe925477dd79156258d24b4bf4948a0f1d3ea11c40c45ae16ff310ded05ff8e7626765eb123ab2f826f2db5e4c6c92a36da712ddb32f6297d
-  data.tar.gz: f76c1f3acec13c3848aae0b7a5017ecf05f5de80cf81280850c5443e9309c987f3cc77757b566dc359f7c9361be4234314ec8f68a1dbb55499eb8882aa6f46f7
+  metadata.gz: a0bd90c60a77bfed598db5f7a707fb15fa9c06cf290d320fa44b6a2d7025fba30cfd87bddb65ed92ada94b95c1147872321da4f52f8029a13b63123dffd29a69
+  data.tar.gz: e065672af43bb05078e505a1469ec6c440edee36650156d7718c9d4a4d54c995322de8e657830bb6010f6659913dffbfae5ae8a658dc430f561e612427bf7dce

data/Gemfile

@@ -2,4 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in libcache.gemspec
 gemspec
-gem 'rufus-scheduler'
+gem 'rufus-scheduler'
+gem 'tzinfo-data'

data/lib/libcache/cache.rb

@@ -5,20 +5,25 @@ class Cache
 
   attr_accessor :expiry_time, :refresh, :store, :max_size
 
+  # Creates a basic Cache with the UTC timezone
   def initialize
     ENV['TZ'] = 'UTC'
     @scheduler = Rufus::Scheduler.new
     @time_tracker = Hash.new
   end
 
+  # Initializes the cache store
   def create_store
     @cache = Hash.new
   end
 
+  # Places an object inside the cache and handles max size eviction
+  # @param [String] key The key value used to identify an object in the cache
+  # @param [Object] value The object to be placed in the cache
   def put(key, value)
     # removed oldest entry if max_size is approached
     if max_size != nil
-      if @cache.size >= max_size
+      if @cache.size >= max_size - 1
         key, value = @time_tracker.values.sort {|v| Time.now - v }.reverse.first
         invalidate(key)
         @time_tracker.delete(key)
@@ -26,21 +31,31 @@ class Cache
       @time_tracker[key] = Time.now
     end
     @cache[key] = value
-    @scheduler.in expiry_time, :blocking => true do
-      invalidate key
+    if expiry_time != nil
+      @scheduler.in expiry_time, :blocking => true do
+        invalidate key
+      end
     end
   end
 
+  # Gets the object that corresponds with the key
+  # @param [String] key The key value used to identify an object in the cache
+  # @return [Object] The object that corresponds with the key
   def get(key)
     check_refresh(key)
     return @cache[key]
   end
 
+  # Checks if a key-value pair exists in the cache
+  # @param [String] key The key value used to identify an object in the cache
+  # @return [Boolean] The existence of the key in the cache
   def exists?(key)
     return @cache.key?(key)
   end
 
-
+  # Refreshes an object if it has been invalidated
+  # @param [String] key The key value used to identify an object in the cache
+  # @return [Object] The refreshed object that is recalled from the refresh method
   def check_refresh(key)
     if @cache[key] == nil && !has_refresh?
       val = refresh.call(key)
@@ -49,14 +64,22 @@ class Cache
     end
   end
 
+  # @return [Boolean] Checks if the cache has a refresh method
   def has_refresh?
     return refresh == nil
   end
 
+  def get_size
+    return @cache.size
+  end
+
+  # Deletes a key-value pair from the cache
+  # @param [String] key The key value used to identify an object in the cache
   def invalidate(key)
     @cache.delete key
   end
 
+  # Clears all items in the cache
   def invalidateAll
     @cache.clear
   end

data/lib/libcache/cache_builder.rb

@@ -2,34 +2,44 @@ require_relative 'cache'
 
 class CacheBuilder
 
+  # @param [Cache] cache Initializes with the type of Cache to be used
   def initialize(cache)
     @cache = cache.new
   end
 
+  # @param [Cache] cache Sets the type of Cache to be used
   def self.with(cache)
     return self.new(cache)
   end
 
+  # Sets the required file path for the FileCache
+  # @param [String] path The path of the directory where cached files should be stored
   def set_store(path)
     @cache.store = path
     return self
   end
 
+  # @param [String] time The time value after which an object should expire in the cache. Can be written as '2s' for two seconds, for example. For more info see: https://github.com/jmettraux/rufus-scheduler/blob/two/README.rdoc#the-time-strings-understood-by-rufus-scheduler
   def set_expiry(time)
     @cache.expiry_time = time
     return self
   end
 
+  # Sets the refresh method required for recalling new objects after expiration
+  # @param [Proc] proc The refresh method as a Proc object
   def set_refresh(proc)
     @cache.refresh = proc
     return self
   end
 
+  # Sets the optional max size of a cache
+  # @param [Integer] max_size The max size of the cache
   def set_max(max_size)
     @cache.max_size = max_size
     return self
   end
 
+  # Returns the newly created cache
   def build
     @cache.create_store
     return @cache.dup

data/lib/libcache/file_cache.rb

@@ -8,6 +8,7 @@ class FileCache < Cache
     super
   end
 
+  # Initializes the cache store along with the keys store. Raises an exception if the store path is not supplied.
   def create_store
     @cache = Hash.new
     @keys = Hash.new
@@ -16,9 +17,19 @@ class FileCache < Cache
     end
   end
 
+  # Places an object inside the cache, and by extension, into the filesystem. Handles max size eviction. Raises an InvalidKey exception if the key is not formatted properly.
+  # @param [String] key The key value used to identify an object in the cache
+  # @param [Object] value The object to be placed in the cache
   def put(key, value)
-    if ((key =~ /\A[a-zA-Z0-9_-]+\z/) != 0) || !(key.instance_of? String)
-      raise 'Invalid key value used!'
+    raise InvalidKey unless key.is_a? String
+    raise InvalidKey unless key =~ /\A[a-zA-Z0-9_-]+\z/
+    if max_size != nil
+      if @cache.size >= max_size - 1
+        key, value = @time_tracker.values.sort {|v| Time.now - v }.reverse.first
+        invalidate(key)
+        @time_tracker.delete(key)
+      end
+      @time_tracker[key] = Time.now
     end
     @keys[key] = Digest::MD5.hexdigest(key) + Time.now.to_i.to_s
     @cache[key] = value
@@ -30,16 +41,23 @@ class FileCache < Cache
     end
   end
 
+  # Gets the object that corresponds with the key that is read from the filesystem
+  # @param [String] key The key value used to identify an object in the cache
+  # @return [Object] The object that corresponds with the key
   def get(key)
     refresh
     return File.read(File.join(store, @keys[key]))
   end
 
+  # Deletes a key-value pair from the cache and store directory
+  # @param [String] key The key value used to identify an object in the cache
   def invalidate(key)
     super
+    @keys.delete key
     File.delete(File.join(store, @keys[key]))
   end
 
+  # Clears all items in the cache and the cached files in the store directory
   def invalidateAll
     super
     Dir.foreach(store) do |f|

data/lib/libcache/version.rb

@@ -1,3 +1,3 @@
 module Libcache
-  VERSION = "0.2.1"
+  VERSION = "0.3"
 end

data/lib/libcache.rb

@@ -1,5 +1,4 @@
 require "libcache/version"
-
-module Libcache
-  # Your code goes here...
-end
+require_relative 'libcache/cache'
+require_relative 'libcache/cache_builder'
+require_relative 'libcache/file_cache'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: libcache
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: '0.3'
 platform: ruby
 authors:
 - silk8192