pageflow 17.0.5 → 17.2.0

data/lib/pageflow/entry_structured_data_types.rb

@@ -0,0 +1,43 @@
+module Pageflow
+  # Registry for structured data types that can be used in entries.
+  class EntryStructuredDataTypes
+    def initialize
+      @types = {}
+      @default_name = nil
+    end
+
+    # Register a structured data type for entries.
+    #
+    # @param name [Symbol] The name of the structured data type
+    # @param callable [Proc] A lambda that receives a {PublishedEntry} and returns
+    #   a hash of structured data properties including @type
+    # @param options [Hash] Optional configuration
+    # @option options [Boolean] :default (false) Set this type as the default
+    #   when no structured_data_type_name is specified on the entry
+    #
+    # @example
+    #   config.entry_structured_data_types.register(:video_object, lambda do |entry|
+    #     {
+    #       '@type' => 'VideoObject',
+    #       videoSection: 'documentary'
+    #     }
+    #   end, default: true)
+    def register(name, callable, options = {})
+      @types[name.to_s] = callable
+      @default_name = name.to_s if options[:default]
+    end
+
+    # @api private
+    def names
+      @types.keys
+    end
+
+    # @api private
+    def for(entry)
+      structured_data_type =
+        @types[entry.structured_data_type_name] || @types[@default_name]
+
+      structured_data_type ? structured_data_type.call(entry) : {}
+    end
+  end
+end

data/lib/pageflow/entry_type_configuration.rb

@@ -20,6 +20,7 @@ module Pageflow
     delegate :widget_types, to: :@config
     delegate :transform_theme_customization_overrides=, to: :@config
     delegate :transform_theme_customization_files=, to: :@config
+    delegate :entry_structured_data_types, to: :@config
 
     def plugin(plugin)
       plugin.configure(self)

data/lib/pageflow/entry_types.rb

@@ -25,8 +25,8 @@ module Pageflow
     end
 
     # @api private
-    def each(&block)
-      @entry_types_by_name.values.each(&block)
+    def each(&)
+      @entry_types_by_name.values.each(&)
     end
 
     # @api private

data/lib/pageflow/feature.rb

@@ -33,7 +33,7 @@ module Pageflow
     #
     # @param config [Configuration]
     def enable(config)
-      @block.call(config) if @block
+      @block&.call(config)
     end
   end
 end

data/lib/pageflow/features.rb

@@ -27,10 +27,8 @@ module Pageflow
     #
     # @overload register(feature)
     #   @param feature [String]
-    def register(feature, &block)
-      if feature.is_a?(String)
-        return register(Feature.new(feature, &block))
-      end
+    def register(feature, &)
+      return register(Feature.new(feature, &)) if feature.is_a?(String)
 
       if @features.key?(feature.name)
         raise(ArgumentError, "Feature #{feature.name} is already registered.")
@@ -85,8 +83,8 @@ module Pageflow
       end
     end
 
-    def each(&block)
-      @features.values.each(&block)
+    def each(&)
+      @features.values.each(&)
     end
   end
 end

data/lib/pageflow/file_importers.rb

@@ -16,8 +16,8 @@ module Pageflow
       @file_importers = {}
     end
 
-    def each(&block)
-      @file_importers.values.each(&block)
+    def each(&)
+      @file_importers.values.each(&)
     end
 
     def find_by_name!(name)
@@ -26,8 +26,8 @@ module Pageflow
       end
     end
 
-    def fetch_by_name(name, &block)
-      @file_importers.fetch(name, &block)
+    def fetch_by_name(name, &)
+      @file_importers.fetch(name, &)
     end
   end
 end

data/lib/pageflow/file_type.rb

@@ -123,11 +123,11 @@ module Pageflow
       @css_background_image_class_prefix || model.model_name.singular
     end
 
-    def css_background_image_urls_for(file, **options)
+    def css_background_image_urls_for(file, **)
       if call_arity(css_background_image_urls) == 1
         css_background_image_urls.call(file)
       else
-        css_background_image_urls.call(file, **options)
+        css_background_image_urls.call(file, **)
       end
     end
 
@@ -137,7 +137,7 @@ module Pageflow
     end
 
     # @api private
-    alias_method :short_name, :param_key
+    alias short_name param_key
 
     # @api private
     def type_name
@@ -153,8 +153,8 @@ module Pageflow
 
     def convert_custom_attributes_option(custom_attributes)
       if custom_attributes.is_a?(Array)
-        custom_attributes.each_with_object({}) do |attribute_name, result|
-          result[attribute_name] = {permitted_create_param: true}
+        custom_attributes.to_h do |attribute_name|
+          [attribute_name, {permitted_create_param: true}]
         end
       elsif custom_attributes.is_a?(Hash)
         custom_attributes

data/lib/pageflow/file_types.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class FileTypes
+  class FileTypes # rubocop:todo Style/Documentation
     include Enumerable
 
     def initialize
@@ -14,10 +14,10 @@ module Pageflow
       @file_types = []
     end
 
-    def each(&block)
+    def each(&)
       first_level_file_types = trigger_lazy_loading_of_file_types
       lower_level_file_types = search_for_nested_file_types(first_level_file_types)
-      (first_level_file_types + lower_level_file_types).uniq(&:model).each(&block)
+      (first_level_file_types + lower_level_file_types).uniq(&:model).each(&)
     end
 
     def find_by_collection_name!(collection_name)
@@ -35,7 +35,7 @@ module Pageflow
 
     def with_thumbnail_support
       select do |file_type|
-        file_type.model.instance_methods.include?(:thumbnail_url)
+        file_type.model.method_defined?(:thumbnail_url)
       end
     end
 

data/lib/pageflow/global_config_api.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module GlobalConfigApi
+  module GlobalConfigApi # rubocop:todo Style/Documentation
     # The global configuration.
     #
     # Note that all features have been activated for this
@@ -11,11 +11,10 @@ module Pageflow
     # @return [Configuration]
     def config(options = {})
       unless @config
-        if options[:ignore_not_configured]
-          return Configuration.new
-        else
-          raise('Pageflow has not been configured yet')
-        end
+        return Configuration.new if options[:ignore_not_configured]
+
+        raise('Pageflow has not been configured yet')
+
       end
       @config
     end

data/lib/pageflow/help_entries.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class HelpEntries
+  class HelpEntries # rubocop:todo Style/Documentation
     include Enumerable
 
     def initialize
@@ -24,18 +24,18 @@ module Pageflow
       collection = find_collection(options[:parent])
 
       collection << help_entry
-      collection.sort_by! { |help_entry| -help_entry.priority }
+      collection.sort_by! { |entry| -entry.priority }
     end
 
     # @api private
     def flat
-      map do |help_entry|
-        [help_entry, help_entry.children]
-      end.flatten
+      map { |entry|
+        [entry, entry.children]
+      }.flatten
     end
 
-    def each(&block)
-      @help_entries.each(&block)
+    def each(&)
+      @help_entries.each(&)
     end
 
     private

data/lib/pageflow/help_entry.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class HelpEntry
+  class HelpEntry # rubocop:todo Style/Documentation
     attr_reader :name, :children
 
     def initialize(name, options)

data/lib/pageflow/hooks.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class Hooks
+  class Hooks # rubocop:todo Style/Documentation
     def initialize
       @subscribers = Hash.new do |hash, key|
         hash[key] = []

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/oembed_providers.rb

@@ -0,0 +1,42 @@
+module Pageflow
+  # Registry for oEmbed providers that can be used to resolve URLs.
+  class OembedProviders
+    def initialize
+      @providers = {}
+    end
+
+    # Register an oEmbed provider.
+    #
+    # @param name [Symbol] The name of the provider
+    # @param endpoint [String] The oEmbed endpoint URL with {format} placeholder
+    # @param url_patterns [Array<String>] Array of URL patterns the provider can handle
+    #
+    # @example
+    #   config.oembed_providers.register(
+    #     :bluesky,
+    #     endpoint: 'https://bsky.app/oembed.{format}',
+    #     url_patterns: ['https://bsky.app/profile/*/post/*']
+    #   )
+    def register(name, endpoint:, url_patterns:)
+      provider = OEmbed::Provider.new(endpoint)
+      url_patterns.each { |pattern| provider << pattern }
+      @providers[name.to_s] = provider
+    end
+
+    # @api private
+    def find_by_name!(name)
+      @providers.fetch(name.to_s) do
+        raise(OembedProviderNotFoundError, "Unknown oEmbed provider '#{name}'")
+      end
+    end
+
+    # @api private
+    def names
+      @providers.keys
+    end
+  end
+
+  # Error raised when an oEmbed provider is not found
+  class OembedProviderNotFoundError < StandardError
+  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/primary_domain_entry_redirect.rb

@@ -4,6 +4,10 @@ module Pageflow
   #
   # @since 12.4
   class PrimaryDomainEntryRedirect
+    def initialize(ignore_additional_cnames: false)
+      @ignore_additional_cnames = ignore_additional_cnames
+    end
+
     def call(entry, request)
       site = entry.site
 
@@ -16,6 +20,8 @@ module Pageflow
     private
 
     def known_domains(site)
+      return [site.cname] if @ignore_additional_cnames
+
       [
         site.cname,
         (site.additional_cnames || '').split(',').map(&:strip)

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,17 +1,29 @@
 module Pageflow
+  # @api private
   module RailsVersion
     extend self
 
+    SUPPORTED = ['>= 7.2', '< 8.2'].freeze
+    DEFAULT = '~> 7.2.0'.freeze
+
     def detect
-      from_env || '~> 7.1.0'
+      from_env || DEFAULT
+    end
+
+    def requirement
+      experimental? ? [] : SUPPORTED
     end
 
     def experimental?
-      detect != '~> 7.1.0'
+      !Gem::Requirement.new(SUPPORTED).satisfied_by?(requested_version)
     end
 
     private
 
+    def requested_version
+      Gem::Requirement.new(detect).requirements.first.last
+    end
+
     def from_env
       ENV['PAGEFLOW_RAILS_VERSION'] if ENV['PAGEFLOW_RAILS_VERSION'] != ''
     end

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