spree_backend 4.6.1 → 4.7.0

data/app/models/spree/admin/main_menu/default_configuration_builder.rb

@@ -0,0 +1,263 @@
+module Spree
+  module Admin
+    module MainMenu
+      # rubocop:disable Metrics/ClassLength
+      class DefaultConfigurationBuilder
+        include Spree::Core::Engine.routes.url_helpers
+
+        def build
+          root = Root.new
+          add_dashboard_item(root)
+          add_orders_section(root)
+          add_returns_section(root)
+          add_products_section(root)
+          add_stocks_section(root)
+          add_reports_item(root)
+          add_promotions_section(root)
+          add_users_item(root)
+          add_content_section(root)
+          add_integrations_section(root)
+          add_oauth_section(root)
+          add_settings_section(root)
+          root
+        end
+
+        private
+
+        def add_dashboard_item(root)
+          root.add(ItemBuilder.new('dashboard', admin_dashboard_path).
+            with_label_translation_key('admin.home').
+            with_icon_key('house-door-fill.svg').
+            with_match_path('/dashboard').
+            build)
+        end
+
+        def add_orders_section(root)
+          items = [
+            ItemBuilder.new('completed', admin_orders_path(q: { completed_at_not_null: '1' })).
+              with_label_translation_key('admin.orders.all_orders').
+              with_match_path(/completed_at_not_null%5D=1/).
+              build,
+            ItemBuilder.new('draft_orders', admin_orders_path(q: { completed_at_not_null: false, state_eq: :cart })).
+              with_label_translation_key('admin.orders.draft_orders').
+              with_match_path(/cart/).
+              build,
+            ItemBuilder.new('abandoned_checkouts', admin_orders_path(
+                                                     q: { completed_at_not_null: false, state_in: %i[address delivery payment confirm] }
+                                                   )).
+              with_label_translation_key('admin.orders.abandoned_checkouts').
+              with_match_path(/state_in/).
+              build
+          ]
+
+          section = SectionBuilder.new('orders', 'inbox-fill.svg').
+                    with_admin_ability_check(Spree::Order).
+                    with_items(items).
+                    build
+          root.add(section)
+        end
+
+        def add_returns_section(root)
+          items = [
+            ItemBuilder.new('return_authorizations', admin_return_authorizations_path).
+              with_manage_ability_check(Spree::ReturnAuthorization).
+              with_match_path('/return_authorizations').
+              build,
+            ItemBuilder.new('customer_returns', admin_customer_returns_path).
+              with_manage_ability_check(Spree::CustomerReturn).
+              with_match_path('/customer_returns').
+              build
+          ]
+
+          section = SectionBuilder.new('returns', 'reply-fill.svg').
+                    with_manage_ability_check(Spree::ReturnAuthorization, Spree::CustomerReturn).
+                    with_items(items).
+                    build
+          root.add(section)
+        end
+
+        def add_products_section(root)
+          items = [
+            ItemBuilder.new('products', admin_products_path).with_match_path('/products').build,
+            ItemBuilder.new('option_types', admin_option_types_path).
+              with_admin_ability_check(Spree::OptionType).
+              with_match_path('/option_types').
+              build,
+            ItemBuilder.new('properties', admin_properties_path).
+              with_admin_ability_check(Spree::Property).
+              build,
+            ItemBuilder.new('prototypes', admin_prototypes_path).
+              with_admin_ability_check(Spree::Prototype).
+              build,
+            ItemBuilder.new('taxonomies', admin_taxonomies_path).
+              with_admin_ability_check(Spree::Taxonomy).
+              with_match_path('/taxonomies').
+              build,
+            ItemBuilder.new('taxons', admin_taxons_path).
+              with_admin_ability_check(Spree::Taxon).
+              with_match_path('/taxons').
+              build
+          ]
+
+          section = SectionBuilder.new('products', 'tags-fill.svg').
+                    with_admin_ability_check(Spree::Product).
+                    with_items(items).
+                    build
+          root.add(section)
+        end
+
+        def add_stocks_section(root)
+          items = [
+            ItemBuilder.new('stock_transfers', admin_stock_transfers_path).
+              with_manage_ability_check(Spree::StockTransfer).
+              build,
+            ItemBuilder.new('stock_locations', admin_stock_locations_path).
+              with_manage_ability_check(Spree::StockLocation).
+              build
+          ]
+
+          section = SectionBuilder.new('stocks', 'box-seam.svg').
+                    with_manage_ability_check(Spree::StockLocation, Spree::StockTransfer).
+                    with_label_translation_key('admin.tab.stock').
+                    with_items(items).
+                    build
+          root.add(section)
+        end
+
+        def add_reports_item(root)
+          root.add(ItemBuilder.new('reports', admin_reports_path).
+            with_icon_key('pie-chart-fill.svg').
+            with_admin_ability_check(Spree::Admin::ReportsController).
+            build)
+        end
+
+        def add_promotions_section(root)
+          items = [
+            ItemBuilder.new('promotions', admin_promotions_path).build,
+            ItemBuilder.new('promotion_categories', admin_promotion_categories_path).
+              with_admin_ability_check(Spree::PromotionCategory).
+              with_label_translation_key('admin.tab.promotion_categories').
+              build
+          ]
+
+          section = SectionBuilder.new('promotions', 'percent.svg').
+                    with_admin_ability_check(Spree::Promotion).
+                    with_items(items).
+                    build
+          root.add(section)
+        end
+
+        def add_users_item(root)
+          root.add(ItemBuilder.new('users', admin_users_path).
+            with_icon_key('people-fill.svg').
+            with_availability_check(->(ability, _store) { Spree.user_class && ability.can?(:admin, Spree.user_class) }).
+            build)
+        end
+
+        def add_content_section(root)
+          items = [
+            ItemBuilder.new('menus', admin_menus_path).
+              with_label_translation_key('admin.tab.navigation').
+              with_admin_ability_check(Spree::Menu).
+              with_match_path('/menus').
+              build,
+            ItemBuilder.new('cms_pages', admin_cms_pages_path).
+              with_label_translation_key('admin.tab.pages').
+              with_admin_ability_check(Spree::CmsPage).
+              with_match_path('/cms_pages').
+              build
+          ]
+
+          section = SectionBuilder.new('content', 'card-heading.svg').
+                    with_admin_ability_check(Spree::Menu).
+                    with_label_translation_key('admin.tab.content').
+                    with_items(items).
+                    build
+          root.add(section)
+        end
+
+        def add_integrations_section(root)
+          items = [
+            ItemBuilder.new('payment_methods', admin_payment_methods_path).
+              with_manage_ability_check(Spree::PaymentMethod).
+              with_match_path('/payment_methods').
+              build,
+            ItemBuilder.new('data_feeds', admin_data_feeds_path).
+              with_manage_ability_check(Spree::DataFeed).
+              with_label_translation_key('admin.data_feeds.data_feeds').
+              with_match_path('/data_feeds').
+              build,
+            ItemBuilder.new('webhook_subscribers', admin_webhooks_subscribers_path).
+              with_manage_ability_check(Spree::Webhooks::Subscriber).
+              with_label_translation_key('admin.tab.webhook_subscribers').
+              with_match_path('/webhooks_subscribers').
+              build
+          ]
+
+          section = SectionBuilder.new('integrations', 'stack.svg').
+                    with_manage_ability_check(Spree::Webhooks::Subscriber, Spree::PaymentMethod, Spree::DataFeed).
+                    with_label_translation_key('admin.tab.integrations').
+                    with_items(items).
+                    build
+          root.add(section)
+        end
+
+        def add_oauth_section(root)
+          section = SectionBuilder.new('oauth', 'terminal-fill.svg').
+                    with_admin_ability_check(Spree::OauthApplication).
+                    with_label_translation_key('admin.tab.apps').
+                    with_item(ItemBuilder.new('oauth_applications', admin_oauth_applications_path).
+              with_label_translation_key('admin.oauth_applications.list').
+              with_match_path('/oauth_applications').
+              build).
+                    build
+          root.add(section)
+        end
+
+        # rubocop:disable Metrics/AbcSize
+        def add_settings_section(root)
+          items = [
+            ItemBuilder.new('store', ->(store) { edit_admin_store_path(store) }).build,
+            ItemBuilder.new('tax_categories', admin_tax_categories_path).
+              with_manage_ability_check(Spree::TaxCategory).
+              build,
+            ItemBuilder.new('tax_rates', admin_tax_rates_path).with_manage_ability_check(Spree::TaxRate).build,
+            ItemBuilder.new('zones', admin_zones_path).with_manage_ability_check(Spree::Zone).build,
+            ItemBuilder.new('country', admin_countries_path).with_manage_ability_check(Spree::Country).build,
+            ItemBuilder.new('states', ->(store) { admin_country_states_path(store.default_country) }).
+              with_manage_ability_check(->(ability, store) { store.default_country && ability.can?(:manage, Spree::Country) }).
+              build,
+            ItemBuilder.new('shipping_methods', admin_shipping_methods_path).
+              with_manage_ability_check(Spree::ShippingMethod).
+              build,
+            ItemBuilder.new('shipping_categories', admin_shipping_categories_path).
+              with_manage_ability_check(Spree::ShippingCategory).
+              build,
+            ItemBuilder.new('store_credit_categories', admin_store_credit_categories_path).
+              with_manage_ability_check(Spree::StoreCreditCategory).
+              build,
+            ItemBuilder.new('refund_reasons', admin_refund_reasons_path).
+              with_manage_ability_check(Spree::RefundReason).
+              build,
+            ItemBuilder.new('reimbursement_types', admin_reimbursement_types_path).
+              with_manage_ability_check(Spree::ReimbursementType).
+              build,
+            ItemBuilder.new('return_authorization_reasons', admin_return_authorization_reasons_path).
+              with_manage_ability_check(Spree::ReturnAuthorizationReason).
+              build,
+            ItemBuilder.new('roles', admin_roles_path).with_manage_ability_check(Spree::Role).build
+          ]
+
+          section = SectionBuilder.new('settings', 'gear-fill.svg').
+                    with_availability_check(->(ability, store) { ability.can?(:manage, store) }).
+                    with_label_translation_key('admin.settings').
+                    with_items(items).
+                    build
+          root.add(section)
+        end
+        # rubocop:enable Metrics/AbcSize
+      end
+      # rubocop:enable Metrics/ClassLength
+    end
+  end
+end

data/app/models/spree/admin/main_menu/item.rb

@@ -0,0 +1,30 @@
+module Spree
+  module Admin
+    module MainMenu
+      class Item
+        attr_reader :key, :label_translation_key, :icon_key, :url, :match_path
+
+        def initialize(key, label_translation_key, url, icon_key, availability_checks, match_path) # rubocop:disable Metrics/ParameterLists
+          @key = key
+          @label_translation_key = label_translation_key
+          @url = url
+          @icon_key = icon_key
+          @availability_checks = availability_checks
+          @match_path = match_path
+        end
+
+        def available?(current_ability, resource)
+          return true if @availability_checks.empty?
+
+          result = @availability_checks.map { |check| check.call(current_ability, resource) }
+
+          result.all?(true)
+        end
+
+        def children?
+          false
+        end
+      end
+    end
+  end
+end

data/app/models/spree/admin/main_menu/item_builder.rb

@@ -0,0 +1,37 @@
+module Spree
+  module Admin
+    module MainMenu
+      class ItemBuilder
+        include ::Spree::Admin::PermissionChecks
+
+        def initialize(key, url)
+          @key = key
+          @label_translation_key = key
+          @url = url
+          @icon_key = nil
+          @availability_checks = []
+          @match_path = nil
+        end
+
+        def with_label_translation_key(key)
+          @label_translation_key = key
+          self
+        end
+
+        def with_icon_key(icon_key)
+          @icon_key = icon_key
+          self
+        end
+
+        def with_match_path(match_path)
+          @match_path = match_path
+          self
+        end
+
+        def build
+          Item.new(@key, @label_translation_key, @url, @icon_key, @availability_checks, @match_path)
+        end
+      end
+    end
+  end
+end

data/app/models/spree/admin/main_menu/root.rb

@@ -0,0 +1,17 @@
+module Spree
+  module Admin
+    module MainMenu
+      class Root < Section
+        attr_reader :items
+
+        def initialize
+          super('root', 'root', nil, [], [])
+        end
+
+        def add_to_section(section_key, item)
+          @items.find { |e| e.key == section_key }.add(item)
+        end
+      end
+    end
+  end
+end

data/app/models/spree/admin/main_menu/section.rb

@@ -0,0 +1,31 @@
+module Spree
+  module Admin
+    module MainMenu
+      class Section
+        include ::Spree::Admin::ItemManager
+
+        attr_reader :key, :label_translation_key, :icon_key, :items
+
+        def initialize(key, label_translation_key, icon_key, availability_checks, items)
+          @key = key
+          @label_translation_key = label_translation_key
+          @icon_key = icon_key
+          @availability_checks = availability_checks
+          @items = items
+        end
+
+        def available?(current_ability, resource)
+          return true if @availability_checks.empty?
+
+          result = @availability_checks.map { |check| check.call(current_ability, resource) }
+
+          result.all?(true)
+        end
+
+        def children?
+          @items.any?
+        end
+      end
+    end
+  end
+end

data/app/models/spree/admin/main_menu/section_builder.rb

@@ -0,0 +1,36 @@
+module Spree
+  module Admin
+    module MainMenu
+      class SectionBuilder
+        include ::Spree::Admin::PermissionChecks
+
+        def initialize(key, icon_key)
+          @key =                   key
+          @label_translation_key = key
+          @icon_key =              icon_key
+          @availability_checks =   []
+          @items =                 []
+        end
+
+        def with_label_translation_key(key)
+          @label_translation_key = key
+          self
+        end
+
+        def with_item(item)
+          @items << item
+          self
+        end
+
+        def with_items(items)
+          @items += items
+          self
+        end
+
+        def build
+          Section.new(@key, @label_translation_key, @icon_key, @availability_checks, @items)
+        end
+      end
+    end
+  end
+end

data/app/models/spree/admin/permission_checks.rb

@@ -0,0 +1,50 @@
+module Spree
+  module Admin
+    module PermissionChecks
+      def with_availability_check(availability_check)
+        @availability_checks << availability_check
+        self
+      end
+
+      def with_manage_ability_check(*classes)
+        @availability_checks << ->(ability, _current) { classes.any? { |c| ability.can?(:manage, c) } }
+        self
+      end
+
+      def with_admin_ability_check(*classes)
+        @availability_checks << ->(ability, _current) { classes.any? { |c| ability.can?(:admin, c) } }
+        self
+      end
+
+      def with_index_ability_check(*classes)
+        @availability_checks << ->(ability, _current) { classes.any? { |c| ability.can?(:index, c) } }
+        self
+      end
+
+      def with_create_ability_check(*classes)
+        @availability_checks << ->(ability, _current) { classes.any? { |c| ability.can?(:create, c) } }
+        self
+      end
+
+      def with_update_ability_check
+        @availability_checks << ->(ability, resource) { ability.can?(:update, resource) }
+        self
+      end
+
+      def with_resend_ability_check
+        @availability_checks << ->(ability, resource) { ability.can?(:resend, resource) }
+        self
+      end
+
+      def with_fire_ability_check
+        @availability_checks << ->(ability, resource) { ability.can?(:fire, resource) }
+        self
+      end
+
+      def with_state_change_check(event)
+        @availability_checks << ->(_ability, resource) { resource.send("can_#{event}?") }
+        self
+      end
+    end
+  end
+end

data/app/models/spree/admin/tabs/order_default_tabs_builder.rb

@@ -0,0 +1,147 @@
+module Spree
+  module Admin
+    module Tabs
+      # rubocop:disable Metrics/ClassLength
+      class OrderDefaultTabsBuilder
+        include Spree::Core::Engine.routes.url_helpers
+
+        def build
+          root = Root.new
+          add_cart_tab(root)
+          add_channel_tab(root)
+          add_customer_tab(root)
+          add_shipments_tab(root)
+          add_adjustments_tab(root)
+          add_payments_tab(root)
+          add_return_authorizations_tab(root)
+          add_customer_returns_tab(root)
+          add_state_changes_tab(root)
+          root
+        end
+
+        private
+
+        def add_cart_tab(root)
+          tab =
+            TabBuilder.new('cart', ->(resource) { cart_admin_order_path(resource) }).
+            with_icon_key('cart-check.svg').
+            with_active_check.
+            with_availability_check(
+              # An abstract module should not be aware of resource's internal structure.
+              # If these checks are elaborate, it's better to have this complexity declared explicitly here.
+              lambda do |ability, resource|
+                ability.can?(:update, resource) && (resource.shipments.empty? || resource.shipments.shipped.empty?)
+              end
+            ).
+            with_data_hook('admin_order_tabs_cart_details').
+            build
+
+          root.add(tab)
+        end
+
+        def add_channel_tab(root)
+          tab =
+            TabBuilder.new('channel', ->(resource) { channel_admin_order_path(resource) }).
+            with_icon_key('funnel.svg').
+            with_active_check.
+            with_update_ability_check.
+            with_data_hook('admin_order_tabs_channel_details').
+            build
+
+          root.add(tab)
+        end
+
+        def add_customer_tab(root)
+          tab =
+            TabBuilder.new('customer', ->(resource) { admin_order_customer_path(resource) }).
+            with_icon_key('person-lines-fill.svg').
+            with_partial_name('customer_details').
+            with_active_check.
+            with_availability_check(
+              lambda do |ability, resource|
+                ability.can?(:update, resource) && resource.checkout_steps.include?('address')
+              end
+            ).
+            with_data_hook('admin_order_tabs_customer_details').
+            build
+
+          root.add(tab)
+        end
+
+        def add_shipments_tab(root)
+          tab =
+            TabBuilder.new('shipments', ->(resource) { edit_admin_order_path(resource) }).
+            with_icon_key('truck.svg').
+            with_active_check.
+            with_update_ability_check.
+            with_data_hook('admin_order_tabs_shipment_details').
+            build
+
+          root.add(tab)
+        end
+
+        def add_adjustments_tab(root)
+          tab =
+            TabBuilder.new('adjustments', ->(resource) { admin_order_adjustments_path(resource) }).
+            with_icon_key('adjust.svg').
+            with_active_check.
+            with_index_ability_check(::Spree::Adjustment).
+            with_data_hook('admin_order_tabs_adjustments').
+            build
+
+          root.add(tab)
+        end
+
+        def add_payments_tab(root)
+          tab =
+            TabBuilder.new('payments', ->(resource) { admin_order_payments_path(resource) }).
+            with_icon_key('credit-card.svg').
+            with_active_check.
+            with_index_ability_check(::Spree::Payment).
+            with_data_hook('admin_order_tabs_payments').
+            build
+
+          root.add(tab)
+        end
+
+        def add_return_authorizations_tab(root)
+          tab =
+            TabBuilder.new('return_authorizations', ->(resource) { admin_order_return_authorizations_path(resource) }).
+            with_icon_key('enter.svg').
+            with_active_check.
+            with_completed_check.
+            with_index_ability_check(::Spree::ReturnAuthorization).
+            with_data_hook('admin_order_tabs_return_authorizations').
+            build
+
+          root.add(tab)
+        end
+
+        def add_customer_returns_tab(root)
+          tab =
+            TabBuilder.new('customer_returns', ->(resource) { admin_order_customer_returns_path(resource) }).
+            with_icon_key('returns.svg').
+            with_active_check.
+            with_completed_check.
+            with_index_ability_check(::Spree::CustomerReturn).
+            build
+
+          root.add(tab)
+        end
+
+        def add_state_changes_tab(root)
+          tab =
+            TabBuilder.new('state_changes', ->(resource) { admin_order_state_changes_path(resource) }).
+            with_icon_key('calendar3.svg').
+            with_active_check.
+            with_update_ability_check.
+            with_data_hook('admin_order_tabs_state_changes').
+            build
+
+          root.add(tab)
+        end
+      end
+      # rubocop:enable Metrics/ClassLength
+    end
+  end
+end