Use MenuItem istances for second level backend menus

solidusio · Aug 10, 2023 · 423029d · 423029d
1 parent e193665
commit 423029d
Show file tree

Hide file tree

Showing 5 changed files with 108 additions and 7 deletions.
diff --git a/backend/app/views/spree/admin/shared/_product_sub_menu.html.erb b/backend/app/views/spree/admin/shared/_product_sub_menu.html.erb
@@ -1,3 +1,5 @@
+<% Spree::Deprecation.warn "Using the #{@virtual_path.inspect} partial is deprecated, please use MenuItem#children instead." %>
+
 <ul class="admin-subnav" data-hook="admin_product_sub_tabs">
   <% if can? :admin, Spree::Product %>
     <%= tab label: :products, match_path: '/products' %>

diff --git a/backend/app/views/spree/admin/shared/_promotion_sub_menu.html.erb b/backend/app/views/spree/admin/shared/_promotion_sub_menu.html.erb
@@ -1,3 +1,5 @@
+<% Spree::Deprecation.warn "Using the #{@virtual_path.inspect} partial is deprecated, please use MenuItem#children instead." %>
+
 <ul class="admin-subnav" data-hook="admin_promotion_sub_tabs">
   <% if can? :admin, Spree::Promotion %>
     <%= tab label: :promotions %>

diff --git a/backend/app/views/spree/admin/shared/_settings_sub_menu.html.erb b/backend/app/views/spree/admin/shared/_settings_sub_menu.html.erb
@@ -1,3 +1,5 @@
+<% Spree::Deprecation.warn "Using the #{@virtual_path.inspect} partial is deprecated, please use MenuItem#children instead." %>
+
 <ul class="admin-subnav" data-hook="admin_settings_sub_tabs">
   <% if can?(:admin, Spree::Store) %>
     <%= tab label: :stores, url: spree.admin_stores_path %>

diff --git a/backend/app/views/spree/admin/shared/_tabs.html.erb b/backend/app/views/spree/admin/shared/_tabs.html.erb
@@ -5,10 +5,23 @@
         icon: menu_item.icon,
         label: menu_item.label,
         url: menu_item.url,
-        match_path: menu_item.match_path,
+        selected: menu_item.match_path?(request) || menu_item.children.any? { _1.match_path?(request) },
       ) do
     %>
-      <%- render partial: menu_item.partial if menu_item.partial %>
+      <% if menu_item.render_partial? %>
+        <%- render partial: menu_item.partial %>
+      <% elsif menu_item.children.present? %>
+        <ul class="admin-subnav">
+          <%- menu_item.children.each do |child| %>
+            <%= tab(
+              icon: child.icon,
+              label: child.label,
+              url: child.url,
+              selected: child.match_path?(request),
+            ) %>
+          <% end %>
+        </ul>
+      <% end %>
     <%- end %>
   <% end %>
 <% end %>
diff --git a/backend/lib/spree/backend_configuration.rb b/backend/lib/spree/backend_configuration.rb
@@ -32,6 +32,10 @@ def theme_path(user_theme = nil)
         }
       }
 
+    # @!attribute [rw] prefer_menu_item_partials
+    #   @return [Boolean] Whether or not to prefer menu item partials when both a partial and children are present.
+    preference :prefer_menu_item_partials, :boolean, default: false
+
     autoload :ORDER_TABS, 'spree/backend_configuration/deprecated_tab_constants'
     autoload :PRODUCT_TABS, 'spree/backend_configuration/deprecated_tab_constants'
     autoload :CONFIGURATION_TABS, 'spree/backend_configuration/deprecated_tab_constants'
@@ -98,7 +102,33 @@ def menu_items
             variants
           )}x,
           partial: 'spree/admin/shared/product_sub_menu',
-          position: 1
+          position: 1,
+          children: [
+            MenuItem.new(
+              label: :products,
+              condition: -> { can? :admin, Spree::Product },
+              match_path: '/products',
+            ),
+            MenuItem.new(
+              label: :option_types,
+              condition: -> { can? :admin, Spree::OptionType },
+              match_path: '/option_types',
+            ),
+            MenuItem.new(
+              label: :properties,
+              condition: -> { can? :admin, Spree::Property },
+            ),
+            MenuItem.new(
+              label: :taxonomies,
+              condition: -> { can? :admin, Spree::Taxonomy },
+            ),
+            MenuItem.new(
+              url: :admin_taxons_path,
+              condition: -> { can? :admin, Spree::Taxon },
+              label: :display_order,
+              match_path: '/taxons',
+            ),
+          ],
         ),
         MenuItem.new(
           label: :promotions,
@@ -107,23 +137,33 @@ def menu_items
           partial: 'spree/admin/shared/promotion_sub_menu',
           condition: -> { can?(:admin, Spree::Promotion) },
           url: :admin_promotions_path,
-          position: 2
+          position: 2,
+          children: [
+            MenuItem.new(
+              label: :promotions,
+              condition: -> { can?(:admin, Spree::Promotion) },
+            ),
+            MenuItem.new(
+              label: :promotion_categories,
+              condition: -> { can?(:admin, Spree::PromotionCategory) },
+            ),
+          ],
         ),
         MenuItem.new(
           label: :stock,
           icon: 'cubes',
           match_path: %r{/(stock_items)},
           condition: -> { can?(:admin, Spree::StockItem) },
           url: :admin_stock_items_path,
-          position: 3
+          position: 3,
         ),
         MenuItem.new(
           label: :users,
           icon: 'user',
           match_path: %r{/(users|store_credits)},
           condition: -> { Spree.user_class && can?(:admin, Spree.user_class) },
           url: :admin_users_path,
-          position: 4
+          position: 4,
         ),
         MenuItem.new(
           label: :settings,
@@ -159,7 +199,49 @@ def menu_items
           },
           partial: 'spree/admin/shared/settings_sub_menu',
           url: :admin_stores_path,
-          position: 5
+          position: 5,
+          children: [
+            MenuItem.new(
+              label: :stores,
+              condition: -> { can? :admin, Spree::Store },
+              url: :admin_stores_path,
+            ),
+            MenuItem.new(
+              label: :payment_methods,
+              condition: -> { can? :admin, Spree::PaymentMethod },
+              url: :admin_payment_methods_path,
+            ),
+
+            MenuItem.new(
+              label: :taxes,
+              condition: -> { can?(:admin, Spree::TaxCategory) || can?(:admin, Spree::TaxRate) },
+              url: :admin_tax_categories_path,
+              match_path: %r(tax_categories|tax_rates),
+            ),
+            MenuItem.new(
+              label: :checkout,
+              condition: -> {
+                can?(:admin, Spree::RefundReason) ||
+                can?(:admin, Spree::ReimbursementType) ||
+                can?(:show, Spree::ReturnReason) ||
+                can?(:show, Spree::AdjustmentReason)
+              },
+              url: :admin_refund_reasons_path,
+              match_path: %r(refund_reasons|reimbursement_types|return_reasons|adjustment_reasons|store_credit_reasons)
+            ),
+            MenuItem.new(
+              label: :shipping,
+              condition: -> { can?(:admin, Spree::ShippingMethod) ||
+                can?(:admin, Spree::ShippingCategory) || can?(:admin, Spree::StockLocation) },
+              url: :admin_shipping_methods_path,
+              match_path: %r(shipping_methods|shipping_categories|stock_locations),
+            ),
+            MenuItem.new(
+              label: :zones,
+              condition: -> { can?(:admin, Spree::Zone) },
+              url: :admin_zones_path,
+            ),
+          ],
         )
       ]
     end