spree_admin 5.2.0.rc3 → 5.2.0

data/config/initializers/spree_admin_navigation.rb

@@ -0,0 +1,510 @@
+# Default Admin Navigation Configuration
+# This file defines the default sidebar and settings navigation for Spree Admin
+
+Rails.application.config.after_initialize do
+  # ===============================================
+  # Sidebar Navigation
+  # ===============================================
+  sidebar_nav = Spree.admin.navigation.sidebar
+
+  # Getting Started (onboarding)
+  sidebar_nav.add :getting_started,
+          label: 'admin.getting_started',
+          url: :admin_getting_started_path,
+          icon: 'map',
+          position: 5,
+          if: -> { current_store && can?(:manage, current_store) && !current_store.setup_completed? },
+          badge: -> { "#{current_store.setup_tasks_done}/#{current_store.setup_tasks_total}" },
+          badge_class: 'badge-info',
+          active: -> { controller_name == 'dashboard' && action_name == 'getting_started' }
+
+  # Dashboard / Home
+  sidebar_nav.add :home,
+          label: :home,
+          url: :admin_path,
+          icon: 'home',
+          position: 10,
+          active: -> { controller_name == 'dashboard' && action_name == 'show' }
+
+  # Orders with submenu
+  sidebar_nav.add :orders,
+          label: :orders,
+          url: :admin_orders_path,
+          icon: 'inbox',
+          position: 20,
+          if: -> { can?(:manage, Spree::Order) },
+          badge: -> {
+            # Evaluated in view context with access to helper methods
+            ready_to_ship_orders_count if ready_to_ship_orders_count&.positive?
+          } do |orders|
+    # Orders to Fulfill submenu
+    orders.add :orders_to_fulfill,
+              label: 'admin.orders.orders_to_fulfill',
+              url: -> { spree.admin_orders_path(q: {shipment_state_not_in: [:shipped, :canceled]}) },
+              position: 10,
+              active: -> { controller_name == 'orders' && params.dig(:q, :shipment_state_not_in).present? },
+              if: -> {
+                ready_to_ship_orders_count&.positive?
+              },
+              badge: -> {
+                ready_to_ship_orders_count if ready_to_ship_orders_count&.positive?
+              }
+
+    # Draft Orders
+    orders.add :draft_orders,
+              label: :draft_orders,
+              url: :admin_checkouts_path,
+              position: 20,
+              active: -> { controller_name == 'checkouts' || (@order.present? && !@order.completed?) },
+              if: -> { can?(:manage, :checkouts) }
+  end
+
+  # Returns with submenu
+  sidebar_nav.add :returns,
+          label: :returns,
+          url: :admin_customer_returns_path,
+          icon: 'receipt-refund',
+          position: 25,
+          if: -> { can?(:manage, Spree::CustomerReturn) || can?(:manage, Spree::ReturnAuthorization) } do |returns|
+    # Return Authorizations
+    returns.add :return_authorizations,
+                label: :return_authorizations,
+                url: :admin_return_authorizations_path,
+                position: 10,
+                if: -> { can?(:manage, Spree::ReturnAuthorization) }
+  end
+
+  # Products with submenu
+  sidebar_nav.add :products,
+          label: :products,
+          url: :admin_products_path,
+          icon: 'package',
+          position: 30,
+          if: -> { can?(:manage, Spree::Product) } do |products|
+    # Stock
+    products.add :stock,
+                label: :stock,
+                url: :admin_stock_items_path,
+                position: 10,
+                active: -> { %w[stock_items stock_transfers].include?(controller_name) },
+                if: -> { can?(:manage, Spree::StockItem) || can?(:manage, Spree::StockTransfer) }
+
+    # Taxonomies
+    products.add :taxonomies,
+                label: :taxonomies,
+                url: :admin_taxonomies_path,
+                position: 20,
+                active: -> { %w[taxonomies taxons].include?(controller_name) },
+                if: -> { can?(:manage, Spree::Taxonomy) && can?(:manage, Spree::Taxon) }
+
+    # Options
+    products.add :options,
+                label: :options,
+                url: :admin_option_types_path,
+                position: 30,
+                active: -> { %w[option_types option_values].include?(controller_name) },
+                if: -> { can?(:manage, Spree::OptionType) }
+
+    # Properties
+    products.add :properties,
+                label: :properties,
+                url: :admin_properties_path,
+                position: 40,
+                if: -> { can?(:manage, Spree::Property) && Spree::Config.product_properties_enabled }
+  end
+
+  # Vendors (Enterprise Edition)
+  sidebar_nav.add :vendors,
+          label: :vendors,
+          url: 'https://spreecommerce.org/marketplace-ecommerce/',
+          icon: 'heart-handshake',
+          position: 35,
+          if: -> { can?(:manage, current_store) && !defined?(SpreeEnterprise) },
+          badge: 'Enterprise',
+          tooltip: 'Multi-Vendor Marketplace is available in the Enterprise Edition',
+          target: '_blank'
+
+  # Customers with submenu
+  sidebar_nav.add :customers,
+          label: :customers,
+          url: :admin_users_path,
+          icon: 'users',
+          position: 40,
+          if: -> { can?(:manage, Spree.user_class) } do |customers|
+    # Newsletter Subscribers
+    customers.add :newsletter_subscribers,
+                  label: :newsletter_subscribers,
+                  url: :admin_newsletter_subscribers_path,
+                  position: 10
+  end
+
+  # Promotions with submenu
+  sidebar_nav.add :promotions,
+          label: :promotions,
+          url: :admin_promotions_path,
+          icon: 'discount',
+          position: 50,
+          if: -> { can?(:manage, Spree::Promotion) } do |promotions|
+    # Gift Cards
+    promotions.add :gift_cards,
+                  label: :gift_cards,
+                  url: :admin_gift_cards_path,
+                  position: 10,
+                  active: -> { %w[gift_cards gift_card_batches].include?(controller_name) }
+  end
+
+  # Reports
+  sidebar_nav.add :reports,
+          label: :reports,
+          url: :admin_reports_path,
+          icon: 'chart-bar',
+          position: 60,
+          if: -> { can?(:manage, Spree::Report) }
+
+  # Storefront with submenu
+  sidebar_nav.add :storefront,
+          label: 'admin.storefront',
+          url: :admin_themes_path,
+          icon: 'building-store',
+          position: 70,
+          if: -> { can?(:manage, Spree::Theme) } do |storefront|
+
+    # Pages
+    storefront.add :pages,
+                  label: :pages,
+                  url: :admin_pages_path,
+                  position: 20,
+                  if: -> { can?(:manage, Spree::Page) }
+
+    # Posts (Blog)
+    storefront.add :posts,
+                  label: :posts,
+                  url: :admin_posts_path,
+                  position: 30,
+                  active: -> { %w[posts post_categories].include?(controller_name) },
+                  if: -> { can?(:manage, Spree::Post) }
+
+    # Storefront Settings
+    storefront.add :storefront_settings,
+                  label: :settings,
+                  url: :edit_admin_storefront_path,
+                  position: 40,
+                  if: -> { can?(:manage, current_store) }
+  end
+
+  # Integrations
+  sidebar_nav.add :integrations,
+          label: :integrations,
+          url: :admin_integrations_path,
+          icon: 'plug-connected',
+          position: 80,
+          if: -> { can?(:manage, Spree::Integration) }
+
+  # Section divider before settings
+  sidebar_nav.add :settings_section,
+          section_label: 'Settings',
+          position: 90
+
+  # Settings (bottom of sidebar)
+  sidebar_nav.add :settings,
+          label: :settings,
+          url: -> { spree.edit_admin_store_path(section: 'general-settings') },
+          icon: 'settings',
+          position: 100,
+          if: -> { can?(:manage, current_store) }
+
+  # Admin Users (bottom of sidebar)
+  sidebar_nav.add :admin_users,
+          label: :users,
+          url: :admin_admin_users_path,
+          icon: 'users',
+          position: 110,
+          if: -> { can?(:manage, Spree.admin_user_class) }
+
+  # ===============================================
+  # Settings Navigation
+  # ===============================================
+  settings_nav = Spree.admin.navigation.settings
+
+  # Store Details
+  settings_nav.add :general_settings,
+          label: :store_details,
+          url: -> { spree.edit_admin_store_path(section: 'general-settings') },
+          icon: 'building-store',
+          position: 10,
+          active: -> { controller_name == 'stores' && params[:section] == 'general-settings' },
+          if: -> { can?(:manage, current_store) }
+
+  # Admin Users
+  settings_nav.add :users,
+          label: :users,
+          url: :admin_admin_users_path,
+          icon: 'users',
+          position: 20,
+          active: -> { %w[admin_users invitations roles].include?(controller_name) },
+          if: -> { can?(:manage, Spree.admin_user_class) }
+
+  # Emails
+  settings_nav.add :emails,
+          label: :emails,
+          url: -> { spree.edit_admin_store_path(section: 'emails') },
+          icon: 'send',
+          position: 30,
+          active: -> { controller_name == 'stores' && params[:section] == 'emails' },
+          if: -> { can?(:manage, current_store) }
+
+  # Policies
+  settings_nav.add :policies,
+          label: :policies,
+          url: :admin_policies_path,
+          icon: 'list-check',
+          position: 40,
+          active: -> { controller_name == 'policies' },
+          if: -> { can?(:manage, Spree::Policy) }
+
+  # Checkout
+  settings_nav.add :checkout,
+          label: :checkout,
+          url: -> { spree.edit_admin_store_path(section: 'checkout') },
+          icon: 'shopping-cart',
+          position: 50,
+          active: -> { controller_name == 'stores' && params[:section] == 'checkout' },
+          if: -> { can?(:manage, current_store) }
+
+  # Domains
+  settings_nav.add :domains,
+          label: :domains,
+          url: :admin_custom_domains_path,
+          icon: 'world-www',
+          position: 60,
+          active: -> { controller_name == 'custom_domains' },
+          if: -> { can?(:manage, Spree::CustomDomain) }
+
+  # Payment Methods
+  settings_nav.add :payment_methods,
+          label: :payments,
+          url: :admin_payment_methods_path,
+          icon: 'credit-card',
+          position: 70,
+          active: -> { controller_name == 'payment_methods' },
+          if: -> { can?(:manage, Spree::PaymentMethod) }
+
+  # Zones
+  settings_nav.add :zones,
+          label: :zones,
+          url: :admin_zones_path,
+          icon: 'world',
+          position: 80,
+          active: -> { %w[zones countries states].include?(controller_name) },
+          if: -> { can?(:manage, Spree::Zone) }
+
+  # Shipping Methods
+  settings_nav.add :shipping_methods,
+          label: :shipping,
+          url: :admin_shipping_methods_path,
+          icon: 'truck',
+          position: 90,
+          active: -> { %w[shipping_methods shipping_categories].include?(controller_name) },
+          if: -> { can?(:manage, Spree::ShippingMethod) }
+
+  # Tax Settings
+  settings_nav.add :tax_rates,
+          label: :tax,
+          url: :admin_tax_rates_path,
+          icon: 'receipt-tax',
+          position: 100,
+          active: -> { %w[tax_rates tax_categories stripe_tax_registrations].include?(controller_name) },
+          if: -> { can?(:manage, Spree::TaxRate) }
+
+  # Returns
+  settings_nav.add :return_settings,
+          label: :returns,
+          url: :admin_return_authorization_reasons_path,
+          icon: 'receipt-refund',
+          position: 110,
+          active: -> { %w[refund_reasons reimbursement_types return_authorization_reasons].include?(controller_name) },
+          if: -> { can?(:manage, Spree::ReturnAuthorizationReason) }
+
+  # Stock Locations
+  settings_nav.add :stock_locations,
+          label: :stock_locations,
+          url: :admin_stock_locations_path,
+          icon: 'map-pin',
+          position: 120,
+          active: -> { controller_name == 'stock_locations' },
+          if: -> { can?(:manage, Spree::StockLocation) }
+
+  # Metafield Definitions
+  settings_nav.add :metafield_definitions,
+          label: :metafield_definitions,
+          url: :admin_metafield_definitions_path,
+          icon: 'list-details',
+          position: 130,
+          active: -> { controller_name == 'metafield_definitions' },
+          if: -> { can?(:manage, Spree::MetafieldDefinition) }
+
+  # Audit Log
+  settings_nav.add :audits,
+          label: 'admin.audit_log',
+          url: :admin_audits_path,
+          icon: 'history',
+          position: 140,
+          active: -> { %w[audits exports imports].include?(controller_name) },
+          if: -> {
+            # Only show if audits feature exists
+            can?(:manage, current_store) &&
+            Spree::Core::Engine.routes.url_helpers.respond_to?(:admin_audits_path)
+          }
+
+  # Developers
+  settings_nav.add :developers,
+          label: :developers,
+          url: :admin_oauth_applications_path,
+          icon: 'terminal',
+          position: 150,
+          active: -> { %w[oauth_applications webhooks_subscribers].include?(controller_name) },
+          if: -> { can?(:manage, Spree::OauthApplication) }
+
+  # Edit Profile
+  settings_nav.add :edit_profile,
+          label: 'admin.edit_profile',
+          url: :edit_admin_profile_path,
+          icon: 'user-scan',
+          position: 200,
+          active: -> { controller_name == 'profiles' && action_name == 'edit' }
+
+  # ===============================================
+  # Page Tab Navigations
+  # ===============================================
+
+  # Tax Tab Navigation
+  tax_tabs_nav = Spree.admin.navigation.tax_tabs
+
+  tax_tabs_nav.add :tax_rates,
+          label: :tax_rates,
+          url: :admin_tax_rates_path,
+          position: 10,
+          if: -> { can?(:manage, Spree::TaxRate) }
+
+  tax_tabs_nav.add :tax_categories,
+          label: :tax_categories,
+          url: :admin_tax_categories_path,
+          position: 20,
+          if: -> { can?(:manage, Spree::TaxCategory) }
+
+  # Shipping Tab Navigation
+  shipping_tabs_nav = Spree.admin.navigation.shipping_tabs
+
+  shipping_tabs_nav.add :shipping_methods,
+          label: :shipping_methods,
+          url: :admin_shipping_methods_path,
+          position: 10,
+          active: -> { controller_name == 'shipping_methods' && action_name == 'index' },
+          if: -> { can?(:manage, Spree::ShippingMethod) }
+
+  shipping_tabs_nav.add :shipping_categories,
+          label: :shipping_categories,
+          url: :admin_shipping_categories_path,
+          position: 20,
+          if: -> { can?(:manage, Spree::ShippingCategory) }
+
+  # Team Tab Navigation
+  team_tabs_nav = Spree.admin.navigation.team_tabs
+
+  team_tabs_nav.add :admin_users,
+          label: :users,
+          url: :admin_admin_users_path,
+          position: 10,
+          if: -> { can?(:manage, Spree.admin_user_class) }
+
+  team_tabs_nav.add :invitations,
+          label: :invitations,
+          url: :admin_invitations_path,
+          position: 20,
+          if: -> { can?(:manage, Spree::Invitation) }
+
+  team_tabs_nav.add :roles,
+          label: :roles,
+          url: :admin_roles_path,
+          position: 30,
+          if: -> { can?(:manage, Spree::Role) }
+
+  # Stock Tab Navigation
+  stock_tabs_nav = Spree.admin.navigation.stock_tabs
+
+  stock_tabs_nav.add :stock_items,
+          label: :stock_items,
+          url: :admin_stock_items_path,
+          position: 10,
+          active: -> { controller_name == 'stock_items' },
+          if: -> { can?(:manage, Spree::StockItem) }
+
+  stock_tabs_nav.add :stock_transfers,
+          label: :stock_transfers,
+          url: :admin_stock_transfers_path,
+          position: 20,
+          active: -> { controller_name == 'stock_transfers' },
+          if: -> { can?(:manage, Spree::StockTransfer) }
+
+  # Returns and Refunds Tab Navigation
+  returns_tabs_nav = Spree.admin.navigation.returns_tabs
+
+  returns_tabs_nav.add :return_authorization_reasons,
+          label: :return_authorization_reasons,
+          url: :admin_return_authorization_reasons_path,
+          position: 10,
+          if: -> { can?(:manage, Spree::ReturnAuthorizationReason) }
+
+  returns_tabs_nav.add :refund_reasons,
+          label: :refund_reasons,
+          url: :admin_refund_reasons_path,
+          position: 20,
+          if: -> { can?(:manage, Spree::RefundReason) }
+
+  returns_tabs_nav.add :reimbursement_types,
+          label: :reimbursement_types,
+          url: :admin_reimbursement_types_path,
+          position: 30,
+          if: -> { can?(:manage, Spree::ReimbursementType) }
+
+  # Developers Tab Navigation
+  developers_tabs_nav = Spree.admin.navigation.developers_tabs
+
+  developers_tabs_nav.add :api_keys,
+          label: :api_keys,
+          url: :admin_oauth_applications_path,
+          position: 10,
+          active: -> { controller_name == 'oauth_applications' },
+          if: -> { can?(:manage, Spree::OauthApplication) }
+
+  developers_tabs_nav.add :webhooks,
+          label: :webhooks,
+          url: :admin_webhooks_subscribers_path,
+          position: 20,
+          active: -> { controller_name == 'webhooks_subscribers' },
+          if: -> { can?(:manage, Spree::Webhooks::Subscriber) }
+
+  # Audit Tab Navigation
+  audit_tabs_nav = Spree.admin.navigation.audit_tabs
+
+  audit_tabs_nav.add :audit_log,
+          label: 'admin.audit_log',
+          url: :admin_audits_path,
+          position: 10,
+          active: -> { controller_name == 'audits' },
+          if: -> { can?(:manage, current_store) }
+
+  audit_tabs_nav.add :exports,
+          label: :exports,
+          url: :admin_exports_path,
+          position: 20,
+          active: -> { controller_name == 'exports' },
+          if: -> { can?(:manage, Spree::Export) }
+
+  audit_tabs_nav.add :imports,
+          label: :imports,
+          url: :admin_imports_path,
+          position: 30,
+          active: -> { controller_name == 'imports' },
+          if: -> { can?(:manage, Spree::Import) }
+end

data/config/locales/en.yml

@@ -48,6 +48,7 @@ en:
         special_instructions:
           description: Allow customers to add special instructions to their order.
           label: Display the special instructions field
+      close_sidebar: Close sidebar
       copied: Copied!
       copy_payment_link: Copy Payment Link
       copy_to_clipboard: Copy to clipboard
@@ -75,6 +76,7 @@ en:
       edit_theme: Edit theme
       errors: Errors
       execution_time: Execution Time
+      expand_sidebar: Expand sidebar
       export_all: Export all records (can be slow for large datasets)
       export_coupons: Export coupons as CSV file
       export_created: Your export was started. You will receive an email with a download link when it is ready!
@@ -298,6 +300,8 @@ en:
         compare_at_price_description: This price is used to show marked down price on the product page.
         stock_locations_link: To add more stock locations please go to <a href="%{link}">Stock Locations</a>
         total_inventory_html: 'Total inventory at %{stock_location} location: %{count} available'
+      vendors:
+        enterprise_feature: Multi-Vendor Marketplace is available in the Enterprise Edition
       webhooks_subscribers:
         all_events: All Events
         new_webhooks_subscriber: New Webhooks Subscriber

data/lib/generators/spree/admin/scaffold/templates/controller.rb.tt

@@ -4,7 +4,9 @@ module Spree
       private
 
       def permitted_resource_params
-        params.require(:<%= @singular_name %>).permit(:name)
+        params.require(:<%= @singular_name %>).permit(
+          :name
+        )
       end
     end
   end

data/lib/generators/spree/admin/scaffold/templates/views/_table_row.html.erb.tt

@@ -1,9 +1,11 @@
 <tr id="<%%= spree_dom_id <%= @singular_name %> %>" class="cursor-pointer" data-controller="row-link">
-  <td data-action="click->row-link#openLink" class="w-70"><%%= <%= @singular_name %>.name %></td>
-  <td data-action="click->row-link#openLink" class="w-20"><%%= spree_date(<%= @singular_name %>.created_at) %></td>
-  <td class="actions w-10"">
-    <span class="d-flex justify-content-end">
-      <%%= link_to_edit(<%= @singular_name %>, data: { row_link_target: :link, turbo_frame: '_top' }) if can? :edit, <%= @singular_name %> %>
-    </span>
+  <td data-action="click->row-link#openLink" class="w-70">
+    <%%= <%= @singular_name %>.name %>
+  </td>
+  <td data-action="click->row-link#openLink" class="w-20">
+    <%%= spree_date(<%= @singular_name %>.created_at) %>
+  </td>
+  <td class="actions w-10">
+    <%%= link_to_edit(<%= @singular_name %>, data: { row_link_target: :link, turbo_frame: '_top' }) if can? :edit, <%= @singular_name %> %>
   </td>
 </tr>

data/lib/spree/admin/engine.rb

@@ -125,9 +125,59 @@ module Spree
         :webhooks_subscribers_header_partials,
         :vendors_nav_partials,
         :zones_actions_partials,
-        :zones_header_partials
+        :zones_header_partials,
+        :navigation
       )
 
+      class NavigationEnvironment
+        def initialize
+          @contexts = {}
+        end
+
+        # Register a new navigation context
+        # @param name [Symbol] The name of the navigation context
+        # @return [Spree::Admin::Navigation] The navigation instance
+        def register_context(name)
+          name = name.to_sym
+          @contexts[name] ||= Spree::Admin::Navigation.new(name)
+        end
+
+        # Get a registered navigation context
+        # @param name [Symbol] The name of the navigation context
+        # @return [Spree::Admin::Navigation] The navigation instance
+        # @raise [NoMethodError] if the context hasn't been registered
+        def get_context(name)
+          name = name.to_sym
+          @contexts[name] || raise(NoMethodError, "Navigation context '#{name}' has not been registered. Use Spree.admin.navigation.register_context(:#{name}) first.")
+        end
+
+        # List all registered contexts
+        # @return [Array<Symbol>] Array of registered context names
+        def contexts
+          @contexts.keys
+        end
+
+        # Check if a context exists
+        # @param name [Symbol] The context name to check
+        # @return [Boolean] true if the context is registered
+        def context?(name)
+          @contexts.key?(name.to_sym)
+        end
+
+        # Define accessor methods for predefined and custom contexts
+        def method_missing(method_name, *args)
+          if method_name.to_s.end_with?('=')
+            super
+          else
+            get_context(method_name)
+          end
+        end
+
+        def respond_to_missing?(method_name, include_private = false)
+          method_name.to_s.end_with?('=') ? false : context?(method_name)
+        end
+      end
+
       # accessible via Rails.application.config.spree_admin
       initializer 'spree.admin.environment', before: :load_config_initializers do |app|
         app.config.spree_admin = Environment.new
@@ -182,12 +232,24 @@ module Spree
         end
       end
 
-      config.after_initialize do
+      config.after_initialize do |app|
         Environment.new.tap do |env|
           env.members.each do |key|
             Rails.application.config.spree_admin.send("#{key}=", [])
           end
         end
+
+        # Register predefined navigation contexts
+        app.config.spree_admin.navigation = NavigationEnvironment.new
+        app.config.spree_admin.navigation.register_context(:sidebar)
+        app.config.spree_admin.navigation.register_context(:settings)
+        app.config.spree_admin.navigation.register_context(:tax_tabs)
+        app.config.spree_admin.navigation.register_context(:shipping_tabs)
+        app.config.spree_admin.navigation.register_context(:team_tabs)
+        app.config.spree_admin.navigation.register_context(:stock_tabs)
+        app.config.spree_admin.navigation.register_context(:returns_tabs)
+        app.config.spree_admin.navigation.register_context(:developers_tabs)
+        app.config.spree_admin.navigation.register_context(:audit_tabs)
       end
     end
   end

data/lib/spree/admin/runtime_configuration.rb

@@ -12,6 +12,7 @@ module Spree
       preference :admin_orders_per_page, :integer, default: Kaminari.config.default_per_page
 
       preference :include_application_importmap, :boolean, default: false
+      preference :legacy_sidebar_navigation, :boolean, default: false
     end
   end
 end

data/lib/spree/admin.rb

@@ -18,5 +18,25 @@ require 'inline_svg'
 require 'spree/admin/action_callbacks'
 require 'spree/admin/callbacks'
 require 'spree/admin/engine'
+require 'spree/core/partials'
 
 require 'tinymce-rails'
+
+module Spree
+  def self.admin
+    @admin ||= AdminConfig.new
+  end
+
+  class AdminConfig
+    def partials
+      @partials ||= Spree::Core::Partials.new(
+        Rails.application.config.spree_admin,
+        Spree::Admin::Engine::Environment
+      )
+    end
+
+    def navigation
+      Rails.application.config.spree_admin.navigation
+    end
+  end
+end