Merge pull request #4 from bashleigh/refactor/cleanup

refactor and clean up of abstract repository. Also added extra tests
bashleigh · Jan 4, 2021 · 49c23fc · 49c23fc
2 parents 4a15109 + d97c690
commit 49c23fc
Show file tree

Hide file tree

Showing 10 changed files with 167 additions and 114 deletions.
diff --git a/.env.dist b/.env.dist
@@ -1,14 +1,15 @@
-MYSQL_ROOT_PASSWORD=root
 MYSQL_DATABASE=polymorphic
 MYSQL_USER=root
-MYSQL_PASSWORD=root
+MYSQL_PASSWORD=
+MYSQL_ROOT_PASSWORD=
+MYSQL_ALLOW_EMPTY_PASSWORD=true
 
 TYPEORM_CONNECTION=mysql
 TYPEORM_HOST=localhost
 TYPEORM_PORT=3306
 TYPEORM_DATABASE=polymorphic
 TYPEORM_USERNAME=root
-TYPEORM_PASSWORD=root
+TYPEORM_PASSWORD=
 TYPEORM_ENTITIES=src/__tests__/**/*.entity.ts
 TYPEORM_SYNCHRONIZE=true
 TYPEORM_LOGGING=true

diff --git a/.travis.yml b/.travis.yml
@@ -8,6 +8,7 @@ node_js:
 services:
   - mysql
 before_install:
+  - cp .env.dist .env
   - mysql -e 'CREATE DATABASE IF NOT EXISTS polymorphic;'
   - npm i -g npm@latest
   - npm i -g yarn

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # typeorm-polymorphic
 <a href="https://www.npmjs.com/package/typeorm-polymorphic"><img src="https://img.shields.io/npm/v/typeorm-polymorphic.svg"/></a>
-<img src="https://github.com/bashleigh/typeorm-polymorphic/workflows/tests/badge.svg"/>
+<img src="https://github.com/bashleigh/typeorm-polymorphic/workflows/Tests/badge.svg"/>
 <img src="https://camo.githubusercontent.com/a34cfbf37ba6848362bf2bee0f3915c2e38b1cc1/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5052732d77656c636f6d652d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265" />
 
 An extension package for polymorphic relationship management, declaration and repository queries for [typeorm](https://typeorm.io/)

diff --git a/package.json b/package.json
@@ -12,7 +12,7 @@
     "type": "git",
     "url": "https://github.com/bashleigh/typeorm-polymorphic"
   },
-  "description": "A simple pagination function to build a pagination object with types",
+  "description": "A repository for building typed polymorphic relationships",
   "keywords": [
     "nestjs",
     "typeorm",

diff --git a/src/__tests__/polymorphic.repository.spec.ts b/src/__tests__/polymorphic.repository.spec.ts
@@ -4,7 +4,7 @@ import { UserEntity } from './entities/user.entity';
 import { config } from 'dotenv';
 import { resolve } from 'path';
 import { AdvertRepository } from './repository/advert.repository';
-import { AbstractPolymorphicRepository } from '../../dist';
+import { AbstractPolymorphicRepository } from '../';
 
 describe('AbstractPolymorphicRepository', () => {
   let connection: Connection;
@@ -41,38 +41,118 @@ describe('AbstractPolymorphicRepository', () => {
     ]);
   });
 
-  describe('child', () => {
-    it('Can create with parent', async () => {
-      const repository = connection.getCustomRepository(AdvertRepository);
+  describe('Childen', () => {
+    describe('create', () => {
+      it('Can create with parent', async () => {
+        const repository = connection.getCustomRepository(AdvertRepository);
 
-      const user = new UserEntity();
+        const user = new UserEntity();
 
-      const result = repository.create({
-        owner: user,
+        const result = repository.create({
+          owner: user,
+        });
+
+        expect(result).toBeInstanceOf(AdvertEntity);
+        expect(result.owner).toBeInstanceOf(UserEntity);
+      });
+    });
+
+    describe('save', () => {
+      it('Can save cascade parent', async () => {
+        const repository = connection.getCustomRepository(AdvertRepository);
+        const userRepository = connection.getRepository(UserEntity);
+
+        const user = await userRepository.save(new UserEntity());
+
+        const result = await repository.save(
+          repository.create({
+            owner: user,
+          }),
+        );
+
+        expect(result).toBeInstanceOf(AdvertEntity);
+        expect(result.owner).toBeInstanceOf(UserEntity);
+        expect(result.id).toBeTruthy();
+        expect(result.owner.id).toBeTruthy();
+        expect(result.entityType).toBe(UserEntity.name);
+        expect(result.entityId).toBe(result.owner.id);
       });
 
-      expect(result).toBeInstanceOf(AdvertEntity);
-      expect(result.owner).toBeInstanceOf(UserEntity);
+      it('Can save many with cascade parent', async () => {
+        const repository = connection.getCustomRepository(AdvertRepository);
+        const userRepository = connection.getRepository(UserEntity);
+
+        const user = await userRepository.save(new UserEntity());
+
+        const result = await repository.save([
+          repository.create({
+            owner: user,
+          }),
+          repository.create({
+            owner: user,
+          }),
+        ]);
+
+        result.forEach((res) => {
+          expect(res).toBeInstanceOf(AdvertEntity);
+          expect(res.owner).toBeInstanceOf(UserEntity);
+          expect(res.id).toBeTruthy();
+          expect(res.owner.id).toBeTruthy();
+          expect(res.entityType).toBe(UserEntity.name);
+          expect(res.entityId).toBe(res.owner.id);
+        });
+      });
     });
 
-    it('Can save cascade parent', async () => {
-      const repository = connection.getCustomRepository(AdvertRepository);
-      const userRepository = connection.getRepository(UserEntity);
+    describe('findOne', () => {
+      it('Can find entity with parent', async () => {
+        const repository = connection.getCustomRepository(AdvertRepository);
+        const userRepository = connection.getRepository(UserEntity);
 
-      const user = await userRepository.save(new UserEntity());
+        const user = await userRepository.save(new UserEntity());
 
-      const result = await repository.save(
-        repository.create({
-          owner: user,
-        }),
-      );
-
-      expect(result).toBeInstanceOf(AdvertEntity);
-      expect(result.owner).toBeInstanceOf(UserEntity);
-      expect(result.id).toBeTruthy();
-      expect(result.owner.id).toBeTruthy();
-      expect(result.entityType).toBe(UserEntity.name);
-      expect(result.entityId).toBe(result.owner.id);
+        const advert = await repository.save(
+          repository.create({
+            owner: user,
+          }),
+        );
+
+        const result = await repository.findOne(advert.id);
+
+        expect(result).toBeInstanceOf(AdvertEntity);
+        expect(result.owner).toBeInstanceOf(UserEntity);
+        expect(result.owner.id).toBe(result.entityId);
+        expect(result.entityType).toBe(UserEntity.name);
+      });
+    });
+
+    describe('find', () => {
+      it('Can find entities with parent', async () => {
+        const repository = connection.getCustomRepository(AdvertRepository);
+        const userRepository = connection.getRepository(UserEntity);
+
+        const user = await userRepository.save(new UserEntity());
+
+        await repository.save([
+          repository.create({
+            owner: user,
+          }),
+          repository.create({
+            owner: user,
+          }),
+        ]);
+
+        const result = await repository.find();
+
+        result.forEach((res) => {
+          expect(res).toBeInstanceOf(AdvertEntity);
+          expect(res.owner).toBeInstanceOf(UserEntity);
+          expect(res.id).toBeTruthy();
+          expect(res.owner.id).toBeTruthy();
+          expect(res.entityType).toBe(UserEntity.name);
+          expect(res.entityId).toBe(res.owner.id);
+        });
+      });
     });
   });
 });
diff --git a/src/constants.ts b/src/constants.ts
@@ -1 +1,2 @@
 export const POLYMORPHIC_OPTIONS = 'POLYMORPHIC_OPTIONS';
+export const POLYMORPHIC_KEY_SEPARATOR = '::';
diff --git a/src/decorators.ts b/src/decorators.ts
@@ -1,7 +1,6 @@
-import { POLYMORPHIC_OPTIONS } from './constants';
+import { POLYMORPHIC_KEY_SEPARATOR, POLYMORPHIC_OPTIONS } from './constants';
 import {
-  PolymorphicChildrenDecoratorOptionsInterface,
-  PolymorphicParentDecoratorOptionsInterface,
+  PolymorphicDecoratorOptionsInterface,
   PolymorphicMetadataOptionsInterface,
 } from './polymorphic.interface';
 
@@ -10,7 +9,7 @@ const polymorphicPropertyDecorator = (
 ): PropertyDecorator => (target: Object, propertyKey: string) => {
   Reflect.defineMetadata(POLYMORPHIC_OPTIONS, true, target);
   Reflect.defineMetadata(
-    `${POLYMORPHIC_OPTIONS}::${propertyKey}`,
+    `${POLYMORPHIC_OPTIONS}${POLYMORPHIC_KEY_SEPARATOR}${propertyKey}`,
     {
       propertyKey,
       ...options,
@@ -21,7 +20,7 @@ const polymorphicPropertyDecorator = (
 
 export const PolymorphicChildren = (
   classType: () => Function[] | Function,
-  options: PolymorphicChildrenDecoratorOptionsInterface = {},
+  options: PolymorphicDecoratorOptionsInterface = {},
 ): PropertyDecorator =>
   polymorphicPropertyDecorator({
     type: 'children',
@@ -35,7 +34,7 @@ export const PolymorphicChildren = (
 
 export const PolymorphicParent = (
   classType: () => Function[] | Function,
-  options: PolymorphicParentDecoratorOptionsInterface = {},
+  options: PolymorphicDecoratorOptionsInterface = {},
 ): PropertyDecorator =>
   polymorphicPropertyDecorator({
     type: 'parent',

diff --git a/src/polymorphic.interface.ts b/src/polymorphic.interface.ts
@@ -24,17 +24,7 @@ export interface PolymorphicMetadataInterface extends PolymorphicInterface {
   propertyKey: string;
 }
 
-export interface PolymorphicChildrenDecoratorOptionsInterface {
-  primaryColumn?: string;
-  hasMany?: boolean;
-  cascade?: boolean;
-  eager?: boolean;
-  deleteBeforeUpdate?: boolean;
-  entityTypeColumn?: string;
-  entityTypeId?: string;
-}
-
-export interface PolymorphicParentDecoratorOptionsInterface {
+export interface PolymorphicDecoratorOptionsInterface {
   deleteBeforeUpdate?: boolean;
   primaryColumn?: string;
   hasMany?: boolean;
Original file line number	Diff line number	Diff line change
		@@ -1 +1,2 @@
		export const POLYMORPHIC_OPTIONS = 'POLYMORPHIC_OPTIONS';
		export const POLYMORPHIC_KEY_SEPARATOR = '::';