Big refactor to use better names and separation of concerns

2014-01-27 16:26:58 +00:00
parent 8a0aa55c91
commit 533b8e59a3
8 changed files with 435 additions and 525 deletions
@@ -0,0 +1,176 @@
+sinon = require('sinon')
+chai = require('chai')
+should = chai.should()
+expect = chai.expect
+modulePath = "../../../../app/js/UpdateCompressor.js"
+SandboxedModule = require('sandboxed-module')
+
+describe "UpdateCompressor", ->
+	beforeEach ->
+		@UpdateCompressor = SandboxedModule.require modulePath
+		@user_id = "user-id-1"
+		@other_user_id = "user-id-2"
+		@ts1 = Date.now()
+		@ts2 = Date.now() + 1000
+
+	describe "convertRawUpdatesToCompressedFormat", ->
+		it "should split grouped updates into individual updates", ->
+			expect(@UpdateCompressor.convertRawUpdatesToCompressedFormat [{
+				op:   [ @op1 = { p: 0, i: "Foo" }, @op2 = { p: 6, i: "bar"} ]
+				meta: { ts: @ts1, user_id: @user_id }
+			}, {
+				op:   [ @op3 = { p: 10, i: "baz" } ]
+				meta: { ts: @ts2, user_id: @other_user_id }
+			}])
+			.to.deep.equal [{
+				op: @op1,
+				meta: { start_ts: @ts1, end_ts: @ts1, user_id: @user_id }
+			}, {
+				op: @op2,
+				meta: { start_ts: @ts1, end_ts: @ts1, user_id: @user_id }
+			}, {
+				op: @op3,
+				meta: { start_ts: @ts2, end_ts: @ts2, user_id: @other_user_id }
+			}]
+
+	describe "compress", ->
+		describe "insert - insert", ->
+			it "should append one insert to the other", ->
+				expect(@UpdateCompressor.compressUpdates [{
+					op: { p: 3, i: "foo" }
+					meta: ts: @ts1, user_id: @user_id
+				}, {
+					op: { p: 6, i: "bar" }
+					meta: ts: @ts2, user_id: @user_id
+				}])
+				.to.deep.equal [{
+					op: { p: 3, i: "foobar" }
+					meta: start_ts: @ts1, end_ts: @ts2, user_id: @user_id
+				}]
+
+			it "should insert one insert inside the other", ->
+				expect(@UpdateCompressor.compressUpdates [{
+					op: { p: 3, i: "foo" }
+					meta: ts: @ts1, user_id: @user_id
+				}, {
+					op: { p: 5, i: "bar" }
+					meta: ts: @ts2, user_id: @user_id
+				}])
+				.to.deep.equal [{
+					op: { p: 3, i: "fobaro" }
+					meta: start_ts: @ts1, end_ts: @ts2, user_id: @user_id
+				}]
+
+			it "should not append separated inserts", ->
+				expect(@UpdateCompressor.compressUpdates [{
+					op: { p: 3, i: "foo" }
+					meta: ts: @ts1, user_id: @user_id
+				}, {
+					op: { p: 9, i: "bar" }
+					meta: ts: @ts2, user_id: @user_id
+				}])
+				.to.deep.equal [{
+					op: { p: 3, i: "foo" }
+					meta: start_ts: @ts1, end_ts: @ts1, user_id: @user_id
+				}, {
+					op: { p: 9, i: "bar" }
+					meta: start_ts: @ts2, end_ts: @ts2, user_id: @user_id
+				}]
+
+		describe "delete - delete", ->
+			it "should append one delete to the other", ->
+				expect(@UpdateCompressor.compressUpdates [{
+					op: { p: 3, d: "foo" }
+					meta: ts: @ts1, user_id: @user_id
+				}, {
+					op: { p: 3, d: "bar" }
+					meta: ts: @ts2, user_id: @user_id
+				}])
+				.to.deep.equal [{
+					op: { p: 3, d: "foobar" }
+					meta: start_ts: @ts1, end_ts: @ts2, user_id: @user_id
+				}]
+				
+			it "should insert one delete inside the other", ->
+				expect(@UpdateCompressor.compressUpdates [{
+					op: { p: 3, d: "foo" }
+					meta: ts: @ts1, user_id: @user_id
+				}, {
+					op: { p: 1, d: "bar" }
+					meta: ts: @ts2, user_id: @user_id
+				}])
+				.to.deep.equal [{
+					op: { p: 1, d: "bafoor" }
+					meta: start_ts: @ts1, end_ts: @ts2, user_id: @user_id
+				}]
+				
+			it "should not append separated deletes", ->
+				expect(@UpdateCompressor.compressUpdates [{
+					op: { p: 3, d: "foo" }
+					meta: ts: @ts1, user_id: @user_id
+				}, {
+					op: { p: 9, d: "bar" }
+					meta: ts: @ts2, user_id: @user_id
+				}])
+				.to.deep.equal [{
+					op: { p: 3, d: "foo" }
+					meta: start_ts: @ts1, end_ts: @ts1, user_id: @user_id
+				}, {
+					op: { p: 9, d: "bar" }
+					meta: start_ts: @ts2, end_ts: @ts2, user_id: @user_id
+				}]
+
+		describe "insert - delete", ->
+			it "should undo a previous insert", ->
+				expect(@UpdateCompressor.compressUpdates [{
+					op: { p: 3, i: "foo" }
+					meta: ts: @ts1, user_id: @user_id
+				}, {
+					op: { p: 5, d: "o" }
+					meta: ts: @ts2, user_id: @user_id
+				}])
+				.to.deep.equal [{
+					op: { p: 3, i: "fo" }
+					meta: start_ts: @ts1, end_ts: @ts2, user_id: @user_id
+				}]
+				
+			it "should remove part of an insert from the middle", ->
+				expect(@UpdateCompressor.compressUpdates [{
+					op: { p: 3, i: "fobaro" }
+					meta: ts: @ts1, user_id: @user_id
+				}, {
+					op: { p: 5, d: "bar" }
+					meta: ts: @ts2, user_id: @user_id
+				}])
+				.to.deep.equal [{
+					op: { p: 3, i: "foo" }
+					meta: start_ts: @ts1, end_ts: @ts2, user_id: @user_id
+				}]
+
+			it "should cancel out two opposite updates", ->
+				expect(@UpdateCompressor.compressUpdates [{
+					op: { p: 3, i: "foo" }
+					meta: ts: @ts1, user_id: @user_id
+				}, {
+					op: { p: 3, d: "foo" }
+					meta: ts: @ts2, user_id: @user_id
+				}])
+				.to.deep.equal []
+				
+			it "should not combine separated updates", ->
+				expect(@UpdateCompressor.compressUpdates [{
+					op: { p: 3, i: "foo" }
+					meta: ts: @ts1, user_id: @user_id
+				}, {
+					op: { p: 9, d: "bar" }
+					meta: ts: @ts2, user_id: @user_id
+				}])
+				.to.deep.equal [{
+					op: { p: 3, i: "foo" }
+					meta: start_ts: @ts1, end_ts: @ts1, user_id: @user_id
+				}, {
+					op: { p: 9, d: "bar" }
+					meta: start_ts: @ts2, end_ts: @ts2, user_id: @user_id
+				}]
+
+