pageflow 14.5.2 → 15.0.0.beta1

data/app/models/pageflow/image_file.rb

@@ -1,7 +1,35 @@
 module Pageflow
   class ImageFile < ApplicationRecord
-    include HostedFile
-    include ProcessedFileStateMachine
+    include UploadableFile
+    include ImageAndTextTrackProcessingStateMachine
+
+    # used in paperclip initializer to interpolate the storage path
+    # needs to be "processed_attachments" for images for legacy reasons
+    def attachments_path_name
+      'processed_attachments'
+    end
+
+    after_attachment_on_s3_post_process :save_image_dimensions
+
+    def thumbnail_url(*args)
+      unless ready?
+        return Pageflow::PaperclipInterpolations::Support.pageflow_placeholder(attachment, *args)
+      end
+      attachment.url(*args)
+    end
+
+    def original_url
+      attachment.url if ready?
+    end
+
+    def panorama_url
+      attachment.url(:panorama_large) if ready?
+    end
+
+    # UploadableFile-overrides ->
+    def attachment_default_url
+      ':pageflow_placeholder'
+    end
 
     def attachment_styles(attachment)
       panorama_format = File.extname(attachment.original_filename) == '.png' ? :PNG : :JPG
@@ -30,36 +58,10 @@ module Pageflow
         )
     end
 
-    def attachment_default_url
-      ':pageflow_placeholder'
-    end
-
-    # used in paperclip initializer to interpolate the storage path
-    # needs to be "processed_attachments" for images for legacy reasons
-    def attachments_path_name
-      'processed_attachments'
-    end
-
-    after_attachment_on_s3_post_process :save_image_dimensions
-
-    def thumbnail_url(*args)
-      unless ready?
-        return Pageflow::PaperclipInterpolations::Support.pageflow_placeholder(attachment, *args)
-      end
-      attachment.url(*args)
-    end
-
     def url
       attachment.url(:large) if ready?
     end
-
-    def original_url
-      attachment.url if ready?
-    end
-
-    def panorama_url
-      attachment.url(:panorama_large) if ready?
-    end
+    # <- UploadableFile-overrides
 
     private
 

data/app/models/pageflow/membership.rb

@@ -11,7 +11,7 @@ module Pageflow
                foreign_key: 'entity_id',
                optional: true
 
-    validates :entity, :role, presence: true
+    validates :user, :entity, :role, presence: true
     validates :user_id, uniqueness: {scope: [:entity_type, :entity_id]}
     validate :account_membership_exists, if: :on_entry?
     validates :role,
@@ -38,8 +38,9 @@ module Pageflow
     private
 
     def account_membership_exists
-      errors[:base] << 'Entry Membership misses presupposed Membership on account of entry' if
-        user.present? && !user.accounts.include?(entity.account)
+      unless user.accounts.include?(entity.account)
+        errors[:base] << 'Entry Membership misses presupposed Membership on account of entry'
+      end
     end
 
     def on_entry?

data/app/models/pageflow/page.rb

@@ -16,14 +16,6 @@ module Pageflow
       configuration['title'].presence || configuration['additional_title']
     end
 
-    def thumbnail_url(*args)
-      thumbnail_file.thumbnail_url(*args)
-    end
-
-    def thumbnail_file
-      ThumbnailFileResolver.new(page_type.thumbnail_candidates, configuration).find
-    end
-
     def page_type
       Pageflow.config.page_types.find_by_name!(template)
     end

data/app/models/pageflow/positioned_file.rb

@@ -2,7 +2,7 @@ module Pageflow
   class PositionedFile
     attr_reader :file, :position_x, :position_y
 
-    delegate :thumbnail_url, to: :file
+    delegate :thumbnail_url, :perma_id, to: :file
 
     def initialize(file, position_x = nil, position_y = nil)
       @file = file
@@ -13,7 +13,8 @@ module Pageflow
     def ==(other)
       super(other) ||
         other == file ||
-        (other.is_a?(PositionedFile) && other.file == file)
+        (other.is_a?(PositionedFile) && other.file == file) ||
+        (other.class == file.class && other.id == file.id)
     end
 
     def to_model

data/app/models/pageflow/published_entry.rb

@@ -16,7 +16,7 @@ module Pageflow
 
     delegate(:widgets,
              :storylines, :main_storyline_chapters, :chapters, :pages,
-             :find_files, :find_file,
+             :find_files, :find_file, :find_file_by_perma_id,
              :image_files, :video_files, :audio_files,
              :summary, :credits, :manual_start,
              :emphasize_chapter_beginning,
@@ -54,10 +54,16 @@ module Pageflow
 
     def thumbnail_file
       share_image_file ||
-        pages.first.try(:thumbnail_file) ||
+        page_thumbnail_file(pages.first) ||
         PositionedFile.null
     end
 
+    def page_thumbnail_file(page)
+      return unless page.present?
+      ThumbnailFileResolver.new(self, page.page_type.thumbnail_candidates, page.configuration)
+                           .find_thumbnail
+    end
+
     def self.find(id, scope = Entry)
       PublishedEntry.new(scope.published.find(id))
     end
@@ -98,7 +104,7 @@ module Pageflow
     end
 
     def share_image_file
-      PositionedFile.wrap(ImageFile.find_by_id(share_image_id), share_image_x, share_image_y)
+      PositionedFile.wrap(find_file_by_perma_id(ImageFile, share_image_id), share_image_x, share_image_y)
     end
   end
 end

data/app/models/pageflow/revision.rb

@@ -93,20 +93,14 @@ module Pageflow
       UsedFile.new(file)
     end
 
-    def share_providers
-      self[:share_providers] || entry.theming.default_share_providers
-    end
-
-    def author
-      read_attribute(:author) || Pageflow.config.default_author_meta_tag
-    end
-
-    def publisher
-      read_attribute(:publisher) || Pageflow.config.default_publisher_meta_tag
+    def find_file_by_perma_id(model, perma_id)
+      file = files(model).find_by(pageflow_file_usages: {file_perma_id: perma_id})
+      return unless file
+      UsedFile.new(file)
     end
 
-    def keywords
-      read_attribute(:keywords) || Pageflow.config.default_keywords_meta_tag
+    def share_providers
+      self[:share_providers] || entry.theming.default_share_providers
     end
 
     def active_share_providers

data/app/models/pageflow/text_track_file.rb

@@ -1,8 +1,19 @@
 module Pageflow
   class TextTrackFile < ApplicationRecord
-    include HostedFile
-    include ProcessedFileStateMachine
+    include UploadableFile
+    include ImageAndTextTrackProcessingStateMachine
 
+    # used in paperclip initializer to interpolate the storage path
+    # needs to be "processed_attachments" for text tracks for legacy reasons
+    def attachments_path_name
+      'processed_attachments'
+    end
+
+    def meta_data_attributes=(attributes)
+      self.attributes = attributes.symbolize_keys.slice(:label, :kind, :srclang)
+    end
+
+    # UploadableFile-overrides ->
     def attachment_styles(_attachment)
       {
         vtt: {
@@ -14,15 +25,5 @@ module Pageflow
         }
       }
     end
-
-    # used in paperclip initializer to interpolate the storage path
-    # needs to be "processed_attachments" for text tracks for legacy reasons
-    def attachments_path_name
-      'processed_attachments'
-    end
-
-    def meta_data_attributes=(attributes)
-      self.attributes = attributes.symbolize_keys.slice(:label, :kind, :srclang)
-    end
   end
 end

data/app/models/pageflow/thumbnail_file_resolver.rb

@@ -1,6 +1,6 @@
 module Pageflow
-  class ThumbnailFileResolver < Struct.new(:candidates, :configuration)
-    def find
+  class ThumbnailFileResolver < Struct.new(:entry, :candidates, :configuration)
+    def find_thumbnail
       candidates.detect do |candidate|
         condition = candidate[:unless] || candidate[:if]
         next if condition && !condition_met?(condition, candidate[:unless])
@@ -35,7 +35,7 @@ module Pageflow
     end
 
     def find_file_by_candidate(candidate)
-      file_model(candidate).find_by_id(record_id(candidate))
+      entry.find_file_by_perma_id(file_model(candidate), record_id(candidate))
     end
 
     def file_model(candidate)

data/app/models/pageflow/used_file.rb

@@ -19,6 +19,10 @@ module Pageflow
       @usage.id
     end
 
+    def perma_id
+      @usage.perma_id
+    end
+
     # Not delegated by default. Required to allow using instances in
     # Active Record conditions.
 

data/app/models/pageflow/video_file.rb

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

data/app/models/pageflow/widget.rb

@@ -61,14 +61,10 @@ module Pageflow
       private
 
       def all
-        initial_widgets = placeholders_by_role.merge(defaults_by_role)
-        initial_widgets.merge(from_db_by_role) { |_role_key, old_val, new_val|
-          if old_val.configuration.present?
-            new_val.configuration = {} if new_val.configuration.nil?
-            new_val.configuration = old_val.configuration.merge(new_val.configuration)
-          end
-          new_val
-        }.values
+        placeholders_by_role
+          .merge(defaults_by_role)
+          .merge(from_db_by_role)
+          .values
       end
 
       def from_db_by_role
@@ -77,15 +73,13 @@ module Pageflow
 
       def defaults_by_role
         config.widget_types.defaults_by_role.each_with_object({}) do |(role, widget_type), result|
-          result[role] = Widget.new(role: role, type_name: widget_type.name,
-                                    subject: nil,
-                                    configuration:
-                                      config.widget_types.default_configuration(role))
+          result[role] = Widget.new(role: role, type_name: widget_type.name, subject: nil)
         end
       end
 
       def placeholders_by_role
         return {} unless options[:include_placeholders]
+
         config.widget_types.roles.each_with_object({}) do |role, result|
           result[role] = Widget.new(role: role, type_name: nil, subject: nil)
         end

data/app/state_machines/pageflow/{processed_file_state_machine.rb → image_and_text_track_processing_state_machine.rb}

@@ -1,5 +1,5 @@
 module Pageflow
-  module ProcessedFileStateMachine
+  module ImageAndTextTrackProcessingStateMachine
     extend ActiveSupport::Concern
 
     included do
@@ -15,7 +15,7 @@ module Pageflow
           transition 'processing_failed' => 'processing'
         end
 
-        job ProcessFileJob do
+        job ProcessImageOrTextTrackJob do
           on_enter 'processing'
           result :ok => 'processed'
           result :error => 'processing_failed'
@@ -23,6 +23,7 @@ module Pageflow
       end
     end
 
+    # UploadableFile-overrides
     def retry!
       process!
     end

data/app/state_machines/pageflow/{encoded_file_state_machine.rb → media_encoding_state_machine.rb}

@@ -1,5 +1,5 @@
 module Pageflow
-  module EncodedFileStateMachine
+  module MediaEncodingStateMachine
     extend ActiveSupport::Concern
 
     included do
@@ -15,13 +15,16 @@ module Pageflow
         state 'encoding_failed'
 
         event :process do
-          transition any => 'waiting_for_meta_data', :if => lambda { Pageflow.config.confirm_encoding_jobs }
+          transition any => 'waiting_for_meta_data',
+                     if: -> { Pageflow.config.confirm_encoding_jobs }
           transition any => 'waiting_for_encoding'
         end
 
-        event :retry do
-          transition 'encoding_failed' => 'waiting_for_confirmation', :if => lambda { Pageflow.config.confirm_encoding_jobs }
-          transition 'encoded' => 'waiting_for_confirmation', :if => lambda { Pageflow.config.confirm_encoding_jobs }
+        event :retry_encoding do
+          transition 'encoding_failed' => 'waiting_for_confirmation',
+                     if: -> { Pageflow.config.confirm_encoding_jobs }
+          transition 'encoded' => 'waiting_for_confirmation',
+                     if: -> { Pageflow.config.confirm_encoding_jobs }
 
           transition 'encoding_failed' => 'waiting_for_encoding'
           transition 'encoded' => 'waiting_for_encoding'
@@ -29,15 +32,15 @@ module Pageflow
 
         job RequestMetaDataFromZencoderJob do
           on_enter 'waiting_for_meta_data'
-          result :ok => 'fetching_meta_data'
-          result :error => 'fetching_meta_data_failed'
+          result ok: 'fetching_meta_data'
+          result error: 'fetching_meta_data_failed'
         end
 
         job PollMetaDataFromZencoderJob do
           on_enter 'fetching_meta_data'
-          result :pending, :retry_after => 2.seconds
-          result :ok => 'waiting_for_confirmation'
-          result :error => 'fetching_meta_data_failed'
+          result :pending, retry_after: 2.seconds
+          result ok: 'waiting_for_confirmation'
+          result error: 'fetching_meta_data_failed'
         end
 
         event :confirm_encoding do
@@ -45,34 +48,35 @@ module Pageflow
         end
 
         after_transition 'waiting_for_confirmation' => 'waiting_for_encoding' do |file|
-          Pageflow.config.hooks.invoke(:file_encoding_confirmed, :file => file)
+          Pageflow.config.hooks.invoke(:file_encoding_confirmed, file: file)
         end
 
         job SubmitFileToZencoderJob do
           on_enter 'waiting_for_encoding'
-          result :ok => 'encoding'
-          result :error => 'encoding_failed'
+          result ok: 'encoding'
+          result error: 'encoding_failed'
         end
 
         job PollZencoderJob do
           on_enter 'encoding'
-          result :pending, :retry_after => 2.seconds
-          result :ok => 'encoded'
-          result :error => 'encoding_failed'
+          result :pending, retry_after: 2.seconds
+          result ok: 'encoded'
+          result error: 'encoding_failed'
         end
 
         after_transition any => 'encoded' do |file|
-          Pageflow.config.hooks.invoke(:file_encoded, :file => file)
+          Pageflow.config.hooks.invoke(:file_encoded, file: file)
         end
 
         after_transition any => 'encoding_failed' do |file|
-          Pageflow.config.hooks.invoke(:file_encoding_failed, :file => file)
+          Pageflow.config.hooks.invoke(:file_encoding_failed, file: file)
         end
       end
     end
 
+    # UploadableFile-overrides
     def retryable?
-      can_retry? && !encoded?
+      can_retry_encoding? && !encoded?
     end
 
     def ready?
@@ -84,5 +88,9 @@ module Pageflow
         fetching_meta_data_failed? ||
         encoding_failed?
     end
+
+    def retry!
+      retry_encoding!
+    end
   end
 end

data/app/views/pageflow/editor/files/_file.json.jbuilder

@@ -12,7 +12,7 @@ if file.can_upload?
 end
 
 json.retryable(file.retryable?)
-json.file_name(file.attachment.original_filename)
+json.file_name(file.file_name)
 
 if file.url.present?
   json.url(file.url)

data/app/views/pageflow/entries/mobile_navigation/_page.html.erb

@@ -1,6 +1,6 @@
 <li class="<%= page_navigation_css_class(page) %>">
   <%= link_to "##{page.perma_id}", data: {link: page.id, chapter_id: page.chapter_id} do %>
-    <%= image_tag('', data: {src: asset_path(page.thumbnail_url(:thumbnail_overview_mobile))}) %>
+    <%= image_tag('', data: {src: asset_path(page_thumbnail_url(page, :thumbnail_overview_mobile))}) %>
     <%= page.title %>
   <% end %>
 </li>

data/app/views/pageflow/entries/navigation/_page.html.erb

@@ -1,12 +1,12 @@
 <li class="<%= page_navigation_css_class(page) %>">
   <%= link_to "##{page.perma_id}", :data => {:link => page.id, :chapter_id => page.chapter_id} do %>
-    <%= image_tag('', data: {src: asset_path(page.thumbnail_url(:navigation_thumbnail_small))}, width: 85, height: 47) %>
+    <%= image_tag('', data: {src: asset_path(page_thumbnail_url(page, :navigation_thumbnail_small))}, width: 85, height: 47) %>
     <%= page.title %>
   <% end %>
   <div class="navigation_site_detail">
     <%= page.title %>
     <div class="thumbnail is_<%= page.template %>">
-      <%= image_tag('', data: {src: asset_path(page.thumbnail_url(:navigation_thumbnail_large))}) %>
+      <%= image_tag('', data: {src: asset_path(page_thumbnail_url(page, :navigation_thumbnail_large))}) %>
     </div>
   </div>
 </li>

data/app/views/pageflow/entries/overview/_page.html.erb

@@ -4,6 +4,6 @@
         <%= overview_page_description(page) %>
       </p>
     </div>
-    <%= image_tag('', data: {src: asset_path(page.thumbnail_url(:thumbnail_overview_desktop))}) %>
+    <%= image_tag('', data: {src: asset_path(page_thumbnail_url(page, :thumbnail_overview_desktop))}) %>
     <div class="pictogram"></div>
 <% end %>

data/app/views/pageflow/files/_file.json.jbuilder

@@ -1,5 +1,6 @@
 json.call(file,
           :id,
+          :perma_id,
           :basename,
           :rights,
           :configuration,

data/app/views/pageflow/social_share/_page_meta_tags.html.erb

@@ -1,6 +1,6 @@
 <%= tag :link, rel: "canonical", href: social_share_page_url(entry, page) %>
 
-<%= tag :meta, property: "og:image", content: social_share_normalize_protocol(page.thumbnail_url(:medium)) %>
+<%= tag :meta, property: "og:image", content: social_share_normalize_protocol(page_thumbnail_url(page, :medium)) %>
 
 <%= tag :meta, property: "og:title", content: social_share_page_title(page) %>
 <%= tag :meta, property: "og:description", name: "description", content: social_share_page_description(entry, page) %>

data/config/locales/de.yml

@@ -282,10 +282,6 @@ de:
         dimensions: Maße
         duration: Länge
         format: Format
-      pageflow/widget:
-        blur_strength: Unschärfe
-        invert: Farben invertieren
-        remove_logo: Logo entfernen
       user:
         account: Konto
         admin: System-Administrator
@@ -355,10 +351,6 @@ de:
           attributes:
             folder:
               must_be_same_account: Ordner muss zu gleichem Konto gehören wie Beitrag
-        pageflow/membership:
-          attributes:
-            user:
-              required: Benutzer muss ausgewählt sein
     models:
       account:
         one: Konto
@@ -1128,8 +1120,6 @@ de:
           audio_files: Audios
           image_files: Bilder
           video_files: Videos
-      media_loading_spinner:
-        widget_type_info_box_text: Dies ist eine Vorschau der Lade-Ansicht von 'Bild'. Die Animation wird ausgeführt, während die Seite geladen wird.
       nested_files:
         text_track_files:
           delete:
@@ -1402,19 +1392,7 @@ de:
           without_parent_page: Ohne übergeordnete Seite
       widgets:
         attributes:
-          media_loading_spinner:
-            blur_strength:
-              inline_help: Steuern Sie die Unschärfe des Hintergrundbilds.
-              label: Unschärfe
-            custom_background_image_id:
-              inline_help: Standardmäßig wird das Hintergrundbild der ersten Seite verwendet.
-              label: Hintegrundbild
-            remove_logo:
-              label: Logo entfernen
           title_loading_spinner:
-            blur_strength:
-              inline_help: Steuern Sie die Unschärfe des Hintergrundbilds.
-              label: Unschärfe
             custom_background_image_id:
               inline_help: Standardmäßig wird das Hintergrundbild der ersten Seite verwendet.
               label: Hintegrundbild
@@ -1755,8 +1733,6 @@ de:
       tr: Türkisch
       unknown: "(Unbekannt)"
       zh: Chinesisch
-    media_loading_spinner:
-      widget_type_name: Media
     page_transitions:
       crossfade: Überblenden
       cut: Harter Schnitt

data/config/locales/en.yml

@@ -282,10 +282,6 @@ en:
         dimensions: Dimensions
         duration: Duration
         format: Format
-      pageflow/widget:
-        blur_strength: Blurriness
-        invert: Invert Color
-        remove_logo: Remove Logo
       user:
         account: Account
         admin: System administrator
@@ -355,10 +351,6 @@ en:
           attributes:
             folder:
               must_be_same_account: Folder must belong to same account as story
-        pageflow/membership:
-          attributes:
-            user:
-              required: User must be selected
     models:
       account:
         one: Account
@@ -1128,8 +1120,6 @@ en:
           audio_files: Audios
           image_files: Images
           video_files: Videos
-      media_loading_spinner:
-        widget_type_info_box_text: This is a preview of the 'Image' loading view. The animation runs while the page is loading.
       nested_files:
         text_track_files:
           delete:
@@ -1402,19 +1392,7 @@ en:
           without_parent_page: Without parent page
       widgets:
         attributes:
-          media_loading_spinner:
-            blur_strength:
-              inline_help: Control the bluriness of background image.
-              label: Blur Strength
-            custom_background_image_id:
-              inline_help: By default, the background image of the first page is used.
-              label: Background Image
-            remove_logo:
-              label: Remove logo
           title_loading_spinner:
-            blur_strength:
-              inline_help: Control the bluriness of background image.
-              label: Blur Strength
             custom_background_image_id:
               inline_help: By default the background image of the first page is used.
               label: Background image
@@ -1727,8 +1705,6 @@ en:
       tr: Turkish
       unknown: "(Unknown)"
       zh: Chinese
-    media_loading_spinner:
-      widget_type_name: Media
     page_transitions:
       crossfade: Crossfade
       cut: Cut

data/db/migrate/20190306161431_copy_file_attributes_of_failed_uploads.rb

@@ -1,7 +1,7 @@
 class CopyFileAttributesOfFailedUploads < ActiveRecord::Migration[5.2]
   def up
-    %w(audio text_track video).each do |hosted_file_type|
-      execute("UPDATE pageflow_#{hosted_file_type}_files hf
+    %w(audio text_track video).each do |uploadable_file_type|
+      execute("UPDATE pageflow_#{uploadable_file_type}_files hf
                    SET hf.attachment_on_s3_file_name = hf.attachment_on_filesystem_file_name,
                        hf.attachment_on_s3_content_type = hf.attachment_on_filesystem_content_type,
                        hf.attachment_on_s3_file_size = hf.attachment_on_filesystem_file_size,
@@ -12,8 +12,8 @@ class CopyFileAttributesOfFailedUploads < ActiveRecord::Migration[5.2]
   end
 
   def down
-    %w(audio text_track video).each do |hosted_file_type|
-      execute("UPDATE pageflow_#{hosted_file_type}_files hf
+    %w(audio text_track video).each do |uploadable_file_type|
+      execute("UPDATE pageflow_#{uploadable_file_type}_files hf
                    SET hf.attachment_on_s3_file_name = NULL,
                        hf.attachment_on_s3_content_type = NULL,
                        hf.attachment_on_s3_file_size = NULL,

data/db/migrate/20190523151140_add_perma_id_to_file_usages.rb

@@ -0,0 +1,13 @@
+class AddPermaIdToFileUsages < ActiveRecord::Migration[5.2]
+  def up
+    add_column :pageflow_file_usages, :file_perma_id, :integer, after: 'file_id'
+    add_index :pageflow_file_usages,
+              [:revision_id, :file_type, :file_perma_id],
+              name: 'index_pageflow_file_usages_on_revision_and_file'
+    execute('UPDATE pageflow_file_usages SET file_perma_id = file_id;')
+  end
+
+  def down
+    remove_column :pageflow_file_usages, :file_perma_id
+  end
+end

data/lib/pageflow/built_in_widget_type.rb

@@ -61,12 +61,5 @@ module Pageflow
                                          insert_point: :before_entry,
                                          server_rendering: true)
     end
-
-    def self.media_loading_spinner
-      Pageflow::React.create_widget_type('media_loading_spinner',
-                                         'loading_spinner',
-                                         insert_point: :before_entry,
-                                         server_rendering: true)
-    end
   end
 end