spree_admin 5.0.0.rc1 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c46d7797c6b7f96882ad96c43ea5a208adeca65c74816b1541a4eec33c6dbdd7
-  data.tar.gz: 51593866ea9184c76e644c9e87691b94e183ea9bab9d50df371f97bc6a53ae59
+  metadata.gz: d55b4e39523cee4652dddb953445f27d15190d2cff8e40d3f012329c3e3612ec
+  data.tar.gz: e919c13188d0b35f8c17afaa52fd6e26ea2eae5713e2f5c7d2abb81ea7b7cb9e
 SHA512:
-  metadata.gz: ab791c77bbf7061f800a622f19242dfea2ff77d5e11e6fca722ce06239462f7160bda2bfe31b983ef6fc440b0e9caa36802a986574a9c2ab7fee8dc50ab6b281
-  data.tar.gz: 850bd370e9ec8cc75cf0017d6c866ea7f45c116e33d737977217a6c1e61070e5b2edb9f1275d23cca355cc190ad2c60d17cbf6d57baf49cebd82a6fd49e11303
+  metadata.gz: f7534f9a249beb83294f14d274920f12d7eb55504951365b0511e1efd980040a4811ffb9261af1aaf8074a60afb564176aa654c321bf771da211f629862e1281
+  data.tar.gz: 50b9265c84d615cade73af58b1af47ff41c043394ac10f9475d1a5cfdaf1398cf3bd274be2880264d846ad15e0ff9701e7b883cf1839b99eef34e198779db873

data/app/assets/stylesheets/spree/admin/components/_bulk_panel.scss

@@ -5,6 +5,9 @@
   background-color: $white;
   padding: 0.5rem;
   box-shadow: $dropdown-box-shadow;
+  animation: bounceInUp;
+  animation-duration: 0.5s;
+  gap: 0.75rem;
 }
 
 #bulk-panel {
@@ -28,4 +31,11 @@
     left: 16.66666667%;
     width: 83.33333333%;
   }
-}
+}
+
+.bulk-operations-counter {
+  display: inline-flex;
+  align-items: center;
+  justify-content: center;
+  gap: 0.25rem;
+}

data/app/assets/stylesheets/spree/admin/components/_cards.scss

@@ -60,12 +60,11 @@
 }
 
 .card-lg {
-  @extend .mb-3;
-  @extend .bg-white;
-
+  margin-bottom: 1rem;
+  background-color: $white;
   border-radius: $border-radius-lg;
   border: 1px solid $card-border-color;
-  padding: 1rem;
+  padding: 0;
 }
 
 .card-text {

data/app/assets/stylesheets/spree/admin/components/_dropdowns.scss

@@ -26,7 +26,6 @@
   box-shadow: $dropdown-box-shadow;
 
   .dropdown-item, .dropdown-header {
-    margin-bottom: 0.25rem;
     padding-left: $input-btn-padding-x;
     padding-right: $input-btn-padding-x;
     padding-top: $input-btn-padding-y;
@@ -34,6 +33,7 @@
   }
 
   .dropdown-item {
+    margin-bottom: 0.25rem;
     border-radius: $border-radius;
     display: flex;
     align-items: center;

data/app/assets/stylesheets/spree/admin/components/_main.scss

@@ -54,26 +54,35 @@ turbo-frame[loading] .spinner-border, turbo-frame[busy] .spinner-border {
     border-radius: $border-radius;
     display: flex;
     align-items: center;
-    padding-left: 0.5rem;
-    padding-right: 0.5rem;
+    padding-left: 0.35rem;
+    padding-right: 0.35rem;
     padding-top: 0.35rem;
     padding-bottom: 0.35rem;
 
     .ti {
       font-size: 1rem;
       margin-right: 0.5rem;
+      border-radius: $border-radius-sm;
+      padding: 0.2rem 0.2rem;
     }
 
     &:hover {
-      background-color: $gray-75;
+      background-color: $gray-50;
     }
     &.active {
       color: theme-color('primary');
-      background-color: $gray-100;
+      background-color: $white;
+      box-shadow: rgba(0, 0, 0, 0) 0px 0px 0px 0px, rgba(0, 0, 0, 0) 0px 0px 0px 0px, rgba(0, 0, 0, 0.05) 0px 0px 0px 1px, rgba(0, 0, 0, 0.05) 0px 1px 2px -1px, rgba(0, 0, 0, 0.02) 0px 2px 4px 0px;
       font-weight: 500;
+
+      .ti {
+        background-color: theme-color('primary');
+        color: $white;
+        box-shadow: rgba(0, 0, 0, 0) 0px 0px 0px 0px, rgba(0, 0, 0, 0) 0px 0px 0px 0px, rgba(0, 0, 0, 0.05) 0px 0px 0px 1px, rgba(0, 0, 0, 0.05) 0px 1px 2px -1px, rgba(0, 0, 0, 0.02) 0px 2px 4px 0px;
+      }
     }
 
-    .badge {
+    .badge:not(.badge-info) {
       @extend .badge-light;
     }
   }
@@ -96,6 +105,7 @@ turbo-frame[loading] .spinner-border, turbo-frame[busy] .spinner-border {
       &.active, &:active, &:focus {
         font-weight: 600;
         background-color: transparent !important;
+        box-shadow: none;
       }
     }
   }
@@ -146,3 +156,10 @@ turbo-frame[loading] .spinner-border, turbo-frame[busy] .spinner-border {
     top: 0.5rem;
   }
 }
+
+.documentation-link-container {
+  font-size: $font-size-sm;
+  text-align: center;
+  margin-top: 2rem;
+  color: $gray-400;
+}

data/app/assets/stylesheets/spree/admin/components/_modals.scss

@@ -25,7 +25,7 @@ body.modal-open {
 }
 .modal-footer {
   display: flex;
-  justify-content: flex-end;
+  justify-content: space-between;
   padding: $modal-inner-padding;
   background-color: #FAFAFA;
   border-top: 1px solid $gray-50;

data/app/assets/stylesheets/spree/admin/global/_variables.scss

@@ -21,13 +21,16 @@ $black: #000000 !default;
 $blue: #0077ff !default;
 $white: #FFFFFF !default;
 
+$action: #f1faff !default;
+$action-border: #e2ecff !default;
+
 $theme-colors: (
   "white": $white,
   "black": $black,
   "primary": $primary,
   "secondary": rgba($blue, 0.1),
-  "action": #f1faff,
-  "action-border": #e2ecff,
+  "action": $action,
+  "action-border": $action-border,
   "active": $gray-25,
   "partial": #E2E8F0,
   "warning": #ffe17d,
@@ -67,6 +70,9 @@ $border-color: $gray-100 !default;
 $input-border-color: $gray-100 !default;
 $list-group-border-color: $border-color !default;
 $list-group-hover-bg: $gray-25 !default;
+$list-group-active-bg: $action !default;
+$list-group-active-border-color: $action-border !default;
+
 $thumbnail-border-color: $gray-100 !default;
 $hr-border-color: $border-color !default;
 $table-border-color: $gray-50 !default;

data/app/assets/stylesheets/spree/admin/shared/_base.scss

@@ -671,4 +671,15 @@ div.uppy-Root {
 
 .tooltip-inner {
   box-shadow: $dropdown-box-shadow;
-}
+}
+
+.avatar {
+  border-radius: 50%;
+  background-color: $gray-200;
+  color: $gray-500;
+  font-size: 1rem;
+  font-weight: 500;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+}

data/app/controllers/spree/admin/dashboard_controller.rb

@@ -83,7 +83,10 @@ module Spree
 
         product_ids = line_items_grouped.map(&:variant_product_id).uniq.compact
 
-        return if product_ids.empty?
+        if product_ids.empty?
+          @top_products = []
+          return
+        end
 
         products = current_store.products.with_deleted.includes(:master, :variants).where(id: product_ids)
 

data/app/controllers/spree/admin/products_controller.rb

@@ -68,10 +68,7 @@ module Spree
           # update the product again
           @product.slug = @product.slug_was if @product.slug.blank?
           invoke_callbacks(:update, :fails)
-          respond_to do |format|
-            format.html { render :edit, status: :unprocessable_entity }
-            format.turbo_stream
-          end
+          render :edit, status: :unprocessable_entity
         end
       end
 
@@ -294,10 +291,6 @@ module Spree
 
       private
 
-      def update_turbo_stream_enabled?
-        true
-      end
-
       def variant_stock_includes
         [:images, { stock_items: :stock_location, option_values: :option_type }]
       end

data/app/controllers/spree/admin/storefront_controller.rb

@@ -26,7 +26,7 @@ module Spree
           :meta_description, :meta_title, :meta_keywords, :seo_robots,
           :facebook, :twitter, :instagram, :linkedin, :youtube, :tiktok, :pinterest,
           :storefront_custom_code_head, :storefront_custom_code_body_start,
-          :storefront_custom_code_body_end
+          :storefront_custom_code_body_end, :storefront_password
         )
       end
 

data/app/controllers/spree/admin/translations_controller.rb

@@ -66,7 +66,7 @@ module Spree
           @back_path = spree.edit_admin_taxonomy_path(@resource)
         when Spree::Store
           @resource_name = @resource.name
-          @back_path = spree.edit_admin_store_path(@resource, section: "general-settings")
+          @back_path = spree.edit_admin_store_path(section: "general-settings")
         end
       end
     end

data/app/helpers/spree/admin/base_helper.rb

@@ -3,6 +3,12 @@ module Spree
     module BaseHelper
       include Spree::ImagesHelper
 
+      def render_admin_partials(section, options = {})
+        Rails.application.config.spree_admin.send(section).map do |partial|
+          render partial, options
+        end.join.html_safe
+      end
+
       def enterprise_edition?
         defined?(Vendo)
       end
@@ -15,37 +21,64 @@ module Spree
         @spree_update_available ||= !Rails.env.test? && spree_updater.update_available?
       end
 
+      # check if the current controller is a settings controller
+      # this is used to display different sidebar navigation for settings pages
+      # @return [Boolean]
       def settings_active?
-        %w[stores zones shipping_methods oauth_applications
-           payment_methods refund_reasons reimbursement_types
-           shipping_categories store_credit_categories
-           syncs tax_categories tax_rates webhooks accounts
-           custom_domains audits exports imports return_authorization_reasons
-           documents stripe_tax_registrations members subscriptions stock_locations webhooks_subscribers].include?(controller_name)
+        @settings_active || %w[stores zones shipping_methods oauth_applications
+                               payment_methods refund_reasons reimbursement_types
+                               shipping_categories store_credit_categories
+                               syncs tax_categories tax_rates webhooks accounts
+                               custom_domains audits exports imports return_authorization_reasons
+                               documents stripe_tax_registrations members subscriptions stock_locations webhooks_subscribers].include?(controller_name)
       end
 
+      # @return [Array<String>] the available countries for checkout
       def available_countries_iso
         @available_countries_iso ||= current_store.countries_available_for_checkout.pluck(:iso)
       end
 
-      def avatar_url_for(user)
+      # render an avatar for a user
+      # if user doesn't have an avatar, the user's initials will be displayed on a rounded background
+      # @param user [Spree::User] the user to render the avatar for
+      # @param options [Hash] the options for the avatar
+      # @option options [Integer] :width the width of the avatar, default: 128
+      # @option options [Integer] :height the height of the avatar, default: 128
+      # @option options [String] :class the CSS class(es) of the avatar, default: 'avatar'
+      # @return [String] the avatar
+      def render_avatar(user, options = {})
         return unless user.present?
 
+        options[:width] ||= 128
+        options[:height] ||= 128
+        options[:class] ||= 'avatar'
+
         if user.respond_to?(:avatar) && user.avatar.attached? && user.avatar.variable?
-          main_app.cdn_image_url(
-            user.avatar.variant(spree_image_variant_options(resize_to_fill: [128, 128]))
+          spree_image_tag(
+            user.avatar,
+            width: options[:width],
+            height: options[:height],
+            class: options[:class],
+            style: "width: #{options[:width]}px; height: #{options[:height]}px;"
           )
         else
-          "https://eu.ui-avatars.com/api/?name=#{user.name&.initials}&background=random"
+          content_tag(:div, user.name&.initials, class: options[:class], style: "width: #{options[:width]}px; height: #{options[:height]}px;")
         end
       end
 
+      # returns the available display on options, eg backend, frontend, both
+      # @return [Array<Array<String, String>>] the available display on options
       def display_on_options
         Spree::DisplayOn::DISPLAY.map do |display_on|
           [Spree.t("admin.display_on_options.#{display_on}"), display_on]
         end
       end
 
+      # render an error message for a form field
+      # @param object [Spree::Model] the object to render the error message for
+      # @param method [String] the method to render the error message for
+      # @param options [Hash] the options for the error message
+      # @return [String] the error message
       def error_message_on(object, method, _options = {})
         object = convert_to_model(object)
         obj = object.respond_to?(:errors) ? object : instance_variable_get("@#{object}")
@@ -58,6 +91,10 @@ module Spree
         end
       end
 
+      # render an icon, using the tabler icons library
+      # @param icon_name [String] the name of the icon, eg: 'pencil', see: https://tabler.io/icons
+      # @param options [Hash] the options for the icon
+      # @return [String] the icon
       def icon(icon_name, options = {})
         if icon_name.ends_with?('.svg')
           icon_name = File.basename(icon_name, File.extname(icon_name))
@@ -77,42 +114,19 @@ module Spree
         content_tag :i, nil, class: "ti ti-#{icon_name} #{options[:class]}", style: styles
       end
 
+      # returns the flag emoji for a country
+      # @param iso [String] the ISO code of the country
+      # @return [String] the flag emoji
       def flag_emoji(iso)
         ::Country.new(iso).emoji_flag
       end
 
-      def preference_field_tag(name, value, options)
-        if options[:key] == :currency
-          return select_tag(
-            name,
-            currency_options_for_select(
-              value,
-              current_store.supported_currencies.split(',')
-            ),
-            class: 'custom-select',
-            disabled: current_store.supported_currencies.split(',').count == 1
-          )
-        end
-
-        case options[:type]
-        when :integer
-          number_field_tag(name, value, preference_field_options(options))
-        when :decimal
-          number_field_tag(name, value, preference_field_options(options))
-        when :boolean
-          hidden_field_tag(name, 0, id: "#{name}_hidden") +
-            check_box_tag(name, 1, value, preference_field_options(options))
-        when :string
-          text_field_tag(name, value, preference_field_options(options))
-        when :password
-          password_field_tag(name, value, preference_field_options(options))
-        when :text
-          text_area_tag(name, value, preference_field_options(options))
-        else
-          text_field_tag(name, value, preference_field_options(options))
-        end
-      end
-
+      # render a form field for a preference, according to the type of the preference (number, decimal, boolean, string, password, text)
+      # see https://spreecommerce.org/docs/developer/customization/model-preferences
+      # @param form [ActionView::Helpers::FormBuilder] the form builder
+      # @param field [String] the name of the field
+      # @param options [Hash] the options for the field
+      # @return [String] the preference field
       def preference_field_for(form, field, options)
         case options[:type]
         when :integer
@@ -132,6 +146,11 @@ module Spree
         end
       end
 
+      # returns the options for a preference field, according to the type of the preference (number, decimal, boolean, string, password, text)
+      # @param options [Hash] the options for the field
+      # @option options [Symbol] :type the type of the preference, eg. :integer, :decimal, :boolean, :string, :password, :text
+      # @option options [Boolean] :disabled whether the field is disabled
+      # @return [Hash] the options for the field
       def preference_field_options(options)
         field_options = case options[:type]
                         when :integer
@@ -177,6 +196,10 @@ module Spree
                              size: options[:size])
       end
 
+      # renders all the preference fields for an object
+      # @param object [Spree::TaxRate, Spree::Calculator, Spree::PaymentMethod, Spree::ShippingMethod, Spree::Store] the object to render the preference fields for
+      # @param form [ActionView::Helpers::FormBuilder] the form builder
+      # @return [String] the preference fields
       def preference_fields(object, form)
         return unless object.respond_to?(:preferences)
 
@@ -213,31 +236,14 @@ module Spree
         dom_id(record, 'spree')
       end
 
+      # renders a red dot with a * to indicate that a field is required
+      # @return [String] the required span tag
       def required_span_tag
         content_tag(:span, ' *', class: 'required font-weight-bold text-danger')
       end
 
-      def external_page_preview_link(resource, options = {})
-        resource_name = options[:name] || resource.class.name.demodulize
-
-        url = if [Spree::Product, Spree::Post].include?(resource.class)
-                spree_storefront_resource_url(resource, preview_id: resource.id)
-              else
-                spree_storefront_resource_url(resource)
-              end
-
-        link_to_with_icon(
-          'eye',
-          Spree.t('admin.utilities.preview', name: resource_name),
-          url,
-          class: 'text-left dropdown-item', id: "adminPreview#{resource_name}", target: :blank, data: { turbo: false }
-        )
-      end
-
-      def path_from_url(url)
-        url.to_s.gsub('https://', '').gsub('http://', '')
-      end
-
+      # returns the allowed file types for upload, according to the active storage configuration
+      # @return [Array<String>] the allowed file types for upload, eg. ['image/png', 'image/jpeg', 'image/gif', 'image/webp']
       def allowed_file_types_for_upload
         Rails.application.config.active_storage.web_image_content_types
       end

data/app/helpers/spree/admin/bulk_operations_helper.rb

@@ -0,0 +1,86 @@
+module Spree
+  module Admin
+    module BulkOperationsHelper
+      # render a checkbox to select all items for bulk operations
+      # @return [String]
+      def bulk_operations_select_all_checkbox
+        content_tag :div, class: "custom-control custom-checkbox ml-1" do
+          check_box_tag(
+            nil,
+            nil,
+            false,
+            id: "checkAllMasterCheckbox",
+            class: "custom-control-input",
+            data: { bulk_operation_target: "checkboxAll" }
+          ) +
+          content_tag(:label, content_tag(:span, ""), class: "custom-control-label", for: "checkAllMasterCheckbox")
+        end
+      end
+
+      # render a checkbox to select an item for bulk operations
+      # @param object [Spree::Product, Spree::User, Spree::Order]
+      # @return [String]
+      def bulk_operations_checkbox(object)
+        content_tag :div, class: "custom-control custom-checkbox ml-1" do
+          check_box_tag(
+            "ids[]",
+            object.id,
+            false,
+            class: "custom-control-input",
+            id: "ids_#{object.id}",
+            data: { bulk_operation_target: "checkbox" }
+          ) +
+          content_tag(:label, content_tag(:span, ""), class: "custom-control-label", for: "ids_#{object.id}")
+        end
+      end
+
+      # render a link to perform a bulk action
+      # @param text [String] the text of the link
+      # @param path [String] the path of the link
+      # @param options [Hash] the options of the link
+      # @option options [String] :icon the icon of the link
+      # @option options [String] :url the url to perform the bulk action to be set for the form in bulk modal
+      # @option options [String] :class the class of the link
+      # @option options [String] :data the data of the link
+      # @return [String]
+      def bulk_action_link(text, path, options = {})
+        options[:data] ||= {}
+        options[:data][:action] ||= 'click->bulk-operation#setBulkAction'
+        options[:data][:turbo_frame] ||= :bulk_modal
+        options[:data][:url] ||= options[:url]
+        options[:class] ||= 'btn btn-light'
+
+        if options[:icon]
+          text = icon(options[:icon]) + ' ' + text
+        end
+
+        content_tag :span, data: { toggle: 'modal', target: '#bulk-modal' } do
+          link_to text, path, options
+        end
+      end
+
+      # render a close button for the bulk modal
+      def bulk_operations_close_button
+        button_tag(
+          '',
+          type: 'button',
+          class: 'btn-close',
+          data: {
+            dismiss: 'modal',
+            aria_label: Spree.t(:close),
+            action: 'bulk-operation#cancel'
+          }
+        )
+      end
+
+      # render a counter for the bulk operations
+      # @return [String]
+      def bulk_operations_counter
+        content_tag(:span, class: 'bulk-operations-counter ml-1') do
+          content_tag(:strong, '', data: { bulk_operation_target: 'counter' }) +
+          Spree.t("admin.selected")
+        end
+      end
+    end
+  end
+end

data/app/helpers/spree/admin/modal_helper.rb

@@ -0,0 +1,29 @@
+module Spree
+  module Admin
+    module ModalHelper
+      # render a header for the modal
+      # @param title [String, Proc] the title of the modal
+      # @return [String]
+      def modal_header(title)
+        title = capture(&title) if block_given?
+        content_tag(:div, class: 'modal-header') do
+          content_tag(:h5, title, class: 'modal-title') + modal_close_button
+        end.html_safe
+      end
+
+      # render a close button for the modal
+      # @return [String]
+      def modal_close_button
+        button_tag('', type: 'button', class: 'btn-close', data: { dismiss: 'modal', aria_label: Spree.t(:close) }).html_safe
+      end
+
+      # render a discard button for the modal
+      # @return [String]
+      def modal_discard_button
+        button_tag(type: 'button', class: 'btn btn-light', data: { dismiss: 'modal' }) do
+          Spree.t('actions.discard')
+        end.html_safe
+      end
+    end
+  end
+end