redis-objects 0.1.0

data/lib/redis/objects/sets.rb

@@ -0,0 +1,9 @@
+# This is the class loader, for use as "include Redis::Objects::Sets"
+# For the object itself, see "Redis::Set"
+require 'redis/set'
+class Redis
+  module Objects
+    module Sets
+    end
+  end
+end

data/lib/redis/objects/values.rb

@@ -0,0 +1,37 @@
+# This is the class loader, for use as "include Redis::Objects::Values"
+# For the object itself, see "Redis::Value"
+require 'redis/value'
+class Redis
+  module Objects
+    module Values
+      def self.included(klass)
+        klass.instance_variable_set('@values', {})
+        klass.send :include, InstanceMethods
+        klass.extend ClassMethods
+      end
+
+      # Class methods that appear in your class when you include Redis::Objects.
+      module ClassMethods
+        attr_reader :values
+        
+        # Define a new simple value.  It will function like a regular instance
+        # method, so it can be used alongside ActiveRecord, DataMapper, etc.
+        def value(name, options={})
+          @values[name] = options
+          class_eval <<-EndMethods
+            def #{name}
+              @#{name} ||= Redis::Value.new(field_key(:#{name}), self.class.values[:#{name}].merge(:redis => redis))
+            end
+            def #{name}=(value)
+              #{name}.value = value
+            end
+          EndMethods
+        end
+      end
+      
+      # Instance methods that appear in your class when you include Redis::Objects.
+      module InstanceMethods
+      end
+    end
+  end
+end

data/lib/redis/set.rb

@@ -0,0 +1,7 @@
+class Redis
+  #
+  # Class representing a set.
+  #
+  class Set
+  end
+end

data/lib/redis/value.rb

@@ -0,0 +1,39 @@
+class Redis
+  #
+  # Class representing a simple value.  You can use standard Ruby operations on it.
+  #
+  class Value
+    attr_reader :key, :options, :redis
+    def initialize(key, options={})
+      @key = key
+      @options = options
+      @redis   = options[:redis] || $redis || Redis::Objects.redis
+      @redis.setnx(key, @options[:default]) if @options[:default]
+    end
+
+    def value
+      @value ||= get
+    end
+
+    def value=(val)
+      redis.set(key, val)
+      @value = val
+    end
+    
+    def get
+      @value = redis.get(key)
+    end
+    
+    def delete
+      redis.del(key)
+      @value = nil
+    end
+    alias_method :del, :delete
+
+    def to_s;  value.to_s; end
+    alias_method :to_str, :to_s
+
+    def ==(x); value == x; end
+    def nil?;  value.nil?; end
+  end
+end

data/spec/redis_objects_model_spec.rb

@@ -0,0 +1,278 @@
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class Roster
+  include Redis::Objects
+  counter :available_slots, :start => 10
+  counter :pitchers, :limit => :max_pitchers
+  counter :basic
+  counter :all_players_online, :global => true
+  lock :resort, :timeout => 2
+  value :starting_pitcher
+  list :player_stats
+
+  def initialize(id=1) @id = id end
+  def id; @id; end
+  def max_pitchers; 3; end
+end
+
+describe Redis::Objects do
+  before :all do
+    @roster  = Roster.new
+    @roster2 = Roster.new
+  end
+  
+  before :each do
+    @roster.available_slots.reset
+    @roster.pitchers.reset
+    @roster.basic.reset
+    @roster.resort_lock.clear
+    @roster.starting_pitcher.delete
+    @roster.player_stats.clear
+  end
+
+  it "should provide a connection method" do
+    Roster.redis.should == Redis::Objects.redis
+    Roster.redis.should be_kind_of(Redis)
+  end
+
+  it "should create counter accessors" do
+    [:available_slots, :pitchers, :basic].each do |m|
+       @roster.respond_to?(m).should == true
+     end
+  end
+  
+  it "should support increment/decrement of counters" do
+    @roster.available_slots.key.should == 'roster:1:available_slots'
+    @roster.available_slots.should == 10
+    
+    # math proxy ops
+    (@roster.available_slots == 10).should be_true
+    (@roster.available_slots <= 10).should be_true
+    (@roster.available_slots < 11).should be_true
+    (@roster.available_slots > 9).should be_true
+    (@roster.available_slots >= 10).should be_true
+    "#{@roster.available_slots}".should == "10"
+
+    @roster.available_slots.increment.should == 11
+    @roster.available_slots.increment.should == 12
+    @roster2.available_slots.increment.should == 13
+    @roster2.available_slots.increment(2).should == 15
+    @roster.available_slots.decrement.should == 14
+    @roster2.available_slots.decrement.should == 13
+    @roster.available_slots.decrement.should == 12
+    @roster2.available_slots.decrement(4).should == 8
+    @roster.available_slots.should == 12
+    @roster.available_slots.get.should == 8
+    @roster.available_slots.reset.should == 10
+    @roster.available_slots.should == 10
+    @roster.available_slots.reset(15).should == 15
+    @roster.available_slots.should == 15
+    @roster.pitchers.increment.should == 1
+    @roster.basic.increment.should == 1
+    @roster2.basic.decrement.should == 0
+    @roster.basic.get.should == 0
+  end
+  
+  it "should support class-level increment/decrement of counters" do
+    Roster.get_counter(:available_slots, @roster.id).should == 10
+    Roster.increment_counter(:available_slots, @roster.id).should == 11
+    Roster.increment_counter(:available_slots, @roster.id, 3).should == 14
+    Roster.decrement_counter(:available_slots, @roster.id, 2).should == 12
+    Roster.decrement_counter(:available_slots, @roster.id).should == 11
+    Roster.reset_counter(:available_slots, @roster.id).should == true
+    Roster.get_counter(:available_slots, @roster.id).should == 10
+  end
+
+  it "should take an atomic block for increment/decrement" do
+    a = false
+    @roster.available_slots.should == 10
+    @roster.available_slots.decr do |cnt|
+      if cnt >= 0
+        a = true
+      end
+    end
+    @roster.available_slots.should == 9
+    a.should be_true
+    
+    @roster.available_slots.should == 9
+    @roster.available_slots.decr do |cnt|
+      @roster.available_slots.should == 8
+      false
+    end
+    @roster.available_slots.should == 8
+    
+    @roster.available_slots.should == 8
+    @roster.available_slots.decr do |cnt|
+      @roster.available_slots.should == 7
+      nil  # should rewind
+    end
+    @roster.available_slots.should == 8
+    
+    @roster.available_slots.should == 8
+    @roster.available_slots.incr do |cnt|
+      if 1 == 2  # should rewind
+        true
+      end
+    end
+    @roster.available_slots.should == 8
+
+    @roster.available_slots.should == 8
+    @roster.available_slots.incr do |cnt|
+      @roster.available_slots.should == 9
+      []
+    end
+    @roster.available_slots.should == 9
+
+    @roster.available_slots.should == 9
+    begin
+      @roster.available_slots.decr do |cnt|
+        @roster.available_slots.should == 8
+        raise 'oops'
+      end
+    rescue
+    end
+    @roster.available_slots.should == 9
+    
+    # check return value from the block
+    value =
+      @roster.available_slots.decr do |cnt|
+        @roster.available_slots.should == 8
+        42
+      end
+    value.should == 42
+    @roster.available_slots.should == 8
+  end
+
+  it "should take an atomic block for increment/decrement class methods" do
+    a = false
+    Roster.get_counter(:available_slots, @roster.id).should == 10
+    Roster.decrement_counter(:available_slots, @roster.id) do |cnt|
+      if cnt >= 0
+        a = true
+      end
+    end
+    Roster.get_counter(:available_slots, @roster.id).should == 9
+    a.should be_true
+
+    Roster.get_counter(:available_slots, @roster.id).should == 9
+    Roster.decrement_counter(:available_slots, @roster.id) do |cnt|
+      Roster.get_counter(:available_slots, @roster.id).should == 8
+      false
+    end
+    Roster.get_counter(:available_slots, @roster.id).should == 8
+
+    Roster.get_counter(:available_slots, @roster.id).should == 8
+    Roster.decrement_counter(:available_slots, @roster.id) do |cnt|
+      Roster.get_counter(:available_slots, @roster.id).should == 7
+      nil  # should rewind
+    end
+    Roster.get_counter(:available_slots, @roster.id).should == 8
+
+    Roster.get_counter(:available_slots, @roster.id).should == 8
+    Roster.increment_counter(:available_slots, @roster.id) do |cnt|
+      if 1 == 2  # should rewind
+        true
+      end
+    end
+    Roster.get_counter(:available_slots, @roster.id).should == 8
+
+    Roster.get_counter(:available_slots, @roster.id).should == 8
+    Roster.increment_counter(:available_slots, @roster.id) do |cnt|
+      Roster.get_counter(:available_slots, @roster.id).should == 9
+      []
+    end
+    Roster.get_counter(:available_slots, @roster.id).should == 9
+
+    Roster.get_counter(:available_slots, @roster.id).should == 9
+    begin
+      Roster.decrement_counter(:available_slots, @roster.id) do |cnt|
+        Roster.get_counter(:available_slots, @roster.id).should == 8
+        raise 'oops'
+      end
+    rescue
+    end
+    Roster.get_counter(:available_slots, @roster.id).should == 9
+
+    # check return value from the block
+    value =
+      Roster.decrement_counter(:available_slots, @roster.id) do |cnt|
+        Roster.get_counter(:available_slots, @roster.id).should == 8
+        42
+      end
+    value.should == 42
+    Roster.get_counter(:available_slots, @roster.id).should == 8
+  end
+
+  it "should properly throw errors on bad counters" do
+    error = nil
+    begin
+      Roster.increment_counter(:badness, 2)
+    rescue => error
+    end
+    error.should be_kind_of(Redis::Objects::UndefinedCounter)
+
+    error = nil
+    begin
+      Roster.obtain_lock(:badness, 2){}
+    rescue => error
+    end
+    error.should be_kind_of(Redis::Objects::UndefinedLock)
+
+    error = nil
+    begin
+      @roster.available_slots = 42
+    rescue => error
+    end
+    error.should be_kind_of(NoMethodError)
+
+    error = nil
+    begin
+      @roster.available_slots += 69
+    rescue => error
+    end
+    error.should be_kind_of(NoMethodError)
+
+    error = nil
+    begin
+      @roster.available_slots -= 15
+    rescue => error
+    end
+    error.should be_kind_of(NoMethodError)
+  end
+  
+  it "should handle simple values" do
+    @roster.starting_pitcher.should == nil
+    @roster.starting_pitcher = 'Trevor Hoffman'
+    @roster.starting_pitcher.should == 'Trevor Hoffman'
+    @roster.starting_pitcher.get.should == 'Trevor Hoffman'
+    @roster.starting_pitcher.del
+    @roster.starting_pitcher.should be_nil
+  end
+
+  it "should handle lists of simple values" do
+    @roster.player_stats.should be_empty
+    @roster.player_stats << 'a'
+    @roster.player_stats.should == ['a']
+  end
+
+  it "should provide a lock method that accepts a block" do
+    @roster.resort_lock.key.should == 'roster:1:resort_lock'
+    a = false
+    @roster.resort_lock.lock do
+      a = true
+    end
+    a.should be_true
+  end
+  
+  xit "should raise an exception if the timeout is exceeded" do
+    @roster.redis.set(@roster.resort_lock.key, 1)
+    error = nil
+    begin
+      @roster.resort_lock.lock {}
+    rescue => error
+    end
+    error.should_not be_nil
+    error.should be_kind_of(Redis::Lock::LockTimeout)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+require 'redis'
+require 'redis/objects'
+
+Redis::Objects.redis = Redis.new(:host => ENV['REDIS_HOST'], :port => ENV['REDIS_PORT'])

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: redis-objects
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Nate Wiger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-24 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Redis::Objects is a lightweight library that lets you use Redis primitives as Ruby objects from any class or ORM
+email: nate@wiger.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- ATOMICITY.rdoc
+- README.rdoc
+files: 
+- lib/redis/counter.rb
+- lib/redis/data_types.rb
+- lib/redis/list.rb
+- lib/redis/lock.rb
+- lib/redis/objects/core.rb
+- lib/redis/objects/counters.rb
+- lib/redis/objects/lists.rb
+- lib/redis/objects/locks.rb
+- lib/redis/objects/sets.rb
+- lib/redis/objects/values.rb
+- lib/redis/objects.rb
+- lib/redis/set.rb
+- lib/redis/value.rb
+- spec/redis_objects_model_spec.rb
+- spec/spec_helper.rb
+- ATOMICITY.rdoc
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/nateware/redis-objects
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- Redis::Objects -- Use Redis types as Ruby objects
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: redis-objects
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Lightweight map of Redis types to Ruby objects
+test_files: []
+