pageflow 17.0.5 → 17.1.0

data/app/helpers/pageflow/pages_helper.rb

@@ -1,27 +1,40 @@
 module Pageflow
-  module PagesHelper
+  module PagesHelper # rubocop:todo Style/Documentation
     def render_page_template(page, locals = {})
       page_type = Pageflow.config.page_types.find_by_name!(page.template)
 
       render(template: page_type.template_path,
-             locals: locals.merge(page: page,
+             locals: locals.merge(page:,
                                   configuration: page.configuration))
     end
 
-    def page_css_class(page)
+    # rubocop:todo Metrics/PerceivedComplexity
+    # rubocop:todo Metrics/CyclomaticComplexity
+    def page_css_class(page) # rubocop:todo Metrics/AbcSize
       classes = ['page']
       classes << 'invert' if page.configuration['invert']
       classes << 'hide_title' if page.configuration['hide_title']
-      classes << "text_position_#{page.configuration['text_position']}" if page.configuration['text_position'].present?
-      classes << "scroll_indicator_mode_#{page.configuration['scroll_indicator_mode']}" if page.configuration['scroll_indicator_mode'].present?
-      classes << "scroll_indicator_orientation_#{page.configuration['scroll_indicator_orientation']}" if page.configuration['scroll_indicator_orientation'].present?
-      classes << "delayed_text_fade_in_#{page.configuration['delayed_text_fade_in']}" if page.configuration['delayed_text_fade_in'].present?
+      if page.configuration['text_position'].present?
+        classes << "text_position_#{page.configuration['text_position']}"
+      end
+      if page.configuration['scroll_indicator_mode'].present?
+        classes << "scroll_indicator_mode_#{page.configuration['scroll_indicator_mode']}"
+      end
+      if page.configuration['scroll_indicator_orientation'].present?
+        classes <<
+          "scroll_indicator_orientation_#{page.configuration['scroll_indicator_orientation']}"
+      end
+      if page.configuration['delayed_text_fade_in'].present?
+        classes << "delayed_text_fade_in_#{page.configuration['delayed_text_fade_in']}"
+      end
       classes << 'chapter_beginning' if page.position == 0
       classes << 'first_page' if page.is_first
-      classes << 'no_text_content' if !page_has_content(page)
+      classes << 'no_text_content' unless page_has_content(page)
       classes << 'hide_logo' if page.configuration['hide_logo']
       classes.join(' ')
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
 
     def page_default_content(page)
       safe_join([
@@ -56,7 +69,7 @@ module Pageflow
 
     # @api private
     def page_has_content(page)
-      has_title = ['title','subtitle','tagline'].any? do |attribute|
+      has_title = ['title', 'subtitle', 'tagline'].any? do |attribute|
         page.configuration[attribute].present?
       end
 
@@ -70,14 +83,14 @@ module Pageflow
       classes << 'chapter_beginning' if page.position == 0
       classes << 'emphasized' if page.configuration['emphasize_in_navigation']
       classes << "chapter_#{page.chapter.position}"
-      page.chapter.position % 2 == 0 ? classes << 'chapter_even' : classes << 'chapter_odd'
+      classes << (page.chapter.position.even? ? 'chapter_even' : 'chapter_odd')
       classes.join(' ')
     end
 
     def shadow_div(options = {})
       style = options[:opacity] ? "opacity: #{options[:opacity] / 100.0};" : nil
-      content_tag(:div, '', :class => 'shadow_wrapper') do
-        content_tag(:div, '', :class => 'shadow', :style => style)
+      content_tag(:div, '', class: 'shadow_wrapper') do
+        content_tag(:div, '', class: 'shadow', style:)
       end
     end
 
@@ -89,11 +102,12 @@ module Pageflow
     end
 
     def page_thumbnail_image_class(page, hero)
-      file_thumbnail_css_class(page_thumbnail_file(page), hero ? :link_thumbnail_large : :link_thumbnail)
+      file_thumbnail_css_class(page_thumbnail_file(page),
+                               hero ? :link_thumbnail_large : :link_thumbnail)
     end
 
-    def page_thumbnail_url(page, *args)
-      page_thumbnail_file(page).thumbnail_url(*args)
+    def page_thumbnail_url(page, *)
+      page_thumbnail_file(page).thumbnail_url(*)
     end
 
     def page_thumbnail_file(page)

data/app/helpers/pageflow/public_i18n_helper.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module PublicI18nHelper
+  module PublicI18nHelper # rubocop:todo Style/Documentation
     def public_i18n_javascript_tag(entry)
       render('pageflow/public_i18n/javascript_tag',
              entry_locale: entry.locale,

data/app/helpers/pageflow/quota_helper.rb

@@ -1,11 +1,11 @@
 module Pageflow
-  module QuotaHelper
+  module QuotaHelper # rubocop:todo Style/Documentation
     def quota_state_description(name, account)
       description = Pageflow.config.quotas.get(name, account).state_description
 
-      if description
-        content_tag(:p, description, class: 'quota_state_description')
-      end
+      return unless description
+
+      content_tag(:p, description, class: 'quota_state_description')
     end
   end
 end

data/app/helpers/pageflow/render_json_helper.rb

@@ -3,14 +3,17 @@ module Pageflow
   module RenderJsonHelper
     # Renders `image_files/_image_file.json.jbuilder` when given a
     # collection of `ImageFile` records.
-    def render_json_seed(records, options = {})
+    def render_json_seed(records, _options = {}) # rubocop:todo Metrics/AbcSize
       if records.respond_to?(:to_model)
         name = records.to_model.class.model_name.to_s.split('::').last.underscore.downcase
-        render_json_partial(['pageflow/editor', name.pluralize, name.singularize] * '/', name.singularize.to_sym => records)
+        render_json_partial(['pageflow/editor', name.pluralize, name.singularize].join('/'),
+                            name.singularize.to_sym => records)
       else
         return '[]'.html_safe if records.empty?
+
         name = records.first.to_model.class.model_name.to_s.split('::').last.underscore.downcase
-        render_json_partial(['pageflow/editor', name.pluralize, name.singularize] * '/', :collection => records, :as => name.singularize.to_sym)
+        render_json_partial(['pageflow/editor', name.pluralize, name.singularize].join('/'),
+                            collection: records, as: name.singularize.to_sym)
       end
     end
 

data/app/helpers/pageflow/revision_file_helper.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module RevisionFileHelper
+  module RevisionFileHelper # rubocop:todo Style/Documentation
     # Instead of finding a file directly by its ID (stored in configuration hashes for example),
     # finds the file by its usages perma_id within the scope of the revisions usages.
     # The @entry instance variable (of type DraftEntry or PublishedEntry)
@@ -21,6 +21,7 @@ module Pageflow
     # @returns UsedFile
     def find_file_in_entry(file_type, file_perma_id, entry = @entry)
       raise 'No entry of type PublishedEntry or DraftEntry set.' unless entry.present?
+
       entry.find_file_by_perma_id(file_type, file_perma_id)
     end
   end

data/app/helpers/pageflow/sites_helper.rb

@@ -1,11 +1,11 @@
 module Pageflow
-  module SitesHelper
-    DEFAULT_PUBLIC_ENTRY_OPTIONS = lambda do |site|
+  module SitesHelper # rubocop:todo Style/Documentation
+    DEFAULT_SITE_URL_OPTIONS = lambda do |site|
       site.cname.present? ? {host: site.cname} : nil
     end
 
     def pretty_site_url(site)
-      pageflow.public_root_url(Pageflow.config.site_url_options(site))
+      pageflow.public_root_url(Pageflow.config.site_url_options_for(site))
     end
   end
 end

data/app/helpers/pageflow/social_share_helper.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module SocialShareHelper
+  module SocialShareHelper # rubocop:todo Style/Documentation
     include EntriesHelper
     include PagesHelper
     include RevisionFileHelper
@@ -39,8 +39,13 @@ module Pageflow
     end
 
     def social_share_page_description(entry, page)
-      return social_share_sanitize(page.configuration['text']) if page.configuration['text'].present?
-      return social_share_sanitize(page.configuration['description']) if page.configuration['description'].present?
+      if page.configuration['text'].present?
+        return social_share_sanitize(page.configuration['text'])
+      end
+      if page.configuration['description'].present?
+        return social_share_sanitize(page.configuration['description'])
+      end
+
       social_share_entry_description(entry)
     end
 
@@ -48,23 +53,31 @@ module Pageflow
       return social_share_sanitize(entry.summary) if entry.summary.present?
 
       entry.pages.each do |page|
-        return social_share_sanitize(page.configuration['text']) if page.configuration['text'].present?
+        if page.configuration['text'].present?
+          return social_share_sanitize(page.configuration['text'])
+        end
       end
       ''
     end
 
-    def social_share_entry_image_tags(entry)
+    # rubocop:todo Metrics/AbcSize
+    def social_share_entry_image_tags(entry) # rubocop:todo Metrics/MethodLength
       share_images = []
       image_file = find_file_in_entry(ImageFile, entry.share_image_id, entry)
 
       if image_file
-        image_url = image_file.thumbnail_url(:medium)
-        share_images.push(image_url: image_url, width: image_file.width, height: image_file.height)
+        image_url = image_file.thumbnail_url(
+          image_file.output_present?(:social) ? :social : :medium
+        )
+
+        share_images.push(image_url:, width: image_file.width, height: image_file.height)
       else
         entry.pages.each do |page|
           break if share_images.size >= 4
+
           thumbnail_file = page_thumbnail_file(page)
           next unless thumbnail_file.present?
+
           image_url = thumbnail_file.thumbnail_url(:medium)
           thumbnail_width = 1200
           thumbnail_height = 630
@@ -72,15 +85,16 @@ module Pageflow
             thumbnail_width = thumbnail_file.file.width
             thumbnail_height = thumbnail_file.file.height
           end
-          share_images.push(image_url: image_url,
+          share_images.push(image_url:,
                             width: thumbnail_width,
                             height: thumbnail_height)
           share_images.uniq!
         end
       end
 
-      render 'pageflow/social_share/image_tags', share_images: share_images
+      render 'pageflow/social_share/image_tags', share_images:
     end
+    # rubocop:enable Metrics/AbcSize
 
     def social_share_normalize_protocol(url)
       url.gsub(%r{^//}, 'https://')
@@ -89,7 +103,7 @@ module Pageflow
     private
 
     def social_share_sanitize(text)
-      HTMLEntities.new.decode(strip_tags(text.gsub(/<br ?\/?>|&nbsp;/, ' ').squish))
+      HTMLEntities.new.decode(strip_tags(text.gsub(%r{<br ?/?>|&nbsp;}, ' ').squish))
     end
   end
 end

data/app/helpers/pageflow/social_share_links_helper.rb

@@ -1,19 +1,21 @@
 module Pageflow
-  module SocialShareLinksHelper
+  module SocialShareLinksHelper # rubocop:todo Style/Documentation
     include SocialShareHelper
 
     PROVIDER_URL_TEMPLATES = {
-      email: 'mailto:?body=%{url}',
-      facebook: 'http://www.facebook.com/sharer/sharer.php?u=%{url}',
-      google: 'https://plus.google.com/share?url=%{url}',
-      linked_in: 'https://www.linkedin.com/shareArticle?mini=true&url=%{url}',
-      telegram: 'tg://msg?text=%{url}',
-      twitter: 'https://x.com/intent/post?url=%{url}',
-      whats_app: 'WhatsApp://send?text=%{url}'
+      bluesky: 'https://bsky.app/intent/compose?text=%<url>s',
+      email: 'mailto:?body=%<url>s',
+      facebook: 'http://www.facebook.com/sharer/sharer.php?u=%<url>s',
+      google: 'https://plus.google.com/share?url=%<url>s',
+      linked_in: 'https://www.linkedin.com/shareArticle?mini=true&url=%<url>s',
+      telegram: 'tg://msg?text=%<url>s',
+      threads: 'https://threads.net/intent/post?text=%<url>s',
+      twitter: 'https://x.com/intent/post?url=%<url>s',
+      whats_app: 'WhatsApp://send?text=%<url>s'
     }.freeze
 
     def social_share_link(provider, entry, &block)
-      block ||= ->() {}
+      block ||= -> {}
       page_share_link_url = social_share_link_url(provider, social_share_page_url(entry, 'permaId'))
       data_attributes = entry.share_url.present? ? {} : {share_page: page_share_link_url}
 
@@ -33,6 +35,7 @@ module Pageflow
 
     def social_share_link_url(provider, url)
       return nil if url.blank?
+
       encoded_url = ERB::Util.url_encode(url)
       format(PROVIDER_URL_TEMPLATES[provider], url: encoded_url)
     end

data/app/helpers/pageflow/structured_data_helper.rb

@@ -8,7 +8,7 @@ module Pageflow
     def structured_data_for_entry(entry)
       content_tag(:script, type: 'application/ld+json') do
         render_json_partial('pageflow/structured_data/entry',
-                            entry: entry,
+                            entry:,
                             meta_data: meta_tags_data_for_entry(entry))
       end
     end

data/app/helpers/pageflow/stub_page_configuration.rb

@@ -1,13 +1,17 @@
 module Pageflow
-  class StubPageConfiguration
+  class StubPageConfiguration # rubocop:todo Style/Documentation
     attr_reader :template
 
     def initialize(template)
       @template = template
     end
 
-    def method_missing(name, *args)
-      template.tag(:span, :data => {:property => name})
+    def method_missing(name, *_args)
+      template.tag(:span, data: {property: name})
+    end
+
+    def respond_to_missing?(_name, _include_private = false)
+      true
     end
   end
 end

data/app/helpers/pageflow/text_direction_helper.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module TextDirectionHelper
+  module TextDirectionHelper # rubocop:todo Style/Documentation
     def text_direction(locale)
       PublicI18n.text_direction(locale)
     end

data/app/helpers/pageflow/themes_helper.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module ThemesHelper
+  module ThemesHelper # rubocop:todo Style/Documentation
     include RenderJsonHelper
 
     def themes_options_json_seed(config = Pageflow.config)

data/app/helpers/pageflow/video_files_helper.rb

@@ -1,8 +1,10 @@
 module Pageflow
-  module VideoFilesHelper
+  module VideoFilesHelper # rubocop:todo Style/Documentation
     include RevisionFileHelper
 
-    def mobile_poster_image_div(config = {})
+    # rubocop:todo Metrics/PerceivedComplexity
+    # rubocop:todo Metrics/CyclomaticComplexity
+    def mobile_poster_image_div(config = {}) # rubocop:todo Metrics/AbcSize
       classes = ['background', 'background_image']
       position = {x: 50, y: 50}
 
@@ -26,10 +28,15 @@ module Pageflow
                   class: classes.join(' '),
                   style: "background-position: #{position[:x]}% #{position[:y]}%;")
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
 
     def poster_image_tag(video_file_perma_id, poster_image_perma_id = nil, options = {})
       video_file = find_file_in_entry(VideoFile, video_file_perma_id)
-      poster = poster_image_perma_id.present? ? find_file_in_entry(ImageFile, poster_image_perma_id) : nil
+      poster = if poster_image_perma_id.present?
+                 find_file_in_entry(ImageFile,
+                                    poster_image_perma_id)
+               end
 
       if poster&.ready?
         options = options.merge('data-src' => poster.attachment.url(:medium))
@@ -42,14 +49,17 @@ module Pageflow
       image_tag('', options)
     end
 
-    def video_file_video_tag(video_file, options = {})
+    # rubocop:todo Metrics/AbcSize
+    # rubocop:todo Metrics/PerceivedComplexity
+    # rubocop:todo Metrics/CyclomaticComplexity
+    def video_file_video_tag(video_file, options = {}) # rubocop:todo Metrics/MethodLength
       defaults = {
         crossorigin: 'anonymous',
         class: [
           'player video-js video-viewport vjs-default-skin',
           options.delete(:class)
         ].compact * ' ',
-        preload:  options.delete(:preload) ? 'metadata' : 'none'
+        preload: options.delete(:preload) ? 'metadata' : 'none'
       }
 
       options.reverse_merge! defaults
@@ -58,7 +68,10 @@ module Pageflow
       poster_image_id = options.delete(:poster_image_id)
       poster = poster_image_id.present? ? find_file_in_entry(ImageFile, poster_image_id) : nil
       mobile_poster_image_id = options.delete(:mobile_poster_image_id)
-      mobile_poster = mobile_poster_image_id.present? ? find_file_in_entry(ImageFile, mobile_poster_image_id) : nil
+      mobile_poster = if mobile_poster_image_id.present?
+                        find_file_in_entry(ImageFile,
+                                           mobile_poster_image_id)
+                      end
 
       options[:data] = {}
 
@@ -81,14 +94,17 @@ module Pageflow
       end
 
       render('pageflow/video_files/video_tag',
-             video_file: video_file,
-             options: options,
-             url_options: url_options)
+             video_file:,
+             options:,
+             url_options:)
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/AbcSize
 
     # @deprecated
     def lookup_video_tag(video_id, poster_image_id, options = {})
-      video_file_script_tag(video_id, options.merge(poster_image_id: poster_image_id))
+      video_file_script_tag(video_id, options.merge(poster_image_id:))
     end
 
     def video_file_script_tag(video_file_perma_id, options = {})
@@ -102,9 +118,9 @@ module Pageflow
       end
 
       render('pageflow/video_files/script_tag',
-             script_tag_data: script_tag_data,
-             video_file: video_file,
-             options: options)
+             script_tag_data:,
+             video_file:,
+             options:)
     end
 
     def video_file_non_js_link(entry, video_file_perma_id)

data/app/helpers/pageflow/widgets_helper.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module WidgetsHelper
+  module WidgetsHelper # rubocop:todo Style/Documentation
     include RenderJsonHelper
 
     def render_widget_head_fragments(entry, options = {})
@@ -21,21 +21,22 @@ module Pageflow
     end
 
     def present_widgets_css_class(entry)
-      entry.resolve_widgets.map do |widget|
+      entry.resolve_widgets.map { |widget|
         "widget_#{widget.widget_type.name}_present"
-      end.push('widgets_present').join(' ')
+      }.push('widgets_present').join(' ')
     end
 
     def widget_types_json_seeds(config)
-      config.widget_types.each_with_object({}) do |widget_type, result|
+      config.widget_types.each_with_object({}) { |widget_type, result|
         widget_type.roles.each do |role|
           result[role] ||= []
           result[role] << {
             name: widget_type.name,
-            translationKey: widget_type.translation_key
+            translationKey: widget_type.translation_key,
+            insertPoint: widget_type.insert_point
           }
         end
-      end.to_json.html_safe
+      }.to_json.html_safe
     end
 
     def widgets_json_seeds(entry)

data/app/inputs/pageflow_permalink_input.rb

@@ -1,3 +1,4 @@
+# @api private
 class PageflowPermalinkInput
   include Formtastic::Inputs::Base
   include Formtastic::Inputs::Base::Stringish
@@ -27,10 +28,10 @@ class PageflowPermalinkInput
   end
 
   def permalink_inputs_html
-    return '' if options[:site].permalink_directories.empty?
+    return '' if options[:site].permalink_directories.empty? || options[:only_root]
 
     builder.select(:directory_id, directory_select_options) <<
-      builder.text_field(:slug, placeholder: options[:slug_placeholder])
+      builder.text_field(:slug, data: {placeholder: options[:slug_placeholder]})
   end
 
   def error_keys

data/app/jobs/pageflow/application_job.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class ApplicationJob < ActiveJob::Base
     # Most jobs are safe to ignore if the underlying records are no longer available
     discard_on ActiveJob::DeserializationError

data/app/jobs/pageflow/entry_export_import/upload_and_publish_file_job.rb

@@ -11,7 +11,7 @@ module Pageflow
         reusable_file.attachments_for_export.each do |attachment|
           archive_path = AttachmentFiles.archive_path(reusable_file,
                                                       attachment,
-                                                      exported_id: exported_id)
+                                                      exported_id:)
 
           archive.extract_to_tempfile(archive_path) do |tempfile|
             # Paperclip skips post processing anyway since the name of

data/app/jobs/pageflow/poll_meta_data_from_zencoder_job.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class PollMetaDataFromZencoderJob < PollZencoderJob
     def perform_with_result(file, _options)
       super(file, skip_post_processing: true)

data/app/jobs/pageflow/poll_zencoder_job.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class PollZencoderJob < ApplicationJob
     queue_as :resizing
 
@@ -23,10 +24,10 @@ module Pageflow
     def poll_zencoder(file, api)
       info = api.get_info(file.job_id)
 
-      file.encoding_progress = info[:finished] ? 100 : info[:progress];
+      file.encoding_progress = info[:finished] ? 100 : info[:progress]
       file.encoding_error_message = nil
 
-      if info[:state] === 'failed'
+      if info[:state] == 'failed'
         throw(:halt, :error)
       elsif !info[:finished]
         throw(:halt, :pending)

data/app/jobs/pageflow/process_image_or_text_track_job.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class ProcessImageOrTextTrackJob < ApplicationJob
     queue_as :resizing
 

data/app/jobs/pageflow/prune_auto_snapshots_job.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class PruneAutoSnapshotsJob < ApplicationJob
     queue_as :prune
 

data/app/jobs/pageflow/request_meta_data_from_zencoder_job.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class RequestMetaDataFromZencoderJob < ApplicationJob
     queue_as :default
 

data/app/jobs/pageflow/submit_file_to_zencoder_job.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class SubmitFileToZencoderJob < ApplicationJob
     queue_as :default
 

data/app/mailers/pageflow/user_mailer.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class UserMailer < ActionMailer::Base
     def invitation(options)
       @user = options[:user]

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

@@ -10,7 +10,19 @@ module Pageflow
     end
 
     def ensure_perma_id
-      self.perma_id ||= (self.class.maximum(:perma_id) || 0) + 1
+      return if perma_id.present?
+
+      entry = entry_for_auto_generated_perma_id
+
+      entry.with_lock do
+        entry.increment!(:perma_id_counter)
+        self.perma_id = entry.perma_id_counter
+      end
+    end
+
+    def entry_for_auto_generated_perma_id
+      raise NotImplementedError,
+            "#{self.class.name} must implement #entry_for_auto_generated_perma_id"
     end
   end
 end

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

@@ -1,5 +1,5 @@
 module Pageflow
-  module EntryPublicationStates
+  module EntryPublicationStates # rubocop:todo Style/Documentation
     extend ActiveSupport::Concern
 
     included do
@@ -38,6 +38,10 @@ module Pageflow
       published? && published_revision.password_protected?
     end
 
+    def published_without_password_protection?
+      published? && !published_revision.password_protected?
+    end
+
     def published?
       published_revision.present?
     end
@@ -54,7 +58,7 @@ module Pageflow
       !!revisions.publications.first&.noindex
     end
 
-    module ClassMethods
+    module ClassMethods # rubocop:todo Style/Documentation
       def with_publication_state(state)
         case state
         when 'published_with_password_protection'
@@ -64,7 +68,7 @@ module Pageflow
         when 'not_published'
           not_published
         else
-          fail(ArgumentError, "Unknown publication state #{state}")
+          raise(ArgumentError, "Unknown publication state #{state}")
         end
       end
     end