Merge pull request #85 from RobinBuschmann/issue-70

Issue 70

Author: RobinBuschmann

lib/annotations/DefaultScope.ts

@@ -1,5 +1,5 @@
 import 'reflect-metadata';
-import {addScopeOptions} from "../services/models";
+import {addScopeOptions} from "../services/scopes";
 import {IScopeFindOptions} from "../interfaces/IScopeFindOptions";
 
 /**

lib/annotations/Scopes.ts

@@ -1,5 +1,5 @@
 import 'reflect-metadata';
-import {addScopeOptions} from "../services/models";
+import {addScopeOptions} from "../services/scopes";
 import {IDefineScopeOptions} from "../interfaces/IDefineScopeOptions";
 
 /**

lib/models/BaseSequelize.ts

@@ -2,7 +2,7 @@ import {Model} from "./Model";
 import {DEFAULT_DEFINE_OPTIONS, getModels} from "../services/models";
 import {getAssociations, processAssociation} from "../services/association";
 import {ISequelizeConfig} from "../interfaces/ISequelizeConfig";
-import {resolveScopes} from "../services/models";
+import {resolveScopes} from "../services/scopes";
 import {ISequelizeValidationOnlyConfig} from "../interfaces/ISequelizeValidationOnlyConfig";
 import {extend} from "../utils/object";
 import {ISequelizeAssociation} from "../interfaces/ISequelizeAssociation";

lib/services/models.ts

@@ -6,14 +6,10 @@ import {Model} from "../models/Model";
 import {IPartialDefineAttributeColumnOptions} from "../interfaces/IPartialDefineAttributeColumnOptions";
 import {inferDataType} from "../utils/data-type";
 import {deepAssign} from "../utils/object";
-import {IScopeOptions} from "../interfaces/IScopeOptions";
-import {IFindOptions} from "../interfaces/IFindOptions";
 import {getAssociationsByRelation} from "./association";
 import {uniqueFilter} from "../utils/array";
-import {IScopeFindOptions} from "../interfaces/IScopeFindOptions";
 
 const MODEL_NAME_KEY = 'sequelize:modelName';
-const SCOPES_KEY = 'sequelize:scopes';
 const ATTRIBUTES_KEY = 'sequelize:attributes';
 const OPTIONS_KEY = 'sequelize:options';
 export const DEFAULT_DEFINE_OPTIONS: DefineOptions<any> = {
@@ -210,21 +206,6 @@ export function getModels(arg: Array<typeof Model | string>): Array<typeof Model
   return arg as Array<typeof Model>;
 }
 
-/**
- * Resolves scopes and adds them to the specified models
- */
-export function resolveScopes(models: Array<typeof Model>): void {
-  models.forEach(model => {
-    const options = getScopeOptions(model.prototype);
-
-    if (options) {
-      Object
-        .keys(options)
-        .forEach(key => resolveScope(key, model, options[key]));
-    }
-  });
-}
-
 /**
  * Resolves all model getters of specified options object
  * recursively.
@@ -253,26 +234,6 @@ export function resolveModelGetter(options: any): void {
     });
 }
 
-/**
- * Adds scope option meta data for specified prototype
- */
-export function addScopeOptions(target: any, options: IScopeOptions): void {
-  const _options = getScopeOptions(target) || {};
-
-  setScopeOptions(target, deepAssign({}, _options, options));
-}
-
-/**
- * Returns scope option meta data from specified target
- */
-export function getScopeOptions(target: any): IScopeOptions | undefined {
-  const options = Reflect.getMetadata(SCOPES_KEY, target);
-
-  if (options) {
-    return deepAssign({}, options);
-  }
-}
-
 /**
  * Pre conform includes, so that "as" value can be inferred from source
  */
@@ -301,15 +262,6 @@ export function inferAlias(options: any, source: any): any {
   return options;
 }
 
-/**
- * Resolves scope
- */
-function resolveScope(scopeName: string, model: typeof Model, options: IScopeFindOptions | undefined): void {
-  resolveModelGetter(options);
-  options = inferAlias(options, model);
-  model.addScope(scopeName, options as IFindOptions, {override: true});
-}
-
 /**
  * Pre conform include, so that alias ("as") value can be inferred from source class
  */
@@ -344,14 +296,6 @@ function inferAliasForInclude(include: any, source: any): any {
   return include;
 }
 
-/**
- * Set scope option meta data for specified prototype
- */
-function setScopeOptions(target: any, options: IScopeOptions): void {
-
-  Reflect.defineMetadata(SCOPES_KEY, options, target);
-}
-
 /**
  * Checks if specified filename is importable or not;
  * Which means that, it needs to have a specific file extension

lib/services/scopes.ts

@@ -0,0 +1,66 @@
+import 'reflect-metadata';
+import {Model} from "../models/Model";
+import {deepAssign} from "../utils/object";
+import {IScopeOptions} from "../interfaces/IScopeOptions";
+import {IFindOptions} from "../interfaces/IFindOptions";
+import {IScopeFindOptions} from "../interfaces/IScopeFindOptions";
+import {inferAlias, resolveModelGetter} from './models';
+
+const SCOPES_KEY = 'sequelize:scopes';
+
+/**
+ * Resolves scopes and adds them to the specified models
+ */
+export function resolveScopes(models: Array<typeof Model>): void {
+  models.forEach(model => {
+    const options = getScopeOptions(model.prototype);
+
+    if (options) {
+      Object
+        .keys(options)
+        .forEach(key => resolveScope(key, model, options[key]));
+    }
+  });
+}
+
+/**
+ * Adds scope option meta data for specified prototype
+ */
+export function addScopeOptions(target: any, options: IScopeOptions): void {
+  const _options = getScopeOptions(target) || {};
+
+  setScopeOptions(target, deepAssign({}, _options, options));
+}
+
+/**
+ * Returns scope option meta data from specified target
+ */
+export function getScopeOptions(target: any): IScopeOptions | undefined {
+  const options = Reflect.getMetadata(SCOPES_KEY, target);
+
+  if (options) {
+    return deepAssign({}, options);
+  }
+}
+
+/**
+ * Resolves scope
+ */
+function resolveScope(scopeName: string, model: typeof Model, options: IScopeFindOptions | Function | undefined): void {
+  resolveModelGetter(options);
+  if (typeof options === 'function') {
+    const fn: Function = options;
+    options = (...args: any[]) => inferAlias(fn(...args), model);
+  } else {
+    options = inferAlias(options, model);
+  }
+  model.addScope(scopeName, options as IFindOptions, {override: true});
+}
+
+/**
+ * Set scope option meta data for specified prototype
+ */
+function setScopeOptions(target: any, options: IScopeOptions): void {
+
+  Reflect.defineMetadata(SCOPES_KEY, options, target);
+}

test/models/ShoeWithScopes.ts

@@ -18,7 +18,16 @@ export const SHOE_SCOPES = {
   },
   manufacturerWithScope: {
     include: [() => Manufacturer.scope('brandOnly')]
-  }
+  },
+  primaryColor: primaryColor => ({
+      where: {primaryColor}
+    }
+  ),
+  primaryColorWithManufacturer: primaryColor => ({
+      include: [Manufacturer],
+      where: {primaryColor},
+    }
+  )
 };
 
 @DefaultScope(SHOE_DEFAULT_SCOPE)

test/specs/scopes.spec.ts

@@ -1,7 +1,7 @@
 import {expect, use} from 'chai';
 import * as chaiAsPromised from 'chai-as-promised';
 import {createSequelize} from "../utils/sequelize";
-import {getScopeOptions} from "../../lib/services/models";
+import {getScopeOptions} from "../../lib/services/scopes";
 import {ShoeWithScopes, SHOE_DEFAULT_SCOPE, SHOE_SCOPES} from "../models/ShoeWithScopes";
 import {Manufacturer} from "../models/Manufacturer";
 import {Person} from "../models/Person";
@@ -198,6 +198,29 @@ describe('scopes', () => {
 
     });
 
+    describe('with scope function', () => {
+
+      it('should find appropriate shoe due to correctly passed scope function param', () =>
+        ShoeWithScopes
+          .scope({method: ['primaryColor', 'red']})
+          .findOne()
+          .then(shoe => {
+            expect(shoe).to.have.property('primaryColor', 'red');
+          })
+      );
+
+      it('should find appropriate shoe due to correctly passed scope function param including associated model', () =>
+        ShoeWithScopes
+          .scope({method: ['primaryColorWithManufacturer', 'red']})
+          .findOne()
+          .then(shoe => {
+            expect(shoe).to.have.property('primaryColor', 'red');
+            expect(shoe).to.have.property('manufacturer').that.is.an('object');
+          })
+      );
+
+    });
+
   });
 
 });