katalyst-navigation 1.4.0 → 1.5.0

metadata

@@ -1,15 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-navigation
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-27 00:00:00.000000000 Z
-dependencies: []
+date: 2023-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: katalyst-html-attributes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: katalyst-kpop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: katalyst-tables
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - developers@katalyst.com.au
@@ -19,35 +75,48 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
+- app/assets/builds/katalyst/navigation.esm.js
+- app/assets/builds/katalyst/navigation.js
+- app/assets/builds/katalyst/navigation.min.js
+- app/assets/builds/katalyst/navigation.min.js.map
 - app/assets/config/katalyst-navigation.js
-- app/assets/javascripts/controllers/navigation/editor/item_controller.js
-- app/assets/javascripts/controllers/navigation/editor/list_controller.js
-- app/assets/javascripts/controllers/navigation/editor/menu_controller.js
-- app/assets/javascripts/controllers/navigation/editor/new_item_controller.js
-- app/assets/javascripts/controllers/navigation/editor/status_bar_controller.js
-- app/assets/javascripts/utils/navigation/editor/item.js
-- app/assets/javascripts/utils/navigation/editor/menu.js
-- app/assets/javascripts/utils/navigation/editor/rules-engine.js
 - app/assets/stylesheets/katalyst/navigation/editor/_icon.scss
 - app/assets/stylesheets/katalyst/navigation/editor/_index.scss
 - app/assets/stylesheets/katalyst/navigation/editor/_item-actions.scss
 - app/assets/stylesheets/katalyst/navigation/editor/_item-rules.scss
 - app/assets/stylesheets/katalyst/navigation/editor/_new-items.scss
 - app/assets/stylesheets/katalyst/navigation/editor/_status-bar.scss
+- app/components/katalyst/navigation/editor/base_component.rb
+- app/components/katalyst/navigation/editor/errors_component.html.erb
+- app/components/katalyst/navigation/editor/errors_component.rb
+- app/components/katalyst/navigation/editor/item_component.html.erb
+- app/components/katalyst/navigation/editor/item_component.rb
+- app/components/katalyst/navigation/editor/item_editor_component.rb
+- app/components/katalyst/navigation/editor/new_item_component.html.erb
+- app/components/katalyst/navigation/editor/new_item_component.rb
+- app/components/katalyst/navigation/editor/new_items_component.html.erb
+- app/components/katalyst/navigation/editor/new_items_component.rb
+- app/components/katalyst/navigation/editor/row_component.html.erb
+- app/components/katalyst/navigation/editor/row_component.rb
+- app/components/katalyst/navigation/editor/status_bar_component.rb
+- app/components/katalyst/navigation/editor/table_component.html.erb
+- app/components/katalyst/navigation/editor/table_component.rb
+- app/components/katalyst/navigation/editor_component.html.erb
+- app/components/katalyst/navigation/editor_component.rb
 - app/controllers/concerns/katalyst/navigation/has_navigation.rb
-- app/controllers/katalyst/navigation/base_controller.rb
 - 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
-- app/helpers/katalyst/navigation/editor/new_item.rb
-- app/helpers/katalyst/navigation/editor/status_bar.rb
-- app/helpers/katalyst/navigation/editor_helper.rb
 - app/helpers/katalyst/navigation/frontend/builder.rb
 - app/helpers/katalyst/navigation/frontend_helper.rb
+- app/javascript/navigation/application.js
+- app/javascript/navigation/editor/item.js
+- app/javascript/navigation/editor/item_controller.js
+- app/javascript/navigation/editor/list_controller.js
+- app/javascript/navigation/editor/menu.js
+- app/javascript/navigation/editor/menu_controller.js
+- app/javascript/navigation/editor/new_item_controller.js
+- app/javascript/navigation/editor/rules-engine.js
+- app/javascript/navigation/editor/status_bar_controller.js
 - app/models/concerns/katalyst/navigation/garbage_collection.rb
 - app/models/concerns/katalyst/navigation/has_link.rb
 - app/models/concerns/katalyst/navigation/has_tree.rb
@@ -60,16 +129,14 @@ files:
 - app/models/katalyst/navigation/node.rb
 - app/models/katalyst/navigation/types/nodes_type.rb
 - app/views/katalyst/navigation/items/_button.html.erb
+- app/views/katalyst/navigation/items/_form_errors.html.erb
 - app/views/katalyst/navigation/items/_heading.html.erb
 - app/views/katalyst/navigation/items/_link.html.erb
 - app/views/katalyst/navigation/items/edit.html.erb
+- app/views/katalyst/navigation/items/edit.turbo_stream.erb
 - app/views/katalyst/navigation/items/new.html.erb
 - app/views/katalyst/navigation/items/update.turbo_stream.erb
-- app/views/katalyst/navigation/menus/_item.html.erb
-- app/views/katalyst/navigation/menus/_list_item.html.erb
 - app/views/katalyst/navigation/menus/_menu.html+row.erb
-- app/views/katalyst/navigation/menus/_new_item.html.erb
-- app/views/katalyst/navigation/menus/_new_items.html.erb
 - app/views/katalyst/navigation/menus/edit.html.erb
 - app/views/katalyst/navigation/menus/index.html.erb
 - app/views/katalyst/navigation/menus/new.html.erb
@@ -84,7 +151,6 @@ files:
 - lib/katalyst/navigation.rb
 - lib/katalyst/navigation/config.rb
 - lib/katalyst/navigation/engine.rb
-- lib/katalyst/navigation/version.rb
 - spec/factories/katalyst/navigation/items.rb
 - spec/factories/katalyst/navigation/menus.rb
 homepage: https://github.com/katalyst/navigation
@@ -100,14 +166,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Navigation generator and editor

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

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Katalyst
-  module Navigation
-    class BaseController < ActionController::Base
-      include Katalyst::Tables::Backend
-
-      helper Katalyst::Navigation::EditorHelper
-      helper Katalyst::Tables::Frontend
-    end
-  end
-end

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

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module Katalyst
-  module Navigation
-    module Editor
-      class Base
-        MENU_CONTROLLER       = "navigation--editor--menu"
-        LIST_CONTROLLER       = "navigation--editor--list"
-        ITEM_CONTROLLER       = "navigation--editor--item"
-        STATUS_BAR_CONTROLLER = "navigation--editor--status-bar"
-        NEW_ITEM_CONTROLLER   = "navigation--editor--new-item"
-
-        ATTRIBUTES_SCOPE = "menu[items_attributes][]"
-        TURBO_FRAME      = "navigation--editor--item-frame"
-
-        attr_accessor :template, :menu
-
-        delegate_missing_to :template
-
-        def initialize(template, menu)
-          self.template = template
-          self.menu     = menu
-        end
-
-        def menu_form_id
-          dom_id(menu, :items)
-        end
-
-        private
-
-        def add_option(options, key, *path)
-          if path.length > 1
-            add_option(options[key] ||= {}, *path)
-          else
-            options[key] = [options[key], *path].compact.join(" ")
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,24 +0,0 @@
-# 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/item.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-module Katalyst
-  module Navigation
-    module Editor
-      class Item < Base
-        attr_accessor :item
-
-        def build(item, **options, &block)
-          self.item = item
-          tag.div **default_options(id: dom_id(item), **options) do
-            concat(capture { yield self }) if block
-            concat fields(item)
-          end
-        end
-
-        def accordion_actions
-          tag.div role: "toolbar", data: { tree_accordion_controls: "" } do
-            concat tag.span(role: "button", value: "collapse",
-                            data: { action: "click->#{MENU_CONTROLLER}#collapse", title: "Collapse tree" })
-            concat tag.span(role: "button", value: "expand",
-                            data: { action: "click->#{MENU_CONTROLLER}#expand", title: "Expand tree" })
-          end
-        end
-
-        def item_actions
-          tag.div role: "toolbar", data: { tree_controls: "" } do
-            concat tag.span(role: "button", value: "de-nest",
-                            data: { action: "click->#{MENU_CONTROLLER}#deNest", title: "Outdent" })
-            concat tag.span(role: "button", value: "nest",
-                            data: { action: "click->#{MENU_CONTROLLER}#nest", title: "Indent" })
-            concat link_to("", edit_item_link,
-                           role: "button", title: "Edit", value: "edit",
-                           data: { turbo_frame: TURBO_FRAME })
-            concat tag.span(role: "button", value: "remove",
-                            data: { action: "click->#{MENU_CONTROLLER}#remove", title: "Remove" })
-          end
-        end
-
-        def edit_item_link
-          item.persisted? ? edit_menu_item_path(item.menu, item) : new_menu_item_path(item.menu, type: item.type)
-        end
-
-        def fields(item)
-          template.fields(ATTRIBUTES_SCOPE, model: item, index: nil, skip_default_ids: true) do |f|
-            concat f.hidden_field(:id)
-            concat f.hidden_field(:depth)
-            concat f.hidden_field(:index)
-          end
-        end
-
-        private
-
-        def default_options(options)
-          add_option(options, :data, :controller, ITEM_CONTROLLER)
-
-          options
-        end
-      end
-    end
-  end
-end

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

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module Katalyst
-  module Navigation
-    module Editor
-      class List < Base
-        ACTIONS = <<~ACTIONS.gsub(/\s+/, " ").freeze
-          dragstart->#{LIST_CONTROLLER}#dragstart
-          dragover->#{LIST_CONTROLLER}#dragover
-          dragenter->#{LIST_CONTROLLER}#dragenter
-          dragleave->#{LIST_CONTROLLER}#dragleave
-          drop->#{LIST_CONTROLLER}#drop
-          dragend->#{LIST_CONTROLLER}#dragend
-        ACTIONS
-
-        def build(options, &_block)
-          tag.ol **default_options(id: menu_form_id, **options) do
-            yield self
-          end
-        end
-
-        def items(*items)
-          render partial:    "katalyst/navigation/menus/item",
-                 layout:     "katalyst/navigation/menus/list_item",
-                 collection: items,
-                 as:         :item
-        end
-
-        private
-
-        def default_options(options)
-          add_option(options, :data, :controller, LIST_CONTROLLER)
-          add_option(options, :data, :action, ACTIONS)
-          add_option(options, :data, :"#{MENU_CONTROLLER}_target", "menu")
-
-          options
-        end
-      end
-    end
-  end
-end

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

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module Katalyst
-  module Navigation
-    module Editor
-      class Menu < Base
-        ACTIONS = <<~ACTIONS.gsub(/\s+/, " ").freeze
-          submit->#{MENU_CONTROLLER}#reindex
-          navigation:drop->#{MENU_CONTROLLER}#drop
-          navigation:reindex->#{MENU_CONTROLLER}#reindex
-          navigation:reset->#{MENU_CONTROLLER}#reset
-        ACTIONS
-
-        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
-
-        private
-
-        # Hidden input ensures that if the menu is empty then the controller
-        # receives an empty array.
-        def hidden_input
-          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)
-
-          depth = options.delete(:depth) || menu.depth
-
-          add_option(options, :data, :"#{MENU_CONTROLLER}-max-depth-value", depth) if depth
-
-          options
-        end
-      end
-    end
-  end
-end

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

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-module Katalyst
-  module Navigation
-    module Editor
-      class NewItem < Base
-        ACTIONS = <<~ACTIONS.gsub(/\s+/, " ").freeze
-          dragstart->#{NEW_ITEM_CONTROLLER}#dragstart
-        ACTIONS
-
-        def build(item, **options, &block)
-          capture do
-            concat(tag.div(**default_options(options)) do
-              concat capture(&block)
-              concat item_template(item)
-            end)
-            concat turbo_replace_placeholder(item)
-          end
-        end
-
-        # Remove items that are incomplete when rendering new items, this
-        # causes incomplete items to be removed from the list when the user
-        # cancels adding a new item by pressing 'discard' in the new item form.
-        def turbo_replace_placeholder(item)
-          turbo_stream.replace dom_id(item) do
-            navigation_editor_item(item: item, data: { delete: "" })
-          end
-        end
-
-        # Template is stored inside the new item dom, and copied into drag
-        # events when the user initiates drag so that it can be copied into the
-        # editor list on drop.
-        def item_template(item)
-          tag.template data: { "#{NEW_ITEM_CONTROLLER}-target" => "template" } do
-            navigation_editor_items(item: item)
-          end
-        end
-
-        private
-
-        def default_options(options)
-          add_option(options, :draggable, true)
-          add_option(options, :role, "listitem")
-          add_option(options, :data, :turbo_frame, TURBO_FRAME)
-          add_option(options, :data, :controller, NEW_ITEM_CONTROLLER)
-          add_option(options, :data, :action, ACTIONS)
-
-          options
-        end
-      end
-    end
-  end
-end

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

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module Katalyst
-  module Navigation
-    module EditorHelper
-      def navigation_editor_new_items(menu)
-        Katalyst::Navigation.config.items.map do |item_class|
-          item_class = item_class.safe_constantize if item_class.is_a?(String)
-          item_class.new(menu: menu)
-        end
-      end
-
-      def navigation_editor_menu(menu:, **options, &block)
-        Editor::Menu.new(self, menu).build(options, &block)
-      end
-
-      def navigation_editor_list(menu:, items: menu.draft_items, **options)
-        Editor::List.new(self, menu).build(options) do |list|
-          list.items(*items) if items.present?
-        end
-      end
-
-      # Generate items without their list wrapper, similar to form_with/fields
-      def navigation_editor_items(item:, menu: item.menu)
-        Editor::List.new(self, menu).items(item)
-      end
-
-      # 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
-
-      def navigation_editor_item(item:, menu: item.menu, **options, &block)
-        Editor::Item.new(self, menu).build(item, **options, &block)
-      end
-
-      def navigation_editor_item_fields(item:, menu: item.menu)
-        Editor::Item.new(self, menu).fields(item)
-      end
-
-      def navigation_editor_status_bar(menu:, **options)
-        Editor::StatusBar.new(self, menu).build(**options)
-      end
-    end
-  end
-end

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

@@ -1,15 +0,0 @@
-<%= navigation_editor_item item: item do |builder| %>
-  <div class="tree" data-invisible="<%= !item.visible? %>">
-    <%= builder.accordion_actions %>
-
-    <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>
-
-  <div class="url">
-    <%= link_to item.url || "", item.url || "", data: { turbo: false } %>
-  </div>
-
-  <%= builder.item_actions %>
-<% end %>

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

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

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

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