redis_backed_model 0.0.4 → 0.0.5

data/lib/redis_backed_model/redis_backed_model.rb

@@ -1,6 +1,15 @@
 module RedisBackedModel
   class RedisBackedModel
 
+    def self.find(*args)
+      found = []
+      args.flatten.each do |id|
+        attributes = $redis.hgetall("#{self.to_s.underscore}:#{id}")
+        found << self.new(attributes.merge({'id' => id})) if attributes.size > 0
+      end
+      (found.count == 1) ? found.first : found
+    end
+
     def initialize(attributes={})
       if attributes.class == Hash
         attributes.each do |key, value|

data/lib/redis_backed_model/version.rb

@@ -1,3 +1,3 @@
 module RedisBackedModel
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/redis_backed_model_spec.rb

@@ -3,7 +3,7 @@ require 'extras/person'
 
 describe RedisBackedModel do
   before(:all) do
-    
+    class InheritingFromRedisBackedModel < RedisBackedModel::RedisBackedModel; end
   end
   
   before(:each) do
@@ -19,18 +19,18 @@ describe RedisBackedModel do
   end
   
   it "has no instance variables unless specified" do 
-    rbm = RedisBackedModel::RedisBackedModel.new
+    rbm = InheritingFromRedisBackedModel.new
     rbm.instance_variables.count.should eq(0)
   end
   
   it "creates an instance variable for a hash with one member" do
     attributes = {'id' => 1}
-    rbm = RedisBackedModel::RedisBackedModel.new(attributes)
+    rbm = InheritingFromRedisBackedModel.new(attributes)
     rbm.instance_variables.include?(:@id).should eq(true)
   end
 
   it "creates an instance variable for each member of an attribute hash that doesn't have scores" do
-    rbm = RedisBackedModel::RedisBackedModel.new(@attributes_with_id)
+    rbm = InheritingFromRedisBackedModel.new(@attributes_with_id)
     rbm.instance_variables.count.should eq(@size)
     @attributes_with_id.each do | key, value|
       # rbm.instance_variables.include?("@#{key}".to_sym).should eq(true), "no instance variable for #{key}"
@@ -39,8 +39,8 @@ describe RedisBackedModel do
   end
   
   it "raises an argument error if something other than a hash is passed in" do 
-    expect { RedisBackedModel::RedisBackedModel.new('w') }.to raise_error(ArgumentError)
-    expect { RedisBackedModel::RedisBackedModel.new(['w', 1]) }.to raise_error(ArgumentError)
+    expect { InheritingFromRedisBackedModel.new('w') }.to raise_error(ArgumentError)
+    expect { InheritingFromRedisBackedModel.new(['w', 1]) }.to raise_error(ArgumentError)
   end
   
   context "initializing with the attribute hash contains a score_[|] key" do 
@@ -49,12 +49,12 @@ describe RedisBackedModel do
       @attributes_with_id[@score_key]  = '[1|2]'
     end
     it "does not create a key for any score_[|] attribute" do 
-      rbm = RedisBackedModel::RedisBackedModel.new(@attributes_with_id)
+      rbm = InheritingFromRedisBackedModel.new(@attributes_with_id)
       rbm.instance_variables.include?(@score_key.instance_variableize).should eq(false)
     end
   
     it "creates a scores instance variable if there are any score_[x|y] attributes" do
-      rbm = RedisBackedModel::RedisBackedModel.new(@attributes_with_id)
+      rbm = InheritingFromRedisBackedModel.new(@attributes_with_id)
       rbm.instance_variables.include?('scores'.instance_variableize).should eq(true)    
     end
   end
@@ -63,7 +63,7 @@ describe RedisBackedModel do
     ['score_[foo|bar]', 'score_[baz|qux]', 'score_[wibble|wobble]'].each_with_index do |score,index|
       @attributes_with_id[score]  = "[#{index}|#{index + 1}]"
     end
-    rbm = RedisBackedModel::RedisBackedModel.new(@attributes_with_id)
+    rbm = InheritingFromRedisBackedModel.new(@attributes_with_id)
     rbm.send(:scores).each do |score|
       score.class.should eq(RedisBackedModel::SortedSet)
     end
@@ -72,28 +72,28 @@ describe RedisBackedModel do
   it "does not add near matches to scores instance variable, so it tries to add it as an instance variable instead, raising a name error because of []" do
     ['score_[foobar]', 'score[foo|bar]', 'score_[foobar|]'].each_with_index do |s,i|
       @attributes_with_id[s] = '[i|i+1]'
-      expect { rbm = RedisBackedModel::RedisBackedModel.new(@attributes_with_id) }.to raise_error(NameError)
+      expect { rbm = InheritingFromRedisBackedModel.new(@attributes_with_id) }.to raise_error(NameError)
     end
   end
     
   it "returns a redis command to add the model id to a set named (model_name)_ids" do 
-    rbm = RedisBackedModel::RedisBackedModel.new(@attributes_with_id)
-    rbm.send(:id_set_command).should eq('sadd|redis_backed_model_ids|1')    
+    rbm = InheritingFromRedisBackedModel.new(@attributes_with_id)
+    rbm.send(:id_set_command).should eq("sadd|#{rbm.class.to_s.underscore}_ids|1")    
   end
   
   context "creating an hset command for an instance variable" do
     before(:each) do 
-      @rbm = RedisBackedModel::RedisBackedModel.new()
+      @rbm = InheritingFromRedisBackedModel.new()
       @rbm.instance_variable_set('@id', 1)    
       @rbm.instance_variable_set('@foo', 20)      
     end
     it "creates a hset command for instance variables" do 
-      @rbm.send(:instance_variable_to_redis, '@foo').should eq('hset|redis_backed_model:1|foo|20')
+      @rbm.send(:instance_variable_to_redis, '@foo').should eq("hset|#{@rbm.class.to_s.underscore}:1|foo|20")
     end
 
     it "puts a underscored version of the model name as the first part of the hset key name in instance_variable_set" do 
       hset_command = @rbm.send(:instance_variable_to_redis, '@foo')
-      hset_command.split('|')[1].split(':')[0].should eq(RedisBackedModel.to_s.underscore)
+      hset_command.split('|')[1].split(':')[0].should eq(InheritingFromRedisBackedModel.to_s.underscore)
     end
 
     it "puts the id as the second part of the hset hset key name in instance_variable_set" do 
@@ -120,13 +120,13 @@ describe RedisBackedModel do
   
   it "includes as sadd command in to_redis" do
     @attributes_with_id['score_[foo|bar]']  = '[1|2012-03-04]'
-    rbm = RedisBackedModel::RedisBackedModel.new(@attributes_with_id)
+    rbm = InheritingFromRedisBackedModel.new(@attributes_with_id)
     rbm.to_redis.select { |command| command.match(/sadd/)}.count.should eq(1)
   end
   
   it "includes a hset command for each instance variable except scores in to_redis" do
     @attributes_with_id['score_[foo|bar]']  = '[1|2012-03-04]'
-    rbm = RedisBackedModel::RedisBackedModel.new(@attributes_with_id)
+    rbm = InheritingFromRedisBackedModel.new(@attributes_with_id)
     expected = rbm.instance_variables.count - 1
     rbm.to_redis.select {|command| command.match(/hset/)}.count.should eq(expected)
   end
@@ -136,22 +136,59 @@ describe RedisBackedModel do
     scores.each_with_index do |score,index|
       @attributes_with_id[score]  = "[#{index}|#{index + 1}]"
     end
-    rbm = RedisBackedModel::RedisBackedModel.new(@attributes_with_id)
+    rbm = InheritingFromRedisBackedModel.new(@attributes_with_id)
     rbm.to_redis.select { |command| command.match(/zadd/) }.count.should eq(scores.count)
   end
   
   it "should not error if there are no scores" do
-    rbm = RedisBackedModel::RedisBackedModel.new(@attributes_with_id)
+    rbm = InheritingFromRedisBackedModel.new(@attributes_with_id)
     rbm.to_redis.select { |command| command.include?('score')}.count.should eq(0)
   end
 
   it "should convert symbol attributes to strings" do
     attributes = {:id => 1, :first_name => 'jane', :last_name => 'doe'}
-    rbm = RedisBackedModel::RedisBackedModel.new(attributes)
+    rbm = InheritingFromRedisBackedModel.new(attributes)
     rbm.instance_variables.include?(:@id).should eq(true)
     rbm.instance_variable_get(:@id).should eq(1)
   end
 
+  context "class method 'find'" do 
+    before(:each) do 
+      $redis.hset('inheriting_from_redis_backed_model:0', 'foo', 'bar')
+      $redis.hset('inheriting_from_redis_backed_model:1', 'wibble', 'wobble')
+    end
+    it "should return an array if objects found for ids" do 
+      found = InheritingFromRedisBackedModel.find([0, 1])
+      found.should be_instance_of(Array)
+      found.count.should eq(2)
+    end
+    it "should have objects in the array" do
+      found = InheritingFromRedisBackedModel.find([0, 1])
+      found.each do |f|
+        f.should be_instance_of(InheritingFromRedisBackedModel)
+      end
+    end
+    it "should return an object if only one item is found" do
+      found = InheritingFromRedisBackedModel.find(0)
+      found.should be_instance_of(InheritingFromRedisBackedModel)
+      found.send(:id).should eq(0)
+    end
+    it "should return an object if only one item is found regardless of arguments" do
+      found = InheritingFromRedisBackedModel.find(0,2,3,4,5,6,7)
+      found.should be_instance_of(InheritingFromRedisBackedModel)
+      found.send(:id).should eq(0)
+    end
+    it "should return empty array if nothing found" do
+      found = InheritingFromRedisBackedModel.find(2,3,4,5,6,7)
+      found.should be_instance_of(Array)
+      found.count.should eq(0)
+    end
+    after(:each) do
+      $redis.hdel('inheriting_from_redis_backed_model:0', 'foo')
+      $redis.hdel('inheriting_from_redis_backed_model:1', 'wibble')
+    end
+  end
+
 end
 
 # test inheriting from RedisBackedModel
@@ -174,4 +211,8 @@ describe Person do
     person.name.should eq('jane doe')    
   end
   
+  after(:all) do 
+    $redis.hdel 'person:0', 'first_name'
+    $redis.hdel 'person:0', 'last_name'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_backed_model
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-04 00:00:00.000000000Z
+date: 2012-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2164484940 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164484940
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &2164484520 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +38,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164484520
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2164484100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,7 +54,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2164484100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides methods to models that are backed by a redis instance.
 email:
 - iwhitney@ssa-i.org
@@ -89,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.16
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Provides methods for the creation of redis-backed models, specifically the