pageflow 17.0.5 → 17.1.0

data/app/models/concerns/pageflow/feature_target.rb

@@ -5,7 +5,7 @@ module Pageflow
       true => 'enabled',
       false => 'disabled',
       nil => 'default'
-    }
+    }.freeze
 
     extend ActiveSupport::Concern
 
@@ -21,7 +21,7 @@ module Pageflow
 
     def feature_state(name)
       state = own_feature_state(name)
-      state == nil ? inherited_feature_state(name) : state
+      state.nil? ? inherited_feature_state(name) : state
     end
 
     def own_feature_state(name)
@@ -32,6 +32,8 @@ module Pageflow
       Pageflow.config.features.enabled_by_default?(name)
     end
 
+    # rubocop:todo Metrics/PerceivedComplexity
+    # rubocop:todo Metrics/CyclomaticComplexity
     def feature_states=(states)
       boolean_states = states.each_with_object({}) do |(key, value), result|
         if value == true || value == STATE_MAPPING[true]
@@ -44,9 +46,11 @@ module Pageflow
       end
 
       self.features_configuration = features_configuration
-        .merge(boolean_states)
-        .reject { |_, value| value.nil? }
+                                    .merge(boolean_states)
+                                    .compact
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
 
     def features_configuration
       self[:features_configuration] || {}

data/app/models/concerns/pageflow/output_source.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module OutputSource
+  module OutputSource # rubocop:todo Style/Documentation
     STATE_MAPPING = {
       true => 'finished',
       false => 'skipped'
@@ -36,7 +36,7 @@ module Pageflow
 
       self[:output_presences] = output_presences
                                 .merge(boolean_presences)
-                                .reject { |_key, value| value.nil? }
+                                .compact
     end
 
     def output_presences
@@ -55,7 +55,7 @@ module Pageflow
         [label.to_s, true]
       end
 
-      Hash[pairs]
+      pairs.to_h
     end
   end
 end

data/app/models/concerns/pageflow/permalinkable.rb

@@ -4,7 +4,8 @@ module Pageflow
     extend ActiveSupport::Concern
 
     included do
-      belongs_to :permalink, optional: true
+      belongs_to :permalink, optional: true, dependent: :destroy
+      has_many :permalink_redirects, dependent: :destroy
 
       accepts_nested_attributes_for :permalink, update_only: true
     end

data/app/models/concerns/pageflow/reusable_file.rb

@@ -1,21 +1,22 @@
 module Pageflow
-  module ReusableFile
+  module ReusableFile # rubocop:todo Style/Documentation
     extend ActiveSupport::Concern
 
     included do
       belongs_to :uploader, class_name: 'User', optional: true
       belongs_to :entry, optional: true
-      belongs_to :parent_file, polymorphic: true, foreign_type: :parent_file_model_type, optional: true
+      belongs_to :parent_file, polymorphic: true, foreign_type: :parent_file_model_type,
+                               optional: true
 
-      has_many :usages, :as => :file, :class_name => 'Pageflow::FileUsage', :dependent => :destroy
+      has_many :usages, as: :file, class_name: 'Pageflow::FileUsage', dependent: :destroy
       has_one  :import,
                as: :file,
                class_name: 'Pageflow::FileImport',
                required: false,
                dependent: :destroy
-      has_many :using_revisions, :through => :usages, :source => :revision
-      has_many :using_entries, :through => :using_revisions, :source => :entry
-      has_many :using_accounts, :through => :using_entries, :source => :account
+      has_many :using_revisions, through: :usages, source: :revision
+      has_many :using_entries, through: :using_revisions, source: :entry
+      has_many :using_accounts, through: :using_entries, source: :account
 
       validate :parent_allows_type_for_nesting, :parent_belongs_to_same_entry
 
@@ -25,30 +26,29 @@ module Pageflow
     end
 
     def parent_allows_type_for_nesting
-      if parent_file.present?
-        parent_class = parent_file.class
-        file_type_of_parent = Pageflow.config.file_types.find_by_model!(parent_class)
-        models_of_nested_file_types = file_type_of_parent.nested_file_types.map(&:model)
-        unless models_of_nested_file_types.include?(self.class)
-          errors.add(:base, 'File type of provided parent file does not permit nesting files of '\
-                            "type #{self.class.name}")
-        end
-      end
+      return unless parent_file.present?
+
+      parent_class = parent_file.class
+      file_type_of_parent = Pageflow.config.file_types.find_by_model!(parent_class)
+      models_of_nested_file_types = file_type_of_parent.nested_file_types.map(&:model)
+      return if models_of_nested_file_types.include?(self.class)
+
+      errors.add(:base, 'File type of provided parent file does not permit nesting files of ' \
+                        "type #{self.class.name}")
     end
 
     def parent_belongs_to_same_entry
-      if parent_file.present?
-        unless parent_file.using_entries.include?(entry)
-          errors.add(:base, 'Parent file does not belong to same entry as nested file')
-        end
-      end
+      return unless parent_file.present?
+      return if parent_file.using_entries.include?(entry)
+
+      errors.add(:base, 'Parent file does not belong to same entry as nested file')
     end
 
     def nested_files(model)
       model_table_name = model.table_name
       model
         .select("#{model_table_name}.*")
-        .where("#{model_table_name}.parent_file_id = #{id} AND "\
+        .where("#{model_table_name}.parent_file_id = #{id} AND " \
                "#{model_table_name}.parent_file_model_type = '#{self.class.name}'")
     end
 
@@ -65,7 +65,6 @@ module Pageflow
       "#{super}-#{state}"
     end
 
-
     # The following are method defaults for file types that do not require processing/encoding.
     # They are overwritten with default values in UploadableFile for files that are uploaded
     # through the editor.
@@ -131,7 +130,8 @@ module Pageflow
       raise 'Not implemented!'
     end
 
-    # Gets called to trigger the `file_uploaded` event in the upload state machine of UploadableFile.
+    # Gets called to trigger the `file_uploaded` event in the upload state
+    # machine of UploadableFile.
     # Files that are not uploaded through the editor (and therefore not using the
     # upload state machine of UploadableFile) can overwrite this method to trigger whatever
     # the file does (i.e. processing/transcoding), depending on the including class'

data/app/models/concerns/pageflow/serialization_blacklist.rb

@@ -7,7 +7,7 @@ module Pageflow
       options[:except] = Array(options[:except])
       options[:except].concat(blacklist_for_serialization)
 
-      super(options)
+      super
     end
 
     private

data/app/models/concerns/pageflow/suspendable.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module Suspendable
+  module Suspendable # rubocop:todo Style/Documentation
     def active_for_authentication?
       super && !suspended?
     end
@@ -10,14 +10,16 @@ module Pageflow
 
     def suspend!
       return if suspended?
+
       self.suspended_at = Time.zone.now
-      save(:validate => false)
+      save(validate: false)
     end
 
     def unsuspend!
       return unless suspended?
+
       self.suspended_at = nil
-      save(:validate => false)
+      save(validate: false)
     end
   end
 end

data/app/models/concerns/pageflow/theme_referencer.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module ThemeReferencer
+  module ThemeReferencer # rubocop:todo Style/Documentation
     extend ActiveSupport::Concern
 
     included do

data/app/models/concerns/pageflow/translatable.rb

@@ -0,0 +1,62 @@
+module Pageflow
+  # @api private
+  module Translatable
+    extend ActiveSupport::Concern
+
+    included do
+      belongs_to(:translation_group,
+                 optional: true,
+                 class_name: 'EntryTranslationGroup')
+
+      has_many(:translations,
+               through: :translation_group,
+               source: :entries)
+
+      after_destroy do
+        if translation_group&.single_item_or_empty?
+          translation_group.destroy
+        elsif default_translation?
+          translation_group.update(default_translation: nil)
+        end
+      end
+    end
+
+    def mark_as_translation_of(entry)
+      transaction do
+        ensure_translation_group(entry)
+
+        if !entry.translation_group
+          entry.update!(translation_group:)
+        elsif entry.translation_group != translation_group
+          entry.translation_group.merge_into(translation_group)
+        end
+      end
+    end
+
+    def remove_from_translation_group
+      if translation_group.entries.count <= 2
+        translation_group.destroy
+      else
+        translation_group.update(default_translation: nil) if default_translation?
+        update!(translation_group: nil)
+      end
+    end
+
+    def mark_as_default_translation
+      translation_group.update!(default_translation: self)
+    end
+
+    def default_translation?
+      translation_group&.default_translation == self
+    end
+
+    private
+
+    def ensure_translation_group(other_entry)
+      return if translation_group
+
+      update!(translation_group: other_entry.translation_group ||
+              build_translation_group(default_translation: self))
+    end
+  end
+end

data/app/models/concerns/pageflow/uploadable_file.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module UploadableFile
+  module UploadableFile # rubocop:todo Style/Documentation
     extend ActiveSupport::Concern
     include ReusableFile
 
@@ -20,7 +20,7 @@ module Pageflow
                           ))
 
       validates_attachment_presence :attachment_on_s3
-      validates_attachment_file_name :attachment_on_s3, matches: %r{^[^\/\\]+\.[\w]{3,4}$}
+      validates_attachment_file_name :attachment_on_s3, matches: %r{^[^/\\]+\.\w{3,4}$}
       do_not_validate_attachment_file_type :attachment_on_s3
 
       state_machine initial: 'uploading' do
@@ -76,9 +76,9 @@ module Pageflow
     end
 
     def url
-      if attachment.present?
-        attachment.url
-      end
+      return unless attachment.present?
+
+      attachment.url
     end
 
     def basename
@@ -109,7 +109,7 @@ module Pageflow
       file_uploaded!
     end
 
-    module ClassMethods
+    module ClassMethods # rubocop:todo Style/Documentation
       def processing_state_machine(&block)
         state_machine do
           extend StateMachineJob::Macro

data/app/models/pageflow/account.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class Account < ApplicationRecord
+  class Account < ApplicationRecord # rubocop:todo Style/Documentation
     include FeatureTarget
     include SerializationBlacklist
 
@@ -10,17 +10,18 @@ module Pageflow
     has_many :entry_memberships, through: :entries, source: :memberships
 
     has_many :sites, dependent: :destroy
-    belongs_to :default_site, :class_name => 'Site'
+    belongs_to :default_site, class_name: 'Site'
 
-    validates :default_site, :presence => true
+    validates :default_site, presence: true
 
-    accepts_nested_attributes_for :default_site, :update_only => true
+    accepts_nested_attributes_for :default_site, update_only: true
 
-    scope :with_landing_page, -> { where.not(:landing_page_name => '') }
+    scope :with_landing_page, -> { where.not(landing_page_name: '') }
 
     def build_default_site(*args)
       super.tap do |site|
         site.account = self
+        site.build_root_permalink_directory
       end
     end
 

data/app/models/pageflow/account_member_query.rb

@@ -1,7 +1,7 @@
 module Pageflow
   # Query accounts for members, e.g. based on role
   class AccountMemberQuery < ApplicationQuery
-    class Scope < ApplicationQuery::Scope
+    class Scope < ApplicationQuery::Scope # rubocop:todo Style/Documentation
       # Account whose members we scope
       # @return [Pageflow::Account]
       attr_reader :account

data/app/models/pageflow/account_role_query.rb

@@ -59,7 +59,7 @@ module Pageflow
       @user
         .memberships
         .where(role: Roles.at_least(role))
-        .where('(entity_id = :account_id AND '\
+        .where('(entity_id = :account_id AND ' \
                "entity_type = 'Pageflow::Account')",
                account_id: @account.id)
         .any?

data/app/models/pageflow/application_query.rb

@@ -1,7 +1,7 @@
 module Pageflow
   # Abstraction layer for Pageflow's query interface
   class ApplicationQuery
-    class Scope
+    class Scope # rubocop:todo Style/Documentation
       protected
 
       # @api private

data/app/models/pageflow/application_record.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class ApplicationRecord < ActiveRecord::Base
+  class ApplicationRecord < ActiveRecord::Base # rubocop:todo Style/Documentation
     self.abstract_class = true
   end
 end

data/app/models/pageflow/audio_file.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class AudioFile < ApplicationRecord
+  class AudioFile < ApplicationRecord # rubocop:todo Style/Documentation
     include UploadableFile
     include MediaEncodingStateMachine
 
@@ -21,15 +21,15 @@ module Pageflow
     end
 
     def m4a
-      ZencoderAttachment.new(self, "audio.m4a")
+      ZencoderAttachment.new(self, 'audio.m4a')
     end
 
     def mp3
-      ZencoderAttachment.new(self, "audio.mp3")
+      ZencoderAttachment.new(self, 'audio.mp3')
     end
 
     def ogg
-      ZencoderAttachment.new(self, "audio.ogg")
+      ZencoderAttachment.new(self, 'audio.ogg')
     end
 
     def output_definition

data/app/models/pageflow/audio_file_url_templates.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class AudioFileUrlTemplates
+  class AudioFileUrlTemplates # rubocop:todo Style/Documentation
     def call
       {
         original: url_template(:attachment, :original),

data/app/models/pageflow/authentication_token.rb

@@ -4,7 +4,7 @@ module Pageflow
   # AuthenticationToken stores the tokens with expiry time against user and provider
   class AuthenticationToken < ApplicationRecord
     belongs_to :user, class_name: 'User'
-    default_scope -> { where(['expiry_time > :expiry', expiry: Time.zone.now]) }
+    default_scope -> { where(['expiry_time > :expiry', {expiry: Time.zone.now}]) }
 
     def auth_token
       SymmetricEncryption.decrypt(read_attribute(:auth_token))
@@ -31,7 +31,7 @@ module Pageflow
 
     def self.find_auth_token(current_user, provider)
       where(user_id: current_user.id,
-            provider: provider)
+            provider:)
     end
   end
 end

data/app/models/pageflow/chapter.rb

@@ -1,7 +1,8 @@
 module Pageflow
-  class Chapter < ApplicationRecord
+  class Chapter < ApplicationRecord # rubocop:todo Style/Documentation
     include SerializedConfiguration
     include NestedRevisionComponent
+    include AutoGeneratedPermaId
 
     belongs_to :storyline, touch: true
     has_many :pages, -> { order('position ASC') }, dependent: :destroy, inverse_of: :chapter
@@ -15,5 +16,9 @@ module Pageflow
     def pages
       super.tap { |p| p.first.is_first = true if is_first && p.present? }
     end
+
+    def entry_for_auto_generated_perma_id
+      storyline.revision.entry
+    end
   end
 end

data/app/models/pageflow/chapter_scaffold.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class ChapterScaffold
+  class ChapterScaffold # rubocop:todo Style/Documentation
     def initialize(chapter, options)
       @chapter = chapter
       @options = options
@@ -8,9 +8,7 @@ module Pageflow
     delegate :save!, to: :@chapter
 
     def build
-      if @options[:depth] == 'page'
-        @page = @chapter.pages.build(template: 'background_image')
-      end
+      @page = @chapter.pages.build(template: 'background_image') if @options[:depth] == 'page'
 
       self
     end

data/app/models/pageflow/cname_site_request_scope.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class CnameSiteRequestScope
+  class CnameSiteRequestScope # rubocop:todo Style/Documentation
     def call(sites, request)
       sites.where(<<-SQL, host: request.host)
         cname = :host OR

data/app/models/pageflow/customized_theme.rb

@@ -11,8 +11,8 @@ module Pageflow
 
     def self.find(entry:, theme:)
       build(
-        entry: entry,
-        theme: theme,
+        entry:,
+        theme:,
         theme_customization: Pageflow.theme_customizations.get(
           site: entry.site,
           entry_type_name: entry.type_name
@@ -26,13 +26,13 @@ module Pageflow
       new(theme,
           config.transform_theme_customization_overrides.call(
             theme_customization.overrides,
-            entry: entry,
-            theme: theme
+            entry:,
+            theme:
           ),
           config.transform_theme_customization_files.call(
             theme_customization.selected_files.transform_values(&:urls),
-            entry: entry,
-            theme: theme
+            entry:,
+            theme:
           ))
     end
   end

data/app/models/pageflow/draft_entry.rb

@@ -1,3 +1,5 @@
+require 'securerandom'
+
 module Pageflow
   # A merged view of an entry and its draft revision
   class DraftEntry < EntryAtRevision
@@ -14,20 +16,35 @@ module Pageflow
       entry.title
     end
 
+    def translations(scope = -> { self }, **)
+      return [] unless entry.translation_group
+
+      PublishedEntry.wrap_all_drafts(
+        entry.translation_group.entries.instance_exec(&scope)
+      )
+    end
+
+    def cutoff_mode_enabled_for?(_request)
+      false
+    end
+
     def create_file!(file_type, attributes)
       check_foreign_key_custom_attributes(file_type.custom_attributes, attributes)
 
-      file = file_type.model.create!(attributes.except(:configuration)) do |f|
-        f.entry = entry
-      end
+      file = file_type.model.create!(
+        attributes
+          .except(:configuration, :display_name)
+          .merge(file_name: generate_file_name(attributes[:display_name]))
+      ) { |f| f.entry = entry }
 
-      usage = revision.file_usages.create_with_lock!(file: file,
-                                                     configuration: attributes[:configuration])
+      usage = revision.file_usages.create!(file:,
+                                           configuration: attributes[:configuration],
+                                           display_name: attributes[:display_name])
       UsedFile.new(file, usage)
     end
 
-    def remove_file(file)
-      draft.file_usages.where(file: file).destroy_all
+    def remove_file(file) # rubocop:todo Metrics/AbcSize
+      draft.file_usages.where(file:).destroy_all
 
       file.file_type.nested_file_types.each do |nested_file_type|
         nested_file_ids = file.nested_files(nested_file_type.model).map(&:id)
@@ -44,7 +61,8 @@ module Pageflow
 
     def use_file(file)
       draft.file_usages.create!(file: file.to_model,
-                                configuration: file.configuration)
+                                configuration: file.configuration,
+                                display_name: file.display_name)
     end
 
     def save!
@@ -77,6 +95,10 @@ module Pageflow
       draft.cache_key
     end
 
+    def published_revision?
+      false
+    end
+
     private
 
     def check_foreign_key_custom_attributes(custom_attributes, attributes)
@@ -93,8 +115,14 @@ module Pageflow
         end
     end
 
+    def generate_file_name(file_name)
+      return nil if file_name.blank?
+
+      "#{SecureRandom.alphanumeric(8).downcase}#{File.extname(file_name)}"
+    end
+
     def file_is_used(file_type, file_id)
-      draft.file_usages.where(file_type: file_type, file_id: file_id).exists?
+      draft.file_usages.where(file_type:, file_id:).exists?
     end
   end
 end