Merge pull request #35 from davidmorgan/add-chat-example

Add chat example.

Author: davidmorgan

.travis.yml

@@ -6,5 +6,9 @@ script:
   - pub run test
   - cd ../example
   - pub get
-  - pub run tool/build.dart
+  - dart tool/build.dart
+  - pub run test
+  - cd ../chat_example
+  - pub get
+  - dart tool/build.dart
   - pub run test

chat_example/.analysis_options

@@ -0,0 +1,2 @@
+analyzer:
+ strong-mode: true

chat_example/README.md

@@ -0,0 +1,17 @@
+# built_json chat example
+
+A simple chat client (dart2js) and server (Dart VM).
+
+Launch the server:
+
+`dart bin/main.dart`
+
+This will immediately work in Dartium, connect to `localhost:26199`. To build for js, run:
+
+`pub build`
+
+When developing, run
+
+`dart tool/watch.dart`
+
+to continuously update generated source.

chat_example/bin/main.dart

@@ -0,0 +1,13 @@
+// Copyright (c) 2016, Google Inc. Please see the AUTHORS file for details.
+// All rights reserved. Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+import 'package:chat_example/server/http_server_connection.dart';
+import 'package:chat_example/server/resource_server.dart';
+import 'package:chat_example/server/server.dart';
+
+void main() {
+  final server = new Server();
+  new ResourceServer().start(
+      (webSocket) => server.addConnection(new HttpServerConnection(webSocket)));
+}

chat_example/lib/client/client.dart

@@ -0,0 +1,126 @@
+// Copyright (c) 2016, Google Inc. Please see the AUTHORS file for details.
+// All rights reserved. Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+import 'dart:async';
+import 'dart:convert';
+
+import 'package:chat_example/client/client_connection.dart';
+import 'package:chat_example/client/display.dart';
+import 'package:chat_example/data_model/data_model.dart';
+import 'package:chat_example/data_model/serializers.dart';
+
+typedef CommandRunner(String command);
+
+/// Client-side logic for built_json chat example.
+class Client {
+  final Stream<String> _keyboardInput;
+  final Display _display;
+  final ClientConnection _connection;
+
+  /// A chat client needs a keyboard, a display and a connection.
+  Client(this._keyboardInput, this._display, this._connection) {
+    _keyboardInput.listen(_runLocalCommand);
+    _connection.dataFromServer.listen(_handleServerData);
+  }
+
+  void _handleServerData(String data) {
+    final response = serializers.deserialize(JSON.decode(data));
+
+    if (response is Response) {
+      _display.add(response.render());
+    } else {
+      throw new StateError('Invalid data from server: $response');
+    }
+  }
+
+  void _runLocalCommand(String command) {
+    final handlers = <String, CommandRunner>{
+      '/away': _runAway,
+      '/help': _runHelp,
+      '/list': _runList,
+      '/login': _runLogin,
+      '/quit': _runQuit,
+      '/status': _runStatus,
+      '/tell': _runTell,
+    };
+
+    var found = false;
+    handlers.forEach((prefix, commandRunner) {
+      if (command.startsWith(prefix)) {
+        commandRunner(command);
+        found = true;
+      }
+    });
+    if (found) return;
+
+    if (command.startsWith('/')) {
+      _display.addLocal(command);
+      _display.add('Unknown command.');
+      return;
+    }
+
+    _send(new Chat((b) => b..text = command));
+  }
+
+  void _runAway(String command) {
+    _send(new Status((b) => b
+      ..message = command.substring('/away '.length)
+      ..type = StatusType.away));
+  }
+
+  void _runHelp(String command) {
+    _display.add('''Commands:
+
+/away <message> -- sets away message
+/help -- for help
+/list -- list online users
+/login <username> <password> -- log in or create new user
+/quit <message> -- quits with message
+/status <message> -- sets status message
+/tell <username> <message> -- private message
+''');
+  }
+
+  void _runList(String command) {
+    _display.addLocal(command);
+    _send(new ListUsers(
+        (b) => b..statusTypes.replace([StatusType.online, StatusType.away])));
+  }
+
+  void _runLogin(String command) {
+    final words = command.split(' ');
+    _display.addLocal('/login ${words[1]} ********');
+    _send(new Login((b) => b
+      ..username = words[1]
+      ..password = words[2]));
+  }
+
+  void _runQuit(String command) {
+    _display.addLocal(command);
+    _send(new Status((b) => b
+      ..message = command.substring('/quit '.length)
+      ..type = StatusType.offline));
+  }
+
+  void _runStatus(String command) {
+    _display.addLocal(command);
+    _display.addLocal(command);
+    _send(new Status((b) => b
+      ..message = command.substring('/status '.length)
+      ..type = StatusType.online));
+  }
+
+  void _runTell(String command) {
+    _display.addLocal(command);
+    final words = command.split(' ');
+    final targets = words[1].split(',');
+    _send(new Chat((b) => b
+      ..text = words.sublist(2).join(' ')
+      ..targets.replace(targets)));
+  }
+
+  void _send(Command command) {
+    _connection.sendToServer(JSON.encode(serializers.serialize(command)));
+  }
+}

chat_example/lib/client/client_connection.dart

@@ -0,0 +1,12 @@
+// Copyright (c) 2016, Google Inc. Please see the AUTHORS file for details.
+// All rights reserved. Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+import 'dart:async';
+
+/// Two-way connection between client and server; the client.
+abstract class ClientConnection {
+  Stream<String> get dataFromServer;
+
+  void sendToServer(String string);
+}

chat_example/lib/client/display.dart

@@ -0,0 +1,12 @@
+// Copyright (c) 2016, Google Inc. Please see the AUTHORS file for details.
+// All rights reserved. Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+/// Chat window main text display.
+abstract class Display {
+  /// Adds [text] to the display, coloured to indicate a local command.
+  void addLocal(String text);
+
+  /// Adds [text] to the display.
+  void add(String text);
+}

chat_example/lib/client/html_display.dart

@@ -0,0 +1,34 @@
+// Copyright (c) 2016, Google Inc. Please see the AUTHORS file for details.
+// All rights reserved. Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+import 'dart:convert';
+import 'dart:html';
+
+import 'package:chat_example/client/display.dart';
+
+/// [Display] using `dart:html`.
+class HtmlDisplay implements Display {
+  final Element _element;
+  final HtmlEscape _htmlEscape = const HtmlEscape();
+
+  factory HtmlDisplay() {
+    return new HtmlDisplay._(querySelector('#text'));
+  }
+
+  HtmlDisplay._(this._element) {
+    add('Welcome to the built_json chat example. For help, type /help.');
+  }
+
+  void addLocal(String text) {
+    _element.innerHtml +=
+        '<div class="local">${_htmlEscape.convert(text)}</div>';
+    window.scrollTo(0, document.body.scrollHeight);
+  }
+
+  void add(String text) {
+    _element.innerHtml +=
+        '${_htmlEscape.convert(text).replaceAll('\n', '<br>')}<br>';
+    window.scrollTo(0, document.body.scrollHeight);
+  }
+}

chat_example/lib/client/http_client_connection.dart

@@ -0,0 +1,32 @@
+// Copyright (c) 2016, Google Inc. Please see the AUTHORS file for details.
+// All rights reserved. Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+import 'dart:async';
+import 'dart:html';
+
+import 'package:chat_example/client/client_connection.dart';
+
+/// [ClientConnection] using a web socket.
+class HttpClientConnection implements ClientConnection {
+  final WebSocket _websocket;
+  final StreamController<String> _streamController =
+      new StreamController<String>();
+
+  factory HttpClientConnection() {
+    return new HttpClientConnection._(
+        new WebSocket('ws://${window.location.host}/ws'));
+  }
+
+  HttpClientConnection._(this._websocket) {
+    _websocket.onMessage.listen((message) {
+      _streamController.add(message.data as String);
+    });
+  }
+
+  Stream<String> get dataFromServer => _streamController.stream;
+
+  void sendToServer(String data) {
+    _websocket.send(data);
+  }
+}

chat_example/lib/client/input.dart

@@ -0,0 +1,25 @@
+// Copyright (c) 2016, Google Inc. Please see the AUTHORS file for details.
+// All rights reserved. Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+import 'dart:async';
+import 'dart:html';
+
+/// An input box using `dart:html`.
+class Input {
+  final StreamController<String> _streamController =
+      new StreamController<String>();
+
+  Input() {
+    final input = querySelector('#input') as InputElement;
+
+    input.onKeyPress.listen((keyEvent) {
+      if (keyEvent.keyCode == KeyCode.ENTER) {
+        _streamController.add(input.value);
+        input.value = '';
+      }
+    });
+  }
+
+  Stream<String> get keyboardInput => _streamController.stream;
+}

chat_example/lib/client/layout.dart

@@ -0,0 +1,22 @@
+// Copyright (c) 2016, Google Inc. Please see the AUTHORS file for details.
+// All rights reserved. Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+import 'dart:html';
+
+/// Forces focus to the input box.
+class Layout {
+  Layout() {
+    final screen = querySelector('#screen');
+    final text = querySelector('#text');
+    final input = querySelector('#input');
+
+    input.focus();
+
+    for (final element in [screen, text]) {
+      element.onClick.listen((e) {
+        input.focus();
+      });
+    }
+  }
+}