redis_storage 0.2.6 → 0.2.7

data/README

@@ -4,6 +4,7 @@ RedisStorage
 This is a little gem which provides a redis interface for models. It works out of the box with rails or can be used standalone.
 
 Basically I just got sick rewriting the same logic over and over again for each model of my little sinatra apps so this evolved. Then I wanted to write a new rails app an thought having this in a gem would be really nice, and a generator would be awesome.
+Now I will add new Feature as I need them. You also can let me know what to add.
 
 Features
 ---
@@ -13,20 +14,21 @@ Features
 * compatible with the default rails controller
 * uses ActiveModel to provide things like validations
 * provides a Rails 3 Generator
+* indexing of choosen attributes and find_by
 
 Roadmap aka. ToDo
 ---
 
+* perhaps use some stuff from redis-scripting to make more methods atomic (like find_by or update_attributes)
 * some wrappers for searching in a model(probably will need some indexes)
-* add something to make it easy to add an index(but there will be the update problematic)
 * perhaps some kind of dirty flag - or the ActiveModel::Dirty module, but that will make some things way more complicated
 * more tests/specs are always good
 
 Newest Stuff
 ---
 
-* the generator now calls the test_framework generator for models
-* added a random method which returns a random item from the collection
+* indexing for choosen attributes
+* new find_by :attr
 
 Installation
 ---
@@ -77,6 +79,22 @@ Minimal Example
       attr_accessor *attrs
     end
 
+Indexing and find_by
+---
+
+If you want or need to find records based on a attribute you have to add it to the index_for array like this.
+
+    def self.index_for
+      [:some, :attributes, :to, :index]
+    end
+
+The elements should be symbols and have to also be element of attrs.
+After that you can use the following to get the the instance.
+
+    MyModel.find_by :key, "search"
+
+Also I should mention that you should update record only via the update_attributes method, otherwise the indexes will become corrupt.
+
 Rails 3 Integration
 ---
 

data/lib/redis_storage.rb

@@ -19,6 +19,9 @@ module RedisStorage
     attr_accessor :id
     attr_reader :errors
 
+    def self.index_for
+      []
+    end
     def self.build(params)
       new params
     end
@@ -31,25 +34,27 @@ module RedisStorage
 
     def self.random
       i = $db.srandmember(persisted_key)
-      find_by_id(i) unless i.nil?
+      load(i) unless i.nil?
     end
     def self.find(params=nil)
       if params.nil?
         all
       else
-        find_by_id(params)   #TODO perhaps make this at some point more generic
+        load(params)   #TODO perhaps make this at some point more generic
       end
     end
-    def self.find_by_id(entry_id)
-      return nil if entry_id.nil?
-      r = $db.get("#{db_key}:#{entry_id}")
-      new(JSON.parse(r)) unless r.nil?
+    def self.find_by(key, value)
+      if key == :id
+        load "#{db_key}:#{value}"
+      elsif index_for.include? key
+        load($db.get("#{db_key}:#{key}:#{value.hash}"))
+      else
+        nil
+      end
     end
 
     def self.all
-      keys = $db.smembers(persisted_key).map do |i|
-        "#{db_key}:#{i}"
-      end
+      keys = $db.smembers(persisted_key)
 
       if keys.empty?
         []
@@ -64,10 +69,10 @@ module RedisStorage
       $db.scard(persisted_key)
     end
     def self.first
-      find_by_id $db.smembers(persisted_key).sort.first
+      load $db.smembers(persisted_key).sort.first
     end
     def self.last
-      find_by_id $db.smembers(persisted_key).sort.last
+      load $db.smembers(persisted_key).sort.last
     end
     def serializable_hash
       self.class.attrs.inject({:id => @id}) do |a,key|
@@ -80,19 +85,23 @@ module RedisStorage
     end
 
     def update_attributes(params)
+      delete!
       params.each do |key, value|
         send("#{key}=", value) unless key.to_sym == :id
       end
       save
     end
     def save
-      unless persisted?
+      if @id.nil?
         @id = $db.incr(self.class.next_id_key)
       end
       if valid?
         $db.multi do
           $db.set db_key, to_json
-          $db.sadd self.class.persisted_key, id
+          $db.sadd self.class.persisted_key, db_key
+          for key in self.class.index_for do
+            $db.set "#{self.class.db_key}:#{key}:#{send(key).hash}", db_key
+          end
         end
         @id
       else
@@ -107,7 +116,10 @@ module RedisStorage
       if persisted?
         $db.multi do
           $db.del db_key
-          $db.srem self.class.persisted_key, id
+          $db.srem self.class.persisted_key, db_key
+          for key in self.class.index_for do
+            $db.del "#{self.class.db_key}:#{key}:#{send(key).hash}"
+          end
         end
         true
       else
@@ -119,7 +131,7 @@ module RedisStorage
       if id.nil?
         false
       else
-        $db.sismember(self.class.persisted_key, id)
+        $db.sismember(self.class.persisted_key, db_key)
       end
     end
 
@@ -141,6 +153,11 @@ module RedisStorage
       end
     end
     private
+    def self.load(key)
+      return nil if key.nil?
+      r = $db.get(key)
+      new(JSON.parse(r)) unless r.nil?
+    end
     def self.next_id_key
       "#{db_key}:next_id"
     end

data/lib/redis_storage/version.rb

@@ -1,3 +1,3 @@
 module RedisStorage
-  VERSION = "0.2.6"
+  VERSION = "0.2.7"
 end

data/spec/model_spec.rb

@@ -4,6 +4,9 @@ class MockModel < RedisStorage::Model
     [:body, :title]
   end
   attr_accessor *attrs
+  def self.index_for
+    [:title]
+  end
 end
 
 describe RedisStorage::Model do
@@ -57,19 +60,42 @@ describe RedisStorage::Model do
         MockModel.expects(:all)
         MockModel.find
       end
-      it 'should push the given Params from .find to .find_by_id' do
-        MockModel.expects(:find_by_id).with(3)
+      it 'should push the given params from .find to .load' do
+        MockModel.expects(:load).with(3)
         MockModel.find(3)
       end
-      context '#find_by_id' do
+      context '#find_by' do
+        it "should call load if called find_by :id" do
+          MockModel.expects(:load)
+          MockModel.find_by(:id,3)
+        end
         1.upto(4) do |i|
-          it "should find record #{i} and create a new instance" do
-            record = MockModel.find_by_id(i)
+          it "should find record #{i} by id, load it and create a new instance" do
+            record = MockModel.find_by :id, i
             record.id.should == i
             record.body.should == h[i-1]['body']
             record.title.should == h[i-1]['title']
           end
         end
+        it 'should find instances based on their title' do
+          model = MockModel.find_by :title, "second test"
+          model.title.should eq("second test")
+          model.body.should eq("Dolor Sit")
+        end
+        it 'should still find by title after updating the title' do
+          m = MockModel.first
+          m.update_attributes({'title' => "f**k that title"})
+          n = MockModel.find_by :title, "f**k that title"
+          n.title.should == "f**k that title"
+          n.id.should == m.id
+        end
+        it 'should no longer find by the old title after updating the title' do
+          m = MockModel.first
+          t = m.title
+          m.update_attributes({'title' => "f**k that title"})
+          n = MockModel.find_by :title, t
+          n.should be_nil
+        end
       end
       context '#all' do
         it 'should return an empty array if there are no entries' do
@@ -136,7 +162,7 @@ describe RedisStorage::Model do
       end
       it 'should add the id to the persisted set in redis' do
         id = model.save
-        $db.sismember("MockModel:persisted", id).should be_true
+        $db.sismember("MockModel:persisted", "MockModel:#{id}").should be_true
       end
     end
     context '#update_attributes' do
@@ -166,7 +192,7 @@ describe RedisStorage::Model do
       it 'should remove the id from the persisted set in redis' do
         id=model.save
         model.delete!
-        $db.sismember("MockModel:persisted", id).should be_false
+        $db.sismember("MockModel:persisted", "MockModel:#{id}").should be_false
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_storage
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-27 00:00:00.000000000 +02:00
+date: 2011-06-30 00:00:00.000000000 +02:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &193730080 !ruby/object:Gem::Requirement
+  requirement: &13617920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 2.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *193730080
+  version_requirements: *13617920
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &193729660 !ruby/object:Gem::Requirement
+  requirement: &13655520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *193729660
+  version_requirements: *13655520
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &193729120 !ruby/object:Gem::Requirement
+  requirement: &13654980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *193729120
+  version_requirements: *13654980
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &193728620 !ruby/object:Gem::Requirement
+  requirement: &13654480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *193728620
+  version_requirements: *13654480
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &193728160 !ruby/object:Gem::Requirement
+  requirement: &13654020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: 0.9.10
   type: :development
   prerelease: false
-  version_requirements: *193728160
+  version_requirements: *13654020
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &193727700 !ruby/object:Gem::Requirement
+  requirement: &13653560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,7 +77,7 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *193727700
+  version_requirements: *13653560
 description: Provides a data backend for a Redis in Rails, will also provide a Rails
   3 Generator
 email: