pageflow 17.0.5 → 17.2.0

data/app/models/pageflow/entry_title_or_account_name_query.rb

@@ -1,7 +1,7 @@
 module Pageflow
   # @api private
   class EntryTitleOrAccountNameQuery < ApplicationQuery
-    class Scope < Scope
+    class Scope < Scope # rubocop:todo Style/Documentation
       def initialize(term, scope)
         @term = term
         @scope = scope
@@ -19,7 +19,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/entry_translation_group.rb

@@ -0,0 +1,42 @@
+module Pageflow
+  # @api private
+  class EntryTranslationGroup < ApplicationRecord
+    has_many :entries,
+             -> { order(title: :asc) },
+             foreign_key: 'translation_group_id',
+             dependent: :nullify
+
+    has_many :published_entries,
+             -> { published },
+             foreign_key: 'translation_group_id',
+             class_name: 'Entry'
+
+    has_many :publicly_visible_entries,
+             -> { published_without_password_protection.published_without_noindex },
+             foreign_key: 'translation_group_id',
+             class_name: 'Entry'
+
+    has_many :entries_published_without_password_protection,
+             -> { published_without_password_protection },
+             foreign_key: 'translation_group_id',
+             class_name: 'Entry'
+
+    has_many :entries_published_without_noindex,
+             -> { published_without_noindex },
+             foreign_key: 'translation_group_id',
+             class_name: 'Entry'
+
+    belongs_to :default_translation,
+               class_name: 'Entry',
+               optional: true
+
+    def merge_into(translation_group)
+      entries.update_all(translation_group_id: translation_group.id)
+      destroy
+    end
+
+    def single_item_or_empty?
+      !entries.many?
+    end
+  end
+end

data/app/models/pageflow/file_folder.rb

@@ -0,0 +1,74 @@
+module Pageflow
+  # Groups the file usages of a revision. Folders refer to their parent
+  # folder by perma id since row ids would not survive copying a
+  # revision.
+  #
+  # @api private
+  class FileFolder < ApplicationRecord
+    include RevisionComponent
+
+    validates :name, presence: true
+    validate :parent_belongs_to_revision
+    validate :parent_is_not_nested_inside_folder
+
+    def parent
+      return if parent_folder_perma_id.blank?
+
+      folders_of_revision.find_by(perma_id: parent_folder_perma_id)
+    end
+
+    # Broken data with a folder nested inside one of its own descendants
+    # would make walking up the tree loop forever.
+    def ancestors
+      result = []
+      current = parent
+
+      while current && result.exclude?(current)
+        result.unshift(current)
+        current = current.parent
+      end
+
+      result
+    end
+
+    def children
+      folders_of_revision.where(parent_folder_perma_id: perma_id)
+    end
+
+    def file_usages
+      revision.file_usages.where(folder_perma_id: perma_id)
+    end
+
+    def empty?
+      children.none? && file_usages.none?
+    end
+
+    private
+
+    # A folder from another revision would leave this folder unreachable
+    # in any folder tree.
+    def parent_belongs_to_revision
+      return if parent_folder_perma_id.blank? || revision.blank?
+      return if folders_of_revision.exists?(perma_id: parent_folder_perma_id)
+
+      errors.add(:parent_folder_perma_id, 'unknown folder')
+    end
+
+    # Nesting a folder inside itself or inside one of its own subfolders
+    # would detach the whole subtree from the folder tree.
+    def parent_is_not_nested_inside_folder
+      return if parent_folder_perma_id.blank? || revision.blank?
+
+      parent_folder = parent
+
+      return if parent_folder.blank?
+      return if [parent_folder, *parent_folder.ancestors].exclude?(self)
+
+      errors.add(:parent_folder_perma_id, 'nested inside folder')
+    end
+
+    def folders_of_revision
+      FileFolder.all_for_revision(revision)
+    end
+  end
+end

data/app/models/pageflow/file_reuse.rb

@@ -1,16 +1,17 @@
 module Pageflow
-  class FileReuse
+  class FileReuse # rubocop:todo Style/Documentation
     attr_accessor :source_entry, :destination_entry, :file_type, :file
 
-    def initialize(destination_entry, source_entry, file_type, file_id)
+    def initialize(destination_entry, source_entry, file_type, file_id, folder_perma_id: nil)
       @source_entry = source_entry
       @destination_entry = destination_entry
       @file_type = file_type
       @file = source_entry.find_file(file_type.model, file_id)
+      @folder_perma_id = folder_perma_id
     end
 
-    def save!
-      destination_entry.use_file(file)
+    def save! # rubocop:todo Metrics/AbcSize
+      destination_entry.use_file(file, folder_perma_id: @folder_perma_id)
 
       file_type.nested_file_types.each do |nested_file_type|
         source_entry.find_files(nested_file_type.model).each do |nested_file|

data/app/models/pageflow/file_usage.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class FileUsage < ApplicationRecord
+  class FileUsage < ApplicationRecord # rubocop:todo Style/Documentation
     include SerializedConfiguration
     include RevisionComponent
 
@@ -7,8 +7,23 @@ module Pageflow
 
     belongs_to :file, polymorphic: true
 
-    def copy_to(revision)
-      revision.file_usages << dup
+    validate :display_name_extension_matches
+    validate :folder_belongs_to_revision
+
+    private
+
+    def display_name_extension_matches
+      return if display_name.blank? || file.blank?
+      return if File.extname(display_name) == File.extname(file.file_name.to_s)
+
+      errors.add(:display_name, 'extension mismatch')
+    end
+
+    def folder_belongs_to_revision
+      return if folder_perma_id.blank? || revision.blank?
+      return if FileFolder.all_for_revision(revision).exists?(perma_id: folder_perma_id)
+
+      errors.add(:folder_perma_id, 'unknown folder')
     end
   end
 end

data/app/models/pageflow/folder.rb

@@ -1,8 +1,8 @@
 module Pageflow
-  class Folder < ApplicationRecord
+  class Folder < ApplicationRecord # rubocop:todo Style/Documentation
     belongs_to :account
     has_many :entries
 
-    validates :account, :name, :presence => true
+    validates :account, :name, presence: true
   end
 end

data/app/models/pageflow/home_button.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class HomeButton
+  class HomeButton # rubocop:todo Style/Documentation
     attr_reader :revision, :site
 
     def initialize(revision, site)
@@ -28,12 +28,12 @@ module Pageflow
     private
 
     def site_home_button_url
-      if site.home_url.present?
-        options = Pageflow.config.site_url_options(site) || {}
-        Pageflow::Engine.routes.url_for(options.merge(controller: 'pageflow/entries',
-                                                      action: 'index',
-                                                      only_path: !options[:host]))
-      end
+      return unless site.home_url.present?
+
+      options = Pageflow.config.site_url_options_for(site) || {}
+      Pageflow::Engine.routes.url_for(options.merge(controller: 'pageflow/entries',
+                                                    action: 'index',
+                                                    only_path: !options[:host]))
     end
   end
 end

data/app/models/pageflow/image_file.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class ImageFile < ApplicationRecord
+  class ImageFile < ApplicationRecord # rubocop:todo Style/Documentation
     include UploadableFile
     include ImageAndTextTrackProcessingStateMachine
     include OutputSource
@@ -14,11 +14,12 @@ module Pageflow
 
     before_attachment_on_s3_post_process :save_image_dimensions
 
-    def thumbnail_url(*args)
+    def thumbnail_url(*)
       unless ready?
-        return Pageflow::PaperclipInterpolations::Support.pageflow_placeholder(attachment, *args)
+        return Pageflow::PaperclipInterpolations::Support.pageflow_placeholder(attachment, *)
       end
-      attachment.url(*args)
+
+      attachment.url(*)
     end
 
     def original_url
@@ -39,26 +40,31 @@ module Pageflow
 
       Pageflow
         .config.thumbnail_styles.transform_values { |options| options.merge(style_defaults) }
-        .merge(
-          print: {geometry: '300x300>',
-                  **style_defaults,
-                  convert_options: '-quality 10 -interlace Plane'},
-          medium: {geometry: '1024x1024>',
-                   **style_defaults,
-                   convert_options: '-quality 70 -interlace Plane'},
-          large: {geometry: '1920x1920>',
-                  **style_defaults,
-                  convert_options: '-quality 70 -interlace Plane'},
-          ultra: {geometry: '3840x3840>',
-                  **style_defaults,
-                  convert_options: '-quality 90 -interlace Plane'},
-          panorama_medium: {geometry: ImageFile.scale_down_to_cover(1024, 1024),
-                            format: panorama_format,
-                            convert_options: '-quality 90 -interlace Plane'},
-          panorama_large: {geometry: ImageFile.scale_down_to_cover(1920, 1080),
-                           format: panorama_format,
-                           convert_options: '-quality 90 -interlace Plane'}
-        )
+                                .merge(
+                                  print: {geometry: '300x300>',
+                                          **style_defaults,
+                                          convert_options: '-quality 10 -interlace Plane'},
+                                  medium: {geometry: '1024x1024>',
+                                           **style_defaults,
+                                           convert_options: '-quality 70 -interlace Plane'},
+                                  large: {geometry: '1920x1920>',
+                                          **style_defaults,
+                                          convert_options: '-quality 70 -interlace Plane'},
+                                  ultra: {geometry: '3840x3840>',
+                                          **style_defaults,
+                                          convert_options: '-quality 90 -interlace Plane'},
+                                  panorama_medium: {
+                                    geometry: ImageFile.scale_down_to_cover(1024, 1024),
+                                    format: panorama_format,
+                                    convert_options: '-quality 90 -interlace Plane'
+                                  },
+                                  panorama_large: {
+                                    geometry: ImageFile.scale_down_to_cover(1920, 1080),
+                                    format: panorama_format,
+                                    convert_options: '-quality 90 -interlace Plane'
+                                  }
+                                )
+        .merge(social_image_styles)
     end
 
     def url
@@ -81,9 +87,22 @@ module Pageflow
 
     def save_image_dimensions
       geo = Paperclip::Geometry.from_file(attachment.queued_for_write[:original])
+      geo.auto_orient
+
       self.width = geo.width
       self.height = geo.height
     rescue Paperclip::Errors::NotIdentifiedByImageMagickError
+      # Ignore files that can't be processed by ImageMagick
+    end
+
+    def social_image_styles
+      if output_present?(:social)
+        {social: {geometry: '1024x1024>',
+                  format: :jpg,
+                  convert_options: '-quality 70 -interlace Plane'}}
+      else
+        {}
+      end
     end
 
     def style_defaults
@@ -95,7 +114,7 @@ module Pageflow
     end
 
     def set_output_presences
-      self.output_presences = {webp: true} if entry&.feature_state('webp_images')
+      self.output_presences = {webp: true, social: true} if entry&.feature_state('webp_images')
     end
   end
 end

data/app/models/pageflow/image_file_url_templates.rb

@@ -1,10 +1,10 @@
 module Pageflow
-  class ImageFileUrlTemplates
+  class ImageFileUrlTemplates # rubocop:todo Style/Documentation
     def call
-      styles.each_with_object({}) do |style, result|
-        result[style] = replace_extension_with_placeholder(
+      styles.to_h do |style|
+        [style, replace_extension_with_placeholder(
           UrlTemplate.from_attachment(example_file.attachment, style)
-        )
+        )]
       end
     end
 

data/app/models/pageflow/invitation_form.rb

@@ -22,6 +22,7 @@ module Pageflow
 
     def save
       return false unless valid?
+
       Pageflow.config.quotas.get(:users, initial_account).verify_available!
 
       membership.save!
@@ -33,7 +34,7 @@ module Pageflow
 
     def existing_member
       @existing_member ||=
-        initial_account && initial_account.users.find_by_email(user.email)
+        initial_account&.users&.find_by_email(user.email)
     end
 
     def initial_account

data/app/models/pageflow/legal_info.rb

@@ -0,0 +1,38 @@
+module Pageflow
+  # Legal info of a site, resolved for a single locale. Each attribute
+  # falls back to the value stored in the site's column when there is
+  # no translation for the locale.
+  #
+  # @since 17.2
+  class LegalInfo
+    Link = Struct.new(:label, :url, keyword_init: true)
+
+    def initialize(site, locale)
+      @site = site
+      @locale = locale
+    end
+
+    def imprint
+      @imprint ||= link('imprint')
+    end
+
+    def copyright
+      @copyright ||= link('copyright')
+    end
+
+    def privacy_url
+      translated(:privacy_link_url)
+    end
+
+    private
+
+    def link(kind)
+      Link.new(label: translated("#{kind}_link_label"),
+               url: translated("#{kind}_link_url"))
+    end
+
+    def translated(attribute)
+      @site.translated(attribute, locale: @locale)
+    end
+  end
+end

data/app/models/pageflow/managed_user_query.rb

@@ -1,7 +1,7 @@
 module Pageflow
   # @api private
   class ManagedUserQuery < ApplicationQuery
-    class Scope < Scope
+    class Scope < Scope # rubocop:todo Style/Documentation
       def initialize(current_user, scope)
         @current_user = current_user
         @scope = scope

data/app/models/pageflow/membership.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class Membership < ApplicationRecord
+  class Membership < ApplicationRecord # rubocop:todo Style/Documentation
     belongs_to :user
     belongs_to :entity, polymorphic: true
     belongs_to :entry,
@@ -15,17 +15,17 @@ module Pageflow
     validates :user_id, uniqueness: {scope: [:entity_type, :entity_id]}
     validate :account_membership_exists, if: :on_entry?
     validates :role,
-              inclusion: {in: %w(previewer editor publisher manager)},
+              inclusion: {in: %w[previewer editor publisher manager]},
               if: :on_entry?
     validates :role,
-              inclusion: {in: %w(member previewer editor publisher manager)},
+              inclusion: {in: %w[member previewer editor publisher manager]},
               if: :on_account?
 
     scope :on_entries, -> { where(entity_type: 'Pageflow::Entry') }
     scope :on_accounts, -> { where(entity_type: 'Pageflow::Account') }
     scope :as_manager, -> { where(role: :manager) }
-    scope :as_publisher_or_above, -> { where(role: %w(publisher manager)) }
-    scope :as_previewer_or_above, -> { where(role: %w(previewer editor publisher manager)) }
+    scope :as_publisher_or_above, -> { where(role: %w[publisher manager]) }
+    scope :as_previewer_or_above, -> { where(role: %w[previewer editor publisher manager]) }
 
     after_create do
       entity.increment!(:users_count)