spree_admin 5.0.0.rc1

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

@@ -0,0 +1,179 @@
+module Spree
+  module Admin
+    module OrdersHelper
+      TaxLine = Struct.new(:label, :display_amount, :item, :for_shipment, keyword_init: true) do
+        def name
+          item_name = item.name
+          item_name += " #{Spree.t(:shipment).downcase}" if for_shipment
+
+          "#{label} (#{item_name})"
+        end
+      end
+
+      def order_summary_tax_lines_additional(order)
+        line_item_taxes = order.line_item_adjustments.tax.map { |tax_adjustment| map_to_tax_line(tax_adjustment) }
+        shipment_taxes = order.shipment_adjustments.tax.map { |tax_adjustment| map_to_tax_line(tax_adjustment, for_shipment: true) }
+
+        line_item_taxes + shipment_taxes
+      end
+
+      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
+          if order.order_refunded?
+            icon('credit-card-refund') + Spree.t('payment_states.refunded')
+          elsif order.partially_refunded?
+            icon('credit-card-refund') + Spree.t('payment_states.partially_refunded')
+          elsif order.payment_state == 'failed' || order.payment_state == 'void'
+            icon('cancel') + Spree.t('payment_states.failed')
+          elsif order.payment_state == 'paid'
+            icon('check') + Spree.t('payment_states.paid')
+          else
+            icon('progress') + Spree.t("payment_states.#{order.payment_state}")
+          end
+        end
+      end
+
+      def order_shipment_state(order, options = {})
+        shipment_state(order.shipment_state, options)
+      end
+
+      def shipment_state(shipment_state, options = {})
+        return if shipment_state.blank?
+
+        content_tag :span, class: "badge  #{options[:class]} badge-#{shipment_state}" do
+          if shipment_state == 'shipped'
+            icon('check') + Spree.t('shipment_states.shipped')
+          elsif shipment_state == 'partial'
+            icon('progress-check') + Spree.t('shipment_states.partial')
+          elsif shipment_state == 'canceled'
+            icon('cancel') + Spree.t('shipment_states.canceled')
+          else
+            icon('progress') + Spree.t("shipment_states.#{shipment_state}")
+          end
+        end
+      end
+
+      def payment_state_badge(state)
+        content_tag :span, class: "badge badge-#{state}" do
+          if state == 'completed'
+            icon('check') + Spree.t('payment_states.completed')
+          elsif state == 'failed'
+            icon('cancel') + Spree.t('payment_states.failed')
+          elsif state == 'processing'
+            icon('progress') + Spree.t('payment_states.processing')
+          else
+            Spree.t("payment_states.#{state}")
+          end
+        end
+      end
+
+      # Renders all the extension partials that may have been specified in the extensions
+      def event_links(order, events)
+        links = []
+        events.each do |event|
+          next unless order.send("can_#{event}?")
+
+          label = Spree.t(event, scope: 'admin.order.events', default: Spree.t(event))
+          links << button_link_to(
+            label.capitalize,
+            [event.to_sym, :admin, order],
+            method: :put,
+            icon: event.to_s + '.svg',
+            data: { turbo_confirm: Spree.t(:order_sure_want_to, event: label) },
+            class: 'btn-light'
+          )
+        end
+        safe_join(links, ''.html_safe)
+      end
+
+      def line_item_shipment_price(line_item, quantity)
+        Spree::Money.new(line_item.price * quantity, currency: line_item.currency)
+      end
+
+      def ready_to_ship_orders_count
+        @ready_to_ship_orders_count ||= begin
+          if defined?(current_vendor)
+            if current_vendor.present?
+              current_vendor.orders.complete.ready_to_ship.count
+            else
+              current_store.orders.without_vendor.complete.ready_to_ship.count
+            end
+          else
+            current_store.orders.complete.ready_to_ship.count
+          end
+        end
+      end
+
+      def avs_response_code
+        {
+          'A' => 'Street address matches, but 5-digit and 9-digit postal code do not match.',
+          'B' => 'Street address matches, but postal code not verified.',
+          'C' => 'Street address and postal code do not match.',
+          'D' => 'Street address and postal code match. ',
+          'E' => 'AVS data is invalid or AVS is not allowed for this card type.',
+          'F' => "Card member's name does not match, but billing postal code matches.",
+          'G' => 'Non-U.S. issuing bank does not support AVS.',
+          'H' => "Card member's name does not match. Street address and postal code match.",
+          'I' => 'Address not verified.',
+          'J' => "Card member's name, billing address, and postal code match.",
+          'K' => "Card member's name matches but billing address and billing postal code do not match.",
+          'L' => "Card member's name and billing postal code match, but billing address does not match.",
+          'M' => 'Street address and postal code match. ',
+          'N' => 'Street address and postal code do not match.',
+          'O' => "Card member's name and billing address match, but billing postal code does not match.",
+          'P' => 'Postal code matches, but street address not verified.',
+          'Q' => "Card member's name, billing address, and postal code match.",
+          'R' => 'System unavailable.',
+          'S' => 'Bank does not support AVS.',
+          'T' => "Card member's name does not match, but street address matches.",
+          'U' => 'Address information unavailable. Returned if the U.S. bank does not support non-U.S. AVS or if the AVS in a U.S. bank is not functioning properly.',
+          'V' => "Card member's name, billing address, and billing postal code match.",
+          'W' => 'Street address does not match, but 9-digit postal code matches.',
+          'X' => 'Street address and 9-digit postal code match.',
+          'Y' => 'Street address and 5-digit postal code match.',
+          'Z' => 'Street address does not match, but 5-digit postal code matches.'
+        }
+      end
+
+      def cvv_response_code
+        {
+          'M' => 'CVV2 Match',
+          'N' => 'CVV2 No Match',
+          'P' => 'Not Processed',
+          'S' => 'Issuer indicates that CVV2 data should be present on the card, but the merchant has indicated data is not present on the card',
+          'U' => 'Issuer has not certified for CVV2 or Issuer has not provided Visa with the CVV2 encryption keys',
+          '' => 'Transaction failed because wrong CVV2 number was entered or no CVV2 number was entered'
+        }
+      end
+
+      def order_filter_dropdown_value
+        if params.dig(:q, :shipment_state_not_in) == ['shipped', 'canceled']
+          Spree.t('admin.orders.unfulfilled')
+        elsif params.dig(:q, :shipment_state_eq) == 'shipped'
+          Spree.t('admin.orders.fulfilled')
+        elsif params.dig(:q, :state_in) == ['canceled','partially_canceled']
+          Spree.t('admin.orders.canceled')
+        elsif params.dig(:q, :refunded)&.present?
+          Spree.t('admin.orders.refunded')
+        elsif params.dig(:q, :partially_refunded)&.present?
+          Spree.t('admin.orders.partially_refunded')
+        else
+          Spree.t('admin.orders.all_orders')
+        end
+      end
+
+      private
+
+      def map_to_tax_line(tax_adjustment, for_shipment: false)
+        TaxLine.new(
+          label: tax_adjustment.label,
+          display_amount: tax_adjustment.display_amount,
+          item: tax_adjustment.adjustable,
+          for_shipment: for_shipment
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,130 @@
+module Spree
+  module Admin
+    module PageBuilderHelper
+      def system_fonts_list
+        ['Sans-serif', 'Serif', 'Mono']
+      end
+
+      def google_fonts_list
+        ['Abel', 'Abril Fatface', 'Alegreya', 'Alegreya Sans', 'Alice', 'Amiri', 'Anonymous Pro', 'Arapey', 'Archivo', 'Archivo Narrow',
+         'Arimo', 'Armata', 'Arvo', 'Asap', 'Assistant', 'Asul', 'Bitter', 'Cabin', 'Cardo', 'Catamaran', 'Chivo', 'Cormorant',
+         'Crimson Text', 'DM Sans', 'Domine', 'Dosis', 'Eczar', 'Figtree', 'Fira Sans', 'Fjalla One', 'Glegoo', 'IBM Plex Sans', 'Inconsolata',
+         'Inknut Antiqua', 'Inter', 'Josefin Sans', 'Josefin Slab', 'Kalam', 'Karla', 'Kreon', 'Lato', 'Libre Baskerville',
+         'Libre Franklin', 'Lobster', 'Lobster Two', 'Lora', 'Maven Pro', 'Megrim', 'Merriweather Sans', 'Montserrat',
+         'Mouse Memoirs', 'Muli', 'Neuton', 'News Cycle', 'Nobile', 'Noticia Text', 'Noto Serif', 'Nunito', 'Nunito Sans',
+         'Old Standard TT', 'Open Sans', 'Oswald', 'Ovo', 'Oxygen', 'PT Mono', 'PT Sans', 'PT Sans Narrow', 'PT Serif',
+         'Pacifico', 'Playball', 'Playfair Display', 'Poppins', 'Prata', 'Prompt', 'Quattrocento', 'Quattrocento Sans',
+         'Questrial', 'Quicksand', 'Rajdhani', 'Raleway', 'Righteous', 'Roboto', 'Roboto Condensed', 'Roboto Mono', 'Roboto Slab',
+         'Rubik', 'Shadows Into Light', 'Slabo 13px', 'Slabo 27px', 'Smooch', 'Source Code Pro', 'Source Sans Pro', 'Space Mono',
+         'Syne', 'Tenor Sans', 'Tinos', 'Titillium Web', 'Ubuntu', 'Unica One', 'Unna', 'Varela', 'Varela Round', 'Vidaloka',
+         'Volkhov', 'Vollkorn', 'Work Sans']
+      end
+
+      def color_palettes
+        [
+          {
+            primary_color: '#1e4bd1',
+            text_color: '#000000',
+            border_color: '#d1d5db',
+            button_text_color: '#ffffff',
+            background_color: '#F9FAFB'
+          },
+          {
+            primary_color: '#e63946',
+            text_color: '#1d3557',
+            border_color: '#a8dadc',
+            button_text_color: '#ffffff',
+            background_color: '#f1faee'
+          },
+          {
+            primary_color: '#264653',
+            text_color: '#060C0E',
+            border_color: '#2a9d8f',
+            button_text_color: '#ffffff',
+            background_color: '#e9c46a'
+          },
+          {
+            primary_color: '#606c38',
+            text_color: '#283618',
+            border_color: '#dda15e',
+            button_text_color: '#ffffff',
+            background_color: '#fefae0'
+          },
+          {
+            primary_color: '#FF961F',
+            text_color: '#023047',
+            border_color: '#219EBC',
+            button_text_color: '#FFEEDA',
+            background_color: '#DEF0F7'
+          },
+          {
+            primary_color: '#181CF1',
+            text_color: '#011627',
+            border_color: '#7678ED',
+            button_text_color: '#FFFFFF',
+            background_color: '#FFF5D6'
+          }
+        ]
+      end
+
+      def color_palette_active?(color_palette)
+        @theme_preview&.primary_color&.downcase == color_palette[:primary_color].downcase &&
+          @theme_preview&.text_color&.downcase == color_palette[:text_color].downcase &&
+          @theme_preview&.border_color&.downcase == color_palette[:border_color].downcase &&
+          @theme_preview&.button_text_color&.downcase == color_palette[:button_text_color].downcase &&
+          @theme_preview&.background_color&.downcase == color_palette[:background_color].downcase
+      end
+
+      def all_fonts_options
+        @all_fonts_options ||= system_fonts_list + google_fonts_list
+      end
+
+      def all_linkable_pages
+        @all_linkable_pages ||= Spree::Page.
+                                linkable.
+                                without_previews.
+                                where(pageable: [@theme, current_store]).
+                                map { |page| [page.display_name, page.id] }
+      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] }
+      end
+
+      def refresh_theme_preview(section = nil, block = nil)
+        reload_params = section.present? ? "{ frame: 'section-#{section.id}' }" : "{ action: 'replace' }"
+
+        editor_id = if block.present?
+                      "block-#{block.id}"
+                    elsif section.present?
+                      "section-#{section.id}"
+                    end
+
+        turbo_stream.replace :iframe_preview_scripts do
+          turbo_frame_tag :iframe_preview_scripts do
+            javascript_tag do
+              raw <<~JS
+                document.getElementById('page-builder-preview').contentWindow.window.Turbo.visit(
+                  document.getElementById('page-builder').dataset.pageBuilderPreviewUrlValue + '&editor_id=#{editor_id}',
+                  #{reload_params}
+                )
+              JS
+            end
+          end
+        end
+      end
+
+      def page_preview_url
+        preview_url = @page.preview_url(@theme_preview, @page_preview)
+        return if preview_url.blank?
+
+        "#{preview_url}&page_builder=true"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Spree
+  module Admin
+    module PaymentsHelper
+      def payment_method_name(payment)
+        payment_method = payment.payment_method
+
+        if can?(:update, payment_method)
+          link_to payment_method.name, spree.edit_admin_payment_method_path(payment_method)
+        else
+          payment_method.name
+        end
+      end
+
+      def payment_method_icon_tag(payment_method, opts = {})
+        image_tag "payment_icons/#{payment_method}.svg", opts
+      rescue Sprockets::Rails::Helper::AssetNotFound
+      end
+
+      def available_payment_methods
+        @available_payment_methods ||= Spree::PaymentMethod.providers.map { |provider| provider.name.constantize.new }.delete_if { |payment_method| !payment_method.show_in_admin? || current_store.payment_methods.pluck(:type).include?(payment_method.type) }.sort_by(&:name)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Spree
+  module Admin
+    module PostsHelper
+      def post_authors_select_options
+        current_store.admin_users.map { |user| [user.name, user.id] }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,127 @@
+module Spree
+  module Admin
+    module ProductsHelper
+      def display_admin_price(product_or_variant)
+        price_in_current_currency = product_or_variant.price_in(current_currency)
+
+        if price_in_current_currency.amount
+          price_in_current_currency.display_price_including_vat_for(current_price_options).to_html
+        end
+      end
+
+      def display_inventory(product_or_variant)
+        if product_or_variant.total_on_hand == BigDecimal::INFINITY
+          content_tag :span, class: 'text-muted' do
+            Spree.t('admin.not_tracking_inventory')
+          end
+        else
+          stock = if product_or_variant.total_on_hand.positive?
+                    "#{product_or_variant.total_on_hand} #{Spree.t(:in_stock).downcase}"
+                  else
+                    content_tag(:span, "0 #{Spree.t(:in_stock).downcase}", class: 'text-danger')
+                  end
+          if product_or_variant.respond_to?(:variants) && product_or_variant.variants.size.positive?
+            stock += " - #{product_or_variant.variants.size} #{Spree.t(:variants).downcase}"
+          end
+          stock
+        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')
+        else
+          content_tag(:span, class: "badge  badge-#{product.status}") do
+            if product.active?
+              icon('check')
+            else
+              ''
+            end + available_status(product)
+          end.html_safe
+        end
+      end
+
+      def product_currencies(product)
+        product_currencies = product.prices_including_master.map(&:currency).compact.uniq.map do |currency|
+          ::Money::Currency.find(currency)
+        end
+
+        (supported_currencies_list + product_currencies).compact.uniq
+      end
+
+      # will return a human readable string
+      def available_status(product)
+        return Spree.t('admin.products.draft') if product.draft?
+        return Spree.t('admin.products.active') if product.available?
+        return Spree.t('admin.products.archived') if product.archived?
+        return Spree.t('admin.products.paused') if product.respond_to?(:paused?) && product.paused?
+        return Spree.t('admin.products.deleted') if product.deleted?
+        return ''
+      end
+
+      def available_status_options(product)
+        options = ['draft', 'active', 'archived']
+        options.delete('active') if cannot?(:activate, product)
+        options.map { |status| [Spree.t(status), status] }
+      end
+
+      def map_categories(product)
+        category_tree = ['n/a', 'n/a']
+
+        category = product.main_taxon&.pretty_name.to_s
+        return category_tree if category.blank?
+
+        category.split('->').map(&:strip).map.with_index { |c, index| category_tree[index] = c }
+
+        category_tree
+      end
+
+      def product_filter_status_dropdown_value
+        case params.dig(:q, :status_eq)
+        when 'active'
+          Spree.t('admin.products.active')
+        when 'draft'
+          Spree.t('admin.products.draft')
+        when 'archived'
+          Spree.t('admin.products.archived')
+        else
+          Spree.t('admin.products.all_statuses')
+        end
+      end
+
+      def product_filter_stock_dropdown_value
+        if params.dig(:q, :in_stock_items) == '1'
+          Spree.t('admin.products.in_stock')
+        elsif params.dig(:q, :out_of_stock_items) == '1'
+          Spree.t('admin.products.out_of_stock')
+        else
+          Spree.t('admin.products.any_stock')
+        end
+      end
+
+      def show_product_status_help_bubble?
+        false
+      end
+
+      def variant_form_stock_location_options
+        options_for_select(available_stock_locations_list)
+      end
+
+      def product_list_filters_search_form_path
+        [:admin, @search]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Spree
+  module Admin
+    module PromotionActionsHelper
+      def options_for_promotion_action_types(promotion)
+        existing = promotion.actions.pluck(:type)
+        Rails.application.config.spree.promotions.actions.map(&:name).reject { |r| existing.include? r }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Spree
+  module Admin
+    module PromotionRulesHelper
+      def options_for_promotion_rule_types(promotion)
+        existing = promotion.rules.pluck(:type)
+        Rails.application.config.spree.promotions.rules.map(&:name).reject { |r| existing.include? r }
+      end
+
+      def active_options_for_option_value_promotion_rule(promotion_rule)
+        eligible_values = promotion_rule.preferred_eligible_values || []
+        return [] if eligible_values.empty?
+
+        Spree::OptionValueVariant.where(id: eligible_values).to_tom_select_json
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Spree
+  module Admin
+    module PromotionsHelper
+      def promotion_filter_dropdown_value
+        if params.dig(:q, :expired)
+          Spree.t(:expired)
+        elsif params.dig(:q, :active)
+          Spree.t(:active)
+        else
+          Spree.t(:all)
+        end
+      end
+
+      def promotion_status(promotion)
+        if promotion.active?
+          Spree.t(:active)
+        elsif promotion.expired?
+          Spree.t(:expired)
+        elsif promotion.inactive?
+          Spree.t(:inactive)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Spree
+  module Admin
+    module ReimbursementTypeHelper
+      def reimbursement_type_name(reimbursement_type)
+        reimbursement_type.present? ? reimbursement_type.name.humanize : ''
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Spree
+  module Admin
+    module SessionAssetsHelper
+      def ensure_session_uploaded_assets_uuid
+        session['spree.admin.uploaded_assets.uuid'] ||= SecureRandom.uuid
+      end
+
+      def store_uploaded_asset_in_session(asset)
+        ensure_session_uploaded_assets_uuid
+        asset.update(session_uploaded_assets_uuid: session['spree.admin.uploaded_assets.uuid'])
+      end
+
+      def session_uploaded_assets
+        return Spree::Asset.none if session['spree.admin.uploaded_assets.uuid'].blank?
+
+        Spree::Asset.with_session_uploaded_assets_uuid(session['spree.admin.uploaded_assets.uuid']).where(viewable_id: nil)
+      end
+
+      def clear_session_for_uploaded_assets
+        session.delete('spree.admin.uploaded_assets.uuid')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Spree::Admin
+  module ShipmentHelper
+    def can_ship?(shipment)
+      can?(:update, shipment) && shipment.shippable?
+    end
+
+    def stock_locations_for_split(variant)
+      available_stock_locations.
+        joins(:stock_items).
+        where(spree_stock_items: { variant_id: variant.id }).
+        group(:id).
+        pluck(:name, "sum(spree_stock_items.count_on_hand)", :id).
+        map { |name, count, id| ["#{name.capitalize} (#{count} on hand)", "stock-location_#{id}"] }
+    end
+
+    def shipments_for_transfer(current_shipment)
+      current_shipment.
+        order.
+        shipments.
+        ready_or_pending.
+        where(stock_location: available_stock_locations).
+        where.not(id: current_shipment.id).
+        pluck(:number, :id).
+        map { |n, i| [n, "shipment_#{i}"] }
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module Spree
+  module Admin
+    module SortableTreeHelper
+      def sortable_tree_bar(parent_resource, child_resource)
+        partial_name = parent_resource.class.name.demodulize.underscore
+        render "spree/admin/shared/sortable_tree/#{partial_name}", parent_resource: parent_resource, child_resource: child_resource
+      end
+
+      def build_sortable_tree(parent_resource, child_resource)
+        descendants = []
+
+        unless child_resource.leaf?
+          child_resource.children.includes(image_attachment: :blob, square_image_attachment: :blob).each do |child_item|
+            descendants << build_sortable_tree(parent_resource, child_item) unless child_resource.leaf?
+          end
+        end
+
+        row = sortable_tree_bar(parent_resource, child_resource)
+        container = content_tag(:div, raw(descendants.join), data: { sortable_tree_parent_id_value: child_resource.id })
+
+        content_tag(:div, row + container,
+                    id: spree_dom_id(child_resource),
+                    class: 'sortable-tree-item draggable',
+                    data: {
+                      sortable_tree_resource_name_value: :taxon,
+                      sortable_tree_update_url_value: spree.reposition_admin_taxonomy_taxon_path(child_resource.taxonomy_id, child_resource.id)
+                    })
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module Spree
+  module Admin
+    module StockLocationsHelper
+      def available_stock_locations(_opts = {})
+        Spree::StockLocation.order_default.active.accessible_by(current_ability)
+      end
+
+      def available_stock_locations_list(opts = {})
+        available_stock_locations(opts).map { |stock_location| [stock_location.display_name, stock_location.id] }
+      end
+
+      # overwrite this to customize behavior
+      def available_stock_locations_for_product(_product)
+        available_stock_locations
+      end
+
+      def default_stock_location_for_product(_product)
+        current_store.default_stock_location
+      end
+    end
+  end
+end