pageflow 0.4.0 → 0.5.0

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

@@ -0,0 +1,93 @@
+module Pageflow
+  module HostedFile
+    extend ActiveSupport::Concern
+    include UploadedFile
+
+    included do
+      has_attached_file(:attachment_on_filesystem, Pageflow.config.paperclip_filesystem_default_options)
+      has_attached_file(:attachment_on_s3, Pageflow.config.paperclip_s3_default_options)
+
+      state_machine initial: 'not_uploaded_to_s3' do
+        extend StateMachineJob::Macro
+
+        state 'not_uploaded_to_s3'
+        state 'uploading_to_s3'
+        state 'uploaded_to_s3'
+        state 'uploading_to_s3_failed'
+
+        event :publish do
+          transition 'not_uploaded_to_s3' => 'uploading_to_s3'
+        end
+
+        event :retry do
+          transition 'uploading_to_s3_failed' => 'uploading_to_s3'
+        end
+
+        job UploadFileToS3Job do
+          on_enter 'uploading_to_s3'
+          result :pending, retry_after: 30.seconds
+          result :ok, state: 'uploaded_to_s3'
+          result :error, state: 'uploading_to_s3_failed'
+        end
+
+        event :process
+      end
+    end
+
+    def attachment
+      attachment_on_s3.present? ? attachment_on_s3 : attachment_on_filesystem
+    end
+
+    def attachment=(value)
+      self.attachment_on_filesystem = value
+    end
+
+    def keep_on_filesystem_after_upload_to_s3?
+      false
+    end
+
+    def retryable?
+      can_retry?
+    end
+
+    def url
+      if attachment_on_s3.present?
+        attachment.url
+      end
+    end
+
+    def self.columns(t)
+      t.belongs_to(:entry, index: true)
+      t.belongs_to(:uploader, index: true)
+
+      t.string(:state)
+      t.string(:rights)
+
+      t.string(:attachment_on_filesystem_file_name)
+      t.string(:attachment_on_filesystem_content_type)
+      t.integer(:attachment_on_filesystem_file_size, limit: 8)
+      t.datetime(:attachment_on_filesystem_updated_at)
+
+      t.string(:attachment_on_s3_file_name)
+      t.string(:attachment_on_s3_content_type)
+      t.integer(:attachment_on_s3_file_size, limit: 8)
+      t.datetime(:attachment_on_s3_updated_at)
+
+      t.timestamps
+    end
+
+    module ClassMethods
+      def processing_state_machine(&block)
+        state_machine do
+          extend StateMachineJob::Macro
+
+          after_transition(any => 'uploaded_to_s3') do |hosted_file|
+            hosted_file.process!
+          end
+
+          instance_eval(&block)
+        end
+      end
+    end
+  end
+end

data/app/models/pageflow/audio_file.rb

@@ -1,21 +1,10 @@
 module Pageflow
   class AudioFile < ActiveRecord::Base
+    include HostedFile
     include EncodedFileStateMachine
-    include UploadedFile
 
     belongs_to :confirmed_by, :class_name => 'User'
 
-    has_attached_file(:attachment_on_filesystem, Pageflow.config.paperclip_filesystem_default_options)
-    has_attached_file(:attachment_on_s3, Pageflow.config.paperclip_s3_default_options)
-
-    def attachment
-      attachment_on_s3
-    end
-
-    def attachment=(value)
-      self.attachment_on_filesystem = value
-    end
-
     def attachment_s3_url
       "s3://#{File.join(attachment_on_s3.bucket_name, attachment_on_s3.path)}"
     end

data/app/models/pageflow/draft_entry.rb

@@ -12,6 +12,7 @@ module Pageflow
 
     delegate(:title, :summary, :credits, :manual_start,
              :chapters, :pages,
+             :files,
              :image_files, :video_files, :audio_files,
              :to => :draft)
 
@@ -32,7 +33,7 @@ module Pageflow
     end
 
     def remove_file(file)
-      collection_containing(file).destroy(file)
+      draft.file_usages.where(file: file).destroy_all
       file.destroy if file.usages.empty?
     end
 
@@ -73,15 +74,5 @@ module Pageflow
     def home_button
       HomeButton.new(draft, theming)
     end
-
-    private
-
-    def collection_containing(file)
-      collection_for(file.class.name)
-    end
-
-    def collection_for(model_name)
-      draft.send(model_name.to_s.underscore.split('/').last.pluralize)
-    end
   end
 end

data/app/models/pageflow/image_file.rb

@@ -7,20 +7,10 @@ module Pageflow
 
     has_attached_file(:processed_attachment, Pageflow.config.paperclip_s3_default_options
                         .merge(:default_url => ':pageflow_placeholder',
-                               :styles => {
-                                 :thumbnail => ["100x100#", :JPG],
-                                 :navigation_thumbnail_small => ['85x47#', :JPG],
-                                 :navigation_thumbnail_large => ['170x95#', :JPG],
-                                 :thumbnail_overview_desktop => ['230x72#', :JPG],
-                                 :thumbnail_overview_mobile => ['200x112#', :JPG],
-
-                                 :link_thumbnail => ['192x108#', :JPG],
-                                 :link_thumbnail_large => ['394x226#', :JPG],
-
-                                 :print => ['300x300>', :JPG],
-                                 :medium => ['1024x1024>', :JPG],
-                                 :large => ['1920x1920>', :JPG]
-                               },
+                               :styles => Pageflow.config.thumbnail_styles
+                                 .merge(:print => ['300x300>', :JPG],
+                                        :medium => ['1024x1024>', :JPG],
+                                        :large => ['1920x1920>', :JPG]),
                                :convert_options => {
                                  :print => "-quality 10 -interlace Plane",
                                  :medium => "-quality 70 -interlace Plane",
@@ -37,6 +27,16 @@ module Pageflow
       self.unprocessed_attachment = value
     end
 
+    def thumbnail_url(*args)
+      processed_attachment.url(*args)
+    end
+
+    def url
+      if processed_attachment.present?
+        attachment.url(:large)
+      end
+    end
+
     private
 
     def save_image_dimensions

data/app/models/pageflow/page.rb

@@ -16,33 +16,16 @@ module Pageflow
       configuration['title'].presence || configuration['additional_title']
     end
 
-    def thumbnail
-      model_name, attachment, property, model_class = thumbnail_definition
+    def thumbnail_url(*args)
+      thumbnail_file.thumbnail_url(*args)
+    end
 
-      begin
-        model_name.to_s.camelcase.constantize.find(configuration[property]).send(attachment)
-      rescue ActiveRecord::RecordNotFound
-        ImageFile.new.processed_attachment
-      end
+    def thumbnail_file
+      ThumbnailFileResolver.new(page_type.thumbnail_candidates, configuration).find
     end
 
-    def thumbnail_definition
-      # TODO: this has to be refactored to be page type agnostic
-      if template == 'video' || template == 'background_video'
-        if configuration['poster_image_id'].present?
-          ['pageflow/image_file', :processed_attachment, 'poster_image_id', 'image_file']
-        else
-          ['pageflow/video_file', :poster, 'video_file_id', 'video_file']
-        end
-      else
-        if configuration['thumbnail_image_id'].present?
-          ['pageflow/image_file', :processed_attachment, 'thumbnail_image_id', 'image_file']
-        elsif configuration['after_image_id'].present?
-          ['pageflow/image_file', :processed_attachment, 'after_image_id','image_file']
-        else
-          ['pageflow/image_file', :processed_attachment, 'background_image_id', 'image_file']
-        end
-      end
+    def page_type
+      Pageflow.config.lookup_page_type(template)
     end
 
     def configuration

data/app/models/pageflow/published_entry.rb

@@ -8,6 +8,7 @@ module Pageflow
     delegate(:account, :theming, :to_model, :to_key, :persisted?, :to => :entry)
 
     delegate(:chapters, :pages,
+             :files,
              :image_files, :video_files, :audio_files,
              :title, :summary, :credits, :manual_start,
              :to => :revision)
@@ -26,8 +27,8 @@ module Pageflow
       revision.cache_key
     end
 
-    def thumbnail
-      pages.first.try(:thumbnail) || ImageFile.new.processed_attachment
+    def thumbnail_url(*args)
+      pages.first.try(:thumbnail_url, *args) || ImageFile.new.processed_attachment.url(*args)
     end
 
     def self.find(id, scope = Entry)

data/app/models/pageflow/revision.rb

@@ -33,6 +33,13 @@ module Pageflow
     validate :published_until_unchanged, :if => :published_until_was_in_past?
     validate :published_until_blank, :if => :published_at_blank?
 
+    def files(model)
+      model
+        .select("#{model.table_name}.*, pageflow_file_usages.id AS usage_id")
+        .joins(:usages)
+        .where(pageflow_file_usages: {revision_id: id})
+    end
+
     def creator
       super || NullUser.new
     end

data/app/models/pageflow/thumbnail_file_resolver.rb

@@ -0,0 +1,33 @@
+module Pageflow
+  class ThumbnailFileResolver < Struct.new(:candidates, :configuration)
+    class Null
+      def thumbnail_url(*args)
+        ImageFile.new.processed_attachment.url(*args)
+      end
+
+      def blank?
+        true
+      end
+    end
+
+    def find
+      candidates.reduce(nil) do |result, candidate|
+        result || file_model(candidate).find_by_id(record_id(candidate))
+      end || Null.new
+    end
+
+    private
+
+    def file_model(candidate)
+      file_type(candidate).model
+    end
+
+    def file_type(candidate)
+      Pageflow.config.file_types.find_by_collection_name!(candidate.fetch(:file_collection))
+    end
+
+    def record_id(candidate)
+      configuration[candidate.fetch(:attribute)]
+    end
+  end
+end

data/app/models/pageflow/video_file.rb

@@ -1,30 +1,16 @@
 module Pageflow
   class VideoFile < ActiveRecord::Base
+    include HostedFile
     include EncodedFileStateMachine
-    include UploadedFile
 
     belongs_to :confirmed_by, :class_name => 'User'
 
-    has_attached_file(:attachment_on_filesystem, Pageflow.config.paperclip_filesystem_default_options)
-
-    has_attached_file(:attachment_on_s3, Pageflow.config.paperclip_s3_default_options)
-
     has_attached_file(:poster, Pageflow.config.paperclip_s3_default_options
                         .merge(:default_url => ':pageflow_placeholder',
-                               :styles => {
-                                 :thumbnail  => ["100x100#", :JPG],
-                                 :navigation_thumbnail_small => ['85x47#', :JPG],
-                                 :navigation_thumbnail_large => ['170x95#', :JPG],
-                                 :thumbnail_overview_desktop => ['230x72#', :JPG],
-                                 :thumbnail_overview_mobile => ['200x112#', :JPG],
-
-                                 :link_thumbnail => ['192x108#', :JPG],
-                                 :link_thumbnail_large => ['394x226#', :JPG],
-
-                                 :medium => ['1920x1920>', :JPG],
-                                 :large => ['1024x1024>', :JPG],
-                                 :print => ['300x300>', :JPG]
-                               },
+                               :styles => Pageflow.config.thumbnail_styles
+                                 .merge(:medium => ['1920x1920>', :JPG],
+                                        :large => ['1024x1024>', :JPG],
+                                        :print => ['300x300>', :JPG]),
                                :convert_options => {
                                  :medium => "-quality 90 -interlace Plane",
                                  :large => "-quality 90 -interlace Plane",
@@ -34,26 +20,16 @@ module Pageflow
     has_attached_file(:thumbnail, Pageflow.config.paperclip_s3_default_options
                         .merge(:default_url => ':pageflow_placeholder',
                                :default_style => :thumbnail,
-                               :styles => {
-                                 :thumbnail  => ["100x100#", :JPG],
-                                 :navigation_thumbnail_small => ['85x47#', :JPG],
-                                 :navigation_thumbnail_large => ['170x95#', :JPG],
-                                 :thumbnail_overview_desktop => ['230x72#', :JPG],
-                                 :thumbnail_overview_mobile => ['200x112#', :JPG],
-                                 :medium => ['1920x1920>', :JPG],
-                                 :large => ['1024x1024>', :JPG],
-                               },
+                               :styles => Pageflow.config.thumbnail_styles
+                                 .merge(:medium => ['1920x1920>', :JPG],
+                                        :large => ['1024x1024>', :JPG]),
                                :convert_options => {
                                  :medium => "-quality 60 -interlace Plane",
                                  :large => "-quality 60 -interlace Plane"
                                }))
 
-    def attachment
-      attachment_on_s3.present? ? attachment_on_s3 : attachment_on_filesystem
-    end
-
-    def attachment=(value)
-      self.attachment_on_filesystem = value
+    def thumbnail_url(*args)
+      poster.url(*args)
     end
 
     def attachment_s3_url

data/app/models/pageflow/zencoder_attachment.rb

@@ -14,7 +14,7 @@ module Pageflow
     def initialize(instance, file_name_pattern, options = {})
       @instance = instance
       @file_name_pattern = file_name_pattern
-      @options = options.merge(default_options)
+      @options = options.reverse_merge(default_options)
 
       @styles = {}
     end
@@ -47,7 +47,7 @@ module Pageflow
     private
 
     def ensure_default_protocol(url, url_options)
-      url =~ /^http/ ? url : [url_options[:default_protocol], url].compact.join(':')
+      url =~ %r'^//' ? [url_options[:default_protocol], url].compact.join(':') : url
     end
 
     def url_pattern(url_options)

data/app/state_machines/pageflow/encoded_file_state_machine.rb

@@ -3,11 +3,7 @@ module Pageflow
     extend ActiveSupport::Concern
 
     included do
-      state_machine :initial => 'not_uploaded_to_s3' do
-        extend StateMachineJob::Macro
-
-        state 'not_uploaded_to_s3'
-        state 'uploading_to_s3'
+      processing_state_machine do
         state 'waiting_for_meta_data'
         state 'fetching_meta_data'
         state 'waiting_for_confirmation'
@@ -15,17 +11,15 @@ module Pageflow
         state 'encoding'
         state 'encoded'
 
-        state 'upload_to_s3_failed'
         state 'fetching_meta_data_failed'
         state 'encoding_failed'
 
-        event :publish do
-          transition 'not_uploaded_to_s3' => 'uploading_to_s3'
+        event :process do
+          transition any => 'waiting_for_meta_data', :if => lambda { Pageflow.config.confirm_encoding_jobs }
+          transition any => 'waiting_for_encoding'
         end
 
         event :retry do
-          transition 'upload_to_s3_failed' => 'uploading_to_s3'
-
           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 }
 
@@ -33,16 +27,6 @@ module Pageflow
           transition 'encoded' => 'waiting_for_encoding'
         end
 
-        job UploadFileToS3Job do
-          on_enter 'uploading_to_s3'
-          result :pending, :retry_after => 30.seconds
-
-          result :ok, :state => 'waiting_for_meta_data', :if => lambda { Pageflow.config.confirm_encoding_jobs }
-          result :ok, :state => 'waiting_for_encoding'
-
-          result :error => 'uploading_to_s3_failed'
-        end
-
         job RequestMetaDataFromZencoderJob do
           on_enter 'waiting_for_meta_data'
           result :ok => 'fetching_meta_data'
@@ -86,5 +70,9 @@ module Pageflow
         end
       end
     end
+
+    def retryable?
+      can_retry? && !encoded?
+    end
   end
 end