sir_cachealot 0.4.2 → 0.5

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NmUyMGY5NzdhN2NmNjI2ZTAxYjcwMjM5N2RiYTg5ZmMyOTI0YTZiYg==
+  data.tar.gz: !binary |-
+    MjRhYjBlYmE0ZDQ4MDQ4MDE2MzE3MTU5NzNhNzZhM2I4ODRiNmRmMw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    M2JhMGZiYzc3NGFjMmY4OWUzOWJhMTZjYTc5ODU3NmQ0ZjI1ZjRmMDAxMjM3
+    NjM4NGU4MWVhNzc3YjQ1MmIyNWQ1OGYxYzBmMGFhZGI2M2E3ODEwNDI3NDQz
+    MmFjOWEwODk3ZTIwYzE0YzNiZjIzMWZjNjRlOTBhMjc4MTczYmI=
+  data.tar.gz: !binary |-
+    Mjc5NjRlZGY0ZjU1M2M5YThkZGE0YWVlNmU0NzViMjE2ZGI1ODQ4YzZmZDYy
+    N2RhMjE1ZjZiZGI4NGRkMDI0MTZlM2U2MTI1MDE4MjY5ZjM4NWVjYWU1ZWVh
+    MjQ1MDA1Y2UyMWJlOTIxMWVhOTdjMjIxNzU2Nzc3MDdlZTBkZjk=

data/README.md

@@ -35,7 +35,8 @@ If `config(:delete_on_nil) == true` and `value == nil`, `put()` will return `tru
 
 **You can retreive the value later, if it hasn't expired, with:**
 
-    my_var = Sir.get(keyname)
+    my_var = Sir.get(keyname) # for a shallow copy
+    my_var = Sir.get(keyname, true) # for a deep copy (crude way, Marshal.load(Marshal.dump(obj)) )
 
 or
 

data/lib/sir_cachealot.rb

@@ -1,8 +1,11 @@
-require "sir_cachealot/version"
+#require "sir_cachealot/version"
 
 module Sir
 
 	RAM = :ram_cache
+	REDIS = :redis_cache
+	
+	@@redis_driver = nil
 
 	@@ram_cache = { }
 
@@ -11,8 +14,8 @@ module Sir
 		debug:          false,
 		annoy:          false, #super annoying debug messages
 		default_expiry: 3600, #Integer(1.hour),
-		delete_on_nil:  true
-
+		delete_on_nil:  true,
+		use_redis_obj:	nil
 	}
 
 	#Configuration parameters
@@ -25,6 +28,11 @@ module Sir
 
 		if !key.nil? && !value.nil?
 			@@configuration[key] = value
+			
+			if key == :use_redis_obj
+				self::set_redis_obj(value)
+			end
+			
 			return value
 
 		elsif !key.nil? && value.nil?
@@ -43,6 +51,10 @@ module Sir
 					@@configuration.delete(k)
 				end
 
+				if knew == :use_redis_obj
+					self::set_redis_obj(@@configuration[knew])
+				end
+
 			end
 
 		end
@@ -63,25 +75,30 @@ module Sir
 
 		case config(:mode)
 			when RAM
-
 				if x = @@ram_cache[key]
-
 					if x[:expiry].nil? || x[:expiry] > Time.now
 						to_ret = x[:value]
 					else
 						# cache entry is stale
 						puts ("          SirCachealot: Cache entry <#{key}> expired at #{x[:expiry]}. Deleting...") if config(:debug)
 						@@ram_cache.delete(key)
-
 					end
-
 				end
-
+				
+			when REDIS
+				key = self::nsed_key(key)
+				got = @@redis_driver.get(key) 
+				
+				unless got.nil?
+					to_ret = Marshal.load( got ) 
+				else
+					to_ret = nil
+				end
 			else
 				puke
 		end
 
-		if copy
+		if copy && config(:mode) == RAM
 			to_ret = self.crude_clone(to_ret)
 		end
 
@@ -104,6 +121,12 @@ module Sir
 					@@ram_cache.delete(key)
 					return true
 				end
+			when REDIS
+				if @@redis_driver.del( self::nsed_key(key) )
+					return true
+				end
+			else
+				puke
 		end
 
 	end
@@ -138,12 +161,18 @@ module Sir
 		else
 			case config(:mode)
 				when RAM
-
 					@@ram_cache[key]          ||= { }
 					@@ram_cache[key][:value]  = value
 					@@ram_cache[key][:expiry] = expiry
 					return value
 
+				when REDIS
+					key = self::nsed_key(key)
+					@@redis_driver.set(key, Marshal.dump(value).to_s )
+					#$stderr.puts "Will expire at #{expiry}"
+					@@redis_driver.expireat(key, expiry.to_i) unless expiry == nil
+					return value
+					
 				else
 					puke
 			end
@@ -159,6 +188,8 @@ module Sir
 		case config(:mode)
 			when RAM
 				return @@ram_cache.count
+			when REDIS
+				return :not_possible
 			else
 				puke
 		end
@@ -174,6 +205,8 @@ module Sir
 				@@ram_cache.each do |k, v|
 					puts("%-20s %-20s %20s" % [k, v[:value].class, v[:expiry]])
 				end
+			when REDIS
+				raise ArgumentError, "This command not available in REDIS mode"
 			else
 				puke
 		end
@@ -190,6 +223,8 @@ module Sir
 		case config(:mode)
 			when RAM
 				@@ram_cache = { }
+			when REDIS
+				raise ArgumentError, "This command not available in REDIS mode"
 			else
 				puke
 		end
@@ -209,6 +244,8 @@ module Sir
 						@@ram_cache.delete(k)
 					end
 				end
+			when REDIS
+				raise ArgumentError, "This command not available in REDIS mode"
 			else
 				puke
 		end
@@ -218,13 +255,28 @@ module Sir
 
 	private
 
+	def self.set_redis_obj(value)
+		if value.class.name == "Redis"
+			@@configuration[:mode] = REDIS
+			@@redis_driver = @@configuration[:use_redis_obj] 
+		else
+			if @@configuration[:mode] == REDIS
+				raise ArgumentError, "use_redis_obj must be of class Redis"
+			end
+			
+		end
+	end
+
 	def self.puke
 		raise TypeError, "Invalid config(:mode). Check the inputs sent to Sir.configure()"
 	end
 
-
 	def self.crude_clone(obj)
 		return Marshal.load(Marshal.dump(obj))
 	end
-
-end
+	
+	# returns a namespaced key
+	def self.nsed_key(key)
+		return "SirCachealot-#{key}"
+	end
+end

data/lib/sir_cachealot/version.rb

@@ -1,3 +1,3 @@
 module SirCachealot
-  VERSION = "0.4.2"
+  VERSION = "0.5"
 end

data/sir_cachealot.gemspec

@@ -18,5 +18,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_development_dependency 'rspec', '~> 2.5'
+  gem.add_development_dependency 'redis'
 
 end

data/spec/redis_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'redis'
+
+TEST           = "test"
+DEFAULT_EXPIRY = 600
+
+redis_obj = Redis.new(:path => "/tmp/redis.sock")
+
+describe "SirCachealot Redis support" do
+	
+	it 'should connect and configure correctly' do
+		Sir.configure do |config|
+			config[:default_expiry] = DEFAULT_EXPIRY
+			config[:mode]          = :redis_cache
+			config[:debug]          = true
+			config[:use_redis_obj] = redis_obj
+		end
+	end
+
+	it 'should return the key that is put into it' do
+		Sir.put(:test, TEST).should == TEST
+	end
+
+	it 'should return an arbitrary key' do
+		(Sir.get(:test) == TEST).should == true
+	end
+
+	it 'should yield when given a block and a key that does not exist' do
+		(Sir.get(:asdoiajdoaijdaodijaodiajdoaidjaodijaodij) { 5 }).should == 5
+	end
+
+	it 'should return nil when not given a block and a key that does not exist' do
+		(Sir.get(:asdoiajdoaijdaodijaodiajdoaidjaodijaodij)).should == nil
+	end
+
+	it 'should immediately expire a 0-expiry key' do
+		Sir.put(:expire, TEST, 0)
+		sleep(1)
+
+		Sir.get(:expire).should == nil
+	end
+
+	it 'should report its size correctly' do
+
+		Sir.size?.should == :not_possible
+
+	end
+
+end

data/spec/sir_cachealot_spec.rb

@@ -13,7 +13,7 @@ describe SirCachealot do
 			config[:debug]          = true
 		end
 
-		(Sir.config(:default_expiry) == DEFAULT_EXPIRY && Sir.config("MODE") == :ram_cache).should == true
+		(Sir.config(:default_expiry) == DEFAULT_EXPIRY && Sir.config(:mode) == :ram_cache).should == true
 
 	end
 
@@ -22,9 +22,7 @@ describe SirCachealot do
 	end
 
 	it 'should return an arbitrary key' do
-
 		(Sir.get(:test) == TEST).should == true
-
 	end
 
 	it 'should yield when given a block and a key that does not exist' do
@@ -104,6 +102,5 @@ describe SirCachealot do
 		(hash[:a][:aa]).should_not == newhash[:a][:aa]
 
 	end
-
-
+	
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: sir_cachealot
 version: !ruby/object:Gem::Version
-  version: 0.4.2
-  prerelease: 
+  version: '0.5'
 platform: ruby
 authors:
 - Lyjia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-06 00:00:00.000000000 Z
+date: 2013-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,11 +20,24 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A dead simple RAM keystore
 email:
 - tom@tomcorelis.com
@@ -43,35 +54,36 @@ files:
 - lib/sir_cachealot/version.rb
 - sir_cachealot.gemspec
 - sircachealot.png
+- spec/redis_spec.rb
 - spec/sir_cachealot_spec.rb
 - spec/spec_helper.rb
 homepage: http://www.lyjia.us
 licenses: []
+metadata: {}
 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
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: SirCachealot is a drop-in memcache-like RAM cache for Ruby. Cache entries
   are saved and recalled by a key string, and their values can be whatever a Ruby
   hash can hold. Values can also expire, however expiration is only checked when the
   key is called, or a manual sweeper is run.
 test_files:
+- spec/redis_spec.rb
 - spec/sir_cachealot_spec.rb
 - spec/spec_helper.rb