pageflow 17.0.5 → 17.2.0

data/app/controllers/pageflow/review/comments_controller.rb

@@ -0,0 +1,53 @@
+module Pageflow
+  module Review
+    # @api private
+    class CommentsController < Pageflow::ApplicationController
+      respond_to :json
+      before_action :authenticate_user!
+
+      def create
+        entry = DraftEntry.find(params[:entry_id])
+        authorize!(:read, entry.to_model)
+
+        thread = entry.comment_threads.find(params[:comment_thread_id])
+        @comment = thread.comments.build(comment_params)
+        @comment.creator = current_user
+        @comment.save!
+
+        render :create, status: :created
+      end
+
+      def update
+        entry = DraftEntry.find(params[:entry_id])
+        authorize!(:read, entry.to_model)
+
+        @comment = find_comment(entry)
+
+        return head(:forbidden) unless @comment.creator == current_user
+
+        @comment.update!(update_params.merge(edited_at: Time.current))
+
+        render :create
+      end
+
+      private
+
+      def find_comment(entry)
+        entry.comment_threads
+             .find(params[:comment_thread_id])
+             .comments
+             .find(params[:id])
+      end
+
+      def comment_params
+        params.require(:comment).permit(:body, :quote)
+      end
+
+      # The quote records the wording the comment referred to when it was
+      # written. Editing must not make it describe some later version.
+      def update_params
+        params.require(:comment).permit(:body)
+      end
+    end
+  end
+end

data/app/controllers/pageflow/revisions_controller.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class RevisionsController < Pageflow::ApplicationController
     include ControllerDelegation
     include QuotaVerification
@@ -38,7 +39,10 @@ module Pageflow
     end
 
     def delegate_to_entry_type_frontend_app!(entry)
-      EntriesControllerEnvHelper.add_entry_info_to_env(request.env, entry: entry, mode: :preview)
+      EntriesControllerEnvHelper.add_entry_info_to_env(request.env,
+                                                       entry:,
+                                                       mode: :preview,
+                                                       ui_locale: I18n.locale)
       delegate_to_rack_app!(entry.entry_type.frontend_app)
     end
   end

data/app/controllers/pageflow/sitemaps_controller.rb

@@ -5,7 +5,7 @@ module Pageflow
       site = Site.for_request(request).first!
       return head 404 unless site.sitemap_enabled?
 
-      @entries = Sitemaps.entries_for(site: site)
+      @entries = Sitemaps.entries_for(site:)
 
       respond_to do |format|
         format.xml

data/app/controllers/pageflow/storylines_controller.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class StorylinesController < Pageflow::ApplicationController
     respond_to :json
 

data/app/helpers/pageflow/admin/cutoff_modes_helper.rb

@@ -0,0 +1,12 @@
+module Pageflow
+  module Admin
+    # @api private
+    module CutoffModesHelper
+      def cutoff_modes_collection(config)
+        config.cutoff_modes.names.map do |name|
+          [t(name, scope: 'pageflow.cutoff_modes'), name]
+        end
+      end
+    end
+  end
+end

data/app/helpers/pageflow/admin/entries_helper.rb

@@ -1,6 +1,6 @@
 module Pageflow
   module Admin
-    module EntriesHelper
+    module EntriesHelper # rubocop:todo Style/Documentation
       def admin_entry_title(entry)
         if entry.title.blank?
           I18n.t('pageflow.admin.entries.default_title', id: entry.id)
@@ -19,6 +19,46 @@ module Pageflow
         end
       end
 
+      def entry_comments_indicator(entry, summaries: entry_comment_summaries)
+        summary = summaries[entry.id]
+        return unless summary&.any?
+
+        content_tag(:span,
+                    class: 'entry_comments_indicator',
+                    data: {tooltip: entry_comments_tooltip(summary)}) do
+          safe_join([summary.topic_count.to_s,
+                     (content_tag(:span, '', class: 'unread_dot') if summary.unread?)].compact)
+        end
+      end
+
+      # Built for the whole page at once, so that rendering a row does
+      # not query. Views without an index table collection pass their own
+      # summaries instead.
+      def entry_comment_summaries
+        @entry_comment_summaries ||=
+          EntryCommentSummary.for_entries(collection, user: current_user)
+      end
+
+      def entry_comments_tooltip(summary)
+        scope = 'pageflow.admin.entries.comments'
+
+        parts = [t("#{scope}.topic_count", count: summary.topic_count)]
+
+        if summary.unread_topic_count.positive?
+          parts << t("#{scope}.unread_topic_count", count: summary.unread_topic_count)
+        end
+
+        if summary.unread_reply_count.positive?
+          parts << t("#{scope}.unread_reply_count", count: summary.unread_reply_count)
+        end
+
+        if summary.unread_resolution_count.positive?
+          parts << t("#{scope}.unread_resolution_count", count: summary.unread_resolution_count)
+        end
+
+        t("#{scope}.tooltip", summary: parts.join(', '))
+      end
+
       def entry_type_collection(entry_types = Pageflow.config.entry_types)
         entry_types.map(&:name).index_by do |type|
           I18n.t(type, scope: 'activerecord.values.pageflow/entry.type_names')

data/app/helpers/pageflow/admin/entry_translations_helper.rb

@@ -0,0 +1,18 @@
+module Pageflow
+  module Admin
+    # @api private
+    module EntryTranslationsHelper
+      include Pageflow::PublicI18n::LocalesHelper
+
+      def entry_translation_display_locale(entry)
+        display_locale = public_locale_name_for((entry.published_revision || entry.draft).locale)
+
+        if entry.default_translation?
+          t('pageflow.admin.entry_translations.default_translation', display_locale:)
+        else
+          display_locale
+        end
+      end
+    end
+  end
+end

data/app/helpers/pageflow/admin/features_helper.rb

@@ -1,6 +1,6 @@
 module Pageflow
   module Admin
-    module FeaturesHelper
+    module FeaturesHelper # rubocop:todo Style/Documentation
       def feature_state_select_tag(feature_target, feature_name)
         own_state = feature_target.own_feature_state(feature_name)
         inherited_state = feature_target.inherited_feature_state(feature_name)

data/app/helpers/pageflow/admin/form_helper.rb

@@ -1,13 +1,13 @@
 module Pageflow
   module Admin
-    module FormHelper
+    module FormHelper # rubocop:todo Style/Documentation
       # Using semantic_form_for directly causes Formtastic deprecation
       # warnings regarding `input_class_finder` and
       # `action_class_finder`. `active_admin_form_for` causes issues
       # in `erb` templates (see
       # https://github.com/activeadmin/activeadmin/issues/3916).
-      def admin_form_for(resource, options = {}, &block)
-        semantic_form_for(resource, options.merge(builder: ActiveAdmin::FormBuilder), &block)
+      def admin_form_for(resource, options = {}, &)
+        semantic_form_for(resource, options.merge(builder: ActiveAdmin::FormBuilder), &)
       end
     end
   end

data/app/helpers/pageflow/admin/locales_helper.rb

@@ -1,9 +1,17 @@
 module Pageflow
   module Admin
-    module LocalesHelper
+    module LocalesHelper # rubocop:todo Style/Documentation
+      include Pageflow::PublicI18n::LocalesHelper
+
       def available_locales_collection
         Pageflow.config.available_locales.map do |locale|
-          [I18n.t('language', locale: locale), locale.to_s]
+          [I18n.t('language', locale:), locale.to_s]
+        end
+      end
+
+      def available_public_locales_collection
+        Pageflow.config.available_public_locales.map do |locale|
+          [public_locale_name_for(locale), locale.to_s]
         end
       end
     end

data/app/helpers/pageflow/admin/memberships_helper.rb

@@ -1,22 +1,22 @@
 module Pageflow
   module Admin
-    module MembershipsHelper
-      def membership_user_select(f, parent)
-        if f.object.persisted?
-          membership_disabled_select(f, :user, f.object.user, :formal_name)
+    module MembershipsHelper # rubocop:todo Style/Documentation
+      def membership_user_select(form, parent)
+        if form.object.persisted?
+          membership_disabled_select(form, :user, form.object.user, :formal_name)
         elsif parent.is_a?(User)
-          membership_disabled_select(f, :user, parent, :formal_name)
+          membership_disabled_select(form, :user, parent, :formal_name)
         else
           parent_type = parent.class.model_name.singular_route_key
-          membership_select(f, :user, parent, :"potential_users_for_#{parent_type}")
+          membership_select(form, :user, parent, :"potential_users_for_#{parent_type}")
         end
       end
 
-      def membership_entity_select(f, parent, entity_type)
+      def membership_entity_select(form, parent, entity_type)
         if entity_type == 'Pageflow::Entry'
-          membership_entry_select(f, parent)
+          membership_entry_select(form, parent)
         else
-          membership_account_select(f, parent)
+          membership_account_select(form, parent)
         end
       end
 
@@ -35,41 +35,41 @@ module Pageflow
 
       private
 
-      def membership_entry_select(f, parent)
-        if f.object.persisted?
-          membership_disabled_select(f, :entity, f.object.entity, :title)
+      def membership_entry_select(form, parent)
+        if form.object.persisted?
+          membership_disabled_select(form, :entity, form.object.entity, :title)
         elsif parent.is_a?(Entry)
-          membership_disabled_select(f, :entity, parent, :title)
+          membership_disabled_select(form, :entity, parent, :title)
         else
-          membership_select(f, :entry, parent, :potential_entries_for_user)
+          membership_select(form, :entry, parent, :potential_entries_for_user)
         end
       end
 
-      def membership_account_select(f, parent)
-        if f.object.persisted?
-          membership_disabled_select(f, :entity, f.object.entity, :name)
+      def membership_account_select(form, parent)
+        if form.object.persisted?
+          membership_disabled_select(form, :entity, form.object.entity, :name)
         elsif parent.is_a?(Account)
-          membership_disabled_select(f, :entity, parent, :name)
+          membership_disabled_select(form, :entity, parent, :name)
         else
-          membership_select(f, :entity, parent, :potential_accounts_for_user)
+          membership_select(form, :entity, parent, :potential_accounts_for_user)
         end
       end
 
-      def membership_select(f, name, parent, collection_name)
-        f.input(name,
-                as: :searchable_select,
-                ajax: {resource: Membership,
-                       collection_name: collection_name,
-                       params: {parent_id: parent.id}},
-                include_blank: false)
+      def membership_select(form, name, parent, collection_name)
+        form.input(name,
+                   as: :searchable_select,
+                   ajax: {resource: Membership,
+                          collection_name:,
+                          params: {parent_id: parent.id}},
+                   include_blank: false)
       end
 
-      def membership_disabled_select(f, name, record, text_method)
-        f.input(name,
-                as: :searchable_select,
-                collection: [[record.send(text_method), record.id]],
-                include_blank: false,
-                input_html: {disabled: true})
+      def membership_disabled_select(form, name, record, text_method)
+        form.input(name,
+                   as: :searchable_select,
+                   collection: [[record.send(text_method), record.id]],
+                   include_blank: false,
+                   input_html: {disabled: true})
       end
     end
   end

data/app/helpers/pageflow/admin/revisions_helper.rb

@@ -1,6 +1,6 @@
 module Pageflow
   module Admin
-    module RevisionsHelper
+    module RevisionsHelper # rubocop:todo Style/Documentation
       def revision_css_class(revision)
         css_classes = []
         css_classes << 'published' if revision.published?

data/app/helpers/pageflow/admin/sites_helper.rb

@@ -0,0 +1,22 @@
+module Pageflow
+  module Admin
+    # @api private
+    module SitesHelper
+      def site_home_url_hint(site)
+        if site&.persisted?
+          if (root_entry = site.root_entry)
+            t('pageflow.admin.sites.home_url_with_root_entry_hint_html',
+              entry_title: root_entry.title,
+              entry_url: admin_entry_path(root_entry))
+          else
+            t('pageflow.admin.sites.home_url_hint_html',
+              choose_url: admin_site_root_entry_choose_path(site_id: site),
+              new_url: new_admin_entry_path(site_id: site, at: 'root'))
+          end
+        else
+          t('pageflow.admin.sites.home_url_new_site_hint')
+        end
+      end
+    end
+  end
+end

data/app/helpers/pageflow/admin/users_helper.rb

@@ -1,6 +1,6 @@
 module Pageflow
   module Admin
-    module UsersHelper
+    module UsersHelper # rubocop:todo Style/Documentation
       include QuotaHelper
 
       def users_quota_state(account)
@@ -11,13 +11,15 @@ module Pageflow
         }
 
         render('pageflow/admin/users/quota_state',
-               account: account,
-               quota: quota,
-               data_attributes: data_attributes)
+               account:,
+               quota:,
+               data_attributes:)
       end
 
       def collection_for_user_roles
-        User.roles_accessible_by(current_ability).index_by { |role| t(role, :scope => 'pageflow.admin.users.roles') }
+        User.roles_accessible_by(current_ability).index_by do |role|
+          t(role, scope: 'pageflow.admin.users.roles')
+        end
       end
 
       def delete_own_user_section

data/app/helpers/pageflow/admin/widgets_helper.rb

@@ -1,16 +1,16 @@
 module Pageflow
   module Admin
-    module WidgetsHelper
+    module WidgetsHelper # rubocop:todo Style/Documentation
       def admin_widgets_fields(form, config)
         render('pageflow/admin/widgets/fields',
                widgets: form.object.widgets.resolve(config, include_placeholders: true),
-               form: form,
-               config: config)
+               form:,
+               config:)
       end
 
       def admin_widget_types_collection_for_role(config, role)
-        config.widget_types.find_all_by_role(role).each_with_object({}) do |widget_type, result|
-          result[I18n.t(widget_type.translation_key)] = widget_type.name
+        config.widget_types.find_all_by_role(role).to_h do |widget_type|
+          [I18n.t(widget_type.translation_key), widget_type.name]
         end
       end
     end

data/app/helpers/pageflow/asset_urls_helper.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module AssetUrlsHelper
+  module AssetUrlsHelper # rubocop:todo Style/Documentation
     include RenderJsonHelper
 
     def editor_asset_urls

data/app/helpers/pageflow/audio_files_helper.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module AudioFilesHelper
+  module AudioFilesHelper # rubocop:todo Style/Documentation
     include RevisionFileHelper
 
     def audio_file_audio_tag(audio_file_perma_id, options = {})
@@ -10,6 +10,7 @@ module Pageflow
 
       audio_file = find_file_in_entry(AudioFile, audio_file_perma_id)
       return unless audio_file
+
       content_tag(:audio, options) do
         audio_file_sources(audio_file, url_options).each do |source|
           concat(tag(:source, source.slice(:src, :type)))
@@ -20,14 +21,16 @@ module Pageflow
     def audio_file_script_tag(audio_file_perma_id, options = {})
       audio_file = find_file_in_entry(AudioFile, audio_file_perma_id)
       return unless audio_file
+
       render('pageflow/audio_files/script_tag',
-             audio_file: audio_file,
+             audio_file:,
              audio_file_sources: audio_file_sources(audio_file, options))
     end
 
     def audio_file_non_js_link(entry, audio_file_perma_id)
       audio_file = find_file_in_entry(AudioFile, audio_file_perma_id)
       return unless audio_file
+
       link_to(t('pageflow.audio.open'), short_audio_file_path(entry, audio_file))
     end
 

data/app/helpers/pageflow/background_image_helper.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module BackgroundImageHelper
+  module BackgroundImageHelper # rubocop:todo Style/Documentation
     include RevisionFileHelper
 
     def background_image_div(configuration, property_base_name, options = {})
@@ -24,7 +24,7 @@ module Pageflow
       ".load_all_images .#{css_class}, .load_image.#{css_class}"
     end
 
-    class Div
+    class Div # rubocop:todo Style/Documentation
       attr_reader :configuration, :property_base_name, :options
 
       delegate :content_tag, to: :@template
@@ -71,7 +71,7 @@ module Pageflow
 
       def background_position(coord)
         property_name = "#{property_base_name}_#{coord}"
-        configuration.key?(property_name) ? "#{configuration[property_name]}%" : "50%"
+        configuration.key?(property_name) ? "#{configuration[property_name]}%" : '50%'
       end
 
       def file_type
@@ -80,7 +80,7 @@ module Pageflow
       end
     end
 
-    class DivWithSizeAttributes < Div
+    class DivWithSizeAttributes < Div # rubocop:todo Style/Documentation
       include RevisionFileHelper
 
       def data_attributes
@@ -93,7 +93,8 @@ module Pageflow
 
       def inline_style
         if options[:spanning]
-          "padding-top: #{padding_top}%; width: 100%; background-position: 0 0" # fix me (yet disables background_position option)
+          "padding-top: #{padding_top}%; width: 100%; " \
+            'background-position: 0 0' # fix me (yet disables background_position option)
         else
           super
         end
@@ -110,7 +111,7 @@ module Pageflow
       end
 
       def file
-        @file ||= (find_file || :none)
+        @file ||= find_file || :none
         @file == :none ? nil : @file
       end
 

data/app/helpers/pageflow/common_entry_seed_helper.rb

@@ -10,7 +10,9 @@ module Pageflow
       config = Pageflow.config_for(entry)
 
       json.locale entry.locale
-      json.site entry.site.as_json(only: [:privacy_link_url])
+      json.site do
+        json.privacy_link_url entry.legal_info.privacy_url
+      end
       json.enabled_feature_names entry.enabled_feature_names
       json.page_types PageTypesSeed.new(config).as_json
 
@@ -18,7 +20,7 @@ module Pageflow
       json.file_model_types { config_file_model_types_seed(json, config) }
     end
 
-    class PageTypesSeed
+    class PageTypesSeed # rubocop:todo Style/Documentation
       attr_reader :config
 
       def initialize(config)
@@ -26,8 +28,8 @@ module Pageflow
       end
 
       def as_json
-        config.page_types.each_with_object({}) do |page_type, result|
-          result[page_type.name.to_sym] = page_type_seed(page_type)
+        config.page_types.to_h do |page_type|
+          [page_type.name.to_sym, page_type_seed(page_type)]
         end
       end
 
@@ -58,9 +60,7 @@ module Pageflow
       def condition(candidate)
         result = candidate[:unless] || candidate[:if]
 
-        if result
-          result[:negated] = !!candidate[:unless]
-        end
+        result[:negated] = !!candidate[:unless] if result
 
         result
       end

data/app/helpers/pageflow/editor/config_helper.rb

@@ -5,7 +5,9 @@ module Pageflow
       include RenderJsonHelper
 
       def editor_config_seeds(entry)
-        render_json_partial('pageflow/editor/config/seeds', entry: entry)
+        render_json_partial('pageflow/editor/config/seeds',
+                            entry:,
+                            entry_config: Pageflow.config_for(entry))
       end
     end
   end

data/app/helpers/pageflow/editor/files_helper.rb

@@ -11,7 +11,7 @@ module Pageflow
         inner = Pageflow.config.file_types.map { |file_type|
           json = render_json_partial(partial: 'pageflow/editor/files/file',
                                      collection: entry.find_files(file_type.model),
-                                     locals: {file_type: file_type},
+                                     locals: {file_type:},
                                      as: :file)
 
           %("#{file_type.collection_name}": #{json})

data/app/helpers/pageflow/embed_code_helper.rb

@@ -1,17 +1,17 @@
 module Pageflow
-  module EmbedCodeHelper
+  module EmbedCodeHelper # rubocop:todo Style/Documentation
     def embed_code_entry_snippet(entry)
       Pageflow::EmbedCodeHelper::EntrySnippet.new(pageflow, entry)
     end
 
-    class EntrySnippet
+    class EntrySnippet # rubocop:todo Style/Documentation
       def initialize(routes, entry)
         @routes = routes
         @entry = entry
       end
 
       def call
-        %'<iframe src="#{url(entry)}" allowfullscreen></iframe>'
+        %(<iframe src="#{url(entry)}" allowfullscreen></iframe>)
       end
 
       private