collectr 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a1f4385cfefa7933f53f24c6e7301e69cdc462b
-  data.tar.gz: 62e291a7a1d17c36f0caffb0a4318dbdb14ad6e2
+  metadata.gz: ef5508b4fd489d875c554e14b9a7c66865c5b9ba
+  data.tar.gz: 4cc883b6c7e1715a2bf226900b46e7aa75614dd7
 SHA512:
-  metadata.gz: 3a9f9c5d33f12bac6e1fb9de0362ccd4c5769370016845468e200e62c9387cb66b18e555e2c2ddb9883facc2e61210c5ac28f6225104aa4730771a4a4e6c80ca
-  data.tar.gz: 874d39f87800c6d3cdb6f21c7ead59b11615f08bda08215faa421c0a9b18ae63ceb312b5bc1f9b39ec7f5c165df7e01567bf04d54751d5c4aa7f1999bfd9d053
+  metadata.gz: deee470529b6ec71158c8846b10ec7b6cec78c2a72f9b752b44a29a35d456529eeeb6dec9e2be57fd7db2a70dad604b19a5ca8da806c234b2b345ae99dfeb440
+  data.tar.gz: 6e717276f583f241aa831e31d1c6d7a3dd8a1cb96a6179c8574ac09951b7f417b2c518b23af85f725472481881f6da7971ac88361fad73612b40990b30757e74

data/lib/collectr/version.rb

@@ -1,3 +1,3 @@
 module Collectr
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/redis/redis_hash_expiry.rb

@@ -0,0 +1,122 @@
+require 'redis'
+require 'json'
+
+require_relative 'redis_base'
+
+# Redis has a special hash type, which keeps the redis namespace clean, but
+# doesn't allow expriations of the keys inside the hash.
+#
+# This class solves that problem by placing the keys in the global redis namespec.
+# As long as the name provided upon creation is unique, this class acts like a hash.
+#
+# It might be tempting to replace redis_hash.rb with this code; however,
+# that file is preferable when expirations aren't needed because the namespace
+# is kept clean.
+
+module Collectr
+  class RedisHashExpiry < RedisBase
+    attr_reader :store
+
+    def initialize(name, options={})
+      @title = name
+      # Use raw only when both the keys and values are strings.
+      @raw = options.fetch(:raw) { false }
+      @store = Redis.current
+      @default_expires_in = options[:expires_in]
+    end
+
+    def [](key)
+      deserialize @store.get(key_name(key))
+    end
+
+    def []=(key, val, options={})
+    	write(key, val, options)
+    end
+    
+    def set_expiration(key, seconds)
+    	return unless seconds
+    	@store.expire(key_name(key), seconds)
+    end
+
+    def write(key, val, options={})
+      expiration = options.fetch(:expires_in) { @default_expires_in }
+      @store.set key_name(key), serialize(val)
+      set_expiration(key, expiration)
+      val
+    end
+
+    def fetch(key, options={})
+      expiration = options.fetch(:expires_in) { @default_expires_in }
+      result = self[key]
+      if result.nil?
+        return nil if has_key?(key)
+        if block_given?
+          result = yield key
+        else
+          raise KeyError
+        end
+      end
+      result
+    end
+
+    def cache(key, options={})
+    	fetch(key, options) do
+    		result = yield key
+    		write(key, result, options)
+    		result
+    	end
+    end
+
+    def destroy 
+    	keys.each{ |key| delete key }
+    end
+
+    def delete(key)
+      @store.del key_name(key)
+    end
+
+    def empty?
+      size == 0
+    end
+
+    def size
+      keys.size
+    end
+
+    def has_key?(key)
+      key? key
+    end
+    def key?(key)
+      @store.exists key_name(key)
+    end
+
+    def keys
+      @store.keys(key_prefix).collect{ |key| dekey key }
+    end
+
+    def to_hash
+      hash = {}
+      keys.each do |key|
+        hash[key] = self[key]
+      end
+      hash
+    end
+
+    def clear
+      destroy
+      # keys.each{ |key| delete key }
+    end
+    
+    def key_name(key)
+    	"#{@title}-#{serialize(key)}"
+    end
+    
+    def dekey(key)
+    	deserialize(key[key_prefix.size-1..-1])
+    end
+    
+    def key_prefix
+    	@key_prefix ||= "#{@title}-*"
+    end
+  end
+end

data/spec/hash_spec.rb

@@ -1,8 +1,8 @@
 require 'json'
 require 'spec_helper'
 
-require 'redis/redis_hash.rb'
-require 'memory/memory_hash.rb'
+#require 'redis/redis_hash.rb'
+#require 'redis/redis_hash_expiry.rb'
 
 shared_examples 'a hash' do
   context 'when keys and/or values may be other than strings' do
@@ -27,7 +27,7 @@ shared_examples 'a hash' do
       before { collection.clear ; collection[1] = 'aa1' ; collection['b2'] = nil ; collection[[1,2]] = 3 }
 
       its(:size) { should eq(3) }
-      its(:keys) { should eq([1, 'b2', [1,2]]) }
+      it { expect(collection.keys.to_set).to eq([1, 'b2', [1,2]].to_set) }
       its(:to_hash) { should eq({1=>'aa1', 'b2'=>nil, [1,2]=>3}) }
       it { expect(collection.fetch(1)).to eq('aa1') }
       it { expect(collection.fetch('b2')).to eq(nil) }
@@ -43,10 +43,8 @@ shared_examples 'a hash' do
     before { collection.destroy ; collection['1'] = 'a1' ; collection['b2'] = '2'; collection['[1,2]'] = '3' }
     after { collection.clear }
     its(:size) { should eq(3) }
-    its(:keys) { should eq(['1', 'b2', '[1,2]'])}
     its(:to_hash) { should eq({'1'=>'a1', 'b2'=>'2', '[1,2]'=>'3'}) }
-    # it { expect(collection.size).to eq(3) }
-    it { expect(collection.keys).to eq(['1', 'b2', '[1,2]'])}
+    it { expect(collection.keys.to_set).to eq(['1', 'b2', '[1,2]'].to_set)}
     it { expect(collection.to_hash).to eq({'1'=>'a1', 'b2'=>'2', '[1,2]'=>'3'}) }
   end
 
@@ -66,14 +64,15 @@ shared_examples 'a hash' do
   # end
 end
 
-if redis_exists?
+if redis_exists? and false
   describe Collectr::RedisHash do
     it_behaves_like 'a hash'
   end
+
+  describe Collectr::RedisHashExpiry do
+    it_behaves_like 'a hash'
+  end
 end
 
 # warn Redis.current.flushall
 
-describe Collectr::MemoryHash do
-  it_behaves_like 'a hash'
-end

data/spec/memory/memory_hash_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+require 'memory/memory_hash.rb'
+require 'hash_spec'
+
+describe Collectr::MemoryHash do
+  it_behaves_like 'a hash'
+end

data/spec/redis/redis_hash_expiry_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'redis/redis_hash_expiry'
+require 'hash_spec'
+
+if redis_exists?
+	describe Collectr::RedisHashExpiry do
+		
+	  it_behaves_like 'a hash'
+	  
+	  describe 'expires' do
+	  	subject(:collection) { described_class.new 'expiry', expires_in: 1 }
+	  	before{ collection.destroy }
+	  	
+	  	it 'after the default one second' do
+	  		collection['three'] = 3
+	      expect(collection['three']).to eq(3)
+	  		sleep 1.1
+	  		expect(collection['three']).to be_nil
+	  	end
+	  	
+	  	it 'write after overridden 2 second expiration' do
+	  		collection.write('nine', 9, expires_in: 2)
+	      expect(collection['nine']).to eq(9)
+	      sleep 1.3
+	  		expect(collection['nine']).to eq(9)
+	  		sleep 0.8
+	  		expect(collection['nine']).to be_nil
+	  	end
+	  	
+	  	it 'cache after overridden 2 seconds' do
+	  		collection.cache('ten', expires_in: 2) { 10 }
+	  		collection.cache('ten', expires_in: 5) { 20 }
+	      expect(collection['ten']).to eq(10)
+	      sleep 1.1
+	  		expect(collection['ten']).to eq(10)
+	      sleep 1
+	  		expect(collection['ten']).to eq(nil)
+	  	end
+	  end
+	end
+end

data/spec/redis/redis_hash_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'redis/redis_hash'
+require 'hash_spec'
+
+if redis_exists?
+	describe Collectr::RedisHash do
+	  it_behaves_like 'a hash'
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: collectr
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Brian Murphy-Dye
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-16 00:00:00.000000000 Z
+date: 2015-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -218,10 +218,14 @@ files:
 - lib/redis/redis_base.rb
 - lib/redis/redis_factory.rb
 - lib/redis/redis_hash.rb
+- lib/redis/redis_hash_expiry.rb
 - lib/redis/redis_set.rb
 - spec/bag_spec.rb
 - spec/hash_spec.rb
+- spec/memory/memory_hash_spec.rb
 - spec/redis/redis_array_spec.rb
+- spec/redis/redis_hash_expiry_spec.rb
+- spec/redis/redis_hash_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -250,5 +254,8 @@ summary: Abstraction for thread-safe collections (array, hash, set, bag).
 test_files:
 - spec/bag_spec.rb
 - spec/hash_spec.rb
+- spec/memory/memory_hash_spec.rb
 - spec/redis/redis_array_spec.rb
+- spec/redis/redis_hash_expiry_spec.rb
+- spec/redis/redis_hash_spec.rb
 - spec/spec_helper.rb