redis-objects 0.5.2 → 0.5.3

data/README.rdoc

@@ -26,7 +26,9 @@ you want to create.
 
 == Installation
 
-    gem install redis-objects
+Add it to your Gemfile as:
+
+    gem 'redis-objects', :require => 'redis/objects'
 
 == Example 1: Model Class Usage
 
@@ -45,7 +47,7 @@ config/initializers/redis.rb is a good place for this.)
 
     require 'redis'
     require 'redis/objects'
-    Redis::Objects.redis = Redis.new(:host => '127.0.0.1', :port => 6379)
+    Redis.current = Redis.new(:host => '127.0.0.1', :port => 6379)
 
 Remember you can use Redis::Objects in any Ruby code.  There are *no* dependencies
 on Rails.  Standalone, Sinatra, Resque - no problem.
@@ -124,15 +126,15 @@ which may already exist on the redis-server.
 === Initialization
 
 Redis::Objects needs a handle to the +redis+ server.  For standalone use, you
-can either set the $redis global variable:
+can either set Redis.current:
 
-    $redis = Redis.new(:host => 'localhost', :port => 6379)
-    @list  = Redis::List.new('mylist')
+    Redis.current = Redis.new(:host => 'localhost', :port => 6379)
+    @list = Redis::List.new('mylist')
 
 Or you can pass the Redis handle into the new method for each type:
 
-    redis  = Redis.new(:host => 'localhost', :port => 6379)
-    @list  = Redis::List.new('mylist', redis)
+    @redis = Redis.new(:host => 'localhost', :port => 6379)
+    @list = Redis::List.new('mylist', @redis)
 
 === Counters
 
@@ -351,8 +353,8 @@ Atomic counters are a good way to handle concurrency:
       @team.drafted_players.decrement
     end
 
-Atomic block - a cleaner way to do the above. Exceptions or return nil
-rewind counter back to previous state:
+Atomic block - a cleaner way to do the above. <b><em>Exceptions or returning nil
+rewind counter back to previous state</em></b>:
 
     @team.drafted_players.increment do |val|
       raise Team::TeamFullError if val > @team.max_players
@@ -411,6 +413,6 @@ lock time.
 
 == Author
 
-Copyright (c) 2009-2010 {Nate Wiger}[http://nate.wiger.org].  All Rights Reserved.
+Copyright (c) 2009-2012 {Nate Wiger}[http://nateware.com].  All Rights Reserved.
 Released under the {Artistic License}[http://www.opensource.org/licenses/artistic-license-2.0.php].
 

data/VERSION

@@ -1 +1 @@
-0.5.2
+0.5.3

data/lib/redis/hash_key.rb

@@ -70,7 +70,7 @@ class Redis
 
     # Retrieve the entire hash.  Redis: HGETALL
     def all
-      h = redis.hgetall(key)
+      h = redis.hgetall(key) || {}
       h.each { |k,v| h[k] = from_redis(v, options[:marshal_keys][k]) }
       h
     end
@@ -115,6 +115,15 @@ class Redis
         arr + [kv[0], to_redis(kv[1], options[:marshal_keys][kv[0]])]
       })
     end
+    alias_method :update, :bulk_set
+
+    # Set keys in bulk if they do not exist. Takes a hash of field/values {'field1' => 'val1'}. Redis: HSETNX
+    def fill(pairs={})
+      raise ArgumentErorr, "Arugment to fill must be a hash of key/value pairs" unless pairs.is_a?(::Hash)
+      pairs.each do |field, value|
+        redis.hsetnx(key, field, to_redis(value, options[:marshal_keys][field]))
+      end
+    end
 
     # Get keys in bulk, takes an array of fields as arguments. Redis: HMGET
     def bulk_get(*fields)

data/lib/redis/helpers/core_commands.rb

@@ -38,8 +38,12 @@ class Redis
         redis.expire key, unixtime
       end
 
+      def persist
+        redis.persist key
+      end
+
       def ttl
-        redis.ttl(@key).seconds
+        redis.ttl(@key)
       end
 
       def move(dbindex)

data/lib/redis/list.rb

@@ -32,6 +32,18 @@ class Redis
       from_redis redis.rpop(key)
     end
 
+    # Atomically pops a value from one list, pushes to another and returns the
+    # value.  Destination can be a String or a Redis::List
+    #
+    #   list.rpoplpush(destination)
+    #
+    # Returns the popped/pushed value.
+    #
+    # Redis: RPOPLPUSH
+    def rpoplpush(destination)
+      from_redis redis.rpoplpush(key, destination.is_a?(Redis::List) ? destination.key : destination.to_s)
+    end
+
     # Add a member to the start of the list. Redis: LPUSH
     def unshift(value)
       redis.lpush(key, to_redis(value))

data/lib/redis/set.rb

@@ -26,6 +26,11 @@ class Redis
       redis.sadd(key, to_redis(value))
     end
 
+    # Remove and return a random member.  Redis:SPOP
+    def pop
+      from_redis redis.spop(key)
+    end
+
     # Return all members in the set.  Redis: SMEMBERS
     def members
       v = from_redis redis.smembers(key)
@@ -133,6 +138,19 @@ class Redis
       redis.sdiffstore(name, key, *keys_from_objects(sets))
     end
 
+    # Moves value from one set to another. Destination can be a String
+    # or Redis::Set.
+    #
+    #   set.move(value, "name_of_key_in_redis")
+    #   set.move(value, set2)
+    #
+    # Returns true if moved successfully.
+    #
+    # Redis: SMOVE
+    def move(value, destination)
+      redis.smove(key, destination.is_a?(Redis::Set) ? destination.key : destination.to_s, value)
+    end
+
     # The number of members in the set. Aliased as size. Redis: SCARD
     def length
       redis.scard(key)

data/lib/redis/sorted_set.rb

@@ -58,11 +58,19 @@ class Redis
     # When the given member does not exist in the sorted set, nil is returned.
     # The returned rank (or index) of the member is 0-based for both commands
     def rank(member)
-      redis.zrank(key, to_redis(member)).to_i
+      if n = redis.zrank(key, to_redis(member))
+        n.to_i
+      else
+        nil
+      end
     end
 
     def revrank(member)
-      redis.zrevrank(key, to_redis(member)).to_i
+      if n = redis.zrevrank(key, to_redis(member))
+        n.to_i
+      else
+        nil
+      end
     end
 
     # Return all members of the sorted set with their scores.  Extremely CPU-intensive.

data/lib/redis/value.rb

@@ -13,11 +13,15 @@ class Redis
     attr_reader :key, :options, :redis
     def initialize(key, *args)
       super(key, *args)
-      @redis.setnx(key, @options[:default]) if @options[:default]
+      @redis.setnx(key, to_redis(@options[:default])) if @options[:default]
     end
 
     def value=(val)
-      redis.set key, to_redis(val)
+      if val.nil?
+        delete
+      else
+        redis.set key, to_redis(val)
+      end
     end
     alias_method :set, :value=
 
@@ -26,8 +30,17 @@ class Redis
     end
     alias_method :get, :value
 
-    def to_s;  value.to_s; end
-    def ==(x); value == x; end
-    def nil?;  value.nil?; end
+    def inspect
+      "#<Redis::Value #{value.inspect}>"
+    end
+
+    def ==(other); value == other end
+    def nil?; value.nil? end
+    def as_json(*args); value.as_json *args end
+    def to_json(*args); value.to_json *args end
+
+    def method_missing(*args)
+      self.value.send *args
+    end
   end
 end

data/redis-objects.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "redis-objects"
-  s.version = "0.5.2"
+  s.version = "0.5.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nate Wiger"]
-  s.date = "2011-09-20"
+  s.date = "2012-06-13"
   s.description = "Map Redis types directly to Ruby objects. Works with any class or ORM."
   s.email = "nate@wiger.org"
   s.extra_rdoc_files = [

data/spec/redis_objects_instance_spec.rb

@@ -14,6 +14,11 @@ describe Redis::Value do
     @value = Redis::Value.new('spec/value')
     @value.delete
   end
+  
+  it "should marshal default value" do
+    @value = Redis::Value.new('spec/value', :default => {:json => 'data'}, :marshal => true)
+    @value.value.should == {:json => 'data'}
+  end
 
   it "should handle simple values" do
     @value.should == nil
@@ -58,6 +63,33 @@ describe Redis::Value do
     @value.value.should == 'Peter Pan'
   end
 
+  it "should provide a readable inspect" do
+    @value.value = 'monkey'
+    @value.inspect.should == '#<Redis::Value "monkey">'
+    @value.value = 1234
+    @value.inspect.should == '#<Redis::Value "1234">'
+  end
+
+  it 'should delegate unrecognized methods to the value' do
+    @value.value = 'monkey'
+    @value.to_sym.should == :monkey
+  end
+
+  it 'should properly pass equality operations on to the value' do
+    @value.value = 'monkey'
+    @value.should == 'monkey'
+  end
+
+  it 'should properly pass nil? on to the value' do
+    @value.delete
+    @value.nil?.should == true
+  end
+
+  it 'should equate setting the value to nil to deletion' do
+    @value.value = nil
+    @value.nil?.should == true
+  end
+
   after do
     @value.delete
   end
@@ -187,6 +219,17 @@ describe Redis::List do
       @list.get.should == ['a','c','f','j','a']
     end
 
+    it "should handle rpoplpush" do
+      list2 = Redis::List.new("spec/list2")
+      list2.clear
+
+      @list << "a" << "b"
+      result = @list.rpoplpush(list2)
+      result.should == "b"
+      @list.should == ["a"]
+      list2.should == ["b"]
+    end
+
     it "should handle lists of complex data types" do
       @list.options[:marshal] = true
       v1 = {:json => 'data'}
@@ -520,6 +563,15 @@ describe Redis::HashKey do
     @hash.incr('counter')
     @hash['counter'].to_i.should == 2
   end
+
+  it "should respond to fill" do
+    @hash['foo'] = 'bar'
+    
+    @hash.fill('abc' => '123', 'bang' => 'michael')
+    @hash['foo'].should == 'bar'
+    @hash['abc'].should == '123'
+    @hash['bang'].should == 'michael'
+  end
   
 
   after do
@@ -559,7 +611,12 @@ describe Redis::Set do
     @set.get.sort.should == ['a','b']
     @set.length.should == 2
     @set.size.should == 2
+    @set.delete('a')
+    @set.pop.should == 'b'
     
+    @set.add('a')
+    @set.add('b')
+
     i = 0
     @set.each do |st|
       i += 1
@@ -742,6 +799,14 @@ describe Redis::SortedSet do
     # @set.rank('b').should == 2
     # @set.revrank('b').should == 3
 
+    # shouldn't report a rank for a key that doesn't exist
+    @set.rank('foo').should.not == @set.rank(@set.first)
+    @set.rank('foo').should == nil
+
+    # shouldn't report a rank for a key that doesn't exist
+    @set.revrank('foo').should.not == @set.revrank(@set.first)
+    @set.revrank('foo').should == nil
+
     @set['f'] = 100
     @set['g'] = 110
     @set['h'] = 120

data/spec/redis_objects_model_spec.rb

@@ -142,6 +142,26 @@ describe Redis::Objects do
     @roster.contact_information.size.should == 2
   end
 
+  it 'should be able to expire keys and then persist them' do
+    # on a hash_key
+    @roster.contact_information['Jenny_Phone'] = '8675309'
+    @roster.contact_information.expire 30
+    @roster.contact_information.ttl.should > -1
+    @roster.contact_information.ttl.should <= 30
+    @roster.contact_information.persist
+    @roster.contact_information.ttl.should == -1
+    @roster.contact_information['Jenny_Phone'].should == '8675309'
+
+    # on a value
+    @roster.my_rank = 42
+    @roster.my_rank.expire 30
+    @roster.my_rank.ttl.should > -1
+    @roster.my_rank.ttl.should <= 30
+    @roster.my_rank.persist
+    @roster.my_rank.ttl.should == -1
+    @roster.my_rank.to_i.should == 42
+  end
+
   it "should be marshalling hash keys" do
     @roster.contact_information['updated_at'] = Time.now
     @roster.contact_information['updated_at'].class.should == Time

data/spec/spec_helper.rb

@@ -5,6 +5,9 @@ require 'redis'
 $LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
 require 'bacon'
 Bacon.summary_at_exit
+if $0 =~ /\brspec$/
+  raise "\n===\nThese tests are in bacon, not rspec.  Try: bacon #{ARGV * ' '}\n===\n"
+end
 
 UNIONSTORE_KEY = 'test:unionstore'
 INTERSTORE_KEY = 'test:interstore'

metadata

@@ -1,59 +1,56 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: redis-objects
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.5.3
   prerelease: 
-  version: 0.5.2
 platform: ruby
-authors: 
+authors:
 - Nate Wiger
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-20 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bacon
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2165783560 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: redis-namespace
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2165783560
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: &2165782960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: redis
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2165782960
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &2165782480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.1.1
   type: :runtime
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *2165782480
 description: Map Redis types directly to Ruby objects. Works with any class or ORM.
 email: nate@wiger.org
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
-files: 
+files:
 - ATOMICITY.rdoc
 - CHANGELOG.rdoc
 - README.rdoc
@@ -85,25 +82,23 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/nateware/redis-objects
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-requirements: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
 - redis, v2.1.1 or greater
 rubyforge_project: 
 rubygems_version: 1.8.10
@@ -111,4 +106,3 @@ signing_key:
 specification_version: 3
 summary: Map Redis types directly to Ruby objects
 test_files: []
-