Merge branch 'map'

CHANGELOG.md

@@ -4,6 +4,15 @@
 
 
 
+## v2.1.1, 2023-02-22
+
+  * add map to the exports
+
+### Statistics
+
+  * code churn: 4 files changed, 134 insertions(+), 121 deletions(-)
+
+
 ## v2.1.0, 2023-00-13
 
   * add function 'matches'

CHANGELOG.yml

@@ -6,16 +6,22 @@ project:
   ticket_url: ~
   with_stats: true
 releases:
+  - version: v2.1.1
+    date: 2023-02-22
+    changes:
+      - desc: add map to the exports
+      - desc: 'code churn: 4 files changed, 134 insertions(+), 121 deletions(-)'
+        type: stats
   - version: v2.1.0
     date: 2023-00-13
     changes:
       - desc: add function 'matches'
-      - desc: "code churn: 7 files changed, 66 insertions(+), 174 deletions(-)"
+      - desc: 'code churn: 7 files changed, 66 insertions(+), 174 deletions(-)'
         type: stats
   - version: v2.0.0
     date: ~
     changes:
-      - desc: "Fork from the [mothership](github.com/substantial/updeep), v1.2.1"
+      - desc: 'Fork from the [mothership](github.com/substantial/updeep), v1.2.1'
 change_types:
   - keywords:
       - feat

Taskfile.yaml

@@ -13,6 +13,7 @@ tasks:
     generates: [./CHANGELOG.md]
     cmds:
       - changelord print > CHANGELOG.md
+
   test: vitest run
 
   build:

package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@yanick/updeep-remeda",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "Easily update nested frozen objects and arrays in a declarative and immutable manner.",
   "homepage": "https://git.babyl.ca/yanick/updeep-remeda",
   "repository": {

src/index.ts

@@ -12,23 +12,25 @@ import pickBy from "./pickBy.js";
 import filter from "./filter.js";
 import reject from "./reject.js";
 import matches from "./matches.js";
+import myMap from "./map.js";
 
 const functions = {
+  constant,
   filter,
-  reject,
+  freeze,
-  pickBy,
+  ifElse,
-  pick,
+  if: _if,
+  is,
+  map: myMap,
+  matches,
   omit,
   omitBy,
-  constant,
+  pick,
-  if: _if,
+  pickBy,
-  ifElse,
+  reject,
-  is,
+  skip,
-  freeze,
   update,
   updateIn,
-  skip,
-  matches,
 };
 
 export {
@@ -47,6 +49,7 @@ export {
   updateIn,
   skip,
   matches,
+  myMap as map,
 };
 
 const merged = update;

src/map.ts

@@ -21,7 +21,7 @@ function map(object, iteratee) {
   return equal ? object : newObject;
 }
 
-interface Map {
+export interface Map {
   (object, iteratee): any;
   (iteratee): (object) => any;
 }

src/same-if-unchanged.test.ts

@@ -15,9 +15,15 @@ describe("update", () => {
     expect(result).toBe(orig);
   });
 
-  test.only("with u.skip", () => {
+  test("with u.skip", () => {
     const orig = { a: 1 };
     const result = u(orig, { b: u.skip });
     expect(result).toBe(orig);
   });
+
+  test("found in the wild", () => {
+    const x = { a: { c: 3 }, b: 2 };
+    const res = u(x, { a: { c: 3 } });
+    expect(res).toBe(x);
+  });
 });

src/updeep.test.ts

@@ -1,61 +1,61 @@
-import { expect, it, describe } from "vitest";
+import { expect, test, describe } from "vitest";
 import u from "./index.js";
 
-it("does not change anything if no updates are specified", () => {
+test("does not change anything if no updates are specified", () => {
   const object = { foo: 3, bar: [7, 5] };
   const result = u(object, {});
 
   expect(result).to.equal(object);
 });
 
-it("can update with fixed values", () => {
+test("can update with fixed values", () => {
   const object = { foo: 3, bar: [7, 5] };
   const result = u(object, { foo: 4 });
 
   expect(result).to.deep.equal({ foo: 4, bar: [7, 5] });
 });
 
-it("returns the same instance if an update doesn't make changes", () => {
+test("returns the same instance if an update doesn't make changes", () => {
   const object = { foo: 3 };
   const result = u({ foo: 3 })(object);
 
   expect(result).to.equal(object);
 });
 
-it("can update a nested structure", () => {
+test("can update a nested structure", () => {
   const object = { foo: { bar: 7, bam: 3 }, baz: 32 };
   const result = u({ foo: { bar: 8 } })(object);
 
   expect(result).to.deep.equal({ foo: { bar: 8, bam: 3 }, baz: 32 });
 });
 
-it("can update arrays", () => {
+test("can update arrays", () => {
   const object = [1, 2, 3];
   const result = u({ 1: 7 })(object);
 
   expect(result).to.deep.equal([1, 7, 3]);
 });
 
-it("replaces the object outright if updates are a constant", () => {
+test("replaces the object outright if updates are a constant", () => {
   expect(u(3)({})).to.equal(3);
   expect(u(null)({})).to.be.null;
 });
 
-it("can add an element to an array", () => {
+test("can add an element to an array", () => {
   const object = [];
   const result = u({ 0: 3 })(object);
 
   expect(result).to.eql([3]);
 });
 
-it("can update nested arrays", () => {
+test("can update nested arrays", () => {
   const object = { foo: [1, 2, 3], bar: 9 };
   const result = u({ foo: { 1: 7 } })(object);
 
   expect(result).to.deep.equal({ foo: [1, 7, 3], bar: 9 });
 });
 
-it("can use functions to update values", () => {
+test("can use functions to update values", () => {
   const inc = (i) => i + 1;
   const object = { foo: 3, bar: 4, baz: 7 };
   const result = u({ foo: inc, bar: inc })(object);
@@ -63,7 +63,7 @@ it("can use functions to update values", () => {
   expect(result).to.deep.equal({ foo: 4, bar: 5, baz: 7 });
 });
 
-it("can be partially applied", () => {
+test("can be partially applied", () => {
   const inc = (i) => i + 1;
   const object = { foo: 3 };
   const incFoo = u({ foo: inc });
@@ -73,37 +73,37 @@ it("can be partially applied", () => {
   expect(result).to.deep.equal({ foo: 4 });
 });
 
-it("can update if the value is an array", () => {
+test("can update if the value is an array", () => {
   const object = {};
   const result = u({ foo: [0, 1] })(object);
 
   expect(result).to.deep.equal({ foo: [0, 1] });
 });
 
-it("can update when original object is undefined", () => {
+test("can update when original object is undefined", () => {
   const result = u({ foo: [0, 1] })(undefined);
 
   expect(result).to.deep.equal({ foo: [0, 1] });
 });
 
-it("can take a function as the updater", () => {
+test("can take a function as the updater", () => {
   const result = u((i) => i + 1)(7);
 
   expect(result).to.eql(8);
 });
 
-it("deeply freezes the result", () => {
+test("deeply freezes the result", () => {
   const result = u({ foo: { bar: 3 } }, { foo: { bar: 0 } });
 
   expect(Object.isFrozen(result)).to.be.true;
   expect(Object.isFrozen(result.foo)).to.be.true;
 });
 
-it("assigns null values", () => {
+test("assigns null values", () => {
   expect(u({ isNull: null }, {})).to.eql({ isNull: null });
 });
 
-it("defaults to an empty object when null or undefined", () => {
+test("defaults to an empty object when null or undefined", () => {
   let result = u({ a: { b: 0 } })({ a: null });
   expect(result).to.eql({ a: { b: 0 } });
 
@@ -114,12 +114,12 @@ it("defaults to an empty object when null or undefined", () => {
   expect(result).to.eql({ a: { b: 0 } });
 });
 
-it("preserves empty objects when empty updates are specified", () => {
+test("preserves empty objects when empty updates are specified", () => {
   const result = u({ a: {} })({});
   expect(result).to.eql({ a: {} });
 });
 
-it("works with date objects", () => {
+test("works with date objects", () => {
   const date = new Date();
   const result = u({ created: date })({});
   expect(result).toEqual({ created: date });
@@ -129,11 +129,11 @@ const expectU = (update, orig, expected) =>
   expect(update(orig)).to.eql(expected);
 
 describe("u.skip", () => {
-    it("omit properties via u.skip", () => {
+  test("omit properties via u.skip", () => {
     expectU(u({ a: u.skip, b: (i) => i + 1 }), { a: 1, b: 2 }, { b: 3 });
   });
 
-    it("omit array and object properties", () => {
+  test("omit array and object properties", () => {
     expectU(
       u({ a: u.skip, b: "stuff", c: u.skip }),
       { a: [1, 2, 3], b: "orig", c: { z: "bar" } },
@@ -141,7 +141,7 @@ describe("u.skip", () => {
     );
   });
 
-    it("deep omit", () => {
+  test("deep omit", () => {
     expectU(
       u({ a: { b: u.skip, c: "stuff" } }),
       { a: { b: "foo", z: "bar" } },
@@ -149,19 +149,23 @@ describe("u.skip", () => {
     );
   });
 
-    it("omitting an array item filters it out", () => {
+  test("omitting an array item filters it out", () => {
     expectU(u({ 1: u.skip }), ["a", "b", "c"], ["a", "c"]);
   });
 
-    it("doesn't change the obj if nothing is omitted", () => {
+  test("doesn't change the obj if nothing is omitted", () => {
     const orig = { a: 1 };
     const result = u(orig, { b: u.skip });
     expect(result).to.be.equal(orig);
   });
 
-    it("doesn't change the array if nothing is omitted", () => {
+  test("doesn't change the array if nothing is omitted", () => {
     const orig = [1, 2, 3];
     const result = u({ 4: u.skip })(orig);
     expect(result).to.be.equal(orig);
   });
 });
+
+test("has map", () => {
+  expect(u).toHaveProperty("map");
+});