pageflow 17.0.5 → 17.1.0

data/entry_types/scrolled/package/widgets/textInlineFileRights.js

@@ -1,5 +1,5 @@
-import { frontend } from 'pageflow-scrolled/frontend';
-import React from 'react';
+import { useDarkBackground, useContentElementEditorState, frontend } from 'pageflow-scrolled/frontend';
+import React, { useEffect } from 'react';
 import classNames from 'classnames';
 
 function _defineProperty(obj, key, value) {
@@ -17,18 +17,35 @@ function _defineProperty(obj, key, value) {
   return obj;
 }
 
-var styles = {"text":"TextInlineFileRights-module_text__1tT0W","forSection":"TextInlineFileRights-module_forSection__22xHD"};
+var styles = {"darkContentSurfaceColor":"var(--theme-dark-content-surface-color, #101010)","lightContentSurfaceColor":"var(--theme-light-content-surface-color, #fff)","darkContentTextColor":"var(--theme-dark-content-text-color, #222)","lightContentTextColor":"var(--theme-light-content-text-color, #fff)","contentColorScope":"colors-module_contentColorScope__3ypcw","text":"TextInlineFileRights-module_text__1tT0W","withBackdrop":"TextInlineFileRights-module_withBackdrop__2cRu8","darkBackground":"TextInlineFileRights-module_darkBackground__3oIUp","forSection":"TextInlineFileRights-module_forSection__22xHD"};
 
 function TextInlineFileRights(_ref) {
-  var context = _ref.context,
-      children = _ref.children;
-
-  if (context === 'insideElement' || context === 'playerControls') {
+  var configuration = _ref.configuration,
+    context = _ref.context,
+    children = _ref.children;
+  var darkBackground = useDarkBackground();
+  var _useContentElementEdi = useContentElementEditorState(),
+    setTransientState = _useContentElementEdi.setTransientState;
+  var supported = context !== 'insideElement' && context !== 'playerControls';
+  useEffect(function () {
+    if (supported) {
+      setTransientState({
+        hasFileRights: true
+      });
+    }
+    return function () {
+      if (supported) {
+        setTransientState({
+          hasFileRights: false
+        });
+      }
+    };
+  }, [setTransientState, supported]);
+  if (!supported) {
     return null;
   }
-
   return /*#__PURE__*/React.createElement("div", {
-    className: classNames(styles.text, _defineProperty({}, styles.forSection, context === 'section'))
+    className: classNames(styles.text, _defineProperty(_defineProperty(_defineProperty({}, styles.forSection, context === 'section'), styles.withBackdrop, context === 'section' || configuration.showTextInlineFileRightsBackdrop), styles.darkBackground, darkBackground))
   }, /*#__PURE__*/React.createElement("div", null, children));
 }
 

data/entry_types/scrolled/package/widgets-server.js

@@ -2,3 +2,4 @@ import 'pageflow-scrolled/widgets/defaultNavigation';
 import 'pageflow-scrolled/widgets/consentBar';
 import 'pageflow-scrolled/widgets/iconInlineFileRights';
 import 'pageflow-scrolled/widgets/textInlineFileRights';
+import 'pageflow-scrolled/widgets/iconScrollIndicator';

data/entry_types/scrolled/spec/factories/chapters.rb

@@ -1,7 +1,20 @@
 module PageflowScrolled
   FactoryBot.define do
     factory :scrolled_chapter, class: Chapter do
-      revision
+      transient do
+        revision { nil }
+      end
+
+      before(:create) do |chapter, evaluator|
+        if chapter.storyline.nil?
+          revision = evaluator.revision || build(:revision)
+          chapter.storyline = Storyline.all_for_revision(revision).first ||
+                              create(:scrolled_storyline,
+                                     revision:,
+                                     configuration: {main: true})
+        end
+      end
+
       configuration do
         {
           title: 'chapter title'

data/entry_types/scrolled/spec/factories/content_elements.rb

@@ -10,7 +10,7 @@ module PageflowScrolled
       before(:create) do |content_element, evaluator|
         if evaluator.revision
           chapter = create(:scrolled_chapter, revision: evaluator.revision)
-          content_element.section = create(:section, chapter: chapter)
+          content_element.section = create(:section, chapter:)
         end
       end
     end

data/lib/generators/pageflow/active_admin_initializer/active_admin_initializer_generator.rb

@@ -2,8 +2,9 @@ require 'rails/generators'
 
 module Pageflow
   module Generators
+    # @api private
     class ActiveAdminInitializerGenerator < Rails::Generators::Base
-      desc "Configure active admin utilitiy menu to contain profile link."
+      desc 'Configure active admin utilitiy menu to contain profile link.'
 
       def configure_active_admin_load_path
         prepend_to_file 'config/initializers/active_admin.rb' do
@@ -12,7 +13,8 @@ module Pageflow
       end
 
       def configure_active_admin
-        inject_into_file 'config/initializers/active_admin.rb', after: "ActiveAdmin.setup do |config|\n" do
+        inject_into_file 'config/initializers/active_admin.rb',
+                         after: "ActiveAdmin.setup do |config|\n" do
           <<-RUBY
   Pageflow.active_admin_settings(config)
 
@@ -26,7 +28,7 @@ module Pageflow
       admin.add_logout_button_to_menu(menu)
     end
   end
-RUBY
+          RUBY
         end
       end
 

data/lib/generators/pageflow/assets/assets_generator.rb

@@ -2,10 +2,11 @@ require 'rails/generators'
 
 module Pageflow
   module Generators
+    # @api private
     class AssetsGenerator < Rails::Generators::Base
-      desc "Install the pageflow assets."
+      desc 'Install the pageflow assets.'
 
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path('templates', __dir__)
 
       def create_assets
         template 'editor.js', 'app/assets/javascripts/pageflow/editor.js'
@@ -26,9 +27,10 @@ module Pageflow
       end
 
       def initialize_on_precompile
-        inject_into_file 'config/application.rb', after: "class Application < Rails::Application\n" do
-          "    # required for i18n-js gem\n" +
-          "    config.assets.initialize_on_precompile = true\n\n"
+        inject_into_file 'config/application.rb',
+                         after: "class Application < Rails::Application\n" do
+          "    # required for i18n-js gem\n    " \
+            "config.assets.initialize_on_precompile = true\n\n"
         end
       end
     end

data/lib/generators/pageflow/cancan/cancan_generator.rb

@@ -2,10 +2,11 @@ require 'rails/generators'
 
 module Pageflow
   module Generators
+    # @api private
     class CancanGenerator < Rails::Generators::Base
       desc 'Setup ability class.'
 
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path('templates', __dir__)
 
       def create_ability
         template 'ability.rb', 'app/models/ability.rb'

data/lib/generators/pageflow/cancan/templates/ability.rb

@@ -7,6 +7,6 @@ class Ability
     pageflow_default_abilities(user)
 
     # Allow signed-in users to view the admin dashboard
-    can :read, ActiveAdmin::Page, :name => "Dashboard"
+    can :read, ActiveAdmin::Page, name: 'Dashboard'
   end
 end

data/lib/generators/pageflow/error_pages/error_pages_generator.rb

@@ -2,10 +2,11 @@ require 'rails/generators'
 
 module Pageflow
   module Generators
+    # @api private
     class ErrorPagesGenerator < Rails::Generators::Base
       desc 'Generate error pages.'
 
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path('templates', __dir__)
 
       def create_not_found
         copy_file '404.html', 'public/pageflow/error_pages/404.html'

data/lib/generators/pageflow/initializer/initializer_generator.rb

@@ -2,10 +2,11 @@ require 'rails/generators'
 
 module Pageflow
   module Generators
+    # @api private
     class InitializerGenerator < Rails::Generators::Base
-      desc "Install the pageflow initializer."
+      desc 'Install the pageflow initializer.'
 
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path('templates', __dir__)
 
       def create_initializer
         template 'pageflow.rb', 'config/initializers/pageflow.rb'

data/lib/generators/pageflow/install/install_generator.rb

@@ -1,8 +1,8 @@
 module Pageflow
   module Generators
+    # @api private
     class InstallGenerator < Rails::Generators::Base
-
-      desc "Installs Pageflow and generates the necessary migrations."
+      desc 'Installs Pageflow and generates the necessary migrations.'
 
       def generate_all
         generate 'active_admin:install User --skip-users'

data/lib/generators/pageflow/procfile/procfile_generator.rb

@@ -2,10 +2,11 @@ require 'rails/generators'
 
 module Pageflow
   module Generators
+    # @api private
     class ProcfileGenerator < Rails::Generators::Base
       desc 'Generate a Procfile in Rails root.'
 
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path('templates', __dir__)
 
       def generate_procfile
         copy_file 'Procfile', 'Procfile'

data/lib/generators/pageflow/resque/resque_generator.rb

@@ -2,20 +2,22 @@ require 'rails/generators'
 
 module Pageflow
   module Generators
+    # @api private
     class ResqueGenerator < Rails::Generators::Base
-      desc "Configure resque for pageflow."
+      desc 'Configure resque for pageflow.'
 
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path('templates', __dir__)
 
       def create_initializers
         template 'resque.rb', 'config/initializers/resque.rb'
-        template 'resque_enqueue_after_commit_patch.rb', 'config/initializers/resque_enqueue_after_commit_patch.rb'
+        template 'resque_enqueue_after_commit_patch.rb',
+                 'config/initializers/resque_enqueue_after_commit_patch.rb'
         template 'resque.rake', 'lib/tasks/resque.rake'
 
         inject_into_file 'config/application.rb', after: /config.load_defaults .*\n/ do
           <<-RUBY
     config.active_job.queue_adapter = :resque
-RUBY
+          RUBY
         end
       end
     end

data/lib/generators/pageflow/resque/templates/resque.rake

@@ -3,5 +3,5 @@ require 'resque/scheduler/tasks'
 
 namespace :resque do
   # Tell resque to initialize the rails app in worker processes
-  task :setup => :environment
+  task setup: :environment
 end

data/lib/generators/pageflow/routes/routes_generator.rb

@@ -2,8 +2,9 @@ require 'rails/generators'
 
 module Pageflow
   module Generators
+    # @api private
     class RoutesGenerator < Rails::Generators::Base
-      desc "Injects the pageflow mount call into config/routes.rb"
+      desc 'Injects the pageflow mount call into config/routes.rb'
 
       def add_route
         inject_into_file 'config/routes.rb', after: "  ActiveAdmin.routes(self)\n" do
@@ -19,7 +20,8 @@ module Pageflow
       end
 
       def require_resque_server
-        prepend_to_file 'config/routes.rb', "require 'resque/server'\nrequire 'resque/scheduler/server'\n\n"
+        prepend_to_file 'config/routes.rb',
+                        "require 'resque/server'\nrequire 'resque/scheduler/server'\n\n"
       end
     end
   end

data/lib/generators/pageflow/seeds/seeds_generator.rb

@@ -3,14 +3,15 @@ require 'securerandom'
 
 module Pageflow
   module Generators
+    # @api private
     class SeedsGenerator < Rails::Generators::Base
-      desc "Requires the pageflow seeds in db/seeds.rb"
+      desc 'Requires the pageflow seeds in db/seeds.rb'
 
       argument :password,
                default: SecureRandom.random_number(36**12).to_s(36).rjust(12, '0'),
                desc: 'Default user password'
 
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path('templates', __dir__)
 
       def create_initializer
         template 'seeds.rb', 'db/seeds.rb'

data/lib/generators/pageflow/seeds/templates/seeds.rb

@@ -2,7 +2,7 @@
 # It will create example users for each of the Pageflow roles.
 # Feel free to edit or remove it; these entries are not required for Pageflow to function.
 
-include Pageflow::Seeds
+include Pageflow::Seeds # rubocop:disable Style/MixinUsage
 
 default_user_password('<%= password %>')
 
@@ -13,11 +13,11 @@ member_account = account(name: 'Stagg Enterprises')
 account(name: 'Waterloo Road Comprehensive')
 
 account(name: 'Pageflow') do |account|
-  politics_entry = sample_entry(account: account, title: 'Story in Politics')
-  sports_entry = sample_entry(account: account, title: 'Story in Sports')
-  finance_entry = sample_entry(account: account, title: 'Story in Finance')
-  entertainment_entry = sample_entry(account: account, title: 'Story in Entertainment')
-  sample_entry(account: account, title: 'Story in Science')
+  politics_entry = sample_entry(account:, title: 'Story in Politics')
+  sports_entry = sample_entry(account:, title: 'Story in Sports')
+  finance_entry = sample_entry(account:, title: 'Story in Finance')
+  entertainment_entry = sample_entry(account:, title: 'Story in Entertainment')
+  sample_entry(account:, title: 'Story in Science')
 
   user(email: 'admin@example.com',
        first_name: 'Alice',

data/lib/generators/pageflow/theme/theme_generator.rb

@@ -2,6 +2,7 @@ require 'rails/generators'
 
 module Pageflow
   module Generators
+    # @api private
     class ThemeGenerator < Rails::Generators::Base
       desc 'Creates a configurable theme based on the default theme.'
 
@@ -10,7 +11,7 @@ module Pageflow
                default: 'custom',
                desc: 'The name of the new theme'
 
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path('templates', __dir__)
 
       def copy_template
         directory('themes', File.join('app', 'assets', 'stylesheets', 'pageflow', 'themes'))

data/lib/generators/pageflow/user/user_generator.rb

@@ -2,8 +2,9 @@ require 'rails/generators'
 
 module Pageflow
   module Generators
+    # @api private
     class UserGenerator < Rails::Generators::Base
-      desc "Injects the Pageflow::User mixin into the User class."
+      desc 'Injects the Pageflow::User mixin into the User class.'
 
       def include_mixin
         inject_into_file 'app/models/user.rb', before: /end$/ do

data/lib/pageflow/ability_mixin.rb

@@ -35,8 +35,8 @@ module Pageflow
         membership.entity.nil? ||
           membership.user.nil? ||
           (!(membership.user.entries.include?(membership.entity) ||
-             membership.user.accounts.include?(membership.entity))) &&
-            MembershipPolicy.new(user, membership).create?
+             membership.user.accounts.include?(membership.entity)) &&
+            MembershipPolicy.new(user, membership).create?)
       end
 
       can :index, Membership, MembershipPolicy::Scope.new(user, Membership).indexable
@@ -111,6 +111,12 @@ module Pageflow
         AccountPolicy.new(user, account).see_entry_types?
       end
 
+      can :manage, ActiveAdmin::Page, name: 'Site Root Entry'
+
+      can :manage_root_entry, Site do |site|
+        SitePolicy.new(user, site).manage_root_entry?
+      end
+
       unless user.admin?
         can :configure_folder_on, Account do |account|
           AccountPolicy.new(user, account).configure_folder_on?
@@ -156,6 +162,10 @@ module Pageflow
           EntryPolicy.new(user, entry).duplicate?
         end
 
+        can :manage_translations, Entry do |entry|
+          EntryPolicy.new(user, entry).manage_translations?
+        end
+
         can :edit_outline, Entry do |entry|
           EntryPolicy.new(user, entry).edit_outline?
         end
@@ -273,20 +283,20 @@ module Pageflow
         UserPolicy.new(user, user_to_delete).delete_own_user?
       end
 
-      if user.admin?
-        can [:create, :configure_folder_on], Account
-        can :create_any, :accounts
-        can :destroy, Account do |account|
-          account.users.empty? && account.entries.empty?
-        end
-        can :manage, [Storyline, Chapter, Page]
-        can :manage, [Entry, Revision]
-        can :manage, Pageflow.config.file_types.map(&:model)
-        can :manage, Folder
-        can :manage, Site
-        can :manage, EntryTemplate
-        can :manage, ::User
+      return unless user.admin?
+
+      can [:create, :configure_folder_on], Account
+      can :create_any, :accounts
+      can :destroy, Account do |account|
+        account.users.empty? && account.entries.empty?
       end
+      can :manage, [Storyline, Chapter, Page]
+      can :manage, [Entry, Revision]
+      can :manage, Pageflow.config.file_types.map(&:model)
+      can :manage, Folder
+      can :manage, Site
+      can :manage, EntryTemplate
+      can :manage, ::User
     end
   end
 end

data/lib/pageflow/active_admin_patches/views/attributes_table.rb

@@ -1,6 +1,7 @@
 module Pageflow
   module ActiveAdminPatches
     module Views
+      # @api private
       module AttributesTable
         def boolean_status_tag_row(name, yes_state = :warning)
           status_tag_row(name,

data/lib/pageflow/active_admin_patches/views/pages/base.rb

@@ -2,9 +2,10 @@ module Pageflow
   module ActiveAdminPatches
     module Views
       module Pages
+        # @api private
         module Base
-          def build(*args)
-            super(*args)
+          def build(*)
+            super
             set_attribute(:lang, I18n.locale)
           end
         end

data/lib/pageflow/active_admin_patches/views/table_for.rb

@@ -1,6 +1,7 @@
 module Pageflow
   module ActiveAdminPatches
     module Views
+      # @api private
       module TableFor
         def row_attributes
           @collection.each_with_index do |item, i|

data/lib/pageflow/additional_headers.rb

@@ -0,0 +1,27 @@
+module Pageflow
+  # Register additional response headers for published entries.
+  class AdditionalHeaders
+    # @api private
+    def initialize
+      @headers = []
+    end
+
+    # Either a hash of name values pair or a callable taking a
+    # {PublishedEntry} record and an {ActionDispatch::Request} object
+    # and returns a hash.
+    def register(headers)
+      @headers << headers
+    end
+
+    # @api private
+    def for(entry, request)
+      @headers.map { |headers|
+        if headers.respond_to?(:call)
+          headers.call(entry, request)
+        else
+          headers
+        end
+      }.reduce({}, :merge)
+    end
+  end
+end

data/lib/pageflow/admin/attributes_table_rows.rb

@@ -4,7 +4,7 @@ module Pageflow
   #
   # @since 12.2
   module Admin
-    class AttributesTableRows
+    class AttributesTableRows # rubocop:todo Style/Documentation
       # @api private
       def initialize
         @rows = {}
@@ -31,8 +31,8 @@ module Pageflow
       def register(resource_name, name, options = {}, &block)
         @rows[resource_name] ||= []
         @rows[resource_name] << {
-          name: name,
-          block: block,
+          name:,
+          block:,
           options: options.except(:before, :after),
           **options.slice(:before, :after)
         }

data/lib/pageflow/admin/tabs.rb

@@ -1,6 +1,6 @@
 module Pageflow
   module Admin
-    class Tabs
+    class Tabs # rubocop:todo Style/Documentation
       # @api private
       def initialize
         @tabs = {}

data/lib/pageflow/built_in_file_type.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module BuiltInFileType
+  module BuiltInFileType # rubocop:todo Style/Documentation
     # Factory methods to decouple Pageflow initializers from concrete
     # file type classes, making more transparent which file types are
     # available as built-ins.

data/lib/pageflow/built_in_page_types_plugin.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class BuiltInPageTypesPlugin < Plugin
+  class BuiltInPageTypesPlugin < Plugin # rubocop:todo Style/Documentation
     def configure(config)
       config.for_entry_type(PageflowPaged.entry_type) do |entry_type_config|
         entry_type_config.page_types.register(BuiltInPageType.plain)

data/lib/pageflow/built_in_widget_type.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class BuiltInWidgetType < WidgetType
+  class BuiltInWidgetType < WidgetType # rubocop:todo Style/Documentation
     attr_reader :name, :roles, :partial_path
 
     def initialize(name, roles, partial_path)
@@ -13,7 +13,7 @@ module Pageflow
     end
 
     def render(template, entry)
-      template.render(partial_path, entry: entry, widget_type_name: name)
+      template.render(partial_path, entry:, widget_type_name: name)
     end
 
     def self.navigation

data/lib/pageflow/built_in_widget_types_plugin.rb

@@ -46,7 +46,8 @@ module Pageflow
 
     def player_controls(config)
       config.widget_types.register(Pageflow::BuiltInWidgetType.slim_player_controls)
-      config.widget_types.register(Pageflow::BuiltInWidgetType.classic_player_controls, default: true)
+      config.widget_types.register(Pageflow::BuiltInWidgetType.classic_player_controls,
+                                   default: true)
     end
 
     def cookie_notice(config)