rename class JointPoint to JoinPoint (#64)

mgechev · Oct 9, 2018 · fe0588c · fe0588c
1 parent 144a255
commit fe0588c
Show file tree

Hide file tree

Showing 6 changed files with 70 additions and 18 deletions.
diff --git a/lib/src/core/join_point.ts b/lib/src/core/join_point.ts
@@ -5,7 +5,7 @@ export interface Precondition {
   assert(data: any): boolean;
 }
 
-export abstract class JointPoint {
+export abstract class JoinPoint {
   constructor(public precondition: Precondition) {}
 
   public abstract match(descriptor: Function): string[];
@@ -57,3 +57,16 @@ export abstract class JointPoint {
     return metadata;
   }
 }
+
+/**
+ * Kept for backward compability only.
+ * Use {@link JoinPoint} instead.
+ *
+ * @deprecated renamed to JoinPoint
+ * @see JoinPoint
+ */
+export abstract class JointPoint extends JoinPoint {
+  constructor(public precondition: Precondition) {
+    super(precondition)
+  }
+}
diff --git a/lib/src/core/pointcut.ts b/lib/src/core/pointcut.ts
@@ -1,8 +1,8 @@
-import { JointPoint } from './join_point';
+import { JoinPoint } from './join_point';
 import { Advice } from './advice';
 
 export class Pointcut {
-  public joinPoints: JointPoint[];
+  public joinPoints: JoinPoint[];
   public advice: Advice;
   private _applications = new Set<Function>();
 

diff --git a/lib/src/join_points/accessor_use.ts b/lib/src/join_points/accessor_use.ts
@@ -1,4 +1,4 @@
-import { JointPoint, Precondition } from '../core/join_point';
+import { JoinPoint, Precondition } from '../core/join_point';
 import { Advice } from '../core/advice';
 import { Pointcut } from '../core/pointcut';
 import { AspectRegistry, Targets, Aspect } from '../core/aspect';
@@ -7,8 +7,8 @@ import { MemberPrecondition } from './preconditions';
 
 export type AccessorType = 'get' | 'set';
 
-export class AccessorJointPoint extends JointPoint {
-  constructor(precondition: Precondition, private type: AccessorType) {
+export class AccessorJoinPoint extends JoinPoint {
+  constructor(precondition: Precondition, protected type: AccessorType) {
     super(precondition);
   }
 
@@ -53,7 +53,7 @@ export function makeFieldGetAdviceDecorator(constr: new (...args: any[]) => Advi
   return function(...selectors: MemberSelector[]): MethodDecorator {
     return function<T>(target: Object, prop: string | symbol, descriptor: TypedPropertyDescriptor<T>) {
       const joinpoints = selectors.map(selector => {
-        return new AccessorJointPoint(new MemberPrecondition(selector), 'get');
+        return new AccessorJoinPoint(new MemberPrecondition(selector), 'get');
       });
       const pointcut = new Pointcut();
       pointcut.advice = <Advice>new constr(target, descriptor.value);
@@ -71,7 +71,7 @@ export function makeFieldSetAdviceDecorator(constr: new (...args: any[]) => Advi
   return function(...selectors: MemberSelector[]): MethodDecorator {
     return function<T>(target: Object, prop: string | symbol, descriptor: TypedPropertyDescriptor<T>) {
       const joinpoints = selectors.map(selector => {
-        return new AccessorJointPoint(new MemberPrecondition(selector), 'set');
+        return new AccessorJoinPoint(new MemberPrecondition(selector), 'set');
       });
       const pointcut = new Pointcut();
       pointcut.advice = <Advice>new constr(target, descriptor.value);
@@ -85,3 +85,16 @@ export function makeFieldSetAdviceDecorator(constr: new (...args: any[]) => Advi
     };
   };
 }
+
+/**
+ * Kept for backward compability only.
+ * Use {@link AccessorJoinPoint} instead.
+ *
+ * @deprecated renamed to AccessorJoinPoint
+ * @see AccessorJoinPoint
+ */
+export abstract class AccessorJointPoint extends AccessorJoinPoint {
+  constructor(precondition: Precondition, protected type: AccessorType) {
+    super(precondition, type);
+  }
+}
diff --git a/lib/src/join_points/method_call.ts b/lib/src/join_points/method_call.ts
@@ -1,4 +1,4 @@
-import { Precondition, JointPoint } from '../core/join_point';
+import { Precondition, JoinPoint } from '../core/join_point';
 import { Advice } from '../core/advice';
 import { Pointcut } from '../core/pointcut';
 import { AspectRegistry, Targets, Aspect } from '../core/aspect';
@@ -7,7 +7,7 @@ import { MethodPrecondition } from './preconditions';
 
 const BLACK_LIST = ['constructor'];
 
-export class MethodCallJointPoint extends JointPoint {
+export class MethodCallJoinPoint extends JoinPoint {
   public getTarget(fn: Function): any {
     return fn.prototype;
   }
@@ -51,7 +51,7 @@ export function makeMethodCallAdviceDecorator(constr: any) {
   return function(...selectors: MethodSelector[]): MethodDecorator {
     return function<T>(target: Object, prop: symbol | string, descriptor: TypedPropertyDescriptor<T>) {
       let joinpoints = selectors.map(selector => {
-        return new MethodCallJointPoint(new MethodPrecondition(selector));
+        return new MethodCallJoinPoint(new MethodPrecondition(selector));
       });
       let pointcut = new Pointcut();
       pointcut.advice = <Advice>new constr(target, descriptor.value);
@@ -66,3 +66,16 @@ export function makeMethodCallAdviceDecorator(constr: any) {
     };
   };
 }
+
+/**
+ * Kept for backward compability only.
+ * Use {@link MethodCallJoinPoint} instead.
+ *
+ * @deprecated renamed to MethodCallJoinPoint
+ * @see MethodCallJoinPoint
+ */
+export abstract class MethodCallJointPoint extends MethodCallJoinPoint {
+  constructor(precondition: Precondition) {
+    super(precondition)
+  }
+}
diff --git a/lib/src/join_points/static_method.ts b/lib/src/join_points/static_method.ts
@@ -1,11 +1,11 @@
-import { Precondition, JointPoint } from '../core/join_point';
+import { Precondition, JoinPoint } from '../core/join_point';
 import { Advice } from '../core/advice';
 import { Pointcut } from '../core/pointcut';
 import { AspectRegistry, Targets, Aspect } from '../core/aspect';
 import { MethodSelector } from './selectors';
 import { MethodPrecondition } from './preconditions';
 
-export class StaticMethodJointPoint extends JointPoint {
+export class StaticMethodJoinPoint extends JoinPoint {
   constructor(precondition: Precondition) {
     super(precondition);
   }
@@ -44,7 +44,7 @@ export function makeStaticMethodAdviceDecorator(constr: any) {
   return function(...selectors: MethodSelector[]): MethodDecorator {
     return function<T>(target: Object, prop: symbol | string, descriptor: TypedPropertyDescriptor<T>) {
       let joinpoints = selectors.map(selector => {
-        return new StaticMethodJointPoint(new MethodPrecondition(selector));
+        return new StaticMethodJoinPoint(new MethodPrecondition(selector));
       });
       let pointcut = new Pointcut();
       pointcut.advice = <Advice>new constr(target, descriptor.value);
@@ -58,3 +58,16 @@ export function makeStaticMethodAdviceDecorator(constr: any) {
     };
   };
 }
+
+/**
+ * Kept for backward compability only.
+ * Use {@link StaticMethodJoinPoint} instead.
+ *
+ * @deprecated renamed to StaticMethodJoinPoint
+ * @see StaticMethodJoinPoint
+ */
+export abstract class StaticMethodJointPoint extends StaticMethodJoinPoint {
+  constructor(precondition: Precondition) {
+    super(precondition)
+  }
+}
diff --git a/test/core/pointcut.spec.ts b/test/core/pointcut.spec.ts
@@ -1,8 +1,8 @@
-import { Pointcut, Precondition, JointPoint, Advice } from '../../lib/src/core';
+import { Pointcut, Precondition, JoinPoint, Advice } from '../../lib/src/core';
 
 import { expect } from 'chai';
 
-class SimpleJP extends JointPoint {
+class SimpleJP extends JoinPoint {
   match(descriptor: Object): string[] {
     if (this.precondition.assert(descriptor)) {
       return ['1'];
@@ -25,8 +25,8 @@ class SimplePrecondition implements Precondition {
 // TODO(mgechev) refactor with spies
 describe('Pointcut', () => {
   let pc: Pointcut;
-  let jp1: JointPoint;
-  let jp2: JointPoint;
+  let jp1: JoinPoint;
+  let jp2: JoinPoint;
   beforeEach(() => {
     pc = new Pointcut();
     jp1 = new SimpleJP(new SimplePrecondition());