Merge pull request #5593 from solidusio/elia/admin/table-keys

elia · web-flow · commit bb39b3f8a151 · 2024-01-11T10:37:14.000+01:00
[admin] Consistently use `label` for providing text for table scopes, batch actions and filters
diff --git a/admin/app/components/solidus_admin/adjustment_reasons/index/component.rb b/admin/app/components/solidus_admin/adjustment_reasons/index/component.rb
@@ -20,7 +20,7 @@ def row_url(adjustment_reason)
   def batch_actions
     [
       {
-        display_name: t('.batch_actions.delete'),
+        label: t('.batch_actions.delete'),
         action: solidus_admin.adjustment_reasons_path,
         method: :delete,
         icon: 'delete-bin-7-line',
diff --git a/admin/app/components/solidus_admin/option_types/index/component.rb b/admin/app/components/solidus_admin/option_types/index/component.rb
@@ -36,7 +36,7 @@ def next_page_path
   def batch_actions
     [
       {
-        display_name: t('.batch_actions.delete'),
+        label: t('.batch_actions.delete'),
         action: solidus_admin.option_types_path,
         method: :delete,
         icon: 'delete-bin-7-line',
diff --git a/admin/app/components/solidus_admin/orders/index/component.rb b/admin/app/components/solidus_admin/orders/index/component.rb
@@ -43,7 +43,7 @@ def scopes
   def filters
     [
       {
-        presentation: t('.filters.status'),
+        label: t('.filters.status'),
         combinator: 'or',
         attribute: "state",
         predicate: "eq",
@@ -55,7 +55,7 @@ def filters
         end
       },
       {
-        presentation: t('.filters.shipment_state'),
+        label: t('.filters.shipment_state'),
         combinator: 'or',
         attribute: "shipment_state",
         predicate: "eq",
@@ -67,7 +67,7 @@ def filters
         end
       },
       {
-        presentation: t('.filters.payment_state'),
+        label: t('.filters.payment_state'),
         combinator: 'or',
         attribute: "payment_state",
         predicate: "eq",
@@ -79,7 +79,7 @@ def filters
         end
       },
       {
-        presentation: t('.filters.promotions'),
+        label: t('.filters.promotions'),
         combinator: 'or',
         attribute: "promotions_id",
         predicate: "in",
diff --git a/admin/app/components/solidus_admin/payment_methods/index/component.rb b/admin/app/components/solidus_admin/payment_methods/index/component.rb
@@ -36,7 +36,7 @@ def page_actions
   def batch_actions
     [
       {
-        display_name: t('.batch_actions.delete'),
+        label: t('.batch_actions.delete'),
         action: solidus_admin.payment_methods_path,
         method: :delete,
         icon: 'delete-bin-7-line',
diff --git a/admin/app/components/solidus_admin/products/index/component.rb b/admin/app/components/solidus_admin/products/index/component.rb
@@ -29,19 +29,19 @@ def page_actions
   def batch_actions
     [
       {
-        display_name: t('.batch_actions.delete'),
+        label: t('.batch_actions.delete'),
         action: solidus_admin.products_path,
         method: :delete,
         icon: 'delete-bin-7-line',
       },
       {
-        display_name: t('.batch_actions.discontinue'),
+        label: t('.batch_actions.discontinue'),
         action: solidus_admin.discontinue_products_path,
         method: :put,
         icon: 'pause-circle-line',
       },
       {
-        display_name: t('.batch_actions.activate'),
+        label: t('.batch_actions.activate'),
         action: solidus_admin.activate_products_path,
         method: :put,
         icon: 'play-circle-line',
@@ -63,7 +63,7 @@ def scopes
   def filters
     Spree::OptionType.all.map do |option_type|
       {
-        presentation: option_type.presentation,
+        label: option_type.presentation,
         combinator: 'or',
         attribute: "variants_option_values",
         predicate: "in",
diff --git a/admin/app/components/solidus_admin/promotion_categories/index/component.rb b/admin/app/components/solidus_admin/promotion_categories/index/component.rb
@@ -21,7 +21,7 @@ def page_actions
   def batch_actions
     [
       {
-        display_name: t('.batch_actions.delete'),
+        label: t('.batch_actions.delete'),
         action: solidus_admin.promotion_categories_path,
         method: :delete,
         icon: 'delete-bin-7-line',
diff --git a/admin/app/components/solidus_admin/promotions/index/component.rb b/admin/app/components/solidus_admin/promotions/index/component.rb
@@ -29,7 +29,7 @@ def page_actions
   def batch_actions
     [
       {
-        display_name: t('.batch_actions.delete'),
+        label: t('.batch_actions.delete'),
         action: solidus_admin.promotions_path,
         method: :delete,
         icon: 'delete-bin-7-line',
@@ -50,7 +50,7 @@ def scopes
   def filters
     [
       {
-        presentation: Spree::PromotionCategory.model_name.human.pluralize,
+        label: Spree::PromotionCategory.model_name.human.pluralize,
         attribute: "promotion_category_id",
         predicate: "in",
         options: Spree::PromotionCategory.pluck(:name, :id)
diff --git a/admin/app/components/solidus_admin/properties/index/component.rb b/admin/app/components/solidus_admin/properties/index/component.rb
@@ -29,7 +29,7 @@ def page_actions
   def batch_actions
     [
       {
-        display_name: t('.batch_actions.delete'),
+        label: t('.batch_actions.delete'),
         action: solidus_admin.properties_path,
         method: :delete,
         icon: 'delete-bin-7-line',
diff --git a/admin/app/components/solidus_admin/refund_reasons/index/component.rb b/admin/app/components/solidus_admin/refund_reasons/index/component.rb
@@ -30,7 +30,7 @@ def actions
   def batch_actions
     [
       {
-        display_name: t('.batch_actions.delete'),
+        label: t('.batch_actions.delete'),
         action: solidus_admin.refund_reasons_path,
         method: :delete,
         icon: 'delete-bin-7-line',
diff --git a/admin/app/components/solidus_admin/return_reasons/index/component.rb b/admin/app/components/solidus_admin/return_reasons/index/component.rb
@@ -20,7 +20,7 @@ def row_url(return_reason)
   def batch_actions
     [
       {
-        display_name: t('.batch_actions.delete'),
+        label: t('.batch_actions.delete'),
         action: solidus_admin.return_reasons_path,
         method: :delete,
         icon: 'delete-bin-7-line',
diff --git a/admin/app/components/solidus_admin/shipping_categories/index/component.rb b/admin/app/components/solidus_admin/shipping_categories/index/component.rb
@@ -30,7 +30,7 @@ def search_url
   def batch_actions
     [
       {
-        display_name: t('.batch_actions.delete'),
+        label: t('.batch_actions.delete'),
         action: solidus_admin.shipping_categories_path,
         method: :delete,
         icon: 'delete-bin-7-line',
diff --git a/admin/app/components/solidus_admin/shipping_methods/index/component.rb b/admin/app/components/solidus_admin/shipping_methods/index/component.rb
@@ -30,7 +30,7 @@ def actions
   def batch_actions
     [
       {
-        display_name: t('.batch_actions.delete'),
+        label: t('.batch_actions.delete'),
         action: solidus_admin.shipping_methods_path,
         method: :delete,
         icon: 'delete-bin-7-line',
diff --git a/admin/app/components/solidus_admin/stock_items/index/component.rb b/admin/app/components/solidus_admin/stock_items/index/component.rb
@@ -30,7 +30,7 @@ def scopes
   def filters
     [
       {
-        presentation: t('.filters.stock_locations'),
+        label: t('.filters.stock_locations'),
         combinator: 'or',
         attribute: "stock_location_id",
         predicate: "eq",
@@ -42,7 +42,7 @@ def filters
         end
       },
       {
-        presentation: t('.filters.variants'),
+        label: t('.filters.variants'),
         combinator: 'or',
         attribute: "variant_id",
         predicate: "eq",
diff --git a/admin/app/components/solidus_admin/stock_locations/index/component.rb b/admin/app/components/solidus_admin/stock_locations/index/component.rb
@@ -30,7 +30,7 @@ def search_key
   def batch_actions
     [
       {
-        display_name: t('.batch_actions.delete'),
+        label: t('.batch_actions.delete'),
         action: solidus_admin.stock_locations_path,
         method: :delete,
         icon: 'delete-bin-7-line',
diff --git a/admin/app/components/solidus_admin/store_credit_reasons/index/component.rb b/admin/app/components/solidus_admin/store_credit_reasons/index/component.rb
@@ -30,7 +30,7 @@ def search_key
   def batch_actions
     [
       {
-        display_name: t('.batch_actions.delete'),
+        label: t('.batch_actions.delete'),
         action: solidus_admin.store_credit_reasons_path,
         method: :delete,
         icon: 'delete-bin-7-line',
diff --git a/admin/app/components/solidus_admin/stores/index/component.rb b/admin/app/components/solidus_admin/stores/index/component.rb
@@ -29,7 +29,7 @@ def page_actions
   def batch_actions
     [
       {
-        display_name: t('.batch_actions.delete'),
+        label: t('.batch_actions.delete'),
         action: solidus_admin.stores_path,
         method: :delete,
         icon: 'delete-bin-7-line',
diff --git a/admin/app/components/solidus_admin/tax_categories/index/component.rb b/admin/app/components/solidus_admin/tax_categories/index/component.rb
@@ -30,7 +30,7 @@ def search_key
   def batch_actions
     [
       {
-        display_name: t('.batch_actions.delete'),
+        label: t('.batch_actions.delete'),
         action: solidus_admin.tax_categories_path,
         method: :delete,
         icon: 'delete-bin-7-line',
diff --git a/admin/app/components/solidus_admin/tax_rates/index/component.rb b/admin/app/components/solidus_admin/tax_rates/index/component.rb
@@ -30,7 +30,7 @@ def search_key
   def batch_actions
     [
       {
-        display_name: t('.batch_actions.delete'),
+        label: t('.batch_actions.delete'),
         action: solidus_admin.tax_rates_path,
         method: :delete,
         icon: 'delete-bin-7-line',
@@ -41,13 +41,13 @@ def batch_actions
   def filters
     [
       {
-        presentation: Spree::Zone.model_name.human,
+        label: Spree::Zone.model_name.human,
         attribute: :zone_id,
         predicate: :eq,
         options: Spree::Zone.pluck(:name, :id),
       },
       {
-        presentation: Spree::TaxCategory.model_name.human,
+        label: Spree::TaxCategory.model_name.human,
         attribute: :tax_categories_id,
         predicate: :in,
         options: Spree::TaxCategory.pluck(:name, :id),
diff --git a/admin/app/components/solidus_admin/taxonomies/index/component.rb b/admin/app/components/solidus_admin/taxonomies/index/component.rb
@@ -28,7 +28,7 @@ def page_actions
   def batch_actions
     [
       {
-        display_name: t('.batch_actions.delete'),
+        label: t('.batch_actions.delete'),
         action: solidus_admin.taxonomies_path,
         method: :delete,
         icon: 'delete-bin-7-line',
diff --git a/admin/app/components/solidus_admin/ui/table/component.rb b/admin/app/components/solidus_admin/ui/table/component.rb
@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 class SolidusAdmin::UI::Table::Component < SolidusAdmin::BaseComponent
-  BatchAction = Struct.new(:display_name, :icon, :action, :method, keyword_init: true) # rubocop:disable Lint/StructNewOverride
   Column = Struct.new(:header, :data, :col, :wrap, keyword_init: true)
-  Filter = Struct.new(:presentation, :combinator, :attribute, :predicate, :options, keyword_init: true)
-  Scope = Struct.new(:name, :label, :default, keyword_init: true)
   Sortable = Struct.new(:url, :param, :animation, :handle, keyword_init: true)
+  Scope = Struct.new(:label, :name, :default, keyword_init: true)
+  Filter = Struct.new(:label, :combinator, :attribute, :predicate, :options, keyword_init: true)
+  BatchAction = Struct.new(:label, :icon, :action, :method, keyword_init: true) # rubocop:disable Lint/StructNewOverride
   private_constant :BatchAction, :Column, :Filter, :Scope, :Sortable
 
   class Data < Struct.new(:rows, :class, :url, :prev, :next, :columns, :fade, :batch_actions, keyword_init: true) # rubocop:disable Lint/StructNewOverride,Style/StructInheritance
@@ -108,14 +108,14 @@ def render_batch_action_button(batch_action)
       form: batch_actions_form_id,
       type: :submit,
       icon: batch_action.icon,
-      text: batch_action.display_name,
+      text: batch_action.label,
       scheme: :secondary,
     )
   end
 
   def render_ransack_filter_dropdown(filter, index)
     render component("ui/table/ransack_filter").new(
-      presentation: filter.presentation,
+      presentation: filter.label,
       search_param: @search.name,
       combinator: filter.combinator,
       attribute: filter.attribute,
diff --git a/admin/app/components/solidus_admin/users/index/component.rb b/admin/app/components/solidus_admin/users/index/component.rb
@@ -29,7 +29,7 @@ def page_actions
   def batch_actions
     [
       {
-        display_name: t('.batch_actions.delete'),
+        label: t('.batch_actions.delete'),
         action: solidus_admin.users_path,
         method: :delete,
         icon: 'delete-bin-7-line',
@@ -50,7 +50,7 @@ def scopes
   def filters
     [
       {
-        presentation: Spree::Role.model_name.human.pluralize,
+        label: Spree::Role.model_name.human.pluralize,
         attribute: "spree_roles_id",
         predicate: "in",
         options: Spree::Role.pluck(:name, :id)
diff --git a/admin/app/components/solidus_admin/zones/index/component.rb b/admin/app/components/solidus_admin/zones/index/component.rb
@@ -30,7 +30,7 @@ def page_actions
   def batch_actions
     [
       {
-        display_name: t('.batch_actions.delete'),
+        label: t('.batch_actions.delete'),
         action: solidus_admin.zones_path,
         method: :delete,
         icon: 'delete-bin-7-line',
diff --git a/admin/spec/components/previews/solidus_admin/ui/pages/index/component_preview.rb b/admin/spec/components/previews/solidus_admin/ui/pages/index/component_preview.rb
@@ -40,7 +40,7 @@ def page_actions
 
       def batch_actions
         [{
-          display_name: "Print",
+          label: "Print",
           action: "print",
         }]
       end
diff --git a/admin/spec/components/previews/solidus_admin/ui/table/component_preview.rb b/admin/spec/components/previews/solidus_admin/ui/table/component_preview.rb
@@ -56,19 +56,19 @@ def table_data(batch_actions, sortable)
   def batch_actions_data
     [
       {
-        display_name: "Delete",
+        label: "Delete",
         action: "#",
         method: :delete,
         icon: 'delete-bin-7-line',
       },
       {
-        display_name: "Discontinue",
+        label: "Discontinue",
         action: "#",
         method: :put,
         icon: 'pause-circle-line',
       },
       {
-        display_name: "Activate",
+        label: "Activate",
         action: "#",
         method: :put,
         icon: 'play-circle-line',

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ def row_url(adjustment_reason)`
`20`	`20`	`def batch_actions`
`21`	`21`	`[`
`22`	`22`	`{`
`23`		`- display_name: t('.batch_actions.delete'),`
	`23`	`+ label: t('.batch_actions.delete'),`
`24`	`24`	`action: solidus_admin.adjustment_reasons_path,`
`25`	`25`	`method: :delete,`
`26`	`26`	`icon: 'delete-bin-7-line',`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ def next_page_path`
`36`	`36`	`def batch_actions`
`37`	`37`	`[`
`38`	`38`	`{`
`39`		`- display_name: t('.batch_actions.delete'),`
	`39`	`+ label: t('.batch_actions.delete'),`
`40`	`40`	`action: solidus_admin.option_types_path,`
`41`	`41`	`method: :delete,`
`42`	`42`	`icon: 'delete-bin-7-line',`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ def page_actions`
`36`	`36`	`def batch_actions`
`37`	`37`	`[`
`38`	`38`	`{`
`39`		`- display_name: t('.batch_actions.delete'),`
	`39`	`+ label: t('.batch_actions.delete'),`
`40`	`40`	`action: solidus_admin.payment_methods_path,`
`41`	`41`	`method: :delete,`
`42`	`42`	`icon: 'delete-bin-7-line',`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ def page_actions`
`21`	`21`	`def batch_actions`
`22`	`22`	`[`
`23`	`23`	`{`
`24`		`- display_name: t('.batch_actions.delete'),`
	`24`	`+ label: t('.batch_actions.delete'),`
`25`	`25`	`action: solidus_admin.promotion_categories_path,`
`26`	`26`	`method: :delete,`
`27`	`27`	`icon: 'delete-bin-7-line',`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ def page_actions`
`29`	`29`	`def batch_actions`
`30`	`30`	`[`
`31`	`31`	`{`
`32`		`- display_name: t('.batch_actions.delete'),`
	`32`	`+ label: t('.batch_actions.delete'),`
`33`	`33`	`action: solidus_admin.promotions_path,`
`34`	`34`	`method: :delete,`
`35`	`35`	`icon: 'delete-bin-7-line',`
`@@ -50,7 +50,7 @@ def scopes`
`50`	`50`	`def filters`
`51`	`51`	`[`
`52`	`52`	`{`
`53`		`- presentation: Spree::PromotionCategory.model_name.human.pluralize,`
	`53`	`+ label: Spree::PromotionCategory.model_name.human.pluralize,`
`54`	`54`	`attribute: "promotion_category_id",`
`55`	`55`	`predicate: "in",`
`56`	`56`	`options: Spree::PromotionCategory.pluck(:name, :id)`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ def actions`
`30`	`30`	`def batch_actions`
`31`	`31`	`[`
`32`	`32`	`{`
`33`		`- display_name: t('.batch_actions.delete'),`
	`33`	`+ label: t('.batch_actions.delete'),`
`34`	`34`	`action: solidus_admin.refund_reasons_path,`
`35`	`35`	`method: :delete,`
`36`	`36`	`icon: 'delete-bin-7-line',`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ def row_url(return_reason)`
`20`	`20`	`def batch_actions`
`21`	`21`	`[`
`22`	`22`	`{`
`23`		`- display_name: t('.batch_actions.delete'),`
	`23`	`+ label: t('.batch_actions.delete'),`
`24`	`24`	`action: solidus_admin.return_reasons_path,`
`25`	`25`	`method: :delete,`
`26`	`26`	`icon: 'delete-bin-7-line',`