Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Add helper methods to access admin navigation (#13294)

Damian Legawiecf31a2e09ea33
diff --git a/admin/app/helpers/spree/admin/navigation_helper.rb b/admin/app/helpers/spree/admin/navigation_helper.rb
index 7aa3aaa8e3..a047190589 100644
--- a/admin/app/helpers/spree/admin/navigation_helper.rb
+++ b/admin/app/helpers/spree/admin/navigation_helper.rb
@@ -334,7 +334,7 @@ module Spree
# @return [Array<Spree::Admin::Navigation::Item>] the visible navigation items
def navigation_items(context = :sidebar)
# Pass the view context (self) so that can? and other helpers are available
- Rails.application.config.spree_admin.navigation.send(context).visible_items(self)
+ Spree::Admin.navigation.send(context)&.visible_items(self) || []
end
# Renders page tab navigation for the given context
diff --git a/admin/config/initializers/spree_admin_navigation.rb b/admin/config/initializers/spree_admin_navigation.rb
index 3ad9a1a37b..b206bed379 100644
--- a/admin/config/initializers/spree_admin_navigation.rb
+++ b/admin/config/initializers/spree_admin_navigation.rb
@@ -5,7 +5,7 @@ Rails.application.config.after_initialize do
# ===============================================
# Sidebar Navigation
# ===============================================
- sidebar_nav = Rails.application.config.spree_admin.navigation[:sidebar]
+ sidebar_nav = Spree::Admin.navigation.sidebar
# Getting Started (onboarding)
sidebar_nav.add :getting_started,
@@ -231,7 +231,7 @@ Rails.application.config.after_initialize do
# ===============================================
# Settings Navigation
# ===============================================
- settings_nav = Rails.application.config.spree_admin.navigation[:settings]
+ settings_nav = Spree::Admin.navigation.settings
# Store Details
settings_nav.add :general_settings,
@@ -385,7 +385,7 @@ Rails.application.config.after_initialize do
# ===============================================
# Tax Tab Navigation
- tax_tabs_nav = Rails.application.config.spree_admin.navigation[:tax_tabs]
+ tax_tabs_nav = Spree::Admin.navigation.tax_tabs
tax_tabs_nav.add :tax_rates,
label: :tax_rates,
@@ -400,7 +400,7 @@ Rails.application.config.after_initialize do
if: -> { can?(:manage, Spree::TaxCategory) }
# Shipping Tab Navigation
- shipping_tabs_nav = Rails.application.config.spree_admin.navigation[:shipping_tabs]
+ shipping_tabs_nav = Spree::Admin.navigation.shipping_tabs
shipping_tabs_nav.add :shipping_methods,
label: :shipping_methods,
@@ -416,7 +416,7 @@ Rails.application.config.after_initialize do
if: -> { can?(:manage, Spree::ShippingCategory) }
# Team Tab Navigation
- team_tabs_nav = Rails.application.config.spree_admin.navigation[:team_tabs]
+ team_tabs_nav = Spree::Admin.navigation.team_tabs
team_tabs_nav.add :admin_users,
label: :users,
@@ -437,7 +437,7 @@ Rails.application.config.after_initialize do
if: -> { can?(:manage, Spree::Role) }
# Stock Tab Navigation
- stock_tabs_nav = Rails.application.config.spree_admin.navigation[:stock_tabs]
+ stock_tabs_nav = Spree::Admin.navigation.stock_tabs
stock_tabs_nav.add :stock_items,
label: :stock_items,
@@ -454,7 +454,7 @@ Rails.application.config.after_initialize do
if: -> { can?(:manage, Spree::StockTransfer) }
# Returns and Refunds Tab Navigation
- returns_tabs_nav = Rails.application.config.spree_admin.navigation[:returns_tabs]
+ returns_tabs_nav = Spree::Admin.navigation.returns_tabs
returns_tabs_nav.add :return_authorization_reasons,
label: :return_authorization_reasons,
@@ -475,7 +475,7 @@ Rails.application.config.after_initialize do
if: -> { can?(:manage, Spree::ReimbursementType) }
# Developers Tab Navigation
- developers_tabs_nav = Rails.application.config.spree_admin.navigation[:developers_tabs]
+ developers_tabs_nav = Spree::Admin.navigation.developers_tabs
developers_tabs_nav.add :api_keys,
label: :api_keys,
@@ -492,7 +492,7 @@ Rails.application.config.after_initialize do
if: -> { can?(:manage, Spree::Webhooks::Subscriber) }
# Audit Tab Navigation
- audit_tabs_nav = Rails.application.config.spree_admin.navigation[:audit_tabs]
+ audit_tabs_nav = Spree::Admin.navigation.audit_tabs
audit_tabs_nav.add :audit_log,
label: 'admin.audit_log',
diff --git a/admin/lib/spree/admin.rb b/admin/lib/spree/admin.rb
index 5290c798c7..584e03c8e4 100644
--- a/admin/lib/spree/admin.rb
+++ b/admin/lib/spree/admin.rb
@@ -20,3 +20,15 @@ require 'spree/admin/callbacks'
require 'spree/admin/engine'
require 'tinymce-rails'
+
+module Spree
+ module Admin
+ def self.navigation
+ Rails.application.config.spree_admin.navigation
+ end
+
+ def self.navigation=(navigation)
+ Rails.application.config.spree_admin.navigation = navigation
+ end
+ end
+end
diff --git a/admin/spec/helpers/spree/admin/navigation_helper_spec.rb b/admin/spec/helpers/spree/admin/navigation_helper_spec.rb
index 7e4d2f9efd..3620e6a420 100644
--- a/admin/spec/helpers/spree/admin/navigation_helper_spec.rb
+++ b/admin/spec/helpers/spree/admin/navigation_helper_spec.rb
@@ -119,7 +119,7 @@ describe Spree::Admin::NavigationHelper, type: :helper do
end
describe '#render_navigation' do
- let(:nav) { Rails.application.config.spree_admin.navigation.sidebar }
+ let(:nav) { Spree::Admin.navigation.sidebar }
before do
nav.clear
@@ -150,7 +150,7 @@ describe Spree::Admin::NavigationHelper, type: :helper do
end
describe '#navigation_items' do
- let(:nav) { Rails.application.config.spree_admin.navigation.sidebar }
+ let(:nav) { Spree::Admin.navigation.sidebar }
before do
nav.clear