redis_orm 0.6.1 → 0.6.2

data/CHANGELOG

@@ -1,3 +1,11 @@
+v0.6.2 [23-05-2011]
+* adds an ability to specify indices on *has_one* assoc
+* adds an ability to create indices on belongs_to association
+* fixed error with updating indices in :belongs_to assoc with :as option; 
+* tests refactoring, now all tests are run with Rake::TestTask, 
+* moved all classes and modules from test cases to special folders
+* fixed bug: :default values should be properly transformed to right classes (if :default values are wrong) so when comparing them to other/stored instances they'll be the same
+
 v0.6.1 [05-12-2011]
 * rewritten sortable functionality for attributes which values are strings
 * added Gemfile to the project, improved tests

data/Manifest

@@ -4,6 +4,7 @@ LICENSE
 Manifest
 README.md
 Rakefile
+TODO
 benchmarks/sortable_benchmark.rb
 lib/redis_orm.rb
 lib/redis_orm/active_model_behavior.rb
@@ -21,10 +22,41 @@ test/atomicity_test.rb
 test/basic_functionality_test.rb
 test/callbacks_test.rb
 test/changes_array_test.rb
+test/classes/album.rb
+test/classes/article.rb
+test/classes/book.rb
+test/classes/catalog_item.rb
+test/classes/category.rb
+test/classes/city.rb
+test/classes/comment.rb
+test/classes/country.rb
+test/classes/custom_user.rb
+test/classes/cutout.rb
+test/classes/cutout_aggregator.rb
+test/classes/default_user.rb
+test/classes/dynamic_finder_user.rb
+test/classes/empty_person.rb
+test/classes/giftcard.rb
+test/classes/jigsaw.rb
+test/classes/location.rb
+test/classes/message.rb
+test/classes/note.rb
+test/classes/omni_user.rb
+test/classes/person.rb
+test/classes/photo.rb
+test/classes/profile.rb
+test/classes/sortable_user.rb
+test/classes/timestamp.rb
+test/classes/user.rb
+test/classes/uuid_default_user.rb
+test/classes/uuid_timestamp.rb
+test/classes/uuid_user.rb
 test/dynamic_finders_test.rb
 test/exceptions_test.rb
 test/has_one_has_many_test.rb
 test/indices_test.rb
+test/modules/belongs_to_model_within_module.rb
+test/modules/has_many_model_within_module.rb
 test/options_test.rb
 test/polymorphic_test.rb
 test/redis.conf

data/Rakefile

@@ -1,10 +1,11 @@
-require 'psych'
 require 'rubygems'
 require 'rake'
+require 'rake/testtask'
+
 #=begin
 require 'echoe'
 
-Echoe.new('redis_orm', '0.6.1') do |p|
+Echoe.new('redis_orm', '0.6.2') do |p|
   p.description    = "ORM for Redis (advanced key-value storage) with ActiveRecord API"
   p.url            = "https://github.com/german/redis_orm"
   p.author         = "Dmitrii Samoilov"
@@ -14,20 +15,11 @@ Echoe.new('redis_orm', '0.6.1') do |p|
 end
 #=end
 
-#require 'rake/testtask'
-#$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+task :default => :test
 
-=begin
-desc 'Test the redis_orm gem.'
+desc 'Test the redis_orm functionality'
 Rake::TestTask.new(:test) do |t|
-  #t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << 'lib'
+  t.test_files = FileList['test/*_test.rb']
   t.verbose = true
 end
-=end
-
-task :test do |t|
-  Dir['test/**/*_test.rb'].each do |file|
-    puts `ruby -I./lib #{file}`
-  end
-end

data/TODO

@@ -0,0 +1,5 @@
+* add rake task to create index keys to existing records after the index was added to the column, something like *rake redis_orm:update_index_on zip*
+* add named_scopes
+* Sinatra based admin interface to overview all redis_orm keys in redis
+* ActiveRecord 3.x API
+* refactoring ;)

data/lib/redis_orm/associations/belongs_to.rb

@@ -16,6 +16,10 @@ module RedisOrm
 
         foreign_model_name = options[:as] ? options[:as].to_sym : foreign_model.to_sym
         
+        if options[:index]
+          class_variable_get(:"@@indices")[model_name] << {:name => foreign_model_name, :options => {:reference => true}}
+        end
+        
         define_method foreign_model_name do
           if options[:polymorphic]
             model_type = $redis.get("#{model_name}:#{id}:#{foreign_model_name}_type")
@@ -32,12 +36,13 @@ module RedisOrm
             end
           end
         end
-
+  
         # look = Look.create :title => 'test'
         # look.user = User.find(1) => look:23:user => 1
         define_method "#{foreign_model_name}=" do |assoc_with_record|
           # we need to store this to clear old association later
           old_assoc = self.send(foreign_model_name)
+
           # find model even if it's in some module
           full_model_scope = RedisOrm::Base.descendants.detect{|desc| desc.to_s.split('::').include?(foreign_model.to_s.camelize) }
           
@@ -53,7 +58,36 @@ module RedisOrm
               raise TypeMismatchError
             end
           end
+
+          # handle indices for references
+          self.get_indices.select{|index| index[:options][:reference]}.each do |index|
+            # delete old reference that points to the old associated record
+            if !old_assoc.nil?
+              prepared_index = [self.model_name, index[:name], old_assoc.id].join(':')
+              prepared_index.downcase! if index[:options][:case_insensitive]
+
+              if index[:options][:unique]
+                $redis.del(prepared_index, id)
+              else
+                $redis.zrem(prepared_index, id)
+              end
+            end
+            
+            # if new associated record is nil then skip to next index (since old associated record was already unreferenced)
+            next if assoc_with_record.nil?
+            
+            prepared_index = [self.model_name, index[:name], assoc_with_record.id].join(':')
+
+            prepared_index.downcase! if index[:options][:case_insensitive]
+
+            if index[:options][:unique]
+              $redis.set(prepared_index, id)
+            else
+              $redis.zadd(prepared_index, Time.now.to_f, id)
+            end
+          end
           
+          # we should have an option to delete created earlier associasion (like 'node.owner = nil')
           if assoc_with_record.nil?
             # remove old assoc            
             $redis.zrem("#{old_assoc.model_name}:#{old_assoc.id}:#{model_name.to_s.pluralize}", self.id) if old_assoc
@@ -61,7 +95,7 @@ module RedisOrm
             # check whether *assoc_with_record* object has *has_many* declaration and TODO it states *self.model_name* in plural and there is no record yet from the *assoc_with_record*'s side (in order not to provoke recursion)
             if class_associations[assoc_with_record.model_name].detect{|h| h[:type] == :has_many && h[:foreign_models] == model_name.pluralize.to_sym} && !$redis.zrank("#{assoc_with_record.model_name}:#{assoc_with_record.id}:#{model_name.pluralize}", self.id)
               # remove old assoc
-              $redis.zrem("#{old_assoc.model_name}:#{old_assoc.id}:#{model_name.to_s.pluralize}", self.id) if old_assoc   
+              $redis.zrem("#{old_assoc.model_name}:#{old_assoc.id}:#{model_name.to_s.pluralize}", self.id) if old_assoc
               assoc_with_record.send(model_name.pluralize.to_sym).send(:"<<", self)
 
             # check whether *assoc_with_record* object has *has_one* declaration and TODO it states *self.model_name* and there is no record yet from the *assoc_with_record*'s side (in order not to provoke recursion)
@@ -74,4 +108,4 @@ module RedisOrm
       end
     end
   end
-end
+end

data/lib/redis_orm/associations/has_one.rb

@@ -15,6 +15,10 @@ module RedisOrm
           foreign_model.to_sym
         end
 
+        if options[:index]
+          class_variable_get(:"@@indices")[model_name] << {:name => foreign_model_name, :options => {:reference => true}}
+        end
+        
         define_method foreign_model_name do
           foreign_model.to_s.camelize.constantize.find($redis.get "#{model_name}:#{@id}:#{foreign_model_name}")
         end     
@@ -32,6 +36,34 @@ module RedisOrm
           else
             raise TypeMismatchError
           end
+          
+          # handle indices for references
+          self.get_indices.select{|index| index[:options][:reference]}.each do |index|
+            # delete old reference that points to the old associated record
+            if !old_assoc.nil?
+              prepared_index = [self.model_name, index[:name], old_assoc.id].join(':')
+              prepared_index.downcase! if index[:options][:case_insensitive]
+
+              if index[:options][:unique]
+                $redis.del(prepared_index, id)
+              else
+                $redis.zrem(prepared_index, id)
+              end
+            end
+            
+            # if new associated record is nil then skip to next index (since old associated record was already unreferenced)
+            next if assoc_with_record.nil?
+            
+            prepared_index = [self.model_name, index[:name], assoc_with_record.id].join(':')
+
+            prepared_index.downcase! if index[:options][:case_insensitive]
+
+            if index[:options][:unique]
+              $redis.set(prepared_index, id)
+            else
+              $redis.zadd(prepared_index, Time.now.to_f, id)
+            end
+          end
 
           if !options[:as]
             if assoc_with_record.nil?

data/lib/redis_orm/redis_orm.rb

@@ -75,7 +75,7 @@ module RedisOrm
         send(:define_method, property_name) do
           value = instance_variable_get(:"@#{property_name}")
 
-          return value if value.nil? # we must return nil here so :default option will work when saving, otherwise it'll return "" or 0 or 0.0
+          return nil if value.nil? # we must return nil here so :default option will work when saving, otherwise it'll return "" or 0 or 0.0
 
           if Time == class_name
             value = begin
@@ -203,11 +203,22 @@ module RedisOrm
 
         prepared_index = if !options[:conditions].blank? && options[:conditions].is_a?(Hash)
           properties = options[:conditions].collect{|key, value| key}
+          
+          # if some condition includes object => get only the id of this object
+          conds = options[:conditions].inject({}) do |sum, item|
+            key, value = item
+            if value.respond_to?(:model_name)
+              sum.merge!({key => value.id})
+            else
+              sum.merge!({key => value})
+            end
+          end
+
           index = find_indices(properties, :first => true)
           
           raise NotIndexFound if !index
 
-          construct_prepared_index(index, options[:conditions])
+          construct_prepared_index(index, conds)
         else
           if options[:order] && options[:order].is_a?(Array)
             model_name
@@ -438,10 +449,15 @@ module RedisOrm
           instance_variable_set :"@#{prop[:name]}_changes", []
         end
       end
- 
+
+      # get all names of properties to assign only those attributes from attributes hash whose key are in prop_names 
+      # we're not using *self.respond_to?("#{key}=".to_sym)* since *belongs_to* and other assocs could create their own methods 
+      # with *key=* name, that in turn will mess up indices
+      prop_names = @@properties[model_name].collect{|m| m[:name]}
+      
       if attributes.is_a?(Hash) && !attributes.empty?        
         attributes.each do |key, value|
-          self.send("#{key}=".to_sym, value) if self.respond_to?("#{key}=".to_sym)
+          self.send("#{key}=".to_sym, value) if prop_names.include?(key.to_sym)
         end
       end
       self
@@ -554,7 +570,9 @@ module RedisOrm
               if !@@associations[model_name].empty?
                 @@associations[model_name].each do |assoc|
                   if :belongs_to == assoc[:type]
-                    if !self.send(assoc[:foreign_model]).nil?
+                    # if association has :as option use it, otherwise use standard :foreign_model
+                    foreign_model_name = assoc[:options][:as] ? assoc[:options][:as].to_sym : assoc[:foreign_model].to_sym
+                    if !self.send(foreign_model_name).nil?
                       if index[:name].is_a?(Array)
                         keys_to_delete = if index[:name].index(prop) == 0
                           $redis.keys "#{assoc[:foreign_model]}:#{self.send(assoc[:foreign_model]).id}:#{model_name.to_s.pluralize}:#{prop[:name]}#{prev_prop_value}*"
@@ -601,9 +619,29 @@ module RedisOrm
         
         if prop_value.nil? && !prop[:options][:default].nil?
           prop_value = prop[:options][:default]
+
+          # cast prop_value to proper class if they are not in it
+          # for example 'property :wage, Float, :sortable => true, :default => 20_000' turn 20_000 to 20_000.0
+          if prop[:class] != prop_value.class.to_s
+            prop_value = case prop[:class]
+                         when 'Time'
+                           begin
+                             value.to_s.to_time(:local)
+                           rescue ArgumentError => e
+                             nil
+                           end
+                         when 'Integer'
+                           prop_value.to_i
+                         when 'Float'
+                           prop_value.to_f
+                         when 'RedisOrm::Boolean'
+                           (prop_value == "false" || prop_value == false) ? false : true
+                         end
+          end
+
           # set instance variable in order to properly save indexes here
-          self.instance_variable_set(:"@#{prop[:name]}", prop[:options][:default])
-          instance_variable_set :"@#{prop[:name]}_changes", [prop[:options][:default]]
+          self.instance_variable_set(:"@#{prop[:name]}", prop_value)
+          instance_variable_set :"@#{prop[:name]}_changes", [prop_value]
         end
 
         $redis.hset("#{model_name}:#{id}", prop[:name].to_s, prop_value)
@@ -643,9 +681,9 @@ module RedisOrm
         end
       end
 
-      # save new indices in order to sort by finders
+      # save new indices (not *reference* onces (for example not these *belongs_to :note, :index => true*)) in order to sort by finders
       # city:name:Chicago => 1
-      @@indices[model_name].each do |index|
+      @@indices[model_name].reject{|index| index[:options][:reference]}.each do |index|
         prepared_index = construct_prepared_index(index) # instance method not class one!
 
         if index[:options][:unique]

data/redis_orm.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{redis_orm}
-  s.version = "0.6.1"
+  s.version = "0.6.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Dmitrii Samoilov}]
-  s.date = %q{2011-12-05}
+  s.date = %q{2012-05-23}
   s.description = %q{ORM for Redis (advanced key-value storage) with ActiveRecord API}
   s.email = %q{germaninthetown@gmail.com}
-  s.extra_rdoc_files = [%q{CHANGELOG}, %q{LICENSE}, %q{README.md}, %q{lib/redis_orm.rb}, %q{lib/redis_orm/active_model_behavior.rb}, %q{lib/redis_orm/associations/belongs_to.rb}, %q{lib/redis_orm/associations/has_many.rb}, %q{lib/redis_orm/associations/has_many_helper.rb}, %q{lib/redis_orm/associations/has_many_proxy.rb}, %q{lib/redis_orm/associations/has_one.rb}, %q{lib/redis_orm/redis_orm.rb}, %q{lib/redis_orm/utils.rb}]
-  s.files = [%q{CHANGELOG}, %q{Gemfile}, %q{LICENSE}, %q{Manifest}, %q{README.md}, %q{Rakefile}, %q{benchmarks/sortable_benchmark.rb}, %q{lib/redis_orm.rb}, %q{lib/redis_orm/active_model_behavior.rb}, %q{lib/redis_orm/associations/belongs_to.rb}, %q{lib/redis_orm/associations/has_many.rb}, %q{lib/redis_orm/associations/has_many_helper.rb}, %q{lib/redis_orm/associations/has_many_proxy.rb}, %q{lib/redis_orm/associations/has_one.rb}, %q{lib/redis_orm/redis_orm.rb}, %q{lib/redis_orm/utils.rb}, %q{redis_orm.gemspec}, %q{test/association_indices_test.rb}, %q{test/associations_test.rb}, %q{test/atomicity_test.rb}, %q{test/basic_functionality_test.rb}, %q{test/callbacks_test.rb}, %q{test/changes_array_test.rb}, %q{test/dynamic_finders_test.rb}, %q{test/exceptions_test.rb}, %q{test/has_one_has_many_test.rb}, %q{test/indices_test.rb}, %q{test/options_test.rb}, %q{test/polymorphic_test.rb}, %q{test/redis.conf}, %q{test/sortable_test.rb}, %q{test/test_helper.rb}, %q{test/uuid_as_id_test.rb}, %q{test/validations_test.rb}]
+  s.extra_rdoc_files = [%q{CHANGELOG}, %q{LICENSE}, %q{README.md}, %q{TODO}, %q{lib/redis_orm.rb}, %q{lib/redis_orm/active_model_behavior.rb}, %q{lib/redis_orm/associations/belongs_to.rb}, %q{lib/redis_orm/associations/has_many.rb}, %q{lib/redis_orm/associations/has_many_helper.rb}, %q{lib/redis_orm/associations/has_many_proxy.rb}, %q{lib/redis_orm/associations/has_one.rb}, %q{lib/redis_orm/redis_orm.rb}, %q{lib/redis_orm/utils.rb}]
+  s.files = [%q{CHANGELOG}, %q{Gemfile}, %q{LICENSE}, %q{Manifest}, %q{README.md}, %q{Rakefile}, %q{TODO}, %q{benchmarks/sortable_benchmark.rb}, %q{lib/redis_orm.rb}, %q{lib/redis_orm/active_model_behavior.rb}, %q{lib/redis_orm/associations/belongs_to.rb}, %q{lib/redis_orm/associations/has_many.rb}, %q{lib/redis_orm/associations/has_many_helper.rb}, %q{lib/redis_orm/associations/has_many_proxy.rb}, %q{lib/redis_orm/associations/has_one.rb}, %q{lib/redis_orm/redis_orm.rb}, %q{lib/redis_orm/utils.rb}, %q{redis_orm.gemspec}, %q{test/association_indices_test.rb}, %q{test/associations_test.rb}, %q{test/atomicity_test.rb}, %q{test/basic_functionality_test.rb}, %q{test/callbacks_test.rb}, %q{test/changes_array_test.rb}, %q{test/classes/album.rb}, %q{test/classes/article.rb}, %q{test/classes/book.rb}, %q{test/classes/catalog_item.rb}, %q{test/classes/category.rb}, %q{test/classes/city.rb}, %q{test/classes/comment.rb}, %q{test/classes/country.rb}, %q{test/classes/custom_user.rb}, %q{test/classes/cutout.rb}, %q{test/classes/cutout_aggregator.rb}, %q{test/classes/default_user.rb}, %q{test/classes/dynamic_finder_user.rb}, %q{test/classes/empty_person.rb}, %q{test/classes/giftcard.rb}, %q{test/classes/jigsaw.rb}, %q{test/classes/location.rb}, %q{test/classes/message.rb}, %q{test/classes/note.rb}, %q{test/classes/omni_user.rb}, %q{test/classes/person.rb}, %q{test/classes/photo.rb}, %q{test/classes/profile.rb}, %q{test/classes/sortable_user.rb}, %q{test/classes/timestamp.rb}, %q{test/classes/user.rb}, %q{test/classes/uuid_default_user.rb}, %q{test/classes/uuid_timestamp.rb}, %q{test/classes/uuid_user.rb}, %q{test/dynamic_finders_test.rb}, %q{test/exceptions_test.rb}, %q{test/has_one_has_many_test.rb}, %q{test/indices_test.rb}, %q{test/modules/belongs_to_model_within_module.rb}, %q{test/modules/has_many_model_within_module.rb}, %q{test/options_test.rb}, %q{test/polymorphic_test.rb}, %q{test/redis.conf}, %q{test/sortable_test.rb}, %q{test/test_helper.rb}, %q{test/uuid_as_id_test.rb}, %q{test/validations_test.rb}]
   s.homepage = %q{https://github.com/german/redis_orm}
   s.rdoc_options = [%q{--line-numbers}, %q{--inline-source}, %q{--title}, %q{Redis_orm}, %q{--main}, %q{README.md}]
   s.require_paths = [%q{lib}]

data/test/association_indices_test.rb

@@ -1,32 +1,5 @@
 require File.dirname(File.expand_path(__FILE__)) + '/test_helper.rb'
 
-class Article < RedisOrm::Base
-  property :title, String
-  has_many :comments
-end
-
-class Comment < RedisOrm::Base
-  property :body, String
-  
-  property :moderated, RedisOrm::Boolean, :default => false
-  index :moderated
-  
-  belongs_to :article
-end
-
-class User < RedisOrm::Base
-  property :name, String
-  index :name
-  
-  property :moderator, RedisOrm::Boolean, :default => false
-  property :moderated_area, String, :default => "messages"
-  
-  index :moderator
-  index [:moderator, :moderated_area]
-  
-  has_many :users, :as => :friends
-end
-
 describe "check indices for associations" do
   before(:each) do
     @article = Article.new :title => "DHH drops OpenID on 37signals"
@@ -142,4 +115,54 @@ describe "check indices for associations" do
     me.friends.find(:all, :conditions => {:moderated_area => "all", :moderator => true}).size.should == 1
     me.friends.find(:all, :conditions => {:moderated_area => "all", :moderator => true})[0].id.should == friend2.id
   end
-end
+  
+  # TODO check that index assoc shouldn't be created while no assoc_record is provided
+
+  it "should return first model if it exists, when conditions contain associated object" do
+    user = User.create :name => "Dmitrii Samoilov", :age => 99, :wage => 35_000, :first_name => "Dmitrii", :last_name => "Samoilov"
+    note = Note.create :body => "a test to test"
+    note2 = Note.create :body => "aero"
+    
+    note.owner = user
+    
+    User.count.should == 1
+    Note.count.should == 2
+    $redis.zcard("note:owner:1").should == 1    
+    note.owner.should == user
+    Note.find(:all, :conditions => {:owner => user}).should == [note]
+    Note.find(:first, :conditions => {:owner => user}).should == note
+    
+    note.owner = nil
+    Note.find(:all, :conditions => {:owner => user}).should == []
+    Note.find(:first, :conditions => {:owner => user}).should == nil
+    $redis.zcard("note:owner:1").should == 0
+  end
+
+  it "should return first model if it exists when conditions contain associated object (belongs_to assoc established when creating object)" do
+    user = User.create :name => "Dmitrii Samoilov", :age => 99, :wage => 35_000, :first_name => "Dmitrii", :last_name => "Samoilov"
+    note = Note.create :body => "a test to test", :owner => user
+    Note.create :body => "aero" # just test what would *find* return if 2 exemplars of Note are created
+    
+    User.count.should == 1
+    Note.count.should == 2
+
+    note.owner.should == user
+    
+    Note.find(:all, :conditions => {:owner => user}).should == [note]
+    Note.find(:first, :conditions => {:owner => user}).should == note
+  end
+  
+  it "should return first model if it exists when conditions contain associated object (has_one assoc established when creating object)" do
+    profile = Profile.create :title => "a test to test", :name => "german"
+    user = User.create :name => "Dmitrii Samoilov", :age => 99, :wage => 35_000, :first_name => "Dmitrii", :last_name => "Samoilov", :profile => profile
+    User.create :name => "Warren Buffet", :age => 399, :wage => 12_235_000, :first_name => "Warren", :last_name => "Buffet"
+    
+    User.count.should == 2
+    Profile.count.should == 1
+
+    profile.user.should == user
+    
+    User.find(:all, :conditions => {:profile => profile}).should == [user]
+    User.find(:first, :conditions => {:profile => profile}).should == user
+  end
+end

data/test/associations_test.rb

@@ -1,64 +1,5 @@
 require File.dirname(File.expand_path(__FILE__)) + '/test_helper.rb'
 
-class Article < RedisOrm::Base
-  property :title, String
-  has_many :comments
-  has_many :categories
-end
-
-class Comment < RedisOrm::Base
-  property :body, String
-    
-  belongs_to :article
-  has_many :comments, :as => :replies
-  belongs_to :comment, :as => :reply_to
-end
-
-module BelongsToModelWithinModule
-  class Reply < RedisOrm::Base
-    property :body, String, :default => "test"
-    belongs_to :article, :as => :essay
-  end
-end
-
-module HasManyModelWithinModule
-  class SpecialComment < RedisOrm::Base
-    property :body, String, :default => "test"
-    belongs_to :brochure, :as => :book
-  end
-
-  class Brochure < RedisOrm::Base
-    property :title, String
-    has_many :special_comments
-  end
-end
-
-class Profile < RedisOrm::Base
-  property :title, String
-  has_one :city
-end
-
-class City < RedisOrm::Base
-  property :name, String
-  has_many :profiles
-end
-
-class Category < RedisOrm::Base
-  property :name, String
-  has_many :articles
-end
-
-class User < RedisOrm::Base
-  property :name, String
-  index :name  
-  has_many :users, :as => :friends
-end
-
-class Message < RedisOrm::Base
-  property :text, String
-  has_one :message, :as => :replay_to
-end
-
 describe "check associations" do
   before(:each) do
     @article = Article.new :title => "DHH drops OpenID on 37signals"