Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[admin] Consistently use label for providing text for table scopes, batch actions and filters #5593

Merged
merged 3 commits into from
Jan 11, 2024
Merged

[admin] Consistently use label for providing text for table scopes, batch actions and filters #5593

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2adb60a
Rename the batch_actions text key from `display_name` to `label`
elia Jan 10, 2024
366d39d
Rename the filters text key from `presentation` to `label`
elia Jan 10, 2024
e717cdb
Keep all the label structs in the table component together
elia Jan 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion admin/app/components/solidus_admin/adjustment_reasons/index/component.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
2 changes: 1 addition & 1 deletion admin/app/components/solidus_admin/option_types/index/component.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
8 changes: 4 additions & 4 deletions admin/app/components/solidus_admin/orders/index/component.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ def scopes
def filters
[
{
presentation: t('.filters.status'),
label: t('.filters.status'),
combinator: 'or',
attribute: "state",
predicate: "eq",
Expand All @@ -55,7 +55,7 @@ def filters
end
},
{
presentation: t('.filters.shipment_state'),
label: t('.filters.shipment_state'),
combinator: 'or',
attribute: "shipment_state",
predicate: "eq",
Expand All @@ -67,7 +67,7 @@ def filters
end
},
{
presentation: t('.filters.payment_state'),
label: t('.filters.payment_state'),
combinator: 'or',
attribute: "payment_state",
predicate: "eq",
Expand All @@ -79,7 +79,7 @@ def filters
end
},
{
presentation: t('.filters.promotions'),
label: t('.filters.promotions'),
combinator: 'or',
attribute: "promotions_id",
predicate: "in",
Expand Down
2 changes: 1 addition & 1 deletion admin/app/components/solidus_admin/payment_methods/index/component.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
8 changes: 4 additions & 4 deletions admin/app/components/solidus_admin/products/index/component.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,19 @@
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',
Expand All @@ -63,7 +63,7 @@
def filters
Spree::OptionType.all.map do |option_type|
{
presentation: option_type.presentation,
label: option_type.presentation,

Check warning on line 66 in admin/app/components/solidus_admin/products/index/component.rb

View check run for this annotation

Codecov / codecov/patch

admin/app/components/solidus_admin/products/index/component.rb#L66 

Added line #L66 was not covered by tests
combinator: 'or',
attribute: "variants_option_values",
predicate: "in",
Expand Down
2 changes: 1 addition & 1 deletion admin/app/components/solidus_admin/promotion_categories/index/component.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
4 changes: 2 additions & 2 deletions admin/app/components/solidus_admin/promotions/index/component.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand All @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion admin/app/components/solidus_admin/properties/index/component.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
2 changes: 1 addition & 1 deletion admin/app/components/solidus_admin/refund_reasons/index/component.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
2 changes: 1 addition & 1 deletion admin/app/components/solidus_admin/return_reasons/index/component.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
2 changes: 1 addition & 1 deletion admin/app/components/solidus_admin/shipping_categories/index/component.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
2 changes: 1 addition & 1 deletion admin/app/components/solidus_admin/shipping_methods/index/component.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
4 changes: 2 additions & 2 deletions admin/app/components/solidus_admin/stock_items/index/component.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -42,7 +42,7 @@ def filters
end
},
{
presentation: t('.filters.variants'),
label: t('.filters.variants'),
combinator: 'or',
attribute: "variant_id",
predicate: "eq",
Expand Down
2 changes: 1 addition & 1 deletion admin/app/components/solidus_admin/stock_locations/index/component.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
2 changes: 1 addition & 1 deletion admin/app/components/solidus_admin/store_credit_reasons/index/component.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
2 changes: 1 addition & 1 deletion admin/app/components/solidus_admin/stores/index/component.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
2 changes: 1 addition & 1 deletion admin/app/components/solidus_admin/tax_categories/index/component.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
6 changes: 3 additions & 3 deletions admin/app/components/solidus_admin/tax_rates/index/component.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand All @@ -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),
Expand Down
2 changes: 1 addition & 1 deletion admin/app/components/solidus_admin/taxonomies/index/component.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
10 changes: 5 additions & 5 deletions admin/app/components/solidus_admin/ui/table/component.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions admin/app/components/solidus_admin/users/index/component.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand All @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion admin/app/components/solidus_admin/zones/index/component.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
2 changes: 1 addition & 1 deletion admin/spec/components/previews/solidus_admin/ui/pages/index/component_preview.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def page_actions

def batch_actions
[{
display_name: "Print",
label: "Print",
action: "print",
}]
end
Expand Down
6 changes: 3 additions & 3 deletions admin/spec/components/previews/solidus_admin/ui/table/component_preview.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down