katalyst-navigation 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6424bb96df0ceb96b40aa6d225dbe12461784edb41c1b83863435a56db02fd68
-  data.tar.gz: 6a46bbd339f8c171fe7a9791ad94281c6e0cb6f846f8bab04bd62edb8e8c339c
+  metadata.gz: faf8cc382bdaae60ca2a35d93dcdfe970e36d317912ed13038607e74cf68da45
+  data.tar.gz: '05539e1025ee15510fb6952a3bfec19534daa834af0dd80f303081badb3a68cf'
 SHA512:
-  metadata.gz: 173290becb5111777b887baeefe3a93642d8b154cb6463fd0a84a83e0246be7159568cc836d3eb2ca4ca7b9d7a2b616eff69c284d7abbaa93f7f2a26e0f81f76
-  data.tar.gz: cad3f1cf87f00b7868aac073b71d192345b341feb73a0d28de332fccd932278988c256cc9228d2f30eadc55b2de0c4070d8a263c323e235b22f18f087bbc9abb
+  metadata.gz: dd9484b91afa4c6e80347513fe063989b00f838b9b6ca7bd3ff448879f444a89a7789e9e3fe7216987f67ea23fa4ae036797841b6e8631be37b157b6000b807f
+  data.tar.gz: 650999ce4d2ead2f82c80ec97458edbc326c0c43c57c62a5bb72f86f1c79c7c8c0adee7dba0653b4ea09b05d135677ad4de582209b13d7d9a66592ca8b49a058

data/app/assets/stylesheets/katalyst/navigation/editor/_item-actions.scss

@@ -22,8 +22,7 @@
     }
   }
 
-  [role="img"][value="link"],
-  [role="img"][value="title"] {
+  [role="img"][title="Type"] {
     width: 1.5rem;
     height: 1.5rem;
     display: grid;
@@ -44,18 +43,18 @@
       line-height: 1.125rem;
       text-align: center;
     }
+  }
 
-    &[value="link"] {
-      &::before {
-        content: "#";
-      }
-    }
+  [role="img"][value="heading"]::before {
+    content: "H";
+  }
 
-    &[value="title"] {
-      &::before {
-        content: "T";
-      }
-    }
+  [role="img"][value="link"]::before {
+    content: "#";
+  }
+
+  [role="img"][value="button"]::before {
+    content: "#";
   }
 
   [role="img"][value="invisible"] {

data/app/assets/stylesheets/katalyst/navigation/editor/_new-items.scss

@@ -28,6 +28,10 @@
       position: unset;
     }
 
+    &[data-item-type="heading"]:before {
+      background-image: url("data:image/svg+xml,%3Csvg viewBox='0 0 64 64' xmlns='http://www.w3.org/2000/svg'%3E%3Cstyle%3Etext %7B font: 72px serif %7D%3C/style%3E%3Ctext x='7' y='56' textLength='48'%3EH%3C/text%3E%3C/svg%3E%0A");
+    }
+
     &[data-item-type="link"]:before {
       background-image: url("data:image/svg+xml,%3Csvg viewBox='0 0 48 48' xmlns='http://www.w3.org/2000/svg'%3E%3Cg clip-path='url(%23clip0_67_1273)'%3E%3Cpath d='M16 22H32V26H16V22ZM40.2 24H44C44 18.48 39.52 14 34 14H26V17.8H34C37.42 17.8 40.2 20.58 40.2 24ZM7.8 24C7.8 20.58 10.58 17.8 14 17.8H22V14H14C8.48 14 4 18.48 4 24C4 29.52 8.48 34 14 34H22V30.2H14C10.58 30.2 7.8 27.42 7.8 24ZM38 24H34V30H28V34H34V40H38V34H44V30H38V24Z' /%3E%3C/g%3E%3Cdefs%3E%3CclipPath id='clip0_67_1273'%3E%3Crect width='48' height='48' /%3E%3C/clipPath%3E%3C/defs%3E%3C/svg%3E");
     }

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

@@ -10,6 +10,10 @@ module Katalyst
         render locals: { item: @menu.items.build(type: new_item_params) }
       end
 
+      def edit
+        render locals: { item: @item }
+      end
+
       def create
         item = @menu.items.build(item_params)
         if item.save
@@ -19,10 +23,6 @@ module Katalyst
         end
       end
 
-      def edit
-        render locals: { item: @item }
-      end
-
       def update
         @item.attributes = item_params
 
@@ -41,8 +41,17 @@ module Katalyst
         params[:type] || Link.name
       end
 
+      def item_params_type
+        type = params.require(:item).fetch(:type, "")
+        if Katalyst::Navigation.config.items.include?(type)
+          type.safe_constantize
+        else
+          Item
+        end
+      end
+
       def item_params
-        params.require(:item).permit(%i[title url visible http_method new_tab type])
+        params.require(:item).permit(item_params_type.permitted_params)
       end
 
       def set_menu

data/app/controllers/katalyst/navigation/menus_controller.rb

@@ -9,10 +9,22 @@ module Katalyst
         render locals: { menus: menus, sort: sort }
       end
 
+      def show
+        menu = Menu.find(params[:id])
+
+        render locals: { menu: menu }
+      end
+
       def new
         render locals: { menu: Menu.new }
       end
 
+      def edit
+        menu = Menu.find(params[:id])
+
+        render locals: { menu: menu }
+      end
+
       def create
         @menu = Menu.new(menu_params)
 
@@ -23,18 +35,6 @@ module Katalyst
         end
       end
 
-      def show
-        menu = Menu.find(params[:id])
-
-        render locals: { menu: menu }
-      end
-
-      def edit
-        menu = Menu.find(params[:id])
-
-        render locals: { menu: menu }
-      end
-
       # PATCH /admins/navigation_menus/:slug
       def update
         menu = Menu.find(params[:id])
@@ -42,7 +42,8 @@ module Katalyst
         menu.attributes = menu_params
 
         unless menu.valid?
-          return render :show, locals: { menu: menu }, status: :unprocessable_entity
+          return render turbo_stream: helpers.navigation_editor_errors(menu: menu),
+                        status:       :unprocessable_entity
         end
 
         case params[:commit]

data/app/helpers/katalyst/navigation/editor/errors.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Navigation
+    module Editor
+      class Errors < Base
+        def build(**options)
+          turbo_frame_tag dom_id(menu, :errors) do
+            next unless menu.errors.any?
+
+            tag.div(class: "navigation-errors", **options) do
+              tag.h2("Errors in navigation") +
+                tag.ul(class: "errors") do
+                  menu.errors.each do |error|
+                    concat(tag.li(error.message))
+                  end
+                end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/helpers/katalyst/navigation/editor/menu.rb

@@ -14,6 +14,7 @@ module Katalyst
         def build(options)
           form_with(model: menu, **default_options(id: menu_form_id, **options)) do |form|
             concat hidden_input
+            concat errors
             concat(capture { yield form })
           end
         end
@@ -26,6 +27,10 @@ module Katalyst
           tag.input(type: "hidden", name: "#{Item::ATTRIBUTES_SCOPE}[id]")
         end
 
+        def errors
+          Editor::Errors.new(self, menu).build
+        end
+
         def default_options(options)
           add_option(options, :data, :controller, MENU_CONTROLLER)
           add_option(options, :data, :action, ACTIONS)

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

@@ -4,11 +4,10 @@ module Katalyst
   module Navigation
     module EditorHelper
       def navigation_editor_new_items(menu)
-        [
-          Heading.new(menu: menu),
-          Link.new(menu: menu),
-          Button.new(menu: menu),
-        ]
+        Katalyst::Navigation.config.items.map do |item_class|
+          item_class = item_class.is_a?(String) ? item_class.safe_constantize : item_class
+          item_class.new(menu: menu)
+        end
       end
 
       def navigation_editor_menu(menu:, **options, &block)
@@ -26,7 +25,13 @@ module Katalyst
         Editor::List.new(self, menu).items(item)
       end
 
-      # Gene
+      # Generate a turbo stream fragment that will show structural errors to the user.
+      def navigation_editor_errors(menu:, **options)
+        turbo_stream.replace(dom_id(menu, :errors),
+                             Editor::Errors.new(self, menu).build(**options))
+      end
+
+      # Generate a new item template.
       def navigation_editor_new_item(item:, menu: item.menu, **options, &block)
         Editor::NewItem.new(self, menu).build(item, **options, &block)
       end

data/app/helpers/katalyst/navigation/frontend/builder.rb

@@ -1,22 +1,23 @@
 # frozen_string_literal: true
 
+# rubocop:disable Rails/HelperInstanceVariable
 module Katalyst
   module Navigation
     module Frontend
       class Builder
-        attr_accessor :template, :menu_options, :list_options, :item_options
+        attr_accessor :template
 
         delegate_missing_to :@template
 
         def initialize(template, list: {}, item: {}, **menu_options)
-          self.template     = template
-          self.menu_options = menu_options
-          self.list_options = list
-          self.item_options = item
+          self.template = template
+          @menu_options = menu_options.freeze
+          @list_options = list.freeze
+          @item_options = item.freeze
         end
 
         def render(tree)
-          tag.ul **menu_options do
+          tag.ul(**menu_options(tree)) do
             tree.each do |item|
               concat render_item(item)
             end
@@ -26,32 +27,47 @@ module Katalyst
         def render_item(item)
           return unless item.visible?
 
-          tag.li **item_options do
+          tag.li(**item_options(item)) do
             concat public_send("render_#{item.model_name.param_key}", item)
-            concat render_list(item.children) if item.children.any?
+            concat render_children(item) if item.children.any?
           end
         end
 
-        def render_list(items)
-          tag.ul **list_options do
-            items.each do |child|
+        def render_children(item)
+          tag.ul(**list_options(item)) do
+            item.children.each do |child|
               concat render_item(child)
             end
           end
         end
 
         def render_heading(heading)
-          tag.header { tag.p heading.title }
+          tag.span(heading.title)
         end
 
         def render_link(link)
-          link_to(link.title, link.url, item_options)
+          link_to(link.title, link.url)
         end
 
         def render_button(link)
-          link_to(link.title, link.url, **item_options, method: link.http_method)
+          link_to(link.title, link.url, method: link.http_method)
+        end
+
+        private
+
+        def menu_options(_tree)
+          @menu_options
+        end
+
+        def list_options(_item)
+          @list_options
+        end
+
+        def item_options(_item)
+          @item_options
         end
       end
     end
   end
 end
+# rubocop:enable Rails/HelperInstanceVariable

data/app/models/katalyst/navigation/button.rb

@@ -10,6 +10,10 @@ module Katalyst
 
       validates :title, :url, :http_method, presence: true
       validates :http_method, inclusion: { in: HTTP_METHODS.values.map(&:to_s) }
+
+      def self.permitted_params
+        super + %i[http_method]
+      end
     end
   end
 end

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

@@ -10,6 +10,16 @@ module Katalyst
 
       attr_accessor :parent, :children, :index, :depth
 
+      def self.permitted_params
+        %i[
+          title
+          url
+          visible
+          new_tab
+          type
+        ]
+      end
+
       def layout?
         is_a? Layout
       end

data/app/models/katalyst/navigation/menu.rb

@@ -69,6 +69,11 @@ module Katalyst
         self
       end
 
+      # Required for testing items validation
+      def items_attributes
+        draft_version&.nodes&.as_json
+      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:}]`.
       #
@@ -105,6 +110,8 @@ module Katalyst
 
         attribute :nodes, Types::NodesType.new, default: -> { [] }
 
+        validate :ensure_items_exists
+
         def items
           # support building menus in memory
           # requires that items are added in order and index and depth are set
@@ -112,12 +119,18 @@ module Katalyst
 
           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
+            items[node.id]&.tap do |item|
+              item.index = node.index
+              item.depth = node.depth
+            end
           end
         end
+
+        private
+
+        def ensure_items_exists
+          parent.errors.add(:items, :missing_item) unless items.all?(&:present?)
+        end
       end
     end
   end

data/app/views/katalyst/navigation/menus/_item.html.erb

@@ -2,7 +2,7 @@
   <div class="tree" data-invisible="<%= !item.visible? %>">
     <%= builder.accordion_actions %>
 
-    <span role="img" value="<%= item.url.present? ? "link" : "title" %>" title="Type"></span>
+    <span role="img" value="<%= item.model_name.param_key %>" title="Type"></span>
     <h4 class="title" title="<%= item.title %>"><%= item.title %></h4>
     <span role="img" value="invisible" title="Hidden"></span>
   </div>

data/config/locales/en.yml

@@ -1,4 +1,8 @@
 en:
+  activerecord:
+    errors:
+      messages:
+        missing_item: Items are missing or invalid
   views:
     katalyst:
       navigation:

data/lib/katalyst/navigation/config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "active_support/configurable"
+
+module Katalyst
+  module Navigation
+    class Config
+      include ActiveSupport::Configurable
+
+      config_accessor(:items) do
+        %w[
+          Katalyst::Navigation::Heading
+          Katalyst::Navigation::Link
+          Katalyst::Navigation::Button
+        ]
+      end
+    end
+  end
+end

data/lib/katalyst/navigation/version.rb

@@ -2,6 +2,6 @@
 
 module Katalyst
   module Navigation
-    VERSION = "1.2.0"
+    VERSION = "1.3.1"
   end
 end

data/lib/katalyst/navigation.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-navigation
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-25 00:00:00.000000000 Z
+date: 2022-11-02 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -39,6 +39,7 @@ files:
 - app/controllers/katalyst/navigation/items_controller.rb
 - app/controllers/katalyst/navigation/menus_controller.rb
 - app/helpers/katalyst/navigation/editor/base.rb
+- app/helpers/katalyst/navigation/editor/errors.rb
 - app/helpers/katalyst/navigation/editor/item.rb
 - app/helpers/katalyst/navigation/editor/list.rb
 - app/helpers/katalyst/navigation/editor/menu.rb
@@ -78,6 +79,7 @@ files:
 - db/migrate/20220826034507_create_katalyst_navigation_items.rb
 - db/migrate/20220908044500_add_depth_limit_to_menus.rb
 - lib/katalyst/navigation.rb
+- lib/katalyst/navigation/config.rb
 - lib/katalyst/navigation/engine.rb
 - lib/katalyst/navigation/version.rb
 - lib/tasks/yarn.rake