pageflow 0.11.4 → 12.0.0.rc1

data/lib/pageflow.rb

@@ -14,6 +14,10 @@ module Pageflow
         resources :entries do
           resources :memberships
         end
+
+        resources :accounts do
+          resources :memberships
+        end
       end
 
       mount Pageflow::Engine, at: '/'
@@ -29,4 +33,8 @@ module Pageflow
   def self.active_admin_load_path
     Dir[Pageflow::Engine.root.join('admins')].first
   end
+
+  def self.built_in_page_types_plugin
+    BuiltInPageTypesPlugin.new
+  end
 end

data/lib/pageflow/ability_mixin.rb

@@ -5,101 +5,235 @@ module Pageflow
     def pageflow_default_abilities(user)
       return if user.nil?
 
-      can :read, Folder, :id => user.entries.map(&:folder_id)
+      can :read, Account, AccountPolicy::Scope.new(user, Account).resolve do |account|
+        AccountPolicy.new(user, account).read?
+      end
 
-      can [:read, :use_files], Entry, :id => user.entry_ids
+      can :update, Account do |account|
+        AccountPolicy.new(user, account).update?
+      end
 
-      can [:edit, :update, :edit_outline, :publish, :restore, :snapshot, :confirm_encoding], Entry do |entry|
-        can_edit_entry?(user, entry)
+      can :index, Account do |account|
+        AccountPolicy.new(user, account).index?
       end
 
-      can :manage, Storyline do |storyline|
-        can_edit_entry?(user, storyline.revision.entry)
+      can :add_member_to, Account do |account|
+        AccountPolicy.new(user, account).add_member_to?
       end
 
-      can :manage, Chapter do |record|
-        can_edit_entry?(user, record.entry)
+      can :see_badge_belonging_to, Account do |account|
+        AccountPolicy.new(user, account).see_badge_belonging_to?
       end
 
-      can :manage, Pageflow.config.file_types.map(&:model) do |record|
-        can_edit_any_entry_using_file?(user, record)
+      can :create, Membership do |membership|
+        membership.entity.nil? ||
+          membership.user.nil? ||
+          (!(membership.user.entries.include?(membership.entity) ||
+             membership.user.accounts.include?(membership.entity))) &&
+            MembershipPolicy.new(user, membership).create?
       end
 
-      can :manage, Page do |page|
-        can_edit_entry?(user, page.chapter.entry)
+      can :index, Membership, MembershipPolicy::Scope.new(user, Membership).indexable
+
+      can :update, Membership do |membership|
+        MembershipPolicy.new(user, membership).edit_role?
       end
 
-      can :manage, Revision do |revision|
-        can_edit_entry?(user, revision.entry)
+      can :destroy, Membership do |membership|
+        MembershipPolicy.new(user, membership).destroy?
       end
 
-      can :view, [Admin::MembersTab, Admin::RevisionsTab]
+      can :set_admin, ::User do |managed_user|
+        UserPolicy.new(user, managed_user).set_admin?
+      end
 
-      can :delete_own_user, ::User do |user_to_delete|
-        Pageflow.config.authorize_user_deletion.call(user_to_delete) == true
+      can :see, :accounts do
+        user.admin? || user.memberships.on_accounts.length > 1
       end
 
-      if user.admin?
-        can [:read, :create, :update], Account
-        can :destroy, Account do |account|
-          account.users.empty? && account.entries.empty?
+      can :see_own_role_on, :accounts do
+        !user.admin?
+      end
+
+      can :index, :accounts do
+        AccountPolicy.new(user, Account.new).index?
+      end
+
+      can :see_own_role_on, :entries do
+        !user.admin?
+      end
+
+      can :see_entry_admin_tab, Admin::Tab do |tab|
+        Admin::EntryTabPolicy.new(user, tab).see?
+      end
+
+      can :see_theming_admin_tab, Admin::Tab do |tab|
+        Admin::AdminOnlyTabPolicy.new(user, tab).see?
+      end
+
+      can :see_user_admin_tab, Admin::Tab do |tab|
+        Admin::AdminOnlyTabPolicy.new(user, tab).see?
+      end
+
+      unless user.admin?
+        can :configure_folder_on, Account do |account|
+          AccountPolicy.new(user, account).configure_folder_on?
         end
-        can :manage, Theming
 
-        can :manage, ::User
+        can :update_theming_on_entry_of, Account do |account|
+          AccountPolicy.new(user, account).update_theming_on_entry_of?
+        end
 
-        can :destroy, Membership
-        can :create, Membership do |membership|
-          membership.entry.nil? ||
-            membership.user.nil? ||
-            membership.entry.account == membership.user.account
+        can :create, Entry do |entry|
+          EntryPolicy.new(user, entry).create?
         end
 
-        can :view, Admin::FeaturesTab
+        can :manage, Chapter do |record|
+          EntryPolicy.new(user, record.entry).edit?
+        end
 
-        can :manage, Folder
-        can :manage, [Entry, Revision]
-        can :manage, [Storyline, Chapter, Page]
-        can :manage, Pageflow.config.file_types.map(&:model)
+        can :read, Entry, EntryPolicy::Scope.new(user, Entry).resolve do |entry|
+          EntryPolicy.new(user, entry).read?
+        end
 
-        can :manage, Resque
-      elsif user.account_manager?
-        can :manage, Theming, :account_id => user.account_id
-        can :manage, Folder, :account_id => user.account.id
-        can :manage, Entry, :account_id => user.account.id
-        can :manage, ::User, :account_id => user.account.id
-        can :manage, Revision, :entry => {:account_id => user.account.id}
+        can :update, Entry do |entry|
+          EntryPolicy.new(user, entry).edit?
+        end
 
-        can :destroy, Membership, :entry => {:account_id => user.account.id}
-        can :destroy, Membership, :user => {:account_id => user.account.id}
+        can :destroy, Entry do |entry|
+          EntryPolicy.new(user, entry).destroy?
+        end
 
-        can :create, Membership do |membership|
-          (membership.entry.nil? || membership.entry.account == user.account) &&
-            (membership.user.nil? || membership.user.account == user.account)
+        can :add_member_to, Entry do |entry|
+          EntryPolicy.new(user, entry).add_member_to?
         end
-      end
-    end
 
-    private
+        can :configure_folder_for, Entry do |entry|
+          AccountPolicy.new(user, entry.account).configure_folder_on?
+        end
 
-    def can_edit_entry?(user, entry)
-      user.entries.include?(entry) || account_manager_of_entries_account?(user, entry)
-    end
+        can :confirm_encoding, Entry do |entry|
+          EntryPolicy.new(user, entry).confirm_encoding?
+        end
 
-    def account_manager_of_entries_account?(user, entry)
-      user.account_manager? && entry.account_id == user.account_id
-    end
+        can :duplicate, Entry do |entry|
+          EntryPolicy.new(user, entry).duplicate?
+        end
 
-    def can_edit_any_entry_using_file?(user, file)
-      member_of_any_entry_using_file?(user, file) || account_manager_of_account_using_file?(user, file)
-    end
+        can :edit_outline, Entry do |entry|
+          EntryPolicy.new(user, entry).edit_outline?
+        end
 
-    def member_of_any_entry_using_file?(user, file)
-      (user.entry_ids & file.using_entry_ids).any?
-    end
+        can :index_widgets_for, Entry do |entry|
+          EntryPolicy.new(user, entry).index_widgets_for?
+        end
+
+        can :publish, Entry do |entry|
+          EntryPolicy.new(user, entry).publish?
+        end
+
+        can :restore, Entry do |entry|
+          EntryPolicy.new(user, entry).restore?
+        end
+
+        can :snapshot, Entry do |entry|
+          EntryPolicy.new(user, entry).snapshot?
+        end
+
+        can :update_account_on, Entry do |entry|
+          EntryPolicy.new(user, entry).update_account_on?
+        end
 
-    def account_manager_of_account_using_file?(user, file)
-      user.account_manager? && file.using_account_ids.include?(user.account_id)
+        can :update_feature_configuration_on, Entry do |entry|
+          EntryPolicy.new(user, entry).update_feature_configuration_on?
+        end
+
+        can :update_theming_on, Entry do |entry|
+          EntryPolicy.new(user, entry).update_theming_on?
+        end
+
+        can :use_files, Entry, EntryPolicy::Scope.new(user, Entry).resolve do |entry|
+          EntryPolicy.new(user, entry).use_files?
+        end
+
+        can [:retry, :update], Pageflow.config.file_types.map(&:model) do |record|
+          FilePolicy.new(user, record).manage?
+        end
+
+        can :destroy, Pageflow.config.file_types.map(&:model) do |record|
+          FilePolicy.new(user, record).destroy?
+        end
+
+        can :use, Pageflow.config.file_types.map(&:model) do |record|
+          FilePolicy.new(user, record).use?
+        end
+
+        can [:create, :update, :destroy], Folder do |folder|
+          FolderPolicy.new(user, folder).manage?
+        end
+
+        can :read, Folder, FolderPolicy::Scope.new(user, Folder).resolve
+
+        can :show_account_selection_on, Folder do |folder|
+          FolderPolicy.new(user, folder).show_account_selection_on?
+        end
+
+        can :manage, Page do |page|
+          EntryPolicy.new(user, page.chapter.entry).edit?
+        end
+
+        can :read, Revision do |revision|
+          EntryPolicy.new(user, revision.entry).preview?
+        end
+
+        can :manage, Storyline do |storyline|
+          EntryPolicy.new(user, storyline.revision.entry).edit?
+        end
+
+        can :edit, Theming do |theming|
+          ThemingPolicy.new(user, theming).edit?
+        end
+
+        can :index_widgets_for, Theming do |theming|
+          ThemingPolicy.new(user, theming).index_widgets_for?
+        end
+
+        can :create, ::User do |managed_user|
+          UserPolicy.new(user, managed_user).create?
+        end
+
+        can :index, ::User, UserPolicy::Scope.new(user, ::User).resolve do |managed_user|
+          UserPolicy.new(user, managed_user).index?
+        end
+
+        can :read, ::User, UserPolicy::Scope.new(user, ::User).resolve do |managed_user|
+          UserPolicy.new(user, managed_user).read?
+        end
+
+        can :redirect_to_user,
+            ::User,
+            UserPolicy::Scope.new(user, ::User).resolve do |managed_user|
+          UserPolicy.new(user, managed_user).redirect_to_user?
+        end
+      end
+
+      can :delete_own_user, ::User do |user_to_delete|
+        UserPolicy.new(user, user_to_delete).delete_own_user?
+      end
+
+      if user.admin?
+        can [:create, :configure_folder_on], Account
+        can :destroy, Account do |account|
+          account.users.empty? && account.entries.empty?
+        end
+        can :manage, [Storyline, Chapter, Page]
+        can :manage, [Entry, Revision]
+        can :manage, Pageflow.config.file_types.map(&:model)
+        can :manage, Folder
+        can :manage, Resque
+        can :manage, Theming
+        can :manage, ::User
+      end
     end
   end
 end

data/lib/pageflow/admin/tab.rb

@@ -0,0 +1,21 @@
+module Pageflow
+  module Admin
+    # @api private
+    class Tab
+      attr_reader :name, :component, :required_role, :required_account_role, :resource
+
+      def initialize(options, resource = nil)
+        @name = options[:name]
+        @component = options[:component]
+        @required_role = options[:required_role]
+        @required_account_role = options[:required_account_role]
+        @admin_only = options[:admin_only]
+        @resource = resource
+      end
+
+      def admin_only?
+        @admin_only
+      end
+    end
+  end
+end

data/lib/pageflow/admin/tabs.rb

@@ -1,20 +1,45 @@
 module Pageflow
   module Admin
     class Tabs
+      # @api private
       def initialize
         @tabs = {}
       end
 
-      # @param [Symbol] resource_name  A resource name like `:entry` or `:account`
-      # @param [Hash] tab_options
-      def register(resource_name, tab_options)
+      # Display additional tabs on admin resource pages.
+      #
+      # @param [Symbol] resource_name A resource name like `:entry`,
+      #   `:user` or `:account`
+      # @param [Hash] options
+      # @option options [Symbol] :name Unique identifier.
+      # @option options [Arbre::Component] :component Component to
+      #   render as tab contents
+      # @option options [Symbol] :required_role (`nil`) Requires the
+      #   current user to either have an account or entry membership
+      #   with at least the given role. By default all users can see
+      #   the tab.
+      # @option options [Symbol] :required_account_role (`nil`)
+      #   Requires the current user to have an account membership with
+      #   at least the given role. By default all users can see the
+      #   tab. This option only takes effect for the entry resource.
+      # @option options [Boolean] :admin_only (`false`) Allow only
+      #   admins to see the tab.
+      def register(resource_name, options)
         @tabs[resource_name] ||= []
-        @tabs[resource_name] << tab_options
+        @tabs[resource_name] << options
       end
 
       # @api private
-      def find_by_resource(name)
-        @tabs.fetch(name, [])
+      def find_by_resource(resource)
+        @tabs.fetch(resource_name(resource), []).map do |options|
+          Tab.new(options, resource)
+        end
+      end
+
+      private
+
+      def resource_name(resource)
+        resource.class.model_name.param_key.to_sym
       end
     end
   end

data/lib/pageflow/built_in_file_type.rb

@@ -0,0 +1,39 @@
+module Pageflow
+  module BuiltInFileType
+    # Factory methods to decouple Pageflow initializers from concrete
+    # file type classes, making more transparent which file types are
+    # available as built-ins.
+    def self.image
+      FileType.new(model: 'Pageflow::ImageFile',
+                   editor_partial: 'pageflow/editor/image_files/image_file',
+                   collection_name: 'image_files',
+                   url_templates: ImageFileUrlTemplates.new,
+                   top_level_type: true)
+    end
+
+    def self.video
+      FileType.new(model: 'Pageflow::VideoFile',
+                   partial: 'pageflow/video_files/video_file',
+                   editor_partial: 'pageflow/editor/video_files/video_file',
+                   collection_name: 'video_files',
+                   url_templates: VideoFileUrlTemplates.new,
+                   top_level_type: true,
+                   nested_file_types: [BuiltInFileType.text_track])
+    end
+
+    def self.audio
+      FileType.new(model: 'Pageflow::AudioFile',
+                   editor_partial: 'pageflow/editor/audio_files/audio_file',
+                   collection_name: 'audio_files',
+                   url_templates: AudioFileUrlTemplates.new,
+                   top_level_type: true,
+                   nested_file_types: [BuiltInFileType.text_track])
+    end
+
+    def self.text_track
+      FileType.new(model: 'Pageflow::TextTrackFile',
+                   collection_name: 'text_track_files',
+                   url_templates: TextTrackFileUrlTemplates.new)
+    end
+  end
+end

data/lib/pageflow/built_in_page_types_plugin.rb

@@ -0,0 +1,80 @@
+module Pageflow
+  class BuiltInPageTypesPlugin < Plugin
+    def configure(config)
+      config.page_types.register(plain_page_type)
+      config.page_types.register(video_page_type)
+      config.page_types.register(audio_page_type)
+    end
+
+    private
+
+    def plain_page_type
+      Pageflow::React.create_page_type('background_image',
+                                       thumbnail_candidates: default_thumbnail_candidates,
+                                       file_types: [
+                                         BuiltInFileType.image,
+                                         BuiltInFileType.video
+                                       ])
+    end
+
+    def video_page_type
+      Pageflow::React.create_page_type('video',
+                                       thumbnail_candidates: video_thumbnail_candidates,
+                                       file_types: [
+                                         BuiltInFileType.image,
+                                         BuiltInFileType.video
+                                       ])
+    end
+
+    def audio_page_type
+      Pageflow::React.create_page_type('audio',
+                                       thumbnail_candidates: default_thumbnail_candidates,
+                                       file_types: [
+                                         BuiltInFileType.audio,
+                                         BuiltInFileType.image,
+                                         BuiltInFileType.video
+                                       ])
+    end
+
+    def 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
+
+    def default_thumbnail_candidates
+      [
+        {
+          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
+  end
+end