pageflow 12.6.0 → 13.0.0.beta1

data/app/jobs/pageflow/application_job.rb

@@ -0,0 +1,6 @@
+module Pageflow
+  class ApplicationJob < ActiveJob::Base
+    # Most jobs are safe to ignore if the underlying records are no longer available
+    discard_on ActiveJob::DeserializationError
+  end
+end

data/app/jobs/pageflow/poll_meta_data_from_zencoder_job.rb

@@ -1,9 +1,7 @@
 module Pageflow
   class PollMetaDataFromZencoderJob < PollZencoderJob
-    @queue = :resizing
-
-    def self.perform_with_result(file, options)
-      super(file, :skip_thumbnail => true)
+    def perform_with_result(file, _options)
+      super(file, skip_thumbnail: true)
     end
   end
 end

data/app/jobs/pageflow/poll_zencoder_job.rb

@@ -1,13 +1,13 @@
 module Pageflow
-  class PollZencoderJob
-    @queue = :resizing
+  class PollZencoderJob < ApplicationJob
+    queue_as :resizing
 
-    extend StateMachineJob
+    include StateMachineJob
 
-    def self.perform_with_result(file, options, api = ZencoderApi.instance)
+    def perform_with_result(file, options, api = ZencoderApi.instance)
       options ||= {}
 
-      result = catch(:halt) do
+      catch(:halt) do
         poll_zencoder(file, api)
         fetch_input_details(file, api)
         fetch_thumbnail(file) unless options[:skip_thumbnail]
@@ -20,7 +20,7 @@ module Pageflow
 
     private
 
-    def self.poll_zencoder(file, api)
+    def poll_zencoder(file, api)
       info = api.get_info(file.job_id)
 
       file.encoding_progress = info[:finished] ? 100 : info[:progress];
@@ -39,7 +39,7 @@ module Pageflow
       raise
     end
 
-    def self.fetch_thumbnail(file)
+    def fetch_thumbnail(file)
       return unless file.respond_to?(:thumbnail)
       file.thumbnail = URI.parse(file.zencoder_thumbnail.url(default_protocol: 'http'))
       file.poster = URI.parse(file.zencoder_poster.url(default_protocol: 'http'))
@@ -47,7 +47,7 @@ module Pageflow
       throw(:halt, :pending)
     end
 
-    def self.fetch_input_details(file, api)
+    def fetch_input_details(file, api)
       file.meta_data_attributes = api.get_details(file.job_id)
     rescue ZencoderApi::RecoverableError => e
       file.encoding_error_message = e.message

data/app/jobs/pageflow/process_file_job.rb

@@ -1,10 +1,10 @@
 module Pageflow
-  class ProcessFileJob
-    @queue = :resizing
+  class ProcessFileJob < ApplicationJob
+    queue_as :resizing
 
-    extend StateMachineJob
+    include StateMachineJob
 
-    def self.perform_with_result(file, _options)
+    def perform_with_result(file, _options)
       file.processed_attachment = file.unprocessed_attachment
       file.save!
 

data/app/jobs/pageflow/prune_auto_snapshots_job.rb

@@ -1,8 +1,8 @@
 module Pageflow
-  class PruneAutoSnapshotsJob
-    @queue = :prune
+  class PruneAutoSnapshotsJob < ApplicationJob
+    queue_as :prune
 
-    def self.perform(entry_id, options)
+    def perform(entry_id, options)
       AutoSnapshotPruning.prune(Entry.find(entry_id), options.symbolize_keys)
     end
   end

data/app/jobs/pageflow/request_meta_data_from_zencoder_job.rb

@@ -1,10 +1,10 @@
 module Pageflow
-  class RequestMetaDataFromZencoderJob
-    @queue = :default
+  class RequestMetaDataFromZencoderJob < ApplicationJob
+    queue_as :default
 
-    extend StateMachineJob
+    include StateMachineJob
 
-    def self.perform_with_result(file, options, api = ZencoderApi.instance)
+    def perform_with_result(file, _options, api = ZencoderApi.instance)
       file.job_id = api.create_job(ZencoderMetaDataOutputDefinition.new(file))
       file.save!
 

data/app/jobs/pageflow/submit_file_to_zencoder_job.rb

@@ -1,10 +1,10 @@
 module Pageflow
-  class SubmitFileToZencoderJob
-    @queue = :default
+  class SubmitFileToZencoderJob < ApplicationJob
+    queue_as :default
 
-    extend StateMachineJob
+    include StateMachineJob
 
-    def self.perform_with_result(file, options, api = ZencoderApi.instance)
+    def perform_with_result(file, _options, api = ZencoderApi.instance)
       file.job_id = api.create_job(file.output_definition)
       file.save!
 

data/app/jobs/pageflow/upload_file_to_s3_job.rb

@@ -1,12 +1,12 @@
 module Pageflow
-  class UploadFileToS3Job
-    @queue = :slow
+  class UploadFileToS3Job < ApplicationJob
+    queue_as :slow
 
-    extend StateMachineJob
+    include StateMachineJob
 
-    def self.perform_with_result(file, options = {})
+    def perform_with_result(file, _options = {})
       if file && file.attachment_on_filesystem.file?
-        if File.exists?(file.attachment_on_filesystem.path)
+        if File.exist?(file.attachment_on_filesystem.path)
           file.attachment_on_s3 = file.attachment_on_filesystem
           file.save!
 

data/app/mailers/pageflow/user_mailer.rb

@@ -1,21 +1,7 @@
 module Pageflow
   class UserMailer < ActionMailer::Base
-    include Resque::Mailer
-
     def invitation(options)
-      # Different versions of resque_mailer either pass:
-      #
-      # - Hash with string keys (<= 2.4.0)
-      # - Hash with symbol keys (2.4.1)
-      # - Hash with both string and symbol keys (2.4.2)
-      # - HashWithIndifferentAccess (2.4.3)
-      #
-      # Symbolize keys to support 2.4.1, but do not use bang version
-      # (i.e. `smbolize_keys!`) since that is not supported by
-      # HashWithIndifferentAccess.
-      options = options.symbolize_keys
-
-      @user = User.find(options[:user_id])
+      @user = options[:user]
       @password_token = options[:password_token]
 
       I18n.with_locale(@user.locale) do

data/app/models/concerns/pageflow/uploaded_file.rb

@@ -3,9 +3,9 @@ module Pageflow
     extend ActiveSupport::Concern
 
     included do
-      belongs_to :uploader, :class_name => 'User'
-      belongs_to :entry
-      belongs_to :parent_file, polymorphic: true, foreign_type: :parent_file_model_type
+      belongs_to :uploader, class_name: 'User', optional: true
+      belongs_to :entry, optional: true
+      belongs_to :parent_file, polymorphic: true, foreign_type: :parent_file_model_type, optional: true
 
       has_many :usages, :as => :file, :class_name => 'Pageflow::FileUsage', :dependent => :destroy
       has_many :using_revisions, :through => :usages, :source => :revision

data/app/models/pageflow/audio_file.rb

@@ -3,7 +3,7 @@ module Pageflow
     include HostedFile
     include EncodedFileStateMachine
 
-    belongs_to :confirmed_by, :class_name => 'User'
+    belongs_to :confirmed_by, class_name: 'User', optional: true
 
     def attachment_s3_url
       "s3://#{File.join(attachment_on_s3.bucket_name, attachment_on_s3.path)}"

data/app/models/pageflow/chapter.rb

@@ -3,7 +3,7 @@ module Pageflow
     include SerializedConfiguration
 
     belongs_to :storyline, touch: true
-    has_many :pages, -> { order('position ASC') }, dependent: :destroy
+    has_many :pages, -> { order('position ASC') }, dependent: :destroy, inverse_of: :chapter
 
     delegate :entry, to: :storyline
 

data/app/models/pageflow/entry.rb

@@ -11,7 +11,7 @@ module Pageflow
     friendly_id :slug_candidates, :use => [:finders, :slugged]
 
     belongs_to :account, counter_cache: true
-    belongs_to :folder
+    belongs_to :folder, optional: true
     belongs_to :theming
 
     has_many :revisions, -> { order('frozen_at DESC') }

data/app/models/pageflow/invited_user.rb

@@ -31,7 +31,7 @@ module Pageflow
     end
 
     def send_invitation
-      UserMailer.invitation('user_id' => id, 'password_token' => @token).deliver
+      UserMailer.invitation(user: self, password_token: @token).deliver_later
     end
   end
 end

data/app/models/pageflow/membership.rb

@@ -4,10 +4,12 @@ module Pageflow
     belongs_to :entity, polymorphic: true
     belongs_to :entry,
                -> { where(pageflow_memberships: {entity_type: 'Pageflow::Entry'}) },
-               foreign_key: 'entity_id'
+               foreign_key: 'entity_id',
+               optional: true
     belongs_to :account,
                -> { where(pageflow_memberships: {entity_type: 'Pageflow::Account'}) },
-               foreign_key: 'entity_id'
+               foreign_key: 'entity_id',
+               optional: true
 
     validates :user, :entity, :role, presence: true
     validates :user_id, uniqueness: {scope: [:entity_type, :entity_id]}

data/app/models/pageflow/page.rb

@@ -2,7 +2,7 @@ module Pageflow
   class Page < ApplicationRecord
     include SerializedConfiguration
 
-    belongs_to :chapter, :touch => true
+    belongs_to :chapter, touch: true
 
     attr_accessor :is_first
 

data/app/models/pageflow/published_entry.rb

@@ -42,7 +42,7 @@ module Pageflow
     end
 
     def stylesheet_cache_key
-      revision.cache_key
+      revision.cache_key_with_version
     end
 
     def thumbnail_url(*args)
@@ -59,9 +59,8 @@ module Pageflow
       PublishedEntry.new(scope.published.find(id))
     end
 
-    def cache_key
-      "#{self.class.model_name.cache_key}/" \
-        "#{entry.cache_key}-#{revision.cache_key}-#{theming.cache_key}"
+    def cache_version
+      "#{entry.cache_version}-#{revision.cache_version}-#{theming.cache_version}"
     end
 
     def home_button

data/app/models/pageflow/revision.rb

@@ -9,8 +9,8 @@ module Pageflow
     include ThemeReferencer
 
     belongs_to :entry, touch: :edited_at
-    belongs_to :creator, :class_name => 'User'
-    belongs_to :restored_from, :class_name => 'Pageflow::Revision'
+    belongs_to :creator, class_name: 'User', optional: true
+    belongs_to :restored_from, class_name: 'Pageflow::Revision', optional: true
 
     has_many :widgets, as: :subject, dependent: :destroy
 
@@ -44,7 +44,9 @@ module Pageflow
     scope :auto_snapshots, -> { where(snapshot_type: 'auto') }
 
     validates :entry, :presence => true
-    validates :creator, :presence => true, :if => :published?
+
+    # Workaround for https://github.com/rails/rails/issues/33445
+    validates_with ActiveModel::Validations::PresenceValidator, attributes: [:creator], if: :published?
 
     validate :published_until_unchanged, :if => :published_until_was_in_past?
     validate :published_until_blank, :if => :published_at_blank?

data/app/models/pageflow/storyline.rb

@@ -5,7 +5,11 @@ module Pageflow
 
     belongs_to :revision, touch: true
 
-    has_many :chapters, -> { order('pageflow_chapters.position ASC') }, dependent: :destroy
+    has_many(:chapters,
+             -> { order('pageflow_chapters.position ASC') },
+             dependent: :destroy,
+             inverse_of: :storyline)
+
     has_many :pages, through: :chapters
 
     delegate :entry, to: :revision

data/app/models/pageflow/theming.rb

@@ -37,8 +37,7 @@ module Pageflow
         publisher: default_publisher.presence || Pageflow.config.default_publisher_meta_tag,
         keywords: default_keywords.presence || Pageflow.config.default_keywords_meta_tag,
         theme_name: theme_name,
-        home_button_enabled: home_button_enabled_by_default,
-        locale: default_locale
+        home_button_enabled: home_button_enabled_by_default
       )
     end
 

data/app/models/pageflow/used_file.rb

@@ -2,6 +2,7 @@ module Pageflow
   class UsedFile < SimpleDelegator
     def initialize(file, usage = nil)
       super(file)
+      @file = file
       @usage = usage || file.usages.first
     end
 
@@ -17,5 +18,16 @@ module Pageflow
     def usage_id
       @usage.id
     end
+
+    # Not delegated by default. Required to allow using instances in
+    # Active Record conditions.
+
+    def is_a?(klass)
+      @file.is_a?(klass)
+    end
+
+    def class
+      @file.class
+    end
   end
 end

data/app/models/pageflow/video_file.rb

@@ -4,7 +4,7 @@ module Pageflow
     include EncodedFileStateMachine
     include OutputSource
 
-    belongs_to :confirmed_by, :class_name => 'User'
+    belongs_to :confirmed_by, class_name: 'User', optional: true
 
     has_attached_file(:poster, Pageflow.config.paperclip_s3_default_options
                         .merge(default_url: ':pageflow_placeholder',

data/app/views/admin/accounts/_form.html.erb

@@ -18,13 +18,6 @@
     <% end %>
 
     <%= f.inputs do %>
-      <%= theming.input :default_locale,
-                        as: :select,
-                        include_blank: false,
-                        collection: Pageflow.config.available_public_locales.map{ |locale|
-                          [t('pageflow.public._language', locale: locale), locale.to_s]
-                        },
-                        hint: t('pageflow.admin.themings.default_locale_hint') %>
       <%= theming.input :default_author,
         hint: t('pageflow.admin.themings.default_author_hint'),
         placeholder: Pageflow.config.default_author_meta_tag %>
@@ -41,7 +34,6 @@
       <%= theming.input :imprint_link_url %>
       <%= theming.input :copyright_link_label %>
       <%= theming.input :copyright_link_url %>
-      <%= theming.input :privacy_link_url %>
 
       <% account_config.admin_form_inputs.find_all_for(:theming).each do |form_input| %>
         <%= form_input.build(theming) %>

data/app/views/admin/accounts/_theming_details.html.arb

@@ -5,9 +5,6 @@ extensible_attributes_table_for(account.default_theming,
   row :theme, class: 'theme' do
     account.default_theming.theme.name
   end
-  row :default_locale, class: 'default_locale' do
-    t('pageflow.public._language', locale: account.default_theming.default_locale)
-  end
   row :default_author, class: 'default_author'
   row :default_publisher, class: 'default_publisher'
   row :default_keywords, class: 'default_keywords'

data/app/views/pageflow/entries/_mobile_navigation.html.erb

@@ -7,8 +7,9 @@
       <span class="heading-1"><%= t('pageflow.public.overview') %></span>
       <div class="wrapper">
         <ul class="pages">
-          <%= render :partial => 'pageflow/entries/mobile_navigation/page',
-                     :collection => entry_mobile_navigation_pages(entry) %>
+          <%= render :partial => 'pageflow/entries/navigation/page',
+                     :collection => entry_mobile_navigation_pages(entry),
+                     :locals => {:image_style => :thumbnail_overview_mobile, :image_width => nil} %>
         </ul>
       </div>
   </div>

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

@@ -4,8 +4,6 @@
   <% 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))}) %>
-    </div>
+    <div class="thumbnail is_<%= page.template %>" style="background-image: url('<%= asset_path(page.thumbnail_url(: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("#{page.thumbnail_url(:thumbnail_overview_desktop)}") %>
     <div class="pictogram"></div>
 <% end %>

data/app/views/pageflow/entry_json_seed/_entry.json.jbuilder

@@ -1,6 +1,6 @@
 json.merge! common_entry_seed(entry)
 
-json.theme entry_theme_seed(entry)
+json.theming entry_theming_seed(entry)
 
 json.storylines entry_storylines_seed(entry)
 json.chapters entry_chapters_seed(entry)

data/app/views/pageflow/user_mailer/invitation.html.erb

@@ -2,8 +2,8 @@
 
 <p><%= t('.instruction') %></p>
 
-<p><%= link_to edit_admin_initial_password_url(reset_password_token: @password_token),
-               edit_admin_initial_password_url(reset_password_token: @password_token) %></p>
+<p><%= link_to main_app.edit_user_password_url(@user, reset_password_token: @password_token),
+               main_app.edit_user_password_url(@user, reset_password_token: @password_token) %></p>
 
 <p><%= t('.ending') %></p>