pageflow 14.0.0.beta1 → 14.0.0.beta2

data/app/assets/javascripts/pageflow/editor/collections/files_collection.js

@@ -27,7 +27,8 @@ pageflow.FilesCollection = Backbone.Collection.extend({
   findOrCreateBy: function(attributes) {
     return this.findWhere(attributes) ||
       this.create(attributes, {
-        fileType: this.fileType
+        fileType: this.fileType,
+        queryParams: { no_upload: true }
       });
   },
 

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

@@ -3,7 +3,7 @@
 
   Backbone.sync = function(method, model, options) {
     if (model.paramRoot && !options.attrs) {
-      options.attrs = {};
+      options.attrs = options.queryParams || {};
       options.attrs[model.paramRoot] = model.toJSON(options);
     }
 

data/app/assets/javascripts/pageflow/page_types/mixins/default_page_content.js

@@ -0,0 +1,8 @@
+pageflow.defaultPageContent = {
+  updateDefaultPageContent: function(pageElement, configuration) {
+    pageElement.find('.page_header-tagline').text(configuration.get('tagline') || '');
+    pageElement.find('.page_header-title').text(configuration.get('title') || '');
+    pageElement.find('.page_header-subtitle').text(configuration.get('subtitle') || '');
+    pageElement.find('.page_text p').html(configuration.get('text') || '');
+  }
+};

data/app/assets/javascripts/pageflow/ready.js

@@ -8,13 +8,13 @@ pageflow.ready = new $.Deferred(function(readyDeferred) {
       var slideshow = $('[data-role=slideshow]');
       var body = $('body');
 
+      pageflow.Visited.setup();
+
       pagePreloaded.then(function() {
         readyDeferred.resolve();
         pageflow.events.trigger('ready');
       });
 
-      pageflow.Visited.setup();
-
       slideshow.each(function() {
         pageflow.events.trigger('seed:loaded');
 

data/app/assets/javascripts/pageflow/slideshow/dom_order_scroll_navigator.js

@@ -32,7 +32,8 @@ pageflow.DomOrderScrollNavigator = function(slideshow, entryData) {
   };
 
   this.getNextPage = function(currentPage, pages) {
-    var nextPage = currentPage.next('.page');
+    var currentPageIndex = pages.index(currentPage);
+    var nextPage = currentPageIndex < pages.length - 1 ? $(pages.get(currentPageIndex + 1)) : $();
 
     if (sameStoryline(currentPage, nextPage)) {
       return nextPage;
@@ -48,7 +49,8 @@ pageflow.DomOrderScrollNavigator = function(slideshow, entryData) {
   };
 
   this.getPreviousPage = function(currentPage, pages) {
-    var previousPage =  currentPage.prev('.page');
+    var currentPageIndex = pages.index(currentPage);
+    var previousPage = currentPageIndex > 0 ? $(pages.get(currentPageIndex - 1)) : $();
 
     if (sameStoryline(currentPage, previousPage)) {
       return previousPage;
@@ -57,8 +59,8 @@ pageflow.DomOrderScrollNavigator = function(slideshow, entryData) {
     return getParentPage(currentPage, pages);
   };
 
-  this.getTransitionDirection = function(previousPage, currentPage, options) {
-    return (currentPage.index() > previousPage.index() ? 'forwards' : 'backwards');
+  this.getTransitionDirection = function(previousPage, currentPage, pages, options) {
+    return (pages.index(currentPage) > pages.index(previousPage) ? 'forwards' : 'backwards');
   };
 
   this.getDefaultTransition = function(previousPage, currentPage, pages) {

data/app/assets/javascripts/pageflow/slideshow.js

@@ -113,7 +113,7 @@ pageflow.Slideshow = function($el, configurations) {
           this.scrollNavigator.getDefaultTransition(previousPage, currentPage, pages);
 
         var direction =
-          this.scrollNavigator.getTransitionDirection(previousPage, currentPage, options);
+          this.scrollNavigator.getTransitionDirection(previousPage, currentPage, pages, options);
 
         var outDuration = previousPage.page('deactivate', {
           direction: direction,

data/app/assets/stylesheets/pageflow/overview.scss

@@ -64,7 +64,7 @@
     @include transition(0.5s ease);
     @include transform(translate(200%,0));
 
-    h2 {
+    .overview_headline {
       @include margin-start(10px);
       margin-bottom: 0;
       margin-top: 0;
@@ -231,4 +231,4 @@
       }
     }
   }
-}
+}

data/app/assets/stylesheets/pageflow/themes/default/overview/colors.scss

@@ -54,7 +54,7 @@ $overview-pictogram-visibility: $standard-page-pictogram-visibility !default;
   color: $overview-text-color;
 }
 
-h2 {
+.overview_headline {
   color: $overview-header-text-color;
 }
 

data/app/assets/stylesheets/pageflow/themes/default/overview/typography.scss

@@ -19,11 +19,12 @@ $overview-close-button-typography: () !default;
 
 @include standard-typography($overview-typography, ());
 
-h2 {
+.overview_headline {
   @include typography(
     $overview-header-typography,
     (
       font-size: 3em,
+      font-weight: bold
     )
   );
 }

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

@@ -20,6 +20,7 @@ module Pageflow
         verify_edit_lock!(entry)
 
         @file = entry.create_file!(file_type.model, create_params)
+        @file.publish! if params[:no_upload]
 
         respond_with(:editor, @file)
       rescue ActiveRecord::RecordInvalid => e

data/app/helpers/pageflow/common_entry_seed_helper.rb

@@ -10,6 +10,7 @@ module Pageflow
       {
         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

data/app/helpers/pageflow/entries_helper.rb

@@ -53,7 +53,7 @@ module Pageflow
       end
 
       if links.any?
-        content_tag(:h2, I18n.t('pageflow.helpers.entries.global_links'), :class => 'hidden') + safe_join(links, ''.html_safe)
+        content_tag(:span, I18n.t('pageflow.helpers.entries.global_links'), class: 'hidden') + safe_join(links, ''.html_safe)
       else
         ''
       end

data/app/helpers/pageflow/entry_json_seed_helper.rb

@@ -14,7 +14,8 @@ module Pageflow
     def entry_attributes_seed(entry)
       {
         title: entry.title,
-        slug: entry.slug
+        slug: entry.slug,
+        published_at: entry.published_at.try(:iso8601, 0)
       }
     end
 

data/app/helpers/pageflow/meta_tags_helper.rb

@@ -1,7 +1,12 @@
 module Pageflow
+  # @api private
   module MetaTagsHelper
     def meta_tags_for_entry(entry)
-      render partial: 'pageflow/meta_tags/entry', locals: {
+      render partial: 'pageflow/meta_tags/entry', locals: meta_tags_data_for_entry(entry)
+    end
+
+    def meta_tags_data_for_entry(entry)
+      {
         keywords: entry.keywords.presence || Pageflow.config.default_keywords_meta_tag,
         author: entry.author.presence || Pageflow.config.default_author_meta_tag,
         publisher: entry.publisher.presence || Pageflow.config.default_publisher_meta_tag

data/app/helpers/pageflow/page_background_asset_helper.rb

@@ -1,8 +1,12 @@
 module Pageflow
   module PageBackgroundAssetHelper
-    def page_background_asset(configuration)
+    include EntryJsonSeedHelper
+    include ReactServerSideRenderingHelper
+
+    def page_background_asset(page, entry = @entry)
       render('pageflow/page_background_asset/element',
-             configuration: configuration)
+             entry: entry,
+             page: page)
     end
   end
 end

data/app/helpers/pageflow/react_server_side_rendering_helper.rb

@@ -0,0 +1,25 @@
+module Pageflow
+  # @api private
+  module ReactServerSideRenderingHelper
+    def render_page_react_component(entry, page, component_name)
+      return '' if page.perma_id.blank?
+      extra_props_string = %("pageId": #{page.perma_id}, "pageType": "#{page.template}")
+      render_react_component_with_seed(entry, component_name, extra_props_string)
+    end
+
+    def render_widget_react_component(entry, widget_type_name, component_name)
+      render_react_component_with_seed(entry,
+                                       component_name,
+                                       %("widgetTypeName": "#{widget_type_name}"))
+    end
+
+    private
+
+    def render_react_component_with_seed(entry, component_name, extra_props_string)
+      seed = (@_pageflow_react_entry_seed ||= entry_json_seed(entry))
+      props_string = %({ "resolverSeed": #{seed}, #{extra_props_string} })
+
+      ::React::ServerRendering.render(component_name, props_string, true)
+    end
+  end
+end

data/app/helpers/pageflow/structured_data_helper.rb

@@ -0,0 +1,22 @@
+module Pageflow
+  # @api private
+  module StructuredDataHelper
+    include RenderJsonHelper
+    include SocialShareHelper
+    include MetaTagsHelper
+
+    def structured_data_for_entry(entry)
+      return '' unless Pageflow.config_for(entry).features.enabled?('structured_data')
+
+      content_tag(:script, type: 'application/ld+json') do
+        render_json_partial('pageflow/structured_data/entry',
+                            entry: entry,
+                            meta_data: meta_tags_data_for_entry(entry))
+      end
+    end
+
+    def structured_data_normalize_protocol(url)
+      url.gsub(%r{^//}, 'https://')
+    end
+  end
+end

data/app/models/pageflow/draft_entry.rb

@@ -10,6 +10,7 @@ module Pageflow
              :published_until, :published?,
              :password_digest,
              :to_model, :to_key, :persisted?, :to_json,
+             :first_published_at,
              :to => :entry)
 
     delegate(:title, :summary, :credits, :manual_start,
@@ -23,6 +24,7 @@ module Pageflow
              :locale,
              :author, :publisher, :keywords,
              :theme,
+             :published_at,
              :to => :draft)
 
     def initialize(entry, draft = nil)

data/app/models/pageflow/published_entry.rb

@@ -11,6 +11,7 @@ module Pageflow
              :enabled_feature_names,
              :to_model, :to_key, :persisted?,
              :authenticate,
+             :first_published_at,
              :to => :entry)
 
     delegate(:widgets,
@@ -25,6 +26,7 @@ module Pageflow
              :author, :publisher, :keywords,
              :theme,
              :password_protected?,
+             :published_at,
              :to => :revision)
 
     def initialize(entry, revision = nil)

data/app/models/pageflow/revision.rb

@@ -6,6 +6,11 @@ module Pageflow
       'pageflow_pages.position ASC'
     ].join(',')
 
+    CHAPTER_ORDER = [
+      'pageflow_storylines.position ASC',
+      'pageflow_chapters.position ASC'
+    ].join(',')
+
     include ThemeReferencer
 
     belongs_to :entry, touch: :edited_at
@@ -15,7 +20,7 @@ module Pageflow
     has_many :widgets, as: :subject, dependent: :destroy
 
     has_many :storylines, -> { order('pageflow_storylines.position ASC') }, dependent: :destroy
-    has_many :chapters, -> { order('position ASC') }, through: :storylines
+    has_many :chapters, -> { order(CHAPTER_ORDER) }, through: :storylines
     has_many :pages, -> { reorder(PAGE_ORDER) }, through: :storylines
 
     has_many :file_usages, dependent: :destroy

data/app/views/pageflow/audio_files/_audio_file.json.jbuilder

@@ -0,0 +1,2 @@
+json.call(audio_file, :duration_in_ms)
+json.created_at audio_file.created_at.try(:iso8601, 0)

data/app/views/pageflow/chapters/_chapter.html.erb

@@ -0,0 +1,5 @@
+<section class="chapter">
+  <h2><%= chapter.title %></h2>
+
+  <%= render chapter.pages, entry: entry %>
+</section>

data/app/views/pageflow/entries/_entry.html.erb

@@ -2,16 +2,17 @@
                 id: 'outer_wrapper',
                 data: {theme: entry.theme.name},
                 class: entry_css_class(entry)) do %>
+  <%= structured_data_for_entry(entry) %>
 
   <%= render 'pageflow/entries/skip_links' %>
 
   <h1 class="hidden"><%= entry.title %></h1>
 
-  <img src="<%= image_path("pageflow/themes/#{entry.theme.directory_name}/logo_print.png") %>" class="print_image" alt="<%= t('pageflow.public.logo') %>">
+  <img src="<%= image_path(entry.theme.print_logo_path) %>" class="print_image" alt="<%= t('pageflow.public.logo') %>">
   <span class="print_only page_url"><%= request.original_url %></span>
 
   <%= content_tag :div, :id => 'content', :class => 'entry', :data => {:role => 'slideshow'} do %>
-    <%= render entry.pages, entry: entry %>
+    <%= render entry.chapters, entry: entry %>
     <%= render 'pageflow/entries/indicators', :theme => entry.theme %>
   <% end %>
 

data/app/views/pageflow/entries/_multimedia_alert.html.erb

@@ -1,7 +1,7 @@
 <div class="multimedia_alert">
   <div class="multimedia_alert_box">
     <div class="alert_block">
-    <h1 class="alert_headline"><%= t('pageflow.public.notice') %></h1>
+    <div class="alert_headline"><%= t('pageflow.public.notice') %></div>
     <div class="alert_icon speaker"></div>
       <p>
         <%= t('pageflow.public.sound_hint') %>

data/app/views/pageflow/entries/overview/_entry.html.erb

@@ -1,9 +1,9 @@
-<section class="overview">
+<div class="overview">
   <div class="content">
     <a class="close button">
       <span class="label"><%= t('pageflow.public.close') %></span>
     </a>
-    <h2><%= t('pageflow.public.overview') %></h2>
+    <div class="overview_headline"><%= t('pageflow.public.overview') %></div>
 
     <a class="overview_scroll_indicator left button"
        tabindex="1"
@@ -25,4 +25,4 @@
       <span class="hint"><%= t('pageflow.public.scroll_right') %></span>
     </a>
   </div>
-</section>
+</div>

data/app/views/pageflow/files/_file.json.jbuilder

@@ -1,6 +1,7 @@
 json.call(file,
           :id,
           :basename,
+          :rights,
           :configuration,
           :parent_file_id,
           :parent_file_model_type)

data/app/views/pageflow/image_files/_image_file.json.jbuilder

@@ -0,0 +1,2 @@
+json.call(image_file, :width, :height)
+json.created_at image_file.created_at.try(:iso8601, 0)

data/app/views/pageflow/page_background_asset/_element.html.erb

@@ -1,3 +1,3 @@
-<div class="page_background_asset" style="height: 100%;">
-  <%= background_image_div(configuration, 'background_image') %>
-</div>
+<%= content_tag(:div, class: 'page_background_asset', style: 'height: 100%;') do -%>
+  <% concat render_page_react_component(entry, page, 'pageflow.react.ServerSidePageBackgroundAsset') %>
+<% end %>

data/app/views/pageflow/pages/_page.html.erb

@@ -1,6 +1,12 @@
 <%= cache page do %>
-  <%= content_tag :section, :id => page.perma_id, :class => page_css_class(page), :data => {:template => page.template, :id => page.id, :chapter_id => page.chapter_id} do %>
-    <%= render_page_template(page, entry: entry) %>
-    <a class="to_top" href="#content"><%= t('pageflow.public.goto_top') %></a>
+  <%= content_tag(:section,
+                  id: page.perma_id,
+                  class: page_css_class(page),
+                  data: {
+                    template: page.template,
+                    id: page.id, chapter_id: page.chapter_id
+                  }) do -%>
+    <% concat(render_page_template(page, entry: entry)) -%>
   <% end %>
+  <a class="to_top" href="#content"><%= t('pageflow.public.goto_top') %></a>
 <% end %>

data/app/views/pageflow/react/_widget.html.erb

@@ -1,8 +1,5 @@
 <%= content_tag(:div, '', data: {widget: name}) do -%>
   <% if server_rendering -%>
-    <% concat React::ServerRendering.render(
-       'pageflow.react.ServerSideWidget',
-       %Q'{ "resolverSeed": #{@_pageflow_react_entry_seed ||= entry_json_seed(entry)}, "widgetTypeName": "#{name}" }',
-       true) %>
+    <% concat render_widget_react_component(entry, name, 'pageflow.react.ServerSideWidget') %>
   <% end %>
 <% end %>

data/app/views/pageflow/react/page.html.erb

@@ -1,6 +1,3 @@
 <% if page.template.present? %>
-  <% concat React::ServerRendering.render(
-     'pageflow.react.ServerSidePage',
-     %Q'{ "resolverSeed": #{@_pageflow_react_entry_seed ||= entry_json_seed(entry)}, "pageId": #{page.perma_id}, "pageType": "#{page.template}" }',
-     true) %>
+  <% concat render_page_react_component(entry, page, 'pageflow.react.ServerSidePage') %>
 <% end %>

data/app/views/pageflow/structured_data/_entry.json.jbuilder

@@ -0,0 +1,46 @@
+json.key_format!(camelize: :lower)
+
+json.set! '@context', 'http://schema.org'
+json.set! '@type', 'Article'
+
+json.headline pretty_entry_title(entry)
+json.description social_share_entry_description(entry)
+
+json.keywords(meta_data[:keywords]) if meta_data[:keywords].present?
+
+if meta_data[:author].present?
+  json.author do
+    json.set! '@type', 'Organization'
+    json.name meta_data[:author]
+  end
+end
+
+if meta_data[:publisher].present?
+  json.publisher do
+    json.set! '@type', 'Organization'
+    json.name meta_data[:publisher]
+    json.logo do
+      json.set! '@type', 'ImageObject'
+      json.url structured_data_normalize_protocol(asset_url(entry.theme.print_logo_path))
+    end
+  end
+end
+
+json.date_published entry.first_published_at.try(:iso8601, 0)
+json.date_modified entry.published_at.try(:iso8601, 0)
+
+json.main_entity_of_page do
+  json.set! '@type', 'WebPage'
+  json.set! '@id', structured_data_normalize_protocol(social_share_entry_url(entry))
+end
+
+thumbnail_file = entry.thumbnail_file
+
+if thumbnail_file.present?
+  json.image do
+    json.set! '@type', 'ImageObject'
+    json.url structured_data_normalize_protocol(thumbnail_file.thumbnail_url(:thumbnail_large))
+    json.width 560
+    json.height 315
+  end
+end

data/app/views/pageflow/video_files/_video_file.json.jbuilder

@@ -1,2 +1,3 @@
-json.call(video_file, :width, :height)
+json.call(video_file, :width, :height, :duration_in_ms)
+json.created_at video_file.created_at.try(:iso8601, 0)
 json.variants video_file.present_outputs + [:poster_medium, :poster_large, :poster_ultra, :print]

data/config/initializers/features.rb

@@ -8,4 +8,7 @@ Pageflow.configure do |config|
   config.features.register('selectable_themes')
   config.features.register('editor_emulation_mode')
   config.features.register('waveform_player_controls')
+  config.features.register('structured_data')
+
+  config.features.enable_by_default('structured_data')
 end

data/config/locales/de.yml

@@ -1765,6 +1765,8 @@ de:
       feature_name: Erzählstränge
       main: Hauptstrang
       untitled: Unbenannter Erzählstrang
+    structured_data:
+      feature_name: Eingebettete strukturierte Daten
     title_loading_spinner:
       feature_name: "'Titel und Bild'-Lade-Ansicht"
       widget_type_name: Titel und Bild

data/config/locales/en.yml

@@ -1737,6 +1737,8 @@ en:
       feature_name: Storylines
       main: Main storyline
       untitled: Unnamed storyline
+    structured_data:
+      feature_name: Embedded structured data
     title_loading_spinner:
       feature_name: "'Title and image' loading view"
       widget_type_name: Title and Image

data/lib/pageflow/built_in_file_type.rb

@@ -5,6 +5,7 @@ module Pageflow
     # available as built-ins.
     def self.image
       FileType.new(model: 'Pageflow::ImageFile',
+                   partial: 'pageflow/image_files/image_file',
                    editor_partial: 'pageflow/editor/image_files/image_file',
                    collection_name: 'image_files',
                    url_templates: ImageFileUrlTemplates.new,
@@ -27,6 +28,7 @@ module Pageflow
 
     def self.audio
       FileType.new(model: 'Pageflow::AudioFile',
+                   partial: 'pageflow/audio_files/audio_file',
                    editor_partial: 'pageflow/editor/audio_files/audio_file',
                    collection_name: 'audio_files',
                    url_templates: AudioFileUrlTemplates.new,

data/lib/pageflow/theme.rb

@@ -20,6 +20,10 @@ module Pageflow
       "pageflow/themes/#{name}/preview_thumbnail.png"
     end
 
+    def print_logo_path
+      "pageflow/themes/#{name}/logo_print.png"
+    end
+
     def has_home_button?
       !@options[:no_home_button]
     end

data/lib/pageflow/version.rb

@@ -1,3 +1,3 @@
 module Pageflow
-  VERSION = '14.0.0.beta1'.freeze
+  VERSION = '14.0.0.beta2'.freeze
 end

data/spec/factories/audio_files.rb

@@ -9,6 +9,7 @@ module Pageflow
 
       transient do
         used_in { nil }
+        with_configuration { nil }
       end
 
       before(:create) do |file, evaluator|
@@ -16,7 +17,12 @@ module Pageflow
       end
 
       after(:create) do |file, evaluator|
-        create(:file_usage, :file => file, :revision => evaluator.used_in) if evaluator.used_in
+        if evaluator.used_in
+          create(:file_usage,
+                 file: file,
+                 revision: evaluator.used_in,
+                 configuration: evaluator.with_configuration)
+        end
       end
 
       trait :uploading do

data/spec/factories/entries.rb

@@ -20,6 +20,7 @@ module Pageflow
         with_manager { nil }
 
         with_feature { nil }
+        without_feature { nil }
       end
 
       after(:create) do |entry, evaluator|
@@ -43,7 +44,8 @@ module Pageflow
 
       after(:build) do |entry, evaluator|
         entry.features_configuration =
-          entry.features_configuration.merge(evaluator.with_feature => true)
+          entry.features_configuration.merge(evaluator.with_feature => true,
+                                             evaluator.without_feature => false)
       end
 
       trait :published do

data/spec/factories/image_files.rb

@@ -9,6 +9,7 @@ module Pageflow
 
       transient do
         used_in { nil }
+        with_configuration { nil }
       end
 
       before(:create) do |file, evaluator|
@@ -16,7 +17,12 @@ module Pageflow
       end
 
       after(:create) do |file, evaluator|
-        create(:file_usage, :file => file, :revision => evaluator.used_in) if evaluator.used_in
+        if evaluator.used_in
+          create(:file_usage,
+                 file: file,
+                 revision: evaluator.used_in,
+                 configuration: evaluator.with_configuration)
+        end
       end
 
       trait :uploading do

data/spec/factories/pages.rb

@@ -4,6 +4,17 @@ module Pageflow
       chapter
       template { 'background_image' }
       configuration { {} }
+
+      transient do
+        revision { nil }
+      end
+
+      before(:create) do |page, evaluator|
+        if evaluator.revision
+          storyline = create(:storyline, revision: evaluator.revision)
+          page.chapter = create(:chapter, storyline: storyline)
+        end
+      end
     end
 
     factory :valid_page, :class => Page do