libcache 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd7de71e70376b7fddaf6082f9136bc66e98e3e6
-  data.tar.gz: c349e392443f65fa59c5c55259af48c8afd10eec
+  metadata.gz: 1f93dbc8d8b5f2e3d2923d3c9000c8bd20318b6d
+  data.tar.gz: b3145f6b8c78876b7370d644fe2118979bf6a499
 SHA512:
-  metadata.gz: 6bc46327213cb45af8cd9890402e1936e7be7771b9f405cfb0693e91263c8815cef38df31e4f08af956bb7536a942e641d5982c0516d9a09be7296861642f7ac
-  data.tar.gz: a96427c27f0a4ae159be068a1b76636da792096b77bc48b731d9a72896cd1c75e9713090c54fd00d7a91a23e02c3651a84997ad97d5c88e9bae20b07a32e624d
+  metadata.gz: cdcc1bd213388017f78ef50c2e0ce50ff68ed4701ffd6e7de408a164f5b120819c55d830d60d42043b7e7933b8dd4bf6a517193c1fc0066c4b89fe76dbcc89ef
+  data.tar.gz: c16a2b9e3d2ed9b1ebb24f27b21edc9e836f2e2ed392f49d122c99ba121820d1e46b8a5f587f34f4a1080c2931bea73e620dec5f074b2e517e3bdf5b86666ee4

data/README.md

@@ -28,48 +28,32 @@ Or install it yourself as:
     $ gem install libcache
 
 ## Usage
-
-For an in memory Cache with an expiry time of 3 seconds, store location at 'foo\bar', a max size of 500, and refresh method where 100 is added to the key (of course more sophisticated value retrieving operations will replace this method). Of course these additions are optional and configurable. The simplest form of an in-memory cache is ```CacheBuilder.with(Cache).build```
+For an in memory Cache with an expiry time of 3 seconds, a max size of 500, and refresh method where 100 is added to the key (of course more sophisticated value retrieving operations will replace this method), and a function set_post_get which defines a function to be executed after the retrieval of a key. The These additions are optional and configurable. The simplest form of an in-memory cache is 'CacheBuilder.with(Cache).build'
 ```ruby
-
-cache = CacheBuilder.with(Cache).set_expiry('3s').set_max(500).set_refresh(Proc.new { |key| key + 100 }).build
-
-cache.put(1, 5)
-cache.get(1) # will return 5
-sleep 4 # note that this is more than the expiry time
-cache.get(1) # will return 105 as the data has been refreshed
-cache.exists?(1) # will return true. if there is no set_refresh method provided then it will return false
-
-cache.put("key123", [1,2,true])
-pp cache.get("key123") # prints '[1, 2, true]' preserves type
-
-# delete all data on exit of program
-at_exit do
-  cache.invalidate_all
-end
-
+cache = CacheBuilder.with(Cache).set_expiry('3s').set_max(500).set_refresh(lambda { |key| key + 100 }).set_post_get(lambda { |*key| puts "Retrieved #{key}!" }).build
+```
+...or for an file-based Cache with an expiry time of 3 seconds, store location at 'foo\bar', and refresh method where 100 is added to the key, and a function set_post_get which defines a function to be executed after the retrieval of a key. Of course these additions are optional and configurable. The only thing that is non-removable is the ```set_store``` method. The simplest form of a File cache is 'CacheBuilder.with(FileCache).set_store('foo\bar').build'
+```ruby
+cache = CacheBuilder.with(FileCache).set_store('foo\bar').set_expiry('3s').set_max(500).set_refresh(lambda { |key| key + 100 }).set_post_get(lambda { |*key| puts "Retrieved #{key}!" }).build
 ```
-
-For an file-based Cache with an expiry time of 3 seconds, store location at 'foo\bar', and refresh method where 100 is added to the key (of course more sophisticated value retrieving operations will replace this method). Of course these additions are optional and configurable. The only thing that is non-removable is the ```set_store``` method. 
 ```ruby
-cache = CacheBuilder.with(FileCache).set_store('foo\bar').set_expiry('3s').set_max(500).set_refresh(Proc.new { |key| key + 100 }).build
-
 cache.put(1, 5)
-cache.get(1) # will return 5
+cache.get(1) # will return 5, also prints "Retrieved [1]!" to the console, as per the function defined in the set_post_get method
 sleep 4 # note that this is more than the expiry time
-cache.get(1) # will return 105 as the data has been refreshed
+cache.get(1) # will return 105 as the data has been refreshed, also prints "Retrieved [1]!" 
 cache.exists?(1) # will return true. if there is no set_refresh method provided then it will return false
 
 cache.put("key123", [1,2,true])
-pp cache.get("key123") # prints '[1, 2, true]' preserves type
+pp cache.get("key123") # prints '[1, 2, true]' preserves type, prints "Retrieved ["key123"]!"
 
-# delete all leftover files on exit of program
+# delete all data on exit of program
+# if the file cache was used, deletes all left over files. #cache.invalidate_all can be called at any point in runtime.
 at_exit do
   cache.invalidate_all
 end
-```
 
-For more on what kind of strings are understood as times, [click here](https://github.com/jmettraux/rufus-scheduler/blob/two/README.rdoc#the-time-strings-understood-by-rufus-scheduler).
+```
+For more on what kind of strings are understood as times, like "3s", [click here](https://github.com/jmettraux/rufus-scheduler/blob/two/README.rdoc#the-time-strings-understood-by-rufus-scheduler).
 
 ## Development
 

data/lib/libcache/cache.rb

@@ -3,7 +3,7 @@ require 'pp'
 
 class Cache
 
-  attr_accessor :expiry_time, :refresh, :store, :max_size
+  attr_accessor :expiry_time, :refresh, :store, :max_size, :post_get
 
   # Creates a basic Cache with the UTC timezone
   def initialize
@@ -53,6 +53,7 @@ class Cache
     if(@cache[key]) == nil
       return nil
     end
+    perform_post_get(key)
     return @cache[key]
   end
 
@@ -74,6 +75,14 @@ class Cache
     end
   end
 
+  # Performs a function after a key has been summoned from the cache
+  # @param [String] key The key value used to identify an object in the cache
+  def perform_post_get(key)
+    unless post_get.nil?
+      post_get.call(key)
+    end
+  end
+
   # @return [Boolean] Checks if the cache has a refresh method
   def has_refresh?
     return refresh == nil

data/lib/libcache/cache_builder.rb

@@ -39,6 +39,11 @@ class CacheBuilder
     return self
   end
 
+  def set_post_get(proc)
+    @cache.post_get = proc
+    return self
+  end
+
   # Returns the newly created cache
   def build
     @cache.create_store

data/lib/libcache/file_cache.rb

@@ -44,6 +44,7 @@ class FileCache < Cache
     if(@keys[key]) == nil
       return nil
     end
+    perform_post_get(key)
     return Marshal.load(File.read(File.join(store, @keys[key])))
   end
 

data/lib/libcache/version.rb

@@ -1,3 +1,3 @@
 module Libcache
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libcache
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - silk8192
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-21 00:00:00.000000000 Z
+date: 2017-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler