persistent-cache 0.0.6

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p194@persistent-hash"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.14.3 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'rspec'
+
+# Specify your gem's dependencies in persistent-cache.gemspec
+gemspec
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Wynand van Dyk, Ernst van Graan, Hetzner (Pty) Ltd
+
+MIT License
+
+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,76 @@
+# Persistent::Cache
+
+Persistent cache behaves like a hash, with a sqlite3 storage back-end. 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. If stale data is requested from the cache, nil is returned. Updates to the cache are
+written to the sqlite3 storage, with SQL driver timeout set to 30 seconds. 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 from the
+sqlite database
+
+This gem is sponsored by Hetzner (Pty) Ltd - http://hetzner.co.za
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'persistent-cache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install persistent-cache
+
+## Usage
+
+cache = Persistent::Cache.new("/tmp/my-persistent-cache", 3600) # 1 hour freshness
+
+cache["testkey"] = "testvalue"
+puts cache["testkey"] # testvalue
+
+cache["testkey"] = "newvalue"
+puts cache["testkey"] # newvalue
+
+cache["testkey"] = nil
+puts cache["testkey"] #
+
+cache["testkey"] = "one"
+cache["testkey2"] = "two"
+cache["testkey3"] = 3
+
+cache.each do |key|
+  puts "#{key} - #{cache[key]}"
+end
+
+#testkey - one
+#testkey2 - two
+#testkey3 - 3
+
+puts cache.size # 3
+
+puts cache.keys
+#testkey
+#testkey2
+#testkey3
+
+cache.clear # []
+
+puts cache.size #0
+
+cache = Persistent::Cache.new("/tmp/my-persistent-cache") # 15465600 (179 days) freshness
+
+cache = Persistent::Cache.new("/tmp/my-persistent-cache", nil) # for-ever fresh
+
+Please send feedback and comments to the authors at:
+Wynand van Dyk <wynand.van.dyk@hetzner.co.za>
+Ernst van Graan <ernst.van.graan@hetzner.co.za>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/persistent-cache.rb

@@ -0,0 +1,104 @@
+require "persistent-cache/version"
+require "sqlite3"
+
+module Persistent
+  class Cache
+    # 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
+    DB_TABLE = "key_value"; DB_TABLE.freeze
+
+    attr_accessor :database_details
+
+    def initialize(database_details, fresh = FRESH)
+      @database_details = database_details
+      @db_handle = connect_to_database
+      @db_handle.busy_timeout = 30000
+      @fresh = fresh
+    end
+
+    def []=(key, value)
+      if value.nil?
+        delete_entry(Marshal.dump(key))
+      else
+        save_key_value_pair(Marshal.dump(key), Marshal.dump(value))
+      end
+    end
+
+    def [](key)
+      lookup_key(Marshal.dump(key))
+    end
+
+    def each(&block)
+      keys.each do |key|
+        yield key, lookup_key(Marshal.dump(key))
+      end
+    end
+
+    def size
+      @db_handle.execute("SELECT value FROM #{DB_TABLE}").size
+    end
+
+    def keys
+      @db_handle.execute("SELECT key FROM #{DB_TABLE}").collect { |key|
+        Marshal.load(key[0])
+      }
+    end
+
+    def clear
+      @db_handle.execute("DELETE FROM #{DB_TABLE}")
+    end
+
+    # Methods not supported by this implementation
+    private
+
+    def save_key_value_pair(serialized_key, serialized_value)
+      delete_entry(serialized_key)
+      @db_handle.execute("INSERT INTO #{DB_TABLE} (key, value, timestamp) VALUES(?, ?, ?)",serialized_key, serialized_value, Time.now.to_s)
+    end
+
+    def lookup_key(serialized_key)
+      result = @db_handle.execute("SELECT value, timestamp FROM #{DB_TABLE} WHERE key=?", serialized_key)
+      return nil if nil_result?(result)
+      return nil if stale_entry?(serialized_key, result)
+
+      return Marshal.load(result[0][0])
+    end
+
+    def stale_entry?(serialized_key, result)
+      return false if @fresh.nil?
+      timestamp = Time.parse(result[0][1])
+      if ((Time.now - timestamp) > FRESH)
+        delete_entry(serialized_key)
+        return true
+      end
+      return false
+    end
+
+    def delete_entry(serialized_key)
+      @db_handle.execute("DELETE FROM #{DB_TABLE} WHERE key=?", serialized_key)
+    end
+
+    def open_database
+      @handle = SQLite3::Database.open(@database_details)
+    end
+
+    def create_database
+      @handle = SQLite3::Database.new(@database_details)
+      create_table
+      @handle
+    end
+
+    def create_table
+      @handle.execute("CREATE TABLE #{DB_TABLE}(key TEXT PRIMARY KEY, value TEXT, timestamp TEXT)")
+      @handle
+    end
+
+    def connect_to_database
+      File.exists?(@database_details) ? open_database : create_database
+    end
+
+    def nil_result?(result)
+      result.nil? or result[0].nil? or result[0][0].nil?
+    end
+  end
+end

data/lib/persistent-cache/version.rb

@@ -0,0 +1,5 @@
+module Persistent
+  class Cache
+    VERSION = "0.0.6"
+  end
+end

data/persistent-cache.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/persistent-cache/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Wynand van Dyk", "Ernst van Graan"]
+  gem.email         = ["wvd@hetzner.co.za", "ernst.van.graan@hetzner.co.za"]
+  gem.description   = %q{Persistent Cache using SQLite}
+  gem.summary       = %q{Persistent Cache has a default freshness threshold of 179 days after which entries are no longer returned}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "persistent-cache"
+  gem.require_paths = ["lib"]
+  gem.version       = Persistent::Cache::VERSION
+  gem.add_development_dependency 'rspec', '2.12.0'
+  gem.add_dependency 'sqlite3', '1.3.7'
+end

data/spec/persistent-cache_spec.rb

@@ -0,0 +1,182 @@
+require 'spec_helper'
+require 'persistent-cache'
+require 'tempfile'
+
+describe Persistent::Cache do
+  def get_database_name
+    path = Tempfile.new("persistent-cache-spec-testdb").path
+    FileUtils.rm_f(path)
+    path
+  end
+
+  before :each do
+    @db_name = get_database_name
+  end
+
+
+  context "When assigning a value to a key" do
+    it "should store the key/value pair in the db, with a timestamp" do
+      start_time = Time.now - 1
+      @pcache = Persistent::Cache.new(@db_name)
+      @pcache["testkey"] = "testvalue"
+      handle = SQLite3::Database.open(@db_name)
+      result = handle.execute "select value, timestamp from #{Persistent::Cache::DB_TABLE} where key=?", Marshal.dump("testkey")
+      result.nil?.should == false
+      result[0].nil?.should == false
+      result[0][0].should == Marshal.dump("testvalue")
+      test_time = Time.parse(result[0][1])
+      test_time.should > start_time and test_time.should < start_time + 600
+    end
+
+    it "should overwrite the existing key/value pair if they already exist" do
+      @pcache = Persistent::Cache.new(@db_name)
+      @pcache["testkey"] = "testvalue"
+      @pcache["testkey"] = "testvalue2"
+      handle = SQLite3::Database.open(@db_name)
+      result = handle.execute "select value from #{Persistent::Cache::DB_TABLE} where key=?", Marshal.dump("testkey")
+      result.nil?.should == false
+      result[0].nil?.should == false
+      result.size.should == 1
+      result[0][0].should == Marshal.dump("testvalue2")
+    end
+
+    it "should serialize the key and value for persistence" do
+      @pcache = Persistent::Cache.new(@db_name)
+      @pcache.should_receive(:save_key_value_pair).with(Marshal.dump("testkey"), Marshal.dump("testvalue"))
+      @pcache["testkey"] = "testvalue"
+    end
+  end
+  
+  context "When looking up a value given its key" do
+    it "should retrieve the value from the database and deserialize the value" do
+      @pcache = Persistent::Cache.new(@db_name)
+      @pcache["testkey"] = "testvalue2"
+      result = @pcache["testkey"]
+      result.should == "testvalue2"
+    end
+
+    it "should return nil if a value exists but it not fresh" do
+      fetch_stale_entry
+    end
+
+    it "should remove from the cache an entry it encounters that is not fresh" do
+      fetch_stale_entry
+      result = @handle.execute("SELECT value FROM #{Persistent::Cache::DB_TABLE} WHERE key=?", Marshal.dump("oldkey"))
+      result.size.should == 0
+    end
+
+    it "should return nil if a key is not in the database" do
+      @pcache = Persistent::Cache.new(@db_name)
+      @pcache["testkey"] = "testvalue2"
+      result = @pcache["testkey2"]
+      result.nil?.should == true
+    end
+
+    it "should serialize the key for lookup" do
+      @pcache = Persistent::Cache.new(@db_name)
+      @pcache["testkey"] = "testvalue"
+      @pcache.should_receive(:lookup_key).with(Marshal.dump("testkey"))
+      @pcache["testkey"]
+    end
+
+    def fetch_stale_entry
+      @pcache = Persistent::Cache.new(@db_name)
+      timestamp = Time.now - Persistent::Cache::FRESH
+      @handle = SQLite3::Database.open(@db_name)
+      @handle.execute("INSERT INTO #{Persistent::Cache::DB_TABLE} (key, value, timestamp) VALUES ('#{Marshal.dump("oldkey")}', '#{Marshal.dump("oldvalue")}', '#{timestamp}')")
+      @pcache["oldkey"].nil?.should == true
+    end
+  end
+
+  context "when constructing" do
+    it "should receive database connection details" do
+      @pcache = Persistent::Cache.new(@db_name)
+      @pcache.class.should == Persistent::Cache
+      @pcache.database_details.should == @db_name
+    end
+
+    it "should create the database if it does not exist" do
+      FileUtils.rm_f(@db_name)
+      Persistent::Cache.new(@db_name)
+      File.exists?(@db_name).should be_true
+    end
+
+    it "should create a key_value table with key (TEXT) and value (TEXT) and timestamp (TEXT) columns" do
+      FileUtils.rm_f(@db_name)
+      Persistent::Cache.new(@db_name)
+      handle = SQLite3::Database.open(@db_name)
+      result = handle.execute "PRAGMA table_info(#{Persistent::Cache::DB_TABLE})"
+      result[0][1].should == "key"
+      result[0][2].should == "TEXT"
+      result[1][1].should == "value"
+      result[1][2].should == "TEXT"
+      result[2][1].should == "timestamp"
+      result[2][2].should == "TEXT"
+    end
+
+
+    it "should use the existing database if it does exist" do
+      FileUtils.rm_f(@db_name)
+      handle = SQLite3::Database.new(@db_name)
+      handle.execute "create table test123 ( id int );"
+      handle.close
+      Persistent::Cache.new(@db_name)
+      handle = SQLite3::Database.open(@db_name)
+      result = handle.execute "select name from sqlite_master where type='table'"
+      result[0][0].should == "test123"
+    end
+  end
+
+  context "it should behave like a cache" do
+    it "should return the correct size" do
+      setup_cache
+      @pcache.size.should == 3
+    end
+
+    it "should return the list of keys when asked" do
+      setup_cache
+      @pcache.keys.should == ["one", "two", "three"]
+    end
+
+    it "should allow iteration through each" do
+      setup_cache
+      test = []
+      @pcache.each do |key, value|
+        test << "#{key} => #{value}"
+      end
+      test.should == ["one => value one", "two => value two", "three => value three"]
+    end
+
+    it "should delete all entries in the database when asked to clear" do
+      setup_cache
+      @pcache.clear
+      @pcache.size.should == 0
+    end
+
+    it "should be able to handle multiple accesses to the same db" do
+      #pending "find a better way to test this, currently you need to spawn multiple rspecs running this test to hit the error if the busy_timeout is not specified"
+      pcache = Persistent::Cache.new("multidb") 
+      pcache["multi_test"] = 0
+
+      threads = []
+      100.times do |i|
+        threads << Thread.new do
+          Thread.current['pcache'] = Persistent::Cache.new("multidb") 
+          Thread.current['pcache']["multi_test"] += 1
+        end
+      end
+      threads.each { |t| t.join }
+
+      p pcache["multi_test"]
+      
+    end
+
+    def setup_cache
+      FileUtils.rm_f(@db_name)
+      @pcache = Persistent::Cache.new(@db_name)
+      @pcache["one"] = "value one"
+      @pcache["two"] = "value two"
+      @pcache["three"] = "value three"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'rspec'
+require 'rspec/mocks'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'persistent-cache'))
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: persistent-cache
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+  prerelease: 
+platform: ruby
+authors:
+- Wynand van Dyk
+- Ernst van Graan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+description: Persistent Cache using SQLite
+email:
+- wvd@hetzner.co.za
+- ernst.van.graan@hetzner.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/persistent-cache.rb
+- lib/persistent-cache/version.rb
+- persistent-cache.gemspec
+- spec/persistent-cache_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Persistent Cache has a default freshness threshold of 179 days after which
+  entries are no longer returned
+test_files:
+- spec/persistent-cache_spec.rb
+- spec/spec_helper.rb