Entity.get - Code Metrics - Inspection of "Implementation of entity functions" - jatitoam/ddd-typescript - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — develop (#7)

by Tito

created 2023-03-31 22:59 UTC

Entity.get A

↳ Parent: Entity

Complexity

Conditions

Size

Total Lines	14
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	6
dl	0
loc	14
rs	10
c	0
b	0
f	0
cc	2

import { FieldNotFoundError } from "Errors/Entities/FieldNotFoundError";
import { UniqueEntityId } from "Utilities/Ids/UniqueEntityId";

/**
 * Abstract Entity class
 */
export abstract class Entity<T> {
  /**
   * Id of the entity
   */
  protected readonly _id: UniqueEntityId;

  /**
   * Collection of properties
   */
  protected readonly props: T;

  /**
   * @param T props
   * @param IEntityDefinition definition Needed for each specific entity overriding this entity.  The child entity should not expose this parameter in its own constructor
   * @param UniqueEntityId id If not sent, it generates a UUID
   */
  constructor(props: T, id?: UniqueEntityId) {
    this.props = props;
    this._id =
      typeof props["id"] !== "undefined" && props["id"] !== null
        ? new UniqueEntityId(props["id"])
        : id
        ? id
        : new UniqueEntityId();
  }

  /**
   * Gets the id in its natural type
   *
   * @returns string|number
   */
  public getId(): string | number {
    return this._id.toValue();
  }

  /**
   * Gets the id stringified
   *
   * @returns string
   */
  public getIdString(): string {
    return this._id.toString();
  }

  /**
   * Field getter
   *
   * @param field
   *
   * @throws FieldNotFoundError
   */
  public get(field: string): any {
    if (typeof this.props[field] === "undefined") {
      throw new FieldNotFoundError(field);
    }

    return this.props[field];
  }

  /**
   * Serialize the entity as a JSON
   *
   * @returns object
   */
  public serialize(): object {
    return {
      id: this._id.toValue(),
      ...this.props,
    };
  }
}


1			import { FieldNotFoundError } from "Errors/Entities/FieldNotFoundError";
2			import { UniqueEntityId } from "Utilities/Ids/UniqueEntityId";
3
4			/**
5			* Abstract Entity class
6			*/
7			export abstract class Entity<T> {
8			/**
9			* Id of the entity
10			*/
11			protected readonly _id: UniqueEntityId;
12
13			/**
14			* Collection of properties
15			*/
16			protected readonly props: T;
17
18			/**
19			* @param T props
20			* @param IEntityDefinition definition Needed for each specific entity overriding this entity. The child entity should not expose this parameter in its own constructor
21			* @param UniqueEntityId id If not sent, it generates a UUID
22			*/
23			constructor(props: T, id?: UniqueEntityId) {
24			this.props = props;
25			this._id =
26			typeof props["id"] !== "undefined" && props["id"] !== null
27			? new UniqueEntityId(props["id"])
28			: id
29			? id
30			: new UniqueEntityId();
31			}
32
33			/**
34			* Gets the id in its natural type
35			*
36			* @returns string\|number
37			*/
38			public getId(): string \| number {
39			return this._id.toValue();
40			}
41
42			/**
43			* Gets the id stringified
44			*
45			* @returns string
46			*/
47			public getIdString(): string {
48			return this._id.toString();
49			}
50
51			/**
52			* Field getter
53			*
54			* @param field
55			*
56			* @throws FieldNotFoundError
57			*/
58			public get(field: string): any {
59			if (typeof this.props[field] === "undefined") {
60			throw new FieldNotFoundError(field);
61			}
62
63			return this.props[field];
64			}
65
66			/**
67			* Serialize the entity as a JSON
68			*
69			* @returns object
70			*/
71			public serialize(): object {
72			return {
73			id: this._id.toValue(),
74			...this.props,
75			};
76			}
77			}
78

jatitoam / ddd-typescript

Pull Request — develop (#7)

Entity.get A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like