yafowil.widget.autocomplete 2.0a1__py3-none-any.whl

yafowil/widget/autocomplete/__init__.py

@@ -0,0 +1,64 @@
+from yafowil.base import factory
+from yafowil.utils import entry_point
+import os
+import webresource as wr
+
+
+resources_dir = os.path.join(os.path.dirname(__file__), 'resources')
+
+
+##############################################################################
+# Default
+##############################################################################
+
+# webresource ################################################################
+
+resources = wr.ResourceGroup(
+    name='yafowil.widget.autocomplete',
+    directory=resources_dir,
+    path='yafowil-autocomplete'
+)
+resources.add(wr.ScriptResource(
+    name='yafowil-autocomplete-js',
+    depends='jquery-js',
+    resource='widget.js',
+    compressed='widget.min.js'
+))
+resources.add(wr.StyleResource(
+    name='yafowil-autocomplete-css',
+    resource='widget.css'
+))
+
+# B/C resources ##############################################################
+
+js = [{
+    'group': 'yafowil.widget.autocomplete.common',
+    'resource': 'widget.js',
+    'order': 21,
+}]
+css = [{
+    'group': 'yafowil.widget.autocomplete.common',
+    'resource': 'widget.css',
+    'order': 21,
+}]
+
+
+##############################################################################
+# Registration
+##############################################################################
+
+@entry_point(order=10)
+def register():
+    from yafowil.widget.autocomplete import widget  # noqa
+
+    widget_name = 'yafowil.widget.autocomplete'
+
+    # Default
+    factory.register_theme(
+        'default',
+        widget_name,
+        resources_dir,
+        js=js,
+        css=css
+    )
+    factory.register_resources('default', widget_name, resources)

yafowil/widget/autocomplete/example.py

@@ -0,0 +1,127 @@
+from yafowil.base import factory
+from yafowil.compat import IS_PY2
+import json
+
+
+if IS_PY2:
+    from urlparse import urlparse
+    from urlparse import parse_qs
+else:
+    from urllib.parse import urlparse
+    from urllib.parse import parse_qs
+
+
+lipsum = """Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
+eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
+veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum
+dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident,
+sunt in culpa qui officia deserunt mollit anim id est laborum."""
+lipsum = sorted(set(lipsum.lower().replace('.', '').replace(',', '').split()))
+
+
+def json_response(url):
+    purl = urlparse(url)
+    qs = parse_qs(purl.query)
+    data = json_data(qs.get('term', [''])[0])
+    return {
+        'body': json.dumps(data),
+        'header': [('Content-Type', 'application/json')]
+    }
+
+
+def json_data(term):
+    data = lipsum
+    if term:
+        data = [_ for _ in data if _.startswith(term)]
+    return data
+
+
+DOC_STATIC = """\
+Autocomplete with static vocabulary
+-----------------------------------
+
+Autocomplete can make use of a static vocabulary source. Here words of blind
+text Lorem Ipsum are used. First the static list of words is generated
+
+.. code-block:: python
+
+    lipsum = '''Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
+    eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
+    veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
+    commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit
+    esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat
+    cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
+    est laborum.'''
+    lipsum = sorted(set(lipsum.lower().replace('.', '').replace(',', '').split()))
+
+Next, the field is defined as
+
+.. code-block:: python
+
+    field = factory('#field:autocomplete', props={
+        'label': 'Enter some text (local, lorem ipsum)',
+        'value': '',
+        'source': lipsum,
+    })
+"""
+
+DOC_JSON = """\
+Autocomplete with dynamic json vocabulary
+-----------------------------------------
+
+Instead of static lists autocomplete may ask the server for a list of words
+matching a given term. The source is a string and as such interpreted as a
+absolute or relative url
+
+.. code-block:: python
+
+    field = factory('#field:autocomplete', props={
+        'label': 'Enter some text (remote listdir)',
+        'value': '',
+        'source': 'yafowil.widget.autocomplete.json',
+        'minLength': 1,
+    })
+
+The server answers with a JSON response, here the example does it using WSGI
+and ``webob`` way. This code needs modification depending on the framework
+used
+
+.. code-block:: python
+
+    def json_response(environ, start_response):
+        data = lipsum
+        if environ['QUERY_STRING'].startswith('term='):
+            qsts = environ['QUERY_STRING'][5:]
+            data = [_ for _ in data if _.startswith(qsts)]
+        response = Response(content_type='application/json',
+                            body=json.dumps(data))
+        return response(environ, start_response)
+"""
+
+
+def get_example():
+    static_ac = factory('#field:autocomplete', name='static', props={
+        'label': 'Enter some text (local, lorem ipsum)',
+        'value': '',
+        'source': lipsum,
+    })
+    json_ac = factory('#field:autocomplete', name='json', props={
+        'label': 'Enter some text (remote listdir)',
+        'value': '',
+        'source': 'yafowil.widget.autocomplete.json',
+        'minLength': 1,
+    })
+    routes = {
+        'yafowil.widget.autocomplete.json': json_response,
+    }
+    return [{
+        'widget': static_ac,
+        'doc': DOC_STATIC,
+        'title': 'Static autocomplete',
+    }, {
+        'widget': json_ac,
+        'routes': routes,
+        'doc': DOC_JSON,
+        'title': 'JSON data autocomplete',
+    }]

yafowil/widget/autocomplete/resources/widget.css

@@ -0,0 +1,29 @@
+div.yafowil-widget-autocomplete .hiddenStructure {
+	display: none;
+}
+
+div.autocomplete-dropdown {
+	display: none;
+    position: absolute;
+    z-index: 2000;
+    min-width: 200px;
+    max-height: 320px;
+    overflow: hidden;
+    overflow-y: auto;
+    background: white;
+    border: 1px solid rgb(0 0 0 / 20%);
+    border-radius: 4px;
+    padding: 0;
+    box-shadow: 1px 1px 4px rgb(0 0 0 / 20%);
+}
+
+.autocomplete-suggestion {
+	display: block;
+    cursor: default;
+	padding: 5px 15px;
+}
+
+.autocomplete-suggestion.selected {
+	background: var(--yafowil-accent-color, #0d6efd);
+    color: var(--yafowil-accent-font-color, #fff);
+}

yafowil/widget/autocomplete/resources/widget.js

@@ -0,0 +1,340 @@
+var yafowil_autocomplete = (function (exports, $) {
+    'use strict';
+
+    class AutocompleteSuggestion {
+        constructor(widget, source, val) {
+            this.widget = widget;
+            this.elem = $('<div />')
+                .addClass('autocomplete-suggestion')
+                .appendTo(this.widget.dd_elem);
+            let index = source.toUpperCase().indexOf(val.toUpperCase());
+            $(`<span />`)
+                .text(source.substring(0, index))
+                .appendTo(this.elem);
+            $(`<strong />`)
+                .text(source.substring(index, index + val.length))
+                .appendTo(this.elem);
+            $(`<span />`)
+                .text(source.substring(index + val.length))
+                .appendTo(this.elem);
+            this.value = source;
+            this.selected = false;
+            this.select = this.select.bind(this);
+            this.elem.off('mousedown', this.select).on('mousedown', this.select);
+        }
+        get selected() {
+            return this._selected;
+        }
+        set selected(selected) {
+            if (selected) {
+                this._selected = true;
+                this.elem.addClass('selected');
+            } else {
+                this._selected = false;
+                this.elem.removeClass('selected');
+            }
+        }
+        select() {
+            this.selected = true;
+            this.widget.select_suggestion(this.value);
+        }
+    }
+    class AutocompleteWidget {
+        static initialize(context) {
+            $('div.yafowil-widget-autocomplete', context).each(function() {
+                let elem = $(this);
+                if (window.yafowil_array !== undefined &&
+                    window.yafowil_array.inside_template(elem)) {
+                    return;
+                }
+                new AutocompleteWidget(elem);
+            });
+        }
+        constructor(elem) {
+            elem.data('yafowil-autocomplete', this);
+            this.elem = elem;
+            this.input_elem = $('input.autocomplete', this.elem)
+                .attr('spellcheck', false)
+                .attr('autocomplete', 'off');
+            this.dd_elem = $(`<div />`)
+                .addClass('autocomplete-dropdown')
+                .appendTo('body');
+            this.suggestions = [];
+            this.current_focus = 0;
+            let options = this.parse_options();
+            this.sourcetype = options.type;
+            this.delay = options.delay;
+            this.min_length = options.minLength;
+            this.parse_source();
+            this.on_input = this.on_input.bind(this);
+            this.hide_dropdown = this.hide_dropdown.bind(this);
+            this.on_keydown = this.on_keydown.bind(this);
+            this.input_elem
+                .on('focusout', this.hide_dropdown)
+                .on('focus input', this.on_input)
+                .on('keydown', this.on_keydown);
+            this.autocomplete = this.autocomplete.bind(this);
+        }
+        unload() {
+            clearTimeout(this.timeout);
+            this.input_elem
+                .off('focusout', this.hide_dropdown)
+                .off('focus input', this.on_input)
+                .off('keydown', this.on_keydown);
+        }
+        parse_options() {
+            let rawparams = $('.autocomplete-params', this.elem).text().split('|'),
+                options = [];
+            for (let i = 0; i < rawparams.length; i++) {
+                let pair = rawparams[i].split(',');
+                let value = pair[1].replace(/^\s+|\s+$/g, "");
+                if (!isNaN(value)) {
+                    value = parseInt(value);
+                } else
+                if (value === 'True') {
+                    value = true;
+                } else
+                if (value === 'False') {
+                    value = false;
+                }
+                let key = pair[0].replace(/^\s+|\s+$/g, "");
+                options[key] = value;
+            }
+            return options;
+        }
+        parse_source() {
+            let source = $('.autocomplete-source', this.elem).text();
+            if (source.indexOf('javascript:') === 0) {
+                let src = source.substring(11, source.length).split('.');
+                let window_src = window;
+                for (let part of src) {
+                    window_src = window_src[part];
+                    if (window_src === undefined) {
+                        throw new Error('Cannot locate source function: ' + source);
+                    }
+                }
+                this.source = function(request, response) {
+                    window_src(request, response);
+                };
+            } else if (this.sourcetype === 'local') {
+                if (source === '') {
+                    throw new Error('Local source is empty');
+                }
+                this.source = function(request, response) {
+                    let src = source.split('|'),
+                        term = request.term,
+                        data = [];
+                    for (let item of src) {
+                        if (item.toUpperCase().indexOf(term.toUpperCase()) > -1) {
+                            data.push(item);
+                        }
+                    }
+                    response(data);
+                };
+            } else if (this.sourcetype === 'remote') {
+                this.source = function(request, response) {
+                    $.ajax({
+                        url: source,
+                        data: {term: request.term},
+                        dataType: "json",
+                        success: function(data) {
+                            response(data);
+                        },
+                        error: function() {
+                            response([]);
+                            throw new Error('Cannot locate JSON at: ' + source);
+                        }
+                    });
+                };
+            }
+        }
+        on_input(e) {
+            clearTimeout(this.timeout);
+            this.dd_elem.empty().hide();
+            this.suggestions = [];
+            this.current_focus = -1;
+            if (this.input_elem.val().length >= this.min_length) {
+                this.timeout = setTimeout(this.autocomplete, this.delay);
+            }
+        }
+        autocomplete() {
+            let val = this.input_elem.val();
+            this.source({term: val}, (data) => {
+                if(!data.length) {
+                    return;
+                }
+                for (let item of data) {
+                    this.suggestions.push(new AutocompleteSuggestion(this, item, val));
+                }
+                let scrolltop = $(document).scrollTop(),
+                    input_top = this.elem.offset().top,
+                    input_left = this.elem.offset().left,
+                    input_height = this.elem.outerHeight(),
+                    dd_height = this.dd_elem.outerHeight(),
+                    top;
+                let viewport_edge = scrolltop + $(window).outerHeight();
+                let dd_bottom = input_top + input_height + dd_height;
+                if (dd_bottom >= viewport_edge) {
+                    top = input_top - dd_height;
+                } else {
+                    top = input_top + input_height;
+                }
+                this.dd_elem.css({
+                    top: `${top}px`,
+                    left: `${input_left}px`
+                });
+                this.dd_elem.show();
+            });
+        }
+        on_keydown(e) {
+            let scrolltop = this.dd_elem.scrollTop();
+            switch (e.key) {
+                case "ArrowDown":
+                    this.current_focus++;
+                    this.add_active(true);
+                    break;
+                case "ArrowUp":
+                    this.current_focus--;
+                    this.add_active(false);
+                    break;
+                case "Enter":
+                    e.preventDefault();
+                    if (this.current_focus > -1) {
+                        let selected_elem = this.suggestions[this.current_focus];
+                        selected_elem.selected = true;
+                        this.input_elem.val(selected_elem.value);
+                        this.hide_dropdown();
+                        this.input_elem.trigger('blur');
+                    }
+                    break;
+                case "Escape":
+                    this.hide_dropdown();
+                    this.input_elem.trigger('blur');
+                    break;
+                case "Tab":
+                    this.hide_dropdown();
+                    if (this.current_focus > -1) {
+                        let selected_elem = this.suggestions[this.current_focus];
+                        this.input_elem.val(selected_elem.value);
+                        this.hide_dropdown();
+                        this.input_elem.trigger('blur');
+                    }
+                    break;
+                case "PageDown":
+                    e.preventDefault();
+                    this.dd_elem.scrollTop(scrolltop + this.dd_elem.height());
+                    if (this.current_focus > -1) {
+                        let index = 0;
+                        for (let i in this.suggestions) {
+                            let elem = this.suggestions[i].elem;
+                            if (elem.offset().top < this.dd_elem.offset().top) {
+                                index++;
+                            }
+                        }
+                        this.current_focus = index;
+                        let selected_elem = this.suggestions[index];
+                        this.unselect_all();
+                        selected_elem.selected = true;
+                    }
+                    break;
+                case "PageUp":
+                    e.preventDefault();
+                    this.dd_elem.scrollTop(scrolltop - this.dd_elem.height());
+                    if (this.current_focus > -1) {
+                        let index = 0;
+                        for (let i in this.suggestions) {
+                            let elem = this.suggestions[i].elem;
+                            if (elem.offset().top < this.dd_elem.offset().top) {
+                                index++;
+                            }
+                        }
+                        this.current_focus = index;
+                        let selected_elem = this.suggestions[index];
+                        this.unselect_all();
+                        selected_elem.selected = true;
+                    }
+                    break;
+            }
+        }
+        select_suggestion(val) {
+            this.hide_dropdown();
+            this.input_elem.val(val);
+        }
+        unselect_all() {
+            for (let suggestion of this.suggestions) {
+                suggestion.selected = false;
+            }
+        }
+        add_active(dir) {
+            if (this.suggestions.length === 0) {
+                return;
+            }
+            this.unselect_all();
+            if (this.current_focus >= this.suggestions.length) {
+                this.current_focus = 0;
+            } else if (this.current_focus < 0) {
+                this.current_focus = (this.suggestions.length - 1);
+            }
+            let active_elem = this.suggestions[this.current_focus];
+            active_elem.selected = true;
+            let scrolltop = this.dd_elem.scrollTop();
+            let elem_top = active_elem.elem.offset().top;
+            let elem_height = active_elem.elem.outerHeight();
+            let dd_top = this.dd_elem.offset().top;
+            let dd_height = this.dd_elem.outerHeight();
+            if (dir) {
+                if (this.current_focus === 0) {
+                    this.dd_elem.scrollTop(0);
+                } else if (elem_top + elem_height > dd_top + dd_height) {
+                    this.dd_elem.scrollTop(scrolltop + elem_height);
+                }
+            } else {
+                if (this.current_focus >= this.suggestions.length - 1) {
+                    this.dd_elem.scrollTop(elem_height * this.suggestions.length);
+                } else if (elem_top < dd_top) {
+                    this.dd_elem.scrollTop(scrolltop - elem_height);
+                }
+            }
+        }
+        hide_dropdown() {
+            this.dd_elem.hide();
+        }
+    }
+    function autocomplete_on_array_add(inst, context) {
+        AutocompleteWidget.initialize(context);
+    }
+    function register_array_subscribers() {
+        if (window.yafowil_array !== undefined) {
+            window.yafowil_array.on_array_event('on_add', autocomplete_on_array_add);
+        } else if (yafowil.array !== undefined) {
+            $.extend(yafowil.array.hooks.add, {
+                autocomplete_binder: AutocompleteWidget.initialize
+            });
+        }
+    }
+
+    $(function() {
+        if (window.ts !== undefined) {
+            ts.ajax.register(AutocompleteWidget.initialize, true);
+        } else if (window.bdajax !== undefined) {
+            bdajax.register(AutocompleteWidget.initialize, true);
+        } else {
+            AutocompleteWidget.initialize();
+        }
+        register_array_subscribers();
+    });
+
+    exports.AutocompleteSuggestion = AutocompleteSuggestion;
+    exports.AutocompleteWidget = AutocompleteWidget;
+    exports.register_array_subscribers = register_array_subscribers;
+
+    Object.defineProperty(exports, '__esModule', { value: true });
+
+
+    window.yafowil = window.yafowil || {};
+    window.yafowil.autocomplete = exports;
+
+
+    return exports;
+
+})({}, jQuery);

yafowil/widget/autocomplete/resources/widget.min.js

@@ -0,0 +1 @@
+var yafowil_autocomplete=function(e,t){"use strict";class s{constructor(e,s,i){this.widget=e,this.elem=t("<div />").addClass("autocomplete-suggestion").appendTo(this.widget.dd_elem);let o=s.toUpperCase().indexOf(i.toUpperCase());t("<span />").text(s.substring(0,o)).appendTo(this.elem),t("<strong />").text(s.substring(o,o+i.length)).appendTo(this.elem),t("<span />").text(s.substring(o+i.length)).appendTo(this.elem),this.value=s,this.selected=!1,this.select=this.select.bind(this),this.elem.off("mousedown",this.select).on("mousedown",this.select)}get selected(){return this._selected}set selected(e){e?(this._selected=!0,this.elem.addClass("selected")):(this._selected=!1,this.elem.removeClass("selected"))}select(){this.selected=!0,this.widget.select_suggestion(this.value)}}class i{static initialize(e){t("div.yafowil-widget-autocomplete",e).each((function(){let e=t(this);void 0!==window.yafowil_array&&window.yafowil_array.inside_template(e)||new i(e)}))}constructor(e){e.data("yafowil-autocomplete",this),this.elem=e,this.input_elem=t("input.autocomplete",this.elem).attr("spellcheck",!1).attr("autocomplete","off"),this.dd_elem=t("<div />").addClass("autocomplete-dropdown").appendTo("body"),this.suggestions=[],this.current_focus=0;let s=this.parse_options();this.sourcetype=s.type,this.delay=s.delay,this.min_length=s.minLength,this.parse_source(),this.on_input=this.on_input.bind(this),this.hide_dropdown=this.hide_dropdown.bind(this),this.on_keydown=this.on_keydown.bind(this),this.input_elem.on("focusout",this.hide_dropdown).on("focus input",this.on_input).on("keydown",this.on_keydown),this.autocomplete=this.autocomplete.bind(this)}unload(){clearTimeout(this.timeout),this.input_elem.off("focusout",this.hide_dropdown).off("focus input",this.on_input).off("keydown",this.on_keydown)}parse_options(){let e=t(".autocomplete-params",this.elem).text().split("|"),s=[];for(let t=0;t<e.length;t++){let i=e[t].split(","),o=i[1].replace(/^\s+|\s+$/g,"");isNaN(o)?"True"===o?o=!0:"False"===o&&(o=!1):o=parseInt(o),s[i[0].replace(/^\s+|\s+$/g,"")]=o}return s}parse_source(){let e=t(".autocomplete-source",this.elem).text();if(0===e.indexOf("javascript:")){let t=e.substring(11,e.length).split("."),s=window;for(let i of t)if(s=s[i],void 0===s)throw new Error("Cannot locate source function: "+e);this.source=function(e,t){s(e,t)}}else if("local"===this.sourcetype){if(""===e)throw new Error("Local source is empty");this.source=function(t,s){let i=e.split("|"),o=t.term,l=[];for(let e of i)e.toUpperCase().indexOf(o.toUpperCase())>-1&&l.push(e);s(l)}}else"remote"===this.sourcetype&&(this.source=function(s,i){t.ajax({url:e,data:{term:s.term},dataType:"json",success:function(e){i(e)},error:function(){throw i([]),new Error("Cannot locate JSON at: "+e)}})})}on_input(e){clearTimeout(this.timeout),this.dd_elem.empty().hide(),this.suggestions=[],this.current_focus=-1,this.input_elem.val().length>=this.min_length&&(this.timeout=setTimeout(this.autocomplete,this.delay))}autocomplete(){let e=this.input_elem.val();this.source({term:e},(i=>{if(!i.length)return;for(let t of i)this.suggestions.push(new s(this,t,e));let o,l=t(document).scrollTop(),n=this.elem.offset().top,r=this.elem.offset().left,h=this.elem.outerHeight(),u=this.dd_elem.outerHeight();o=n+h+u>=l+t(window).outerHeight()?n-u:n+h,this.dd_elem.css({top:`${o}px`,left:`${r}px`}),this.dd_elem.show()}))}on_keydown(e){let t=this.dd_elem.scrollTop();switch(e.key){case"ArrowDown":this.current_focus++,this.add_active(!0);break;case"ArrowUp":this.current_focus--,this.add_active(!1);break;case"Enter":if(e.preventDefault(),this.current_focus>-1){let e=this.suggestions[this.current_focus];e.selected=!0,this.input_elem.val(e.value),this.hide_dropdown(),this.input_elem.trigger("blur")}break;case"Escape":this.hide_dropdown(),this.input_elem.trigger("blur");break;case"Tab":if(this.hide_dropdown(),this.current_focus>-1){let e=this.suggestions[this.current_focus];this.input_elem.val(e.value),this.hide_dropdown(),this.input_elem.trigger("blur")}break;case"PageDown":if(e.preventDefault(),this.dd_elem.scrollTop(t+this.dd_elem.height()),this.current_focus>-1){let e=0;for(let t in this.suggestions){this.suggestions[t].elem.offset().top<this.dd_elem.offset().top&&e++}this.current_focus=e;let t=this.suggestions[e];this.unselect_all(),t.selected=!0}break;case"PageUp":if(e.preventDefault(),this.dd_elem.scrollTop(t-this.dd_elem.height()),this.current_focus>-1){let e=0;for(let t in this.suggestions){this.suggestions[t].elem.offset().top<this.dd_elem.offset().top&&e++}this.current_focus=e;let t=this.suggestions[e];this.unselect_all(),t.selected=!0}}}select_suggestion(e){this.hide_dropdown(),this.input_elem.val(e)}unselect_all(){for(let e of this.suggestions)e.selected=!1}add_active(e){if(0===this.suggestions.length)return;this.unselect_all(),this.current_focus>=this.suggestions.length?this.current_focus=0:this.current_focus<0&&(this.current_focus=this.suggestions.length-1);let t=this.suggestions[this.current_focus];t.selected=!0;let s=this.dd_elem.scrollTop(),i=t.elem.offset().top,o=t.elem.outerHeight(),l=this.dd_elem.offset().top,n=this.dd_elem.outerHeight();e?0===this.current_focus?this.dd_elem.scrollTop(0):i+o>l+n&&this.dd_elem.scrollTop(s+o):this.current_focus>=this.suggestions.length-1?this.dd_elem.scrollTop(o*this.suggestions.length):i<l&&this.dd_elem.scrollTop(s-o)}hide_dropdown(){this.dd_elem.hide()}}function o(e,t){i.initialize(t)}function l(){void 0!==window.yafowil_array?window.yafowil_array.on_array_event("on_add",o):void 0!==yafowil.array&&t.extend(yafowil.array.hooks.add,{autocomplete_binder:i.initialize})}return t((function(){void 0!==window.ts?ts.ajax.register(i.initialize,!0):void 0!==window.bdajax?bdajax.register(i.initialize,!0):i.initialize(),l()})),e.AutocompleteSuggestion=s,e.AutocompleteWidget=i,e.register_array_subscribers=l,Object.defineProperty(e,"__esModule",{value:!0}),window.yafowil=window.yafowil||{},window.yafowil.autocomplete=e,e}({},jQuery);

yafowil/widget/autocomplete/tests.py

@@ -0,0 +1,165 @@
+from node.utils import UNSET
+from yafowil.base import ExtractionError
+from yafowil.base import factory
+from yafowil.compat import IS_PY2
+from yafowil.tests import fxml
+from yafowil.tests import YafowilTestCase
+import os
+import unittest
+
+
+if not IS_PY2:
+    from importlib import reload
+
+
+def np(path):
+    return path.replace('/', os.path.sep)
+
+
+class TestAutocompleteWidget(YafowilTestCase):
+
+    def setUp(self):
+        super(TestAutocompleteWidget, self).setUp()
+        from yafowil.widget import autocomplete
+        from yafowil.widget.autocomplete import widget
+        reload(widget)
+        autocomplete.register()
+
+    def test_source_is_string(self):
+        # Render plain, source is string
+        widget = factory(
+            'autocomplete',
+            name='root',
+            props={
+                'source': 'http://www.foo.bar/baz'
+            })
+        self.checkOutput("""
+        <div class="yafowil-widget-autocomplete">
+          <input class="autocomplete" id="input-root" name="root" type="text"/>
+          <div class="autocomplete-source hiddenStructure">http://www.foo.bar/baz</div>
+          <div class="autocomplete-params hiddenStructure">delay,300|minLength,1|type,remote</div>
+        </div>
+        """, fxml(widget()))
+
+    def test_source_is_list(self):
+        # Render plain, source is list
+        widget = factory(
+            'autocomplete',
+            name='root',
+            props={
+                'source': ['foo', 'bar']
+            })
+        self.checkOutput("""
+        <div class="yafowil-widget-autocomplete">
+          <input class="autocomplete" id="input-root" name="root" type="text"/>
+          <div class="autocomplete-source hiddenStructure">foo|bar</div>
+          <div class="autocomplete-params hiddenStructure">delay,300|minLength,1|type,local</div>
+        </div>
+        """, fxml(widget()))
+
+    def test_source_is_callable(self):
+        # Render plain, source is callable
+        def test_source(widget, data):
+            return 'http://from.callable/'
+
+        widget = factory(
+            'autocomplete',
+            name='root',
+            props={
+                'source': test_source
+            })
+        self.checkOutput("""
+        <div class="yafowil-widget-autocomplete">
+          <input class="autocomplete" id="input-root" name="root" type="text"/>
+          <div class="autocomplete-source hiddenStructure">http://from.callable/</div>
+          <div class="autocomplete-params hiddenStructure">delay,300|minLength,1|type,remote</div>
+        </div>""", fxml(widget()))
+
+    def test_extraction(self):
+        def test_source(widget, data):
+            return 'http://from.callable/'
+
+        widget = factory(
+            'autocomplete',
+            name='root',
+            props={
+                'source': test_source
+            })
+        data = widget.extract({'root': 'abc'})
+        self.assertEqual(
+            [data.name, data.value, data.extracted, data.errors],
+            ['root', UNSET, 'abc', []]
+        )
+
+        widget = factory(
+            'error:autocomplete',
+            name='root',
+            props={
+                'source': test_source,
+                'required': 'Autocomplete widget is required'
+            })
+        data = widget.extract({'root': ''})
+        error = ExtractionError('Autocomplete widget is required')
+        self.assertEqual(
+            [data.name, data.value, data.extracted, data.errors],
+            ['root', UNSET, '', [error]]
+        )
+
+        self.checkOutput("""
+        <div class="error">
+          <div class="errormessage">Autocomplete widget is required</div>
+          <div class="yafowil-widget-autocomplete">
+            <input class="autocomplete required" id="input-root" name="root"
+                   required="required" type="text" value=""/>
+            <div class="autocomplete-source hiddenStructure">http://from.callable/</div>
+            <div class="autocomplete-params hiddenStructure">delay,300|minLength,1|type,remote</div>
+          </div>
+        </div>
+        """, fxml(widget(data)))
+
+    def test_invalid_source_type(self):
+        widget = factory(
+            'autocomplete',
+            name='root',
+            props={
+                'source': None
+            })
+        with self.assertRaises(ValueError) as arc:
+            widget()
+        self.assertEqual(
+            str(arc.exception),
+            'resulting source must be tuple/list or string'
+        )
+
+    def test_resources(self):
+        factory.theme = 'default'
+        resources = factory.get_resources('yafowil.widget.autocomplete')
+        self.assertTrue(
+            resources.directory.endswith(np('/autocomplete/resources'))
+        )
+        self.assertEqual(resources.name, 'yafowil.widget.autocomplete')
+        self.assertEqual(resources.path, 'yafowil-autocomplete')
+
+        scripts = resources.scripts
+        self.assertEqual(len(scripts), 1)
+
+        self.assertTrue(
+            scripts[0].directory.endswith(np('/autocomplete/resources'))
+        )
+        self.assertEqual(scripts[0].path, 'yafowil-autocomplete')
+        self.assertEqual(scripts[0].file_name, 'widget.min.js')
+        self.assertTrue(os.path.exists(scripts[0].file_path))
+
+        styles = resources.styles
+        self.assertEqual(len(styles), 1)
+
+        self.assertTrue(
+            styles[0].directory.endswith(np('/autocomplete/resources'))
+        )
+        self.assertEqual(styles[0].path, 'yafowil-autocomplete')
+        self.assertEqual(styles[0].file_name, 'widget.css')
+        self.assertTrue(os.path.exists(styles[0].file_path))
+
+
+if __name__ == '__main__':
+    unittest.main()

yafowil/widget/autocomplete/widget.py

@@ -0,0 +1,82 @@
+from yafowil.base import factory
+from yafowil.common import generic_extractor
+from yafowil.common import generic_required_extractor
+from yafowil.common import input_generic_renderer
+from yafowil.compat import STR_TYPE
+from yafowil.utils import attr_value
+from yafowil.utils import managedprops
+
+
+@managedprops('source', 'delay', 'minLength')
+def autocomplete_renderer(widget, data):
+    result = data.rendered
+    tag = data.tag
+    source = attr_value('source', widget, data)
+    if isinstance(source, (list, tuple)):
+        source = '|'.join(source)
+        source_type = 'local'
+    elif isinstance(source, STR_TYPE):
+        source_type = 'remote'
+    else:
+        raise ValueError('resulting source must be tuple/list or string')
+    result += tag('div', source, **{
+        'class': 'autocomplete-source hiddenStructure'
+    })
+    params = [
+        ('%s,%s' % (_, attr_value(_, widget, data)))
+        for _ in ['delay', 'minLength']
+    ]
+    params.append('type,%s' % source_type)
+    result += tag('div', '|'.join(params), **{
+        'class': 'autocomplete-params hiddenStructure'
+    })
+    return tag('div', result, **{'class': 'yafowil-widget-autocomplete'})
+
+
+def autocomplete_extractor(widget, data):
+    return data.extracted
+
+
+factory.register(
+    'autocomplete',
+    extractors=[
+        generic_extractor,
+        generic_required_extractor,
+        autocomplete_extractor
+    ],
+    edit_renderers=[
+        input_generic_renderer,
+        autocomplete_renderer
+    ]
+)
+
+factory.doc['blueprint']['autocomplete'] = """\
+Add-on blueprint `yafowil.widget.autocomplete
+<http://github.com/conestack/yafowil.widget.autocomplete/>`_ utilizing
+``jquery.ui.autocomplete`` to offer the user a selection based on the input
+given so far.
+"""
+
+factory.defaults['autocomplete.type'] = 'text'
+
+factory.defaults['autocomplete.class'] = 'autocomplete'
+
+factory.defaults['autocomplete.required_class'] = 'required'
+
+factory.defaults['autocomplete.disabled'] = False
+
+factory.defaults['autocomplete.size'] = None
+
+factory.defaults['autocomplete.delay'] = '300'
+factory.doc['props']['autocomplete.delay'] = """\
+Delay in milliseconds.
+"""
+
+factory.defaults['autocomplete.minLength'] = '1'
+factory.doc['props']['autocomplete.minLength'] = """\
+Minimum input length to trigger autocomplete.
+"""
+
+factory.doc['props']['autocomplete.source'] = """\
+Autocomplete source as python iterable or string defining JSON view callback.
+"""

yafowil.widget.autocomplete-2.0a1-py3.9-nspkg.pth

@@ -0,0 +1,2 @@
+import sys, types, os;p = os.path.join(sys._getframe(1).f_locals['sitedir'], *('yafowil',));importlib = __import__('importlib.util');__import__('importlib.machinery');m = sys.modules.setdefault('yafowil', importlib.util.module_from_spec(importlib.machinery.PathFinder.find_spec('yafowil', [os.path.dirname(p)])));m = m or sys.modules.setdefault('yafowil', types.ModuleType('yafowil'));mp = (m or []) and m.__dict__.setdefault('__path__',[]);(p not in mp) and mp.append(p)
+import sys, types, os;p = os.path.join(sys._getframe(1).f_locals['sitedir'], *('yafowil', 'widget'));importlib = __import__('importlib.util');__import__('importlib.machinery');m = sys.modules.setdefault('yafowil.widget', importlib.util.module_from_spec(importlib.machinery.PathFinder.find_spec('yafowil.widget', [os.path.dirname(p)])));m = m or sys.modules.setdefault('yafowil.widget', types.ModuleType('yafowil.widget'));mp = (m or []) and m.__dict__.setdefault('__path__',[]);(p not in mp) and mp.append(p);m and setattr(sys.modules['yafowil'], 'widget', m)

yafowil.widget.autocomplete-2.0a1.dist-info/LICENSE.rst

@@ -0,0 +1,27 @@
+License
+=======
+
+Copyright (c) 2010-2021, BlueDynamics Alliance, Austria, Germany, Switzerland
+Copyright (c) 2021-2022, Yafowil Contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

yafowil.widget.autocomplete-2.0a1.dist-info/METADATA

@@ -0,0 +1,186 @@
+Metadata-Version: 2.1
+Name: yafowil.widget.autocomplete
+Version: 2.0a1
+Summary: Autocomplete Widget for YAFOWIL
+Home-page: http://github.com/conestack/yafowil.widget.autocomplete
+Author: Yafowil Contributors
+Author-email: dev@conestack.org
+License: Simplified BSD
+Keywords: jquery jquery.ui.autocomplete widget yafowil
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Topic :: Software Development
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+License-File: LICENSE.rst
+Requires-Dist: setuptools
+Requires-Dist: yafowil >2.1.99
+Provides-Extra: test
+Requires-Dist: lxml ; extra == 'test'
+Requires-Dist: zope.testrunner ; extra == 'test'
+
+This is a **autocomplete widget** for for `YAFOWIL
+<http://pypi.python.org/pypi/yafowil>`_ - Yet Another Form WIdget Library.
+
+- `Documentation <http://docs.yafowil.info/en/latest/blueprints.html#autocomplete>`_
+- `DEMO - see it Live <http://docs.demo.yafowil.info/++widget++yafowil.widget.autocomplete/index.html>`_
+
+
+Source Code
+===========
+
+The sources are in a GIT DVCS with its main branches at
+`github <http://github.com/conestack/yafowil.widget.autocomplete>`_.
+
+We'd be happy to see many forks and pull-requests to make YAFOWIL even better.
+
+
+Contributors
+============
+
+- Jens Klein
+
+- Robert Niederreiter
+
+- Georg Bernhard
+
+- Lena Daxenbichler
+
+
+Changes
+=======
+
+2.0a1 (2024-06-02)
+------------------
+
+- Extend JS by ``autocomplete_on_array_add`` and ``register_array_subscribers``
+  to enable usage in ``yafowil.widget.array``.
+  [lenadax]
+
+- Get rid of jQuery UI. Rewrite Jacascript widget using ES6.
+  [lenadax]
+
+
+1.7 (2018-07-16)
+----------------
+
+- Python 3 compatibility.
+  [rnix]
+
+- Convert doctests to unittests.
+  [rnix]
+
+
+1.6 (2017-03-01)
+----------------
+
+- Add dedicated CSS for ``plone5`` theme provided by ``yafowil.plone``.
+  [rnix, 2016-06-28]
+
+- Use ``yafowil.utils.entry_point`` decorator.
+  [rnix, 2016-06-28]
+
+
+1.5.1 (2015-06-25)
+------------------
+
+- Resolve JSHint errors and warnings.
+  [thet]
+
+
+1.5 (2015-01-23)
+----------------
+
+- Update jquery UI autocomplete to 1.10.3 and use latest jquery ui boostrap
+  styles.
+  [rnix, 2014-07-05]
+
+1.4.1
+-----
+
+- use ``yafowil.utils.attr_value`` wherever possible.
+  [rnix, 2012-10-25]
+
+1.4
+---
+
+- Add ``generic_required_extractor`` to extraction chain
+  [rnix, 2012-07-25]
+
+- Adopt resource providing
+  [rnix, 2012-06-12]
+
+- Remove example app
+  [rnix, 2012-06-12]
+
+1.3
+---
+
+- Support JavaScript callback functions in source attribute
+  [rnix, 2011-10-03]
+
+- register autocomplete binder in ``yafowil.widget.array`` hooks if installed
+  [rnix, 2011-10-03]
+
+- register plan and depend on yafowil 1.3
+  [jensens, 2011-09-30]
+
+1.2
+---
+
+- adopt to yafowil 1.2
+  [jensens, 2011-09-20]
+
+- resource available in plain Zope2
+  [jensens, 2011-09-20]
+
+1.1
+---
+
+- adopt to yafowil 1.1
+  [rnix, 2011-07-08]
+
+1.0.1
+-----
+
+- test coverage
+  [rnix, 2011-05-07]
+
+1.0
+---
+
+- made it work
+  [jensens, 2010-11-24]
+
+
+License
+=======
+
+Copyright (c) 2010-2021, BlueDynamics Alliance, Austria, Germany, Switzerland
+Copyright (c) 2021-2022, Yafowil Contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

yafowil.widget.autocomplete-2.0a1.dist-info/RECORD

@@ -0,0 +1,15 @@
+yafowil.widget.autocomplete-2.0a1-py3.9-nspkg.pth,sha256=qMztS1qcT3Izik2RG40diPoBu5UBjZngpO4B5vlyj2I,1032
+yafowil/widget/autocomplete/__init__.py,sha256=Td_ploHAruVP8scuFhcpTrh5gb8VNIEKZzzhYFGv08I,1644
+yafowil/widget/autocomplete/example.py,sha256=XfxLIZZr-1vchDMQBAw4pl5bW2cwbJgKPyC1QWQnsU8,4055
+yafowil/widget/autocomplete/tests.py,sha256=Zeo63EpkxAiTcrrvJsDwuZpWVKQ02LPri5x3unQ1Yv0,5637
+yafowil/widget/autocomplete/widget.py,sha256=K1VXmLlyxkWy74xXQCpCTRon-GyxmiMTFPd_9yO9hY0,2432
+yafowil/widget/autocomplete/resources/widget.css,sha256=T2WDambBG4WZnGNxN_07EMCIFZ574J5QeeTCmR6TNDs,625
+yafowil/widget/autocomplete/resources/widget.js,sha256=P35IQ3P5YHWy1zxtzy6aaxOSUvmf7wXXMP_r-zUYX7w,13530
+yafowil/widget/autocomplete/resources/widget.min.js,sha256=BdjBUTg83ReDi0sj1uMiIRfzC35dLMxe7J_3B_zWyXM,5967
+yafowil.widget.autocomplete-2.0a1.dist-info/LICENSE.rst,sha256=voySO5bColCbsIXQyWy4yWhSk5DULUYHeiQ121Vh3fU,1403
+yafowil.widget.autocomplete-2.0a1.dist-info/METADATA,sha256=yzK9GCyjTLnMiYIVoqNpoeO4le9D604c1rcFKycRZcw,4629
+yafowil.widget.autocomplete-2.0a1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+yafowil.widget.autocomplete-2.0a1.dist-info/entry_points.txt,sha256=OqVe3M8KB75CHP8cJicoLRsFWtv12qlibX1P1PYCXRU,123
+yafowil.widget.autocomplete-2.0a1.dist-info/namespace_packages.txt,sha256=oTPEdRfMCGNcZRcF2Y0ULt8JBOUbIGRQHpcQ3vb_vXQ,23
+yafowil.widget.autocomplete-2.0a1.dist-info/top_level.txt,sha256=cJz5CZEzEKmMv88hkEh5t8fW1bRvd7Dv6VZ7l6RpqUA,8
+yafowil.widget.autocomplete-2.0a1.dist-info/RECORD,,

yafowil.widget.autocomplete-2.0a1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.43.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

yafowil.widget.autocomplete-2.0a1.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[yafowil.plugin]
+example = yafowil.widget.autocomplete.example:get_example
+register = yafowil.widget.autocomplete:register

yafowil.widget.autocomplete-2.0a1.dist-info/namespace_packages.txt

@@ -0,0 +1,2 @@
+yafowil
+yafowil.widget

yafowil.widget.autocomplete-2.0a1.dist-info/top_level.txt

@@ -0,0 +1 @@
+yafowil