solidus_admin 0.0.2 → 0.1.0

data/lib/solidus_admin/configuration.rb

@@ -17,38 +17,6 @@ module SolidusAdmin
     # 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
@@ -65,33 +33,18 @@ module SolidusAdmin
       "#{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] 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] 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
+    # @!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] 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
 
     preference :storefront_product_path_proc, :proc, default: ->(_version) {
       ->(product) { "/products/#{product.slug}" }
@@ -186,16 +139,69 @@ module SolidusAdmin
       ]
     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)
-
-        raise ComponentNotFoundError, "Unknown component #{k}#{DidYouMean.formatter.message_for(corrections)}"
+        const_name = "solidus_admin/#{k}/component".classify
+
+        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
 
@@ -211,6 +217,26 @@ module SolidusAdmin
 
     # 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
 

data/lib/solidus_admin/install_tailwindcss.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+# This file is a Rails app template and should be loaded with `bin/rails `.
+
+engine_root = File.expand_path("#{__dir__}/../..")
+config_path = "config/solidus_admin/tailwind.config.js"
+input_path = "app/assets/stylesheets/solidus_admin/application.tailwind.css"
+output_path = "app/assets/builds/solidus_admin/tailwind.css"
+
+unless bundle_command "show tailwindcss-rails"
+  bundle_command "add tailwindcss-rails"
+end
+
+# Copy the Tailwind CSS main file.
+create_file input_path, File.read("#{engine_root}/app/assets/stylesheets/solidus_admin/application.tailwind.css")
+
+create_file config_path, <<~JS
+  const { execSync } = require('child_process')
+  const adminRoot = execSync('bundle show solidus_admin').toString().trim()
+  const solidusAdmin = require(`${adminRoot}/config/tailwind.config.js`)
+
+  module.exports = {
+    // Read how to use TailwindCSS presets: https://tailwindcss.com/docs/presets.
+    presets: [solidusAdmin],
+
+    content: [
+      // Include paths coming from SolidusAdmin.
+      ...solidusAdmin.content,
+
+      // Include paths to your own components.
+      `${__dirname}/../../app/components/admin/**/*`,
+    ],
+  }
+JS
+
+create_file "lib/tasks/solidus_admin/tailwind.rake", <<~RUBY
+  # frozen_string_literal: true
+
+  namespace :solidus_admin do
+    namespace :tailwindcss do
+      root = Rails.root
+      tailwindcss = Tailwindcss::Commands.executable
+
+      tailwindcss_command = [
+        tailwindcss,
+        "--config", root.join(#{config_path.to_s.inspect}),
+        "--input", root.join(#{input_path.to_s.inspect}),
+        "--output", root.join(#{output_path.to_s.inspect}),
+      ]
+
+      desc 'Build Tailwind CSS'
+      task :build do
+        sh tailwindcss_command.shelljoin
+      end
+
+      desc 'Watch Tailwind CSS'
+      task :watch do
+        sh (tailwindcss_command + ['--watch']).shelljoin
+      end
+    end
+  end
+
+  # Attach Tailwind CSS build to other tasks.
+  %w[
+    assets:precompile
+    test:prepare
+    spec:prepare
+    db:test:prepare
+  ].each do |task_name|
+    next unless Rake::Task.task_defined?(task_name)
+
+    Rake::Task[task_name].enhance(['solidus_admin:tailwindcss:build'])
+  end
+RUBY
+
+append_file ".gitignore", "app/assets/builds/solidus_admin/"
+
+unless Rails.root.join("Procfile.dev").exist?
+  create_file "Procfile.dev", <<~YAML
+    web: bin/rails server
+  YAML
+end
+
+unless Rails.root.join("bin/dev").exist?
+  create_file "bin/dev", <<~SH
+    #!/usr/bin/env sh
+
+    if ! gem list foreman -i --silent; then
+      echo "Installing foreman..."
+      gem install foreman
+    fi
+
+    # Default to port 3000 if not specified
+    export PORT="${PORT:-3000}"
+
+    exec foreman start -f Procfile.dev "$@"
+  SH
+
+  run "chmod +x bin/dev"
+end
+
+append_to_file "Procfile.dev", "admin_css: bin/rails solidus_admin:tailwindcss:watch\n"

data/lib/solidus_admin/{main_nav_item.rb → menu_item.rb}

@@ -2,7 +2,7 @@
 
 module SolidusAdmin
   # Encapsulates the data for a main navigation item.
-  class MainNavItem
+  class MenuItem
     # @!attribute [r] key
     #  @return [String] a unique identifier for this item
     attr_reader :key
@@ -45,7 +45,7 @@ module SolidusAdmin
     end
 
     def name
-      I18n.t("solidus_admin.main_nav.#{key}", default: key.to_s.humanize)
+      I18n.t("solidus_admin.menu_item.#{key}", default: key.to_s.humanize)
     end
 
     # @return [Boolean] whether this item has any children

data/lib/solidus_admin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidusAdmin
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/solidus_admin.rb

@@ -6,9 +6,8 @@ require "solidus_backend"
 module SolidusAdmin
   require "solidus_admin/version"
   require "solidus_admin/importmap"
-  require "solidus_admin/main_nav_item"
+  require "solidus_admin/menu_item"
   require "solidus_admin/preview"
-  require "solidus_admin/tailwindcss"
 
   require "solidus_admin/configuration"
   require "solidus_admin/engine"

data/lib/tasks/tailwind.rake

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+namespace :solidus_admin do
+  namespace :tailwindcss do
+    desc 'Install Tailwind CSS on the host application'
+    task :install do
+      system "#{RbConfig.ruby} ./bin/rails app:template LOCATION='#{__dir__}/../solidus_admin/install_tailwindcss.rb'"
+    end
+  end
+end

data/solidus_admin.gemspec

@@ -19,17 +19,16 @@ Gem::Specification.new do |s|
 
   s.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(spec|script)/})
-  end
+  end + ["app/assets/builds/solidus_admin/tailwind.css"]
 
   s.required_ruby_version = '>= 3.0.0'
   s.required_rubygems_version = '>= 1.8.23'
 
   s.add_dependency 'geared_pagination', '~> 1.1'
   s.add_dependency 'importmap-rails', '~> 1.2', '>= 1.2.1'
-  s.add_dependency 'solidus_backend', Spree.solidus_gem_version.approximate_recommendation
-  s.add_dependency 'solidus_core', Spree.solidus_gem_version.approximate_recommendation
+  s.add_dependency 'solidus_backend'
+  s.add_dependency 'solidus_core', '> 4.2'
   s.add_dependency 'stimulus-rails', '~> 1.2'
-  s.add_dependency 'tailwindcss-rails', '~> 2.0'
   s.add_dependency 'turbo-rails', '~> 1.4'
   s.add_dependency 'view_component', '~> 3.3'
 end