pageflow 0.4.0 → 0.5.0

data/config/locales/activerecord.de.yml

@@ -122,14 +122,14 @@ de:
         description: "Beschreibung für Übersicht"
         additional_title: "Titel für Infobox"
         additional_description: "Beschreibung für Infobox"
-        gradient_opacity: "Intensität des Farverlaufs"
+        gradient_opacity: "Intensität des Farbverlaufs"
         invert: "Farben invertieren"
         transition: "Übergangseffekt"
         display_in_navigation: "In Navigationsleiste anzeigen"
         allow_full_screen: "Vollbild Anzeige erlauben"
         autoplay: "automatisch abspielen"
         background_image_id: "Hintergrundbild"
-        thumbnail_image_id: "Hintergrundbild"
+        thumbnail_image_id: "Thumbnail"
         background_video_id: "Hintergrundvideo"
         video_file_id: "Video"
         audio_file_id: "Audio"
@@ -164,6 +164,7 @@ de:
           background_video: "Hintergrund-Video"
           video: "Video"
           audio: "Audio"
+          audio_loop: "Hintergrund-Audio"
           internal_links: "Seiten-Verweise"
         transition:
           scroll: "Scrollen"

data/config/locales/pageflow/audio.de.yml

@@ -0,0 +1,4 @@
+de:
+  pageflow:
+    audio:
+      open: "Audio anhören"

data/config/locales/pageflow/editor/errors.de.yml

@@ -0,0 +1,6 @@
+de:
+  pageflow:
+    editor:
+      errors:
+        unknown: "Ein unbekannter Fehler ist aufgetreten."
+        "UnmatchedUploadError": "Der Dateityp wird nicht unterstützt."

data/config/routes.rb

@@ -24,19 +24,12 @@ Pageflow::Engine.routes.draw do
 
     namespace :editor do
       resources :entries, :only => :index, :shallow => true do
-        resources :image_files, :only => [:index, :create, :update] do
-          get :retry, :on => :member
-        end
-
-        resources :video_files, :only => [:index, :create, :update] do
-          get :retry, :on => :member
-        end
-
-        resources :audio_files, :only => [:index, :create, :update] do
+        resources :files, :path => 'files/:collection_name', :only => [:index, :create, :update] do
           get :retry, :on => :member
         end
 
         resources :file_usages, :only => [:create, :destroy]
+
         resources :encoding_confirmations, :only => [:create] do
           post :check, :on => :collection
         end
@@ -50,7 +43,8 @@ Pageflow::Engine.routes.draw do
     root :to => redirect('/admin')
   end
 
-  get ':entry_id/videos/:id', :to => 'video_files#show', :as => :short_video_file
+  get ':entry_id/videos/:id', :to => 'files#show', :as => :short_video_file, :defaults => {:collection_name => 'video_files'}
+  get ':entry_id/audio/:id', :to => 'files#show', :as => :short_audio_file, :defaults => {:collection_name => 'audio_files'}
 
   resources :entries, :only => [:show]
   get ':id', :to => 'entries#show', :as => :short_entry

data/lib/generators/pageflow/initializer/templates/pageflow.rb

@@ -4,7 +4,7 @@ ActiveAdmin.application.load_paths.unshift(Dir[Pageflow::Engine.root.join('admin
 Pageflow.configure do |config|
   # The email address to use as from header in invitation mails to new
   # users.
-  config.mailer_sender = 'change-me-in-at-config-initializers-pageflow@example.com'
+  config.mailer_sender = 'change-me-at-config-initializers-pageflow@example.com'
 
   # Page types available in the editor. Add futher page types from
   # page type engines below.
@@ -12,6 +12,7 @@ Pageflow.configure do |config|
   config.register_page_type(Pageflow::BuiltInPageType.background_video)
   config.register_page_type(Pageflow::BuiltInPageType.video)
   config.register_page_type(Pageflow::BuiltInPageType.audio)
+  config.register_page_type(Pageflow::BuiltInPageType.audio_loop)
   config.register_page_type(Pageflow::BuiltInPageType.internal_links)
   # config.register_page_type(Pageflow::Rainbow::PageType.new)
 

data/lib/pageflow.rb

@@ -20,16 +20,18 @@ module Pageflow
   def self.configure!
     return unless @finalized
 
-    @config = Configuration.new
+    config = Configuration.new
     @configure_blocks ||= []
 
     @configure_blocks.each do |block|
-      block.call(@config)
+      block.call(config)
     end
 
     @after_configure_blocks.each do |block|
-      block.call(@config)
+      block.call(config)
     end
+
+    @config = config
   end
 
   def self.finalize!

data/lib/pageflow/ability_mixin.rb

@@ -17,7 +17,7 @@ module Pageflow
         can_edit_entry?(user, record.entry)
       end
 
-      can :manage, [ImageFile, VideoFile, AudioFile] do |record|
+      can :manage, Pageflow.config.file_types.map(&:model) do |record|
         can_edit_any_entry_using_file?(user, record)
       end
 
@@ -47,7 +47,7 @@ module Pageflow
         can :manage, Folder
         can :manage, [Entry, Revision]
         can :manage, [Chapter, Page]
-        can :manage, [ImageFile, VideoFile, AudioFile]
+        can :manage, Pageflow.config.file_types.map(&:model)
 
         can :manage, Resque
       elsif user.account_manager?

data/lib/pageflow/built_in_page_type.rb

@@ -1,10 +1,23 @@
 module Pageflow
   # Definition of page type located inside the Pageflow gem.
   class BuiltInPageType < PageType
-    attr_reader :name
+    attr_reader :name, :file_type_models
 
-    def initialize(name)
+    def initialize(name, options = {})
       @name = name.to_s
+      @file_type_models = options.fetch(:file_type_models, [])
+      @thumbnail_candidates = options.fetch(:thumbnail_candidates, nil)
+    end
+
+    def file_types
+      @file_types ||= file_type_models.map do |model_name|
+        model = model_name.constantize
+        base_name = model_name.underscore.split('/').last
+
+        FileType.new(model: model,
+                     editor_partial: "pageflow/editor/#{base_name.pluralize}/#{base_name}",
+                     collection_name: base_name.pluralize)
+      end
     end
 
     def template_path
@@ -15,28 +28,48 @@ module Pageflow
       "activerecord.values.pageflow/page.template.#{name}"
     end
 
+    def thumbnail_candidates
+      @thumbnail_candidates.presence || super
+    end
+
     # Factory methods to decouple Pageflow initializers from concrete
     # page type classes, so we might decide later to create a
     # VideoPageType subclass etc.
 
     def self.audio
-      new('audio')
+      new('audio', file_type_models: ['Pageflow::ImageFile', 'Pageflow::AudioFile'])
+    end
+
+    def self.audio_loop
+      new('audio_loop', file_type_models: ['Pageflow::ImageFile', 'Pageflow::AudioFile'])
     end
 
     def self.background_image
-      new('background_image')
+      new('background_image', file_type_models: ['Pageflow::ImageFile'])
     end
 
     def self.background_video
-      new('background_video')
+      new('background_video',
+          file_type_models: ['Pageflow::ImageFile', 'Pageflow::VideoFile'],
+          thumbnail_candidates: video_thumbnail_candidates)
     end
 
     def self.internal_links
-      new('internal_links')
+      new('internal_links', file_type_models: ['Pageflow::ImageFile'])
     end
 
     def self.video
-      new('video')
+      new('video',
+          file_type_models: ['Pageflow::ImageFile', 'Pageflow::VideoFile'],
+          thumbnail_candidates: video_thumbnail_candidates)
+    end
+
+    def self.video_thumbnail_candidates
+      [
+        {file_collection: 'image_files', attribute: 'thumbnail_image_id'},
+        {file_collection: 'image_files', attribute: 'poster_image_id'},
+        {file_collection: 'video_files', attribute: 'video_file_id'}
+      ]
     end
   end
 end

data/lib/pageflow/configuration.rb

@@ -60,6 +60,19 @@ module Pageflow
     # @return [Themes]
     attr_reader :themes
 
+    # List of {FileType} instances provided by page types.
+    # @return [FileTypes]
+    attr_reader :file_types
+
+    # Paperclip style definitions of thumbnails used by Pageflow.
+    # @return Hash
+    attr_accessor :thumbnail_styles
+
+    # Names of Paperclip styles that shall be rendered into entry
+    # specific stylesheets.
+    # @return Array<Symbol>
+    attr_accessor :css_rendered_thumbnail_styles
+
     # Either a lambda or an object with a `match?` method, to restrict
     # access to the editor routes defined by Pageflow.
     #
@@ -133,6 +146,10 @@ module Pageflow
       @hooks = Hooks.new
       @quotas = Quotas.new
       @themes = Themes.new
+      @file_types = FileTypes.new(page_types)
+
+      @thumbnail_styles = {}
+      @css_rendered_thumbnail_styles = Pageflow::PagesHelper::CSS_RENDERED_THUMBNAIL_STYLES
 
       @theming_request_scope = CnameThemingRequestScope.new
       @public_entry_request_scope = lambda { |entries, request| entries }

data/lib/pageflow/file_type.rb

@@ -0,0 +1,60 @@
+module Pageflow
+  # Describes a type of file that can be managed in the editor and
+  # used in revisions.
+  class FileType
+    class NotFoundError < RuntimeError
+    end
+
+    # ActiveRecord model that represents the files of this type.
+    # @return {ActiveRecord::Model}
+    attr_reader :model
+
+    # Path of the partial used to render a json representation of the
+    # file.
+    # @return {String}
+    attr_reader :editor_partial
+
+    # Underscored plural name for usage in routes.
+    # @return {String}
+    attr_reader :collection_name
+
+    # Create file type to be returned in {PageType#file_types}.
+    #
+    # @example
+    #
+    #   Pageflow::FileType.new(model: Pageflow::Rainbow::File,
+    #                          editor_partial: 'pageflow/rainbow/editor/files/file')
+    #
+    # @param [Hash] options
+    # @option options [ActiveRecord::Base] :model  Required. Model
+    #   representing the file.
+    # @option options [String] :editor_partial  Optional. Path of a
+    #   partial to include in json representations of the file.
+    # @option options [String] :collection_name  Optional. String to
+    #   be used in routes. Defaults to `"pageflow_rainbow_file"` for
+    #   model `Pageflow::Rainbow::File`.
+    def initialize(options)
+      @model = options.fetch(:model)
+      @editor_partial = options.fetch(:editor_partial, nil)
+      @collection_name = options.fetch(:collection_name, model.model_name.plural)
+    end
+
+    # @api private
+    def param_key
+      model.model_name.param_key.to_sym
+    end
+
+    # @api private
+    alias_method :short_name, :param_key
+
+    # @api private
+    def type_name
+      model.name
+    end
+
+    # @api private
+    def i18n_key
+      model.model_name.i18n_key
+    end
+  end
+end

data/lib/pageflow/file_types.rb

@@ -0,0 +1,25 @@
+module Pageflow
+  class FileTypes
+    include Enumerable
+
+    def initialize(page_types)
+      @page_types = page_types
+    end
+
+    def each(&block)
+      @page_types.map(&:file_types).flatten.uniq(&:model).each(&block)
+    end
+
+    def find_by_collection_name!(collection_name)
+      detect do |file_type|
+        file_type.collection_name == collection_name
+      end || raise(FileType::NotFoundError, "No file type found for collection name '#{collection_name}'.")
+    end
+
+    def with_thumbnail_support
+      select do |file_type|
+        file_type.model.instance_methods.include?(:thumbnail_url)
+      end
+    end
+  end
+end

data/lib/pageflow/page_type.rb

@@ -66,6 +66,37 @@ module Pageflow
       []
     end
 
+    # File types to enable when this page type is registered..
+    # @returns {Array<FileType>}
+    def file_types
+      []
+    end
+
+    # A list of hashes used to determine a thumbnail for a page. Each
+    # hash in the list must contain two keys: `attribute` and
+    # `file_collection`.
+    #
+    # For each item, the given attribute is fetched from the page
+    # configuration and used to find a file from the given
+    # collection. `file_collection` must equal the collection_name of
+    # a registered {FileType}. The first file found is used as
+    # thumbnail.
+    #
+    # @example Default return value
+    #
+    #     [
+    #       {attribute: 'thumbnail_image_id', file_collection: 'image_files'},
+    #       {attribute: 'background_image_id', file_collection: 'image_files'}
+    #     ]
+    #
+    # @returns {Array<Hash>}
+    def thumbnail_candidates
+      [
+        {attribute: 'thumbnail_image_id', file_collection: 'image_files'},
+        {attribute: 'background_image_id', file_collection: 'image_files'}
+      ]
+    end
+
     # View path of a template containing additional json to pass to
     # the editor. The data is available in the javascript definition
     # of the page type's configuration editor. By default nothing is

data/lib/pageflow/version.rb

@@ -1,3 +1,3 @@
 module Pageflow
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/pageflow/zencoder_video_output_definition.rb

@@ -169,15 +169,15 @@ module Pageflow
     def hls_stream_definitions
       [
         {
-          :path => video_file.hls_medium.url(default_protocol: 'http'),
+          :path => video_file.hls_medium.url(host: :hls_origin, default_protocol: 'http'),
           :bandwidth => 2250
         },
         {
-          :path => video_file.hls_low.url(default_protocol: 'http'),
+          :path => video_file.hls_low.url(host: :hls_origin, default_protocol: 'http'),
           :bandwidth => 256
         },
         {
-          :path => video_file.hls_high.url(default_protocol: 'http'),
+          :path => video_file.hls_high.url(host: :hls_origin, default_protocol: 'http'),
           :bandwidth => 3750
         }
       ]

data/spec/factories/audio_files.rb

@@ -24,10 +24,10 @@ module Pageflow
         state 'not_uploaded_to_s3'
       end
 
-      trait :upload_to_s3_failed do
+      trait :uploading_to_s3_failed do
         attachment_on_filesystem File.open(Engine.root.join('spec', 'fixtures', 'et.ogg'))
         attachment_on_s3 nil
-        state 'upload_to_s3_failed'
+        state 'uploading_to_s3_failed'
       end
 
       trait :waiting_for_confirmation do

data/spec/factories/hosted_files.rb

@@ -0,0 +1,35 @@
+module Pageflow
+  FactoryGirl.define do
+    hosted_file_model = Class.new(ActiveRecord::Base) do
+      self.table_name = 'test_hosted_files'
+      include HostedFile
+    end
+
+    factory :hosted_file, class: hosted_file_model do
+      trait :on_filesystem do
+        attachment_on_filesystem File.open(Engine.root.join('spec', 'fixtures', 'image.png'))
+        attachment_on_s3 nil
+        state 'not_uploaded_to_s3'
+      end
+
+      trait :uploading_to_s3_failed do
+        attachment_on_filesystem File.open(Engine.root.join('spec', 'fixtures', 'image.png'))
+        attachment_on_s3 nil
+        state 'uploading_to_s3_failed'
+      end
+
+      trait :uploaded_to_s3 do
+        attachment_on_s3 File.open(Engine.root.join('spec', 'fixtures', 'image.png'))
+        state 'uploaded_to_s3'
+      end
+
+      trait :with_overridden_keep_on_filesystem do
+        after(:build) do |hosted_file|
+          def hosted_file.keep_on_filesystem_after_upload_to_s3?
+            true
+          end
+        end
+      end
+    end
+  end
+end