pageflow 15.1.0.beta2 → 15.1.0.beta3

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

@@ -0,0 +1,24 @@
+module Pageflow
+  module Editor
+    # @api private
+    module FilesHelper
+      include Pageflow::FilesHelper
+      include AudioFilesHelper
+      include VideoFilesHelper
+      include RenderJsonHelper
+
+      def editor_files_json_seed(entry)
+        inner = Pageflow.config.file_types.map { |file_type|
+          json = render_json_partial(partial: 'pageflow/editor/files/file',
+                                     collection: entry.find_files(file_type.model),
+                                     locals: {file_type: file_type},
+                                     as: :file)
+
+          %("#{file_type.collection_name}": #{json})
+        }.join(',')
+
+        "{#{inner}}".html_safe
+      end
+    end
+  end
+end

data/app/helpers/pageflow/entries_helper.rb

@@ -66,10 +66,11 @@ module Pageflow
     end
 
     def entry_stylesheet_link_tag(entry)
-      url = polymorphic_path(entry.stylesheet_model,
-                             v: entry.stylesheet_cache_key,
-                             p: Pageflow::VERSION,
-                             format: 'css')
+      url = pageflow.polymorphic_path(entry.stylesheet_model,
+                                      action: :stylesheet,
+                                      v: entry.stylesheet_cache_key,
+                                      p: Pageflow::VERSION,
+                                      format: 'css')
 
       # We cannot use stylesheet_link_tag here since that always uses
       # the asset host. Entry stylesheet requests are subject to

data/app/helpers/pageflow/entry_json_seed_helper.rb

@@ -5,6 +5,7 @@ module Pageflow
   module EntryJsonSeedHelper
     include RenderJsonHelper
     include CommonEntrySeedHelper
+    include FilesHelper
 
     def entry_json_seed(entry)
       sanitize_json(render_json_partial('pageflow/entry_json_seed/entry',

data/app/helpers/pageflow/files_helper.rb

@@ -1,8 +1,7 @@
 module Pageflow
+  # Format and generate seed data for files
   module FilesHelper
     include RenderJsonHelper
-    include VideoFilesHelper
-    include AudioFilesHelper
 
     def file_format(file)
       file.format.presence || '-'
@@ -29,17 +28,19 @@ module Pageflow
       end
     end
 
-    def files_json_seeds(entry)
-      inner = Pageflow.config.file_types.map do |file_type|
-        json = render_json_partial(partial: 'pageflow/editor/files/file',
-                                   collection: entry.find_files(file_type.model),
-                                   locals: {file_type: file_type},
-                                   as: :file)
-
-        %'"#{file_type.collection_name}": #{json}'
-      end.join(',')
-
-      "{#{inner}}".html_safe
+    # Render seed data for all files of the revision.
+    #
+    # @param [JBuilder] json
+    # @param [PublishedEntry] entry
+    # @since 15.1
+    def files_json_seed(json, entry)
+      Pageflow.config.file_types.each do |file_type|
+        json.set!(file_type.collection_name) do
+          json.array!(entry.find_files(file_type.model)) do |file|
+            json.partial!('pageflow/files/file', file: file, file_type: file_type)
+          end
+        end
+      end
     end
   end
 end

data/app/helpers/pageflow/page_types_helper.rb

@@ -21,7 +21,10 @@ module Pageflow
                                      locals: {
                                        configuration: {},
                                        page: Page.new,
-                                       entry: entry
+                                       entry: entry,
+
+                                       # Required by RevisionFileHelper#find_file_in_entry
+                                       :@entry => entry
                                      },
                                      layout: false).to_str,
                     type: 'text/html', data: {template: "#{page_type.name}_page"})

data/app/helpers/pageflow/render_json_helper.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # Helpers for rendering JSON seed data.
   module RenderJsonHelper
     # Renders `image_files/_image_file.json.jbuilder` when given a
     # collection of `ImageFile` records.
@@ -13,11 +14,25 @@ module Pageflow
       end
     end
 
+    # Render the given partial with format JSON, independent from
+    # currently rendered format. Can be used together with
+    # {sanitize_json} to render JSON to be included in an HTML script
+    # tag. Takes same parameters as JBuilder's partial! method.
     def render_json_partial(*args)
       render_with_format(:json) do
-        JbuilderTemplate.encode(self) do |json|
+        render_json { |json|
           json.partial!(*args)
-        end.html_safe
+        }.html_safe
+      end
+    end
+
+    # Yields to given block with JBuilder object and returns rendered
+    # JSON as string.
+    #
+    # @since 15.1
+    def render_json(&block)
+      render_with_format(:json) do
+        JbuilderTemplate.encode(self, &block)
       end
     end
 
@@ -25,23 +40,33 @@ module Pageflow
       "\u2028" => '\u2028',
       "\u2029" => '\u2029',
       '</' => '<\/'
-    }
+    }.freeze
 
     ESCAPED_CHARS_REGEX = %r{</|[\u2028\u2029]}u
 
+    # Make JSON string safe for embedding in HTML script tag. Escape
+    # whitespace characters that are allowed in JSON but not allowed
+    # in HTML. Make sure closing script tag in JSON text is not
+    # interpreted as closing tag of the surrounding script tag.
     def sanitize_json(json)
       json.gsub(ESCAPED_CHARS_REGEX, ESCAPED_CHARS)
     end
 
+    # Render the given partial with format HTML, independent from
+    # currently rendered format. Can be used to render HTML to be
+    # included in a JSON response. Takes same parameters as Rails
+    # normal render method.
     def render_html_partial(*args)
       render_with_format(:html) do
         render(*args)
       end
     end
 
-    def render_with_format(format, &block)
+    private
+
+    def render_with_format(format)
       old_formats = formats
-      self.formats = [format] # hack so partials resolve with json not html format
+      self.formats = [format] # HACK: so partials resolve with json not html format
       yield
     ensure
       self.formats = old_formats

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

@@ -0,0 +1,16 @@
+module Pageflow
+  # Add a +perma_id+ attribute of type integer.
+  # The perma_id is automatically generated on create
+  # and remains unchanged throughout the models lifecycle.
+  module AutoGeneratedPermaId
+    extend ActiveSupport::Concern
+
+    included do
+      before_save :ensure_perma_id
+    end
+
+    def ensure_perma_id
+      self.perma_id ||= (self.class.maximum(:perma_id) || 0) + 1
+    end
+  end
+end

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

@@ -13,10 +13,10 @@ module Pageflow
       serialize :features_configuration, JSON
     end
 
-    def enabled_feature_names
-      Pageflow.config.features.select do |feature|
+    def enabled_feature_names(config = Pageflow.config_for(self))
+      config.features.select { |feature|
         feature_state(feature.name) == true
-      end.map(&:name)
+      }.map(&:name)
     end
 
     def feature_state(name)

data/app/models/pageflow/draft_entry.rb

@@ -14,6 +14,7 @@ module Pageflow
              :password_digest,
              :to_model, :to_key, :persisted?, :to_json,
              :first_published_at,
+             :type_name,
              :to => :entry)
 
     delegate(:title, :summary, :credits, :manual_start,
@@ -36,6 +37,8 @@ module Pageflow
       @draft = draft || entry.draft
     end
 
+    alias revision draft
+
     # So we can always get to the original Entry title.
     def entry_title
       entry.title

data/app/models/pageflow/home_button.rb

@@ -30,7 +30,9 @@ module Pageflow
     def theming_home_button_url
       if theming.home_url.present?
         options = Pageflow.config.theming_url_options(theming) || {}
-        options.merge(controller: 'entries', action: 'index')
+        Pageflow::Engine.routes.url_for(options.merge(controller: 'pageflow/entries',
+                                                      action: 'index',
+                                                      only_path: !options[:host]))
       end
     end
   end

data/app/models/pageflow/page.rb

@@ -1,6 +1,7 @@
 module Pageflow
   class Page < ApplicationRecord
     include SerializedConfiguration
+    include AutoGeneratedPermaId
 
     belongs_to :chapter, touch: true
 
@@ -10,8 +11,6 @@ module Pageflow
 
     scope :displayed_in_navigation, -> { where(:display_in_navigation => true) }
 
-    before_save :ensure_perma_id
-
     def title
       configuration['title'].presence || configuration['additional_title']
     end
@@ -28,9 +27,5 @@ module Pageflow
     def copy_to(chapter)
       chapter.pages << dup
     end
-
-    def ensure_perma_id
-      self.perma_id ||= (Page.maximum(:perma_id) || 0) + 1
-    end
   end
 end

data/app/models/pageflow/published_entry.rb

@@ -13,6 +13,7 @@ module Pageflow
              :to_model, :to_key, :persisted?,
              :authenticate,
              :first_published_at,
+             :type_name,
              :to => :entry)
 
     delegate(:widgets,

data/app/models/pageflow/revision.rb

@@ -156,6 +156,9 @@ module Pageflow
       end
     end
 
+    # Public interface for copying a revision
+    #
+    # @since 15.1
     def copy(&block)
       revision = dup
 

data/app/models/pageflow/storyline.rb

@@ -3,8 +3,6 @@ module Pageflow
     include SerializedConfiguration
     include RevisionComponent
 
-    belongs_to :revision, touch: true
-
     has_many(:chapters,
              -> { order('pageflow_chapters.position ASC') },
              dependent: :destroy,

data/app/views/admin/entries/_links.html.arb

@@ -1,7 +1,7 @@
 para do
   if authorized?(:edit, entry)
     span(link_to(I18n.t('pageflow.admin.entries.editor'),
-                 pageflow.edit_entry_path(entry),
+                 pageflow.editor_entry_path(entry),
                  class: 'editor icon_button button'))
   end
 

data/app/views/admin/features/_form.html.erb

@@ -2,7 +2,7 @@
   <%= hidden_field_tag('tab', params[:tab]) %>
 
   <%= f.inputs do %>
-    <% Pageflow.config.features.each do |feature| %>
+    <% Pageflow.config_for(resource).features.each do |feature| %>
       <li>
         <%= label_tag(feature_state_input_name(resource, feature.name),
                       t(feature.name_translation_key)) %>

data/app/views/components/pageflow/admin/add_membership_button.rb

@@ -16,6 +16,7 @@ module Pageflow
           path = new_admin_entry_membership_path(
             parent, entity_type: to_class_name(entity_type)
           )
+          quota = Pageflow.config.quotas.get(:users, parent.account)
         else
           path = new_admin_account_membership_path(
             parent, entity_type: to_class_name(entity_type)
@@ -28,7 +29,13 @@ module Pageflow
           rel = 'add_member'
         end
 
-        if membership_possible_for(user, parent, entity_type)
+        if parent.is_a?(Entry) && parent.account.users.length < 2
+          render 'pageflow/admin/entries/cannot_add_user',
+                 user: user,
+                 parent: parent,
+                 entity_type: entity_type,
+                 quota: quota
+        elsif membership_possible_for(user, parent, entity_type)
           para do
             link_to(button_label, path, class: 'button', data: {rel: rel})
           end
@@ -38,6 +45,11 @@ module Pageflow
                            class: 'button disabled',
                            data: {rel: rel}),
                'data-tooltip' => data_tooltip)
+          render 'pageflow/admin/users/cannot_add',
+                 user: user,
+                 parent: parent,
+                 entity_type: entity_type,
+                 quota: quota
         end
       end
 

data/app/views/layouts/pageflow/application.html.erb

@@ -1,33 +1,17 @@
 <!DOCTYPE html>
-<%= content_tag(:html, lang: I18n.locale, dir: @page_text_direction) do %>
+<%= content_tag(:html, lang: I18n.locale) do %>
 <head>
   <title><%= @page_title.presence || 'Pageflow' %></title>
 
-  <script>
-    window.PAGEFLOW_EDITOR = <%= @editor_scope ? 'true' : 'false' %>;
-  </script>
-
-  <%= javascript_include_tag 'pageflow/vendor', 'data-turbolinks-track' => true %>
-  <%= javascript_include_tag 'pageflow/application', 'data-turbolinks-track' => true %>
-
   <%= csrf_meta_tags %>
+
   <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1, minimum-scale=1, maximum-scale=1" />
   <meta name="apple-mobile-web-app-capable" content="yes" />
 
   <%= yield :head %>
-
-  <%= stylesheet_link_tag 'pageflow/print_view', media: 'print', 'data-turbolinks-track' => true %>
-  <%= render 'layouts/pageflow/loading_spinner_inline_script' %>
-
-  <%= render 'layouts/pageflow/ie_include_tags' %>
 </head>
 
-<body class="load_all_images has_no_mobile_platform non_js">
-  <script>
-    jQuery('body').removeClass('load_all_images');
-    jQuery("body").removeClass('non_js').addClass('js');
-  </script>
+<body>
   <%= yield %>
-  <%= render 'layouts/pageflow/theme_probes' %>
 </body>
 <% end %>

data/app/views/layouts/pageflow/editor.html.erb

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<%= content_tag(:html, lang: I18n.locale) do %>
+<head>
+  <title><%= @page_title.presence || 'Pageflow' %></title>
+
+  <%= csrf_meta_tags %>
+
+  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1, minimum-scale=1, maximum-scale=1" />
+  <meta name="apple-mobile-web-app-capable" content="yes" />
+
+  <%= yield :head %>
+</head>
+
+<body class="js">
+  <%= yield %>
+  <%= render 'layouts/pageflow/theme_probes' %>
+</body>
+<% end %>

data/app/views/pageflow/admin/entries/_cannot_add_user.html.erb

@@ -0,0 +1,5 @@
+<% if quota.exhausted? %>
+  <%= t("pageflow.admin.entry.user_quota_exhausted") %>
+<% else %>
+    <%= t("pageflow.admin.entry.entry_membership_hint") %>
+<% end %>

data/app/views/pageflow/admin/users/_cannot_add.html.erb

@@ -0,0 +1,8 @@
+<% if parent.is_a?(Pageflow::Entry) %>
+  <%= render 'pageflow/admin/entries/cannot_add_user', user: user, parent: parent, entity_type: entity_type, quota: quota %>
+<% elsif parent.is_a?(User) %>
+  <%= render "pageflow/admin/users/cannot_add_#{entity_type}", user: user, parent: parent, entity_type: entity_type %>
+<% elsif parent.is_a?(Pageflow::Account) %>
+  <%= t("pageflow.admin.account.cannot_add") %>
+  <%= render "pageflow/admin/accounts/cannot_add_#{entity_type}", user: user, parent: parent, entity_type: entity_type %>
+<%end%>

data/app/views/pageflow/{config/_editor_seeds.json.jbuilder → editor/config/_seeds.json.jbuilder}

@@ -5,7 +5,7 @@ json.call(Pageflow.config,
           :available_public_locales,
           :available_text_track_kinds,
           :available_share_providers)
-json.file_types Pageflow.config.file_types do |file_type|
+json.file_types Pageflow.config_for(entry).file_types do |file_type|
   json.collection_name file_type.collection_name
   json.top_level_type file_type.top_level_type
   json.type_name file_type.type_name
@@ -15,7 +15,8 @@ json.file_types Pageflow.config.file_types do |file_type|
     json.collection_name nested_file_type.collection_name
   end
 end
-json.file_importers Pageflow.config.file_importers do |file_importer|
+
+json.file_importers Pageflow.config_for(entry).file_importers do |file_importer|
   json.importer_name file_importer.name
   json.logo_source file_importer.logo_source
   json.authentication_provider file_importer.authentication_provider