Skip to content

Add check arguments to save model method #226

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
monkeycatdog wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add check arguments to save model method #226

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c918406
Add check arguments to save model method
May 29, 2019
672aa42
Updated coverage percent for model
May 29, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion src/models/json-api.model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,38 @@ export class JsonApiModel {
this.lastSyncModels = included;
}

public save(params?: any, headers?: HttpHeaders, customUrl?: string): Observable<this> {
public save(): Observable<this>;
public save(params: {[s: string]: any}): Observable<this>;
public save(headers: HttpHeaders): Observable<this>;
public save(customUrl: string): Observable<this>;
public save(params: {[s: string]: any}, headers: HttpHeaders): Observable<this>;
public save(params: {[s: string]: any}, customUrl: string): Observable<this>;
public save(headers: HttpHeaders, customUrl: string): Observable<this>;
public save(params: {[s: string]: any}, headers: HttpHeaders, customUrl: string): Observable<this>;
public save(...args: any[]): Observable<this> {
Copy link
Collaborator

@safo6m safo6m Jul 18, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rather have a single argument instead of this type checking.
something like:

public save(options: SaveRequestOptions): Observable<this>;

@iamruslanbakirov what do you think about that?

Copy link
Author

@monkeycatdog monkeycatdog Aug 15, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe you right, but typescript has overloading and it's great feature for this cause. And I saw same implementation in AngularJS.

so, when you have only one parameter you should be again and again create options object. it's bored 😑

this.checkChanges();
const attributesMetadata: any = this[AttributeMetadataIndex];
let [params, headers, customUrl] = args;

const length = args.length;

if (length) {
if (params instanceof HttpHeaders) {
headers = params;
params = {};
}

if (typeof params === 'string') {
customUrl = params;
params = {};
}

if (typeof headers === 'string') {
customUrl = headers;
headers = undefined;
}
}

return this.internalDatastore.saveRecord(attributesMetadata, this, params, headers, customUrl);
}

Expand Down
19 changes: 18 additions & 1 deletion src/services/json-api-datastore.service.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import {
BASE_URL_FROM_CONFIG,
DatastoreWithConfig
} from '../../test/datastore-with-config.service';
import { HttpHeaders } from '@angular/common/http';
import { HttpHeaders, HttpRequest } from '@angular/common/http';

let datastore: Datastore;
let datastoreWithConfig: DatastoreWithConfig;
Expand Down Expand Up @@ -321,6 +321,23 @@ describe('JsonApiDatastore', () => {
}, { status: 201, statusText: 'Created' });
});

it('should create new author with difference arguments', () => {
const expectedUrl = `${BASE_URL}/${API_VERSION}/author/internal/`;
const author = datastore.createRecord(Author, {
name: AUTHOR_NAME,
date_of_birth: AUTHOR_BIRTH
});

author.save(`${BASE_URL}/${API_VERSION}/author/internal/`).subscribe();
httpMock.expectOne({ method: 'POST', url: expectedUrl });

author.save({ check: 'params' }, `${BASE_URL}/${API_VERSION}/author/internal/`).subscribe();
httpMock.expectOne({ method: 'POST', url: `${expectedUrl}?check=params` });

author.save(new HttpHeaders().set('Auth', '123')).subscribe();
httpMock.expectOne((req: HttpRequest<any>) => req.headers.get('Auth') === '123');
});

it('should throw error on new author with 201 response but no body', () => {
const expectedUrl = `${BASE_URL}/${API_VERSION}/authors`;
const author = datastore.createRecord(Author, {
Expand Down