Merge pull request #102 from Carreau/no-global

Start working on removing global JS IPython

examples/Notebook/Custom Keyboard Shortcuts.ipynb

@@ -11,7 +11,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Starting with IPython 2.0 keyboard shortcuts in command and edit mode are fully customizable. These customizations are made using the IPython JavaScript API. Here is an example that makes the `r` key available for running a cell:"
+    "Starting with IPython 2.0 keyboard shortcuts in command and edit mode are fully customizable. These customizations are made using the Jupyter JavaScript API. Here is an example that makes the `r` key available for running a cell:"
    ]
   },
   {
@@ -24,7 +24,7 @@
    "source": [
     "%%javascript\n",
     "\n",
-    "IPython.keyboard_manager.command_shortcuts.add_shortcut('r', {\n",
+    "Jupyter.keyboard_manager.command_shortcuts.add_shortcut('r', {\n",
     "    help : 'run cell',\n",
     "    help_index : 'zz',\n",
     "    handler : function (event) {\n",
@@ -34,6 +34,13 @@
     ");"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "\"By default the keypress `r`, while in command mode, changes the type of the selected cell to `raw`.  This shortcut is overridden by the code in the previous cell, and thus the action no longer be available via the keypress `r`.\""
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -55,7 +62,7 @@
    "source": [
     "%%javascript\n",
     "\n",
-    "IPython.keyboard_manager.command_shortcuts.add_shortcut('r', function (event) {\n",
+    "Jupyter.keyboard_manager.command_shortcuts.add_shortcut('r', function (event) {\n",
     "    IPython.notebook.execute_cell();\n",
     "    return false;\n",
     "});"
@@ -78,14 +85,36 @@
    "source": [
     "%%javascript\n",
     "\n",
-    "IPython.keyboard_manager.command_shortcuts.remove_shortcut('r');"
+    "Jupyter.keyboard_manager.command_shortcuts.remove_shortcut('r');"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "If you want your keyboard shortcuts to be active for all of your notebooks, put the above API calls into your `<profile>/static/custom/custom.js` file."
+    "If you want your keyboard shortcuts to be active for all of your notebooks, put the above API calls into your `custom.js` file."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {
+    "collapsed": true
+   },
+   "source": [
+    "Of course we provide name for majority of existing action so that you do not have to re-write everything, here is for example how to bind `r` back to it's initial behavior:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "collapsed": false
+   },
+   "outputs": [],
+   "source": [
+    "%%javascript\n",
+    "\n",
+    "Jupyter.keyboard_manager.command_shortcuts.add_shortcut('r', 'ipython.change-selected-cell-to-raw-cell');"
    ]
   }
  ],

notebook/static/auth/js/loginwidget.js

@@ -2,10 +2,9 @@
 // Distributed under the terms of the Modified BSD License.
 
 define([
-    'base/js/namespace',
     'base/js/utils',
     'jquery',
-], function(IPython, utils, $){
+], function(utils, $){
     "use strict";
 
     var LoginWidget = function (selector, options) {
@@ -19,7 +18,6 @@ define([
     };
 
 
-
     LoginWidget.prototype.bind_events = function () {
         var that = this;
         this.element.find("button#logout").click(function () {
@@ -36,8 +34,5 @@ define([
         });
     };
 
-    // Set module variables
-    IPython.LoginWidget = LoginWidget;
-
     return {'LoginWidget': LoginWidget};
 });

notebook/static/base/js/dialog.js

@@ -5,7 +5,6 @@ define(function(require) {
     "use strict";
 
     var CodeMirror = require('codemirror/lib/codemirror');
-    var IPython = require('base/js/namespace');
     var $ = require('jquery');
 
     /**
@@ -205,8 +204,5 @@ define(function(require) {
         edit_metadata : edit_metadata,
     };
 
-    // Backwards compatability.
-    IPython.dialog = dialog;
-
     return dialog;
 });

notebook/static/base/js/keyboard.js

@@ -9,11 +9,10 @@
  */
 
 define([
-    'base/js/namespace',
     'jquery',
     'base/js/utils',
     'underscore',
-], function(IPython, $, utils, _) {
+], function($, utils, _) {
     "use strict";
 
 
@@ -447,8 +446,5 @@ define([
         event_to_shortcut : event_to_shortcut,
     };
 
-    // For backwards compatibility.
-    IPython.keyboard = keyboard;
-
     return keyboard;
 });

notebook/static/base/js/namespace.js

@@ -1,10 +1,84 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
 
-var IPython = IPython || {};
-define([], function(){
+
+var Jupyter = Jupyter || {};
+
+var jprop = function(name, module_path){
+    Object.defineProperty(Jupyter, name, {
+      get: function() { 
+          console.warn('accessing `'+name+'` is deprecated. Use `require("'+module_path+'")`');
+          return require(module_path); 
+      },
+      enumerable: true,
+      configurable: false
+    });
+}
+
+var jglobal = function(name, module_path){
+    Object.defineProperty(Jupyter, name, {
+      get: function() { 
+          console.warn('accessing `'+name+'` is deprecated. Use `require("'+module_path+'").'+name+'`');
+          return require(module_path)[name]; 
+      },
+      enumerable: true,
+      configurable: false
+    });
+}
+
+define(function(){
     "use strict";
-    IPython.version = "4.0.0.dev";
-    IPython._target = '_blank';
-    return IPython;
+
+    // expose modules
+
+    jprop('utils','base/js/utils')
+
+    //Jupyter.load_extensions = Jupyter.utils.load_extensions;
+    // 
+    jprop('security','base/js/security');
+    jprop('keyboard','base/js/keyboard');
+    jprop('dialog','base/js/dialog');
+    jprop('mathjaxutils','notebook/js/mathjaxutils');
+
+
+    //// exposed constructors
+    jglobal('CommManager','services/kernels/comm')
+    jglobal('Comm','services/kernels/comm')
+
+    jglobal('NotificationWidget','base/js/notificationwidget');
+    jglobal('Kernel','services/kernels/kernel');
+    jglobal('Session','services/sessions/session');
+    jglobal('LoginWidget','auth/js/loginwidget');
+    jglobal('Page','base/js/page');
+
+    // notebook
+    jglobal('TextCell','notebook/js/textcell');
+    jglobal('OutputArea','notebook/js/outputarea');
+    jglobal('KeyboardManager','notebook/js/keyboardmanager');
+    jglobal('Completer','notebook/js/completer');
+    jglobal('Notebook','notebook/js/notebook');
+    jglobal('Tooltip','notebook/js/tooltip');
+    jglobal('Toolbar','notebook/js/toolbar');
+    jglobal('SaveWidget','notebook/js/savewidget');
+    jglobal('Pager','notebook/js/pager');
+    jglobal('QuickHelp','notebook/js/quickhelp');
+    jglobal('MarkdownCell','notebook/js/textcell');
+    jglobal('RawCell','notebook/js/textcell');
+    jglobal('Cell','notebook/js/cell');
+    jglobal('MainToolBar','notebook/js/maintoolbar');
+    jglobal('NotebookNotificationArea','notebook/js/notificationarea');
+    jglobal('NotebookTour', 'notebook/js/tour');
+    jglobal('MenuBar', 'notebook/js/menubar');
+
+    // tree
+    jglobal('SessionList','tree/js/sessionlist');
+    jglobal('ClusterList','tree/js/clusterlist');
+    jglobal('ClusterItem','tree/js/clusterlist');
+
+    Jupyter.version = "4.0.0.dev";
+    Jupyter._target = '_blank';
+    return Jupyter;
 });
+
+// deprecated since 4.0, remove in 5+
+var IPython = Jupyter

notebook/static/base/js/notificationwidget.js

@@ -2,9 +2,8 @@
 // Distributed under the terms of the Modified BSD License.
 
 define([
-    'base/js/namespace',
     'jquery',
-], function(IPython, $) {
+], function($) {
     "use strict";
 
     /**
@@ -167,8 +166,5 @@ define([
         return this.inner.html();
     };
 
-    // For backwards compatibility.
-    IPython.NotificationWidget = NotificationWidget;
-
     return {'NotificationWidget': NotificationWidget};
 });

notebook/static/base/js/page.js

@@ -2,10 +2,9 @@
 // Distributed under the terms of the Modified BSD License.
 
 define([
-    'base/js/namespace',
     'jquery',
     'base/js/events',
-], function(IPython, $, events){
+], function($, events){
     "use strict";
 
     var Page = function () {
@@ -59,7 +58,5 @@ define([
         $('div#site').height($(window).height() - $('#header').height());
     };
 
-    // Register self in the global namespace for convenience.
-    IPython.Page = Page;
     return {'Page': Page};
 });

notebook/static/base/js/security.js

@@ -2,10 +2,9 @@
 // Distributed under the terms of the Modified BSD License.
 
 define([
-    'base/js/namespace',
     'jquery',
     'components/google-caja/html-css-sanitizer-minified',
-], function(IPython, $) {
+], function($, sanitize) {
     "use strict";
 
     var noop = function (x) { return x; };
@@ -123,7 +122,5 @@ define([
         sanitize_html: sanitize_html
     };
 
-    IPython.security = security;
-
     return security;
 });

notebook/static/base/js/utils.js

@@ -2,17 +2,16 @@
 // Distributed under the terms of the Modified BSD License.
 
 define([
-    'base/js/namespace',
     'jquery',
     'codemirror/lib/codemirror',
     'moment',
     // silently upgrades CodeMirror
     'codemirror/mode/meta',
-], function(IPython, $, CodeMirror, moment){
+], function($, CodeMirror, moment){
     "use strict";
 
     var load_extensions = function () {
-        // load one or more IPython notebook extensions with requirejs
+        // load one or more Jupyter notebook extensions with requirejs
 
         var extensions = [];
         var extension_names = arguments;
@@ -39,8 +38,6 @@ define([
         );
     };
 
-    IPython.load_extensions = load_extensions;
-
     /**
      * Wait for a config section to load, and then load the extensions specified
      * in a 'load_extensions' key inside it.
@@ -505,7 +502,7 @@ define([
 
     var from_absolute_cursor_pos = function (cm, cursor_pos) {
         /**
-         * turn absolute cursor postion into CodeMirror col, ch cursor
+         * turn absolute cursor position into CodeMirror col, ch cursor
          */
         var i, line, next_line;
         var offset = 0;
@@ -881,8 +878,5 @@ define([
         time: time,
     };
 
-    // Backwards compatability.
-    IPython.utils = utils;
-
     return utils;
 }); 

notebook/static/edit/js/savewidget.js

@@ -2,13 +2,12 @@
 // Distributed under the terms of the Modified BSD License.
 
 define([
-    'base/js/namespace',
     'jquery',
     'base/js/utils',
     'base/js/dialog',
     'base/js/keyboard',
     'moment',
-], function(IPython, $, utils, dialog, keyboard, moment) {
+], function($, utils, dialog, keyboard, moment) {
     "use strict";
 
     var SaveWidget = function (selector, options) {

notebook/static/notebook/js/about.js

@@ -9,7 +9,7 @@ require([
     'use strict';
     $('#notebook_about').click(function () {
         // use underscore template to auto html escape
-        var text = 'You are using IPython notebook.<br/><br/>';
+        var text = 'You are using Jupyter notebook.<br/><br/>';
         text = text + 'The version of the notebook server is ';
         text = text + _.template('<b><%- version %></b>')({ version: sys_info.ipython_version });
         if (sys_info.commit_hash) {
@@ -23,7 +23,7 @@ require([
         body.append($('<h4/>').text('Current Kernel Information:'));
         body.append(kinfo);
         dialog.modal({
-            title: 'About IPython Notebook',
+            title: 'About Jupyter Notebook',
             body: body,
             buttons: { 'OK': {} }
         });