test(mappers): implement unit tests for all mappers

Author: michaelwittwer

README.md

@@ -78,22 +78,9 @@ present on a property)
 
 Generic information is never available due to some serialization limitations at the time of writing.
 
-## A word on Collections (Array & Set)
-
-###Array
-Javascript Arrays with a a items of type String, Number or Binary will be mapped to a S(et) type, by default all other types are mapped to L(ist) type.
-If an item of an Array has a complex type the type can be defined using the @TypedArray() Decorator.
-
-###Set
-ES6 Set types will be marshalled to dynamoDb set type if the type of the set is supported, if the type is not supported it will be
-marshalled to an dynamoDB List.  
-
-When one of the following decorators is added, the value is marshalled to a List type.
-@SortedSet(itemType?: ModelClazz), @TypedSet(itemType?: ModelClazz)
-
 ## Model
 
-###Custom TableName
+### Custom TableName
 Here is the rule how a table name is built `${kebabCase(modelName)}s` so for a model called Product the table will be named products, this is a default implementation.
 
 There are two possibilities to change the name:
@@ -121,17 +108,51 @@ Complex Types (properties with these types need some decorators to work properly
 - Map
 - Array<complexType>
 
+| TS Type       | Dynamo Type   |
+| ------------- |:-------------:|
+| String        | S             |
+| Number        | N             |
+| Boolean       | BOOL          |
+| moment.Moment | S (ISO-8601 formatted) |
+| null          | NULL          |
+| Array         | L, (S,N,B)S   |
+| ES6 Set       | L, (S,N,B)S   |
+| Object       | M   |
+|----|------|
+| Binary        | Not Supported |
+| ES6 Map       | Not Supported   |
+| Date          | Not Supported |
+
+## Custom Attribute Mapping
+It is always possible to define a custom mapping strategy, just implement the [MapperForType](https://shiftcode.github.io/dynamo-easy/interfaces/_mapper_for_type_base_mapper_.mapperfortype.html) class.
+
+## Collection Mapping (Array & Set)
+
+### Array
+Javascript Arrays with a items of type String, Number or Binary will be mapped to a S(et) type, by default all other types are mapped to L(ist) type.
+If the items have a complex type it will be mapped to a L(ist).
+
+### Set
+An instance of ES6 Set type will be mapped to a S(et) type if the type of the items is supported (String, Number, Binary), otherwise it is mapped to a L(ist).  
+
+When one of the following decorators is present, the value is always mapped to a L(ist).
+
+- @SortedSet(itemType?: ModelClazz) - only L(ist) type preserves order
+- @TypedSet(itemType?: ModelClazz) - if the itemType is not one of String | Number | Binary
+- @TypedArray()
+
 ## Date
-Right now we only support (MomentJS)[http://momentjs.com/] Dates.
+Right now we only support [MomentJS](http://momentjs.com/) Dates.
 
 If you want to explicitly mark a property to be a Date use the @Date() decorator. If we find a moment value we automatically map it to a String (using ISO-8601 format).
 When coming from db we do a regex test for ISO-8601 format and map it back to a moment object.
 
-# Requests API
-To start making requests create an instance of [DynamoStore](https://shiftcode.github.io/dynamo-easy/classes/_dynamo_dynamo_store_.dynamostore.html) and execute the desired operation using the provided api.
-We support all the common dynamodb operations.
+## Enum
+Enum values are persisted as Numbers (index of enum).
 
-The request api has support for the following operations:
+# Request API
+To start making requests create an instance of [DynamoStore](https://shiftcode.github.io/dynamo-easy/classes/_dynamo_dynamo_store_.dynamostore.html) and execute the desired operation using the provided api.
+We support all the common dynamodb operations:
 
 - Put
 - Get
@@ -141,9 +162,6 @@ The request api has support for the following operations:
 - Query
 - MakeRequest (generic low level method for special scenarios)
 
-For most of the api there is probably no explanation required, here are some topics we think
-need some more info.
-
 There is always the possibility to access the Params object directly to add values which are not covered with our api.
 
 # Authentication
@@ -154,8 +172,8 @@ The default implementation is a no-op function.
 ## Session Validity Ensurer
 Here is an example of an implementation using amazon cognito
 
-```
-function sessionValidityEnsurer(): Observable<>{
+```javascript
+function sessionValidityEnsurer(): Observable<boolean> {
   return Observable.of(this.isLoggedIn())
     .switchMap(isLoggedIn => {
        if (isLoggedIn) {
@@ -226,18 +244,17 @@ which publishes our code automatically on github and npm, plus generates automat
 We use 2 git hooks:
 
 `precommit`
-- to format the code with Prettier :nail_care: before sending it to the git repo.
+- to format the code with Prettier :nail_care:
 - to check if the commit message follows a [conventional commit message](https://github.com/conventional-changelog/conventional-changelog)
 
-
 `prepush`
-- if the code can be built running npm run build
-- if all the tests pass
+- to check if the code can be built running `npm run build`
+- to check if all tests pass
 
 ## Credits
-[https://github.com/alexjoverm/typescript-library-starter](https://github.com/alexjoverm/typescript-library-starter) For the awesome project which helps to scaffold, develop and build a typescript library project
-[https://github.com/ryanfitz/vogels](https://github.com/ryanfitz/vogels) - To get an idea on how to build the chainable api
-[http://densebrain.github.io/typestore/](http://densebrain.github.io/typestore/) - Thats where the base idea on how to implement the model decorators came came from
+- [https://github.com/alexjoverm/typescript-library-starter](https://github.com/alexjoverm/typescript-library-starter) For the awesome project which helps to scaffold, develop and build a typescript library project
+- [https://github.com/ryanfitz/vogels](https://github.com/ryanfitz/vogels) - To get an idea on how to build the chainable api
+- [http://densebrain.github.io/typestore/](http://densebrain.github.io/typestore/) - Thats where the base idea on how to implement the model decorators came came from
 
 ## Contributors
 Made with :heart: by [@michaelwittwer](https://github.com/michaelwittwer) and all these wonderful contributors ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):

package.json

@@ -87,15 +87,12 @@
     }
   },
   "devDependencies": {
-    "aws-sdk": "^2.100.0",
-    "lodash": "^4.17.4",
-    "moment": "^2.18.1",
-    "rxjs": "^5.4.3",
     "@types/debug": "^0.0.30",
     "@types/jest": "^21.1.2",
     "@types/lodash": "^4.14.74",
     "@types/node": "^8.0.26",
     "@types/uuid": "^3.4.1",
+    "aws-sdk": "^2.100.0",
     "colors": "^1.1.2",
     "commitizen": "^2.9.6",
     "coveralls": "^3.0.0",
@@ -104,7 +101,9 @@
     "husky": "^0.14.0",
     "jest": "^21.2.1",
     "lint-staged": "^4.0.4",
+    "lodash": "^4.17.4",
     "lodash.camelcase": "^4.3.0",
+    "moment": "^2.18.1",
     "prettier": "^1.6.1",
     "prompt": "^1.0.0",
     "replace-in-file": "^2.6.3",
@@ -115,6 +114,7 @@
     "rollup-plugin-node-builtins": "^2.1.2",
     "rollup-plugin-node-resolve": "^3.0.0",
     "rollup-plugin-sourcemaps": "^0.4.2",
+    "rxjs": "^5.4.3",
     "semantic-release": "^8.0.3",
     "ts-jest": "^21.0.1",
     "ts-loader": "^2.3.4",

src/decorator/impl/collection/typed-array.decorator.ts

@@ -3,7 +3,7 @@ import { TypeInfo } from '../../metadata/property-metadata.model'
 import { AttributeModelTypes, initOrUpdateProperty, KEY_PROPERTY } from '../property/property.decorator'
 
 /**
- * Makes sure the property will be marshalled to a L(ist) type. The modelClass is required if the collection items
+ * Makes sure the property will be mapped to a L(ist) type. The modelClass is required if the collection items
  * have some property decorators, so we can retrieve this information using the model class.
  */
 export function TypedArray<T>(modelClass?: ModelConstructor<T>): PropertyDecorator {

src/decorator/impl/enum/enum.decorator.ts

@@ -1,7 +1,7 @@
 import { EnumType } from '../../../mapper/type/enum.type'
 import { initOrUpdateProperty } from '../property/property.decorator'
 
-export function Enum(): PropertyDecorator {
+export function Enum<T>(enumType?: T): PropertyDecorator {
   return (target: any, propertyKey: string) => {
     initOrUpdateProperty({ typeInfo: { type: EnumType, isCustom: true } }, target, propertyKey)
   }

src/mapper/for-type/boolean.mapper.spec.ts

@@ -0,0 +1,59 @@
+import { PropertyMetadata } from '../../decorator/metadata/property-metadata.model'
+import { BooleanMapper } from './boolean.mapper'
+import { EnumMapper } from './enum.mapper'
+
+describe('boolean mapper', () => {
+  let mapper: BooleanMapper
+
+  beforeEach(() => {
+    mapper = new BooleanMapper()
+  })
+
+  describe('to db', () => {
+    it('should work (true)', () => {
+      const attributeValue = mapper.toDb(true)
+      expect(attributeValue).toEqual({ BOOL: true })
+    })
+
+    it('should work (false)', () => {
+      const attributeValue = mapper.toDb(false)
+      expect(attributeValue).toEqual({ BOOL: false })
+    })
+
+    it('should throw (string is not a valid boolean value)', () => {
+      expect(() => {
+        mapper.toDb(<any>'true')
+      }).toThrowError()
+    })
+
+    it('should throw (string is not a valid boolean value)', () => {
+      expect(() => {
+        mapper.toDb(<any>1)
+      }).toThrowError()
+    })
+  })
+
+  describe('from db', () => {
+    it('should work (true)', () => {
+      const enumValue = mapper.fromDb({ BOOL: true })
+      expect(enumValue).toBe(true)
+    })
+
+    it('should work (false)', () => {
+      const enumValue = mapper.fromDb({ BOOL: false })
+      expect(enumValue).toBe(false)
+    })
+
+    it('should throw (S cannot be mapped to boolean)', () => {
+      expect(() => {
+        mapper.fromDb({ S: 'true' })
+      }).toThrowError()
+    })
+
+    it('should throw (N cannot be mapped to boolean)', () => {
+      expect(() => {
+        mapper.fromDb({ N: '1' })
+      }).toThrowError()
+    })
+  })
+})

src/mapper/for-type/boolean.mapper.ts

@@ -3,10 +3,18 @@ import { MapperForType } from './base.mapper'
 
 export class BooleanMapper implements MapperForType<boolean> {
   fromDb(dbValue: any): boolean {
+    if (dbValue.BOOL === undefined) {
+      throw new Error('only attribute values with BOOL value can be mapped to a boolean')
+    }
+
     return dbValue.BOOL === true
   }
 
   toDb(modelValue: boolean): AttributeValue {
+    if (!(modelValue === true || modelValue === false)) {
+      throw new Error('only boolean values are mapped to a BOOl attribute')
+    }
+
     return { BOOL: modelValue }
   }
 }