Fix comments

move humanize-map out of function call to have only one instance

IPython/html/static/notebook/js/quickhelp.js

@@ -1,260 +1,267
 // Copyright (c) IPython Development Team.
 // Distributed under the terms of the Modified BSD License.
 
 define([
     'base/js/namespace',
     'jquery',
     'base/js/utils',
     'base/js/dialog',
 ], function(IPython, $, utils, dialog) {
     "use strict";
     var platform = utils.platform;
 
     var QuickHelp = function (options) {
         /**
          * Constructor
          *
          * Parameters:
          *  options: dictionary
          *      Dictionary of keyword arguments.
          *          events: $(Events) instance
          *          keyboard_manager: KeyboardManager instance
          *          notebook: Notebook instance
          */
         this.keyboard_manager = options.keyboard_manager;
         this.notebook = options.notebook;
         this.keyboard_manager.quick_help = this;
         this.events = options.events;
     };
 
     var cmd_ctrl = 'Ctrl-';
     var platform_specific;
 
     if (platform === 'MacOS') {
         // Mac OS X specific
         cmd_ctrl = 'Cmd-';
         platform_specific = [
             { shortcut: "Cmd-Up",     help:"go to cell start"  },
             { shortcut: "Cmd-Down",   help:"go to cell end"  },
             { shortcut: "Alt-Left",   help:"go one word left"  },
             { shortcut: "Alt-Right",  help:"go one word right"  },
             { shortcut: "Alt-Backspace",      help:"del word before"  },
             { shortcut: "Alt-Delete",         help:"del word after"  },
         ];
     } else {
         // PC specific
         platform_specific = [
             { shortcut: "Ctrl-Home",  help:"go to cell start"  },
             { shortcut: "Ctrl-Up",     help:"go to cell start"  },
             { shortcut: "Ctrl-End",   help:"go to cell end"  },
             { shortcut: "Ctrl-Down",  help:"go to cell end"  },
             { shortcut: "Ctrl-Left",  help:"go one word left"  },
             { shortcut: "Ctrl-Right", help:"go one word right"  },
             { shortcut: "Ctrl-Backspace", help:"del word before"  },
             { shortcut: "Ctrl-Delete",    help:"del word after"  },
         ];
     }
 
     var cm_shortcuts = [
         { shortcut:"Tab",   help:"code completion or indent" },
         { shortcut:"Shift-Tab",   help:"tooltip" },
         { shortcut: cmd_ctrl + "]",   help:"indent"  },
         { shortcut: cmd_ctrl + "[",   help:"dedent"  },
         { shortcut: cmd_ctrl + "a",   help:"select all"  },
         { shortcut: cmd_ctrl + "z",   help:"undo"  },
         { shortcut: cmd_ctrl + "Shift-z",   help:"redo"  },
         { shortcut: cmd_ctrl + "y",   help:"redo"  },
     ].concat( platform_specific );
+    
+    var mac_humanize_map = {
+        // all these are unicode, will probably display badly on anything except macs.
+        // these are the standard symbol that are used in MacOS native menus
+        'cmd':'⌘',
+        'shift':'⇧',
+        'alt':'⌥',
+        'up':'↑',
+        'down':'↓',
+        'left':'←',
+        'right':'→',
+        'eject':'⏏',
+        'tab':'⇥',
+        'capslock':'⇧',
+        'esc':'⎋',
+        'ctrl':'⌃',
+        'enter':'↩',
+        'pageup':'⇞',
+        'pagedown':'⇟',
+        'home':'↖',
+        'end':'↘',
+        'altenter':'⌤',
+        'space':'␣',
+        'backspace':'⇤',
+        'apple':'',
+    };
+
+    var default_humanize_map = {
+        'shift':'Shift',
+        'alt':'Alt',
+        'up':'Up',
+        'down':'Down',
+        'left':'Left',
+        'right':'Right',
+        'tab':'Tab',
+        'capslock':'Caps Lock',
+        'esc':'Esc',
+        'ctrl':'Ctrl',
+        'enter':'Enter',
+        'pageup':'Page Up',
+        'pagedown':'Page Down',
+        'home':'Home',
+        'end':'End',
+        'space':'Space',
+        'backspace,':'Backaspace',
+        };
+    
+    var humanize_map;
+
+    if (platform === 'MacOS'){
+        humanize_map = mac_humanize_map;
+    } else {
+        humanize_map = default_humanize_map;
+    }
 
     function humanize_key(key){
-        if (platform === 'MacOS'){
         if (key.length === 1){
             key = key.toUpperCase();
         }
-        var d= {
-            // all these are unicode, will probably display badly on anything except macs.
-            // these are the standard symbol that are used in MacOS native menus
-            'cmd':'⌘',
-            'shift':'⇧',
-            'alt':'⌥',
-            'up':'↑',
-            'down':'↓',
-            'left':'←',
-            'right':'→',
-            'eject':'⏏',
-            'tab':'⇥',
-            'capslock':'⇧',
-            'esc':'⎋',
-            'ctrl':'⌃',
-            'enter':'↩',
-            'pageup':'⇞',
-            'pagedown':'⇟',
-            'home':'↖',
-            'end':'↘',
-            'altenter':'⌤',
-            'space':'␣',
-            'backspace':'⇤',
-            'apple':'',
-            };
-        } else {
-        var d = {
-            'shift':'Shift',
-            'alt':'Alt',
-            'up':'Up',
-            'down':'Down',
-            'left':'Left',
-            'right':'Right',
-            'tab':'Tab',
-            'capslock':'Caps Lock',
-            'esc':'Esc',
-            'ctrl':'Ctrl',
-            'enter':'Enter',
-            'pageup':'Page Up',
-            'pagedown':'Page Down',
-            'home':'Home',
-            'end':'End',
-            'space':'Space',
-            'backspace,':'Backaspace',
-            };
-        }
-        return d[key.toLowerCase()]||key;
+        return humanize_map[key.toLowerCase()]||key;
     }
 
     function humanize_sequence(sequence){
         var joinchar = ',';
         var hum = _.map(sequence.replace(/meta/g, 'cmd').split(','), humanize_shortcut).join(joinchar);
         return hum;
     }
 
     function humanize_shortcut(shortcut){
         var joinchar = '-';
         if (platform === 'MacOS'){
             joinchar = '';
         }
         var sh = _.map(shortcut.split('-'), humanize_key ).join(joinchar);
         return sh;
     }
 
 
     QuickHelp.prototype.show_keyboard_shortcuts = function () {
         /**
          * toggles display of keyboard shortcut dialog
          */
         var that = this;
         if ( this.force_rebuild ) {
             this.shortcut_dialog.remove();
             delete(this.shortcut_dialog);
             this.force_rebuild = false;
         }
         if ( this.shortcut_dialog ){
             // if dialog is already shown, close it
             $(this.shortcut_dialog).modal("toggle");
             return;
         }
         var command_shortcuts = this.keyboard_manager.command_shortcuts.help();
         var edit_shortcuts = this.keyboard_manager.edit_shortcuts.help();
         var help, shortcut;
         var i, half, n;
         var element = $('<div/>');
 
         // The documentation
         var doc = $('<div/>').addClass('alert alert-warning');
         doc.append(
             $('<button/>').addClass('close').attr('data-dismiss','alert').html('&times;')
         ).append(
             'The IPython Notebook has two different keyboard input modes. <b>Edit mode</b> '+
             'allows you to type code/text into a cell and is indicated by a green cell '+
             'border. <b>Command mode</b> binds the keyboard to notebook level actions '+
             'and is indicated by a grey cell border.'
         );
         element.append(doc);
 
         // Command mode
         var cmd_div = this.build_command_help();
         element.append(cmd_div);
 
         // Edit mode
         var edit_div = this.build_edit_help(cm_shortcuts);
         element.append(edit_div);
 
         this.shortcut_dialog = dialog.modal({
             title : "Keyboard shortcuts",
             body : element,
             destroy : false,
             buttons : {
                 Close : {}
             },
             notebook: this.notebook,
             keyboard_manager: this.keyboard_manager,
         });
         this.shortcut_dialog.addClass("modal_stretch");
         
         this.events.on('rebuild.QuickHelp', function() { that.force_rebuild = true;});
     };
 
     QuickHelp.prototype.build_command_help = function () {
         var command_shortcuts = this.keyboard_manager.command_shortcuts.help();
         return build_div('<h4>Command Mode (press <code>Esc</code> to enable)</h4>', command_shortcuts);
     };
 
     var special_case = { pageup: "PageUp", pagedown: "Page Down", 'minus': '-' };
     var prettify = function (s) {
         s = s.replace(/-$/, 'minus'); // catch shortcuts using '-' key
         var keys = s.split('-');
         var k, i;
         for (i=0; i < keys.length; i++) {
             k = keys[i];
             if ( k.length == 1 ) {
                 keys[i] = "<code><strong>" + k + "</strong></code>";
                 continue; // leave individual keys lower-cased
             }
             if (k.indexOf(',') === -1){
                 keys[i] = ( special_case[k] ? special_case[k] : k.charAt(0).toUpperCase() + k.slice(1) );
             }
             keys[i] = "<code><strong>" + keys[i] + "</strong></code>";
         }
         return keys.join('-');
 
 
     };
 
     QuickHelp.prototype.build_edit_help = function (cm_shortcuts) {
         var edit_shortcuts = this.keyboard_manager.edit_shortcuts.help();
         jQuery.merge(cm_shortcuts, edit_shortcuts);
         return build_div('<h4>Edit Mode (press <code>Enter</code> to enable)</h4>', cm_shortcuts);
     };
 
     var build_one = function (s) {
         var help = s.help;
         var shortcut = '';
         if(s.shortcut){
             shortcut = prettify(humanize_sequence(s.shortcut));
         } else {
             console.error('[debug] -  nothing for', s)
         }
         return $('<div>').addClass('quickhelp').
             append($('<span/>').addClass('shortcut_key').append($(shortcut))).
             append($('<span/>').addClass('shortcut_descr').text(' : ' + help));
 
     };
 
     var build_div = function (title, shortcuts) {
         var i, half, n;
         var div = $('<div/>').append($(title));
         var sub_div = $('<div/>').addClass('hbox');
         var col1 = $('<div/>').addClass('box-flex1');
         var col2 = $('<div/>').addClass('box-flex1');
         n = shortcuts.length;
         half = ~~(n/2);  // Truncate :)
         for (i=0; i<half; i++) { col1.append( build_one(shortcuts[i]) ); }
         for (i=half; i<n; i++) { col2.append( build_one(shortcuts[i]) ); }
         sub_div.append(col1).append(col2);
         div.append(sub_div);
         return div;
     };
 
     // Backwards compatability.
     IPython.QuickHelp = QuickHelp;
 
     return {'QuickHelp': QuickHelp};
 });

IPython/html/static/notebook/js/toolbar.js

@@ -1,161 +1,162
 // Copyright (c) IPython Development Team.
 // Distributed under the terms of the Modified BSD License.
 
 define([
     'base/js/namespace',
-    'jquery',
+    'jquery'
 ], function(IPython, $) {
     "use strict";
 
     /**
      * A generic toolbar on which one can add button
      * @class ToolBar
      * @constructor
      * @param {Dom_object} selector
      */
     var ToolBar = function (selector, options) {
         this.selector = selector;
         this.actions = (options||{}).actions;
         if (this.selector !== undefined) {
             this.element = $(selector);
             this.style();
         }
     };
 
 
    // thought, this might not be the best way as dict might not keep the right order.
    // Might want to put the group name as second to make it optional
    //
    ToolBar.prototype.construct = function (config) {
         for(var k in config){
             this.add_buttons_group(config[k][0],k[1]);
         }
     };
 
     /**
      *  Add a group of button into the current toolbar.
      *
      *  Use a [dict of [list of action name]] to trigger
      *  on click to the button
      *
      *  @example
      *
      *      ... todo, maybe use a list of  list to keep ordering.
      *
      *      [
      *          [
      *            [
      *              action_name_1,
      *              action_name_2,
      *              action_name_3,
      *            ],
      *            optional_group_name
      *          ],
      *          ...
      *      ]
      *
      *  For backward compatibility this also support the
      *  old methods of adding busson directly bound to callbacks:
      *  @example
      *      # deprecate, do not use
      *      IPython.toolbar.add_buttons_group([
      *          {
      *            label:'my button',
      *            icon:'icon-hdd',
      *            callback:function(){alert('hoho')},
      *            id : 'my_button_id',    // this is optional
      *          },
      *          {
      *            label:'my second button',
      *            icon:'icon-play',
      *            callback:function(){alert('be carefull I cut')}
      *          }
      *        ],
      *        "my_button_group_id"
      *      )
      *
      *  @method add_buttons_group
      *  @param list {List}
      *      List of button of the group, with the following paramter for each :
      *      @param list.label {string} text to show on button hover
      *      @param list.icon {string} icon to choose from [Font Awesome](http://fortawesome.github.io/Font-Awesome)
      *      @param list.callback {function} function to be called on button click
      *      @param [list.id] {String} id to give to the button
      *  @param [group_id] {String} optionnal id to give to the group
      *
      *
      *  for private usage, the key can also be strings starting with '<' and ending with '>' to inject custom element that cannot
      *  be bound to an action.
      *
      */
     // TODO JUPYTER:
     // get rid of legacy code that handle things that are not actions.
     ToolBar.prototype.add_buttons_group = function (list, group_id) {
         // handle custom call of pseudoaction binding.
-        if(typeof(list) == 'string' && list.slice(0,1) == '<' && list.slice(-1) == '>'){
+        if(typeof(list) === 'string' && list.slice(0,1) === '<' && list.slice(-1) === '>'){
+            var _pseudo_action;
             try{
-                var _n = list.slice(1,-1)
-                var fun = this[_n]();
+                _pseudo_action = list.slice(1,-1);
+                this[_pseudo_action]();
             } catch (e) {
-                console.warn('ouch, calling ', _n, 'does not seem to work...:')
+                console.warn('ouch, calling ', _pseudo_action, 'does not seem to work...:');
             }
             return ;
         }
         var that = this;
         var btn_group = $('<div/>').addClass("btn-group");
         if( group_id !== undefined ) {
             btn_group.attr('id',group_id);
         }
         var el;
         for(var i=0; i < list.length; i++) {
 
-            // IIFE because Fucking javascript don't have loop scope so
+            // IIFE because javascript don't have loop scope so
             // action_name would otherwise be the same on all iteration
             // of the loop
             // TODO: Indent this thing once reviewed:
             (function(){
             el = list[i];
             var action_name;
             var action;
             if(typeof(el) === 'string'){
                 action = that.actions.get(el);
                 action_name = el;
 
             }
             var button  = $('<button/>')
                 .addClass('btn btn-default')
                 .attr("title", el.label||action.help)
                 .append(
                     $("<i/>").addClass(el.icon||action.icon).addClass('fa')
                 );
             var id = el.id;
             if( id !== undefined )
                 button.attr('id',id);
             var fun = el.callback|| function(){
                 that.actions.call(action_name);
             };
             button.click(fun);
             btn_group.append(button);
             })();
             // END IIFE
         }
         $(this.selector).append(btn_group);
     };
 
     ToolBar.prototype.style = function () {
         this.element.addClass('toolbar');
     };
 
     /**
      * Show and hide toolbar
      * @method toggle
      */
     ToolBar.prototype.toggle = function () {
         this.element.toggle();
     };
 
     // Backwards compatibility.
     IPython.ToolBar = ToolBar;
 
     return {'ToolBar': ToolBar};
 });

IPython/html/tests/notebook/execute_code.js

@@ -1,78 +1,79
 //
 // Test code cell execution.
 //
 casper.notebook_test(function () {
     this.evaluate(function () {
         var cell = IPython.notebook.get_cell(0);
         cell.set_text('a=10; print(a)');
         cell.execute();
     });
 
     this.wait_for_output(0);
 
     // refactor this into  just a get_output(0)
     this.then(function () {
         var result = this.get_output_cell(0);
         this.test.assertEquals(result.text, '10\n', 'cell execute (using js)');
     });
 
 
     // do it again with the keyboard shortcut
     this.thenEvaluate(function () {
         var cell = IPython.notebook.get_cell(0);
         cell.set_text('a=11; print(a)');
         cell.clear_output();
     });
 
     this.then(function(){
         
         this.trigger_keydown('shift-enter');
     });
 
     this.wait_for_output(0);
 
     this.then(function () {
         var result = this.get_output_cell(0);
         var num_cells = this.get_cells_length();
         this.test.assertEquals(result.text, '11\n', 'cell execute (using ctrl-enter)');
         this.test.assertEquals(num_cells, 2, 'shift-enter adds a new cell at the bottom')
     });
     
     // do it again with the keyboard shortcut
     this.thenEvaluate(function () {
         IPython.notebook.select(1);
         IPython.notebook.delete_cell();
         var cell = IPython.notebook.get_cell(0);
         cell.set_text('a=12; print(a)');
         cell.clear_output();
     });
 
     this.then(function(){
         this.trigger_keydown('ctrl-enter');
     });
 
     this.wait_for_output(0);
 
     this.then(function () {
         var result = this.get_output_cell(0);
         var num_cells = this.get_cells_length();
         this.test.assertEquals(result.text, '12\n', 'cell execute (using shift-enter)');
         this.test.assertEquals(num_cells, 1, 'ctrl-enter adds no new cell at the bottom')
     });
 
     // press the "play" triangle button in the toolbar
     this.thenEvaluate(function () {
         var cell = IPython.notebook.get_cell(0);
         IPython.notebook.select(0);
         cell.clear_output();
         cell.set_text('a=13; print(a)');
+        // 'run button' is the first of the forth group in default config.
         $('#maintoolbar  .btn-group:nth(4) .btn:first').click()
     });
     
     this.wait_for_output(0);
 
     this.then(function () {
         var result = this.get_output_cell(0);
         this.test.assertEquals(result.text, '13\n', 'cell execute (using "play" toolbar button)')
     });
 });