pageflow 0.9.2 → 0.10.0

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

@@ -4,9 +4,10 @@ pageflow.SidebarController = Backbone.Marionette.Controller.extend({
     this.entry = options.entry;
   },
 
-  index: function() {
+  index: function(storylineId) {
     this.region.show(new pageflow.EditEntryView({
-      model: this.entry
+      model: this.entry,
+      storylineId: storylineId
     }));
   },
 
@@ -45,6 +46,12 @@ pageflow.SidebarController = Backbone.Marionette.Controller.extend({
     pageflow.editor.setDefaultHelpEntry('pageflow.help_entries.publish');
   },
 
+  storyline: function(id) {
+    this.region.show(new pageflow.EditStorylineView({
+      model: this.entry.storylines.get(id)
+    }));
+  },
+
   chapter: function(id) {
     this.region.show(new pageflow.EditChapterView({
       model: this.entry.chapters.get(id)
@@ -60,5 +67,15 @@ pageflow.SidebarController = Backbone.Marionette.Controller.extend({
     }));
 
     pageflow.editor.setDefaultHelpEntry(page.pageType().help_entry_translation_key);
+  },
+
+  pageLink: function(linkId) {
+    var pageId = linkId.split(':')[0];
+    var page = pageflow.pages.getByPermaId(pageId);
+
+    this.region.show(new pageflow.EditPageLinkView({
+      model: page.pageLinks().get(linkId),
+      page: page
+    }));
   }
 });

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

@@ -2,5 +2,5 @@ pageflow.app.addInitializer(function(options) {
   pageflow.editLock = new pageflow.EditLockContainer();
 
   pageflow.editLock.watchForErrors();
-  pageflow.editLock.aquire();
+  pageflow.editLock.acquire();
 });

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

@@ -7,18 +7,29 @@ pageflow.app.addInitializer(function(options) {
 
   pageflow.pages = new pageflow.PagesCollection(options.pages);
   pageflow.chapters = new pageflow.ChaptersCollection(options.chapters);
+  pageflow.storylines = new pageflow.StorylinesCollection(options.storylines);
   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({
+    storylines: pageflow.storylines,
     chapters: pageflow.chapters,
     pages: pageflow.pages,
     theming: pageflow.theming
   });
 
+  pageflow.storylineOrdering = new pageflow.StorylineOrdering(pageflow.storylines, pageflow.pages);
+  pageflow.storylineOrdering.sort({silent: true});
+  pageflow.storylineOrdering.watch();
+
   pageflow.pages.sort();
 
+  // TODO
+  pageflow.storylines.on('sort', _.debounce(function() {
+    pageflow.storylines.saveOrder();
+  }, 100));
+
   pageflow.editor.failures.watch(pageflow.entry);
   pageflow.editor.failures.watch(pageflow.pages);
   pageflow.editor.failures.watch(pageflow.chapters);

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

@@ -0,0 +1,3 @@
+pageflow.app.addInitializer(function(options) {
+  pageflow.seed = options.common;
+});

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

@@ -0,0 +1,11 @@
+pageflow.app.addInitializer(function(options) {
+  pageflow.entry.on('change:pending_files_count', function(model, value) {
+    if (value < pageflow.entry.previous('pending_files_count')) {
+      pageflow.reloadStylesheet('entry');
+    }
+  });
+
+  pageflow.entry.on('use:file', function() {
+    pageflow.reloadStylesheet('entry');
+  });
+});

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

@@ -29,17 +29,24 @@ pageflow.Chapter = Backbone.Model.extend({
     return this.isNew() ? this.collection.url() : '/chapters';
   },
 
-  addPage: function(options) {
-    options = options || {};
+  storylinePosition: function() {
+    return (this.storyline && this.storyline.get('position')) || -1;
+  },
+
+  addPage: function(attributes) {
+    var page = this.buildPage(attributes);
+    page.save();
 
-    var pos = ('position' in options) ? options.position : this.pages.length;
+    return page;
+  },
 
-    var create_opts = {
-      chapter_id: this.get('id'),
-      position: pos
+  buildPage: function(attributes) {
+    var defaults = {
+      chapter_id: this.id,
+      position: this.pages.length
     };
 
-    return this.pages.create(create_opts);
+    return this.pages.addAndReturnModel(_.extend(defaults, attributes));
   },
 
   toJSON: function() {

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

@@ -0,0 +1,13 @@
+pageflow.ChapterScaffold = pageflow.Scaffold.extend({
+  build: function() {
+    this.chapter = this.parent.buildChapter(this.options.chapterAttributes);
+    this.page = this.chapter.buildPage();
+
+    return this.chapter;
+  },
+
+  load: function(response) {
+    this.chapter.set(response.chapter);
+    this.page.set(response.page);
+  }
+});

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

@@ -3,7 +3,7 @@ pageflow.EditLockContainer = Backbone.Model.extend({
     this.storageKey = 'pageflow.edit_lock.' + pageflow.entry.id;
   },
 
-  aquire: function(options) {
+  acquire: function(options) {
     options = options || {};
     var container = this;
 
@@ -18,7 +18,7 @@ pageflow.EditLockContainer = Backbone.Model.extend({
         sessionStorage[container.storageKey] = lock.id;
 
         container.lock = lock;
-        container.trigger('aquired');
+        container.trigger('acquired');
 
         container.startPolling();
       }
@@ -28,7 +28,7 @@ pageflow.EditLockContainer = Backbone.Model.extend({
   startPolling: function() {
     if (!this.pollingInteval) {
       this.pollingInteval = setInterval(_.bind(function() {
-        this.aquire({polling: true});
+        this.acquire({polling: true});
       }, this), 2000);
     }
   },
@@ -78,7 +78,7 @@ pageflow.EditLockContainer = Backbone.Model.extend({
     this.trigger('locked',
                  xhr.responseJSON || {},
                  {
-                   context: (settings.url.match(/\/edit_lock/) && !settings.polling) ? 'aquire' : 'other'
+                   context: (settings.url.match(/\/edit_lock/) && !settings.polling) ? 'acquire' : 'other'
                  });
 
     this.stopPolling();

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

@@ -19,6 +19,8 @@ pageflow.Entry = Backbone.Model.extend({
     this.configuration.parent = this;
 
     this.files = options.files || pageflow.files;
+    this.storylines = options.storylines || pageflow.storylines;
+    this.storylines.parentModel = this;
     this.chapters = options.chapters || pageflow.chapters;
     this.chapters.parentModel = this;
     this.pages = pageflow.pages;
@@ -31,6 +33,10 @@ pageflow.Entry = Backbone.Model.extend({
       this.watchFileCollection(fileType.collectionName, this.getFileCollection(fileType));
     }, this);
 
+    this.listenTo(this.storylines, 'sort', function() {
+      this.pages.sort();
+    });
+
     this.listenTo(this.chapters, 'sort', function() {
       this.pages.sort();
     });
@@ -49,13 +55,34 @@ pageflow.Entry = Backbone.Model.extend({
     });
   },
 
-  addChapter: function(params) {
+  addStoryline: function(attributes) {
+    var storyline = this.buildStoryline(attributes);
+    storyline.save();
+
+    return storyline;
+  },
+
+  buildStoryline: function(attributes) {
     var defaults = {
-      entry_id: this.get('id'),
       title: '',
-      position: this.chapters.length
     };
-    return this.chapters.create(_.extend(defaults, params));
+
+    return this.storylines.addAndReturnModel(_.extend(defaults, attributes));
+  },
+
+  scaffoldStoryline: function(options) {
+    var scaffold = new pageflow.StorylineScaffold(this, options);
+    scaffold.create();
+
+    return scaffold;
+  },
+
+  addChapterInNewStoryline: function(options) {
+    return this.scaffoldStoryline(_.extend({depth: 'chapter'}, options)).chapter;
+  },
+
+  addPageInNewStoryline: function(options) {
+    return this.scaffoldStoryline(_.extend({depth: 'page'}, options)).page;
   },
 
   addFileUpload: function(upload) {
@@ -78,6 +105,8 @@ pageflow.Entry = Backbone.Model.extend({
     fileUsages.createForFile(file, { success: function(usage) {
       file.set('usage_id', usage.get('id'));
       this.getFileCollection(file.fileType()).add(file);
+
+      this.trigger('use:file', file);
     }.bind(this)});
   },
 

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

@@ -0,0 +1,18 @@
+pageflow.persistedPromise = {
+  persisted: function() {
+    var model = this;
+
+    this._persistedDeferred = this._persistedDeferred || jQuery.Deferred(function(deferred) {
+      if (model.isNew()) {
+        model.once('change:id', deferred.resolve);
+      }
+      else {
+        deferred.resolve();
+      }
+    });
+
+    return this._persistedDeferred.promise();
+  }
+};
+
+Cocktail.mixin(Backbone.Model, pageflow.persistedPromise);

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

@@ -39,6 +39,10 @@ pageflow.Page = Backbone.Model.extend({
     return this.isNew() ? this.collection.url() : '/pages';
   },
 
+  storylinePosition: function() {
+    return (this.chapter && this.chapter.storylinePosition()) || -1;
+  },
+
   chapterPosition: function() {
     return (this.chapter && this.chapter.get('position')) || -1;
   },

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

@@ -0,0 +1,37 @@
+pageflow.PageLink = Backbone.Model.extend({
+  mixins: [pageflow.transientReferences],
+
+  i18nKey: 'pageflow/page_link',
+
+  targetPage: function() {
+    return pageflow.pages.getByPermaId(this.get('target_page_id'));
+  },
+
+  label: function() {
+    return this.get('label');
+  },
+
+  editPath: function() {
+    return '/page_links/' + this.id;
+  },
+
+  getPageId: function() {
+    return this.collection.page.id;
+  },
+
+  toSerializedJSON: function() {
+    return _.omit(this.attributes, 'highlighted', 'position');
+  },
+
+  highlight: function() {
+    this.set('highlighted', true);
+  },
+
+  resetHighlight: function() {
+    this.unset('highlighted');
+  },
+
+  remove: function() {
+    this.collection.remove(this);
+  }
+});

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

@@ -0,0 +1,14 @@
+pageflow.PageLinkFileSelectionHandler = function(options) {
+  var page = pageflow.pages.getByPermaId(options.id.split(':')[0]);
+  var pageLink = page.pageLinks().get(options.id);
+
+  this.call = function(file) {
+    pageLink.setReference(options.attributeName, file);
+  };
+
+  this.getReferer = function() {
+    return '/page_links/' + pageLink.id;
+  };
+};
+
+pageflow.editor.registerFileSelectionHandler('pageLink', pageflow.PageLinkFileSelectionHandler);

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

@@ -1,5 +1,6 @@
 pageflow.PreviewEntryData = pageflow.EntryData.extend({
   initialize: function(options) {
+    this.storylines = options.storylines;
     this.chapters = options.chapters;
     this.pages = options.pages;
     this.theming = options.theming;
@@ -9,6 +10,11 @@ pageflow.PreviewEntryData = pageflow.EntryData.extend({
     return this.theming.get(name);
   },
 
+  getStorylineConfiguration: function(id) {
+    var storyline = this.storylines.get(id);
+    return storyline ? storyline.configuration.attributes : {};
+  },
+
   getChapterConfiguration: function(id) {
     var chapter = this.chapters.get(id);
     return chapter ? chapter.configuration.attributes : {};
@@ -19,6 +25,11 @@ pageflow.PreviewEntryData = pageflow.EntryData.extend({
     return chapter ? chapter.pages.pluck('perma_id') : [];
   },
 
+  getStorylineIdByChapterId: function(id) {
+    var chapter = this.chapters.get(id);
+    return chapter && chapter.get('storyline_id');
+  },
+
   getChapterIdByPagePermaId: function(permaId) {
     var page = this.pages.getByPermaId(permaId);
     return page && page.get('chapter_id');
@@ -27,5 +38,9 @@ pageflow.PreviewEntryData = pageflow.EntryData.extend({
   getPageConfiguration: function(permaId) {
     var page = this.pages.getByPermaId(permaId);
     return page ? page.configuration.attributes : {};
+  },
+
+  getPagePosition: function(permaId) {
+    return this.pages.indexOf(this.pages.getByPermaId(permaId));
   }
 });

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

@@ -0,0 +1,26 @@
+pageflow.Scaffold = pageflow.Object.extend({
+  initialize: function(parent, options) {
+    this.parent = parent;
+    this.options = options || {};
+  },
+
+  create: function() {
+    var scaffold = this;
+    var query = this.options.depth ? '?depth=' + this.options.depth : '';
+
+    this.model = this.build();
+
+    Backbone.sync('create', this.model, {
+      url: this.model.url() + '/scaffold' + query,
+
+      success: function(response) {
+        scaffold.load(response);
+        scaffold.model.trigger('sync', scaffold.model, response, {});
+      }
+    });
+  },
+
+  build: function() {},
+
+  load: function() {}
+});

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

@@ -0,0 +1,99 @@
+pageflow.Storyline = Backbone.Model.extend({
+  modelName: 'storyline',
+  paramRoot: 'storyline',
+  i18nKey: 'pageflow/storyline',
+
+  mixins: [pageflow.failureTracking, pageflow.delayedDestroying],
+
+  initialize: function(attributes, options) {
+    this.chapters = new pageflow.StorylineChaptersCollection({
+      chapters: options.chapters || pageflow.chapters,
+      storyline: this
+    });
+
+    this.configuration = new pageflow.StorylineConfiguration(this.get('configuration') || {});
+
+    this.listenTo(this.configuration, 'change', function() {
+      this.save();
+      this.trigger('change:configuration', this);
+    });
+
+    this.listenTo(this.configuration, 'change:main', function(model, value) {
+      this.trigger('change:main', this, value);
+    });
+  },
+
+  urlRoot: function() {
+    return this.isNew() ? this.collection.url() : '/storylines';
+  },
+
+  displayTitle: function() {
+    return _([
+      this.title() ||
+        (!this.isMain() && I18n.t('pageflow.storylines.untitled')),
+      this.isMain() && I18n.t('pageflow.storylines.main')
+    ]).compact().join(' - ');
+  },
+
+  title: function() {
+    return this.configuration.get('title');
+  },
+
+  isMain: function() {
+    return !!this.configuration.get('main');
+  },
+
+  lane: function() {
+    return this.configuration.get('lane');
+  },
+
+  row: function() {
+    return this.configuration.get('row');
+  },
+
+  parentPagePermaId: function() {
+    return this.configuration.get('parent_page_perma_id');
+  },
+
+  parentPage: function() {
+    return pageflow.pages.getByPermaId(this.parentPagePermaId());
+  },
+
+  transitiveChildPages: function() {
+    return new pageflow.StorylineTransitiveChildPages(this, pageflow.storylines, pageflow.pages);
+  },
+
+  addChapter: function(attributes) {
+    var chapter = this.buildChapter(attributes);
+    chapter.save();
+
+    return chapter;
+  },
+
+  buildChapter: function(attributes) {
+    var defaults = {
+      storyline_id: this.id,
+      title: '',
+      position: this.chapters.length
+    };
+
+    return this.chapters.addAndReturnModel(_.extend(defaults, attributes));
+  },
+
+  scaffoldChapter: function(options) {
+    var scaffold = new pageflow.ChapterScaffold(this, options);
+    scaffold.create();
+
+    return scaffold;
+  },
+
+  toJSON: function() {
+    return {
+      configuration: this.configuration.toJSON()
+    };
+  },
+
+  destroy: function() {
+    this.destroyWithDelay();
+  }
+});