pageflow 17.0.5 → 17.2.0

data/lib/pageflow/seeds.rb

@@ -17,7 +17,7 @@ module Pageflow
   #          last_name: 'Doe')
   #   end
   module Seeds
-    DEFAULT_USER_PASSWORD = '!Pass123'
+    DEFAULT_USER_PASSWORD = '!Pass123'.freeze
 
     # Create an {Account} with a default {Site} if no account by
     # that name exists.
@@ -26,7 +26,7 @@ module Pageflow
     # @option attributes [String] :name  required
     # @yield [account] a block to be called before the account is saved
     # @return [Account] newly created account
-    def account(attributes, &block)
+    def account(attributes)
       Account.find_or_create_by!(attributes.slice(:name)) do |account|
         account.attributes = attributes.reverse_merge(name: 'Pageflow')
 
@@ -52,7 +52,7 @@ module Pageflow
     # @param [Hash] attributes  further attributes to override defaults
     # @yield [site] a block which is passed the newly built site
     # @return [Site] newly built site
-    def build_default_site_for(account, attributes = {}, &block)
+    def build_default_site_for(account, attributes = {}, &)
       default_attributes = {
         imprint_link_label: 'Impressum',
         imprint_link_url: 'http://example.com/impressum.html',
@@ -60,7 +60,7 @@ module Pageflow
         copyright_link_url: 'http://www.example.com/copyright.html'
       }
 
-      account.build_default_site(default_attributes.merge(attributes), &block)
+      account.build_default_site(default_attributes.merge(attributes), &)
     end
 
     # Create a {User} if none with the given email exists yet.
@@ -69,7 +69,7 @@ module Pageflow
     # @option attributes [String] :email  required
     # @yield [user] a block to be called before the user is saved
     # @return [User] newly created user
-    def user(attributes, &block)
+    def user(attributes)
       default_attributes = {
         password: default_user_password,
         first_name: 'Elliot',
@@ -146,9 +146,7 @@ module Pageflow
          (attributes[:account].present? && attributes[:entity].present?)
         say_attribute_precedence(':entity', ':entry and :account')
       end
-      unless attributes[:entity].present?
-        entry_or_account_attributes_specified attributes
-      end
+      entry_or_account_attributes_specified attributes unless attributes[:entity].present?
 
       if attributes[:entity].is_a?(Entry) || attributes[:entry].present?
         entry = attributes[:entity] || attributes[:entry]
@@ -173,14 +171,14 @@ module Pageflow
     end
 
     def say_creating_user(user)
-      say(<<-END)
+      say(<<-TEXT)
 
    user with login:
 
    email:     #{user.email}
    password:  #{user.password}
 
-END
+      TEXT
     end
 
     def say_creating_entry(entry)
@@ -188,13 +186,13 @@ END
     end
 
     def say_creating_membership(membership)
-      say("   -- '#{membership.role}' membership for user '#{membership.user.email}' on " +
+      say("   -- '#{membership.role}' membership for user '#{membership.user.email}' on " \
           "#{membership.entity_type == 'Pageflow::Entry' ? 'entry' : 'account'} " +
-          %|'#{if membership.entity_type == "Pageflow::Entry"
+          %('#{if membership.entity_type == 'Pageflow::Entry'
                  membership.entity.title
                else
                  membership.entity.name
-               end}'\n|)
+               end}'\n))
     end
 
     def say_attribute_precedence(subject, object)
@@ -208,9 +206,7 @@ END
     def entry_or_account_attributes_specified(attributes)
       if attributes[:entry].present? || attributes[:account].present?
         attributes[:entity] = attributes[:entry]
-        if attributes[:account].present?
-          say_attribute_precedence(':entry', ':account')
-        end
+        say_attribute_precedence(':entry', ':account') if attributes[:account].present?
       else
         attributes[:entity] = attributes[:account]
       end

data/lib/pageflow/theme.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class Theme
+  class Theme # rubocop:todo Style/Documentation
     attr_reader :name, :directory_name, :options
 
     def initialize(name, options = {})

data/lib/pageflow/theme_customizations.rb

@@ -8,8 +8,8 @@ module Pageflow
     # a specific site.
     def update(site:, entry_type_name:, overrides: {}, file_ids: {})
       ThemeCustomization
-        .find_or_initialize_by(site: site, entry_type_name: entry_type_name)
-        .update!(overrides: overrides, selected_file_ids: file_ids)
+        .find_or_initialize_by(site:, entry_type_name:)
+        .update!(overrides:, selected_file_ids: file_ids)
     end
 
     # Construct an entry that uses the given overrides and files in
@@ -19,15 +19,15 @@ module Pageflow
     def preview(site:, entry:, overrides: {}, file_ids: {})
       theme_customization =
         ThemeCustomization
-        .find_or_initialize_by(site: site, entry_type_name: entry.type_name)
+        .find_or_initialize_by(site:, entry_type_name: entry.type_name)
 
-      theme_customization.assign_attributes(overrides: overrides, selected_file_ids: file_ids)
+      theme_customization.assign_attributes(overrides:, selected_file_ids: file_ids)
 
-      theme = CustomizedTheme.build(entry: entry,
+      theme = CustomizedTheme.build(entry: PublishedEntry.new(entry, entry.draft),
                                     theme: entry.draft.theme,
-                                    theme_customization: theme_customization)
+                                    theme_customization:)
 
-      PublishedEntry.new(entry, entry.draft, theme: theme)
+      PublishedEntry.new(entry, entry.draft, theme:)
     end
 
     # Get customization for entry type and site.
@@ -35,7 +35,7 @@ module Pageflow
     # @return [ThemeCustomization]
     def get(site:, entry_type_name:)
       ThemeCustomization
-        .find_or_initialize_by(site: site, entry_type_name: entry_type_name)
+        .find_or_initialize_by(site:, entry_type_name:)
     end
 
     # Upload a file that shall be used to customize a theme. Uploading
@@ -46,9 +46,9 @@ module Pageflow
     def upload_file(site:, entry_type_name:, type_name:, attachment:)
       theme_customization_file =
         ThemeCustomization
-        .find_or_create_by(site: site, entry_type_name: entry_type_name)
+        .find_or_create_by(site:, entry_type_name:)
         .uploaded_files
-        .build(type_name: type_name)
+        .build(type_name:)
 
       # Assign attachment in separate step to make sure theme
       # customization association (which is used to look up Paperclip

data/lib/pageflow/themes.rb

@@ -1,9 +1,50 @@
 module Pageflow
-  class Themes
+  class Themes # rubocop:todo Style/Documentation
     include Enumerable
 
     def initialize
       @themes = HashWithIndifferentAccess.new
+      @default_options = {}
+      @options_transforms = []
+    end
+
+    # Register default options that apply to all themes. Can be called
+    # multiple times to accumulate defaults from different sources
+    # (gem, plugins, host app). Later calls override earlier ones for
+    # the same keys. Theme options always take precedence over defaults.
+    #
+    # @param options [Hash]
+    #   Default options to deep merge into accumulated defaults.
+    #
+    # @since 17.2
+    def register_default_options(options)
+      @default_options = @default_options.deep_merge(options)
+    end
+
+    # Register a transform that can conditionally modify theme options.
+    # Transforms run after defaults are merged with theme options, so
+    # they can inspect what the theme defines and add conditional defaults.
+    #
+    # @param callable [#call]
+    #   Receives merged options hash, returns transformed options.
+    #   Use for conditional defaults based on what theme defines.
+    #
+    # @since 17.2
+    def register_options_transform(callable)
+      @options_transforms << callable
+    end
+
+    # Apply all registered defaults to theme options.
+    #
+    # @api private
+    def apply_default_options(options, entry:)
+      # First merge hash defaults under theme options (theme wins)
+      result = @default_options.deep_merge(options)
+
+      # Then apply callable transforms (they can see theme options)
+      @options_transforms.reduce(result) do |opts, transform|
+        transform.call(opts, entry:)
+      end
     end
 
     # Register a theme and supply theme options.
@@ -52,8 +93,8 @@ module Pageflow
       map(&:name)
     end
 
-    def each(&block)
-      @themes.values.each(&block)
+    def each(&)
+      @themes.values.each(&)
     end
   end
 end

data/lib/pageflow/user_mixin.rb

@@ -23,10 +23,22 @@ module Pageflow
 
       has_many :revisions, class_name: 'Pageflow::Revision', foreign_key: :creator_id
 
+      has_many :comment_thread_reads,
+               dependent: :destroy,
+               class_name: 'Pageflow::CommentThreadRead'
+
       validates :first_name, :last_name, presence: true
       validates_inclusion_of :locale, in: Pageflow.config.available_locales.map(&:to_s)
 
       scope :admins, -> { where(admin: true) }
+
+      before_create :ensure_unread_comments_since_at
+    end
+
+    # Comments predating a user are not new to them. Without a baseline,
+    # joining would mean facing every comment ever written as unread.
+    def ensure_unread_comments_since_at
+      self.unread_comments_since_at ||= Time.current
     end
 
     def admin?
@@ -34,11 +46,11 @@ module Pageflow
     end
 
     def full_name
-      [first_name, last_name] * ' '
+      [first_name, last_name].join(' ')
     end
 
     def formal_name
-      [last_name, first_name] * ', '
+      [last_name, first_name].join(', ')
     end
 
     def locale
@@ -47,7 +59,7 @@ module Pageflow
 
     def update_with_password(attributes)
       if needs_password?(attributes)
-        super(attributes)
+        super
       else
         # remove the virtual current_password attribute update_without_password
         # doesn't know how to ignore it
@@ -66,11 +78,11 @@ module Pageflow
     end
 
     # Configure devise to send emails using ActiveJob.
-    def send_devise_notification(notification, *args)
-      devise_mailer.send(notification, self, *args).deliver_later
+    def send_devise_notification(notification, *)
+      devise_mailer.send(notification, self, *).deliver_later
     end
 
-    module ClassMethods
+    module ClassMethods # rubocop:todo Style/Documentation
       def ransackable_attributes(_auth_object = nil)
         %w[first_name last_name email]
       end

data/lib/pageflow/version.rb

@@ -1,3 +1,3 @@
 module Pageflow
-  VERSION = '17.0.5'.freeze
+  VERSION = '17.2.0'.freeze
 end

data/lib/pageflow/widget_type.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class WidgetType
+  class WidgetType # rubocop:todo Style/Documentation
     class NotFoundError < RuntimeError
     end
 
@@ -44,7 +44,7 @@ module Pageflow
 
     # Override to return html as string.
     def render(template, entry)
-      template.render(File.join('pageflow', name, 'widget'), entry: entry)
+      template.render(File.join('pageflow', name, 'widget'), entry:)
     end
 
     # Override instead of render_head_fragment to use the widget
@@ -56,11 +56,11 @@ module Pageflow
 
     # Override to return html that should be placed in the head
     # element of the page. Not supported inside the editor.
-    def render_head_fragment(template, entry)
+    def render_head_fragment(_template, _entry)
       ''
     end
 
-    class Null < WidgetType
+    class Null < WidgetType # rubocop:todo Style/Documentation
       def initialize(role)
         @role = role
       end

data/lib/pageflow/widget_types.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class WidgetTypes
+  class WidgetTypes # rubocop:todo Style/Documentation
     include Enumerable
 
     attr_reader :defaults_by_role
@@ -10,10 +10,10 @@ module Pageflow
 
     def register(widget_type, options = {})
       @widget_types[widget_type.name] = widget_type
-      if options[:default]
-        widget_type.roles.each do |role|
-          defaults_by_role[role] = widget_type
-        end
+      return unless options[:default]
+
+      widget_type.roles.each do |role|
+        defaults_by_role[role] = widget_type
       end
     end
 
@@ -27,8 +27,8 @@ module Pageflow
       @default_configurations = {}
     end
 
-    def each(&block)
-      @widget_types.values.each(&block)
+    def each(&)
+      @widget_types.values.each(&)
     end
 
     def find_by_name!(name)
@@ -37,8 +37,8 @@ module Pageflow
       end
     end
 
-    def fetch_by_name(name, &block)
-      @widget_types.fetch(name, &block)
+    def fetch_by_name(name, &)
+      @widget_types.fetch(name, &)
     end
 
     def type_name?(name)

data/lib/pageflow/zencoder_api.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class ZencoderApi
     class Error < StandardError; end
     class RecoverableError < Error; end
@@ -6,13 +7,11 @@ module Pageflow
 
     def create_job(definition)
       with_exception_translation do
-        response = Zencoder::Job.create(:input => definition.input_s3_url,
-                                        :outputs => definition.outputs)
-        if response.success?
-          response.body['id']
-        else
-          raise translate_zencoder_errors(response.errors)
-        end
+        response = Zencoder::Job.create(input: definition.input_s3_url,
+                                        outputs: definition.outputs)
+        raise translate_zencoder_errors(response.errors) unless response.success?
+
+        response.body['id']
       end
     end
 
@@ -20,15 +19,13 @@ module Pageflow
       with_exception_translation do
         response = Zencoder::Job.progress(job_id)
 
-        if response.success?
-          {
-            :state => response.body["state"],
-            :progress => response.body["progress"],
-            :finished => response.body["state"] == 'finished'
-          }
-        else
-          raise translate_zencoder_errors(response.errors)
-        end
+        raise translate_zencoder_errors(response.errors) unless response.success?
+
+        {
+          state: response.body['state'],
+          progress: response.body['progress'],
+          finished: response.body['state'] == 'finished'
+        }
       end
     end
 
@@ -37,31 +34,26 @@ module Pageflow
       get_details(job_id)
     end
 
-    def get_details(job_id)
+    def get_details(job_id) # rubocop:todo Metrics/AbcSize
       with_exception_translation do
         response = Zencoder::Job.details(job_id)
 
-        if response.success?
-          input_details = response.body['job']['input_media_file']
-          outputs_details = response.body['job']['output_media_files']
+        raise translate_zencoder_errors(response.errors) unless response.success?
 
-          output_presences = outputs_details.inject({}) do |presences, output|
-            if output['label'].present?
-              presences[output['label'].to_sym] = output['state']
-            end
-            presences
-          end
+        input_details = response.body['job']['input_media_file']
+        outputs_details = response.body['job']['output_media_files']
 
-          {
-            format: input_details['format'],
-            duration_in_ms: input_details['duration_in_ms'],
-            width: input_details['width'],
-            height: input_details['height'],
-            output_presences: output_presences
-          }
-        else
-          raise translate_zencoder_errors(response.errors)
+        output_presences = outputs_details.each_with_object({}) do |output, presences|
+          presences[output['label'].to_sym] = output['state'] if output['label'].present?
         end
+
+        {
+          format: input_details['format'],
+          duration_in_ms: input_details['duration_in_ms'],
+          width: input_details['width'],
+          height: input_details['height'],
+          output_presences:
+        }
       end
     end
 
@@ -72,13 +64,11 @@ module Pageflow
     private
 
     def with_exception_translation
-      begin
-        yield
-      rescue Timeout::Error
-        raise RecoverableError, 'Zencoder timed out.'
-      rescue Zencoder::HTTPError => e
-        raise RecoverableError, e.message
-      end
+      yield
+    rescue Timeout::Error
+      raise RecoverableError, 'Zencoder timed out.'
+    rescue Zencoder::HTTPError => e
+      raise RecoverableError, e.message
     end
 
     def translate_zencoder_errors(errors)

data/lib/pageflow/zencoder_audio_output_definition.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class ZencoderAudioOutputDefinition < ZencoderOutputDefinition
     attr_reader :audio_file
 
@@ -23,11 +24,11 @@ module Pageflow
 
     def m4a_definition
       {
-        :label => 'm4a',
-        :format => 'm4a',
-        :path => audio_file.m4a.path,
-        :public => 1,
-        :headers => {
+        label: 'm4a',
+        format: 'm4a',
+        path: audio_file.m4a.path,
+        public: 1,
+        headers: {
           'Content-Type' => 'audio/mp4'
         }
       }
@@ -35,19 +36,19 @@ module Pageflow
 
     def mp3_definition
       {
-        :label => 'mp3',
-        :format => 'mp3',
-        :path => audio_file.mp3.path,
-        :public => 1
+        label: 'mp3',
+        format: 'mp3',
+        path: audio_file.mp3.path,
+        public: 1
       }
     end
 
     def ogg_definition
       {
-        :label => 'ogg',
-        :format => 'ogg',
-        :path => audio_file.ogg.path,
-        :public => 1
+        label: 'ogg',
+        format: 'ogg',
+        path: audio_file.ogg.path,
+        public: 1
       }
     end
   end

data/lib/pageflow/zencoder_meta_data_output_definition.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class ZencoderMetaDataOutputDefinition < ZencoderOutputDefinition
     attr_reader :file
 
@@ -14,8 +15,8 @@ module Pageflow
     def outputs
       [
         {
-          :label => 'stub',
-          :clip_length => 1
+          label: 'stub',
+          clip_length: 1
         }
       ]
     end

data/lib/pageflow/zencoder_output_definition.rb

@@ -1,6 +1,8 @@
 module Pageflow
+  # @api private
   class ZencoderOutputDefinition
-    cattr_accessor :default_output_bucket_name, :default_sftp_host, :default_akamai_host, :default_akamai_credentials
+    cattr_accessor :default_output_bucket_name, :default_sftp_host, :default_akamai_host,
+                   :default_akamai_credentials
 
     attr_accessor :options
 
@@ -9,11 +11,11 @@ module Pageflow
     end
 
     def input_s3_url
-      raise "Not implemented"
+      raise 'Not implemented'
     end
 
     def outputs
-      raise "Not implemented"
+      raise 'Not implemented'
     end
 
     def ==(other)
@@ -21,9 +23,9 @@ module Pageflow
         other.input_s3_url == input_s3_url &&
         other.outputs == outputs
     end
-    alias_method :eql?, :==
+    alias eql? ==
 
-      protected
+    protected
 
     def transferable(definition)
       if akamai_configured?
@@ -42,9 +44,7 @@ module Pageflow
     end
 
     def with_credentials(definition)
-      if akamai_configured?
-        definition[:credentials] = akamai_credentials
-      end
+      definition[:credentials] = akamai_credentials if akamai_configured?
 
       definition
     end
@@ -58,7 +58,7 @@ module Pageflow
     end
 
     def sftp_url(path)
-      "#{File.join(sftp_host, path)}"
+      File.join(sftp_host, path).to_s
     end
 
     def sftp_host
@@ -70,7 +70,7 @@ module Pageflow
     end
 
     def akamai_url(path)
-      "#{File.join(akamai_host, path)}"
+      File.join(akamai_host, path).to_s
     end
 
     def akamai_host
@@ -89,11 +89,12 @@ module Pageflow
 
     def sftp_transfer_definition(definition)
       return unless sftp_configured?
+
       {
-        :label => "sftp_transfer_#{definition[:label]}",
-        :source => definition[:label],
-        :type => 'transfer-only',
-        :url => sftp_url(definition[:path])
+        label: "sftp_transfer_#{definition[:label]}",
+        source: definition[:label],
+        type: 'transfer-only',
+        url: sftp_url(definition[:path])
       }
     end
 
@@ -105,6 +106,7 @@ module Pageflow
 
     def sftp_definition(source_defintion)
       return unless sftp_configured?
+
       source_defintion.dup.tap do |definiton|
         definiton[:label] = "sftp_#{definiton[:label]}"
         definiton[:url] = sftp_url(definiton.delete(:path))