refactor(date.decorator): date -> dateProperty

switch name to avoid naming collision with date

Author: michaelwittwer

.lintstagedrc.yml

@@ -1,5 +1,5 @@
 linters:
-  "{src,test}/**/*.ts":
+  "{src}/**/*.ts":
     - prettier --write --config ./.prettierrc.yml
     - tslint --project ./tsconfig.json -t codeFrame --fix
     - git add

src/decorator/impl/date/date.decorator.spec.ts

@@ -3,14 +3,14 @@ import { metadataForModel, Model, ModelMetadata } from '../..'
 import { getMetaDataProperty } from '../../../../test/helper'
 import { updateDynamoEasyConfig } from '../../../config'
 import { DateToNumberMapper } from '../../../mapper/custom'
-import { Date } from './date.decorator'
+import { DateProperty } from './date.decorator'
 
 // important: it's necessary to update dynamo-easy-config BEFORE the models are loaded.
 updateDynamoEasyConfig({ dateMapper: DateToNumberMapper })
 
 @Model()
 class ModelWithDate {
-  @Date()
+  @DateProperty()
   aDate: Date
 }
 

src/decorator/impl/date/date.decorator.ts

@@ -1,7 +1,7 @@
 import { dynamoEasyConfig } from '../../../config/dynamo-easy-config'
 import { initOrUpdateProperty } from '../property/init-or-update-property.function'
 
-export function Date(): PropertyDecorator {
+export function DateProperty(): PropertyDecorator {
   return (target: any, propertyKey: string | symbol) => {
     if (typeof propertyKey === 'string') {
       initOrUpdateProperty({ mapper: () => dynamoEasyConfig.dateMapper }, target, propertyKey)

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

@@ -1,6 +1,7 @@
 import { EnumType } from '../../../mapper/type/enum.type'
 import { initOrUpdateProperty } from '../property/init-or-update-property.function'
 
+// FIXME remove unused
 export function Enum<T>(enumType?: T): PropertyDecorator {
   return (target: any, propertyKey: string | symbol) => {
     if (typeof propertyKey === 'string') {

test/models/complex.model.ts

@@ -1,4 +1,4 @@
-import { Date, Model, PartitionKey, Property, SortedSet, SortKey, Transient, TypedSet } from '../../src/dynamo-easy'
+import { DateProperty, Model, PartitionKey, Property, SortedSet, SortKey, Transient, TypedSet } from '../../src/dynamo-easy'
 import { NestedObject } from './nested-object.model'
 
 @Model({ tableName: 'complex_model' })
@@ -7,10 +7,10 @@ export class ComplexModel {
   id: string
 
   @SortKey()
-  @Date()
+  @DateProperty()
   creationDate: Date
 
-  @Date()
+  @DateProperty()
   lastUpdated: Date
 
   @Property({ name: 'isActive' })

test/models/employee.model.ts

@@ -1,12 +1,12 @@
-import { Date, Model, SortedSet } from '../../src/dynamo-easy'
+import { DateProperty, Model, SortedSet } from '../../src/dynamo-easy'
 
 @Model()
 export class Employee {
   name: string
 
   age: number
 
-  @Date()
+  @DateProperty()
   createdAt: Date | null
 
   @SortedSet()

test/models/model-with-date-as-key.model.ts

@@ -1,10 +1,10 @@
 // tslint:disable:max-classes-per-file
-import { Date, GSIPartitionKey, Model, PartitionKey, SortKey } from '../../src/dynamo-easy'
+import { DateProperty, GSIPartitionKey, Model, PartitionKey, SortKey } from '../../src/dynamo-easy'
 
 @Model()
 export class ModelWithDateAsHashKey {
   @PartitionKey()
-  @Date()
+  @DateProperty()
   startDate: Date
 
   constructor(startDate: Date) {
@@ -18,7 +18,7 @@ export class ModelWithDateAsRangeKey {
   id: number
 
   @SortKey()
-  @Date()
+  @DateProperty()
   creationDate: Date
 
   constructor(id: number, creationDate: Date) {
@@ -33,7 +33,7 @@ export class ModelWithDateAsIndexHashKey {
   id: number
 
   @GSIPartitionKey('anyGSI')
-  @Date()
+  @DateProperty()
   creationDate: Date
 
   constructor(id: number, creationDate: Date) {

test/models/model-with-indexes.model.ts

@@ -1,22 +1,22 @@
 // tslint:disable:max-classes-per-file
 import {
-  Date,
+  DateProperty,
   GSIPartitionKey,
   GSISortKey,
   LSISortKey,
   Model,
-  PartitionKey,
-  Property,
+  PartitionKey, Property,
   SortKey,
 } from '../../src/dynamo-easy'
 
 export const INDEX_ACTIVE = 'active-index'
+
 @Model()
 export class ModelWithGSI {
   @PartitionKey()
   id: string
 
-  @Date()
+  @DateProperty()
   createdAt: Date
 
   @GSIPartitionKey(INDEX_ACTIVE)
@@ -28,7 +28,7 @@ export class ModelWithLSI {
   @PartitionKey()
   id: string
 
-  @Date()
+  @DateProperty()
   createdAt: Date
 
   @LSISortKey(INDEX_ACTIVE)
@@ -46,7 +46,7 @@ export class ModelWithABunchOfIndexes {
 
   @SortKey()
   @GSISortKey(INDEX_ACTIVE_CREATED_AT)
-  @Date()
+  @DateProperty()
   createdAt: Date
 
   @GSIPartitionKey(INDEX_ACTIVE_CREATED_AT)

test/models/organization.model.ts

@@ -1,5 +1,5 @@
 import {
-  Date,
+  DateProperty,
   Model,
   PartitionKey,
   Property,
@@ -19,7 +19,7 @@ export class Gift {
 
 @Model()
 export class Birthday {
-  @Date()
+  @DateProperty()
   date: Date
 
   @TypedArray(Gift)
@@ -58,10 +58,10 @@ export class Organization {
   name: string
 
   @SortKey()
-  @Date()
+  @DateProperty()
   createdAtDate: Date
 
-  @Date()
+  @DateProperty()
   lastUpdated: Date
 
   // Boolean
@@ -88,7 +88,7 @@ export class Organization {
   // simple type, mixed (no metadata required)
   randomDetails: any[]
 
-  // complex type (requries metadata)
+  // complex type (requires metadata)
   @TypedArray(Employee)
   employees: Employee[]
 

test/models/product.model.ts

@@ -4,12 +4,6 @@ import { NestedComplexModel } from './nested-complex.model'
 
 @Model()
 export class ProductNested {
-  /*
-   * introduce new decorators
-   */
-  // @SortedArray()
-  // @Set()
-  // @Date()
   @SortedSet()
   collection: Set<string>
 
@@ -25,11 +19,9 @@ export class ProductNested {
 
 @Model()
 export class Product {
-  // @CustomMapper(ObjectMapper) --> works great
   @Property()
   nestedValue: NestedComplexModel
 
-  // @Type(Array, ProductNested)
   @TypedArray(ProductNested)
   list: ProductNested[]