spree_admin 5.1.7 → 5.2.0.rc1

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

@@ -1,21 +1,24 @@
 class Spree::Admin::ResourceController < Spree::Admin::BaseController
   include Spree::Admin::Callbacks
 
-  helper_method :new_object_url, :edit_object_url, :object_url, :collection_url, :model_class
+  helper_method :new_object_url, :edit_object_url, :object_url, :collection_url, :model_class, :search_collection, :paginated_collection
   before_action :load_resource
   before_action :set_currency, :set_current_store, only: [:new, :create]
   after_action :set_return_to, only: [:index]
 
   rescue_from ActiveRecord::RecordNotFound, with: :resource_not_found
 
+  # GET /admin/<resource_name>/new
   def new
     invoke_callbacks(:new_action, :before)
   end
 
+  # GET /admin/<resource_name_plural>/<id>/edit
   def edit
     invoke_callbacks(:edit_action, :before)
   end
 
+  # PUT /admin/<resource_name_plural>/<id>
   def update
     invoke_callbacks(:update, :before)
     if @object.update(permitted_resource_params)
@@ -47,6 +50,7 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseController
     end
   end
 
+  # POST /admin/<resource_name_plural>
   def create
     invoke_callbacks(:create, :before)
     set_created_by
@@ -77,6 +81,7 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseController
     end
   end
 
+  # DELETE /admin/<resource_name_plural>/<id>
   def destroy
     invoke_callbacks(:destroy, :before)
     if @object.destroy
@@ -131,6 +136,8 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseController
     redirect_to collection_url, status: :see_other
   end
 
+  # Returns the resource for the current controller
+  # @return [Spree::Admin::Resource]
   def resource
     return @resource if @resource
 
@@ -138,6 +145,8 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseController
     @resource = Spree::Admin::Resource.new controller_path, controller_name, parent_model_name, object_name
   end
 
+  # Loads the resource for the current controller
+  # @return [Spree::Admin::Resource]
   def load_resource
     if member_action?
       @object ||= load_resource_instance
@@ -207,6 +216,8 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseController
     end
   end
 
+  # Returns the collection of resources (as a scope)
+  # @return [ActiveRecord::Relation]
   def collection
     return parent.send(controller_name) if parent_data.present?
 
@@ -223,32 +234,66 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseController
     end
   end
 
+  # Returns the filtered and paginated ransack results
+  # @return [ActiveRecord::Relation]
+  def paginated_collection
+    @paginated_collection ||= begin
+      # Check if collection is already a ransack collection and return it
+      return collection if collection.respond_to?(:current_page)
+
+      search_collection.result(distinct: true).page(params[:page]).per(params[:per_page])
+    end
+  end
+
+  # Returns the ransack search collection
+  # @return [Ransack::Search]
+  def search_collection
+    @search_collection ||= begin
+      params[:q] ||= {}
+      collection.ransack(params[:q])
+    end
+  end
+
+  # Returns the URL to redirect to after destroying a resource
+  # @return [String]
   def location_after_destroy
     collection_url
   end
 
+  # Returns the URL to redirect to after creating a resource
+  # @return [String]
   def location_after_create
     location_after_save
   end
 
+  # Returns the URL to redirect to after saving a resource (update or create)
+  # @return [String]
   def location_after_save
     edit_object_url(@object)
   end
 
+  # Returns the flash message after creating a resource
+  # @return [String]
   def message_after_create
     flash_message_for(@object, :successfully_created)
   end
 
+  # Returns the flash message after updating a resource
+  # @return [String]
   def message_after_update
     flash_message_for(@object, :successfully_updated)
   end
 
+  # Sets the current store for the resource, if resource is store related
+  # @return [void]
   def set_current_store
     return if @object.nil?
 
     ensure_current_store(@object)
   end
 
+  # Sets the created_by with the current admin user for the resource, if resource is created_by related
+  # @return [void]
   def set_created_by
     return if @object.nil?
 
@@ -264,6 +309,8 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseController
 
   # URL helpers
 
+  # Returns the URL to redirect to after creating a resource
+  # @return [String]
   def new_object_url(options = {})
     if parent_data.present?
       spree.new_polymorphic_url([:admin, parent, model_class], options)
@@ -272,6 +319,8 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseController
     end
   end
 
+  # Returns the URL to edit a resource
+  # @return [String]
   def edit_object_url(object, options = {})
     if parent_data.present?
       spree.send "edit_admin_#{resource.model_name}_#{resource.object_name}_url",
@@ -281,6 +330,8 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseController
     end
   end
 
+  # Returns the URL to the resource
+  # @return [String]
   def object_url(object = nil, options = {})
     target = object || @object
     if parent_data.present?
@@ -290,6 +341,8 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseController
     end
   end
 
+  # Returns the URL to the collection of resources
+  # @return [String]
   def collection_url(options = {})
     if parent_data.present?
       spree.polymorphic_url([:admin, parent, model_class], options)
@@ -308,16 +361,22 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseController
     raise NotImplementedError, "You must implement the permitted_resource_params method"
   end
 
+  # Returns the actions that are collection actions
+  # @return [Array]
   def collection_actions
     [:index, :select_options, :bulk_modal, :bulk_status_update,
      :bulk_add_to_taxons, :bulk_remove_from_taxons,
      :bulk_add_tags, :bulk_remove_tags, :bulk_destroy]
   end
 
+  # Returns true if the current action is a member action
+  # @return [Boolean]
   def member_action?
     !collection_actions.include? action
   end
 
+  # Returns the actions that are new actions
+  # @return [Array]
   def new_actions
     [:new, :create]
   end

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

@@ -1,7 +1,7 @@
 module Spree
   module Admin
     class ReturnAuthorizationReasonsController < ResourceController
-      add_breadcrumb Spree.t(:return_authorization_reasons), :admin_return_authorization_reasons_path
+      include Spree::Admin::SettingsConcern
 
       private
 

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

@@ -1,6 +1,9 @@
 module Spree
   module Admin
     class ReturnAuthorizationsController < ResourceController
+      add_breadcrumb_icon 'receipt-refund'
+      add_breadcrumb Spree.t(:returns), :admin_customer_returns_path
+
       def index; end
 
       def cancel

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

@@ -1,8 +1,7 @@
 module Spree
   module Admin
     class RolesController < ResourceController
-      add_breadcrumb Spree.t(:users), :admin_admin_users_path
-      add_breadcrumb Spree.t(:roles), :admin_roles_path
+      include Spree::Admin::SettingsConcern
 
       private
 

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

@@ -1,7 +1,7 @@
 module Spree
   module Admin
     class ShippingCategoriesController < ResourceController
-      add_breadcrumb Spree.t(:shipping_categories), :admin_shipping_categories_path
+      include Spree::Admin::SettingsConcern
 
       private
 

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

@@ -1,11 +1,11 @@
 module Spree
   module Admin
     class ShippingMethodsController < ResourceController
+      include Spree::Admin::SettingsConcern
+
       before_action :load_data, except: :index
       before_action :set_default_values, only: :new
 
-      add_breadcrumb Spree.t(:shipping_methods), :admin_shipping_methods_path
-
       private
 
       def set_default_values

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

@@ -1,9 +1,9 @@
 module Spree
   module Admin
     class StockLocationsController < ResourceController
-      before_action :set_country, only: :new
+      include Spree::Admin::SettingsConcern
 
-      add_breadcrumb Spree.t(:stock_locations), :admin_stock_locations_path
+      before_action :set_country, only: :new
 
       # PUT /admin/stock_locations/:id/mark_as_default
       def mark_as_default

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

@@ -6,6 +6,7 @@ module Spree
       before_action :load_user
       before_action :load_store_credit, only: [:new, :edit, :update, :destroy]
       before_action :ensure_unused_store_credit, only: [:update]
+      helper_method :collection_url
 
       def index
         @store_credits = scope.includes(:created_by).order(created_at: :desc)
@@ -84,6 +85,7 @@ module Spree
 
       def load_store_credit
         @store_credit = scope.find_by(id: params[:id]) || scope.new
+        @object = @store_credit
       end
 
       def scope
@@ -95,6 +97,10 @@ module Spree
           raise StoreCreditError, Spree.t('store_credit.errors.cannot_change_used_store_credit')
         end
       end
+
+      def collection_url
+        spree.admin_user_store_credits_path(@user)
+      end
     end
   end
 end

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

@@ -26,7 +26,7 @@ module Spree
         params.require(:store).permit(
           :preferred_index_in_search_engines,
           :preferred_password_protected, :social_image, :favicon_image, :name,
-          :meta_description, :meta_title, :meta_keywords, :seo_robots,
+          :meta_description, :meta_keywords, :seo_robots, :seo_title,
           :facebook, :twitter, :instagram, :linkedin, :youtube, :tiktok, :pinterest,
           :storefront_custom_code_head, :storefront_custom_code_body_start,
           :storefront_custom_code_body_end, :storefront_password, :spotify, :discord

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

@@ -1,6 +1,8 @@
 module Spree
   module Admin
     class StoresController < Spree::Admin::BaseController
+      include Spree::Admin::SettingsConcern
+
       before_action :load_store, only: [:edit, :update]
       before_action :normalize_supported_currencies, only: [:update]
       before_action :normalize_supported_locales, only: [:update]
@@ -12,6 +14,7 @@ module Spree
           default_country_iso: current_store.default_country_iso,
           default_currency: current_store.default_currency
         )
+        render :new, layout: 'spree/admin_wizard'
       end
 
       def create
@@ -25,7 +28,7 @@ module Spree
           end
 
           flash[:success] = flash_message_for(@store, :successfully_created)
-          # redirect in view, Turbo doesn't support redirecting to a different host
+          redirect_to spree.admin_getting_started_url(host: @store.url), allow_other_host: true
         else
           render :new, status: :unprocessable_entity
         end
@@ -50,7 +53,10 @@ module Spree
 
         if @store.save
           remove_assets(%w[logo mailer_logo], object: @store)
-          flash[:success] = flash_message_for(@store, :successfully_updated)
+          respond_to do |format|
+            format.turbo_stream { flash.now[:success] = flash_message_for(@store, :successfully_updated) }
+            format.html { flash[:success] = flash_message_for(@store, :successfully_updated) }
+          end
         else
           flash[:error] = "#{Spree.t('store_errors.unable_to_update')}: #{@store.errors.full_messages.join(', ')}"
         end

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

@@ -1,7 +1,7 @@
 module Spree
   module Admin
     class TaxCategoriesController < ResourceController
-      add_breadcrumb Spree.t(:tax_categories), :admin_tax_categories_path
+      include Spree::Admin::SettingsConcern
 
       private
 

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

@@ -1,11 +1,11 @@
 module Spree
   module Admin
     class TaxRatesController < ResourceController
+      include Spree::Admin::SettingsConcern
+
       before_action :load_data
       before_action :set_defaults, only: :new
 
-      add_breadcrumb Spree.t(:tax_rates), :admin_tax_rates_path
-
       private
 
       def set_defaults

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

@@ -1,32 +1,24 @@
 module Spree
   module Admin
-    class TranslationsController < Spree::Admin::BaseController
-      before_action :set_resource, only: [:edit, :update]
-      before_action :load_data, only: [:edit]
-      before_action :set_translation_locale, only: [:edit, :update]
+    class TranslationsController < ResourceController
+      # Set the resource being translated and any related data
+      before_action :load_data
+      before_action :set_translation_locale
+      helper_method :normalized_locale
 
-      def edit; end
-
-      def update
-        @resource.update!(permitted_translation_params)
-
-        flash[:success] = Spree.t('notice_messages.translations_saved')
-
-        redirect_to spree.edit_admin_translation_path(
-          @resource,
-          resource_type: @resource.class.to_s,
-          translation_locale: @selected_translation_locale
-        )
+      # Normalizes a locale string by replacing '-' with '_' and downcasing
+      def normalized_locale(locale)
+        locale.to_s.downcase.tr('-', '_')
       end
 
       private
 
-      def permitted_translation_params
-        params.require(@resource.model_name.param_key).permit(translation_fields(resource_class), **nested_params)
+      def permitted_resource_params
+        params.require(@object.model_name.param_key).permit(translation_fields(model_class), **nested_params)
       end
 
       def nested_params
-        case resource_class.to_s
+        case model_class.to_s
           when 'Spree::OptionType'
             { option_values_attributes: [ :id, *translation_fields(Spree::OptionValue)] }
           else
@@ -34,54 +26,42 @@ module Spree
         end
       end
 
+      # Build translation field names with normalized locale suffix
       def translation_fields(klass)
-        klass.translatable_fields.map { |field| "#{field}_#{@selected_translation_locale}" }
+        klass.translatable_fields.map { |field| "#{field}_#{normalized_locale(@selected_translation_locale)}" }
       end
 
-      def resource_class
-        @resource_class ||= begin
+      # Determine the class of the resource
+      def model_class
+        @model_class ||= begin
           klass = params[:resource_type]
-          allowed_resource_class.find { |allowed_class| allowed_class.to_s == klass } ||
+          allowed_model_classes.find { |allowed_class| allowed_class.to_s == klass } ||
             raise(ActiveRecord::RecordNotFound, "Resource type not found")
         end
       end
 
-      def allowed_resource_class
+      # Allowed translatable resources configured in Spree
+      def allowed_model_classes
         Rails.application.config.spree.translatable_resources
       end
 
-      def set_resource
-        @resource = if resource_class.respond_to?(:friendly)
-                      resource_class.friendly.find(params[:id])
-                    else
-                      resource_class.find(params[:id])
-                    end
-      end
-
+      # Determine the translation locale to use
       def set_translation_locale
-        @selected_translation_locale = params[:translation_locale].presence || @locales&.first || current_store.supported_locales_list.first
+        raw_locale = params[:translation_locale].presence ||
+        @locales&.first ||
+        current_store.default_locale ||
+        current_store.supported_locales_list.first
+
+        @selected_translation_locale = normalized_locale(raw_locale)
       end
 
+      # Load available locales for this resource, excluding default
       def load_data
         @locales = (current_store.supported_locales_list - [@default_locale]).sort
-        @resource_name = @resource.try(:name)
+      end
 
-        @back_path = case @resource.class.name
-          when 'Spree::OptionType'
-            spree.edit_admin_option_type_path(@resource)
-          when 'Spree::Product'
-            spree.edit_admin_product_path(@resource)
-          when 'Spree::Property'
-            spree.edit_admin_property_path(@resource)
-          when 'Spree::Store'
-            spree.edit_admin_store_path(section: "general-settings")
-          when 'Spree::Taxon'
-            spree.edit_admin_taxonomy_taxon_path(@resource.taxonomy, @resource.id)
-          when 'Spree::Taxonomy'
-            spree.admin_taxonomy_path(@resource)
-          else
-            [:edit, :admin, @resource]
-        end
+      def update_turbo_stream_enabled?
+        true
       end
     end
   end

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

@@ -73,6 +73,10 @@ module Spree
         model_class.accessible_by(current_ability, :show).find(params[:id])
       end
 
+      def collection_url
+        spree.admin_users_path
+      end
+
       private
 
       def user_params

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

@@ -1,14 +1,13 @@
 module Spree
   module Admin
     class WebhooksSubscribersController < ResourceController
+      include Spree::Admin::SettingsConcern
+
       before_action :set_supported_events, except: [:index, :show]
 
       create.before :process_subscriptions
       update.before :process_subscriptions
 
-      add_breadcrumb Spree.t(:developers), :admin_oauth_applications_path
-      add_breadcrumb Spree.t(:webhooks), :admin_webhooks_subscribers_path
-
       def show
         @webhooks_subscriber = Webhooks::Subscriber.find(params[:id])
         @events = @webhooks_subscriber.events.order(created_at: :desc).page(params[:page]).per(params[:per_page])

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

@@ -1,7 +1,7 @@
 module Spree
   module Admin
     class ZonesController < ResourceController
-      add_breadcrumb Spree.t(:zones), :admin_zones_path
+      include Spree::Admin::SettingsConcern
       before_action :load_data, except: :index
 
       def new

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

@@ -0,0 +1,42 @@
+module Spree
+  module Admin
+    module AssetsHelper
+      def media_form_assets(viewable, viewable_type)
+        if viewable&.persisted?
+          viewable.images
+        elsif session_uploaded_assets(viewable_type).any?
+          Spree::Asset.accessible_by(current_ability, :manage).where(id: session_uploaded_assets(viewable_type))
+        else
+          []
+        end
+      end
+
+      def ensure_session_uploaded_assets_uuid(viewable_type)
+        session[session_uploaded_assets_uuid_key(viewable_type)] ||= SecureRandom.uuid
+      end
+
+      def store_uploaded_asset_in_session(asset, viewable_type)
+        ensure_session_uploaded_assets_uuid(viewable_type)
+        asset.update(session_id: session[session_uploaded_assets_uuid_key(viewable_type)])
+      end
+
+      def session_uploaded_assets(viewable_type)
+        return Spree::Asset.none if session[session_uploaded_assets_uuid_key(viewable_type)].blank?
+
+        Spree::Asset.with_session_uploaded_assets_uuid(session[session_uploaded_assets_uuid_key(viewable_type)]).where(viewable_id: nil)
+      end
+
+      def clear_session_for_uploaded_assets(viewable_type)
+        session.delete(session_uploaded_assets_uuid_key(viewable_type))
+      end
+
+      def session_uploaded_assets_uuid_key(viewable_type)
+        [
+          'spree.admin.uploaded_assets',
+          viewable_type&.underscore,
+          'uuid'
+        ].compact_blank.join('.')
+      end
+    end
+  end
+end

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

@@ -34,11 +34,16 @@ module Spree
       # check if the current controller is a settings controller
       # this is used to display different sidebar navigation for settings pages
       # @return [Boolean]
+      def settings_area?
+        @settings_area.present?
+      end
+
       def settings_active?
-        @settings_active || %w[admin_users audits custom_domains exports imports invitations oauth_applications
+        Spree::Deprecation.warn('settings_active? is deprecated and will be removed in Spree 6.0. Please use settings_area? instead')
+        @settings_active || %w[admin_users audits custom_domains exports invitations oauth_applications
                                payment_methods refund_reasons reimbursement_types return_authorization_reasons roles
                                shipping_categories shipping_methods stock_locations store_credit_categories
-                               stores tax_categories tax_rates webhooks webhooks_subscribers zones].include?(controller_name)
+                               stores tax_categories tax_rates webhooks webhooks_subscribers zones policies metafield_definitions].include?(controller_name) || settings_area?
       end
 
       # @return [Array<String>] the available countries for checkout
@@ -76,8 +81,10 @@ module Spree
 
       # 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|
+      def display_on_options(model = nil)
+        model ||= Spree::DisplayOn
+
+        model::DISPLAY.map do |display_on|
           [Spree.t("admin.display_on_options.#{display_on}"), display_on]
         end
       end
@@ -115,11 +122,12 @@ module Spree
         icon_name = 'plus' if icon_name == 'add'
         icon_name = 'x' if icon_name == 'cancel'
 
-        styles = options[:style]
-        styles ||= ''
-        styles += ";font-size: #{options[:height]}px !important;line-height:#{options[:height]}px !important" if options[:height]
+        options[:style] ||= ''
+        options[:style] += ";font-size: #{options[:height]}px !important;line-height:#{options[:height]}px !important" if options[:height]
 
-        content_tag :i, nil, class: "ti ti-#{icon_name} #{options[:class]}", style: styles
+        options[:class] = "ti ti-#{icon_name} #{options[:class]}"
+
+        content_tag :i, nil, options
       end
 
       # returns the flag emoji for a country
@@ -256,16 +264,16 @@ module Spree
       # @option options [String] :title the title of the button
       # @return [String] the button
       def clipboard_button(options = {})
-        options[:class] ||= 'btn btn-clipboard with-tip'
+        options[:class] ||= 'btn btn-clipboard'
         options[:type] ||= 'button'
         options[:data] ||= {}
         options[:data][:action] = 'clipboard#copy'
         options[:data][:clipboard_target] = 'button'
-        options[:data][:title] = Spree.t('admin.copy_to_clipboard')
+        options[:data][:controller] = 'tooltip'
         options[:aria_label] ||= Spree.t('admin.copy_to_clipboard') # screen-reader label
 
         content_tag(:button, options) do
-          icon('copy', class: 'mr-0 font-size-sm')
+          icon('copy', class: 'mr-0 font-size-sm') + tooltip(Spree.t('admin.copy_to_clipboard'))
         end
       end
 
@@ -309,6 +317,45 @@ module Spree
       def allowed_file_types_for_upload
         Rails.application.config.active_storage.web_image_content_types
       end
+
+      # returns the local date for a given date
+      # @param date [Date] the date to format
+      # @return [String] the local date
+      def spree_date(date, options = {})
+        local_date(date, options)
+      end
+
+      # returns the local time for a given time
+      # @param time [Time] the time to format
+      # @return [String] the local time
+      def spree_time(time, options = {})
+        local_time(time, options)
+      end
+
+      # returns the local time ago for a given time
+      # @param time [Time] the time to format
+      # @return [String] the local time ago
+      def spree_time_ago(time, options = {})
+        return '' if time.blank?
+        options[:data] ||= {}
+        options[:data][:controller] = 'tooltip'
+
+        # Generate the time ago element with tooltip
+        content_tag(:span, options) do
+          tooltip_text = spree_time(time)
+          local_time_ago(time, class: '', title: nil) + tooltip(tooltip_text)
+        end
+      end
+
+      def tooltip(text = nil, &block)
+        content_tag(:span, role: 'tooltip', data: { tooltip_target: 'tooltip' }, class: 'tooltip-container') do
+          if block_given?
+            capture(&block)
+          else
+            text
+          end
+        end
+      end
     end
   end
 end