pageflow 0.2.1 → 0.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZGI1ZGVmY2NmOTFiNTVmOGRjMTY0NWVlYmM1MjlhMzQwMWVlYThhZQ==
+    MjhlOGVhOTIyNDNiMDdkM2ViMjUwODE4NDUzM2M3NmZkOGEzOGU5ZQ==
   data.tar.gz: !binary |-
-    NWExZTYwMWI4MWFlYjkzMjA1N2NjZGE1NzAxZTM3MmMxZDYyNTI1MQ==
+    ZWE2YTAzZDFkZTZlODk3OGM0ZWY1ODIwMTBjYzJlNmEwNWQwY2ZkYQ==
 SHA512:
   metadata.gz: !binary |-
-    YzBhYTViN2ZmOGQwZGRmNmQxOTY5Njk0ZjZiYjAyNDE2NDFjYjYxOGIxNThh
-    MTNjNTNjMjczMDdjOWRjN2I0MTk1MTZkMjY0OTRhZWZiNjdiM2U1ODZiNWRh
-    YTBjMjUwNDcyZDk4ZTJkMjA5NmY4NDkwNjlhOWQwYTBiNjAyYzU=
+    ZWYxZjhmNDk0ODZmMGNiMDc1NGE1ODc5OWVlNzMyZjg2MDk3OWE2MmNmNGVj
+    NmViNTgzYTgwODYxZTJiNTQ5MjQxNGY0N2I0MzIxNTM2OWNhMDM4YzA1YzAz
+    OTllNzVmZDMzN2E5YzQ3ODA2ZTAzYmNiOTMzZDM5ZTZiYTFlYTE=
   data.tar.gz: !binary |-
-    YmY1MzBjNDNkNmY5OTI5ODNlYTIwMmQxOTZiOGFhZDEyMGE5NDBmZTMzY2M5
-    ZGY0Zjc5NDZhZWVhYzJjNWI3MDg0OTIwMTc1OWVlY2U1ZTczYTQ3YzRiMGM3
-    YzAxNWM0MjEzOWIzOGQ4OGUwNGUxMDZhMDQzMTVlMWNlNmIzY2U=
+    MjdmYmY5MTA3MGQ5MzM0MGE4M2FkMDI4Yjk4OTM0ZmFhNDJiODBiZWUzMjk5
+    NTZkODFmNjg4MmY0MDAzZmY3ZjVjN2RmOGJiMmY0NTQ0YjhmZGUzOWFjZWIy
+    ODRjY2E4MTA5OWQ5NGM1YmI4ZWEyNDQ1NWZlN2NlNzYxYmFmOTM=

data/admins/pageflow/accounts.rb

@@ -24,6 +24,8 @@ module Pageflow
     end
 
     controller do
+      helper ThemesHelper
+
       def new
         @account = Account.new
         @account.default_theming = Theming.new
@@ -36,7 +38,7 @@ module Pageflow
       end
 
       def permitted_params
-        params.permit(:account => [:name, :default_file_rights, :default_theming_attributes => [:cname, :theme_name, :imprint_link_url, :imprint_link_label, :copyright_link_url, :copyright_link_label]])
+        params.permit(:account => [:name, :default_file_rights, :default_theming_attributes => [:cname, :theme_name, :imprint_link_url, :imprint_link_label, :copyright_link_url, :copyright_link_label, :home_url, :home_button_enabled_by_default]])
       end
     end
   end

data/admins/pageflow/entry.rb

@@ -25,7 +25,7 @@ module Pageflow
         end
         span(link_to(I18n.t("admin.entries.preview"), preview_admin_entry_path(entry), :class => 'preview button'))
         if entry.published?
-          span(link_to(I18n.t("admin.entries.show_public"), pageflow.entry_path(entry), :class => 'show_public button'))
+          span(link_to(I18n.t("admin.entries.show_public"), pretty_entry_url(entry), :class => 'show_public button'))
         end
       end
     end
@@ -89,6 +89,7 @@ module Pageflow
 
     controller do
       helper FoldersHelper
+      helper EntriesHelper
       helper Admin::RevisionsHelper
 
       def scoped_collection

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

@@ -1 +1,2 @@
+//= require ./admin/accounts
 //= require ./admin/entries

data/app/assets/javascripts/pageflow/admin/accounts.js

@@ -0,0 +1,30 @@
+jQuery(function($) {
+  $('.admin_accounts form.pageflow_account').each(function() {
+    var themeSelect = $('#account_default_theming_attributes_theme_name', this);
+    var themeOptions = JSON.parse($('script#theme_options', this).text());
+    var homeButtonCheckBox = $('#account_default_theming_attributes_home_button_enabled_by_default', this);
+
+    updateThemeFeatures();
+    themeSelect.on('change', updateThemeFeatures);
+
+    function updateThemeFeatures() {
+      toggleDisabled(homeButtonCheckBox, !selectedThemeSupportsHomeButton());
+    }
+
+    function selectedThemeSupportsHomeButton() {
+      return !themeOptions[themeSelect.val()].no_home_button;
+    }
+
+    function toggleDisabled(checkBox, disabled) {
+      if (disabled) {
+        checkBox.data('wasChecked', checkBox.is(':checked'));
+        checkBox.prop('checked', false);
+        checkBox.prop('disabled', true);
+      }
+      else {
+        checkBox.removeAttr('disabled');
+        checkBox.prop('checked', checkBox.data('wasChecked'));
+      }
+    }
+  });
+});

data/app/assets/javascripts/pageflow/asset_urls.js.erb

@@ -1,6 +1,6 @@
 pageflow.assetUrls = {
-  largeBandwidthProbe: '<%= Rails.env.test? ? asset_path("bandwidth_probe_large.png") : "http://#{File.join(Pageflow.config.zencoder_options[:s3_host_alias], "bandwidth_probe_large.png")}" %>',
-  smallBandwidthProbe: '<%= Rails.env.test? ? asset_path("bandwidth_probe_small.png") : "http://#{File.join(Pageflow.config.zencoder_options[:s3_host_alias], "bandwidth_probe_small.png")}" %>',
+  largeBandwidthProbe: '<%= Rails.env.test? ? asset_path("bandwidth_probe_large.png") : "//#{File.join(Pageflow.config.zencoder_options[:s3_host_alias], "bandwidth_probe_large.png")}" %>',
+  smallBandwidthProbe: '<%= Rails.env.test? ? asset_path("bandwidth_probe_small.png") : "//#{File.join(Pageflow.config.zencoder_options[:s3_host_alias], "bandwidth_probe_small.png")}" %>',
   audioSwf: '<%= asset_path "pageflow/audio5js.swf" %>',
   emptyMp4: '<%= asset_path "pageflow/empty.mp4" %>',
   emptyWebm: '<%= asset_path "pageflow/empty.webm" %>'

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

@@ -0,0 +1,136 @@
+//= require_tree ./api
+//= require_self
+
+/**
+ * Interface for engines providing editor extensions.
+ */
+pageflow.EditorApi = pageflow.Object.extend({
+  initialize: function() {
+    this.sideBarRoutings = [];
+    this.mainMenuItems = [];
+    this.initializers = [];
+    this.fileSelectionHandlers = {};
+
+    /**
+     * Register additional router and controller for sidebar.
+     *
+     * Supported options:
+     * - router: constructor function of Backbone Marionette app router
+     * - controller: constructor function of Backbone Marionette controller
+     */
+    this.registerSideBarRouting = function(options) {
+      this.sideBarRoutings.push(options);
+    };
+
+    /**
+     * Register additional menu item to be displayed on the root sidebar
+     * view.
+     *
+     * Supported options:
+     * - translationKey: for the label
+     * - path: route to link to
+     */
+    this.registerMainMenuItem = function(options) {
+      this.mainMenuItems.push(options);
+    };
+
+    /**
+     * Register a custom initializer which will be run before the boot
+     * initializer of the editor.
+     */
+    this.addInitializer = function(fn) {
+      this.initializers.push(fn);
+    };
+
+    /**
+     * Navigate to the given path.
+     */
+    this.navigate = function(path, options) {
+      editor.navigate(path, options);
+    };
+
+    /**
+     * Extend the interface of page configuration objects. This is
+     * especially convenient to wrap structured data from the page
+     * configuration as Backbone objects.
+     *
+     * Example:
+     *
+     *     pageflow.editor.registerPageConfigurationMixin({
+     *       externalLinks: function() {
+     *         return new Backbone.Collection(this.get('external_links'));
+     *       }
+     *     }
+     *
+     *     pageflow.pages.get(1).configuration.externalLinks().each(...);
+     */
+    this.registerPageConfigurationMixin = function(mixin) {
+      Cocktail.mixin(pageflow.Configuration, mixin);
+    };
+
+    /**
+     * File selection handlers let editor extensions use the files view
+     * to select files for usage in their custom models.
+     *
+     * See selectFile method for details how to trigger file selection.
+     *
+     * Example:
+     *
+     *     function MyFileSelectionHandler(options) {
+     *       this.call = function(file) {
+     *         // invoked with the selected file
+     *       };
+     *
+     *       this.getReferer = function() {
+     *         // the path to return to when the back button is clicked
+     *         // or after file selection
+     *         return '/some/path';
+     *       }
+     *     }
+     *
+     *     pageflow.editor.registerFileSelectionHandler('my_file_selection_handler', MyFileSelectionHandler);
+     */
+    this.registerFileSelectionHandler = function(name, handler) {
+      this.fileSelectionHandlers[name] = handler;
+    };
+
+    /**
+     * Trigger selection of the given file type with the given
+     * handler. Payload hash is passed to selection handler as options.
+     *
+     * Example:
+     *
+     *     pageflow.editor.selectFile('image_files', 'my_file_selection_handler', {some: 'option for handler'});
+     */
+    this.selectFile = function(fileType, handlerName, payload) {
+      this.navigate('/files/' + fileType + '?handler=' + handlerName + '&payload=' + encodeURIComponent(JSON.stringify(payload)), {trigger: true});
+    };
+
+    /**
+     * Failures API
+     *
+     * 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));
+     *
+     */
+    this.failures = new pageflow.FailuresAPI();
+
+
+    /** @private */
+    this.createFileSelectionHandler = function(handlerName, encodedPayload) {
+      /** @private */
+      if (!this.fileSelectionHandlers[handlerName]) {
+        throw 'Unknown FileSelectionHandler ' + handlerName;
+      }
+
+      var payloadJson = JSON.parse(decodeURIComponent(encodedPayload));
+      return new this.fileSelectionHandlers[handlerName](payloadJson);
+    };
+  }
+});

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

@@ -0,0 +1,54 @@
+/**
+ * pageflow.Failure and subclasses are used in the failures api.
+ *
+ * Subclasses that represent failures that are can not be retried should
+ * override `catRetry` with false.
+ * Retryable failures should implement `retryAction`.
+ */
+pageflow.Failure = pageflow.Object.extend({
+  canRetry: true,
+  type: 'Failure',
+
+  initialize: function(model) {
+    this.model = model;
+  },
+
+  retry: function() {
+    if (this.canRetry) {
+      return this.retryAction();
+    }
+  },
+
+  retryAction: function() {
+    return this.model.save();
+  },
+
+  key: function() {
+    return this.model.cid + '-' + this.type;
+  }
+});
+
+/**
+ * SavingFailure represents a unsuccessful attempt to save
+ * a model on the server.
+ */
+pageflow.SavingFailure = pageflow.Failure.extend({
+  type: 'SavingFailure'
+});
+
+/**
+ *  OrderingFailure represent a unsuccessful attempt to save
+ *  the ordering of a pageflow.orderedCollection.
+ */
+pageflow.OrderingFailure = pageflow.Failure.extend({
+  type: 'OrderingFailure',
+
+  initialize: function(model, collection) {
+    pageflow.Failure.prototype.initialize.call(this, model);
+    this.collection = collection;
+  },
+
+  retryAction: function() {
+    return this.collection.saveOrder();
+  }
+});

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

@@ -0,0 +1,47 @@
+/**
+ * API to allow access to failure UI and recovery.
+ * Global instance at pageflow.failures.
+ */
+pageflow.FailuresAPI = pageflow.Object.extend({
+  initialize: function() {
+    this.failures = {};
+    this.length = 0;
+  },
+
+  watch: function(collection) {
+    this.listenTo(collection, 'sync', this.remove);
+
+    this.listenTo(collection, 'error', function(model) {
+      if (!model.isNew()) {
+        this.add(new pageflow.SavingFailure(model));
+      }
+    });
+  },
+
+  retry: function() {
+    _.each(this.failures, function(failure, key) {
+      this.remove(key);
+      failure.retry();
+    }, this);
+  },
+
+  isEmpty: function() {
+    return _.size(this.failures) === 0;
+  },
+
+  add: function(failure) {
+    this.failures[failure.key()] = failure;
+    this.length = _.size(this.failures);
+  },
+
+  remove: function(key) {
+    delete this.failures[key];
+    this.length = _.size(this.failures);
+  },
+
+  count: function() {
+    return this.length;
+  }
+});
+
+_.extend(pageflow.FailuresAPI.prototype, Backbone.Events);

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

@@ -5,6 +5,7 @@
 
 //= require jquery.ui.all
 //= require jquery/layout
+
 //= require jquery-fileupload/vendor/load-image
 //= require jquery-fileupload/vendor/canvas-to-blob
 //= require jquery-fileupload/jquery.fileupload
@@ -14,6 +15,10 @@
 //= require parser_rules/simple
 
 //= require i18n
+//= require i18n/translations
+
+//= require ./object
+//= require ./api
 
 //= require_self
 
@@ -40,6 +45,9 @@
 //= require ./initializers/setup_page_types
 //= require ./initializers/edit_lock
 //= require ./initializers/files_polling
+//= require ./initializers/routing
+//= require ./initializers/additional_initializers
 //= require ./initializers/boot
 
 pageflow.app = new Backbone.Marionette.Application();
+pageflow.editor = new pageflow.EditorApi();

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

@@ -10,4 +10,4 @@ pageflow.ChaptersCollection = Backbone.Collection.extend({
   comparator: function(chapter) {
     return chapter.get('position');
   }
-});
+});

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

@@ -1,15 +1,20 @@
 pageflow.orderedCollection = {
   saveOrder: function() {
     var parentModel = this.parentModel;
+    var collection = this;
 
-    Backbone.sync('patch', parentModel, {
-      url: this.url() + '/order',
-      attrs: {ids: this.pluck('id')},
+    return Backbone.sync('patch', parentModel, {
+      url: collection.url() + '/order',
+      attrs: {ids: collection.pluck('id')},
 
       success: function(response) {
         parentModel.trigger('sync', parentModel, response, {});
         parentModel.trigger('sync:order', parentModel, response, {});
+      },
+
+      error: function(jqXHR,  textStatus, errorThrown) {
+        pageflow.editor.failures.add(new pageflow.OrderingFailure(parentModel, collection));
       }
     });
   }
-};
+};

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

@@ -10,23 +10,22 @@ pageflow.SidebarController = Backbone.Marionette.Controller.extend({
     }));
   },
 
-  imageFiles: function(pageId, attributeName) {
-    this.files(pageId, attributeName, 'image_files');
+  imageFiles: function(handler, payload) {
+    this.files(handler, payload, 'image_files');
   },
 
-  videoFiles: function(pageId, attributeName) {
-    this.files(pageId, attributeName, 'video_files');
+  videoFiles: function(handler, payload) {
+    this.files(handler, payload, 'video_files');
   },
 
-  audioFiles: function(pageId, attributeName) {
-    this.files(pageId, attributeName, 'audio_files');
+  audioFiles: function(handler, payload) {
+    this.files(handler, payload, 'audio_files');
   },
 
-  files: function(pageId, attributeName, tabName) {
+  files: function(handler, payload, tabName) {
     this.region.show(new pageflow.FilesView({
       model: this.entry,
-      page: this.entry.pages.get(pageId),
-      pageAttributeName: attributeName,
+      selectionHandler: handler && pageflow.editor.createFileSelectionHandler(handler, payload),
       tabName: tabName
     }));
   },
@@ -62,4 +61,4 @@ pageflow.SidebarController = Backbone.Marionette.Controller.extend({
       tab: tab
     }));
   }
-});
+});

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

@@ -0,0 +1,8 @@
+pageflow.app.addInitializer(function(/* args */) {
+  var context = this;
+  var args = arguments;
+
+  _.each(pageflow.editor.initializers, function(fn) {
+    fn.call(context, args);
+  });
+});