pageflow 15.1.0.beta2 → 15.1.0.beta3

data/app/assets/javascripts/pageflow/editor/base.js

@@ -1,20 +0,0 @@
-//= require wysihtml-toolbar
-//= require jquery.minicolors
-
-//= require i18n
-//= require i18n/translations
-
-//= require cocktail
-//= require backbone.marionette
-
-//= require jquery-ui
-//= require jquery/layout
-
-//= require jquery-fileupload/vendor/load-image
-//= require jquery-fileupload/vendor/canvas-to-blob
-//= require jquery-fileupload/jquery.fileupload
-//= require jquery-fileupload/jquery.fileupload-fp
-
-//= require pageflow/dist/editor
-
-_.extend(pageflow, pageflow._editorGlobalInterop);

data/app/assets/javascripts/pageflow/editor/vendor.js

@@ -0,0 +1,16 @@
+//= require i18n
+//= require i18n/translations
+
+//= require wysihtml-toolbar
+//= require jquery.minicolors
+
+//= require cocktail
+//= require backbone.marionette
+
+//= require jquery-ui
+//= require jquery/layout
+
+//= require jquery-fileupload/vendor/load-image
+//= require jquery-fileupload/vendor/canvas-to-blob
+//= require jquery-fileupload/jquery.fileupload
+//= require jquery-fileupload/jquery.fileupload-fp

data/app/assets/stylesheets/pageflow/admin/embedded_index_table.scss

@@ -1,6 +1,10 @@
+//since activeadmin 2.5.0 depends on ruby 2.4
+//this is a temporary fix to use activeadmin < 2.5 for supporting ruby 2.3
+$orderable-icon-url: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAcAAABGCAYAAAAAVo4aAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAH5JREFUeNpi3LhlOwMU1AExGxDXwARYoHQLEFdD2cxAXAliMKFJgEAFEHfBJEHGMKLhMpgkTsAEdch/NNwCk2xCdiEQtML4LEgCf6EubUX3Cgh0oNvJ+P//f7wOGpUclRwYSZb41CyidNbB8giNM+9oXhmVHHm5bJjUSAABBgDKKiwMMUxPwgAAAABJRU5ErkJggg==" !default;
+
 .embedded_index_table {
   .sortable a {
-    background: url("/assets/active_admin/orderable.png") no-repeat 100% 2px;
+    background: url($orderable-icon-url) no-repeat 100% 2px;
     padding-right: 13px;
   }
 

data/app/controllers/concerns/pageflow/controller_delegation.rb

@@ -0,0 +1,31 @@
+module Pageflow
+  # Allow delegating to another Rack app from a controller action.
+  #
+  # @api private
+  module ControllerDelegation
+    # Abort currently executed controller action, call passed Rack app
+    # and use its response instead. A block can be passed to mutate
+    # the response.
+    def delegate_to_rack_app!(app)
+      result = app.call(request.env)
+      yield(*result) if block_given?
+
+      throw(:delegate, result)
+    end
+
+    # Override ActionController::Metal#dispatch [1] which returns the
+    # Rack response triple generated by the controller. Calling
+    # `delegate_to_rack_app!` aborts execution of the current
+    # controller action and returns the response of the given Rack app
+    # instead.
+    #
+    # The second argument passed to `throw` is becomes the return
+    # value of `catch`. If `throw` is not called, `catch` passes the
+    # return value of its block.
+    #
+    # [1] https://github.com/rails/rails/blob/8bec77cc0f1fd47677a331a64f68c5918efd2ca9/actionpack/lib/action_controller/metal.rb#L188
+    def dispatch(*)
+      catch(:delegate) { super }
+    end
+  end
+end

data/app/controllers/concerns/pageflow/entry_password_protection.rb

@@ -3,11 +3,11 @@ module Pageflow
     private
 
     def check_entry_password_protection(entry)
-      return unless entry.password_protected?
+      return true unless entry.password_protected?
+      return true if authenticate_with_http_basic { |_, password| entry.authenticate(password) }
 
-      authenticate_or_request_with_http_basic('Pageflow') do |_, password|
-        entry.authenticate(password)
-      end
+      request_http_basic_authentication('Pageflow')
+      false
     end
   end
 end

data/app/controllers/pageflow/editor/entries_controller.rb

@@ -1,6 +1,8 @@
 module Pageflow
   module Editor
     class EntriesController < Pageflow::ApplicationController
+      layout 'pageflow/editor'
+
       respond_to :json
 
       before_action :authenticate_user!
@@ -16,6 +18,39 @@ module Pageflow
 
         @entry_config = Pageflow.config_for(@entry)
       end
+
+      def show
+        @entry = DraftEntry.find(params[:id])
+        authorize!(:edit, @entry.to_model)
+
+        @entry_config = Pageflow.config_for(@entry)
+
+        respond_to do |format|
+          format.html
+          format.json
+        end
+      end
+
+      def update
+        @entry = DraftEntry.find(params[:id])
+
+        authorize!(:update, @entry.to_model)
+        @entry.update_meta_data!(entry_params)
+
+        head(:no_content)
+      end
+
+      private
+
+      def entry_params
+        params.require(:entry).permit(:title, :summary, :credits, :manual_start,
+                                      :home_url, :home_button_enabled,
+                                      :overview_button_enabled,
+                                      :emphasize_chapter_beginning, :emphasize_new_pages,
+                                      :share_url, :share_image_id, :share_image_x, :share_image_y,
+                                      :locale, :author, :publisher, :keywords, :theme_name,
+                                      share_providers: {})
+      end
     end
   end
 end

data/app/controllers/pageflow/editor/file_import_controller.rb

@@ -81,7 +81,7 @@ module Pageflow
 
       def file_importer
         importer_key = params[:file_import_name]
-        Pageflow.config.file_importers.find_by_name!(importer_key)
+        Pageflow.config_for(DraftEntry.find(entry_name)).file_importers.find_by_name!(importer_key)
       end
 
       def file_importer_credentials

data/app/controllers/pageflow/editor/files_controller.rb

@@ -40,7 +40,7 @@ module Pageflow
 
         file_reuse.save!
 
-        redirect_to(entry_url(entry))
+        redirect_to(editor_entry_url(entry))
       end
 
       def retry

data/app/controllers/pageflow/entries_controller.rb

@@ -1,19 +1,10 @@
 module Pageflow
+  # @api private
   class EntriesController < Pageflow::ApplicationController
+    include ControllerDelegation
     include PublicHttpsMode
     include EntryPasswordProtection
 
-    before_action :authenticate_user!, except: [:index, :show, :page]
-
-    after_action :allow_iframe_for_embed, only: :show
-
-    helper_method :render_to_string
-
-    helper PagesHelper
-    helper NavigationBarHelper
-    helper BackgroundImageHelper
-    helper RenderJsonHelper
-
     def index
       theming = Theming.for_request(request).with_home_url.first!
 
@@ -22,30 +13,22 @@ module Pageflow
 
     def show
       respond_to do |format|
-        format.any(:html, :css) do
-          @entry = PublishedEntry.find(params[:id], entry_request_scope)
-          I18n.locale = @entry.locale
-
-          if redirect_location = entry_redirect(@entry)
-            return redirect_to(redirect_location, status: :moved_permanently)
-          end
+        format.html do
+          entry = PublishedEntry.find(params[:id], entry_request_scope)
 
+          return if redirect_according_to_entry_redirect(entry)
           return if redirect_according_to_public_https_mode
+          return unless check_entry_password_protection(entry)
 
-          if !request.format.css?
-            check_entry_password_protection(@entry)
-          end
-
-          if params[:page].present?
-            @entry.share_target = @entry.pages.find_by_perma_id(params[:page])
-          else
-            @entry.share_target = @entry
-          end
+          delegate_to_entry_type_frontend_app!(entry)
         end
-        format.json do
-          authenticate_user!
-          @entry = DraftEntry.find(params[:id])
-          authorize!(:show, @entry.to_model)
+      end
+    end
+
+    def stylesheet
+      respond_to do |format|
+        format.css do
+          @entry = PublishedEntry.find(params[:id], entry_request_scope)
         end
       end
     end
@@ -57,57 +40,32 @@ module Pageflow
       redirect_to(short_entry_path(entry.to_model, :anchor => entry.pages[index].try(:perma_id)))
     end
 
-    def partials
-      authenticate_user!
-      @entry = DraftEntry.find(params[:id])
-      I18n.locale = @entry.locale
-      authorize!(:show, @entry.to_model)
-
-      respond_to do |format|
-        format.html { render :action => 'partials', :layout => false }
-      end
-    end
-
-    def edit
-      @entry = DraftEntry.find(params[:id])
-      authorize!(:edit, @entry.to_model)
-
-      @entry_config = Pageflow.config_for(@entry)
-    end
-
-    def update
-      @entry = DraftEntry.find(params[:id])
-
-      authorize!(:update, @entry.to_model)
-      @entry.update_meta_data!(entry_params)
-
-      head(:no_content)
-    end
-
     protected
 
-    def entry_params
-      params.require(:entry).permit(:title, :summary, :credits, :manual_start,
-                                    :home_url, :home_button_enabled,
-                                    :overview_button_enabled,
-                                    :emphasize_chapter_beginning, :emphasize_new_pages,
-                                    :share_url, :share_image_id, :share_image_x, :share_image_y,
-                                    :locale, :author, :publisher, :keywords, :theme_name,
-                                    share_providers: {})
-    end
-
     def entry_request_scope
       Pageflow.config.public_entry_request_scope.call(Entry, request)
     end
 
+    def redirect_according_to_entry_redirect(entry)
+      return unless (redirect_location = entry_redirect(entry))
+
+      redirect_to(redirect_location, status: :moved_permanently)
+    end
+
     def entry_redirect(entry)
       Pageflow.config.public_entry_redirect.call(entry, request)
     end
 
-    def allow_iframe_for_embed
-      if params[:embed]
-        response.headers.except! 'X-Frame-Options'
+    def delegate_to_entry_type_frontend_app!(entry)
+      EntriesControllerEnvHelper.add_entry_info_to_env(request.env, entry: entry, mode: :published)
+
+      delegate_to_rack_app!(entry.entry_type.frontend_app) do |_status, headers, _body|
+        allow_iframe_for_embed(headers)
       end
     end
+
+    def allow_iframe_for_embed(headers)
+      headers.except!('X-Frame-Options') if params[:embed]
+    end
   end
 end

data/app/controllers/pageflow/revisions_controller.rb

@@ -1,20 +1,26 @@
 module Pageflow
   class RevisionsController < Pageflow::ApplicationController
+    include ControllerDelegation
     include QuotaVerification
 
-    before_action :authenticate_user!, :unless => lambda { |controller| controller.request.format.css? }
+    before_action :authenticate_user!, except: [:stylesheet]
 
     respond_to :json
 
     def show
       revision = Revision.find(params[:id])
-      authorize!(:show, revision) unless request.format.css?
+      authorize!(:show, revision)
+
+      entry = PublishedEntry.new(revision.entry, revision)
+      delegate_to_entry_type_frontend_app!(entry)
+    end
+
+    def stylesheet
+      revision = Revision.find(params[:id])
 
       @entry = PublishedEntry.new(revision.entry, revision)
-      I18n.locale = @entry.locale
 
-      @widget_scope = :preview
-      render :template => 'pageflow/entries/show'
+      render template: 'pageflow/entries/stylesheet'
     end
 
     def depublish_current
@@ -30,5 +36,10 @@ module Pageflow
     def revision_params
       params.fetch(:revision, {}).permit(:published_until)
     end
+
+    def delegate_to_entry_type_frontend_app!(entry)
+      EntriesControllerEnvHelper.add_entry_info_to_env(request.env, entry: entry, mode: :preview)
+      delegate_to_rack_app!(entry.entry_type.frontend_app)
+    end
   end
 end

data/app/helpers/pageflow/common_entry_seed_helper.rb

@@ -4,33 +4,18 @@ module Pageflow
   #
   # @api private
   module CommonEntrySeedHelper
-    def common_entry_seed(entry)
-      config = Pageflow.config_for(entry)
+    include ConfigHelper
 
-      {
-        locale: entry.locale,
-        theming: entry.theming.as_json(only: [:privacy_link_url]),
-        enabled_feature_names: entry.enabled_feature_names,
-        page_types: PageTypesSeed.new(config).as_json,
-        file_url_templates: FileUrlTemplatesSeed.new(config).as_json,
-        file_model_types: config.file_types
-                                .index_by(&:collection_name)
-                                .transform_values { |file_type| file_type.model.name }
-      }
-    end
+    def common_entry_seed(json, entry)
+      config = Pageflow.config_for(entry)
 
-    class FileUrlTemplatesSeed
-      attr_reader :config
+      json.locale entry.locale
+      json.theming entry.theming.as_json(only: [:privacy_link_url])
+      json.enabled_feature_names entry.enabled_feature_names
+      json.page_types PageTypesSeed.new(config).as_json
 
-      def initialize(config)
-        @config = config
-      end
-
-      def as_json
-        config.file_types.each_with_object({}) do |file_type, result|
-          result[file_type.collection_name] = file_type.url_templates.call
-        end
-      end
+      json.file_url_templates { config_file_url_templates_seed(json, config) }
+      json.file_model_types { config_file_model_types_seed(json, config) }
     end
 
     class PageTypesSeed

data/app/helpers/pageflow/config_helper.rb

@@ -1,9 +1,31 @@
 module Pageflow
+  # Generate seed data based on configuration objects
   module ConfigHelper
-    include RenderJsonHelper
+    # Render seed data that can be used to build file urls.
+    #
+    # @param [JBuilder] json
+    # @param [Configuration] config
+    # @since 15.1
+    def config_file_url_templates_seed(json, config)
+      config.file_types.each do |file_type|
+        json.set!(file_type.collection_name) do
+          file_type.url_templates.call.each do |key, value|
+            json.set!(key, value)
+          end
+        end
+      end
+    end
 
-    def editor_config_seeds
-      render_json_partial('pageflow/config/editor_seeds')
+    # Render seed data that can be used map model names in
+    # parent_file_model_type attributes to file collection names.
+    #
+    # @param [JBuilder] json
+    # @param [Configuration] config
+    # @since 15.1
+    def config_file_model_types_seed(json, config)
+      config.file_types.index_by(&:collection_name).each do |collection_name, file_type|
+        json.set!(collection_name, file_type.model.name)
+      end
     end
   end
 end

data/app/helpers/pageflow/editor/config_helper.rb

@@ -0,0 +1,12 @@
+module Pageflow
+  module Editor
+    # @api private
+    module ConfigHelper
+      include RenderJsonHelper
+
+      def editor_config_seeds(entry)
+        render_json_partial('pageflow/editor/config/seeds', entry: entry)
+      end
+    end
+  end
+end

data/app/helpers/pageflow/editor/entries_helper.rb

@@ -0,0 +1,10 @@
+module Pageflow
+  module Editor
+    # @api private
+    module EntriesHelper
+      def editor_entry_type_fragment(entry, fragment_name)
+        entry.entry_type.editor_fragment_renderer.send("#{fragment_name}_fragment", entry)
+      end
+    end
+  end
+end