pageflow 0.2.1 → 0.3.0

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

@@ -10,13 +10,6 @@ pageflow.app.addInitializer(function(options) {
   pageflow.app.notificationsRegion.show(new pageflow.NotificationsView().render());
   pageflow.app.helpButtonRegion.show(new pageflow.HelpButtonView().render());
 
-  window.editor = new pageflow.SidebarRouter({
-    controller: new pageflow.SidebarController({
-      region: pageflow.app.sidebarRegion,
-      entry: pageflow.entry
-    })
-  });
-
   Backbone.history.start({root: options.root});
 });
 
@@ -26,4 +19,4 @@ pageflow.app.addRegions({
   dialogRegion: '.dialog_container',
   notificationsRegion: 'sidebar .notifications_container',
   helpButtonRegion: 'sidebar .help_button_container'
-});
+});

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

@@ -0,0 +1,17 @@
+pageflow.app.addInitializer(function() {
+  _.each(pageflow.editor.sideBarRoutings, function(options) {
+    new options.router({
+      controller: new options.controller({
+        region: pageflow.app.sidebarRegion,
+        entry: pageflow.entry
+      })
+    });
+  });
+
+  window.editor = new pageflow.SidebarRouter({
+    controller: new pageflow.SidebarController({
+      region: pageflow.app.sidebarRegion,
+      entry: pageflow.entry
+    })
+  });
+});

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

@@ -6,15 +6,15 @@ pageflow.app.addInitializer(function(options) {
   pageflow.pages = new pageflow.PagesCollection(options.pages);
   pageflow.chapters = new pageflow.ChaptersCollection(options.chapters);
   pageflow.entry = new pageflow.Entry(options.entry);
+  pageflow.theming = new pageflow.Theming(options.theming);
 
   pageflow.pages.sort();
 
-  pageflow.failedRecords = new pageflow.FailedRecordsCollection();
-  pageflow.failedRecords.watch(pageflow.entry);
-  pageflow.failedRecords.watch(pageflow.pages);
-  pageflow.failedRecords.watch(pageflow.chapters);
+  pageflow.editor.failures.watch(pageflow.entry);
+  pageflow.editor.failures.watch(pageflow.pages);
+  pageflow.editor.failures.watch(pageflow.chapters);
 
   pageflow.savingRecords = new pageflow.SavingRecordsCollection();
   pageflow.savingRecords.watch(pageflow.pages);
   pageflow.savingRecords.watch(pageflow.chapters);
-});
+});

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

@@ -10,7 +10,16 @@ pageflow.Configuration = Backbone.Model.extend({
     transition: 'fade',
     text_position: 'left',
     invert: false,
-    hide_title: false
+    hide_title: false,
+    autoplay: true
+  },
+
+  /**
+   * Used by views (i.e. FileInputView) to get id which can be used in
+   * routes to lookup configuration via its page.
+   */
+  getRoutableId: function() {
+    return this.page.id;
   },
 
   getImageFileUrl: function(attribute) {
@@ -96,4 +105,4 @@ pageflow.Configuration = Backbone.Model.extend({
       return clone;
     });
   }
-});
+});

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

@@ -19,7 +19,7 @@ pageflow.Entry = Backbone.Model.extend({
       this.pages.sort();
     });
 
-    this.listenTo(this, 'change:title change:summary change:credits change:manual_start', function() {
+    this.listenTo(this, 'change:title change:summary change:credits change:manual_start change:home_url change:home_button_enabled', function() {
       this.save();
     });
 
@@ -121,6 +121,6 @@ pageflow.Entry = Backbone.Model.extend({
   },
 
   toJSON: function() {
-    return _.pick(this.attributes, 'title', 'summary', 'credits', 'manual_start');
+    return _.pick(this.attributes, 'title', 'summary', 'credits', 'manual_start', 'home_url', 'home_button_enabled');
   }
 });

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

@@ -12,5 +12,5 @@ pageflow.retryable = {
     };
     options.url = this.url() + '/retry';
     return this.sync('post', this, options);
-  },
-};
+  }
+};

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

@@ -0,0 +1,37 @@
+
+pageflow.PageConfigurationFileSelectionHandler = function(options) {
+  pageflow.ConfigurationEditorView.register('audio_loop', {
+    configure: function() {
+      this.tab('general', function() {
+        this.group('general');
+
+        this.input('additional_title', pageflow.TextInputView);
+        this.input('additional_description', pageflow.TextAreaInputView, {size: 'short'});
+      });
+
+      this.tab('files', function() {
+        this.input('audio_file_id', pageflow.FileInputView, {collection: pageflow.audioFiles});
+        this.input('background_image_id', pageflow.FileInputView, {collection: pageflow.imageFiles});
+        this.input('thumbnail_image_id', pageflow.FileInputView, {
+          collection: pageflow.imageFiles,
+          imagePositioning: false
+        });
+      });
+
+      this.tab('options', function() {
+        this.group('options');
+      });
+    }
+  });
+  var page = pageflow.pages.get(options.id);
+
+  this.call = function(file) {
+    page.configuration.setReference(options.attributeName, file);
+  };
+
+  this.getReferer = function() {
+    return '/pages/' + page.id + '/files';
+  };
+};
+
+pageflow.editor.registerFileSelectionHandler('pageConfiguration', pageflow.PageConfigurationFileSelectionHandler);

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

@@ -0,0 +1,8 @@
+pageflow.Theming = Backbone.Model.extend({
+  modelName: 'theming',
+  i18nKey: 'pageflow/theming',
+
+  hasHomeButton: function() {
+    return this.get('home_button');
+  }
+});

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

@@ -0,0 +1,14 @@
+(function() {
+  // Class-y constructor by github.com/opensas
+  // https://github.com/jashkenas/backbone/issues/2601
+
+  pageflow.Object = function(options) {
+      this.initialize.apply(this, arguments);
+  };
+  _.extend(pageflow.Object.prototype, Backbone.Events, {
+      initialize: function(options) {}
+  });
+
+  // The self-propagating extend function that Backbone classes use.
+  pageflow.Object.extend = Backbone.Model.extend;
+}());

data/app/assets/javascripts/pageflow/editor/routers/sidebar_router.js

@@ -4,9 +4,9 @@ pageflow.SidebarRouter = Backbone.Marionette.AppRouter.extend({
     'pages/:id/:tab': 'page',
     'chapters/:id': 'chapter',
 
-    'files/image_files?page=:page_id&attribute=:attribute': 'imageFiles',
-    'files/video_files?page=:page_id&attribute=:attribute': 'videoFiles',
-    'files/audio_files?page=:page_id&attribute=:attribute': 'audioFiles',
+    'files/image_files?handler=:handler&payload=:payload': 'imageFiles',
+    'files/video_files?handler=:handler&payload=:payload': 'videoFiles',
+    'files/audio_files?handler=:handler&payload=:payload': 'audioFiles',
 
     'files/image_files': 'imageFiles',
     'files/video_files': 'videoFiles',
@@ -22,4 +22,4 @@ pageflow.SidebarRouter = Backbone.Marionette.AppRouter.extend({
 
     '.*': 'index'
   }
-});
+});

data/app/assets/javascripts/pageflow/editor/templates/edit_entry.jst.ejs

@@ -2,12 +2,12 @@
 <a class="publish" href="#">Veröffentlichen...</a>
 
 <ul class="menu">
-  <li>    
-    <a class="edit_entry_meta_data" href="#">Titel und Optionen</a>
+  <li>
+    <a class="edit_entry_meta_data" href="#" data-path="/meta_data">Titel und Optionen</a>
     <span class="failure_icon" title="Beim Speichern der Metadaten ist ein Fehler aufgetreten." />
   </li>
-  <li>    
-    <a class="manage_files" href="#">Dateien verwalten</a>
+  <li>
+    <a class="manage_files" href="#" data-path="/files">Dateien verwalten</a>
   </li>
 </ul>
 

data/app/assets/javascripts/pageflow/editor/templates/notifications.jst.ejs

@@ -1,5 +1,5 @@
 <li class="uploading"><span class="count">0</span> Dateien werden gerade hochgeladen.</li>
-<li class="failed"><span class="count">0</span> Datensätze konnten nicht gespeichert werden. <a class="retry">Erneut versuchen</a></li>
+<li class="failed"><span class="count">0</span> <span class="description">Datensätze konnten nicht gespeichert werden.</span> <a class="retry">Erneut versuchen</a></li>
 <li class="saving">Änderungen werden gespeichert...</li>
 <li class="saved">Alle Änderungen wurden gespeichert.</li>
 

data/app/assets/javascripts/pageflow/editor/views/back_button_decorator_view.js

@@ -1,8 +1,9 @@
 pageflow.BackButtonDecoratorView = Backbone.Marionette.Layout.extend({
   template: 'templates/back_button_decorator',
+  className: 'back_button_decorator',
 
   events: {
-    'click a.back': 'goBack',
+    'click a.back': 'goBack'
   },
 
   regions: {
@@ -16,4 +17,4 @@ pageflow.BackButtonDecoratorView = Backbone.Marionette.Layout.extend({
   goBack: function() {
     editor.navigate('/', {trigger: true});
   }
-});
+});

data/app/assets/javascripts/pageflow/editor/views/configuration_editors/audio.js

@@ -13,7 +13,8 @@ pageflow.ConfigurationEditorView.register('audio', {
     });
 
     this.tab('options', function() {
+      this.input('autoplay', pageflow.CheckBoxInputView);
       this.group('options');
     });
   }
-});
+});

data/app/assets/javascripts/pageflow/editor/views/configuration_editors/video.js

@@ -16,7 +16,8 @@ pageflow.ConfigurationEditorView.register('video', {
     });
 
     this.tab('options', function() {
+      this.input('autoplay', pageflow.CheckBoxInputView);
       this.group('options');
     });
   }
-});
+});

data/app/assets/javascripts/pageflow/editor/views/edit_entry_view.js

@@ -4,7 +4,8 @@ pageflow.EditEntryView = Backbone.Marionette.ItemView.extend({
   mixins: [pageflow.failureIndicatingView],
 
   ui: {
-    publicationStateButton: 'a.publication_state'
+    publicationStateButton: 'a.publication_state',
+    menu: '.menu'
   },
 
   events: {
@@ -19,22 +20,19 @@ pageflow.EditEntryView = Backbone.Marionette.ItemView.extend({
       return false;
     },
 
-    'click a.edit_entry_meta_data': function() {
-      editor.navigate('/meta_data', {trigger: true});
-      return false;
+    'click a.add_chapter': function() {
+      this.model.addChapter();
     },
 
-    'click a.manage_files': function() {
-      editor.navigate('/files', {trigger: true});
+    'click .menu a': function(event) {
+      editor.navigate($(event.target).data('path'), {trigger: true});
       return false;
-    },
-
-    'click a.add_chapter': function() {
-      this.model.addChapter();
     }
   },
 
   onRender: function() {
+    this._addMenuItems();
+
     this.subview(new pageflow.SortableCollectionView({
       el: this.$('ul.chapters'),
       collection: this.model.chapters,
@@ -45,5 +43,19 @@ pageflow.EditEntryView = Backbone.Marionette.ItemView.extend({
         }
       }
     }));
+  },
+
+  _addMenuItems: function() {
+    var view = this;
+
+    _.each(pageflow.editor.mainMenuItems, function(options) {
+      var item = $('<li><a href="#"></a></li>');
+      var link = item.find('a');
+
+      link.data('path', options.path);
+      link.text(I18n.t(options.translationKey));
+
+      view.ui.menu.append(item);
+    });
   }
-});
+});

data/app/assets/javascripts/pageflow/editor/views/edit_meta_data_view.js

@@ -1,13 +1,13 @@
 /*global editor*/
 
-pageflow.EditMetaDataView = Backbone.Marionette.ItemView.extend({
+pageflow.EditMetaDataView = Backbone.Marionette.Layout.extend({
   template: 'templates/edit_meta_data',
   className: 'edit_meta_data',
 
   mixins: [pageflow.failureIndicatingView],
 
-  ui: {
-    form: '.form_fields'
+  regions: {
+    formContainer: '.form_fields'
   },
 
   events: {
@@ -15,25 +15,31 @@ pageflow.EditMetaDataView = Backbone.Marionette.ItemView.extend({
   },
 
   onRender: function() {
-    this.ui.form.append(this.subview(new pageflow.TextInputView({
-      model: this.model,
-      propertyName: 'title'
-    })).el);
-
-    this.ui.form.append(this.subview(new pageflow.TextAreaInputView({
-      model: this.model,
-      propertyName: 'summary'
-    })).el);
-
-    this.ui.form.append(this.subview(new pageflow.TextAreaInputView({
-      model: this.model,
-      propertyName: 'credits'
-    })).el);
-
-    this.ui.form.append(this.subview(new pageflow.CheckBoxInputView({
-      model: this.model,
-      propertyName: 'manual_start'
-    })).el);
+    var configurationEditor = new pageflow.ConfigurationEditorView({
+      model: this.model
+    });
+
+    configurationEditor.tab('general', function() {
+      this.input('title', pageflow.TextInputView);
+      this.input('summary', pageflow.TextAreaInputView);
+      this.input('credits', pageflow.TextAreaInputView);
+    });
+
+    configurationEditor.tab('widgets', function() {
+      this.input('manual_start', pageflow.CheckBoxInputView);
+      this.input('home_button_enabled', pageflow.CheckBoxInputView, {
+        disabled: !pageflow.theming.hasHomeButton(),
+        displayUncheckedIfDisabled: true
+      });
+      if (pageflow.theming.hasHomeButton()) {
+        this.input('home_url', pageflow.TextInputView, {
+          placeholder: pageflow.theming.get('pretty_url'),
+          visibleBinding: 'home_button_enabled'
+        });
+      }
+    });
+
+    this.formContainer.show(configurationEditor);
   },
 
   goBack: function() {

data/app/assets/javascripts/pageflow/editor/views/entry_preview_view.js

@@ -21,7 +21,11 @@ pageflow.EntryPreviewView = Backbone.Marionette.ItemView.extend({
 
     this.update();
 
-    this.listenTo(pageflow.entry, 'sync:order change:credits', this.update);
+    this.listenTo(pageflow.entry, 'sync:order', this.update);
+    this.listenTo(pageflow.entry, 'change:credits change:home_url change:home_button_enabled', function() {
+      pageflow.entry.once('sync', this.update, this);
+    });
+
     this.listenTo(pageflow.chapters, 'sync', this.update);
     this.listenTo(pageflow.pages, 'sync', this.update);
 

data/app/assets/javascripts/pageflow/editor/views/file_item_view.js

@@ -23,7 +23,8 @@ pageflow.FileItemView = Backbone.Marionette.ItemView.extend({
 
   events: {
     'click .select': function() {
-      this.$el.trigger('file-selected', this.model);
+      this.options.selectionHandler.call(this.model);
+      pageflow.editor.navigate(this.options.selectionHandler.getReferer(), {trigger: true});
       return false;
     },
 
@@ -71,7 +72,7 @@ pageflow.FileItemView = Backbone.Marionette.ItemView.extend({
     this.ui.downloadLink.attr('href', this.model.get('url'));
     this.ui.downloads.toggle(this.model.isUploaded());
 
-    this.ui.selectButton.toggle(this.options.selectable);
+    this.ui.selectButton.toggle(!!this.options.selectionHandler);
 
     this.ui.cancelButton.toggle(this.model.isUploading());
     this.ui.removeButton.toggle(!this.model.isUploading());

data/app/assets/javascripts/pageflow/editor/views/files_view.js

@@ -61,7 +61,7 @@ pageflow.FilesView = Backbone.Marionette.ItemView.extend({
         collection: options.collection,
         itemViewConstructor: options.itemView,
         itemViewOptions: {
-          selectable: this.options.tabName === name
+          selectionHandler: this.options.tabName === name && this.options.selectionHandler
         },
         blankSlateViewConstructor: Backbone.Marionette.ItemView.extend({
           template: 'templates/files_blank_slate'
@@ -75,8 +75,8 @@ pageflow.FilesView = Backbone.Marionette.ItemView.extend({
   },
 
   goBack: function() {
-    if (this.options.page) {
-      editor.navigate('/pages/' + this.options.page.id + '/files', {trigger: true});
+    if (this.options.selectionHandler) {
+      editor.navigate(this.options.selectionHandler.getReferer(), {trigger: true});
     }
     else {
       editor.navigate('/', {trigger: true});
@@ -85,12 +85,5 @@ pageflow.FilesView = Backbone.Marionette.ItemView.extend({
 
   upload: function() {
     pageflow.app.trigger('request-upload');
-  },
-
-  updatePage: function(event, file) {
-    if (this.options.page) {
-      this.options.page.configuration.setReference(this.options.pageAttributeName, file);
-      this.goBack();
-    }
   }
 });