angular-extensions / model Goto Github PK

This may be out of the scope of this library, but thought I'd ask. I'm trying to use the html5 navigator api's to watch a user's position. I would then like to update the Position model.

What i'm getting right now is the code runs, but the model's value doesn't actually update. Here's an abbreviated version:

 private model: Model<Position>;

constructor(private modelFactory: ModelFactory<Position>){

    this.model = this.modelFactory.create(initialData);
    this.userPosition$ = this.model.data$;

    navigator.geolocation.watchPosition(this.updatePosition);
}

private updatePosition = (position: Position) => {
    this.model.set(position);
}

I have also tried forcing it to run in the zone:

 private model: Model<Position>;

constructor(private modelFactory: ModelFactory<Position>, private ngZone: NgZone){

    this.model = this.modelFactory.create(initialData);
    this.userPosition$ = this.model.data$;

    navigator.geolocation.watchPosition((position) => this.ngZone.run(() => {

        this.model.set(position);

    }));
}

I feel like I'm missing something obvious here.

Thank you

Hi,

thank you for providing this library.
It is really intuitive and easy to use especially for newcomers dealing with state management.

Describe the feature you'd like:

Do you plan to enhance the Model-API making it easier to add, update and delete model items?
The maintainers of ngrx/entity introduced an adapter for this.
I did a lot with ngrx and would be glad to help to implement this feature. :)

Other information:

Desired Methods would be

• addOne
• addMany
• updateOne
• updateMany
• removeOne
• removeMany

I would be willing to submit a PR to add this feature:

[x] Yes (Assistance is provided if you need help submitting a pull request)
[ ] No

If you are willing to submit a PR but are a bit unsure, feel free to check out the Contributors Guide for useful tips and hints that help you get started.

Cheers 🍻
Gregor

Minimal reproduction of the bug with instructions:

This bug was replicated locally and on stackblitz

StackBlitz Link

1. Open stackblitz from demo app.
2. When "addTodo(name: string)
3. Check type returned form this.model.get();

type = Object[]

Expected behavior:

Type should be Todo[]

Other information:

I would be willing to submit a PR to fix this issue:

[ ] Yes (Assistance is provided if you need help submitting a pull request)
[ x] No

Minimal reproduction of the bug with instructions:

I installed the library using:

ng add @angular-extensions/model

then i attempted to create a model service:

ng g @angular-extensions/model:model examples/todo --items

I received this error:

project_1.getProject is not a function

Expected behavior:

I expected the model service to be generated. I'm following the examples provided in the documentation exactly.

Other information:

I thought perhaps the issue stemmed from using Angular 6.x since @angular-extensions/model is version 7.x. There's no information in documentation about which version of Angular is supported. So, I went about upgrading to version 7.x for Angular and all of it's associated libraries. After getting everything upgraded, I tried the exact same snippets from the documentation and I am receiving the exact same error.

I would be willing to submit a PR to fix this issue:

[ ] Yes (Assistance is provided if you need help submitting a pull request)
[ X] No

Minimal reproduction of the bug with instructions:

Running ng add @angular-extensions/model generates the following warning:

npm WARN @angular-extensions/[email protected] requires a peer of typescript@~3.1.0 but none is installed. You must install peer dependencies yourself.

Running ng update --all generates:

Package "@angular-extensions/model" has an incompatible peer dependency to "typescript" (requires "~3.1.0", would install "3.2.4").

The typescript peer dependency used by @angular/angular is as follows:

"typescript": "~3.2.2"

So Angular installs typescript 3.2.4, which breaks your modules peer dependency. I do not believe there were any breaking changes from typescript ~3.1 to ~3.2, so any easy fix would be changing your dependency accordingly, at least to match what current versions of Angular are using.

Expected behavior:

Installing or updating this package should install peer dependencies in line with current versions of Angular.

Other information:

Angular CLI: 7.2.2
Node: 10.15.0
OS: linux x64
Angular: 7.2.1
... animations, common, compiler, compiler-cli, core, forms
... language-service, platform-browser, platform-browser-dynamic
... router

Package                           Version
-----------------------------------------------------------
@angular-devkit/architect         0.12.2
@angular-devkit/build-angular     0.12.2
@angular-devkit/build-optimizer   0.12.2
@angular-devkit/build-webpack     0.12.2
@angular-devkit/core              7.2.2
@angular-devkit/schematics        7.2.2
@angular/cli                      7.2.2
@ngtools/webpack                  7.2.2
@schematics/angular               7.2.2
@schematics/update                0.12.2
rxjs                              6.3.3
typescript                        3.2.4
webpack                           4.28.4

I would be willing to submit a PR to fix this issue:

[X] Yes (Assistance is provided if you need help submitting a pull request)
[ ] No

Describe the feature you'd like:

Hello Tomas, do you plan to update this library to Angular 12?

I would be willing to submit a PR to add this feature:

I could prepare PR for Angular 11 and 12. Would you accept this?

Describe the feature you'd like:

I want to use this lib for angular 13.

Other information:

I would be willing to submit a PR to add this feature:

[ ] Yes (Assistance is provided if you need help submitting a pull request)
[ x] No

If you are willing to submit a PR but are a bit unsure, feel free to check out the Contributors Guide for useful tips and hints that help you get started.

Minimal reproduction of the bug with instructions:

//DataType is {date: Date}

this.model.data$.subscribe(x => {
console.log(x[0].date) // this is a string
})

this.model.set([{date:new Date()}])

Expected behavior:

Should retain its Date typing

Other information:

This is because we do a

JSON.parse(JSON.stringify(obj))

to copy

Is there a reason

//For Object
Object.assign({},obj)
//For Array
[...objs]

wouldn't work

I would be willing to submit a PR to fix this issue:

[x] Yes (Assistance is provided if you need help submitting a pull request)
[ ] No

Minimal reproduction of the bug with instructions:

1. npm i -S @angular-extensions/model
2. Create sample service, import Model, ModelFactory from @angular-extensions/model

Expected behavior:

You can create a service and use it

Other information:

There are errors during ng serve, in fact if you go to node_modules it pulls non-compiled repo.

I would be willing to submit a PR to fix this issue:

[ ] Yes (Assistance is provided if you need help submitting a pull request)
[ x] No

Workaround

Currently 7.0.1 can be installed using
npm i -S @angular-extensions/[email protected]

Hi,

if you create a Model of type T[], you will not get immutable data, as JS does only reference arrays.

Minimal reproduction of the bug with instructions:

These tests will fail.

it('should be an immutable array', () => {
    const factory: ModelFactory<TestModel[]> = new ModelFactory<TestModel[]>();

    const initial: TestModel[] = [];
    const store = factory.create(initial);

    const initialState = store.get();
    initialState.push({ value: 'updated' });

    assert.equal(store.get().length, 0); // will be 1
  });

  it('should be an immutable array after set', () => {
    const factory: ModelFactory<TestModel[]> = new ModelFactory<TestModel[]>();

    const initial: TestModel[] = [];
    const store = factory.create(initial);

    const updateArray = [{ value: 'first element' }];
    store.set(updateArray);

    updateArray.push({ value: '2nd element' });
    assert.equal(store.get().length, 1); // will be 2
  });

  it('should be immutable array on sub', () => {
    const factory: ModelFactory<TestModel[]> = new ModelFactory<TestModel[]>();

    const initial: TestModel[] = [];
    const store = factory.create(initial);

    const initialState = store.get();
    initialState.push({ value: 'updated' });

    store.data$.subscribe(v => {
      assert.equal(store.get().length, 0); // will be 1
    });
  });

Expected behavior:

Tests succeed.

Other information:

I've forked your repo and fixed the issues with the same approach you used inside the pipe. Not sure if there are more elegant/performant ways though.

I would be willing to submit a PR to fix this issue:

[X ] Yes (Assistance is provided if you need help submitting a pull request)
[ ] No

It would be great if we could provide code coverage info as a part of standard CI build (on Travis CI)...

The setup of CODECOV_TOKEN of the Travis CI build is already done, what is left to do is to adjust .travis.yml build so that it runs tests with coverage and use html and json reporters

Example codecov repo can provide more guidance.

We can introduce new coverage npm script which will run all tests together (both model and schematics, using appropriate glob pattern) and this script should run on the CI build ( .travis.yml )

We're aiming on combined coverage of both model and schematics, It can be tested locally by using html reporter and opening generated coverage/index.html.

If you are willing to submit a PR but are a bit unsure, feel free to check out the Contributors Guide for useful tips and hints that help you get started.