pageflow 15.1.0.beta2 → 15.1.0.beta3

data/entry_types/scrolled/app/controllers/pageflow_scrolled/editor/entries_controller.rb

@@ -0,0 +1,8 @@
+module PageflowScrolled
+  module Editor
+    # @api private
+    class EntriesController < ActionController::Base
+      helper SeedHtmlHelper
+    end
+  end
+end

data/entry_types/scrolled/app/controllers/pageflow_scrolled/editor/sections_controller.rb

@@ -0,0 +1,59 @@
+module PageflowScrolled
+  module Editor
+    # @api private
+    class SectionsController < ActionController::Base
+      include Pageflow::EditorController
+
+      def create
+        chapter = Chapter.all_for_revision(@entry.draft).find(params[:chapter_id])
+        section = chapter.sections.create(section_params)
+
+        render partial: 'pageflow_scrolled/sections/section',
+               locals: {section: section},
+               status: :created
+      end
+
+      def update
+        section = Section.all_for_revision(@entry.draft).find(params[:id])
+        section.update_attributes(section_params)
+
+        render partial: 'pageflow_scrolled/sections/section', locals: {section: section}
+      rescue ActiveRecord::RecordNotFound
+        head :not_found
+      end
+
+      def destroy
+        section = Section.all_for_revision(@entry.draft).find(params[:id])
+        section.destroy
+
+        render partial: 'pageflow_scrolled/sections/section', locals: {section: section}
+      rescue ActiveRecord::RecordNotFound
+        head :not_found
+      end
+
+      def order
+        chapter = Chapter.all_for_revision(@entry.draft).find(params[:chapter_id])
+        storyline = chapter.storyline
+
+        params.require(:ids).each_with_index do |id, index|
+          storyline.sections.update(id,
+                                    chapter_id: chapter.id,
+                                    position: index)
+        end
+
+        head :no_content
+      rescue ActiveRecord::RecordNotFound
+        head :not_found
+      end
+
+      private
+
+      def section_params
+        configuration = params.require(:section)[:configuration].try(:permit!) || {}
+        params.require(:section)
+              .permit(:position)
+              .merge(configuration: configuration)
+      end
+    end
+  end
+end

data/entry_types/scrolled/app/controllers/pageflow_scrolled/entries_controller.rb

@@ -0,0 +1,10 @@
+module PageflowScrolled
+  # @api private
+  class EntriesController < ActionController::Base
+    include Pageflow::EntriesControllerEnvHelper
+
+    def show
+      @entry = get_published_entry_from_env
+    end
+  end
+end

data/entry_types/scrolled/app/helpers/pageflow_scrolled/editor/seed_html_helper.rb

@@ -0,0 +1,21 @@
+module PageflowScrolled
+  module Editor
+    # @api private
+    module SeedHtmlHelper
+      include EntryJsonSeedHelper
+
+      def scrolled_editor_iframe_seed_html_script_tag(entry)
+        html = render(template: 'pageflow_scrolled/entries/show',
+                      locals: {
+                        :@entry => entry,
+                        :@seed_options => {skip_collections: true}
+                      })
+
+        content_tag(:script,
+                    html.gsub('</', '<\/').html_safe,
+                    type: 'text/html',
+                    data: {template: 'iframe_seed'})
+      end
+    end
+  end
+end

data/entry_types/scrolled/app/helpers/pageflow_scrolled/entry_json_seed_helper.rb

@@ -0,0 +1,33 @@
+module PageflowScrolled
+  # Render seed data for published scrolled entries.
+  #
+  # @api private
+  module EntryJsonSeedHelper
+    include Pageflow::ConfigHelper
+    include Pageflow::RenderJsonHelper
+    include Pageflow::FilesHelper
+
+    def scrolled_entry_json_seed_script_tag(scrolled_entry, options = {})
+      seed_json = render_json do |json|
+        scrolled_entry_json_seed(json, scrolled_entry, options)
+      end
+
+      content_tag(:script, <<-JS.html_safe)
+        var pageflowScrolledSeed = #{sanitize_json(seed_json)};
+      JS
+    end
+
+    def scrolled_entry_json_seed(json, scrolled_entry, options = {})
+      main_storyline = Storyline.all_for_revision(scrolled_entry.revision).first
+      main_storyline ||= Storyline.new
+
+      json.partial!('pageflow_scrolled/entry_json_seed/entry',
+                    chapters: main_storyline.chapters,
+                    entry: scrolled_entry,
+                    entry_config: Pageflow.config_for(scrolled_entry),
+                    sections: main_storyline.sections,
+                    content_elements: main_storyline.content_elements,
+                    options: options)
+    end
+  end
+end

data/entry_types/scrolled/app/models/pageflow_scrolled/chapter.rb

@@ -0,0 +1,40 @@
+module PageflowScrolled
+  class Chapter < Pageflow::ApplicationRecord
+    include Pageflow::SerializedConfiguration
+    include Pageflow::AutoGeneratedPermaId
+
+    belongs_to :storyline, touch: true
+    has_many :sections,
+             -> { order('pageflow_scrolled_sections.position ASC') },
+             dependent: :destroy,
+             inverse_of: :chapter
+    has_many :content_elements, through: :sections
+
+    attr_accessor :revision # used on :create to lazily create storyline
+    before_validation :ensure_storyline, on: :create
+
+    def self.all_for_revision(revision)
+      joins(storyline: :revision)
+        .where(pageflow_scrolled_storylines: {revision_id: revision})
+    end
+
+    def copy_to(storyline)
+      chapter = dup
+      storyline.chapters << chapter
+
+      sections.each do |section|
+        section.copy_to(chapter)
+      end
+    end
+
+    private
+
+    def ensure_storyline
+      return if storyline.present?
+      unless Storyline.all_for_revision(revision).exists?
+        Storyline.create!(revision: revision, configuration: {main: true})
+      end
+      self.storyline = Storyline.all_for_revision(revision).first
+    end
+  end
+end

data/entry_types/scrolled/app/models/pageflow_scrolled/content_element.rb

@@ -0,0 +1,17 @@
+module PageflowScrolled
+  class ContentElement < Pageflow::ApplicationRecord
+    include Pageflow::SerializedConfiguration
+    include Pageflow::AutoGeneratedPermaId
+
+    belongs_to :section
+
+    def self.all_for_revision(revision)
+      joins(section: {chapter: {storyline: :revision}})
+        .where(pageflow_scrolled_storylines: {revision_id: revision})
+    end
+
+    def copy_to(section)
+      section.content_elements << dup
+    end
+  end
+end

data/entry_types/scrolled/app/models/pageflow_scrolled/section.rb

@@ -0,0 +1,26 @@
+module PageflowScrolled
+  class Section < Pageflow::ApplicationRecord
+    include Pageflow::SerializedConfiguration
+    include Pageflow::AutoGeneratedPermaId
+
+    belongs_to :chapter
+    has_many :content_elements,
+             -> { order('pageflow_scrolled_content_elements.position ASC') },
+             dependent: :destroy,
+             inverse_of: :section
+
+    def self.all_for_revision(revision)
+      joins(chapter: {storyline: :revision})
+        .where(pageflow_scrolled_storylines: {revision_id: revision})
+    end
+
+    def copy_to(chapter)
+      section = dup
+      chapter.sections << section
+
+      content_elements.each do |content_element|
+        content_element.copy_to(section)
+      end
+    end
+  end
+end

data/entry_types/scrolled/app/models/pageflow_scrolled/storyline.rb

@@ -0,0 +1,39 @@
+module PageflowScrolled
+  class Storyline < Pageflow::ApplicationRecord
+    SECTIONS_ORDER = [
+      'pageflow_scrolled_chapters.position ASC',
+      'pageflow_scrolled_sections.position ASC'
+    ].join(',')
+
+    CONTENT_ELEMENTS_ORDER = [
+      'pageflow_scrolled_chapters.position ASC',
+      'pageflow_scrolled_sections.position ASC',
+      'pageflow_scrolled_content_elements.position ASC'
+    ].join(',')
+
+    include Pageflow::RevisionComponent
+    include Pageflow::SerializedConfiguration
+
+    has_many :chapters,
+             -> { order('pageflow_scrolled_chapters.position ASC') },
+             class_name: 'PageflowScrolled::Chapter',
+             dependent: :destroy,
+             inverse_of: :storyline
+    has_many :sections,
+             -> { reorder(SECTIONS_ORDER) },
+             through: :chapters
+    has_many :content_elements,
+             -> { reorder(CONTENT_ELEMENTS_ORDER) },
+             through: :sections
+
+    def copy_to(revision)
+      storyline = dup
+      storyline.revision = revision
+      storyline.save!
+
+      chapters.each do |chapter|
+        chapter.copy_to(storyline)
+      end
+    end
+  end
+end

data/entry_types/scrolled/app/views/pageflow_scrolled/chapters/_chapter.json.jbuilder

@@ -0,0 +1,8 @@
+json.key_format!(camelize: :lower)
+
+json.call(chapter,
+          :id,
+          :perma_id,
+          :storyline_id,
+          :position,
+          :configuration)

data/entry_types/scrolled/app/views/pageflow_scrolled/content_elements/_content_element.json.jbuilder

@@ -0,0 +1,9 @@
+json.key_format!(camelize: :lower)
+
+json.call(content_element,
+          :id,
+          :perma_id,
+          :type_name,
+          :position,
+          :section_id,
+          :configuration)

data/entry_types/scrolled/app/views/pageflow_scrolled/editor/entries/_body.html.erb

@@ -0,0 +1 @@
+<%= scrolled_editor_iframe_seed_html_script_tag(entry) %>

data/entry_types/scrolled/app/views/pageflow_scrolled/editor/entries/_head.html.erb

@@ -0,0 +1,12 @@
+<%= stylesheet_link_tag 'pageflow_paged/editor', media: 'all' %>
+
+<%= javascript_include_tag 'pageflow/vendor' %>
+
+<%# Can be removed once remaining mentions of pageflow global in editor are removed %>
+<script>
+  window.PAGEFLOW_EDITOR = true;
+</script>
+<%= javascript_include_tag 'pageflow/application' %>
+
+<%= javascript_include_tag 'pageflow/editor/vendor' %>
+<%= javascript_pack_tag 'pageflow-scrolled-editor' %>

data/entry_types/scrolled/app/views/pageflow_scrolled/editor/entries/_seed.json.jbuilder

@@ -0,0 +1 @@
+scrolled_entry_json_seed(json, entry, skip_files: true)

data/entry_types/scrolled/app/views/pageflow_scrolled/entries/show.html.erb

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no">
+    <meta name="theme-color" content="#000000" />
+    <meta
+      name="description"
+      content="Pageflow Next Showcase"
+    />
+    <link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,700&display=swap" rel="stylesheet">
+    <title>Pageflow Next Showcase</title>
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+
+    <%= scrolled_entry_json_seed_script_tag(@entry, @seed_options || {}) %>
+
+    <%= javascript_pack_tag 'pageflow-scrolled-frontend' %>
+  </body>
+</html>

data/entry_types/scrolled/app/views/pageflow_scrolled/entry_json_seed/_entry.json.jbuilder

@@ -0,0 +1,35 @@
+json.key_format!(camelize: :lower)
+
+json.config do
+  json.file_url_templates do
+    config_file_url_templates_seed(json, entry_config)
+  end
+  json.file_model_types do
+    config_file_model_types_seed(json, entry_config)
+  end
+end
+
+unless options[:skip_collections]
+  json.collections do
+    json.chapters do
+      json.array!(chapters) do |chapter|
+        json.partial! 'pageflow_scrolled/chapters/chapter', chapter: chapter
+      end
+    end
+
+    json.sections do
+      json.array!(sections) do |section|
+        json.partial! 'pageflow_scrolled/sections/section', section: section
+      end
+    end
+
+    json.content_elements do
+      json.array!(content_elements) do |content_element|
+        json.partial! 'pageflow_scrolled/content_elements/content_element',
+                      content_element: content_element
+      end
+    end
+
+    files_json_seed(json, entry) unless options[:skip_files]
+  end
+end

data/entry_types/scrolled/app/views/pageflow_scrolled/sections/_section.json.jbuilder

@@ -0,0 +1,8 @@
+json.key_format!(camelize: :lower)
+
+json.call(section,
+          :id,
+          :perma_id,
+          :chapter_id,
+          :position,
+          :configuration)

data/entry_types/scrolled/config/routes.rb

@@ -0,0 +1,23 @@
+PageflowScrolled::Engine.routes.draw do
+  scope module: 'editor' do
+    shallow do
+      resources :chapters do
+        collection do
+          put :order
+        end
+
+        resources :sections do
+          collection do
+            put :order
+          end
+
+          resources :content_elements do
+            collection do
+              put :order
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/entry_types/scrolled/lib/generators/pageflow_scrolled/install/install_generator.rb

@@ -0,0 +1,34 @@
+module PageflowScrolled
+  module Generators
+    # @api private
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Installs Pageflow Scrolled entry type.'
+
+      def install_webpacker
+        require 'webpacker'
+        gemfile = File.expand_path('../../../../../../Gemfile', __dir__)
+        rake "webpacker:install BUNDLE_GEMFILE=#{gemfile}"
+      end
+
+      def webpack_environment
+        inject_into_file('config/webpack/environment.js',
+                         before: "module.exports = environment\n") do
+          "const pageflowConfig = require('pageflow/config/webpack')\n" \
+          "environment.config.merge(pageflowConfig)\n\n"
+        end
+      end
+
+      def editor_pack
+        create_file 'app/javascript/packs/pageflow-scrolled-editor.js', <<-JS
+          import 'pageflow-scrolled/editor';
+        JS
+      end
+
+      def frontend_pack
+        create_file 'app/javascript/packs/pageflow-scrolled-frontend.js', <<-JS
+          import 'pageflow-scrolled/frontend';
+        JS
+      end
+    end
+  end
+end

data/entry_types/scrolled/lib/pageflow_scrolled.rb

@@ -2,4 +2,23 @@ require 'pageflow_scrolled/engine'
 
 # Entry type plugin for entries using native scrolling
 module PageflowScrolled
+  class << self
+    def plugin
+      PageflowScrolled::Plugin.new
+    end
+
+    def entry_type
+      Pageflow::EntryType.new(name: 'scrolled',
+                              frontend_app: PageflowScrolled::EntriesController.action(:show),
+                              configuration: PageflowScrolled::Configuration,
+                              editor_fragment_renderer: editor_fragment_renderer,
+                              editor_app: PageflowScrolled::Engine)
+    end
+
+    private
+
+    def editor_fragment_renderer
+      Pageflow::PartialEditorFragmentRenderer.new(PageflowScrolled::Editor::EntriesController)
+    end
+  end
 end