spree_admin 5.1.7 → 5.2.0.rc1

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

@@ -45,24 +45,27 @@ module Spree
       # @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][:action] ||= 'click->bulk-operation#setBulkAction click->bulk-dialog#open'
+        options[:data][:turbo_frame] ||= :bulk_dialog
         options[:data][:url] ||= options[:url]
-        options[:class] ||= 'btn btn-light'
+        options[:class] ||= 'btn'
 
+        tooltip_text = nil
         if options[:icon]
           if options[:only_icon]
-            options[:title] = text
+            tooltip_text = options[:title] || text
             text = icon(options[:icon], class: 'mr-0')
-            options[:class] += ' with-tip'
+            options[:data][:controller] = 'tooltip'
+            options.delete(:title)
           else
             text = icon(options[:icon]) + ' ' + text
           end
         end
 
-        content_tag :span, data: { toggle: 'modal', target: '#bulk-modal' } do
-          link_to text, path, options
-        end
+        link_content = text
+        link_content += tooltip(tooltip_text) if tooltip_text
+
+        link_to link_content, path, options
       end
 
       # render a close button for the bulk modal
@@ -70,11 +73,10 @@ module Spree
         button_tag(
           '',
           type: 'button',
-          class: 'btn-close',
+          class: 'btn-close mr-1',
           data: {
-            dismiss: 'modal',
-            aria_label: Spree.t(:close),
-            action: 'bulk-operation#cancel'
+            action: 'bulk-operation#cancel',
+            aria_label: Spree.t(:close)
           }
         )
       end

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

@@ -0,0 +1,21 @@
+module Spree
+  module Admin
+    module DialogHelper
+      def dialog_header(title, controller_name = 'dialog')
+        content_tag(:div, class: 'dialog-header') do
+          content_tag(:h5, title, class: 'dialog-title') + dialog_close_button(controller_name)
+        end.html_safe
+      end
+
+      def dialog_close_button(controller_name = 'dialog')
+        button_tag('', type: 'button', class: 'btn-close', data: { action: "#{controller_name}#close", dismiss: controller_name, aria_label: Spree.t(:close) }).html_safe
+      end
+
+      def dialog_discard_button(controller_name = 'dialog')
+        button_tag(type: 'button', class: 'btn btn-light', data: { action: "#{controller_name}#close", dismiss: controller_name }) do
+          Spree.t('actions.discard')
+        end.html_safe
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Spree
+  module Admin
+    module DrawerHelper
+      def drawer_header(title)
+        content_tag(:div, class: 'drawer-header') do
+          content_tag(:h5, title, class: 'drawer-title') + drawer_close_button
+        end.html_safe
+      end
+
+      def drawer_close_button
+        button_tag('', type: 'button', class: 'btn-close', data: { action: 'drawer#close', dismiss: 'drawer', aria_label: Spree.t(:close) }).html_safe
+      end
+
+      def drawer_discard_button
+        button_tag(type: 'button', class: 'btn btn-light', data: { action: 'drawer#close', dismiss: 'drawer' }) do
+          Spree.t('actions.discard')
+        end.html_safe
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Spree
+  module Admin
+    module DropdownHelper
+      def dropdown(options = {}, &block)
+        options[:class] = ['dropdown'] + Array(options[:class])
+        options[:data] = { controller: 'dropdown' }.merge(options[:data] || {})
+        content_tag(:div, options, &block)
+      end
+
+      def dropdown_toggle(options = {}, &block)
+        options[:type] = 'button'
+        options[:class] = ['btn'] + Array(options[:class])
+        options[:data] = { action: 'dropdown#toggle click@window->dropdown#hide' }.merge(options[:data] || {})
+        button_tag(options, &block)
+      end
+
+      def dropdown_menu(options = {}, &block)
+        options[:class] = ['dropdown-container hidden'] + Array(options[:class])
+
+        if options[:direction] == 'left'
+          options[:class] << 'dropdown-container-left'
+        elsif options[:direction] == 'top'
+          options[:class] << 'dropdown-container-top'
+        elsif options[:direction] == 'top-left'
+          options[:class] << 'dropdown-container-top dropdown-container-left'
+        end
+        options[:data] = { dropdown_target: 'menu' }.merge(options[:data] || {})
+        content_tag(:div, options, &block)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+module Spree
+  module Admin
+    module JsonPreviewHelper
+      def link_to_show_json(record, options = {})
+        return unless json_serializers_available?(record)
+        return unless can?(:read, record)
+        return unless can?(:read, :json_preview)
+
+        options[:class] ||= 'dropdown-item'
+        options[:data] ||= { action: 'drawer#open', turbo_frame: :drawer }
+
+        link_to_with_icon(
+          'code',
+          Spree.t('admin.show_json'),
+          spree.admin_json_preview_resource_path(record.id, resource_type: record.class.to_s),
+          options
+        )
+      end
+
+      def json_serializers_available?(record)
+        storefront_serializer_exists?(record) || platform_serializer_exists?(record)
+      end
+
+      def storefront_serializer_exists?(record)
+        serializer_class_name = "Spree::V2::Storefront::#{record.class.name.demodulize}Serializer"
+        serializer_class_name.safe_constantize.present?
+      end
+
+      def platform_serializer_exists?(record)
+        serializer_class_name = "Spree::Api::V2::Platform::#{record.class.name.demodulize}Serializer"
+        serializer_class_name.safe_constantize.present?
+      end
+
+      def serialize_to_json(record, api_type: :storefront)
+        return unless record
+
+        serializer = case api_type.to_sym
+                     when :storefront
+                       storefront_serializer_for(record)
+                     when :platform
+                       platform_serializer_for(record)
+                     end
+
+        return nil unless serializer
+
+        serializable_hash = serializer.new(
+          record,
+          params: serializer_params(record)
+        ).serializable_hash
+
+        JSON.pretty_generate(serializable_hash)
+      end
+
+      private
+
+      def storefront_serializer_for(record)
+        serializer_class_name = "Spree::V2::Storefront::#{record.class.name.demodulize}Serializer"
+        serializer_class_name.safe_constantize
+      end
+
+      def platform_serializer_for(record)
+        serializer_class_name = "Spree::Api::V2::Platform::#{record.class.name.demodulize}Serializer"
+        serializer_class_name.safe_constantize
+      end
+
+      def serializer_params(record)
+        params = {}
+        params[:store] = current_store if defined?(current_store) && current_store.present?
+        params[:currency] = current_currency if defined?(current_currency) && current_currency.present?
+        params[:locale] = current_locale if defined?(current_locale) && current_locale.present?
+        params
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Spree
+  module Admin
+    module MetafieldsHelper
+      def link_to_edit_metafields(record, options = {})
+        return unless Spree::MetafieldDefinition.available_resources.map(&:name).include?(record.class.name)
+        return unless record.respond_to?(:metafields)
+        return unless can?(:manage, record)
+        return unless can?(:manage, Spree::Metafield)
+
+        options[:class] ||= 'dropdown-item'
+        options[:data]  ||= { action: 'drawer#open', turbo_frame: :drawer }
+
+        link_to_with_icon 'edit', Spree.t(:metafields), spree.edit_admin_metafield_path(record.id, resource_type: record.class.name), options
+      end
+
+      def metafield_definition_resource_types
+        @metafield_definition_resource_types ||= Spree::MetafieldDefinition.available_resources.map do |type|
+          [type.to_s.demodulize.titleize, type]
+        end
+      end
+
+      def metafield_definition_types
+        @metafield_definition_types ||= Spree::MetafieldDefinition.available_types.map do |type|
+          [type.to_s.demodulize.titleize, type]
+        end
+      end
+    end
+  end
+end

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

@@ -39,17 +39,18 @@ module Spree
           per_page_default * 8
         ]
 
-        selected_option = (params[:per_page].try(:to_i) || per_page_default).to_s
-
-        selected_option += icon('chevron-down', class: 'ml-1 mr-0 arrow')
-
-        content_tag :div, id: 'per-page-dropdown' do
-          button_tag(raw(selected_option), class: 'btn btn-light btn-sm', data: { toggle: 'dropdown', expanded: false }) +
-            content_tag(:div, class: 'dropdown-menu') do
-              per_page_options.map do |option|
-                link_to option, per_page_dropdown_params(option), class: "dropdown-item #{'active' if option.to_i == selected_option.to_i}"
-              end.join.html_safe
-            end
+        selected_option = (params[:per_page].try(:to_i) || per_page_default).to_i
+        selected_option_label = selected_option.to_s + icon('chevron-down', class: 'ml-1 mr-0 arrow')
+
+        dropdown(id: 'per-page-dropdown') do
+          dropdown_toggle(class: 'btn-light btn-sm') do
+            raw(selected_option_label)
+          end +
+          dropdown_menu(direction: 'top-left') do
+            per_page_options.map do |option|
+              link_to option, per_page_dropdown_params(option), class: "dropdown-item #{'active' if option.to_i == selected_option}"
+            end.join.html_safe
+          end
         end
       end
 
@@ -107,17 +108,36 @@ module Spree
       # @param options [Hash] the options for the link
       # @return [String] the link with the icon
       def link_to_with_icon(icon_name, text, url, options = {})
-        options[:class] ||= (options[:class].to_s + " with-tip").strip
-        options[:title] ||= text if options[:no_text]
         no_text = options[:no_text]
-        label = options[:no_text] ? '' : content_tag(:span, text)
+        tooltip_text = options[:title] || (no_text ? text : nil)
         options.delete(:no_text)
+        options.delete(:title) if tooltip_text
+
+        if tooltip_text
+          options[:data] ||= {}
+          options[:data][:controller] = 'tooltip'
+        end
+
+        label = no_text ? '' : content_tag(:span, text)
 
         if icon_name
           icon = icon(icon_name, class: "icon icon-#{icon_name} #{text.blank? || no_text ? 'mr-0' : ''}")
           text = "#{icon} #{label}"
         end
-        link_to(text.html_safe, url, options)
+
+        link_content = text.html_safe
+        link_content += tooltip(tooltip_text) if tooltip_text
+
+        link_to(link_content, url, options)
+      end
+
+      def link_to_export_modal
+        return unless can?(:create, Spree::Export)
+
+        button_tag(type: 'button', class: 'btn btn-light', data: { action: 'click->export-dialog#open' }) do
+          icon('table-export', class: 'mr-0 mr-lg-2') +
+          content_tag(:span, Spree.t(:export), class: 'd-none d-lg-inline')
+        end
       end
 
       # renders an active link with an icon, using the active_link_to method from https://github.com/comfy/active_link_to gem
@@ -127,17 +147,27 @@ module Spree
       # @param options [Hash] the options for the link
       # @return [String] the active link with the icon
       def active_link_to_with_icon(icon_name, text, url, options = {})
-        options[:class] = (options[:class].to_s + " with-tip").strip
-        options[:title] = text if options[:no_text]
         no_text = options[:no_text]
-        label = options[:no_text] ? '' : content_tag(:span, text)
+        tooltip_text = options[:title] || (no_text ? text : nil)
         options.delete(:no_text)
+        options.delete(:title) if tooltip_text
+
+        if tooltip_text
+          options[:data] ||= {}
+          options[:data][:controller] = 'tooltip'
+        end
+
+        label = no_text ? '' : content_tag(:span, text)
 
         if icon_name
           icon = icon(icon_name, class: "icon icon-#{icon_name}")
           text = "#{icon} #{label}"
         end
-        active_link_to(text.html_safe, url, options)
+
+        link_content = text.html_safe
+        link_content += tooltip(tooltip_text) if tooltip_text
+
+        active_link_to(link_content, url, options)
       end
 
       # renders a button with an icon (optional)
@@ -268,13 +298,15 @@ module Spree
       # @param placement [String] the placement of the help bubble
       # @param css [String] the css class of the help bubble
       # @return [String] the help bubble with the icon
-      def help_bubble(text = '', placement = 'bottom', css: nil)
-        css ||= 'text-muted opacity-75 cursor-default'
-        content_tag :small, icon('info-square-rounded', class: css), data: { placement: placement }, class: "with-tip #{css}", title: text
+      def help_bubble(text = '', placement = 'top', css: nil)
+        css ||= 'text-xs text-muted cursor-default opacity-75'
+        content_tag :span, data: { controller: 'tooltip', tooltip_placement_value: placement } do
+          icon('info-square-rounded', class: css) + tooltip(text)
+        end
       end
 
       def render_breadcrumb_icon
-        if settings_active?
+        if settings_area?
           icon('settings')
         elsif @breadcrumb_icon
           icon(@breadcrumb_icon)

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

@@ -14,40 +14,49 @@ module Spree
 
         if search_params[:created_at_gt].present?
           search_params[:created_at_gt] = begin
-                                            # Firstly we parse to date to avoid issues with timezones because frontend sends time in local timezone
-                                            search_params[:created_at_gt].to_date&.in_time_zone(current_timezone)
-                                          rescue StandardError
-                                            ''
-                                          end
+            # Firstly we parse to date to avoid issues with timezones because frontend sends time in local timezone
+            search_params[:created_at_gt].to_date&.in_time_zone(current_timezone)&.beginning_of_day
+          rescue StandardError
+            ''
+          end
         end
 
         if search_params[:created_at_lt].present?
           search_params[:created_at_lt] = begin
-                                            search_params[:created_at_lt].to_date&.in_time_zone(current_timezone)&.end_of_day
-                                          rescue StandardError
-                                            ''
-                                          end
+            search_params[:created_at_lt].to_date&.in_time_zone(current_timezone)&.end_of_day
+          rescue StandardError
+            ''
+          end
         end
 
         if search_params[:completed_at_gt].present?
           search_params[:completed_at_gt] = begin
-                                            search_params[:completed_at_gt].to_date&.in_time_zone(current_timezone)
-                                          rescue StandardError
-                                            ''
-                                          end
+            search_params[:completed_at_gt].to_date&.in_time_zone(current_timezone)&.beginning_of_day
+          rescue StandardError
+            ''
+          end
         end
 
         if search_params[:completed_at_lt].present?
           search_params[:completed_at_lt] = begin
-                                            search_params[:completed_at_lt].to_date&.in_time_zone(current_timezone)&.end_of_day
-                                          rescue StandardError
-                                            ''
-                                          end
+            search_params[:completed_at_lt].to_date&.in_time_zone(current_timezone)&.end_of_day
+          rescue StandardError
+            ''
+          end
         end
 
         search_params[:vendor_orders_vendor_id_eq] = vendor.id if vendor.present?
         search_params[:user_id_eq] = user.id if user.present?
 
+        # Handle refunded and partially_refunded payment state filters
+        if search_params[:payment_state_eq] == 'refunded'
+          search_params[:refunded] = '1'
+          search_params.delete(:payment_state_eq)
+        elsif search_params[:payment_state_eq] == 'partially_refunded'
+          search_params[:partially_refunded] = '1'
+          search_params.delete(:payment_state_eq)
+        end
+
         search_params
       end
 

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

@@ -20,7 +20,15 @@ module Spree
       def order_payment_state(order, options = {})
         return if order.payment_state.blank?
 
-        content_tag :span, class: "badge  #{options[:class]} badge-#{order.partially_refunded? ? 'warning' : order.payment_state}" do
+        badge_class = if order.order_refunded?
+                        'badge-danger'
+                      elsif order.partially_refunded?
+                        'badge-warning'
+                      else
+                        "badge-#{order.payment_state}"
+                      end
+
+        content_tag :span, class: "badge #{options[:class]} #{badge_class}" do
           if order.order_refunded?
             icon('credit-card-refund') + Spree.t('payment_states.refunded')
           elsif order.partially_refunded?

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

@@ -81,19 +81,14 @@ module Spree
 
       def all_linkable_pages
         @all_linkable_pages ||= Spree::Page.
-                                linkable.
                                 without_previews.
                                 where(pageable: [@theme, current_store]).
-                                map { |page| [page.display_name, page.id] }
+                                select(&:linkable?).
+                                map { |page| [page.display_name, page.id] }.sort_by(&:first)
       end
 
       def all_linkable_policies
-        @all_linkable_policies = [
-          current_store.customer_privacy_policy,
-          current_store.customer_terms_of_service,
-          current_store.customer_returns_policy,
-          current_store.customer_shipping_policy
-        ].compact.map { |policy| [policy.name.humanize, policy.id] }
+        @all_linkable_policies ||= current_store.policies.pluck(:name, :id)
       end
 
       def refresh_theme_preview(section = nil, block = nil)

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

@@ -2,6 +2,8 @@ module Spree
   module Admin
     module PaymentsHelper
       def payment_method_name(payment)
+        return unless payment.payment_method.present?
+
         payment_method = payment.payment_method
 
         if can?(:update, payment_method)

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

@@ -27,18 +27,6 @@ module Spree
         end
       end
 
-      # we use this method to fetch images for media gallery on product form
-      # for new products we use session to store temporary assets not tied to any variant/product (yet)
-      def media_form_assets(variant)
-        if variant&.persisted?
-          variant.images
-        elsif session_uploaded_assets.any?
-          Spree::Image.accessible_by(current_ability, :manage).where(id: session_uploaded_assets)
-        else
-          []
-        end
-      end
-
       def product_status(product)
         if product.deleted?
           content_tag(:span, 'Deleted', class: 'badge  badge-danger')

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

@@ -1,13 +1,20 @@
 module Spree
   module Admin
     module TranslationsHelper
-      def link_to_edit_translations(resource, classes: 'text-left dropdown-item')
+      def link_to_edit_translations(resource, options = {})
+        return unless Rails.application.config.spree.translatable_resources.map(&:name).include?(resource.class.name)
+        return unless can?(:update, resource)
+        return unless can?(:update, :translations)
+
+        options[:class] ||= 'dropdown-item'
+        options[:data]  ||= { action: 'drawer#open', turbo_frame: :drawer }
+
         link_to_with_icon(
           'language',
           Spree.t(:translations),
-          spree.edit_admin_translation_path(resource, resource_type: resource.class.to_s),
-          class: classes
-        ) if can?(:update, resource)
+          spree.edit_admin_translation_path(resource.id, resource_type: resource.class.to_s),
+          options
+        )
       end
     end
   end

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

@@ -2,6 +2,8 @@ module Spree
   module Admin
     module TurboHelper
       def turbo_close_modal(modal_id = nil)
+        Spree::Deprecation.warn('turbo_close_modal is deprecated and will be removed in Spree 6. Use turbo_close_dialog instead.')
+
         modal_id ||= 'modal'
 
         turbo_stream.replace :modal_scripts do
@@ -17,9 +19,15 @@ module Spree
         end
       end
 
-      def turbo_render_alerts
-        turbo_stream.replace :alerts do
-          render 'spree/admin/shared/alerts'
+      def turbo_close_dialog
+        turbo_stream.replace 'main-dialog' do
+          render 'spree/admin/shared/dialog'
+        end
+      end
+
+      def turbo_render_alerts(frame_name = :alerts)
+        turbo_stream.replace frame_name do
+          render 'spree/admin/shared/alerts', frame_name: frame_name
         end
       end
 
@@ -27,8 +35,13 @@ module Spree
         opts[:class] ||= 'btn btn-primary text-center'
         opts[:class] << ' d-flex align-items-center justify-content-center' if opts[:class].exclude?('d-block') && opts[:class].exclude?('d-flex')
 
-        opts['data-turbo-submits-with'] ||= "#{content_tag(:span, '', class: 'spinner-border spinner-border-sm mr-2', role: 'status')}Saving..."
+        opts['data-turbo-submits-with'] ||= "#{content_tag(:span, '', class: 'spinner-border spinner-border-sm', role: 'status')}"
         opts['data-enable-button-target'] = 'button'
+        if opts['data-controller'].present?
+          opts['data-controller'] += ' turbo-submit-button'
+        else
+          opts['data-controller'] = 'turbo-submit-button'
+        end
 
         if block_given?
           button_tag opts, &block