pageflow 17.0.5 → 17.1.0

data/lib/pageflow/nested_revision_component.rb

@@ -13,15 +13,6 @@ module Pageflow
         cattr_accessor :nested_revision_component_collection_names, default: []
       end
 
-      # @api private
-      def copy_nested_revision_component_to(record, reset_perma_ids: false)
-        nested_revision_component_collection_names.each do |collection_name|
-          send(collection_name).each do |nested|
-            nested.copy_to(record.send(collection_name), reset_perma_ids: reset_perma_ids)
-          end
-        end
-      end
-
       # Macro methods to declare nested revision components
       module ClassMethods
         # Call this macro in the body of a class which includes
@@ -39,27 +30,18 @@ module Pageflow
     include Container
 
     def duplicate
-      copy_with(reset_perma_ids: true) do |record|
-        yield record if block_given?
-        record.save!
-      end
-    end
-
-    # @api private
-    def copy_to(collection, reset_perma_ids: false)
-      copy_with(reset_perma_ids: reset_perma_ids) do |record|
-        collection << record
-      end
-    end
+      record = dup
+      record.perma_id = nil
 
-    private
+      yield record if block_given?
 
-    def copy_with(reset_perma_ids:)
-      record = dup
-      record.perma_id = nil if reset_perma_ids && record.respond_to?(:perma_id=)
+      record.save!
 
-      yield record
-      copy_nested_revision_component_to(record, reset_perma_ids: reset_perma_ids)
+      NestedRevisionComponentCopy.new(
+        from: self,
+        to: record,
+        reset_perma_ids: true
+      ).perform_for_nested_revision_components
 
       record
     end

data/lib/pageflow/news_item_api.rb

@@ -11,7 +11,7 @@ module Pageflow
     # @since 12.2
     def news_item(name, options)
       after_global_configure do |config|
-        config.news.item(name, options) if config.news
+        config.news&.item(name, options)
       end
     end
   end

data/lib/pageflow/page_type.rb

@@ -63,7 +63,6 @@ module Pageflow
       []
     end
 
-
     # ActiveRecord models to be copied together with a revision.
     #
     # This allows authors of PageTypes to attach models to the Pageflow
@@ -217,12 +216,12 @@ module Pageflow
     #       }
     #     });
     #
-    def json_seed_template
-    end
+    def json_seed_template; end
 
     # Helper method to define the name of a subclassed page type.
     def self.name(name = nil)
       return super() unless name
+
       define_method :name do
         name
       end

data/lib/pageflow/page_types.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class PageTypes
+  class PageTypes # rubocop:todo Style/Documentation
     include Enumerable
 
     def initialize
@@ -28,8 +28,8 @@ module Pageflow
       map(&:name)
     end
 
-    def each(&block)
-      @page_types.each(&block)
+    def each(&)
+      @page_types.each(&)
     end
 
     def setup(config)

data/lib/pageflow/paperclip_interpolations/support.rb

@@ -14,7 +14,7 @@ module Pageflow
       end
 
       def class_basename(attachment, _style)
-        attachment \
+        attachment
           .instance
           .class
           .name

data/lib/pageflow/paperclip_processors/vtt.rb

@@ -3,6 +3,7 @@ require 'fileutils'
 
 module Pageflow
   module PaperclipProcessors
+    # @api private
     class Vtt < Paperclip::Processor
       def make
         destination = make_tempfile_for(file.path)

data/lib/pageflow/paperclip_processors/webp.rb

@@ -29,8 +29,8 @@ module Pageflow
             ANIMATED_FORMATS.include?(@current_format) ? "#{source.path}[n=-1]" : source.path,
             width,
             size: @should_crop ? :both : :down,
-            height: height,
-            crop: crop
+            height:,
+            crop:
           )
           thumbnail.webpsave(destination.path)
         rescue Vips::Error => e

data/lib/pageflow/partial_editor_fragment_renderer.rb

@@ -29,9 +29,9 @@ module Pageflow
     private
 
     def render(partial, entry, format: :html)
-      @renderer.render(partial: partial,
+      @renderer.render(partial:,
                        formats: format,
-                       locals: {entry: entry})
+                       locals: {entry:})
     end
   end
 end

data/lib/pageflow/plugin.rb

@@ -7,7 +7,6 @@ module Pageflow
     # Override to configure Pageflow
     #
     # @param [Configuration] config
-    def configure(config)
-    end
+    def configure(config); end
   end
 end

data/lib/pageflow/quota.rb

@@ -1,6 +1,6 @@
 module Pageflow
-  class Quota
-    class ExhaustedError < RuntimeError
+  class Quota # rubocop:todo Style/Documentation
+    class ExhaustedError < RuntimeError # rubocop:todo Style/Documentation
       attr_reader :quota
 
       def initialize(quota)
@@ -18,7 +18,11 @@ module Pageflow
     end
 
     def state
-      raise(NotImplementedError, 'Quota#state must be implemented and return either "available", "exhausted" or "exceeded".')
+      raise(
+        NotImplementedError,
+        'Quota#state must be implemented and return either ' \
+        '"available", "exhausted" or "exceeded".'
+      )
     end
 
     def state_description
@@ -45,11 +49,11 @@ module Pageflow
       raise(ExceededError.new(self), "Quota '#{name}' exceeded.") if exceeded?
     end
 
-    def assume(assumptions)
+    def assume(_assumptions)
       self
     end
 
-    class Unlimited < Quota
+    class Unlimited < Quota # rubocop:todo Style/Documentation
       def state
         'available'
       end

data/lib/pageflow/quotas.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class Quotas
+  class Quotas # rubocop:todo Style/Documentation
     def initialize
       @factories = HashWithIndifferentAccess.new
     end

data/lib/pageflow/rails_version.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   module RailsVersion
     extend self
 

data/lib/pageflow/react.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module React
+  module React # rubocop:todo Style/Documentation
     # @deprecated Use `PageflowPaged::React.create_page_type` instead.
     def self.create_page_type(name, options = {})
       PageflowPaged::React.create_page_type(name, options)

data/lib/pageflow/revision_component.rb

@@ -8,35 +8,18 @@ module Pageflow
   module RevisionComponent
     extend ActiveSupport::Concern
 
-    ADVISORY_LOCK_TIMEOUT_SECONDS = 5
+    include AutoGeneratedPermaId
+    include NestedRevisionComponent::Container
 
-    class PermaIdGenerationAdvisoryLockTimeout < StandardError; end
+    def entry_for_auto_generated_perma_id
+      revision.entry
+    end
 
     included do
-      include AutoGeneratedPermaId
-      include NestedRevisionComponent::Container
-
       belongs_to :revision, class_name: 'Pageflow::Revision', touch: true
     end
 
-    def copy_to(revision)
-      record = dup
-      record.revision = revision
-      record.save!
-
-      copy_nested_revision_component_to(record)
-    end
-
-    module ClassMethods
-      # Recommended way to create revision components. Uses an
-      # advisory lock to ensure concurrently created records are not
-      # assigned the same perma id.
-      def create_with_lock!(attributes, &block)
-        with_advisory_lock_for_perma_id_generation! do
-          create!(attributes, &block)
-        end
-      end
-
+    module ClassMethods # rubocop:todo Style/Documentation
       def all_for_revision(revision)
         where(revision_id: revision.id)
       end
@@ -44,24 +27,9 @@ module Pageflow
       def from_perma_ids(revision, perma_ids)
         return [] if revision.blank? || perma_ids.blank?
 
-        perma_ids.map do |perma_id|
+        perma_ids.map { |perma_id|
           find_by_revision_id_and_perma_id(revision.id, perma_id)
-        end.compact
-      end
-
-      private
-
-      def with_advisory_lock_for_perma_id_generation!(&block)
-        r = with_advisory_lock_result_for_perma_id_generation(&block)
-        raise(PermaIdGenerationAdvisoryLockTimeout) unless r.lock_was_acquired?
-
-        r.result
-      end
-
-      def with_advisory_lock_result_for_perma_id_generation(&block)
-        with_advisory_lock_result("#{table_name}_perma_id",
-                                  timeout_seconds: ADVISORY_LOCK_TIMEOUT_SECONDS,
-                                  &block)
+        }.compact
       end
     end
   end

data/lib/pageflow/revision_components.rb

@@ -1,18 +1,28 @@
 module Pageflow
-  class RevisionComponents
+  class RevisionComponents # rubocop:todo Style/Documentation
     include Enumerable
 
     def initialize
       @revision_components = []
+      @create_defaults_hooks = []
     end
 
-    def register(revision_component)
-      @revision_components << revision_component unless
-        @revision_components.include?(revision_component)
+    def register(revision_component, create_defaults: false)
+      return if @revision_components.include?(revision_component)
+
+      @revision_components << revision_component
+
+      return unless create_defaults
+
+      @create_defaults_hooks << ->(revision) { revision_component.create_defaults(revision) }
+    end
+
+    def each(&)
+      @revision_components.each(&)
     end
 
-    def each(&block)
-      @revision_components.each(&block)
+    def create_defaults(revision)
+      @create_defaults_hooks.each { |hook| hook.call(revision) }
     end
   end
 end

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,5 +1,5 @@
 module Pageflow
-  class Themes
+  class Themes # rubocop:todo Style/Documentation
     include Enumerable
 
     def initialize
@@ -52,8 +52,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

@@ -34,11 +34,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 +47,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 +66,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.1.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)