Merge pull request #19 from MinimaHQ/chore

Update deps, add `cmp` function to `DndEntry` interface

Author: Alex Fedoseev

HISTORY.md

@@ -1,5 +1,10 @@
 # History
 
+## 2.0.0
+* **[ BREAKING ]** Modules of `DndEntry` type must provide `cmp` function to avoid polymorphic comparison. See [this diff](https://github.com/MinimaHQ/re-dnd/commit/238a0abab8ad88a7c643c0b022c49887c025a89b) for details.
+* **[ BREAKING ]** Minimum required version of `bs-platform` is `7.1.1`.
+* **[ BREAKING ]** Minimum required version of `reason-react` is `0.8.0`.
+
 ## 1.2.0
 * `bs-platform` updated to `v7`.
 * `bs-log` updated to `v1`.

README.md

@@ -20,9 +20,9 @@ Drag & drop for [`reason-react`](https://reasonml.github.io/reason-react/).
 
 ```shell
 # yarn
-yarn add re-dnd@next
+yarn add re-dnd
 # or npm
-npm install --save re-dnd@next
+npm install --save re-dnd
 ```
 
 Then add it to `bsconfig.json`:
@@ -40,7 +40,7 @@ Then add it to `bsconfig.json`:
 
 ## Examples
 * Demos: [`live`](https://re-dnd.now.sh) | [`sources`](./examples)
-* @Production: [`Minima`](https://minima.app)
+* Production app: [`Minima`](https://minima.app)
 
 ## State
 🚧 The library is not feature-complete and some features/apis might be missing.<br>

bsconfig.json

@@ -17,13 +17,16 @@
     "react-jsx": 3
   },
   "refmt": 3,
-  "bsc-flags": ["-w -45", "-open Belt"],
+  "bsc-flags": ["-open Belt"],
   "ppx-flags": [
     ["bs-log/ppx", "--lib=re-dnd"],
   ],
   "package-specs": {
     "module": "es6",
     "in-source": true
   },
-  "suffix": ".bs.js"
+  "suffix": ".bs.js",
+  "warnings": {
+    "number": "+A-40-42-44"
+  }
 }

docs/01-GettingStartedGuide.md

@@ -32,7 +32,7 @@ To create components that handle all drag & drop business, we need to call `Dnd.
 module Items = Dnd.Make(Item, Container);
 ```
 
-This code won't compile yet because we need to provide two modules to the `Dnd.Make` functor:
+This code wouldn't compile yet because we need to provide two modules to the `Dnd.Make` functor:
 
 - `Item`: configuration for draggable item.
 - `Container`: configuration for droppable container, which contains draggable items.
@@ -42,18 +42,21 @@ Both of these modules has the same signature:
 ```reason
 type t;
 let eq: (t, t) => bool;
+let cmp: (t, t) => int;
 ```
 
 Basically, functor asks you to answer the following questions:
 1. What the thing is? _Answer: type `t`._
-1. And when two things given, do those equal or not? _Answer: `eq` function._
+1. When two things given, do those equal or not? _Answer: `eq` function._
+1. When two things given, how to compare those? _Answer: `cmp` function._
 
 Let's start with very simple (and in general not 100% safe) implementation of `Item` container:
 
 ```reason
 module Item = {
   type t = item; // `item` is a type alias we defined above which is resolved to `int`
   let eq = (x1, x2) => x1 == x2; // or more concise: let eq = (==);
+  let cmp = compare; // default comparator from Pervasives module
 }
 ```
 
@@ -64,6 +67,7 @@ module Container = {
   type t; // abstract type
   external id: unit => t = "%identity"; // `Container.id()` would produce value of abstract type `t`
   let eq = (_, _) => true; // since `Container` is singleton, it's always equal to self
+  let cmp = (_, _) => 0; // same logic applies
 }
 ```
 
@@ -73,7 +77,7 @@ For convenience, `re-dnd` exposes functor which would create such singleton for
 module Container = Dnd.MakeSingletonContainer();
 ```
 
-Now, when we have all configuration defined, we can create module which holds React components:
+Now, when we have complete configuration defined, we can create module which holds React components:
 
 ```reason
 module Items = Dnd.Make(Item, Container);
@@ -189,6 +193,7 @@ type item = int;
 module Item = {
   type t = item;
   let eq = (x1, x2) => x1 == x2;
+  let cmp = compare;
 };
 
 module Container =

docs/02-SaferIdentifiersAndMultipleContainersGuide.md

@@ -222,10 +222,13 @@ module MakeId = () => {
   external make: int => t = "%identity";
   external toInt: t => int = "%identity";
 
+  let eq = (x1, x2) => x1->toInt == x2->toInt;
+  let cmp = (x1, x2) => compare(x1->toInt, x2->toInt);
+
   module Comparable =
     Belt.Id.MakeComparable({
       type t = Id.t;
-      let cmp = Pervasives.compare;
+      let cmp = cmp;
     });
 
   module Map = {
@@ -248,12 +251,14 @@ With all the hard prerequisite work done, we can finally proceed to implementati
 ```reason
 module DraggableItem = {
   type t = TodoId.t;
-  let eq = (x1, x2) => x1->TodoId.toInt == x2->TodoId.toInt;
+  let eq = TodoId.eq;
+  let cmp = TodoId.cmp;
 };
 
 module DroppableContainer = {
   type t = TodoListId.t;
-  let eq = (x1, x2) => x1->TodoListId.toInt == x2->TodoListId.toInt;
+  let eq = TodoListId.eq;
+  let cmp = TodoListId.cmp;
 };
 
 module Todos = Dnd.Make(DraggableItem, DroppableContainer);

docs/03-Api.md

@@ -9,6 +9,7 @@ module T: DndComponents = Dnd.Make(Item: DndEntry, Container: DndEntry);
 module type DndEntry = {
   type t;
   let eq: (t, t) => bool;
+  let cmp: (t, t) => int;
 };
 
 module type DndComponents = {

examples/examples/CardBoard.re

@@ -23,12 +23,14 @@ module TodoList = {
 module Todos = {
   module Item = {
     type t = TodoId.t;
-    let eq = (x1, x2) => x1->TodoId.toInt == x2->TodoId.toInt;
+    let eq = TodoId.eq;
+    let cmp = TodoId.cmp;
   };
 
   module Container = {
     type t = TodoListId.t;
-    let eq = (x1, x2) => x1->TodoListId.toInt == x2->TodoListId.toInt;
+    let eq = TodoListId.eq;
+    let cmp = TodoListId.cmp;
   };
 
   include Dnd.Make(Item, Container);
@@ -37,7 +39,8 @@ module Todos = {
 module TodoLists = {
   module Item = {
     type t = TodoListId.t;
-    let eq = (x1, x2) => x1->TodoListId.toInt == x2->TodoListId.toInt;
+    let eq = TodoListId.eq;
+    let cmp = TodoListId.cmp;
   };
 
   module Container =

examples/examples/NestedVerticalLists.re

@@ -23,12 +23,14 @@ module TodoList = {
 module Todos = {
   module Item = {
     type t = TodoId.t;
-    let eq = (x1, x2) => x1->TodoId.toInt == x2->TodoId.toInt;
+    let eq = TodoId.eq;
+    let cmp = TodoId.cmp;
   };
 
   module Container = {
     type t = TodoListId.t;
-    let eq = (x1, x2) => x1->TodoListId.toInt == x2->TodoListId.toInt;
+    let eq = TodoListId.eq;
+    let cmp = TodoListId.cmp;
   };
 
   include Dnd.Make(Item, Container);
@@ -37,7 +39,8 @@ module Todos = {
 module TodoLists = {
   module Item = {
     type t = TodoListId.t;
-    let eq = (x1, x2) => x1->TodoListId.toInt == x2->TodoListId.toInt;
+    let eq = TodoListId.eq;
+    let cmp = TodoListId.cmp;
   };
 
   module Container =

examples/examples/SimpleList.re

@@ -11,7 +11,8 @@ module Todo = {
 module Todos = {
   module Item = {
     type t = TodoId.t;
-    let eq = (x1, x2) => x1->TodoId.toInt == x2->TodoId.toInt;
+    let eq = TodoId.eq;
+    let cmp = TodoId.cmp;
   };
 
   module Container =

examples/guides/GettingStartedGuide.re

@@ -2,7 +2,8 @@ type item = int;
 
 module Item = {
   type t = item;
-  let eq = (x1, x2) => x1 == x2;
+  let eq: (item, item) => bool = (x1, x2) => x1 == x2;
+  let cmp: (item, item) => int = Pervasives.compare;
 };
 
 module Container =