SP-63 Feature/improve admin actions extensibility

app/helpers/spree/admin/navigation_helper.rb

@@ -1,5 +1,6 @@
 module Spree
   module Admin
+    # rubocop:disable Metrics/ModuleLength
     module NavigationHelper
       # Makes an admin navigation tab (<li> tag) that links to a routing resource under /admin.
       # The arguments should be a list of symbolized controller names that will cause this tab to
@@ -320,6 +321,63 @@ def user_tabs
       def product_tabs
         Rails.application.config.spree_backend.tabs[:product]
       end
+
+      def orders_actions
+        Rails.application.config.spree_backend.actions[:orders]
+      end
+
+      def order_actions
+        Rails.application.config.spree_backend.actions[:order]
+      end
+
+      def users_actions
+        Rails.application.config.spree_backend.actions[:users]
+      end
+
+      def user_actions
+        Rails.application.config.spree_backend.actions[:user]
+      end
+
+      def products_actions
+        Rails.application.config.spree_backend.actions[:products]
+      end
+
+      def product_actions
+        Rails.application.config.spree_backend.actions[:product]
+      end
+
+      def images_actions
+        Rails.application.config.spree_backend.actions[:images]
+      end
+
+      def prices_actions
+        Rails.application.config.spree_backend.actions[:prices]
+      end
+
+      def store_credits_actions
+        Rails.application.config.spree_backend.actions[:store_credits]
+      end
+
+      def adjustments_actions
+        Rails.application.config.spree_backend.actions[:adjustments]
+      end
+
+      def payments_actions
+        Rails.application.config.spree_backend.actions[:payments]
+      end
+
+      def stock_actions
+        Rails.application.config.spree_backend.actions[:stock]
+      end
+
+      def variants_actions
+        Rails.application.config.spree_backend.actions[:variants]
+      end
+
+      def product_properties_actions
+        Rails.application.config.spree_backend.actions[:product_properties]
+      end
+      # rubocop:enable Metrics/ModuleLength
     end
   end
 end

app/helpers/spree/admin/orders_helper.rb

@@ -2,24 +2,6 @@ module Spree
   module Admin
     module OrdersHelper
       # 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: { 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

app/models/spree/admin/actions/action.rb

@@ -0,0 +1,35 @@
+module Spree
+  module Admin
+    module Actions
+      class Action
+        attr_reader :icon_name, :key, :classes, :text, :method, :id, :target, :data
+
+        def initialize(config)
+          @icon_name =           config[:icon_name]
+          @key =                 config[:key]
+          @url =                 config[:url]
+          @classes =             config[:classes]
+          @availability_checks = config[:availability_checks]
+          @text =                config[:text]
+          @method =              config[:method]
+          @id =                  config[:id]
+          @translation_options = config[:translation_options]
+          @target =              config[:target]
+          @data =                config[:data]
+        end
+
+        def available?(current_ability, resource = nil)
+          return true if @availability_checks.empty?
+
+          result = @availability_checks.map { |check| check.call(current_ability, resource) }
+
+          result.all?(true)
+        end
+
+        def url(resource = nil)
+          @url.is_a?(Proc) ? @url.call(resource) : @url
+        end
+      end
+    end
+  end
+end

app/models/spree/admin/actions/action_builder.rb

@@ -0,0 +1,48 @@
+module Spree
+  module Admin
+    module Actions
+      class ActionBuilder
+        include ::Spree::Admin::PermissionChecks
+
+        def initialize(config)
+          @icon_name =           config[:icon_name]
+          @key =                 config[:key]
+          @url =                 config[:url]
+          @classes =             config[:classes]
+          @availability_checks = []
+          @method =              config[:method]
+          @id =                  config[:id]
+          @translation_options = config[:translation_options]
+          @target =              config[:target]
+          @data =                config[:data]
+        end
+
+        def build
+          Action.new(build_config)
+        end
+
+        private
+
+        def build_config
+          {
+            icon_name: @icon_name,
+            key: @key,
+            url: @url,
+            classes: @classes,
+            availability_checks: @availability_checks,
+            text: text(@key, @translation_options),
+            method: @method,
+            id: @id,
+            translation_options: @translation_options,
+            target: @target,
+            data: @data
+          }
+        end
+
+        def text(text, options)
+          options.present? ? ::Spree.t(text, options) : ::Spree.t(text)
+        end
+      end
+    end
+  end
+end

app/models/spree/admin/actions/adjustments_default_actions_builder.rb

@@ -0,0 +1,35 @@
+module Spree
+  module Admin
+    module Actions
+      class AdjustmentsDefaultActionsBuilder
+        include Spree::Core::Engine.routes.url_helpers
+
+        def build
+          root = Root.new
+          add_new_adjustment_action(root)
+          root
+        end
+
+        private
+
+        def add_new_adjustment_action(root)
+          action =
+            ActionBuilder.new(new_adjustment_config).
+            with_create_ability_check(::Spree::Adjustment).
+            build
+
+          root.add(action)
+        end
+
+        def new_adjustment_config
+          {
+            icon_name: 'add.svg',
+            key: :new_adjustment,
+            url: ->(resource) { new_admin_order_adjustment_path(resource) },
+            classes: 'btn-success'
+          }
+        end
+      end
+    end
+  end
+end

app/models/spree/admin/actions/images_default_actions_builder.rb

@@ -0,0 +1,36 @@
+module Spree
+  module Admin
+    module Actions
+      class ImagesDefaultActionsBuilder
+        include Spree::Core::Engine.routes.url_helpers
+
+        def build
+          root = Root.new
+          add_new_image_action(root)
+          root
+        end
+
+        private
+
+        def add_new_image_action(root)
+          action =
+            ActionBuilder.new(new_image_config).
+            with_create_ability_check(::Spree::Image).
+            build
+
+          root.add(action)
+        end
+
+        def new_image_config
+          {
+            icon_name: 'add.svg',
+            key: :new_image,
+            url: ->(resource) { new_admin_product_image_path(resource) },
+            classes: 'btn-success',
+            id: 'new_image_link'
+          }
+        end
+      end
+    end
+  end
+end

app/models/spree/admin/actions/order_default_actions_builder.rb

@@ -0,0 +1,138 @@
+module Spree
+  module Admin
+    module Actions
+      class OrderDefaultActionsBuilder
+        include Spree::Core::Engine.routes.url_helpers
+
+        def build
+          root = Root.new
+          add_approve_action(root)
+          add_cancel_action(root)
+          add_resume_action(root)
+          add_resend_action(root)
+          add_reset_download_links_action(root)
+          root
+        end
+
+        private
+
+        def add_approve_action(root)
+          action =
+            ActionBuilder.new(approve_config).
+            with_state_change_check('approve').
+            with_fire_ability_check.
+            build
+
+          root.add(action)
+        end
+
+        def approve_config
+          {
+            icon_name: 'approve.svg',
+            key: :approve,
+            url: ->(resource) { approve_admin_order_path(resource) },
+            classes: 'btn-light',
+            method: :put,
+            translation_options: {
+              scope: 'admin.order.events'
+            },
+            data: { confirm: Spree.t(:order_sure_want_to, event: :approve) }
+          }
+        end
+
+        def add_cancel_action(root)
+          action =
+            ActionBuilder.new(cancel_config).
+            with_state_change_check('cancel').
+            with_fire_ability_check.
+            build
+
+          root.add(action)
+        end
+
+        def cancel_config
+          {
+            icon_name: 'cancel.svg',
+            key: :cancel,
+            url: ->(resource) { cancel_admin_order_path(resource) },
+            classes: 'btn-light',
+            method: :put,
+            translation_options: {
+              scope: 'admin.order.events'
+            },
+            data: { confirm: Spree.t(:order_sure_want_to, event: :cancel) }
+          }
+        end
+
+        def add_resume_action(root)
+          action =
+            ActionBuilder.new(resume_config).
+            with_state_change_check('resume').
+            with_fire_ability_check.
+            build
+
+          root.add(action)
+        end
+
+        def resume_config
+          {
+            icon_name: 'resume.svg',
+            key: :resume,
+            url: ->(resource) { resume_admin_order_path(resource) },
+            classes: 'btn-light',
+            method: :put,
+            translation_options: {
+              scope: 'admin.order.events'
+            },
+            data: { confirm: Spree.t(:order_sure_want_to, event: :resume) }
+          }
+        end
+
+        def add_resend_action(root)
+          action =
+            ActionBuilder.new(resend_config).
+            with_resend_ability_check.
+            build
+
+          root.add(action)
+        end
+
+        def resend_config
+          {
+            icon_name: 'envelope.svg',
+            key: :resend,
+            url: ->(resource) { resend_admin_order_path(resource) },
+            classes: 'btn-secondary',
+            method: :post,
+            translation_options: {
+              scope: 'admin.order.events',
+              default: ::Spree.t(:resend)
+            }
+          }
+        end
+
+        def add_reset_download_links_action(root)
+          action =
+            ActionBuilder.new(reset_download_links_config).
+            with_availability_check(
+              lambda do |ability, resource|
+                ability.can?(:update, resource) && resource.some_digital?
+              end
+            ).
+            build
+
+          root.add(action)
+        end
+
+        def reset_download_links_config
+          {
+            icon_name: 'hdd.svg',
+            key: 'admin.digitals.reset_download_links',
+            url: ->(resource) { reset_digitals_admin_order_path(resource) },
+            method: :put
+          }
+        end
+      end
+    end
+  end
+end