more tests added; coverage added; some cleanups

Author: Robin Buschmann

.gitignore

@@ -10,6 +10,7 @@ node_modules
 
 # testing
 coverage
+.nyc_output
 
 #logs
 npm-debug.log

.travis.yml

@@ -6,7 +6,10 @@ node_js:
 install:
   - npm install
 
-before_script:
-
 script:
-  - npm test
+  - npm run lint
+  - npm run build
+  - npm run cover
+
+after_success:
+ - 'nyc report --reporter=lcov > coverage.lcov && codecov'

README.md

@@ -44,7 +44,7 @@ Your `tsconfig.json` needs the following flags:
 
 ## Model definition
 ```typescript
-import {Table, Column, Model} from 'sequelize-typescript';
+import {Table, Column, Model, HasMany} from 'sequelize-typescript';
 
 @Table
 class Person extends Model<Person> {
@@ -53,7 +53,10 @@ class Person extends Model<Person> {
   name: string;
 
   @Column
-  age: number;
+  birthday: Date;
+
+  @HasMany(() => Hobby)
+  hobbies: Hobby[];
 }
 ```
 The model needs to extend the `Model` class and has to be annotated with the `@Table` decorator. All properties, that
@@ -161,6 +164,23 @@ Design type      | Sequelize data type
  `Date`          | `DATE`
  `Buffer`        | `BLOB`
 
+### Accessors
+Get/set accessors do work as well
+```typescript
+@Table
+class Person extends Model<Person> {
+
+  @Column
+  get name(): string {
+    return 'My name is ' + this.getDataValue('name');
+  }
+  
+  set name(value: string) {
+    this.setDataValue('name', value);
+  }
+}
+```
+ 
 ## Usage
 Except for minor variations *sequelize-typescript* will work like pure sequelize. 
 (See sequelize [docs](http://docs.sequelizejs.com/en/v3/docs/models-usage/))

index.ts

@@ -32,6 +32,7 @@ export {IsIn} from "./lib/annotations/validation/IsIn";
 export {IsInt} from "./lib/annotations/validation/IsInt";
 export {IsIP} from "./lib/annotations/validation/IsIP";
 export {IsIPv4} from "./lib/annotations/validation/IsIPv4";
+export {IsArray} from "./lib/annotations/validation/IsArray";
 export {IsIPv6} from "./lib/annotations/validation/IsIPv6";
 export {IsLowercase} from "./lib/annotations/validation/IsLowercase";
 export {IsNull} from "./lib/annotations/validation/IsNull";

lib/services/models.ts

@@ -3,7 +3,6 @@ import * as fs from 'fs';
 import * as path from 'path';
 import {DataTypeAbstract, DefineOptions} from 'sequelize';
 import {Model} from "../models/Model";
-import {ISequelizeForeignKeyConfig} from "../interfaces/ISequelizeForeignKeyConfig";
 import {IPartialDefineAttributeColumnOptions} from "../interfaces/IPartialDefineAttributeColumnOptions";
 import {inferDataType} from "../utils/data-type";
 import {deepAssign} from "../utils/object";
@@ -15,7 +14,6 @@ const MODEL_NAME_KEY = 'sequelize:modelName';
 const SCOPES_KEY = 'sequelize:scopes';
 const ATTRIBUTES_KEY = 'sequelize:attributes';
 const OPTIONS_KEY = 'sequelize:options';
-const FOREIGN_KEYS_KEY = 'sequelize:foreignKey';
 const DEFAULT_OPTIONS: DefineOptions<any> = {
   timestamps: false
 };
@@ -153,26 +151,6 @@ export function getSequelizeTypeByDesignType(target: any, propertyName: string):
             define the data type manually`);
 }
 
-/**
- * Adds foreign key meta data for specified class
- */
-export function addForeignKey(target: any,
-                              relatedClassGetter: () => typeof Model,
-                              propertyName: string): void {
-
-  let foreignKeys = getForeignKeys(target);
-
-  if (!foreignKeys) {
-    foreignKeys = [];
-    setForeignKeys(target, foreignKeys);
-  }
-
-  foreignKeys.push({
-    relatedClassGetter,
-    foreignKey: propertyName
-  });
-}
-
 /**
  * Determines models from value
  */
@@ -349,20 +327,3 @@ function setScopeOptions(target: any, options: IScopeOptions): void {
 
   Reflect.defineMetadata(SCOPES_KEY, options, target);
 }
-
-
-/**
- * Returns foreign key meta data from specified class
- */
-function getForeignKeys(target: any): ISequelizeForeignKeyConfig[]|undefined {
-
-  return Reflect.getMetadata(FOREIGN_KEYS_KEY, target);
-}
-
-/**
- * Set foreign key meta data for specified prototype
- */
-function setForeignKeys(target: any, foreignKeys: ISequelizeForeignKeyConfig[]): void {
-
-  Reflect.defineMetadata(FOREIGN_KEYS_KEY, foreignKeys, target);
-}

lib/utils/validation.ts

@@ -6,12 +6,16 @@
     "build": "tsc && tsc --project lib/models/v4",
     "build-tests-es5": "tsc --project test",
     "build-tests-es6": "tsc --project test --target es6",
-    "prepare-test-v3": "npm install [email protected] && npm run build && npm run build-tests-es5",
-    "prepare-test-v4": "npm install [email protected] && npm run build && npm run build-tests-es6",
+    "prepare-test-v3": "npm install [email protected] && npm run build-tests-es5",
+    "prepare-test-v4": "npm install [email protected] && npm run build-tests-es6",
     "test-v3": "npm run prepare-test-v3 && npm run exec-tests",
     "test-v4": "npm run prepare-test-v4 && npm run exec-tests",
+    "cover-v3": "npm run prepare-test-v3 && SEQ_SILENT=true nyc --exclude 'lib/models/v4/**/*.js' --all --require source-map-support/register mocha 'test/specs/**/*.js'",
+    "cover-v4": "npm run prepare-test-v4 && SEQ_SILENT=true nyc --exclude 'lib/models/v3/**/*.js' --all --require source-map-support/register mocha 'test/specs/**/*.js'",
     "exec-tests": "SEQ_SILENT=true mocha 'test/specs/**/*.js'",
-    "test": "npm run test-v4 && npm run test-v3"
+    "test": "npm run test-v4 && npm run test-v3",
+    "cover": "npm run cover-v4 && npm run cover-v3",
+    "lint": "tslint ."
   },
   "repository": {
     "type": "git",
@@ -47,16 +51,38 @@
     "mocha": "3.2.0",
     "moment": "2.17.1",
     "mysql": "2.13.0",
+    "nyc": "10.1.2",
     "prettyjson": "1.2.1",
     "reflect-metadata": "0.1.9",
     "sinon": "1.17.7",
     "sinon-chai": "2.8.0",
+    "source-map-support": "0.4.14",
     "sqlite3": "3.1.8",
     "tslint": "4.3.1",
     "typescript": "2.2.1",
     "uuid-validate": "0.0.2"
   },
   "engines": {
     "node": ">=0.8.15"
+  },
+  "nyc": {
+    "lines": 85,
+    "statements": 85,
+    "functions": 85,
+    "branches": 85,
+    "include": [
+      "lib/**/*.js"
+    ],
+    "exclude": [
+      "test/**/*.js"
+    ],
+    "reporter": [
+      "lcov",
+      "text-summary"
+    ],
+    "cache": true,
+    "all": true,
+    "check-coverage": true,
+    "report-dir": "./coverage"
   }
 }

package.json

@@ -28,6 +28,9 @@ export class ShoeWithScopes extends Model<ShoeWithScopes> {
   @Column
   secondaryColor: string;
 
+  @Column
+  img: Buffer;
+
   @Column
   producedAt: Date;
 

test/models/ShoeWithScopes.ts

@@ -3,7 +3,8 @@ import {
   Equals, Contains, Is, IsDate, Length, IsUrl, IsAfter, IsBefore,
   IsUUID, IsAlpha, IsAlphanumeric, IsEmail, IsInt, IsDecimal, IsFloat,
   IsIn, IsIP, IsIPv4, IsIPv6, IsLowercase, IsUppercase, Max, Min,
-  Not, NotContains, NotIn, NotNull, Validate
+  Not, NotContains, NotIn, NotNull, Validate, NotEmpty, IsNumeric,
+  IsNull, IsArray
 } from "../../index";
 import {IsCreditCard} from "../../lib/annotations/validation/IsCreditCard";
 
@@ -80,6 +81,10 @@ export class ShoeWithValidation extends Model<ShoeWithValidation> {
   @IsLowercase
   @IsUppercase
   @NotNull
+  @NotEmpty
+  @IsArray
+  @IsNull
+  @IsNumeric
   @Max(MAX)
   @Min(MIN)
   @Not(NOT)

test/models/ShoeWithValidation.ts

@@ -6,6 +6,8 @@ import {User} from "../models/User";
 import {getOptions, getAttributes} from "../../lib/services/models";
 import {Shoe, SHOE_TABLE_NAME} from "../models/Shoe";
 
+/* tslint:disable:max-classes-per-file */
+
 describe('table_column', () => {
 
   const sequelize = createSequelize();
@@ -195,49 +197,94 @@ describe('table_column', () => {
 
   });
 
-  describe('implicit get', () => {
+  describe('accessors', () => {
 
-    @Table
-    class User extends Model<User> {
+    describe('get', () => {
 
-      @Column
-      get name(): string {
-        return 'My name is ' + this.getDataValue('name');
-      }
+      @Table
+      class User extends Model<User> {
+
+        @Column
+        get name(): string {
+          return 'My name is ' + this.getDataValue('name');
+        }
 
-      set name(value: string) {
-        this.setDataValue('name', value);
+        set name(value: string) {
+          this.setDataValue('name', value);
+        }
       }
-    }
 
-    sequelize.addModels([User]);
+      sequelize.addModels([User]);
 
-    it('should consider getter', () => {
+      it('should consider getter', () => {
 
-      const user = new User({});
-      user.name = 'Peter';
+        const user = new User({});
+        user.name = 'Peter';
 
-      expect(user.name).to.equal('My name is Peter');
-    });
+        expect(user.name).to.equal('My name is Peter');
+      });
 
-    it('shouldn\'t store value from getter', () => {
+      it('shouldn\'t store value from getter into db', () => {
 
-      const user = new User({});
+        const user = new User({});
 
-      user.name = 'elli';
+        user.name = 'elli';
 
-      return user
-        .save()
-        .then(() => User.findById(user.id))
-        .then(_user => {
+        return user
+          .save()
+          .then(() => User.findById(user.id))
+          .then(_user => {
+
+            expect(_user.getDataValue('name')).to.equal('elli');
+          });
+      });
 
-          expect(_user.getDataValue('name')).to.equal('elli');
-        });
     });
 
-  });
+    describe('set', () => {
+
+      @Table
+      class User extends Model<User> {
+
+        @Column
+        get name(): string {
+          return this.getDataValue('name');
+        }
+
+        set name(value: string) {
+          this.setDataValue('name', value.toUpperCase());
+        }
+      }
 
-  describe('implicit set', () => {
+      sequelize.addModels([User]);
+
+      it('should consider setter', () => {
+
+        const name = 'Peter';
+
+        const user = new User({});
+        user.name = name;
+
+        expect(user.name).to.equal(name.toUpperCase());
+      });
+
+      it('should store value from setter into db', () => {
+
+        const name = 'elli';
+        const user = new User({});
+
+        user.name = name;
+
+        return user
+          .save()
+          .then(() => User.findById(user.id))
+          .then(_user => {
+
+            expect(_user.getDataValue('name')).to.equal(name.toUpperCase());
+          });
+      });
+
+    });
 
   });