pageflow 0.11.4 → 12.0.0.rc1

data/lib/pageflow/configuration.rb

@@ -169,6 +169,11 @@ module Pageflow
     #     end
     attr_accessor :public_entry_url_options
 
+    # Either a lambda or an object with a `call` method taking a
+    # {Theming} as paramater and returing a hash of options used to
+    # construct the embed url of a published entry.
+    attr_accessor :entry_embed_url_options
+
     # Submit video/audio encoding jobs only after the user has
     # explicitly confirmed in the editor. Defaults to false.
     attr_accessor :confirm_encoding_jobs
@@ -234,7 +239,7 @@ module Pageflow
     #
     #     config.authorize_user_deletion =
     #       lambda do |user_to_delete|
-    #         if user_to_delete.account.users.length > 1
+    #         if user_to_delete.accounts.all? { |account| account.users.size > 1 }
     #           true
     #         else
     #           'Last user on account. Permission denied'
@@ -243,6 +248,10 @@ module Pageflow
     # @since 0.11
     attr_accessor :authorize_user_deletion
 
+    # Array of values that the `kind` attribute on text tracks can
+    # take. Defaults to `[:captions, :subtitles, :descriptions]`.
+    attr_reader :available_text_track_kinds
+
     def initialize
       @paperclip_filesystem_default_options = {validate_media_type: false}
       @paperclip_s3_default_options = {validate_media_type: false}
@@ -266,6 +275,7 @@ module Pageflow
       @theming_request_scope = CnameThemingRequestScope.new
       @public_entry_request_scope = lambda { |entries, request| entries }
       @public_entry_url_options = Pageflow::ThemingsHelper::DEFAULT_PUBLIC_ENTRY_OPTIONS
+      @entry_embed_url_options = {protocol: 'https'}
 
       @confirm_encoding_jobs = false
 
@@ -282,6 +292,8 @@ module Pageflow
       @default_publisher_meta_tag = 'Pageflow'
 
       @authorize_user_deletion = lambda { |_user| true }
+
+      @available_text_track_kinds = [:captions, :subtitles, :descriptions]
     end
 
     # Activate a plugin.

data/lib/pageflow/engine.rb

@@ -9,6 +9,7 @@ require 'cancan'
 require 'jbuilder'
 require 'htmlentities'
 require 'kramdown'
+require 'react-rails'
 
 require 'resque_mailer'
 require 'resque_scheduler'
@@ -16,7 +17,6 @@ require 'resque_scheduler'
 require 'active_admin'
 
 require 'jquery-layout-rails'
-require 'videojs_rails'
 require 'backbone-rails'
 require 'marionette-rails'
 require 'jquery-fileupload-rails'
@@ -25,6 +25,11 @@ require 'i18n-js'
 require 'http_accept_language'
 require 'pageflow-public-i18n'
 
+if Gem::Specification.find_all_by_name('pageflow-react', '>= 0.0').any?
+  fail('The pageflow-react gem has been merged into the pageflow gem. ' \
+       'See the pageflow changelog for update instructions.')
+end
+
 module Pageflow
   # Rails integration
   class Engine < ::Rails::Engine

data/lib/pageflow/file_type.rb

@@ -5,18 +5,29 @@ module Pageflow
     class NotFoundError < RuntimeError
     end
 
-    # ActiveRecord model that represents the files of this type.
-    # @return {ActiveRecord::Model}
-    attr_reader :model
+    # Path of a partial rendered in the json representation of the
+    # file in both the editor and published entries
+    # @return {String}
+    attr_reader :partial
 
-    # Path of the partial used to render a json representation of the
-    # file.
+    # Path of a partial rendered in the json representation of the
+    # file inside the editor.
     # @return {String}
     attr_reader :editor_partial
 
-    # Underscored plural name for usage in routes.
-    # @return {String}
-    attr_reader :collection_name
+    # File types that are allowed to be nested inside the file
+    # @return {Array<FileType>}
+    attr_reader :nested_file_types
+
+    # Is this file type used in situations where it is not nested into
+    # another file type?
+    # @return {Boolean}
+    attr_reader :top_level_type
+
+    # Callable that returns a hash of url template strings indexed by
+    # their names.
+    # @return [#call]
+    attr_reader :url_templates
 
     # Create file type to be returned in {PageType#file_types}.
     #
@@ -26,17 +37,51 @@ module Pageflow
     #                          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 [ActiveRecord::Base, String] :model
+    #   Required. Model representing the file, or name of that model.
+    # @option options [String] :partial
+    #   Optional. Path of a partial to include in json representations
+    #   of the file both inside  the editor and published entries.
+    # @option options [String] :editor_partial
+    #   Optional. Path of a partial to include in json representations
+    #   of the file inside the editor.
     # @option options [String] :collection_name  Optional. String to
     #   be used in routes. Defaults to `"pageflow_rainbow_file"` for
     #   model `Pageflow::Rainbow::File`.
+    # @option options [Array<FileType>] :nested_file_types
+    #   Optional. Array of FileTypes allowed for nested files. Defaults to [].
+    # @option options [#call] :url_templates
+    #   Optional. Callable returning a hash of url template strings
+    #   indexed by their names.
     def initialize(options)
-      @model = options.fetch(:model)
-      @editor_partial = options.fetch(:editor_partial, nil)
-      @collection_name = options.fetch(:collection_name, model.model_name.plural)
+      @model_string_or_reference = options.fetch(:model)
+      @partial = options[:partial]
+      @editor_partial = options[:editor_partial]
+      @collection_name_or_blank = options[:collection_name]
+      @nested_file_types = options.fetch(:nested_file_types, [])
+      @top_level_type = options.fetch(:top_level_type, false)
+      @url_templates = options.fetch(:url_templates, ->() { {} })
+    end
+
+    # ActiveRecord model that represents the files of this type.
+    # @return {ActiveRecord::Model}
+    def model
+      @model ||=
+        if @model_string_or_reference.is_a?(String)
+          @model_string_or_reference.constantize
+        else
+          @model_string_or_reference
+        end
+    end
+
+    # Underscored plural name for usage in routes.
+    # @return {String}
+    def collection_name
+      if @collection_name_or_blank.blank?
+        model.model_name.plural
+      else
+        @collection_name_or_blank
+      end
     end
 
     # @api private

data/lib/pageflow/file_types.rb

@@ -7,13 +7,22 @@ module Pageflow
     end
 
     def each(&block)
-      @page_types.map(&:file_types).flatten.uniq(&:model).each(&block)
+      first_level_file_types = @page_types.map(&:file_types).flatten
+      lower_level_file_types = search_for_nested_file_types(first_level_file_types)
+      (first_level_file_types + lower_level_file_types).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 || raise(FileType::NotFoundError,
+                   "No file type found for collection name '#{collection_name}'.")
+    end
+
+    def find_by_model!(model)
+      detect do |file_type|
+        file_type.model == model
+      end || raise(FileType::NotFoundError, "No file type found for '#{model.name}'.")
     end
 
     def with_thumbnail_support
@@ -21,5 +30,14 @@ module Pageflow
         file_type.model.instance_methods.include?(:thumbnail_url)
       end
     end
+
+    private
+
+    def search_for_nested_file_types(higher_level_file_types)
+      higher_level_file_types.map { |file_type|
+        file_type.nested_file_types +
+          search_for_nested_file_types(file_type.nested_file_types)
+      }.flatten
+    end
   end
 end

data/lib/pageflow/page_type.rb

@@ -104,18 +104,67 @@ module Pageflow
     # 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'}
     #     ]
     #
+    # It is possible to specify further conditions under which the
+    # candidate may be used via `if` or `unless` keys:
+    #
+    #     [
+    #       {
+    #         attribute: 'video_id',
+    #         file_collection: 'video_files',
+    #         if: {
+    #           attribute: 'background_type',
+    #           value: 'video',
+    #         }
+    #       },
+    #       {
+    #         attribute: 'image_id',
+    #         file_collection: 'image_files',
+    #         unless: {
+    #           attribute: 'background_type',
+    #           value: 'video',
+    #         }
+    #       }
+    #     ]
+    #
+    # The candidate will only be used if the given attribute has the
+    # given value.
+    #
     # @returns {Array<Hash>}
     def thumbnail_candidates
       [
-        {attribute: 'thumbnail_image_id', file_collection: 'image_files'},
-        {attribute: 'background_image_id', file_collection: 'image_files'}
+        {
+          file_collection: 'image_files',
+          attribute: 'thumbnail_image_id'
+        },
+        {
+          file_collection: 'image_files',
+          attribute: 'background_image_id',
+          unless: {
+            attribute: 'background_type',
+            value: 'video'
+          }
+        },
+        {
+          file_collection: 'image_files',
+          attribute: 'poster_image_id',
+          if: {
+            attribute: 'background_type',
+            value: 'video'
+          }
+        },
+        {
+          file_collection: 'video_files',
+          attribute: 'video_file_id',
+          if: {
+            attribute: 'background_type',
+            value: 'video'
+          }
+        }
       ]
     end
 

data/lib/pageflow/page_types.rb

@@ -3,6 +3,10 @@ module Pageflow
     include Enumerable
 
     def initialize
+      clear
+    end
+
+    def clear
       @page_types = []
       @page_types_by_name = {}
     end

data/lib/pageflow/paperclip_processors/vtt.rb

@@ -0,0 +1,35 @@
+require 'webvtt'
+require 'fileutils'
+
+module Pageflow
+  module PaperclipProcessors
+    class Vtt < Paperclip::Processor
+      def make
+        destination = make_tempfile_for(file.path)
+
+        if File.extname(file.path) =~ /\.srt$/
+          srt_to_vtt(file.path, destination.path)
+        else
+          FileUtils.cp(file.path, destination.path)
+        end
+
+        destination
+      end
+
+      private
+
+      def srt_to_vtt(source_path, destination_path)
+        WebVTT.convert_from_srt(source_path, destination_path)
+      end
+
+      def make_tempfile_for(path)
+        basename = File.basename(path, File.extname(path))
+
+        tempfile = Tempfile.new([basename, '.vtt'])
+        tempfile.binmode
+
+        tempfile
+      end
+    end
+  end
+end

data/lib/pageflow/react.rb

@@ -0,0 +1,11 @@
+module Pageflow
+  module React
+    def self.create_page_type(name, options = {})
+      Pageflow::React::PageType.new(name, options)
+    end
+
+    def self.create_widget_type(name, role)
+      Pageflow::React::WidgetType.new(name, role)
+    end
+  end
+end

data/lib/pageflow/react/page_type.rb

@@ -0,0 +1,26 @@
+module Pageflow
+  module React
+    class PageType < Pageflow::PageType
+      attr_reader :name, :component_name, :file_types
+
+      def initialize(name, options)
+        @name = name
+        @thumbnail_candidates = options[:thumbnail_candidates]
+        @translation_key_prefix = options[:translation_key_prefix]
+        @file_types = options.fetch(:file_types, [])
+      end
+
+      def template_path
+        'pageflow/react/page'
+      end
+
+      def thumbnail_candidates
+        @thumbnail_candidates || super
+      end
+
+      def translation_key_prefix
+        @translation_key_prefix || super
+      end
+    end
+  end
+end

data/lib/pageflow/react/widget_type.rb

@@ -0,0 +1,20 @@
+module Pageflow
+  module React
+    class WidgetType < Pageflow::WidgetType
+      attr_reader :name, :role
+
+      def initialize(name, role)
+        @name = name
+        @role = role
+      end
+
+      def roles
+        [role]
+      end
+
+      def render(template, _)
+        template.render(File.join('pageflow', 'react', 'widget'), name: name)
+      end
+    end
+  end
+end

data/lib/pageflow/seeds.rb

@@ -65,7 +65,7 @@ module Pageflow
       account.build_default_theming(default_attributes.merge(attributes), &block)
     end
 
-    # Create a {User} if non with the given email exists yet.
+    # Create a {User} if none with the given email exists yet.
     #
     # @param [Hash] attributes  attributes to override defaults
     # @option attributes [String] :email  required
@@ -111,33 +111,55 @@ module Pageflow
       entry = Entry.where(attributes.slice(:account, :title)).first
 
       if entry.nil?
-        entry = Entry.create!(attributes) do |entry|
-          entry.theming = attributes.fetch(:account).default_theming
+        entry = Entry.create!(attributes) do |created_entry|
+          created_entry.theming = attributes.fetch(:account).default_theming
 
-          say_creating_entry(entry)
-          yield(entry) if block_given?
+          say_creating_entry(created_entry)
+          yield(created_entry) if block_given?
         end
 
         storyline = entry.draft.storylines.first
 
-        chapter = storyline.chapters.create!(title: 'Chapter 1')
+        chapter = storyline.chapters.create!(title: 'Chapter 1', position: 0)
         chapter.pages.create!(template: 'background_image')
         chapter.pages.create!(template: 'background_image')
 
-        chapter = storyline.chapters.create!(title: 'Chapter 2')
+        chapter = storyline.chapters.create!(title: 'Chapter 2', position: 1)
         chapter.pages.create!(template: 'video')
       end
 
       entry
     end
 
-    # Create a {Membership} for the given user and entry.
+    # Create a {Membership} for the given user and entity.
+    # Create a {Membership} for the corresponding account first if a {Membership} on an entry is to
+    # be created and no {Membership} on the entry's account exists yet.
     #
     # @param [Hash] attributes  attributes to override defaults
     # @option attributes [User] :user  required
-    # @option attributes [Entry] :entry  required
+    # @option attributes [Entity] :entity  required
+    # :entry and :account are lower-priority aliases for :entity
     # @return [Membership] newly created membership
     def membership(attributes)
+      if (attributes[:entry].present? && attributes[:entity].present?) ||
+         (attributes[:account].present? && attributes[:entity].present?)
+        say_attribute_precedence(':entity', ':entry and :account')
+      end
+      unless attributes[:entity].present?
+        entry_or_account_attributes_specified attributes
+      end
+
+      if attributes[:entity].is_a?(Entry) || attributes[:entry].present?
+        entry = attributes[:entity] || attributes[:entry]
+        unless attributes[:user].accounts.include?(entry.account)
+          Membership.find_or_create_by!(entity: entry.account,
+                                        user: attributes[:user],
+                                        role: :member) do |membership|
+            say_creating_membership(membership)
+          end
+        end
+      end
+
       Membership.find_or_create_by!(attributes) do |membership|
         say_creating_membership(membership)
       end
@@ -150,25 +172,47 @@ module Pageflow
     end
 
     def say_creating_user(user)
-     say(<<-END)
-   #{user.role} user:
+      say(<<-END)
+
+   user with login:
 
-     email:     #{user.email}
-     password:  #{user.password}
+   email:     #{user.email}
+   password:  #{user.password}
 
 END
     end
 
     def say_creating_entry(entry)
-      say("   sample entry '#{entry.title}'")
+      say("   sample entry '#{entry.title}'\n")
     end
 
     def say_creating_membership(membership)
-      say("   membership for user '#{membership.user.email}' and entry '#{membership.entry.title}'")
+      say("   -- '#{membership.role}' membership for user '#{membership.user.email}' on " +
+          "#{membership.entity_type == 'Pageflow::Entry' ? 'entry' : 'account'} " +
+          %|'#{if membership.entity_type == "Pageflow::Entry"
+                 membership.entity.title
+               else
+                 membership.entity.name
+               end}'\n|)
+    end
+
+    def say_attribute_precedence(subject, object)
+      say("   #{subject} attribute precedes #{object}")
     end
 
     def say(text)
       puts(text) unless Rails.env.test?
     end
+
+    def entry_or_account_attributes_specified(attributes)
+      if attributes[:entry].present? || attributes[:account].present?
+        attributes[:entity] = attributes[:entry]
+        if attributes[:account].present?
+          say_attribute_precedence(':entry', ':account')
+        end
+      else
+        attributes[:entity] = attributes[:account]
+      end
+    end
   end
 end