solidus_backend 4.1.0 → 4.2.0

data/lib/spree/backend_configuration/menu_item.rb

@@ -4,54 +4,108 @@ module Spree
   class BackendConfiguration < Preferences::Configuration
     # An item which should be drawn in the admin menu
     class MenuItem
-      attr_reader :icon, :label, :partial, :condition, :sections, :match_path
+      attr_reader :icon, :label, :partial, :children, :condition, :data_hook, :match_path
 
-      attr_accessor :position
+      def sections # rubocop:disable Style/TrivialAccessors
+        @sections
+      end
+      deprecate sections: :label, deprecator: Spree.deprecator
+
+      attr_accessor :position # rubocop:disable Layout/EmptyLinesAroundAttributeAccessor
+      deprecate position: nil, deprecator: Spree.deprecator
+      deprecate "position=": nil, deprecator: Spree.deprecator
 
-      # @param sections [Array<Symbol>] The sections which are contained within
-      #   this admin menu section.
       # @param icon [String] The icon to draw for this menu item
       # @param condition [Proc] A proc which returns true if this menu item
       #   should be drawn. If nil, it will be replaced with a proc which always
       #   returns true.
       # @param label [Symbol] The translation key for a label to use for this
       #   menu item.
-      # @param partial [String] A partial to draw within this menu item for use
-      #   in declaring a submenu
-      # @param url [String] A url where this link should send the user to
-      # @param position [Integer] The position in which the menu item should render
-      #   nil will cause the item to render last
+      # @param children [Array<Spree::BackendConfiguration::MenuItem>] An array
+      # @param url [String|Symbol] A url where this link should send the user to or a Symbol representing a route name
       # @param match_path [String, Regexp, callable] (nil) If the {url} to determine the active tab is ambigous
       #   you can pass a String, Regexp or callable to identify this menu item. The callable
       #   accepts a request object and returns a Boolean value.
       def initialize(
-        sections,
-        icon,
+        *args,
+        icon: nil,
         condition: nil,
         label: nil,
         partial: nil,
+        children: [],
         url: nil,
         position: nil,
+        data_hook: nil,
         match_path: nil
       )
+        if args.length == 2
+          sections, icon = args
+          label ||= sections.first.to_s
+          Spree.deprecator.warn "Passing sections to #{self.class.name} is deprecated. Please pass a label instead."
+          Spree.deprecator.warn "Passing icon to #{self.class.name} is deprecated. Please use the keyword argument instead."
+        elsif args.any?
+          raise ArgumentError, "wrong number of arguments (given #{args.length}, expected 0..2)"
+        end
+
+        if partial.present? && children.blank?
+          # We only show the deprecation if there are no children, because if there are children,
+          # then the menu item is already future-proofed.
+          Spree.deprecator.warn "Passing a partial to #{self.class.name} is deprecated. Please use the children keyword argument instead."
+        end
 
         @condition = condition || -> { true }
         @sections = sections
         @icon = icon
-        @label = label || sections.first
+        @label = label
         @partial = partial
+        @children = children
         @url = url
-        @position = position
+        @data_hook = data_hook
         @match_path = match_path
+
+        self.position = position if position # Use the setter to deprecate
+      end
+
+      def render_in?(view_context)
+        view_context.instance_exec(&@condition) ||
+          children.any? { |child| child.render_in?(view_context) }
+      end
+
+      def render_partial?
+        return false if partial.blank?
+
+        children.blank? || Spree::Backend::Config.prefer_menu_item_partials
+      end
+
+      def match_path?(request)
+        if match_path.is_a? Regexp
+          request.fullpath =~ match_path
+        elsif match_path.respond_to?(:call)
+          match_path.call(request)
+        elsif match_path
+          request.fullpath.starts_with?("#{spree.admin_path}#{match_path}")
+        else
+          request.fullpath.to_s.starts_with?(url.to_s)
+        end
       end
 
       def url
         if @url.respond_to?(:call)
           @url.call
+        elsif @url.is_a?(Symbol)
+          spree.public_send(@url)
+        elsif @url.nil? && @label
+          spree.send("admin_#{@label}_path")
         else
           @url
         end
       end
+
+      private
+
+      def spree
+        Spree::Core::Engine.routes.url_helpers
+      end
     end
   end
 end

data/lib/spree/backend_configuration.rb

@@ -22,6 +22,12 @@ module Spree
       user_theme ? themes.fetch(user_theme.to_sym) : themes.fetch(theme.to_sym)
     end
 
+    # @!attribute [rw] admin_updated_navbar
+    #   @return [Boolean] Should the updated navbar be used in admin (default: +false+)
+    #
+    # TODO: Update boundaries before merging to `main`
+    versioned_preference :admin_updated_navbar, :boolean, initial_value: false, boundaries: { "4.1.0.a" => true }
+
     preference :frontend_product_path,
       :proc,
       default: proc {
@@ -32,40 +38,32 @@ module Spree
         }
       }
 
-    ORDER_TABS         ||= [:orders, :payments, :creditcard_payments,
-                            :shipments, :credit_cards, :return_authorizations,
-                            :customer_returns, :adjustments, :customer_details]
-    PRODUCT_TABS       ||= [:products, :option_types, :properties,
-                            :variants, :product_properties, :taxonomies,
-                            :taxons]
-    CONFIGURATION_TABS ||= [:stores, :tax_categories,
-                            :tax_rates, :zones,
-                            :payment_methods, :shipping_methods,
-                            :shipping_categories, :stock_locations,
-                            :refund_reasons, :reimbursement_types,
-                            :return_reasons, :adjustment_reasons,
-                            :store_credit_reasons]
-    PROMOTION_TABS     ||= [:promotions, :promotion_categories]
-    STOCK_TABS         ||= [:stock_items]
-    USER_TABS          ||= [:users, :store_credits]
+    # @!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'
+    autoload :PROMOTION_TABS, 'spree/backend_configuration/deprecated_tab_constants'
+    autoload :STOCK_TABS, 'spree/backend_configuration/deprecated_tab_constants'
+    autoload :USER_TABS, 'spree/backend_configuration/deprecated_tab_constants'
 
     # Items can be added to the menu by using code like the following:
     #
     # Spree::Backend::Config.configure do |config|
     #   config.menu_items << config.class::MenuItem.new(
-    #     [:section],
-    #     'icon-name',
-    #     url: 'https://solidus.io/'
+    #     label: :my_reports,
+    #     icon: 'file-text-o', # see https://fontawesome.com/v4/icons/
+    #     url: :my_admin_reports_path,
+    #     condition: -> { can?(:admin, MyReports) },
+    #     partial: 'spree/admin/shared/my_reports_sub_menu',
+    #     match_path: '/reports',
     #   )
     # end
     #
     # @!attribute menu_items
     #   @return [Array<Spree::BackendConfiguration::MenuItem>]
-    #
-    # Positioning can be determined by setting the position attribute to
-    # an Integer or nil. Menu Items will be rendered with smaller lower values
-    # first and higher values last. A position value of nil will cause the menu
-    # item to be rendered at the end of the list.
     attr_writer :menu_items
 
     # Return the menu items which should be drawn in the menu
@@ -75,63 +73,138 @@ module Spree
     def menu_items
       @menu_items ||= [
         MenuItem.new(
-          ORDER_TABS,
-          'shopping-cart',
+          label: :orders,
+          icon: admin_updated_navbar ? 'ri-inbox-line' : 'shopping-cart',
           condition: -> { can?(:admin, Spree::Order) },
-          position: 0
+          match_path: %r{/(
+            adjustments|
+            credit_cards|
+            creditcard_payments|
+            customer_details|
+            customer_returns|
+            orders|
+            payments|
+            return_authorizations|
+            shipments
+          )}x,
         ),
         MenuItem.new(
-          PRODUCT_TABS,
-          'th-large',
+          label: :products,
+          icon: admin_updated_navbar ? 'ri-price-tag-3-line' : 'th-large',
           condition: -> { can?(:admin, Spree::Product) },
           partial: 'spree/admin/shared/product_sub_menu',
-          position: 1
+          data_hook: :admin_product_sub_tabs,
+          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(
-          PROMOTION_TABS,
-          'bullhorn',
+          label: :promotions,
+          icon: admin_updated_navbar ? 'ri-megaphone-line' : 'bullhorn',
           partial: 'spree/admin/shared/promotion_sub_menu',
           condition: -> { can?(:admin, Spree::Promotion) },
           url: :admin_promotions_path,
-          position: 2
+          data_hook: :admin_promotion_sub_tabs,
+          children: [
+            MenuItem.new(
+              label: :promotions,
+              condition: -> { can?(:admin, Spree::Promotion) },
+            ),
+            MenuItem.new(
+              label: :promotion_categories,
+              condition: -> { can?(:admin, Spree::PromotionCategory) },
+            ),
+          ],
         ),
         MenuItem.new(
-          STOCK_TABS,
-          'cubes',
-          condition: -> { can?(:admin, Spree::StockItem) },
           label: :stock,
+          icon: admin_updated_navbar ? 'ri-stack-line' : 'cubes',
+          match_path: %r{/(stock_items)},
+          condition: -> { can?(:admin, Spree::StockItem) },
           url: :admin_stock_items_path,
-          match_path: '/stock_items',
-          position: 3
         ),
         MenuItem.new(
-          USER_TABS,
-          'user',
+          label: :users,
+          icon: admin_updated_navbar ? 'ri-user-line' : 'user',
+          match_path: %r{/(users|store_credits)},
           condition: -> { Spree.user_class && can?(:admin, Spree.user_class) },
           url: :admin_users_path,
-          position: 4
         ),
         MenuItem.new(
-          CONFIGURATION_TABS,
-          'wrench',
-          condition: -> {
-            can?(:admin, Spree::Store) ||
-            can?(:admin, Spree::AdjustmentReason) ||
-            can?(:admin, Spree::PaymentMethod) ||
-            can?(:admin, Spree::RefundReason) ||
-            can?(:admin, Spree::ReimbursementType) ||
-            can?(:admin, Spree::ShippingCategory) ||
-            can?(:admin, Spree::ShippingMethod) ||
-            can?(:admin, Spree::StockLocation) ||
-            can?(:admin, Spree::TaxCategory) ||
-            can?(:admin, Spree::TaxRate) ||
-            can?(:admin, Spree::ReturnReason) ||
-            can?(:admin, Spree::Zone)
-          },
           label: :settings,
+          icon: admin_updated_navbar ? 'ri-settings-line' : 'wrench',
+          data_hook: :admin_settings_sub_tabs,
           partial: 'spree/admin/shared/settings_sub_menu',
+          condition: -> { can? :admin, Spree::Store },
           url: :admin_stores_path,
-          position: 5
+          children: [
+            MenuItem.new(
+              label: :stores,
+              condition: -> { can? :admin, Spree::Store },
+              url: :admin_stores_path,
+            ),
+            MenuItem.new(
+              label: :payments,
+              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

data/vendor/assets/javascripts/solidus_admin/select2_locales/select2_locale_es-CL.js

@@ -0,0 +1,10 @@
+/**
+ * Select2 Chilean Spanish translations
+ */
+(function ($) {
+  "use strict";
+
+  $.fn.select2.locales['es-CL'] = {};
+
+  $.extend($.fn.select2.defaults, $.fn.select2.locales['es-CL']);
+})(jQuery);

data/vendor/assets/javascripts/solidus_admin/select2_locales/select2_locale_hy.js

@@ -0,0 +1,37 @@
+/**
+ * Select2 Armenian translation.
+ *
+ * @author  Arman Harutyunyan <armanx@gmail.com>
+ * @author  Siruhi Karakhanyan <sirunkarakhanyan1983@gmail.com>
+ *
+ */
+(function($) {
+    "use strict";
+
+    $.fn.select2.locales['hy'] = {
+        formatNoMatches: function() {
+            return "Համընկնումներ չեն գտնվել";
+        },
+        formatInputTooShort: function(input, min) {
+            return "Խնդրում ենք մուտքագրել առնվազն" + character(min - input.length);
+        },
+        formatInputTooLong: function(input, max) {
+            return "Խնդրում ենք մուտքագրել" + character(input.length - max) + " պակաս";
+        },
+        formatSelectionTooBig: function(limit) {
+            return "Դուք կարող եք ընտրել ոչ ավելին" + character(limit);
+        },
+        formatLoadMore: function(pageNumber) {
+            return "Տվյալների բեռնում…";
+        },
+        formatSearching: function() {
+            return "Որոնել…";
+        }
+    };
+
+    $.extend($.fn.select2.defaults, $.fn.select2.locales['hy']);
+
+    function character(n) {
+        return " " + n + " խորհրդանիշ";
+    }
+})(jQuery);

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus_backend
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Solidus Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-29 00:00:00.000000000 Z
+date: 2023-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solidus_api
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: solidus_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: font-awesome-rails
   requirement: !ruby/object:Gem::Requirement
@@ -167,6 +167,7 @@ files:
 - app/assets/config/solidus_backend_manifest.js
 - app/assets/images/favicon.ico
 - app/assets/images/solidus-style-guide-logo.png
+- app/assets/images/spree/backend/themes/solidus_admin/remixicon.symbol.svg
 - app/assets/javascripts/spree/backend.js
 - app/assets/javascripts/spree/backend/addresses.js
 - app/assets/javascripts/spree/backend/adjustments.js
@@ -296,11 +297,13 @@ files:
 - app/assets/stylesheets/spree/backend/components/_list_group.scss
 - app/assets/stylesheets/spree/backend/components/_messages.scss
 - app/assets/stylesheets/spree/backend/components/_navigation.scss
+- app/assets/stylesheets/spree/backend/components/_navigation_solidus_admin.scss
 - app/assets/stylesheets/spree/backend/components/_number_with_currency.scss
 - app/assets/stylesheets/spree/backend/components/_pills.scss
 - app/assets/stylesheets/spree/backend/components/_progress.scss
 - app/assets/stylesheets/spree/backend/components/_sidebar.scss
 - app/assets/stylesheets/spree/backend/components/_stock_table.scss
+- app/assets/stylesheets/spree/backend/components/_switch_solidus_admin.scss
 - app/assets/stylesheets/spree/backend/components/_table-filter.scss
 - app/assets/stylesheets/spree/backend/components/_tabs.scss
 - app/assets/stylesheets/spree/backend/components/index.scss
@@ -346,6 +349,7 @@ files:
 - app/assets/stylesheets/spree/backend/spree_admin.scss
 - app/assets/stylesheets/spree/backend/themes/classic.css.scss
 - app/assets/stylesheets/spree/backend/themes/solidus_admin.css.scss
+- app/assets/stylesheets/spree/backend/themes/solidus_admin/_colors.scss
 - app/assets/stylesheets/spree/backend/themes/solidus_admin/_tables.scss
 - app/assets/stylesheets/spree/backend/themes/solidus_admin/_variables.scss
 - app/assets/stylesheets/spree/backend/vendor/index.scss
@@ -599,6 +603,7 @@ files:
 - app/views/spree/admin/shared/_navigation.html.erb
 - app/views/spree/admin/shared/_navigation_footer_fallback.html.erb
 - app/views/spree/admin/shared/_navigation_header.html.erb
+- app/views/spree/admin/shared/_navigation_solidus_admin.html.erb
 - app/views/spree/admin/shared/_new_resource_links.html.erb
 - app/views/spree/admin/shared/_no_objects_found.html.erb
 - app/views/spree/admin/shared/_number_with_currency.html.erb
@@ -741,6 +746,7 @@ files:
 - lib/spree/backend/config.rb
 - lib/spree/backend/engine.rb
 - lib/spree/backend_configuration.rb
+- lib/spree/backend_configuration/deprecated_tab_constants.rb
 - lib/spree/backend_configuration/menu_item.rb
 - lib/spree_backend.rb
 - solidus_backend.gemspec
@@ -777,6 +783,7 @@ files:
 - vendor/assets/javascripts/solidus_admin/select2_locales/select2_locale_en-IN.js
 - vendor/assets/javascripts/solidus_admin/select2_locales/select2_locale_en-NZ.js
 - vendor/assets/javascripts/solidus_admin/select2_locales/select2_locale_en-US.js
+- vendor/assets/javascripts/solidus_admin/select2_locales/select2_locale_es-CL.js
 - vendor/assets/javascripts/solidus_admin/select2_locales/select2_locale_es-MX.js
 - vendor/assets/javascripts/solidus_admin/select2_locales/select2_locale_es.js
 - vendor/assets/javascripts/solidus_admin/select2_locales/select2_locale_et.js
@@ -788,6 +795,7 @@ files:
 - vendor/assets/javascripts/solidus_admin/select2_locales/select2_locale_he.js
 - vendor/assets/javascripts/solidus_admin/select2_locales/select2_locale_hr.js
 - vendor/assets/javascripts/solidus_admin/select2_locales/select2_locale_hu.js
+- vendor/assets/javascripts/solidus_admin/select2_locales/select2_locale_hy.js
 - vendor/assets/javascripts/solidus_admin/select2_locales/select2_locale_id.js
 - vendor/assets/javascripts/solidus_admin/select2_locales/select2_locale_is.js
 - vendor/assets/javascripts/solidus_admin/select2_locales/select2_locale_it.js
@@ -922,7 +930,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.8.23
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.23
 signing_key:
 specification_version: 4
 summary: Admin interface for the Solidus e-commerce framework.