pageflow 17.0.5 → 17.1.0

data/app/models/pageflow/edit_lock.rb

@@ -1,17 +1,17 @@
 module Pageflow
-  class EditLock < ApplicationRecord
+  class EditLock < ApplicationRecord # rubocop:todo Style/Documentation
     scope :active, (lambda do
       time = Time.now - EditLock.time_to_live
       where('pageflow_edit_locks.updated_at >= ?', time)
     end)
 
-    class Error < RuntimeError
+    class Error < RuntimeError # rubocop:todo Style/Documentation
       def code
         self.class.name.split('::').last.underscore
       end
     end
 
-    class HeldByOtherUserError < Error
+    class HeldByOtherUserError < Error # rubocop:todo Style/Documentation
       attr_reader :user
 
       def initialize(user)
@@ -23,7 +23,7 @@ module Pageflow
     class NotHeldError < Error; end
 
     belongs_to :user
-    belongs_to :entry, :inverse_of => :edit_lock
+    belongs_to :entry, inverse_of: :edit_lock
 
     def self.time_to_live
       timer_tolerance = 2.3
@@ -45,33 +45,32 @@ module Pageflow
     def acquire(current_user, options = {})
       verify!(current_user, options)
     rescue Error
-      if options[:force] || timed_out?
-        entry.create_edit_lock(:user => current_user)
-      else
-        raise
-      end
+      raise unless options[:force] || timed_out?
+
+      entry.create_edit_lock(user: current_user)
     end
 
     def release(current_user)
-      if user == current_user
-        destroy
-      end
+      return unless user == current_user
+
+      destroy
     end
 
     def verify!(current_user, options)
-      raise HeldByOtherUserError.new(user) unless held_by?(current_user)
+      raise HeldByOtherUserError, user unless held_by?(current_user)
       raise HeldByOtherSessionError unless matches?(options[:id])
+
       touch
     end
 
-    class Null
+    class Null # rubocop:todo Style/Documentation
       attr_reader :entry
 
       def initialize(entry)
         @entry = entry
       end
 
-      def held_by?(user)
+      def held_by?(_user)
         false
       end
 
@@ -79,15 +78,14 @@ module Pageflow
         true
       end
 
-      def acquire(user, options = {})
-        entry.create_edit_lock!(:user => user)
+      def acquire(user, _options = {})
+        entry.create_edit_lock!(user:)
       end
 
-      def release(user)
-      end
+      def release(user); end
 
-      def verify!(user, options = {})
-        raise NotHeldError.new
+      def verify!(_user, _options = {})
+        raise NotHeldError
       end
     end
   end

data/app/models/pageflow/encoding_confirmation.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class EncodingConfirmation
+  class EncodingConfirmation # rubocop:todo Style/Documentation
     class QuotaExceededError < RuntimeError
     end
 
@@ -29,7 +29,7 @@ module Pageflow
     end
 
     def assumed_quota
-      @assumed_quota ||= encoding_quota.assume(files: files)
+      @assumed_quota ||= encoding_quota.assume(files:)
     end
 
     def files

data/app/models/pageflow/entries_feed.rb

@@ -1,6 +1,6 @@
 module Pageflow
   # @api private
-  EntriesFeed = Struct.new(:title, :locale, :custom_url, :root_url, :entries) do
+  EntriesFeed = Struct.new(:title, :locale, :custom_url, :root_url, :entries) do # rubocop:disable Lint/StructNewOverride
     def updated_at
       entries.map(&:published_at).max
     end
@@ -23,7 +23,7 @@ module Pageflow
           site
             .entries
             .published_without_password_protection
-            .where(pageflow_revisions: {locale: locale})
+            .where(pageflow_revisions: {locale:})
             .order('first_published_at DESC')
         )
       end

data/app/models/pageflow/entry.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class Entry < ApplicationRecord
+  class Entry < ApplicationRecord # rubocop:todo Style/Documentation
     class PasswordMissingError < StandardError
     end
 
@@ -7,9 +7,11 @@ module Pageflow
     include EntryPublicationStates
     include Permalinkable
     include SerializationBlacklist
+    include Translatable
 
     extend FriendlyId
-    friendly_id :slug_candidates, :use => [:finders, :slugged]
+
+    friendly_id :slug_candidates, use: [:finders, :slugged]
 
     belongs_to :account, counter_cache: true
     belongs_to :folder, optional: true
@@ -17,11 +19,13 @@ module Pageflow
 
     has_many :revisions, -> { order('frozen_at DESC') }
 
-    has_many :chapters, -> { order('pageflow_chapters.position ASC') }, :through => :revisions
-    has_many :pages, -> { order('pageflow_chapters.position ASC, pageflow_pages.position ASC') }, :through => :chapters
+    has_many :chapters, -> { order('pageflow_chapters.position ASC') }, through: :revisions
+    has_many :pages, lambda {
+                       order('pageflow_chapters.position ASC, pageflow_pages.position ASC')
+                     }, through: :chapters
 
     has_many :memberships, as: :entity, dependent: :destroy
-    has_many :users, :through => :memberships, :class_name => '::User'
+    has_many :users, through: :memberships, class_name: '::User'
 
     has_many :image_files
     has_many :video_files
@@ -32,11 +36,11 @@ module Pageflow
     has_one :draft, -> { editable }, class_name: 'Revision', inverse_of: :entry
     has_one :published_revision, -> { published }, class_name: 'Revision', inverse_of: :entry
 
-    has_one :edit_lock, :dependent => :destroy
+    has_one :edit_lock, dependent: :destroy
 
     has_secure_password validations: false
 
-    validates :account, :site, :presence => true
+    validates :account, :site, presence: true
     validates :title, presence: true
     validate :entry_type_is_available_for_account
     validate :folder_belongs_to_same_account
@@ -52,7 +56,7 @@ module Pageflow
 
     after_create unless: :skip_draft_creation do
       create_draft!
-      draft.storylines.create!(configuration: {main: true})
+      create_default_revision_components
       entry_template.copy_defaults_to(draft)
     end
 
@@ -74,8 +78,8 @@ module Pageflow
       account.feature_state(name)
     end
 
-    def publish(options = {})
-      ActiveRecord::Base.transaction do
+    def publish(options = {}) # rubocop:todo Metrics/AbcSize
+      transaction do
         self.first_published_at ||= Time.now
         update_password!(options.slice(:password, :password_protected))
 
@@ -94,25 +98,30 @@ module Pageflow
     end
 
     def snapshot(options)
-      draft.copy do |revision|
-        revision.creator = options[:creator]
-        revision.frozen_at = Time.now
-        revision.snapshot_type = options.fetch(:type, 'auto')
+      transaction do
+        draft.copy do |revision|
+          revision.creator = options[:creator]
+          revision.frozen_at = Time.now
+          revision.snapshot_type = options.fetch(:type, 'auto')
+        end
       end
     end
 
     def restore(options)
-      restored_revision = options.fetch(:revision)
-      draft.update!(:frozen_at => Time.now, :creator => options[:creator], :snapshot_type => 'before_restore')
-
-      restored_revision.copy do |revision|
-        revision.restored_from = restored_revision
-        revision.frozen_at = nil
-        revision.snapshot_type = nil
-        revision.published_at = nil
-        revision.published_until = nil
-        revision.password_protected = nil
-        revision.noindex = nil
+      transaction do
+        restored_revision = options.fetch(:revision)
+        draft.update!(frozen_at: Time.now, creator: options[:creator],
+                      snapshot_type: 'before_restore')
+
+        restored_revision.copy do |revision|
+          revision.restored_from = restored_revision
+          revision.frozen_at = nil
+          revision.snapshot_type = nil
+          revision.published_at = nil
+          revision.published_until = nil
+          revision.password_protected = nil
+          revision.noindex = nil
+        end
       end
     end
 
@@ -151,19 +160,24 @@ module Pageflow
     private
 
     def folder_belongs_to_same_account
-      errors.add(:folder, :must_be_same_account) if folder.present? && folder.account_id != account_id
+      return unless folder.present? && folder.account_id != account_id
+
+      errors.add(:folder,
+                 :must_be_same_account)
     end
 
     def entry_type_is_available_for_account
       return if Pageflow.config_for(account).entry_types.map(&:name).include?(type_name)
 
-      errors.add(:type_name, :must_be_available_for_account, type_name: type_name)
+      errors.add(:type_name, :must_be_available_for_account, type_name:)
+    end
+
+    def create_default_revision_components
+      Pageflow.config_for(self).revision_components.create_defaults(draft)
     end
 
     def update_password!(options)
-      if options[:password].present?
-        self.password = options[:password]
-      end
+      self.password = options[:password] if options[:password].present?
 
       if options[:password_protected]
         raise PasswordMissingError if password_digest.blank?

data/app/models/pageflow/entry_at_revision.rb

@@ -45,7 +45,7 @@ module Pageflow
     end
 
     def theme
-      @theme ||= CustomizedTheme.find(entry: entry, theme: revision.theme)
+      @theme ||= CustomizedTheme.find(entry: self, theme: revision.theme)
     end
 
     def home_button
@@ -67,5 +67,9 @@ module Pageflow
     def emphasize_new_pages
       revision.configuration['emphasize_new_pages']
     end
+
+    def self.wrap_all_drafts(entries)
+      entries.includes(:draft).map { |entry| new(entry, entry.draft) }
+    end
   end
 end

data/app/models/pageflow/entry_duplicate.rb

@@ -1,11 +1,13 @@
 module Pageflow
-  class EntryDuplicate < Struct.new(:original_entry)
+  EntryDuplicate = Struct.new(:original_entry) do
     def create!
-      create_entry
+      ActiveRecord::Base.transaction do
+        create_entry
 
-      copy_permalink
-      copy_draft
-      copy_memberships
+        copy_permalink
+        copy_draft
+        copy_memberships
+      end
 
       new_entry
     end
@@ -47,6 +49,7 @@ module Pageflow
         account: original_entry.account,
         site: original_entry.site,
         features_configuration: original_entry.features_configuration,
+        perma_id_counter: original_entry.perma_id_counter,
 
         skip_draft_creation: true
       }

data/app/models/pageflow/entry_publication.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class EntryPublication
+  class EntryPublication # rubocop:todo Style/Documentation
     attr_reader :entry, :attributes, :quota, :user
 
     def initialize(entry, attributes, published_entries_quota, user)
@@ -17,7 +17,7 @@ module Pageflow
       assumed_quota.verify_not_exceeded!
       entry.publish(attributes.merge(creator: user))
 
-      Pageflow.config.hooks.invoke(:entry_published, entry: entry)
+      Pageflow.config.hooks.invoke(:entry_published, entry:)
     end
 
     private

data/app/models/pageflow/entry_role_query.rb

@@ -1,6 +1,6 @@
 module Pageflow
-  class EntryRoleQuery < ApplicationQuery
-    class Scope < Scope
+  class EntryRoleQuery < ApplicationQuery # rubocop:todo Style/Documentation
+    class Scope < Scope # rubocop:todo Style/Documentation
       attr_reader :user, :scope
 
       def initialize(user, scope, table_alias_prefix: nil)
@@ -68,14 +68,14 @@ module Pageflow
       def entry_account_membership_has_at_least_role(role)
         membership_has_at_least_role(
           table_alias: table_alias_for('entry_account'),
-          role: role
+          role:
         )
       end
 
       def entry_membership_has_at_least_role(role)
         membership_has_at_least_role(
           table_alias: table_alias_for('entry'),
-          role: role
+          role:
         )
       end
 

data/app/models/pageflow/entry_template.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class EntryTemplate < ApplicationRecord
+  class EntryTemplate < ApplicationRecord # rubocop:todo Style/Documentation
     include ThemeReferencer
     include SerializedConfiguration
 
@@ -55,8 +55,8 @@ module Pageflow
         publisher: default_publisher.presence || Pageflow.config.default_publisher_meta_tag,
         keywords: default_keywords.presence || Pageflow.config.default_keywords_meta_tag,
         share_providers: default_share_providers,
-        theme_name: theme_name,
-        configuration: configuration,
+        theme_name:,
+        configuration:,
         locale: default_locale
       )
     end
@@ -66,7 +66,7 @@ module Pageflow
     end
 
     def hashify_provider_array(arr)
-      Hash[arr.reject(&:blank?).map { |v| [v.to_s, true] }]
+      arr.reject(&:blank?).to_h { |v| [v.to_s, true] }
     end
   end
 end

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_reuse.rb

@@ -1,5 +1,5 @@
 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)
@@ -9,7 +9,7 @@ module Pageflow
       @file = source_entry.find_file(file_type.model, file_id)
     end
 
-    def save!
+    def save! # rubocop:todo Metrics/AbcSize
       destination_entry.use_file(file)
 
       file_type.nested_file_types.each do |nested_file_type|

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,15 @@ module Pageflow
 
     belongs_to :file, polymorphic: true
 
-    def copy_to(revision)
-      revision.file_usages << dup
+    validate :display_name_extension_matches
+
+    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
   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
@@ -59,6 +60,7 @@ module Pageflow
                            format: panorama_format,
                            convert_options: '-quality 90 -interlace Plane'}
         )
+        .merge(social_image_styles)
     end
 
     def url
@@ -81,9 +83,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 +110,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,5 +1,5 @@
 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(

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/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)