pageflow 17.1.0 → 17.2.0

data/lib/pageflow/file_types.rb

@@ -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/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/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/rails_version.rb

@@ -3,16 +3,27 @@ module Pageflow
   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/themes.rb

@@ -4,6 +4,47 @@ module Pageflow
 
     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.

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?

data/lib/pageflow/version.rb

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

data/lib/pageflow.rb

@@ -2,6 +2,7 @@ require 'pageflow/engine'
 require 'pageflow/global_config_api'
 require 'pageflow/news_item_api'
 require 'pageflow/version'
+require 'pageflow/deprecation'
 
 module Pageflow # rubocop:todo Style/Documentation
   extend GlobalConfigApi

data/package/config/eslint-rules/documented-in-toc.js

@@ -0,0 +1,125 @@
+const fs = require('fs');
+const path = require('path');
+const yaml = require('js-yaml');
+
+// JSDoc comments on these are either nested under another item or
+// excluded from the generated docs, so they do not need toc entries.
+const skippedTags = /@(private|internal|ignore|memberof)\b/;
+
+module.exports = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description:
+        'Ensure JSDoc documented top level items are listed in the toc ' +
+        'of documentation.yml. Otherwise they render at an arbitrary ' +
+        'spot at the end of the generated docs.'
+    },
+    schema: []
+  },
+
+  create(context) {
+    const config = findTocConfig(path.dirname(context.getFilename()));
+
+    if (!config) {
+      return {};
+    }
+
+    const sourceCode = context.getSourceCode();
+
+    return {
+      Program(program) {
+        program.body.forEach(statement => {
+          const comment = jsdocCommentBefore(statement);
+
+          if (!comment || skippedTags.test(comment.value)) {
+            return;
+          }
+
+          const name = documentedName(comment, statement);
+
+          if (name && !config.names.has(name)) {
+            context.report({
+              loc: comment.loc,
+              message:
+                `'${name}' has a JSDoc comment, but is not listed in the ` +
+                `toc in ${config.relativePath}. Add it to the section ` +
+                'where it should show up in the generated docs.'
+            });
+          }
+        });
+      }
+    };
+
+    function jsdocCommentBefore(statement) {
+      const comments = sourceCode.getCommentsBefore(statement);
+      const comment = comments[comments.length - 1];
+
+      return comment &&
+             comment.type === 'Block' &&
+             comment.value.startsWith('*') ? comment : null;
+    }
+  }
+};
+
+function documentedName(comment, statement) {
+  const tagMatch = comment.value.match(/@(?:name|alias)\s+([\w.#]+)/);
+
+  if (tagMatch) {
+    return tagMatch[1];
+  }
+
+  return declaredName(statement);
+}
+
+function declaredName(statement) {
+  switch (statement.type) {
+  case 'ExportNamedDeclaration':
+  case 'ExportDefaultDeclaration':
+    return statement.declaration && declaredName(statement.declaration);
+  case 'FunctionDeclaration':
+  case 'ClassDeclaration':
+    return statement.id && statement.id.name;
+  case 'VariableDeclaration':
+    return statement.declarations[0].id.type === 'Identifier' ?
+           statement.declarations[0].id.name : null;
+  default:
+    return null;
+  }
+}
+
+const configCache = new Map();
+
+function findTocConfig(directory) {
+  if (configCache.has(directory)) {
+    return configCache.get(directory);
+  }
+
+  const configPath = path.join(directory, 'documentation.yml');
+  let config;
+
+  if (fs.existsSync(configPath)) {
+    config = loadTocConfig(configPath);
+  }
+  else {
+    const parent = path.dirname(directory);
+    config = parent === directory ? null : findTocConfig(parent);
+  }
+
+  configCache.set(directory, config);
+  return config;
+}
+
+function loadTocConfig(configPath) {
+  const toc = yaml.safeLoad(fs.readFileSync(configPath, 'utf8')).toc || [];
+  const names = new Set();
+
+  toc.forEach(section =>
+    (section.children || []).forEach(child => names.add(child))
+  );
+
+  return {
+    names,
+    relativePath: path.relative(process.cwd(), configPath)
+  };
+}

data/package/config/jest/index.js

@@ -13,7 +13,6 @@ module.exports = {
   moduleNameMapper: {
     '^jquery$': resolve('../../vendor/jquery'),
     '^jquery-ui$': resolve('../../vendor/jquery-ui'),
-    '^jquery.minicolors$': resolve('../../vendor/jquery.minicolors'),
     '^backbone.marionette$': resolve('../../vendor/backbone.marionette'),
     '^backbone.babysitter$': resolve('../../vendor/backbone.babysitter'),
     '^backbone$': resolve('../../vendor/backbone'),

data/package/config/webpack.js

@@ -5,7 +5,6 @@ module.exports = {
     'cocktail': 'Cocktail',
     'jquery': 'jQuery',
     'jquery-ui': 'jQuery',
-    'jquery.minicolors': 'jQuery',
     'underscore': '_',
     'backbone.marionette': 'Backbone.Marionette',
     'iscroll': 'IScroll',

data/package/config/webpack5.js

@@ -5,7 +5,6 @@ module.exports = {
     'cocktail': 'Cocktail',
     'jquery': 'jQuery',
     'jquery-ui': 'jQuery',
-    'jquery.minicolors': 'jQuery',
     'underscore': '_',
     'backbone.marionette': 'Backbone.Marionette',
     'iscroll': 'IScroll',