katalyst-navigation 1.3.4 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8641b8fd17205d9daa4beaf83301081e559193179c236ada502f251c577555b
-  data.tar.gz: 3fa8331ed9c531013405915b57dd998440b385ceaf662fe72cbe74a88d29bb4f
+  metadata.gz: 8f0c8d0aa7dd3f14b5d2e423e9e6475a495b2ea39060c38c468834d8c415f548
+  data.tar.gz: f816fa5eb041622143a475d5442d0ff9cb397da26597d2ff2d691c5f28da495c
 SHA512:
-  metadata.gz: 673b6803479f9d2b772e9bfbf0fbd05734794e334a4f9f14ace81dd83e8aca6c79554704595aa0bcbe8fdf92d5b309bffe4a5eba3c153dc6c83a5615bf6a3699
-  data.tar.gz: 325eea3d0caab65ea72dd948adcfc6a94f847d2d2ba158d281b75281edaf6b7204608fb01e001861709592acfbd545a2b0fabf122ed50cf43e06ca98d2d71797
+  metadata.gz: 3bdb779e520ce91cd70fa66d33e355bb19b61bc5b011d551db70d0d1fade623ab48359a00aeb782bc26e06c0ca8a41d45c4760b4645ef0a7160ecf6b75418e75
+  data.tar.gz: fe696c32dd1dbb6a3e14525a3ed26b2efd99e87095dfc41585b845f7ef30704bb59725d603ec14b60b4fdf19920d7dee1ffa0bb31a5d0c9137c156075cf551f6

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

@@ -4,9 +4,16 @@ module Katalyst
   module Navigation
     class MenusController < BaseController
       def index
-        sort, menus = table_sort(Menu.all)
-
-        render locals: { menus: menus, sort: sort }
+        collection = Katalyst::Tables::Collection::Base.new(sorting: :title).with_params(params).apply(Menu.all)
+        table      = Katalyst::Turbo::TableComponent.new(collection: collection,
+                                                         id:         "index-table",
+                                                         class:      "index-table",
+                                                         caption:    true)
+
+        respond_to do |format|
+          format.turbo_stream { render(table) } if self_referred?
+          format.html { render :index, locals: { table: table } }
+        end
       end
 
       def show

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

@@ -5,7 +5,7 @@ module Katalyst
     module EditorHelper
       def navigation_editor_new_items(menu)
         Katalyst::Navigation.config.items.map do |item_class|
-          item_class = item_class.is_a?(String) ? item_class.safe_constantize : item_class
+          item_class = item_class.safe_constantize if item_class.is_a?(String)
           item_class.new(menu: menu)
         end
       end

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

@@ -9,15 +9,15 @@ module Katalyst
 
         delegate_missing_to :@template
 
-        def initialize(template, list: {}, item: {}, **menu_options)
-          self.template = template
-          @menu_options = menu_options.freeze
-          @list_options = list.freeze
-          @item_options = item.freeze
+        def initialize(template, list: {}, item: {}, **menu_attributes)
+          self.template    = template
+          @menu_attributes = menu_attributes.freeze
+          @list_attributes = list.freeze
+          @item_attributes = item.freeze
         end
 
         def render(tree)
-          tag.ul(**menu_options(tree)) do
+          tag.ul(**menu_attributes(tree)) do
             tree.each do |item|
               concat render_item(item)
             end
@@ -27,14 +27,14 @@ module Katalyst
         def render_item(item)
           return unless item.visible?
 
-          tag.li(**item_options(item)) do
+          tag.li(**item_attributes(item)) do
             concat public_send("render_#{item.model_name.param_key}", item)
             concat render_children(item) if item.children.any?
           end
         end
 
         def render_children(item)
-          tag.ul(**list_options(item)) do
+          tag.ul(**list_attributes(item)) do
             item.children.each do |child|
               concat render_item(child)
             end
@@ -46,25 +46,25 @@ module Katalyst
         end
 
         def render_link(link)
-          link_to(link.title, link.url, link.item_options)
+          link_to(link.title, link.url, **link.link_attributes)
         end
 
         def render_button(link)
-          link_to(link.title, link.url, link.item_options)
+          link_to(link.title, link.url, **link.link_attributes)
         end
 
         private
 
-        def menu_options(_tree)
-          @menu_options
+        def menu_attributes(_tree)
+          @menu_attributes
         end
 
-        def list_options(_item)
-          @list_options
+        def list_attributes(_item)
+          @list_attributes
         end
 
-        def item_options(_item)
-          @item_options
+        def item_attributes(_item)
+          @item_attributes
         end
       end
     end

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

@@ -13,9 +13,9 @@ module Katalyst
       # @return Structured HTML containing top level + nested navigation links
       def navigation_menu_with(menu:, **options)
         builder = navigation_builder(**options)
-        menu    = menu.is_a?(Symbol) ? navigation_menu_for(menu) : menu
+        menu    = navigation_menu_for(menu) if menu.is_a?(Symbol)
 
-        return unless menu&.published_version&.present?
+        return if menu&.published_version.blank?
 
         cache menu.published_version do
           concat builder.render(menu.published_tree)

data/app/models/concerns/katalyst/navigation/has_link.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Navigation
+    module HasLink
+      extend ActiveSupport::Concern
+
+      HTTP_METHODS = %w[get post patch put delete].index_by(&:itself).freeze
+      TARGETS      = %w[self top blank kpop].index_by(&:itself).freeze
+
+      class_methods do
+        def permitted_params
+          super + %i[url http_method target]
+        end
+      end
+
+      included do
+        validates :url, :http_method, :target, presence: true
+
+        attribute :http_method, :string, default: "get"
+
+        enum http_method: HTTP_METHODS, _prefix: :http
+
+        attribute :target, :string, default: "self"
+
+        enum target: TARGETS, _prefix: :target
+      end
+
+      def link_attributes
+        options = if target_self?
+                    {} # default
+                  elsif target_blank? || target_top?
+                    { target: "_#{target}" } # browser will handle this target
+                  else
+                    { data: { turbo_frame: target } } # turbo target
+                  end
+
+        options.deep_merge!({ data: { turbo_method: http_method } }) unless http_get? || target_blank?
+
+        options
+      end
+    end
+  end
+end

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

@@ -4,27 +4,9 @@ module Katalyst
   module Navigation
     # Renders an HTML button using `button_to`.
     class Button < Item
-      HTTP_METHODS = %i[get post patch put delete].index_by(&:itself).freeze
+      include HasLink
 
-      enum method: HTTP_METHODS, _prefix: :http
-
-      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
-
-      def options_for_target
-        options = super
-
-        if target == "_blank" || target == "_top" || target == "self"
-          options.deep_merge!({ data: { method: http_method } })
-        else
-          options.deep_merge!({ data: { turbo_method: http_method } })
-        end
-        options
-      end
+      validates :title, presence: true
     end
   end
 end

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

@@ -10,16 +10,10 @@ module Katalyst
 
       attr_accessor :parent, :children, :index, :depth
 
-      TARGETS = %i[self _top _blank kpop].index_by(&:itself).freeze
-
-      enum method: TARGETS, _prefix: :target
-
       def self.permitted_params
         %i[
           title
-          url
           visible
-          target
           type
         ]
       end
@@ -28,22 +22,6 @@ module Katalyst
         is_a? Layout
       end
 
-      # Entrypoint for combining additional options based on attribute rules
-      def item_options
-        options_for_target
-      end
-
-      def options_for_target
-        return {} if target == "self"
-
-        options = { target: target }
-
-        unless target == "_blank" || target == "_top"
-          options = { data: { turbo: true, turbo_frame: target } }
-        end
-        options
-      end
-
       private
 
       def initialize_tree

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

@@ -4,7 +4,9 @@ module Katalyst
   module Navigation
     # Renders an HTML link using `link_to`.
     class Link < Item
-      validates :title, :url, presence: true
+      include HasLink
+
+      validates :title, presence: true
     end
   end
 end

data/app/views/katalyst/navigation/menus/_menu.html+row.erb

@@ -0,0 +1,4 @@
+<%= row.cell :title do |cell| %>
+  <%= link_to cell.value, menu %>
+<% end %>
+<%= row.cell :slug %>

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

@@ -6,9 +6,4 @@
   </div>
 </nav>
 
-<%= table_with collection: menus, sort: sort, class: "index-table" do |row, menu| %>
-  <%= row.cell :title do |cell| %>
-    <%= link_to cell.value, menu %>
-  <% end %>
-  <%= row.cell :slug %>
-<% end %>
+<%= render(table) %>

data/db/migrate/20230727025052_update_target_syntax.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Ensures that all navigation items have a valid target and http_method.
+class UpdateTargetSyntax < ActiveRecord::Migration[7.0]
+  def change
+    Katalyst::Navigation::Item.where(http_method: nil).update_all(target: "get")
+    Katalyst::Navigation::Item.where(target: nil).update_all(target: "self")
+    Katalyst::Navigation::Item.where(target: "_blank").update_all(target: "blank")
+    Katalyst::Navigation::Item.where(target: "_top").update_all(target: "top")
+  end
+end

data/lib/katalyst/navigation/version.rb

@@ -2,6 +2,6 @@
 
 module Katalyst
   module Navigation
-    VERSION = "1.3.4"
+    VERSION = "1.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-navigation
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.4.0
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-15 00:00:00.000000000 Z
+date: 2023-07-27 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -49,6 +49,7 @@ files:
 - app/helpers/katalyst/navigation/frontend/builder.rb
 - app/helpers/katalyst/navigation/frontend_helper.rb
 - app/models/concerns/katalyst/navigation/garbage_collection.rb
+- app/models/concerns/katalyst/navigation/has_link.rb
 - app/models/concerns/katalyst/navigation/has_tree.rb
 - app/models/katalyst/navigation/button.rb
 - app/models/katalyst/navigation/heading.rb
@@ -66,6 +67,7 @@ files:
 - 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
@@ -78,6 +80,7 @@ files:
 - db/migrate/20220826034057_create_katalyst_navigation_menus.rb
 - db/migrate/20220826034507_create_katalyst_navigation_items.rb
 - db/migrate/20220908044500_add_depth_limit_to_menus.rb
+- db/migrate/20230727025052_update_target_syntax.rb
 - lib/katalyst/navigation.rb
 - lib/katalyst/navigation/config.rb
 - lib/katalyst/navigation/engine.rb
@@ -104,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
 summary: Navigation generator and editor