Merge pull request #20 from MVCoconut/hydrate

Hydrate

Author: back2dos

.github/workflows/ci.yml

@@ -15,11 +15,12 @@ jobs:
         haxe-version:
           - stable
           - nightly
-        target: 
+        target:
           - interp
           - neko
           - node
           - js
+          - js -lib coconut.vdom
           - cpp
           - php
           - jvm
@@ -29,7 +30,7 @@ jobs:
     steps:
     - name: Check out repo
       uses: actions/checkout@v2
-    
+
     - name: Get yarn cache directory path
       id: yarn-cache-dir-path
       run: echo "::set-output name=dir::$(yarn cache dir)"
@@ -41,34 +42,34 @@ jobs:
         key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
         restore-keys: |
           ${{ runner.os }}-yarn-
-        
+
     - name: Cache Haxe
       uses: actions/cache@v1
       with:
         path: ${{ startsWith(runner.os, 'windows') && '%AppData%' || '~/haxe' }}
         key: ${{ runner.os }}-haxe
-        
+
     - name: Install Lix
       uses: lix-pm/setup-lix@master
-      
+
     - name: Install Haxe
       run: lix install haxe ${{ matrix.haxe-version }}
-    
+
     - name: Install Haxe Libraries
       run: lix download
-      
+
     - name: Run Test
       run: lix run travix ${{ matrix.target }}
 
   release:
     runs-on: ubuntu-latest
     needs: test
     if: startsWith(github.ref, 'refs/tags/') # consider using the "release" event. see: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#release
-    
+
     steps:
     - name: Check out repo
       uses: actions/checkout@v2
-    
+
     - name: Get yarn cache directory path
       id: yarn-cache-dir-path
       run: echo "::set-output name=dir::$(yarn cache dir)"
@@ -80,24 +81,23 @@ jobs:
         key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
         restore-keys: |
           ${{ runner.os }}-yarn-
-        
+
     - name: Cache Haxe
       uses: actions/cache@v1
       with:
         path: ${{ startsWith(runner.os, 'windows') && '%AppData%' || '~/haxe' }}
         key: ${{ runner.os }}-haxe
-        
+
     - name: Install Lix
       uses: lix-pm/setup-lix@master
-      
+
     - name: Install Haxe
       run: lix install haxe stable
-    
+
     - name: Install Haxe Libraries
       run: lix download
-      
+
     - name: Release to Haxelib
       run: lix run travix release
       env:
         HAXELIB_AUTH: ${{ secrets.HAXELIB_AUTH }}
-    

.haxerc

@@ -1,4 +1,4 @@
 {
-  "version": "4.1.3",
+  "version": "4.2.1",
   "resolveLibs": "scoped"
 }

dev.hxml

@@ -1,9 +1,4 @@
--cp tests
--lib tink_unittest
--main TodoMvc
+tests.hxml
+-lib travix
 -lib coconut.diffing
--D no-deprecation-warnings
-coconut.diffing.Implicit
---interp
-# -js bin/js/tests.js
-# -dce full
+--interp

haxe_libraries/coconut.vdom.hxml

@@ -1,5 +1,5 @@
-# @install: lix --silent download "gh://github.com/MVCoconut/coconut.vdom#058fbb7b86580043bea3335ab0a58f863c143b72" into coconut.vdom/0.8.1/github/058fbb7b86580043bea3335ab0a58f863c143b72
+# @install: lix --silent download "gh://github.com/MVCoconut/coconut.vdom#c549f6902e337eca6fa9f8fc88729c44dea907b6" into coconut.vdom/0.9.0/github/c549f6902e337eca6fa9f8fc88729c44dea907b6
 -lib coconut.diffing
 -lib xDOM
--cp ${HAXE_LIBCACHE}/coconut.vdom/0.8.1/github/058fbb7b86580043bea3335ab0a58f863c143b72/src
--D coconut.vdom=0.8.1
+-cp ${HAXE_LIBCACHE}/coconut.vdom/0.9.0/github/c549f6902e337eca6fa9f8fc88729c44dea907b6/src
+-D coconut.vdom=0.9.0

src/coconut/diffing/Cursor.hx

@@ -1,21 +1,28 @@
 package coconut.diffing;
 
-interface Cursor<Native> {
+abstract class Cursor<Native> {
   /**
     A reference back to the applicator that created this cursor.
   **/
-  final applicator:Applicator<Native>;
+  public final applicator:Applicator<Native>;
+  public function new(applicator)
+    this.applicator = applicator;
   /**
     Inserts a native node at the current cursor position.
 
     Please note that:
 
-    1. The native element may already be a child of the parent node being iterated over
-    2. The native element may even be at the current cursor position.
+    1. The native node may already be a child of the parent node being iterated over
+    2. The native node may even be at the current cursor position.
   **/
-  function insert(native:Native):Void;
+  public abstract function insert(native:Native):Void;
   /**
-    Delete `count` elements from the current position.
+    Delete `count` nodes from the current position.
   **/
-  function delete(count:Int):Void;
+  public abstract function delete(count:Int):Void;
+  /**
+    Returns the current node. Only used for hydration (which is only truly relevant for coconut.vdom)
+  **/
+  public function current():Null<Native>
+    return null;
 }

src/coconut/diffing/Factory.hx

@@ -2,23 +2,29 @@ package coconut.diffing;
 
 import coconut.ui.Ref;
 
-@:using(coconut.diffing.Factory.FactoryTools)
-interface Factory<Data, Native, Target:Native> {
-  final type:TypeId;
-  function create(data:Data):Target;
-  function update(target:Target, next:Data, prev:Data):Void;
-}
+abstract class Factory<Data, Native, Target:Native> {
+  public final type = new TypeId();
+
+  public abstract function create(data:Data):Target;
+  public abstract function update(target:Target, next:Data, prev:Data):Void;
 
-class FactoryTools {
-  static public function vnode<Data, Native, Concrete:Native, RenderResult:VNode<Native>>(f:Factory<Data, Native, Concrete>, data:Data, ?key:Key, ?ref:Ref<Concrete>, ?children:Children<RenderResult>):VNode<Native>
-    return new VNative<Data, Native, Concrete>(f, data, key, ref, children);
+  /**
+    Only used in hydration (by coconut.vdom). The currently encountered native node is passed to `adopt`.
+    Return `null` if the wrong type of node is encountered.
+  **/
+  public function adopt(target:Native):Null<Target> return null;
+  /**
+    The actual implementation of the hydration (only used by coconut.vdom)
+  **/
+  public function hydrate(target:Target, data:Data):Void {}
+
+  public function vnode<RenderResult:VNode<Native>>(data:Data, ?key:Key, ?ref:Ref<Target>, ?children:Children<RenderResult>):VNode<Native>
+    return new VNative<Data, Native, Target>(this, data, key, ref, children);
 }
 
 private typedef Dict<T> = Null<haxe.DynamicAccess<Null<T>>>;
 
-class Properties<Value, Native:{}, Target:Native> implements Factory<Dict<Value>, Native, Target> {
-
-  public final type = new TypeId();
+class Properties<Value, Native:{}, Target:Native> extends Factory<Dict<Value>, Native, Target> {
 
   final construct:()->Target;
   final apply:(target:Target, name:String, nu:Null<Value>, old:Null<Value>)->Void;

src/coconut/diffing/Implicit.hx

@@ -19,8 +19,8 @@ class Implicit<Native, RenderResult:VNode<Native>> implements VNode<Native> {
     this.defaults = attr.defaults;
   }
 
-  public function render(parent:Parent, cursor:Cursor<Native>, later):RNode<Native>
-    return new RImplicit(this, parent, cursor, later);
+  public function render(parent:Parent, cursor:Cursor<Native>, later, hydrate:Bool):RNode<Native>
+    return new RImplicit(this, parent, cursor, later, hydrate);
 
 }
 
@@ -29,10 +29,10 @@ private class RImplicit<Native> extends Parent implements RNode<Native> {
   public final type = Implicit.TYPE;
 
   final children:VMany.RMany<Native>;
-  public function new<RenderResult:VNode<Native>>(v:Implicit<Native, RenderResult>, parent:Parent, cursor, later) {
+  public function new<RenderResult:VNode<Native>>(v:Implicit<Native, RenderResult>, parent:Parent, cursor, later, hydrate) {
     super(new ImplicitContext(parent.context), parent);
     this.context.update(v.defaults);
-    this.children = new VMany.RMany(this, v.children, cursor, later);
+    this.children = new VMany.RMany(this, v.children, cursor, later, hydrate);
   }
 
   public function reiterate(applicator)

src/coconut/diffing/Root.hx

@@ -2,12 +2,18 @@ package coconut.diffing;
 
 import coconut.ui.internal.ImplicitContext;
 
+enum abstract Hydration(Int) {
+  var No;
+  var Into;
+  var Onto;
+}
+
 class Root<Native> extends Parent {
   final rendered:RCell<Native>;
 
-  public function new(parent, applicator:Applicator<Native>, ?content) {
+  public function new(parent, applicator:Applicator<Native>, ?content, hydration = No) {
     super(new ImplicitContext());
-    var rendered = Parent.withLater(later -> new RCell(this, content, applicator.children(parent), later));
+    var rendered = Parent.withLater(later -> new RCell(this, content, if (hydration == Onto) applicator.siblings(parent) else applicator.children(parent), later, hydration != No));
     this.rendered = rendered;
   }
 

src/coconut/diffing/internal/RCell.hx

@@ -7,12 +7,12 @@ class RCell<Native> {
   var virtual:VNode<Native>;
   var rendered:RNode<Native>;
 
-  public function new(parent, virtual, cursor, later) {
+  public function new(parent, virtual, cursor, later, hydrate:Bool) {
     this.parent = parent;
     if (virtual == null)
       virtual = empty;
     this.virtual = virtual;
-    this.rendered = virtual.render(parent, cursor, later);
+    this.rendered = virtual.render(parent, cursor, later, hydrate);
     this.applicator = cursor.applicator;
   }
 
@@ -38,7 +38,7 @@ class RCell<Native> {
         this.rendered.update(virtual, cursor, later);
       else {
         var old = this.rendered;
-        this.rendered = virtual.render(parent, cursor, later);
+        this.rendered = virtual.render(parent, cursor, later, false);
         cursor.delete(old.destroy(applicator));
       }
     }

src/coconut/diffing/internal/RChildren.hx

@@ -9,10 +9,10 @@ class RChildren<Native> {
 
   public final parent:Parent;
 
-  public function new(parent:Parent, children:Children<VNode<Native>>, cursor:Cursor<Native>, later) {
+  public function new(parent:Parent, children:Children<VNode<Native>>, cursor:Cursor<Native>, later, hydrate) {
     this.parent = parent;
     for (c in children) if (c != null) {
-      var r = c.render(parent, cursor, later);
+      var r = c.render(parent, cursor, later, hydrate);
       switch [c.key, byType[r.type]] {
         case [null, null]: byType[r.type] = [r];
         case [null, a]: a.push(r);
@@ -45,7 +45,7 @@ class RChildren<Native> {
       }
 
     inline function insert(v:VNode<Native>)
-      return byType[v.type][counts[v.type]++] = v.render(parent, cursor, later);
+      return byType[v.type][counts[v.type]++] = v.render(parent, cursor, later, false);
 
     var deleteCount = 0,
         applicator = cursor.applicator;
@@ -71,7 +71,7 @@ class RChildren<Native> {
           }
         case [k, _]:
           inline function insert(v:VNode<Native>)
-            return setKey(k, v.render(parent, cursor, later));
+            return setKey(k, v.render(parent, cursor, later, false));
           switch getKey(k) {
             case null:
               insert(v);