spree_admin 5.0.0.rc1

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

@@ -0,0 +1,46 @@
+module Spree
+  module Admin
+    module StoreHelper
+      include LocaleHelper
+
+      def weight_units(store = nil)
+        store ||= current_store
+
+        if store.metric_unit_system?
+          [
+            [Spree.t('weight_units.kilogram'), 'kg'],
+            [Spree.t('weight_units.gram'), 'g']
+          ]
+        else
+          [
+            [Spree.t('weight_units.pound'), 'lb'],
+            [Spree.t('weight_units.ounce'), 'oz']
+          ]
+        end
+      end
+
+      def dimension_units(store = nil)
+        store ||= current_store
+
+        if store.metric_unit_system?
+          [
+            [Spree.t('dimension_units.centimeter'), 'cm'],
+            [Spree.t('dimension_units.millimeter'), 'mm']
+          ]
+        else
+          [
+            [Spree.t('dimension_units.inch'), 'in'],
+            [Spree.t('dimension_units.foot'), 'ft']
+          ]
+        end
+      end
+
+      def unit_systems
+        [
+          [Spree.t('unit_systems.metric_system'), 'metric'],
+          [Spree.t('unit_systems.imperial_system'), 'imperial']
+        ]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+module Spree
+  module Admin
+    module StoresHelper
+      def available_stores
+        @available_stores ||= Spree::Store.accessible_by(current_ability)
+      end
+
+      DEFAULT_ICON_SIZE = 40
+
+      def store_admin_icon(store, opts = {})
+        opts[:class] ||= 'rounded-sm bg-white border'
+        opts[:height] ||= DEFAULT_ICON_SIZE
+        opts[:width] ||= DEFAULT_ICON_SIZE
+
+        store ||= current_store
+
+        return unless store
+
+        Rails.cache.fetch(["#{store.cache_key_with_version}/admin_icon", opts.to_param]) do
+          if store.logo&.attached? && store.logo&.variable?
+            image_tag(
+              main_app.cdn_image_url(
+                store.logo.variant(
+                  spree_image_variant_options(
+                    resize_to_fill: [opts[:width] * 2, opts[:height] * 2]
+                  )
+                )
+              ),
+              class: opts[:class],
+              width: opts[:width],
+              height: opts[:height]
+            )
+          elsif store.favicon_image&.attached? && store.favicon_image&.variable?
+            image_tag(
+              main_app.cdn_image_url(
+                store.favicon_image.variant(
+                  spree_image_variant_options(
+                    resize_to_fill: [opts[:width] * 2, opts[:height] * 2]
+                  )
+                )
+              ),
+              class: opts[:class],
+              width: opts[:width],
+              height: opts[:height]
+            )
+          else
+            first_letter_icon(store.name, opts)
+          end
+        end
+      end
+
+      def first_letter_icon(name, opts = {})
+        opts[:height] ||= DEFAULT_ICON_SIZE
+        opts[:width] ||= DEFAULT_ICON_SIZE
+        opts[:class] ||= ''
+        opts[:class] += ' rounded text-dark d-flex align-items-center justify-content-center bg-gray-200'
+        content_tag(:span, name[0].upcase, class: opts[:class], style: "height: #{opts[:height]}px; width: #{opts[:width]}px;")
+      end
+
+      def store_logo(store = nil, options = {})
+        store ||= current_store
+        return unless store
+
+        opts = { width: 30, height: 30, crop: :fit, quality: :auto, fetch_format: :auto, alt: store.name, title: store.name, class: 'with-tip' }
+        opts.merge!(options)
+
+        if store.is_a?(Spree::Store) && store.logo&.attached? && store.logo&.variable?
+          image_tag(
+            main_app.cdn_image_url(
+              store.logo.variant(
+                spree_image_variant_options(
+                  resize_to_fill: [opts[:width] * 2, opts[:height] * 2]
+                )
+              )
+            ),
+            opts
+          )
+        else
+          initials = store.name.split.map(&:first).join.upcase
+          image_tag("https://eu.ui-avatars.com/api/?name=#{initials}&background=random", width: opts[:height], height: opts[:height],
+                                                                                        class: 'rounded with-tip', title: store.name)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module Spree
+  module Admin
+    module TagsHelper
+      def tags_scope
+        @tags_scope ||= ActsAsTaggableOn::Tag.for_context(:tags)
+      end
+
+      def tags_json_array
+        @tags_json_array ||= tags_scope.pluck(:id, :name).map { |id, name| { id: id, name: name } }.as_json
+      end
+
+      def post_tags_scope
+        @post_tags_scope ||= ActsAsTaggableOn::Tag.
+                             joins(:taggings).
+                             where("#{ActsAsTaggableOn.taggings_table}.taggable_type = ?", 'Spree::Post').
+                             for_context(:tags)
+      end
+
+      def post_tags_json_array
+        @post_tags_json_array ||= post_tags_scope.pluck(:id, :name).map { |id, name| { id: id, name: name } }.as_json
+      end
+
+      def user_tags_scope
+        @user_tags_scope ||= ActsAsTaggableOn::Tag.
+                             joins(:taggings).
+                             where("#{ActsAsTaggableOn.taggings_table}.taggable_type = ?", Spree.user_class.to_s).
+                             for_context(:tags)
+      end
+
+      def user_tags_json_array
+        @user_tags_json_array ||= user_tags_scope.pluck(:id, :name).map { |id, name| { id: id, name: name } }.as_json
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Spree
+  module Admin
+    module TaxonsHelper
+      def taxons_scope(with_automatic: false)
+        @memoized_taxons_scope ||= {}
+        @memoized_taxons_scope[with_automatic] ||= begin
+          scope = current_store.taxons.where.not(parent_id: nil)
+          scope = scope.where(automatic: false) unless with_automatic
+          scope
+        end
+      end
+
+      def taxons_options_json_array(with_automatic: false)
+        taxons_scope(with_automatic: with_automatic).pluck(:id, :pretty_name).map { |id, pretty_name| { id: id, name: pretty_name } }.as_json
+      end
+
+      def taxon_sort_options_for_select
+        @taxon_sort_options_for_select ||= Spree::Taxon::SORT_ORDERS.map do |sort_order|
+          [
+            Spree.t("products_sort_options.#{sort_order.underscore}"),
+            sort_order
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Spree
+  module Admin
+    module ThemesHelper
+      def available_themes
+        @available_themes ||= Spree::Theme.available_themes.sort_by(&:name).reject { |theme_class| current_store.themes.any? { |theme| theme.class.to_s == theme_class.to_s } }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Spree
+  module Admin
+    module TranslationsHelper
+      def link_to_edit_translations(resource, classes: 'text-left dropdown-item')
+        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)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module Spree
+  module Admin
+    module TurboHelper
+      def turbo_close_modal(modal_id = nil)
+        modal_id ||= 'modal'
+
+        turbo_stream.replace :modal_scripts do
+          turbo_frame_tag :modal_scripts do
+            javascript_tag do
+              raw <<~JS
+                if (document.querySelector('##{modal_id}')) {
+                  window.$("##{modal_id}").modal('hide');
+                }
+              JS
+            end
+          end
+        end
+      end
+
+      def turbo_render_alerts
+        turbo_stream.replace :alerts do
+          render 'spree/admin/shared/alerts'
+        end
+      end
+
+      def turbo_save_button_tag(label = Spree.t('actions.save'), opts = {}, &block)
+        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-enable-button-target'] = 'button'
+
+        if block_given?
+          button_tag opts, &block
+        else
+          button_tag label, opts
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module Spree
+  module Admin
+    module UsersHelper
+      def customer_location(user)
+        address = user.billing_address || user.shipping_address || user.addresses.first
+
+        return if address.nil?
+
+        "#{address.city}, #{address&.state_name_text || address&.country&.to_s}"
+      end
+
+      def customer_location_flag(user)
+        address = user.billing_address || user.shipping_address || user.addresses.first
+
+        return if address.nil?
+
+        country = address.country
+
+        return if country.nil?
+
+        ::Country.new(country.iso).emoji_flag
+      end
+
+      def customer_full_name(user)
+        user.name&.full
+      end
+
+      def users_for_select_options
+        @users_for_select_options ||= Spree.user_class.accessible_by(current_ability).pluck(:id, :email).map { |id, email| { id: id, name: email } }.as_json
+      end
+
+      def user_roles_json_array
+        @user_roles_json_array ||= Spree::Role.pluck(:id, :name).map { |id, name| { id: id, name: name } }.as_json
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module Spree
+  module Admin
+    module WebhooksSubscribersHelper
+      def event_checkbox_for(resource_name, form)
+        content_tag :div, class: 'col-xs-12 col-sm-6 col-md-4 col-lg-4 form-group' do
+          content_tag :div, class: 'custom-control custom-switch' do
+            (form.check_box resource_name, event_checkbox_opts(resource_name), true, nil) + ' ' +
+              form.label(resource_name, Spree.t("admin.webhooks_subscribers.#{resource_name.to_s.pluralize}"), class: 'custom-control-label')
+          end
+        end
+      end
+
+      def subscribe_to_all_events?
+        @webhooks_subscriber.new_record? || @webhooks_subscriber.subscriptions == ['*']
+      end
+
+      private
+
+      def event_checkbox_opts(resource_name)
+        {
+          class: 'events-checkbox custom-control-input',
+          checked: subscribed_to_resource?(resource_name)
+        }
+      end
+
+      def subscribed_to_resource?(resource_name)
+        @webhooks_subscriber.subscriptions&.any? { |event| event.include? "#{resource_name}." }
+      end
+    end
+  end
+end

data/app/helpers/tom_select_helper.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module TomSelectHelper
+  #
+  # @param [String] name
+  # @param [Hash] options
+  def tom_select_tag(name, options = { template: false, multiple: false, url: nil, active_option: nil, class: 'w-100', create: false, select_data: {} })
+    stimulus_options = options[:data] || {}
+    stimulus_options[:controller] = 'select' unless options[:template].present?
+    stimulus_options['select-active-option-value'] = options[:active_option].as_json if options[:active_option]
+    stimulus_options['select-empty-option-value'] = options[:empty_option] if options[:empty_option]
+    stimulus_options['select-options-value'] = options[:options].as_json if options[:options]
+    stimulus_options['select-url-value'] = options[:url] if options[:url]
+    stimulus_options['select-remote-search-value'] = options[:remote_search] if options[:remote_search]
+    stimulus_options['select-remote-search-params-value'] = options[:remote_search_params] if options[:remote_search_params]
+    stimulus_options['select-remote-search-active-option-value'] = options[:remote_search_active_option].as_json if options[:remote_search_active_option]
+    stimulus_options['select-multiple-value'] = options[:multiple]
+    stimulus_options['select-create-value'] = options[:create]
+    stimulus_options['select-value-field-value'] = options[:value_field] if options[:value_field].present?
+    stimulus_options['select-search-field-value'] = options[:value_field] if options[:search_field].present?
+    stimulus_options['select-label-field-value'] = options[:value_field] if options[:label_field].present?
+    stimulus_options['select-sort-field-value'] = options[:value_field] if options[:sort_field].present?
+    html_select_options = if options[:grouped_options].present?
+                            grouped_options_for_select(options[:grouped_options], options[:active_option])
+                          else
+                            options_for_select(
+                              options[:options] || options[:preloaded_options] || [], options[:active_option]
+                            )
+                          end
+
+    content_tag :div, data: stimulus_options, class: options[:class] do
+      select_tag name, html_select_options,
+                 multiple: options[:multiple],
+                 data: { 'select-target': 'input', **(options[:select_data] || {}) },
+                 class: options[:select_class] || 'd-none',
+                 required: options[:required],
+                 disabled: options[:disabled],
+                 include_blank: options[:include_blank],
+                 placeholder: options[:placeholder]
+    end
+  end
+end

data/app/javascript/spree/admin/application.js

@@ -0,0 +1,157 @@
+// Rails stuff
+import "@rails/actioncable"
+import "@rails/actiontext"
+import "@hotwired/turbo-rails"
+import * as ActiveStorage from "@rails/activestorage"
+ActiveStorage.start()
+
+import "trix"
+
+import "chartkick"
+import "Chart.bundle"
+
+import LocalTime from "local-time"
+import "mapkick/bundle"
+
+// Helpers
+import 'spree/admin/helpers/tinymce'
+import 'spree/admin/helpers/canvas'
+import 'spree/admin/helpers/trix/video_embed'
+import 'spree/admin/helpers/bootstrap'
+
+// Stimulus controllers
+import { Application } from "@hotwired/stimulus"
+
+let application
+if (typeof Stimulus === 'undefined') {
+  application = Application.start()
+
+  // Configure Stimulus development experience
+  application.debug = false
+  window.Stimulus = application
+} else {
+  application = window.Stimulus
+}
+import AutoSubmit from '@stimulus-components/auto-submit'
+import CheckboxSelectAll from 'stimulus-checkbox-select-all'
+import TextareaAutogrow from 'stimulus-textarea-autogrow'
+import Notification from 'stimulus-notification'
+import PasswordVisibility from 'stimulus-password-visibility'
+import RailsNestedForm from '@stimulus-components/rails-nested-form'
+import Reveal from 'stimulus-reveal-controller'
+import Sortable from 'stimulus-sortable'
+import { Tabs } from 'tailwindcss-stimulus-components'
+
+import ActiveStorageUpload from 'spree/admin/controllers/active_storage_upload_controller'
+import AssetUploaderController from 'spree/admin/controllers/asset_uploader_controller'
+import AutocompleteSelectController from 'spree/admin/controllers/autocomplete_select_controller'
+import BetterSliderController from 'spree/admin/controllers/better_slider_controller'
+import BlockFormController from 'spree/admin/controllers/block_form_controller'
+import BootstrapTabs from 'spree/admin/controllers/bootstrap_tabs_controller'
+import BulkOperationController from 'spree/admin/controllers/bulk_operation_controller'
+import CalculatorFieldsController from 'spree/admin/controllers/calculator_fields_controller'
+import CalendarRangeController from 'spree/admin/controllers/calendar_range_controller'
+import Clipboard from 'spree/admin/controllers/clipboard_controller'
+import ColorPaletteController from 'spree/admin/controllers/color_palette_controller'
+import ColorPickerController from 'spree/admin/controllers/color_picker_controller'
+import FiltersController from 'spree/admin/controllers/filters_controller'
+import FontPickerController from 'spree/admin/controllers/font_picker_controller'
+import MediaFormController from 'spree/admin/controllers/media_form_controller'
+import MultiInputController from 'spree/admin/controllers/multi_input_controller'
+import MultiTomSelectController from 'spree/admin/controllers/multi_tom_select_controller'
+import OrderBillingAddressController from 'spree/admin/controllers/order_billing_address_controller'
+import PageBuilderController from 'spree/admin/controllers/page_builder_controller'
+import PasswordToggle from 'spree/admin/controllers/password_toggle_controller'
+import ProductFormController from 'spree/admin/controllers/product_form_controller'
+import RangeInputController from 'spree/admin/controllers/range_input_controller'
+import ReturnItemsController from 'spree/admin/controllers/return_items_controller'
+import ReplaceController from 'spree/admin/controllers/replace_controller'
+import RowLinkController from 'spree/admin/controllers/row_link_controller'
+import RuleFormController from 'spree/admin/controllers/rule_form_controller'
+import SearchPickerController from 'spree/admin/controllers/search_picker_controller'
+import SectionFormController from 'spree/admin/controllers/section_form_controller'
+import SelectController from 'spree/admin/controllers/select_controller'
+import SeoFormController from 'spree/admin/controllers/seo_form_controller'
+import SlugFormController from 'spree/admin/controllers/slug_form_controller'
+import SortableTree from 'spree/admin/controllers/sortable_tree_controller'
+import StockTransferController from 'spree/admin/controllers/stock_transfer_controller'
+import StoreFormController from 'spree/admin/controllers/store_form_controller'
+import UnitSystemController from 'spree/admin/controllers/unit_system_controller'
+import VariantsFormController from 'spree/admin/controllers/variants_form_controller'
+import WebhooksSubscriberEventsController from 'spree/admin/controllers/webhook_subscriber_events_controller'
+import AddressAutocompleteController from 'spree/core/controllers/address_autocomplete_controller'
+import AddressFormController from 'spree/core/controllers/address_form_controller'
+import EnableButtonController from 'spree/core/controllers/enable_button_controller'
+
+application.register('active-storage-upload', ActiveStorageUpload)
+application.register('address-autocomplete', AddressAutocompleteController)
+application.register('address-form', AddressFormController)
+application.register('asset-uploader', AssetUploaderController)
+application.register('auto-submit', AutoSubmit)
+application.register('autocomplete-select', AutocompleteSelectController)
+application.register('better-slider', BetterSliderController)
+application.register('block-form', BlockFormController)
+application.register('bootstrap-tabs', BootstrapTabs) // We should merge with tabs controller/remove this
+application.register('bulk-operation', BulkOperationController)
+application.register('calculator-fields', CalculatorFieldsController)
+application.register('calendar-range', CalendarRangeController)
+application.register('checkbox-select-all', CheckboxSelectAll)
+application.register('clipboard', Clipboard)
+application.register('color-palette', ColorPaletteController)
+application.register('color-picker', ColorPickerController)
+application.register('enable-button', EnableButtonController)
+application.register('filters', FiltersController)
+application.register('font-picker', FontPickerController)
+application.register('media-form', MediaFormController)
+application.register('multi-input', MultiInputController)
+application.register('multi-tom-select', MultiTomSelectController)
+application.register('nested-form', RailsNestedForm)
+application.register('notification', Notification)
+application.register('order-billing-address', OrderBillingAddressController)
+application.register('page-builder', PageBuilderController)
+application.register('password-toggle', PasswordToggle)
+application.register('password-visibility', PasswordVisibility)
+application.register('product-form', ProductFormController)
+application.register('range-input', RangeInputController)
+application.register('replace', ReplaceController)
+application.register('return-items', ReturnItemsController)
+application.register('reveal', Reveal)
+application.register('row-link', RowLinkController)
+application.register('rule-form', RuleFormController)
+application.register('search-picker', SearchPickerController)
+application.register('section-form', SectionFormController)
+application.register('select', SelectController)
+application.register('seo-form', SeoFormController)
+application.register('slug-form', SlugFormController)
+application.register('sortable', Sortable)
+application.register('sortable-tree', SortableTree)
+application.register('stock-transfer', StockTransferController)
+application.register('store-form', StoreFormController)
+application.register('tabs', Tabs)
+application.register('textarea-autogrow', TextareaAutogrow)
+application.register('unit-system', UnitSystemController)
+application.register('variants-form', VariantsFormController)
+application.register('webhooks-subscriber-events', WebhooksSubscriberEventsController)
+
+LocalTime.start()
+
+Trix.config.blockAttributes.heading1.tagName = 'h2'
+
+document.addEventListener('turbo:before-visit', _event => {
+  const content = document.getElementById('content')
+  if (content) content.classList.add('blurred')
+})
+
+document.addEventListener('turbo:load', _event => {
+  const content = document.getElementById('content')
+  if (content) content.classList.remove('blurred')
+})
+
+document.addEventListener('turbo:submit-start', () => {
+  Turbo.navigator.delegate.adapter.progressBar.setValue(0)
+  Turbo.navigator.delegate.adapter.progressBar.show()
+})
+document.addEventListener('turbo:submit-end', () => {
+  Turbo.navigator.delegate.adapter.progressBar.setValue(1)
+  Turbo.navigator.delegate.adapter.progressBar.hide()
+})