redis_orm 0.1

data/redis_orm.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{redis_orm}
+  s.version = "0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dmitrii Samoilov"]
+  s.date = %q{2011-06-02}
+  s.description = %q{ORM for Redis advanced key-value storage}
+  s.email = %q{germaninthetown@gmail.com}
+  s.extra_rdoc_files = ["LICENSE", "README.md", "lib/redis_orm.rb", "lib/redis_orm/active_model_behavior.rb", "lib/redis_orm/associations/belongs_to.rb", "lib/redis_orm/associations/has_many.rb", "lib/redis_orm/associations/has_many_proxy.rb", "lib/redis_orm/associations/has_one.rb", "lib/redis_orm/redis_orm.rb"]
+  s.files = ["LICENSE", "Manifest", "README.md", "Rakefile", "lib/redis_orm.rb", "lib/redis_orm/active_model_behavior.rb", "lib/redis_orm/associations/belongs_to.rb", "lib/redis_orm/associations/has_many.rb", "lib/redis_orm/associations/has_many_proxy.rb", "lib/redis_orm/associations/has_one.rb", "lib/redis_orm/redis_orm.rb", "redis_orm.gemspec", "test/associations_test.rb", "test/basic_functionality_test.rb", "test/callbacks_test.rb", "test/changes_array_test.rb", "test/dynamic_finders_test.rb", "test/exceptions_test.rb", "test/has_one_has_many_test.rb", "test/indices_test.rb", "test/options_test.rb", "test/redis.conf", "test/validations_test.rb"]
+  s.homepage = %q{https://github.com/german/redis_orm}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Redis_orm", "--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{redis_orm}
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{ORM for Redis advanced key-value storage}
+  s.test_files = ["test/options_test.rb", "test/dynamic_finders_test.rb", "test/associations_test.rb", "test/validations_test.rb", "test/exceptions_test.rb", "test/has_one_has_many_test.rb", "test/indices_test.rb", "test/changes_array_test.rb", "test/callbacks_test.rb", "test/basic_functionality_test.rb"]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_runtime_dependency(%q<activemodel>, [">= 3.0.0"])
+      s.add_runtime_dependency(%q<redis>, [">= 2.2.0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.5.0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_dependency(%q<activemodel>, [">= 3.0.0"])
+      s.add_dependency(%q<redis>, [">= 2.2.0"])
+      s.add_dependency(%q<rspec>, [">= 2.5.0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+    s.add_dependency(%q<activemodel>, [">= 3.0.0"])
+    s.add_dependency(%q<redis>, [">= 2.2.0"])
+    s.add_dependency(%q<rspec>, [">= 2.5.0"])
+  end
+end

data/test/associations_test.rb

@@ -0,0 +1,226 @@
+require 'rspec'
+require File.dirname(File.expand_path(__FILE__)) + '/../lib/redis_orm.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
+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
+
+describe "check associations" do
+  before(:all) do
+    path_to_conf = File.dirname(File.expand_path(__FILE__)) + "/redis.conf"
+    $redis_pid = spawn 'redis-server ' + path_to_conf, :out => "/dev/null"
+    sleep(0.3) # must be some delay otherwise "Connection refused - Unable to connect to Redis"
+    path_to_socket = File.dirname(File.expand_path(__FILE__)) + "/../redis.sock"
+    $redis = Redis.new(:host => 'localhost', :path => path_to_socket)
+  end
+  
+  before(:each) do
+    $redis.flushall if $redis
+    @article = Article.new
+    @article.title = "DHH drops OpenID on 37signals"
+    @article.save
+
+    @article.should be
+    @article.title.should == "DHH drops OpenID on 37signals"
+
+    @comment1 = Comment.new
+    @comment1.body = "test"
+    @comment1.save
+    @comment1.should be
+    @comment1.body.should == "test"
+
+    @comment2 = Comment.new
+    @comment2.body = "test #2"
+    @comment2.save
+    @comment2.should be
+    @comment2.body.should == "test #2"
+  end
+
+  after(:each) do
+   $redis.flushall if $redis
+  end
+
+  after(:all) do    
+    Process.kill 9, $redis_pid.to_i if $redis_pid
+  end
+
+  it "should return array" do
+    @article.comments << [@comment1, @comment2]
+    #@article.comments.should be_kind_of(Array)
+
+    @article.comments.count.should == 2    
+    @article.comments.size.should == 2
+
+    @comment1.article.should be
+    @comment2.article.should be
+
+    @comment1.article.id.should == @comment2.article.id
+  end
+
+  it "should return 1 comment when second was deleted" do
+    Comment.count.should == 2
+    @article.comments << [@comment1, @comment2]
+    #@article.comments.should be_kind_of(Array)
+    @article.comments.size.should == 2
+    
+    @comment1.destroy
+
+    @article.comments.size.should == 1
+    @article.comments.count.should == 1
+    Comment.count.should == 1
+  end
+
+  it "should leave associations when parent has been deleted (nullify assocs)" do
+    Comment.count.should == 2
+    @article.comments << [@comment1, @comment2]
+    @comment1.article.id.should == @article.id
+    @comment2.article.id.should == @article.id
+    #@article.comments.should be_kind_of(Array)
+    @article.comments.size.should == 2
+    @article.comments.count.should == 2
+    
+    @article.destroy
+
+    Article.count.should == 0
+
+    Comment.count.should == 2
+  end
+
+  it "should replace associations when '=' is used instead of '<<' " do
+    Comment.count.should == 2
+    @article.comments << [@comment1, @comment2]
+    @comment1.article.id.should == @article.id
+    @comment2.article.id.should == @article.id
+    @article.comments.size.should == 2
+    @article.comments.count.should == 2
+    
+    @article.comments = [@comment1]
+    @article.comments.count.should == 1
+    @article.comments.first.id.should == @comment1.id
+
+    @comment1.article.id.should == @article.id
+  end
+
+  it "should correctly use many-to-many associations both with '=' and '<<' " do
+    @cat1 = Category.create :name => "Nature"
+    @cat2 = Category.create :name => "Art"
+    @cat3 = Category.create :name => "Web"
+
+    @cat1.name.should == "Nature"
+    @cat2.name.should == "Art"
+    @cat3.name.should == "Web"
+
+    @article.categories << [@cat1, @cat2]
+
+    @cat1.articles.count.should == 1
+    @cat1.articles[0].id.should == @article.id
+    @cat2.articles.count.should == 1
+    @cat2.articles[0].id.should == @article.id
+
+    @article.categories.size.should == 2
+    @article.categories.count.should == 2
+    
+    @article.categories = [@cat1, @cat3]
+    @article.categories.count.should == 2
+    @article.categories.map{|c| c.id}.include?(@cat1.id).should be
+    @article.categories.map{|c| c.id}.include?(@cat3.id).should be
+
+    @cat1.articles.count.should == 1
+    @cat1.articles[0].id.should == @article.id
+
+    @cat3.articles.count.should == 1
+    @cat3.articles[0].id.should == @article.id
+
+    @cat2.articles.count.should == 0
+
+    @cat1.destroy
+    Category.count.should == 2
+    @article.categories.count.should == 1
+  end
+
+  it "should remove old associations and create new ones" do
+    profile = Profile.new
+    profile.title = "test"
+    profile.save
+
+    chicago = City.new
+    chicago.name = "Chicago"
+    chicago.save
+    
+    washington = City.new
+    washington.name = "Washington"
+    washington.save
+
+    profile.city = chicago
+    profile.city.name.should == "Chicago"
+    chicago.profiles.count.should == 1
+    washington.profiles.count.should == 0
+    chicago.profiles[0].id.should == profile.id
+
+    profile.city = washington
+    profile.city.name.should == "Washington"
+    chicago.profiles.count.should == 0
+    washington.profiles.count.should == 1
+    washington.profiles[0].id.should == profile.id
+  end
+
+  it "should maintain correct self referencing link" do
+    me = User.create :name => "german"
+    friend1 = User.create :name => "friend1"
+    friend2 = User.create :name => "friend2"
+
+    me.friends << [friend1, friend2]
+
+    me.friends.count.should == 2
+    friend1.friends.count.should == 0
+    friend2.friends.count.should == 0
+  end
+
+  it "should delete one specific record from an array with associated records" do
+    me = User.create :name => "german"
+    friend1 = User.create :name => "friend1"
+    friend2 = User.create :name => "friend2"
+
+    me.friends << [friend1, friend2]
+
+    me = User.find_by_name 'german'
+    me.friends.count.should == 2
+    friend1 = User.find_by_name 'friend1'
+    friend1.friends.count.should == 0
+    friend2 = User.find_by_name 'friend2'
+    friend2.friends.count.should == 0
+
+    me.friends.delete(friend1.id)
+    me.friends.count.should == 1
+    me.friends[0].id == friend2.id
+    User.count.should == 3
+  end
+end

data/test/basic_functionality_test.rb

@@ -0,0 +1,166 @@
+require 'rspec'
+require File.dirname(File.expand_path(__FILE__)) + '/../lib/redis_orm.rb'
+
+class User < RedisOrm::Base
+  property :name, String
+  property :age, Integer
+  property :wage, Float
+  property :male, RedisOrm::Boolean
+
+  property :created_at, Time
+  property :modified_at, Time
+end
+
+class DefaultUser < RedisOrm::Base
+  property :name, String, :default => "german"
+  property :age, Integer, :default => 26
+  property :wage, Float, :default => 256.25
+  property :male, RedisOrm::Boolean, :default => true
+
+  property :created_at, Time
+  property :modified_at, Time
+end
+
+describe "check basic functionality" do
+  before(:all) do
+    path_to_conf = File.dirname(File.expand_path(__FILE__)) + "/redis.conf"
+    $redis_pid = spawn 'redis-server ' + path_to_conf, :out => "/dev/null"
+    sleep(0.3) # must be some delay otherwise "Connection refused - Unable to connect to Redis"
+    path_to_socket = File.dirname(File.expand_path(__FILE__)) + "/../redis.sock"
+    $redis = Redis.new(:host => 'localhost', :path => path_to_socket)
+  end
+  
+  before(:each) do
+    $redis.flushall if $redis
+  end
+
+  after(:each) do
+   $redis.flushall if $redis
+  end
+
+  after(:all) do
+    Process.kill 9, $redis_pid.to_i if $redis_pid
+  end
+
+  it "test_simple_creation" do
+    User.count.should == 0
+
+    user = User.new :name => "german"
+    user.save
+
+    user.should be
+
+    user.name.should == "german"
+
+    User.count.should == 1
+    User.first.name.should == "german"
+  end
+
+  it "should test different ways to update a record" do
+    User.count.should == 0
+
+    user = User.new :name => "german"
+    user.should be
+    user.save
+
+    user.name.should == "german"
+
+    user.name = "nobody"
+    user.save
+
+    User.count.should == 1
+    User.first.name.should == "nobody"
+
+    u = User.first
+    u.should be
+    u.update_attribute :name, "root"
+    User.first.name.should == "root"
+
+    u = User.first
+    u.should be
+    u.update_attributes :name => "german"
+    User.first.name.should == "german"
+  end
+
+  it "test_deletion" do
+    User.count.should == 0
+
+    user = User.new :name => "german"
+    user.save
+    user.should be
+
+    user.name.should == "german"
+
+    User.count.should == 1
+
+    user.destroy
+    User.count.should == 0
+  end
+
+  it "should return first and last objects" do
+    User.count.should == 0
+    User.first.should == nil
+    User.last.should == nil
+
+    user1 = User.new :name => "german"
+    user1.save
+    user1.should be
+    user1.name.should == "german"
+
+    user2 = User.new :name => "nobody"
+    user2.save
+    user2.should be
+    user2.name.should == "nobody"
+
+    User.count.should == 2
+
+    User.first.should be
+    User.last.should be
+
+    User.first.id.should == user1.id
+    User.last.id.should  == user2.id
+  end
+
+  it "should return values with correct classes" do
+    user = User.new
+    user.name = "german"
+    user.age = 26
+    user.wage = 124.34
+    user.male = true
+    user.save
+
+    user.should be
+
+    u = User.first
+
+    u.created_at.class.should == Time
+    u.modified_at.class.should == Time
+    u.wage.class.should == Float
+    u.male.class.to_s.should match(/TrueClass|FalseClass/)
+    u.age.class.to_s.should match(/Integer|Fixnum/)
+
+    u.name.should == "german"
+    u.wage.should == 124.34
+    u.age.should  == 26
+    u.male.should == true
+  end
+
+  it "should return correct saved defaults" do
+    DefaultUser.count.should == 0
+    DefaultUser.create
+    DefaultUser.count.should == 1
+
+    u = DefaultUser.first
+
+    u.created_at.class.should == Time
+    u.modified_at.class.should == Time
+    u.wage.class.should == Float
+    u.male.class.to_s.should match(/TrueClass|FalseClass/)
+    u.age.class.to_s.should match(/Integer|Fixnum/)
+
+    u.name.should == "german"
+    u.male.should == true
+    u.age.should  == 26
+    u.wage.should == 256.25
+  end
+end

data/test/callbacks_test.rb

@@ -0,0 +1,140 @@
+require 'rspec'
+require File.dirname(File.expand_path(__FILE__)) + '/../lib/redis_orm.rb'
+
+class CutoutAggregator < RedisOrm::Base
+  property :modified_at, Time
+
+  property :revision, Integer, :default => 0
+end
+
+class Cutout < RedisOrm::Base
+  property :filename, String
+
+  before_create :increase_revisions
+  before_destroy :decrease_revisions
+
+  def increase_revisions
+    ca = CutoutAggregator.last
+    ca.update_attribute(:revision, ca.revision + 1) if ca
+  end
+
+  def decrease_revisions
+    ca = CutoutAggregator.first
+    if ca.revision > 0
+      ca.update_attribute :revision, ca.revision - 1
+    end
+
+    ca.destroy if ca.revision == 0
+  end
+end
+
+class Comment < RedisOrm::Base
+  property :text, String
+
+  belongs_to :user
+
+  before_save :trim_whitespaces
+  after_save :regenerate_karma
+
+  def trim_whitespaces
+    self.text = self.text.strip
+  end
+
+  def regenerate_karma
+    if self.user
+      self.user.update_attribute :karma, (self.user.karma - self.text.length)
+    end
+  end
+end
+
+class User < RedisOrm::Base
+  property :first_name, String
+  property :last_name, String
+
+  property :karma, Integer, :default => 1000
+
+  index :first_name
+  index :last_name
+  index [:first_name, :last_name]
+
+  has_many :comments
+
+  after_create :store_in_rating
+  after_destroy :after_destroy_callback
+
+  def store_in_rating
+    $redis.zadd "users:sorted_by_rating", 0.0, self.id
+  end
+
+  def after_destroy_callback
+    self.comments.map{|c| c.destroy}
+  end
+end
+
+describe "check callbacks" do
+  before(:all) do
+    path_to_conf = File.dirname(File.expand_path(__FILE__)) + "/redis.conf"
+    $redis_pid = spawn 'redis-server ' + path_to_conf, :out => "/dev/null"
+    sleep(0.3) # must be some delay otherwise "Connection refused - Unable to connect to Redis"
+    path_to_socket = File.dirname(File.expand_path(__FILE__)) + "/../redis.sock"
+    $redis = Redis.new(:host => 'localhost', :path => path_to_socket)
+  end
+  
+  before(:each) do
+    $redis.flushall if $redis
+  end
+
+  after(:each) do
+   $redis.flushall if $redis
+  end
+
+  after(:all) do
+    Process.kill 9, $redis_pid.to_i if $redis_pid
+  end
+
+  it "should fire after_create/after_destroy callbacks" do
+    user = User.new :first_name => "Robert", :last_name => "Pirsig"
+    user.save
+
+    $redis.zrank("users:sorted_by_rating", user.id).should == 0
+
+    comment = Comment.create :text => "First!"
+    user.comments << comment
+
+    u = User.first
+    u.id.should == user.id
+    u.comments.count.should == 1
+    u.destroy
+    u.comments.count.should == 0
+  end
+
+  it "should fire before_create/before_destroy callbacks" do
+    CutoutAggregator.create
+
+    CutoutAggregator.count.should == 1
+    Cutout.create :filename => "1.jpg"
+    Cutout.create :filename => "2.jpg"
+    CutoutAggregator.last.revision.should == 2
+    Cutout.last.destroy
+    Cutout.last.destroy
+    CutoutAggregator.count.should == 0
+  end
+
+  it "should fire after_save/before_save callbacks" do
+    comment = Comment.new :text => "      Trim meeee !   "
+    comment.save
+    Comment.first.text.should == "Trim meeee !"
+
+    user = User.new :first_name => "Robert", :last_name => "Pirsig"
+    user.save
+    user.karma.should == 1000
+
+    user.comments << comment
+    user.comments.count == 1
+
+    c = Comment.first
+    c.update_attributes :text => "Another brick in the wall"
+
+    User.first.karma.should == 975
+  end
+end