From c83fcdd487796e6cdcf32c2cec0c00760085fcf1 Mon Sep 17 00:00:00 2001 From: Damien Cassou Date: Fri, 8 Dec 2023 11:34:49 +0100 Subject: [PATCH] Delete unmaintained docs/ folder --- docs/docco/abstractSegment.html | 78 ---- docs/docco/core.html | 21 - docs/docco/docco.css | 192 -------- docs/docco/events.html | 317 ------------- docs/docco/hashLocation.html | 173 ------- docs/docco/htmlCanvas.html | 507 --------------------- docs/docco/optionalParameterSegment.html | 60 --- docs/docco/parameterSegment.html | 118 ----- docs/docco/route.html | 270 ----------- docs/docco/routeFactory.html | 71 --- docs/docco/routeMatchResult.html | 134 ------ docs/docco/router.html | 552 ----------------------- docs/docco/staticSegment.html | 44 -- docs/docco/url.html | 156 ------- docs/docco/widget-extensions.html | 16 - docs/docco/widget.html | 455 ------------------- 16 files changed, 3164 deletions(-) delete mode 100644 docs/docco/abstractSegment.html delete mode 100644 docs/docco/core.html delete mode 100644 docs/docco/docco.css delete mode 100644 docs/docco/events.html delete mode 100644 docs/docco/hashLocation.html delete mode 100644 docs/docco/htmlCanvas.html delete mode 100644 docs/docco/optionalParameterSegment.html delete mode 100644 docs/docco/parameterSegment.html delete mode 100644 docs/docco/route.html delete mode 100644 docs/docco/routeFactory.html delete mode 100644 docs/docco/routeMatchResult.html delete mode 100644 docs/docco/router.html delete mode 100644 docs/docco/staticSegment.html delete mode 100644 docs/docco/url.html delete mode 100644 docs/docco/widget-extensions.html delete mode 100644 docs/docco/widget.html diff --git a/docs/docco/abstractSegment.html b/docs/docco/abstractSegment.html deleted file mode 100644 index 57027ca9..00000000 --- a/docs/docco/abstractSegment.html +++ /dev/null @@ -1,78 +0,0 @@ - abstractSegment.js

abstractSegment.js 

define([
-  'klassified'
-], function(object) {
-  /**
-   * A segment represents a single part of a route that can be matched
-   * against a URL segment using `match()`.
-   *
-   * @param {{}} spec
-   * @param {string} segmentString
-   * @param {{}} spec.options all route options
-   * @param my
-   * @returns {abstractSegment}
-   */
-  var abstractSegment = object.subclass(function(that, my) {
-
-    my.initialize = function(spec) {
-      my.super(spec);
-      my.segmentString = spec.segmentString;
-      my.options = spec.options || {};
-    };

Public

 
    /**
-     * Answers true if route segment match URL segment
-     *
-     * @param {string} urlSegment
-     * @returns {boolean}
-     */
-    that.match = function(urlSegment) {
-      return false;
-    };
-
-    /**
-     * Value captured for urlSegment
-     *
-     * @param {string} urlSegment
-     * @returns {*}
-     */
-    that.getValue = function(urlSegment) {
-      return my.segmentString;
-    };
-
-    /**
-     * Variable part of the route.
-     *
-     * @returns {boolean}
-     */
-    that.isParameter = function() {
-      return false;
-    };
-
-    /**
-     * Optional segments can be omitted in URLs and the
-     * URL will still match the route if all other non
-     * optional segments match.
-     *
-     * @returns {boolean}
-     */
-    that.isOptional = function() {
-      return false;
-    };
-
-    /**
-     * String representation for segment that can be used eg. when debugging.
-     * @returns {*}
-     */
-    that.toString = function() {
-      return my.segmentString;
-    };
-  });
-
-  abstractSegment.class(function(that) {
-    that.match = function(segmentString) {
-      return false;
-    };
-  });
-
-  return abstractSegment;
-});
-
-
\ No newline at end of file diff --git a/docs/docco/core.html b/docs/docco/core.html deleted file mode 100644 index 4e3eea16..00000000 --- a/docs/docco/core.html +++ /dev/null @@ -1,21 +0,0 @@ - core.js

core.js 

define(
-  [
-    './htmlCanvas',
-    './widget',
-    './widget-extensions',
-    './router',
-    './events'
-  ],
-
-  function (htmlCanvas, widget, ext, router, events) {
-    return {
-      htmlCanvas : htmlCanvas,
-      widget : widget,
-      ext : ext,
-      router : router,
-      events : events
-    };
-  }
-);
-
-
\ No newline at end of file diff --git a/docs/docco/docco.css b/docs/docco/docco.css deleted file mode 100644 index 04cc7ecb..00000000 --- a/docs/docco/docco.css +++ /dev/null @@ -1,192 +0,0 @@ -/*--------------------- Layout and Typography ----------------------------*/ -body { - font-family: 'Palatino Linotype', 'Book Antiqua', Palatino, FreeSerif, serif; - font-size: 15px; - line-height: 22px; - color: #252519; - margin: 0; padding: 0; -} -a { - color: #261a3b; -} - a:visited { - color: #261a3b; - } -p { - margin: 0 0 15px 0; -} -h1, h2, h3, h4, h5, h6 { - margin: 0px 0 15px 0; -} - h1 { - margin-top: 40px; - } -hr { - border: 0 none; - border-top: 1px solid #e5e5ee; - height: 1px; - margin: 20px 0; -} -#container { - position: relative; -} -#background { - position: fixed; - top: 0; left: 525px; right: 0; bottom: 0; - background: #f5f5ff; - border-left: 1px solid #e5e5ee; - z-index: -1; -} -#jump_to, #jump_page { - background: white; - -webkit-box-shadow: 0 0 25px #777; -moz-box-shadow: 0 0 25px #777; - -webkit-border-bottom-left-radius: 5px; -moz-border-radius-bottomleft: 5px; - font: 10px Arial; - text-transform: uppercase; - cursor: pointer; - text-align: right; -} -#jump_to, #jump_wrapper { - position: fixed; - right: 0; top: 0; - padding: 5px 10px; -} - #jump_wrapper { - padding: 0; - display: none; - } - #jump_to:hover #jump_wrapper { - display: block; - } - #jump_page { - padding: 5px 0 3px; - margin: 0 0 25px 25px; - } - #jump_page .source { - display: block; - padding: 5px 10px; - text-decoration: none; - border-top: 1px solid #eee; - } - #jump_page .source:hover { - background: #f5f5ff; - } - #jump_page .source:first-child { - } -table td { - border: 0; - outline: 0; -} - td.docs, th.docs { - max-width: 450px; - min-width: 450px; - min-height: 5px; - padding: 10px 25px 1px 50px; - overflow-x: hidden; - vertical-align: top; - text-align: left; - } - .docs pre { - margin: 15px 0 15px; - padding-left: 15px; - } - .docs p tt, .docs p code { - background: #f8f8ff; - border: 1px solid #dedede; - font-size: 12px; - padding: 0 0.2em; - } - .pilwrap { - position: relative; - } - .pilcrow { - font: 12px Arial; - text-decoration: none; - color: #454545; - position: absolute; - top: 3px; left: -20px; - padding: 1px 2px; - opacity: 0; - -webkit-transition: opacity 0.2s linear; - } - td.docs:hover .pilcrow { - opacity: 1; - } - td.code, th.code { - padding: 14px 15px 16px 25px; - width: 100%; - vertical-align: top; - background: #f5f5ff; - border-left: 1px solid #e5e5ee; - } - pre, tt, code { - font-size: 12px; line-height: 18px; - font-family: Menlo, Monaco, Consolas, "Lucida Console", monospace; - margin: 0; padding: 0; - } - - -/*---------------------- Syntax Highlighting -----------------------------*/ -td.linenos { background-color: #f0f0f0; padding-right: 10px; } -span.lineno { background-color: #f0f0f0; padding: 0 5px 0 5px; } -body .hll { background-color: #ffffcc } -body .c { color: #408080; font-style: italic } /* Comment */ -body .err { border: 1px solid #FF0000 } /* Error */ -body .k { color: #954121 } /* Keyword */ -body .o { color: #666666 } /* Operator */ -body .cm { color: #408080; font-style: italic } /* Comment.Multiline */ -body .cp { color: #BC7A00 } /* Comment.Preproc */ -body .c1 { color: #408080; font-style: italic } /* Comment.Single */ -body .cs { color: #408080; font-style: italic } /* Comment.Special */ -body .gd { color: #A00000 } /* Generic.Deleted */ -body .ge { font-style: italic } /* Generic.Emph */ -body .gr { color: #FF0000 } /* Generic.Error */ -body .gh { color: #000080; font-weight: bold } /* Generic.Heading */ -body .gi { color: #00A000 } /* Generic.Inserted */ -body .go { color: #808080 } /* Generic.Output */ -body .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ -body .gs { font-weight: bold } /* Generic.Strong */ -body .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ -body .gt { color: #0040D0 } /* Generic.Traceback */ -body .kc { color: #954121 } /* Keyword.Constant */ -body .kd { color: #954121; font-weight: bold } /* Keyword.Declaration */ -body .kn { color: #954121; font-weight: bold } /* Keyword.Namespace */ -body .kp { color: #954121 } /* Keyword.Pseudo */ -body .kr { color: #954121; font-weight: bold } /* Keyword.Reserved */ -body .kt { color: #B00040 } /* Keyword.Type */ -body .m { color: #666666 } /* Literal.Number */ -body .s { color: #219161 } /* Literal.String */ -body .na { color: #7D9029 } /* Name.Attribute */ -body .nb { color: #954121 } /* Name.Builtin */ -body .nc { color: #0000FF; font-weight: bold } /* Name.Class */ -body .no { color: #880000 } /* Name.Constant */ -body .nd { color: #AA22FF } /* Name.Decorator */ -body .ni { color: #999999; font-weight: bold } /* Name.Entity */ -body .ne { color: #D2413A; font-weight: bold } /* Name.Exception */ -body .nf { color: #0000FF } /* Name.Function */ -body .nl { color: #A0A000 } /* Name.Label */ -body .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ -body .nt { color: #954121; font-weight: bold } /* Name.Tag */ -body .nv { color: #19469D } /* Name.Variable */ -body .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ -body .w { color: #bbbbbb } /* Text.Whitespace */ -body .mf { color: #666666 } /* Literal.Number.Float */ -body .mh { color: #666666 } /* Literal.Number.Hex */ -body .mi { color: #666666 } /* Literal.Number.Integer */ -body .mo { color: #666666 } /* Literal.Number.Oct */ -body .sb { color: #219161 } /* Literal.String.Backtick */ -body .sc { color: #219161 } /* Literal.String.Char */ -body .sd { color: #219161; font-style: italic } /* Literal.String.Doc */ -body .s2 { color: #219161 } /* Literal.String.Double */ -body .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */ -body .sh { color: #219161 } /* Literal.String.Heredoc */ -body .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */ -body .sx { color: #954121 } /* Literal.String.Other */ -body .sr { color: #BB6688 } /* Literal.String.Regex */ -body .s1 { color: #219161 } /* Literal.String.Single */ -body .ss { color: #19469D } /* Literal.String.Symbol */ -body .bp { color: #954121 } /* Name.Builtin.Pseudo */ -body .vc { color: #19469D } /* Name.Variable.Class */ -body .vg { color: #19469D } /* Name.Variable.Global */ -body .vi { color: #19469D } /* Name.Variable.Instance */ -body .il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/docs/docco/events.html b/docs/docco/events.html deleted file mode 100644 index 8c35ea78..00000000 --- a/docs/docco/events.html +++ /dev/null @@ -1,317 +0,0 @@ - events.js

events.js 

define([],
-    function () {
-
-        /**
-         * Keeps a list of bindings/callbacks that can be added using **push()** and
-         * removed using **remove()**. *trigger()* executes all callbacks one by one in registration order.
-         *
-         * @param [spec] {Object}
-         * @param [my] {Object}
-         * @returns {event}
-         */
-        var event = function (spec, my) {
-            my = my || {};
-
-            var that = function(callback) {
-                return bindCallback(callback);
-            };
-
-            var bindings = [];

Public API

 
            /**
-             * Binds callback to event. The callback will be invoked whenever the event is fired.
-             *
-             * @param callback {function}
-             * @returns {eventBinding}
-             */
-            that.on = function(callback) {
-                return bindCallback(callback);
-            };
-
-            /**
-             * Like on() except callback will only be fired once
-             *
-             * @param callback {function}
-             * @returns {eventBinding}
-             */
-            that.onceOn = function(callback) {
-                var onceBinding = eventBinding({
-                    callback: function () {
-                        my.remove(onceBinding);
-                        callback.apply(that, arguments);
-                    }
-                });
-
-                bindings.push(onceBinding);
-                return onceBinding;
-            };
-
-            /**
-             * Removed 'binding' attached to event.
-             * @param name {String} Name of event
-             * @param binding {eventBinding} Binding
-             */
-            that.off = function (binding) {
-                my.remove(binding);
-            };
-
-            /**
-             * Trigger event by executing all callbacks one by one in registration order.
-             *
-             * @param arguments {Object|Object[]} Arguments passed to callback of each binding
-             */
-            that.trigger = function () {
-                var params = Array.prototype.slice.call(arguments);
-                bindings.forEach(function(binding) {
-                    binding.execute(params);
-                });
-            };
-
-            /**
-             * Unbind all callbacks bound to this event.
-             */
-            that.dispose = function() {
-                bindings.slice().forEach(function(binding) {
-                    binding.unbind();
-                });
-            };
-
-            /**
-             * @param binding {eventBinding}
-             */
-            my.push = function (binding) {
-                bindings.push(binding);
-                binding.bind(that);
-            };
-
-            /**
-             * @param binding {eventBinding}
-             */
-            my.remove = function (binding) {
-                bindings.splice(bindings.indexOf(binding), 1);
-            };
-
-            /**
-             * Create and add callback binding to event
-             *
-             * @param callback
-             * @returns {eventBinding}
-             */
-            function bindCallback(callback) {
-                var binding = eventBinding({ callback: callback, event: that });
-                bindings.push(binding);
-                return binding;
-            }
-
-            return that;
-        };
-
-        /**
-         * Keeps a list of events.
-         *
-         * @returns {{}}
-         */
-        var eventCategory = function () {
-            var that = {};

Map of events with name as key

 
            var namedEvents = {};
-            var events = [];
-
-            /**
-             * Lazily makes sure that an event exists for 'name'.
-             *
-             * @param name {String}
-             * @returns {event} Also return the event
-             */
-            function ensureEventHolderFor(name) {
-                if (!hasEventNamed(name)) {
-                    addEvent(event(), name);
-                }
-                return namedEvents[name];
-            }
-
-            /**
-             * Create a new event and if name i supplied adds it to event manager
-             *
-             * @param [name] {string} Name of event in eventHandler
-             * @returns {event}
-             */
-            that.createEvent = function (name) {
-                return addEvent(event(), name);
-            };
-
-            /**
-             * Binds callback to a named event. The callback will be invoked whenever the event is fired.
-             *
-             * @param name {String}
-             * @param callback {function}
-             */
-            that.on = function (name, callback) {
-                return ensureEventHolderFor(name).on(callback);
-            };
-
-            /**
-             * Removed 'binding' attached to event.
-             * @param name {String} Name of event
-             * @param binding {eventBinding} Binding
-             */
-            that.off = function (name, binding) {
-                return ensureEventHolderFor(name).off(binding);
-            };
-
-            /**
-             * Like on() except callback will only be fired once
-             *
-             * @param name
-             * @param callback
-             * @returns {*}
-             */
-            that.onceOn = function (name, callback) {
-                return ensureEventHolderFor(name).onceOn(callback);
-            };
-
-            /**
-             * Trigger all callbacks attached to event
-             * @param name
-             * @param arguments Any arguments to trigger is sent as arguments to callback.
-             */
-            that.trigger = function (name) {
-                var params = Array.prototype.slice.call(arguments, 1);
-                var event = ensureEventHolderFor(name);
-                event.trigger.apply(that, params);
-            };
-
-            /**
-             * Dispose all events.
-             */
-            that.dispose = function() {
-                events.forEach(function(event) {
-                    event.dispose();
-                });
-
-                namedEvents = {};
-                events = [];
-            };
-
-
-            /**
-             * Answers true if an event with name exists
-             *
-             * @param name {String}
-             * @returns {boolean}
-             */
-            function hasEventNamed(name) {
-                return namedEvents[name] !== undefined;
-            }
-
-            /**
-             * @param event {event}
-             * @param [name] {string}
-             * @returns {event}
-             */
-            function addEvent(event, name) {
-                events.push(event);
-                if(name) {
-                    namedEvents[name] = event;
-                }
-                return event;
-            }
-
-            return that;
-        };
-
-        /**
-         * Binds a callback to an event
-         *
-         * @param spec.callback {function} Callback to execute on event
-         * @param spec.event {event} Event to bind callback to
-
-         * @returns {eventBinding}
-         */
-        var eventBinding = function (spec) {
-            spec = spec || {};
-            var that = {};
-
-            var callback = spec.callback;
-            var event = spec.event;
-
-            /**
-             * Is bound to an event
-             * @returns {boolean}
-             */
-            that.isBound = function() {
-                return event !== undefined;
-            };
-
-            /**
-             * Remove itself from event, if bound.
-             */
-            that.unbind = function () {
-                if (that.isBound()) {
-                    event.off(that);
-                    event = undefined;
-                }
-            };
-
-            /**
-             * @param anEvent
-             */
-            that.bind = function (anEvent) {
-                that.unbind();
-                if (anEvent) {
-                    event = anEvent;
-                }
-            };
-
-            /**
-             * Executes connected callback
-             * @param params
-             */
-            that.execute = function (params) {
-                if (callback) {
-                    callback.apply(that, params);
-                }
-            };
-
-            return that;
-        };
-
-        /**
-         * Singleton object that keeps a list of named event categories.
-         */
-        var eventManager = (function () {
-            var that = {};

Map of event categories with (category) name as key

 
            var categories = {};
-
-            /**
-             * Register a new event category with 'name'.
-             * @param name
-             * @returns {eventCategory}
-             */
-            that.register = function (name) {
-                if (categories[name]) {
-                    throw ('A event category is already registered for ' + name);
-                }
-                categories[name] = eventCategory();
-
-                return categories[name];
-            };
-
-            /**
-             * Returns event category by name. Creates a new category if not already
-             * registered.
-             * @param name
-             * @returns {*}
-             */
-            that.at = function (name) {
-                if (!categories[name]) {
-                    that.register(name);
-                }
-
-                return categories[name];
-            };
-
-            return that;
-        })();

Exports Singleton event manager -but also expose event and event category

 
        eventManager.eventCategory = eventCategory;

@deprecated Spelling mistake

 
        eventManager.eventhandler = eventCategory;
-        eventManager.event = event;
-
-        return eventManager;
-    });
-
-
\ No newline at end of file diff --git a/docs/docco/hashLocation.html b/docs/docco/hashLocation.html deleted file mode 100644 index 9b5528ca..00000000 --- a/docs/docco/hashLocation.html +++ /dev/null @@ -1,173 +0,0 @@ - hashLocation.js

hashLocation.js 

define([
-  'jquery',
-  '../events',
-  './url',
-  'klassified'
-], function(jQuery, events, url, object) {
-
-  /**
-   * In modern browsers we use the 'hashchange' event to listen for location changes. If not supported
-   * we poll for changes using a timer.
-   */
-  var noHashChangeSupport = !('onhashchange' in window);
-
-  /**
-   * Num ms between each location change poll on browsers without 'hashchange'
-   */
-  var pollInterval = 25;
-
-  /**
-   * Manages and listens for changes in the hash fragment of the URL.
-   *
-   * @example
-   *    var location = hash();
-   *    hash.on('changed', function(newUrl) { window.alert(newUrl); });
-   *    location.start();
-   *    location.setUrl('newUrl');
-   *    location.setUrl('anotherUrl');
-   *    location.back();
-   *
-   * @param {{}} [spec]
-   *
-   * @param [my]
-   * @returns {hashLocation}
-   */
-  var hashLocation = object.subclass(function(that, my) {
-
-    var pollTimerId = null;
-
-    my.currentHash = undefined; // last hash fragment
-    my.history = []; // history of visited hash fragments
-        my.events = events.eventCategory();

Public

 
    /**
-     * Triggered when location change with new URL as
-     * argument.
-     *
-     * @type {event}
-     */
-        that.onChanged = my.events.createEvent('changed');
-
-    /**
-     * Set hash fragment to URL
-     *
-     * @param {url|string} aUrl
-     */
-    that.setUrl = function(aUrl) {
-      var aHash = urlToHash(aUrl);
-      setWindowHash(aHash);
-      setCurrentHash(aHash);
-    };
-
-    /**
-     * Creates a URL from current hash fragment
-     *
-     * @returns {url}
-     */
-    that.getUrl = function() {
-      return urlFromHash(getWindowHash());
-    };
-
-    /**
-     * Creates a raw URL string from a URL that can be used eg. in a href.
-     *
-     * @param {string|url} aUrl
-     * @returns {string}
-     */
-    that.linkToUrl = function(aUrl) {
-      return urlToHash(aUrl);
-    };
-
-
-    /**
-     * Navigate back to previous location in history. If history is empty
-     * the location will be changed to fallback URL.
-     *
-     * @param {string|url} fallbackUrl
-     * @returns {string} URL
-     */
-    that.back = function(fallbackUrl) {
-      if (!that.isHistoryEmpty()) {
-        my.history.pop();
-        setWindowHash(my.history.pop());
-      } else if (fallbackUrl) {
-        setWindowHash(urlToHash(fallbackUrl));
-      }
-
-      setCurrentHash();
-    };
-
-    /**
-     * Return `true` if the history is empty.
-     */
-    that.isHistoryEmpty = function() {
-      return my.history.length <= 1;
-    };
-
-    /**
-     * Start listening for URL changes. If `hashchange` is supported by the browser
-     * it will be used, otherwise a timer will poll for changes.
-     */
-    that.start = function() {
-      that.stop();
-
-      my.currentHash = getWindowHash();
-      my.history = [my.currentHash];
-
-      if (noHashChangeSupport) {
-        pollTimerId = setInterval(check, pollInterval);
-      } else {
-        jQuery(window).bind('hashchange', check);
-      }
-    };
-
-    /**
-     * Stop listening for location changes and unregister all bindings.
-     */
-    that.stop = function() {
-      if (pollTimerId) {
-        clearInterval(pollTimerId);
-        pollTimerId = null;
-      }
-      jQuery(window).unbind('hashchange', check);
-    };

Private

 
    function getWindowHash() {
-      return window.location.hash;
-    }
-
-    function setWindowHash(aHash) {
-      window.location.hash = aHash;
-    }
-
-    function urlToHash(aUrl) {
-      if(typeof aUrl === 'string') {
-        aUrl = url({rawUrl: aUrl});
-      }
-      return '#!/' + aUrl.toString();
-    }
-
-    function urlFromHash(aHash) {

Remove hash/hash-bang and any leading /

 
      return url({rawUrl: aHash.replace(/^#!?[\/]?/, '')});
-    }
-
-    function setCurrentHash(newHash) {
-      newHash = newHash || getWindowHash();
-
-      if(my.currentHash !== newHash) {
-        my.currentHash = newHash;
-        my.history.push(my.currentHash);
-      }
-
-      that.onChanged.trigger(urlFromHash(my.currentHash));
-    }
-
-    function check() {
-      var windowHash = getWindowHash();
-
-      var urlChanged = my.currentHash !== windowHash;
-      if (urlChanged) {
-        setCurrentHash(windowHash);
-      }
-    }
-  });
-
-  return hashLocation;
-});
-
-
\ No newline at end of file diff --git a/docs/docco/htmlCanvas.html b/docs/docco/htmlCanvas.html deleted file mode 100644 index d761a0bc..00000000 --- a/docs/docco/htmlCanvas.html +++ /dev/null @@ -1,507 +0,0 @@ - htmlCanvas.js

htmlCanvas.js 

define(
-  [
-    'jquery'
-  ],
-
-  function (jQuery) {
-
-    /**
-     * @typedef {function} renderer
-     * @param {htmlCanvas} html
-     */
-
-    /** @typedef {({}|string|renderer|widget|htmlTagBrush|*)} renderable */

Supported HTML 'tags'

 
    var tags = ('a abbr acronym address area article aside audio b bdi bdo big ' +
-      'blockquote body br button canvas caption cite code col colgroup command ' +
-      'datalist dd del details dfn div dl dt em embed fieldset figcaption figure ' +
-      'footer form frame frameset h1 h2 h3 h4 h5 h6 hr head header hgroup html i ' +
-      'iframe img input ins kbd keygen label legend li link map mark meta meter ' +
-      'nav noscript object ol optgroup option output p param pre progress q rp rt' +
-      'ruby samp script section select small source span strong style sub summary' +
-      'sup table tbody td textarea tfoot th thead time title tr track tt ul var' +
-      'video wbr').split(' ');

Supported HTML events

 
    var attributes = 'href for id media rel src style title type'.split(' ');
-
-    var omitSymbol = {};

Supported HTML attributes

 
    var events = ('blur focus focusin focusout load resize scroll unload ' +
-      'click dblclick mousedown mouseup mousemove mouseover ' +
-      'mouseout mouseenter mouseleave change select submit ' +
-      'keydown keypress keyup error dragstart dragenter dragover dragleave drop dragend').split(' ');
-
-    /**
-     * htmlCanvas provides a DSL that we use to add elements to the DOM using a HTML looking syntax.
-     *
-     * The basic metaphor used is one of painting on a canvas using brushes. The canvas is the
-     * DOM and the brushes HTML 'tags'. Note that it have nothing to do with the HTML5 canvas tag
-     *
-     * @example
-     *    // A htmlCanvas is created on a jQuery object:
-     *    var html = htmlCanvas($('BODY'));
-     *
-     *    // We write HTML using standard tags:
-     *    html.h1('Hello World!');
-     *
-     *    // and standard attributes:
-     *    html.a({ id: 'id', href: 'http://www.google.se'}, 'Google');
-     *
-     *    // Callbacks can be attached to events:
-     *    html.a({click: function() { alert('Hello World!')} 'Click me!');
-     *
-     *    // Tags can be nested:
-     *    html.div({'class' : 'outer_div'},
-     *      html.div({'class' : 'inner_div'},
-     *        html.span('Some text')
-     *      )
-     *    );
-     *
-     *    // Parts can be assigned to variables:
-     *    var homeButton = html.a('Home').href('/');
-     *    if(showAlert) {
-     *      homeButton.click(function() { alert('Hello'); });
-     *    }
-     *
-     *
-     * @param {string|jQuery|htmlTagBrush} [rootElement] Element to  "paint" on. If not supplied a document fragment will be created
-     *
-     * @returns {htmlCanvas}
-     */
-    function htmlCanvas(rootElement) {
-
-      var root = htmlTagBrush({ element: rootElement });
-
-      /** @typedef {{}} htmlCanvas */
-      var that = {};

Public

 
      /**
-       * The root object that brushes will append elements to.
-       *
-       * @type {htmlTagBrush}
-       */
-      that.root = root;
-
-      /**
-       * Creates a brush that "paints" a tag of type tagName. Any children supplied
-       * will be appended as children to brush.
-       *
-       * @param {string} tagName Type of element (supported by document.createElement)
-       * @param {renderable[]} [children] Renderable objects to append as children of brush.
-       */
-      that.tag = function (tagName, children) {
-        var tagBrush = htmlTagBrush({ tag: tagName, children: children });
-        root.appendBrush(tagBrush);
-        return tagBrush;
-      };
-
-      /**
-       * Tags builders for each supported tag type.
-       *
-       * @example
-       *  html.h1('Title');
-       *  html.strong('Important stuff');
-       *  html.span(html.strong(userName), ' signed in.')
-       */
-      tags.forEach(function (tagName) {
-        that[tagName] = function () {
-          var args = Array.prototype.slice.call(arguments);
-          return that.tag(tagName, args);
-        };
-      });
-
-      /**
-       * Returns omit symbol that is used to omit a attribute pair
-       * and omit the object appended to brush.
-       *
-       * @returns {{}}
-       */
-      that.omit = function() {
-        return omitSymbol;
-      };
-
-      /**
-       * Append an object to the root brush
-       *
-       * @param anObject
-       */
-      that.render = function () {
-        var args = Array.prototype.slice.call(arguments);
-        root.render(args);
-      };
-
-      /**
-       * Append an unescaped HTML string to the root brush
-       */
-      that.raw = function(htmlString) {
-        root.raw(htmlString);
-      };
-
-      /**
-       * Append an unescaped string replacing all spaces by
-       * non-breaking spaces
-       */
-      that.renderNonBreaking = function(htmlString) {
-        that.raw(htmlString.replace(/\s/g, "&nbsp;"));
-      };
-
-      return that;
-    }
-
-    /**
-     * A tag brush object represents a DOM element, built on a canvas. The element can
-     * be created from a 'tag' or an element matched using 'jQuery'.
-     *
-     * Note: A brush is usually only created from `htmlCanvas` and it should only
-     * be used once.
-     *
-     * @param {{}} spec
-     * @param {string} [spec.tag] Name of tag to create (using document.createElement)
-     * @param {string|jQuery|widget|htmlTagBrush|*} [spec.element]
-     * @param {renderable[]} [spec.children]
-     *
-     * @returns {htmlTagBrush}
-     */
-    function htmlTagBrush(spec) {
-
-      /** @typedef {{}} htmlTagBrush */
-      var that = {};
-
-      /**
-       * Create a new element from tagName or get it from elements.
-       *
-       * @type {HTMLElement}
-       */
-      var element = spec.tag ? createElement(spec.tag) : getElement(spec.element);
-      if (!element) {
-        throw new Error('htmlTagBrush requires an element');
-      }

Public

 
      /**
-       * DOM element created by brush
-       *
-       * @returns {HTMLElement}
-       */
-      that.element = function () {
-        return element;
-      };
-
-      /**
-       * Appends child objects to brush. Can take a single or several arguments.
-       *
-       * @example
-       *  html.h1().render(
-       *    'hello',
-       *    html.span('world',
-       *      function(html) {
-       *        html.img().src('foo.img');
-       *        }
-       *      )
-       *    );
-       *
-       * @param {renderable[]} arguments Any renderable objects
-       * @returns {htmlTagBrush}
-       */
-      that.render = function () {
-        var args = Array.prototype.slice.call(arguments);
-        for (var i = 0; i < args.length; i++) {
-          append(args[i]);
-        }
-        return that;
-      };
-
-      /**
-       * Implementation for `appendToBrush()` to allow a brush to be
-       * appended to another brush.
-       *
-       * @param {htmlTagBrush} aTagBrush
-       */
-      that.appendToBrush = function (aTagBrush) {
-        aTagBrush.appendBrush(that);
-      };
-
-      /**
-       * Append brush as child.
-       *
-       * @param {htmlTagBrush} aTagBrush
-       */
-      that.appendBrush = appendBrush;
-
-      /**
-       * Set unescaped html contents.
-       *
-       * @param {string} htmlContents
-       */
-      that.html = function (htmlContents) {
-        that.asJQuery().html(htmlContents);
-        return that;
-      };
-
-      /**
-       * Append an unescaped html contents.
-       *
-       * @param {string} htmlContents
-       */
-      that.raw = function (htmlContents) {
-        that.asJQuery().append(htmlContents);
-        return that;
-      };
-
-      /**
-       * Append an unescaped string replacing all spaces by
-       * non-breaking spaces
-       */
-      that.renderNonBreaking = function(htmlString) {
-        that.raw(htmlString.replace(/\s/g, "&nbsp;"));
-      };
-
-      /**
-       * Bind callback to DOM event
-       *
-       * @usage
-       *    html.a('click me').on('click', function() {
-       *      alert('click');
-       *    });
-       *
-       * @param {string} eventType One or more DOM event types, such as "click" or "submit," or custom event names.
-       * @param {function} callback A function to execute each time the event is triggered.
-       * @returns {{}}
-       */
-      that.on = function (eventType, callback) {
-        that.asJQuery().bind(eventType, callback);
-        return that;
-      };
-
-      /**
-       * Event functions for each supported event type.
-       *
-       * @example
-       *  aBrush.click(function() { .. });
-       *  aBrush.blur(function() { .. });
-       */
-      events.forEach(function(eventType) {
-        that[eventType] = function (callback) {
-          return that.on(eventType, callback);
-        };
-      });
-
-      /**
-       * Adds a new attribute or changes the value of an existing attribute on the specified element.
-       * @param key
-       * @param value
-       * @returns {{}}
-       */
-      that.setAttribute = function (key, value) {

Omit attribute if value is omit

 
        if(value === omitSymbol) {
-          return that;
-        }
-
-        element.setAttribute(key, value);
-        return that;
-      };
-
-      /**
-       * Accessors for each supported attribute.
-       *
-       * @example
-       *  aBrush.id('id');
-       *  aBrush.src('javascript:0');
-       *  aBrush.href('#');
-       */
-      attributes.forEach(function(attributeName) {
-        that[attributeName] = function (value) {
-          return that.setAttribute(attributeName, value);
-        };
-      });
-
-      /**
-       * Set element style with key/value or object literal.
-       *
-       * @example
-       *    html.h1().css('display', 'block');
-       *    html.h1().css({'display' : 'block', 'color' : 'red'});
-       *
-       * @param {string|{}} key
-       * @param {string} value
-       * @returns {{}}
-       */
-      that.css = function (key, value) {
-        if (typeof key === "string") {
-          that.asJQuery().css(key, value);
-        }
-        else {
-          that.asJQuery().css(key); // otherwise assume key is a map (object literal)
-        }
-
-        return that;
-      };
-
-      /**
-       * Set attributes using object literal.
-       *
-       * @example
-       *  html.h1().attr({id : 'myid', 'class' : 'myclass'});
-       *
-       * @note
-       *  Use klass or 'class' with quotation marks as key instead of class since its a reserved word.
-       *
-       * @param object
-       * @returns {{}}
-       */
-      that.attr = function(object) {
-        for (var key in object) {
-          if (object.hasOwnProperty(key)) {

Attach functions

 
            if(typeof object[key] === "function") {
-              that.on(key, object[key]);
-            }
-
-            else if (key === 'klass') {
-              that.addClass(object[key]);
-            } else {
-              that.setAttribute(key, object[key]);
-            }
-          }
-        }
-        return that;
-      };
-
-      /**
-       * Appends className to class attribute
-       * @param className
-       * @returns {htmlTagBrush}
-       */
-      that.addClass = function (className) {
-        that.asJQuery().addClass(className);
-        return that;
-      };
-
-      /**
-       * Removes className from class attribute
-       *
-       * @param {string} className
-       * @returns {htmlTagBrush}
-       */
-      that.removeClass = function (className) {
-        that.asJQuery().removeClass(className);
-        return that;
-      };
-
-      /**
-       * Returns jQuery that match element.
-       * @returns {jQuery}
-       */
-      that.asJQuery = function () {
-        return jQuery(that.element());
-      };

Private

 
      /**
-       * Creates a new element from tagName
-       *
-       * @param {string} tagName
-       * @returns {Element}
-       */
-      function createElement(tagName) {
-        return document.createElement(tagName);
-      }
-
-      /**
-       * Appends object as child to brush. A tag brush knows how to append:
-       *
-       * - strings
-       * - functions (that take a htmlCanvas as argument)
-       * - other brushes and widgets (that implements `appendToBrush()`)
-       * - map / object literal with attributes (eg. {id: 'aId', 'class' : 'aClass'})
-       * - array of valid objects (see above)
-       *
-       * all other objects are appended using:
-       * `jQuery(element).append(object);`
-       *
-       * @param {renderable|renderable[]|{}} object
-       */
-      function append(object) {
-        if (typeof(object) === 'undefined' || object === null) {
-          throw new Error('cannot append null or undefined to brush');
-        }

Ignore object if it's a omit symbol

 
        if(object === omitSymbol) {
-          return;
-        }
-
-        if (typeof object === "object" && object.constructor === Array) {
-          for (var i = 0; i < object.length; i++) {
-            append(object[i]);
-          }
-        }
-        else if (typeof object === "string") {
-          appendString(object);
-        } else if (typeof object === "function") {
-          appendFunction(object);
-        } else if (typeof object === "object" &&
-          object.appendToBrush /* eg. widget and tagBrush implement appendToBrush */) {
-          object.appendToBrush(that); // double dispatch
-        }
-        else if (typeof object === "object") {
-          that.attr(object); // assume attributes if none of above
-        } else {
-          jQuery(element).append(object); // default to jquery
-        }
-      }
-
-      /**
-       * Appends DOM node as last child of element or concatenate with
-       * text if element can't have children.
-       *
-       * @param {string|HTMLElement} child
-       */
-      function appendChild(child) {
-        if (element.canHaveChildren !== false) {
-          element.appendChild(child);
-        } else {
-          element.text = element.text + child.innerHTML;
-        }
-      }
-
-      /**
-       * Appends element of brush
-       *
-       * @param {htmlTagBrush} aTagBrush
-       */
-      function appendBrush(aTagBrush) {
-        appendChild(aTagBrush.element());
-      }
-
-      /**
-       * Append text as child. `string` is escaped
-       *
-       * @param {string} string
-       */
-      function appendString(string) {
-        jQuery(element).append(document.createTextNode(string));
-      }
-
-      /**
-       * Append function by executing function with this element as canvas.
-       *
-       * @param {renderer} fn
-       */
-      function appendFunction(fn) {
-        var brushCanvas = htmlCanvas(that);
-        fn(brushCanvas);
-      }
-
-      /**
-       * Element is set to first match if a jQuery was given.
-       *
-       * @param {string|jQuery|HTMLElement|widget|htmlTagBrush} [object]
-       * @returns {HTMLElement}
-       */
-      function getElement(object) {

Create a fragment if no object

 
        if (typeof(object) === 'undefined' || object === null) {
-          return  jQuery(document.createDocumentFragment()).get(0);
-        }

Any object that implements asJQuery eg. widget and tagBrush

 
        if(typeof object === "object" && object.asJQuery) {
-          return object.asJQuery().get(0);
-        }

Fall back on jQuery if a string containing a selector expression, -a DOM Element, an existing jQuery object or any other argument that -jQuery accept (http://api.jquery.com/jQuery/)

 
        return jQuery(object).get(0);
-      }

Init

 
      /**
-       * Append children to support nesting
-       *
-       * @example
-       *    html.ul(html.li(html.a({href: '#'}, 'home'));
-       */
-      if(spec.children) {
-        append(spec.children);
-      }
-
-      return that;
-    }
-
-
-    return htmlCanvas;
-  }
-);
-
-
\ No newline at end of file diff --git a/docs/docco/optionalParameterSegment.html b/docs/docco/optionalParameterSegment.html deleted file mode 100644 index 44f1a93e..00000000 --- a/docs/docco/optionalParameterSegment.html +++ /dev/null @@ -1,60 +0,0 @@ - optionalParameterSegment.js

optionalParameterSegment.js 

define([
-  './parameterSegment'
-], function(parameterSegment) {
-
-  /**
-   * Optional parameters can have a default value.
-   *
-   * @param {{}} spec abstractSegment string
-   * @param my
-   * @returns {parameter}
-   */
-  var optionalParameterSegment = parameterSegment.subclass(function(that, my) {
-
-    my.initialize = function(spec) {
-      my.super(spec);
-      my.defaultValue = my.options.defaults && my.options.defaults[my.name];
-    };

Public

 
    /**
-     * Parameter value or default value if not matched.
-     *
-     * @param {string} urlSegment
-     * @returns {*}
-     */
-    that.getValue = function(urlSegment) {
-      return urlSegment === undefined ?
-        my.defaultValue :
-        urlSegment;
-    };
-
-    /**
-     * Always true.
-     * @returns {boolean}
-     */
-    that.isOptional = function() {
-      return true;
-    };
-
-    /**
-     * String representation for segment that can be used eg. when debugging.
-     * @returns {*}
-     */
-    that.toString = function() {
-      return 'optional(' + that.getName() + ')';
-    };
-  });
-
-  optionalParameterSegment.class(function(that) {
-    /**
-     * Match segment strings with a leading `?`.
-     * @param {string} segmentString
-     * @returns {boolean}
-     */
-    that.match = function(segmentString) {
-      return segmentString.substr(0, 1) === '?';
-    };
-  });
-
-  return optionalParameterSegment;
-});
-
-
\ No newline at end of file diff --git a/docs/docco/parameterSegment.html b/docs/docco/parameterSegment.html deleted file mode 100644 index 5e97b644..00000000 --- a/docs/docco/parameterSegment.html +++ /dev/null @@ -1,118 +0,0 @@ - parameterSegment.js

parameterSegment.js 

define([
-  './abstractSegment'
-], function(abstractSegment) {
-
-  /**
-   * Constructs validator functions from constraints parameters.
-   *
-   * @param {*} constraint
-   * @returns {function} function that take a urlSegment as argument
-   */
-  function parameterValidator(constraint) {

Custom function that take a url segment as argument

 
    if(typeof constraint === 'function') {
-      return constraint;
-    }

Match against RegExp

 
    if(constraint instanceof RegExp) {
-      var exp = new RegExp(constraint);
-      return function(urlSegment) {
-        return exp.test(urlSegment);
-      };
-    }

Match valid options in an array

 
    if(Object.prototype.toString.call(constraint) === '[object Array]') {
-      var options = constraint.map(function(option) {
-        return option.toLowerCase();
-      });
-      return function(urlSegment) {
-        var val = urlSegment.toLowerCase();
-        return options.indexOf(val) !== -1;
-      };
-    }
-  }
-
-  /**
-   * Parameter match URL segments if all constraints are met.
-   *
-   * @param {{}} spec abstractSegment spec
-   * @param [my]
-   * @returns {parameterSegment}
-   */
-  var parameterSegment = abstractSegment.subclass(function(that, my) {
-
-    my.initialize = function(spec) {
-      my.super(spec);
-      my.name = my.segmentString.substr(1); // strip of the leading #
-      my.constraints = (my.options.constraints && my.options.constraints[my.name] &&
-        [my.options.constraints[my.name]]) || [];
-      my.validators = my.constraints.map(parameterValidator).filter(Boolean);
-    };

Public

 
    /**
-     * Name is segmentString without leading property type char.
-     *
-     * @returns {string}
-     */
-    that.getName = function() {
-      return my.name;
-    };
-
-    /**
-     * Value captured for urlSegment
-     *
-     * @param {string} urlSegment
-     * @returns {*}
-     */
-    that.getValue = function(urlSegment) {
-      return urlSegment;
-    };
-
-    /**
-     * Always true
-     *
-     * @returns {boolean}
-     */
-    that.isParameter = function() {
-      return true;
-    };
-
-    /**
-     * Match urSegment if all constraints are met.
-     *
-     * @param {string} urlSegment
-     * @returns {boolean|*}
-     */
-    that.match = function(urlSegment) {
-      return urlSegment !== undefined && that.validate(urlSegment);
-    };
-
-    /**
-     * Answers true if url segment meet all constraints for parameter.
-     *
-     * @param {string} urlSegment
-     * @returns {boolean}
-     */
-    that.validate = function(urlSegment) {
-      return my.validators.every(function(validator) {
-        return validator(urlSegment);
-      });
-    };
-
-    /**
-     * String representation for segment that can be used eg. when debugging.
-     * @returns {*}
-     */
-    that.toString = function() {
-      return 'param(' + that.getName() + ')';
-    };
-  });
-
-  parameterSegment.class(function(that) {
-
-    /**
-     * Match segment strings with a leading `#`.
-     * @param {string} segmentString
-     * @returns {boolean}
-     */
-    that.match = function(segmentString) {
-      return segmentString.substr(0, 1) === '#';
-    };
-  });
-
-  return parameterSegment;
-});
-
-
\ No newline at end of file diff --git a/docs/docco/route.html b/docs/docco/route.html deleted file mode 100644 index 583825fc..00000000 --- a/docs/docco/route.html +++ /dev/null @@ -1,270 +0,0 @@ - route.js

route.js 

define(
-  ['./routeFactory', '../events', './routeMatchResult', 'jquery', './url',
-    'klassified'],
-  function(routeFactory, events, routeMatchResult, jQuery, url, object) {
-
-    /**
-     * Routes represent the path for which an action should be taken (see `matched` event).
-     *
-     * Route is implemented as an array of segments. A route can be constructed from a segment array
-     * or a route pattern string.
-     *
-     * @example
-     *    var aRouteFromSegments = route({segments: arrayOfRouteSegments});
-     *    var aRouteFromPattern = route('/segmentA/#aParameter/?andAnOptionalParameter');
-     *
-     * Route pattern strings are parsed into segment arrays by `routeFactory`.
-     *
-     * Route match URL:s by comparing the URL segments against an array
-     * of route segments. A route match a URL if the segments matches the route segments.
-     *
-     * @example
-     *  route('/User/#id').matchUrl('/User/john').matched(); // => true
-     *
-     * Route would match URL since first segment in URL match Route (both 'User') and second
-     * segment is matched since a route parameter will match all values (if no constraints).
-     *
-     * Some segments can be optional and other mandatory. The strategy to match route with optional
-     * segments is to match it against the segments and then all combinations of optional parameters.
-     *
-     * An array with all optional sequences is calculated when route is created.
-     *
-     * Note: Avoid large number of optionals since it will consume memory and slow down matching.
-     * You can use query parameters instead.
-     *
-     * When a URL is matched the router will bind matches parameters to corresponding segments in URL
-     * and return them in `matchResult`
-     *
-     * @example
-     *
-     *    var result = route('/user/#id').matchUrl('/user/john');
-     *    console.dir(result.getValues()); // => { user: 'john'}
-     *
-     * Routes can also be used as patterns for creating URLs
-     *
-     *    var url = route('/user/#id').expand({id: 'john'});
-     *    console.log(url); // => '/user/john'
-     *
-     *
-     * @param {string|{}} spec Route pattern or route spec
-     * @param {boolean} spec.ignoreTrailingSegments Route will match if all route segment match
-     * even if url have trailing unmatched segments
-     * @param {segment[]} [spec.segments] Array of route segments
-     *
-     * @param {{}} my
-     * @returns {route}
-     */
-    var route = object.subclass(function(that, my) {
-
-      var segments;
-      var ignoreTrailingSegments;
-      var optionalSequences;
-
-      my.initialize = function(spec) {
-        my.super();

Build segments from pattern

 
        segments = routeFactory(spec.pattern, spec.options);

Route match URL if all route segments match -but URL still contain trailing segments (default false)

 
        ignoreTrailingSegments = (spec.options && spec.options.ignoreTrailingSegments) || false;

Array with all optional sequences, ie. all combinations -of optional parameters. Array must be ordered to match URL:s -left to right.

 
        optionalSequences = [];

Pre-calculate optional sequences.

 
        ensureOptionalSequences();
-      };
-
-            my.events = events.eventCategory();

Public

 
      that.onMatched = my.events.createEvent('matched');

@deprecated Use event property instead

 
      that.on = my.events.on;
-
-      /**
-       * Match route against URL by comparing segments. Triggers
-       * `onMatched` event on match.
-       *
-       * @param {url} url
-       * @returns {routeMatchResult}
-       */
-      that.matchUrl = function(url) {
-        var match = findMatch(url);
-        if(!match) {
-          return routeMatchResult.routeNoMatchResult;
-        }
-
-        var result = createMatchResult(match, url);
-                my.events.trigger('matched', result);
-
-        return result;
-      };
-
-      /**
-       * Expands route into a url. All non optional route parameters must exist
-       * in `params`.
-       *
-       * @param {{}} params Key/Values where keys are route parameter names and values the values to use
-       *
-       * @returns {string} URL string
-       */
-      that.expand = function(params) {
-        params = params || {};

Try to expand route into URL

 
        var urlSegments = [];
-        segments.forEach(function(routeSegment) {
-          var urlSegment;
-          if(routeSegment.isParameter()) {

Use supplied value for parameters

 
            urlSegment = params[routeSegment.getName()];
-          } else {

name/value for segments

 
            urlSegment = routeSegment.getValue();
-          }

Skip if no match and optional

 
          if(urlSegment === undefined &&
-            routeSegment.isOptional()) {
-            return;
-          }

Validate segment

 
          if (!routeSegment.match(urlSegment)) {
-            throw new Error('Could not generate a valid URL');
-          }
-
-          urlSegments.push(urlSegment);
-        });
-
-        var query = {};
-
-        Object.keys(params).forEach(function(param) {
-          if(!that.hasParameter(param)) {
-            query[param] = params[param];

Handle array param values

 
            if(query[param] instanceof Array) {
-              query[param] = query[param].join(',');
-            }
-          }
-        });
-
-        return url.build(urlSegments.join('/'), query).toString();
-      };
-
-      /**
-       * Answers true if parameter with `name` exists in route.
-       *
-       * @param {string} name
-       * @returns {boolean}
-       */
-      that.hasParameter = function(name) {
-        return segments.some(function(segment) {
-          return segment.isParameter() && segment.getName() === name;
-        });
-      };
-
-      /**
-       * Returns a string representation of route useful for debugging.
-       *
-       * @returns {string}
-       */
-      that.toString = function() {
-        return 'route(' + segments.join('/') + ')';
-      };

Private

 
      /**
-       * Checks if an array of url segments match a sequence of route segments.
-       *
-       * @param {string[]} urlSegments
-       * @param {segments[]} [sequence] Route segments will be used as default
-       * @returns {boolean}
-       */
-      function isMatch(urlSegments, sequence) {
-        sequence = sequence || segments;

Can not match if different sizes

 
        if(urlSegments.length != sequence.length && !ignoreTrailingSegments) {
-          return false;
-        }

All routeSegments much match corresponding URL segment

 
        return sequence.every(function(routeSegment, index) {
-          var urlSegment = urlSegments[index];
-          return urlSegment !== undefined && routeSegment.match(urlSegment);
-        });
-      }
-
-      /**
-       * Returns first sequence of segments that match url or null if no sequence match.
-       *
-       * @param {url} url
-       * @returns {segment[]}
-       */
-      function findMatch(url) {
-        var urlSegments = url.getSegments();

Try match url segments

 
        if(isMatch(urlSegments)) {
-          return segments;
-        }

then optional sequences

 
                var sequenceIndex;
-        for(sequenceIndex = 0; sequenceIndex < optionalSequences.length; sequenceIndex++) {
-          if(isMatch(urlSegments, optionalSequences[sequenceIndex])) {
-            return optionalSequences[sequenceIndex];
-          }
-        }
-
-        return null;
-      }
-
-      /**
-       * Pre-calculate all optional sequences of segments.
-       */
-      function ensureOptionalSequences () {

Find positions for optionals

 
        var optionalPositions = [];
-        segments.forEach(function(segment, index) {
-          if(segment.isOptional()) {
-            optionalPositions.push(index);
-          }
-        });
-
-        if(optionalPositions.length > 15)  {
-          throw new Error ('Too many optional arguments. "' + optionalPositions.length +
-            '"" optionals would generate  ' + Math.pow(2,optionalPositions.length) +
-            ' optional sequences.');
-        }

Generate possible sequences

 
        var possibleOptionalSequences = orderedSubsets(optionalPositions);
-
-        possibleOptionalSequences.forEach(function(sequence) {

Clone segments array and remove optionals matching -indexes in index sequence

 
          var optionalSequence = segments.slice();
-          sequence.forEach(function(optionalIndex, numRemoved) {

Remove optional but take in to account that we have already -removed {numRemoved} from permutation.

 
            optionalSequence.splice(optionalIndex - numRemoved, 1);
-          });
-
-          optionalSequences.push(optionalSequence);
-        });
-      }
-
-      /**
-       * Create a 'routeMatchResult' from a matched sequence.
-       *
-       * @param {segment[]} match Matched segment sequence
-       * @param {url} url Matched URL
-       *
-       * @returns {routeMatchResult}
-       */
-      function createMatchResult(match, url) {
-        var urlSegments = url.getSegments();
-
-        var parameterValues = {};
-        segments.forEach(function(routeSegment) {
-          if(!routeSegment.isParameter()) {
-            return;
-          }
-
-          var matchedIndex = match.indexOf(routeSegment);
-          if(matchedIndex >= 0) {
-            parameterValues[routeSegment.getName()] = routeSegment.getValue(urlSegments[matchedIndex]);
-          } else {
-            parameterValues[routeSegment.getName()] = routeSegment.getValue();
-          }
-        });
-
-
-        return routeMatchResult({route: that, url: url, values: parameterValues });
-      }
-    });
-
-    /**
-     * Generates all subsets of an array with same internal order. Returned subsets are
-     * ordered in right to left order.
-     *
-     * @example
-     *  orderedSubsets([1,2,3]); // => [[1,2,3],[2,3],[1,3],[3],[1,2],[2],[1]]
-     *
-     * @param {[]} input
-     * @returns {[[]]} Array with all subset arrays
-     */
-    function orderedSubsets(input) {
-      var results = [], result, mask,
-        total = Math.pow(2, input.length);
-
-      for (mask = 1; mask < total; mask++) {
-        result = [];
-        i = input.length - 1;
-        do {
-          if ((mask & (1 << i)) !== 0) {
-            result.unshift(input[i]);
-          }
-        } while (i--);
-        results.unshift(result);
-      }
-
-      return results;
-    }
-
-    return route;
-  }
-);
-
-
\ No newline at end of file diff --git a/docs/docco/routeFactory.html b/docs/docco/routeFactory.html deleted file mode 100644 index 4d0b86ec..00000000 --- a/docs/docco/routeFactory.html +++ /dev/null @@ -1,71 +0,0 @@ - routeFactory.js

routeFactory.js 

define([
-  './parameterSegment',
-  './optionalParameterSegment',
-  './staticSegment',
-  './abstractSegment'
-], function(parameterSegment, optionalParameterSegment, staticSegment, abstractSegment) {
-
-  /**
-   * Token/Char used to separate segments in route patterns.
-   * @type {string}
-   */
-  var routePatternSeparator = '/';
-
-  /**
-   * Creates a route from pattern. A pattern is a string with route segments
-   * separated by `routePatternSeparator`.
-   *
-   * @example
-   *  routeFactory(`/foo/#bar/?baz`);
-   *
-   * @param {string} pattern
-   * @param {{}} options
-   * @returns {abstractSegment[]}
-   */
-  function routeFactory(pattern, options) {
-    if(!pattern) {
-      return [];
-    }
-
-    options = options || {};
-    var segmentStrings = pattern.split(routePatternSeparator);
-
-    var nonEmptySegmentStrings = segmentStrings
-      .map(Function.prototype.call, String.prototype.trim)
-      .filter(Boolean);
-
-    var segmentArray = nonEmptySegmentStrings.map(function(segmentString) {
-      return segmentFactory(segmentString, options);
-    });
-
-    return segmentArray;
-  }
-
-
-  /**
-   * Create segment from string
-   *
-   * @param {string} segmentString
-   * @param {{}} options
-   * @returns {abstractSegment}
-   */
-  function segmentFactory(segmentString, options) {
-    options = options || {};
-
-    var segments = abstractSegment.allSubclasses();

Find segment type from string

 
    for(var i = 0; i < segments.length; i++) {
-      var segment = segments[i];
-      if(segment.match(segmentString)) {
-        return segment({
-          segmentString: segmentString,
-          options: options
-        });
-      }
-    }
-
-    return null;
-  }
-
-  return routeFactory;
-});
-
-
\ No newline at end of file diff --git a/docs/docco/routeMatchResult.html b/docs/docco/routeMatchResult.html deleted file mode 100644 index 8097b88d..00000000 --- a/docs/docco/routeMatchResult.html +++ /dev/null @@ -1,134 +0,0 @@ - routeMatchResult.js

routeMatchResult.js 

define([
-  'klassified'
-], function(object) {
-
-  /**
-   * Route match result are used as the answer of matching a url against a route.
-   *
-   * @param {{}} [spec]
-   * @param {{}} spec.url Matched URL
-   * @param {{}} spec.route Matched Route
-   * @param {{}} spec.values Hash with matched parameter names as keys and matching url segment values.
-   *
-   * @returns {routeMatchResult}
-   */
-  var routeMatchResult = object.subclass(function(that, my) {
-
-    var url;
-    var route;
-    var urlParameters;
-    var routeParameters;
-    var parameters;
-
-    my.initialize = function(spec) {
-      my.super(spec);
-      url = spec.url;
-      route = spec.route;
-
-      urlParameters = (url && url.getQuery && url.getQuery()) || {};
-      routeParameters = spec.values || {};
-      parameters = mergeParameters(routeParameters, urlParameters);
-    };

Public

 
    /**
-     * Matched route
-     *
-     * @returns {route}
-     */
-    that.getRoute = function () {
-      return route;
-    };
-
-    /**
-     * Matched URL
-     *
-     * @returns {url}
-     */
-    that.getUrl = function () {
-      return url;
-    };
-
-    /**
-     * Answers true if route match URL
-     *
-     * @returns {boolean}
-     */
-    that.isMatch = function() {
-      return true;
-    };
-
-    /**
-     * Values for parameters in route
-     *
-     * @returns {{}}
-     */
-    that.getRouteParameters = function() {
-      return routeParameters;
-    };
-
-    /**
-     * Values for parameters in query
-     *
-     * @returns {{}}
-     */
-    that.getQueryParameters = function() {
-      return url.getQuery();
-    };
-
-    /**
-     * All matched parameters
-     *
-     * @returns {{}}
-     */
-    that.getParameters = function() {
-      return parameters;
-    };
-
-    /**
-     * Constructs an array with all parameters in same order as in route pattern with
-     * query parameter as the last value.
-     *
-     * @returns {Array}
-     */
-    that.getActionArguments = function () {
-      var actionArguments =  Object.keys(routeParameters).map(function (parameterName) {
-        return routeParameters[parameterName];
-      });
-      actionArguments.push(url.getQuery());
-      return actionArguments;
-    };

Private

 
    function mergeParameters(routeParameters, queryParameters) {
-      var allValues = {};

Fill with route parameters

 
      for (var parameterName in routeParameters) {
-        if(routeParameters.hasOwnProperty(parameterName)) {
-          allValues[parameterName] = routeParameters[parameterName];
-        }
-      }

Fill with query parameters

 
      for (var queryParameterName in queryParameters) {
-        if(queryParameters.hasOwnProperty(queryParameterName)) {
-          allValues[queryParameterName] = queryParameters[queryParameterName];
-        }
-      }
-
-      return allValues;
-
-    }
-  });
-
-  routeMatchResult.class(function(that) {
-
-    /**
-     * Result to use when match does not match url
-     */
-    that.routeNoMatchResult = (function() {
-
-      /** @typedef {routeMatchResult} routeNoMatchResult */
-      var instance = that();
-
-      instance.isMatch = function() {
-        return false;
-      };
-
-      return instance;
-    }());
-  });
-
-  return routeMatchResult;
-});
-
-
\ No newline at end of file diff --git a/docs/docco/router.html b/docs/docco/router.html deleted file mode 100644 index e2f46867..00000000 --- a/docs/docco/router.html +++ /dev/null @@ -1,552 +0,0 @@ - router.js

router.js 

define(
-  [
-    'jquery',
-    '../events',
-    './route',
-    './url',
-    './hashLocation',
-    'klassified'
-  ],
-  function(jQuery, events, route, url, hashLocation, object) {
-
-    /**
-     * Lazily creates a singleton instance of
-     * hash-fragment listener `hashLocation()`.
-     *
-     * @returns {hashLocation}
-     */
-    var hashSingleton = function() {
-      if(!hashSingleton.instance) {
-        hashSingleton.instance = hashLocation();
-      }
-
-      return hashSingleton.instance;
-    };
-
-    /**
-    * Router allow you to keep state in the URL. When a user visits a specific URL the application
-    * can be transformed accordingly.
-    *
-    * Router have a routing table consisting of an array of routes. When the router resolves a URL
-    * each route is matched against the URL one-by-one. The order is defined by the route priority
-    * property (lower first). If two routes have the same priority or if priority is omitted, routes
-    * are matched in registration order.
-    *
-    * @param [spec]
-    * @param [spec.locationHandler] hashSingleton by default
-    *
-    * @returns {{}}
-    */
-    var router = object.subclass(function(that, my) {
-
-      my.initialize = function(spec) {
-        my.super(spec);
-        my.location = spec.locationHandler || hashSingleton();
-        my.routeTable = [];
-        my.lastMatch = undefined;
-        my.defaultParameters = {};

Listen for URL changes and resolve URL when changed

 
        my.location.onChanged(function() { my.resolveUrl(); });
-      };

Events

 
            my.events = events.eventCategory();

Public

 
      /**
-       * Triggered when a route is matched with `routeMatchResult` as argument.
-       * @type {event}
-       */
-            that.onRouteMatched = my.events.createEvent('routeMatched');
-
-      /**
-       * Triggered when a route is not matched with 'url' as argument.
-       * @type {event}
-       */
-            that.onRouteNotFound = my.events.createEvent('routeNotFound');
-
-      /**
-       * Triggered each time a URL is resolved with `url` as argument
-       * @type {event}
-       */
-            that.onResolveUrl = my.events.createEvent('resolveUrl');

@deprecated Use event property instead

 
            that.on = my.events.on;

Public

 
      /**
-       * Tries to resolve URL by matching the URL against all routes in
-       * route table. Unless `fallThrough` is set on the matched route, router
-       * will stop on first match.
-       *
-       * Last match is also stored as `my.lastMatch`
-       *
-       * @param {url} [aUrl] A URL or current url as default
-       */
-      that.resolveUrl = function(aUrl) {
-        if(typeof aUrl === "string") {
-          aUrl = url({rawUrl: aUrl});
-        }
-
-        my.resolveUrl(aUrl);
-      };
-
-      /**
-       * Creates and adds a new route to the routing table.
-       *
-       * @example
-       *
-       *    // Simplest possible route
-       *    aRouter.addRoute({
-       *      pattern: '/user/#id',
-       *      action: function(id, query) { console.log(id, query);},
-       *    });
-       *
-       *    // Route with name and priority,
-       *    aRouter.addRoute({
-       *      name: 'user',
-       *      pattern: '/user/#id',
-       *      priority: 4000,
-       *      action: function(id) { console.log(id);},
-       *    });
-       *
-       *    // Route with only pattern and custom onMatched event handler,
-       *    var route = aRouter.addRoute({ pattern: ''/user/#id''});
-       *    route.onMatched(function(result) {
-       *      console.dir(result.getValues());
-       *    });
-       *
-       *    // Route with route options,
-       *    aRouter.addRoute({
-       *      pattern: '/user/#id',
-       *      priority: 4000,
-       *      defaults: {
-       *        id: 'john_doe'
-       *      },
-       *      constraints: {
-       *        id: ['john_doe', 'jane_doe']
-       *      }
-       *    });
-       *
-       *
-       * @param {routeSpec} routeSpec Options passed to route plus options below
-       * @param {string} routeSpec.pattern Route pattern as string
-       * @param {function} routeSpec.action Executed when route is matched with parameters as arguments +
-       * query object as the last argument.
-       * @param {string} routeSpec.pattern Route pattern as string
-       *
-       * @returns {route}
-       */
-      that.addRoute = function(routeSpec) {
-        routeSpec = routeSpec || {};
-
-        var newRoute = route({
-          pattern: routeSpec.pattern,
-          options: routeSpec
-        });
-
-        if(routeSpec.action) {
-          newRoute.onMatched(function(result) {
-            routeSpec.action.apply(this, result.getActionArguments());
-          });
-        }
-
-                newRoute.name = routeSpec.name;
-        newRoute.fallThrough = routeSpec.fallThrough;
-
-        newRoute.priority = routeSpec.priority;
-        my.addRoute(newRoute);
-
-        return newRoute;
-      };
-
-      /**
-       * Find a route using a predicate function. The function is applied on routes
-       * on-by-one until match.
-       *
-       * @param {function} predicate
-       * @returns {route} Matched route or null if not matched
-       */
-            that.findRoute = function(predicate) {
-                var numRoutes = my.routeTable.length;
-                for(var routeIndex = 0; routeIndex < numRoutes; routeIndex++) {
-                    var route = my.routeTable[routeIndex];
-                    if(predicate(route)) {
-                        return route;
-                    }
-                }
-
-                return null;
-            };
-
-      /**
-       * Finds route by name
-       *
-       * @param {string} routeName
-       * @returns {route}
-       */
-            that.getRouteByName = function(routeName) {
-                return that.findRoute(function(route) {
-                    return route.name && route.name === routeName;
-                });
-            };
-
-      /**
-       * Removes a route from routing table
-       *
-       * @param route
-       */
-      that.removeRoute = function(route) {
-        var index = my.routeTable.indexOf(route);
-        if(index === -1) {
-          throw new Error('Route not in route table');
-        }
-
-        my.routeTable.splice(index, 1);
-      };
-
-      /**
-       * Removes all routes from routing table.
-       */
-            that.clear = function() {
-                my.routeTable = [];
-                my.lastMatch = undefined;
-            };
-
-      /**
-       * Pipes URL matching 'routeSpec' to another router.
-       *
-       * @param {{}} routeSpec Same options as `addRoute`
-       * @param {router} router
-       *
-       * @returns {route}
-       */
-      that.pipeRoute = function (routeSpec, router) {
-        if(!routeSpec || !routeSpec.pattern) {
-          throw new Error('Route pattern required');
-        }
-
-        var aRoute = that.addRoute(routeSpec);
-        aRoute.onMatched(function(result) {
-          router.resolveUrl(result.getUrl());
-        });
-
-        return aRoute;
-      };
-
-      /**
-       * Pipe not found to a different router
-       *
-       * @param {router} router
-       * @returns {route}
-       */
-      that.pipeNotFound = function (router) {
-        return that.onRouteNotFound(function(aRawUrl) {
-          router.resolveUrl(aRawUrl);
-        });
-      };
-
-      /**
-       * Returns the current URL
-       * @returns {url}
-       */
-      that.getUrl = function() {
-        return my.location.getUrl();
-      };
-
-      /**
-       * Constructs a link that can be used eg. in href.
-       *
-       * @example
-       *  // Link to a route by name (recommended)
-       *  aRouter.linkTo('users-list', {user: 'jane'});
-       *
-       *  // Link to a path
-       *  aRouter.linkTo('/user/mikael');
-       *  aRouter.linkTo('/user/', {sortBy: 'name'});
-       *
-       * @param {string} routeName Name of route or path
-       * @param {{}} [parameters]
-       * @param {boolean} [includeCurrentParameters=false] Merge parameters with parameters in current match.
-       *
-       * @returns {string}
-       */
-            that.linkTo = function(routeName, parameters, includeCurrentParameters) {
-                var route = that.getRouteByName(routeName);
-                if(route) {
-          return my.location.linkToUrl(that.expand({
-            routeName: route.name,
-            parameters: parameters,
-            excludeCurrentParameters: !includeCurrentParameters
-          }));
-                }

fallback to path (eg. /user/john) if route is not defined

 
        return that.linkToPath(routeName, parameters);
-            };
-
-      /**
-       * Link to a path
-       *
-       * @example
-       *  aRouter.linkToPath('/user/mikael');
-       *  aRouter.linkToPath('/user/', {sortBy: 'name'});
-       *
-       * @param {string} path
-       * @param {{}} query
-       * @returns {string}
-       */
-            that.linkToPath = function(path, query) {
-        return that.linkToUrl(url.build(path, query));
-      };
-
-      /**
-       * Link from url
-       *
-       * @param {url} aUrl
-       * @returns {string}
-       */
-      that.linkToUrl = function(aUrl) {
-        return my.location.linkToUrl(aUrl);
-      };
-
-      /**
-       * Redirects browser to route or path.
-       *
-       * @example
-       *  // Redirect to a route by name
-       *  aRouter.redirectTo('users-list', {user: 'jane'});
-       *
-       *  // Redirect to a path
-       *  aRouter.redirectTo('/user/mikael');
-       *  aRouter.redirectTo('/user/', {sortBy: 'name'});
-       *
-       * @param {string} routeName
-       * @param {{}} [parameters]
-       * @param {boolean} [includeCurrentParameters=false] Merge parameters with parameters in current match.
-       *
-       * @returns {string}
-       */
-      that.redirectTo = function(routeName, parameters, includeCurrentParameters) {
-                var route = that.getRouteByName(routeName);
-                if(route) {
-          return my.location.setUrl(that.expand({
-            routeName: route.name,
-            parameters: parameters,
-            excludeCurrentParameters: !includeCurrentParameters
-          }));
-                }
-
-                return that.redirectToPath(routeName, parameters);
-            };
-
-      /**
-       * Redirect to a path
-       *
-       * @example
-       *  aRouter.redirectToPath('/user/mikael');
-       *  aRouter.redirectToPath('/user/', {sortBy: 'name'});
-       *
-       * @param {string} path
-       * @param {{}} query
-       * @returns {string}
-       */
-      that.redirectToPath = function(path, query) {
-        return that.redirectToUrl(url.build(path, query));
-      };
-
-      /**
-       * Redirect to url
-       *
-       * @param {url} aUrl
-       * @returns {string}
-       */
-      that.redirectToUrl = function(aUrl) {
-        return my.location.setUrl(aUrl);
-      };
-
-      /**
-       * Constructs a new URL from parameters with a route as template. If no route is
-       * supplied the last matched route is used.
-       *
-       * Parameters are merged with parameters from last match unless `excludeCurrentParameters`
-       * is set to true.
-       *
-       * @param {{}} [options]
-       * @param {string} [options.routeName] Name of route to link to. Default route from last match.
-       * @param {{}} [options.parameters={}]
-       * @param {boolean} [options.excludeCurrentParameters=false]
-       *
-       * @returns {url}
-       */
-      that.expand = function(options) {
-        var routeName = options.routeName;
-        var suppliedParameters = options.parameters || {};
-        var excludeCurrentParameters = options.excludeCurrentParameters || false;

Pick a template route

 
        var templateRoute;
-        if(routeName) {
-          templateRoute = that.getRouteByName(routeName) || route();
-        } else if(my.lastMatch) {
-          templateRoute = my.lastMatch.getRoute();
-        } else {
-          templateRoute = route();
-        }

Merge current parameters with supplied parameters

 
        var currentParameters = !excludeCurrentParameters ? that.getParameters() : {};
-        var allParameters = merge(currentParameters, suppliedParameters);

Fill with defaults if needed

 
        Object.keys(my.defaultParameters).forEach(function(parameterName){
-          if(!(parameterName in allParameters)) {
-            allParameters[parameterName] = typeof my.defaultParameters[parameterName] === "function" ?
-              my.defaultParameters[parameterName]() :
-              my.defaultParameters[parameterName];
-          }
-        });

Expand template route and construct URL

 
        var aRawUrl = templateRoute.expand(allParameters);
-        return url({rawUrl: aRawUrl});
-      };
-
-      /**
-       * Constructs a link from supplied parameters.
-       *
-       * @param {{}} [parameters={}]
-       * @param {boolean} [excludeCurrentParameters=false]
-       *
-       * @returns {string}
-       */
-      that.linkToParameters = function(parameters, excludeCurrentParameters) {
-        return my.location.linkToUrl(that.expand({
-          parameters: parameters,
-          excludeCurrentParameters: excludeCurrentParameters
-        }));
-      };
-
-      /**
-       * Constructs a link from supplied parameters.
-       *
-       * @param {{}} [parameters={}]
-       * @param {boolean} [excludeCurrentParameters=false]
-       *
-       * @returns {string}
-       */
-      that.setParameters = function(parameters, excludeCurrentParameters) {
-        that.redirectToUrl(that.expand({
-          parameters: parameters,
-          excludeCurrentParameters: excludeCurrentParameters
-        }));
-      };
-
-      /**
-       * Return current parameters, ether from last match or if no match
-       * from query in current URL.
-       *
-       * @returns {{}} Parameter values with parameter names as keys
-       */
-            that.getParameters = function () {
-        if (!my.lastMatch) {
-          return my.location.getUrl().getQuery();
-        }
-
-        return my.lastMatch.getParameters();
-            };
-
-      /**
-       * Returns parameter value by name
-       *
-       * @param {string} parameterName
-       * @returns {*}
-       */
-            that.getParameter = function (parameterName) {
-                var parameters = that.getParameters();
-                return parameters[parameterName];
-            };
-
-      that.setDefaultParameter = function(parameterName, value) {
-        my.defaultParameters[parameterName] = value;
-      };
-
-      /**
-       * Navigate back to previous location in history. If history is empty
-       * the location will be changed to fallback URL.
-       *
-       * @param {string|url} aFallbackUrl
-       * @returns {string} URL
-       */
-            that.back = function(aFallbackUrl) {
-        return my.location.back(aFallbackUrl);
-      };
-
-      /**
-       * Return `true` if the history is empty
-       */
-      that.isHistoryEmpty = function() {
-        return my.location.isHistoryEmpty();
-      };
-
-
-      /**
-       * Start listening for location changes and automatically
-       * resolve new URLs (including the current)
-       */
-      that.start = function() {
-        my.location.start();
-        my.resolveUrl(); // resolve current url
-      };
-
-      /**
-       * Stop listening for location changes.
-       */
-      that.stop = function() {
-        my.location.stop();
-      };

Protected

 
      /**
-       * Tries to resolve URL by matching the URL against all routes in
-       * route table. Unless  `fallThrough`is set on the matched route router
-       * will stop on first match.
-       *
-       * Last match is also stored as `my.lastMatch`
-       *
-       * @param {url} [aUrl] A URL or current url as default
-       */
-      my.resolveUrl = function(aUrl) {
-        var currentUrl = aUrl === undefined ? my.location.getUrl() : aUrl;
-
-        that.onResolveUrl.trigger(currentUrl);
-
-        var numMatched = 0;
-        my.routeTable.some(function(candidateRoute) {
-          var result = currentUrl.matchRoute(candidateRoute);
-          if(result.isMatch()) {
-            my.lastMatch = result;
-            numMatched++;
-            that.onRouteMatched.trigger(result);
-
-            if(candidateRoute.fallThrough === undefined ||
-              candidateRoute.fallThrough === false) {
-              return true;
-            }
-          }
-        });
-
-        if (numMatched === 0) {
-          that.onRouteNotFound.trigger(currentUrl.toString());
-        }
-      };
-
-      /**
-       * Injects route in route table. Routes are ordered by priority (lower first) with
-       * routes without priority last. Routes with same priority are order in
-       * registration order.
-       *
-       * @param {route} route
-       */
-      my.addRoute = function (route) {
-        var routeIndex = my.routeTable.length;
-        if(route.priority !== undefined) {
-          do { --routeIndex; } while (my.routeTable[routeIndex] &&
-          (my.routeTable[routeIndex].priority === undefined ||
-          route.priority < my.routeTable[routeIndex].priority));
-          routeIndex += 1;
-        }
-        my.routeTable.splice(routeIndex, 0, route);
-      };

Private

 
      /**
-       * Shallow merge all objects in arguments. Properties in later objects overwrites
-       * properties.
-       *
-       * @returns {{}}
-       */
-      function merge() {
-        var objects = Array.prototype.slice.call(arguments);
-
-        var target = {};
-        objects.forEach(function(obj) {
-          Object.keys(obj).forEach(function (key) {
-            target[key] = obj[key];
-          });
-        });
-
-        return target;
-      }
-    });
-
-    return router;
-  });
-
-
\ No newline at end of file diff --git a/docs/docco/staticSegment.html b/docs/docco/staticSegment.html deleted file mode 100644 index 1e63a52b..00000000 --- a/docs/docco/staticSegment.html +++ /dev/null @@ -1,44 +0,0 @@ - staticSegment.js

staticSegment.js 

define([
-  './abstractSegment'
-], function(abstractSegment) {
-
-  /**
-   * A static segment match URL segments that are identical
-   * to the route segment string.
-   *
-   * @param spec abstractSegment spec
-   * @param [my]
-   * @returns {segment}
-   */
-  var staticSegment = abstractSegment.subclass(function(that, my) {
-
-    /**
-     * Static segment match if URL and route segment
-     * strings are identical.
-     *
-     * @param {string} urlSegment
-     * @returns {boolean}
-     */
-    that.match = function(urlSegment) {
-      return that.getValue() === urlSegment;
-    };
-
-    return that;
-  });
-
-  staticSegment.class(function(that) {
-
-    /**
-     * Match all but parameter segment strings
-     * @param {string} segmentString
-     * @returns {boolean}
-     */
-    that.match = function(segmentString) {
-      return ['#', '?'].indexOf(segmentString[0]) === -1;
-    };
-  });
-
-  return staticSegment;
-});
-
-
\ No newline at end of file diff --git a/docs/docco/url.html b/docs/docco/url.html deleted file mode 100644 index 55db59bc..00000000 --- a/docs/docco/url.html +++ /dev/null @@ -1,156 +0,0 @@ - url.js

url.js 

define([
-  'klassified'
-],
-  function (object) {
-
-    /**
-     * Token/Char used to separate segments in URL paths.
-     * @type {string}
-     */
-    var urlSeparator = '/';
-
-    /**
-     * A `url` actually represents the fragment part of the actual url.
-     *
-     * @example
-     *  var url = url({rawUrl: 'path/to?foo=a&bar=b'});
-     *  url.getPath(); // => 'path/to'
-     *  url.getQuery(); // => {foo: 'a', bar: 'b'}
-     *  url.matchRoute(aRoute); // => true
-     *
-     * @param {string} rawUrl
-     * @returns {url}
-     */
-    var url = object.subclass(function(that, my) {
-
-      var rawUrl;
-      var path;
-      var query;
-      var segments;
-
-      my.initialize = function(spec) {
-        my.super(spec);
-        rawUrl = spec.rawUrl || '';
-        path = parsePath(rawUrl);
-        query = parseQuery(rawUrl);
-        segments = parseSegments(path);
-      };

Public

 
      /**
-       * URL path
-       * @returns {string}
-       */
-      that.getPath = function () { return path; };
-
-      /**
-       * Key/Value pairs parsed from query
-       *
-       * @returns {{}}
-       */
-      that.getQuery = function () { return query; };
-
-      /**
-       * Segments in path parsed by splitting `path` by `urlSeparator`
-       *
-       * @returns {string[]}
-       */
-      that.getSegments = function () { return segments; };
-
-      /**
-       * Answers true if the route is a match for the receiver
-       *
-       * @param route
-       * @returns {boolean}
-       */
-      that.matchRoute = function (route) {
-        return route.matchUrl(that);
-      };
-
-      /**
-       * Returns `rawUrl`
-       * @returns {string}
-       */
-      that.toString = function() {
-        return rawUrl;
-      };
-    });
-
-    /**
-     * Create URL from path and query
-     *
-     * @example
-     *  var aUrl = url('/path/to', {foo: 'bar' });
-     *  aUrl.toString(); // => 'path/to?foo=bar'
-     *
-     * @param {string} path
-     * @param {{}} query
-     * @returns {url}
-     */
-    url.build = function(path, query) {
-      if (typeof(path) === 'undefined' || path === null || typeof path !== "string") {
-        throw 'accepts only string paths';
-      }
-
-      if (query) {
-                var queryPart = decodeURIComponent(jQuery.param(query));
-                if(queryPart) {
-                    return url({rawUrl: path + '?' + queryPart});
-                }
-            }
-
-      return url({rawUrl: path});
-    };
-
-    /**
-     * Splits URL path into segments. Removes leading, trailing, and
-     * duplicated `urlSeparator`.
-     *
-     * @example
-     *  parseSegments('/a/path/to'); // => ['a', 'path', 'to']
-     *
-     * @param path
-     * @returns {string[]}
-     */
-    function parseSegments(path) {

Split on separator and remove all leading, trailing, and -duplicated urlSeparator by filtering empty strings.

 
      return path.split(urlSeparator).filter(Boolean);
-    }
-
-    /**
-     * Returns path from a raw URL
-     *
-     * @example
-     *  parsePath('/a/path/to?foo=bar'); // => '/a/path/to'
-     *
-     * @param {string} rawUrl
-     * @returns {string}
-     */
-    function parsePath(rawUrl) {
-      return rawUrl.replace(/\?.*$/g, '');
-    }
-
-    /**
-     * Extract query key/value(s) from a rawUrl and return them as an
-     * object literal with key/values.
-     *
-     * @example
-     *  parsePath('/a/path/to?foo=bar&test=1'); // => {foo: 'bar', test: '1'}
-     *
-     * @param {string} rawUrl
-     * @returns {{}}
-     */
-    function parseQuery(rawUrl) {

Extract query key/value(s) from a rawUrl and add them to query object.

 
      var result = /[^?]*\?(.*)$/g.exec(rawUrl);
-      var query = {};
-      var pair;
-      if (result && result.length >= 2) {
-        (result[1].split("&")).forEach(function (each) {
-          pair = each.split("=");
-          query[pair[0]] = pair[1];
-        });
-      }
-
-      return query;
-    }
-
-    return url;
-  }
-);
-
-
\ No newline at end of file diff --git a/docs/docco/widget-extensions.html b/docs/docco/widget-extensions.html deleted file mode 100644 index 3ce1c231..00000000 --- a/docs/docco/widget-extensions.html +++ /dev/null @@ -1,16 +0,0 @@ - widget-extensions.js

widget-extensions.js

Widget extensions

- -

In your application include widget extensions. Using require.js: -define(['canvas/'widget-extensions], function(ext) { ... });

- -

add properties to ext that you need in all widgets. -ext.hello = function() { alert('hello world')};

- -

and use in all widgets: -my.hello();

 
define(
-  function () {
-    return {};
-  }
-);
-
-
\ No newline at end of file diff --git a/docs/docco/widget.html b/docs/docco/widget.html deleted file mode 100644 index 9d2a8d73..00000000 --- a/docs/docco/widget.html +++ /dev/null @@ -1,455 +0,0 @@ - widget.js

widget.js 

define(
-  [
-    'klassified',
-    './widget-extensions',
-    './router',
-    './events',
-    './htmlCanvas',
-    'jquery'
-  ],
-
-  function (object, ext, router, events, htmlCanvas, jQuery) {
-
-    /**
-     * Base for all widgets. A widget can keep state in variables, contain logic and
-     * render itself using `renderOn()`.
-     *
-     * @example
-     *
-     *    var titleWidget = function(spec) {
-     *      var that = widget(spec);
-     *
-     *      var title = spec.title || 'Hello World';
-     *
-     *      that.renderContentOn = function(html) {
-     *        html.h1(title)
-     *      }
-     *
-     *      return that;
-     *    };
-     *
-     *    var helloWorldWidget = titleWidget({title: 'Hello Widget!'});
-     *
-     *    $(document).ready(function() {
-     *      helloWorldWidget.appendTo('BODY');
-     *    });
-     *
-     * Widgets can also be rendered on a HTML canvas (since widget implements `appendToBrush()`). Eg.
-     *
-     *    html.div(helloWorldWidget)
-     *
-     * It is therefor easy to compose widgets from other widgets.
-     *
-     *
-     * @param {Object} spec
-     * @param {String} [spec.id] Unique id for widget. Also used for root element when attached/rendered to DOM.
-     *                           If not provided an ID will automatically be generated and assigned.
-     * @param {Object} [my]
-     *
-     * @returns {widget}
-     */
-    var widget = object.subclass(function(that, my) {
-
-      /**
-       * Keep track of the rendered subwidgets
-       */
-      var children;
-      var id;
-
-      my.initialize = function(spec) {
-        my.super(spec);
-        id = spec.id || idGenerator.newId();

When within an update transaction, do not update the widget

 
        my.inUpdateTransaction = false;
-        children = [];
-      };
-
-      /** Events for widget */
-      my.events = events.eventCategory();
-
-      that.onAttach = my.events.createEvent();
-      that.onDetach = my.events.createEvent();

Public

 
      /**
-       * Returns a unique id for the widget
-       *
-       * @returns {String}
-       */
-      that.getId = function () {
-        return id;
-      };
-
-      that.id = that.getId; //TODO: deprecated
-
-      /**
-       * Performance tasks need for freeing/releasing/cleaning-up resources used by widget.
-       *
-       * Should always be executed before a widget is disposed. Especially
-       * if the widget register events to avoid memory leaks.
-       *
-       * Most widgets should override `my.dispose` instead of overriding
-       * this function.
-       *
-       */
-      that.dispose = function() {
-        children.forEach(function(child) {
-          child.dispose();
-        });
-        my.dispose();
-
-        my.events.dispose();
-      };
-
-      /**
-       * Method to be performed when a root widget is detached from the
-       * DOM. The widegt and all its children will call `my.willDetach` in
-       * turn.
-       */
-      that.willDetach = function() {
-        children.forEach(function(child) {
-          child.willDetach();
-        });
-        my.willDetach();
-        that.onDetach.trigger();
-      };
-
-      /**
-       * Renders the widget on a JQuery / DOM
-       *
-       * @example
-       * widget.appendTo('BODY');
-       *
-       * @param aJQuery
-       */
-      that.appendTo = function (aJQuery) {
-        my.withAttachHooks(function() {
-          renderBasicOn(htmlCanvas(aJQuery));
-        });
-      };
-
-      /**
-       * Does the same as appendTo except it first clear the
-       * elements matched by aJQuery
-       *
-       * @param aJQuery
-       */
-      that.replace = function (aJQuery) {
-        my.withAttachHooks(function() {
-          var canvas = htmlCanvas(aJQuery);
-          canvas.root.asJQuery().empty();
-          renderBasicOn(canvas);
-        });
-      };
-
-      /**
-       * Answers a jQuery that match the root DOM element. By default
-       * by selecting an element that have the same ID as the widget.
-       *
-       * See 'renderOn'
-       *
-       * @returns {*}
-       */
-      that.asJQuery = function () {
-        return jQuery('#' + that.getId());
-      };
-
-      /**
-       * Answers true if if widget have rendered content in DOM
-       *
-       * @returns {boolean}
-       */
-      that.isRendered = function () {
-        return that.asJQuery().length > 0;
-      };
-
-      /**
-       * Implementation for `appendToBrush()` to allow a widget to be
-       * appended to a brush. See 'htmlCanvas'.
-       *
-       * Basically it allows us to do:
-       *    html.div(widget);
-       *
-       * @param aTagBrush
-       */
-      that.appendToBrush = function (aTagBrush) {
-        my.withAttachHooks(function() {
-          renderBasicOn(htmlCanvas(aTagBrush.asJQuery()));
-        });
-      };
-
-      /**
-       * Trigger the `willAttach` event on the receiver and all
-       * rendered subwidgets.
-       */
-      that.triggerWillAttach = function() {
-        my.willAttach();
-        children.forEach(function (widget) {
-          widget.triggerWillAttach();
-        });
-      };
-
-      /**
-       * Trigger the `didAttach` event on the receiver and all
-       * rendered subwidgets.
-       */
-      that.triggerDidAttach = function() {
-        my.didAttach();
-        children.forEach(function (widget) {
-          widget.triggerDidAttach();
-        });
-        that.onAttach.trigger();
-      };
-
-      /**
-       * Evaluate `fn`, calling `willAttach` before and `didAttach` after
-       * the evaluation.
-       */
-      my.withAttachHooks = function(fn) {
-        var inRendering = inRenderingLoop();
-        if(!inRendering) {
-          that.triggerWillAttach();
-        }
-        fn();
-        if(!inRendering) {
-          that.triggerDidAttach();
-        }
-      };

Expose events

 
      that.on = my.events.on;
-      that.onceOn = my.events.onceOn;
-      that.off = my.events.off;
-      that.trigger = my.events.trigger;

Protected

 
      /**
-       * Exposes the internal ID generator. Generates new unique IDs to be used
-       * for sub-widgets, etc.
-       *
-       * @returns {String}
-       */
-      my.nextId = function() {
-        return idGenerator.newId();
-      };
-
-      /**
-       * Widget specific dispose.
-       */
-      my.dispose = function() {};

Route / Controller extensions

 
      my.router = router.getRouter();
-
-      my.linkTo = my.router.linkTo;
-      my.linkToPath = my.router.linkToPath;
-      my.linkToUrl = my.router.linkToUrl;
-
-      my.redirectTo = my.router.redirectTo;
-      my.redirectToPath = my.router.redirectToPath;
-      my.redirectToUrl = my.router.redirectToUrl;
-
-      my.getParameters = my.router.getParameters;
-      my.getParameter = my.router.getParameter;
-      my.setParameters = my.router.setParameters;

Render

 
      /**
-       * Private rendering function.  This is the function
-       * internally called each time the widget is rendered, in
-       * `appendTo`, `replace` and `update`.
-       *
-       */
-      function renderBasicOn(html) {
-        my.withChildrenRegistration(function() {
-          that.renderOn(html);
-        });
-      }
-
-      /**
-       * Main entry point for rendering. For convenience 'renderOn' will  wrap the content
-       * rendered by 'renderContentOn' in a root element (renderRootOn) that will be matched
-       * by asJQuery.
-       *
-       * Usually concrete widgets override 'renderContentOn' to render it content. Widgets
-       * can override 'renderOn' but must then make sure that it can be matched by 'asJQuery'.
-       *
-       * One way to do that is to make sure to have only one root element and setting the ID of
-       * that element to the ID of the widget.
-       *
-       * @example
-       *
-       *    that.renderOn = function (html) {
-       *      html.ul({id: that.getId()}
-       *        html.li('BMW'),
-       *        html.li('Toyota')
-       *      );
-       *    };
-       *
-       *
-       * @param html
-       */
-      that.renderOn = function (html) {

Renders widget by wrapping renderContentOn() in a root element.

 
        my.renderRootOn(html).render(that.renderContentOn);
-      };
-
-      my.withChildrenRegistration = function(fn) {
-        var parent = currentWidget.get();
-        if(parent) {
-          parent.registerChild(that);
-        }
-        withCurrentWidget(function () {
-          children = [];
-          fn();
-        }, that);
-      };
-
-      that.registerChild = function(widget) {
-        children.push(widget);
-      };
-
-      /**
-       * Renders a wrapper element (by default a 'widgetjs-widget' tag) and
-       * set the element ID to the ID of the widget so that it can be found by
-       * 'asJQuery' eg. when we re-render using 'update'.
-       *
-       * @param html
-       * @returns {htmlBrush}
-       */
-      my.renderRootOn = function (html) {
-        return html.tag('widgetjs-widget').id(id);
-      };
-
-      /**
-       * Overridden in concrete widgets to render widget to canvas/DOM.
-       *
-       * @example
-       *
-       *    that.renderContentOn = function (html) {
-       *      html.ul(
-       *        html.li('BMW'),
-       *        html.li('Toyota')
-       *      );
-       *    };
-       *
-       * @param {htmlCanvas} html
-       */
-      that.renderContentOn = function (html) {};
-
-      /**
-       * Hook evaluated before the widget is attached (or reattached due
-       * to an update of rendering) to the DOM.
-       */
-      my.willAttach = function() {};
-
-      /**
-       * Hook evaluated each time the widget is attached (or
-       * reattached due to an update of rendering) to the DOM.
-       */
-      my.didAttach = function() {};
-
-      /**
-       * Hook evaluated when a widget is detached from the DOM.
-       */
-      my.willDetach = function() {};
-
-      /**
-       * Hook evaluated before widget update.
-       */
-      my.willUpdate = function() {};
-
-      /**
-       * Re-renders the widget and replace it in the DOM
-       *
-       * Content is first re-rendered on a document fragment. Update then replace the element matched
-       * by 'asJQuery' with the new content.
-       *
-       */
-      that.update = function () {
-        if (my.inUpdateTransaction || !that.isRendered()) {
-          return;
-        }
-
-        my.willUpdate();
-        my.withAttachHooks(function() {

Re-render

 
          var html = htmlCanvas();
-          renderBasicOn(html);

Replace our self

 
          that.asJQuery().replaceWith(html.root.element);
-        });
-      };
-
-      that.withinTransaction = function(fn, onDone) {
-        if(my.inUpdateTransaction) {
-          fn();
-        } else {
-          try {
-            my.inUpdateTransaction = true;
-            fn();
-          }
-          finally {
-            my.inUpdateTransaction = false;
-            if(onDone) {
-              onDone();
-            }
-          }
-        }
-      };
-
-
-      /**
-       * Evaluate `fn`, ensuring that an update will be
-       * performed after evaluating the function. Nested calls
-       * to `withUpdate` or `update` will result in updating the
-       * widget only once.
-       */
-      that.withUpdate = function(fn) {
-        that.withinTransaction(fn, that.update);
-      };
-
-      that.withNoUpdate = function(fn) {
-        that.withinTransaction(fn);
-      };

Third party protected extensions** added to my. -See widget-extensions.js

 
      for (var extProperty in ext) {
-        if (ext.hasOwnProperty(extProperty)) {
-          my[extProperty] = ext[extProperty];
-        }
-      }
-
-      return that;
-    });
-
-    /**
-     * Creates unique ids used by widgets to identify their root div.
-     */
-    var idGenerator = (function () {
-      var that = {};
-      var id = 0;
-
-      that.newId = function () {
-        id += 1;
-        return id.toString();
-      };
-
-      return that;
-    })();
-
-    /**
-     * Helpers for keeping track of the currently rendered widget.
-     */
-    var currentWidget = (function () {
-      var current;
-      return {
-        get: function () {
-          return current;
-        },
-        set: function (widget) {
-          current = widget;
-        }
-      };
-    })();
-
-    /**
-     * Return true if the parent widget is rendering the receiver.
-     */
-    function inRenderingLoop() {
-      return !!currentWidget.get();
-    }
-
-    /**
-     * Set `widget` as the current widget while evaluating `fn`.
-     */
-    function withCurrentWidget(fn, widget) {
-      var current = currentWidget.get();
-      try {
-        currentWidget.set(widget);
-        fn();
-      } finally {
-        currentWidget.set(current);
-      }
-    }
-
-    return widget;
-  }
-);
-
-
\ No newline at end of file