katalyst-content 0.1.0

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

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Content
+    module Container
+      extend ActiveSupport::Concern
+
+      included do # rubocop:disable Metrics/BlockLength
+        include Katalyst::Content::GarbageCollection
+
+        before_destroy :unset_versions
+
+        belongs_to :draft_version,
+                   autosave:   true,
+                   class_name: "#{name}::Version",
+                   inverse_of: :parent,
+                   optional:   true
+        belongs_to :published_version,
+                   class_name: "#{name}::Version",
+                   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
+
+        has_many :versions,
+                 class_name:  "#{name}::Version",
+                 dependent:   :delete_all,
+                 foreign_key: :parent_id,
+                 inverse_of:  :parent,
+                 validate:    true do
+          def active
+            parent = proxy_association.owner
+            where(id: [parent.published_version_id, parent.draft_version_id].uniq.compact)
+          end
+
+          def inactive
+            parent = proxy_association.owner
+            where.not(id: [parent.published_version_id, parent.draft_version_id].uniq.compact)
+          end
+        end
+
+        has_many :items,
+                 as:         :container,
+                 autosave:   true,
+                 class_name: "Katalyst::Content::Item",
+                 dependent:  :destroy,
+                 validate:   true
+      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
+          :draft
+        end
+      end
+
+      # Promotes the draft version to become the published version
+      def publish!
+        update!(published_version: draft_version)
+        self
+      end
+
+      # Reverts the draft version to the current published version
+      def revert!
+        update!(draft_version: published_version)
+        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:}]`.
+      #
+      # This method conforms to the behaviour of `accepts_nested_attributes_for` so that it can be used with rails form
+      # helpers.
+      def items_attributes=(attributes)
+        next_version.nodes = attributes
+      end
+
+      private
+
+      def unset_versions
+        update(draft_version: nil, published_version: nil)
+      end
+
+      # Returns an unsaved copy of draft version for accumulating changes.
+      def next_version
+        if draft_version.nil?
+          build_draft_version
+        elsif draft_version.persisted?
+          self.draft_version = draft_version.dup
+        else
+          draft_version
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Content
+    module GarbageCollection
+      extend ActiveSupport::Concern
+
+      included do
+        after_update :remove_stale_versions
+      end
+
+      def remove_stale_versions
+        transaction do
+          # find all the versions that are not linked to the record
+          orphaned_versions = versions.inactive
+
+          next unless orphaned_versions.any?
+
+          # find items that are not included in active versions
+          orphaned_items = items.pluck(:id) - versions.active.pluck(:nodes).flat_map { |k| k.map(&:id) }.uniq
+
+          # delete orphaned items with a 2 hour grace period to allow for in-progress editing
+          items.where(id: orphaned_items, updated_at: ..2.hours.ago).destroy_all
+
+          # delete orphaned versions without a grace period as they can only be created by updates
+          orphaned_versions.destroy_all
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Content
+    module HasTree
+      # Constructs a tree from an ordered list of items with depth.
+      #  * items that have higher depth than their predecessor are nested as `children`.
+      #  * items with the same depth become siblings.
+      def tree
+        items.reduce(Builder.new, &:add).tree
+      end
+
+      class Builder
+        attr_reader :current, :depth, :children, :tree
+
+        def initialize
+          @depth    = 0
+          @children = @tree = []
+        end
+
+        def add(node)
+          if node.depth == depth
+            node.parent = current
+            children << node
+            self
+          elsif node.depth > depth
+            push(children.last)
+            add(node)
+          else
+            pop
+            add(node)
+          end
+        end
+
+        private
+
+        attr_writer :current, :depth, :children
+
+        # Add node to the top of builder stacks
+        def push(node)
+          self.depth += 1
+          self.current  = node
+          self.children = node.children = []
+          node
+        end
+
+        # Remove current from builder stack
+        def pop
+          previous = current
+          self.depth -= 1
+          if depth.zero?
+            self.current  = nil
+            self.children = tree
+          else
+            self.current  = previous.parent
+            self.children = current.children
+          end
+          previous
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Content
+    module Version
+      extend ActiveSupport::Concern
+
+      included do # rubocop:disable Metrics/BlockLength
+        include Katalyst::Content::HasTree
+
+        # rubocop:disable Rails/ReflectionClassName
+        belongs_to :parent, class_name: name.gsub(/::Version$/, ""), inverse_of: :versions
+        # rubocop:enable Rails/ReflectionClassName
+
+        attribute :nodes, Katalyst::Content::Types::NodesType.new, default: -> { [] }
+      end
+
+      def items
+        # support building menus in memory
+        # requires that items are added in order and index and depth are set
+        return parent.items unless parent.persisted?
+
+        items = parent.items.where(id: nodes.map(&:id)).index_by(&:id)
+        nodes.map do |node|
+          item       = items[node.id]
+          item.index = node.index
+          item.depth = node.depth
+          item
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Content
+    class Content < Item
+      has_rich_text :content
+
+      validates :content, presence: true
+
+      def initialize_copy(source)
+        super
+
+        self.content = source.content&.body if source.content.is_a?(ActionText::RichText)
+      end
+
+      def self.permitted_params
+        super + %i[content]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Content
+    # STI base class for content items
+    class Item < ApplicationRecord
+      belongs_to :container, polymorphic: true
+
+      validates :heading, presence: true
+      validates :background, presence: true, inclusion: { in: Katalyst::Content.config.backgrounds }
+
+      after_initialize :initialize_tree
+
+      attr_accessor :parent, :children, :index, :depth
+
+      def self.permitted_params
+        %i[
+          container_type
+          container_id
+          type
+          heading
+          show_heading
+          background
+          visible
+        ]
+      end
+
+      private
+
+      def initialize_tree
+        self.parent   ||= nil
+        self.children ||= []
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Content
+    # Data class for representing structural information about an item
+    class Node
+      include ActiveModel::Model
+      include ActiveModel::Attributes
+
+      attribute :id, :integer
+      attribute :index, :integer
+      attribute :depth, :integer, default: 0
+
+      attr_accessor :item
+
+      def as_json
+        attributes.slice("id", "depth").as_json
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Content
+    module Types
+      # Data serialization/deserialization for Katalyst::Content structural data
+      class NodesType < ActiveRecord::Type::Json
+        def serialize(value)
+          super(value.as_json)
+        end
+
+        def deserialize(value)
+          case value
+          when nil
+            nil
+          when String
+            deserialize(super)
+          when Hash
+            deserialize_params(value)
+          when Array
+            deserialize_array(value)
+          end
+        end
+
+        private
+
+        # Deserialize a params-style array, e.g. "0" => { ... }
+        def deserialize_params(value)
+          value.map do |index, attributes|
+            Node.new(index: index, **attributes)
+          end.select(&:id).sort_by(&:index)
+        end
+
+        def deserialize_array(value)
+          value.map.with_index do |attributes, index|
+            Node.new(index: index, **attributes)
+          end.select(&:id).sort_by(&:index)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+<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 ]) %>
+  <% end %>
+
+  <figcaption class="attachment__caption">
+    <% if caption = blob.try(:caption) %>
+      <%= caption %>
+    <% else %>
+      <span class="attachment__name"><%= blob.filename %></span>
+      <span class="attachment__size"><%= number_to_human_size blob.byte_size %></span>
+    <% end %>
+  </figcaption>
+</figure>

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

@@ -0,0 +1,39 @@
+<%= 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? %>
+
+  <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>
+
+  <div class="field">
+    <%= form.label :content %>
+    <%= form.rich_text_area :content %>
+  </div>
+
+  <%= form.submit "Done" %>
+  <%= link_to "Discard", :back %>
+<% end %>

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

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

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

@@ -0,0 +1,11 @@
+<%= content_editor_item item: item do |builder| %>
+  <div class="tree" data-invisible="<%= !item.visible? %>">
+    <%= builder.accordion_actions %>
+
+    <span role="img" value="<%= item.model_name.to_param %>" title="Type"></span>
+    <h4 class="heading" title="<%= item.heading %>"><%= item.heading %></h4>
+    <span role="img" value="invisible" title="Hidden"></span>
+  </div>
+
+  <%= builder.item_actions %>
+<% end %>

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

@@ -0,0 +1,14 @@
+<li draggable="true"
+    data-content-item
+    data-content-item-id="<%= item.id %>"
+    data-content-index="<%= item.index %>"
+    data-content-depth="<%= item.depth %>"
+    data-deny-de-nest
+    data-deny-nest
+    data-deny-collapse
+    data-deny-expand
+    data-deny-remove
+    data-deny-drag
+    data-deny-edit>
+  <%= yield %>
+</li>

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

@@ -0,0 +1,3 @@
+<%= content_editor_new_item item: item, data: { item_type: item.model_name.param_key } do %>
+  <%= item.model_name.human %>
+<% end %>

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

@@ -0,0 +1,5 @@
+<%= turbo_frame_tag "content--editor--item-frame" do %>
+  <div class="content--editor--new-items" role="listbox">
+    <%= render partial: "katalyst/content/editor/new_item", collection: content_editor_new_items(container: container), as: :item %>
+  </div>
+<% end %>

data/app/views/katalyst/content/items/_item.html+form.erb

@@ -0,0 +1,34 @@
+<%= form_with model: item, 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 %>
+    <% item.errors.full_messages.each do |error| %>
+      <li class="error"><%= error %></li>
+    <% end %>
+  <% end if item.errors.any? %>
+
+  <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/items/_item.html.erb

@@ -0,0 +1,3 @@
+<div class="<%= item.background %>">
+  <%= tag.h2 item.heading if item.show_heading? %>
+</div>

data/app/views/katalyst/content/items/edit.html.erb

@@ -0,0 +1,4 @@
+<%= turbo_frame_tag "content--editor--item-frame" do %>
+  <h3 class="heading-three">Edit <%= item.model_name.human.downcase %></h3>
+  <%= render item, path: katalyst_content.item_path(item) %>
+<% end %>

data/app/views/katalyst/content/items/new.html.erb

@@ -0,0 +1,4 @@
+<%= turbo_frame_tag "content--editor--item-frame" do %>
+  <h3 class="heading-three">New <%= item.model_name.human.downcase %></h3>
+  <%= render item, path: katalyst_content.items_path %>
+<% end %>

data/app/views/katalyst/content/items/update.turbo_stream.erb

@@ -0,0 +1,7 @@
+<%= turbo_stream.replace "content--editor--item-frame" do %>
+  <%= render "katalyst/content/editor/new_items", container: item.container %>
+<% end %>
+
+<%= turbo_stream.replace dom_id(previous) do %>
+  <%= render "katalyst/content/editor/item", item: item %>
+<% end %>

data/app/views/layouts/action_text/contents/_content.html.erb

@@ -0,0 +1,3 @@
+<div class="trix-content">
+  <%= yield -%>
+</div>

data/config/importmap.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+pin "trix"
+pin "@rails/actiontext", to: "actiontext.js"
+
+pin_all_from Katalyst::Content::Engine.root.join("app/assets/javascripts"),
+             # preload in tests so that we don't start clicking before controllers load
+             preload: Rails.env.test?

data/config/locales/en.yml

@@ -0,0 +1,12 @@
+en:
+  views:
+    katalyst:
+      content:
+        editor:
+          draft_html: Draft
+          dirty_html: Unsaved changes
+          discard: Discard
+          publish: Publish
+          published_html: Published <i>(last updated %{last_update})</i>
+          revert: Revert
+          save: Save

data/config/routes.rb

@@ -0,0 +1,3 @@
+Katalyst::Content::Engine.routes.draw do
+  resources :items
+end

data/db/migrate/20220913003839_create_katalyst_content_items.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class CreateKatalystContentItems < ActiveRecord::Migration[7.0]
+  def change
+    create_table :katalyst_content_items do |t|
+      t.string :type
+      t.belongs_to :container, polymorphic: true
+
+      t.string :heading, null: false
+      t.boolean :show_heading, null: false, default: true
+      t.string :background, null: false
+      t.boolean :visible, null: false, default: true
+
+      t.timestamps
+    end
+  end
+end

data/lib/katalyst/content/config.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "active_support/configurable"
+
+module Katalyst
+  module Content
+    class Config
+      include ActiveSupport::Configurable
+
+      config_accessor(:backgrounds) { %w[light dark] }
+      config_accessor(:items) do
+        %w[
+          Katalyst::Content::Content
+        ]
+      end
+    end
+  end
+end

data/lib/katalyst/content/engine.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "rails"
+
+module Katalyst
+  module Content
+    class Engine < ::Rails::Engine
+      isolate_namespace Katalyst::Content
+
+      initializer "katalyst-content.factories", after: "factory_bot.set_factory_paths" do
+        FactoryBot.definition_file_paths << Engine.root.join("spec/factories") if defined?(FactoryBot)
+      end
+
+      config.generators do |g|
+        g.test_framework :rspec
+        g.fixture_replacement :factory_bot
+        g.factory_bot dir: "spec/factories"
+      end
+
+      initializer "katalyst-content.asset" do
+        config.after_initialize do |app|
+          if app.config.respond_to?(:assets)
+            app.config.assets.precompile += %w(katalyst-content.js)
+          end
+        end
+      end
+
+      initializer "katalyst-content.importmap", before: "importmap" do |app|
+        if app.config.respond_to?(:importmap)
+          app.config.importmap.paths << root.join("config/importmap.rb")
+          app.config.importmap.cache_sweepers << root.join("app/assets/javascripts")
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/content/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Content
+    VERSION = "0.1.0"
+  end
+end

data/lib/katalyst/content.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "katalyst/content/config"
+require "katalyst/content/engine"
+require "katalyst/content/version"
+
+module Katalyst
+  module Content
+    extend self
+
+    def config
+      @config ||= Config.new
+    end
+
+    def configure
+      yield config
+    end
+  end
+end

data/lib/tasks/yarn.rake

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+namespace :yarn do
+  desc "Install npm packages with yarn"
+  task install: :environment do
+    sh "yarn install"
+  end
+
+  desc "Lint JS/SCSS files using yarn (prettier)"
+  task lint: :install do
+    sh "yarn lint"
+  end
+
+  desc "Autoformat JS/SCSS files using yarn (prettier)"
+  task format: :install do
+    sh "yarn format"
+  end
+end