pageflow 16.0.0 → 16.1.0

data/lib/pageflow/engine.rb

@@ -31,6 +31,8 @@ require 'pageflow_paged'
 require 'pageflow_scrolled'
 require 'symmetric-encryption'
 
+require 'pageflow/rails_version'
+
 if Gem::Specification.find_all_by_name('pageflow-react', '>= 0.0').any?
   fail('The pageflow-react gem has been merged into the pageflow gem. ' \
        'See the pageflow changelog for update instructions.')
@@ -41,44 +43,63 @@ module Pageflow
   class Engine < ::Rails::Engine
     isolate_namespace Pageflow
 
-    config.paths.add('app/views/components', autoload: true)
-    config.paths.add('lib', autoload: true)
-
-    def eager_load!
-      # Manually eager load `lib/pageflow` as the least bad option:
-      #
-      # - Autoload paths are not eager loaded in production.
-      #
-      # - `lib` cannot be an eager load path since otherwise templates
-      #   in `lib/generators` are also executed.
-      #
-      # - `lib/pageflow` cannot be an eager load path since eager load
-      #   paths are automatically used as autoload paths. That way
-      #   `lib/pageflow/admin/something.rb` could be autoloaded via
-      #   `Admin::Something`.
-      #
-      # - Using `require` in `lib/pageflow.rb` disables code
-      #   reloading.
-      #
-      # - Using `require_dependency` in `lib/pageflow.rb` does not
-      #   activate code reloading either since it requires the
-      #   autoload path to be set up correctly, which only happens
-      #   during initialization.
-      super
-
-      lib_path = config.root.join('lib')
-      matcher = %r{\A#{Regexp.escape(lib_path.to_s)}/(.*)\.rb\Z}
-
-      already_required_files = [
-        'pageflow/engine',
-        'pageflow/global_config_api',
-        'pageflow/news_item_api',
-        'pageflow/version'
-      ]
-
-      Dir.glob("#{lib_path}/pageflow/**/*.rb").sort.each do |file|
-        logical_path = file.sub(matcher, '\1')
-        require_dependency(logical_path) unless already_required_files.include?(logical_path)
+    if Pageflow::RailsVersion.experimental?
+      config.autoload_paths << root.join('app/views/components')
+      config.eager_load_paths << root.join('app/views/components')
+
+      lib = root.join('lib')
+
+      config.autoload_paths << lib
+      config.eager_load_paths << lib
+
+      initializer 'pageflow.autoloading' do
+        Rails.autoloaders.main.ignore(
+          lib.join('generators'),
+          lib.join('tasks'),
+          lib.join('pageflow/paperclip_processors'),
+          lib.join('pageflow/version.rb')
+        )
+      end
+    else
+      config.paths.add('app/views/components', autoload: true)
+      config.paths.add('lib', autoload: true)
+
+      def eager_load!
+        # Manually eager load `lib/pageflow` as the least bad option:
+        #
+        # - Autoload paths are not eager loaded in production.
+        #
+        # - `lib` cannot be an eager load path since otherwise templates
+        #   in `lib/generators` are also executed.
+        #
+        # - `lib/pageflow` cannot be an eager load path since eager load
+        #   paths are automatically used as autoload paths. That way
+        #   `lib/pageflow/admin/something.rb` could be autoloaded via
+        #   `Admin::Something`.
+        #
+        # - Using `require` in `lib/pageflow.rb` disables code
+        #   reloading.
+        #
+        # - Using `require_dependency` in `lib/pageflow.rb` does not
+        #   activate code reloading either since it requires the
+        #   autoload path to be set up correctly, which only happens
+        #   during initialization.
+        super
+
+        lib_path = config.root.join('lib')
+        matcher = %r{\A#{Regexp.escape(lib_path.to_s)}/(.*)\.rb\Z}
+
+        already_required_files = [
+          'pageflow/engine',
+          'pageflow/global_config_api',
+          'pageflow/news_item_api',
+          'pageflow/version'
+        ]
+
+        Dir.glob("#{lib_path}/pageflow/**/*.rb").sort.each do |file|
+          logical_path = file.sub(matcher, '\1')
+          require_dependency(logical_path) unless already_required_files.include?(logical_path)
+        end
       end
     end
 
@@ -106,7 +127,7 @@ module Pageflow
     end
 
     initializer 'pageflow.factories', after: 'factory_bot.set_factory_paths' do
-      if Pageflow.configured? && defined?(FactoryBot)
+      if defined?(FactoryBot)
         FactoryBot.definition_file_paths.unshift(Engine.root.join('spec', 'factories'))
       end
     end

data/lib/pageflow/entry_export_import/revision_serialization.rb

@@ -28,7 +28,7 @@ module Pageflow
       end
 
       def import(data, options)
-        Import.new(options).perform(data)
+        Import.new(**options).perform(data)
       end
 
       private

data/lib/pageflow/file_type.rb

@@ -123,11 +123,11 @@ module Pageflow
       @css_background_image_class_prefix || model.model_name.singular
     end
 
-    def css_background_image_urls_for(file, options)
+    def css_background_image_urls_for(file, **options)
       if call_arity(css_background_image_urls) == 1
         css_background_image_urls.call(file)
       else
-        css_background_image_urls.call(file, options)
+        css_background_image_urls.call(file, **options)
       end
     end
 

data/lib/pageflow/global_config_api.rb

@@ -87,8 +87,6 @@ module Pageflow
     # coniguration is now complete.
     def finalize!
       @finalized = true
-      configure!
-      @config.lint!
     end
 
     # @api private
@@ -103,6 +101,8 @@ module Pageflow
       @after_global_configure_blocks.each do |block|
         block.call(@config)
       end
+
+      @config.lint!
     end
 
     private

data/lib/pageflow/nested_revision_component.rb

@@ -14,10 +14,10 @@ module Pageflow
       end
 
       # @api private
-      def copy_nested_revision_component_to(record)
+      def copy_nested_revision_component_to(record, reset_perma_ids: false)
         nested_revision_component_collection_names.each do |collection_name|
           send(collection_name).each do |nested|
-            nested.copy_to(record.send(collection_name))
+            nested.copy_to(record.send(collection_name), reset_perma_ids: reset_perma_ids)
           end
         end
       end
@@ -38,12 +38,30 @@ module Pageflow
     extend ActiveSupport::Concern
     include Container
 
+    def duplicate
+      copy_with(reset_perma_ids: true) do |record|
+        yield record if block_given?
+        record.save!
+      end
+    end
+
     # @api private
-    def copy_to(collection)
+    def copy_to(collection, reset_perma_ids: false)
+      copy_with(reset_perma_ids: reset_perma_ids) do |record|
+        collection << record
+      end
+    end
+
+    private
+
+    def copy_with(reset_perma_ids:)
       record = dup
-      collection << record
+      record.perma_id = nil if reset_perma_ids && record.respond_to?(:perma_id=)
+
+      yield record
+      copy_nested_revision_component_to(record, reset_perma_ids: reset_perma_ids)
 
-      copy_nested_revision_component_to(record)
+      record
     end
   end
 end

data/lib/pageflow/rails_version.rb

@@ -0,0 +1,19 @@
+module Pageflow
+  module RailsVersion
+    extend self
+
+    def detect
+      from_env || '5.2.0'
+    end
+
+    def experimental?
+      detect != '5.2.0'
+    end
+
+    private
+
+    def from_env
+      ENV['PAGEFLOW_RAILS_VERSION'] if ENV['PAGEFLOW_RAILS_VERSION'] != ''
+    end
+  end
+end

data/lib/pageflow/seeds.rb

@@ -97,16 +97,18 @@ module Pageflow
       end
     end
 
-    # Create a sample {Entry} with some chapter and pages if no
-    # entry with that title exists in the given account.
+    # Create a sample {Entry} with some chapter, pages, and optional
+    # text if no entry with that title exists in the given account.
     #
     # @param [Hash] attributes  attributes to override defaults
     # @option attributes [Account] :account  required
-    # @option attributes [title] :title  required
+    # @option attributes [String] :title  required
+    # @option attributes [String] :text optional
     # @yield [entry] a block to be called before the entry is saved
     # @return [Entry] newly created entry
     def sample_entry(attributes)
       entry = Entry.where(attributes.slice(:account, :title)).first
+      page_text = attributes.delete(:text) { |_| '' }
 
       if entry.nil?
         entry = Entry.create!(attributes) do |created_entry|
@@ -117,13 +119,14 @@ module Pageflow
         end
 
         storyline = entry.draft.storylines.first
-
         chapter = storyline.chapters.create!(title: 'Chapter 1', position: 0)
-        chapter.pages.create!(template: 'background_image')
-        chapter.pages.create!(template: 'background_image')
+        chapter.pages.create!(template: 'background_image',
+                              configuration: {text: page_text})
+        chapter.pages.create!(template: 'background_image',
+                              configuration: {text: page_text})
 
         chapter = storyline.chapters.create!(title: 'Chapter 2', position: 1)
-        chapter.pages.create!(template: 'video')
+        chapter.pages.create!(template: 'video', configuration: {text: page_text})
       end
 
       entry

data/lib/pageflow/version.rb

@@ -1,3 +1,3 @@
 module Pageflow
-  VERSION = '16.0.0'.freeze
+  VERSION = '16.1.0'.freeze
 end

data/lib/pageflow/widget_types.rb

@@ -41,6 +41,10 @@ module Pageflow
       @widget_types.fetch(name, &block)
     end
 
+    def type_name?(name)
+      @widget_types.key?(name)
+    end
+
     def default_configuration(name)
       @default_configurations[name]
     end

data/package/config/webpack5.js

@@ -0,0 +1,14 @@
+module.exports = {
+  externals: {
+    'backbone': 'Backbone',
+    'backbone.babysitter': 'Backbone.ChildViewContainer',
+    'cocktail': 'Cocktail',
+    'jquery': 'jQuery',
+    'jquery-ui': 'jQuery',
+    'jquery.minicolors': 'jQuery',
+    'underscore': '_',
+    'backbone.marionette': 'Backbone.Marionette',
+    'iscroll': 'IScroll',
+    'wysihtml5': 'wysihtml5'
+  }
+};

data/package/editor.js

@@ -1,12 +1,13 @@
 import Backbone from 'backbone';
 import _ from 'underscore';
-import { Object as Object$1, ConfigurationEditorTabView, TextInputView, UrlDisplayView, TabsView, ConfigurationEditorView, CollectionView, tooltipContainer, SelectInputView, inputView, TextAreaInputView, CheckBoxGroupInputView, i18nUtils, TableView, TextTableCellView, PresenceTableCellView, SortableCollectionView, DeleteRowTableCellView, CheckBoxInputView, SliderInputView, IconTableCellView } from 'pageflow/ui';
+import { Object as Object$1, ConfigurationEditorTabView, TextInputView, UrlDisplayView, TabsView, ConfigurationEditorView, CollectionView, tooltipContainer, SelectInputView, inputView, TextAreaInputView, CheckBoxGroupInputView, i18nUtils, TableView, TextTableCellView, PresenceTableCellView, SortableCollectionView, attributeBinding, DeleteRowTableCellView, CheckBoxInputView, SliderInputView, IconTableCellView } from 'pageflow/ui';
 export * from 'pageflow/ui';
 import Cocktail from 'cocktail';
 import I18n$1 from 'i18n-js';
 import Marionette from 'backbone.marionette';
 import $ from 'jquery';
 import { browser, features, Audio, events } from 'pageflow/frontend';
+import 'jquery-ui';
 
 (function () {
   var sync = Backbone.sync;
@@ -234,7 +235,7 @@ var UnmatchedUploadError = UploadError.extend({
 });
 var validFileTypeTranslationList = {
   validFileTypeTranslations: function validFileTypeTranslations(validFileTypes) {
-    return _.map(validFileTypes, function (validFileType) {
+    return validFileTypes.map(function (validFileType) {
       return I18n$1.t('activerecord.models.' + validFileType.i18nKey + '.other');
     }).join(', ');
   }
@@ -264,7 +265,7 @@ var InvalidNestedTypeError = UploadError.extend({
   initialize: function initialize(upload, options) {
     var editor = options.editor;
     var fileType = options.fileType;
-    var validFileTypes = editor.nextUploadTargetFile.fileType().nestedFileTypes.fileTypes;
+    var validFileTypes = editor.nextUploadTargetFile.fileType().nestedFileTypes;
     var validFileTypeTranslations = this.validFileTypeTranslations(validFileTypes);
     var typeI18nKey = fileType.i18nKey;
     var typeSingularTranslation = I18n$1.t('activerecord.models.' + typeI18nKey + '.one');
@@ -578,22 +579,31 @@ var FileTypes = Object$1.extend({
     this.clientSideConfigModifications[name].push(config);
   },
   setup: function setup(serverSideConfigs) {
+    var _this = this;
+
     var clientSideConfigs = this.clientSideConfigs;
     this._setup = true;
-    this.collection = new FileTypesCollection(_.map(serverSideConfigs, function (serverSideConfig) {
+
+    var configs = _.chain(serverSideConfigs).map(function (serverSideConfig) {
       var clientSideConfig = clientSideConfigs[serverSideConfig.collectionName];
 
       if (!clientSideConfig) {
         throw 'Missing client side config for file type "' + serverSideConfig.collectionName + '"';
       }
 
-      _(this.clientSideConfigModifications[serverSideConfig.collectionName]).each(function (modification) {
+      _(_this.clientSideConfigModifications[serverSideConfig.collectionName]).each(function (modification) {
         this.lintModification(modification, serverSideConfig.collectionName);
         this.applyModification(clientSideConfig, modification);
-      }, this);
+      }, _this);
 
-      return new FileType(_.extend({}, serverSideConfig, clientSideConfig));
-    }, this));
+      return _.extend({}, serverSideConfig, clientSideConfig);
+    }).sortBy(function (config) {
+      return config.priority || 10;
+    }).value();
+
+    this.collection = new FileTypesCollection(_.map(configs, function (config) {
+      return new FileType(config);
+    }));
     var those = this;
 
     _.map(serverSideConfigs, function (serverSideConfig) {
@@ -1107,10 +1117,12 @@ var EditorApi = Object$1.extend(
    * Trigger selection of the given file type with the given
    * handler. Payload hash is passed to selection handler as options.
    *
-   * @param {string|{name: string, filter: string}} fileType
+   * @param {string|{name: string, filter: string}|{defaultTab: string, filter: string}} fileType
    *   Either collection name of a file type or and object containing
    *   the collection name a file type and a the name of a file type
-   *   filter.
+   *   filter or an object containingn a defaultTab property that controls
+   *   which tab will visible initially, while allowing selecting files of
+   *   any type.
    *
    * @param {string} handlerName
    *   The name of a handler registered via {@link
@@ -1136,7 +1148,7 @@ var EditorApi = Object$1.extend(
       };
     }
 
-    this.navigate('/files/' + fileType.name + '?handler=' + handlerName + '&payload=' + encodeURIComponent(JSON.stringify(payload)) + (fileType.filter ? '&filter=' + fileType.filter : ''), {
+    this.navigate('/files/' + (fileType.defaultTab ? "".concat(fileType.defaultTab, ":default") : fileType.name) + '?handler=' + handlerName + '&payload=' + encodeURIComponent(JSON.stringify(payload)) + (fileType.filter ? '&filter=' + fileType.filter : ''), {
       trigger: true
     });
   },
@@ -3555,6 +3567,13 @@ var ForeignKeySubsetCollection = SubsetCollection.extend({
     var parent = options.parent;
     var parentModel = options.parentModel;
     this.autoConsolidatePositions = options.autoConsolidatePositions;
+    this.listenTo(this, 'add', function (model) {
+      if (options.parentReferenceAttribute) {
+        model[options.parentReferenceAttribute] = parentModel;
+      }
+
+      model.set(options.foreignKeyAttribute, parentModel.id);
+    });
     SubsetCollection.prototype.constructor.call(this, {
       parent: parent,
       parentModel: parentModel,
@@ -3565,13 +3584,6 @@ var ForeignKeySubsetCollection = SubsetCollection.extend({
         return item.get('position');
       }
     });
-    this.listenTo(this, 'add', function (model) {
-      if (options.parentReferenceAttribute) {
-        model[options.parentReferenceAttribute] = parentModel;
-      }
-
-      model.set(options.foreignKeyAttribute, parentModel.id);
-    });
     this.listenTo(parentModel, 'destroy dependentDestroy', function () {
       this.invoke('trigger', 'dependentDestroy');
       this.clear();
@@ -3824,6 +3836,64 @@ var SidebarRouter = Marionette.AppRouter.extend({
   }
 });
 
+function _arrayWithHoles(arr) {
+  if (Array.isArray(arr)) return arr;
+}
+
+function _iterableToArrayLimit(arr, i) {
+  if (typeof Symbol === "undefined" || !(Symbol.iterator in Object(arr))) return;
+  var _arr = [];
+  var _n = true;
+  var _d = false;
+  var _e = undefined;
+
+  try {
+    for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) {
+      _arr.push(_s.value);
+
+      if (i && _arr.length === i) break;
+    }
+  } catch (err) {
+    _d = true;
+    _e = err;
+  } finally {
+    try {
+      if (!_n && _i["return"] != null) _i["return"]();
+    } finally {
+      if (_d) throw _e;
+    }
+  }
+
+  return _arr;
+}
+
+function _arrayLikeToArray(arr, len) {
+  if (len == null || len > arr.length) len = arr.length;
+
+  for (var i = 0, arr2 = new Array(len); i < len; i++) {
+    arr2[i] = arr[i];
+  }
+
+  return arr2;
+}
+
+function _unsupportedIterableToArray(o, minLen) {
+  if (!o) return;
+  if (typeof o === "string") return _arrayLikeToArray(o, minLen);
+  var n = Object.prototype.toString.call(o).slice(8, -1);
+  if (n === "Object" && o.constructor) n = o.constructor.name;
+  if (n === "Map" || n === "Set") return Array.from(n);
+  if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen);
+}
+
+function _nonIterableRest() {
+  throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+}
+
+function _slicedToArray(arr, i) {
+  return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest();
+}
+
 function template$3(data) {
 var __t, __p = '';
 __p += '<a class="back">' +
@@ -4514,6 +4584,13 @@ return __p
  *   Require click to open menu. By default, menu opens on when the
  *   mouse enters the button.
  *
+ * @param {String} [options.alignMenu]
+ *   "right" to align menu on the right. Aligned on the left by
+ *   default.
+ *
+ * @param {String} [options.buttonClassName]
+ *   CSS class name for button element.
+ *
  * ## Item Models
  *
  * The following model attributes can be used to control the
@@ -4553,7 +4630,9 @@ var DropDownButtonView = Marionette.ItemView.extend({
     this.$el.toggleClass('full_width', !!this.options.fullWidth);
     this.ui.button.toggleClass('has_icon_and_text', !!this.options.label);
     this.ui.button.toggleClass('has_icon_only', !this.options.label);
+    this.ui.button.toggleClass('ellipsis_icon', !!this.options.ellipsisIcon);
     this.ui.button.text(this.options.label);
+    this.ui.button.addClass(this.options.buttonClassName);
     this.ui.menu.append(this.subview(new DropDownButtonItemListView({
       items: this.options.items
     })).el);
@@ -4577,7 +4656,7 @@ var DropDownButtonView = Marionette.ItemView.extend({
     var offset = this.$el.offset();
     this.ui.menu.css({
       top: offset.top + this.$el.height(),
-      left: offset.left,
+      left: this.options.alignMenu === 'right' ? offset.left + this.$el.width() - this.ui.menu.outerWidth() : offset.left,
       width: this.options.fullWidth ? this.$el.width() : null
     });
   },
@@ -4712,6 +4791,7 @@ var FileInputView = Marionette.ItemView.extend({
     if (dropDownMenuItems.length) {
       this.appendSubview(new DropDownButtonView({
         items: dropDownMenuItems,
+        ellipsisIcon: true,
         openOnClick: true
       }));
     }
@@ -6302,7 +6382,7 @@ var FilesView = Marionette.ItemView.extend({
     this.$el.append(this.subview(this.tabsView).el);
   },
   tab: function tab(fileType) {
-    var selectionMode = this.options.tabName === fileType.collectionName;
+    var selectionMode = this.options.allowSelectingAny || this.options.tabName === fileType.collectionName;
     this.tabsView.tab(fileType.collectionName, _.bind(function () {
       return this.subview(new FilteredFilesView({
         entry: state.entry,
@@ -6488,10 +6568,10 @@ var PublishEntryView = Marionette.ItemView.extend({
       this.ui.publishUntilField.datepicker('setDate', publishedUntil);
       this.ui.publishUntilTimeField.val(timeStr(publishedUntil));
     } else {
-      this.ui.publishUntilField.datepicker('setDate', oneYearFromNow());
+      this.ui.publishUntilField.datepicker('setDate', this.defaultPublishedUntilDate());
     }
 
-    this.ui.userNameField.val(state.account.get('name'));
+    this.ui.userNameField.val(this.options.account.get('name'));
 
     if (this.model.get('password_protected')) {
       this.ui.passwordProtectedCheckBox.prop('checked', true);
@@ -6511,12 +6591,6 @@ var PublishEntryView = Marionette.ItemView.extend({
         return ("0" + val).slice(-2);
       }
     }
-
-    function oneYearFromNow() {
-      var date = new Date();
-      date.setFullYear(date.getFullYear() + 1);
-      return date;
-    }
   },
   save: function save() {
     var publishedUntil = null;
@@ -6591,6 +6665,11 @@ var PublishEntryView = Marionette.ItemView.extend({
       return false;
     }
   },
+  defaultPublishedUntilDate: function defaultPublishedUntilDate() {
+    var date = new Date();
+    date.setMonth(date.getMonth() + this.options.config.defaultPublishedUntilDurationInMonths);
+    return date;
+  },
   enableSave: function enableSave() {
     this.ui.saveButton.removeAttr('disabled');
   },
@@ -6690,10 +6769,16 @@ var SidebarController = Marionette.Controller.extend({
     }));
   },
   files: function files(collectionName, handler, payload, filterName) {
+    var _split = (collectionName || '').split(':'),
+        _split2 = _slicedToArray(_split, 2),
+        tabName = _split2[0],
+        suffix = _split2[1];
+
     this.region.show(new FilesView({
       model: this.entry,
       selectionHandler: handler && editor.createFileSelectionHandler(handler, payload),
-      tabName: collectionName,
+      tabName: tabName,
+      allowSelectingAny: suffix === 'default',
       filterName: filterName
     }));
     editor.setDefaultHelpEntry('pageflow.help_entries.files');
@@ -6720,7 +6805,9 @@ var SidebarController = Marionette.Controller.extend({
   publish: function publish() {
     this.region.show(PublishEntryView.create({
       model: this.entry,
-      entryPublication: new EntryPublication()
+      account: state.account,
+      entryPublication: new EntryPublication(),
+      config: state.config
     }));
     editor.setDefaultHelpEntry('pageflow.help_entries.publish');
   },
@@ -7090,7 +7177,15 @@ var HelpImageView = Marionette.View.extend({
 
 var InfoBoxView = Marionette.View.extend({
   className: 'info_box',
+  mixins: [attributeBinding],
+  initialize: function initialize() {
+    this.setupBooleanAttributeBinding('visible', this.updateVisible);
+  },
+  updateVisible: function updateVisible() {
+    this.$el.toggleClass('hidden_via_binding', this.getBooleanAttributBoundOption('visible') === false);
+  },
   render: function render() {
+    this.$el.addClass(this.options.level);
     this.$el.html(this.options.text);
     return this;
   }
@@ -8006,6 +8101,10 @@ app.addInitializer(function () {
   });
 });
 
+var OtherFile = UploadableFile.extend({
+  thumbnailPictogram: 'other'
+});
+
 app.addInitializer(function (options) {
   var textTracksMetaDataAttribute = {
     name: 'text_tracks',
@@ -8115,6 +8214,18 @@ app.addInitializer(function (options) {
       binding: 'label'
     }
   });
+  editor.fileTypes.register('other_files', {
+    model: OtherFile,
+    metaDataAttributes: [altMetaDataAttribute],
+    matchUpload: function matchUpload() {
+      return true;
+    },
+    priority: 100,
+    configurationEditorInputs: [{
+      name: 'alt',
+      inputView: TextInputView
+    }]
+  });
   editor.fileTypes.setup(options.config.fileTypes);
 });