spree_admin 5.0.0 → 5.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a3f2875dd028cc2a4d3dc3fb9933583918ff856afe242193a4c784bae6af84f
-  data.tar.gz: 9b3ec33e0fbc122fa9915fb5f0199c2ec79e249f9291429713c6d7e5dd89e2b8
+  metadata.gz: 1fb2e27934e0ce22324b5a7c032fbeb7d0abf76d3512f726dd0acddc30a217dc
+  data.tar.gz: 3caabc53934c4c0bdbd2b70bfea5dcaa9685eb3acb9a2d2bcebcc362c4807e73
 SHA512:
-  metadata.gz: 42d85993653cd2792a7ee9bb052da3a5dfab181415fb2362c73fd09f33acc46a4ed6253d81fcdbb3d61320ca14ca4d5fa5eb92f5080e292a179f397778dcfc1a
-  data.tar.gz: cadca2e5fa570bf58c8de527f4702e9623e0ad3a3861a030404838a9ae3e1186d23cdd071dea58d3fe5222faf5a3d90f49cd095e767ea08b870f28cb21921944
+  metadata.gz: ffb8d7703b134adf2439b7f035557930448883896f6e4a07daea768de52847d13dc0ed7ca8cb37fc1e38e0df637b7fcbfb54cc3d7e13fdf03adc23493714e33a
+  data.tar.gz: 88f4985f3985761932f2e341ed62085658c925a18244718bb14ffc729b3074cc9d726fa8419c70af12a3da77e9a624f39d3bba5841b4d759a03a1cb8abaad994

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

@@ -31,13 +31,16 @@
 }
 
 .alert-danger {
-  background-color: #f8d7da;
-  border-color: rgba($danger, 0.3) !important;
-
+  background-color: #FEF2F2;
+  border-color: #FBE3E3;
+  color: #450A09;
   background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%23dc2626' stroke-width='2' stroke-linecap='round' stroke-linejoin='round' class='icon icon-tabler icons-tabler-outline icon-tabler-exclamation-circle'%3E%3Cpath stroke='none' d='M0 0h24v24H0z' fill='none'/%3E%3Cpath d='M12 12m-9 0a9 9 0 1 0 18 0a9 9 0 1 0 -18 0' /%3E%3Cpath d='M12 9v4' /%3E%3Cpath d='M12 16v.01' /%3E%3C/svg%3E");
 }
 
 .alert-success {
+  background-color: #ECFDF5;
+  color: #092E26;
+  border-color: #D5F9E6;
   background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%2310b981' stroke-width='2' stroke-linecap='round' stroke-linejoin='round' class='icon icon-tabler icons-tabler-outline icon-tabler-check-circle'%3E%3Cpath stroke='none' d='M0 0h24v24H0z' fill='none'/%3E%3Cpath d='M12 12m-9 0a9 9 0 1 0 18 0a9 9 0 1 0 -18 0' /%3E%3Cpath d='M9 12l2 2l4 -4' /%3E%3C/svg%3E");
 }
 

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

@@ -82,7 +82,7 @@ turbo-frame[loading] .spinner-border, turbo-frame[busy] .spinner-border {
       }
     }
 
-    .badge {
+    .badge:not(.badge-info) {
       @extend .badge-light;
     }
   }
@@ -156,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

@@ -18,16 +18,19 @@ $light: $gray-50 !default;
 
 $primary: #061932 !default;
 $black: #000000 !default;
-$blue: #0077ff !default;
+$blue: #0090FE !default;
 $white: #FFFFFF !default;
 
+$action: #F4F9FF !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;
@@ -98,11 +104,11 @@ $box-shadow: 0 4px 6px -1px rgba(0, 0, 0, 0.1),0 2px 4px -1px rgba(0, 0, 0, 0.06
 $box-shadow-xs: rgba(43, 34, 51, 0.04) 0px 1px 2px !default;
 $box-shadow-lg: rgba(0, 5, 13, 0.5) 0px 4px 8px 2px;
 
-$tooltip-border-radius: $border-radius-sm !default;
+$tooltip-border-radius: $border-radius !default;
 $tooltip-opacity: 1 !default;
 $tooltip-margin:                    0.25rem 0 !default;
-$tooltip-padding-y:                 .5rem !default;
-$tooltip-padding-x:                 .75rem !default;
+$tooltip-padding-y:                 .25rem !default;
+$tooltip-padding-x:                 .5rem !default;
 $tooltip-bg: $white !default;
 $tooltip-color: $body-color !default;
 $tooltip-arrow-color: transparent !default;

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

@@ -1,10 +1,7 @@
 // https://twitter.com/NatalieMarleny/status/1662402066365526016
 html {
   min-height: 100%;
-  font-feature-settings: "kern";
-  font-optical-sizing: auto;
-  font-style: normal;
-  font-variation-settings: "slnt" 0;
+  letter-spacing: normal;
 }
 body {
   @extend .h-100;
@@ -670,7 +667,8 @@ div.uppy-Root {
 }
 
 .tooltip-inner {
-  box-shadow: $dropdown-box-shadow;
+  border: 1px solid $gray-100;
+  box-shadow: $box-shadow-xs;
 }
 
 .avatar {

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

@@ -1,6 +1,8 @@
 module Spree
   module Admin
     class PostsController < ResourceController
+      before_action :load_post_categories
+
       def select_options
         render json: current_store.posts.published.to_tom_select_json
       end
@@ -18,6 +20,10 @@ module Spree
         @search = @collection.ransack(params[:q])
         @collection = @search.result.page(params[:page]).per(params[:per_page])
       end
+
+      def load_post_categories
+        @post_categories = current_store.post_categories.accessible_by(current_ability).order(:title)
+      end
     end
   end
 end

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

@@ -15,6 +15,7 @@ module Spree
       before_action :prepare_product_params, only: [:create, :update]
       before_action :strip_stock_items_param, only: [:create, :update]
       before_action :ensure_session_uploaded_assets_uuid, only: :new
+      before_action :check_slug_availability, only: [:create, :update]
 
       new_action.before :build_master_prices
       new_action.before :build_master_stock_items
@@ -68,10 +69,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 +292,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
@@ -361,6 +355,11 @@ module Spree
           variant_images: [],
         }
       end
+
+      def check_slug_availability
+        new_slug = permitted_resource_params[:slug]
+        permitted_resource_params[:slug] = @product.ensure_slug_is_unique(new_slug)
+      end
     end
   end
 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/controllers/spree/admin/users_controller.rb

@@ -27,7 +27,7 @@ module Spree
 
       def update
         if @user.update(user_params)
-          flash[:success] = Spree.t(:account_updated)
+          flash[:success] = flash_message_for(@user, :successfully_updated)
           redirect_to spree.admin_user_path(@user)
         else
           render :edit, status: :unprocessable_entity

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

@@ -21,6 +21,9 @@ 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?
         @settings_active || %w[stores zones shipping_methods oauth_applications
                                payment_methods refund_reasons reimbursement_types
@@ -30,10 +33,19 @@ module Spree
                                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
 
+      # 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?
 
@@ -42,10 +54,10 @@ module Spree
         options[:class] ||= 'avatar'
 
         if user.respond_to?(:avatar) && user.avatar.attached? && user.avatar.variable?
-          image_tag(
-            main_app.cdn_image_url(
-              user.avatar.variant(spree_image_variant_options(resize_to_fill: [options[:width] * 2, options[:height] * 2]))
-            ),
+          spree_image_tag(
+            user.avatar,
+            width: options[:width],
+            height: options[:height],
             class: options[:class],
             style: "width: #{options[:width]}px; height: #{options[:height]}px;"
           )
@@ -54,12 +66,19 @@ module Spree
         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}")
@@ -72,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))
@@ -91,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
@@ -146,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
@@ -191,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)
 
@@ -227,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