global helper functions need to have grep-able names, i.e. a little bit longer

[myslice.git] / manifold / js / plugin.js

diff --git a/manifold/js/plugin.js b/manifold/js/plugin.js
index 84ebbc4..5b8eff6 100644 (file)
--- a/manifold/js/plugin.js
+++ b/manifold/js/plugin.js
@@ -22,8 +22,7 @@ $.plugin = function(name, object) {
 
 var Plugin = Class.extend({
 
-    init: function(options, element)
-    {
+    init: function(options, element) {
         // Mix in the passed in options with the default options
         this.options = $.extend({}, this.default_options, options);
 
@@ -40,35 +39,34 @@ var Plugin = Class.extend({
         return (typeof this.on_filter_added === 'function');
     },
 
-    _query_handler: function(e, event_type, data)
-    {
+    _query_handler: function(prefix, event_type, data) {
         // We suppose this.query_handler_prefix has been defined if this
         // callback is triggered    
         var fn;
         switch(event_type) {
-            case FILTER_ADDED:
-                fn = 'filter_added';
-                break;
-            case FILTER_REMOVED:
-                fn = 'filter_removed';
-                break;
-            case CLEAR_FILTERS:
-                fn = 'filter_clear';
-                break;
-            case FIELD_ADDED:
-                fn = 'field_added';
-                break;
-            case FIELD_REMOVED:
-                fn = 'field_removed';
-                break;
-            case CLEAR_FIELDS:
-                fn = 'field_clear';
-                break;
-            default:
-                return;
+        case FILTER_ADDED:
+            fn = 'filter_added';
+            break;
+        case FILTER_REMOVED:
+            fn = 'filter_removed';
+            break;
+        case CLEAR_FILTERS:
+            fn = 'filter_clear';
+            break;
+        case FIELD_ADDED:
+            fn = 'field_added';
+            break;
+        case FIELD_REMOVED:
+            fn = 'field_removed';
+            break;
+        case CLEAR_FIELDS:
+            fn = 'field_clear';
+            break;
+        default:
+            return;
         } // switch
         
-        fn = 'on_' + this.query_handler_prefix + fn;
+        fn = 'on_' + prefix + fn;
         if (typeof this[fn] === 'function') {
             // call with data as parameter
             // XXX implement anti loop
@@ -76,17 +74,58 @@ var Plugin = Class.extend({
         }
     },
 
+    _record_handler: function(prefix, event_type, record) {
+        // We suppose this.query_handler_prefix has been defined if this
+        // callback is triggered    
+        var fn;
+        switch(event_type) {
+        case NEW_RECORD:
+            fn = 'new_record';
+            break;
+        case CLEAR_RECORDS:
+            fn = 'clear_records';
+            break;
+        case IN_PROGRESS:
+            fn = 'query_in_progress';
+            break;
+        case DONE:
+            fn = 'query_done';
+            break;
+        case FIELD_STATE_CHANGED:
+            fn = 'field_state_changed';
+            break;
+        default:
+            return;
+        } // switch
+        
+        fn = 'on_' + prefix + fn;
+        if (typeof this[fn] === 'function') {
+            // call with data as parameter
+            // XXX implement anti loop
+            this[fn](record);
+        }
+    },
+
+    get_handler_function: function(type, prefix) {
+        
+        return $.proxy(function(e, event_type, record) {
+            return this['_' + type + '_handler'](prefix, event_type, record);
+        }, this);
+    },
+
     listen_query: function(query_uuid, prefix) {
-        this.query_handler_prefix = (typeof prefix === 'undefined') ? '' : (prefix + manifold.separator);
-        this.$element.on(manifold.get_query_channel(query_uuid), $.proxy(this._query_handler, this));
+        // default: prefix = ''
+        prefix = (typeof prefix === 'undefined') ? '' : (prefix + '_');
+
+        this.$element.on(manifold.get_channel('query', query_uuid),  this.get_handler_function('query',  prefix));
+        this.$element.on(manifold.get_channel('record', query_uuid),  this.get_handler_function('record', prefix));
     },
 
     default_options: {},
 
     /* Helper functions for naming HTML elements (ID, classes), with support for filters and fields */
 
-    id: function()
-    {
+    id: function() {
         var ret = this.options.plugin_uuid;
         for (var i = 0; i < arguments.length; i++) {
             ret = ret + manifold.separator + arguments[i];
@@ -94,8 +133,7 @@ var Plugin = Class.extend({
         return ret;
     },
 
-    el: function()
-    {
+    el: function() {
         if (arguments.length == 0) {
             return $('#' + this.id());
         } else {
@@ -104,13 +142,11 @@ var Plugin = Class.extend({
         }
     },
 
-    els: function(cls)
-    {
+    elts: function(cls) {
         return $('.' + cls, this.el());
     },
 
-    id_from_filter: function(filter, use_value)
-    {
+    id_from_filter: function(filter, use_value) {
         use_value = typeof use_value !== 'undefined' ? use_value : true;
 
         var key    = filter[0];
@@ -126,25 +162,21 @@ var Plugin = Class.extend({
         }
     },
 
-    str_from_filter: function(filter)
-    {
+    str_from_filter: function(filter) {
         return filter[0] + ' ' + filter[1] + ' ' + filter[2];
     },
 
-    array_from_id: function(id)
-    {
+    array_from_id: function(id) {
         var ret = id.split(manifold.separator);
         ret.shift(); // remove plugin_uuid at the beginning
         return ret;
     },
 
-    id_from_field: function(field)
-    {
+    id_from_field: function(field) {
         return 'field' + manifold.separator + field;
     },
 
-    field_from_id: function(id)
-    {
+    field_from_id: function(id) {
         var array;
         if (typeof id === 'string') {
             array = id.split(manifold.separator);
@@ -155,4 +187,59 @@ var Plugin = Class.extend({
         return array[1];
     },
 
+    id_from_key: function(key_field, value) {
+        
+        return key_field + manifold.separator + unfold.escape_id(value).replace(/\\/g, '');
+    },
+
+    id_from_record: function(method, record) {
+        var keys = manifold.metadata.get_key(method);
+        if (!keys)
+            return;
+        if (keys.length > 1)
+            return;
+
+        var key = keys[0];
+        switch (Object.toType(key)) {
+        case 'string':
+            if (!(key in record))
+                return null;
+            return this.id_from_key(key, record[key]);
+           
+        default:
+            throw 'Not implemented';
+        }
+    },
+
+    key_from_id: function(id) {
+        // NOTE this works only for simple keys
+
+        var array;
+        if (typeof id === 'string') {
+            array = id.split(manifold.separator);
+        } else { // We suppose we have an array ('object')
+            array = id;
+        }
+
+        // arguments has the initial id but lacks the key field name (see id_from_key), so we are even
+        // we finally add +1 for the plugin_uuid at the beginning
+        return array[arguments.length + 1];
+    },
+
+    /* SPIN */
+
+    spin: function() {
+        manifold.spin(this.element);
+    },
+
+    unspin: function() {
+        manifold.spin(this.element, false);
+    },
+
+    /* TEMPLATE */
+
+    load_template: function(name, ctx) {
+        return Mustache.render(this.el(name).html(), ctx);
+    },
+
 });