pageflow 17.0.5 → 17.2.0

data/app/models/pageflow/revision.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class Revision < ApplicationRecord
+  class Revision < ApplicationRecord # rubocop:todo Style/Documentation
     include SerializedConfiguration
 
     PAGE_ORDER = [
@@ -27,14 +27,17 @@ module Pageflow
     has_many :chapters, -> { order(CHAPTER_ORDER) }, through: :storylines
     has_many :pages, -> { reorder(PAGE_ORDER) }, through: :storylines
 
+    has_many :comment_threads, dependent: :destroy
+
     has_many :file_usages, dependent: :destroy
+    has_many :file_folders, dependent: :destroy
 
     has_many :image_files, -> { extending WithFileUsageExtension },
-    :through => :file_usages, :source => :file, :source_type => 'Pageflow::ImageFile'
+             through: :file_usages, source: :file, source_type: 'Pageflow::ImageFile'
     has_many :video_files, -> { extending WithFileUsageExtension },
-    :through => :file_usages, :source => :file, :source_type => 'Pageflow::VideoFile'
+             through: :file_usages, source: :file, source_type: 'Pageflow::VideoFile'
     has_many :audio_files, -> { extending WithFileUsageExtension },
-    :through => :file_usages, :source => :file, :source_type => 'Pageflow::AudioFile'
+             through: :file_usages, source: :file, source_type: 'Pageflow::AudioFile'
 
     scope(:published,
           lambda do
@@ -71,7 +74,11 @@ module Pageflow
     scope :frozen, -> { where('frozen_at IS NOT NULL') }
 
     scope :publications, -> { where('published_at IS NOT NULL') }
-    scope :publications_and_user_snapshots, -> { where('published_at IS NOT NULL OR snapshot_type = "user"') }
+    scope :publications_and_user_snapshots, lambda {
+      where(
+        'published_at IS NOT NULL OR snapshot_type = "user"'
+      )
+    }
     scope :user_snapshots, -> { where(snapshot_type: 'user') }
     scope :auto_snapshots, -> { where(snapshot_type: 'auto') }
 
@@ -100,6 +107,7 @@ module Pageflow
     def find_file_by_perma_id(model, perma_id)
       file = files(model).find_by(pageflow_file_usages: {file_perma_id: perma_id})
       return unless file
+
       UsedFile.new(file)
     end
 
@@ -140,7 +148,7 @@ module Pageflow
     end
 
     def published?
-      (published_at.present? && Time.now >= published_at) &&
+      published_at.present? && Time.now >= published_at &&
         (published_until.blank? || Time.now < published_until)
     end
 
@@ -163,7 +171,7 @@ module Pageflow
     # Public interface for copying a revision
     #
     # @since 15.1
-    def copy(&block)
+    def copy
       revision = dup
 
       yield(revision) if block_given?
@@ -172,15 +180,16 @@ module Pageflow
         widget.copy_to(revision)
       end
 
-      file_usages.each do |file_usage|
-        file_usage.copy_to(revision)
-      end
+      revision.save!
 
-      find_revision_components.each do |revision_component|
-        revision_component.copy_to(revision)
-      end
+      NestedRevisionComponentCopy.new(
+        from: self,
+        to: revision
+      ).perform_for(
+        revision_components: Pageflow.config.revision_components.to_a +
+                             [FileFolder, FileUsage]
+      )
 
-      revision.save!
       revision
     end
 
@@ -190,8 +199,12 @@ module Pageflow
       end
     end
 
+    def entry_for_auto_generated_perma_id
+      entry
+    end
+
     def self.depublish_all
-      published.update_all(:published_until => Time.now)
+      published.update_all(published_until: Time.now)
     end
 
     def configuration
@@ -203,7 +216,7 @@ module Pageflow
         'manual_start' => manual_start,
         'overview_button_enabled' => overview_button_enabled
       }.delete_if { |_k, v| v.nil? }
-        .merge(read_attribute(:configuration) || {})
+       .merge(read_attribute(:configuration) || {})
     end
 
     def self.ransackable_attributes(_auth_object = nil)

data/app/models/pageflow/roles.rb

@@ -1,33 +1,29 @@
 module Pageflow
-  module Roles
+  module Roles # rubocop:todo Style/Documentation
     module_function
 
     def at_least(role_uncasted)
       role = role_uncasted.to_sym
-      if role == :member
-        %w(member previewer editor publisher manager)
-      elsif role == :previewer
-        %w(previewer editor publisher manager)
-      elsif role == :editor
-        %w(editor publisher manager)
-      elsif role == :publisher
-        %w(publisher manager)
-      elsif role == :manager
-        %w(manager)
-      end
+      {
+        member: %w[member previewer editor publisher manager],
+        previewer: %w[previewer editor publisher manager],
+        editor: %w[editor publisher manager],
+        publisher: %w[publisher manager],
+        manager: %w[manager]
+      }[role]
     end
 
     def high(user, entry)
       roles = [:none, :member, :previewer, :editor, :publisher, :manager]
 
-      account_membership = Membership.where(user: user, entity: entry.account).first
+      account_membership = Membership.where(user:, entity: entry.account).first
       account_role = account_membership ? account_membership.role : :none
 
-      if user.entries.include?(entry)
-        entry_role = Membership.where(user: user, entity: entry).first.role
-      else
-        entry_role = :none
-      end
+      entry_role = if user.entries.include?(entry)
+                     Membership.where(user:, entity: entry).first.role
+                   else
+                     :none
+                   end
 
       if roles.find_index(account_role.to_sym) > roles.find_index(entry_role.to_sym)
         account_role.to_sym

data/app/models/pageflow/site.rb

@@ -1,18 +1,31 @@
 module Pageflow
-  class Site < ApplicationRecord
+  class Site < ApplicationRecord # rubocop:todo Style/Documentation
+    include TranslatedAttributes
+
     belongs_to :account
+    belongs_to :custom_404_entry, class_name: 'Entry', optional: true
 
     has_many :entry_templates, dependent: :destroy
     has_many :entries
     has_many :permalink_directories, -> { order('path ASC') }
 
+    translated_attributes :imprint_link_label, :imprint_link_url,
+                          :copyright_link_label, :copyright_link_url,
+                          :privacy_link_url
+
     scope :with_home_url, -> { where.not(home_url: '') }
     scope :for_request, ->(request) { Pageflow.config.site_request_scope.call(all, request) }
 
-    validates :account, :presence => true
+    validates :account, presence: true
+    validates_inclusion_of :cutoff_mode_name, in: :available_cutoff_mode_names, allow_blank: true
+    validate :custom_404_entry_belongs_to_same_site
 
     delegate :enabled_feature_names, to: :account
 
+    def legal_info(locale:)
+      LegalInfo.new(self, locale)
+    end
+
     def display_name
       name.presence || I18n.t('pageflow.admin.sites.default_name')
     end
@@ -22,13 +35,31 @@ module Pageflow
     end
 
     def host
-      Pageflow.config.site_url_options(self)&.dig(:host)
+      Pageflow.config.site_url_options_for(self)&.dig(:host)
+    end
+
+    def display_title
+      title.presence || cname_domain.presence
     end
 
     def cname_domain
       cname.split('.').pop(2).join('.')
     end
 
+    def build_root_permalink_directory
+      permalink_directories.build(path: '')
+    end
+
+    def root_entry
+      return unless root_permalink_directory
+
+      root_permalink_directory.permalinks.find_by_slug('')&.entry
+    end
+
+    def root_permalink_directory
+      permalink_directories.find_by_path('')
+    end
+
     def first_paged_entry_template
       entry_templates.find_or_initialize_by(entry_type_name: 'paged')
     end
@@ -63,5 +94,17 @@ module Pageflow
     def self.ransackable_associations(_auth_object = nil)
       %w[account]
     end
+
+    private
+
+    def available_cutoff_mode_names
+      Pageflow.config_for(account).cutoff_modes.names
+    end
+
+    def custom_404_entry_belongs_to_same_site
+      return unless custom_404_entry.present?
+
+      errors.add(:custom_404_entry, :must_belong_to_same_site) if custom_404_entry.site_id != id
+    end
   end
 end

data/app/models/pageflow/site_root_entry_form.rb

@@ -0,0 +1,27 @@
+module Pageflow
+  # @api private
+  class SiteRootEntryForm
+    include ActiveModel::Model
+
+    attr_accessor :entry_id
+
+    validates :entry, presence: true
+
+    def initialize(attributes, site)
+      super(attributes)
+      @site = site
+    end
+
+    def save
+      return false unless valid?
+
+      entry.permalink.update(allow_root_path: true,
+                             directory: @site.permalink_directories.find_by_path(''),
+                             slug: '')
+    end
+
+    def entry
+      @entry ||= @site.entries.find_by_id(entry_id)
+    end
+  end
+end

data/app/models/pageflow/sitemaps.rb

@@ -5,9 +5,18 @@ module Pageflow
       PublishedEntry.wrap_all(
         site
           .entries
+          .preload(:account,
+                   permalink: :directory,
+                   translation_group: {
+                     publicly_visible_entries: [
+                       :account,
+                       :published_revision,
+                       {permalink: :directory}
+                     ]
+                   })
           .published_without_password_protection
           .published_without_noindex
-          .order('first_published_at DESC')
+          .order(first_published_at: :desc)
       )
     end
   end

data/app/models/pageflow/storyline.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class Storyline < ApplicationRecord
+  class Storyline < ApplicationRecord # rubocop:todo Style/Documentation
     include SerializedConfiguration
     include RevisionComponent
 
@@ -11,7 +11,10 @@ module Pageflow
     has_many :pages, through: :chapters
 
     nested_revision_components :chapters
-
     delegate :entry, to: :revision
+
+    def self.create_defaults(draft)
+      create!(revision: draft, configuration: {main: true})
+    end
   end
 end

data/app/models/pageflow/storyline_scaffold.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class StorylineScaffold
+  class StorylineScaffold # rubocop:todo Style/Documentation
     def initialize(storyline, options)
       @storyline = storyline
       @options = options

data/app/models/pageflow/text_track_file.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class TextTrackFile < ApplicationRecord
+  class TextTrackFile < ApplicationRecord # rubocop:todo Style/Documentation
     include UploadableFile
     include ImageAndTextTrackProcessingStateMachine
 

data/app/models/pageflow/text_track_file_url_templates.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class TextTrackFileUrlTemplates
+  class TextTrackFileUrlTemplates # rubocop:todo Style/Documentation
     def call
       {
         vtt: UrlTemplate.from_attachment(example_file.attachment, :vtt)

data/app/models/pageflow/theme_customization_file.rb

@@ -20,6 +20,7 @@ module Pageflow
     class AttachmentContentTypeValidator < Paperclip::Validators::AttachmentContentTypeValidator
       def validate_whitelist(record, attribute, value)
         return if value =~ record.options_from_entry_type[:content_type]
+
         record.errors.add(attribute, :invalid)
       end
 
@@ -39,9 +40,9 @@ module Pageflow
     # A hash of urls based on the styles that were defined when
     # registering the entry type.
     def urls
-      styles_from_options.map { |style, _|
+      styles_from_options.to_h do |style, _|
         [style, attachment.url(style)]
-      }.to_h
+      end
     end
 
     # @api private

data/app/models/pageflow/thumbnail_file_resolver.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class ThumbnailFileResolver < Struct.new(:entry, :candidates, :configuration)
+  ThumbnailFileResolver = Struct.new(:entry, :candidates, :configuration) do
     def find_thumbnail
       candidates.detect do |candidate|
         condition = candidate[:unless] || candidate[:if]

data/app/models/pageflow/url_template.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module UrlTemplate
+  module UrlTemplate # rubocop:todo Style/Documentation
     extend self
 
     def from_attachment(attachment, *style)

data/app/models/pageflow/used_file.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class UsedFile < SimpleDelegator
+  class UsedFile < SimpleDelegator # rubocop:todo Style/Documentation
     def initialize(file, usage = nil)
       super(file)
       @file = file
@@ -10,9 +10,11 @@ module Pageflow
       @usage.configuration
     end
 
+    USAGE_ATTRIBUTES = [:configuration, :display_name, :folder_perma_id].freeze
+
     def update!(attributes)
-      super(attributes.except(:configuration))
-      @usage.update!(attributes.slice(:configuration))
+      super(attributes.except(*USAGE_ATTRIBUTES))
+      @usage.update!(attributes.slice(*USAGE_ATTRIBUTES))
     end
 
     def usage_id
@@ -23,6 +25,14 @@ module Pageflow
       @usage.perma_id
     end
 
+    def display_name
+      @usage.display_name
+    end
+
+    def folder_perma_id
+      @usage.folder_perma_id
+    end
+
     def cache_key
       [@file.cache_key, @usage.cache_key].join('-')
     end

data/app/models/pageflow/user_name_query.rb

@@ -1,7 +1,7 @@
 module Pageflow
   # @api private
   class UserNameQuery < ApplicationQuery
-    class Scope < Scope
+    class Scope < Scope # rubocop:todo Style/Documentation
       def initialize(term, scope)
         @term = term
         @scope = scope
@@ -16,7 +16,7 @@ module Pageflow
       attr_reader :term, :scope
 
       def word_conditions(term)
-        term.split(' ').map { |word|
+        term.split.map { |word|
           word_condition(word)
         }.join(' AND ')
       end

data/app/models/pageflow/video_file.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class VideoFile < ApplicationRecord
+  class VideoFile < ApplicationRecord # rubocop:todo Style/Documentation
     include UploadableFile
     include MediaEncodingStateMachine
     include OutputSource
@@ -9,8 +9,8 @@ module Pageflow
     has_attached_file(:poster, Pageflow.config.paperclip_s3_default_options
                         .merge(default_url: ':pageflow_placeholder',
                                styles: Pageflow.config.thumbnail_styles
-                                 .merge(medium: ['1920x1920>', :JPG],
-                                        large: ['1024x1024>', :JPG],
+                                 .merge(medium: ['1024x1024>', :JPG],
+                                        large: ['1920x1920>', :JPG],
                                         ultra: ['3840x3840>', :JPG],
                                         print: ['300x300>', :JPG]),
                                convert_options: {
@@ -21,22 +21,21 @@ module Pageflow
                                }))
 
     has_attached_file(:thumbnail, Pageflow.config.paperclip_s3_default_options
-                        .merge(:default_url => ':pageflow_placeholder',
-                               :default_style => :thumbnail,
-                               :styles => Pageflow.config.thumbnail_styles
-                                 .merge(:medium => ['1920x1920>', :JPG],
-                                        :large => ['1024x1024>', :JPG]),
-                               :convert_options => {
-                                 :medium => "-quality 60 -interlace Plane",
-                                 :large => "-quality 60 -interlace Plane"
+                        .merge(default_url: ':pageflow_placeholder',
+                               default_style: :thumbnail,
+                               styles: Pageflow.config.thumbnail_styles
+                                  .merge(medium: ['1024x1024>', :JPG],
+                                         large: ['1920x1920>', :JPG]),
+                               convert_options: {
+                                 medium: '-quality 60 -interlace Plane',
+                                 large: '-quality 60 -interlace Plane'
                                }))
 
-
     do_not_validate_attachment_file_type(:poster)
     do_not_validate_attachment_file_type(:thumbnail)
 
-    def thumbnail_url(*args)
-      poster.url(*args)
+    def thumbnail_url(*)
+      poster.url(*)
     end
 
     def attachment_s3_url
@@ -111,6 +110,10 @@ module Pageflow
       ZencoderAttachment.new(self, 'dash/manifest.mpd')
     end
 
+    def dash_playlist_high_and_up
+      ZencoderAttachment.new(self, 'dash/manifest-high-and-up.mpd')
+    end
+
     def hls_playlist
       if Pageflow.config.zencoder_options[:hls_smil_suffix].present?
         ZencoderAttachment.new(self,
@@ -125,6 +128,10 @@ module Pageflow
       end
     end
 
+    def hls_playlist_high_and_up
+      ZencoderAttachment.new(self, 'hls-playlist-high-and-up.m3u8', host: :hls)
+    end
+
     def smil
       ZencoderAttachment.new(self, 'hls-playlist.smil')
     end
@@ -143,7 +150,7 @@ module Pageflow
 
     def externally_generated_outputs
       if Pageflow.config.zencoder_options[:hls_smil_suffix].present?
-        %w(hls-playlist)
+        %w[hls-playlist]
       else
         []
       end

data/app/models/pageflow/video_file_url_templates.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class VideoFileUrlTemplates
+  class VideoFileUrlTemplates # rubocop:todo Style/Documentation
     def call
       {
         original: url_template(:attachment, :original),
@@ -7,10 +7,12 @@ module Pageflow
         high: url_template(:mp4_high),
         medium: url_template(:mp4_medium),
         fullhd: url_template(:mp4_fullhd),
-        :'4k' => url_template(:mp4_4k),
+        '4k': url_template(:mp4_4k),
 
-        :'hls-playlist' => url_template(:hls_playlist),
-        :'dash-playlist' => url_template(:dash_playlist),
+        'hls-playlist': url_template(:hls_playlist),
+        'hls-playlist-high-and-up': url_template(:hls_playlist_high_and_up),
+        'dash-playlist': url_template(:dash_playlist),
+        'dash-playlist-high-and-up': url_template(:dash_playlist_high_and_up),
 
         poster_medium: url_template(:poster, :medium),
         poster_large: url_template(:poster, :large),

data/app/models/pageflow/widget.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class Widget < ApplicationRecord
+  class Widget < ApplicationRecord # rubocop:todo Style/Documentation
     include SerializedConfiguration
 
     belongs_to :subject, polymorphic: true, touch: true
@@ -85,7 +85,7 @@ module Pageflow
 
       def defaults_by_role
         config.widget_types.defaults_by_role.each_with_object({}) do |(role, widget_type), result|
-          result[role] = Widget.new(role: role, type_name: widget_type.name,
+          result[role] = Widget.new(role:, type_name: widget_type.name,
                                     subject: nil,
                                     configuration:
                                       config.widget_types.default_configuration(role))
@@ -94,8 +94,9 @@ module Pageflow
 
       def placeholders_by_role
         return {} unless options[:include_placeholders]
-        config.widget_types.roles.each_with_object({}) do |role, result|
-          result[role] = Widget.new(role: role, type_name: nil, subject: nil)
+
+        config.widget_types.roles.to_h do |role|
+          [role, Widget.new(role:, type_name: nil, subject: nil)]
         end
       end
 

data/app/models/pageflow/with_file_usage_extension.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module WithFileUsageExtension
+  module WithFileUsageExtension # rubocop:todo Style/Documentation
     def with_usage_id
       select("#{table_name}.*, pageflow_file_usages.id AS usage_id")
     end

data/app/models/pageflow/zencoder_attachment.rb

@@ -1,7 +1,7 @@
 require 'uri'
 
 module Pageflow
-  class ZencoderAttachment
+  class ZencoderAttachment # rubocop:todo Style/Documentation
     cattr_accessor :default_options
     self.default_options = {
       path: '/:zencoder_asset_version/:pageflow_s3_root/:class/:id_partition/:zencoder_filename',
@@ -45,20 +45,20 @@ module Pageflow
                               url_options)
     end
 
-    def url_relative_to(attachment)
-      dir_path = File.dirname(URI.parse(attachment.url).path)
+    def relative_path_to(other_path)
+      dir_path = File.dirname(path)
 
-      unless URI.parse(url).path.start_with?(dir_path)
-        raise("Could not generate relative url for #{url} based on #{attachment.url}.")
+      unless URI.parse(other_path).path.start_with?(dir_path)
+        raise("Could not generate relative path for #{other_path} based on #{url}.")
       end
 
-      url.split("#{dir_path}/", 2).last
+      other_path.split("#{dir_path}/", 2).last
     end
 
     private
 
     def ensure_default_protocol(url, url_options)
-      url =~ %r'^//' ? [url_options[:default_protocol], url].compact.join(':') : url
+      url =~ %r{^//} ? [url_options[:default_protocol], url].compact.join(':') : url
     end
 
     def url_pattern(url_options)
@@ -66,7 +66,7 @@ module Pageflow
     end
 
     def base_url(url_options)
-      case (url_options[:host] || options[:host])
+      case url_options[:host] || options[:host]
       when :hls
         options[:hls_url]
       when :hls_origin

data/app/policies/pageflow/account_policy.rb

@@ -1,5 +1,7 @@
 module Pageflow
+  # @api private
   class AccountPolicy < ApplicationPolicy
+    # @api private
     class Scope < Scope
       attr_reader :user, :scope, :query
 
@@ -111,7 +113,7 @@ module Pageflow
     end
 
     def see_badge_belonging_to?
-      (@account.entries & user.entries).any? ||
+      @account.entries.intersect?(user.entries) ||
         query.has_at_least_role?(:previewer) ||
         user.admin?
     end

data/app/policies/pageflow/admin/admin_only_tab_policy.rb

@@ -1,5 +1,6 @@
 module Pageflow
   module Admin
+    # @api private
     class AdminOnlyTabPolicy
       attr_reader :user, :tab
 

data/app/policies/pageflow/admin/entry_tab_policy.rb

@@ -1,5 +1,6 @@
 module Pageflow
   module Admin
+    # @api private
     class EntryTabPolicy
       attr_reader :user, :tab, :query
 

data/app/policies/pageflow/application_policy.rb

@@ -1,5 +1,7 @@
 module Pageflow
+  # @api private
   class ApplicationPolicy
+    # @api private
     class Scope
       protected