toystore 0.5

data/spec/toy/extensions/string_spec.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+describe "String.to_store" do
+  it "should convert value to_s" do
+    [21, '21'].each do |value|
+      String.to_store(value).should == '21'
+    end
+  end
+
+  it "should be nil if nil" do
+    String.to_store(nil).should be_nil
+  end
+end
+
+describe "String.from_store" do
+  it "should be string if value present" do
+    String.from_store('Scotch! Scotch! Scotch!').should == 'Scotch! Scotch! Scotch!'
+  end
+
+  it "should return nil if nil" do
+    String.from_store(nil).should be_nil
+  end
+
+  it "should return empty string if blank" do
+    String.from_store('').should == ''
+  end
+end
+

data/spec/toy/extensions/time_spec.rb

@@ -0,0 +1,94 @@
+require 'helper'
+
+describe "Time.to_store without Time.zone" do
+  before :each do
+    Time.zone = nil
+  end
+
+  it "should be time to milliseconds if string" do
+    Time.to_store('2000-01-01 01:01:01.123456').to_f.should == Time.local(2000, 1, 1, 1, 1, 1, 0).utc.to_f
+  end
+
+  it "should be time in utc if time" do
+    Time.to_store(Time.local(2009, 8, 15, 0, 0, 0)).zone.should == 'UTC'
+  end
+
+  it "should be nil if blank string" do
+    Time.to_store('').should be_nil
+  end
+
+  it "should not be nil if nil" do
+    Time.to_store(nil).should be_nil
+  end
+end
+
+describe "Time.to_store with Time.zone" do
+  it "should be time to milliseconds if time" do
+    Time.zone = 'Hawaii'
+    Time.to_store(Time.zone.local(2009, 8, 15, 14, 0, 0, 123456)).to_f.should == Time.utc(2009, 8, 16, 0, 0, 0, 0).to_f
+    Time.zone = nil
+  end
+
+  it "should be time to milliseconds if string" do
+    Time.zone = 'Hawaii'
+    Time.to_store('2009-08-15 14:00:00.123456').to_f.should == Time.utc(2009, 8, 16, 0, 0, 0, 0).to_f
+    Time.zone = nil
+  end
+
+  it "should not round up times at the end of the month" do
+    Time.to_store(Time.now.end_of_month).to_i.should == Time.now.end_of_month.utc.to_i
+  end
+
+  it "should be nil if blank string" do
+    Time.zone = 'Hawaii'
+    Time.to_store('').should be_nil
+    Time.zone = nil
+  end
+
+  it "should be nil if nil" do
+    Time.zone = 'Hawaii'
+    Time.to_store(nil).should be_nil
+    Time.zone = nil
+  end
+end
+
+describe "Time.from_store without Time.zone" do
+  it "should be time in utc" do
+    time = Time.now
+    Time.from_store(time).should be_within(1).of(time.utc)
+  end
+
+  it "should be time if string" do
+    time = Time.now
+    Time.from_store(time.to_s).should be_within(1).of(time)
+  end
+
+  it "should be nil if nil" do
+    Time.from_store(nil).should be_nil
+  end
+end
+
+describe "Time.from_store with Time.zone" do
+  before do
+    Time.zone = 'Hawaii'
+  end
+
+  after do
+    Time.zone = nil
+  end
+
+  it "should be time in Time.zone" do
+    time = Time.from_store(Time.utc(2009, 10, 1))
+    time.should == Time.zone.local(2009, 9, 30, 14)
+    time.is_a?(ActiveSupport::TimeWithZone).should be_true
+  end
+
+  it "should be time if string" do
+    time = Time.zone.now
+    Time.from_store(time.to_s).should be_within(1).of(time)
+  end
+
+  it "should be nil if nil" do
+    Time.from_store(nil).should be_nil
+  end
+end

data/spec/toy/identity/abstract_key_factory_spec.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+describe Toy::Identity::AbstractKeyFactory do
+  it "should raise not implemented error for #next_key" do
+    lambda { Toy::Identity::AbstractKeyFactory.new.next_key("any object") }.should raise_error(NotImplementedError)
+  end
+end

data/spec/toy/identity/uuid_key_factory_spec.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+describe Toy::Identity::UUIDKeyFactory do
+  it "should use uuid for next key" do
+    Toy::Identity::UUIDKeyFactory.new.next_key(nil).length.should == 36
+  end
+end

data/spec/toy/identity_map_spec.rb

@@ -0,0 +1,150 @@
+require 'helper'
+
+describe Toy::IdentityMap do
+  uses_constants('User', 'Skill')
+
+  before do
+    Toy.identity_map.clear
+  end
+
+  describe ".identity_map" do
+    it "defaults to hash" do
+      User.identity_map.should == {}
+    end
+
+    it "memoizes" do
+      User.identity_map.should equal(User.identity_map)
+    end
+  end
+
+  it "adds to map on save" do
+    user = User.new
+    user.save!
+    user.should be_in_identity_map
+  end
+
+  it "adds to map on load" do
+    user = User.load({'id' => '1'})
+    user.should be_in_identity_map
+  end
+
+  it "removes from map on delete" do
+    user = User.create
+    user.should be_in_identity_map
+    user.delete
+    user.should_not be_in_identity_map
+  end
+
+  it "removes from map on destroy" do
+    user = User.create
+    user.should be_in_identity_map
+    user.destroy
+    user.should_not be_in_identity_map
+  end
+
+  describe ".get" do
+    it "adds to map if not in map" do
+      user = User.create
+      user.identity_map.clear
+      user.should_not be_in_identity_map
+      user = User.get(user.id)
+      user.should be_in_identity_map
+    end
+
+    it "returns from map if in map" do
+      user = User.create
+      user.should be_in_identity_map
+      User.get(user.id).should equal(user)
+    end
+
+    it "does not query if in map" do
+      user = User.create
+      user.should be_in_identity_map
+      user.store.should_not_receive(:read)
+      User.get(user.id).should equal(user)
+    end
+  end
+
+  describe "#reload" do
+    it "forces new query each time and skips the identity map" do
+      user = User.create
+      user.should be_in_identity_map
+      User.store.should_receive(:read).with(user.store_key).and_return({})
+      user.reload
+    end
+  end
+
+  describe "identity map off" do
+    it "does not add to map on save" do
+      User.identity_map_off
+      user = User.new
+      user.save!
+      user.should_not be_in_identity_map
+    end
+
+    it "does not add to map on load" do
+      User.identity_map_off
+      user = User.load('id' => '1')
+      user.should_not be_in_identity_map
+    end
+
+    it "does not remove from map on delete" do
+      user = User.create
+      user.should be_in_identity_map
+      User.identity_map_off
+      user.delete
+      user.should be_in_identity_map
+    end
+
+    it "does not remove from map on destroy" do
+      user = User.create
+      user.should be_in_identity_map
+      User.identity_map_off
+      user.destroy
+      user.should be_in_identity_map
+    end
+
+    describe ".get" do
+      it "does not add to map if not in map" do
+        User.identity_map_off
+        user = User.create
+        user.should_not be_in_identity_map
+        user = User.get(user.id)
+        user.should_not be_in_identity_map
+      end
+
+      it "does not load from map if in map" do
+        user = User.create
+        user.should be_in_identity_map
+        User.identity_map_off
+        user.store.should_receive(:read).with(user.store_key).and_return(user.persisted_attributes)
+        User.get(user.id)
+      end
+    end
+  end
+
+  describe ".without_identity_map" do
+    describe "with identity map off" do
+      it "turns identity map off, yields, and returns it to previous state" do
+        User.identity_map_off
+        User.should be_identity_map_off
+        User.without_identity_map do
+          user = User.create
+          user.should_not be_in_identity_map
+        end
+        User.should be_identity_map_off
+      end
+    end
+
+    describe "with identity map on" do
+      it "turns identity map off, yields, and returns it to previous state" do
+        User.should be_identity_map_on
+        User.without_identity_map do
+          user = User.create
+          user.should_not be_in_identity_map
+        end
+        User.should be_identity_map_on
+      end
+    end
+  end
+end

data/spec/toy/identity_spec.rb

@@ -0,0 +1,52 @@
+require 'helper'
+
+describe Toy::Identity do
+  uses_constants('User', 'Piece')
+
+  describe "setting the key" do
+    it "should set key factory to UUIDKeyFactory" do
+      User.key(:uuid).should be_instance_of(Toy::Identity::UUIDKeyFactory)
+    end
+
+    it "should set key factory passed in factory" do
+      factory = Toy::Identity::UUIDKeyFactory
+      User.key(factory).should == factory
+    end
+
+    it "should use Toy.key_factory by default" do
+      key_factory     = mock
+      Toy.key_factory = key_factory
+      klass           = Class.new { include Toy::Store }
+
+      key_factory.should_receive(:next_key).and_return('some_key')
+      klass.next_key
+
+      Toy.key_factory = nil
+    end
+  end
+
+  describe ".next_key" do
+    it "should call the next key on the key factory" do
+      factory = Toy::Identity::UUIDKeyFactory
+      factory.should_receive(:next_key).and_return('some_key')
+      User.key(factory)
+      User.next_key.should == 'some_key'
+    end
+
+    it "should raise an exception for nil key" do
+      factory = Toy::Identity::UUIDKeyFactory
+      factory.should_receive(:next_key).and_return(nil)
+      User.key(factory)
+      lambda { User.next_key }.should raise_error
+    end
+  end
+
+  describe "initializing the id" do
+    it "should pass use pass the new object" do
+      Piece.attribute(:name, String)
+      Piece.attribute(:number, Integer)
+      Piece.key(NameAndNumberKeyFactory.new)
+      Piece.new(:name => 'Rook', :number => 1).id.should == 'Rook-1'
+    end
+  end
+end

data/spec/toy/index_spec.rb

@@ -0,0 +1,230 @@
+require 'helper'
+
+describe Toy::Index do
+  uses_constants('User', 'Student', 'Friendship')
+
+  before do
+    User.attribute(:ssn, String)
+    @index = User.index(:ssn)
+  end
+  let(:index) { @index }
+
+  it "has a model" do
+    index.model.should == User
+  end
+
+  it "has a name" do
+    index.name.should == :ssn
+  end
+
+  it "raises error if attribute does not exist" do
+    lambda {
+      User.index :student_id
+    }.should raise_error(ArgumentError, "No attribute student_id for index")
+  end
+
+  it "has a sha1'd key for a value" do
+    index.key('some_value').should == 'User:ssn:8c818171573b03feeae08b0b4ffeb6999e3afc05'
+  end
+
+  it "adds index to model" do
+    User.indices.keys.should include(:ssn)
+  end
+
+  describe "#eql?" do
+    it "returns true if same class, model, and name" do
+      index.should eql(index)
+    end
+
+    it "returns false if not same class" do
+      index.should_not eql({})
+    end
+
+    it "returns false if not same model" do
+      Student.attribute :ssn, String
+      index.should_not eql(Toy::Index.new(Student, :ssn))
+    end
+
+    it "returns false if not the same name" do
+      User.attribute :student_id, String
+      index.should_not eql(Toy::Index.new(User, :student_id))
+    end
+  end
+
+  describe "single key" do
+    describe "creating with index" do
+      before do
+        @user = User.create(:ssn => '555-00-1234')
+      end
+      let(:user) { @user }
+
+      it "creates key for indexed value" do
+        User.store.should be_key("User:ssn:f6edc9155d79e311ad2d4a6e1b54004f31497f4c")
+      end
+
+      it "adds instance id to index array" do
+        User.get_index(:ssn, '555-00-1234').should == [user.id]
+      end
+    end
+
+    describe "creating second record for same index value" do
+      before do
+        @user1 = User.create(:ssn => '555-00-1234')
+        @user2 = User.create(:ssn => '555-00-1234')
+      end
+
+      it "adds both instances to index" do
+        User.get_index(:ssn, '555-00-1234').should == [@user1.id, @user2.id]
+      end
+    end
+
+    describe "destroying with index" do
+      before do
+        @user = User.create(:ssn => '555-00-1234')
+        @user.destroy
+      end
+
+      it "removes id from index" do
+        User.get_index(:ssn, '555-00-1234').should == []
+      end
+    end
+
+    describe "updating record and changing indexed value" do
+      before do
+        @user = User.create(:ssn => '555-00-1234')
+        @user.update_attributes(:ssn => '555-00-4321')
+      end
+
+      it "removes from old index" do
+        User.get_index(:ssn, '555-00-1234').should == []
+      end
+
+      it "adds to new index" do
+        User.get_index(:ssn, '555-00-4321').should == [@user.id]
+      end
+    end
+
+    describe "updating record without changing indexed value" do
+      before do
+        @user = User.create(:ssn => '555-00-1234')
+        @user.update_attributes(:ssn => '555-00-1234')
+      end
+
+      it "leaves index alone" do
+        User.get_index(:ssn, '555-00-1234').should == [@user.id]
+      end
+    end
+
+    describe "first by index" do
+      it "should not find values that are not in index" do
+        User.first_by_ssn('does-not-exist').should be_nil
+      end
+
+      it "should find indexed value" do
+        user = User.create(:ssn => '555-00-1234')
+        User.first_by_ssn('555-00-1234').should == user
+      end
+    end
+
+    describe "first or new by index" do
+      it "initializes if not existing" do
+        user = User.first_or_new_by_ssn('does-not-exist')
+        user.ssn.should == 'does-not-exist'
+        user.should_not be_persisted
+      end
+
+      it "returns if existing" do
+        user = User.create(:ssn => '555-00-1234')
+        User.first_or_new_by_ssn('555-00-1234').should == user
+      end
+    end
+
+    describe "first or create by index" do
+      it "creates if not existing" do
+        user = User.first_or_create_by_ssn('does-not-exist')
+        user.ssn.should == 'does-not-exist'
+        user.should be_persisted
+      end
+
+      it "returns if existing" do
+        user = User.create(:ssn => '555-00-1234')
+        User.first_or_create_by_ssn('555-00-1234').should == user
+      end
+    end
+  end
+
+  describe "array key" do
+    before do
+      User.list :friendships
+      Friendship.list :users
+      Friendship.index :user_ids
+      @user1 = User.create(:ssn => '555-00-1234')
+      @user2 = User.create(:ssn => '555-00-9876')
+      @friendship = Friendship.create(:user_ids => [@user1.id, @user2.id])
+    end
+    let(:user1) { @user1 }
+    let(:user2) { @user2 }
+    let(:friendship) { @friendship }
+
+    describe "creating with index" do
+      it "creates key for indexed values sorted" do
+        sha_value = Digest::SHA1.hexdigest([user1.id, user2.id].sort.join(''))
+        Friendship.store.should be_key("Friendship:user_ids:#{sha_value}")
+      end
+
+      it "adds instance id to index array" do
+        Friendship.get_index(:user_ids, [user1.id, user2.id]).should == [friendship.id]
+        Friendship.get_index(:user_ids, [user2.id, user1.id]).should == [friendship.id]
+      end
+    end
+
+    describe "destroying with index" do
+      before do
+        friendship.destroy
+      end
+
+      it "removes id from index" do
+        Friendship.get_index(:user_ids, [user2.id, user1.id]).should == []
+      end
+    end
+
+    describe "first by index" do
+      it "should not find values that are not in index" do
+        Friendship.first_by_user_ids([user1.id, 'does-not-exist']).should be_nil
+      end
+
+      it "should find indexed value" do
+        Friendship.first_by_user_ids([user1.id, user2.id]).should == friendship
+        Friendship.first_by_user_ids([user2.id, user1.id]).should == friendship
+      end
+    end
+
+    describe "first or new by index" do
+      it "initializes if not existing" do
+        new_friend = User.create(:ssn => '555-00-1928')
+        new_friendship = Friendship.first_or_new_by_user_ids([user1.id, new_friend.id])
+        new_friendship.user_ids.sort.should == [user1.id, new_friend.id].sort
+        new_friendship.should_not be_persisted
+      end
+
+      it "returns if existing" do
+        Friendship.first_or_new_by_user_ids([user1.id, user2.id]).should == friendship
+        Friendship.first_or_new_by_user_ids([user2.id, user1.id]).should == friendship
+      end
+    end
+
+    describe "first or create by index" do
+      it "creates if not existing" do
+        new_friend = User.create(:ssn => '555-00-1928')
+        new_friendship = Friendship.first_or_create_by_user_ids([user1.id, new_friend.id])
+        new_friendship.user_ids.sort.should == [user1.id, new_friend.id].sort
+        new_friendship.should be_persisted
+      end
+
+      it "returns if existing" do
+        Friendship.first_or_create_by_user_ids([user1.id, user2.id]).should == friendship
+        Friendship.first_or_create_by_user_ids([user2.id, user1.id]).should == friendship
+      end
+    end
+  end
+end