persistent-cache 0.1.2 → 0.1.3

data/README.md

@@ -1,6 +1,6 @@
 # Persistent::Cache
 
-Persistent cache behaves like a hash, with a pluggable back-end. Currently sqlite3 and file system directory back-ends are provided. The cache defaults to type STORAGE_SQLITE
+Persistent cache behaves like a hash, with a pluggable back-end. Currently sqlite3, file system directory and RAM back-ends are provided. The cache defaults to type STORAGE_SQLITE
 
 Values in the cache have a default freshness period of 15465600 ms. This can be configured in the cache initializer. Setting fresh = nil indicates that data remains fresh for-ever. Each user of the cache may have his own independent freshness value. If stale data is requested from the cache, nil is returned. Data is marshalled before storage. If a key is not found in the cache, nil is returned. Setting the value of a key in the cache to nil deletes the entry. If required, creation time of an entry can be specified using set(key, value, timestamp)
 
@@ -20,6 +20,10 @@ When a StorageDirectory is used, it can be asked whether a key is present and wh
 
     key_cached?(key)
 
+## StorageRAM
+
+Updates to the cache are stored in RAM using a hash.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -74,10 +78,12 @@ Or install it yourself as:
 
     cache = Persistent::Cache.new("/tmp/my-persistent-cache", nil) # for-ever fresh
 
-    cache = Persistent::Cache.new("/tmp/directory-cache", nil, STORAGE_DIRECTORY)
+    cache = Persistent::Cache.new("/tmp/directory-cache", nil, Persistent::Cache::STORAGE_DIRECTORY)
 
     cache.set("mykey", "myvalue", Time.now) # explicitly set creation time
 
+    cache = Persistent::Cache.new("cache-name", nil, Persistent::Cache::STORAGE_RAM)
+
 Please send feedback and comments to the authors at:
 
 Wynand van Dyk <wynand.van.dyk@hetzner.co.za>

data/lib/persistent-cache.rb

@@ -1,11 +1,14 @@
 require "persistent-cache/version"
 require "sqlite3"
 require "persistent-cache/storage/storage_sq_lite"
+require "persistent-cache/storage/storage_directory"
+require "persistent-cache/storage/storage_ram"
 
 module Persistent
   class Cache
     STORAGE_SQLITE = 'sqlite' unless defined? STORAGE_SQLITE
     STORAGE_DIRECTORY = 'directory' unless defined? STORAGE_DIRECTORY
+    STORAGE_RAM = 'ram' unless defined? STORAGE_RAM
 
     # Fresh is 1 day less than the bacula default job retention time. If this is configured differently, FRESH should be updated as well.
     FRESH = 15465600; FRESH.freeze
@@ -19,6 +22,7 @@ module Persistent
 
       @storage = StorageSQLite.new(storage_details) if storage == STORAGE_SQLITE
       @storage = StorageDirectory.new(storage_details) if storage == STORAGE_DIRECTORY
+      @storage = StorageRAM.new if storage == STORAGE_RAM
       @fresh = fresh
       @storage_details = storage_details
 

data/lib/persistent-cache/storage/storage_directory.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'tempfile'
 
 module Persistent
   class StorageDirectory
@@ -162,4 +163,4 @@ module Persistent
     end
 
   end
-end
+end

data/lib/persistent-cache/storage/storage_ram.rb

@@ -0,0 +1,54 @@
+require "eh/eh"
+
+module Persistent
+  class StorageRAM
+    attr_accessor :storage
+
+    def initialize()
+      @storage = {}
+    end
+
+    def save_key_value_pair(serialized_key, serialized_value, timestamp = nil)
+      delete_entry(serialized_key)
+      time_entry = timestamp.nil? ? Time.now.to_s : timestamp.to_s
+      EH::retry!(:args => [serialized_key, serialized_value, time_entry]) do
+        @storage[serialized_key] = {:value => serialized_value, :timestamp => time_entry}
+      end
+    end
+
+    def lookup_key(serialized_key)
+      EH::retry!(:args => [serialized_key]) do
+        return [] if @storage[serialized_key].nil?
+        result = [[]]
+        result[0][0] = @storage[serialized_key][:value]
+        result[0][1] = @storage[serialized_key][:timestamp]
+        result
+      end
+    end
+
+    def delete_entry(serialized_key)
+      EH::retry!(:args => [serialized_key]) do
+        @storage.delete(serialized_key)
+      end
+    end
+
+    def size
+      EH::retry!(:args => []) do
+        @storage.size
+      end
+    end
+
+    def keys
+      EH::retry!(:args => []) do
+        return [] if @storage.keys == []
+        [@storage.keys]
+      end
+    end
+
+    def clear
+      EH::retry!(:args => []) do
+        @storage.clear
+      end
+    end
+  end
+end

data/lib/persistent-cache/version.rb

@@ -1,5 +1,5 @@
 module Persistent
   class Cache
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

data/spec/storage/storage_ram_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper'
+require "persistent-cache/storage/storage_ram"
+
+describe Persistent::StorageRAM do
+  before :each do
+    @test_key = "testkey"
+    @test_value = "testvalue"
+    @iut = Persistent::StorageRAM.new
+  end
+
+  context "when constructed" do
+    it "should have a storage hash in RAM" do
+      @iut.storage.nil?.should == false
+      @iut.storage.instance_of?(Hash).should == true
+    end
+  end
+
+  context "when asked to store a key value pair" do
+    it "should store the key/value pair in RAM, with the current time as timestamp" do
+      start_time = Time.now - 1
+      @iut.save_key_value_pair(Marshal.dump(@test_key), Marshal.dump(@test_value))
+      result = @iut.lookup_key(Marshal.dump(@test_key))
+      result.nil?.should == false
+      result[0].nil?.should == false
+      result[0][0].should == Marshal.dump(@test_value)
+      test_time = Time.parse(result[0][1])
+      test_time.should > start_time and test_time.should < start_time + 600
+    end
+
+    it "should store the key/value pair in RAM, with a timestamp specified" do
+      test_time = (Time.now - 2500)
+      @iut.save_key_value_pair(Marshal.dump(@test_key), Marshal.dump(@test_value), test_time)
+      result = @iut.lookup_key(Marshal.dump(@test_key))
+      result.nil?.should == false
+      result[0].nil?.should == false
+      result[0][0].should == Marshal.dump(@test_value)
+      time_retrieved = Time.parse(result[0][1])
+      time_retrieved.to_s.should == test_time.to_s
+    end
+
+    it "should overwrite the existing key/value pair if they already exist" do
+      @iut.save_key_value_pair(Marshal.dump(@test_key), Marshal.dump(@test_value))
+      @iut.save_key_value_pair(Marshal.dump(@test_key), Marshal.dump("testvalue2"))
+      result = @iut.lookup_key(Marshal.dump(@test_key))
+      result.nil?.should == false
+      result[0].nil?.should == false
+      result.size.should == 1
+      result[0][0].should == Marshal.dump("testvalue2")
+    end
+  end
+
+  context "When looking up a value given its key" do
+    it "should retrieve the value from RAM" do
+      @iut.save_key_value_pair(Marshal.dump(@test_key), Marshal.dump(@test_value))
+      result = @iut.lookup_key(Marshal.dump(@test_key))
+      result[0][0].should == Marshal.dump(@test_value)
+    end
+
+    it "should retrieve the timestamp when the value was stored from RAM" do
+      now = Time.now.to_s
+      @iut.save_key_value_pair(Marshal.dump(@test_key), Marshal.dump(@test_value))
+      sleep 1
+      result = @iut.lookup_key(Marshal.dump(@test_key))
+      result[0][1].should == now
+    end
+
+    it "should return an empty array if a key is not in RAM" do
+      @iut.delete_entry(Marshal.dump(@test_key))
+      result = @iut.lookup_key(Marshal.dump(@test_key))
+      result.should == []
+      result[0].should == nil
+    end
+  end
+
+  context "when asked to delete an entry" do
+    it "should not raise an error if the entry is not present" do
+      @iut.delete_entry(Marshal.dump("shouldnotbepresent"))
+    end
+
+    it "should delete the entry if it is present" do
+      @iut.save_key_value_pair(Marshal.dump(@test_key), Marshal.dump(@test_value))
+      result = @iut.lookup_key(Marshal.dump(@test_key))
+      result[0][0].should == Marshal.dump(@test_value)
+      @iut.delete_entry(Marshal.dump(@test_key))
+      result = @iut.lookup_key(Marshal.dump(@test_key))
+      result.should == []
+    end
+  end
+
+  context "when asked the size of the RAM database" do
+    it "should return 0 if the RAM database has no entries" do
+      @iut.size.should == 0
+    end
+
+    it "should return the number of entries" do
+      populate_database(@iut)
+      @iut.size.should == 3
+    end
+  end
+
+  context "when asked for the keys in the RAM database" do
+    it "should return an empty array if there are no entries in the RAM database" do
+      @iut.keys.should == []
+    end
+
+    it "should return the keys in the RAM database" do
+      populate_database(@iut)
+      keys = @iut.keys.flatten
+      keys.include?(Marshal.dump("one")).should == true
+      keys.include?(Marshal.dump("two")).should == true
+      keys.include?(Marshal.dump("three")).should == true
+      @iut.size.should == 3
+    end
+
+    it "should return the keys in an array, with each key in its own sub-array" do
+      populate_database(@iut)
+      found = false
+      test = Marshal.dump("one")
+      found = true if (@iut.keys[0][0] == test or @iut.keys[0][1] == test or @iut.keys[0][2] == test)
+      found.should == true
+    end
+  end
+
+  context "when asked to clear the RAM database" do
+    it "should delete all entries in RAM" do
+      populate_database(@iut)
+      @iut.clear
+      @iut.size.should == 0
+    end
+  end
+
+  def populate_database(iut)
+    iut.save_key_value_pair(Marshal.dump("one"), Marshal.dump("one"))
+    iut.save_key_value_pair(Marshal.dump("two"), Marshal.dump("two"))
+    iut.save_key_value_pair(Marshal.dump("three"), Marshal.dump("three"))
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: persistent-cache
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-12 00:00:00.000000000 Z
+date: 2013-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -109,6 +109,7 @@ files:
 - Rakefile
 - lib/persistent-cache.rb
 - lib/persistent-cache/storage/storage_directory.rb
+- lib/persistent-cache/storage/storage_ram.rb
 - lib/persistent-cache/storage/storage_sq_lite.rb
 - lib/persistent-cache/version.rb
 - multidb
@@ -116,6 +117,7 @@ files:
 - spec/persistent-cache_spec.rb
 - spec/spec_helper.rb
 - spec/storage/storage_directory_spec.rb
+- spec/storage/storage_ram_spec.rb
 - spec/storage/storage_sqlite_spec.rb
 homepage: ''
 licenses: []
@@ -137,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Persistent Cache has a default freshness threshold of 179 days after which
@@ -146,4 +148,5 @@ test_files:
 - spec/persistent-cache_spec.rb
 - spec/spec_helper.rb
 - spec/storage/storage_directory_spec.rb
+- spec/storage/storage_ram_spec.rb
 - spec/storage/storage_sqlite_spec.rb