bootbox-rails 0.0.1 → 0.1.0

data/README.md

@@ -1,4 +1,4 @@
-# bootbox-rails
+# bootbox-rails [![Build Status](https://secure.travis-ci.org/tanraya/bootbox-rails.png)](http://travis-ci.org/tanraya/bootbox-rails)
 
 Wrappers for JavaScript alert(), confirm() and other flexible dialogs using Twitter's bootstrap framework for Rails 3.1+
 
@@ -44,24 +44,4 @@ Please see http://paynedigital.com/bootbox for full usage instructions, or head
 
 ## License
 
-(The MIT License)
-
-Copyright (C) 2011-2012 by http://rocketscience.it <demerest@gmail.com> 
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE
+[The MIT License](https://github.com/tanraya/bootbox-rails/blob/master/MIT-LICENSE)

data/Rakefile

@@ -12,16 +12,8 @@ rescue LoadError
   RDoc::Task = Rake::RDocTask
 end
 
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'BootboxRails'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-
-
+# Run tests by default
+task :default => :spec
 
 Bundler::GemHelper.install_tasks
 

data/vendor/assets/javascripts/bootbox.js

@@ -1,84 +1,26 @@
 /**
- * bootbox.js v2.4.2
+ * bootbox.js v3.2.0
  *
  * http://bootboxjs.com/license.txt
  */
-var bootbox = window.bootbox || (function($) {
+var bootbox = window.bootbox || (function(document, $) {
+    /*jshint scripturl:true sub:true */
 
     var _locale        = 'en',
         _defaultLocale = 'en',
         _animate       = true,
         _backdrop      = 'static',
+        _defaultHref   = 'javascript:;',
+        _classes       = '',
+        _btnClasses    = {},
         _icons         = {},
         /* last var should always be the public object we'll return */
         that           = {};
 
+
     /**
-     * standard locales. Please add more according to ISO 639-1 standard. Multiple language variants are
-     * unlikely to be required. If this gets too large it can be split out into separate JS files.
+     * public API
      */
-    var _locales = {
-        'en' : {
-            OK      : 'OK',
-            CANCEL  : 'Cancel',
-            CONFIRM : 'OK'
-        },
-        'fr' : {
-            OK      : 'OK',
-            CANCEL  : 'Annuler',
-            CONFIRM : 'D\'accord'
-        },
-        'de' : {
-            OK      : 'OK',
-            CANCEL  : 'Abbrechen',
-            CONFIRM : 'Akzeptieren'
-        },
-        'es' : {
-            OK      : 'OK',
-            CANCEL  : 'Cancelar',
-            CONFIRM : 'Aceptar'
-        },
-        'br' : {
-            OK      : 'OK',
-            CANCEL  : 'Cancelar',
-            CONFIRM : 'Sim'
-        },
-        'nl' : {
-            OK      : 'OK',
-            CANCEL  : 'Annuleren',
-            CONFIRM : 'Accepteren'
-        },
-        'ru' : {
-            OK      : 'OK',
-            CANCEL  : 'Отмена',
-            CONFIRM : 'Применить'
-        },
-        'it' : {
-            OK      : 'OK',
-            CANCEL  : 'Annulla',
-            CONFIRM : 'Conferma'
-        }
-    };
-
-    function _translate(str, locale) {
-        // we assume if no target locale is probided then we should take it from current setting
-        if (locale == null) {
-            locale = _locale;
-        }
-        if (typeof _locales[locale][str] == 'string') {
-            return _locales[locale][str];
-        }
-
-        // if we couldn't find a lookup then try and fallback to a default translation
-
-        if (locale != _defaultLocale) {
-            return _translate(str, _defaultLocale);
-        }
-
-        // if we can't do anything then bail out with whatever string was passed in - last resort
-        return str;
-    }
-
     that.setLocale = function(locale) {
         for (var i in _locales) {
             if (i == locale) {
@@ -87,23 +29,30 @@ var bootbox = window.bootbox || (function($) {
             }
         }
         throw new Error('Invalid locale: '+locale);
-    }
+    };
 
     that.addLocale = function(locale, translations) {
-        if (typeof _locales[locale] == 'undefined') {
+        if (typeof _locales[locale] === 'undefined') {
             _locales[locale] = {};
         }
         for (var str in translations) {
             _locales[locale][str] = translations[str];
         }
-    }
+    };
 
     that.setIcons = function(icons) {
         _icons = icons;
-        if (typeof _icons !== 'object' || _icons == null) {
+        if (typeof _icons !== 'object' || _icons === null) {
             _icons = {};
         }
-    }
+    };
+
+    that.setBtnClasses = function(btnClasses) {
+        _btnClasses = btnClasses;
+        if (typeof _btnClasses !== 'object' || _btnClasses === null) {
+            _btnClasses = {};
+        }
+    };
 
     that.alert = function(/*str, label, cb*/) {
         var str   = "",
@@ -132,17 +81,20 @@ var bootbox = window.bootbox || (function($) {
                 break;
             default:
                 throw new Error("Incorrect number of arguments: expected 1-3");
-                break;
         }
 
         return that.dialog(str, {
-            "label": label,
-            "icon" : _icons.OK,
+            // only button (ok)
+            "label"   : label,
+            "icon"    : _icons.OK,
+            "class"   : _btnClasses.OK,
             "callback": cb
         }, {
-            "onEscape": cb
+            // ensure that the escape key works; either invoking the user's
+            // callback or true to just close the dialog
+            "onEscape": cb || true
         });
-    }
+    };
 
     that.confirm = function(/*str, labelCancel, labelOk, cb*/) {
         var str         = "",
@@ -179,27 +131,37 @@ var bootbox = window.bootbox || (function($) {
                 break;
             default:
                 throw new Error("Incorrect number of arguments: expected 1-4");
-                break;
         }
 
-        return that.dialog(str, [{
-            "label": labelCancel,
-            "icon" : _icons.CANCEL,
-            "callback": function() {
-                if (typeof cb == 'function') {
-                    cb(false);
-                }
+        var cancelCallback = function() {
+            if (typeof cb === 'function') {
+                return cb(false);
             }
-        }, {
-            "label": labelOk,
-            "icon" : _icons.CONFIRM,
-            "callback": function() {
-                if (typeof cb == 'function') {
-                    cb(true);
-                }
+        };
+
+        var confirmCallback = function() {
+            if (typeof cb === 'function') {
+                return cb(true);
             }
-        }]);
-    }
+        };
+
+        return that.dialog(str, [{
+            // first button (cancel)
+            "label"   : labelCancel,
+            "icon"    : _icons.CANCEL,
+            "class"   : _btnClasses.CANCEL,
+            "callback": cancelCallback
+        }, {
+            // second button (confirm)
+            "label"   : labelOk,
+            "icon"    : _icons.CONFIRM,
+            "class"   : _btnClasses.CONFIRM,
+            "callback": confirmCallback
+        }], {
+            // escape key bindings
+            "onEscape": cancelCallback
+        });
+    };
 
     that.prompt = function(/*str, labelCancel, labelOk, cb, defaultVal*/) {
         var str         = "",
@@ -244,7 +206,6 @@ var bootbox = window.bootbox || (function($) {
                 break;
             default:
                 throw new Error("Incorrect number of arguments: expected 1-5");
-                break;
         }
 
         var header = str;
@@ -253,28 +214,45 @@ var bootbox = window.bootbox || (function($) {
         var form = $("<form></form>");
         form.append("<input autocomplete=off type=text value='" + defaultVal + "' />");
 
-        var div = that.dialog(form, [{
-            "label": labelCancel,
-            "icon" : _icons.CANCEL,
-            "callback": function() {
-                if (typeof cb == 'function') {
-                    cb(null);
-                }
+        var cancelCallback = function() {
+            if (typeof cb === 'function') {
+                // yep, native prompts dismiss with null, whereas native
+                // confirms dismiss with false...
+                return cb(null);
             }
-        }, {
-            "label": labelOk,
-            "icon" : _icons.CONFIRM,
-            "callback": function() {
-                if (typeof cb == 'function') {
-                    cb(
-                        form.find("input[type=text]").val()
-                    );
-                }
+        };
+
+        var confirmCallback = function() {
+            if (typeof cb === 'function') {
+                return cb(form.find("input[type=text]").val());
             }
+        };
+
+        var div = that.dialog(form, [{
+            // first button (cancel)
+            "label"   : labelCancel,
+            "icon"    : _icons.CANCEL,
+            "class"   : _btnClasses.CANCEL,
+            "callback":  cancelCallback
+        }, {
+            // second button (confirm)
+            "label"   : labelOk,
+            "icon"    : _icons.CONFIRM,
+            "class"   : _btnClasses.CONFIRM,
+            "callback": confirmCallback
         }], {
-            "header": header
+            // prompts need a few extra options
+            "header"  : header,
+            // explicitly tell dialog NOT to show the dialog...
+            "show"    : false,
+            "onEscape": cancelCallback
         });
 
+        // ... the reason the prompt needs to be hidden is because we need
+        // to bind our own "shown" handler, after creating the modal but
+        // before any show(n) events are triggered
+        // @see https://github.com/makeusabrew/bootbox/issues/69
+
         div.on("shown", function() {
             form.find("input[type=text]").focus();
 
@@ -286,61 +264,21 @@ var bootbox = window.bootbox || (function($) {
             });
         });
 
-        return div;
-    }
-
-    that.modal = function(/*str, label, options*/) {
-        var str;
-        var label;
-        var options;
-
-        var defaultOptions = {
-            "onEscape": null,
-            "keyboard": true,
-            "backdrop": _backdrop
-        };
+        div.modal("show");
 
-        switch (arguments.length) {
-            case 1:
-                str = arguments[0];
-                break;
-            case 2:
-                str = arguments[0];
-                if (typeof arguments[1] == 'object') {
-                    options = arguments[1];
-                } else {
-                    label = arguments[1];
-                }
-                break;
-            case 3:
-                str     = arguments[0];
-                label   = arguments[1];
-                options = arguments[2];
-                break;
-            default:
-                throw new Error("Incorrect number of arguments: expected 1-3");
-                break;
-        }
+        return div;
+    };
 
-        defaultOptions['header'] = label;
+    that.dialog = function(str, handlers, options) {
+        var buttons    = "",
+            callbacks  = [];
 
-        if (typeof options == 'object') {
-            options = $.extend(defaultOptions, options);
-        } else {
-            options = defaultOptions;
+        if (!options) {
+            options = {};
         }
 
-        return that.dialog(str, [], options);
-    }
-
-    that.dialog = function(str, handlers, options) {
-        var hideSource = null,
-            buttons    = "",
-            callbacks  = [],
-            options    = options || {};
-
         // check for single object and convert to array if necessary
-        if (handlers == null) {
+        if (typeof handlers === 'undefined') {
             handlers = [];
         } else if (typeof handlers.length == 'undefined') {
             handlers = [handlers];
@@ -349,6 +287,7 @@ var bootbox = window.bootbox || (function($) {
         var i = handlers.length;
         while (i--) {
             var label    = null,
+                href     = null,
                 _class   = null,
                 icon     = '',
                 callback = null;
@@ -398,7 +337,14 @@ var bootbox = window.bootbox || (function($) {
                 icon = "<i class='"+handlers[i]['icon']+"'></i> ";
             }
 
-            buttons += "<a data-handler='"+i+"' class='btn "+_class+"' href='javascript:;'>"+icon+""+label+"</a>";
+            if (handlers[i]['href']) {
+                href = handlers[i]['href'];
+            }
+            else {
+                href = _defaultHref;
+            }
+
+            buttons = "<a data-handler='"+i+"' class='btn "+_class+"' href='" + href + "'>"+icon+""+label+"</a>" + buttons;
 
             callbacks[i] = callback;
         }
@@ -406,13 +352,15 @@ var bootbox = window.bootbox || (function($) {
         // @see https://github.com/makeusabrew/bootbox/issues/46#issuecomment-8235302
         // and https://github.com/twitter/bootstrap/issues/4474
         // for an explanation of the inline overflow: hidden
+        // @see https://github.com/twitter/bootstrap/issues/4854
+        // for an explanation of tabIndex=-1
 
-        var parts = ["<div class='bootbox modal' style='overflow:hidden;'>"];
+        var parts = ["<div class='bootbox modal' tabindex='-1' style='overflow:hidden;'>"];
 
         if (options['header']) {
             var closeButton = '';
             if (typeof options['headerCloseButton'] == 'undefined' || options['headerCloseButton']) {
-                closeButton = "<a href='javascript:;' class='close'>&times;</a>";
+                closeButton = "<a href='"+_defaultHref+"' class='close'>&times;</a>";
             }
 
             parts.push("<div class='modal-header'>"+closeButton+"<h3>"+options['header']+"</h3></div>");
@@ -422,7 +370,7 @@ var bootbox = window.bootbox || (function($) {
         parts.push("<div class='modal-body'></div>");
 
         if (buttons) {
-            parts.push("<div class='modal-footer'>"+buttons+"</div>")
+            parts.push("<div class='modal-footer'>"+buttons+"</div>");
         }
 
         parts.push("</div>");
@@ -436,73 +384,258 @@ var bootbox = window.bootbox || (function($) {
             div.addClass("fade");
         }
 
-        // now we've built up the div properly we can inject the content whether it was a string or a jQuery object
-        $(".modal-body", div).html(str);
+        var optionalClasses = (typeof options.classes === 'undefined') ? _classes : options.classes;
+        if (optionalClasses) {
+            div.addClass(optionalClasses);
+        }
 
-        div.bind('hidden', function() {
-            div.remove();
-        });
+        // now we've built up the div properly we can inject the content whether it was a string or a jQuery object
+        div.find(".modal-body").html(str);
+
+        function onCancel(source) {
+            // for now source is unused, but it will be in future
+            var hideModal = null;
+            if (typeof options.onEscape === 'function') {
+                // @see https://github.com/makeusabrew/bootbox/issues/91
+                hideModal = options.onEscape();
+            }
 
-        div.bind('hide', function() {
-            if (hideSource == 'escape' &&
-                typeof options.onEscape == 'function') {
-                options.onEscape();
+            if (hideModal !== false) {
+                div.modal('hide');
             }
-        });
+        }
 
         // hook into the modal's keyup trigger to check for the escape key
-        $(document).bind('keyup.modal', function ( e ) {
-            if (e.which == 27) {
-                hideSource = 'escape';
+        div.on('keyup.dismiss.modal', function(e) {
+            // any truthy value passed to onEscape will dismiss the dialog
+            // as long as the onEscape function (if defined) doesn't prevent it
+            if (e.which === 27 && options.onEscape) {
+                onCancel('escape');
             }
         });
 
-        // well, *if* we have a primary - give the last dom element (first displayed) focus
-        div.bind('shown', function() {
-            $("a.btn-primary:last", div).focus();
+        // handle close buttons too
+        div.on('click', 'a.close', function(e) {
+            e.preventDefault();
+            onCancel('close');
+        });
+
+        // well, *if* we have a primary - give the first dom element focus
+        div.on('shown', function() {
+            div.find("a.btn-primary:first").focus();
+        });
+
+        div.on('hidden', function() {
+            div.remove();
         });
 
         // wire up button handlers
-        div.on('click', '.modal-footer a, a.close', function(e) {
+        div.on('click', '.modal-footer a', function(e) {
+
             var handler   = $(this).data("handler"),
                 cb        = callbacks[handler],
                 hideModal = null;
 
-            if (typeof cb == 'function') {
+            // sort of @see https://github.com/makeusabrew/bootbox/pull/68 - heavily adapted
+            // if we've got a custom href attribute, all bets are off
+            if (typeof handler                   !== 'undefined' &&
+                typeof handlers[handler]['href'] !== 'undefined') {
+
+                return;
+            }
+
+            e.preventDefault();
+
+            if (typeof cb === 'function') {
                 hideModal = cb();
             }
-            if (hideModal !== false){
-                e.preventDefault();
-                hideSource = 'button';
+
+            // the only way hideModal *will* be false is if a callback exists and
+            // returns it as a value. in those situations, don't hide the dialog
+            // @see https://github.com/makeusabrew/bootbox/pull/25
+            if (hideModal !== false) {
                 div.modal("hide");
             }
         });
 
-        if (options.keyboard == null) {
-            options.keyboard = (typeof options.onEscape == 'function');
-        }
-
+        // stick the modal right at the bottom of the main body out of the way
         $("body").append(div);
 
         div.modal({
-            "backdrop" : (typeof options.backdrop  === 'undefined') ? _backdrop : options.backdrop,
-            "keyboard" : options.keyboard
+            // unless explicitly overridden take whatever our default backdrop value is
+            backdrop : (typeof options.backdrop  === 'undefined') ? _backdrop : options.backdrop,
+            // ignore bootstrap's keyboard options; we'll handle this ourselves (more fine-grained control)
+            keyboard : false,
+            // @ see https://github.com/makeusabrew/bootbox/issues/69
+            // we *never* want the modal to be shown before we can bind stuff to it
+            // this method can also take a 'show' option, but we'll only use that
+            // later if we need to
+            show     : false
         });
 
+        // @see https://github.com/makeusabrew/bootbox/issues/64
+        // @see https://github.com/makeusabrew/bootbox/issues/60
+        // ...caused by...
+        // @see https://github.com/twitter/bootstrap/issues/4781
+        div.on("show", function(e) {
+            $(document).off("focusin.modal");
+        });
+
+        if (typeof options.show === 'undefined' || options.show === true) {
+            div.modal("show");
+        }
+
         return div;
-    }
+    };
+
+    /**
+     * #modal is deprecated in v3; it can still be used but no guarantees are
+     * made - have never been truly convinced of its merit but perhaps just
+     * needs a tidyup and some TLC
+     */
+    that.modal = function(/*str, label, options*/) {
+        var str;
+        var label;
+        var options;
+
+        var defaultOptions = {
+            "onEscape": null,
+            "keyboard": true,
+            "backdrop": _backdrop
+        };
+
+        switch (arguments.length) {
+            case 1:
+                str = arguments[0];
+                break;
+            case 2:
+                str = arguments[0];
+                if (typeof arguments[1] == 'object') {
+                    options = arguments[1];
+                } else {
+                    label = arguments[1];
+                }
+                break;
+            case 3:
+                str     = arguments[0];
+                label   = arguments[1];
+                options = arguments[2];
+                break;
+            default:
+                throw new Error("Incorrect number of arguments: expected 1-3");
+        }
+
+        defaultOptions['header'] = label;
+
+        if (typeof options == 'object') {
+            options = $.extend(defaultOptions, options);
+        } else {
+            options = defaultOptions;
+        }
+
+        return that.dialog(str, [], options);
+    };
+
 
     that.hideAll = function() {
         $(".bootbox").modal("hide");
-    }
+    };
 
     that.animate = function(animate) {
         _animate = animate;
-    }
+    };
 
     that.backdrop = function(backdrop) {
         _backdrop = backdrop;
+    };
+
+    that.classes = function(classes) {
+        _classes = classes;
+    };
+
+    /**
+     * private API
+     */
+
+    /**
+     * standard locales. Please add more according to ISO 639-1 standard. Multiple language variants are
+     * unlikely to be required. If this gets too large it can be split out into separate JS files.
+     */
+    var _locales = {
+        'br' : {
+            OK      : 'OK',
+            CANCEL  : 'Cancelar',
+            CONFIRM : 'Sim'
+        },
+        'da' : {
+            OK      : 'OK',
+            CANCEL  : 'Annuller',
+            CONFIRM : 'Accepter'
+        },
+        'de' : {
+            OK      : 'OK',
+            CANCEL  : 'Abbrechen',
+            CONFIRM : 'Akzeptieren'
+        },
+        'en' : {
+            OK      : 'OK',
+            CANCEL  : 'Cancel',
+            CONFIRM : 'OK'
+        },
+        'es' : {
+            OK      : 'OK',
+            CANCEL  : 'Cancelar',
+            CONFIRM : 'Aceptar'
+        },
+        'fr' : {
+            OK      : 'OK',
+            CANCEL  : 'Annuler',
+            CONFIRM : 'D\'accord'
+        },
+        'it' : {
+            OK      : 'OK',
+            CANCEL  : 'Annulla',
+            CONFIRM : 'Conferma'
+        },
+        'nl' : {
+            OK      : 'OK',
+            CANCEL  : 'Annuleren',
+            CONFIRM : 'Accepteren'
+        },
+        'pl' : {
+            OK      : 'OK',
+            CANCEL  : 'Anuluj',
+            CONFIRM : 'Potwierdź'
+        },
+        'ru' : {
+            OK      : 'OK',
+            CANCEL  : 'Отмена',
+            CONFIRM : 'Применить'
+        },
+    };
+
+    function _translate(str, locale) {
+        // we assume if no target locale is probided then we should take it from current setting
+        if (typeof locale === 'undefined') {
+            locale = _locale;
+        }
+        if (typeof _locales[locale][str] === 'string') {
+            return _locales[locale][str];
+        }
+
+        // if we couldn't find a lookup then try and fallback to a default translation
+
+        if (locale != _defaultLocale) {
+            return _translate(str, _defaultLocale);
+        }
+
+        // if we can't do anything then bail out with whatever string was passed in - last resort
+        return str;
     }
 
     return that;
-})( window.jQuery );
+
+}(document, window.jQuery));
+
+// @see https://github.com/makeusabrew/bootbox/issues/71
+window.bootbox = bootbox;

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bootbox-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-07 00:00:00.000000000 Z
+date: 2013-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -83,9 +83,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/bootbox-rails/engine.rb
 - lib/bootbox-rails.rb
 - lib/tasks/bootbox-rails_tasks.rake
-- lib/bootbox-rails/engine.rb
 - vendor/assets/javascripts/bootbox.js
 - MIT-LICENSE
 - Rakefile