Compare commits
30 Commits
Author | SHA1 | Date | |
---|---|---|---|
138290a7b8 | |||
036cafc282 | |||
7764ba5cb8 | |||
7f77634ea1 | |||
acf3c29939 | |||
925cd639b4 | |||
af8de58dcd | |||
f39703b8d9 | |||
fa1951b4dd | |||
8c37a367a0 | |||
37f388e998 | |||
78bdb6760e | |||
ce1dceb60c | |||
16add8bff0 | |||
11149b2712 | |||
e508a942e3 | |||
5b093c68e4 | |||
d1b0a65993 | |||
316030be7c | |||
411b0b1ae9 | |||
50a6a1a690 | |||
ee3c3580d3 | |||
6dd82994a6 | |||
295096de24 | |||
50b5f84955 | |||
1557c713cd | |||
4ce457fadf | |||
56d6e0fd45 | |||
89ebf23d46 | |||
a861444c30 |
89
README.md
Normal file
89
README.md
Normal file
@ -0,0 +1,89 @@
|
|||||||
|
# smartdata
|
||||||
|
|
||||||
|
> Note: Still in Beta
|
||||||
|
|
||||||
|
smartdata is a ODM that adheres to TypeScript practices and uses classes to organize data.
|
||||||
|
It uses MongoDB as persistent storage.
|
||||||
|
|
||||||
|
## Intention
|
||||||
|
There are many ODMs out there, however when we searched for a ODM that uses TypeScript,
|
||||||
|
acts smart while still embracing an easy the NoSQL idea we didn't find a matching solution.
|
||||||
|
This is why we started smartdata
|
||||||
|
|
||||||
|
How MongoDB terms map to smartdata classes
|
||||||
|
|
||||||
|
MongoDB term | smartdata class
|
||||||
|
--- | ---
|
||||||
|
Database | smartdata.Db
|
||||||
|
Collection | smartdata.DbCollection
|
||||||
|
Document | smartdata.DbDoc
|
||||||
|
|
||||||
|
### class Db
|
||||||
|
represents a Database. Naturally it has .connect() etc. methods on it.
|
||||||
|
Since it is a class you can have multiple DBs defined.
|
||||||
|
```typescript
|
||||||
|
import * as smartdata from 'smartdata'
|
||||||
|
|
||||||
|
let myDb1 = new smartdata.Db('someConnectionUrl')
|
||||||
|
let myDb2 = new smartdata.Db('someConnectionUrl')
|
||||||
|
|
||||||
|
myDb1.connect()
|
||||||
|
myDb2.connect()
|
||||||
|
|
||||||
|
// continues in next block...
|
||||||
|
```
|
||||||
|
|
||||||
|
### class DbCollection
|
||||||
|
represents a collection of objects.
|
||||||
|
A collection is defined by the object class (that is extending smartdata.dbdoc) it respresents
|
||||||
|
|
||||||
|
So to get to get access to a specific collection you document
|
||||||
|
```typescript
|
||||||
|
// continues from the block before...
|
||||||
|
|
||||||
|
class myObject extends smartdata.DbDoc { // read the next block about DbDoc
|
||||||
|
property1:string
|
||||||
|
property2:number
|
||||||
|
constructor(optionsArg:{
|
||||||
|
queryArg?:any,
|
||||||
|
dataArg?:{
|
||||||
|
property1:string,
|
||||||
|
property2:number
|
||||||
|
}
|
||||||
|
}) {
|
||||||
|
super(this,optionsArg)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let myCollection = myDb1.getCollection(myObject)
|
||||||
|
```
|
||||||
|
|
||||||
|
> Alert: You NEVER instantiate a collection.
|
||||||
|
This is done for you!!!
|
||||||
|
|
||||||
|
### class DbDoc
|
||||||
|
represents a individual document in a collection
|
||||||
|
and thereby is ideally suited to extend the class you want to actually store.
|
||||||
|
|
||||||
|
DbDoc extends your class with the following methods:
|
||||||
|
|
||||||
|
* `.save()` will save (or update) the object you call it on only. Any referenced non-savable objects will not get stored.
|
||||||
|
* `.saveDeep()` does the same like `.save()`.
|
||||||
|
In addition it will look for properties that reference an object
|
||||||
|
that extends DbDoc as well and call .saveDeep() on them as well.
|
||||||
|
Loops are prevented
|
||||||
|
|
||||||
|
So now we can **store** instances of classes to Db...
|
||||||
|
How do we **get** a new class instance from a Doc in the DB?
|
||||||
|
Easy! Take a look at the constructor. When you specify `optionsArg.queryArg`
|
||||||
|
smartdata will fill in the data from the database!
|
||||||
|
But when you specify a `optionsArg.dataArg` instead
|
||||||
|
the data for the class is taken from there :)
|
||||||
|
|
||||||
|
## TypeScript
|
||||||
|
How does TypeScript play into this?
|
||||||
|
Since you define your classes in TapeScript and types flow through smartdata in a generic way
|
||||||
|
you should get all the Intellisense and type checking you love when using smartdata.
|
||||||
|
smartdata itself also bundles typings.
|
||||||
|
So you don't need to install any additional types whenimporting smartdata.
|
||||||
|
|
||||||
|
[](https://push.rocks)
|
16
dist/index.d.ts
vendored
16
dist/index.d.ts
vendored
@ -1,14 +1,2 @@
|
|||||||
/// <reference types="q" />
|
export * from './smartdata.classes.dbcollection';
|
||||||
import * as plugins from './smartdata.plugins';
|
export * from './smartdata.classes.db';
|
||||||
export declare class DbCollection<T> {
|
|
||||||
constructor(nameArg: string, db: plugins.mongodb.Db);
|
|
||||||
}
|
|
||||||
export declare type TDbConnectionStatus = 'disconnected' | 'connected' | 'failed';
|
|
||||||
export declare class DbConnection {
|
|
||||||
dbUrl: string;
|
|
||||||
db: plugins.mongodb.Db;
|
|
||||||
status: TDbConnectionStatus;
|
|
||||||
constructor(dbUrl: string);
|
|
||||||
connect(): plugins.q.Promise<any>;
|
|
||||||
close(): plugins.q.Promise<any>;
|
|
||||||
}
|
|
||||||
|
38
dist/index.js
vendored
38
dist/index.js
vendored
@ -1,35 +1,7 @@
|
|||||||
"use strict";
|
"use strict";
|
||||||
const plugins = require('./smartdata.plugins');
|
function __export(m) {
|
||||||
class DbCollection {
|
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
|
||||||
constructor(nameArg, db) {
|
|
||||||
let collection = db.collection(nameArg);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
exports.DbCollection = DbCollection;
|
__export(require('./smartdata.classes.dbcollection'));
|
||||||
class DbConnection {
|
__export(require('./smartdata.classes.db'));
|
||||||
constructor(dbUrl) {
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7O0FBRUEsaUJBQWMsa0NBQ2QsQ0FBQyxFQUQrQztBQUNoRCxpQkFBYyx3QkFDZCxDQUFDLEVBRHFDIn0=
|
||||||
this.dbUrl = dbUrl;
|
|
||||||
}
|
|
||||||
connect() {
|
|
||||||
let done = plugins.q.defer();
|
|
||||||
plugins.mongodb.MongoClient.connect(this.dbUrl, (err, db) => {
|
|
||||||
if (err) {
|
|
||||||
console.log(err);
|
|
||||||
}
|
|
||||||
plugins.assert.equal(null, err);
|
|
||||||
this.db = db;
|
|
||||||
plugins.beautylog.success(`connected to database at ${this.dbUrl}`);
|
|
||||||
done.resolve(this.db);
|
|
||||||
});
|
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
close() {
|
|
||||||
let done = plugins.q.defer();
|
|
||||||
this.db.close();
|
|
||||||
plugins.beautylog.ok(`disconnected to database at ${this.dbUrl}`);
|
|
||||||
done.resolve();
|
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
exports.DbConnection = DbConnection;
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsTUFBWSxPQUFPLFdBQU0scUJBRXpCLENBQUMsQ0FGNkM7QUFFOUM7SUFDSSxZQUFZLE9BQWUsRUFBRSxFQUFzQjtRQUMvQyxJQUFJLFVBQVUsR0FBRyxFQUFFLENBQUMsVUFBVSxDQUFDLE9BQU8sQ0FBQyxDQUFBO0lBQzNDLENBQUM7QUFDTCxDQUFDO0FBSlksb0JBQVksZUFJeEIsQ0FBQTtBQUlEO0lBS0ksWUFBWSxLQUFhO1FBQ3JCLElBQUksQ0FBQyxLQUFLLEdBQUcsS0FBSyxDQUFBO0lBQ3RCLENBQUM7SUFFRCxPQUFPO1FBQ0gsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQTtRQUM1QixPQUFPLENBQUMsT0FBTyxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDLEdBQUcsRUFBRSxFQUFFO1lBQ3BELEVBQUUsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUM7Z0JBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQTtZQUFDLENBQUM7WUFDN0IsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFBO1lBQy9CLElBQUksQ0FBQyxFQUFFLEdBQUcsRUFBRSxDQUFBO1lBQ1osT0FBTyxDQUFDLFNBQVMsQ0FBQyxPQUFPLENBQUMsNEJBQTRCLElBQUksQ0FBQyxLQUFLLEVBQUUsQ0FBQyxDQUFBO1lBQ25FLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFBO1FBQ3pCLENBQUMsQ0FBQyxDQUFBO1FBQ0YsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUE7SUFDdkIsQ0FBQztJQUVELEtBQUs7UUFDRCxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFBO1FBQzVCLElBQUksQ0FBQyxFQUFFLENBQUMsS0FBSyxFQUFFLENBQUE7UUFDZixPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQywrQkFBK0IsSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDLENBQUE7UUFDakUsSUFBSSxDQUFDLE9BQU8sRUFBRSxDQUFBO1FBQ2QsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUE7SUFDdkIsQ0FBQztBQUNMLENBQUM7QUE1Qlksb0JBQVksZUE0QnhCLENBQUEifQ==
|
|
11
dist/smartdata.classes.db.d.ts
vendored
Normal file
11
dist/smartdata.classes.db.d.ts
vendored
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
/// <reference types="q" />
|
||||||
|
import * as plugins from './smartdata.plugins';
|
||||||
|
export declare type TConnectionStatus = 'disconnected' | 'connected' | 'failed';
|
||||||
|
export declare class Db {
|
||||||
|
dbUrl: string;
|
||||||
|
db: plugins.mongodb.Db;
|
||||||
|
status: TConnectionStatus;
|
||||||
|
constructor(dbUrl: string);
|
||||||
|
connect(): plugins.q.Promise<any>;
|
||||||
|
close(): plugins.q.Promise<any>;
|
||||||
|
}
|
29
dist/smartdata.classes.db.js
vendored
Normal file
29
dist/smartdata.classes.db.js
vendored
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
"use strict";
|
||||||
|
const plugins = require('./smartdata.plugins');
|
||||||
|
class Db {
|
||||||
|
constructor(dbUrl) {
|
||||||
|
this.dbUrl = dbUrl;
|
||||||
|
}
|
||||||
|
connect() {
|
||||||
|
let done = plugins.q.defer();
|
||||||
|
plugins.mongodb.MongoClient.connect(this.dbUrl, (err, db) => {
|
||||||
|
if (err) {
|
||||||
|
console.log(err);
|
||||||
|
}
|
||||||
|
plugins.assert.equal(null, err);
|
||||||
|
this.db = db;
|
||||||
|
plugins.beautylog.success(`connected to database at ${this.dbUrl}`);
|
||||||
|
done.resolve(this.db);
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
|
}
|
||||||
|
close() {
|
||||||
|
let done = plugins.q.defer();
|
||||||
|
this.db.close();
|
||||||
|
plugins.beautylog.ok(`disconnected to database at ${this.dbUrl}`);
|
||||||
|
done.resolve();
|
||||||
|
return done.promise;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
exports.Db = Db;
|
||||||
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRkYXRhLmNsYXNzZXMuZGIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGRhdGEuY2xhc3Nlcy5kYi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsTUFBWSxPQUFPLFdBQU0scUJBRXpCLENBQUMsQ0FGNkM7QUFJOUM7SUFLSSxZQUFZLEtBQWE7UUFDckIsSUFBSSxDQUFDLEtBQUssR0FBRyxLQUFLLENBQUE7SUFDdEIsQ0FBQztJQUVELE9BQU87UUFDSCxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFBO1FBQzVCLE9BQU8sQ0FBQyxPQUFPLENBQUMsV0FBVyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsS0FBSyxFQUFFLENBQUMsR0FBRyxFQUFFLEVBQUU7WUFDcEQsRUFBRSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQztnQkFBQyxPQUFPLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxDQUFBO1lBQUMsQ0FBQztZQUM3QixPQUFPLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUE7WUFDL0IsSUFBSSxDQUFDLEVBQUUsR0FBRyxFQUFFLENBQUE7WUFDWixPQUFPLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyw0QkFBNEIsSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDLENBQUE7WUFDbkUsSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLENBQUE7UUFDekIsQ0FBQyxDQUFDLENBQUE7UUFDRixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUN2QixDQUFDO0lBRUQsS0FBSztRQUNELElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUE7UUFDNUIsSUFBSSxDQUFDLEVBQUUsQ0FBQyxLQUFLLEVBQUUsQ0FBQTtRQUNmLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLCtCQUErQixJQUFJLENBQUMsS0FBSyxFQUFFLENBQUMsQ0FBQTtRQUNqRSxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUE7UUFDZCxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUN2QixDQUFDO0FBQ0wsQ0FBQztBQTVCWSxVQUFFLEtBNEJkLENBQUEifQ==
|
24
dist/smartdata.classes.dbcollection.d.ts
vendored
Normal file
24
dist/smartdata.classes.dbcollection.d.ts
vendored
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
/// <reference types="q" />
|
||||||
|
import * as plugins from './smartdata.plugins';
|
||||||
|
import { Db } from './smartdata.classes.db';
|
||||||
|
export declare class DbCollection<T> {
|
||||||
|
collection: plugins.mongodb.Collection;
|
||||||
|
constructor(nameArg: string, dbArg: Db);
|
||||||
|
/**
|
||||||
|
* adds a validation function that all newly inserted and updated objects have to pass
|
||||||
|
*/
|
||||||
|
addObjectValidation(funcArg: any): void;
|
||||||
|
/**
|
||||||
|
* finds an object in the DbCollection
|
||||||
|
*/
|
||||||
|
find(docMatchArg: T | any): plugins.q.Promise<T[]>;
|
||||||
|
/**
|
||||||
|
* inserts object into the DbCollection
|
||||||
|
*/
|
||||||
|
insertOne(docArg: T): plugins.q.Promise<void>;
|
||||||
|
/**
|
||||||
|
* inserts many objects at once into the DbCollection
|
||||||
|
*/
|
||||||
|
insertMany(docArrayArg: T[]): plugins.q.Promise<void>;
|
||||||
|
private checkDoc(doc);
|
||||||
|
}
|
57
dist/smartdata.classes.dbcollection.js
vendored
Normal file
57
dist/smartdata.classes.dbcollection.js
vendored
Normal file
@ -0,0 +1,57 @@
|
|||||||
|
"use strict";
|
||||||
|
const plugins = require('./smartdata.plugins');
|
||||||
|
class DbCollection {
|
||||||
|
constructor(nameArg, dbArg) {
|
||||||
|
this.collection = dbArg.db.collection(nameArg);
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* adds a validation function that all newly inserted and updated objects have to pass
|
||||||
|
*/
|
||||||
|
addObjectValidation(funcArg) { }
|
||||||
|
/**
|
||||||
|
* finds an object in the DbCollection
|
||||||
|
*/
|
||||||
|
find(docMatchArg) {
|
||||||
|
let done = plugins.q.defer();
|
||||||
|
this.collection.find(docMatchArg).toArray((err, docs) => {
|
||||||
|
if (err) {
|
||||||
|
throw err;
|
||||||
|
}
|
||||||
|
done.resolve(docs);
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* inserts object into the DbCollection
|
||||||
|
*/
|
||||||
|
insertOne(docArg) {
|
||||||
|
let done = plugins.q.defer();
|
||||||
|
this.checkDoc(docArg).then(() => {
|
||||||
|
this.collection.insertOne(docArg)
|
||||||
|
.then(() => { done.resolve(); });
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* inserts many objects at once into the DbCollection
|
||||||
|
*/
|
||||||
|
insertMany(docArrayArg) {
|
||||||
|
let done = plugins.q.defer();
|
||||||
|
let checkDocPromiseArray = [];
|
||||||
|
for (let docArg of docArrayArg) {
|
||||||
|
checkDocPromiseArray.push(this.checkDoc(docArg));
|
||||||
|
}
|
||||||
|
plugins.q.all(checkDocPromiseArray).then(() => {
|
||||||
|
this.collection.insertMany(docArrayArg)
|
||||||
|
.then(() => { done.resolve(); });
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
|
}
|
||||||
|
checkDoc(doc) {
|
||||||
|
let done = plugins.q.defer();
|
||||||
|
done.resolve();
|
||||||
|
return done.promise;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
exports.DbCollection = DbCollection;
|
||||||
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRkYXRhLmNsYXNzZXMuZGJjb2xsZWN0aW9uLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRkYXRhLmNsYXNzZXMuZGJjb2xsZWN0aW9uLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxNQUFZLE9BQU8sV0FBTSxxQkFDekIsQ0FBQyxDQUQ2QztBQUc5QztJQUVJLFlBQVksT0FBZSxFQUFFLEtBQVM7UUFDbEMsSUFBSSxDQUFDLFVBQVUsR0FBRyxLQUFLLENBQUMsRUFBRSxDQUFDLFVBQVUsQ0FBQyxPQUFPLENBQUMsQ0FBQTtJQUNsRCxDQUFDO0lBRUQ7O09BRUc7SUFDSCxtQkFBbUIsQ0FBQyxPQUFPLElBQUksQ0FBQztJQUVoQzs7T0FFRztJQUNILElBQUksQ0FBQyxXQUFvQjtRQUNyQixJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBTyxDQUFBO1FBQ2pDLElBQUksQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxDQUFDLEdBQUcsRUFBRSxJQUFJO1lBQ2hELEVBQUUsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUM7Z0JBQUMsTUFBTSxHQUFHLENBQUE7WUFBQyxDQUFDO1lBQ3RCLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUE7UUFDdEIsQ0FBQyxDQUFDLENBQUE7UUFDRixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUN2QixDQUFDO0lBRUQ7O09BRUc7SUFDSCxTQUFTLENBQUMsTUFBUztRQUNmLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFRLENBQUE7UUFDbEMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsQ0FBQyxJQUFJLENBQUM7WUFDdkIsSUFBSSxDQUFDLFVBQVUsQ0FBQyxTQUFTLENBQUMsTUFBTSxDQUFDO2lCQUM1QixJQUFJLENBQUMsUUFBUSxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUEsQ0FBQyxDQUFDLENBQUMsQ0FBQTtRQUN2QyxDQUFDLENBQUMsQ0FBQTtRQUNGLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFBO0lBQ3ZCLENBQUM7SUFFRDs7T0FFRztJQUNILFVBQVUsQ0FBQyxXQUFnQjtRQUN2QixJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBUSxDQUFBO1FBQ2xDLElBQUksb0JBQW9CLEdBQThCLEVBQUUsQ0FBQTtRQUN4RCxHQUFHLENBQUMsQ0FBQyxJQUFJLE1BQU0sSUFBSSxXQUFXLENBQUMsQ0FBQSxDQUFDO1lBQzVCLG9CQUFvQixDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUE7UUFDcEQsQ0FBQztRQUNELE9BQU8sQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDLG9CQUFvQixDQUFDLENBQUMsSUFBSSxDQUFDO1lBQ3JDLElBQUksQ0FBQyxVQUFVLENBQUMsVUFBVSxDQUFDLFdBQVcsQ0FBQztpQkFDbEMsSUFBSSxDQUFDLFFBQVEsSUFBSSxDQUFDLE9BQU8sRUFBRSxDQUFBLENBQUMsQ0FBQyxDQUFDLENBQUE7UUFDdkMsQ0FBQyxDQUFDLENBQUE7UUFDRixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUN2QixDQUFDO0lBRU8sUUFBUSxDQUFDLEdBQU07UUFDbkIsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQVEsQ0FBQTtRQUNsQyxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUE7UUFDZCxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUN2QixDQUFDO0FBQ0wsQ0FBQztBQXhEWSxvQkFBWSxlQXdEeEIsQ0FBQSJ9
|
1
dist/smartdata.classes.dbdoc.js
vendored
Normal file
1
dist/smartdata.classes.dbdoc.js
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRkYXRhLmNsYXNzZXMuZGJkb2MuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGRhdGEuY2xhc3Nlcy5kYmRvYy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIn0=
|
19
docs/index.md
Normal file
19
docs/index.md
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
# smartdata
|
||||||
|
|
||||||
|
smartdata is a ODM that adheres to TypeScript practices and uses classes to organize data.
|
||||||
|
It uses MongoDB as persistent storage.
|
||||||
|
|
||||||
|
## Intention
|
||||||
|
There are many ODMs out there, however when we searched for a ODM that uses TypeScript,
|
||||||
|
acts smart while still embracing an easy the NoSQL idea we didn't find a matching solution.
|
||||||
|
This is why we started smartdata
|
||||||
|
|
||||||
|
How MongoDB terms map to smartdata classes
|
||||||
|
|
||||||
|
MongoDB term | smartdata class
|
||||||
|
--- | ---
|
||||||
|
Database | smartdata.DbConnection
|
||||||
|
Collection | smartdata.DbCollection
|
||||||
|
Document | smartdata.DbDoc
|
||||||
|
|
||||||
|
[](https://push.rocks)
|
@ -1,11 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "smartdata",
|
"name": "smartdata",
|
||||||
"version": "1.0.1",
|
"version": "1.0.13",
|
||||||
"description": "do more with data",
|
"description": "do more with data",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"typings": "dist/index.d.ts",
|
"typings": "dist/index.d.ts",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(npmts)"
|
"test": "(npm run prepareMongo && npmts)",
|
||||||
|
"prepareMongo": "(rm -rf ./test/data && mkdir ./test/data/)"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@ -30,6 +31,7 @@
|
|||||||
"@types/should": "^8.1.29",
|
"@types/should": "^8.1.29",
|
||||||
"shelljs": "^0.7.4",
|
"shelljs": "^0.7.4",
|
||||||
"should": "^11.1.0",
|
"should": "^11.1.0",
|
||||||
|
"smartstring": "^2.0.17",
|
||||||
"typings-test": "^1.0.3"
|
"typings-test": "^1.0.3"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
65
test/test.js
65
test/test.js
@ -1,30 +1,79 @@
|
|||||||
"use strict";
|
"use strict";
|
||||||
require('typings-test');
|
require('typings-test');
|
||||||
const shelljs = require('shelljs');
|
const shelljs = require('shelljs');
|
||||||
|
const should = require('should');
|
||||||
|
const smartstring = require('smartstring');
|
||||||
|
// the tested module
|
||||||
const smartdata = require('../dist/index');
|
const smartdata = require('../dist/index');
|
||||||
let mongoChildProcess;
|
let mongoChildProcess;
|
||||||
let testDbConnection;
|
let testDb;
|
||||||
|
let testDbCollection;
|
||||||
|
class testCar {
|
||||||
|
constructor(colorArg) {
|
||||||
|
this.color = colorArg;
|
||||||
|
}
|
||||||
|
}
|
||||||
describe('mongodb', function () {
|
describe('mongodb', function () {
|
||||||
it('should start mongodb', function (done) {
|
it('should start mongodb', function (done) {
|
||||||
mongoChildProcess = shelljs.exec('mongod --dbpath=./test/data --port 27017', { async: true });
|
this.timeout(30000);
|
||||||
setTimeout(() => { done(); }, 1500);
|
mongoChildProcess = shelljs.exec('mongod --dbpath=./test/data --port 27017', { async: true, silent: true });
|
||||||
|
let doneCalled = false;
|
||||||
|
mongoChildProcess.stdout.on('data', function (data) {
|
||||||
|
console.log(smartstring.indent.indentWithPrefix(data, "*** MongoDB Process *** : "));
|
||||||
|
if (!doneCalled) {
|
||||||
|
if (/waiting for connections on port 27017/.test(data)) {
|
||||||
|
doneCalled = true;
|
||||||
|
done();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
describe('smartdata', function () {
|
describe('smartdata', function () {
|
||||||
it('should establish a connection to mongodb', function (done) {
|
it('should establish a connection to mongodb', function (done) {
|
||||||
testDbConnection = new smartdata.DbConnection('mongodb://localhost:27017/smartdata');
|
testDb = new smartdata.Db('mongodb://localhost:27017/smartdata');
|
||||||
testDbConnection.connect().then(() => { done(); });
|
testDb.connect().then(() => { done(); });
|
||||||
});
|
});
|
||||||
it('should create a collection', function () {
|
it('should create a collection', function () {
|
||||||
|
testDbCollection = new smartdata.DbCollection('something', testDb);
|
||||||
|
});
|
||||||
|
it('should insert a doc into the collection', function (done) {
|
||||||
|
testDbCollection.insertOne({ value1: 'test' }).then(() => { done(); });
|
||||||
|
});
|
||||||
|
it('should find all docs of testDbCollection', function (done) {
|
||||||
|
testDbCollection.find({}).then((resultArray) => {
|
||||||
|
console.log(resultArray);
|
||||||
|
should(resultArray[0].value1).equal('test');
|
||||||
|
done();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
it('should insert many docs into the collection', function (done) {
|
||||||
|
testDbCollection.insertMany([
|
||||||
|
{ value1: 'test2' },
|
||||||
|
{ value1: 'test', value2: 3, value3: 'hi' }
|
||||||
|
]).then(() => { done(); });
|
||||||
|
});
|
||||||
|
it('should find a specified doc', function (done) {
|
||||||
|
testDbCollection.find({ 'value3': { '$exists': true } }).then((resultArray) => {
|
||||||
|
console.log(resultArray);
|
||||||
|
should(resultArray[0].value3).equal('hi');
|
||||||
|
done();
|
||||||
|
}).catch(console.log);
|
||||||
});
|
});
|
||||||
it('should close the db Connection', function () {
|
it('should close the db Connection', function () {
|
||||||
testDbConnection.close();
|
testDb.close();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
describe('mongodb', function () {
|
describe('mongodb', function () {
|
||||||
it('should kill mongodb', function () {
|
it('should kill mongodb', function (done) {
|
||||||
|
this.timeout(30000);
|
||||||
|
mongoChildProcess.stdout.on('data', function (data) {
|
||||||
|
if (/dbexit: rc: 0/.test(data)) {
|
||||||
|
done();
|
||||||
|
}
|
||||||
|
});
|
||||||
shelljs.exec('mongod --dbpath=./test/data --shutdown');
|
shelljs.exec('mongod --dbpath=./test/data --shutdown');
|
||||||
mongoChildProcess.kill('SIGTERM');
|
mongoChildProcess.kill('SIGTERM');
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FDUCxDQUFDLENBRG9CO0FBQ3JCLE1BQVksT0FBTyxXQUFNLFNBQ3pCLENBQUMsQ0FEaUM7QUFFbEMsTUFBWSxTQUFTLFdBQU0sZUFHM0IsQ0FBQyxDQUh5QztBQUcxQyxJQUFJLGlCQUFpQixDQUFBO0FBQ3JCLElBQUksZ0JBQXdDLENBQUE7QUFHNUMsUUFBUSxDQUFDLFNBQVMsRUFBQztJQUNmLEVBQUUsQ0FBQyxzQkFBc0IsRUFBQyxVQUFTLElBQUk7UUFDbkMsaUJBQWlCLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQywwQ0FBMEMsRUFBQyxFQUFDLEtBQUssRUFBRSxJQUFJLEVBQUMsQ0FBQyxDQUFBO1FBQzFGLFVBQVUsQ0FBQyxRQUFRLElBQUksRUFBRSxDQUFBLENBQUMsQ0FBQyxFQUFFLElBQUksQ0FBQyxDQUFBO0lBQ3RDLENBQUMsQ0FBQyxDQUFBO0FBQ04sQ0FBQyxDQUFDLENBQUE7QUFDRixRQUFRLENBQUMsV0FBVyxFQUFDO0lBQ2pCLEVBQUUsQ0FBQywwQ0FBMEMsRUFBQyxVQUFTLElBQUk7UUFDdkQsZ0JBQWdCLEdBQUcsSUFBSSxTQUFTLENBQUMsWUFBWSxDQUFDLHFDQUFxQyxDQUFDLENBQUE7UUFDcEYsZ0JBQWdCLENBQUMsT0FBTyxFQUFFLENBQUMsSUFBSSxDQUFDLFFBQVEsSUFBSSxFQUFFLENBQUEsQ0FBQyxDQUFDLENBQUMsQ0FBQTtJQUNyRCxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyw0QkFBNEIsRUFBQztJQUVoQyxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyxnQ0FBZ0MsRUFBQztRQUNoQyxnQkFBZ0IsQ0FBQyxLQUFLLEVBQUUsQ0FBQTtJQUM1QixDQUFDLENBQUMsQ0FBQTtBQUNOLENBQUMsQ0FBQyxDQUFBO0FBRUYsUUFBUSxDQUFDLFNBQVMsRUFBQztJQUNmLEVBQUUsQ0FBQyxxQkFBcUIsRUFBQztRQUNyQixPQUFPLENBQUMsSUFBSSxDQUFDLHdDQUF3QyxDQUFDLENBQUE7UUFDdEQsaUJBQWlCLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFBO0lBQ3JDLENBQUMsQ0FBQyxDQUFBO0FBQ04sQ0FBQyxDQUFDLENBQUEifQ==
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FFUCxDQUFDLENBRm9CO0FBRXJCLE1BQVksT0FBTyxXQUFNLFNBQ3pCLENBQUMsQ0FEaUM7QUFDbEMsTUFBWSxNQUFNLFdBQU0sUUFDeEIsQ0FBQyxDQUQrQjtBQUNoQyxNQUFZLFdBQVcsV0FBTSxhQUc3QixDQUFDLENBSHlDO0FBRTFDLG9CQUFvQjtBQUNwQixNQUFZLFNBQVMsV0FBTSxlQUUzQixDQUFDLENBRnlDO0FBRTFDLElBQUksaUJBQWlCLENBQUE7QUFDckIsSUFBSSxNQUFvQixDQUFBO0FBUXhCLElBQUksZ0JBQXNELENBQUE7QUFFMUQ7SUFFSSxZQUFZLFFBQWU7UUFDdkIsSUFBSSxDQUFDLEtBQUssR0FBRyxRQUFRLENBQUE7SUFDekIsQ0FBQztBQUNMLENBQUM7QUFHRCxRQUFRLENBQUMsU0FBUyxFQUFFO0lBQ2hCLEVBQUUsQ0FBQyxzQkFBc0IsRUFBRSxVQUFVLElBQUk7UUFDckMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQTtRQUNuQixpQkFBaUIsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLDBDQUEwQyxFQUFFLEVBQUUsS0FBSyxFQUFFLElBQUksRUFBRSxNQUFNLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQTtRQUMzRyxJQUFJLFVBQVUsR0FBRyxLQUFLLENBQUE7UUFDdEIsaUJBQWlCLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQyxNQUFNLEVBQUUsVUFBVSxJQUFJO1lBQzlDLE9BQU8sQ0FBQyxHQUFHLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQyxnQkFBZ0IsQ0FBQyxJQUFJLEVBQUUsNEJBQTRCLENBQUMsQ0FBQyxDQUFBO1lBQ3BGLEVBQUUsQ0FBQyxDQUFDLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQztnQkFDZCxFQUFFLENBQUMsQ0FBQyx1Q0FBdUMsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDO29CQUNyRCxVQUFVLEdBQUcsSUFBSSxDQUFBO29CQUNqQixJQUFJLEVBQUUsQ0FBQTtnQkFDVixDQUFDO1lBQ0wsQ0FBQztRQUNMLENBQUMsQ0FBQyxDQUFBO0lBQ04sQ0FBQyxDQUFDLENBQUE7QUFDTixDQUFDLENBQUMsQ0FBQTtBQUVGLFFBQVEsQ0FBQyxXQUFXLEVBQUU7SUFDbEIsRUFBRSxDQUFDLDBDQUEwQyxFQUFFLFVBQVUsSUFBSTtRQUN6RCxNQUFNLEdBQUcsSUFBSSxTQUFTLENBQUMsRUFBRSxDQUFDLHFDQUFxQyxDQUFDLENBQUE7UUFDaEUsTUFBTSxDQUFDLE9BQU8sRUFBRSxDQUFDLElBQUksQ0FBQyxRQUFRLElBQUksRUFBRSxDQUFBLENBQUMsQ0FBQyxDQUFDLENBQUE7SUFDM0MsQ0FBQyxDQUFDLENBQUE7SUFDRixFQUFFLENBQUMsNEJBQTRCLEVBQUU7UUFDN0IsZ0JBQWdCLEdBQUcsSUFBSSxTQUFTLENBQUMsWUFBWSxDQUFlLFdBQVcsRUFBRSxNQUFNLENBQUMsQ0FBQTtJQUNwRixDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyx5Q0FBeUMsRUFBRSxVQUFVLElBQUk7UUFDeEQsZ0JBQWdCLENBQUMsU0FBUyxDQUFDLEVBQUUsTUFBTSxFQUFFLE1BQU0sRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLFFBQVEsSUFBSSxFQUFFLENBQUEsQ0FBQyxDQUFDLENBQUMsQ0FBQTtJQUN6RSxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQywwQ0FBMEMsRUFBRSxVQUFVLElBQUk7UUFDekQsZ0JBQWdCLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLFdBQVc7WUFDdkMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxXQUFXLENBQUMsQ0FBQTtZQUN4QixNQUFNLENBQUMsV0FBVyxDQUFDLENBQUMsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsQ0FBQTtZQUMzQyxJQUFJLEVBQUUsQ0FBQTtRQUNWLENBQUMsQ0FBQyxDQUFBO0lBQ04sQ0FBQyxDQUFDLENBQUE7SUFDRixFQUFFLENBQUMsNkNBQTZDLEVBQUUsVUFBVSxJQUFJO1FBQzVELGdCQUFnQixDQUFDLFVBQVUsQ0FBQztZQUN4QixFQUFFLE1BQU0sRUFBRSxPQUFPLEVBQUU7WUFDbkIsRUFBRSxNQUFNLEVBQUUsTUFBTSxFQUFFLE1BQU0sRUFBRSxDQUFDLEVBQUUsTUFBTSxFQUFFLElBQUksRUFBRTtTQUM5QyxDQUFDLENBQUMsSUFBSSxDQUFDLFFBQVEsSUFBSSxFQUFFLENBQUEsQ0FBQyxDQUFDLENBQUMsQ0FBQTtJQUM3QixDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyw2QkFBNkIsRUFBRSxVQUFVLElBQUk7UUFDNUMsZ0JBQWdCLENBQUMsSUFBSSxDQUFDLEVBQUMsUUFBUSxFQUFFLEVBQUMsU0FBUyxFQUFFLElBQUksRUFBQyxFQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxXQUFXO1lBQ2xFLE9BQU8sQ0FBQyxHQUFHLENBQUMsV0FBVyxDQUFDLENBQUE7WUFDeEIsTUFBTSxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxNQUFNLENBQUMsQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUE7WUFDekMsSUFBSSxFQUFFLENBQUE7UUFDVixDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxDQUFBO0lBQ3pCLENBQUMsQ0FBQyxDQUFBO0lBQ0YsRUFBRSxDQUFDLGdDQUFnQyxFQUFFO1FBQ2pDLE1BQU0sQ0FBQyxLQUFLLEVBQUUsQ0FBQTtJQUNsQixDQUFDLENBQUMsQ0FBQTtBQUNOLENBQUMsQ0FBQyxDQUFBO0FBRUYsUUFBUSxDQUFDLFNBQVMsRUFBRTtJQUNoQixFQUFFLENBQUMscUJBQXFCLEVBQUUsVUFBVSxJQUFJO1FBQ3BDLElBQUksQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLENBQUE7UUFDbkIsaUJBQWlCLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQyxNQUFNLEVBQUUsVUFBVSxJQUFJO1lBQzlDLEVBQUUsQ0FBQyxDQUFDLGdCQUFnQixDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUM7Z0JBQzlCLElBQUksRUFBRSxDQUFBO1lBQ1YsQ0FBQztRQUNMLENBQUMsQ0FBQyxDQUFBO1FBQ0YsT0FBTyxDQUFDLElBQUksQ0FBQyx3Q0FBd0MsQ0FBQyxDQUFBO1FBQ3RELGlCQUFpQixDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsQ0FBQTtJQUNyQyxDQUFDLENBQUMsQ0FBQTtBQUNOLENBQUMsQ0FBQyxDQUFBIn0=
|
98
test/test.ts
98
test/test.ts
@ -1,34 +1,92 @@
|
|||||||
import 'typings-test'
|
import 'typings-test'
|
||||||
|
|
||||||
import * as shelljs from 'shelljs'
|
import * as shelljs from 'shelljs'
|
||||||
import * as should from 'should'
|
import * as should from 'should'
|
||||||
|
import * as smartstring from 'smartstring'
|
||||||
|
|
||||||
|
// the tested module
|
||||||
import * as smartdata from '../dist/index'
|
import * as smartdata from '../dist/index'
|
||||||
|
|
||||||
|
|
||||||
let mongoChildProcess
|
let mongoChildProcess
|
||||||
let testDbConnection: smartdata.DbConnection
|
let testDb: smartdata.Db
|
||||||
|
|
||||||
|
interface ITestObject1 {
|
||||||
|
value1: string
|
||||||
|
value2?: number
|
||||||
|
value3?: string
|
||||||
|
}
|
||||||
|
|
||||||
|
let testDbCollection: smartdata.DbCollection<ITestObject1>
|
||||||
|
|
||||||
|
class testCar {
|
||||||
|
color: string
|
||||||
|
constructor(colorArg:string) {
|
||||||
|
this.color = colorArg
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
describe('mongodb',function(){
|
describe('mongodb', function () {
|
||||||
it('should start mongodb',function(done){
|
it('should start mongodb', function (done) {
|
||||||
mongoChildProcess = shelljs.exec('mongod --dbpath=./test/data --port 27017',{async: true})
|
this.timeout(30000)
|
||||||
setTimeout(() => { done() }, 1500)
|
mongoChildProcess = shelljs.exec('mongod --dbpath=./test/data --port 27017', { async: true, silent: true })
|
||||||
})
|
let doneCalled = false
|
||||||
})
|
mongoChildProcess.stdout.on('data', function (data) {
|
||||||
describe('smartdata',function(){
|
console.log(smartstring.indent.indentWithPrefix(data, "*** MongoDB Process *** : "))
|
||||||
it('should establish a connection to mongodb',function(done){
|
if (!doneCalled) {
|
||||||
testDbConnection = new smartdata.DbConnection('mongodb://localhost:27017/smartdata')
|
if (/waiting for connections on port 27017/.test(data)) {
|
||||||
testDbConnection.connect().then(() => { done() })
|
doneCalled = true
|
||||||
})
|
done()
|
||||||
it('should create a collection',function(){
|
}
|
||||||
|
}
|
||||||
})
|
})
|
||||||
it('should close the db Connection',function(){
|
|
||||||
testDbConnection.close()
|
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
describe('mongodb',function(){
|
describe('smartdata', function () {
|
||||||
it('should kill mongodb',function(){
|
it('should establish a connection to mongodb', function (done) {
|
||||||
|
testDb = new smartdata.Db('mongodb://localhost:27017/smartdata')
|
||||||
|
testDb.connect().then(() => { done() })
|
||||||
|
})
|
||||||
|
it('should create a collection', function () {
|
||||||
|
testDbCollection = new smartdata.DbCollection<ITestObject1>('something', testDb)
|
||||||
|
})
|
||||||
|
it('should insert a doc into the collection', function (done) {
|
||||||
|
testDbCollection.insertOne({ value1: 'test' }).then(() => { done() })
|
||||||
|
})
|
||||||
|
it('should find all docs of testDbCollection', function (done) {
|
||||||
|
testDbCollection.find({}).then((resultArray) => {
|
||||||
|
console.log(resultArray)
|
||||||
|
should(resultArray[0].value1).equal('test')
|
||||||
|
done()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
it('should insert many docs into the collection', function (done) {
|
||||||
|
testDbCollection.insertMany([
|
||||||
|
{ value1: 'test2' },
|
||||||
|
{ value1: 'test', value2: 3, value3: 'hi' }
|
||||||
|
]).then(() => { done() })
|
||||||
|
})
|
||||||
|
it('should find a specified doc', function (done) {
|
||||||
|
testDbCollection.find({'value3': {'$exists': true}}).then((resultArray) => {
|
||||||
|
console.log(resultArray)
|
||||||
|
should(resultArray[0].value3).equal('hi')
|
||||||
|
done()
|
||||||
|
}).catch(console.log)
|
||||||
|
})
|
||||||
|
it('should close the db Connection', function () {
|
||||||
|
testDb.close()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('mongodb', function () {
|
||||||
|
it('should kill mongodb', function (done) {
|
||||||
|
this.timeout(30000)
|
||||||
|
mongoChildProcess.stdout.on('data', function (data) {
|
||||||
|
if (/dbexit: rc: 0/.test(data)) {
|
||||||
|
done()
|
||||||
|
}
|
||||||
|
})
|
||||||
shelljs.exec('mongod --dbpath=./test/data --shutdown')
|
shelljs.exec('mongod --dbpath=./test/data --shutdown')
|
||||||
mongoChildProcess.kill('SIGTERM')
|
mongoChildProcess.kill('SIGTERM')
|
||||||
})
|
})
|
||||||
|
39
ts/index.ts
39
ts/index.ts
@ -1,39 +1,4 @@
|
|||||||
import * as plugins from './smartdata.plugins'
|
import * as plugins from './smartdata.plugins'
|
||||||
|
|
||||||
export class DbCollection<T> {
|
export * from './smartdata.classes.dbcollection'
|
||||||
constructor(nameArg: string, db: plugins.mongodb.Db) {
|
export * from './smartdata.classes.db'
|
||||||
let collection = db.collection(nameArg)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export type TDbConnectionStatus = 'disconnected' | 'connected' | 'failed'
|
|
||||||
|
|
||||||
export class DbConnection {
|
|
||||||
dbUrl: string
|
|
||||||
db: plugins.mongodb.Db
|
|
||||||
status: TDbConnectionStatus
|
|
||||||
|
|
||||||
constructor(dbUrl: string) {
|
|
||||||
this.dbUrl = dbUrl
|
|
||||||
}
|
|
||||||
|
|
||||||
connect(): plugins.q.Promise<any> {
|
|
||||||
let done = plugins.q.defer()
|
|
||||||
plugins.mongodb.MongoClient.connect(this.dbUrl, (err, db) => {
|
|
||||||
if (err) { console.log(err) }
|
|
||||||
plugins.assert.equal(null, err)
|
|
||||||
this.db = db
|
|
||||||
plugins.beautylog.success(`connected to database at ${this.dbUrl}`)
|
|
||||||
done.resolve(this.db)
|
|
||||||
})
|
|
||||||
return done.promise
|
|
||||||
}
|
|
||||||
|
|
||||||
close(): plugins.q.Promise<any> {
|
|
||||||
let done = plugins.q.defer()
|
|
||||||
this.db.close()
|
|
||||||
plugins.beautylog.ok(`disconnected to database at ${this.dbUrl}`)
|
|
||||||
done.resolve()
|
|
||||||
return done.promise
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
33
ts/smartdata.classes.db.ts
Normal file
33
ts/smartdata.classes.db.ts
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
import * as plugins from './smartdata.plugins'
|
||||||
|
|
||||||
|
export type TConnectionStatus = 'disconnected' | 'connected' | 'failed'
|
||||||
|
|
||||||
|
export class Db {
|
||||||
|
dbUrl: string
|
||||||
|
db: plugins.mongodb.Db
|
||||||
|
status: TConnectionStatus
|
||||||
|
|
||||||
|
constructor(dbUrl: string) {
|
||||||
|
this.dbUrl = dbUrl
|
||||||
|
}
|
||||||
|
|
||||||
|
connect(): plugins.q.Promise<any> {
|
||||||
|
let done = plugins.q.defer()
|
||||||
|
plugins.mongodb.MongoClient.connect(this.dbUrl, (err, db) => {
|
||||||
|
if (err) { console.log(err) }
|
||||||
|
plugins.assert.equal(null, err)
|
||||||
|
this.db = db
|
||||||
|
plugins.beautylog.success(`connected to database at ${this.dbUrl}`)
|
||||||
|
done.resolve(this.db)
|
||||||
|
})
|
||||||
|
return done.promise
|
||||||
|
}
|
||||||
|
|
||||||
|
close(): plugins.q.Promise<any> {
|
||||||
|
let done = plugins.q.defer()
|
||||||
|
this.db.close()
|
||||||
|
plugins.beautylog.ok(`disconnected to database at ${this.dbUrl}`)
|
||||||
|
done.resolve()
|
||||||
|
return done.promise
|
||||||
|
}
|
||||||
|
}
|
60
ts/smartdata.classes.dbcollection.ts
Normal file
60
ts/smartdata.classes.dbcollection.ts
Normal file
@ -0,0 +1,60 @@
|
|||||||
|
import * as plugins from './smartdata.plugins'
|
||||||
|
import { Db } from './smartdata.classes.db'
|
||||||
|
|
||||||
|
export class DbCollection<T> {
|
||||||
|
collection: plugins.mongodb.Collection
|
||||||
|
constructor(nameArg: string, dbArg: Db) {
|
||||||
|
this.collection = dbArg.db.collection(nameArg)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* adds a validation function that all newly inserted and updated objects have to pass
|
||||||
|
*/
|
||||||
|
addObjectValidation(funcArg) { }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* finds an object in the DbCollection
|
||||||
|
*/
|
||||||
|
find(docMatchArg: T | any): plugins.q.Promise<T[]> {
|
||||||
|
let done = plugins.q.defer<T[]>()
|
||||||
|
this.collection.find(docMatchArg).toArray((err, docs) => {
|
||||||
|
if (err) { throw err }
|
||||||
|
done.resolve(docs)
|
||||||
|
})
|
||||||
|
return done.promise
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* inserts object into the DbCollection
|
||||||
|
*/
|
||||||
|
insertOne(docArg: T): plugins.q.Promise<void> {
|
||||||
|
let done = plugins.q.defer<void>()
|
||||||
|
this.checkDoc(docArg).then(() => {
|
||||||
|
this.collection.insertOne(docArg)
|
||||||
|
.then(() => { done.resolve() })
|
||||||
|
})
|
||||||
|
return done.promise
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* inserts many objects at once into the DbCollection
|
||||||
|
*/
|
||||||
|
insertMany(docArrayArg: T[]): plugins.q.Promise<void> {
|
||||||
|
let done = plugins.q.defer<void>()
|
||||||
|
let checkDocPromiseArray: plugins.q.Promise<void>[] = []
|
||||||
|
for (let docArg of docArrayArg){
|
||||||
|
checkDocPromiseArray.push(this.checkDoc(docArg))
|
||||||
|
}
|
||||||
|
plugins.q.all(checkDocPromiseArray).then(() => {
|
||||||
|
this.collection.insertMany(docArrayArg)
|
||||||
|
.then(() => { done.resolve() })
|
||||||
|
})
|
||||||
|
return done.promise
|
||||||
|
}
|
||||||
|
|
||||||
|
private checkDoc(doc: T): plugins.q.Promise<void> {
|
||||||
|
let done = plugins.q.defer<void>()
|
||||||
|
done.resolve()
|
||||||
|
return done.promise
|
||||||
|
}
|
||||||
|
}
|
0
ts/smartdata.classes.dbdoc.ts
Normal file
0
ts/smartdata.classes.dbdoc.ts
Normal file
Reference in New Issue
Block a user