solidus_admin 0.3.1 → 0.3.2

data/app/components/solidus_admin/base_component.rb

@@ -10,7 +10,7 @@ module SolidusAdmin
     include Turbo::FramesHelper
 
     def icon_tag(name, **attrs)
-      render component("ui/icon").new(name: name, **attrs)
+      render component("ui/icon").new(name:, **attrs)
     end
 
     def missing_translation(key, options)
@@ -25,6 +25,10 @@ module SolidusAdmin
       end
     end
 
+    def self.i18n_scope
+      @i18n_scope ||= name.underscore.tr("/", ".")
+    end
+
     def self.stimulus_id
       @stimulus_id ||= name.underscore
         .sub(/^solidus_admin\/(.*)\/component$/, '\1')
@@ -34,12 +38,22 @@ module SolidusAdmin
 
     delegate :stimulus_id, to: :class
 
-    def spree
-      @spree ||= Spree::Core::Engine.routes.url_helpers
+    class << self
+      private
+
+      def engines_with_routes
+        Rails::Engine.subclasses.map(&:instance).reject do |engine|
+          engine.routes.empty?
+        end
+      end
     end
 
-    def solidus_admin
-      @solidus_admin ||= SolidusAdmin::Engine.routes.url_helpers
+    # For each engine with routes, define a method that returns the routes proxy.
+    # This allows us to use the routes in the context of a component class.
+    engines_with_routes.each do |engine|
+      define_method(engine.engine_name) do
+        engine.routes.url_helpers
+      end
     end
   end
 end

data/app/components/solidus_admin/layout/navigation/account/component.rb

@@ -11,7 +11,7 @@ class SolidusAdmin::Layout::Navigation::Account::Component < SolidusAdmin::BaseC
   def locale_options_for_select(available_locales)
     available_locales.map do |locale|
       [
-        t("spree.i18n.this_file_language", locale: locale, default: locale.to_s, fallback: false),
+        t("spree.i18n.this_file_language", locale:, default: locale.to_s, fallback: false),
         locale,
       ]
     end.sort
@@ -27,7 +27,7 @@ class SolidusAdmin::Layout::Navigation::Account::Component < SolidusAdmin::BaseC
         block_given? ? capture(&block) : nil,
         tag.label(safe_join([
           icon_tag(icon, class: "w-full max-w-[20px] h-5 fill-current shrink"),
-          tag.select(options, name: name, onchange: "this.form.requestSubmit()", class: "w-full appearance-none grow bg-transparent outline-none"),
+          tag.select(options, name:, onchange: "this.form.requestSubmit()", class: "w-full appearance-none grow bg-transparent outline-none"),
           icon_tag("expand-up-down-line", class: "w-full max-w-[20px] h-5 fill-current shrink"),
         ]), class: "flex gap-2 items-center px-2"),
       ])

data/app/components/solidus_admin/layout/navigation/component.rb

@@ -9,7 +9,7 @@ class SolidusAdmin::Layout::Navigation::Component < SolidusAdmin::BaseComponent
     @logo_path = logo_path
     @items = items.map do |attrs|
       children = attrs[:children].to_a.map { SolidusAdmin::MenuItem.new(**_1, top_level: false) }
-      SolidusAdmin::MenuItem.new(**attrs, children: children, top_level: true)
+      SolidusAdmin::MenuItem.new(**attrs, children:, top_level: true)
     end
     @store = store
   end

data/app/components/solidus_admin/layout/navigation/item/component.html.erb

@@ -1,7 +1,7 @@
 <li class="group <%= "active" if active? %>">
   <a
     href="<%= path %>"
-    aria-current="<%= @item.current?(@url_helpers, @fullpath) ? "page" : "false" %>"
+    aria-current="<%= @item.current?(self, @fullpath) ? "page" : "false" %>"
     class="
       flex gap-3 items-center
       py-1 px-3 rounded
@@ -20,7 +20,7 @@
 
   <% if @item.children? %>
     <ul class="flex flex-col gap-0.5 pt-0.5 <%= "hidden" unless active? %>">
-      <%= render self.class.with_collection(@item.children, url_helpers: @url_helpers, fullpath: @fullpath) %>
+      <%= render self.class.with_collection(@item.children, fullpath: @fullpath) %>
     </ul>
   <% end %>
 </li>

data/app/components/solidus_admin/layout/navigation/item/component.rb

@@ -6,22 +6,19 @@ class SolidusAdmin::Layout::Navigation::Item::Component < SolidusAdmin::BaseComp
 
   # @param item [SolidusAdmin::MenuItem]
   # @param fullpath [String] the current path
-  # @param url_helpers [#solidus_admin, #spree] context for generating paths
   def initialize(
     item:,
-    fullpath: "#",
-    url_helpers: Struct.new(:spree, :solidus_admin).new(spree, solidus_admin)
+    fullpath: "#"
   )
     @item = item
-    @url_helpers = url_helpers
     @fullpath = fullpath
   end
 
   def path
-    @item.path(@url_helpers)
+    @item.path(self)
   end
 
   def active?
-    @item.active?(@url_helpers, @fullpath)
+    @item.active?(self, @fullpath)
   end
 end

data/app/components/solidus_admin/orders/index/component.rb

@@ -124,7 +124,7 @@ class SolidusAdmin::Orders::Index::Component < SolidusAdmin::UI::Pages::Index::C
           'canceled' => :blue,
           'cart' => :graphite_light,
         }[order.state] || :yellow
-        component('ui/badge').new(name: order.state.humanize, color: color)
+        component('ui/badge').new(name: order.state.humanize, color:)
       end
     }
   end

data/app/components/solidus_admin/orders/show/adjustments/index/adjustable/component.rb

@@ -10,7 +10,7 @@ class SolidusAdmin::Orders::Show::Adjustments::Index::Adjustable::Component < So
   end
 
   def call
-    render component("ui/thumbnail_with_caption").new(caption: caption, detail: detail) do
+    render component("ui/thumbnail_with_caption").new(caption:, detail:) do
       thumbnail
     end
   end

data/app/components/solidus_admin/orders/show/adjustments/index/source/component.rb

@@ -10,7 +10,7 @@ class SolidusAdmin::Orders::Show::Adjustments::Index::Source::Component < Solidu
   end
 
   def call
-    render component("ui/thumbnail_with_caption").new(icon: icon, caption: caption, detail: detail)
+    render component("ui/thumbnail_with_caption").new(icon:, caption:, detail:)
   end
 
   def caption

data/app/components/solidus_admin/products/status/component.rb

@@ -20,7 +20,7 @@ class SolidusAdmin::Products::Status::Component < SolidusAdmin::BaseComponent
         :unavailable
       end
 
-    new(status: status)
+    new(status:)
   end
 
   def initialize(status:)

data/app/components/solidus_admin/stock_items/index/component.rb

@@ -138,7 +138,7 @@ class SolidusAdmin::StockItems::Index::Component < SolidusAdmin::UI::Pages::Inde
         count = stock_movement_counts[_1.id] || 0
 
         link_to(
-          "#{count} #{Spree::StockMovement.model_name.human(count: count).downcase}",
+          "#{count} #{Spree::StockMovement.model_name.human(count:).downcase}",
           spree.admin_stock_location_stock_movements_path(
             _1.stock_location.id,
             q: { variant_sku_eq: _1.variant.sku },

data/app/components/solidus_admin/stock_locations/index/component.rb

@@ -57,7 +57,7 @@ class SolidusAdmin::StockLocations::Index::Component < SolidusAdmin::Shipping::C
           color = _1.active? ? :green : :graphite_light
           text = _1.active? ? t('.active') : t('.inactive')
 
-          component('ui/badge').new(name: text, color: color)
+          component('ui/badge').new(name: text, color:)
         },
       },
       {
@@ -78,7 +78,7 @@ class SolidusAdmin::StockLocations::Index::Component < SolidusAdmin::Shipping::C
           count = _1.stock_movements.count
 
           link_to(
-            "#{count} #{Spree::StockMovement.model_name.human(count: count).downcase}",
+            "#{count} #{Spree::StockMovement.model_name.human(count:).downcase}",
             spree.admin_stock_location_stock_movements_path(_1),
             class: 'body-link'
           )

data/app/components/solidus_admin/ui/forms/field/component.rb

@@ -18,14 +18,14 @@ class SolidusAdmin::UI::Forms::Field::Component < SolidusAdmin::BaseComponent
     object_name, object, label, errors = extract_form_details(form, object, method)
 
     new(
-      label: label,
-      hint: hint,
-      tip: tip,
+      label:,
+      hint:,
+      tip:,
       error: errors,
       input_attributes: {
         name: "#{object_name}[#{method}]",
         tag: :input,
-        size: size,
+        size:,
         value: object.public_send(method),
         error: (errors.to_sentence.capitalize if errors),
         **attributes,
@@ -37,15 +37,15 @@ class SolidusAdmin::UI::Forms::Field::Component < SolidusAdmin::BaseComponent
     object_name, object, label, errors = extract_form_details(form, object, method)
 
     new(
-      label: label,
-      hint: hint,
-      tip: tip,
+      label:,
+      hint:,
+      tip:,
       error: errors,
       input_attributes: {
         name: "#{object_name}[#{method}]",
         tag: :select,
-        choices: choices,
-        size: size,
+        choices:,
+        size:,
         value: object.public_send(method),
         error: (errors.to_sentence.capitalize if errors),
         **attributes,
@@ -57,13 +57,13 @@ class SolidusAdmin::UI::Forms::Field::Component < SolidusAdmin::BaseComponent
     object_name, object, label, errors = extract_form_details(form, object, method)
 
     new(
-      label: label,
-      hint: hint,
-      tip: tip,
+      label:,
+      hint:,
+      tip:,
       error: errors,
       input_attributes: {
         name: "#{object_name}[#{method}]",
-        size: size,
+        size:,
         tag: :textarea,
         value: object.public_send(method),
         error: (errors.to_sentence.capitalize if errors),
@@ -76,14 +76,14 @@ class SolidusAdmin::UI::Forms::Field::Component < SolidusAdmin::BaseComponent
     object_name, object, label, errors = extract_form_details(form, object, method)
 
     new(
-      label: label,
-      hint: hint,
-      tip: tip,
+      label:,
+      hint:,
+      tip:,
       error: errors,
     ).with_content(
       component('ui/forms/switch').new(
         name: "#{object_name}[#{method}]",
-        size: size,
+        size:,
         checked: object.public_send(method),
         include_hidden: true,
         **attributes,

data/app/components/solidus_admin/ui/icon/component.rb

@@ -23,7 +23,9 @@ class SolidusAdmin::UI::Icon::Component < SolidusAdmin::BaseComponent
   end
 
   def call
-    href = "#{image_path('solidus_admin/remixicon.symbol.svg')}#ri-#{@name}"
+    # bypass the asset_host configuration to avoid CORS issues with CDNs:
+    # https://github.com/solidusio/solidus/issues/5657
+    href = asset_path("solidus_admin/remixicon.symbol.svg#ri-#{@name}", host: "")
     tag.svg(tag.use("xlink:href": href), **@attrs)
   end
 end

data/app/components/solidus_admin/ui/pages/index/component.rb

@@ -61,8 +61,8 @@ class SolidusAdmin::UI::Pages::Index::Component < SolidusAdmin::BaseComponent
       value: search_params,
       url: search_url,
       searchbar_key: search_key,
-      filters: filters,
-      scopes: scopes,
+      filters:,
+      scopes:,
     }
   end
 
@@ -80,12 +80,12 @@ class SolidusAdmin::UI::Pages::Index::Component < SolidusAdmin::BaseComponent
       id: stimulus_id,
       data: {
         class: model_class,
-        rows: rows,
+        rows:,
         fade: -> { row_fade(_1) },
         prev: prev_page_path,
         next: next_page_path,
-        columns: columns,
-        batch_actions: batch_actions,
+        columns:,
+        batch_actions:,
         url: -> { row_url(_1) },
       },
       search: search_options,

data/app/components/solidus_admin/ui/table/component.rb

@@ -138,7 +138,7 @@ class SolidusAdmin::UI::Table::Component < SolidusAdmin::BaseComponent
       predicate: filter.predicate,
       options: filter.options,
       form: search_form_id,
-      index: index,
+      index:,
     )
   end
 

data/app/components/solidus_admin/ui/thumbnail_with_caption/component.rb

@@ -10,6 +10,6 @@ class SolidusAdmin::UI::ThumbnailWithCaption::Component < SolidusAdmin::BaseComp
   end
 
   def icon_thumbnail
-    render component("ui/thumbnail").new(icon: icon)
+    render component("ui/thumbnail").new(icon:)
   end
 end

data/app/components/solidus_admin/ui/toast/component.html.erb

@@ -8,7 +8,7 @@
   "
   data-controller="<%= stimulus_id %>"
   data-<%= stimulus_id %>-animation-class="translate-y-full opacity-0"
-  data-<%= stimulus_id %>-transition-value="500"
+  data-<%= stimulus_id %>-transition-value="<%= Rails.env.test? ? 1000 : 500 %>"
   role="dialog"
   aria-label="<%= t(".#{@scheme}_label") %>"
   aria-live="polite"

data/app/components/solidus_admin/users/index/component.rb

@@ -77,7 +77,7 @@ class SolidusAdmin::Users::Index::Component < SolidusAdmin::UsersAndRoles::Compo
               when 'customer' then :green
               else :graphite_light
               end
-            render component('ui/badge').new(name: _1.name, color: color)
+            render component('ui/badge').new(name: _1.name, color:)
           })
         end,
       },

data/app/components/solidus_admin/users/store_credits/index/component.html.erb

@@ -0,0 +1,49 @@
+<%= page do %>
+  <%= page_header do %>
+    <%= page_header_back(solidus_admin.users_path) %>
+    <%= page_header_title(t(".title", email: @user.email)) %>
+
+    <%= page_header_actions do %>
+      <%= render component("ui/button").new(tag: :a, text: t(".add_store_credit"), href: spree.new_admin_user_store_credit_url(user_id: @user.id, only_path: true)) %>
+    <% end %>
+  <% end %>
+
+  <%= page_header do %>
+    <% tabs.each do |tab| %>
+      <%= render(component("ui/button").new(tag: :a, scheme: :ghost, text: tab[:text], 'aria-current': tab[:current], href: tab[:href])) %>
+    <% end %>
+  <% end %>
+
+  <%= page_with_sidebar do %>
+    <%= page_with_sidebar_main do %>
+
+      <% if @store_credits.present? %>
+        <% @store_credits.group_by(&:currency).each do |currency, credits| %>
+          <% title = [t('spree.admin.store_credits.current_balance'), Spree::Money.new(credits.sum(&:amount_remaining), currency: currency)].join(" ") %>
+
+          <%= render component('ui/panel').new(title: title) do %>
+            <%= render component('ui/table').new(
+                id: stimulus_id,
+                data: {
+                  class: model_class,
+                  rows: credits,
+                  fade: -> (_order) { false },
+                  columns: columns,
+                  url: -> { row_url(_1) },
+                },
+            )%>
+          <% end %>
+        <% end %>
+      <% else %>
+        <%= render component('ui/panel').new(title: t(".store_credit")) do %>
+          <%= t(".no_credits_found") %>
+          <%= render component("ui/button").new(tag: :a, text: t(".create_one"), href: spree.new_admin_user_store_credit_url(user_id: @user.id, only_path: true)) %>
+        <% end %>
+      <% end %>
+    <% end %>
+
+    <%= page_with_sidebar_aside do %>
+      <%= render component("users/stats").new(user: @user) %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/components/solidus_admin/users/store_credits/index/component.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+class SolidusAdmin::Users::StoreCredits::Index::Component < SolidusAdmin::BaseComponent
+  include SolidusAdmin::Layout::PageHelpers
+
+  def initialize(user:, store_credits:)
+    @user = user
+    @store_credits = store_credits
+  end
+
+  def model_class
+    Spree::StoreCredit
+  end
+
+  def tabs
+    [
+      {
+        text: t('.account'),
+        href: solidus_admin.user_path(@user),
+        current: false,
+      },
+      {
+        text: t('.addresses'),
+        href: solidus_admin.addresses_user_path(@user),
+        current: false,
+      },
+      {
+        text: t('.order_history'),
+        href: solidus_admin.orders_user_path(@user),
+        current: false,
+      },
+      {
+        text: t('.items'),
+        href: spree.items_admin_user_path(@user),
+        current: false,
+      },
+      {
+        text: t('.store_credit'),
+        href: solidus_admin.store_credits_user_path(@user),
+        current: true,
+      },
+    ]
+  end
+
+  def rows
+    @store_credits
+  end
+
+  def row_url(store_credit)
+    spree.admin_user_store_credit_path(@user, store_credit)
+  end
+
+  def columns
+    [
+      {
+        header: :credited,
+        col: { class: "w-[12%]" },
+        data: ->(store_credit) do
+          content_tag :div, store_credit.display_amount.to_html, class: "text-sm"
+        end
+      },
+      {
+        header: :authorized,
+        col: { class: "w-[13%]" },
+        data: ->(store_credit) do
+          content_tag :div, store_credit.display_amount_authorized.to_html, class: "text-sm"
+        end
+      },
+      {
+        header: :used,
+        col: { class: "w-[9%]" },
+        data: ->(store_credit) do
+          content_tag :div, store_credit.display_amount_used.to_html, class: "text-sm"
+        end
+      },
+      {
+        header: :type,
+        col: { class: "w-[13%]" },
+        data: ->(store_credit) do
+          component('ui/badge').new(name: store_credit.credit_type.name, color: :blue)
+        end
+      },
+      {
+        header: :created_by,
+        col: { class: "w-[22%]" },
+        data: ->(store_credit) do
+          content_tag :div, store_credit.created_by_email, class: "font-semibold text-sm"
+        end
+      },
+      {
+        header: :issued_on,
+        col: { class: "w-[16%]" },
+        data: ->(store_credit) do
+          I18n.l(store_credit.created_at.to_date)
+        end
+      },
+      {
+        header: :invalidated,
+        col: { class: "w-[15%]" },
+        data: ->(store_credit) do
+          store_credit.invalidated? ? component('ui/badge').yes : component('ui/badge').no
+        end
+      },
+    ]
+  end
+end

data/app/components/solidus_admin/users/store_credits/index/component.yml

@@ -0,0 +1,12 @@
+en:
+  title: "Users / %{email} / Store Credit"
+  account: Account
+  addresses: Addresses
+  order_history: Order History
+  items: Items
+  store_credit: Store Credit
+  last_active: Last Active
+  add_store_credit: Add Store Credit
+  no_credits_found: No Store Credits found.
+  create_one: Create One
+  back: Back

data/app/controllers/solidus_admin/controller_helpers/search.rb

@@ -7,8 +7,8 @@ module SolidusAdmin::ControllerHelpers::Search
     def search_scope(name, default: false, &block)
       search_scopes << SearchScope.new(
         name: name.to_s,
-        block: block,
-        default: default,
+        block:,
+        default:,
       )
     end
 
@@ -20,8 +20,8 @@ module SolidusAdmin::ControllerHelpers::Search
   private
 
   def apply_search_to(relation, param:)
-    relation = apply_scopes_to(relation, param: param)
-    apply_ransack_search_to(relation, param: param)
+    relation = apply_scopes_to(relation, param:)
+    apply_ransack_search_to(relation, param:)
   end
 
   def apply_ransack_search_to(relation, param:)

data/app/controllers/solidus_admin/users_controller.rb

@@ -5,7 +5,7 @@ module SolidusAdmin
     include SolidusAdmin::ControllerHelpers::Search
     include Spree::Core::ControllerHelpers::StrongParameters
 
-    before_action :set_user, only: [:edit, :addresses, :update_addresses, :orders, :items]
+    before_action :set_user, only: [:edit, :addresses, :update_addresses, :orders, :items, :store_credits]
 
     search_scope(:all, default: true)
     search_scope(:customers) { _1.left_outer_joins(:role_users).where(role_users: { id: nil }) }
@@ -81,6 +81,14 @@ module SolidusAdmin
       redirect_back_or_to users_path, status: :see_other
     end
 
+    def store_credits
+      @store_credits = Spree::StoreCredit.where(user_id: @user.id).order(id: :desc)
+
+      respond_to do |format|
+        format.html { render component("users/store_credits/index").new(user: @user, store_credits: @store_credits) }
+      end
+    end
+
     private
 
     def set_user

data/config/routes.rb

@@ -51,6 +51,7 @@ SolidusAdmin::Engine.routes.draw do
       put :update_addresses
       get :orders
       get :items
+      get :store_credits
     end
   end
 

data/lib/generators/solidus_admin/install/install_generator.rb

@@ -38,6 +38,8 @@ module SolidusAdmin
           gem "actioncable"
         end
 
+        execute_command :bundle, :install
+
         route "mount Lookbook::Engine, at: '#{solidus_mount_point}lookbook' if Rails.env.development?"
       end
 

data/lib/solidus_admin/component_registry.rb

@@ -28,7 +28,7 @@ module SolidusAdmin
       prefix = "#{SolidusAdmin::Configuration::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(key.to_s)
+      corrections = DidYouMean::SpellChecker.new(dictionary:).correct(key.to_s)
 
       raise ComponentNotFoundError.new(
         "Unknown component #{key}#{DidYouMean.formatter.message_for(corrections)}",

data/lib/solidus_admin/configuration.rb

@@ -169,10 +169,10 @@ module SolidusAdmin
         {
           position: index,
           key: item.label,
-          icon: icon,
-          route: route,
+          icon:,
+          route:,
           children: item.children.map.with_index(&menu_item_to_hash),
-          match_path: match_path,
+          match_path:,
         }
       end
 

data/lib/solidus_admin/testing_support/feature_helpers.rb

@@ -19,7 +19,7 @@ module SolidusAdmin
       end
 
       def find_row(text)
-        find('table tbody tr', text: text)
+        find('table tbody tr', text:)
       end
 
       def find_row_checkbox(text)

data/lib/solidus_admin/version.rb

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

data/solidus_admin.gemspec

@@ -22,10 +22,10 @@ Gem::Specification.new do |s|
   s.metadata["changelog_uri"] = "https://github.com/solidusio/solidus/releases?q=%22solidus_admin%2Fv0%22&expanded=true"
 
   s.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(spec|script)/})
+    f.match(%r{^(spec|bin)/})
   end + ["app/assets/builds/solidus_admin/tailwind.css"]
 
-  s.required_ruby_version = '>= 3.0.0'
+  s.required_ruby_version = '>= 3.1.0'
   s.required_rubygems_version = '>= 1.8.23'
 
   s.add_dependency 'geared_pagination', '~> 1.1'