3.0.2

.gitignore

@@ -1,5 +1,4 @@
 node_modules/
-test/data
-pages/
-coverage/
 public/
+coverage/
+.nogit/

.gitlab-ci.yml

@@ -1,43 +1,141 @@
-image: hosttoday/ht-docker-node:npmts
+# gitzone standard
+image: hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+  - .npmci_cache/
+  key: "$CI_BUILD_STAGE"
 
 stages:
+- security
 - test
 - release
+- metadata
 
-before_script:
-  - apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv EA312927
-  - echo "deb http://repo.mongodb.org/apt/ubuntu xenial/mongodb-org/3.2 multiverse" | tee /etc/apt/sources.list.d/mongodb-org-3.2.list
-  - apt-get update
-  - apt-get install -y mongodb-org
+# ====================
+# security stage
+# ====================
+mirror:
+  stage: security
+  script:
+  - npmci git mirror
+  tags:
+  - docker
+  - notpriv
 
+snyk:
+  stage: security
+  script:
+    - npmci command npm install -g snyk
+    - npmci command npm install --ignore-scripts
+    - npmci command snyk test
+  tags:
+  - docker
+  - notpriv
+
+# ====================
+# test stage
+# ====================
 testLEGACY:
   stage: test
   script:
-    - npmci test legacy
+  - npmci node install legacy
+  - npmci npm install
+  - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - docker
+  - docker
+  - notpriv
   allow_failure: true
 
 testLTS:
   stage: test
   script:
-    - npmci test lts
+  - npmci node install lts
+  - npmci npm install
+  - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - docker
+  - docker
+  - notpriv
     
 testSTABLE:
   stage: test
   script:
-    - npmci test stable
+  - npmci node install stable
+  - npmci npm install
+  - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - docker
+  - docker
+  - notpriv
 
 release:
   stage: release
-  environment: npm_registry
   script:
-    - npmci publish
+  - npmci node install stable
+  - npmci npm publish
+  only:
+  - tags
+  tags:
+  - docker
+  - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  image: docker:stable
+  allow_failure: true
+  services:
+    - docker:stable-dind
+  script:
+    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - docker run
+        --env SOURCE_CODE="$PWD"
+        --volume "$PWD":/code
+        --volume /var/run/docker.sock:/var/run/docker.sock
+        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
+  artifacts:
+    paths: [codeclimate.json]
+  tags:
+  - docker
+  - priv
+
+trigger:
+  stage: metadata
+  script:
+  - npmci trigger
+  only:
+  - tags
+  tags:
+  - docker
+  - notpriv
+
+pages:
+  image: hosttoday/ht-docker-node:npmci
+  stage: metadata
+  script:
+    - npmci command npm install -g npmpage
+    - npmci command npmpage
+  tags:
+    - docker
+    - notpriv
   only:
     - tags
+  artifacts:
+    expire_in: 1 week
+    paths:
+    - public
+  allow_failure: true
+
+windowsCompatibility:
+  image: stefanscherer/node-windows:10-build-tools
+  stage: metadata
+  script:
+  - npm install & npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - docker
+  - windows
+  allow_failure: true

README.md

@@ -0,0 +1,129 @@
+# @pushrocks/smartdata
+
+do more with data and RethinkDB
+
+## Availabililty
+
+[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartdata)
+[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartdata)
+[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartdata)
+[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartdata/)
+
+## Status for master
+
+[![build status](https://GitLab.com/pushrocks/smartdata/badges/master/build.svg)](https://GitLab.com/pushrocks/smartdata/commits/master)
+[![coverage report](https://GitLab.com/pushrocks/smartdata/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartdata/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/smartdata.svg)](https://www.npmjs.com/package/smartdata)
+[![Dependency Status](https://david-dm.org/pushrocks/smartdata.svg)](https://david-dm.org/pushrocks/smartdata)
+[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartdata/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartdata/master/dependencies/npm)
+[![bitHound Code](https://www.bithound.io/github/pushrocks/smartdata/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartdata)
+[![Known Vulnerabilities](https://snyk.io/test/npm/smartdata/badge.svg)](https://snyk.io/test/npm/smartdata)
+[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
+
+## Usage
+
+Use TypeScript for best in class instellisense.
+
+smartdata is an ODM that adheres to TypeScript practices and uses classes to organize data.
+It uses RethinkDB as persistent storage.
+
+## Intention
+
+There are many ODMs out there, however when we searched for an ODM that uses TypeScript,
+acts smart while still embracing the NoSQL idea we didn't find a matching solution.
+This is why we started smartdata.
+
+How RethinkDB's terms map to the ones of smartdata:
+
+| MongoDb term   | smartdata class               |
+| -------------- | ------------------------------|
+| Database       | smartdata.SmartdataDb         |
+| Collection     | smartdata.SmartdataCollection |
+| Document       | smartdata.SmartadataDoc       |
+
+### class Db
+
+represents a Database. Naturally it has .connect() etc. methods on it.
+
+```typescript
+import * as smartdata from 'smartdata';
+
+const smartdataDb = new smartdata.SmartdataDb({
+  mongoDbUrl: '//someurl',
+  mongoDbName: 'myDatabase',
+  mongoDbPass: 'mypassword'
+});
+
+smartdataDb.connect();
+```
+
+### 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...
+
+@smartdata.Collection(smartdataDb)
+class MyObject extends smartdata.DbDoc<MyObject> {
+  // read the next block about DbDoc
+  @smartdata.svDb() property1: string; // @smartdata.svDb() marks the property for db save
+  property2: number; // this one is not marked, so it won't be save upon calling this.save()
+  constructor(optionsArg: { property1: string; property2: number }) {
+    super();
+  }
+}
+
+// start to instantiate instances of classes from scratch or database
+
+let localObject = new MyObject({
+  property1: 'hi',
+  property2: 2
+});
+localObject.save(); // saves the object to the database
+
+// start retrieving instances
+
+MyObject.getInstance<MyObject>({
+  property: 'hi'
+}); // outputs a new instance of MyObject with the values from db assigned
+```
+
+### class DbDoc
+
+represents a individual document in a collection
+and thereby is ideally suited to extend the class you want to actually store.
+
+**sStore** instances of classes to Db:
+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
+
+**Get** a new class instance from a Doc in the DB:
+DbDoc exposes a static method that allows you specify a filter to retrieve a cloned class of the one you used to that doc at some point later in time. Yes, let that sink in a minute :)
+
+So you can just call `.getInstance({ /* filter props here */ })`.
+
+## TypeScript
+
+How does TypeScript play into this?
+Since you define your classes in TypeScript 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 when importing smartdata.
+
+For further information read the linked docs at the top of this README.
+
+> MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
+> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+
+[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)

dist/index.d.ts

@@ -1,14 +0,0 @@
-/// <reference types="q" />
-import * as plugins from './smartdata.plugins';
-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>;
-}

dist/index.js

@@ -1,35 +0,0 @@
-"use strict";
-const plugins = require('./smartdata.plugins');
-class DbCollection {
-    constructor(nameArg, db) {
-        let collection = db.collection(nameArg);
-    }
-}
-exports.DbCollection = DbCollection;
-class DbConnection {
-    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.DbConnection = DbConnection;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsTUFBWSxPQUFPLFdBQU0scUJBRXpCLENBQUMsQ0FGNkM7QUFFOUM7SUFDSSxZQUFZLE9BQWUsRUFBRSxFQUFzQjtRQUMvQyxJQUFJLFVBQVUsR0FBRyxFQUFFLENBQUMsVUFBVSxDQUFDLE9BQU8sQ0FBQyxDQUFBO0lBQzNDLENBQUM7QUFDTCxDQUFDO0FBSlksb0JBQVksZUFJeEIsQ0FBQTtBQUlEO0lBS0ksWUFBWSxLQUFhO1FBQ3JCLElBQUksQ0FBQyxLQUFLLEdBQUcsS0FBSyxDQUFBO0lBQ3RCLENBQUM7SUFFRCxPQUFPO1FBQ0gsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQTtRQUM1QixPQUFPLENBQUMsT0FBTyxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDLEdBQUcsRUFBRSxFQUFFO1lBQ3BELEVBQUUsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUM7Z0JBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQTtZQUFDLENBQUM7WUFDN0IsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFBO1lBQy9CLElBQUksQ0FBQyxFQUFFLEdBQUcsRUFBRSxDQUFBO1lBQ1osT0FBTyxDQUFDLFNBQVMsQ0FBQyxPQUFPLENBQUMsNEJBQTRCLElBQUksQ0FBQyxLQUFLLEVBQUUsQ0FBQyxDQUFBO1lBQ25FLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFBO1FBQ3pCLENBQUMsQ0FBQyxDQUFBO1FBQ0YsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUE7SUFDdkIsQ0FBQztJQUVELEtBQUs7UUFDRCxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFBO1FBQzVCLElBQUksQ0FBQyxFQUFFLENBQUMsS0FBSyxFQUFFLENBQUE7UUFDZixPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQywrQkFBK0IsSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDLENBQUE7UUFDakUsSUFBSSxDQUFDLE9BQU8sRUFBRSxDQUFBO1FBQ2QsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUE7SUFDdkIsQ0FBQztBQUNMLENBQUM7QUE1Qlksb0JBQVksZUE0QnhCLENBQUEifQ==

dist/smartdata.plugins.d.ts

@@ -1,5 +0,0 @@
-import 'typings-global';
-export import assert = require('assert');
-export import beautylog = require('beautylog');
-export import mongodb = require('mongodb');
-export import q = require('q');

dist/smartdata.plugins.js

@@ -1,7 +0,0 @@
-"use strict";
-require('typings-global');
-exports.assert = require('assert');
-exports.beautylog = require('beautylog');
-exports.mongodb = require('mongodb');
-exports.q = require('q');
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRkYXRhLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGRhdGEucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsUUFBTyxnQkFDUCxDQUFDLENBRHNCO0FBQ1QsY0FBTSxXQUFXLFFBQVEsQ0FBQyxDQUFBO0FBQzFCLGlCQUFTLFdBQVcsV0FBVyxDQUFDLENBQUE7QUFDaEMsZUFBTyxXQUFXLFNBQVMsQ0FBQyxDQUFBO0FBQzVCLFNBQUMsV0FBVyxHQUFHLENBQUMsQ0FBQSJ9

docs/index.md

@@ -0,0 +1,29 @@
+# smartdata
+
+do more with data
+
+## Availabililty
+
+[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartdata)
+[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartdata)
+[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartdata)
+[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartdata/)
+
+## Status for master
+
+[![build status](https://GitLab.com/pushrocks/smartdata/badges/master/build.svg)](https://GitLab.com/pushrocks/smartdata/commits/master)
+[![coverage report](https://GitLab.com/pushrocks/smartdata/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartdata/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/smartdata.svg)](https://www.npmjs.com/package/smartdata)
+[![Dependency Status](https://david-dm.org/pushrocks/smartdata.svg)](https://david-dm.org/pushrocks/smartdata)
+[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartdata/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartdata/master/dependencies/npm)
+[![bitHound Code](https://www.bithound.io/github/pushrocks/smartdata/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartdata)
+[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
+
+For further information read the linked docs at the top of this README.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+
+[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)

npmextra.json

@@ -0,0 +1,18 @@
+{
+  "npmdocker": {
+    "baseImage": "hosttoday/ht-docker-node:mongo",
+    "command": "npmci test stable",
+    "dockerSock": false
+  },
+  "npmci": {
+    "npmGlobalTools": [
+      "npmts"
+    ],
+    "npmAccessLevel": "public"
+  },
+  "npmts": {
+    "testConfig": {
+      "parallel": false
+    }
+  }
+}

package.json

@@ -1,11 +1,14 @@
 {
-  "name": "smartdata",
-  "version": "1.0.2",
+  "name": "@pushrocks/smartdata",
+  "version": "3.0.2",
+  "private": false,
   "description": "do more with data",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "(npmts)"
+    "test": "tsrun test/test.ts",
+    "testLocal": "(npmdocker)",
+    "build": "(npmts)"
   },
   "repository": {
     "type": "git",
@@ -18,18 +21,20 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartdata#README",
   "dependencies": {
-    "@types/mongodb": "^2.1.32",
-    "@types/q": "0.0.30",
-    "beautylog": "^5.0.23",
-    "mongodb": "^2.2.9",
-    "q": "^1.4.1",
-    "typings-global": "^1.0.14"
+    "@pushrocks/smartlog": "^1.0.6",
+    "@pushrocks/smartpromise": "^2.0.5",
+    "@types/lodash": "^4.14.110",
+    "@types/mongodb": "^3.1.1",
+    "lik": "^2.0.5",
+    "lodash": "^4.17.10",
+    "mongodb": "^3.1.1",
+    "runtime-type-checks": "0.0.4",
+    "smartstring": "^2.0.28"
   },
   "devDependencies": {
-    "@types/shelljs": "^0.3.30",
-    "@types/should": "^8.1.29",
-    "shelljs": "^0.7.4",
-    "should": "^11.1.0",
-    "typings-test": "^1.0.3"
+    "@gitzone/tsrun": "^1.1.2",
+    "@types/node": "^10.5.2",
+    "qenv": "^1.1.7",
+    "tapbundle": "^2.0.2"
   }
 }

qenv.yml

@@ -0,0 +1,4 @@
+vars:
+  - MONGO_URL
+  - MONGO_DBNAME
+  - MONGO_PASS

test/test.d.ts

@@ -1 +0,0 @@
-import 'typings-test';

test/test.js

@@ -1,31 +0,0 @@
-"use strict";
-require('typings-test');
-const shelljs = require('shelljs');
-const smartdata = require('../dist/index');
-let mongoChildProcess;
-let testDbConnection;
-describe('mongodb', function () {
-    it('should start mongodb', function (done) {
-        this.timeout(10000);
-        mongoChildProcess = shelljs.exec('mongod --dbpath=./test/data --port 27017', { async: true });
-        setTimeout(() => { done(); }, 5000); // give mongodb it some time to complete startup
-    });
-});
-describe('smartdata', function () {
-    it('should establish a connection to mongodb', function (done) {
-        testDbConnection = new smartdata.DbConnection('mongodb://localhost:27017/smartdata');
-        testDbConnection.connect().then(() => { done(); });
-    });
-    it('should create a collection', function () {
-    });
-    it('should close the db Connection', function () {
-        testDbConnection.close();
-    });
-});
-describe('mongodb', function () {
-    it('should kill mongodb', function () {
-        shelljs.exec('mongod --dbpath=./test/data --shutdown');
-        mongoChildProcess.kill('SIGTERM');
-    });
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FDUCxDQUFDLENBRG9CO0FBQ3JCLE1BQVksT0FBTyxXQUFNLFNBQ3pCLENBQUMsQ0FEaUM7QUFFbEMsTUFBWSxTQUFTLFdBQU0sZUFHM0IsQ0FBQyxDQUh5QztBQUcxQyxJQUFJLGlCQUFpQixDQUFBO0FBQ3JCLElBQUksZ0JBQXdDLENBQUE7QUFHNUMsUUFBUSxDQUFDLFNBQVMsRUFBQztJQUNmLEVBQUUsQ0FBQyxzQkFBc0IsRUFBQyxVQUFTLElBQUk7UUFDbkMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQTtRQUNuQixpQkFBaUIsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLDBDQUEwQyxFQUFDLEVBQUMsS0FBSyxFQUFFLElBQUksRUFBQyxDQUFDLENBQUE7UUFDMUYsVUFBVSxDQUFDLFFBQVEsSUFBSSxFQUFFLENBQUEsQ0FBQyxDQUFDLEVBQUUsSUFBSSxDQUFDLENBQUEsQ0FBQyxnREFBZ0Q7SUFDdkYsQ0FBQyxDQUFDLENBQUE7QUFDTixDQUFDLENBQUMsQ0FBQTtBQUNGLFFBQVEsQ0FBQyxXQUFXLEVBQUM7SUFDakIsRUFBRSxDQUFDLDBDQUEwQyxFQUFDLFVBQVMsSUFBSTtRQUN2RCxnQkFBZ0IsR0FBRyxJQUFJLFNBQVMsQ0FBQyxZQUFZLENBQUMscUNBQXFDLENBQUMsQ0FBQTtRQUNwRixnQkFBZ0IsQ0FBQyxPQUFPLEVBQUUsQ0FBQyxJQUFJLENBQUMsUUFBUSxJQUFJLEVBQUUsQ0FBQSxDQUFDLENBQUMsQ0FBQyxDQUFBO0lBQ3JELENBQUMsQ0FBQyxDQUFBO0lBQ0YsRUFBRSxDQUFDLDRCQUE0QixFQUFDO0lBRWhDLENBQUMsQ0FBQyxDQUFBO0lBQ0YsRUFBRSxDQUFDLGdDQUFnQyxFQUFDO1FBQ2hDLGdCQUFnQixDQUFDLEtBQUssRUFBRSxDQUFBO0lBQzVCLENBQUMsQ0FBQyxDQUFBO0FBQ04sQ0FBQyxDQUFDLENBQUE7QUFFRixRQUFRLENBQUMsU0FBUyxFQUFDO0lBQ2YsRUFBRSxDQUFDLHFCQUFxQixFQUFDO1FBQ3JCLE9BQU8sQ0FBQyxJQUFJLENBQUMsd0NBQXdDLENBQUMsQ0FBQTtRQUN0RCxpQkFBaUIsQ0FBQyxJQUFJLENBQUMsU0FBUyxDQUFDLENBQUE7SUFDckMsQ0FBQyxDQUFDLENBQUE7QUFDTixDQUFDLENBQUMsQ0FBQSJ9

test/test.ts

@@ -1,36 +1,63 @@
-import 'typings-test'
-import * as shelljs from 'shelljs'
-import * as should from 'should'
-import * as smartdata from '../dist/index'
+import { tap, expect } from 'tapbundle';
+import * as smartpromise from '@pushrocks/smartpromise';
+import { Qenv } from 'qenv';
 
+let testQenv = new Qenv(process.cwd(), process.cwd() + '/.nogit/');
 
-let mongoChildProcess
-let testDbConnection: smartdata.DbConnection
+// the tested module
+import * as smartdata from '../ts';
+import { smartstring } from '../ts/smartdata.plugins';
 
+// =======================================
+// Connecting to the database server
+// =======================================
 
-describe('mongodb',function(){
-    it('should start mongodb',function(done){
-        this.timeout(10000)
-        mongoChildProcess = shelljs.exec('mongod --dbpath=./test/data --port 27017',{async: true})
-        setTimeout(() => { done() }, 5000) // give mongodb it some time to complete startup
-    })
-})
-describe('smartdata',function(){
-    it('should establish a connection to mongodb',function(done){
-        testDbConnection = new smartdata.DbConnection('mongodb://localhost:27017/smartdata')
-        testDbConnection.connect().then(() => { done() })
-    })
-    it('should create a collection',function(){
+let testDb = new smartdata.SmartdataDb({
+  mongoDbName: process.env.MONGO_DBNAME,
+  mongoDbUrl: process.env.MONGO_URL,
+  mongoDbPass: process.env.MONGO_PASS
+});
 
-    })
-    it('should close the db Connection',function(){
-        testDbConnection.close()
-    })
-})
+tap.test('should establish a connection to the rethink Db cluster', async () => {
+  await testDb.connect();
+});
 
-describe('mongodb',function(){
-    it('should kill mongodb',function(){
-        shelljs.exec('mongod --dbpath=./test/data --shutdown')
-        mongoChildProcess.kill('SIGTERM')
-    })
-})
+// =======================================
+// The actual tests
+// =======================================
+
+// ------
+// Collections
+// ------
+
+@smartdata.Collection(testDb)
+class Car extends smartdata.SmartDataDbDoc<Car> {
+  @smartdata.svDb() color: string;
+  @smartdata.svDb() brand: string;
+  constructor(colorArg: string, brandArg: string) {
+    super();
+    this.color = colorArg;
+    this.brand = brandArg;
+  }
+}
+
+tap.test('should save the car to the db', async () => {
+  const myCar = new Car('red', 'Volvo');
+  await myCar.save();
+});
+
+tap.test('expect to get instance of Car', async () => {
+  let myCars = await Car.getInstances<Car>({
+    brand: 'Volvo'
+  });
+  expect(myCars[0].color).to.equal('red');
+});
+
+// =======================================
+// close the database connection
+// =======================================
+tap.test('should close the database connection', async tools => {
+  await testDb.close();
+});
+
+tap.start();

ts/index.ts

@@ -1,39 +1,3 @@
-import * as plugins from './smartdata.plugins'
-
-export class DbCollection<T> {
-    constructor(nameArg: string, db: plugins.mongodb.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
-    }
-}
+export * from './smartdata.classes.db';
+export * from './smartdata.classes.collection';
+export * from './smartdata.classes.doc';

ts/smartdata.classes.collection.ts

@@ -0,0 +1,117 @@
+import * as plugins from './smartdata.plugins';
+import { SmartdataDb } from './smartdata.classes.db';
+import { SmartDataDbDoc } from './smartdata.classes.doc';
+
+export interface IFindOptions {
+  limit?: number;
+}
+
+/**
+ *
+ */
+export interface IDocValidationFunc<T> {
+  (doc: T): boolean;
+}
+
+/**
+ * This is a decorator that will tell the decorated class what dbTable to use
+ * @param db
+ */
+export function Collection(db: SmartdataDb) {
+  return function(constructor) {
+    constructor['smartdataCollection'] = new SmartdataCollection(constructor, db);
+  };
+}
+
+export class SmartdataCollection<T> {
+  /**
+   * the collection that is used
+   */
+  mongoDbCollection: plugins.mongodb.Collection;
+  objectValidation: IDocValidationFunc<T> = null;
+  collectionName: string;
+  smartdataDb: SmartdataDb;
+
+  constructor(collectedClassArg: T & SmartDataDbDoc<T>, smartDataDbArg: SmartdataDb) {
+    // tell the collection where it belongs
+    this.collectionName = collectedClassArg.name;
+    this.smartdataDb = smartDataDbArg;
+
+    // tell the db class about it (important since Db uses different systems under the hood)
+    this.smartdataDb.addTable(this);
+  }
+
+  /**
+   * makes sure a collection exists within MongoDb that maps to the SmartdataCollection
+   */
+  async init() {
+    if (!this.mongoDbCollection) {
+      // connect this instance to a MongoDB collection
+      const availableMongoDbCollections = await this.smartdataDb.mongoDb.collections();
+      const wantedCollection = availableMongoDbCollections.find(collection => {
+        return collection.collectionName === this.collectionName;
+      });
+      if (!wantedCollection) {
+        await this.smartdataDb.mongoDb.createCollection(this.collectionName);
+      }
+      this.mongoDbCollection = await this.smartdataDb.mongoDb.collection(this.collectionName);
+      console.log(`Successfully initiated Collection ${this.collectionName}`)
+    }
+  }
+
+  /**
+   * adds a validation function that all newly inserted and updated objects have to pass
+   */
+  addDocValidation(funcArg: IDocValidationFunc<T>) {
+    this.objectValidation = funcArg;
+  }
+
+  /**
+   * finds an object in the DbCollection
+   */
+  async find(filterObject: any): Promise<any> {
+    await this.init();
+    const result = await this.mongoDbCollection.find(filterObject).toArray();
+    return result;
+  }
+
+  /**
+   * create an object in the database
+   */
+  async insert(dbDocArg: T & SmartDataDbDoc<T>): Promise<any> {
+    await this.init();
+    await this.checkDoc(dbDocArg);
+    const saveableObject = await dbDocArg.createSavableObject();
+    console.log(saveableObject);
+    const result = await this.mongoDbCollection.insertOne(saveableObject);
+    return result;
+  }
+
+  /**
+   * inserts object into the DbCollection
+   */
+  async update(dbDocArg: T & SmartDataDbDoc<T>): Promise<any> {
+    await this.init();
+    await this.checkDoc(dbDocArg);
+    const saveableObject = await dbDocArg.createSavableObject();
+    this.mongoDbCollection.updateOne(saveableObject.dbDocUniqueId, saveableObject);
+  }
+
+  /**
+   * checks a Doc for constraints
+   * if this.objectValidation is not set it passes.
+   */
+  private checkDoc(docArg: T): Promise<void> {
+    let done = plugins.smartq.defer<void>();
+    let validationResult = true;
+    if (this.objectValidation) {
+      validationResult = this.objectValidation(docArg);
+    }
+    if (validationResult) {
+      done.resolve();
+    } else {
+      done.reject('validation of object did not pass');
+    }
+    return done.promise;
+  }
+}

ts/smartdata.classes.db.ts

@@ -0,0 +1,95 @@
+import * as plugins from './smartdata.plugins';
+import { Objectmap } from 'lik';
+
+import { SmartdataCollection } from './smartdata.classes.collection';
+
+import * as mongoHelpers from './smartdata.mongohelpers';
+
+/**
+ * interface - indicates the connection status of the db
+ */
+export type TConnectionStatus = 'initial' | 'disconnected' | 'connected' | 'failed';
+
+export interface ISmartdataOptions {
+  /**
+   * the URL to connect to
+   */
+  mongoDbUrl: string;
+
+  /**
+   * the db to use for the project
+   */
+  mongoDbName: string;
+
+  /**
+   * an optional password that will be replace <PASSWORD> in the connection string
+   */
+  mongoDbPass?: string;
+}
+
+export class SmartdataDb {
+  smartdataOptions: ISmartdataOptions;
+  mongoDbClient: plugins.mongodb.MongoClient;
+  mongoDb: plugins.mongodb.Db;
+  status: TConnectionStatus;
+  smartdataCollectionMap = new Objectmap<SmartdataCollection<any>>();
+
+  constructor(smartdataOptions: ISmartdataOptions) {
+    this.smartdataOptions = smartdataOptions;
+    this.status = 'initial';
+  }
+
+  // basic connection stuff ----------------------------------------------
+
+  /**
+   * connects to the database that was specified during instance creation
+   */
+  async connect(): Promise<any> {
+    let finalConnectionUrl = this.smartdataOptions.mongoDbUrl;
+    if (this.smartdataOptions.mongoDbPass) {
+      finalConnectionUrl = mongoHelpers.addPassword(
+        this.smartdataOptions.mongoDbUrl,
+        this.smartdataOptions.mongoDbPass
+      );
+    }
+    console.log(finalConnectionUrl);
+    this.mongoDbClient = await plugins.mongodb.MongoClient.connect(
+      finalConnectionUrl,
+      {
+        useNewUrlParser: true
+      }
+    );
+    this.mongoDb = this.mongoDbClient.db(this.smartdataOptions.mongoDbName);
+    this.status = 'connected';
+    console.log(`Connected to database ${this.smartdataOptions.mongoDbName}`);
+  }
+
+  /**
+   * closes the connection to the databse
+   */
+  async close(): Promise<any> {
+    await this.mongoDbClient.close();
+    this.status = 'disconnected';
+    plugins.smartlog
+      .getDefaultLogger()
+      .info(`disconnected from database ${this.smartdataOptions.mongoDbName}`);
+  }
+
+  // handle table to class distribution
+
+  addTable(SmartdataCollectionArg: SmartdataCollection<any>) {
+    this.smartdataCollectionMap.add(SmartdataCollectionArg);
+  }
+
+  /**
+   * Gets a collection's name and returns a SmartdataCollection instance
+   * @param nameArg
+   * @returns DbTable
+   */
+  async getSmartdataCollectionByName<T>(nameArg: string): Promise<SmartdataCollection<T>> {
+    let resultCollection = this.smartdataCollectionMap.find(dbTableArg => {
+      return dbTableArg.collectionName === nameArg;
+    });
+    return resultCollection;
+  }
+}

ts/smartdata.classes.doc.ts

@@ -0,0 +1,125 @@
+import * as plugins from './smartdata.plugins';
+
+import { Objectmap } from 'lik';
+
+import { SmartdataDb } from './smartdata.classes.db';
+import { SmartdataCollection } from './smartdata.classes.collection';
+
+export type TDocCreation = 'db' | 'new' | 'mixed';
+
+/**
+ * saveable - saveable decorator to be used on class properties
+ */
+export function svDb() {
+  return (target: SmartDataDbDoc<any>, key: string) => {
+    console.log('called sva');
+    if (!target.saveableProperties) {
+      target.saveableProperties = [];
+    }
+    target.saveableProperties.push(key);
+  };
+}
+
+export class SmartDataDbDoc<T> {
+  /**
+   * the collection object an Doc belongs to
+   */
+  collection: SmartdataCollection<T>;
+
+  /**
+   * how the Doc in memory was created, may prove useful later.
+   */
+  creationStatus: TDocCreation = 'new';
+
+  /**
+   * an array of saveable properties of a doc
+   */
+  saveableProperties: string[];
+
+  /**
+   * name
+   */
+  name: string;
+
+  /**
+   * primary id in the database
+   */
+  dbDocUniqueId: string;
+
+  /**
+   * class constructor
+   */
+  constructor() {
+    this.name = this.constructor['name'];
+    this.collection = this.constructor['smartdataCollection'];
+  }
+
+  static async getInstances<T>(filterArg): Promise<T[]> {
+    let self: any = this; // fool typesystem
+    let referenceMongoDBCollection: SmartdataCollection<T> = self.smartdataCollection;
+    const foundDocs = await referenceMongoDBCollection.find(filterArg);
+    const returnArray = [];
+    for (let item of foundDocs) {
+      let newInstance = new this();
+      for (let key in item) {
+        if (key !== 'id') {
+          newInstance[key] = item[key];
+        }
+      }
+      returnArray.push(newInstance);
+    }
+    return returnArray;
+  }
+
+  static async getInstance<T>(filterArg): Promise<T> {
+    let result = await this.getInstances<T>(filterArg);
+    if (result && result.length > 0) {
+      return result[0];
+    }
+  }
+
+  /**
+   * saves this instance but not any connected items
+   * may lead to data inconsistencies, but is faster
+   */
+  async save() {
+    let self: any = this;
+    switch (this.creationStatus) {
+      case 'db':
+        await this.collection.update(self);
+        break;
+      case 'new':
+        let writeResult = await this.collection.insert(self);
+        this.creationStatus = 'db';
+        break;
+      default:
+        console.error('neither new nor in db?');
+    }
+  }
+
+  /**
+   * also store any referenced objects to DB
+   * better for data consistency
+   */
+  saveDeep(savedMapArg: Objectmap<SmartDataDbDoc<any>> = null) {
+    if (!savedMapArg) {
+      savedMapArg = new Objectmap<SmartDataDbDoc<any>>();
+    }
+    savedMapArg.add(this);
+    this.save();
+    for (let propertyKey in this) {
+      let property: any = this[propertyKey];
+      if (property instanceof SmartDataDbDoc && !savedMapArg.checkForObject(property)) {
+        property.saveDeep(savedMapArg);
+      }
+    }
+  }
+
+  async createSavableObject() {
+    let saveableObject: any = {}; // is not exposed to outside, so any is ok here
+    for (let propertyNameString of this.saveableProperties) {
+      saveableObject[propertyNameString] = this[propertyNameString];
+    }
+    return saveableObject;
+  }
+}

ts/smartdata.mongohelpers.ts

@@ -0,0 +1,3 @@
+export const addPassword = (mongoUrlArg: string, passwordArg: string): string => {
+  return mongoUrlArg.replace('<PASSWORD>', passwordArg);
+};

ts/smartdata.plugins.ts

@@ -1,5 +1,8 @@
-import 'typings-global'
-export import assert = require('assert')
-export import beautylog = require('beautylog')
-export import mongodb = require('mongodb')
-export import q = require('q')
+import * as assert from 'assert';
+import * as smartlog from '@pushrocks/smartlog';
+import * as lodash from 'lodash';
+import * as mongodb from 'mongodb';
+import * as smartq from 'smartq';
+import * as smartstring from 'smartstring';
+
+export { assert, smartlog, lodash, smartq, mongodb, smartstring };

tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "target": "es2017",
+    "module": "commonjs"
+  }
+}

tslint.json

@@ -1,3 +0,0 @@
-{
-    "extends": "tslint-config-standard"
-}