WIP Custom fields feature.

This commit is contained in:
Ahmed Bouhuolia
2020-01-26 21:14:21 +02:00
parent 77c67cc4cb
commit a97b527e8c
10 changed files with 326 additions and 75 deletions

View File

@@ -1,13 +1,13 @@
import Option from '@/models/Option';
import MetadataCollection from '@/lib/Metable/MetableCollection';
import ResourceFieldMetadata from '@/models/ResourceFieldMetadata';
import { create, expect } from '~/testInit';
describe('MetableCollection', () => {
describe('findMeta', () => {
it('Should retrieve the found meta object.', async () => {
const option = await create('option');
const options = await Option.query();
const metadataCollection = MetadataCollection.from(options);
const metadataCollection = await Option.query();
const foundMeta = metadataCollection.findMeta(option.key);
expect(foundMeta).to.be.an('object');
@@ -17,9 +17,7 @@ describe('MetableCollection', () => {
describe('allMetadata', () => {
it('Should retrieve all exists metadata entries.', async () => {
const option = await create('option');
const options = await Option.query();
const metadataCollection = MetadataCollection.from(options);
const metadataCollection = await Option.query();
const foundMetadata = metadataCollection.allMetadata();
expect(foundMetadata.length).equals(1);
@@ -29,21 +27,17 @@ describe('MetableCollection', () => {
describe('getMeta', () => {
it('Should retrieve the found meta value.', async () => {
const option = await create('option');
const options = await Option.query();
const metadataCollection = MetadataCollection.from(options);
const metadataCollection = await Option.query();
const foundMeta = metadataCollection.getMeta(option.key);
expect(foundMeta).equals(option.value);
});
it('Should retrieve the default meta value in case the meta key was not exist.', async () => {
const option = await create('option');
const options = await Option.query();
const metadataCollection = MetadataCollection.from(options);
const metadataCollection = await Option.query();
const foundMeta = metadataCollection.getMeta('not-found', true);
expect(foundMeta).equals(true);
});
});
@@ -60,6 +54,8 @@ describe('MetableCollection', () => {
describe('removeAllMeta()', () => {
it('Should remove all metadata from the stack.', async () => {
const metadataCollection = new MetadataCollection();
metadataCollection.setModel(Option);
metadataCollection.setMeta('key', 'value');
metadataCollection.setMeta('key2', 'value2');
@@ -73,24 +69,28 @@ describe('MetableCollection', () => {
describe('saveMeta', () => {
it('Should save inserted new metadata.', async () => {
const metadataCollection = new MetadataCollection();
metadataCollection.setModel(Option);
metadataCollection.setMeta('key', 'value');
metadataCollection.setModel(Option);
await metadataCollection.saveMeta();
const storedMetadata = await Option.query();
expect(storedMetadata.length).equals(1);
expect(storedMetadata.metadata.length).equals(1);
});
it('Should save updated the exist metadata.', async () => {
const option = await create('option');
const metadataCollection = new MetadataCollection();
metadataCollection.setModel(Option);
metadataCollection.setMeta(option.key, 'value');
metadataCollection.setModel(Option);
await metadataCollection.saveMeta();
const storedMetadata = Option.query().where('key', option.key).first();
const storedMetadata = await Option.query().where('key', option.key).first();
expect(storedMetadata.value).equals('value');
});
@@ -108,5 +108,22 @@ describe('MetableCollection', () => {
const storedMetadata = await Option.query();
expect(storedMetadata.length).equals(0);
});
it('Should save instered new metadata with extra columns.', async () => {
const resource = await create('resource');
const metadataCollection = new MetadataCollection();
metadataCollection.extraColumns = ['resource_id'];
metadataCollection.setModel(ResourceFieldMetadata);
metadataCollection.setMeta('key', 'value', { resource_id: resource.id });
await metadataCollection.saveMeta();
const storedMetadata = await ResourceFieldMetadata.query().first();
expect(storedMetadata.metadata.length).equals(1);
expect(storedMetadata.metadata[0].resourceId).equals(resource.id);
});
});
});

View File

@@ -1,5 +1,4 @@
import {
request,
expect,
create,
login,
@@ -26,20 +25,31 @@ describe('ResourceCustomFieldRepository', () => {
});
});
describe('fetchCustomFields', () => {
describe('loadResource()', () => {
it('Should fetches the resource name.', async () => {
const resource = await create('resource', { name: 'Expense' });
const customFieldsRepo = new ResourceCustomFieldRepository(Expense);
await customFieldsRepo.loadResource();
expect(customFieldsRepo.resource.name).equals('Expense');
});
});
describe('loadResourceCustomFields()', () => {
it('Should fetches all custom fields that associated with the resource.', async () => {
const resource = await create('resource', { name: 'Expense' });
const resourceField = await create('resource_field', { resource_id: resource.id });
const resourceField2 = await create('resource_field', { resource_id: resource.id });
const customFieldsRepo = new ResourceCustomFieldRepository(Expense);
await customFieldsRepo.fetchCustomFields();
await customFieldsRepo.loadResource();
await customFieldsRepo.loadResourceCustomFields();
expect(customFieldsRepo.customFields.length).equals(2);
});
});
describe.only('fetchCustomFieldsMetadata', () => {
describe('fetchCustomFieldsMetadata', () => {
it('Should fetches all custom fields metadata that associated to the resource and resource item.', async () => {
const resource = await create('resource', { name: 'Expense' });
const resourceField = await create('resource_field', { resource_id: resource.id });
@@ -52,46 +62,64 @@ describe('ResourceCustomFieldRepository', () => {
});
const customFieldsRepo = new ResourceCustomFieldRepository(Expense);
await customFieldsRepo.fetchCustomFields();
await customFieldsRepo.load();
await customFieldsRepo.fetchCustomFieldsMetadata(expense.id);
expect(customFieldsRepo.metadata[expense.id].metadata.length).equals(1);
expect(customFieldsRepo.metadata[expense.id].metadata[0].key).equals(fieldMetadata.key);
expect(customFieldsRepo.metadata[expense.id].metadata[0].value).equals(fieldMetadata.value);
});
});
describe('fillCustomFields', () => {
});
describe('saveCustomFields', () => {
it('Should save the given custom fields metadata to the resource item.', () => {
const resource = await create('resource');
const resourceField = await create('resource_field', { resource_field: resource.id });
it('Should fill custom fields metadata attributes to metadata object.', async () => {
const resource = await create('resource', { name: 'Expense' });
const resourceField = await create('resource_field', { resource_id: resource.id });
const expense = await create('expense');
const fieldMetadata = await create('resource_custom_field_metadata', {
resource_id: resource.id, resource_item_id: expense.id,
});
const customFieldsRepo = new ResourceCustomFieldRepository(Expense);
await customFieldsRepo.load();
await customFieldsRepo.fetchCustomFieldsMetadata(expense.id);
customFieldsRepo.fillCustomFields(expense.id, [
{
key: resourceField.key,
value: 'Hello World',
},
]);
expect(customFieldsRepo.fieldsMetadata[expense.id].metadata.length).equals(1);
expect(customFieldsRepo.filledCustomFields[expense.id].length).equals(1);
});
});
describe('saveCustomFields', () => {
it('Should save the given custom fields metadata to the resource item.', async () => {
const resource = await create('resource', { name: 'Expense' });
const resourceField = await create('resource_field', { resource_id: resource.id });
const expense = await create('expense');
const fieldMetadata = await create('resource_custom_field_metadata', {
key: resourceField.slug,
resource_id: resource.id,
resource_item_id: expense.id,
});
const customFieldsRepo = new ResourceCustomFieldRepository(Expense);
await customFieldsRepo.load();
await customFieldsRepo.fetchCustomFieldsMetadata(expense.id);
customFieldsRepo.fillCustomFields(expense.id, [
{ key: resourceField.slug, value: 'Hello World' },
]);
await customFieldsRepo.saveCustomFields();
await customFieldsRepo.saveCustomFields(expense.id);
const updateResourceFieldData = await ResourceFieldMetadata.query()
.where('resource_id', resource.id)
.where('resource_item_id', expense.id)
.first();
expect(updateResourceFieldData.value).equals('Hello World');
const updateResourceFieldData = await ResourceFieldMetadata.query();
expect(updateResourceFieldData.metadata[0].value).equals('Hello World');
});
});
// describe('validateExistCustomFields', () => {
describe('validateExistCustomFields', () => {
// });
});
});

View File

@@ -6,6 +6,7 @@ import {
} from '~/testInit';
import AccountTransaction from '@/models/AccountTransaction';
import Expense from '@/models/Expense';
import ResourceFieldMetadata from '@/models/ResourceFieldMetadata';
let loginRes;
let expenseType;
@@ -143,16 +144,60 @@ describe('routes: /expenses/', () => {
});
const expenseTransaction = await Expense.query().where('id', res.body.id);
expect(expenseTransaction.amount).equals(100);
});
it('Should response bad request in case custom field slug was not exists in the storage.', () => {
it('Should response bad request in case custom field slug was not exists in the storage.', async () => {
const res = await request()
.post('/api/expenses')
.set('x-access-token', loginRes.body.token)
.send({
expense_account_id: expenseAccount.id,
payment_account_id: cashAccount.id,
amount: 100,
custom_options: [
{
key: 'random_key',
value: 'Value here',
},
],
});
expect(res.status).equals(400);
});
it('Should save expense custom fields to the storage.', () => {
it('Should save expense custom fields to the storage.', async () => {
const resource = await create('resource', { name: 'Expense' });
const resourceField = await create('resource_field', {
resource_id: resource.id,
slug: 'custom_field_1',
});
const res = await request()
.post('/api/expenses')
.set('x-access-token', loginRes.body.token)
.send({
expense_account_id: expenseAccount.id,
payment_account_id: cashAccount.id,
amount: 100,
custom_fields: [
{
key: 'custom_field_1',
value: 'Value here',
},
],
});
const storedResourceItemMetadata = await ResourceFieldMetadata.query()
.where('resource_id', resource.id)
.where('resource_item_id', res.body.id);
expect(storedResourceItemMetadata.metadata.length).equals(1);
expect(storedResourceItemMetadata.metadata[0].resourceId).equals(resource.id);
expect(storedResourceItemMetadata.metadata[0].resourceItemId).equals(res.body.id);
expect(storedResourceItemMetadata.metadata[0].key).equals('custom_field_1');
expect(storedResourceItemMetadata.metadata[0].value).equals('Value here');
});
});
@@ -403,16 +448,43 @@ describe('routes: /expenses/', () => {
describe('GET: `/expenses/:id`', () => {
it('Should response view not found in case the custom view id was not exist.', async () => {
const expense = await create('expense');
const res = await request()
.get('/api/expenses')
.get(`/api/expenses/${expense.id}123`)
.set('x-access-token', loginRes.body.token)
.send();
console.log(res.status);
expect(res.status).equals(404);
expect(res.body.errors).include.something.deep.equals({
type: 'EXPENSE.TRANSACTION.NOT.FOUND', code: 100,
});
});
it('Should retrieve custom fields metadata.', () => {
it('Should retrieve custom fields metadata.', async () => {
const expense = await create('expense');
const resource = await create('resource', { name: 'Expense' });
const resourceField = await create('resource_field', {
resource_id: resource.id,
slug: 'custom_field_1',
});
const resourceFieldMetadata = await create('resource_custom_field_metadata', {
resource_id: resource.id,
resource_item_id: expense.id,
key: 'custom_field_1',
});
const res = await request()
.get(`/api/expenses/${expense.id}`)
.set('x-access-token', loginRes.body.token)
.send();
expect(res.status).equals(200);
expect(res.body.custom_fields.length).equals(1);
expect(res.body.custom_fields[0].key).equals('custom_field_1');
expect(res.body.custom_fields[0].value).equals(resourceFieldMetadata.value);
});
});
});