redis-objective 0.1.0

data/README.md

@@ -0,0 +1,39 @@
+Store objects in Redis
+
+    sudo gem install redis-objective
+
+Usage
+=====
+    require 'redis/objective'
+    redis = Redis.new(:host => ...).objective
+
+    redis['xxx'] = {:foo => :bar}
+    redis['xxx'] # {:foo => :bar}
+    redis['xxx'] = nil # delete key 'xxx'
+
+    # Non-objects can be read:
+    pure = Redis.new
+    pure['xxx'] = 'abc'
+    redis['xxx'] # 'abc'
+
+    # get/set - many
+    redis.mset('xxx' => {:foo => :bat}, 'yyy' => 'something else') # {'xxx' => {:foo => :bar}, 'yyy' => 'something else'}
+    redis.mget('xxx','yyy') # {'xxx' => {:foo => :bar}, 'yyy' => 'something else'}
+
+### Supported methods
+
+ - get / []
+ - set /set_with_expire / []=
+ - mget / mapped_mget
+ - mset / mapped_mset
+ - all other missing methods are delegated
+
+TODO
+====
+ - also unset keys that were set to nil via mset
+
+Author
+======
+[Michael Grosser](http://pragmatig.wordpress.com)  
+grosser.michael@gmail.com  
+Hereby placed under public domain, do what you want, just do not hold me accountable...

data/Rakefile

@@ -0,0 +1,20 @@
+task :default => :spec
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new {|t| t.spec_opts = ['--color']}
+
+begin
+  require 'jeweler'
+  project_name = 'redis-objective'
+  Jeweler::Tasks.new do |gem|
+    gem.name = project_name
+    gem.summary = "Store objects in Redis"
+    gem.email = "grosser.michael@gmail.com"
+    gem.homepage = "http://github.com/grosser/#{project_name}"
+    gem.authors = ["Michael Grosser"]
+    gem.add_dependency ['redis']
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/redis/objective.rb

@@ -0,0 +1,59 @@
+require 'redis'
+
+class Redis::Client
+  def objective
+    @@objective ||= Redis::Objective.new(self)
+  end
+end
+
+class Redis::Objective
+  VERSION = File.read( File.join(File.dirname(__FILE__),'..','..','VERSION') ).strip
+
+  def initialize(client)
+    @client = client
+  end
+
+  def get(key, *args)
+    value = @client.get(key, *args)
+    return if value.nil?
+    YAML.load(value)
+  end
+  alias :[] :get
+
+  def set(key, value, *args)
+    if value.nil?
+      @client.del(key)
+    else
+      if args.empty?
+        @client.set(key, value.to_yaml)
+      else
+        @client.set_with_expire(key, value.to_yaml, *args)
+      end
+    end
+    value
+  end
+  alias :[]= :set
+  alias :set_with_expire :set
+
+  def mapped_mget(*args)
+    @client.mapped_mget(*args).inject({}){|h,k_v| h[k_v[0]] = YAML.load(k_v[1]); h}
+  end
+  alias :mget :mapped_mget
+
+  def mset(*args)
+    # flatten given hash/nested array
+    if args.size == 1
+      args = args.first.inject([]){|a,k_v| a << k_v[0]; a << k_v[1]; a}
+    end
+
+    # serialize all values [k1, v1, k2, v2, ...]
+    args.size.times{|i| args[i] = args[i].to_yaml if i % 2 == 1 }
+
+    @client.mset(*args)
+  end
+  alias :mapped_mset :mset
+
+  def method_missing(name, *args, &block)
+    @client.send(name, *args, &block)
+  end
+end

data/spec/redis/objective_spec.rb

@@ -0,0 +1,126 @@
+require 'rubygems'
+
+$LOAD_PATH << 'lib'
+require 'redis/objective'
+
+REDIS = Redis.new
+
+REDIS['xxx'] = '1'
+REDIS['xxx'].should == '1'
+
+describe "Redis.objective" do
+  before do
+    REDIS.flushdb
+  end
+
+  describe :get do
+    before do
+      REDIS.objective.set('x',[1,2])
+    end
+
+    it 'works through []' do
+      REDIS.objective['x'].should == [1,2]
+    end
+
+    it 'works through get' do
+      REDIS.objective.get('x').should == [1,2]
+    end
+
+    it 'does crash with nil' do
+      REDIS.objective.get('unknown').should == nil
+    end
+  end
+
+  describe :set do
+    it 'works through []' do
+      REDIS.objective['x'] = [1,2]
+      REDIS.objective['x'].should == [1,2]
+    end
+
+    it 'works through set' do
+      REDIS.objective.set('x', [1,2])
+      REDIS.objective['x'].should == [1,2]
+    end
+
+    it 'works through set_with_expire' do
+      pending 'my local redis server des not support this...'
+      REDIS.objective.set_with_expire('x', [1,2], 1)
+      REDIS.objective['x'].should == [1,2]
+      sleep 1
+      REDIS.objective['x'].should == nil
+    end
+
+    it 'does not set nil' do
+      REDIS.objective['x'] = nil
+      REDIS['x'].should == nil
+    end
+
+    it 'overwrites when setting nil' do
+      REDIS.objective['x'] = [1,2]
+      REDIS.objective['x'] = nil
+      REDIS['x'].should == nil
+    end
+
+    it 'returns the set value' do
+      REDIS.objective.set('x',[1,2]).should == [1,2]
+      REDIS.objective.set('x',nil).should == nil
+    end
+  end
+
+  describe :mapped_mget do
+    before do
+      REDIS.objective['xx'] = [1,2]
+      REDIS.objective['xy'] = [3,4]
+    end
+
+    it 'gets objective' do
+      REDIS.objective.mapped_mget('xx','xy').should == {'xx' => [1,2], 'xy' => [3,4]}
+    end
+
+    it 'does not crash with nil' do
+      REDIS.objective.mapped_mget('xx','unknown').should == {'xx' => [1,2]}
+    end
+
+    it 'works with mget' do
+      REDIS.objective.mget('xx','unknown').should == {'xx' => [1,2]}
+    end
+  end
+
+  describe :mapped_mset do
+    it 'sets objective' do
+      REDIS.objective.mapped_mset('xx' => [1,2], 'xy' => [3,4])
+      REDIS.objective['xx'].should == [1,2]
+      REDIS.objective['xy'].should == [3,4]
+    end
+
+    it 'sets with nested array' do
+      REDIS.objective.mapped_mset([['xx', [1,2]], ['xy', [3,4]]])
+      REDIS.objective['xx'].should == [1,2]
+      REDIS.objective['xy'].should == [3,4]
+    end
+
+    it 'sets with flat array' do
+      REDIS.objective.mapped_mset('xx', [1,2], 'xy', [3,4])
+      REDIS.objective['xx'].should == [1,2]
+      REDIS.objective['xy'].should == [3,4]
+    end
+
+    it 'sets with mset' do
+      REDIS.objective.mset('xx', [1,2], 'xy', [3,4])
+      REDIS.objective['xx'].should == [1,2]
+      REDIS.objective['xy'].should == [3,4]
+    end
+
+    it 'can set nil' do
+      REDIS.objective.mset('xx', [1,2], 'xy', nil)
+      REDIS.objective['xx'].should == [1,2]
+      REDIS.objective['xy'].should == nil
+    end
+
+    it 'deletes keys that are set to nil'
+  end
+
+  it 'has a version' do
+    Redis::Objective::VERSION.should =~ /^\d+\.\d+\.\d+$/
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: redis-objective
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-13 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: grosser.michael@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- Rakefile
+- VERSION
+- lib/redis/objective.rb
+- spec/redis/objective_spec.rb
+has_rdoc: true
+homepage: http://github.com/grosser/redis-objective
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Store objects in Redis
+test_files: 
+- spec/redis/objective_spec.rb