pageflow 14.5.2 → 15.0.0.beta1

data/app/assets/stylesheets/pageflow/themes/default/player_controls/classic/info_box.scss

@@ -78,11 +78,6 @@ $classic-player-controls-info-box-border-radius: 4px !default;
 
   .js &-info_box {
     pointer-events: none;
-
-    a {
-      pointer-events: all;
-    }
-
     margin: 0;
     margin-bottom: 60px + $classic-player-controls-border-width * 4;
     width: 434px;

data/app/assets/stylesheets/pageflow/themes/default/player_controls/slim/info_box.scss

@@ -73,10 +73,6 @@ $slim-player-controls-info-box-header-typography: () !default;
     @include transition(opacity 0.2s linear, visibility 0.2s linear, transform 0.2s ease);
     pointer-events: none;
 
-    a {
-      pointer-events: all;
-    }
-
     position: absolute;
     left: 50%;
     @include transform(translate3d(-50%, 0, 0));

data/app/controllers/pageflow/files_controller.rb

@@ -8,10 +8,10 @@ module Pageflow
     def show
       respond_to do |format|
         format.html do
-          entry = PublishedEntry.find(params[:entry_id], entry_request_scope)
-          @file = entry.find_file(file_type.model, params[:id])
+          @entry = PublishedEntry.find(params[:entry_id], entry_request_scope)
+          @file = @entry.find_file(file_type.model, params[:id])
 
-          check_entry_password_protection(entry)
+          check_entry_password_protection(@entry)
         end
       end
     end

data/app/helpers/pageflow/audio_files_helper.rb

@@ -1,32 +1,34 @@
 module Pageflow
   module AudioFilesHelper
-    def audio_file_audio_tag(audio_file_id, options = {})
+    include RevisionFileHelper
+
+    def audio_file_audio_tag(audio_file_perma_id, options = {})
       options.merge!(class: ['audio-js', options.delete(:class)].compact * ' ',
                      controls: true,
                      preload: 'none')
       url_options = {unique_id: options.delete(:unique_id)}
 
-      if (audio_file = AudioFile.find_by_id(audio_file_id))
-        content_tag(:audio, options) do
-          audio_file_sources(audio_file, url_options).each do |source|
-            concat(tag(:source, source.slice(:src, :type)))
-          end
+      audio_file = find_file_in_entry(AudioFile, audio_file_perma_id)
+      return unless audio_file
+      content_tag(:audio, options) do
+        audio_file_sources(audio_file, url_options).each do |source|
+          concat(tag(:source, source.slice(:src, :type)))
         end
       end
     end
 
-    def audio_file_script_tag(audio_file_id, options = {})
-      if (audio_file = AudioFile.find_by_id(audio_file_id))
-        render('pageflow/audio_files/script_tag',
-               audio_file: audio_file,
-               audio_file_sources: audio_file_sources(audio_file, options))
-      end
+    def audio_file_script_tag(audio_file_perma_id, options = {})
+      audio_file = find_file_in_entry(AudioFile, audio_file_perma_id)
+      return unless audio_file
+      render('pageflow/audio_files/script_tag',
+             audio_file: audio_file,
+             audio_file_sources: audio_file_sources(audio_file, options))
     end
 
-    def audio_file_non_js_link(entry, audio_file_id)
-      if (audio_file = AudioFile.find_by_id(audio_file_id))
-        link_to(t('pageflow.audio.open'), short_audio_file_path(entry, audio_file))
-      end
+    def audio_file_non_js_link(entry, audio_file_perma_id)
+      audio_file = find_file_in_entry(AudioFile, audio_file_perma_id)
+      return unless audio_file
+      link_to(t('pageflow.audio.open'), short_audio_file_path(entry, audio_file))
     end
 
     def audio_file_sources(audio_file, options = {})

data/app/helpers/pageflow/background_image_helper.rb

@@ -1,33 +1,36 @@
 module Pageflow
   module BackgroundImageHelper
+    include RevisionFileHelper
+
     def background_image_div(configuration, property_base_name, options = {})
-      Div.new(self, configuration, property_base_name, options).render
+      Div.new(@entry, self, configuration, property_base_name, options).render
     end
 
     def background_image_div_with_size(configuration, property_base_name, options = {})
-      DivWithSizeAttributes.new(self, configuration, property_base_name, options).render
+      DivWithSizeAttributes.new(@entry, self, configuration, property_base_name, options).render
     end
 
-    def background_image_tag(image_id, options = {})
-      image = ImageFile.find_by_id(image_id)
-      if image&.ready?
-        options = options.merge(:'data-src' => image.attachment.url(:medium))
-        options = options.merge(:'data-printsrc' => image.attachment.url(:print))
-        image_tag('', options)
-      end
+    def background_image_tag(image_perma_id, options = {})
+      image = find_file_in_entry(ImageFile, image_perma_id)
+      return unless image&.ready?
+
+      options = options.merge('data-src': image.attachment.url(:medium))
+      options = options.merge('data-printsrc': image.attachment.url(:print))
+      image_tag('', options)
     end
 
     def background_image_lazy_loading_css_class(prefix, model)
-      css_class = [prefix, model.id].join('_')
+      css_class = [prefix, model.perma_id].join('_')
       ".load_all_images .#{css_class}, .load_image.#{css_class}"
     end
 
     class Div
       attr_reader :configuration, :property_base_name, :options
 
-      delegate :content_tag, :to => :@template
+      delegate :content_tag, to: :@template
 
-      def initialize(template, configuration, property_base_name, options)
+      def initialize(entry, template, configuration, property_base_name, options)
+        @entry = entry
         @template = template
         @configuration = configuration
         @property_base_name = property_base_name
@@ -35,7 +38,7 @@ module Pageflow
       end
 
       def render
-        content_tag(:div, '', :class => css_class, :style => inline_style, :data => data_attributes)
+        content_tag(:div, '', class: css_class, style: inline_style, data: data_attributes)
       end
 
       protected
@@ -44,7 +47,7 @@ module Pageflow
         options.slice(:style_group)
       end
 
-      def file_id
+      def file_perma_id
         configuration["#{property_base_name}_id"]
       end
 
@@ -59,7 +62,7 @@ module Pageflow
       end
 
       def image_css_class
-        [image_css_class_prefix, options[:style_group], file_id || 'none'].compact.join('_')
+        [image_css_class_prefix, options[:style_group], file_perma_id || 'none'].compact.join('_')
       end
 
       def image_css_class_prefix
@@ -78,9 +81,11 @@ module Pageflow
     end
 
     class DivWithSizeAttributes < Div
+      include RevisionFileHelper
+
       def data_attributes
         if file
-          super.merge(:width => file.width, :height => file.height)
+          super.merge(width: file.width, height: file.height)
         else
           super
         end
@@ -110,7 +115,7 @@ module Pageflow
       end
 
       def find_file
-        file_type.model.find_by_id(file_id)
+        find_file_in_entry(file_type.model, file_perma_id)
       end
     end
   end

data/app/helpers/pageflow/entry_json_seed_helper.rb

@@ -50,13 +50,13 @@ module Pageflow
 
     def entry_file_ids_seed(entry)
       Pageflow.config.file_types.with_thumbnail_support.each_with_object({}) do |file_type, result|
-        result[file_type.collection_name] = entry.find_files(file_type.model).map(&:id)
+        result[file_type.collection_name] = entry.find_files(file_type.model).map(&:perma_id)
       end
     end
 
     def entry_audio_files_json_seed(entry)
-      seed = entry.audio_files.each_with_object({}) do |audio_file, result|
-        result[audio_file.id] = audio_file_sources(audio_file)
+      seed = entry.find_files(AudioFile).each_with_object({}) do |audio_file, result|
+        result[audio_file.perma_id] = audio_file_sources(audio_file)
       end
 
       sanitize_json(seed.to_json).html_safe

data/app/helpers/pageflow/file_thumbnails_helper.rb

@@ -12,7 +12,7 @@ module Pageflow
 
     def file_thumbnail_css_class(file, style)
       return if file.blank?
-      [file.to_model.class.model_name.singular, style, file.to_model.id] * '_'
+      [file.to_model.class.model_name.singular, style, file.perma_id] * '_'
     end
   end
 end

data/app/helpers/pageflow/meta_tags_helper.rb

@@ -7,9 +7,9 @@ module Pageflow
 
     def meta_tags_data_for_entry(entry)
       {
-        keywords: entry.keywords.presence,
-        author: entry.author.presence,
-        publisher: entry.publisher.presence
+        keywords: entry.keywords.presence || Pageflow.config.default_keywords_meta_tag,
+        author: entry.author.presence || Pageflow.config.default_author_meta_tag,
+        publisher: entry.publisher.presence || Pageflow.config.default_publisher_meta_tag
       }
     end
   end

data/app/helpers/pageflow/pages_helper.rb

@@ -88,7 +88,16 @@ module Pageflow
     end
 
     def page_thumbnail_image_class(page, hero)
-      file_thumbnail_css_class(page.thumbnail_file, hero ? :link_thumbnail_large : :link_thumbnail)
+      file_thumbnail_css_class(page_thumbnail_file(page), hero ? :link_thumbnail_large : :link_thumbnail)
+    end
+
+    def page_thumbnail_url(page, *args)
+      page_thumbnail_file(page).thumbnail_url(*args)
+    end
+
+    def page_thumbnail_file(page)
+      ThumbnailFileResolver.new(@entry, page.page_type.thumbnail_candidates, page.configuration)
+                           .find_thumbnail
     end
   end
 end

data/app/helpers/pageflow/revision_file_helper.rb

@@ -0,0 +1,27 @@
+module Pageflow
+  module RevisionFileHelper
+    # Instead of finding a file directly by its ID (stored in configuration hashes for example),
+    # finds the file by its usages perma_id within the scope of the revisions usages.
+    # The @entry instance variable (of type DraftEntry or PublishedEntry)
+    # must always be available in views using this helper, otherwise an exception is raised.
+    #
+    # When testing helpers which use the RevisionFileHelper to find their respective files,
+    # you can use the UsedfileTestHelper to create the file. This will set the @entry-variable
+    # and create a file usage for the file:
+    #
+    #     image_file = create_used_file(:image_file)
+    #
+    # This simplifies spec setup by eliminating the need to set up the entry and usages first.
+    # If you need to setup the entry explicitely, you can optionally pass it to the helper like so:
+    #
+    #     entry = PublishedEntry.new(create(:entry, :published))
+    #     image_file = create_used_file(:image_file, entry: entry)
+    #
+    # @since 15.0
+    # @returns UsedFile
+    def find_file_in_entry(file_type, file_perma_id)
+      raise 'No entry of type PublishedEntry or DraftEntry set.' unless @entry.present?
+      @entry.find_file_by_perma_id(file_type, file_perma_id)
+    end
+  end
+end

data/app/helpers/pageflow/social_share_helper.rb

@@ -1,6 +1,8 @@
 module Pageflow
   module SocialShareHelper
     include EntriesHelper
+    include PagesHelper
+    include RevisionFileHelper
 
     def social_share_meta_tags_for(target)
       if target.is_a?(Page)
@@ -53,7 +55,7 @@ module Pageflow
 
     def social_share_entry_image_tags(entry)
       image_urls = []
-      image_file = ImageFile.find_by_id(entry.share_image_id)
+      image_file = find_file_in_entry(ImageFile, entry.share_image_id)
 
       if image_file
         image_urls << image_file.thumbnail_url(:medium)
@@ -62,13 +64,13 @@ module Pageflow
           if image_urls.size >= 4
             break
           else
-            image_urls << page.thumbnail_url(:medium)
+            image_urls << page_thumbnail_url(page, :medium)
             image_urls.uniq!
           end
         end
       end
 
-      render 'pageflow/social_share/image_tags', :image_urls => image_urls
+      render 'pageflow/social_share/image_tags', image_urls: image_urls
     end
 
     def social_share_normalize_protocol(url)

data/app/helpers/pageflow/social_share_links_helper.rb

@@ -8,7 +8,7 @@ module Pageflow
       google: 'https://plus.google.com/share?url=%{url}',
       linked_in: 'https://www.linkedin.com/shareArticle?mini=true&url=%{url}',
       telegram: 'tg://msg?text=%{url}',
-      twitter: 'https://twitter.com/intent/tweet?url=%{url}',
+      twitter: 'http://twitter.com/home?status=%{url}',
       whats_app: 'WhatsApp://send?text=%{url}'
     }.freeze
 

data/app/helpers/pageflow/video_files_helper.rb

@@ -1,5 +1,7 @@
 module Pageflow
   module VideoFilesHelper
+    include RevisionFileHelper
+
     def mobile_poster_image_div(config = {})
       classes = ['background', 'background_image']
       position = {x: 50, y: 50}
@@ -25,9 +27,9 @@ module Pageflow
                   style: "background-position: #{position[:x]}% #{position[:y]}%;")
     end
 
-    def poster_image_tag(video_id, poster_image_id, options = {})
-      video_file = VideoFile.find_by_id(video_id)
-      poster = ImageFile.find_by_id(poster_image_id)
+    def poster_image_tag(video_file_perma_id, poster_image_perma_id = nil, options = {})
+      video_file = find_file_in_entry(VideoFile, video_file_perma_id)
+      poster = poster_image_perma_id.present? ? find_file_in_entry(ImageFile, poster_image_perma_id) : nil
 
       if poster&.ready?
         options = options.merge('data-src' => poster.attachment.url(:medium))
@@ -53,8 +55,10 @@ module Pageflow
       options.reverse_merge! defaults
       url_options = {unique_id: options.delete(:unique_id)}
 
-      poster = ImageFile.find_by_id(options.delete(:poster_image_id))
-      mobile_poster = ImageFile.find_by_id(options.delete(:mobile_poster_image_id))
+      poster_image_id = options.delete(:poster_image_id)
+      poster = poster_image_id.present? ? find_file_in_entry(ImageFile, poster_image_id) : nil
+      mobile_poster_image_id = options.delete(:mobile_poster_image_id)
+      mobile_poster = mobile_poster_image_id.present? ? find_file_in_entry(ImageFile, mobile_poster_image_id) : nil
 
       options[:data] = {}
 
@@ -87,8 +91,8 @@ module Pageflow
       video_file_script_tag(video_id, options.merge(poster_image_id: poster_image_id))
     end
 
-    def video_file_script_tag(video_id, options = {})
-      video_file = VideoFile.find_by_id(video_id)
+    def video_file_script_tag(video_file_perma_id, options = {})
+      video_file = find_file_in_entry(VideoFile, video_file_perma_id)
 
       script_tag_data = {template: 'video'}
 
@@ -103,12 +107,13 @@ module Pageflow
              options: options)
     end
 
-    def video_file_non_js_link(entry, video_file_id)
-      if (video_file = VideoFile.find_by_id(video_file_id))
-        link_to(t('pageflow.public.play_video'),
-                short_video_file_path(entry, video_file),
-                class: 'hint')
-      end
+    def video_file_non_js_link(entry, video_file_perma_id)
+      video_file = find_file_in_entry(VideoFile, video_file_perma_id)
+      return unless video_file
+
+      link_to(t('pageflow.public.play_video'),
+              short_video_file_path(entry, video_file.id),
+              class: 'hint')
     end
 
     def video_file_sources(video_file, options = {})

data/app/jobs/pageflow/{process_file_job.rb → process_image_or_text_track_job.rb}

@@ -1,5 +1,5 @@
 module Pageflow
-  class ProcessFileJob < ApplicationJob
+  class ProcessImageOrTextTrackJob < ApplicationJob
     queue_as :resizing
 
     include StateMachineJob

data/app/models/concerns/pageflow/{uploaded_file.rb → reusable_file.rb}

@@ -1,5 +1,5 @@
 module Pageflow
-  module UploadedFile
+  module ReusableFile
     extend ActiveSupport::Concern
 
     included do
@@ -56,14 +56,68 @@ module Pageflow
       "#{super}-#{state}"
     end
 
+
+    # The following are method defaults for file types that do not require processing/encoding.
+    # They are overwritten with default values in UploadableFile for files that are uploaded
+    # through the editor.
+
+    # Overwritten if a file type provides a default url for its file.
+    def url
+      ''
+    end
+
+    # Overwritten in case of a file type providing its original (unprocessed) file
+    # for download in the editor.
+    # Defaults to the default url of the file (see above)
+    def original_url
+      url
+    end
+
+    # Overwritten with the basename of the file.
+    def basename
+      'unused'
+    end
+
+    # Overwritten in UploadableFile with attachment filename.
+    def file_name
+      'unused'
+    end
+
+    # Overwritten in UploadableFile based on initial state_machine-state.
+    # Defaults to false for files that only use the ReusableFile module
     def can_upload?
-      # Overwritten in HostedFile based on initial state_machine-state.
-      # Only true directly after creation.
       false
     end
 
-    def direct_upload_config
-      Pageflow.config.paperclip_direct_upload_options.call(attachment)
+    # Overwritten with the conditions that need to be fulfilled in order to `retry`
+    # whatever the file does (i.e. processing/transcoding).
+    def retryable?
+      raise 'Not implemented!'
+    end
+
+    # Overwritten with the conditions that need to be fulfilled in order to (re)use the file.
+    def ready?
+      raise 'Not implemented!'
+    end
+
+    # Overwritten with the conditions that indicate failure during processing.
+    def failed?
+      raise 'Not implemented!'
+    end
+
+    # If the conditions in retryable? are met then this method specifies what should happen when
+    # a retry is requested, depending on the including class' processing state machine.
+    def retry!
+      raise 'Not implemented!'
+    end
+
+    # Gets called to trigger the `file_uploaded` event in the upload state machine of UploadableFile.
+    # Files that are not uploaded through the editor (and therefore not using the
+    # upload state machine of UploadableFile) can overwrite this method to trigger whatever
+    # the file does (i.e. processing/transcoding), depending on the including class'
+    # processing state machine.
+    def publish!
+      raise 'Not implemented!'
     end
   end
 end

data/app/models/concerns/pageflow/{hosted_file.rb → uploadable_file.rb}

@@ -1,7 +1,7 @@
 module Pageflow
-  module HostedFile
+  module UploadableFile
     extend ActiveSupport::Concern
-    include UploadedFile
+    include ReusableFile
 
     included do
       alias_attribute :file_name, :attachment_on_s3_file_name
@@ -30,7 +30,7 @@ module Pageflow
         state 'uploaded'
         state 'uploading_failed'
 
-        event :publish do
+        event :file_uploaded do
           transition 'uploading' => 'uploaded'
         end
 
@@ -46,14 +46,35 @@ module Pageflow
       self.attachment_on_s3 = value
     end
 
+    def direct_upload_config
+      Pageflow.config.paperclip_direct_upload_options.call(attachment)
+    end
+
+    # Overwritten if a file type wants to merge its attachments default_url into
+    # Pageflow.config.paperclip_s3_default_options.
+    # (See Pageflow::ImageFile for example)
     def attachment_default_url
       ''
     end
 
+    # Overwritten if a file type wants to add additional styles to
+    # Pageflow.config.paperclip_s3_default_options.
+    # (See Pageflow::ImageFile for example)
     def attachment_styles(_attachment)
       {}
     end
 
+    # ReusableFile-overrides:
+    def url
+      if attachment.present?
+        attachment.url
+      end
+    end
+
+    def basename
+      File.basename(attachment.original_filename, '.*')
+    end
+
     def can_upload?
       uploading?
     end
@@ -70,18 +91,8 @@ module Pageflow
       uploading_failed?
     end
 
-    def basename
-      File.basename(attachment.original_filename, '.*')
-    end
-
-    def url
-      if attachment.present?
-        attachment.url
-      end
-    end
-
-    def original_url
-      url
+    def publish!
+      file_uploaded!
     end
 
     module ClassMethods

data/app/models/pageflow/audio_file.rb

@@ -1,7 +1,7 @@
 module Pageflow
   class AudioFile < ApplicationRecord
-    include HostedFile
-    include EncodedFileStateMachine
+    include UploadableFile
+    include MediaEncodingStateMachine
 
     belongs_to :confirmed_by, class_name: 'User', optional: true
 

data/app/models/pageflow/draft_entry.rb

@@ -20,7 +20,7 @@ module Pageflow
              :emphasize_new_pages,
              :share_url, :share_image_id, :share_image_x, :share_image_y,
              :share_providers, :active_share_providers,
-             :find_files, :find_file,
+             :find_files, :find_file, :find_file_by_perma_id,
              :image_files, :video_files, :audio_files,
              :locale,
              :author, :publisher, :keywords,

data/app/models/pageflow/entry.rb

@@ -112,14 +112,6 @@ module Pageflow
       [:title, [:title, :id]]
     end
 
-    def self.ransackable_attributes(_auth_object)
-      %w[title type_name created_at edited_at first_published_at]
-    end
-
-    def self.ransackable_associations(_auth_object)
-      %w[account published_revision]
-    end
-
     def self.ransackable_scopes(_)
       [:with_publication_state, :published]
     end

data/app/models/pageflow/file_usage.rb

@@ -1,8 +1,10 @@
 module Pageflow
   class FileUsage < ApplicationRecord
     include SerializedConfiguration
+    include RevisionComponent
+
+    alias_attribute :perma_id, :file_perma_id
 
-    belongs_to :revision
     belongs_to :file, polymorphic: true
 
     def copy_to(revision)