pageflow 12.0.4 → 12.1.0

data/app/assets/stylesheets/pageflow/themes/default/loading_spinner.scss

@@ -27,6 +27,13 @@ $loading-spinner-background-color: #3b5159 !default;
 /// - `"none"`: Nothing
 $loading-spinner-background: "glow" !default;
 
+/// Background size to apply to background image:
+///
+/// - `"auto"`: Do not apply background size (default).
+/// - `"logo"`: Apply same size as for logo image. Allows using
+///   background image as an animated layer of the logo.
+$loading-spinner-background-size: "auto" !default;
+
 /// Radial gradient color.
 $loading-spinner-glow-color: rgba(117, 149, 160, 0.8) !default;
 
@@ -57,6 +64,10 @@ $loading-spinner-animate-background: true !default;
       } @else if $loading-spinner-background == "custom" {
         content: "";
         background-image: image-url("pageflow/themes/#{$theme-name}/loading_spinner/background.png");
+
+        @if $loading-spinner-background-size == "logo" {
+          background-size: $loading-spinner-logo-width $loading-spinner-logo-height;
+        }
       }
 
       @if $loading-spinner-animate-background {

data/app/assets/stylesheets/pageflow/themes/default/logo/alignment.scss

@@ -0,0 +1,27 @@
+/// Alignment of the logo in desktop layout. In phone layout, logos
+/// are always displayed left aligned.
+///
+/// - `"left"`: Left align logo.
+///
+/// - `"right"`: Right align logo in desktop layout.
+$logo-alignment: "left" !default;
+
+// Left position relative to page when logo is left aligned.
+$logo-left: 8% !default;
+
+// Right position relative to page when logo is right aligned.
+$logo-right: 14% !default;
+
+@mixin logo-alignment {
+  @include desktop {
+    @if $logo-alignment == "left" {
+      left: $logo-left;
+    } @else {
+      right: $logo-right;
+    }
+  }
+
+  @include phone {
+    left: $logo-left;
+  }
+}

data/app/assets/stylesheets/pageflow/themes/default/logo/variant/background_image.scss

@@ -1,3 +1,11 @@
+@import "../alignment";
+
+// Opacity of the logo
+$logo-background-image-variant-opacity: null !default;
+
+/// Opacity of the logo on the first page
+$logo-background-image-variant-first-page-opacity: null !default;
+
 @mixin logo-variant-background-image(
   $first-page-only,
   $top,
@@ -14,7 +22,6 @@
     .content_and_background .scroller > div:after {
       content: "";
       position: absolute;
-      left: 8%;
       top: $top;
       z-index: 200;
       min-width: $min-width;
@@ -24,9 +31,10 @@
       background-image: image-url("pageflow/themes/#{$theme-name}/logo_header.png");
       background-repeat: no-repeat;
       background-size: contain;
-      background-position: left top;
+      background-position: #{$logo-alignment} top;
 
       @include mobile {
+        background-position: left top;
         padding-top: 1%;
         height: $mobile-height;
       }
@@ -34,10 +42,20 @@
       @include phone {
         top: $phone-top;
       }
+
+      @include logo-alignment;
     }
 
     &.invert .content_and_background .scroller > div:after {
       background-image: image-url("pageflow/themes/#{$theme-name}/logo_header_invert.png");
     }
   }
+
+  .page .scroller > div:after {
+    opacity: $logo-background-image-variant-opacity;
+  }
+
+  .page:first-child .scroller > div:after {
+    opacity: $logo-background-image-variant-first-page-opacity;
+  }
 }

data/app/assets/stylesheets/pageflow/themes/default/logo/variant/watermark.scss

@@ -1,3 +1,5 @@
+@import "../alignment";
+
 /// Fade in logo when scroller is near top
 ///
 /// - `"first-page"`: only on first page
@@ -25,7 +27,6 @@ $logo-watermark-variant-fade-in-with-header: false !default;
     width: $width;
     height: $height;
     top: $top;
-    left: 8%;
     z-index: 1;
 
     pointer-events: none;
@@ -38,6 +39,8 @@ $logo-watermark-variant-fade-in-with-header: false !default;
       top: 21px;
     }
 
+    @include logo-alignment;
+
     .js & {
       display: block;
     }

data/app/assets/stylesheets/pageflow/themes/default/page/line_lengths.scss

@@ -0,0 +1,113 @@
+/// Max width for tagline and subtitle and content text.
+$page-content-max-width: 500px !default;
+
+/// Max width for header title when text is positioned on the
+/// left. For right positioned text the max width has to match the max
+/// width of tagline and subtitle to ensure the title is left aligned
+/// with those elements.
+$page-header-title-max-width: 700px !default;
+
+/// Maximal width for right positioned headlines and content text.
+$page-content-position-right-max-width: 500px !default;
+
+/// Min width the header title is supposed to have in a split layout
+/// (i.e. when the page has two columns and some kind of embed is
+/// displayed on the right) with text positioned on the left.
+$page-header-title-min-width-for-split-layout: 525px !default;
+
+/// Relative width of tagline, subtitle and content text
+$page-content-width: 60% !default;
+
+.page {
+  h1,
+  h2 .subtitle,
+  h2 .tagline,
+  h3,
+  p {
+    max-width: $page-content-max-width;
+    width: $page-content-width;
+
+    @include mobile {
+      width: 100%;
+    }
+  }
+
+  h2 .title {
+    max-width: $page-header-title-max-width;
+    width: 100%;
+  }
+
+  // see pageflow/page.scss
+  $page-padding-left: 8%;
+  $page-padding-right: 14%;
+  $page-content-wrapper-width: 100% - $page-padding-left - $page-padding-right;
+
+  // On pages that support split layout (i.e. some kind of
+  // embed can be displayed on the right), we have to shorten the page
+  // content so that it is contained inside the left column.
+  //
+  // Embeds use up to 55% of the page width. So we want to ensure that
+  // the sum of the content's width and left margin stays below 45% of
+  // the page width:
+  //
+  //   $page-content-width-relative-to-page + $page-padding-left = 45%
+  //   $page-content-width-relative-to-wrapper * $page-content-wrapper-width
+  //     + $page-padding-left = 45%
+  //
+  // Subtract 1% to keep a bit of space between text and embed.
+  $page-content-split-layout-width: floor((44% - $page-padding-left)
+                                          / ($page-content-wrapper-width / 100%));
+
+  // When the pixel width of the title is given by
+  //
+  //   $title-width-in-px = $page-width-in-px
+  //                          * ($page-content-wrapper-width / 100%)
+  //                          * ($page-content-split-layout-width / 100%),
+  //
+  // the title has at least the given min width if the page has width:
+  $page-min-width-for-split-layout: $page-header-title-min-width-for-split-layout
+                                      / ($page-content-split-layout-width / 100%)
+                                      / ($page-content-wrapper-width / 100%);
+
+  @media screen and (min-width: $page-min-width-for-split-layout) {
+    &-with_split_layout {
+      h2 .subtitle,
+      h2 .title,
+      h2 .tagline,
+      h3,
+      p {
+        width: $page-content-split-layout-width;
+      }
+    }
+  }
+
+  &.text_position_right {
+    .contentText > * {
+      margin-left: auto;
+    }
+
+    h1,
+    h2 .subtitle,
+    h2 .title,
+    h2 .tagline,
+    h3,
+    p {
+      margin-left: auto;
+      max-width: $page-content-position-right-max-width;
+      width: 60%;
+
+      @include mobile {
+        width: 100%;
+      }
+    }
+
+    .page_header {
+      margin-left: auto;
+      width: 100%;
+
+      @include mobile {
+        width: 100%;
+      }
+    }
+  }
+}

data/app/assets/stylesheets/pageflow/themes/default/page.scss

@@ -100,6 +100,7 @@ $page-content-text-font-size: 1.2em !default;
 $page-content-text-line-height: 1.5em !default;
 
 @import "./page/anchors";
+@import "./page/line_lengths";
 
 .page {
   @include typography(

data/app/controllers/pageflow/editor/widgets_controller.rb

@@ -24,7 +24,21 @@ module Pageflow
       private
 
       def widget_batch_params
-        params.permit(widgets: [:role, :type_name]).fetch(:widgets, [])
+        widget_configurations = params.fetch(:widgets, []).map do |widget_params|
+          widget_params[:configuration].try(:permit!)
+        end
+
+        params
+          .permit(widgets: [:role, :type_name])
+          .fetch(:widgets, [])
+          .zip(widget_configurations)
+          .map do |(widget_params, widget_configuration)|
+            if widget_configuration
+              widget_params.merge(configuration: widget_configuration)
+            else
+              widget_params
+            end
+          end
       end
 
       def find_subject

data/app/controllers/pageflow/entries_controller.rb

@@ -90,7 +90,7 @@ module Pageflow
                                     :overview_button_enabled,
                                     :emphasize_chapter_beginning, :emphasize_new_pages,
                                     :share_url, :share_image_id, :share_image_x, :share_image_y,
-                                    :locale, :author, :publisher, :keywords)
+                                    :locale, :author, :publisher, :keywords, :theme_name)
     end
 
     def entry_request_scope

data/app/helpers/pageflow/admin/entries_helper.rb

@@ -18,15 +18,6 @@ module Pageflow
           I18n.t(state, scope: 'activerecord.values.pageflow/entry.publication_states')
         end
       end
-
-      def eligible_accounts
-        AccountPolicy::Scope.new(current_user, Account).entry_movable
-      end
-
-      def eligible_themings
-        ThemingPolicy::Scope.new(current_user, Pageflow::Theming)
-          .themings_allowed_for(resource.account)
-      end
     end
   end
 end

data/app/helpers/pageflow/admin/memberships_helper.rb

@@ -1,58 +1,22 @@
 module Pageflow
   module Admin
     module MembershipsHelper
-      def membership_entries_collection(parent, resource)
-        if resource.new_record?
-          if parent.is_a?(User)
-            accounts = AccountPolicy::Scope.new(current_user, Pageflow::Account)
-                       .entry_creatable
-            MembershipFormCollection.new(parent,
-                                         resource: resource,
-                                         collection_method: :entries,
-                                         display_method: :title,
-                                         order: 'title ASC',
-                                         managed_accounts: accounts).collection_for_entries
-          else
-            MembershipFormCollection.new(parent,
-                                         resource: resource,
-                                         collection_method: :entries,
-                                         display_method: :title,
-                                         order: 'title ASC').pairs
-          end
+      def membership_user_select(f, parent)
+        if f.object.persisted?
+          membership_disabled_select(f, :user, f.object.user, :formal_name)
+        elsif parent.is_a?(User)
+          membership_disabled_select(f, :user, parent, :formal_name)
         else
-          [[resource.entity.title, resource.entity_id]]
+          parent_type = parent.class.model_name.singular_route_key
+          membership_select(f, :user, parent, :"potential_users_for_#{parent_type}")
         end
       end
 
-      def membership_accounts_collection(parent, resource)
-        if resource.new_record?
-          if parent.is_a?(User)
-            accounts = AccountPolicy::Scope
-                       .new(current_user, Account).member_addable.load
-            MembershipFormCollection.new(parent,
-                                         collection_method: :accounts,
-                                         display_method: :name,
-                                         order: 'name ASC',
-                                         managed_accounts: accounts).pairs
-          else
-            [[parent.name, parent.id]]
-          end
+      def membership_entity_select(f, parent, entity_type)
+        if entity_type == 'Pageflow::Entry'
+          membership_entry_select(f, parent)
         else
-          [[resource.entity.name, resource.entity_id]]
-        end
-      end
-
-      def membership_users_collection(parent, resource)
-        if resource.new_record?
-          accounts = AccountPolicy::Scope
-                     .new(current_user, Pageflow::Account).member_addable.load
-          MembershipFormCollection.new(parent,
-                                       collection_method: :users,
-                                       display_method: :formal_name,
-                                       order: 'last_name ASC, first_name ASC',
-                                       managed_accounts: accounts).pairs
-        else
-          [[resource.user.formal_name, resource.user.id]]
+          membership_account_select(f, parent)
         end
       end
 
@@ -61,6 +25,7 @@ module Pageflow
                            [I18n.t('pageflow.admin.users.roles.editor'), :editor],
                            [I18n.t('pageflow.admin.users.roles.publisher'), :publisher],
                            [I18n.t('pageflow.admin.users.roles.manager'), :manager]]
+
         if entity_type == 'Pageflow::Account'
           [[I18n.t('pageflow.admin.users.roles.member'), :member]] + default_options
         else
@@ -68,88 +33,43 @@ module Pageflow
         end
       end
 
-      class MembershipFormCollection
-        include ActionView::Helpers::FormOptionsHelper
-        attr_reader :parent, :options
-
-        def initialize(parent, options)
-          @parent = parent
-          @options = options
-        end
-
-        def pairs
-          items.each_with_object([]) do |item, result|
-            result << [display(item), item.id]
-          end
-        end
-
-        def collection_for_entries
-          accounts = options[:managed_accounts]
-                     .where(accounts_ids_in_parent_accounts_ids)
-                     .includes(:entries).where('pageflow_entries.id IS NOT NULL')
-                     .where(entries_ids_not_in_parent_entries_ids)
-                     .order(:name, 'pageflow_entries.title')
-
-          option_groups_from_collection_for_select(accounts, :entries, :name, :id, :title)
-        end
-
-        private
+      private
 
-        def items
-          if parent.is_a?(User)
-            if options[:collection_method] == :users
-              [parent]
-            else
-              options[:managed_accounts] - items_in_parent
-            end
-          elsif parent.is_a?(Entry)
-            items_in_account - items_in_parent
-          else
-            Set.new(options[:managed_accounts].map(&:users).flatten) - items_in_parent
-          end
-        end
-
-        def display(item)
-          item.send(options[:display_method])
-        end
-
-        def items_in_account
-          if options[:collection_method] == :users
-            parent.account.users.order(options[:order])
-          elsif parent.is_a?(User)
-            options[:resource].entity.send(options[:collection_method]).order(options[:order])
-          else
-            parent.account.send(options[:collection_method]).order(options[:order])
-          end
-        end
-
-        def items_in_parent
-          parent.respond_to?(options[:collection_method]) ? parent.send(options[:collection_method]) : []
+      def membership_entry_select(f, parent)
+        if f.object.persisted?
+          membership_disabled_select(f, :entity, f.object.entity, :title)
+        elsif parent.is_a?(Entry)
+          membership_disabled_select(f, :entity, parent, :title)
+        else
+          membership_select(f, :entry, parent, :potential_entries_for_user)
         end
+      end
 
-        def accounts_ids_in_parent_accounts_ids
-          parent_accounts_ids = parent.accounts.map(&:id)
-          if parent_accounts_ids.any?
-            sanitize_sql_array(['pageflow_accounts.id IN (:parent_accounts_ids)',
-                                parent_accounts_ids: parent_accounts_ids])
-          else
-            'FALSE'
-          end
+      def membership_account_select(f, parent)
+        if f.object.persisted?
+          membership_disabled_select(f, :entity, f.object.entity, :name)
+        elsif parent.is_a?(Account)
+          membership_disabled_select(f, :entity, parent, :name)
+        else
+          membership_select(f, :entity, parent, :potential_accounts_for_user)
         end
+      end
 
-        def entries_ids_not_in_parent_entries_ids
-          parent_entries_ids = items_in_parent.map(&:id)
-          if parent_entries_ids.any?
-            sanitize_sql_array(['pageflow_entries.id NOT IN (:parent_entries_ids)',
-                                parent_entries_ids: parent_entries_ids])
-          else
-            'TRUE'
-          end
-        end
+      def membership_select(f, name, parent, collection_name)
+        f.input(name,
+                as: :searchable_select,
+                ajax: {resource: Membership,
+                       collection_name: collection_name,
+                       params: {parent_id: parent.id}},
+                include_blank: false)
+      end
 
-        def sanitize_sql_array(array)
-          ActiveRecord::Base.send(:sanitize_sql_array, array)
-        end
+      def membership_disabled_select(f, name, record, text_method)
+        f.input(name,
+                as: :searchable_select,
+                collection: [[record.send(text_method), record.id]],
+                include_blank: false,
+                input_html: {disabled: true})
       end
     end
   end

data/app/helpers/pageflow/admin/users_helper.rb

@@ -1,6 +1,21 @@
 module Pageflow
   module Admin
     module UsersHelper
+      include QuotaHelper
+
+      def users_quota_state(account)
+        quota = Pageflow.config.quotas.get(:users, account)
+        data_attributes = {
+          account_id: account.id,
+          state: quota.state
+        }
+
+        render('pageflow/admin/users/quota_state',
+               account: account,
+               quota: quota,
+               data_attributes: data_attributes)
+      end
+
       def collection_for_user_roles
         User.roles_accessible_by(current_ability).index_by { |role| t(role, :scope => 'pageflow.admin.users.roles') }
       end

data/app/helpers/pageflow/entries_helper.rb

@@ -42,7 +42,9 @@ module Pageflow
     end
 
     def entry_theme_stylesheet_link_tag(entry)
-      stylesheet_link_tag(entry.theming.theme.stylesheet_path, :media => 'all')
+      stylesheet_link_tag(entry.theme.stylesheet_path,
+                          media: 'all',
+                          data: {name: 'theme'})
     end
 
     def entry_stylesheet_link_tag(entry)

data/app/helpers/pageflow/entry_json_seed_helper.rb

@@ -12,10 +12,11 @@ module Pageflow
     end
 
     def entry_theming_seed(entry)
+      theme = entry.theme
       {
-        change_to_parent_page_at_storyline_boundary: entry.theming.theme.change_to_parent_page_at_storyline_boundary?,
-        page_change_by_scrolling: entry.theming.theme.page_change_by_scrolling?,
-        hide_text_on_swipe: entry.theming.theme.hide_text_on_swipe?
+        change_to_parent_page_at_storyline_boundary: theme.change_to_parent_page_at_storyline_boundary?,
+        page_change_by_scrolling: theme.page_change_by_scrolling?,
+        hide_text_on_swipe: theme.hide_text_on_swipe?
       }
     end
 
@@ -34,6 +35,11 @@ module Pageflow
       entry.pages.as_json(only: attributes)
     end
 
+    def entry_widgets_seed(entry)
+      attributes = [:type_name, :role, :configuration]
+      entry.resolve_widgets.as_json(only: attributes)
+    end
+
     def entry_file_ids_seed(entry)
       Pageflow.config.file_types.with_thumbnail_support.each_with_object({}) do |file_type, result|
         result[file_type.collection_name] = entry.find_files(file_type.model).map(&:id)

data/app/helpers/pageflow/public_i18n_helper.rb

@@ -9,9 +9,9 @@ module Pageflow
     def public_i18n_translations(entry)
       {
         pageflow: {
-          public: I18n.t('pageflow.public', locale: entry.locale)
+          public: I18n.t('pageflow.public', locale: I18n.default_locale)
                       .dup
-                      .deep_merge(I18n.t('pageflow.public', locale: I18n.default_locale))
+                      .deep_merge(I18n.t('pageflow.public', locale: entry.locale))
         }
       }
     end

data/app/helpers/pageflow/quota_helper.rb

@@ -1,10 +1,10 @@
 module Pageflow
   module QuotaHelper
     def quota_state_description(name, account)
-      description = Pageflow.config.quotas.get(:users, account).state_description
+      description = Pageflow.config.quotas.get(name, account).state_description
 
       if description
-        content_tag(:p, description, :class => 'quota_state')
+        content_tag(:p, description, class: 'quota_state_description')
       end
     end
   end

data/app/helpers/pageflow/social_share_helper.rb

@@ -53,9 +53,10 @@ module Pageflow
 
     def social_share_entry_image_tags(entry)
       image_urls = []
+      image_file = ImageFile.find_by_id(entry.share_image_id)
 
-      if entry.share_image_id.present?
-        image_urls << ImageFile.find(entry.share_image_id).thumbnail_url(:medium)
+      if image_file
+        image_urls << image_file.thumbnail_url(:medium)
       else
         entry.pages.each do |page|
           if image_urls.size >= 4

data/app/helpers/pageflow/themes_helper.rb

@@ -1,9 +1,17 @@
 module Pageflow
   module ThemesHelper
-    def themes_options_json_seed
-      Pageflow.config.themes.each_with_object({}) do |theme, options|
+    include RenderJsonHelper
+
+    def themes_options_json_seed(config = Pageflow.config)
+      config.themes.each_with_object({}) { |theme, options|
         options[theme.name] = theme.options
-      end.to_json.html_safe
+      }.to_json.html_safe
+    end
+
+    def theme_json_seeds(config)
+      render_json_partial('pageflow/themes/theme',
+                          collection: config.themes,
+                          as: :theme)
     end
   end
 end

data/app/helpers/pageflow/widgets_helper.rb

@@ -1,8 +1,12 @@
 module Pageflow
   module WidgetsHelper
+    include RenderJsonHelper
+
     def render_widget_head_fragments(entry, options = {})
       fragments = entry.resolve_widgets(options).map do |widget|
-        widget.widget_type.render_head_fragment(self, entry)
+        widget.widget_type.render_head_fragment_with_configuration(self,
+                                                                   entry,
+                                                                   widget.configuration)
       end
 
       safe_join(fragments)
@@ -10,7 +14,7 @@ module Pageflow
 
     def render_widgets(entry, options = {})
       fragments = entry.resolve_widgets(options).map do |widget|
-        widget.widget_type.render(self, entry)
+        widget.widget_type.render_with_configuration(self, entry, widget.configuration)
       end
 
       safe_join(fragments)
@@ -33,5 +37,9 @@ module Pageflow
         end
       end.to_json.html_safe
     end
+
+    def widgets_json_seeds(entry)
+      render_json_seed(entry.resolve_widgets(include_placeholders: true))
+    end
   end
 end

data/app/jobs/pageflow/prune_auto_snapshots_job.rb

@@ -0,0 +1,9 @@
+module Pageflow
+  class PruneAutoSnapshotsJob
+    @queue = :prune
+
+    def self.perform(entry_id, options)
+      AutoSnapshotPruning.prune(Entry.find(entry_id), options.symbolize_keys)
+    end
+  end
+end