redis-objects 0.2.4 → 0.3.0

data/CHANGELOG.rdoc

@@ -0,0 +1,37 @@
+= Changelog for Redis::Objects
+
+== 0.3.0 [Final] (14 April 2010)
+
+* Due to Ruby 1.9 bugs and performance considerations, marshaling of
+data types is now OFF by default.  You must say :marshal => true for
+any objects that you want serialization enabled on. [Nate Wiger]
+
+* Sorted Set class changed slightly due to feedback. You can now get
+an individual element back via @set['item'] since it acts like a Hash.
+
+== 0.2.4 [Final] (9 April 2010)*
+
+* Added sorted set support via Redis::SortedSet [Nate Wiger]
+
+== 0.2.3 [Final] (18 February 2010)*
+
+* Added lock expiration to Redis::Lock [Ben VandenBos]
+
+* Fixed some bugs [Ben VandenBos]
+
+* Added lock tests and test helpers [Ben VandenBos]
+
+== 0.2.2 [Final] (14 December 2009)*
+
+* Added @set.diff(@set2) with "^" and "-" synonyms (oversight). [Nate Wiger]
+
+* Implemented Redis core commands in all data types, such as rename. [Nate Wiger]
+
+* Renamed Redis::Serialize to Redis::Helpers::Serialize to keep Redis:: cleaner. [Nate Wiger]
+
+* More spec coverage. [Nate Wiger]
+
+== 0.2.1 [Final] (27 November 2009)*
+
+* First worthwhile public release, with good spec coverage and functionality. [Nate Wiger]
+

data/README.rdoc

@@ -12,7 +12,7 @@ to Ruby objects, via a thin layer over Ezra's +redis+ gem.  It offers several ad
 over the lower-level redis-rb API:
 
 1. Easy to integrate directly with existing ORMs - ActiveRecord, DataMapper, etc.  Add counters to your model!
-2. Complex data structures are automatically Marshaled
+2. Complex data structures are automatically Marshaled (if you set :marshal => true)
 3. Integers are returned as integers, rather than '17'
 4. Higher-level types are provided, such as Locks, that wrap multiple calls
 
@@ -171,10 +171,10 @@ Simple values are easy as well:
     @value.value = 'a'
     @value.delete
 
-Of course complex data is no problem:
+Complex data is no problem with :marshal => true:
 
     @account = Account.create!(params[:account])
-    @newest  = Redis::Value.new('newest_account')
+    @newest  = Redis::Value.new('newest_account', :marshal => true)
     @newest.value = @account.attributes
     puts @newest.value['username']
 
@@ -198,16 +198,15 @@ Lists work just like Ruby arrays:
     @list.clear
     # etc
 
-Complex data types are no problem:
+Complex data types are no problem with :marshal => true:
 
+    @list = Redis::List.new('list_name', :marshal => true)
     @list << {:name => "Nate", :city => "San Diego"}
     @list << {:name => "Peter", :city => "Oceanside"}
     @list.each do |el|
       puts "#{el[:name]} lives in #{el[:city]}"
     end
     
-This gem will automatically marshal complex data, similar to how session stores work.
-
 === Sets
 
 Sets work like the Ruby {Set}[http://ruby-doc.org/core/classes/Set.html] class:
@@ -248,8 +247,10 @@ Or store them in Redis:
     @set1.diffstore('diffname', @set2, @set3)
     members = @set1.redis.get('diffname')
 
-And use complex data types too:
+And use complex data types too, with :marshal => true:
 
+    @set1 = Redis::Set.new('set1', :marshal => true)
+    @set2 = Redis::Set.new('set2', :marshal => true)
     @set1 << {:name => "Nate", :city => "San Diego"}
     @set1 << {:name => "Peter", :city => "Oceanside"}
     @set2 << {:name => "Nate", :city => "San Diego"}
@@ -269,15 +270,20 @@ a Hash and an Array.  You assign like a Hash, but retrieve like an Array:
     @sorted_set['Nate']  = 15
     @sorted_set['Peter'] = 75
     @sorted_set['Jeff']  = 24
-    
-    # atomic increment
-    @sorted_set.increment('Nate')
-    @sorted_set.incr('Peter')   # shorthand
-    @sorted_set.incr('Jeff', 4)
 
-    @sorted_set[0,2]            # => ["Nate", "Jeff", "Peter"]
+    # Array access to get sorted order
+    @sorted_set[0..2]           # => ["Nate", "Jeff", "Peter"]
+    @sorted_set[0,2]            # => ["Nate", "Jeff"]
+
+    @sorted_set['Peter']        # => 75
+    @sorted_set['Jeff']         # => 24
+    @sorted_set.score('Jeff')   # same thing (24)
+
+    @sorted_set.rank('Peter')   # => 2
+    @sorted_set.rank('Jeff')    # => 1
+
     @sorted_set.first           # => "Nate"
-    @sorted_set.last            # => "Nate"
+    @sorted_set.last            # => "Peter"
     @sorted_set.revrange(0,2)   # => ["Peter", "Jeff", "Nate"]
 
     @sorted_set['Newbie'] = 1
@@ -286,7 +292,12 @@ a Hash and an Array.  You assign like a Hash, but retrieve like an Array:
     @sorted_set.rangebyscore(10, 100, :limit => 2)   # => ["Nate", "Jeff"]
     @sorted_set.members(:withscores => true)         # => [["Newbie", 1], ["Nate", 16], ["Jeff", 28], ["Peter", 76]]
 
-The other Redis Sorted Set commands are supported as well; see {SortedSets API}[http://code.google.com/p/redis/wiki/SortedSets].
+    # atomic increment
+    @sorted_set.increment('Nate')
+    @sorted_set.incr('Peter')   # shorthand
+    @sorted_set.incr('Jeff', 4)
+
+The other Redis Sorted Set commands are supported as well; see {Sorted Sets API}[http://code.google.com/p/redis/wiki/SortedSets].
 
 == Atomic Counters and Locks
 

data/lib/redis/helpers/serialize.rb

@@ -4,6 +4,7 @@ class Redis
       include Marshal
 
       def to_redis(value)
+        return value unless options[:marshal]
         case value
         when String, Fixnum, Bignum, Float
           value
@@ -13,6 +14,7 @@ class Redis
       end
     
       def from_redis(value)
+        return value unless options[:marshal]
         case value
         when Array
           value.collect{|v| from_redis(v)}

data/lib/redis/list.rb

@@ -62,7 +62,7 @@ class Redis
         at(index)
       end
     end
-    
+
     # Delete the element(s) from the list that match name. If count is specified,
     # only the first-N (if positive) or last-N (if negative) will be removed.
     # Use .del to completely delete the entire key.

data/lib/redis/sorted_set.rb

@@ -42,7 +42,7 @@ class Redis
       elsif length
         range(index, length)
       else
-        at(index)
+        score(index)
       end
     end
 

data/spec/redis_objects_instance_spec.rb

@@ -27,15 +27,24 @@ describe Redis::Value do
   end
 
   it "should handle complex marshaled values" do
+    @value.options[:marshal] = true
     @value.should == nil
     @value.value = {:json => 'data'}
     @value.should == {:json => 'data'}
-    @value.get.should == {:json => 'data'}
+    
+    # no marshaling
+    @value.options[:marshal] = false
+    v = {:json => 'data'}
+    @value.value = v
+    @value.should == v.to_s
+
+    @value.options[:marshal] = true
     @value.value = [[1,2], {:t3 => 4}]
     @value.should == [[1,2], {:t3 => 4}]
     @value.get.should == [[1,2], {:t3 => 4}]
     @value.del.should be_true
     @value.should be_nil
+    @value.options[:marshal] = false
   end
 
   it "should support renaming values" do
@@ -106,6 +115,7 @@ describe Redis::List do
     @list << 'j'
     @list.should == ['a','c','f','j']
     @list[0..2].should == ['a','c','f']
+    @list[0, 2].should == ['a','c','f']  # consistent with Redis, not Ruby
     @list[1, 3].should == ['c','f','j']
     @list.length.should == 4
     @list.size.should == 4
@@ -138,13 +148,17 @@ describe Redis::List do
   end
 
   it "should handle lists of complex data types" do
-    @list << {:json => 'data'}
-    @list << {:json2 => 'data2'}
-    @list.first.should == {:json => 'data'}
-    @list.last.should == {:json2 => 'data2'}
+    @list.options[:marshal] = true
+    v1 = {:json => 'data'}
+    v2 = {:json2 => 'data2'}
+    @list << v1
+    @list << v2
+    @list.first.should == v1
+    @list.last.should == v2
     @list << [1,2,3,[4,5]]
     @list.last.should == [1,2,3,[4,5]]
     @list.shift.should == {:json => 'data'}
+    @list.options[:marshal] = false
   end
   
   it "should support renaming lists" do
@@ -442,15 +456,20 @@ describe Redis::SortedSet do
     @set['a'] = 21
     @set.add('a', 5)
     @set.score('a').should == 5
+    @set['a'].should == 5
     @set['a'] = 3
     @set['b'] = 5
+    @set['b'].should == 5
     @set['c'] = 4
 
     @set[0,-1].should == ['a','c','b']
+    @set[0..2].should == ['a','c','b']
+    @set[0,2].should == ['a','c','b']   # consistent with Redis, not Ruby
+    @set.range(0,1,:withscores => true).should == [['a',3],['c',4]]
     @set.range(0,-1).should == ['a','c','b']
     @set.revrange(0,-1).should == ['b','c','a']
     @set[0..1].should == ['a','c']
-    @set[1].should == 'c'
+    @set[1].should == 0  # missing
     @set.at(1).should == 'c'
     @set.first.should == 'a'
     @set.last.should == 'b'

data/spec/redis_objects_model_spec.rb

@@ -10,9 +10,9 @@ class Roster
   counter :pitchers, :limit => :max_pitchers
   counter :basic
   lock :resort, :timeout => 2
-  value :starting_pitcher
-  list :player_stats
-  set :outfielders
+  value :starting_pitcher, :marshal => true
+  list :player_stats, :marshal => true
+  set :outfielders, :marshal => true
 
   # global class counters
   counter :total_players_online, :global => true

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 4
-  version: 0.2.4
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Nate Wiger
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-09 00:00:00 -07:00
+date: 2010-04-14 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -39,7 +39,7 @@ extensions: []
 
 extra_rdoc_files: 
 - ATOMICITY.rdoc
-- ChangeLog
+- CHANGELOG.rdoc
 - README.rdoc
 files: 
 - lib/redis/counter.rb
@@ -61,7 +61,7 @@ files:
 - spec/redis_objects_model_spec.rb
 - spec/spec_helper.rb
 - ATOMICITY.rdoc
-- ChangeLog
+- CHANGELOG.rdoc
 - README.rdoc
 has_rdoc: true
 homepage: http://github.com/nateware/redis-objects

data/ChangeLog

@@ -1,23 +0,0 @@
-
-*0.2.3 [Final] (18 February 2010)*
-
-* Added lock expiration to Redis::Lock [Ben VandenBos]
-
-* Fixed some bugs [Ben VandenBos]
-
-* Added lock tests and test helpers [Ben VandenBos]
-
-*0.2.2 [Final] (14 December 2009)*
-
-* Added @set.diff(@set2) with "^" and "-" synonyms (oversight). [Nate Wiger]
-
-* Implemented Redis core commands in all data types, such as rename. [Nate Wiger]
-
-* Renamed Redis::Serialize to Redis::Helpers::Serialize to keep Redis:: cleaner. [Nate Wiger]
-
-* More spec coverage. [Nate Wiger]
-
-*0.2.1 [Final] (27 November 2009)*
-
-* First worthwhile public release, with good spec coverage and functionality. [Nate Wiger]
-