pageflow 0.11.4 → 12.0.0.rc1

data/app/assets/javascripts/pageflow/editor/api/failure.js

@@ -4,6 +4,9 @@
  * Subclasses that represent failures that are can not be retried should
  * override `catRetry` with false.
  * Retryable failures should implement `retryAction`.
+ *
+ * @class
+ * @memberof module:pageflow/editor
  */
 pageflow.Failure = pageflow.Object.extend({
   canRetry: true,
@@ -31,6 +34,9 @@ pageflow.Failure = pageflow.Object.extend({
 /**
  * SavingFailure represents a unsuccessful attempt to save
  * a model on the server.
+ *
+ * @class
+ * @memberof module:pageflow/editor
  */
 pageflow.SavingFailure = pageflow.Failure.extend({
   type: 'SavingFailure'
@@ -39,6 +45,9 @@ pageflow.SavingFailure = pageflow.Failure.extend({
 /**
  *  OrderingFailure represent a unsuccessful attempt to save
  *  the ordering of a pageflow.orderedCollection.
+ *
+ * @class
+ * @memberof module:pageflow/editor
  */
 pageflow.OrderingFailure = pageflow.Failure.extend({
   type: 'OrderingFailure',

data/app/assets/javascripts/pageflow/editor/api/failures.js

@@ -1,13 +1,30 @@
 /**
  * API to allow access to failure UI and recovery.
- * Global instance at pageflow.failures.
+ *
+ * Can watch collections for errors saving models and display the error
+ * allong with a retry button.
+ *
+ *     pageflow.editor.failures.watch(collection);
+ *
+ * It's possible to add failures to the UI by adding instances of subclasses of pageflow.Failure:
+ *
+ *     pageflow.editor.failures.add(new pageflow.OrderingFailure(model, collection));
+ *
+ * @alias pageflow.Failures
+ * @memberof module:pageflow/editor
  */
-pageflow.FailuresAPI = pageflow.Object.extend({
+pageflow.FailuresAPI = pageflow.Object.extend(
+/** @lends module:pageflow/editor.pageflow.Failures */{
   initialize: function() {
     this.failures = {};
     this.length = 0;
   },
 
+  /**
+   * Listen to the `error` and `sync` events of a collection and
+   * create {@link module:pageflow/editor.pageflow.SavingFailure
+   * pageflow.SavingFailure} objects.
+   */
   watch: function(collection) {
     this.listenTo(collection, 'sync', this.remove);
 
@@ -29,6 +46,12 @@ pageflow.FailuresAPI = pageflow.Object.extend({
     return _.size(this.failures) === 0;
   },
 
+  /**
+   * Record that a failure occured.
+   *
+   * @param {pageflow.Failure} failure
+   * The failure object to add.
+   */
   add: function(failure) {
     this.failures[failure.key()] = failure;
     this.length = _.size(this.failures);

data/app/assets/javascripts/pageflow/editor/api/file_type.js

@@ -1,13 +1,36 @@
 pageflow.FileType = pageflow.Object.extend({
   initialize: function(options) {
     this.model = options.model;
-
     this.typeName = options.typeName;
     this.collectionName = options.collectionName;
+    this.topLevelType = options.topLevelType;
     this.paramKey = options.paramKey;
     this.i18nKey = options.i18nKey;
+    this.nestedFileTypes = [];
+    this.confirmUploadTableColumns = options.confirmUploadTableColumns || [];
+    this.configurationEditorInputs = [].concat(options.configurationEditorInputs || []);
+    this.configurationUpdaters = options.configurationUpdaters || [];
+    this.nestedFileTableColumns = options.nestedFileTableColumns || [];
+    this.nestedFilesOrder = options.nestedFilesOrder;
+    this.skipUploadConfirmation = options.skipUploadConfirmation || false;
+    this.filters = options.filters || [];
+
+    this.metaDataAttributes = [
+      {
+        name: 'rights',
+        valueView: pageflow.TextFileMetaDataItemValueView,
+        valueViewOptions: {
+          settingsDialogTabLink: 'general'
+        }
+      },
+    ].concat(options.metaDataAttributes || []);
 
-    this.metaDataAttributes = options.metaDataAttributes || [];
+    this.settingsDialogTabs = [
+      {
+        name: 'general',
+        view: pageflow.EditFileView
+      }
+    ].concat(options.settingsDialogTabs || []);
 
     if (typeof options.matchUpload === 'function') {
       this.matchUpload = options.matchUpload;
@@ -28,5 +51,21 @@ pageflow.FileType = pageflow.Object.extend({
     this.model.prototype.modelName = this.model.prototype.modelName || this.paramKey;
     this.model.prototype.paramRoot = this.model.prototype.paramRoot || this.paramKey;
     this.model.prototype.i18nKey = this.model.prototype.i18nKey || this.i18nKey;
+  },
+
+  setNestedFileTypes: function(fileTypesCollection) {
+    this.nestedFileTypes = fileTypesCollection;
+  },
+
+  getFilter: function(name) {
+    var result =  _(this.filters).find(function(filter) {
+      return filter.name === name;
+    });
+
+    if (!result) {
+      throw new Error('Unknown filter "' + name + '" for file type "' + this.collectionName + '".');
+    }
+
+    return result;
   }
-});
+});

data/app/assets/javascripts/pageflow/editor/api/file_types.js

@@ -1,6 +1,14 @@
 pageflow.FileTypes = pageflow.Object.extend({
+  modifyableProperties: [
+    'configurationEditorInputs',
+    'configurationUpdaters',
+    'confirmUploadTableColumns',
+    'filters'
+  ],
+
   initialize: function() {
     this.clientSideConfigs = [];
+    this.clientSideConfigModifications = {};
   },
 
   register: function(name, config) {
@@ -11,63 +19,84 @@ pageflow.FileTypes = pageflow.Object.extend({
     this.clientSideConfigs[name] = config;
   },
 
+  modify: function(name, config) {
+    if (this._setup) {
+      throw 'File types already set up. Modify file types before initializers run.';
+    }
+
+    this.clientSideConfigModifications[name] = this.clientSideConfigModifications[name] || [];
+    this.clientSideConfigModifications[name].push(config);
+  },
+
   setup: function(serverSideConfigs) {
     var clientSideConfigs = this.clientSideConfigs;
     this._setup = true;
 
-    this.fileTypes = _.map(serverSideConfigs, function(serverSideConfig) {
-      var clientSideConfig = clientSideConfigs[serverSideConfig.collectionName];
-
-      if (!clientSideConfig) {
-        throw 'Missing client side config for file type "' + serverSideConfig.collectionName + '"';
-      }
-
-      return new pageflow.FileType(_.extend({}, serverSideConfig, clientSideConfig));
+    this.collection = new pageflow.
+      FileTypesCollection(_.map(serverSideConfigs, function(serverSideConfig) {
+        var clientSideConfig = clientSideConfigs[serverSideConfig.collectionName];
+
+        if (!clientSideConfig) {
+          throw 'Missing client side config for file type "' +
+            serverSideConfig.collectionName + '"';
+        }
+
+        _(this.clientSideConfigModifications[serverSideConfig.collectionName])
+          .each(function(modification) {
+            this.lintModification(modification, serverSideConfig.collectionName);
+            this.applyModification(clientSideConfig, modification);
+          }, this);
+
+        return new pageflow.FileType(_.extend({}, serverSideConfig, clientSideConfig));
+      }, this));
+    var those = this;
+
+    _.map(serverSideConfigs, function(serverSideConfig) {
+      var fileType = those.findByCollectionName(serverSideConfig.collectionName);
+      fileType.setNestedFileTypes(new pageflow.FileTypesCollection(
+        _.map(serverSideConfig.nestedFileTypes, function(nestedFileType) {
+          return those.findByCollectionName(nestedFileType.collectionName);
+        })
+      ));
     });
   },
 
-  findByUpload: function(upload) {
-    var result = this.find(function(fileType) {
-      return fileType.matchUpload(upload);
-    });
-
-    if (!result) {
-      throw(new pageflow.FileTypes.UnmatchedUploadError(upload));
+  lintModification: function(modification, collectionName) {
+    var unmodifyableProperties = _.difference(_.keys(modification), this.modifyableProperties);
+
+    if (unmodifyableProperties.length) {
+      throw 'Only the following properties are allowed in FileTypes#modify: ' +
+        this.modifyableProperties.join(', ') +
+        '. Given in modification for ' +
+        collectionName +
+        ': ' +
+        unmodifyableProperties.join(', ') +
+        '.';
     }
-
-    return result;
   },
 
-  findByCollectionName: function(collectionName) {
-    var result = this.find(function(fileType) {
-      return fileType.collectionName === collectionName;
+  applyModification: function(target, modification) {
+    _(this.modifyableProperties).each(function(property) {
+      target[property] = (target[property] || []).concat(modification[property] || []);
     });
-
-    if (!result) {
-      throw('Could not find file type by collection name "' + collectionName +'"');
-    }
-
-    return result;
   }
 });
 
-_.each(['each', 'map', 'reduce', 'first', 'find'], function(method) {
-  pageflow.FileTypes.prototype[method] = function() {
-    if (!this._setup) {
-      throw  'File types are not yet set up.';
-    }
-
-    var args = Array.prototype.slice.call(arguments);
-    args.unshift(this.fileTypes);
-    return _[method].apply(_, args);
-  };
-});
-
-pageflow.FileTypes.UnmatchedUploadError = pageflow.Object.extend({
-  name: 'UnmatchedUploadError',
-
-  initialize: function(upload) {
-    this.upload = upload;
-    this.message = 'No matching file type found for upload "' + upload.name + '" of type "' + upload.type +'".';
-  }
-});
+_.each(['each',
+        'map',
+        'reduce',
+        'first',
+        'find',
+        'findByUpload',
+        'findByCollectionName',
+        'contains',
+        'filter'],
+       function(method) {
+         pageflow.FileTypes.prototype[method] = function() {
+           if (!this._setup) {
+             throw  'File types are not yet set up.';
+           }
+
+           return this.collection[method].apply(this.collection, arguments);
+         };
+       });

data/app/assets/javascripts/pageflow/editor/base.js

@@ -34,6 +34,7 @@
 //= require_tree ./views/mixins
 //= require ./views/model_thumbnail_view
 //= require ./views/file_item_view
+//= require ./views/file_meta_data_item_value_view
 //= require ./views/chapter_item_view
 //= require ./views/page_item_view
 //= require ./views/inputs/reference_input_view
@@ -48,8 +49,10 @@
 //= require ./initializers/setup_file_types
 //= require ./initializers/setup_widget_types
 //= require ./initializers/setup_collections
+//= require ./initializers/setup_file_uploader
 //= require ./initializers/setup_page_types
 //= require ./initializers/setup_hotkeys
+//= require ./initializers/setup_file_uploader
 //= require ./initializers/edit_lock
 //= require ./initializers/files_polling
 //= require ./initializers/stylesheet_reloading
@@ -58,6 +61,11 @@
 //= require ./initializers/additional_initializers
 //= require ./initializers/boot
 
+/**
+ * The Pageflow editor.
+ * @module pageflow/editor
+ */
+
 pageflow.app = new Backbone.Marionette.Application();
 pageflow.editor = new pageflow.EditorApi();
 

data/app/assets/javascripts/pageflow/editor/collections/file_types_collection.js

@@ -0,0 +1,37 @@
+pageflow.FileTypesCollection = pageflow.Object.extend({
+  initialize: function(fileTypes) {
+    this._fileTypes = fileTypes;
+  },
+
+  findByUpload: function(upload) {
+    var result = this.find(function(fileType) {
+      return fileType.matchUpload(upload);
+    });
+
+    if (!result) {
+      throw(new pageflow.UnmatchedUploadError(upload));
+    }
+
+    return result;
+  },
+
+  findByCollectionName: function(collectionName) {
+    var result = this.find(function(fileType) {
+      return fileType.collectionName === collectionName;
+    });
+
+    if (!result) {
+      throw('Could not find file type by collection name "' + collectionName +'"');
+    }
+
+    return result;
+  }
+});
+
+_.each(['each', 'map', 'reduce', 'first', 'find', 'contains', 'filter'], function(method) {
+  pageflow.FileTypesCollection.prototype[method] = function() {
+    var args = Array.prototype.slice.call(arguments);
+    args.unshift(this._fileTypes);
+    return _[method].apply(_, args);
+  };
+});

data/app/assets/javascripts/pageflow/editor/collections/files_collection.js

@@ -16,6 +16,14 @@ pageflow.FilesCollection = Backbone.Collection.extend({
     return '/editor/entries/' + this.getEntry().get('id') + '/files/' + this.name;
   },
 
+  fetch: function(options) {
+    options = _.extend({
+      fileType: this.fileType
+    }, options || {});
+
+    return Backbone.Collection.prototype.fetch.call(this, options);
+  },
+
   getEntry: function() {
     return this.entry || pageflow.entry;
   },
@@ -29,6 +37,29 @@ pageflow.FilesCollection = Backbone.Collection.extend({
         return item.get('state') === 'waiting_for_confirmation';
       },
     });
+  },
+
+  uploadable: function() {
+    this._uploadableSubsetCollection = this._uploadableSubsetCollection ||
+      new pageflow.SubsetCollection({
+        parent: this,
+        watchAttribute: 'state',
+
+        filter: function(item) {
+          return item.get('state') === 'uploadable';
+        },
+      });
+
+    return this._uploadableSubsetCollection;
+  },
+
+  withFilter: function(filterName) {
+    return new pageflow.SubsetCollection({
+      parent: this,
+      watchAttribute: 'configuration',
+
+      filter: this.fileType.getFilter(filterName).matches,
+    });
   }
 });
 
@@ -51,4 +82,4 @@ pageflow.FilesCollection.createForFileType = function(fileType, files, options)
       model: fileType.model
     }, options || {})
   );
-};
+};

data/app/assets/javascripts/pageflow/editor/collections/mixins/ordered_collection.js

@@ -22,7 +22,7 @@ pageflow.orderedCollection = {
       return $.Deferred().resolve().promise();
     }
 
-    return Backbone.sync('patch', parentModel, {
+    return Backbone.sync('update', parentModel, {
       url: collection.url() + '/order',
       attrs: {ids: collection.pluck('id')},
 

data/app/assets/javascripts/pageflow/editor/collections/multi_collection.js

@@ -1,8 +1,6 @@
-/**
- * A partial implementation of a collection that can store records of
- * different model types.  Backbone.Collection tries to merge records
- * if they have the same id.
- */
+// A partial implementation of a collection that can store records of
+// different model types.  Backbone.Collection tries to merge records
+// if they have the same id.
 pageflow.MultiCollection = function() {
   this.records = {};
   this.length = 0;
@@ -34,4 +32,4 @@ _.extend(pageflow.MultiCollection.prototype, {
 
 _.extend(pageflow.MultiCollection.prototype, Backbone.Events);
 
-pageflow.MultiCollection.extend = Backbone.Collection.extend;
+pageflow.MultiCollection.extend = Backbone.Collection.extend;

data/app/assets/javascripts/pageflow/editor/collections/nested_files_collection.js

@@ -0,0 +1,27 @@
+pageflow.NestedFilesCollection = pageflow.SubsetCollection.extend({
+  constructor: function(options) {
+    var parent = options.parent;
+    var parentFile = options.parentFile;
+
+    var modelType = parentFile.fileType().typeName;
+    var nestedFilesOrder = parent.fileType.nestedFilesOrder;
+
+    pageflow.SubsetCollection.prototype.constructor.call(this, {
+      parent: parent,
+      parentModel: parentFile,
+
+      filter: function(item) {
+        return item.get('parent_file_id') === parentFile.get('id') &&
+          item.get('parent_file_model_type') === modelType;
+      },
+
+      comparator: nestedFilesOrder && nestedFilesOrder.comparator
+    });
+
+    if (nestedFilesOrder) {
+      this.listenTo(this,
+                    'change:configuration:' + nestedFilesOrder.binding,
+                    this.sort);
+    }
+  }
+});