Implemented module and namespace pattern in js notebook.

IPython/frontend/html/notebook/static/js/cell.js

@@ -3,6 +3,9
 // Cell
 //============================================================================
 
+var IPython = (function (IPython) {
+
+    var utils = IPython.utils;
 
 var Cell = function (notebook) {
     this.notebook = notebook;
@@ -13,7 +16,7 var Cell = function (notebook) {
         this.element.data("cell", this);
         this.bind_events();
     }
-    this.cell_id = uuid();
+        this.cell_id = utils.uuid();
 };
 
 
@@ -69,4 +72,9 Cell.prototype.bind_events = function () {
 // Subclasses must implement create_element.
 Cell.prototype.create_element = function () {};
 
+    IPython.Cell = Cell;
+
+    return IPython;
+
+}(IPython));
 

IPython/frontend/html/notebook/static/js/codecell.js

@@ -3,15 +3,18
 // CodeCell
 //============================================================================
 
+var IPython = (function (IPython) {
+
+    var utils = IPython.utils;
 
 var CodeCell = function (notebook) {
     this.code_mirror = null;
     this.input_prompt_number = ' ';
-    Cell.apply(this, arguments);
+        IPython.Cell.apply(this, arguments);
 };
 
 
-CodeCell.prototype = new Cell();
+    CodeCell.prototype = new IPython.Cell();
 
 
 CodeCell.prototype.create_element = function () {
@@ -33,7 +36,7 CodeCell.prototype.create_element = function () {
 
 
 CodeCell.prototype.select = function () {
-    Cell.prototype.select.apply(this);
+        IPython.Cell.prototype.select.apply(this);
     this.code_mirror.focus();
 };
 
@@ -66,7 +69,6 CodeCell.prototype.append_pyerr = function (ename, evalue, tb) {
 
 
 CodeCell.prototype.append_display_data = function (data, element) {
-    console.log(data);
     if (data["text/latex"] !== undefined) {
         this.append_latex(data["text/latex"], element);
         // If it is undefined, then we just appended to div.output, which
@@ -89,7 +91,7 CodeCell.prototype.append_display_data = function (data, element) {
 CodeCell.prototype.append_stream = function (data, element) {
     element = element || this.element.find("div.output");
     var toinsert = $("<div/>").addClass("output_area output_stream monospace-font");
-    toinsert.append($("<pre/>").addClass("monospace-font").html(fixConsole(data)));
+        toinsert.append($("<pre/>").addClass("monospace-font").html(utils.fixConsole(data)));
     element.append(toinsert);
     return element;
 };
@@ -192,4 +194,8 CodeCell.prototype.toJSON = function () {
     };
 };
 
+    IPython.CodeCell = CodeCell;
+
+    return IPython;
+}(IPython));
 

IPython/frontend/html/notebook/static/js/kernel.js

@@ -3,6 +3,9
 // Kernel
 //============================================================================
 
+var IPython = (function (IPython) {
+
+    var utils = IPython.utils;
 
 var Kernel = function () {
     this.kernel_id = null;
@@ -14,7 +17,7 var Kernel = function () {
 Kernel.prototype.get_msg = function (msg_type, content) {
     var msg = {
         header : {
-            msg_id : uuid(),
+                msg_id : utils.uuid(),
             username : "bgranger",
             session: this.session_id,
             msg_type : msg_type
@@ -104,4 +107,9 Kernel.prototype.status_restarting = function () {
     $("#kernel_status").text("Restarting");
 };
 
+    IPython.Kernel = Kernel;
+
+    return IPython;
+
+}(IPython));
 

IPython/frontend/html/notebook/static/js/namespace.js

@@ -1,4 +1,23
-var IPYTHON = {};
+var IPython = IPython || {};
+
+IPython.namespace = function (ns_string) {
+    var parts = ns_string.split('.'),
+        parent = IPython,
+        i;
+
+    // String redundant leading global
+    if (parts[0] === "IPython") {
+        parts = parts.slice(1);
+    }
+
+    for (i=0; i<parts.length; i+=1) {
+        // Create property if it doesn't exist
+        if (typeof parent[parts[i]] === "undefined") {
+            parent[parts[i]] == {};
+        }
+    }
+    return parent;
+};
 
 
 

IPython/frontend/html/notebook/static/js/notebook.js

@@ -3,6 +3,7
 // Notebook
 //============================================================================
 
+var IPython = (function (IPython) {
 
 var Notebook = function (selector) {
     this.element = $(selector);
@@ -42,7 +43,7 Notebook.prototype.bind_events = function () {
             var cell_index = that.find_cell_index(cell);
             // TODO: the logic here needs to be moved into appropriate
             // methods of Notebook.
-            if (cell instanceof CodeCell) {
+                if (cell instanceof IPython.CodeCell) {
                 event.preventDefault();
                 cell.clear_output();
                 var code = cell.get_code();
@@ -62,7 +63,7 Notebook.prototype.bind_events = function () {
                     var msg_id = that.kernel.execute(cell.get_code());
                     that.msg_cell_map[msg_id] = cell.cell_id;
                 };
-            } else if (cell instanceof TextCell) {
+                } else if (cell instanceof IPython.TextCell) {
                 event.preventDefault();
                 cell.render();
             }
@@ -274,7 +275,7 Notebook.prototype.sort_cells = function () {
 Notebook.prototype.insert_code_cell_before = function (index) {
     // TODO: Bounds check for i
     var i = this.index_or_selected(index);
-    var cell = new CodeCell(this);
+        var cell = new IPython.CodeCell(this);
     cell.set_input_prompt(this.next_prompt_number);
     this.next_prompt_number = this.next_prompt_number + 1;
     this.insert_cell_before(cell, i);
@@ -286,7 +287,7 Notebook.prototype.insert_code_cell_before = function (index) {
 Notebook.prototype.insert_code_cell_after = function (index) {
     // TODO: Bounds check for i
     var i = this.index_or_selected(index);
-    var cell = new CodeCell(this);
+        var cell = new IPython.CodeCell(this);
     cell.set_input_prompt(this.next_prompt_number);
     this.next_prompt_number = this.next_prompt_number + 1;
     this.insert_cell_after(cell, i);
@@ -298,7 +299,7 Notebook.prototype.insert_code_cell_after = function (index) {
 Notebook.prototype.insert_text_cell_before = function (index) {
     // TODO: Bounds check for i
     var i = this.index_or_selected(index);
-    var cell = new TextCell(this);
+        var cell = new IPython.TextCell(this);
     cell.config_mathjax();
     this.insert_cell_before(cell, i);
     this.select(this.find_cell_index(cell));
@@ -309,7 +310,7 Notebook.prototype.insert_text_cell_before = function (index) {
 Notebook.prototype.insert_text_cell_after = function (index) {
     // TODO: Bounds check for i
     var i = this.index_or_selected(index);
-    var cell = new TextCell(this);
+        var cell = new IPython.TextCell(this);
     cell.config_mathjax();
     this.insert_cell_after(cell, i);
     this.select(this.find_cell_index(cell));
@@ -322,7 +323,7 Notebook.prototype.text_to_code = function (index) {
     var i = this.index_or_selected(index);
     var source_element = this.cell_elements().eq(i);
     var source_cell = source_element.data("cell");
-    if (source_cell instanceof TextCell) {
+        if (source_cell instanceof IPython.TextCell) {
         this.insert_code_cell_after(i);
         var target_cell = this.cells()[i+1];
         target_cell.set_code(source_cell.get_text());
@@ -336,7 +337,7 Notebook.prototype.code_to_text = function (index) {
     var i = this.index_or_selected(index);
     var source_element = this.cell_elements().eq(i);
     var source_cell = source_element.data("cell");
-    if (source_cell instanceof CodeCell) {
+        if (source_cell instanceof IPython.CodeCell) {
         this.insert_text_cell_after(i);
         var target_cell = this.cells()[i+1];
         var text = source_cell.get_code();
@@ -365,7 +366,7 Notebook.prototype.expand = function (index) {
 // Kernel related things
 
 Notebook.prototype.start_kernel = function () {
-    this.kernel = new Kernel();
+        this.kernel = new IPython.Kernel();
     this.kernel.start_kernel(this._kernel_started, this);
 };
 
@@ -387,7 +388,7 Notebook.prototype._kernel_started = function () {
     this.kernel.iopub_channel.onmessage = function (e) {
         reply = $.parseJSON(e.data);
         var content = reply.content;
-        console.log(reply);
+            // console.log(reply);
         var msg_type = reply.header.msg_type;
         var cell = that.cell_for_msg(reply.parent_header.msg_id);
         if (msg_type === "stream") {
@@ -506,3 +507,9 Notebook.prototype.load_notebook = function (filename) {
     $.ajax("/notebooks/" + filename, settings);
 }
 
+    IPython.Notebook = Notebook;
+
+    return IPython;
+
+}(IPython));
+

IPython/frontend/html/notebook/static/js/notebook_main.js

@@ -20,43 +20,43 $(document).ready(function () {
         }
     });
 
-    IPYTHON.notebook = new Notebook('div.notebook');
-    IPYTHON.notebook.insert_code_cell_after();
+    IPython.notebook = new IPython.Notebook('div.notebook');
+    IPython.notebook.insert_code_cell_after();
 
     $("#menu_tabs").tabs();
 
     $("#help_toolbar").buttonset();
 
     $("#kernel_toolbar").buttonset();
-    $("#interrupt_kernel").click(function () {IPYTHON.notebook.kernel.interrupt();});
-    $("#restart_kernel").click(function () {IPYTHON.notebook.kernel.restart();});
+    $("#interrupt_kernel").click(function () {IPython.notebook.kernel.interrupt();});
+    $("#restart_kernel").click(function () {IPython.notebook.kernel.restart();});
     $("#kernel_status").addClass("status_idle");
 
     $("#move_cell").buttonset();
     $("#move_up").button("option", "icons", {primary:"ui-icon-arrowthick-1-n"});
     $("#move_up").button("option", "text", false);
-    $("#move_up").click(function () {IPYTHON.notebook.move_cell_up();});
+    $("#move_up").click(function () {IPython.notebook.move_cell_up();});
     $("#move_down").button("option", "icons", {primary:"ui-icon-arrowthick-1-s"});
     $("#move_down").button("option", "text", false);
-    $("#move_down").click(function () {IPYTHON.notebook.move_cell_down();});
+    $("#move_down").click(function () {IPython.notebook.move_cell_down();});
 
     $("#insert_delete").buttonset();
-    $("#insert_cell_before").click(function () {IPYTHON.notebook.insert_code_cell_before();});
-    $("#insert_cell_after").click(function () {IPYTHON.notebook.insert_code_cell_after();});
+    $("#insert_cell_before").click(function () {IPython.notebook.insert_code_cell_before();});
+    $("#insert_cell_after").click(function () {IPython.notebook.insert_code_cell_after();});
     $("#delete_cell").button("option", "icons", {primary:"ui-icon-closethick"});
     $("#delete_cell").button("option", "text", false);
-    $("#delete_cell").click(function () {IPYTHON.notebook.delete_cell();});
+    $("#delete_cell").click(function () {IPython.notebook.delete_cell();});
 
     $("#cell_type").buttonset();
-    $("#to_code").click(function () {IPYTHON.notebook.text_to_code();});
-    $("#to_text").click(function () {IPYTHON.notebook.code_to_text();});
+    $("#to_code").click(function () {IPython.notebook.text_to_code();});
+    $("#to_text").click(function () {IPython.notebook.code_to_text();});
 
     $("#sort").buttonset();
-    $("#sort_cells").click(function () {IPYTHON.notebook.sort_cells();});
+    $("#sort_cells").click(function () {IPython.notebook.sort_cells();});
 
     $("#toggle").buttonset();
-    $("#collapse").click(function () {IPYTHON.notebook.collapse();});
-    $("#expand").click(function () {IPYTHON.notebook.expand();});
+    $("#collapse").click(function () {IPython.notebook.collapse();});
+    $("#expand").click(function () {IPython.notebook.expand();});
 
 });
 

IPython/frontend/html/notebook/static/js/textcell.js

@@ -3,15 +3,16
 // TextCell
 //============================================================================
 
+var IPython = (function (IPython) {
 
 var TextCell = function (notebook) {
-    Cell.apply(this, arguments);
+        IPython.Cell.apply(this, arguments);
     this.placeholder = "Type <strong>HTML</strong> and LaTeX: $\\alpha^2$"
     this.rendered = false;
 };
 
 
-TextCell.prototype = new Cell();
+    TextCell.prototype = new IPython.Cell();
 
 
 TextCell.prototype.create_element = function () {
@@ -31,7 +32,7 TextCell.prototype.create_element = function () {
 
 
 TextCell.prototype.bind_events = function () {
-    Cell.prototype.bind_events.apply(this);
+        IPython.Cell.prototype.bind_events.apply(this);
     var that = this;
     this.element.keydown(function (event) {
         if (event.which === 13) {
@@ -45,7 +46,7 TextCell.prototype.bind_events = function () {
 
 
 TextCell.prototype.select = function () {
-    Cell.prototype.select.apply(this);
+        IPython.Cell.prototype.select.apply(this);
     var output = this.element.find("div.text_cell_render");
     output.trigger('focus');
 };
@@ -141,4 +142,9 TextCell.prototype.toJSON = function () {
     };
 };
 
+    IPython.TextCell = TextCell;
+
+    return IPython;
+
+}(IPython));
 

IPython/frontend/html/notebook/static/js/utils.js

@@ -3,6 +3,9
 // Utilities
 //============================================================================
 
+IPython.namespace('IPython.utils')
+
+IPython.utils = (function (IPython) {
 
 var uuid = function () {
     // http://www.ietf.org/rfc/rfc4122.txt
@@ -60,3 +63,10 function fixConsole(txt) {
     return txt.trim()
 }
 
+    return {
+        uuid : uuid,
+        fixConsole : fixConsole
+    }
+
+}(IPython));
+