Skip to content

Commit

Permalink
BC refactors Table.addIndex(), adds Table.addIndexByFieldNames()
Browse files Browse the repository at this point in the history
  • Loading branch information
@danstocker
danstocker committed Feb 22, 2015
1 parent 99870af commit 1ea9f59
Show file tree
Hide file tree
Showing 3 changed files with 83 additions and 47 deletions.
26 changes: 19 additions & 7 deletions js/Table.js
View file
Expand Up @@ -94,22 +94,19 @@ troop.postpone(jorder, 'Table', function () {
// adding table specific properties
this.indexCollection.forEachItem(function (/**jorder.Index*/ index) {
var rowSignature = index.rowSignature;
result.addIndex(rowSignature.fieldNames, rowSignature.signatureType);
result.addIndexByFieldNames(rowSignature.fieldNames, rowSignature.signatureType);
});

return result;
},

/**
* Adds an index to the table.
* @param {string[]} fieldNames Names of fields included in the index
* @param {string} [signatureType] Index type
* @param {boolean} [isCaseInsensitive=false] Whether signature is case insensitive.
* @param {string} [orderType='ascending'] Order type. Either 'ascending' or 'descending'.
* @param {jorder.Index} index
* @returns {jorder.Table}
*/
addIndex: function (fieldNames, signatureType, isCaseInsensitive, orderType) {
var index = jorder.Index.create(fieldNames, signatureType, isCaseInsensitive, orderType);
addIndex: function (index) {
dessert.isIndex(index, "Invalid index");

// adding index to collection
this.indexCollection.setItem(index);
Expand All @@ -120,6 +117,21 @@ troop.postpone(jorder, 'Table', function () {
return this;
},

/**
* Adds an index to the table.
* @param {string[]} fieldNames Names of fields included in the index
* @param {string} [signatureType] Index type
* @param {boolean} [isCaseInsensitive=false] Whether signature is case insensitive.
* @param {string} [orderType='ascending'] Order type. Either 'ascending' or 'descending'.
* @returns {jorder.Table}
*/
addIndexByFieldNames: function (fieldNames, signatureType, isCaseInsensitive, orderType) {
dessert.isArray(fieldNames, "Invalid field names");
var index = fieldNames.toIndex(signatureType, isCaseInsensitive, orderType);
this.addIndex(index);
return this;
},

/**
* Re-indexes table by rebuilding all indexes associated with table.
* @returns {jorder.Table}
Expand Down
100 changes: 62 additions & 38 deletions js/Table.test.js
View file
Expand Up @@ -66,7 +66,7 @@

test("Item setting", function () {
var table = jorder.Table.create()
.addIndex(['foo'])
.addIndex(['foo'].toIndex())
.setItem('0', {foo: "hello"});

deepEqual(
Expand All @@ -85,7 +85,7 @@

test("Setting multiple items", function () {
var table = jorder.Table.create()
.addIndex(['foo'])
.addIndex(['foo'].toIndex())
.setItem('0', {foo: "hello"});

table.setItems({
Expand Down Expand Up @@ -115,7 +115,7 @@
{foo: "hello"},
{foo: "world"}
])
.addIndex(['foo'])
.addIndex(['foo'].toIndex())
.deleteItem(0);

deepEqual(
Expand All @@ -139,7 +139,7 @@
{foo: "hello"},
{foo: "world"}
])
.addIndex(['foo']),
.addIndex(['foo'].toIndex()),
cloneTable;

cloneTable = table.clone();
Expand Down Expand Up @@ -174,7 +174,7 @@
{foo: "hello"},
{foo: "world"}
])
.addIndex(['foo']),
.addIndex(['foo'].toIndex()),
result;

result = /** @type jorder.Table */ table.mergeWith(jorder.Table.create([
Expand Down Expand Up @@ -213,11 +213,29 @@
});

test("Index addition", function () {
var table = jorder.Table.create([
{foo: 'hello', bar: 'world'}
]),
index = ['foo', 'bar'].toIndex('string', false, 'descending');

strictEqual(table.addIndex(index), table, "should be chainable");

equal(table.indexCollection.getKeyCount(), 1, "should increase index collection count");
deepEqual(table.indexCollection.getKeys(), ['foo|bar%string%descending'],
"should set index in collection by the signature as key");

strictEqual(
table.indexCollection.getIndexForFields(['foo', 'bar'], 'string', 'descending'),
index,
"should set index on table");
});

test("Index addition by field names", function () {
var table = jorder.Table.create([
{foo: 'hello', bar: 'world'}
]);

table.addIndex(['foo', 'bar'], 'string', false, 'descending');
table.addIndexByFieldNames(['foo', 'bar'], 'string', false, 'descending');

equal(table.indexCollection.getKeyCount(), 1, "should increase index collection count");
deepEqual(table.indexCollection.getKeys(), ['foo|bar%string%descending'],
Expand All @@ -227,26 +245,26 @@

ok(index.isA(jorder.Index), "Index instance");
equal(index.rowSignature.isCaseInsensitive, false, "Case sensitive by default");

deepEqual(
index.rowIdLookup.items,
{
'hello|world': '0'
},
"Lookup of index"
);
"Lookup of index");

deepEqual(
index.sortedKeys.items,
['hello|world'],
"Keys in index"
);
"Keys in index");
});

test("Re-indexing", function () {
var table = jorder.Table.create([
{foo: 'hello', bar: 'world'}
]);

table.addIndex(['foo', 'bar']);
table.addIndex(['foo', 'bar'].toIndex());

var index = table.indexCollection.getIndexForFields(['foo', 'bar']);

Expand Down Expand Up @@ -300,9 +318,9 @@
test("Query by single row", function () {
var SIGNATURE_TYPES = jorder.RowSignature.SIGNATURE_TYPES,
table = jorder.Table.create(json)
.addIndex(['title'], SIGNATURE_TYPES.fullText)
.addIndex(['author'], SIGNATURE_TYPES.string)
.addIndex(['volumes'], SIGNATURE_TYPES.number);
.addIndex(['title'].toIndex(SIGNATURE_TYPES.fullText))
.addIndex(['author'].toIndex(SIGNATURE_TYPES.string))
.addIndex(['volumes'].toIndex(SIGNATURE_TYPES.number));

deepEqual(
table.queryByRowAsHash({author: 'Tolkien'}).items,
Expand Down Expand Up @@ -336,9 +354,9 @@
test("Query by multiple rows", function () {
var SIGNATURE_TYPES = jorder.RowSignature.SIGNATURE_TYPES,
table = jorder.Table.create(json)
.addIndex(['title'], SIGNATURE_TYPES.fullText)
.addIndex(['author'], SIGNATURE_TYPES.string)
.addIndex(['volumes'], SIGNATURE_TYPES.number);
.addIndex(['title'].toIndex(SIGNATURE_TYPES.fullText))
.addIndex(['author'].toIndex(SIGNATURE_TYPES.string))
.addIndex(['volumes'].toIndex(SIGNATURE_TYPES.number));

deepEqual(
table.queryByRowsAsHash([
Expand Down Expand Up @@ -373,7 +391,7 @@
test("Querying by offset", function () {
var SIGNATURE_TYPES = jorder.RowSignature.SIGNATURE_TYPES,
table = jorder.Table.create(json)
.addIndex(['title'], SIGNATURE_TYPES.string),
.addIndex(['title'].toIndex(SIGNATURE_TYPES.string)),
result;

result = table.queryByOffsetAsHash(['title'], 1);
Expand All @@ -400,7 +418,7 @@
test("Querying by offset range", function () {
var SIGNATURE_TYPES = jorder.RowSignature.SIGNATURE_TYPES,
table = jorder.Table.create(json)
.addIndex(['title'], SIGNATURE_TYPES.string),
.addIndex(['title'].toIndex(SIGNATURE_TYPES.string)),
result;

result = table.queryByOffsetRangeAsHash(['title'], 1, 3);
Expand Down Expand Up @@ -433,7 +451,7 @@

var SIGNATURE_TYPES = jorder.RowSignature.SIGNATURE_TYPES,
table = jorder.Table.create(json)
.addIndex(['author'], SIGNATURE_TYPES.string);
.addIndex(['author'].toIndex(SIGNATURE_TYPES.string));

jorder.Index.addMocks({
getRowIdsForKeyRangeAsHash: function (startValue, endValue, offset, limit) {
Expand All @@ -453,8 +471,8 @@
test("Query by range", function () {
var SIGNATURE_TYPES = jorder.RowSignature.SIGNATURE_TYPES,
table = jorder.Table.create(json)
.addIndex(['title'], SIGNATURE_TYPES.fullText)
.addIndex(['author'], SIGNATURE_TYPES.string);
.addIndex(['title'].toIndex(SIGNATURE_TYPES.fullText))
.addIndex(['author'].toIndex(SIGNATURE_TYPES.string));

deepEqual(
table.queryByRangeAsHash(['author'], "M", "Z").items
Expand All @@ -475,8 +493,8 @@
test("Query by range (case insensitive)", function () {
var SIGNATURE_TYPES = jorder.RowSignature.SIGNATURE_TYPES,
table = jorder.Table.create(json)
.addIndex(['title'], SIGNATURE_TYPES.fullText, true)
.addIndex(['author'], SIGNATURE_TYPES.string, true);
.addIndex(['title'].toIndex(SIGNATURE_TYPES.fullText, true))
.addIndex(['author'].toIndex(SIGNATURE_TYPES.string, true));

deepEqual(
table.queryByRangeAsHash(['author'], "m", "z").items
Expand All @@ -499,7 +517,7 @@

var SIGNATURE_TYPES = jorder.RowSignature.SIGNATURE_TYPES,
table = jorder.Table.create(json)
.addIndex(['author'], SIGNATURE_TYPES.string);
.addIndex(['author'].toIndex(SIGNATURE_TYPES.string));

jorder.Index.addMocks({
getRowIdsForPrefixAsHash: function (prefix, offset, limit) {
Expand All @@ -518,8 +536,8 @@
test("Query by prefix", function () {
var SIGNATURE_TYPES = jorder.RowSignature.SIGNATURE_TYPES,
table = jorder.Table.create(json)
.addIndex(['title'], SIGNATURE_TYPES.fullText)
.addIndex(['author'], SIGNATURE_TYPES.string);
.addIndex(['title'].toIndex(SIGNATURE_TYPES.fullText))
.addIndex(['author'].toIndex(SIGNATURE_TYPES.string));

deepEqual(
table.queryByPrefixAsHash(['author'], "Tol").items,
Expand All @@ -543,8 +561,8 @@
test("Query by prefix (case insensitive)", function () {
var SIGNATURE_TYPES = jorder.RowSignature.SIGNATURE_TYPES,
table = jorder.Table.create(json)
.addIndex(['title'], SIGNATURE_TYPES.fullText, true)
.addIndex(['author'], SIGNATURE_TYPES.string, true);
.addIndex(['title'].toIndex(SIGNATURE_TYPES.fullText, true))
.addIndex(['author'].toIndex(SIGNATURE_TYPES.string, true));

deepEqual(
table.queryByPrefixAsHash(['author'], "tol").items,
Expand All @@ -570,9 +588,9 @@
result;

table
.addIndex(['foo', 'bar'])
.addIndex(['foo'])
.addIndex(['foo', 'baz']);
.addIndex(['foo', 'bar'].toIndex())
.addIndex(['foo'].toIndex())
.addIndex(['foo', 'baz'].toIndex());

deepEqual(table.items, [], "Table is empty by default");

Expand Down Expand Up @@ -628,7 +646,7 @@
test("Updating rows matching row expression", function () {
var SIGNATURE_TYPES = jorder.RowSignature.SIGNATURE_TYPES,
table = jorder.Table.create(sntls.Utils.shallowCopy(json))
.addIndex(['volumes'], SIGNATURE_TYPES.number),
.addIndex(['volumes'].toIndex(SIGNATURE_TYPES.number)),
row = {
'order' : 0,
'title' : 'Green Hills of Africa',
Expand Down Expand Up @@ -671,8 +689,14 @@
"should update all matching rows");

deepEqual(rowsRemoved, [
[{volumes: 1}, '1'],
[{volumes: 1}, '2']
[
{volumes: 1},
'1'
],
[
{volumes: 1},
'2'
]
], "should remove matching rows from affected indexes");

deepEqual(rowsAdded, [
Expand All @@ -689,9 +713,9 @@
{foo: "howdy", bar: "yall", baz: "!"},
{foo: "greetings", bar: "everyone", baz: "."}
])
.addIndex(['foo', 'bar'])
.addIndex(['foo'])
.addIndex(['foo', 'baz']),
.addIndex(['foo', 'bar'].toIndex())
.addIndex(['foo'].toIndex())
.addIndex(['foo', 'baz'].toIndex()),
rowExpression = {foo: "hello", bar: "world"},
affectedSignatures = [];

Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
@@ -1,6 +1,6 @@
{
"name" : "jorder",
"version" : "0.2.7",
"version" : "0.3.0",
"description" : "Indexed table cache",
"keywords" : [
"table", "indexed",
Expand All @@ -17,7 +17,7 @@
"dependencies" : {
"dessert": "~0.3.2",
"troop" : "~0.8.0",
"sntls": "~0.18.0 || ~0.19.0"
"sntls" : "~0.18.0 || ~0.19.0"
},
"devDependencies": {
"phil" : "~0.2.3",
Expand Down

0 comments on commit 1ea9f59

Please sign in to comment.