pageflow 0.4.0 → 0.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTViZDg2ZGZlMzdjYTU0M2E4NzI2YjM4NzU1YWU2NDY1ZTQ3ODA1Zg==
+    NmUxZDk3ZWY0NmIxNjVhYjE5MDdlODYzNDZmMjZiNGE5NjNmMzFmMA==
   data.tar.gz: !binary |-
-    ZTgwZjI4ZTQ1M2I1MTUwNDc1ZDEzMWQ2Mjk4N2E1NGY5MDE5OTUzOQ==
+    ZGRkZmMzODVhMGMyZjE4ZjBkYmZlYTZiM2NlYjc4MTA1NzljZGUyOQ==
 SHA512:
   metadata.gz: !binary |-
-    Yzk4MWEwMWNiOGFiMmJjNjM1NGQ5YmRmZWZkNmE0OGQyNTIzMjk1OTRhZTVh
-    Yjc4NGJmNjljOTJiMTc5ZmFmZTU5YWJjNDk4NGIyNzMyYjcxNDVmMDA4MmU5
-    ZmQyMmFmZDIwOTliMjQzM2RiODdmMjQwMGRhOWQ4MzhjMmM2MDQ=
+    NDNmNDJjNWMyZGI0N2M2Y2M4YzNhNDI1MTVlNDNhODkyNTAwM2UyODBmY2U1
+    ZTgzYzNjYjNmNTMzZmZlZDQyMGJjZDc5M2I4MzQ3MzA0ZTEyNTkwNzk1ZTgz
+    YWFkNTkxYTA0ODkxNGE1YmNkMTFkNGRlMGQwOWRhYmY2MGQ3YmM=
   data.tar.gz: !binary |-
-    MTAzOGJlNTRkMDViODVhODg1ZGYzMTVmNmViMzhlMjczYmVjZmE2OTEzMGEz
-    M2VmYjdlOGM3ZjZmZjBmZGMyNDMyZDM0NzdlMWQxNTcxZWMwYzIwOTc0OWI2
-    N2Q1OWVhYTc3ZmQ0MmYwODQ0M2QxZDU3ZTc1NTc3ZDdmZTcwOGU=
+    YmE0ZDhjMWVmZDk2NjQxNGIwODg5MjJkODcwNGUyZTFjNWZkZjdhNzEwMTk5
+    NTU3NzUzNmI5ODY2MjM3ZmVjMGI0NTJlMDM4MTc4NDYwN2M3ZWZjNTlmNGE5
+    NTIyZDliMTczMjAxYTYyZjZlMzY2M2IzNTgzZjI0ZWYzMWVhYzk=

data/app/assets/javascripts/pageflow/audio_player.js

@@ -66,4 +66,9 @@ pageflow.AudioPlayer.fromAudioTag = function(element) {
       type: $(this).attr('type')
     };
   }).get(), element[0]);
+};
+
+pageflow.AudioPlayer.fromScriptTag = function(element) {
+  var sources = element.length ? JSON.parse(element.text()) : [];
+  return new pageflow.AudioPlayer(sources);
 };

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

@@ -121,6 +121,10 @@ pageflow.EditorApi = pageflow.Object.extend({
      */
     this.failures = new pageflow.FailuresAPI();
 
+    /**
+     *
+     */
+    this.fileTypes = new pageflow.FileTypes();
 
     /** @private */
     this.createFileSelectionHandler = function(handlerName, encodedPayload) {

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

@@ -0,0 +1,32 @@
+pageflow.FileType = pageflow.Object.extend({
+  initialize: function(options) {
+    this.model = options.model;
+
+    this.typeName = options.typeName;
+    this.collectionName = options.collectionName;
+    this.paramKey = options.paramKey;
+    this.i18nKey = options.i18nKey;
+
+    this.metaDataAttributes = options.metaDataAttributes || [];
+
+    if (typeof options.matchUpload === 'function') {
+      this.matchUpload = options.matchUpload;
+    }
+    else if (options.matchUpload instanceof RegExp)  {
+      this.matchUpload = function(upload) {
+        return upload.type.match(options.matchUpload);
+      };
+    }
+    else {
+      throw 'matchUpload option of FileType "' + this.collectionName + '" must either be a function or a RegExp.';
+    }
+
+    this.setupModelNaming();
+  },
+
+  setupModelNaming: function() {
+    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;
+  }
+});

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

@@ -0,0 +1,73 @@
+pageflow.FileTypes = pageflow.Object.extend({
+  initialize: function() {
+    this.clientSideConfigs = [];
+  },
+
+  register: function(name, config) {
+    if (this._setup) {
+      throw 'File types already set up. Register file types before initializers run.';
+    }
+
+    this.clientSideConfigs[name] = 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));
+    });
+  },
+
+  findByUpload: function(upload) {
+    var result = this.find(function(fileType) {
+      return fileType.matchUpload(upload);
+    });
+
+    if (!result) {
+      throw(new pageflow.FileTypes.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'], 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 +'".';
+  }
+});

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

@@ -23,6 +23,9 @@
 //= require_self
 
 //= require_tree ./models/mixins
+//= require ./models/uploaded_file
+//= require ./models/hosted_file
+//= require ./models/encoded_file
 //= require_tree ./models
 //= require_tree ./collections/mixins
 //= require ./collections/multi_collection
@@ -42,11 +45,13 @@
 //= require_tree ./views
 
 //= require ./initializers/setup_config
+//= require ./initializers/setup_file_types
 //= require ./initializers/setup_collections
 //= require ./initializers/setup_page_types
 //= require ./initializers/edit_lock
 //= require ./initializers/files_polling
 //= require ./initializers/routing
+//= require ./initializers/error_listener
 //= require ./initializers/additional_initializers
 //= require ./initializers/boot
 

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

@@ -3,7 +3,19 @@ pageflow.FileUsagesCollection = Backbone.Collection.extend({
 
   name: 'file_usages',
 
+  initialize: function(models, options) {
+    options = options || {};
+    this.entry = options.entry;
+  },
+
   url: function() {
-    return '/editor/entries/' + pageflow.entry.get('id') + '/file_usages';
+    return '/editor/entries/' + this.entry.get('id') + '/file_usages';
+  },
+
+  createForFile: function(file, options) {
+    return this.create({
+      file_id: file.get('id'),
+      file_type: file.fileType().typeName
+    }, options);
   }
 });

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

@@ -0,0 +1,54 @@
+pageflow.FilesCollection = Backbone.Collection.extend({
+  initialize: function(models, options) {
+    options = options || {};
+
+    this.entry = options.entry;
+    this.fileType = options.fileType;
+    this.name = options.fileType.collectionName;
+  },
+
+  comparator: function(file) {
+    var fileName = file.get('file_name');
+    return (fileName && fileName.toLowerCase) ? fileName.toLowerCase() : fileName;
+  },
+
+  url: function() {
+    return '/editor/entries/' + this.getEntry().get('id') + '/files/' + this.name;
+  },
+
+  getEntry: function() {
+    return this.entry || pageflow.entry;
+  },
+
+  confirmable: function() {
+    return new pageflow.SubsetCollection({
+      parent: this,
+      watchAttribute: 'state',
+
+      filter: function(item) {
+        return item.get('state') === 'waiting_for_confirmation';
+      },
+    });
+  }
+});
+
+pageflow.FilesCollection.createForFileTypes = function(fileTypes, files, options) {
+  return fileTypes.reduce(function(result, fileType) {
+    result[fileType.collectionName] = pageflow.FilesCollection.createForFileType(
+      fileType,
+      files[fileType.collectionName],
+      options
+    );
+    return result;
+  }, {});
+};
+
+pageflow.FilesCollection.createForFileType = function(fileType, files, options) {
+  return new pageflow.FilesCollection(
+    files,
+    _.extend({
+      fileType: fileType,
+      model: fileType.model
+    }, options || {})
+  );
+};

data/app/assets/javascripts/pageflow/editor/controllers/sidebar_controller.js

@@ -10,23 +10,11 @@ pageflow.SidebarController = Backbone.Marionette.Controller.extend({
     }));
   },
 
-  imageFiles: function(handler, payload) {
-    this.files(handler, payload, 'image_files');
-  },
-
-  videoFiles: function(handler, payload) {
-    this.files(handler, payload, 'video_files');
-  },
-
-  audioFiles: function(handler, payload) {
-    this.files(handler, payload, 'audio_files');
-  },
-
-  files: function(handler, payload, tabName) {
+  files: function(collectionName, handler, payload) {
     this.region.show(new pageflow.FilesView({
       model: this.entry,
       selectionHandler: handler && pageflow.editor.createFileSelectionHandler(handler, payload),
-      tabName: tabName
+      tabName: collectionName
     }));
   },
 

data/app/assets/javascripts/pageflow/editor/initializers/error_listener.js

@@ -0,0 +1,8 @@
+pageflow.app.addInitializer(function() {
+  pageflow.app.on('error', function(e) {
+    alert(I18n.t(e.name, {
+      scope: 'pageflow.editor.errors',
+      defaultValue: I18n.t('pageflow.editor.errors.unknown')
+    }));
+  });
+});

data/app/assets/javascripts/pageflow/editor/initializers/setup_collections.js

@@ -1,7 +1,9 @@
 pageflow.app.addInitializer(function(options) {
-  pageflow.imageFiles = new pageflow.ImageFilesCollection(options.imageFiles);
-  pageflow.videoFiles = new pageflow.VideoFilesCollection(options.videoFiles);
-  pageflow.audioFiles = new pageflow.AudioFilesCollection(options.audioFiles);
+  pageflow.files = pageflow.FilesCollection.createForFileTypes(pageflow.editor.fileTypes, options.files);
+
+  pageflow.imageFiles = pageflow.files.image_files;
+  pageflow.videoFiles = pageflow.files.video_files;
+  pageflow.audioFiles = pageflow.files.audio_files;
 
   pageflow.pages = new pageflow.PagesCollection(options.pages);
   pageflow.chapters = new pageflow.ChaptersCollection(options.chapters);

data/app/assets/javascripts/pageflow/editor/initializers/setup_file_types.js

@@ -0,0 +1,21 @@
+pageflow.app.addInitializer(function(options) {
+  pageflow.editor.fileTypes.register('image_files', {
+    model: pageflow.ImageFile,
+    metaDataAttributes: ['dimensions'],
+    matchUpload: /^image/
+  });
+
+  pageflow.editor.fileTypes.register('video_files', {
+    model: pageflow.VideoFile,
+    metaDataAttributes: ['format', 'dimensions', 'duration'],
+    matchUpload: /^video/
+  });
+
+  pageflow.editor.fileTypes.register('audio_files', {
+    model: pageflow.AudioFile,
+    metaDataAttributes: ['format', 'duration'],
+    matchUpload: /^audio/
+  });
+
+  pageflow.editor.fileTypes.setup(options.config.fileTypes);
+});

data/app/assets/javascripts/pageflow/editor/models/audio_file.js

@@ -1,17 +1,3 @@
-pageflow.AudioFile = Backbone.Model.extend({
-  modelName: 'audio_file',
-  paramRoot: 'audio_file',
-  i18nKey: 'pageflow/audio_file',
-
-  mixins: [pageflow.file, pageflow.encodedFile, pageflow.stageProvider, pageflow.retryable],
-
+pageflow.AudioFile = pageflow.EncodedFile.extend({
   thumbnailPictogram: 'audio',
-
-  urlRoot: function() {
-    return this.isNew() ? this.collection.url() : '/editor/audio_files';
-  },
-
-  isPositionable: function() {
-    return false;
-  }
 });

data/app/assets/javascripts/pageflow/editor/models/encoded_file.js

@@ -0,0 +1,32 @@
+pageflow.EncodedFile = pageflow.HostedFile.extend({
+  processingStages: function() {
+    var stages = [];
+
+    if (pageflow.config.confirmEncodingJobs) {
+      stages.push({
+        name: 'fetching_meta_data',
+        activeStates: ['waiting_for_meta_data', 'fetching_meta_data'],
+        failedStates: ['fetching_meta_data_failed']
+      });
+    }
+
+    stages.push({
+      name: 'encoding',
+      actionRequiredStates: ['waiting_for_confirmation'],
+      activeStates: ['waiting_for_encoding', 'encoding'],
+      failedStates: ['fetching_meta_data_failed', 'encoding_failed']
+    });
+
+    return stages;
+  },
+
+  readyState: 'encoded',
+
+  isConfirmable: function() {
+    return this.get('state') === 'waiting_for_confirmation';
+  },
+
+  isPositionable: function() {
+    return false;
+  }
+});

data/app/assets/javascripts/pageflow/editor/models/entry.js

@@ -6,8 +6,11 @@ pageflow.Entry = Backbone.Model.extend({
 
   mixins: [pageflow.filesCountWatcher, pageflow.polling, pageflow.failureTracking],
 
-  initialize: function() {
-    this.chapters = pageflow.chapters;
+  initialize: function(attributes, options) {
+    options = options || {};
+
+    this.files = options.files || pageflow.files;
+    this.chapters = options.chapters || pageflow.chapters;
     this.chapters.parentModel = this;
     this.pages = pageflow.pages;
 
@@ -15,6 +18,10 @@ pageflow.Entry = Backbone.Model.extend({
     this.videoFiles = pageflow.videoFiles;
     this.audioFiles = pageflow.audioFiles;
 
+    pageflow.editor.fileTypes.each(function(fileType) {
+      this.watchFileCollection(fileType.collectionName, this.getFileCollection(fileType));
+    }, this);
+
     this.listenTo(this.chapters, 'sort', function() {
       this.pages.sort();
     });
@@ -22,10 +29,6 @@ pageflow.Entry = Backbone.Model.extend({
     this.listenTo(this, 'change:title change:summary change:credits change:manual_start change:home_url change:home_button_enabled', function() {
       this.save();
     });
-
-    this.watchFileCollection('image_files', this.imageFiles);
-    this.watchFileCollection('video_files', this.videoFiles);
-    this.watchFileCollection('audio_files', this.audioFiles);
   },
 
   addChapter: function() {
@@ -35,65 +38,31 @@ pageflow.Entry = Backbone.Model.extend({
     });
   },
 
-  addFile: function(file) {
-    var record;
+  addFileUpload: function(upload) {
+    var fileType = pageflow.editor.fileTypes.findByUpload(upload);
+    var file = new fileType.model({
+      state: 'uploading',
+      file_name: upload.name
+    });
 
-    if (file.type.match(/^image/)) {
-      record = new pageflow.ImageFile({
-        state: 'uploading',
-        file_name: file.name
-      });
-      pageflow.imageFiles.add(record);
-    }
-    else if (file.type.match(/^video/)) {
-      record = new pageflow.VideoFile({
-        state: 'uploading',
-        file_name: file.name
-      });
-      pageflow.videoFiles.add(record);
-    }
-    else if (file.type.match(/^audio/)) {
-      record = new pageflow.AudioFile({
-        state: 'uploading',
-        file_name: file.name
-      });
-      pageflow.audioFiles.add(record);
-    }
+    this.getFileCollection(fileType).add(file);
 
-    return record;
+    return file;
   },
 
   addFileUsage: function(file) {
-    this.createFileUsage(file, { success: function(usage) {
+    var fileUsages = new pageflow.FileUsagesCollection([], {
+      entry: this
+    });
+
+    fileUsages.createForFile(file, { success: function(usage) {
       file.set('usage_id', usage.get('id'));
-      this.addFileToCollection(file);
+      this.getFileCollection(file.fileType()).add(file);
     }.bind(this)});
   },
 
-  createFileUsage: function(file, options) {
-    var file_usages = new pageflow.FileUsagesCollection();
-
-    return file_usages.create({
-      file_id: file.get('id'),
-      file_type: file.get('typeName')
-    }, options);
-
-  },
-
-  addFileToCollection: function (file) {
-    this.getFileCollection(file.get('typeName')).add(file);
-  },
-
-  getFileCollection: function(filetype) {
-    return this[lowerCaseFirst(removeNamespace(filetype)) + 's'];
-
-    function removeNamespace(string) {
-      return string.split('::').pop();
-    }
-
-    function lowerCaseFirst(string) {
-      return string.charAt(0).toLowerCase() + string.slice(1);
-    }
+  getFileCollection: function(fileType) {
+    return this.files[fileType.collectionName];
   },
 
   pollForPendingFiles: function() {
@@ -108,13 +77,10 @@ pageflow.Entry = Backbone.Model.extend({
     if (response) {
       this.set(_.pick(response, 'published', 'published_until'));
 
-      this.imageFiles.set(response.image_files, {add: false, remove: false});
-      this.videoFiles.set(response.video_files, {add: false, remove: false});
-      this.audioFiles.set(response.audio_files, {add: false, remove: false});
-
-      delete response.image_files;
-      delete response.video_files;
-      delete response.audio_files;
+      pageflow.editor.fileTypes.each(function(fileType) {
+        this.getFileCollection(fileType).set(response[fileType.collectionName], {add: false, remove: false});
+        delete response[fileType.collectionName];
+      }, this);
     }
 
     return response;