pageflow 17.0.5 → 17.1.0

data/lib/pageflow/configuration.rb

@@ -187,8 +187,8 @@ module Pageflow
     attr_accessor :public_entry_request_scope
 
     # Either a lambda or an object with a `call` method taking an
-    # {Entry} record and an {ActionDispatch::Request} object and
-    # returning `nil` or a path to redirect to. Can be used in
+    # {PublishedEntry} record and an {ActionDispatch::Request} object
+    # and returning `nil` or a path to redirect to. Can be used in
     # conjuction with {PrimaryDomainEntryRedirect} to make sure
     # entries are accessed via their account's configured cname.
     #
@@ -208,18 +208,76 @@ module Pageflow
     # @return [String]
     attr_accessor :public_entry_cache_control_header
 
+    # Provide additional response headers for published entries.
+    #
+    # @example
+    #
+    #     config.additional_public_entry_headers.register(
+    #       {'Some' => 'value'}
+    #     )
+    #
+    #     config.additional_public_entry_headers.register(
+    #       lambda do |_entry, request|
+    #         {'Some' => request.headers['Other']}
+    #       end
+    #     )
+    #
+    # @return [AdditionalHeaders]
+    # @since 17.1
+    attr_reader :additional_public_entry_headers
+
     # Either a lambda or an object with a `call` method taking a
     # {Site} as paramater and returing a hash of options used to
-    # construct the url of a published entry.
+    # construct the url of a site.
+    #
+    # Can be used to change the host of the url under which entries
+    # and feeds are available.
+    #
+    # If the option is not set, public_entry_url_options is used as a
+    # fallback.
+    #
+    # Example:
+    #
+    #     config.site_url_options = lambda do |site|
+    #       {host: "#{site.account.name}.example.com"}
+    #     end
+    attr_accessor :site_url_options
+
+    # Either a hash, a lambda or an object with a `call` method
+    # returing a hash of options used to construct the url of a
+    # published entry.
     #
     # Can be used to change the host of the url under which entries
     # are available.
     #
+    # If site_url_options is blank, the lambda receives a {Site} as
+    # parameter. This case is only supported for legacy reasons.
+    # Prefer setting site_url_options instead.
+    #
     # Example:
     #
     #     config.public_entry_url_options = lambda do |site|
     #       {host: "#{site.account.name}.example.com"}
     #     end
+    #
+    # If both site_url_options and public_entry_url_options are
+    # present, public_entry_url_options is called exclusively to
+    # construct url options for public entries. The lambda then
+    # receives a {PublishedEntry} to allow for entry specific url
+    # options.
+    #
+    # Example:
+    #
+    #   config.site_url_options = lambda do |site|
+    #     {host: "#{site.account.name}.example.com"}
+    #   end
+    #
+    #   config.public_entry_url_options = lambda do |entry|
+    #     {
+    #       host: "#{entry.site.account.name}.example.com",
+    #       some_entry_specific_param: entry.id
+    #     }
+    #   end
     attr_accessor :public_entry_url_options
 
     # Either a lambda or an object with a `call` method taking a
@@ -227,6 +285,23 @@ module Pageflow
     # construct the embed url of a published entry.
     attr_accessor :entry_embed_url_options
 
+    # Define strategies to determine whether entries should be cut off
+    # (e.g., to preview paywalled premium content).
+    #
+    # @example
+    #
+    #     config.cutoff_modes.register(
+    #       'subscription_header',
+    #       lambda do |_entry, request|
+    #         # Set by some proxy handling user authentication
+    #         request.headers['X-Subscription'] != 'Premium'
+    #       end
+    #     )
+    #
+    # @return [CutoffModes]
+    # @since 17.1
+    attr_reader :cutoff_modes
+
     # Either a lambda or an object with a `call` method taking a hash
     # of theme option overrides and an {EntryAtRevision} and returning
     # a transformed hash of overrides. Can be used to filter overrides
@@ -239,6 +314,14 @@ module Pageflow
     # files based on feature flags and other entry or account traits.
     attr_accessor :transform_theme_customization_files
 
+    # Where to redirect after creating an entry.
+    #
+    # Possible values:
+    #
+    # `:admin`: Go to entry admin page (default)
+    # `:editor`: Open created entry in editor
+    attr_accessor :after_entry_create_redirect_to
+
     # Submit video/audio encoding jobs only after the user has
     # explicitly confirmed in the editor. Can either be set to a
     # boolean or a lambda that is passed the file and returns a
@@ -324,8 +407,7 @@ module Pageflow
     # If you set these to <tt>nil</tt> or <tt>""</tt> the meta tag won't be included.
     # @since 0.10
     attr_accessor :default_keywords_meta_tag
-    attr_accessor :default_author_meta_tag
-    attr_accessor :default_publisher_meta_tag
+    attr_accessor :default_author_meta_tag, :default_publisher_meta_tag
 
     # Share provider defaults.
     #
@@ -381,6 +463,16 @@ module Pageflow
     # @since 12.2
     attr_accessor :news
 
+    # URL to a form that is used to translate an entry via an external service.
+    #
+    # @example
+    #
+    #     config.entry_translator_url = lambda do |entry|
+    #       Rails.application.routes.url_helpers.some_custom_route(entry)
+    #     end
+    # @since 17.1
+    attr_accessor :entry_translator_url
+
     def initialize(target_type_name = nil)
       @target_type_name = target_type_name
 
@@ -425,14 +517,16 @@ module Pageflow
       @css_rendered_thumbnail_styles = Defaults::CSS_RENDERED_THUMBNAIL_STYLES.dup
 
       @site_request_scope = CnameSiteRequestScope.new
-      @public_entry_request_scope = lambda { |entries, request| entries }
-      @public_entry_redirect = ->(_entry, _request) { nil }
-      @public_entry_url_options = Pageflow::SitesHelper::DEFAULT_PUBLIC_ENTRY_OPTIONS
+      @public_entry_request_scope = ->(entries, _request) { entries }
+      @public_entry_redirect = ->(_entry, _request) {}
+      @additional_public_entry_headers = AdditionalHeaders.new
       @entry_embed_url_options = {protocol: 'https'}
+      @cutoff_modes = CutoffModes.new
 
       @transform_theme_customization_overrides = ->(overrides, _entry) { overrides }
       @transform_theme_customization_files = ->(files, _entry) { files }
 
+      @after_entry_create_redirect_to = :admin
       @confirm_encoding_jobs = false
       @default_published_until_duration_in_months = 12
 
@@ -442,7 +536,8 @@ module Pageflow
 
       @available_locales = [:en, :de]
       @available_public_locales = PublicI18n.available_locales
-      @available_share_providers = [:email, :facebook, :linked_in, :twitter, :telegram, :whats_app]
+      @available_share_providers = [:email, :facebook, :linked_in, :bluesky, :threads, :twitter,
+                                    :telegram, :whats_app]
 
       @public_https_mode = :prevent
 
@@ -452,7 +547,7 @@ module Pageflow
 
       @default_share_providers = @available_share_providers
 
-      @authorize_user_deletion = lambda { |_user| true }
+      @authorize_user_deletion = ->(_user) { true }
 
       @available_file_licenses = [
         :cc_by_4, :cc_by_sa_4, :cc_by_nc_4, :cc_by_nc_sa_4, :cc_by_nd_4, :cc_by_nc_nd_4
@@ -489,18 +584,26 @@ module Pageflow
 
     # @deprecated Use `config.page_types.register` instead.
     def register_page_type(page_type)
-      ActiveSupport::Deprecation.warn('Pageflow::Configuration#register_page_type is deprecated. Use config.page_types.register instead.', caller)
+      ActiveSupport::Deprecation.warn(
+        'Pageflow::Configuration#register_page_type is deprecated. ' \
+        'Use config.page_types.register instead.',
+        caller
+      )
       page_types.register(page_type)
     end
 
     # @deprecated Pageflow now supports direct uploads to S3 via signed post requests.
     # Please change your forms accordingly.
     def paperclip_filesystem_root
-      ActiveSupport::Deprecation.warn('Pageflow::Configuration#paperclip_filesystem_root is deprecated.', caller)
+      ActiveSupport::Deprecation.warn(
+        'Pageflow::Configuration#paperclip_filesystem_root is deprecated.', caller
+      )
     end
 
     def paperclip_filesystem_root=(_val)
-      ActiveSupport::Deprecation.warn('Pageflow::Configuration#paperclip_filesystem_root is deprecated.', caller)
+      ActiveSupport::Deprecation.warn(
+        'Pageflow::Configuration#paperclip_filesystem_root is deprecated.', caller
+      )
     end
 
     # Scope configuration to entries of a certain entry type or access
@@ -542,11 +645,27 @@ module Pageflow
     end
 
     # @api private
-    def site_url_options(site)
-      options = public_entry_url_options
+    def site_url_options_for(site)
+      options = site_url_options ||
+                public_entry_url_options ||
+                Pageflow::SitesHelper::DEFAULT_SITE_URL_OPTIONS
+
       options.respond_to?(:call) ? options.call(site) : options
     end
 
+    # @api private
+    def public_entry_url_options_for(entry)
+      return site_url_options_for(entry.site) unless public_entry_url_options
+
+      options = public_entry_url_options
+
+      if options.respond_to?(:call)
+        options.call(site_url_options ? entry : entry.site)
+      else
+        options
+      end
+    end
+
     # @api private
     def enable_features(names)
       features.enable(names, FeatureLevelConfiguration.new(self))
@@ -569,6 +688,10 @@ module Pageflow
       delegate :themes, to: :config
       delegate :widget_types, to: :config
       delegate :public_entry_cache_control_header=, to: :config
+      delegate :additional_public_entry_headers, to: :config
+      delegate :cutoff_modes, to: :config
+      delegate :entry_translator_url=, to: :config
+      delegate :public_entry_url_options=, to: :config
 
       delegate :for_entry_type, to: :config
     end
@@ -580,11 +703,11 @@ module Pageflow
         @entry_type_config = config.get_entry_type_config(entry_type)
       end
 
-      def method_missing(method, *args)
+      def method_missing(method, *)
         if @config.respond_to?(method)
-          @config.send(method, *args)
+          @config.send(method, *)
         elsif @entry_type_config.respond_to?(method)
-          @entry_type_config.send(method, *args)
+          @entry_type_config.send(method, *)
         else
           super
         end

data/lib/pageflow/cutoff_modes.rb

@@ -0,0 +1,39 @@
+module Pageflow
+  # Register strategies to determine whether only the part of an entry
+  # before some cutoff point should be rendered (e.g., to preview
+  # paywalled premium content).
+  # @since 17.1
+  class CutoffModes
+    # @api private
+    def initialize
+      @modes = {}
+    end
+
+    # Register callable to determine whether only the part of an entry
+    # before some cutoff point should be rendered (e.g., to preview
+    # paywalled premium content). Cutoff modes can then be enabled per
+    # site.
+    #
+    # @param name [String]
+    #   Referenced in sites.
+    # @param enabled [#call]
+    #   Take {EntryAtRevision} and {ActionDispatch::Request} and
+    #   return true if the entry shall be cut off.
+    def register(name, enabled)
+      @modes[name.to_s] = Mode.new(name, enabled)
+    end
+
+    # @api private
+    def enabled_for?(entry, request)
+      !!@modes[entry.site.cutoff_mode_name]&.enabled&.call(entry, request)
+    end
+
+    # @api private
+    def names
+      @modes.keys
+    end
+
+    # @api private
+    Mode = Struct.new(:name, :enabled)
+  end
+end

data/lib/pageflow/editor_controller.rb

@@ -13,19 +13,15 @@ module Pageflow
       before_action :authenticate_user!
 
       before_action do
-        begin
-          @entry = DraftEntry.find(params[:entry_id])
-        rescue ActiveRecord::RecordNotFound
-          head :not_found
-        end
+        @entry = DraftEntry.find(params[:entry_id])
+      rescue ActiveRecord::RecordNotFound
+        head :not_found
       end
 
       before_action do
-        begin
-          Ability.new(current_user).authorize!(:update, @entry.to_model)
-        rescue CanCan::AccessDenied
-          head :forbidden
-        end
+        Ability.new(current_user).authorize!(:update, @entry.to_model)
+      rescue CanCan::AccessDenied
+        head :forbidden
       end
 
       before_action :verify_edit_lock

data/lib/pageflow/engine.rb

@@ -23,7 +23,6 @@ require 'backbone-rails'
 require 'marionette-rails'
 require 'jquery-fileupload-rails'
 require 'jquery-minicolors-rails'
-require 'wysihtml/rails'
 require 'i18n-js'
 require 'http_accept_language'
 require 'pageflow-public-i18n'
@@ -35,8 +34,8 @@ require 'symmetric-encryption'
 require 'pageflow/rails_version'
 
 if Gem::Specification.find_all_by_name('pageflow-react', '>= 0.0').any?
-  fail('The pageflow-react gem has been merged into the pageflow gem. ' \
-       'See the pageflow changelog for update instructions.')
+  raise('The pageflow-react gem has been merged into the pageflow gem. ' \
+        'See the pageflow changelog for update instructions.')
 end
 
 module Pageflow
@@ -92,14 +91,14 @@ module Pageflow
 
     # Precompile additional assets.
     initializer 'pageflow.assets.precompile' do |app|
-      app.config.assets.precompile += %w(
+      app.config.assets.precompile += %w[
         pageflow/application_with_simulated_media_queries.css
         pageflow/print_view.css
         pageflow/lt_ie9.js pageflow/lt_ie9.css pageflow/ie9.js pageflow/ie9.css
         pageflow/vendor.js
         pageflow/editor/vendor.js
         video-js.swf vjs.eot vjs.svg vjs.ttf vjs.woff
-      )
+      ]
 
       app.config.assets.precompile << lambda do |path, _filename|
         Pageflow.config.themes.any? do |theme|

data/lib/pageflow/entry_export_import/attachment_files.rb

@@ -36,7 +36,7 @@ module Pageflow
 
       def each_reusable_file(entry, &block)
         Pageflow.config.file_types.each do |file_type|
-          file_type.model.where(entry: entry).each(&block)
+          file_type.model.where(entry:).each(&block)
         end
       end
 

data/lib/pageflow/entry_export_import/entry_serialization.rb

@@ -1,5 +1,6 @@
 module Pageflow
   module EntryExportImport
+    # @api private
     module EntrySerialization
       extend self
 
@@ -50,18 +51,18 @@ module Pageflow
 
       def import_draft(entry_data, options, entry, file_mappings)
         RevisionSerialization.import(entry_data['draft'],
-                                     entry: entry,
+                                     entry:,
                                      creator: options[:creator],
-                                     file_mappings: file_mappings)
+                                     file_mappings:)
       end
 
       def import_last_publication(entry_data, options, entry, file_mappings)
         return unless entry_data['last_publication']
 
         RevisionSerialization.import(entry_data['last_publication'],
-                                     entry: entry,
+                                     entry:,
                                      creator: options[:creator],
-                                     file_mappings: file_mappings)
+                                     file_mappings:)
       end
     end
   end

data/lib/pageflow/entry_export_import/file_mappings.rb

@@ -1,5 +1,6 @@
 module Pageflow
   module EntryExportImport
+    # @api private
     class FileMappings
       def initialize
         @file_mappings = {}

data/lib/pageflow/entry_export_import/revision_serialization/import.rb

@@ -40,7 +40,7 @@ module Pageflow
             revision_attributes['theme_name'] = 'default'
           end
 
-          entry.revisions.create!(revision_attributes.merge(creator: creator)) do |revision|
+          entry.revisions.create!(revision_attributes.merge(creator:)) do |revision|
             revision.published_until = Time.now if revision.published?
           end
         end

data/lib/pageflow/entry_export_import.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  module EntryExportImport
+  module EntryExportImport # rubocop:todo Style/Documentation
     extend self
 
     def export(entry, archive_file_path)
@@ -30,9 +30,9 @@ module Pageflow
     def extract_entry(archive, creator, file_mappings)
       archive.extract_to_tempfile('entry.json') do |tempfile|
         EntrySerialization.import(JSON.parse(tempfile.read),
-                                  creator: creator,
+                                  creator:,
                                   account: creator.accounts.first,
-                                  file_mappings: file_mappings)
+                                  file_mappings:)
       end
     end
 

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

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)

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] = []