| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156 |
- import {expect} from 'chai';
- import {chai} from '../../chai.js';
- import {Schema} from '../../schema.js';
- import {format} from '@e22m4u/js-format';
- import {DataType} from './properties/index.js';
- import {RelationType} from './relations/index.js';
- import {EmptyValuesService} from '@e22m4u/js-empty-values';
- import {InvalidArgumentError} from '../../errors/index.js';
- import {ModelDefinitionUtils} from './model-definition-utils.js';
- import {DEFAULT_PRIMARY_KEY_PROPERTY_NAME as DEF_PK} from './model-definition-utils.js';
- const sandbox = chai.spy.sandbox();
- describe('ModelDefinitionUtils', function () {
- afterEach(function () {
- sandbox.restore();
- });
- describe('getPrimaryKeyAsPropertyName', function () {
- it('returns a default property name if no primary key defined', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getPrimaryKeyAsPropertyName('model');
- expect(result).to.be.eq(DEF_PK);
- });
- it('throws an error if a property name of a default primary key already in use as a regular property', function () {
- const schema = new Schema();
- const S = schema.getService(ModelDefinitionUtils);
- sandbox.on(
- S,
- 'getPropertiesDefinitionInBaseModelHierarchy',
- function (modelName) {
- expect(modelName).to.be.eq('model');
- return {[DEF_PK]: DataType.NUMBER};
- },
- );
- const throwable = () => S.getPrimaryKeyAsPropertyName('model');
- expect(throwable).to.throw(
- format(
- 'The property name %v of the model "model" is defined as a regular property. ' +
- 'In this case, a primary key should be defined explicitly. ' +
- 'Do use the option "primaryKey" to specify the primary key.',
- DEF_PK,
- ),
- );
- });
- it('returns a property name if a primary key has a custom name and a default primary key is used as a regular property', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- myId: {
- type: DataType.NUMBER,
- primaryKey: true,
- },
- [DEF_PK]: DataType.NUMBER,
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getPrimaryKeyAsPropertyName('model');
- expect(result).to.be.eql('myId');
- });
- it('returns a property name of a primary key', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: DataType.NUMBER,
- primaryKey: true,
- },
- bar: {
- type: DataType.NUMBER,
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getPrimaryKeyAsPropertyName('model');
- expect(result).to.be.eq('foo');
- });
- it('uses a base model hierarchy to get a property name of a primary key', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- foo: {
- type: DataType.STRING,
- primaryKey: true,
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- base: 'modelA',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getPrimaryKeyAsPropertyName('modelB');
- expect(result).to.be.eq('foo');
- });
- });
- describe('getPrimaryKeyAsColumnName', function () {
- it('returns a property name of a primary key if a column name is not specified', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: DataType.NUMBER,
- primaryKey: true,
- },
- bar: {
- type: DataType.NUMBER,
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getPrimaryKeyAsColumnName('model');
- expect(result).to.be.eq('foo');
- });
- it('returns a column name of a primary key if specified', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: DataType.NUMBER,
- primaryKey: true,
- columnName: 'fooColumn',
- },
- bar: {
- type: DataType.NUMBER,
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getPrimaryKeyAsColumnName('model');
- expect(result).to.be.eq('fooColumn');
- });
- it('returns a default property name if a primary key is not defined', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getPrimaryKeyAsColumnName('model');
- expect(result).to.be.eq(DEF_PK);
- });
- it('throws an error if a property name of a default primary key already in use as a regular property', function () {
- const schema = new Schema();
- const S = schema.getService(ModelDefinitionUtils);
- sandbox.on(
- S,
- 'getPropertiesDefinitionInBaseModelHierarchy',
- function (modelName) {
- expect(modelName).to.be.eq('model');
- return {[DEF_PK]: DataType.NUMBER};
- },
- );
- const throwable = () => S.getPrimaryKeyAsColumnName('model');
- expect(throwable).to.throw(
- format(
- 'The property name %v of the model "model" is defined as a regular property. ' +
- 'In this case, a primary key should be defined explicitly. ' +
- 'Do use the option "primaryKey" to specify the primary key.',
- DEF_PK,
- ),
- );
- });
- it('returns a property name of a custom primary key when a default primary key is used as a regular property', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- myId: {
- type: DataType.NUMBER,
- primaryKey: true,
- },
- [DEF_PK]: DataType.NUMBER,
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getPrimaryKeyAsColumnName('model');
- expect(result).to.be.eql('myId');
- });
- it('uses a base model hierarchy to get a column name of a primary key', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- foo: {
- type: DataType.STRING,
- primaryKey: true,
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- base: 'modelA',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getPrimaryKeyAsPropertyName('modelB');
- expect(result).to.be.eq('foo');
- });
- });
- describe('getTableNameByModelName', function () {
- it('returns a model name if no table name specified', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getTableNameByModelName('model');
- expect(result).to.be.eq('model');
- });
- it('returns a table name from a model definition', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- tableName: 'table',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getTableNameByModelName('model');
- expect(result).to.be.eq('table');
- });
- });
- describe('getColumnNameByPropertyName', function () {
- it('returns a property name if a column name is not defined', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: DataType.STRING,
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getColumnNameByPropertyName('model', 'foo');
- expect(result).to.be.eq('foo');
- });
- it('returns a specified column name', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: DataType.STRING,
- columnName: 'bar',
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getColumnNameByPropertyName('model', 'foo');
- expect(result).to.be.eq('bar');
- });
- it('throws an error if a given property name does not exist', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- });
- const throwable = () =>
- schema
- .getService(ModelDefinitionUtils)
- .getColumnNameByPropertyName('model', 'foo');
- expect(throwable).to.throw(InvalidArgumentError);
- });
- it('uses a base model hierarchy to get a specified column name', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- foo: {
- type: DataType.STRING,
- columnName: 'fooColumn',
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- base: 'modelA',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getColumnNameByPropertyName('modelB', 'foo');
- expect(result).to.be.eq('fooColumn');
- });
- });
- describe('getDefaultPropertyValue', function () {
- it('returns undefined if no default value specified', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: DataType.STRING,
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getDefaultPropertyValue('model', 'foo');
- expect(result).to.be.undefined;
- });
- it('returns a default value from a property definition', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: DataType.STRING,
- default: 'default',
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getDefaultPropertyValue('model', 'foo');
- expect(result).to.be.eq('default');
- });
- it('returns a value from a factory function', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: DataType.STRING,
- default: () => 'default',
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getDefaultPropertyValue('model', 'foo');
- expect(result).to.be.eq('default');
- });
- it('throws an error if a given property name does not exist', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- });
- const throwable = () =>
- schema
- .getService(ModelDefinitionUtils)
- .getDefaultPropertyValue('model', 'foo');
- expect(throwable).to.throw(InvalidArgumentError);
- });
- it('uses a base model hierarchy to get a specified default value', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- foo: {
- type: DataType.STRING,
- default: 'default',
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- base: 'modelA',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getDefaultPropertyValue('modelB', 'foo');
- expect(result).to.be.eq('default');
- });
- });
- describe('setDefaultValuesToEmptyProperties', function () {
- it('does nothing if no property definitions', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .setDefaultValuesToEmptyProperties('model', {foo: 'string'});
- expect(result).to.be.eql({foo: 'string'});
- });
- it('does nothing if no "default" option in property definition', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- baz: DataType.STRING,
- qux: DataType.NUMBER,
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .setDefaultValuesToEmptyProperties('model', {foo: 'string'});
- expect(result).to.be.eql({foo: 'string'});
- });
- it('sets a default value if a property does not exist', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: DataType.STRING,
- default: 'string',
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .setDefaultValuesToEmptyProperties('model', {});
- expect(result).to.be.eql({foo: 'string'});
- });
- it('sets a default value if a property is undefined', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: DataType.STRING,
- default: 'string',
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .setDefaultValuesToEmptyProperties('model', {foo: undefined});
- expect(result).to.be.eql({foo: 'string'});
- });
- it('sets a default value if a property is null', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: DataType.STRING,
- default: 'string',
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .setDefaultValuesToEmptyProperties('model', {foo: null});
- expect(result).to.be.eql({foo: 'string'});
- });
- it('sets a default value if a property has an empty value', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: DataType.STRING,
- default: 'placeholder',
- },
- },
- });
- schema
- .getService(EmptyValuesService)
- .setEmptyValuesOf(DataType.STRING, ['empty']);
- const result = schema
- .getService(ModelDefinitionUtils)
- .setDefaultValuesToEmptyProperties('model', {foo: 'empty'});
- expect(result).to.be.eql({foo: 'placeholder'});
- });
- it('sets a value from a factory function', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: DataType.STRING,
- default: () => 'string',
- },
- bar: {
- type: DataType.NUMBER,
- default: () => 10,
- },
- baz: {
- type: DataType.STRING,
- default: () => null,
- },
- qux: {
- type: DataType.STRING,
- default: () => undefined,
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .setDefaultValuesToEmptyProperties('model', {});
- expect(result).to.be.eql({
- foo: 'string',
- bar: 10,
- baz: null,
- qux: undefined,
- });
- });
- it('uses a base model hierarchy to set a default values', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- foo: {
- type: DataType.STRING,
- default: 'string',
- },
- bar: {
- type: DataType.NUMBER,
- default: 10,
- },
- baz: {
- type: DataType.STRING,
- default: null,
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- base: 'modelA',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .setDefaultValuesToEmptyProperties('modelB', {});
- expect(result).to.be.eql({
- foo: 'string',
- bar: 10,
- baz: null,
- });
- });
- describe('an option "onlyProvidedProperties" is true', function () {
- it('does not set a default value if a property does not exist', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: DataType.STRING,
- default: 'string',
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .setDefaultValuesToEmptyProperties('model', {}, true);
- expect(result).to.be.eql({});
- });
- it('sets a default value if a property is undefined', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: DataType.STRING,
- default: 'string',
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .setDefaultValuesToEmptyProperties('model', {foo: undefined}, true);
- expect(result).to.be.eql({foo: 'string'});
- });
- it('sets a default value if a property is null', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: DataType.STRING,
- default: 'string',
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .setDefaultValuesToEmptyProperties('model', {foo: null}, true);
- expect(result).to.be.eql({foo: 'string'});
- });
- });
- });
- describe('convertPropertyNamesToColumnNames', function () {
- it('does nothing if no property definitions', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .convertPropertyNamesToColumnNames('model', {foo: 'string'});
- expect(result).to.be.eql({foo: 'string'});
- });
- it('does nothing if no column name specified', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: DataType.STRING,
- bar: DataType.NUMBER,
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .convertPropertyNamesToColumnNames('model', {foo: 'string'});
- expect(result).to.be.eql({foo: 'string'});
- });
- it('replaces property names by column names', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: DataType.STRING,
- columnName: 'fooColumn',
- },
- bar: {
- type: DataType.NUMBER,
- columnName: 'barColumn',
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .convertPropertyNamesToColumnNames('model', {foo: 'string'});
- expect(result).to.be.eql({fooColumn: 'string'});
- });
- it('uses a base model hierarchy to replace property names by column names', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- foo: {
- type: DataType.STRING,
- columnName: 'fooColumn',
- },
- bar: {
- type: DataType.NUMBER,
- columnName: 'barColumn',
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- base: 'modelA',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .convertPropertyNamesToColumnNames('modelB', {foo: 'string'});
- expect(result).to.be.eql({fooColumn: 'string'});
- });
- describe('embedded object with model', function () {
- it('does nothing if no property definitions', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- embedded: {
- type: DataType.OBJECT,
- model: 'modelB',
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .convertPropertyNamesToColumnNames('modelA', {
- embedded: {foo: 'string'},
- });
- expect(result).to.be.eql({embedded: {foo: 'string'}});
- });
- it('does nothing if no column name specified', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- embedded: {
- type: DataType.OBJECT,
- model: 'modelB',
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- properties: {
- foo: DataType.STRING,
- bar: DataType.NUMBER,
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .convertPropertyNamesToColumnNames('modelA', {
- embedded: {foo: 'string', bar: 10},
- });
- expect(result).to.be.eql({embedded: {foo: 'string', bar: 10}});
- });
- it('replaces property names by column names', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- embedded: {
- type: DataType.OBJECT,
- model: 'modelB',
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- properties: {
- foo: {
- type: DataType.STRING,
- columnName: 'fooColumn',
- },
- bar: {
- type: DataType.NUMBER,
- columnName: 'barColumn',
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .convertPropertyNamesToColumnNames('modelA', {
- embedded: {foo: 'string', bar: 10},
- });
- expect(result).to.be.eql({
- embedded: {fooColumn: 'string', barColumn: 10},
- });
- });
- });
- describe('embedded array with items model', function () {
- it('does nothing if no property definitions', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- embedded: {
- type: DataType.ARRAY,
- itemType: DataType.OBJECT,
- itemModel: 'modelB',
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .convertPropertyNamesToColumnNames('modelA', {
- embedded: [{foo: 'val'}, {bar: 10}],
- });
- expect(result).to.be.eql({embedded: [{foo: 'val'}, {bar: 10}]});
- });
- it('does nothing if no column name specified', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- embedded: {
- type: DataType.ARRAY,
- itemType: DataType.OBJECT,
- itemModel: 'modelB',
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- properties: {
- foo: DataType.STRING,
- bar: DataType.NUMBER,
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .convertPropertyNamesToColumnNames('modelA', {
- embedded: [
- {foo: 'val1', bar: 10},
- {foo: 'val2', bar: 20},
- ],
- });
- expect(result).to.be.eql({
- embedded: [
- {foo: 'val1', bar: 10},
- {foo: 'val2', bar: 20},
- ],
- });
- });
- it('replaces property names by column names', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- embedded: {
- type: DataType.ARRAY,
- itemType: DataType.OBJECT,
- itemModel: 'modelB',
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- properties: {
- foo: {
- type: DataType.STRING,
- columnName: 'fooColumn',
- },
- bar: {
- type: DataType.NUMBER,
- columnName: 'barColumn',
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .convertPropertyNamesToColumnNames('modelA', {
- embedded: [
- {foo: 'val1', bar: 10},
- {foo: 'val2', bar: 20},
- ],
- });
- expect(result).to.be.eql({
- embedded: [
- {fooColumn: 'val1', barColumn: 10},
- {fooColumn: 'val2', barColumn: 20},
- ],
- });
- });
- });
- });
- describe('convertColumnNamesToPropertyNames', function () {
- it('does nothing if no property definitions', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .convertColumnNamesToPropertyNames('model', {foo: 'string'});
- expect(result).to.be.eql({foo: 'string'});
- });
- it('does nothing if no column name specified', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: DataType.STRING,
- bar: DataType.NUMBER,
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .convertColumnNamesToPropertyNames('model', {foo: 'string'});
- expect(result).to.be.eql({foo: 'string'});
- });
- it('replaces column names by property names', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: DataType.STRING,
- columnName: 'fooColumn',
- },
- bar: {
- type: DataType.NUMBER,
- columnName: 'barColumn',
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .convertColumnNamesToPropertyNames('model', {fooColumn: 'string'});
- expect(result).to.be.eql({foo: 'string'});
- });
- it('uses a base model hierarchy to replace column names by property names', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- foo: {
- type: DataType.STRING,
- columnName: 'fooColumn',
- },
- bar: {
- type: DataType.NUMBER,
- columnName: 'barColumn',
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- base: 'modelA',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .convertColumnNamesToPropertyNames('modelA', {fooColumn: 'string'});
- expect(result).to.be.eql({foo: 'string'});
- });
- describe('embedded object with model', function () {
- it('does nothing if no property definitions', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- embedded: {
- type: DataType.OBJECT,
- model: 'modelB',
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .convertColumnNamesToPropertyNames('modelA', {
- embedded: {foo: 'string'},
- });
- expect(result).to.be.eql({embedded: {foo: 'string'}});
- });
- it('does nothing if no column name specified', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- embedded: {
- type: DataType.OBJECT,
- model: 'modelB',
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- properties: {
- foo: DataType.STRING,
- bar: DataType.NUMBER,
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .convertColumnNamesToPropertyNames('modelA', {
- embedded: {foo: 'string', bar: 10},
- });
- expect(result).to.be.eql({embedded: {foo: 'string', bar: 10}});
- });
- it('replaces property names by column names', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- embedded: {
- type: DataType.OBJECT,
- model: 'modelB',
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- properties: {
- foo: {
- type: DataType.STRING,
- columnName: 'fooColumn',
- },
- bar: {
- type: DataType.NUMBER,
- columnName: 'barColumn',
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .convertColumnNamesToPropertyNames('modelA', {
- embedded: {fooColumn: 'string', barColumn: 10},
- });
- expect(result).to.be.eql({embedded: {foo: 'string', bar: 10}});
- });
- });
- describe('embedded array with items model', function () {
- it('does nothing if no property definitions', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- embedded: {
- type: DataType.ARRAY,
- itemType: DataType.OBJECT,
- itemModel: 'modelB',
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .convertColumnNamesToPropertyNames('modelA', {
- embedded: [{foo: 'val'}, {bar: 10}],
- });
- expect(result).to.be.eql({embedded: [{foo: 'val'}, {bar: 10}]});
- });
- it('does nothing if no column name specified', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- embedded: {
- type: DataType.ARRAY,
- itemType: DataType.OBJECT,
- itemModel: 'modelB',
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- properties: {
- foo: DataType.STRING,
- bar: DataType.NUMBER,
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .convertColumnNamesToPropertyNames('modelA', {
- embedded: [
- {foo: 'val1', bar: 10},
- {foo: 'val2', bar: 20},
- ],
- });
- expect(result).to.be.eql({
- embedded: [
- {foo: 'val1', bar: 10},
- {foo: 'val2', bar: 20},
- ],
- });
- });
- it('replaces property names by column names', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- embedded: {
- type: DataType.ARRAY,
- itemType: DataType.OBJECT,
- itemModel: 'modelB',
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- properties: {
- foo: {
- type: DataType.STRING,
- columnName: 'fooColumn',
- },
- bar: {
- type: DataType.NUMBER,
- columnName: 'barColumn',
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .convertColumnNamesToPropertyNames('modelA', {
- embedded: [
- {fooColumn: 'val1', barColumn: 10},
- {fooColumn: 'val2', barColumn: 20},
- ],
- });
- expect(result).to.be.eql({
- embedded: [
- {foo: 'val1', bar: 10},
- {foo: 'val2', bar: 20},
- ],
- });
- });
- });
- });
- describe('getDataTypeByPropertyName', function () {
- it('returns a property type of a short property definition', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: DataType.STRING,
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getDataTypeByPropertyName('model', 'foo');
- expect(result).to.be.eq(DataType.STRING);
- });
- it('returns a property type of a full property definition', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: DataType.STRING,
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getDataTypeByPropertyName('model', 'foo');
- expect(result).to.be.eq(DataType.STRING);
- });
- it('throws an error if a property name does not exist', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- });
- const throwable = () =>
- schema
- .getService(ModelDefinitionUtils)
- .getDataTypeByPropertyName('model', 'property');
- expect(throwable).to.throw(InvalidArgumentError);
- });
- it('uses a base model hierarchy to get a type from a short property definition', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- foo: DataType.STRING,
- },
- });
- schema.defineModel({
- name: 'modelB',
- base: 'modelA',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getDataTypeByPropertyName('modelB', 'foo');
- expect(result).to.be.eq(DataType.STRING);
- });
- it('uses a base model hierarchy to get a type from a full property definition', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- foo: {
- type: DataType.STRING,
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- base: 'modelA',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getDataTypeByPropertyName('modelB', 'foo');
- expect(result).to.be.eq(DataType.STRING);
- });
- });
- describe('getDataTypeFromPropertyDefinition', function () {
- it('requires the given argument "propDef" must be an Object or DataType', function () {
- const schema = new Schema();
- const S = schema.getService(ModelDefinitionUtils);
- const throwable = v => () => S.getDataTypeFromPropertyDefinition(v);
- const error = v =>
- format(
- 'The argument "propDef" of the ModelDefinitionUtils.getDataTypeFromPropertyDefinition ' +
- 'should be an Object or the DataType enum, but %s given.',
- v,
- );
- expect(throwable('str')).to.throw(error('"str"'));
- expect(throwable('')).to.throw(error('""'));
- expect(throwable(10)).to.throw(error('10'));
- expect(throwable(0)).to.throw(error('0'));
- expect(throwable(true)).to.throw(error('true'));
- expect(throwable(false)).to.throw(error('false'));
- expect(throwable(undefined)).to.throw(error('undefined'));
- expect(throwable(null)).to.throw(error('null'));
- throwable(DataType.ANY)();
- throwable({type: DataType.ANY})();
- });
- it('requires the given Object to have the "type" property with the DataType enum', function () {
- const schema = new Schema();
- const S = schema.getService(ModelDefinitionUtils);
- const throwable = v => () =>
- S.getDataTypeFromPropertyDefinition({type: v});
- const error = v =>
- format(
- 'The given Object to the ModelDefinitionUtils.getDataTypeFromPropertyDefinition ' +
- 'should have the "type" property with one of values: %l, but %s given.',
- Object.values(DataType),
- v,
- );
- expect(throwable('str')).to.throw(error('"str"'));
- expect(throwable('')).to.throw(error('""'));
- expect(throwable(10)).to.throw(error('10'));
- expect(throwable(0)).to.throw(error('0'));
- expect(throwable(true)).to.throw(error('true'));
- expect(throwable(false)).to.throw(error('false'));
- expect(throwable(undefined)).to.throw(error('undefined'));
- expect(throwable(null)).to.throw(error('null'));
- throwable(DataType.ANY)();
- });
- it('returns the DataType from the given DataType enum', function () {
- const schema = new Schema();
- const S = schema.getService(ModelDefinitionUtils);
- const res = S.getDataTypeFromPropertyDefinition(DataType.STRING);
- expect(res).to.be.eq(DataType.STRING);
- });
- it('returns the DataType from the given PropertyDefinition', function () {
- const schema = new Schema();
- const S = schema.getService(ModelDefinitionUtils);
- const res = S.getDataTypeFromPropertyDefinition({type: DataType.STRING});
- expect(res).to.be.eq(DataType.STRING);
- });
- });
- describe('getOwnPropertiesDefinitionWithoutPrimaryKeys', function () {
- it('returns an empty object if a model does not have properties', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getOwnPropertiesDefinitionWithoutPrimaryKeys('model');
- expect(result).to.be.eql({});
- });
- it('returns a properties definition without primary keys', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- id: {
- type: DataType.STRING,
- primaryKey: true,
- },
- foo: DataType.STRING,
- bar: DataType.STRING,
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getOwnPropertiesDefinitionWithoutPrimaryKeys('model');
- expect(result).to.be.eql({
- foo: DataType.STRING,
- bar: DataType.STRING,
- });
- });
- it('returns its own properties definition even it has a base model properties', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- id: {
- type: DataType.STRING,
- primaryKey: true,
- },
- foo: DataType.STRING,
- bar: DataType.STRING,
- },
- });
- schema.defineModel({
- name: 'modelB',
- base: 'modelA',
- properties: {
- id: {
- type: DataType.NUMBER,
- primaryKey: true,
- },
- foo: DataType.NUMBER,
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getOwnPropertiesDefinitionWithoutPrimaryKeys('modelB');
- expect(result).to.be.eql({
- foo: DataType.NUMBER,
- });
- });
- });
- describe('getOwnPropertiesDefinitionOfPrimaryKeys', function () {
- it('returns an empty object if a model does not have properties', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getOwnPropertiesDefinitionOfPrimaryKeys('model');
- expect(result).to.be.eql({});
- });
- it('returns a properties definition of primary keys', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- id: {
- type: DataType.STRING,
- primaryKey: true,
- },
- foo: DataType.STRING,
- bar: DataType.NUMBER,
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getOwnPropertiesDefinitionOfPrimaryKeys('model');
- expect(result).to.be.eql({
- id: {
- type: DataType.STRING,
- primaryKey: true,
- },
- });
- });
- it('returns its own properties definition even it has a base model properties', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- id: {
- type: DataType.STRING,
- primaryKey: true,
- },
- foo: DataType.STRING,
- bar: DataType.STRING,
- },
- });
- schema.defineModel({
- name: 'modelB',
- base: 'modelA',
- properties: {
- id: {
- type: DataType.NUMBER,
- primaryKey: true,
- },
- foo: DataType.NUMBER,
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getOwnPropertiesDefinitionOfPrimaryKeys('modelB');
- expect(result).to.be.eql({
- id: {
- type: DataType.NUMBER,
- primaryKey: true,
- },
- });
- });
- });
- describe('getPropertiesDefinitionInBaseModelHierarchy', function () {
- it('returns an empty object if a model does not have properties', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getPropertiesDefinitionInBaseModelHierarchy('model');
- expect(result).to.be.eql({});
- });
- it('returns a properties definition of a model', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- id: {
- type: DataType.STRING,
- primaryKey: true,
- },
- foo: DataType.STRING,
- bar: DataType.NUMBER,
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getPropertiesDefinitionInBaseModelHierarchy('model');
- expect(result).to.be.eql({
- id: {
- type: DataType.STRING,
- primaryKey: true,
- },
- foo: DataType.STRING,
- bar: DataType.NUMBER,
- });
- });
- it('returns a properties definition of an extended model', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- foo: DataType.STRING,
- },
- });
- schema.defineModel({
- name: 'modelB',
- base: 'modelA',
- properties: {
- bar: DataType.NUMBER,
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getPropertiesDefinitionInBaseModelHierarchy('modelB');
- expect(result).to.be.eql({
- foo: DataType.STRING,
- bar: DataType.NUMBER,
- });
- });
- it('uses child properties in priority over a base model properties', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- id: {
- type: DataType.STRING,
- primaryKey: true,
- },
- foo: DataType.STRING,
- bar: DataType.STRING,
- },
- });
- schema.defineModel({
- name: 'modelB',
- base: 'modelA',
- properties: {
- id: {
- type: DataType.NUMBER,
- primaryKey: true,
- },
- foo: DataType.NUMBER,
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getPropertiesDefinitionInBaseModelHierarchy('modelB');
- expect(result).to.be.eql({
- id: {
- type: DataType.NUMBER,
- primaryKey: true,
- },
- foo: DataType.NUMBER,
- bar: DataType.STRING,
- });
- });
- it('uses primary keys from a model closest to child model', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- properties: {
- id1: {
- type: DataType.STRING,
- primaryKey: true,
- },
- foo: DataType.STRING,
- },
- });
- schema.defineModel({
- name: 'modelB',
- base: 'modelA',
- properties: {
- id2: {
- type: DataType.STRING,
- primaryKey: true,
- },
- bar: DataType.NUMBER,
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getPropertiesDefinitionInBaseModelHierarchy('modelB');
- expect(result).to.be.eql({
- id2: {
- type: DataType.STRING,
- primaryKey: true,
- },
- foo: DataType.STRING,
- bar: DataType.NUMBER,
- });
- });
- it('throws an error for a circular reference', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- base: 'model',
- });
- const throwable = () =>
- schema
- .getService(ModelDefinitionUtils)
- .getPropertiesDefinitionInBaseModelHierarchy('model');
- expect(throwable).to.throw(
- 'The model "model" has a circular inheritance.',
- );
- });
- });
- describe('getOwnRelationsDefinition', function () {
- it('returns an empty object if a model does not have relations', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getOwnRelationsDefinition('model');
- expect(result).to.be.eql({});
- });
- it('returns a relations definition by a given model', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- relations: {
- foo: {
- type: RelationType.BELONGS_TO,
- model: 'model',
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getOwnRelationsDefinition('model');
- expect(result).to.be.eql({
- foo: {
- type: RelationType.BELONGS_TO,
- model: 'model',
- },
- });
- });
- it('returns its own relations definition even it has a base model relations', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- relations: {
- foo: {
- type: RelationType.BELONGS_TO,
- model: 'modelA',
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- base: 'modelA',
- relations: {
- bar: {
- type: RelationType.BELONGS_TO,
- model: 'modelB',
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getOwnRelationsDefinition('modelB');
- expect(result).to.be.eql({
- bar: {
- type: RelationType.BELONGS_TO,
- model: 'modelB',
- },
- });
- });
- });
- describe('getRelationsDefinitionInBaseModelHierarchy', function () {
- it('returns an empty object if a model does not have relations', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getRelationsDefinitionInBaseModelHierarchy('model');
- expect(result).to.be.eql({});
- });
- it('returns a relations definition of a model', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- relations: {
- foo: {
- type: RelationType.BELONGS_TO,
- model: 'model',
- },
- bar: {
- type: RelationType.BELONGS_TO,
- model: 'model',
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getRelationsDefinitionInBaseModelHierarchy('model');
- expect(result).to.be.eql({
- foo: {
- type: RelationType.BELONGS_TO,
- model: 'model',
- },
- bar: {
- type: RelationType.BELONGS_TO,
- model: 'model',
- },
- });
- });
- it('returns a relations definition of an extended model', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- relations: {
- foo: {
- type: RelationType.BELONGS_TO,
- model: 'modelA',
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- base: 'modelA',
- relations: {
- bar: {
- type: RelationType.BELONGS_TO,
- model: 'modelB',
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getRelationsDefinitionInBaseModelHierarchy('modelB');
- expect(result).to.be.eql({
- foo: {
- type: RelationType.BELONGS_TO,
- model: 'modelA',
- },
- bar: {
- type: RelationType.BELONGS_TO,
- model: 'modelB',
- },
- });
- });
- it('uses child relations in priority over a base model relations', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- relations: {
- foo: {
- type: RelationType.BELONGS_TO,
- model: 'modelA',
- },
- bar: {
- type: RelationType.BELONGS_TO,
- model: 'modelA',
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- base: 'modelA',
- relations: {
- foo: {
- type: RelationType.REFERENCES_MANY,
- model: 'modelB',
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getRelationsDefinitionInBaseModelHierarchy('modelB');
- expect(result).to.be.eql({
- foo: {
- type: RelationType.REFERENCES_MANY,
- model: 'modelB',
- },
- bar: {
- type: RelationType.BELONGS_TO,
- model: 'modelA',
- },
- });
- });
- it('throws an error for a circular reference', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- base: 'model',
- });
- const throwable = () =>
- schema
- .getService(ModelDefinitionUtils)
- .getRelationsDefinitionInBaseModelHierarchy('model');
- expect(throwable).to.throw(
- 'The model "model" has a circular inheritance.',
- );
- });
- });
- describe('getRelationDefinitionByName', function () {
- it('throws an error if a given model is not found', function () {
- const schema = new Schema();
- const throwable = () =>
- schema
- .getService(ModelDefinitionUtils)
- .getRelationDefinitionByName('model', 'myRelation');
- expect(throwable).to.throw('The model "model" is not defined.');
- });
- it('throws an error if a given relation is not found', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- });
- const throwable = () =>
- schema
- .getService(ModelDefinitionUtils)
- .getRelationDefinitionByName('model', 'myRelation');
- expect(throwable).to.throw(
- 'The model "model" does not have relation name "myRelation".',
- );
- });
- it('returns a relation definition by a given name', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- relations: {
- myRelation: {
- type: RelationType.BELONGS_TO,
- model: 'model',
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getRelationDefinitionByName('model', 'myRelation');
- expect(result).to.be.eql({
- type: RelationType.BELONGS_TO,
- model: 'model',
- });
- });
- it('uses a child relations in priority over a base model relations', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- relations: {
- myRelation: {
- type: RelationType.BELONGS_TO,
- model: 'modelA',
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- base: 'modelA',
- relations: {
- myRelation: {
- type: RelationType.REFERENCES_MANY,
- model: 'modelA',
- },
- },
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getRelationDefinitionByName('modelB', 'myRelation');
- expect(result).to.be.eql({
- type: RelationType.REFERENCES_MANY,
- model: 'modelA',
- });
- });
- it('returns a base model relation if a given relation name is not found in a child model', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'modelA',
- relations: {
- myRelation: {
- type: RelationType.BELONGS_TO,
- model: 'modelA',
- },
- },
- });
- schema.defineModel({
- name: 'modelB',
- base: 'modelA',
- });
- const result = schema
- .getService(ModelDefinitionUtils)
- .getRelationDefinitionByName('modelB', 'myRelation');
- expect(result).to.be.eql({
- type: RelationType.BELONGS_TO,
- model: 'modelA',
- });
- });
- });
- describe('excludeObjectKeysByRelationNames', function () {
- it('excludes object keys by relation names', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- relations: {
- baz: {
- type: RelationType.BELONGS_TO,
- model: 'model',
- },
- qux: {
- type: RelationType.BELONGS_TO,
- model: 'model',
- },
- },
- });
- const input = {
- foo: 'fooVal',
- bar: {val: 'barVal'},
- baz: 'bazVal',
- qux: {val: 'quxVal'},
- };
- const result = schema
- .getService(ModelDefinitionUtils)
- .excludeObjectKeysByRelationNames('model', input);
- expect(result).to.be.eql({foo: 'fooVal', bar: {val: 'barVal'}});
- expect(result).to.be.not.eq(input);
- });
- it('requires a given object as an object', function () {
- const schema = new Schema();
- schema.defineModel({name: 'model'});
- const throwable = v => () =>
- schema
- .getService(ModelDefinitionUtils)
- .excludeObjectKeysByRelationNames('model', v);
- const error = v =>
- format(
- 'The second argument of ModelDefinitionUtils.excludeObjectKeysByRelationNames ' +
- 'should be an Object, but %s given.',
- v,
- );
- expect(throwable('')).to.throw(error('""'));
- expect(throwable('str')).to.throw(error('"str"'));
- expect(throwable(10)).to.throw(error('10'));
- expect(throwable(true)).to.throw(error('true'));
- expect(throwable(false)).to.throw(error('false'));
- expect(throwable([])).to.throw(error('Array'));
- expect(throwable(undefined)).to.throw(error('undefined'));
- expect(throwable(null)).to.throw(error('null'));
- throwable({})();
- throwable({foo: 'bar'})();
- });
- });
- describe('getModelNameOfPropertyValueIfDefined', function () {
- it('returns undefined if a given property does not exist in the model', function () {
- const schema = new Schema();
- schema.defineModel({name: 'model'});
- const S = schema.getService(ModelDefinitionUtils);
- const res = S.getModelNameOfPropertyValueIfDefined('model', 'foo');
- expect(res).to.be.undefined;
- });
- describe('short property definition', function () {
- it('requires parameter "modelName" to be a non-empty String', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: DataType.OBJECT,
- },
- });
- const S = schema.getService(ModelDefinitionUtils);
- const throwable = v => () =>
- S.getModelNameOfPropertyValueIfDefined(v, 'foo');
- const error = v =>
- format(
- 'Parameter "modelName" of ' +
- 'ModelDefinitionUtils.getModelNameOfPropertyValueIfDefined ' +
- 'requires a non-empty String, but %s given.',
- v,
- );
- expect(throwable('')).to.throw(error('""'));
- expect(throwable(10)).to.throw(error('10'));
- expect(throwable(true)).to.throw(error('true'));
- expect(throwable(false)).to.throw(error('false'));
- expect(throwable([])).to.throw(error('Array'));
- expect(throwable({})).to.throw(error('Object'));
- expect(throwable(undefined)).to.throw(error('undefined'));
- expect(throwable(null)).to.throw(error('null'));
- throwable('model')();
- });
- it('requires parameter "propertyName" to be a non-empty String', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: DataType.OBJECT,
- },
- });
- const S = schema.getService(ModelDefinitionUtils);
- const throwable = v => () =>
- S.getModelNameOfPropertyValueIfDefined('model', v);
- const error = v =>
- format(
- 'Parameter "propertyName" of ' +
- 'ModelDefinitionUtils.getModelNameOfPropertyValueIfDefined ' +
- 'requires a non-empty String, but %s given.',
- v,
- );
- expect(throwable('')).to.throw(error('""'));
- expect(throwable(10)).to.throw(error('10'));
- expect(throwable(true)).to.throw(error('true'));
- expect(throwable(false)).to.throw(error('false'));
- expect(throwable([])).to.throw(error('Array'));
- expect(throwable({})).to.throw(error('Object'));
- expect(throwable(undefined)).to.throw(error('undefined'));
- expect(throwable(null)).to.throw(error('null'));
- throwable('foo')();
- });
- it('returns undefined if the property definition is DataType', function () {
- const fn = v => {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: v,
- },
- });
- const S = schema.getService(ModelDefinitionUtils);
- return S.getModelNameOfPropertyValueIfDefined('model', 'foo');
- };
- expect(fn(DataType.ANY)).to.be.undefined;
- expect(fn(DataType.STRING)).to.be.undefined;
- expect(fn(DataType.NUMBER)).to.be.undefined;
- expect(fn(DataType.BOOLEAN)).to.be.undefined;
- expect(fn(DataType.ARRAY)).to.be.undefined;
- expect(fn(DataType.OBJECT)).to.be.undefined;
- });
- });
- describe('full property definition', function () {
- it('requires parameter "modelName" to be a non-empty String', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: DataType.OBJECT,
- },
- },
- });
- const S = schema.getService(ModelDefinitionUtils);
- const throwable = v => () =>
- S.getModelNameOfPropertyValueIfDefined(v, 'foo');
- const error = v =>
- format(
- 'Parameter "modelName" of ' +
- 'ModelDefinitionUtils.getModelNameOfPropertyValueIfDefined ' +
- 'requires a non-empty String, but %s given.',
- v,
- );
- expect(throwable('')).to.throw(error('""'));
- expect(throwable(10)).to.throw(error('10'));
- expect(throwable(true)).to.throw(error('true'));
- expect(throwable(false)).to.throw(error('false'));
- expect(throwable([])).to.throw(error('Array'));
- expect(throwable({})).to.throw(error('Object'));
- expect(throwable(undefined)).to.throw(error('undefined'));
- expect(throwable(null)).to.throw(error('null'));
- throwable('model')();
- });
- it('requires parameter "propertyName" to be a non-empty String', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: DataType.OBJECT,
- },
- },
- });
- const S = schema.getService(ModelDefinitionUtils);
- const throwable = v => () =>
- S.getModelNameOfPropertyValueIfDefined('model', v);
- const error = v =>
- format(
- 'Parameter "propertyName" of ' +
- 'ModelDefinitionUtils.getModelNameOfPropertyValueIfDefined ' +
- 'requires a non-empty String, but %s given.',
- v,
- );
- expect(throwable('')).to.throw(error('""'));
- expect(throwable(10)).to.throw(error('10'));
- expect(throwable(true)).to.throw(error('true'));
- expect(throwable(false)).to.throw(error('false'));
- expect(throwable([])).to.throw(error('Array'));
- expect(throwable({})).to.throw(error('Object'));
- expect(throwable(undefined)).to.throw(error('undefined'));
- expect(throwable(null)).to.throw(error('null'));
- throwable('foo')();
- });
- it('return undefined if no model name specified', function () {
- const fn = v => {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: v,
- },
- },
- });
- const S = schema.getService(ModelDefinitionUtils);
- return S.getModelNameOfPropertyValueIfDefined('model', 'foo');
- };
- expect(fn(DataType.ANY)).to.be.undefined;
- expect(fn(DataType.STRING)).to.be.undefined;
- expect(fn(DataType.NUMBER)).to.be.undefined;
- expect(fn(DataType.BOOLEAN)).to.be.undefined;
- expect(fn(DataType.ARRAY)).to.be.undefined;
- expect(fn(DataType.OBJECT)).to.be.undefined;
- });
- it('return undefined if no model name specified in case of Array property', function () {
- const fn = v => {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: DataType.ARRAY,
- itemType: v,
- },
- },
- });
- const S = schema.getService(ModelDefinitionUtils);
- return S.getModelNameOfPropertyValueIfDefined('model', 'foo');
- };
- expect(fn(DataType.ANY)).to.be.undefined;
- expect(fn(DataType.STRING)).to.be.undefined;
- expect(fn(DataType.NUMBER)).to.be.undefined;
- expect(fn(DataType.BOOLEAN)).to.be.undefined;
- expect(fn(DataType.ARRAY)).to.be.undefined;
- expect(fn(DataType.OBJECT)).to.be.undefined;
- });
- it('returns a model name from the option "model" in case of Object property', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: DataType.OBJECT,
- model: 'myModel',
- },
- },
- });
- const S = schema.getService(ModelDefinitionUtils);
- const res = S.getModelNameOfPropertyValueIfDefined('model', 'foo');
- expect(res).to.be.eq('myModel');
- });
- it('returns a model name from the option "itemModel" in case of Array property', function () {
- const schema = new Schema();
- schema.defineModel({
- name: 'model',
- properties: {
- foo: {
- type: DataType.ARRAY,
- itemType: DataType.OBJECT,
- itemModel: 'myModel',
- },
- },
- });
- const S = schema.getService(ModelDefinitionUtils);
- const res = S.getModelNameOfPropertyValueIfDefined('model', 'foo');
- expect(res).to.be.eq('myModel');
- });
- });
- });
- });
|