pageflow 17.0.5 → 17.2.0

data/app/helpers/pageflow/entries_helper.rb

@@ -1,10 +1,10 @@
 module Pageflow
-  module EntriesHelper
+  module EntriesHelper # rubocop:todo Style/Documentation
     def pretty_entry_title(entry)
       return entry.title if entry.site.title == ' '
 
       [entry.title,
-       entry.site.title.presence || entry.site.cname_domain.presence].compact.join(' - ')
+       entry.site.display_title].compact.join(' - ')
     end
 
     def pretty_entry_url(entry, options = {})
@@ -15,7 +15,7 @@ module Pageflow
     module PrettyUrl
       extend self
 
-      def build(routes, entry, options)
+      def build(routes, entry, options = {})
         with_custom_canonical_url_prefix(entry) ||
           default(routes, entry, options)
       end
@@ -24,32 +24,44 @@ module Pageflow
 
       def with_custom_canonical_url_prefix(entry)
         return if entry.site.canonical_entry_url_prefix.blank?
+
         entry = ensure_entry_with_revision(entry)
 
         [
           entry.site.canonical_entry_url_prefix.gsub(':locale', entry.locale),
-          entry.to_param,
+          entry_suffix(entry),
           entry.site.trailing_slash_in_canonical_urls ? '/' : ''
         ].join
       end
 
+      def entry_suffix(entry)
+        if entry.permalink.present?
+          entry_permalink_parts(entry).join
+        else
+          entry.to_param
+        end
+      end
+
       def default(routes, entry, options)
         params =
           options
           .reverse_merge(trailing_slash: entry.site.trailing_slash_in_canonical_urls)
-          .reverse_merge(Pageflow.config.site_url_options(entry.site) || {})
+          .reverse_merge(Pageflow.config_for(entry).public_entry_url_options_for(entry) || {})
 
         if entry.permalink.present?
-          routes.permalink_url(
-            entry.permalink.directory&.path || '',
-            entry.permalink.slug,
-            params
-          )
+          routes.permalink_url(*entry_permalink_parts(entry), params)
         else
           routes.short_entry_url(entry.to_model, params)
         end
       end
 
+      def entry_permalink_parts(entry)
+        [
+          entry.permalink.directory&.path || '',
+          entry.permalink.slug
+        ]
+      end
+
       def ensure_entry_with_revision(entry)
         if entry.is_a?(EntryAtRevision)
           entry
@@ -60,58 +72,53 @@ module Pageflow
     end
 
     def entry_privacy_link_url(entry)
-      return unless entry.site.privacy_link_url.present?
-      "#{entry.site.privacy_link_url}?lang=#{entry.locale}"
+      url = entry.legal_info.privacy_url
+
+      return unless url.present?
+      return url if url.start_with?('javascript:')
+
+      "#{url}?lang=#{entry.locale}"
     end
 
     def entry_file_rights(entry)
-      rights = Pageflow.config.file_types.map do |file_type|
+      rights = Pageflow.config.file_types.map { |file_type|
         entry.find_files(file_type.model).map do |file|
           file.rights.presence || entry.account.default_file_rights.presence
         end
-      end.flatten.compact.sort.uniq
+      }.flatten.compact.sort.uniq
 
       if rights.any?
         content_tag :p, class: 'rights' do
-          I18n.t('pageflow.helpers.entries.image_rights') + ": " + rights * ', '
+          "#{I18n.t('pageflow.helpers.entries.image_rights')}: #{rights * ', '}"
         end
       else
         ''
       end
     end
 
-    def entry_global_links(entry)
-      links = []
+    def entry_global_links(entry) # rubocop:todo Metrics/AbcSize
+      legal_info = entry.legal_info
 
-      if entry.site.imprint_link_label.present? && entry.site.imprint_link_url.present?
-        links << link_to(raw(entry.site.imprint_link_label),
-                         entry.site.imprint_link_url,
-                         target: '_blank',
-                         tabindex: 2,
-                         class: 'legal')
-      end
+      candidates = [
+        [legal_info.imprint.label, legal_info.imprint.url, 'legal'],
+        [legal_info.copyright.label, legal_info.copyright.url, 'copy'],
+        [I18n.t('pageflow.public.privacy_notice'), entry_privacy_link_url(entry), 'privacy']
+      ]
 
-      if entry.site.copyright_link_label.present? && entry.site.copyright_link_url.present?
-        links << link_to(raw(entry.site.copyright_link_label),
-                         entry.site.copyright_link_url,
-                         target: '_blank',
-                         tabindex: 2,
-                         class: 'copy')
-      end
+      links = candidates.filter_map do |label, url, css_class|
+        next if label.blank? || url.blank?
 
-      if entry.site.privacy_link_url.present?
-        links << link_to(I18n.t('pageflow.public.privacy_notice'),
-                         entry_privacy_link_url(entry),
-                         target: '_blank',
-                         tabindex: 2,
-                         class: 'privacy')
+        link_to(raw(label),
+                url,
+                target: url.start_with?('javascript:') ? nil : '_blank',
+                tabindex: 2,
+                class: css_class)
       end
 
-      if links.any?
-        content_tag(:span, I18n.t('pageflow.helpers.entries.global_links'), class: 'hidden') + safe_join(links, ''.html_safe)
-      else
-        ''
-      end
+      return '' if links.empty?
+
+      content_tag(:span, I18n.t('pageflow.helpers.entries.global_links'),
+                  class: 'hidden') + safe_join(links, ''.html_safe)
     end
 
     def entry_theme_stylesheet_link_tag(entry)
@@ -156,15 +163,14 @@ module Pageflow
 
     def entry_header_css_class(entry)
       css_class = 'header'
-      if entry.pages.any? && entry.pages.first.configuration['invert']
-        css_class += ' invert'
-      end
+      css_class += ' invert' if entry.pages.any? && entry.pages.first.configuration['invert']
       css_class
     end
 
     def entry_summary(entry)
       return '' if entry.summary.blank?
-      strip_tags(entry.summary.gsub(/<br ?\/?>/, ' ').squish)
+
+      strip_tags(entry.summary.gsub(%r{<br ?/?>}, ' ').squish)
     end
   end
 end

data/app/helpers/pageflow/entry_json_seed_helper.rb

@@ -9,7 +9,7 @@ module Pageflow
 
     def entry_json_seed(entry)
       sanitize_json(render_json_partial('pageflow/entry_json_seed/entry',
-                                        entry: entry)).html_safe
+                                        entry:)).html_safe
     end
 
     def entry_attributes_seed(entry)
@@ -23,7 +23,8 @@ module Pageflow
     def entry_theme_seed(entry)
       theme = entry.theme
       {
-        change_to_parent_page_at_storyline_boundary: theme.change_to_parent_page_at_storyline_boundary?,
+        change_to_parent_page_at_storyline_boundary:
+          theme.change_to_parent_page_at_storyline_boundary?,
         page_change_by_scrolling: theme.page_change_by_scrolling?,
         hide_text_on_swipe: theme.hide_text_on_swipe?
       }
@@ -50,14 +51,14 @@ module Pageflow
     end
 
     def entry_file_ids_seed(entry)
-      Pageflow.config.file_types.with_thumbnail_support.each_with_object({}) do |file_type, result|
-        result[file_type.collection_name] = entry.find_files(file_type.model).map(&:perma_id)
+      Pageflow.config.file_types.with_thumbnail_support.to_h do |file_type|
+        [file_type.collection_name, entry.find_files(file_type.model).map(&:perma_id)]
       end
     end
 
     def entry_audio_files_json_seed(entry)
-      seed = entry.find_files(AudioFile).each_with_object({}) do |audio_file, result|
-        result[audio_file.perma_id] = audio_file_sources(audio_file)
+      seed = entry.find_files(AudioFile).to_h do |audio_file|
+        [audio_file.perma_id, audio_file_sources(audio_file)]
       end
 
       sanitize_json(seed.to_json).html_safe

data/app/helpers/pageflow/feeds_helper.rb

@@ -14,14 +14,14 @@ module Pageflow
           {
             locale: entry.locale,
             format: 'atom'
-          }.merge(Pageflow.config.site_url_options(entry.site) || {})
+          }.merge(Pageflow.config.site_url_options_for(entry.site) || {})
         )
 
       tag(:link,
           rel: 'alternate',
           type: 'application/atom+xml',
           title: 'Feed',
-          href: href)
+          href:)
     end
 
     # @api private

data/app/helpers/pageflow/file_background_images_helper.rb

@@ -37,10 +37,10 @@ module Pageflow
       end
 
       def rules_for_file(file_type, file)
-        file_type.css_background_image_urls_for(file, entry: entry).map do |name, url|
+        file_type.css_background_image_urls_for(file, entry:).map do |name, url|
           {
             prefix: rule_prefix(file_type, name),
-            file: file,
+            file:,
             url: url_for_breakpoint(file_type, url)
           }
         end

data/app/helpers/pageflow/file_thumbnails_helper.rb

@@ -1,18 +1,19 @@
 module Pageflow
-  module FileThumbnailsHelper
+  module FileThumbnailsHelper # rubocop:todo Style/Documentation
     def file_thumbnails_css(revision)
       render(partial: 'pageflow/file_types/thumbnails',
              collection: Pageflow.config.file_types.with_thumbnail_support,
              as: :file_type,
              locals: {
-               revision: revision,
+               revision:,
                styles: Pageflow.config.css_rendered_thumbnail_styles
              })
     end
 
     def file_thumbnail_css_class(file, style)
       return if file.blank?
-      [file.to_model.class.model_name.singular, style, file.perma_id] * '_'
+
+      [file.to_model.class.model_name.singular, style, file.perma_id].join('_')
     end
   end
 end

data/app/helpers/pageflow/files_helper.rb

@@ -11,7 +11,7 @@ module Pageflow
       if file.width && file.height
         "#{file.width} x #{file.height}px"
       else
-        "-"
+        '-'
       end
     end
 
@@ -22,9 +22,10 @@ module Pageflow
         minutes = (total_seconds / 60) % 60
         hours = total_seconds / (60 * 60)
 
-        format("%02d:%02d:%02d", hours, minutes, seconds)
+        format('%<hours>02d:%<minutes>02d:%<seconds>02d', hours:, minutes:,
+                                                          seconds:)
       else
-        "-"
+        '-'
       end
     end
 
@@ -37,7 +38,7 @@ module Pageflow
       Pageflow.config.file_types.each do |file_type|
         json.set!(file_type.collection_name) do
           json.array!(entry.find_files(file_type.model)) do |file|
-            json.partial!('pageflow/files/file', file: file, file_type: file_type)
+            json.partial!('pageflow/files/file', file:, file_type:)
           end
         end
       end

data/app/helpers/pageflow/folders_helper.rb

@@ -1,8 +1,11 @@
 module Pageflow
-  module FoldersHelper
+  module FoldersHelper # rubocop:todo Style/Documentation
     def collection_for_folders(current_account, current_folder = nil)
-      accounts = AccountPolicy::Scope.new(current_user, Pageflow::Account)
-                 .entry_creatable.includes(:folders).where('pageflow_folders.id IS NOT NULL')
+      accounts = AccountPolicy::Scope
+                 .new(current_user, Pageflow::Account)
+                 .entry_creatable
+                 .includes(:folders)
+                 .where('pageflow_folders.id IS NOT NULL')
                  .order(:name, 'pageflow_folders.name')
 
       option_groups_from_collection_for_select(accounts,
@@ -23,9 +26,9 @@ module Pageflow
         account_folders[0][:account_id] == current_account.id
       end
 
-      folders_array.map(&:to_a).map do |account_folders|
+      folders_array.map(&:to_a).map { |account_folders|
         account_folders.map(&:id)
-      end.flatten
+      }.flatten
     end
   end
 end

data/app/helpers/pageflow/help_entries_helper.rb

@@ -11,9 +11,9 @@ module Pageflow
       render('pageflow/help_entries/menu', help_entries: config.help_entries)
     end
 
-    def help_entry_li(help_entry, &block)
+    def help_entry_li(help_entry, &)
       css_class = help_entry.children.present? ? 'expandable' : nil
-      content_tag(:li, class: css_class, &block)
+      content_tag(:li, class: css_class, &)
     end
   end
 end

data/app/helpers/pageflow/hreflang_links_helper.rb

@@ -0,0 +1,37 @@
+module Pageflow
+  # Helpers to render alternate links to translations of an entry.
+  #
+  # @since 17.1
+  module HreflangLinksHelper
+    include SocialShareHelper
+
+    # Render alternate links to all published entries that have been
+    # marked as translations of the given entry.
+    def hreflang_link_tags_for_entry(entry)
+      safe_join(
+        translations_for_hreflang_links(entry).each_with_object([]) do |translation, links|
+          links << hreflang_link_tag(translation)
+
+          if translation.default_translation?
+            links << hreflang_link_tag(translation, hreflang: 'x-default')
+          end
+        end
+      )
+    end
+
+    private
+
+    def translations_for_hreflang_links(entry)
+      entry.translations(
+        -> { preload(:site, :account, :translation_group, permalink: :directory) }
+      )
+    end
+
+    def hreflang_link_tag(entry, hreflang: entry.locale)
+      tag('link',
+          rel: 'alternate',
+          hreflang:,
+          href: social_share_entry_url(entry))
+    end
+  end
+end

data/app/helpers/pageflow/info_box_helper.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module InfoBoxHelper
+  module InfoBoxHelper # rubocop:todo Style/Documentation
     def info_box(configuration)
       css_classes = ['add_info_box']
 
@@ -9,23 +9,19 @@ module Pageflow
         css_classes << 'empty'
       end
 
-      if configuration['additional_title'].blank?
-        css_classes << 'title_empty'
-      end
+      css_classes << 'title_empty' if configuration['additional_title'].blank?
 
-      if configuration['additional_description'].blank?
-        css_classes << 'description_empty'
-      end
+      css_classes << 'description_empty' if configuration['additional_description'].blank?
 
       render('pageflow/pages/info_box',
-             configuration: configuration,
+             configuration:,
              css_class: css_classes * ' ')
     end
 
     def info_box_title(title)
-      if title.present?
-        content_tag(:h3, title)
-      end
+      return unless title.present?
+
+      content_tag(:h3, title)
     end
   end
 end

data/app/helpers/pageflow/media_query_helper.rb

@@ -1,7 +1,7 @@
 module Pageflow
-  module MediaQueryHelper
-    def media_query(condition, &block)
-      content = capture(&block)
+  module MediaQueryHelper # rubocop:todo Style/Documentation
+    def media_query(condition, &)
+      content = capture(&)
 
       if condition == :default
         content

data/app/helpers/pageflow/navigation_bar_helper.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module NavigationBarHelper
+  module NavigationBarHelper # rubocop:todo Style/Documentation
     def navigation_bar_css_class(entry, options = {})
       [
         options[:class],

data/app/helpers/pageflow/overview_helper.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module OverviewHelper
+  module OverviewHelper # rubocop:todo Style/Documentation
     def overview_page_description(page)
       if page.configuration['description'].present?
         raw(page.configuration['description'])

data/app/helpers/pageflow/page_types_helper.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module PageTypesHelper
+  module PageTypesHelper # rubocop:todo Style/Documentation
     include RenderJsonHelper
 
     def page_type_json_seeds(config)
@@ -9,9 +9,9 @@ module Pageflow
     end
 
     def page_type_json_seed(json, page_type)
-      if page_type.json_seed_template
-        json.partial!(template: page_type.json_seed_template, locals: {page_type: page_type})
-      end
+      return unless page_type.json_seed_template
+
+      json.partial!(template: page_type.json_seed_template, locals: {page_type:})
     end
 
     def page_type_templates(entry)
@@ -24,7 +24,7 @@ module Pageflow
                            locals: {
                              configuration: {},
                              page: Page.new,
-                             entry: entry
+                             entry:
                            },
                            layout: false).to_str,
                     type: 'text/html', data: {template: "#{page_type.name}_page"})

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,
@@ -11,14 +11,15 @@ module Pageflow
         value.presence || fallback
       end
 
-      {
-        pageflow: {
-          public: I18n.t('pageflow.public', locale: I18n.default_locale)
-                      .dup
-                      .deep_merge(I18n.t('pageflow.public', locale: entry.locale),
-                                  &merge_ignoring_nil)
-        }
-      }
+      locales = [I18n.default_locale, *I18n.fallbacks[entry.locale].reverse].uniq &
+                I18n.available_locales
+
+      translations = locales.reduce({}) do |result, locale|
+        result.deep_merge(I18n.t('pageflow.public', locale:, default: {}),
+                          &merge_ignoring_nil)
+      end
+
+      {pageflow: {public: translations}}
     end
   end
 end

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