katalyst-content 0.1.2 → 0.2.0

data/app/assets/stylesheets/katalyst/content/editor/_status-bar.scss

@@ -17,9 +17,11 @@
     display: none;
     grid-area: status;
     font-weight: bold;
+    color: var(--color);
   }
 
   &[data-state="published"] .status-text[data-published],
+  &[data-state="unpublished"] .status-text[data-unpublished],
   &[data-state="draft"] .status-text[data-draft],
   &[data-state="dirty"] .status-text[data-dirty] {
     display: unset;
@@ -72,6 +74,14 @@
     }
   }
 
+  &[data-state="unpublished"] {
+    [value="save"],
+    [value="discard"],
+    [value="revert"] {
+      display: none;
+    }
+  }
+
   &[data-state="draft"] {
     [value="save"],
     [value="discard"] {

data/app/assets/stylesheets/katalyst/content/editor/_trix-rails.scss

@@ -13,12 +13,12 @@
 }
 
 .trix-content
-.attachment-gallery.attachment-gallery--2
-> action-text-attachment,
+  .attachment-gallery.attachment-gallery--2
+  > action-text-attachment,
 .trix-content .attachment-gallery.attachment-gallery--2 > .attachment,
 .trix-content
-.attachment-gallery.attachment-gallery--4
-> action-text-attachment,
+  .attachment-gallery.attachment-gallery--4
+  > action-text-attachment,
 .trix-content .attachment-gallery.attachment-gallery--4 > .attachment {
   flex-basis: 50%;
   max-width: 50%;

data/app/controllers/katalyst/content/direct_uploads_controller.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Content
+    class DirectUploadsController < ActiveStorage::DirectUploadsController
+    end
+  end
+end

data/app/controllers/katalyst/content/items_controller.rb

@@ -14,7 +14,7 @@ module Katalyst
       end
 
       def create
-        item = @container.items.build(item_params)
+        @item = item = @container.items.build(item_params)
         if item.save
           render :update, locals: { item: item, previous: @container.items.build(type: item.type) }
         else

data/app/helpers/katalyst/content/editor/base.rb

@@ -14,6 +14,7 @@ module Katalyst
 
         attr_accessor :template, :container
 
+        delegate :config, to: ::Katalyst::Content
         delegate_missing_to :template
 
         def initialize(template, container)

data/app/helpers/katalyst/content/editor/container.rb

@@ -29,10 +29,6 @@ module Katalyst
           add_option(options, :data, :controller, CONTAINER_CONTROLLER)
           add_option(options, :data, :action, ACTIONS)
 
-          # depth = options.delete(:depth) || container.depth
-          #
-          # add_option(options, :data, :"#{CONTAINER_CONTROLLER}-max-depth-value", depth) if depth
-
           options
         end
       end

data/app/helpers/katalyst/content/editor/image_field.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Content
+    module Editor
+      class ImageField < Base
+        IMAGE_FIELD_CONTROLLER = "content--editor--image-field"
+
+        ACTIONS = <<~ACTIONS.gsub(/\s+/, " ").freeze
+          dragover->#{IMAGE_FIELD_CONTROLLER}#dragover
+          dragenter->#{IMAGE_FIELD_CONTROLLER}#dragenter
+          dragleave->#{IMAGE_FIELD_CONTROLLER}#dragleave
+          drop->#{IMAGE_FIELD_CONTROLLER}#drop
+        ACTIONS
+
+        attr_accessor :item, :method
+
+        def build(item, method, **options, &block)
+          self.item   = item
+          self.method = method
+
+          tag.div **default_options(**options) do
+            concat(capture { yield self }) if block
+          end
+        end
+
+        def preview(**options)
+          add_option(options, :data, "#{IMAGE_FIELD_CONTROLLER}_target", "preview")
+          add_option(options, :class, "hidden") unless preview?
+
+          tag.div **options do
+            image_tag preview_url, class: "image-thumbnail"
+          end
+        end
+
+        def file_input_options(options = {})
+          add_option(options, :accept, config.image_mime_types.join(","))
+          add_option(options, :data, :action, "change->#{IMAGE_FIELD_CONTROLLER}#onUpload")
+
+          options
+        end
+
+        def hint_text
+          t("views.katalyst.content.item.size_hint", max_size: number_to_human_size(config.max_image_size.megabytes))
+        end
+
+        def preview?
+          value&.attached? && value&.persisted?
+        end
+
+        def preview_url
+          preview? ? main_app.url_for(value) : ""
+        end
+
+        def value
+          item.send(method)
+        end
+
+        private
+
+        def default_options(**options)
+          add_option(options, :data, :controller, IMAGE_FIELD_CONTROLLER)
+          add_option(options, :data, :action, ACTIONS)
+          add_option(options, :data, :"#{IMAGE_FIELD_CONTROLLER}_mime_types_value",
+                     config.image_mime_types.to_json)
+
+          options
+        end
+      end
+    end
+  end
+end

data/app/helpers/katalyst/content/editor/status_bar.rb

@@ -11,6 +11,7 @@ module Katalyst
         def build(**options)
           tag.div **default_options(**options) do
             concat status(:published, last_update: l(container.updated_at, format: :short))
+            concat status(:unpublished)
             concat status(:draft)
             concat status(:dirty)
             concat actions
@@ -18,9 +19,17 @@ module Katalyst
         end
 
         def status(state, **options)
-          tag.span(t("views.katalyst.content.editor.#{state}_html", **options),
-                   class: "status-text",
-                   data:  { state => "" })
+          status_text  = t("views.katalyst.content.editor.#{state}_html", **options)
+          html_options = { class: "status-text", data: { state => "", turbo: false } }
+
+          case state
+          when :published
+            link_to status_text, url_for(container), **html_options
+          when :unpublished, :draft
+            link_to status_text, "#{url_for(container)}/preview", **html_options
+          else
+            tag.span status_text, **html_options
+          end
         end
 
         def actions

data/app/helpers/katalyst/content/editor_helper.rb

@@ -37,6 +37,26 @@ module Katalyst
       def content_editor_status_bar(container:, **options)
         Editor::StatusBar.new(self, container).build(**options)
       end
+
+      def content_editor_rich_text_options(options = {})
+        defaults = {
+          data: {
+            direct_upload_url: direct_uploads_url,
+            controller:        "content--editor--trix",
+            action:            "trix-initialize->content--editor--trix#trixInitialize",
+          },
+        }
+        defaults.deep_merge(options)
+      end
+
+      def content_editor_image_field(item:, method:, **options, &block)
+        Editor::ImageField.new(self, item.container).build(item, method, **options, &block)
+      end
+
+      # When rendering item forms do not include the controller namespace prefix (katalyst/content)
+      def prefix_partial_path_with_controller_namespace
+        false
+      end
     end
   end
 end

data/app/helpers/katalyst/content/frontend_helper.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Content
+    module FrontendHelper
+      def render_content(version)
+        render partial: version.tree.select(&:visible?)
+      end
+
+      def render_content_items(items)
+        items = items.select(&:visible?)
+        render partial: items if items.any?
+      end
+
+      def content_item_tag(item, **options, &block)
+        FrontendBuilder.new(self, item).render(**options, &block)
+      end
+    end
+
+    class FrontendBuilder
+      attr_accessor :template, :item
+
+      delegate_missing_to :@template
+
+      def initialize(template, item)
+        self.template = template
+        self.item     = item
+      end
+
+      def render(**options, &block)
+        content_tag tag, **default_options(**options) do
+          content_tag :div, &block
+        end
+      end
+
+      private
+
+      def default_options(**options)
+        {
+          id:    item.heading&.parameterize,
+          class: ["content-item", item.model_name.param_key, item.background, options[:class]],
+          data:  { content_index: item.index, content_depth: item.depth, **options.fetch(:data, {}) },
+          **options.except(:class, :data, :root),
+        }
+      end
+
+      def tag
+        case item
+        when Figure
+          :figure
+        when Section
+          :section
+        else
+          :div
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/katalyst/content/container.rb

@@ -20,8 +20,8 @@ module Katalyst
                    inverse_of: :parent,
                    optional:   true
 
-        delegate :nodes, :items, :tree, to: :published_version, prefix: :published, allow_nil: true
-        delegate :nodes, :items, :tree, to: :draft_version, prefix: :draft, allow_nil: true
+        delegate :nodes, :items, :tree, :text, to: :published_version, prefix: :published, allow_nil: true
+        delegate :nodes, :items, :tree, :text, to: :draft_version, prefix: :draft, allow_nil: true
 
         has_many :versions,
                  class_name:  "#{name}::Version",
@@ -46,18 +46,37 @@ module Katalyst
                  class_name: "Katalyst::Content::Item",
                  dependent:  :destroy,
                  validate:   true
+
+        scope :order_by_state, ->(dir) do
+          dir            = :asc unless %w[asc desc].include?(dir.to_s)
+          unpublished    = arel_table[:published_version_id].eq(nil)
+          draft          = arel_table[:published_version_id].not_eq(arel_table[:draft_version_id])
+          case_statement = Arel::Nodes::Case.new
+                             .when(unpublished).then(3)
+                             .when(draft).then(2)
+                             .else(1)
+          order(case_statement.public_send(dir)).order(updated_at: dir)
+        end
+
+        scope :published, -> { where.not(published_version_id: nil) }
       end
 
       # A resource is in draft mode if it has an unpublished draft or it has no published version.
       # @return the current state of the resource, either `published` or `draft`
       def state
-        if published_version_id && published_version_id == draft_version_id
-          :published
-        else
+        if !published_version_id
+          :unpublished
+        elsif published_version_id != draft_version_id
           :draft
+        else
+          :published
         end
       end
 
+      def published?
+        published_version_id.present?
+      end
+
       # Promotes the draft version to become the published version
       def publish!
         update!(published_version: draft_version)
@@ -70,6 +89,12 @@ module Katalyst
         self
       end
 
+      # Sets the currently published version to nil
+      def unpublish!
+        update!(published_version_id: nil)
+        self
+      end
+
       # Updates the current draft version with new structure. Attributes should be structural information about the
       # items, e.g. `{index => {id:, depth:}` or `[{id:, depth:}]`.
       #
@@ -82,7 +107,9 @@ module Katalyst
       private
 
       def unset_versions
-        update(draft_version: nil, published_version: nil)
+        self.draft_version_id = nil
+        self.published_version_id = nil
+        save!(validate: false)
       end
 
       # Returns an unsaved copy of draft version for accumulating changes.

data/app/models/concerns/katalyst/content/version.rb

@@ -28,6 +28,10 @@ module Katalyst
           item
         end
       end
+
+      def text
+        items.filter_map(&:to_plain_text).join("\n")
+      end
     end
   end
 end

data/app/{helpers/katalyst/content/application_helper.rb → models/katalyst/content/aside.rb}

@@ -2,7 +2,7 @@
 
 module Katalyst
   module Content
-    module ApplicationHelper
+    class Aside < Layout
     end
   end
 end

data/app/models/katalyst/content/column.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Content
+    class Column < Layout
+    end
+  end
+end

data/app/models/katalyst/content/content.rb

@@ -16,6 +16,10 @@ module Katalyst
       def self.permitted_params
         super + %i[content]
       end
+
+      def to_plain_text
+        [super, content.to_plain_text].compact.join("\n") if visible?
+      end
     end
   end
 end

data/app/models/katalyst/content/figure.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "active_storage_validations"
+
+module Katalyst
+  module Content
+    class Figure < Item
+      has_one_attached :image
+
+      validates :image,
+                presence:     true,
+                content_type: config.image_mime_types,
+                size:         { less_than: config.max_image_size.megabytes }
+
+      default_scope { with_attached_image }
+
+      def initialize_dup(source)
+        super
+
+        # if image has changed, duplicate the change, otherwise attach the existing blob
+        if source.attachment_changes["image"]
+          self.image = source.attachment_changes["image"].attachable
+        elsif source.image.attached?
+          image.attach(source.image.blob)
+        end
+      end
+
+      def self.permitted_params
+        super - %i[show_heading] + %i[image caption]
+      end
+
+      alias_attribute :alt, :heading
+
+      def to_plain_text
+        text = ["Image: #{alt}"]
+        text << "Caption: #{caption}" if caption.present?
+        text.compact.join("\n") if visible?
+      end
+    end
+  end
+end

data/app/models/katalyst/content/group.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Content
+    class Group < Layout
+    end
+  end
+end

data/app/models/katalyst/content/item.rb

@@ -4,10 +4,14 @@ module Katalyst
   module Content
     # STI base class for content items
     class Item < ApplicationRecord
+      def self.config
+        Katalyst::Content.config
+      end
+
       belongs_to :container, polymorphic: true
 
       validates :heading, presence: true
-      validates :background, presence: true, inclusion: { in: Katalyst::Content.config.backgrounds }
+      validates :background, presence: true, inclusion: { in: config.backgrounds }
 
       after_initialize :initialize_tree
 
@@ -25,6 +29,14 @@ module Katalyst
         ]
       end
 
+      def to_plain_text
+        heading if show_heading? && visible?
+      end
+
+      def layout?
+        is_a? Layout
+      end
+
       private
 
       def initialize_tree

data/app/models/katalyst/content/layout.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Content
+    class Layout < Item
+    end
+  end
+end

data/app/models/katalyst/content/section.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Content
+    class Section < Layout
+    end
+  end
+end

data/app/views/active_storage/blobs/_blob.html.erb

@@ -1,6 +1,6 @@
 <figure class="attachment attachment--<%= blob.representable? ? "preview" : "file" %> attachment--<%= blob.filename.extension %>">
   <% if blob.representable? %>
-    <%= image_tag blob.representation(resize_to_limit: local_assigns[:in_gallery] ? [ 800, 600 ] : [ 1024, 768 ]) %>
+    <%= image_tag main_app.url_for(blob.representation(resize_to_limit: local_assigns[:in_gallery] ? [ 800, 600 ] : [ 1024, 768 ])) %>
   <% end %>
 
   <figcaption class="attachment__caption">

data/app/views/katalyst/content/asides/_aside.html+form.erb

@@ -0,0 +1,27 @@
+<%= form_with model: aside, scope: :item, url: path do |form| %>
+  <%= render "hidden_fields", form: form %>
+  <%= render "form_errors", form: form %>
+
+  <div class="field">
+    <%= form.label :heading %>
+    <%= form.text_field :heading %>
+  </div>
+
+  <div class="field">
+    <%= form.label :show_heading %>
+    <%= form.check_box :show_heading %>
+  </div>
+
+  <div class="field">
+    <%= form.label :background %>
+    <%= form.select :background, Katalyst::Content.config.backgrounds %>
+  </div>
+
+  <div class="field">
+    <%= form.label :visible %>
+    <%= form.check_box :visible %>
+  </div>
+
+  <%= form.submit "Done" %>
+  <%= link_to "Discard", :back %>
+<% end %>

data/app/views/katalyst/content/asides/_aside.html.erb

@@ -0,0 +1,14 @@
+<%= content_item_tag aside do %>
+  <%= tag.h3 aside.heading if aside.show_heading? %>
+
+  <% items = aside.children.select(&:visible?) %>
+  <% last = items.pop %>
+  <div role="aside-container">
+    <div>
+      <%= render_content_items items %>
+    </div>
+    <aside>
+      <%= render_content_items [last] %>
+    </aside>
+  </div>
+<% end %>

data/app/views/katalyst/content/columns/_column.html+form.erb

@@ -0,0 +1,27 @@
+<%= form_with model: column, scope: :item, url: path do |form| %>
+  <%= render "hidden_fields", form: form %>
+  <%= render "form_errors", form: form %>
+
+  <div class="field">
+    <%= form.label :heading %>
+    <%= form.text_field :heading %>
+  </div>
+
+  <div class="field">
+    <%= form.label :show_heading %>
+    <%= form.check_box :show_heading %>
+  </div>
+
+  <div class="field">
+    <%= form.label :background %>
+    <%= form.select :background, Katalyst::Content.config.backgrounds %>
+  </div>
+
+  <div class="field">
+    <%= form.label :visible %>
+    <%= form.check_box :visible %>
+  </div>
+
+  <%= form.submit "Done" %>
+  <%= link_to "Discard", :back %>
+<% end %>

data/app/views/katalyst/content/columns/_column.html.erb

@@ -0,0 +1,14 @@
+<%= content_item_tag column do %>
+  <%= tag.h3 column.heading if column.show_heading? %>
+
+  <% items = column.children.select(&:visible?) %>
+  <% last = items.pop %>
+  <div class="columns-container">
+    <div class="column">
+      <%= render_content_items items %>
+    </div>
+    <div class="column">
+      <%= render_content_items [last] %>
+    </div>
+  </div>
+<% end %>

data/app/views/katalyst/content/contents/_content.html+form.erb

@@ -1,13 +1,6 @@
 <%= form_with model: content, scope: :item, url: path do |form| %>
-  <%= form.hidden_field :container_type %>
-  <%= form.hidden_field :container_id %>
-  <%= form.hidden_field :type %>
-
-  <%= tag.div class: "errors" do %>
-    <% content.errors.full_messages.each do |error| %>
-      <li class="error"><%= error %></li>
-    <% end %>
-  <% end if content.errors.any? %>
+  <%= render "hidden_fields", form: form %>
+  <%= render "form_errors", form: form %>
 
   <div class="field">
     <%= form.label :heading %>
@@ -31,7 +24,7 @@
 
   <div class="field">
     <%= form.label :content %>
-    <%= form.rich_text_area :content %>
+    <%= form.rich_text_area :content, content_editor_rich_text_options %>
   </div>
 
   <%= form.submit "Done" %>

data/app/views/katalyst/content/contents/_content.html.erb

@@ -1,5 +1,5 @@
-<div class="<%= content.background %>">
-  <%= tag.h2 content.heading if content.show_heading? %>
+<%= content_item_tag content do %>
+  <%= tag.h3 content.heading if content.show_heading? %>
 
   <%= content.content %>
-</div>
+<% end %>

data/app/views/katalyst/content/editor/_list_item.html.erb

@@ -3,6 +3,7 @@
     data-content-item-id="<%= item.id %>"
     data-content-index="<%= item.index %>"
     data-content-depth="<%= item.depth %>"
+    <%= "data-content-layout" if item.layout? %>
     data-deny-de-nest
     data-deny-nest
     data-deny-collapse

data/app/views/katalyst/content/figures/_figure.html+form.erb

@@ -0,0 +1,38 @@
+<%= form_with model: figure, scope: :item, url: path do |form| %>
+  <%= render "hidden_fields", form: form %>
+  <%= render "form_errors", form: form %>
+
+  <%= content_editor_image_field item: figure, method: :image do |builder| %>
+    <div class="field">
+      <%= form.label :image %>
+      <div>
+        <%= builder.preview class: "image-wrapper" %>
+      </div>
+      <%= form.file_field :image, **builder.file_input_options %>
+      <hint><%= builder.hint_text %></hint>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= form.label :heading %>
+    <%= form.text_field :heading %>
+  </div>
+
+  <div class="field">
+    <%= form.label :background %>
+    <%= form.select :background, Katalyst::Content.config.backgrounds %>
+  </div>
+
+  <div class="field">
+    <%= form.label :visible %>
+    <%= form.check_box :visible %>
+  </div>
+
+  <div class="field">
+    <%= form.label :caption %>
+    <%= form.text_field :caption %>
+  </div>
+
+  <%= form.submit "Done" %>
+  <%= link_to "Discard", :back %>
+<% end %>