[exemples] Add officejs scenario

examples/ojs_storages.js

+/*jslint indent:2, maxlen: 80, nomen: true */
+/*global jIO, RSVP, UriTemplate, SimpleQuery, ComplexQuery, QueryFactory,
+  Query, FormData*/
+(function (jIO, RSVP, UriTemplate, SimpleQuery, ComplexQuery, QueryFactory,
+  Query, FormData) {
+  "use strict";
+
+  function getSubIdEqualSubProperty(storage, value, key) {
+    var query;
+    if (storage._no_sub_query_id) {
+      throw new jIO.util.jIOError('no sub query id active', 404);
+    }
+    query = new SimpleQuery({
+      key: key,
+      value: value,
+      type: "simple"
+    });
+    if (storage._query.query !== undefined) {
+      query = new ComplexQuery({
+        operator: "AND",
+        query_list: [query, storage._query.query],
+        type: "complex"
+      });
+    }
+    query = Query.objectToSearchText(query);
+    return storage._sub_storage.allDocs({
+      "query": query,
+      "sort_on": storage._query.sort_on,
+      "select_list": storage._query.select_list,
+      "limit": storage._query.limit
+    })
+      .push(function (data) {
+        if (data.data.rows.length === 0) {
+          throw new jIO.util.jIOError(
+            "Can not find id",
+            404
+          );
+        }
+        if (data.data.rows.length > 1) {
+          throw new TypeError("id must be unique field: " + key
+            + ", result:" + data.data.rows.toString());
+        }
+        return data.data.rows[0].id;
+      });
+  }
+
+  /*jslint unparam: true*/
+  var mapping_function = {
+    "equalSubProperty": {
+      "mapToSubProperty": function (property, sub_doc, doc, args, id) {
+        sub_doc[args] = doc[property];
+        return args;
+      },
+      "mapToMainProperty": function (property, sub_doc, doc, args, sub_id) {
+        if (sub_doc.hasOwnProperty(args)) {
+          doc[property] = sub_doc[args];
+        }
+        return args;
+      },
+      "mapToSubId": function (storage, doc, id, args) {
+        if (doc !== undefined) {
+          if (storage._property_for_sub_id &&
+              doc.hasOwnProperty(storage._property_for_sub_id)) {
+            return doc[storage._property_for_sub_id];
+          }
+        }
+        return getSubIdEqualSubProperty(storage, id, storage._map_id[1]);
+      },
+      "mapToId": function (storage, sub_doc, sub_id, args) {
+        return sub_doc[args];
+      }
+    },
+    "equalValue": {
+      "mapToSubProperty": function (property, sub_doc, doc, args) {
+        sub_doc[property] = args;
+        return property;
+      },
+      "mapToMainProperty": function (property) {
+        return property;
+      }
+    },
+    "ignore": {
+      "mapToSubProperty": function () {
+        return false;
+      },
+      "mapToMainProperty": function (property) {
+        return property;
+      }
+    },
+    "equalSubId": {
+      "mapToSubProperty": function (property, sub_doc, doc) {
+        sub_doc[property] = doc[property];
+        return property;
+      },
+      "mapToMainProperty": function (property, sub_doc, doc, args, sub_id) {
+        if (sub_id === undefined && sub_doc.hasOwnProperty(property)) {
+          doc[property] = sub_doc[property];
+        } else {
+          doc[property] = sub_id;
+        }
+        return property;
+      },
+      "mapToSubId": function (storage, doc, id, args) {
+        return id;
+      },
+      "mapToId": function (storage, sub_doc, sub_id) {
+        return sub_id;
+      }
+    },
+    "keep": {
+      "mapToSubProperty": function (property, sub_doc, doc) {
+        sub_doc[property] = doc[property];
+        return property;
+      },
+      "mapToMainProperty": function (property, sub_doc, doc) {
+        doc[property] = sub_doc[property];
+        return property;
+      }
+    },
+    "switchPropertyValue": {
+      "mapToSubProperty": function (property, sub_doc, doc, args) {
+        sub_doc[args[0]] = args[1][doc[property]];
+        return args[0];
+      },
+      "mapToMainProperty": function (property, sub_doc, doc, args) {
+        var subvalue, value = sub_doc[args[0]];
+        for (subvalue in args[1]) {
+          if (args[1].hasOwnProperty(subvalue)) {
+            if (value === args[1][subvalue]) {
+              doc[property] = subvalue;
+              return property;
+            }
+          }
+        }
+      }
+    }
+  };
+  /*jslint unparam: false*/
+
+  function initializeQueryAndDefaultMapping(storage) {
+    var property, query_list = [];
+    for (property in storage._mapping_dict) {
+      if (storage._mapping_dict.hasOwnProperty(property)) {
+        if (storage._mapping_dict[property][0] === "equalValue") {
+          if (storage._mapping_dict[property][1] === undefined) {
+            throw new jIO.util.jIOError("equalValue has not parameter", 400);
+          }
+          storage._default_mapping[property] =
+            storage._mapping_dict[property][1];
+          query_list.push(new SimpleQuery({
+            key: property,
+            value: storage._mapping_dict[property][1],
+            type: "simple"
+          }));
+        }
+        if (storage._mapping_dict[property][0] === "equalSubId") {
+          if (storage._property_for_sub_id !== undefined) {
+            throw new jIO.util.jIOError(
+              "equalSubId can be defined one time",
+              400
+            );
+          }
+          storage._property_for_sub_id = property;
+        }
+      }
+    }
+    if (storage._query.query !== undefined) {
+      query_list.push(QueryFactory.create(storage._query.query));
+    }
+    if (query_list.length > 1) {
+      storage._query.query = new ComplexQuery({
+        type: "complex",
+        query_list: query_list,
+        operator: "AND"
+      });
+    } else if (query_list.length === 1) {
+      storage._query.query = query_list[0];
+    }
+  }
+
+  function MappingStorage(spec) {
+    this._mapping_dict = spec.property || {};
+    this._sub_storage = jIO.createJIO(spec.sub_storage);
+    this._map_all_property = spec.map_all_property !== undefined ?
+        spec.map_all_property : true;
+    this._no_sub_query_id = spec.no_sub_query_id;
+    this._attachment_mapping_dict = spec.attachment || {};
+    this._query = spec.query || {};
+    this._map_id = spec.id || ["equalSubId"];
+    this._id_mapped = (spec.id !== undefined) ? spec.id[1] : false;
+    this._attachment_list = spec.attachment_list || [];
+
+    if (this._query.query !== undefined) {
+      this._query.query = QueryFactory.create(this._query.query);
+    }
+    this._default_mapping = {};
+
+    initializeQueryAndDefaultMapping(this);
+  }
+
+  function getAttachmentId(storage, sub_id, attachment_id, method) {
+    var mapping_dict = storage._attachment_mapping_dict;
+    if (mapping_dict !== undefined
+        && mapping_dict[attachment_id] !== undefined
+        && mapping_dict[attachment_id][method] !== undefined) {
+      if (mapping_dict[attachment_id][method].uri_template !== undefined) {
+        return UriTemplate.parse(
+          mapping_dict[attachment_id][method].uri_template
+        ).expand({id: sub_id});
+      }
+    }
+    return attachment_id;
+  }
+
+  function getSubStorageId(storage, id, doc) {
+    return new RSVP.Queue()
+      .push(function () {
+        var map_info = storage._map_id || ["equalSubId"];
+        if (storage._property_for_sub_id && doc !== undefined &&
+            doc.hasOwnProperty(storage._property_for_sub_id)) {
+          return doc[storage._property_for_sub_id];
+        }
+        return mapping_function[map_info[0]].mapToSubId(
+          storage,
+          doc,
+          id,
+          map_info[1]
+        );
+      });
+  }
+
+  function mapToSubProperty(storage, property, sub_doc, doc, id) {
+    var mapping_info = storage._mapping_dict[property] || ["keep"];
+    return mapping_function[mapping_info[0]].mapToSubProperty(
+      property,
+      sub_doc,
+      doc,
+      mapping_info[1],
+      id
+    );
+  }
+
+  function mapToMainProperty(storage, property, sub_doc, doc, sub_id) {
+    var mapping_info = storage._mapping_dict[property] || ["keep"];
+    return mapping_function[mapping_info[0]].mapToMainProperty(
+      property,
+      sub_doc,
+      doc,
+      mapping_info[1],
+      sub_id
+    );
+  }
+
+  function mapToMainDocument(storage, sub_doc, sub_id) {
+    var doc = {},
+      property,
+      property_list = [storage._id_mapped];
+    for (property in storage._mapping_dict) {
+      if (storage._mapping_dict.hasOwnProperty(property)) {
+        property_list.push(mapToMainProperty(
+          storage,
+          property,
+          sub_doc,
+          doc,
+          sub_id
+        ));
+      }
+    }
+    if (storage._map_all_property) {
+      for (property in sub_doc) {
+        if (sub_doc.hasOwnProperty(property)) {
+          if (property_list.indexOf(property) < 0) {
+            doc[property] = sub_doc[property];
+          }
+        }
+      }
+    }
+    if (storage._map_for_sub_storage_id !== undefined) {
+      doc[storage._map_for_sub_storage_id] = sub_id;
+    }
+    return doc;
+  }
+
+  function mapToSubstorageDocument(storage, doc, id) {
+    var sub_doc = {}, property;
+
+    for (property in doc) {
+      if (doc.hasOwnProperty(property)) {
+        mapToSubProperty(storage, property, sub_doc, doc, id);
+      }
+    }
+    for (property in storage._default_mapping) {
+      if (storage._default_mapping.hasOwnProperty(property)) {
+        sub_doc[property] = storage._default_mapping[property];
+      }
+    }
+    if (storage._map_id[0] === "equalSubProperty" && id !== undefined) {
+      sub_doc[storage._map_id[1]] = id;
+    }
+    return sub_doc;
+  }
+
+  function handleAttachment(storage, argument_list, method) {
+    return getSubStorageId(storage, argument_list[0])
+      .push(function (sub_id) {
+        argument_list[0] = sub_id;
+        var old_id = argument_list[1];
+        argument_list[1] = getAttachmentId(
+          storage,
+          argument_list[0],
+          argument_list[1],
+          method
+        );
+        if (storage._attachment_list.length > 0
+            && storage._attachment_list.indexOf(old_id) < 0) {
+          if (method === "get") {
+            throw new jIO.util.jIOError("unhautorized attachment", 404);
+          }
+          return;
+        }
+        return storage._sub_storage[method + "Attachment"].apply(
+          storage._sub_storage,
+          argument_list
+        );
+      });
+  }
+
+  MappingStorage.prototype.get = function (id) {
+    var storage = this;
+    return getSubStorageId(this, id)
+      .push(function (sub_id) {
+        return storage._sub_storage.get(sub_id)
+          .push(function (sub_doc) {
+            return mapToMainDocument(storage, sub_doc, sub_id);
+          });
+      });
+  };
+
+  MappingStorage.prototype.post = function (doc) {
+    var sub_doc = mapToSubstorageDocument(
+      this,
+      doc
+    ),
+      id = doc[this._property_for_sub_id];
+    if (this._property_for_sub_id && id !== undefined) {
+      return this._sub_storage.put(id, sub_doc);
+    }
+    if (!this._id_mapped || doc[this._id_mapped] !== undefined) {
+      return this._sub_storage.post(sub_doc);
+    }
+    throw new jIO.util.jIOError(
+      "post is not supported with id mapped",
+      400
+    );
+  };
+
+  MappingStorage.prototype.put = function (id, doc) {
+    var storage = this,
+      sub_doc = mapToSubstorageDocument(this, doc, id);
+    return getSubStorageId(this, id, doc)
+      .push(function (sub_id) {
+        return storage._sub_storage.put(sub_id, sub_doc);
+      })
+      .push(undefined, function (error) {
+        if (error instanceof jIO.util.jIOError && error.status_code === 404) {
+          return storage._sub_storage.post(sub_doc);
+        }
+        throw error;
+      })
+      .push(function () {
+        return id;
+      });
+  };
+
+  MappingStorage.prototype.remove = function (id) {
+    var storage = this;
+    return getSubStorageId(this, id)
+      .push(function (sub_id) {
+        return storage._sub_storage.remove(sub_id);
+      })
+      .push(function () {
+        return id;
+      });
+  };
+
+  MappingStorage.prototype.putAttachment = function (id, attachment_id, blob) {
+    var storage = this,
+      mapping_dict = storage._attachment_mapping_dict;
+    // THIS IS REALLY BAD, FIND AN OTHER WAY IN FUTURE
+    if (mapping_dict !== undefined
+        && mapping_dict[attachment_id] !== undefined
+        && mapping_dict[attachment_id].put !== undefined
+        && mapping_dict[attachment_id].put.erp5_put_template !== undefined) {
+      return new RSVP.Queue()
+        .push(function () {
+          return RSVP.all([
+            getSubStorageId(storage, id),
+            storage.get(id)
+          ]);
+        })
+        .push(function (result) {
+          var sub_id = result[0],
+            doc = result[1],
+            url = UriTemplate.parse(
+              mapping_dict[attachment_id].put.erp5_put_template
+            ).expand({id: sub_id}),
+            data = new FormData();
+          if (doc.filename) {
+            data.append("field_my_file", blob, doc.filename);
+          } else {
+            data.append("field_my_file", blob);
+          }
+          data.append("form_id", "File_view");
+          return jIO.util.ajax({
+            "type": "POST",
+            "url": url,
+            "data": data,
+            "xhrFields": {
+              withCredentials: true
+            }
+          });
+        });
+    }
+    return handleAttachment(this, arguments, "put", id)
+      .push(function () {
+        return attachment_id;
+      });
+  };
+
+  MappingStorage.prototype.getAttachment = function () {
+    return handleAttachment(this, arguments, "get");
+  };
+
+  MappingStorage.prototype.removeAttachment = function (id, attachment_id) {
+    return handleAttachment(this, arguments, "remove", id)
+      .push(function () {
+        return attachment_id;
+      });
+  };
+
+  MappingStorage.prototype.allAttachments = function (id) {
+    var storage = this, sub_id;
+    return getSubStorageId(storage, id)
+      .push(function (sub_id_result) {
+        sub_id = sub_id_result;
+        return storage._sub_storage.allAttachments(sub_id);
+      })
+      .push(function (result) {
+        var attachment_id,
+          attachments = {},
+          mapping_dict = {},
+          i;
+        for (attachment_id in storage._attachment_mapping_dict) {
+          if (storage._attachment_mapping_dict.hasOwnProperty(attachment_id)) {
+            mapping_dict[getAttachmentId(storage, sub_id, attachment_id, "get")]
+              = attachment_id;
+          }
+        }
+        for (attachment_id in result) {
+          if (result.hasOwnProperty(attachment_id)) {
+            if (!(storage._attachment_list.length > 0
+                && storage._attachment_list.indexOf(attachment_id) < 0)) {
+              if (mapping_dict.hasOwnProperty(attachment_id)) {
+                attachments[mapping_dict[attachment_id]] = {};
+              } else {
+                attachments[attachment_id] = {};
+              }
+            }
+          }
+        }
+        for (i = 0; i < storage._attachment_list.length; i += 1) {
+          if (!attachments.hasOwnProperty(storage._attachment_list[i])) {
+            attachments[storage._attachment_list[i]] = {};
+          }
+        }
+        return attachments;
+      });
+  };
+
+  MappingStorage.prototype.hasCapacity = function (name) {
+    return this._sub_storage.hasCapacity(name);
+  };
+
+  MappingStorage.prototype.repair = function () {
+    return this._sub_storage.repair.apply(this._sub_storage, arguments);
+  };
+
+  MappingStorage.prototype.bulk = function (id_list) {
+    var storage = this;
+
+    function mapId(parameter) {
+      return getSubStorageId(storage, parameter.parameter_list[0])
+        .push(function (id) {
+          return {"method": parameter.method, "parameter_list": [id]};
+        });
+    }
+
+    return new RSVP.Queue()
+      .push(function () {
+        var promise_list = id_list.map(mapId);
+        return RSVP.all(promise_list);
+      })
+      .push(function (id_list_mapped) {
+        return storage._sub_storage.bulk(id_list_mapped);
+      })
+      .push(function (result) {
+        var mapped_result = [], i;
+        for (i = 0; i < result.length; i += 1) {
+          mapped_result.push(mapToMainDocument(
+            storage,
+            result[i]
+          ));
+        }
+        return mapped_result;
+      });
+  };
+
+  MappingStorage.prototype.buildQuery = function (option) {
+    var storage = this,
+      i,
+      query,
+      property,
+      select_list = [],
+      sort_on = [];
+
+    function mapQuery(one_query) {
+      var j, query_list = [], key, sub_query;
+      if (one_query.type === "complex") {
+        for (j = 0; j < one_query.query_list.length; j += 1) {
+          sub_query = mapQuery(one_query.query_list[j]);
+          if (sub_query) {
+            query_list.push(sub_query);
+          }
+        }
+        one_query.query_list = query_list;
+        return one_query;
+      }
+      key = mapToMainProperty(storage, one_query.key, {}, {});
+      if (key !== undefined) {
+        one_query.key = key;
+        return one_query;
+      }
+      return false;
+    }
+
+    if (option.sort_on !== undefined) {
+      for (i = 0; i < option.sort_on.length; i += 1) {
+        property = mapToMainProperty(this, option.sort_on[i][0], {}, {});
+        if (property && sort_on.indexOf(property) < 0) {
+          sort_on.push([property, option.sort_on[i][1]]);
+        }
+      }
+    }
+    if (this._query.sort_on !== undefined) {
+      for (i = 0; i < this._query.sort_on.length; i += 1) {
+        property = mapToMainProperty(this, this._query.sort_on[i], {}, {});
+        if (sort_on.indexOf(property) < 0) {
+          sort_on.push([property, option.sort_on[i][1]]);
+        }
+      }
+    }
+    if (option.select_list !== undefined) {
+      for (i = 0; i < option.select_list.length; i += 1) {
+        property = mapToMainProperty(this, option.select_list[i], {}, {});
+        if (property && select_list.indexOf(property) < 0) {
+          select_list.push(property);
+        }
+      }
+    }
+    if (this._query.select_list !== undefined) {
+      for (i = 0; i < this._query.select_list; i += 1) {
+        property = this._query.select_list[i];
+        if (select_list.indexOf(property) < 0) {
+          select_list.push(property);
+        }
+      }
+    }
+    if (this._id_mapped) {
+      // modify here for future way to map id
+      select_list.push(this._id_mapped);
+    }
+    if (option.query !== undefined) {
+      query = mapQuery(QueryFactory.create(option.query));
+    }
+
+    if (this._query.query !== undefined) {
+      if (query === undefined) {
+        query = this._query.query;
+      }
+      query = new ComplexQuery({
+        operator: "AND",
+        query_list: [query, this._query.query],
+        type: "complex"
+      });
+    }
+
+    if (query !== undefined) {
+      query = Query.objectToSearchText(query);
+    }
+    return this._sub_storage.allDocs(
+      {
+        query: query,
+        select_list: select_list,
+        sort_on: sort_on,
+        limit: option.limit
+      }
+    )
+      .push(function (result) {
+        var sub_doc, map_info = storage._map_id || ["equalSubId"];
+        for (i = 0; i < result.data.total_rows; i += 1) {
+          sub_doc = result.data.rows[i].value;
+          result.data.rows[i].id =
+            mapping_function[map_info[0]].mapToId(
+              storage,
+              sub_doc,
+              result.data.rows[i].id,
+              map_info[1]
+            );
+          result.data.rows[i].value =
+            mapToMainDocument(
+              storage,
+              sub_doc
+            );
+        }
+        return result.data.rows;
+      });
+  };
+
+  jIO.addStorage('mapping', MappingStorage);
+}(jIO, RSVP, UriTemplate, SimpleQuery, ComplexQuery, QueryFactory, Query,
+  FormData));
+/*jslint nomen: true*/
+(function (jIO) {
+  "use strict";
+
+  /**
+   * The jIO DateUpdaterStorage extension
+   *
+   * @class DateUpdaterStorage
+   * @constructor
+   */
+
+  function updateDocument(doc, property_list) {
+    var i, len = property_list.length;
+    for (i = 0; i < len; i += 1) {
+      doc[property_list[i]] = new Date().toUTCString().replace('GMT', '+0000');
+    }
+    return doc;
+  }
+
+  function DateUpdaterStorage(spec) {
+    this._sub_storage = jIO.createJIO(spec.sub_storage);
+    this._property_list = spec.property_list || [];
+  }
+
+  DateUpdaterStorage.prototype.get = function () {
+    return this._sub_storage.get.apply(this._sub_storage, arguments);
+  };
+  DateUpdaterStorage.prototype.allAttachments = function () {
+    return this._sub_storage.allAttachments.apply(this._sub_storage, arguments);
+  };
+  DateUpdaterStorage.prototype.post = function (doc) {
+    doc = updateDocument(doc, this._property_list);
+    return this._sub_storage.post(doc);
+  };
+  DateUpdaterStorage.prototype.put = function (id, doc) {
+    doc = updateDocument(doc, this._property_list);
+    return this._sub_storage.put(id, doc);
+  };
+  DateUpdaterStorage.prototype.remove = function () {
+    return this._sub_storage.remove.apply(this._sub_storage, arguments);
+  };
+  DateUpdaterStorage.prototype.getAttachment = function () {
+    return this._sub_storage.getAttachment.apply(this._sub_storage, arguments);
+  };
+  DateUpdaterStorage.prototype.putAttachment = function (id) {
+    var storage = this, argument_list = arguments;
+    return storage.get(id)
+      .push(function (doc) {
+        return storage.put(id, doc);
+      })
+      .push(function () {
+        return storage._sub_storage.putAttachment.apply(
+          storage._sub_storage,
+          argument_list
+        );
+      });
+  };
+  DateUpdaterStorage.prototype.removeAttachment = function (id) {
+    var storage = this, argument_list = arguments;
+    return storage.get(id)
+      .push(function (doc) {
+        return storage.put(id, doc);
+      })
+      .push(function () {
+        return storage._sub_storage.removeAttachment.apply(
+          storage._sub_storage,
+          argument_list
+        );
+      });
+  };
+  DateUpdaterStorage.prototype.repair = function () {
+    return this._sub_storage.repair.apply(this._sub_storage, arguments);
+  };
+  DateUpdaterStorage.prototype.hasCapacity = function (name) {
+    return this._sub_storage.hasCapacity(name);
+  };
+  DateUpdaterStorage.prototype.buildQuery = function () {
+    return this._sub_storage.buildQuery.apply(this._sub_storage,
+                                              arguments);
+  };
+
+  jIO.addStorage('dateupdater', DateUpdaterStorage);
+
+}(jIO));
+
+/*jslint nomen: true*/
+(function (jIO) {
+  "use strict";
+
+  /**
+   * The jIO SafeRepairStorage extension
+   *
+   * @class SafeRepairStorage
+   * @constructor
+   */
+
+
+  function SafeRepairStorage(spec) {
+    this._sub_storage = jIO.createJIO(spec.sub_storage);
+    this._id_dict = {};
+  }
+
+  SafeRepairStorage.prototype.get = function () {
+    return this._sub_storage.get.apply(this._sub_storage, arguments);
+  };
+  SafeRepairStorage.prototype.allAttachments = function () {
+    return this._sub_storage.allAttachments.apply(this._sub_storage, arguments);
+  };
+  SafeRepairStorage.prototype.post = function () {
+    return this._sub_storage.post.apply(this._sub_storage, arguments);
+  };
+  SafeRepairStorage.prototype.put = function (id, doc) {
+    var storage = this;
+    return this._sub_storage.put.apply(this._sub_storage, arguments)
+      .push(undefined, function (error) {
+        if (error instanceof jIO.util.jIOError &&
+            error.status_code === 403) {
+          if (storage._id_dict[id]) {
+            return storage._sub_storage.put(storage._id_dict[id], doc);
+          }
+          return storage._sub_storage.post(doc)
+            .push(function (sub_id) {
+              storage._id_dict[id] = sub_id;
+              return sub_id;
+            });
+        }
+      });
+  };
+  SafeRepairStorage.prototype.remove = function () {
+    return;
+  };
+  SafeRepairStorage.prototype.getAttachment = function () {
+    return this._sub_storage.getAttachment.apply(this._sub_storage, arguments);
+  };
+  SafeRepairStorage.prototype.putAttachment = function (id, attachment_id,
+      attachment) {
+    var storage = this;
+    return this._sub_storage.putAttachment.apply(this._sub_storage, arguments)
+      .push(undefined, function (error) {
+        if (error instanceof jIO.util.jIOError &&
+            error.status_code === 403) {
+          return new RSVP.Queue()
+            .push(function () {
+              if (storage._id_dict[id]) {
+                return storage._id_dict[id];
+              }
+              return storage._sub_storage.get(id)
+                .push(function (doc) {
+                  return storage._sub_storage.post(doc);
+                });
+            })
+            .push(function (sub_id) {
+              storage._id_dict[id] = sub_id;
+              return storage._sub_storage.putAttachment(sub_id, attachment_id,
+                  attachment);
+            });
+        }
+      });
+  };
+  SafeRepairStorage.prototype.removeAttachment = function () {
+    return;
+  };
+  SafeRepairStorage.prototype.repair = function () {
+    return this._sub_storage.repair.apply(this._sub_storage, arguments);
+  };
+  SafeRepairStorage.prototype.hasCapacity = function (name) {
+    return this._sub_storage.hasCapacity(name);
+  };
+  SafeRepairStorage.prototype.buildQuery = function () {
+    return this._sub_storage.buildQuery.apply(this._sub_storage,
+                                              arguments);
+  };
+
+  jIO.addStorage('saferepair', SafeRepairStorage);
+
+}(jIO));
\ No newline at end of file

examples/scenario_officejs.html

+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>OfficeJS Coverage Scenario</title>
+
+  <script src="../node_modules/rsvp/dist/rsvp-2.0.4.js"></script>
+  <script src="../dist/jio-latest.js"></script>
+  <script src="ojs_storages.js"></script>
+
+  <link rel="stylesheet" href="../node_modules/grunt-contrib-qunit/test/libs/qunit.css" type="text/css" media="screen"/>
+  <script src="../node_modules/grunt-contrib-qunit/test/libs/qunit.js" type="text/javascript"></script>
+  <script src="scenario_officejs.js"></script>
+</head>
+
+<body>
+  <h1 id="qunit-header">OfficeJS Coverage Scenario</h1>
+  <h2 id="qunit-banner"></h2>
+  <div id="qunit-testrunner-toolbar"></div>
+  <h2 id="qunit-userAgent"></h2>
+  <ol id="qunit-tests"></ol>
+  <div id="qunit-fixture">test markup, will be hidden</div>
+</body>
+</html>
\ No newline at end of file

examples/scenario_officejs.js

+/*global Blob*/
+/*jslint nomen: true, maxlen: 80*/
+(function (QUnit, jIO, Blob) {
+  "use strict";
+  var test = QUnit.test,
+    // equal = QUnit.equal,
+    expect = QUnit.expect,
+    ok = QUnit.ok,
+    stop = QUnit.stop,
+    start = QUnit.start,
+    deepEqual = QUnit.deepEqual,
+    module = QUnit.module,
+    ATTACHMENT = 'data',
+    i,
+    name_list = ['get', 'post', 'put', 'buildQuery',
+                  'putAttachment', 'getAttachment', 'allAttachments'];
+
+  ///////////////////////////////////////////////////////
+  // Fake Storage
+  ///////////////////////////////////////////////////////
+  function resetCount(count) {
+    for (i = 0; i < name_list.length; i += 1) {
+      count[name_list[i]] = 0;
+    }
+  }
+
+  function MockStorage(spec) {
+    this._erp5_storage = jIO.createJIO({
+      type: "erp5",
+      url: "http://example.org"
+    });
+    this._sub_storage = jIO.createJIO({
+      type: "query",
+      sub_storage: {
+        type: "uuid",
+        sub_storage: {
+          type: "memory"
+        }
+      }
+    });
+    this._options = spec.options;
+    resetCount(spec.options.count);
+  }
+
+  function mockFunction(name) {
+    MockStorage.prototype[name] = function () {
+      this._options.count[name] += 1;
+      if (this._options.mock.hasOwnProperty(name)) {
+        return this._options.mock[name].apply(this, arguments);
+      }
+      return this._sub_storage[name].apply(this._sub_storage, arguments);
+    };
+  }
+
+  for (i = 0; i < name_list.length; i += 1) {
+    mockFunction(name_list[i]);
+  }
+
+  MockStorage.prototype.hasCapacity = function (name) {
+    return this._erp5_storage.hasCapacity(name);
+  };
+
+  jIO.addStorage('mock', MockStorage);
+
+  ///////////////////////////////////////////////////////
+  // Helpers
+  ///////////////////////////////////////////////////////
+  function putFullDoc(storage, id, doc, attachment) {
+    return storage.put(id, doc)
+      .push(function () {
+        return storage.putAttachment(
+          id,
+          ATTACHMENT,
+          attachment
+        );
+      });
+  }
+
+  function equalStorage(storage, doc_tuple_list) {
+    return storage.allDocs()
+      .push(function (result) {
+        var i,
+          promise_list = [];
+        for (i = 0; i < result.data.rows.length; i += 1) {
+          promise_list.push(RSVP.all([
+            result.data.rows[i].id,
+            storage.get(result.data.rows[i].id),
+            storage.getAttachment(result.data.rows[i].id, ATTACHMENT)
+          ]));
+        }
+        return RSVP.all(promise_list);
+      })
+      .push(function (result) {
+        deepEqual(result, doc_tuple_list, 'Storage content');
+      });
+  }
+
+  function isEmptyStorage(storage) {
+    return equalStorage(storage, []);
+  }
+
+  function equalRemoteStorageCallCount(mock_count, expected_count) {
+    for (i = 0; i < name_list.length; i += 1) {
+      if (!expected_count.hasOwnProperty(name_list[i])) {
+        expected_count[name_list[i]] = 0;
+      }
+    }
+    deepEqual(mock_count, expected_count, 'Expected method call count');
+  }
+
+  ///////////////////////////////////////////////////////
+  // Module
+  ///////////////////////////////////////////////////////
+  module("scenario_officejs", {
+    setup: function () {
+      this.remote_mock_options = {
+        mock: {
+          remove: function () {
+            throw new Error('remove not supported');
+          },
+          removeAttachment: function () {
+            throw new Error('removeAttachment not supported');
+          },
+          allAttachments: function () {
+            return {data: null};
+          },
+          post: function (doc) {
+            var context = this;
+            return this._sub_storage.post(doc)
+              .push(function (post_id) {
+                context._options.last_post_id = post_id;
+                return post_id;
+              });
+          }
+        },
+        count: {}
+      };
+      this.jio = jIO.createJIO({
+        type: "replicate",
+        query: {
+          query: 'portal_type:"Foo"',
+          sort_on: [["modification_date", "descending"]]
+        },
+        use_remote_post: true,
+        conflict_handling: 1,
+        signature_hash_key: 'modification_date',
+        check_local_attachment_modification: true,
+        check_local_attachment_creation: true,
+        check_remote_attachment_modification: true,
+        check_remote_attachment_creation: true,
+        check_remote_attachment_deletion: true,
+        check_local_deletion: false,
+        parallel_operation_amount: 10,
+        parallel_operation_attachment_amount: 10,
+        local_sub_storage: {
+          type: "query",
+          sub_storage: {
+            type: "uuid",
+            sub_storage: {
+              type: "memory"
+            }
+          }
+        },
+        signature_sub_storage: {
+          type: "query",
+          sub_storage: {
+            type: "memory"
+          }
+        },
+        remote_sub_storage: {
+          type: "saferepair",
+          sub_storage: {
+            type: "mock",
+            options: this.remote_mock_options
+          }
+        }
+      });
+    }
+  });
+
+  ///////////////////////////////////////////////////////
+  // Do nothing cases
+  ///////////////////////////////////////////////////////
+  test("empty: nothing to do", function () {
+    expect(2);
+    stop();
+
+    var test = this;
+
+    this.jio.repair()
+      .then(function () {
+        return RSVP.all([
+          isEmptyStorage(test.jio),
+          equalRemoteStorageCallCount(
+            test.remote_mock_options.count,
+            {buildQuery: 1}
+          )
+        ]);
+      })
+      .fail(function (error) {
+        ok(false, error);
+      })
+      .always(function () {
+        start();
+      });
+  });
+
+  test("allready synced: nothing to do", function () {
+    expect(2);
+    stop();
+
+    var test = this,
+      doc_id = 'foo_module/1',
+      doc = {title: doc_id, portal_type: "Foo", modification_date: 'a'},
+      blob = new Blob(['a']);
+
+    putFullDoc(this.jio.__storage._remote_sub_storage, doc_id, doc, blob)
+      .then(function () {
+        return test.jio.repair();
+      })
+      .then(function () {
+        resetCount(test.remote_mock_options.count);
+        return test.jio.repair();
+      })
+      .then(function () {
+        equalRemoteStorageCallCount(
+          test.remote_mock_options.count,
+          {buildQuery: 1}
+        );
+        return equalStorage(test.jio, [[doc_id, doc, blob]]);
+      })
+      .fail(function (error) {
+        ok(false, error);
+      })
+      .always(function () {
+        start();
+      });
+  });
+
+  ///////////////////////////////////////////////////////
+  // Remote creation
+  ///////////////////////////////////////////////////////
+  test("remote document creation: copy", function () {
+    expect(2);
+    stop();
+
+    var test = this,
+      doc_id = 'foo_module/1',
+      doc = {title: doc_id, portal_type: "Foo", modification_date: 'a'},
+      blob = new Blob(['a']);
+
+    putFullDoc(this.jio.__storage._remote_sub_storage, doc_id, doc, blob)
+      .then(function () {
+        resetCount(test.remote_mock_options.count);
+        return test.jio.repair();
+      })
+      .then(function () {
+        equalRemoteStorageCallCount(
+          test.remote_mock_options.count,
+          {buildQuery: 1, get: 1, getAttachment: 1, allAttachments: 1}
+        );
+        return equalStorage(test.jio, [[doc_id, doc, blob]]);
+      })
+      .fail(function (error) {
+        ok(false, error);
+      })
+      .always(function () {
+        start();
+      });
+  });
+
+  ///////////////////////////////////////////////////////
+  // Remote modification
+  ///////////////////////////////////////////////////////
+  test("remote document modification: copy", function () {
+    expect(2);
+    stop();
+
+    var test = this,
+      doc_id = 'foo_module/1',
+      doc = {title: doc_id, portal_type: "Foo", modification_date: 'a'},
+      doc2 = {title: doc_id + 'a', portal_type: "Foo", modification_date: 'b'},
+      blob = new Blob(['a']),
+      blob2 = new Blob(['b']);
+
+    putFullDoc(this.jio.__storage._remote_sub_storage, doc_id, doc, blob)
+      .then(function () {
+        return test.jio.repair();
+      })
+      .then(function () {
+        return putFullDoc(test.jio.__storage._remote_sub_storage, doc_id, doc2,
+                          blob2);
+      })
+      .then(function () {
+        resetCount(test.remote_mock_options.count);
+        return test.jio.repair();
+      })
+      .then(function () {
+        equalRemoteStorageCallCount(
+          test.remote_mock_options.count,
+          {buildQuery: 1, get: 1, getAttachment: 1, allAttachments: 1}
+        );
+        return equalStorage(test.jio, [[doc_id, doc2, blob2]]);
+      })
+      .fail(function (error) {
+        ok(false, error);
+      })
+      .always(function () {
+        start();
+      });
+  });
+
+  ///////////////////////////////////////////////////////
+  // Remote hide
+  ///////////////////////////////////////////////////////
+  test("remote document deletion: delete", function () {
+    expect(2);
+    stop();
+
+    var test = this,
+      doc_id = 'foo_module/1',
+      doc = {title: doc_id, portal_type: "Foo", modification_date: 'a'},
+      blob = new Blob(['a']);
+
+    putFullDoc(this.jio.__storage._remote_sub_storage, doc_id, doc, blob)
+      .then(function () {
+        return test.jio.repair();
+      })
+      .then(function () {
+        test.remote_mock_options.mock.buildQuery = function () {
+          return [];
+        };
+        resetCount(test.remote_mock_options.count);
+        return test.jio.repair();
+      })
+      .then(function () {
+        return RSVP.all([
+          isEmptyStorage(test.jio),
+          equalRemoteStorageCallCount(
+            test.remote_mock_options.count,
+            {buildQuery: 1}
+          )
+        ]);
+      })
+      .fail(function (error) {
+        ok(false, error);
+      })
+      .always(function () {
+        start();
+      });
+  });
+
+  ///////////////////////////////////////////////////////
+  // Local creation
+  ///////////////////////////////////////////////////////
+  test("local document creation: copy", function () {
+    expect(3);
+    stop();
+
+    var test = this,
+      doc_id = 'abc',
+      doc = {title: doc_id, portal_type: "Foo", modification_date: 'a'},
+      blob = new Blob(['a']);
+
+    putFullDoc(this.jio, doc_id, doc, blob)
+      .then(function () {
+        resetCount(test.remote_mock_options.count);
+        return test.jio.repair();
+      })
+      .then(function () {
+        equalRemoteStorageCallCount(
+          test.remote_mock_options.count,
+          {buildQuery: 1, post: 1, putAttachment: 1, allAttachments: 1}
+        );
+        return equalStorage(
+          test.jio,
+          [[test.remote_mock_options.last_post_id, doc, blob]]
+        );
+      })
+      .then(function () {
+        return equalStorage(
+          test.jio.__storage._remote_sub_storage,
+          [[test.remote_mock_options.last_post_id, doc, blob]]
+        );
+      })
+      .fail(function (error) {
+        ok(false, error);
+      })
+      .always(function () {
+        start();
+      });
+  });
+
+  ///////////////////////////////////////////////////////
+  // Local modification
+  ///////////////////////////////////////////////////////
+  test("local document modification: copy", function () {
+    expect(2);
+    stop();
+
+    var test = this,
+      doc_id = 'foo_module/1',
+      doc = {title: doc_id, portal_type: "Foo", modification_date: 'a'},
+      doc2 = {title: doc_id + 'a', portal_type: "Foo", modification_date: 'b'},
+      blob = new Blob(['a']),
+      blob2 = new Blob(['b']),
+      last_id;
+
+    putFullDoc(this.jio, doc_id, doc, blob)
+      .then(function () {
+        return test.jio.repair();
+      })
+      .then(function () {
+        last_id = test.remote_mock_options.last_post_id;
+        return putFullDoc(test.jio, last_id, doc2, blob2);
+      })
+      .then(function () {
+        resetCount(test.remote_mock_options.count);
+        return test.jio.repair();
+      })
+      .then(function () {
+        equalRemoteStorageCallCount(
+          test.remote_mock_options.count,
+          {buildQuery: 1, put: 1,
+            allAttachments: 1, putAttachment: 1}
+        );
+        return equalStorage(
+          test.jio.__storage._remote_sub_storage,
+          [[last_id, doc2, blob2]]
+        );
+      })
+      .fail(function (error) {
+        ok(false, error);
+      })
+      .always(function () {
+        start();
+      });
+  });
+
+  ///////////////////////////////////////////////////////
+  // Conflict
+  ///////////////////////////////////////////////////////
+  test("both modification: keep local", function () {
+    expect(2);
+    stop();
+
+    var test = this,
+      doc_id = 'foo_module/1',
+      doc = {title: doc_id, portal_type: "Foo", modification_date: 'a'},
+      doc2 = {title: doc_id + 'a', portal_type: "Foo", modification_date: 'b'},
+      doc3 = {title: doc_id + 'c', portal_type: "Foo", modification_date: 'c'},
+      blob = new Blob(['a']),
+      blob2 = new Blob(['b']),
+      blob3 = new Blob(['c']);
+
+    putFullDoc(this.jio.__storage._remote_sub_storage, doc_id, doc, blob)
+      .then(function () {
+        return test.jio.repair();
+      })
+      .then(function () {
+        return RSVP.all([
+          putFullDoc(test.jio.__storage._remote_sub_storage, doc_id,
+                     doc2, blob2),
+          putFullDoc(test.jio, doc_id, doc3, blob3)
+        ]);
+      })
+      .then(function () {
+        resetCount(test.remote_mock_options.count);
+        return test.jio.repair();
+      })
+      .then(function () {
+        equalRemoteStorageCallCount(
+          test.remote_mock_options.count,
+          {buildQuery: 1, put: 1,
+            allAttachments: 1, putAttachment: 1}
+        );
+        return equalStorage(
+          test.jio.__storage._remote_sub_storage,
+          [[doc_id, doc3, blob3]]
+        );
+      })
+      .fail(function (error) {
+        ok(false, error);
+      })
+      .always(function () {
+        start();
+      });
+  });
+
+  test("local modification / frozen remote", function () {
+    expect(1);
+    stop();
+
+    var test = this,
+      doc_id = 'foo_module/1',
+      doc = {title: doc_id, portal_type: "Foo", modification_date: 'a'},
+      doc2 = {title: doc_id + 'a', portal_type: "Foo", modification_date: 'b'},
+      blob = new Blob(['a']),
+      blob2 = new Blob(['b']);
+
+    putFullDoc(this.jio.__storage._remote_sub_storage, doc_id, doc, blob)
+      .then(function () {
+        return test.jio.repair();
+      })
+      .then(function () {
+        return putFullDoc(test.jio, doc_id, doc2, blob2);
+      })
+      .then(function () {
+        test.remote_mock_options.mock.put = function (id) {
+          if (id === doc_id) {
+            throw new jIO.util.jIOError('put not allowed', 403);
+          }
+          return id;
+        };
+        test.remote_mock_options.mock.putAttachment = function (id) {
+          if (id === doc_id) {
+            throw new jIO.util.jIOError('putattachment not allowed', 403);
+          }
+          return id;
+        };
+        resetCount(test.remote_mock_options.count);
+        return test.jio.repair();
+      })
+      .then(function () {
+        // Create New Document When State is Frozen
+        equalRemoteStorageCallCount(
+          test.remote_mock_options.count,
+          {buildQuery: 1, allAttachments: 1, put: 1, post: 1, putAttachment: 2}
+        );
+      })
+      .fail(function (error) {
+        ok(false, error);
+      })
+      .always(function () {
+        start();
+      });
+  });
+
+  ///////////////////////////////////////////////////////
+  // Local deletion (aka, people playing manually with the browser storage)
+  ///////////////////////////////////////////////////////
+  test("local document deletion: do nothing", function () {
+    expect(3);
+    stop();
+
+    var test = this,
+      doc_id = 'foo_module/1',
+      doc = {title: doc_id, portal_type: "Foo", modification_date: 'a'},
+      blob = new Blob(['a']);
+
+    putFullDoc(this.jio.__storage._remote_sub_storage, doc_id, doc, blob)
+      .then(function () {
+        return test.jio.repair();
+      })
+      .then(function () {
+        return test.jio.remove(doc_id);
+      })
+      .then(function () {
+        resetCount(test.remote_mock_options.count);
+        return test.jio.repair();
+      })
+      .then(function () {
+        equalRemoteStorageCallCount(
+          test.remote_mock_options.count,
+          {buildQuery: 1}
+        );
+        return RSVP.all([
+          isEmptyStorage(test.jio),
+          equalStorage(
+            test.jio.__storage._remote_sub_storage,
+            [[doc_id, doc, blob]]
+          )
+        ]);
+      })
+      .fail(function (error) {
+        ok(false, error);
+      })
+      .always(function () {
+        start();
+      });
+  });
+
+  test("local attachment deletion: do nothing", function () {
+    expect(2);
+    stop();
+
+    var test = this,
+      doc_id = 'foo_module/1',
+      doc = {title: doc_id, portal_type: "Foo", modification_date: 'a'},
+      blob = new Blob(['a']);
+
+    putFullDoc(this.jio.__storage._remote_sub_storage, doc_id, doc, blob)
+      .then(function () {
+        return test.jio.repair();
+      })
+      .then(function () {
+        return test.jio.removeAttachment(doc_id, ATTACHMENT);
+      })
+      .then(function () {
+        resetCount(test.remote_mock_options.count);
+        return test.jio.repair();
+      })
+      .then(function () {
+        equalRemoteStorageCallCount(
+          test.remote_mock_options.count,
+          {buildQuery: 1}
+        );
+        return equalStorage(
+          test.jio.__storage._remote_sub_storage,
+          [[doc_id, doc, blob]]
+        );
+      })
+      .fail(function (error) {
+        ok(false, error);
+      })
+      .always(function () {
+        start();
+      });
+  });
+
+  test("local deletion / remote modification", function () {
+    expect(2);
+    stop();
+
+    var test = this,
+      doc_id = 'foo_module/1',
+      doc = {title: doc_id, portal_type: "Foo", modification_date: 'a'},
+      doc2 = {title: doc_id + 'a', portal_type: "Foo", modification_date: 'b'},
+      blob = new Blob(['a']),
+      blob2 = new Blob(['b']);
+
+    putFullDoc(this.jio.__storage._remote_sub_storage, doc_id, doc, blob)
+      .then(function () {
+        return test.jio.repair();
+      })
+      .then(function () {
+        return RSVP.all([
+          putFullDoc(test.jio.__storage._remote_sub_storage, doc_id,
+                     doc2, blob2),
+          test.jio.remove(doc_id)
+        ]);
+      })
+      .then(function () {
+        resetCount(test.remote_mock_options.count);
+        return test.jio.repair();
+      })
+      .then(function () {
+        equalRemoteStorageCallCount(
+          test.remote_mock_options.count,
+          {buildQuery: 1, get: 1,
+            allAttachments: 1, getAttachment: 1}
+        );
+        return RSVP.all([
+          equalStorage(
+            test.jio,
+            [[doc_id, doc2, blob2]]
+          ),
+          equalStorage(
+            test.jio.__storage._remote_sub_storage,
+            [[doc_id, doc2, blob2]]
+          )
+        ]);
+      })
+      .fail(function (error) {
+        ok(false, error);
+      })
+      .always(function () {
+        start();
+      });
+  });
+
+}(QUnit, jIO, Blob));