Merge pull request #20 from kuzzleio/2.0.0-proposal

Release 2.0.0

.ci/doc/config.yml

@@ -0,0 +1,19 @@
+---
+
+  snippets:
+    mount: /mnt
+    path: 'doc/**/snippets/*.test.yml'
+    templates: /mnt/.ci/doc/templates
+
+  runners:
+    default: dart
+
+    dart:
+      service: doc-runner-dart
+      path: /var/snippets/dart
+      build:
+        cmd: cd /mnt
+      run:
+        before: timeout 600 bash -c 'until stat /tmp/runner_is_ready && curl -f -s -o /dev/null http://kuzzle:7512/_now; do sleep 1; done && cp *.dart /mnt/.ci/doc/project/ && cd /mnt/.ci/doc/project/ && pub get'
+        cmd: cd /mnt/.ci/doc/project/ && dart {{ snippet.source }}
+

.ci/doc/docker-compose.yml

@@ -0,0 +1,56 @@
+version: '3'
+
+services:
+  kuzzle:
+    image: kuzzleio/kuzzle:2
+    ports:
+      - "7512:7512"
+    cap_add:
+      - SYS_PTRACE
+    depends_on:
+      - redis
+      - elasticsearch
+    environment:
+      - kuzzle_services__storageEngine__client__node=http://elasticsearch:9200
+      - kuzzle_services__internalCache__node__host=redis
+      - kuzzle_services__memoryStorage__node__host=redis
+      - kuzzle_services__storageEngine__commonMapping__dynamic=true
+      - NODE_ENV=production
+
+  redis:
+    image: redis:5
+
+  elasticsearch:
+    image: kuzzleio/elasticsearch:7
+    ulimits:
+      nofile: 65536
+
+  doc-tests:
+    image: kuzzleio/snippets-tests
+    privileged: true
+    ports:
+      - '9229:9229'
+    depends_on:
+      - kuzzle
+      - doc-runner-dart
+    volumes:
+      - ../..:/mnt
+      - /var/run/docker.sock:/var/run/docker.sock
+      - snippets:/var/snippets
+    environment:
+      - CONFIG_FILE=/mnt/.ci/doc/config.yml
+
+  doc-runner-dart:
+    image: google/dart
+    command: >
+      bash -c '
+        mkdir -p /var/snippets/dart;
+        touch /tmp/runner_is_ready;
+        tail -f /dev/null
+      '
+    volumes:
+      - ../..:/mnt
+      - snippets:/var/snippets
+
+volumes:
+  snippets:

.ci/doc/project/pubspec.yaml

@@ -0,0 +1,7 @@
+name: Tests
+version: 1.0.0
+description: Dart SDK doc snippet test project
+
+dependencies:
+  kuzzle:
+    path: /mnt/

.ci/doc/templates/catch.tpl.dart

@@ -0,0 +1,23 @@
+import 'dart:io';
+
+import 'package:kuzzle/kuzzle.dart';
+
+void main() async {
+  final kuzzle = Kuzzle(
+    WebSocketProtocol(Uri(
+    scheme: 'ws',
+    host: 'kuzzle',
+    port: 7512,
+  )),
+    offlineMode: OfflineMode.auto,
+  );
+  try {
+    kuzzle.connect();
+    [snippet-code]
+  } catch(e, s) {
+    print(e.message);
+  } finally {
+  kuzzle.disconnect();
+  }
+  exit(0);
+}

.ci/doc/templates/default.tpl.dart

@@ -0,0 +1,19 @@
+import 'dart:io';
+
+import 'package:kuzzle/kuzzle.dart';
+
+void main() async {
+  final kuzzle = Kuzzle(
+    WebSocketProtocol(Uri(
+    scheme: 'ws',
+    host: 'kuzzle',
+    port: 7512,
+  )),
+    offlineMode: OfflineMode.auto,
+  );
+  kuzzle.connect();
+  [snippet-code]
+  print('Success');
+  kuzzle.disconnect();
+  exit(0);
+}

.ci/doc/templates/print-collection-length.tpl.dart

@@ -0,0 +1,19 @@
+import 'dart:io';
+
+import 'package:kuzzle/kuzzle.dart';
+
+void main() async {
+  final kuzzle = Kuzzle(
+    WebSocketProtocol(Uri(
+    scheme: 'ws',
+    host: 'kuzzle',
+    port: 7512,
+  )),
+    offlineMode: OfflineMode.auto,
+  );
+  kuzzle.connect();
+  [snippet-code]
+  print(result['collections'].length);
+  kuzzle.disconnect();
+  exit(0);
+}

.ci/doc/templates/print-result-arraylist.tpl.dart

@@ -0,0 +1,19 @@
+import 'dart:io';
+
+import 'package:kuzzle/kuzzle.dart';
+
+void main() async {
+  final kuzzle = Kuzzle(
+    WebSocketProtocol(Uri(
+    scheme: 'ws',
+    host: 'kuzzle',
+    port: 7512,
+  )),
+    offlineMode: OfflineMode.auto,
+  );
+  kuzzle.connect();
+  [snippet-code]
+  print(result.values);
+  kuzzle.disconnect();
+  exit(0);
+}

.ci/doc/templates/print-result.tpl.dart

@@ -0,0 +1,19 @@
+import 'dart:io';
+
+import 'package:kuzzle/kuzzle.dart';
+
+void main() async {
+  final kuzzle = Kuzzle(
+    WebSocketProtocol(Uri(
+    scheme: 'ws',
+    host: 'kuzzle',
+    port: 7512,
+  )),
+    offlineMode: OfflineMode.auto,
+  );
+  kuzzle.connect();
+  [snippet-code]
+  print(result.toString());
+  kuzzle.disconnect();
+  exit(0);
+}

.ci/doc/templates/print-search-result.tpl.dart

@@ -0,0 +1,19 @@
+import 'dart:io';
+
+import 'package:kuzzle/kuzzle.dart';
+
+void main() async {
+  final kuzzle = Kuzzle(
+    WebSocketProtocol(Uri(
+    scheme: 'ws',
+    host: 'kuzzle',
+    port: 7512,
+  )),
+    offlineMode: OfflineMode.auto,
+  );
+  kuzzle.connect();
+  [snippet-code]
+  print(result.fetched);
+  kuzzle.disconnect();
+  exit(0);
+}

.ci/doc/templates/without-ctor.tpl.dart

@@ -0,0 +1,6 @@
+import 'package:kuzzle/kuzzle.dart';
+
+void main() {
+  [snippet-code]
+  print('Success');
+}

.gitignore

@@ -72,3 +72,6 @@ build/
 
 
 coverage
+
+doc/framework
+.ci/doc/project/*.dart