pageflow 0.8.2 → 0.9.0

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

@@ -11,6 +11,21 @@ pageflow.EditorApi = pageflow.Object.extend({
     this.initializers = [];
     this.fileSelectionHandlers = {};
 
+    /**
+     *  Display Backbone/Marionette View inside the main panel
+     *  of the editor.
+     */
+    this.showViewInMainPanel = function(view) {
+      pageflow.app.mainRegion.show(view);
+    };
+
+    /**
+     *  Display the Pageflow-Preview inside the main panel.
+     */
+    this.showPreview = function() {
+      pageflow.app.mainRegion.$el.empty();
+    };
+
     /**
      * Register additional router and controller for sidebar.
      *
@@ -44,6 +59,7 @@ pageflow.EditorApi = pageflow.Object.extend({
      * Supported options:
      * - translationKey: for the label
      * - path: route to link to
+     * - click: click handler
      */
     this.registerMainMenuItem = function(options) {
       this.mainMenuItems.push(options);
@@ -121,6 +137,14 @@ pageflow.EditorApi = pageflow.Object.extend({
       this.navigate('/files/' + fileType + '?handler=' + handlerName + '&payload=' + encodeURIComponent(JSON.stringify(payload)), {trigger: true});
     };
 
+    /**
+     * Returns a promise which resolves to a page selected by the
+     * user.
+     */
+    this.selectPage = function() {
+      return pageflow.PageSelectionView.selectPage();
+    };
+
     /**
      * Failures API
      *
@@ -136,6 +160,11 @@ pageflow.EditorApi = pageflow.Object.extend({
      */
     this.failures = new pageflow.FailuresAPI();
 
+    /**
+     * Setup editor integration for page types.
+     */
+    this.pageTypes = new pageflow.PageTypes();
+
     /**
      *
      */

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

@@ -0,0 +1,42 @@
+pageflow.PageType = pageflow.Object.extend({
+  initialize: function(name, options, seed) {
+    this.name = name;
+    this.options = options;
+    this.seed = seed;
+  },
+
+  translationKey: function() {
+    return this.seed.translation_key;
+  },
+
+  thumbnailCandidates: function() {
+    return this.seed.thumbnail_candidates;
+  },
+
+  pageLinks: function(configuration) {
+    if ('pageLinks' in this.options) {
+      return this.options.pageLinks(configuration);
+    }
+  },
+
+  configurationEditorView: function() {
+    return this.options.configurationEditorView ||
+      pageflow.ConfigurationEditorView.repository[this.name];
+  },
+
+  embeddedViews: function() {
+    return this.options.embeddedViews;
+  },
+
+  createConfigurationEditorView: function(options) {
+    var constructor = this.configurationEditorView();
+    options.pageType = this.seed;
+
+    return new constructor(_.extend({
+      attributeTranslationKeyPrefixes: [
+        this.seed.translation_key_prefix + '.page_attributes',
+        'pageflow.common_page_attributes'
+      ]
+    }, options));
+  }
+});

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

@@ -0,0 +1,47 @@
+pageflow.PageTypes = pageflow.Object.extend({
+  initialize: function() {
+    this.clientSideConfigs = {};
+  },
+
+  register: function(name, config) {
+    if (this._setup) {
+      throw 'Page types already set up. Register page types before initializers run.';
+    }
+
+    this.clientSideConfigs[name] = config;
+  },
+
+  setup: function(serverSideConfigs) {
+    var clientSideConfigs = this.clientSideConfigs;
+    this._setup = true;
+
+    this.pageTypes = _.map(serverSideConfigs, function(serverSideConfig) {
+      var clientSideConfig = clientSideConfigs[serverSideConfig.name] || {};
+      return new pageflow.PageType(serverSideConfig.name, clientSideConfig, serverSideConfig);
+    });
+  },
+
+  findByName: function(name) {
+     var result = this.find(function(pageType) {
+      return pageType.name === name;
+    });
+
+    if (!result) {
+      throw('Could not find page type with name "' + name +'"');
+    }
+
+    return result;
+  }
+});
+
+_.each(['each', 'map', 'reduce', 'first', 'find', 'pluck'], function(method) {
+  pageflow.PageTypes.prototype[method] = function() {
+    if (!this._setup) {
+      throw  'Page types are not yet set up.';
+    }
+
+    var args = Array.prototype.slice.call(arguments);
+    args.unshift(this.pageTypes);
+    return _[method].apply(_, args);
+  };
+});

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

@@ -19,6 +19,7 @@
 //= require ./models/uploaded_file
 //= require ./models/hosted_file
 //= require ./models/encoded_file
+//= require ./models/configuration
 //= require_tree ./models
 //= require_tree ./collections/mixins
 //= require ./collections/multi_collection
@@ -29,18 +30,23 @@
 //= require_tree ./templates
 
 //= require_tree ./views/mixins
+//= require ./views/model_thumbnail_view
 //= require ./views/file_item_view
 //= require ./views/chapter_item_view
 //= require ./views/page_item_view
+//= require ./views/inputs/reference_input_view
 //= require_tree ./views/configuration_editors
 //= require_tree ./views
 
 //= require ./initializers/setup_config
+//= require ./initializers/setup_features
+//= require ./initializers/setup_audio
 //= require ./initializers/setup_help_entries
 //= require ./initializers/setup_file_types
 //= require ./initializers/setup_widget_types
 //= require ./initializers/setup_collections
 //= require ./initializers/setup_page_types
+//= require ./initializers/setup_hotkeys
 //= require ./initializers/edit_lock
 //= require ./initializers/files_polling
 //= require ./initializers/routing
@@ -55,7 +61,7 @@ pageflow.startEditor = function(options) {
   jQuery(function() {
     $.when(
       $.getJSON('/editor/entries/' + options.entryId + '/seed'),
-      pageflow.features.detect()
+      pageflow.browser.detectFeatures()
     )
       .done(function(result) {
         pageflow.app.start(result[0]);

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

@@ -16,10 +16,14 @@ pageflow.SubsetCollection = Backbone.Collection.extend({
 
     this.listenTo(this.parent, 'add', function(model, collection, options) {
       if (!adding && this.filter(model)) {
-        this.add(model, collection, options);
+        this.add(model, options);
       }
     });
 
+    this.listenTo(this.parent, 'remove', function(model) {
+      this.remove(model);
+    });
+
     this.listenTo(this, 'add', function(model, collection, options) {
       adding = true;
       this.parent.add(model);

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

@@ -3,10 +3,16 @@ pageflow.app.addInitializer(function(options) {
     el: $('body')
   }).render();
 
-  pageflow.app.mainRegion.show(new pageflow.EntryPreviewView({
+  new pageflow.ScrollingView({
+    el: $('sidebar .scrolling'),
+    region: pageflow.app.sidebarRegion
+  }).render();
+
+  pageflow.app.previewRegion.show(new pageflow.EntryPreviewView({
     model: pageflow.entry
   }));
 
+  pageflow.app.indicatorsRegion.show(new pageflow.DisabledAtmoIndicatorView().render());
   pageflow.app.notificationsRegion.show(new pageflow.NotificationsView().render());
   pageflow.app.helpButtonRegion.show(new pageflow.HelpButtonView().render());
 
@@ -14,7 +20,9 @@ pageflow.app.addInitializer(function(options) {
 });
 
 pageflow.app.addRegions({
-  mainRegion: 'main',
+  previewRegion: '#entry_preview',
+  mainRegion: '#main_content',
+  indicatorsRegion: '#editor_indicators',
   sidebarRegion: 'sidebar .container',
   dialogRegion: '.dialog_container',
   notificationsRegion: 'sidebar .notifications_container',

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

@@ -0,0 +1,8 @@
+pageflow.app.addInitializer(function(options) {
+  pageflow.Audio.setup({
+    getSources: function(audioFileId) {
+      var file = pageflow.audioFiles.get(audioFileId);
+      return file ? file.getSources() : '';
+    }
+  });
+});

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

@@ -9,6 +9,13 @@ pageflow.app.addInitializer(function(options) {
   pageflow.chapters = new pageflow.ChaptersCollection(options.chapters);
   pageflow.entry = new pageflow.Entry(options.entry);
   pageflow.theming = new pageflow.Theming(options.theming);
+  pageflow.account = new Backbone.Model(options.account);
+
+  pageflow.entryData = new pageflow.PreviewEntryData({
+    chapters: pageflow.chapters,
+    pages: pageflow.pages,
+    theming: pageflow.theming
+  });
 
   pageflow.pages.sort();
 

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

@@ -0,0 +1,3 @@
+pageflow.app.addInitializer(function(options) {
+  pageflow.features.enable('editor', options.entry.enabled_feature_names);
+});

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

@@ -0,0 +1,20 @@
+pageflow.app.addInitializer(function(options) {
+  var KEY_A = 65;
+  var KEY_X = 88;
+
+  $(document).on('keydown', function(event) {
+    if (event.altKey && event.which === KEY_A) {
+      if (pageflow.features.isEnabled('atmo')) {
+        if (pageflow.atmo.disabled) {
+          pageflow.atmo.enable();
+        }
+        else {
+          pageflow.atmo.disable();
+        }
+      }
+    }
+    else if (event.altKey && event.which === KEY_X) {
+      pageflow.editor.navigate('pages/' + pageflow.slides.currentPage().data('id'), {trigger: true});
+    }
+  });
+});

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

@@ -1,8 +1,3 @@
 pageflow.app.addInitializer(function(options) {
-  pageflow.Page.types = options.page_types;
-
-  pageflow.Page.typesByName = _.reduce(options.page_types, function(memo, pageType) {
-    memo[pageType.name] = pageType;
-    return memo;
-  }, {});
+  pageflow.editor.pageTypes.setup(options.page_types);
 });

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

@@ -1,3 +1,11 @@
 pageflow.AudioFile = pageflow.EncodedFile.extend({
   thumbnailPictogram: 'audio',
+
+  getSources: function(attribute) {
+    if (this.isReady()) {
+      return this.get('sources') ? this.get('sources') : '';
+    }
+
+    return '';
+  },
 });

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

@@ -15,6 +15,13 @@ pageflow.Chapter = Backbone.Model.extend({
       this.save();
     });
 
+    this.configuration = new pageflow.ChapterConfiguration(this.get('configuration') || {});
+
+    this.listenTo(this.configuration, 'change', function() {
+      this.save();
+      this.trigger('change:configuration', this);
+    });
+
     return attributes;
   },
 
@@ -22,14 +29,26 @@ pageflow.Chapter = Backbone.Model.extend({
     return this.isNew() ? this.collection.url() : '/chapters';
   },
 
-  addPage: function() {
-    this.pages.create({
+  addPage: function(options) {
+    options = options || {};
+
+    var pos = ('position' in options) ? options.position : this.pages.length;
+
+    var create_opts = {
       chapter_id: this.get('id'),
-      position: this.pages.length
+      position: pos
+    };
+
+    return this.pages.create(create_opts);
+  },
+
+  toJSON: function() {
+    return _.extend(_.clone(this.attributes), {
+      configuration: this.configuration.toJSON()
     });
   },
 
   destroy: function() {
     this.destroyWithDelay();
   }
-});
+});

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

@@ -0,0 +1,7 @@
+pageflow.ChapterConfiguration = pageflow.Configuration.extend({
+  modelName: 'chapter',
+  i18nKey: 'pageflow/chapter',
+
+  defaults: {
+  }
+});

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

@@ -22,11 +22,13 @@ pageflow.Configuration = Backbone.Model.extend({
     return this.parent.id;
   },
 
-  getImageFileUrl: function(attribute) {
+  getImageFileUrl: function(attribute, options) {
+    options = options || {};
+
     var file = this.getImageFile(attribute);
 
     if (file && file.isReady()) {
-      return file.get('url');
+      return file.get(options.styleGroup ? options.styleGroup + '_url' : 'url');
     }
 
     return '';
@@ -110,7 +112,7 @@ pageflow.Configuration = Backbone.Model.extend({
 
     return _.map(sources, function(source) {
       var clone = _.clone(source);
-      clone.src = clone.src + '?e=' + parent.id;
+      clone.src = clone.src + '?e=' + parent.id + '&t=' + new Date().getTime();
       return clone;
     });
   }

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

@@ -49,11 +49,13 @@ pageflow.Entry = Backbone.Model.extend({
     });
   },
 
-  addChapter: function() {
-    this.chapters.create({
+  addChapter: function(params) {
+    var defaults = {
       entry_id: this.get('id'),
+      title: '',
       position: this.chapters.length
-    });
+    };
+    return this.chapters.create(_.extend(defaults, params));
   },
 
   addFileUpload: function(upload) {
@@ -93,7 +95,7 @@ pageflow.Entry = Backbone.Model.extend({
 
   parse: function(response, options) {
     if (response) {
-      this.set(_.pick(response, 'published', 'published_until'));
+      this.set(_.pick(response, 'published', 'published_until', 'password_protected'));
 
       pageflow.editor.fileTypes.each(function(fileType) {
         this.getFileCollection(fileType).set(response[fileType.collectionName], {add: false, remove: false});

data/app/assets/javascripts/pageflow/editor/models/mixins/delayed_destroying.js

@@ -6,8 +6,8 @@ pageflow.delayedDestroying = {
   destroyWithDelay: function() {
     var model = this;
 
-    this.trigger('destroying', this);
     this._destroying = true;
+    this.trigger('destroying', this);
 
     return Backbone.Model.prototype.destroy.call(this, {
       wait: true,

data/app/assets/javascripts/pageflow/editor/models/mixins/stage_provider.js

@@ -1,8 +1,9 @@
 pageflow.stageProvider = {
   initialize: function() {
     var finishedStates = [this.readyState];
+    var stages = _.result(this, 'stages') || [];
 
-    this.stages = new Backbone.Collection(_.chain(this).result('stages').slice().reverse().map(function (options) {
+    this.stages = new Backbone.Collection(_.chain(stages).slice().reverse().map(function (options) {
       var name = options.name;
 
       options.file = this;
@@ -20,4 +21,4 @@ pageflow.stageProvider = {
       return stage.get('active') || stage.get('action_required') || stage.get('failed');
     });
   }
-};
+};