persistent-cache 0.3.2 → 0.3.3

data/README.md

@@ -4,10 +4,7 @@ Persistent cache behaves like a hash, with a pluggable back-end. Currently sqlit
 
 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. Not though that accessing a stale entry deletes it from the cache. You can use timestamp?(key) to read the timestamp of an entry. 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)
 
-Note that when using a back-end that requires marshalling (e.g. sqlite) the string encoding for []= and [] needs to be the same (e.g. UTF-8, US-ASCII, etc.) If the coding does not match, [] will not be able to find the entry during lookup and will return nil. The easiest way to accomplish this with a ruby script is by adding the following shell directive at the top of your main.rb
-```
-  # encoding: utf-8
-```
+Note that when using a back-end that requires marshalling (e.g. sqlite) the string encoding for []= and [] needs to be the same (e.g. UTF-8, US-ASCII, etc.) If the coding does not match, [] will not be able to find the entry during lookup and will return nil. See the section on 'Encoding' below for more detail.
 
 This gem is sponsored by Hetzner (Pty) Ltd - http://hetzner.co.za
 
@@ -89,14 +86,24 @@ Or install it yourself as:
 
     cache = Persistent::Cache.new("cache-name", nil, Persistent::Cache::STORAGE_RAM)
 
+## Encoding
+
+Note that when using a back-end that requires marshalling (e.g. sqlite) the string encoding for []= and [] needs to be the same (e.g. UTF-8, US-ASCII, etc.) If the coding does not match, [] will not be able to find the entry during lookup and will return nil. See the section on 'Encoding' below for more detail.
+
+The easiest way to accomplish this with a ruby script is by adding the following shell directive at the top of your main.rb
+  # encoding: utf-8
+
+If you'd like persistent cache to rather store keys using an encoding of your preference, after initialization set the encoding explicitly using:
+    cache.encoding = Encoding::UTF_8
+
+## Contributing
+
 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'`)

data/lib/persistent-cache/version.rb

@@ -1,5 +1,5 @@
 module Persistent
   class Cache
-    VERSION = "0.3.2"
+    VERSION = "0.3.3"
   end
 end

data/lib/persistent-cache.rb

@@ -16,6 +16,7 @@ module Persistent
     attr_accessor :storage_details
     attr_accessor :storage
     attr_accessor :fresh
+    attr_accessor :encoding
 
     def initialize(storage_details, fresh = FRESH, storage = STORAGE_SQLITE)
       raise ArgumentError.new("No storage details provided") if storage_details.nil? or storage_details == ""
@@ -49,6 +50,15 @@ module Persistent
       lookup_key(key)
     end
 
+    def lookup_by_key_value(key)
+      if @storage.keys
+        @storage.keys.each do |k|
+          return lookup_key(k) if k == key
+        end
+      end
+      return nil
+    end
+
     def each(&block)
       keys.each do |key|
         yield key, lookup_key(key)
@@ -76,11 +86,13 @@ module Persistent
     private
 
     def save_key_value_pair(key, value, timestamp = nil)
+      key = key.encode!(@encoding) if @encoding
       @storage.delete_entry(key)
       @storage.save_key_value_pair(key, value, timestamp)
     end
 
     def lookup_key(key)
+      key = key.encode!(@encoding) if @encoding
       result = @storage.lookup_key(key)
       return nil if nil_result?(result)
       return nil if stale_entry?(key, result)
@@ -100,6 +112,7 @@ module Persistent
     end
 
     def delete_entry(key)
+      key = key.encode!(@encoding) if @encoding
       @storage.delete_entry(key)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: persistent-cache
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-04 00:00:00.000000000 Z
+date: 2015-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec