Add Command (ES5 + ES6 + CoffeeScript + TypeScript)

Author: Badacadabra

doc/GoF/Behavioral/Command/Command.dia

@@ -0,0 +1,24 @@
+# Synopsis
+
+I am hungry and I decide to call the nearest Tex-Mex restaurant to place an order. I hope I will receive my meal fast.
+
+# Problem
+
+Placing an order is easy to do. As a customer, you only need to say what you want to eat and nothing else. However, for the restaurant, there is a true organization behind the scenes to effectively treat your order. The chef cooks for you, then the meal is packaged and finally the delivery man brings it to you as fast as possible. Plus, you are not the only one to be hungry... The restaurant is most likely in a situation where it has to handle many orders, especially when it is time for dinner.
+
+In computer science terms, it seems obvious that the restaurant has to handle a queue of orders and that each customer is a unique entity. Since a customer normally pays his order to the delivery man, the payment should be the last step of the process. But this is not so intuitive if you try to find a good code organization for this. On the one hand, all orders are handled by the restaurant and everything required to prepare these orders is like encapsulated in each order. On the other hand, only customers can validate orders since their responsible for payment.
+
+# Solution
+
+The Command pattern is a great help here. In this pattern terminology, we will say that:
+  ***
+  * The restaurant is the "invoker" who creates and handles new orders internally
+  * The order is the "command", in other words the request which comes from a client
+  * The customer is the "receiver" of the order
+
+To implement this pattern, we then need:
+
+  * A concrete "class" representing the restaurant
+  * An abstract representation of an order (abstract class or interface)
+  * A concrete order that we will call "TexMex" (this one must have a reference to the customer)
+  * A concrete customer whose action (pay) will be triggered from the order itself

doc/GoF/Behavioral/Command/Command.png

@@ -0,0 +1,55 @@
+# ==============================
+# ABSTRACT ORDER
+# ==============================
+
+class Order
+    constructor: ->
+        throw new Error "You cannot instantiate an abstract class!" if @constructor is Order
+
+    deliver: ->
+        throw new Error "You cannot call an abstract method!"
+
+# ==============================
+# CONCRETE ORDER
+# ==============================
+
+class TexMex extends Order
+    constructor: (@customer) ->
+
+    deliver: ->
+        @customer.pay()
+
+# ==============================
+# CONCRETE RESTAURANT
+# ==============================
+
+class Restaurant
+    constructor: ->
+        @_orders = []
+
+    addOrder: (order) -> 
+        @_orders.push order
+
+    prepareOrders: ->
+        summary = ""
+        summary += order.deliver() for order in @_orders
+        summary
+
+# ==============================
+# CONCRETE CUSTOMER
+# ==============================
+
+class Customer
+    pay: ->
+        "Payment OK!\n"
+
+# ==============================
+# CLIENT CODE
+# ==============================
+
+customer = new Customer
+order = new TexMex customer
+restaurant = new Restaurant
+
+restaurant.addOrder order
+console.log restaurant.prepareOrders()

doc/GoF/Behavioral/Command/README.md

@@ -0,0 +1,64 @@
+// ==============================
+// ABSTRACT ORDER
+// ==============================
+
+interface Order {
+    deliver(): string;
+}
+
+// ==============================
+// CONCRETE ORDER
+// ==============================
+
+class TexMex implements Order {
+    private customer: Customer;
+
+    constructor(customer: Customer) {
+        this.customer = customer;
+    }
+
+    public deliver(): string {
+        return this.customer.pay();
+    }
+}
+
+// ==============================
+// CONCRETE RESTAURANT
+// ==============================
+
+class Restaurant {
+    private orders: Order[] = [];
+
+    addOrder(order: Order): void {
+        this.orders.push(order);
+    }
+
+    prepareOrders(): string {
+        let summary: string = "";
+        for (let order of this.orders) {
+            summary += order.deliver();
+        }
+        return summary;
+    }
+}
+
+// ==============================
+// CONCRETE CUSTOMER
+// ==============================
+
+class Customer {
+    pay(): string {
+        return "Payment OK!\n";
+    }
+}
+
+// ==============================
+// CLIENT CODE
+// ==============================
+
+let customer: Customer = new Customer(),
+    order: Order = new TexMex(customer),
+    restaurant: Restaurant = new Restaurant();
+
+restaurant.addOrder(order);
+console.log(restaurant.prepareOrders());

src/CoffeeScript/GoF/Behavioral/Command/Command.coffee

@@ -0,0 +1,86 @@
+'use strict';
+
+// ==============================
+// ABSTRACT ORDER
+// ==============================
+
+var Order = (function() {
+    function Order() {
+        if (this.constructor === Order) {
+            throw new Error("You cannot instantiate an abstract class!");
+        }
+    }
+
+    Order.prototype.deliver = function () {
+        throw new Error("You cannot call an abstract method!");
+    };
+
+    return Order;
+})();
+
+// ==============================
+// CONCRETE ORDER
+// ==============================
+
+var TexMex = (function () {
+    function TexMex(customer) {
+        this.customer = customer;
+    }
+    TexMex.prototype = Object.create(Order.prototype);
+    TexMex.prototype.constructor = TexMex;
+
+    TexMex.prototype.deliver = function () {
+        return this.customer.pay();
+    };
+
+    return TexMex;
+})();
+
+// ==============================
+// CONCRETE RESTAURANT
+// ==============================
+
+var Restaurant = (function () {
+    var orders = [];
+
+    function Restaurant() {}
+
+    Restaurant.prototype.addOrder = function (order) {
+        orders.push(order);
+    };
+
+    Restaurant.prototype.prepareOrders = function () {
+        var summary = "";
+        for (var i = 0, len = orders.length; i < len; i++) {
+            summary += orders[i].deliver();
+        }
+        return summary;
+    };
+
+    return Restaurant;
+})();
+
+// ==============================
+// CONCRETE CUSTOMER
+// ==============================
+
+var Customer = (function () {
+    function Customer() {}
+
+    Customer.prototype.pay = function () {
+        return "Payment OK!\n";
+    };
+
+    return Customer;
+})();
+
+// ==============================
+// CLIENT CODE
+// ==============================
+
+var customer = new Customer(),
+    order = new TexMex(customer),
+    restaurant = new Restaurant();
+
+restaurant.addOrder(order);
+console.log(restaurant.prepareOrders());

src/TypeScript/GoF/Behavioral/Command/Command.ts

@@ -0,0 +1,73 @@
+// ==============================
+// ABSTRACT ORDER
+// ==============================
+
+class Order {
+    constructor() {
+        if (new.target !== undefined) {
+            throw new Error("You cannot instantiate an abstract class!");
+        }
+    }
+
+    deliver() {
+        throw new Error("You cannot call an abstract method!");
+    }
+}
+
+// ==============================
+// CONCRETE ORDER
+// ==============================
+
+class TexMex extends Order {
+    constructor(customer) {
+        super();
+        this._customer = customer;
+    }
+
+    deliver() {
+        return this._customer.pay();
+    }
+}
+
+// ==============================
+// CONCRETE RESTAURANT
+// ==============================
+
+class Restaurant {
+    constructor() {
+        this._orders = [];
+    }
+
+    addOrder(order) {
+        this._orders.push(order);
+    }
+
+    prepareOrders() {
+        let summary = "";
+        for (let order of this._orders) {
+            summary += order.deliver();
+        }
+        return summary;
+    }
+}
+
+// ==============================
+// CONCRETE CUSTOMER
+// ==============================
+
+class Customer {
+    pay() {
+        return "Payment OK!\n";
+    }
+}
+
+// ==============================
+// CLIENT CODE
+// ==============================
+
+let customer = new Customer(),
+    order = new TexMex(customer),
+    restaurant = new Restaurant();
+
+restaurant.addOrder(order);
+console.log(restaurant.prepareOrders());