configuration.rb in solidus_admin-0.1.0

- old
+ new

@@ -15,42 +15,10 @@
     #
     # It needs to be a path to an image file accessible by Sprockets.
     # The default value is the Solidus logo that lives in the solidus_core gem.
     preference :logo_path, :string, default: "logo/solidus.svg"
 
-    # The list of paths were Tailwind CSS classes are used.
-    #
-    # You can modify this list to include your own paths:
-    #
-    #    SolidusAdmin::Config.tailwind_content << Rails.root.join("app/my/custom/path")
-    #
-    # Recompile with `bin/rails solidus_admin:tailwindcss:build` after changing this list.
-    #
-    # @see https://tailwindcss.com/docs/configuration#content
-    preference :tailwind_content, :array, default: [
-      "#{ENGINE_ROOT}/app/helpers/**/*.rb",
-      "#{ENGINE_ROOT}/app/assets/javascripts/**/*.js",
-      "#{ENGINE_ROOT}/app/views/**/*.erb",
-      "#{ENGINE_ROOT}/app/components/**/*.{rb,erb,js}",
-      "#{ENGINE_ROOT}/spec/components/previews/**/*.{erb,rb}",
-
-      Rails.root&.join("public/solidus_admin/*.html"),
-      Rails.root&.join("app/helpers/solidus_admin/**/*.rb"),
-      Rails.root&.join("app/assets/javascripts/solidus_admin/**/*.js"),
-      Rails.root&.join("app/views/solidus_admin/**/*.{erb,haml,html,slim}"),
-      Rails.root&.join("app/components/solidus_admin/**/*.{rb,erb,haml,html,slim,js}")
-    ].compact
-
-    # List of Tailwind CSS files to be combined into the final stylesheet.
-    #
-    # You can modify this list to include your own files:
-    #
-    #   SolidusAdmin::Config.tailwind_stylesheets << Rails.root.join("app/assets/stylesheets/solidus_admin/application.tailwind.css")
-    #
-    # Recompile with `bin/rails solidus_admin:tailwindcss:build` after changing this list.
-    preference :tailwind_stylesheets, :array, default: []
-
     # List of paths to watch for changes to trigger a cache sweep forcing a regeneration of the importmap.
     #
     # @see https://github.com/rails/importmap-rails#sweeping-the-cache-in-development-and-test
     preference :importmap_cache_sweepers, :array, default: [
       "#{ENGINE_ROOT}/app/assets/javascripts",
@@ -63,38 +31,23 @@
     # @see https://github.com/rails/importmap-rails#composing-import-maps
     preference :importmap_paths, :array, default: [
       "#{ENGINE_ROOT}/config/importmap.rb",
     ]
 
-    # @!attribute [rw] orders_per_page
-    #   @return [Integer] The number of orders to display per page in the admin interface.
-    #                     This preference determines the pagination limit for the order listing.
-    #                     The default value is fetched from the Spree core configuration and currently set to 15.
-    preference :orders_per_page, :integer, default: Spree::Config[:orders_per_page]
+    # @!attribute [rw] low_stock_value
+    #   @return [Integer] The low stock value determines the threshold at which products are considered low in stock.
+    #                     Products with a count_on_hand less than or equal to this value will be considered low in stock.
+    #                     Default: 10
+    preference :low_stock_value, :integer, default: 10
 
-    # @!attribute [rw] order_search_key
-    #   The key that specifies the attributes for searching orders within the admin interface.
-    #   This preference controls which attributes of an order are used in search queries.
-    #   By default, it is set to
-    #   'number_shipments_number_or_bill_address_name_or_email_order_promotions_promotion_code_value_cont',
-    #   enabling a search across order number, shipment number, billing address name, email, and promotion code value.
-    #   @return [String] The search key used to determine order attributes for search.
-    preference :order_search_key, :string, default: :number_or_shipments_number_or_bill_address_name_or_email_or_order_promotions_promotion_code_value_cont
+    # @!attribute [rw] enable_alpha_features?
+    #   @return [Boolean] Determines whether alpha features are enabled or disabled in the application.
+    #                     Setting this to `true` enables access to alpha stage features that might still be in testing or development.
+    #                     Use with caution, as these features may not be fully stable or complete.
+    #                     Default: false
+    preference :enable_alpha_features?, :boolean, default: false
 
-    # @!attribute [rw] products_per_page
-    #   @return [Integer] The number of products to display per page in the admin interface.
-    #                     This preference determines the pagination limit for the product listing.
-    #                     The default value is fetched from the Spree core configuration and currently set to 10.
-    preference :products_per_page, :integer, default: Spree::Config[:admin_products_per_page]
-
-    # @!attribute [rw] product_search_key
-    #   @return [String] The key to use when searching for products in the admin interface.
-    #                    This preference determines the product attribute to use for search.
-    #                    By default, it is set to 'name_or_variants_including_master_sku_cont',
-    #                    meaning it will search by product name or product variants sku.
-    preference :product_search_key, :string, default: :name_or_variants_including_master_sku_cont
-
     preference :storefront_product_path_proc, :proc, default: ->(_version) {
       ->(product) { "/products/#{product.slug}" }
     }
 
     def storefront_product_path(product)
@@ -184,20 +137,73 @@
           position: 60,
         }
       ]
     end
 
+    def import_menu_items_from_backend!
+      menu_item_to_hash = ->(item, index) do
+        route =
+          if item.url.is_a?(Symbol)
+            -> { solidus_admin.public_send(item.url) }
+          elsif item.url.is_a?(String)
+            -> { item.url }
+          elsif item.url.is_a?(Proc)
+            item.url
+          elsif item.url.nil?
+            -> { spree.public_send(:"admin_#{item.label}_path") }
+          else
+            raise ArgumentError, "Unknown url type #{item.url.class}"
+          end
+
+        match_path =
+          case item.match_path
+          when Regexp then -> { _1 =~ item.match_path }
+          when Proc then item.match_path
+          when String then -> { _1.start_with?("/admin#{item.match_path}") }
+          when nil then -> { _1.start_with?(route.call) }
+          else raise ArgumentError, "Unknown match_path type #{item.match_path.class}"
+          end
+
+        icon =
+          case item.icon
+          when /^ri-/
+            item.icon.delete_prefix("ri-")
+          when String
+            'record-circle-line' # fallback on a generic icon
+          end
+
+        {
+          position: index,
+          key: item.label,
+          icon: icon,
+          route: route,
+          children: item.children.map.with_index(&menu_item_to_hash),
+          match_path: match_path,
+        }
+      end
+
+      @menu_items = Spree::Backend::Config.menu_items.map.with_index(&menu_item_to_hash)
+    end
+
     def components
       @components ||= Hash.new do |_h, k|
-        "solidus_admin/#{k}/component".classify.constantize
-      rescue NameError
-        prefix = "#{ENGINE_ROOT}/app/components/solidus_admin/"
-        suffix = "/component.rb"
-        dictionary = Dir["#{prefix}**#{suffix}"].map { _1.delete_prefix(prefix).delete_suffix(suffix) }
-        corrections = DidYouMean::SpellChecker.new(dictionary: dictionary).correct(k.to_s)
+        const_name = "solidus_admin/#{k}/component".classify
 
-        raise ComponentNotFoundError, "Unknown component #{k}#{DidYouMean.formatter.message_for(corrections)}"
+        unless Object.const_defined?(const_name)
+          prefix = "#{ENGINE_ROOT}/app/components/solidus_admin/"
+          suffix = "/component.rb"
+          dictionary = Dir["#{prefix}**#{suffix}"].map { _1.delete_prefix(prefix).delete_suffix(suffix) }
+          corrections = DidYouMean::SpellChecker.new(dictionary: dictionary).correct(k.to_s)
+
+          raise ComponentNotFoundError.new(
+            "Unknown component #{k}#{DidYouMean.formatter.message_for(corrections)}",
+            k.classify,
+            receiver: ::SolidusAdmin
+          )
+        end
+
+        const_name.constantize
       end
     end
 
     # The method used to authenticate the user in the admin interface, it's expected to redirect the user to the login method
     # in case the authentication fails.
@@ -209,9 +215,29 @@
     # The path used to logout the user in the admin interface.
     preference :logout_link_path, :string, default: '/admin/logout'
 
     # The HTTP method used to logout the user in the admin interface.
     preference :logout_link_method, :string, default: :delete
+
+    # @!attribute [rw] themes
+    #   @return [Hash] A hash containing the themes that are available for the admin panel
+    preference :themes, :hash, default: {
+      solidus: 'solidus_admin/application',
+      solidus_dark: 'solidus_admin/dark',
+      solidus_dimmed: 'solidus_admin/dimmed',
+    }
+
+    # @!attribute [rw] theme
+    #   @return [String] Default admin theme name
+    preference :theme, :string, default: 'solidus'
+
+    # @!attribute [rw] dark_theme
+    #   @return [String] Default admin theme name
+    preference :dark_theme, :string, default: 'solidus_dark'
+
+    def theme_path(user_theme)
+      themes.fetch(user_theme&.to_sym, themes[theme.to_sym])
+    end
   end
 end
 
 SolidusAdmin::Config = SolidusAdmin::Configuration.new