Merge branch 'release/1.5.3'

Author: vankeisb

CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## v1.5.2 (14/12/2020)
+*No changelog for this release.*
+
+---
+
+## v1.5.1 (14/12/2020)
+
+#### closed
+
+- [**closed**] fix mapObject, create new object for every call [#51](https://github.com/vankeisb/react-tea-cup/pull/51)
+
+#### dependencies
+
+- [**dependencies**] Bump ini from 1.3.5 to 1.3.8 [#52](https://github.com/vankeisb/react-tea-cup/pull/52)
+
+---
+
 ## v1.5.0 (11/12/2020)
 
 #### closed

README.md

@@ -1,5 +1,3 @@
-[![Build Status](https://travis-ci.org/vankeisb/react-tea-cup.svg?branch=develop)](https://travis-ci.org/vankeisb/react-tea-cup) ![](https://img.shields.io/github/tag/vankeisb/react-tea-cup.svg?label=latest&style=flat)
-
 Want some TEA in your React ?
 
 `react-tea-cup` is a very thin library that helps following The Elm Architecture, in React.

core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tea-cup-core",
-  "version": "1.5.2",
+  "version": "1.5.3",
   "description": "react-tea-cup core classes and utilities (Maybe etc)",
   "author": "Rémi Van Keisbelck <remi@rvkb.com>",
   "license": "MIT",

core/src/TeaCup/UpdatePiped.test.ts

@@ -0,0 +1,57 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2019 Rémi Van Keisbelck
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ */
+
+import { Cmd } from './Cmd';
+import { genericUpdatePiped, updatePiped } from './UpdatePiped';
+
+describe('UpdatePiped', () => {
+  type MyModel = number;
+  type MyCmd = readonly string[];
+
+  test('generic', () => {
+    const model0: MyModel = 6;
+    const [model, cmd] = genericUpdatePiped(
+      (cmd1: MyCmd, cmd2: MyCmd) => new Array().concat(...cmd1, ...cmd2),
+      [],
+      model0,
+      (model) => [model + 1, ['add 1']],
+      (model) => [model * 6, ['multiply by 6']],
+    );
+    expect(model).toBe(42);
+    expect(cmd).toEqual(['add 1', 'multiply by 6']);
+  });
+
+  test('example with none handling', () => {
+    type MyMsg = string;
+    const model0: MyModel = 6;
+    const [model, cmd] = updatePiped(
+      model0,
+      (model) => [model + 1, Cmd.none()],
+      (model) => [model * 6, Cmd.none()],
+    );
+    expect(model).toBe(42);
+    expect(cmd).toEqual(Cmd.none());
+  });
+});

core/src/TeaCup/UpdatePiped.ts

@@ -0,0 +1,71 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2019 Rémi Van Keisbelck
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ */
+
+import { Cmd } from './Cmd';
+
+export type UpdateFunction<Model, Msg> = GenericUpdateFunction<Model, Cmd<Msg>>;
+
+/**
+ * Piped updates.
+ * Useful for chaining building blocks making up the update loop.
+ */
+export function updatePiped<Model, Msg>(
+  model: Model,
+  ...updates: readonly UpdateFunction<Model, Msg>[]
+): [Model, Cmd<Msg>] {
+  const none: Cmd<Msg> = Cmd.none();
+  const combine = (cmd1: Cmd<Msg>, cmd2: Cmd<Msg>) => {
+    const none1 = isNone(cmd1);
+    const none2 = isNone(cmd2);
+    return none1 && none2 ? cmd1 : none1 ? cmd2 : none2 ? cmd1 : Cmd.batch([cmd1, cmd2]);
+  };
+  return genericUpdatePiped(combine, none, model, ...updates);
+}
+
+function isNone<Msg>(cmd: Cmd<Msg>): boolean {
+  return cmd.constructor.name === 'CmdNone';
+}
+
+export type GenericUpdateFunction<Model, Cmd> = (model: Model) => [Model, Cmd];
+
+/**
+ * Generic implementation of chained updates.
+ * See updatePiped().
+ */
+export function genericUpdatePiped<Model, Cmd>(
+  combine: (cmd1: Cmd, cmd2: Cmd) => Cmd,
+  none: Cmd,
+  model: Model,
+  ...updates: readonly GenericUpdateFunction<Model, Cmd>[]
+): [Model, Cmd] {
+  return updates.reduce<[Model, Cmd]>(
+    (acc: [Model, Cmd], update: GenericUpdateFunction<Model, Cmd>) => {
+      const [model0, cmd0] = acc;
+      const [model1, cmd1] = update(model0);
+      return [model1, combine(cmd0, cmd1)];
+    },
+    [model, none],
+  );
+}

samples/package.json

@@ -11,7 +11,7 @@
     "react": "^16.7.0",
     "react-dom": "^16.7.0",
     "react-scripts": "3.4.3",
-    "react-tea-cup": "1.5.2"
+    "react-tea-cup": "^1.5.3"
   },
   "scripts": {
     "start": "react-scripts start",

samples/src/Samples/ProgramSample.test.tsx

@@ -0,0 +1,38 @@
+import { mount, ReactWrapper } from 'enzyme';
+import { extendJest, Cmd, Sub, Task, Program, ProgramProps, updateUntilIdle } from "react-tea-cup";
+import React, { ReactNode } from 'react';
+import { Dispatcher } from 'tea-cup-core';
+
+extendJest(expect);
+
+const init1: () => [number, Cmd<string>] = () => {
+    return [0, toCmd('go')];
+}
+
+const view1: (dispatch: Dispatcher<string>, model: number) => React.ReactNode = (dispatch: Dispatcher<string>, model: number) => {
+    return (<div className={'count'}>{model}</div>);
+}
+
+const update1: (msg: string, model: number) => [number, Cmd<string>] = (msg: string, model: number) => {
+    return [model + 1, model < 5 ? toCmd('go') : Cmd.none()];
+}
+
+// const toCmd = (msg: string) => Task.perform(Time.in(0), () => msg);
+const toCmd = (msg: string) => Task.perform(Task.succeed(0), () => msg);
+
+describe('Test Program', () => {
+
+    it('expect when program is idle', () => {
+        const props: ProgramProps<number, string> = {
+            init: init1,
+            view: view1,
+            update: update1,
+            subscriptions: () => Sub.none<string>()
+        }
+        return updateUntilIdle(props, mount).then(([model, wrapper]) => {
+            expect(model).toEqual(6)
+            // expect(wrapper).toHaveHTML('')
+            expect(wrapper.find('.count')).toHaveText('6')
+        })
+    })
+})

tea-cup/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-tea-cup",
-  "version": "1.5.2",
+  "version": "1.5.3",
   "description": "Put some TEA in your React.",
   "author": "Rémi Van Keisbelck <remi@rvkb.com>",
   "license": "MIT",
@@ -20,7 +20,9 @@
     "samples": "tsc --outFile ./dist/Samples/index.js && cp ./src/Samples/index.html ./dist/Samples"
   },
   "dependencies": {
-    "tea-cup-core": "1.5.2",
+    "tea-cup-core": "^1.5.3"
+  },
+  "peerDependencies": {
     "react": "^16.7.0"
   },
   "devDependencies": {

tea-cup/src/TeaCup/Program.ts

@@ -70,7 +70,7 @@ export class Program<Model, Msg> extends Component<ProgramProps<Model, Msg>, nev
     this.count++;
     const count = this.count;
     const currentModel = this.currentModel;
-    if (currentModel) {
+    if (currentModel !== undefined) {
       const updated = this.props.update(msg, currentModel);
       if (this.props.devTools) {
         this.fireEvent({