Merge pull request #14 from mbasso/0.6.0

Version 0.6.0

Author: mbasso

.travis.yml

@@ -4,12 +4,18 @@ node_js:
   - "7"
   - "8"
   - "9"
+  - "10"
 install: true
+sudo: required
+services:
+  - docker
+before_install:
+  - docker run -dit --name emscripten -v $(pwd):/src trzeci/emscripten:sdk-incoming-64bit bash
 script:
   - npm install --ignore-scripts
+  - docker exec -it emscripten make
   - npm run lint
   - npm run test:js
-  - npm run build
 branches:
   only:
     - master
@@ -32,4 +38,5 @@ jobs:
       branches:
         only:
           - master
+      if: tag =~ ^\d+\.\d+\.\d+
       after_success: echo "Website online"

CONTRIBUTING.md

@@ -25,51 +25,25 @@ git clone https://github.com/mbasso/asm-dom.git
 
 #### Building asm-dom
 
-Running the `build` task will create both a CommonJS module-per-module build and a UMD build.
+Running `make` will create both the C++ and the JS version of asm-dom, a CommonJS module-per-module build and a UMD build.
 ```
-npm run build
+make
 ```
 
-To create just a CommonJS module-per-module build:
-
-```
-npm run build:commonjs
-```
-
-The result will be in the `lib` folder.
-
-To create just a UMD build:
-```
-npm run build:umd
-npm run build:umd:min
-```
-
-The result will be in the `dist` folder.
+The result will be in the `lib`, `es` and `dist` folder.
 
 ### Testing and Linting
 
-To run both linting and testing at once, run the following:
-
-```
-npm run check:src
-```
-
-To only run linting:
-
-```
-npm run lint
-```
-
-To only run tests:
+To run linting:
 
 ```
-npm run test
+make lint
 ```
 
-To continuously watch and run tests, run the following:
+To run tests:
 
 ```
-npm run test:watch
+make test
 ```
 
 ### Docs

Makefile

@@ -0,0 +1,158 @@
+# if you are using windows, comment line 5, 6 and 7 and uncomment line 8, 9 and 10
+# leave it as it was before committing as travis uses linux
+SRCDIR := src
+TESTDIR := test
+SRCS := $(shell find $(SRCDIR) -name "*.js")
+SRCSCPP := $(shell find $(SRCDIR) -name "*.cpp")
+TEST_FILES := $(shell find $(TESTDIR) -name "*.cpp")
+#SRCS := $(shell FORFILES /P $(SRCDIR) /S /M *.js /C "CMD /C ECHO @relpath")
+#SRCSCPP := $(shell FORFILES /P $(SRCDIR) /S /M *.cpp /C "CMD /C ECHO @relpath")
+#TEST_FILES := $(shell FORFILES /P $(TESTDIR) /S /M *.cpp /C "CMD /C ECHO @relpath")
+
+ESDIR := es
+LIBDIR := lib
+ES := $(SRCS:$(SRCDIR)/%=$(ESDIR)/%)
+LIBS := $(SRCS:$(SRCDIR)/%=$(LIBDIR)/%)
+DISTDIR := dist
+DISTJS := $(DISTDIR)/js
+DISTCPP := $(DISTDIR)/cpp
+UMDJS := $(DISTJS)/asm-dom.js
+UMDCPP := $(DISTCPP)/asm-dom.js
+TESTCPP := test/cpp/app.asm.js
+COMPILED := compiled
+COMPILEDASMJS := $(COMPILED)/asmjs
+COMPILEDWASM := $(COMPILED)/wasm
+CPPDIR := cpp
+
+TREE := \
+	$(COMPILED) \
+	$(COMPILEDASMJS) \
+	$(COMPILEDWASM) \
+	$(DISTDIR) \
+	$(DISTJS) \
+	$(DISTCPP) \
+	$(ESDIR) \
+	$(LIBDIR) \
+	$(sort $(patsubst %/,%,$(dir $(ES)))) \
+	$(sort $(patsubst %/,%,$(dir $(LIBS))))
+
+FILES = \
+	src/cpp/asm-dom.cpp \
+	src/cpp/asm-dom-server.cpp
+
+BC = compiled/asm-dom.bc
+
+CFLAGS = \
+	-O3 \
+	--bind \
+	-Wall \
+	-Werror \
+	-Wall \
+	-Wno-deprecated \
+	-Wno-parentheses \
+	-Wno-format
+
+WASM_OPTIONS = \
+	-O3 \
+	--bind \
+	--memory-init-file 0 \
+	--llvm-lto 3 \
+	--llvm-opts 3 \
+	--js-opts 1 \
+	--closure 1 \
+	-s MODULARIZE=1 \
+	-s ALLOW_MEMORY_GROWTH=1 \
+	-s AGGRESSIVE_VARIABLE_ELIMINATION=1 \
+	-s ABORTING_MALLOC=1 \
+	-s NO_EXIT_RUNTIME=1 \
+	-s NO_FILESYSTEM=1 \
+	-s DISABLE_EXCEPTION_CATCHING=2 \
+	-s BINARYEN=1 \
+	-s EXPORTED_RUNTIME_METHODS=[\'UTF8ToString\'] \
+	-s BINARYEN_TRAP_MODE=\'allow\'
+
+ASMJS_OPTIONS = \
+	-O3 \
+	--bind \
+	--memory-init-file 0 \
+	--llvm-lto 3 \
+	--llvm-opts 3 \
+	--js-opts 1 \
+	--closure 1 \
+	-s MODULARIZE=1 \
+	-s AGGRESSIVE_VARIABLE_ELIMINATION=1 \
+	-s ELIMINATE_DUPLICATE_FUNCTIONS=1 \
+	-s ABORTING_MALLOC=1 \
+	-s NO_EXIT_RUNTIME=1 \
+	-s NO_FILESYSTEM=1 \
+	-s DISABLE_EXCEPTION_CATCHING=2 \
+	-s EXPORTED_RUNTIME_METHODS=[\'UTF8ToString\'] \
+	-s WASM=0
+
+.PHONY: all install clean lint test test_js test_watch build
+
+all: build
+
+install:
+	npm install
+
+clean:
+	npx rimraf $(DISTDIR) $(LIBDIR) $(ESDIR) $(CPPDIR) .nyc_output $(COMPILED) $(TESTCPP)
+
+lint:
+	npx eslint src test build
+
+test: $(COMPILEDASMJS)/asm-dom.asm.js $(COMPILEDWASM)/asm-dom.js $(TESTCPP) test_js
+
+test_js:
+	npx cross-env BABEL_ENV=commonjs nyc --require babel-register --require ./test/setup.js mocha --recursive
+
+build: compiled/asm-dom.a $(BC) compiled/asm-dom.o $(COMPILEDASMJS)/asm-dom.asm.js $(COMPILEDWASM)/asm-dom.js $(TESTCPP) $(LIBS) $(ES) $(UMDJS) $(UMDCPP)
+	npx ncp $(SRCDIR)/cpp $(CPPDIR)
+	npx ncp $(DISTCPP) $(CPPDIR)
+	npx ncp $(LIBDIR)/cpp $(CPPDIR)
+
+$(TESTCPP): $(SRCSCPP) $(TEST_FILES)
+	emcc \
+		-DASMDOM_TEST \
+		$(CFLAGS) \
+		$(ASMJS_OPTIONS) \
+		$(FILES) \
+		$(TEST_FILES) \
+		-o $@
+
+.SECONDEXPANSION:
+$(COMPILED)/asm-dom.%: $(SRCSCPP) | $$(@D)
+	emcc \
+		-DASMDOM_JS_SIDE \
+		$(CFLAGS) \
+		$(FILES) \
+		src/js/index.cpp \
+		-o $@
+
+$(COMPILEDASMJS)/asm-dom.asm.js: $(BC) | $$(@D)
+	emcc \
+		$(ASMJS_OPTIONS) \
+		$(BC) \
+		-o $@
+
+$(COMPILEDWASM)/asm-dom.js: $(BC) | $$(@D)
+	emcc \
+		$(WASM_OPTIONS) \
+		$(BC) \
+		-o $@
+
+$(ESDIR)/%: $(SRCDIR)/% | $$(@D)
+	npx cross-env BABEL_ENV=es babel $< --out-file $@
+
+$(LIBDIR)/%: $(SRCDIR)/% | $$(@D)
+	npx cross-env BABEL_ENV=commonjs babel $< --out-file $@
+
+$(UMDJS): $(SRCS) | $$(@D)
+	npx cross-env BABEL_ENV=commonjs webpack --env.prod src/js/index.js $@
+
+$(UMDCPP): $(SRCS) | $$(@D)
+	npx cross-env BABEL_ENV=commonjs webpack --env.prod --env.cpp src/cpp/index.js $@
+
+$(TREE): %:
+	npx mkdirp $@

README.md

@@ -127,7 +127,6 @@ Also, here is the list of the online Demos:
 
 ## Roadmap
 
-- [ ] create asm-dom boilerplate
 - [ ] Thunks support
 - [ ] asm-dom aims to be even more powerful with [GC/DOM Integration](http://webassembly.org/docs/future-features/). Unfortunately this is a future feature 🦄, so, we have to be patient and wait a bit.
 

benchmarks/README.md

@@ -16,12 +16,24 @@ There are 4 tests at the moment:
 
 - `create nodes`: this test create 700 nodes (100 nodes with 3 children, the last of which has 3 more children). Please note that, as we said before, **in the case of asm-dom, this test creates but also destroys the nodes**. While, in the case of snabbdom, the deletion is managed by the garbage collector and it is not measured.
 
-- `create and diff equal nodes`: this test runs the `patch` function 100 times with 2 equal nodes (2 nodes with 100 children, each of them has 1 child), so, the DOM will be not updated.
+- `diff equal nodes`: this test runs the `patch` function 100 times with 2 equal nodes (2 nodes with 100 children, each of them has 1 child), so, the DOM will be not updated.
 
-- `create and diff different nodes`: this test runs the `patch` function 100 times with 2 nodes with different attributes (2 nodes with 100 children, each of them has 1 child), so, the DOM will be updated.
+- `diff different nodes`: this test runs the `patch` function 100 times with 2 nodes with different attributes (2 nodes with 100 children, each of them has 1 child), so, the DOM will be updated.
 
-- `create and add/remove nodes`: this test runs the `patch` function 100 times with 2 nodes, one with 100 children and one without children.
+- `add/remove nodes`: this test runs the `patch` function 100 times with 2 nodes, one with 100 children and one without children.
 
-Here you can find screenshots of the tests (lower is better) runned on a MacBook Pro (Retina, 13-inch, Late 2013), Processor 2,4 GHz Intel Core i5, Memory 8 GB 1600 MHz DDR3:
+Here you can find the tests (lower is better) runned on a MacBook Pro (Retina, 13-inch, Late 2013), Processor 2,4 GHz Intel Core i5, Memory 8 GB 1600 MHz DDR3:
 
-![Benchmarks](benchmarks.jpg)
+### Firefox 59.0.2 (64 bit)
+
+| library | create nodes | diff equal nodes | diff different nodes | add/remove nodes |
+| --- | --- | --- | --- | --- |
+| asm-dom | 0.0000 | 2.0000 | 34.0000 | 32.0000 |
+| snabbbom | 0.0000 | 12.0000 | 42.0000 | 44.0000 |
+
+### Chrome 66.0.3359.181 (64-bit)
+
+| library | create nodes | diff equal nodes | diff different nodes | add/remove nodes |
+| --- | --- | --- | --- | --- |
+| asm-dom | 0.9000 | 3.2000 | 16.4000 | 15.1000 |
+| snabbbom | 0.5000 | 4.6000 | 8.7000 | 13.3000 |