redis-objects 0.4.1 → 0.5.1

data/redis-objects.gemspec

@@ -1,76 +1,70 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{redis-objects}
-  s.version = "0.4.1"
+  s.version = "0.5.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nate Wiger"]
-  s.date = %q{2010-08-23}
+  s.date = %q{2011-05-23}
   s.description = %q{Map Redis types directly to Ruby objects. Works with any class or ORM.}
   s.email = %q{nate@wiger.org}
   s.extra_rdoc_files = [
     "README.rdoc"
   ]
   s.files = [
-    ".gitignore",
-     "ATOMICITY.rdoc",
-     "CHANGELOG.rdoc",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "lib/redis/base_object.rb",
-     "lib/redis/counter.rb",
-     "lib/redis/hash.rb",
-     "lib/redis/helpers/core_commands.rb",
-     "lib/redis/helpers/serialize.rb",
-     "lib/redis/list.rb",
-     "lib/redis/lock.rb",
-     "lib/redis/objects.rb",
-     "lib/redis/objects/counters.rb",
-     "lib/redis/objects/hashes.rb",
-     "lib/redis/objects/lists.rb",
-     "lib/redis/objects/locks.rb",
-     "lib/redis/objects/sets.rb",
-     "lib/redis/objects/sorted_sets.rb",
-     "lib/redis/objects/values.rb",
-     "lib/redis/set.rb",
-     "lib/redis/sorted_set.rb",
-     "lib/redis/value.rb",
-     "redis-objects.gemspec",
-     "spec/redis_objects_instance_spec.rb",
-     "spec/redis_objects_model_spec.rb",
-     "spec/spec_helper.rb"
+    "ATOMICITY.rdoc",
+    "CHANGELOG.rdoc",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/redis/base_object.rb",
+    "lib/redis/counter.rb",
+    "lib/redis/hash_key.rb",
+    "lib/redis/helpers/core_commands.rb",
+    "lib/redis/helpers/serialize.rb",
+    "lib/redis/list.rb",
+    "lib/redis/lock.rb",
+    "lib/redis/objects.rb",
+    "lib/redis/objects/counters.rb",
+    "lib/redis/objects/hashes.rb",
+    "lib/redis/objects/lists.rb",
+    "lib/redis/objects/locks.rb",
+    "lib/redis/objects/sets.rb",
+    "lib/redis/objects/sorted_sets.rb",
+    "lib/redis/objects/values.rb",
+    "lib/redis/set.rb",
+    "lib/redis/sorted_set.rb",
+    "lib/redis/value.rb",
+    "redis-objects.gemspec",
+    "spec/redis_namespace_compat_spec.rb",
+    "spec/redis_objects_active_record_spec.rb",
+    "spec/redis_objects_instance_spec.rb",
+    "spec/redis_objects_model_spec.rb",
+    "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/nateware/redis-objects}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.requirements = ["redis, v2.0.4 or greater"]
-  s.rubygems_version = %q{1.3.7}
+  s.requirements = ["redis, v2.1.1 or greater"]
+  s.rubygems_version = %q{1.7.2}
   s.summary = %q{Map Redis types directly to Ruby objects}
-  s.test_files = [
-    "spec/redis_objects_instance_spec.rb",
-     "spec/redis_objects_model_spec.rb",
-     "spec/spec_helper.rb"
-  ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<bacon>, [">= 0"])
-      s.add_runtime_dependency(%q<redis>, [">= 2.0.4"])
+      s.add_runtime_dependency(%q<redis>, [">= 2.1.1"])
     else
       s.add_dependency(%q<bacon>, [">= 0"])
-      s.add_dependency(%q<redis>, [">= 2.0.4"])
+      s.add_dependency(%q<redis>, [">= 2.1.1"])
     end
   else
     s.add_dependency(%q<bacon>, [">= 0"])
-    s.add_dependency(%q<redis>, [">= 2.0.4"])
+    s.add_dependency(%q<redis>, [">= 2.1.1"])
   end
 end
 

data/spec/redis_namespace_compat_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'redis/objects'
+Redis::Objects.redis = $redis
+
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../../redis-namespace/lib')
+begin
+  require 'redis/namespace'
+
+  describe 'Redis::Namespace compat' do
+    it "tests the compatibility of Hash and ::Hash conflicts" do
+      ns = Redis::Namespace.new("resque", :redis => $redis)
+      ns.instance_eval { rem_namespace({"resque:x" => nil}) }.should == {"x"=>nil}
+      class Foo
+        include Redis::Objects
+      end
+      ns.instance_eval { rem_namespace({"resque:x" => nil}) }.should == {"x"=>nil}
+    end
+  end
+
+rescue LoadError
+  # Redis::Namespace not installed
+  puts "Skipping Redis::Namespace tests as redis-namespace is not installed"
+end

data/spec/redis_objects_active_record_spec.rb

@@ -0,0 +1,105 @@
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'redis/objects'
+Redis::Objects.redis = $redis
+
+begin
+  require 'active_record'
+  ActiveRecord::Base.establish_connection(
+    :adapter => 'sqlite3',
+    :database => File.expand_path(File.dirname(__FILE__) + '/redis_objects_test.sqlite3')
+  )
+
+  class CreateBlogs < ActiveRecord::Migration
+    def self.up
+      create_table :blogs do |t|
+        t.string :name
+        t.integer :posts_count, :default => 0
+        t.timestamps
+      end
+    end
+
+    def self.down
+      drop_table :blogs
+    end
+  end
+
+  class Blog < ActiveRecord::Base
+    include Redis::Objects
+    has_many :posts
+  end
+
+  class CreatePosts < ActiveRecord::Migration
+    def self.up
+      create_table :posts do |t|
+        t.string :title
+        t.string :description, :length => 200
+        t.integer :total
+        t.integer :blog_id
+        t.timestamps
+      end
+    end
+
+    def self.down
+      drop_table :posts
+    end
+  end
+
+  class Post < ActiveRecord::Base
+    include Redis::Objects
+    counter :total
+    belongs_to :blog, :counter_cache => true
+  end
+
+
+  describe Redis::Objects do
+    before do
+      CreatePosts.up
+      CreateBlogs.up
+    end
+    after do
+      CreatePosts.down
+      CreateBlogs.down
+    end
+
+    it "exercises ActiveRecord in more detail" do
+      @ar = Post.new
+      @ar.save!
+      @ar.destroy
+
+      # @ar.total.reset
+      @ar2 = Post.new
+      @ar2.save!
+      @ar2.total.reset
+      @ar2.total.increment.should == 1
+      @ar2.id.should == 2
+      @ar2.increment(:total).should == 2
+      @ar2[:total].should == nil  # DB column
+      @ar2.redis.get(@ar2.redis_field_key('total')).to_i.should == 2
+      @ar2[:total] = 3  # DB column
+      @ar2.total.decrement.should == 1
+      @ar2.total.reset
+      @ar2.total.should == 0
+      @ar2.destroy
+    end
+
+    it "falls back to ActiveRecord if redis counter is not defined" do
+      blog = Blog.create
+      blog.reload.posts_count.should == 0
+      post = Post.create :blog => blog
+      blog.reload.posts_count.should == 1
+      blog2 = Blog.create
+      Post.create :blog => blog2
+      Post.create :blog => blog2
+      blog.reload.posts_count.should == 1
+      blog2.reload.posts_count.should == 2
+      blog.posts_count.should == 1
+    end
+  end
+
+
+rescue LoadError
+  # ActiveRecord not install
+  puts "Skipping ActiveRecord tests as active_record is not installed"
+end

data/spec/redis_objects_instance_spec.rb

@@ -7,7 +7,7 @@ require 'redis/value'
 require 'redis/lock'
 require 'redis/set'
 require 'redis/sorted_set'
-require 'redis/hash'
+require 'redis/hash_key'
 
 describe Redis::Value do
   before do
@@ -20,7 +20,7 @@ describe Redis::Value do
     @value.value = 'Trevor Hoffman'
     @value.should == 'Trevor Hoffman'
     @value.get.should == 'Trevor Hoffman'
-    @value.del.should.be.true
+    @value.del.should == 1
     @value.should.be.nil
   end
 
@@ -40,7 +40,7 @@ describe Redis::Value do
     @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.del.should == 1
     @value.should.be.nil
     @value.options[:marshal] = false
   end
@@ -197,6 +197,9 @@ describe Redis::List do
       @list << [1,2,3,[4,5]]
       @list.last.should == [1,2,3,[4,5]]
       @list.shift.should == {:json => 'data'}
+      @list.size.should == 2
+      @list.delete(v2)
+      @list.size.should == 1
       @list.options[:marshal] = false
     end
     
@@ -356,12 +359,83 @@ describe Redis::Lock do
 end
 
 
-describe Redis::Hash do
+describe Redis::HashKey do
+  describe "With Marshal" do
+    before do
+      @hash = Redis::HashKey.new('test_hash', $redis,
+                                {:marshal_keys=>{'created_at'=>true}})
+      @hash.clear
+    end
+
+    it "should marshal specified keys" do
+      @hash['created_at'] = Time.now
+      @hash['created_at'].class.should == Time
+    end
+
+    it "should not marshal unless required" do
+      @hash['updated_at'] = Time.now
+      @hash['updated_at'].class.should == String
+    end
+
+    it "should marshall appropriate key with bulk set and get" do
+      @hash.bulk_set({'created_at'=>Time.now, 'updated_at'=>Time.now})
+
+      @hash['created_at'].class.should == Time
+      @hash['updated_at'].class.should == String
+
+      h = @hash.bulk_get('created_at', 'updated_at')
+      h['created_at'].class.should == Time
+      h['updated_at'].class.should == String
+
+      h = @hash.all
+      h['created_at'].class.should == Time
+      h['updated_at'].class.should == String
+    end
+  end
+
   before do
-    @hash  = Redis::Hash.new('test_hash')
+    @hash  = Redis::HashKey.new('test_hash')
     @hash.clear
   end
   
+  it "should handle complex marshaled values" do
+    @hash.options[:marshal] = true
+    @hash['abc'].should == nil
+    @hash['abc'] = {:json => 'data'}
+    @hash['abc'].should == {:json => 'data'}
+    
+    # no marshaling
+    @hash.options[:marshal] = false
+    v = {:json => 'data'}
+    @hash['abc'] = v
+    @hash['abc'].should == v.to_s
+
+    @hash.options[:marshal] = true
+    @hash['abc'] = [[1,2], {:t3 => 4}]
+    @hash['abc'].should == [[1,2], {:t3 => 4}]
+    @hash.fetch('abc').should == [[1,2], {:t3 => 4}]
+    @hash.delete('abc').should == 1
+    @hash.fetch('abc').should.be.nil
+    
+    @hash.options[:marshal] = true
+    @hash.bulk_set('abc' => [[1,2], {:t3 => 4}], 'def' => [[6,8], {:t4 => 8}])
+    hsh = @hash.bulk_get('abc', 'def', 'foo')
+    hsh['abc'].should == [[1,2], {:t3 => 4}]
+    hsh['def'].should == [[6,8], {:t4 => 8}]
+    hsh['foo'].should.be.nil
+    
+    hsh = @hash.all
+    hsh['abc'].should == [[1,2], {:t3 => 4}]
+    hsh['def'].should == [[6,8], {:t4 => 8}]
+    
+    @hash.values.should == [[[1,2], {:t3 => 4}], [[6,8], {:t4 => 8}]]
+    
+    @hash.delete('def').should == 1
+    @hash.delete('abc').should == 1
+    
+    @hash.options[:marshal] = false
+  end
+  
   it "should get and set values" do
     @hash['foo'] = 'bar'
     @hash['foo'].should == 'bar'
@@ -406,7 +480,7 @@ describe Redis::Hash do
   end
 
   it "should respond to empty?" do
-    @empty = Redis::Hash.new('test_empty_hash')
+    @empty = Redis::HashKey.new('test_empty_hash')
     @empty.respond_to?(:empty?).should == true
   end
 
@@ -560,11 +634,40 @@ describe Redis::Set do
     @set.redis.del('spec/set2')
   end
 
+  it "should support sorting" do
+    @set_1 << 'a' << 'b' << 'c' << 'd' << 'e'
+    @set_2 << 1 << 2 << 3 << 4 << 5
+    @set_3 << 'm_1' << 'm_2'
+    @set_1.sort.should == %w(a b c d e)
+    @set_2.sort.should == %w(1 2 3 4 5)
+
+    @set_1.sort(SORT_ORDER).should == %w(e d c b a)
+    @set_3.sort(SORT_BY).should == %w(m_1 m_2)        
+    @set_2.sort(SORT_LIMIT).should == %w(3 4)
+
+    val1 = Redis::Value.new('spec/3/sorted')
+    val2 = Redis::Value.new('spec/4/sorted')
+
+    val1.set('val3')
+    val2.set('val4')
+ 
+    @set_2.sort(SORT_GET).should == ['val3', 'val4']
+    @set_2.sort(SORT_STORE).should == 2
+    @set_2.redis.type(SORT_STORE[:store]).should == 'list'
+    @set_2.redis.lrange(SORT_STORE[:store], 0, -1).should == ['val3', 'val4']
+
+    @set_1.redis.del val1.key
+    @set_1.redis.del val2.key
+    @set_1.redis.del SORT_STORE[:store]
+
+  end
+
   after do
     @set.clear
     @set_1.clear
     @set_2.clear
     @set_3.clear
+
   end
 end
 
@@ -657,6 +760,10 @@ describe Redis::SortedSet do
     @set.length.should == 4
     @set.size.should == 4
     
+    @set.range_size(100, 120).should == 0
+    @set.range_size(0, 100).should == 2
+    @set.range_size('-inf', 'inf').should == 4
+    
     @set.delete_if{|m| m == 'b'}
     @set.size.should == 3
   end

data/spec/redis_objects_model_spec.rb

@@ -9,7 +9,7 @@ class Roster
   counter :available_slots, :start => 10
   counter :pitchers, :limit => :max_pitchers
   counter :basic
-  hash_key :contact_information
+  hash_key :contact_information, :marshal_keys=>{'updated_at'=>true}
   lock :resort, :timeout => 2
   value :starting_pitcher, :marshal => true
   list :player_stats, :marshal => true
@@ -18,17 +18,19 @@ class Roster
 
   # global class counters
   counter :total_players_online, :global => true
-  list :all_player_stats, :global => true
   set :all_players_online, :global => true
   value :last_player, :global => true
   
   # custom keys
   counter :player_totals, :key => 'players/#{username}/total'
-  list :all_player_stats, :key => 'players:all_stats'
+  list :all_player_stats, :key => 'players:all_stats', :global => true
   set :total_wins, :key => 'players:#{id}:all_stats'
   value :my_rank, :key => 'players:my_rank:#{username}'
   value :weird_key, :key => 'players:weird_key:#{raise}', :global => true
 
+  #callable as key
+  counter :daily, :global => true, :key => Proc.new { |roster| "#{roster.name}:#{Time.now.strftime('%Y-%m-%dT%H')}:daily" }
+
   def initialize(id=1) @id = id end
   def id; @id; end
   def username; "user#{id}"; end
@@ -46,6 +48,21 @@ class CustomRoster < Roster
   counter :special # New
 end
 
+class MethodRoster
+  def increment(attribute, by=1)
+    42
+  end
+  
+  def initialize(id=1) @id = id end
+  def id; @id; end
+end
+
+class CustomMethodRoster < MethodRoster
+  include Redis::Objects
+  
+  attr_accessor :counter
+  counter :basic
+end
 
 describe Redis::Objects do
   before do
@@ -85,6 +102,8 @@ describe Redis::Objects do
     @roster.total_wins.clear
     @roster.my_rank.clear
 
+    @roster.daily.clear
+
     @custom_roster.basic.reset
     @custom_roster.special.reset
   end
@@ -93,7 +112,7 @@ describe Redis::Objects do
     Roster.redis.should == Redis::Objects.redis
     # Roster.redis.should.be.kind_of(Redis)
   end
-  
+
   it "should support interpolation of key names" do
     @roster.player_totals.incr
     @roster.redis.get('players/user1/total').should == '1'
@@ -108,6 +127,10 @@ describe Redis::Objects do
     @roster.redis.get('players:my_rank:user1').should == 'a'
     Roster.weird_key = 'tuka'
     Roster.redis.get('players:weird_key:#{raise}').should == 'tuka'
+
+    k = "Roster:#{Time.now.strftime('%Y-%m-%dT%H')}:daily"
+    @roster.daily.incr
+    @roster.redis.get(k).should == '1'
   end
 
   it "should be able to get/set contact info" do
@@ -119,6 +142,10 @@ describe Redis::Objects do
     @roster.contact_information.size.should == 2
   end
 
+  it "should be marshalling hash keys" do
+    @roster.contact_information['updated_at'] = Time.now
+    @roster.contact_information['updated_at'].class.should == Time
+  end
 
 
   it "should create counter accessors" do
@@ -312,7 +339,7 @@ describe Redis::Objects do
       Roster.increment_counter(:badness, 2)
     rescue => error
     end
-    error.should.be.kind_of(Redis::Objects::UndefinedCounter)
+    error.should.be.kind_of(NoMethodError)
 
     error = nil
     begin
@@ -363,7 +390,7 @@ describe Redis::Objects do
     @roster.starting_pitcher.get.should == 'Trevor Hoffman'
     @roster.starting_pitcher = 'Tom Selleck'
     @roster.starting_pitcher.should == 'Tom Selleck'
-    @roster.starting_pitcher.del.should.be.true
+    @roster.starting_pitcher.del.should == 1
     @roster.starting_pitcher.should.be.nil
   end
 
@@ -372,7 +399,7 @@ describe Redis::Objects do
     @roster.starting_pitcher = {:json => 'data'}
     @roster.starting_pitcher.should == {:json => 'data'}
     @roster.starting_pitcher.get.should == {:json => 'data'}
-    @roster.starting_pitcher.del.should.be.true
+    @roster.starting_pitcher.del.should == 1
     @roster.starting_pitcher.should.be.nil
   end
 
@@ -630,7 +657,7 @@ describe Redis::Objects do
     Roster.last_player.get.should == 'Trevor Hoffman'
     Roster.last_player = 'Tom Selleck'
     Roster.last_player.should == 'Tom Selleck'
-    Roster.last_player.del.should.be.true
+    Roster.last_player.del.should == 1
     Roster.last_player.should.be.nil
   end
 
@@ -664,7 +691,7 @@ describe Redis::Objects do
     @roster2.last_player.get.should == 'Trevor Hoffman'
     @roster2.last_player = 'Tom Selleck'
     @roster.last_player.should == 'Tom Selleck'
-    @roster.last_player.del.should.be.true
+    @roster.last_player.del.should == 1
     @roster.last_player.should.be.nil
     @roster2.last_player.should.be.nil
   end
@@ -743,9 +770,25 @@ describe Redis::Objects do
     @custom_roster.basic.increment.should == 1
     @roster2.basic.should == 0
     CustomRoster.new.basic.should == 1
+    @custom_roster.basic.decrement.should == 0
   end
 
   it "should handle new subclass objects" do
     @custom_roster.special.increment.should == 1
   end
+  
+  it "should allow passing of increment/decrement to super class" do
+    @custom_method_roster = CustomMethodRoster.new
+    @custom_method_roster.counter.should.be.nil
+
+    @custom_method_roster.increment(:counter).should == 42
+
+    @custom_method_roster.increment(:basic).should == 1
+    @custom_method_roster.basic.increment.should == 2
+    @custom_method_roster.decrement(:basic).should == 1
+    @custom_method_roster.basic.decrement.should == 0
+    @custom_method_roster.basic.reset.should.be.true
+    @custom_method_roster.basic.should == 0
+    @custom_method_roster.basic.should.be.kind_of(Redis::Counter)
+  end
 end

data/spec/spec_helper.rb

@@ -1,8 +1,8 @@
 require 'rubygems'  # poor people still on 1.8
-
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+gem 'redis', '>= 2.1.1'
 require 'redis'
 
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
 require 'bacon'
 Bacon.summary_at_exit
 
@@ -11,3 +11,12 @@ $redis = Redis.new(:host => ENV['REDIS_HOST'], :port => ENV['REDIS_PORT'])
 UNIONSTORE_KEY = 'test:unionstore'
 INTERSTORE_KEY = 'test:interstore'
 DIFFSTORE_KEY  = 'test:diffstore'
+
+
+SORT_ORDER = {:order => 'desc alpha'}
+SORT_LIMIT = {:limit => [2, 2]}
+SORT_BY = {:by => 'm_*'}
+SORT_GET = {:get => 'spec/*/sorted'}.merge!(SORT_LIMIT)
+SORT_STORE = {:store => "spec/aftersort"}.merge!(SORT_GET)
+
+