Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Added serializer shortcuts for prefixed ids, string, money and expandable attributes

Claude7cd1c84c8d30
diff --git a/spree/api/app/serializers/spree/api/v3/admin/address_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/address_serializer.rb
index 4103248347..3e3c5fc952 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/address_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/address_serializer.rb
@@ -24,16 +24,12 @@ module Spree
address.longitude&.to_f
end
- attribute :customer_id do |address|
- address.customer_owner&.prefixed_id
- end
+ prefixed_id_attributes customer_id: :customer_owner
# Who the row belongs to — a customer's book, a company node's, or a
# seller's billing address. `customer_id` above stays as the
# customer-only shorthand the customers surface reads.
- attribute :owner_id do |address|
- address.owner&.prefixed_id
- end
+ prefixed_id_attributes :owner
attributes :owner_type
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/api_key_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/api_key_serializer.rb
index beb5c21984..2c93fe7d71 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/api_key_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/api_key_serializer.rb
@@ -27,17 +27,13 @@ module Spree
created_at: :iso8601, updated_at: :iso8601,
revoked_at: :iso8601, last_used_at: :iso8601
- attribute :channel_id do |key|
- key.channel&.prefixed_id
- end
+ prefixed_id_attributes :channel
# Returned only on the create response — `plaintext_token` is held in
# memory on the model after `generate_token` and is never persisted
# for secret keys, so we serialize it whenever it's available rather
# than gating on the action.
- attribute :plaintext_token do |key|
- key.plaintext_token
- end
+ attributes :plaintext_token
# A key can be minted by another key, which has no email — so the
# address is answered only for the actors that have one, and
diff --git a/spree/api/app/serializers/spree/api/v3/admin/catalog_assignment_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/catalog_assignment_serializer.rb
index c08f213435..97822d7bfb 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/catalog_assignment_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/catalog_assignment_serializer.rb
@@ -18,9 +18,7 @@ module Spree
assignment.assignable_type.demodulize.underscore
end
- attribute :assignable_id do |assignment|
- assignment.assignable&.prefixed_id
- end
+ prefixed_id_attributes :assignable
attribute :assignable_name do |assignment|
assignment.assignable.try(:name)
diff --git a/spree/api/app/serializers/spree/api/v3/admin/catalog_order_minimum_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/catalog_order_minimum_serializer.rb
index 1ed4329aa0..178959e062 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/catalog_order_minimum_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/catalog_order_minimum_serializer.rb
@@ -9,13 +9,7 @@ module Spree
attributes :currency, created_at: :iso8601, updated_at: :iso8601
- attribute :amount do |minimum|
- minimum.amount.to_s
- end
-
- attribute :display_amount do |minimum|
- minimum.display_amount.to_s
- end
+ string_attributes :amount, :display_amount
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/catalog_product_term_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/catalog_product_term_serializer.rb
index 9cd62f92c4..12ec538b25 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/catalog_product_term_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/catalog_product_term_serializer.rb
@@ -28,9 +28,7 @@ module Spree
# True when the product's variants carry different terms, so the
# editor shows "mixed" rather than claiming one variant's pair is
# the product's.
- attribute :mixed do |term|
- term.mixed?
- end
+ attribute :mixed, &:mixed?
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/catalog_quantity_rule_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/catalog_quantity_rule_serializer.rb
index 093adee89c..4f7c7a6356 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/catalog_quantity_rule_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/catalog_quantity_rule_serializer.rb
@@ -15,9 +15,7 @@ module Spree
attributes :minimum_order_quantity, :order_multiple,
created_at: :iso8601, updated_at: :iso8601
- attribute :variant_id do |rule|
- rule.variant&.prefixed_id
- end
+ prefixed_id_attributes :variant
attribute :variant_sku do |rule|
rule.variant&.sku
diff --git a/spree/api/app/serializers/spree/api/v3/admin/catalog_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/catalog_serializer.rb
index 8d2f63ff22..06c979384e 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/catalog_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/catalog_serializer.rb
@@ -25,16 +25,12 @@ module Spree
# Minimums are few (one per currency) and the card renders them
# inline, so they ride along rather than costing a second request.
- many :order_minimums,
- resource: proc { Spree.api.admin_catalog_order_minimum_serializer },
- if: proc { expand?('order_minimums') }
+ expandable :many, :order_minimums, :admin_catalog_order_minimum_serializer
# The owned list rides along so the agreement editor can render its
# pricing without a second request — the catalog page is where an
# owned list is edited (docs/plans/6.0-catalog-agreement-rework.md).
- one :price_list,
- resource: proc { Spree.api.admin_price_list_serializer },
- if: proc { expand?('price_list') }
+ expandable :one, :price_list, :admin_price_list_serializer
many :catalog_assignments, key: :assignments,
resource: proc { Spree.api.admin_catalog_assignment_serializer },
diff --git a/spree/api/app/serializers/spree/api/v3/admin/category_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/category_serializer.rb
index 53ab756406..7f75261d18 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/category_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/category_serializer.rb
@@ -16,21 +16,13 @@ module Spree
created_at: :iso8601, updated_at: :iso8601
# Override inherited associations to use admin serializers
- one :parent,
- resource: proc { Spree.api.admin_category_serializer },
- if: proc { expand?('parent') }
+ expandable :one, :parent, :admin_category_serializer
- many :children,
- resource: proc { Spree.api.admin_category_serializer },
- if: proc { expand?('children') }
+ expandable :many, :children, :admin_category_serializer
- many :ancestors,
- resource: proc { Spree.api.admin_category_serializer },
- if: proc { expand?('ancestors') }
+ expandable :many, :ancestors, :admin_category_serializer
- many :custom_fields,
- resource: proc { Spree.api.admin_custom_field_serializer },
- if: proc { expand?('custom_fields') }
+ expandable :many, :custom_fields, :admin_custom_field_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/channel_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/channel_serializer.rb
index 92f47bae91..15af414ac0 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/channel_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/channel_serializer.rb
@@ -23,9 +23,7 @@ module Spree
# When set, only the default catalog's products are visible on this
# channel; unset means every publication.
- attribute :default_catalog_id do |record|
- record.default_catalog&.prefixed_id
- end
+ prefixed_id_attributes :default_catalog
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/claim_line_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/claim_line_item_serializer.rb
index 1142282443..4d643cc542 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/claim_line_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/claim_line_item_serializer.rb
@@ -7,8 +7,8 @@ module Spree
class ClaimLineItemSerializer < V3::ClaimLineItemSerializer
attributes created_at: :iso8601, updated_at: :iso8601
- one :variant, resource: proc { Spree.api.admin_variant_serializer }, if: proc { expand?('variant') }
- one :replacement_variant, resource: proc { Spree.api.admin_variant_serializer }, if: proc { expand?('replacement_variant') }
+ expandable :one, :variant, :admin_variant_serializer
+ expandable :one, :replacement_variant, :admin_variant_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/claim_reason_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/claim_reason_serializer.rb
index afa92ae6d9..1a961de276 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/claim_reason_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/claim_reason_serializer.rb
@@ -11,9 +11,7 @@ module Spree
# Lets the dashboard hide destructive controls instead of offering a
# delete that the model will refuse.
- attribute :can_be_deleted do |reason|
- reason.can_be_deleted?
- end
+ attribute :can_be_deleted, &:can_be_deleted?
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/claim_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/claim_serializer.rb
index 661bb563c6..9f524d96a2 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/claim_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/claim_serializer.rb
@@ -14,13 +14,11 @@ module Spree
actor_attributes :created_by
- many :claim_line_items,
- resource: proc { Spree.api.admin_claim_line_item_serializer },
- if: proc { expand?('claim_line_items') }
+ expandable :many, :claim_line_items, :admin_claim_line_item_serializer
- one :reason, resource: proc { Spree.api.admin_claim_reason_serializer }, if: proc { expand?('reason') }
- one :order, resource: proc { Spree.api.admin_order_serializer }, if: proc { expand?('order') }
- many :refunds, resource: proc { Spree.api.admin_refund_serializer }, if: proc { expand?('refunds') }
+ expandable :one, :reason, :admin_claim_reason_serializer
+ expandable :one, :order, :admin_order_serializer
+ expandable :many, :refunds, :admin_refund_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/collection_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/collection_serializer.rb
index e9f2e4a962..5bc15cda53 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/collection_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/collection_serializer.rb
@@ -14,14 +14,10 @@ module Spree
attributes :automatic, :rules_match_policy, :metadata,
created_at: :iso8601, updated_at: :iso8601
- many :rules,
- resource: proc { Spree.api.admin_collection_rule_serializer },
- if: proc { expand?('rules') }
+ expandable :many, :rules, :admin_collection_rule_serializer
# Override inherited custom_fields to use the admin serializer.
- many :custom_fields,
- resource: proc { Spree.api.admin_custom_field_serializer },
- if: proc { expand?('custom_fields') }
+ expandable :many, :custom_fields, :admin_custom_field_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/commission_line_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/commission_line_serializer.rb
index 4d77454ab4..ac4b4284f0 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/commission_line_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/commission_line_serializer.rb
@@ -57,9 +57,7 @@ module Spree
line.seller&.name
end
- one :commission_rate,
- resource: proc { Spree.api.admin_commission_rate_serializer },
- if: proc { expand?('commission_rate') }
+ expandable :one, :commission_rate, :admin_commission_rate_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/commission_rule_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/commission_rule_serializer.rb
index dbcd504461..f8a58635b3 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/commission_rule_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/commission_rule_serializer.rb
@@ -24,9 +24,7 @@ module Spree
rule.class.api_type
end
- attribute :commission_rate_id do |rule|
- rule.commission_rate&.prefixed_id
- end
+ prefixed_id_attributes :commission_rate
attribute :preferences, &:serialized_preferences
attribute :preference_schema, &:serialized_preference_schema
diff --git a/spree/api/app/serializers/spree/api/v3/admin/company_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/company_serializer.rb
index f87e017461..31dbcd048e 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/company_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/company_serializer.rb
@@ -19,17 +19,11 @@ module Spree
# The member count covers the node's whole subtree
attributes :members_count
- many :children,
- resource: proc { Spree.api.admin_company_serializer },
- if: proc { expand?('children') }
+ expandable :many, :children, :admin_company_serializer
- many :addresses,
- resource: proc { Spree.api.admin_address_serializer },
- if: proc { expand?('addresses') }
+ expandable :many, :addresses, :admin_address_serializer
- many :memberships,
- resource: proc { Spree.api.admin_company_membership_serializer },
- if: proc { expand?('memberships') }
+ expandable :many, :memberships, :admin_company_membership_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/coupon_code_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/coupon_code_serializer.rb
index 0c0500e795..a24a7bd310 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/coupon_code_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/coupon_code_serializer.rb
@@ -16,13 +16,7 @@ module Spree
attributes :code, :state,
created_at: :iso8601, updated_at: :iso8601
- attribute :promotion_id do |coupon|
- coupon.promotion&.prefixed_id
- end
-
- attribute :order_id do |coupon|
- coupon.order&.prefixed_id
- end
+ prefixed_id_attributes :promotion, :order
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/credit_card_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/credit_card_serializer.rb
index 060728623c..79a6f0c5bc 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/credit_card_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/credit_card_serializer.rb
@@ -7,13 +7,7 @@ module Spree
payment_method_id: [:string, nullable: true],
metadata: 'Record<string, unknown>'
- attribute :customer_id do |credit_card|
- credit_card.customer&.prefixed_id
- end
-
- attribute :payment_method_id do |credit_card|
- credit_card.payment_method&.prefixed_id
- end
+ prefixed_id_attributes :customer, :payment_method
attributes :metadata,
created_at: :iso8601, updated_at: :iso8601
diff --git a/spree/api/app/serializers/spree/api/v3/admin/customer_group_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/customer_group_serializer.rb
index 00dccbb960..edf6824d43 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/customer_group_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/customer_group_serializer.rb
@@ -16,9 +16,7 @@ module Spree
# because a group can hold tens of thousands of users — embedding the
# whole list on every group fetch would explode the index payload.
# Pass `expand=customers` when you need them inline (single-record reads only).
- many :customers,
- resource: proc { Spree.api.admin_customer_serializer },
- if: proc { expand?('customers') }
+ expandable :many, :customers, :admin_customer_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/customer_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/customer_serializer.rb
index bc3fcf6d76..decdb30a8e 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/customer_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/customer_serializer.rb
@@ -28,9 +28,7 @@ module Spree
user.anonymized_at&.iso8601
end
- attribute :anonymized do |user|
- user.anonymized?
- end
+ attribute :anonymized, &:anonymized?
attribute :tags do |user|
user.tags.map(&:name) # not pluck as we preload tags
@@ -44,13 +42,7 @@ module Spree
user.respond_to?(:internal_note) ? user.internal_note.presence : nil
end
- attribute :default_billing_address_id do |user|
- user.bill_address&.prefixed_id
- end
-
- attribute :default_shipping_address_id do |user|
- user.ship_address&.prefixed_id
- end
+ prefixed_id_attributes default_billing_address_id: :bill_address, default_shipping_address_id: :ship_address
# Order aggregates: prefer attributes precomputed on the scope (see
# CustomersController#scope) to avoid N+1 on list endpoints. Fall
@@ -76,7 +68,7 @@ module Spree
end
# Override inherited associations to use admin serializers
- many :addresses, resource: proc { Spree.api.admin_address_serializer }, if: proc { expand?('addresses') }
+ expandable :many, :addresses, :admin_address_serializer
one :bill_address, key: :default_billing_address, resource: proc { Spree.api.admin_address_serializer }, if: proc { expand?('default_billing_address') }
one :ship_address, key: :default_shipping_address, resource: proc { Spree.api.admin_address_serializer }, if: proc { expand?('default_shipping_address') }
@@ -90,27 +82,19 @@ module Spree
user.newsletter_subscriber(store)
end
- many :orders,
- resource: proc { Spree.api.admin_order_serializer },
- if: proc { expand?('orders') }
+ expandable :many, :orders, :admin_order_serializer
- many :store_credits,
- resource: proc { Spree.api.admin_store_credit_serializer },
- if: proc { expand?('store_credits') }
+ expandable :many, :store_credits, :admin_store_credit_serializer
attribute :customer_group_ids do |user|
user.customer_groups.map(&:prefixed_id)
end
- many :customer_groups,
- resource: proc { Spree.api.admin_customer_group_serializer },
- if: proc { expand?('customer_groups') }
+ expandable :many, :customer_groups, :admin_customer_group_serializer
# Membership rows only — standing over a parent is a question for the
# standing filter, not a claim of membership.
- many :companies,
- resource: proc { Spree.api.admin_company_serializer },
- if: proc { expand?('companies') }
+ expandable :many, :companies, :admin_company_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/data_request_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/data_request_serializer.rb
index 6c599220e4..38b6708fab 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/data_request_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/data_request_serializer.rb
@@ -19,16 +19,12 @@ module Spree
attributes :email, :error_message, created_at: :iso8601, updated_at: :iso8601
- attribute :customer_id do |data_request|
- data_request.customer&.prefixed_id
- end
+ prefixed_id_attributes :customer
# Null when the subject asked for it themselves.
- attribute :requested_by_id do |data_request|
- data_request.requested_by&.prefixed_id
- end
+ prefixed_id_attributes :requested_by
- one :customer, resource: proc { Spree.api.admin_customer_serializer }, if: proc { expand?('customer') }
+ expandable :one, :customer, :admin_customer_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/delivery_method_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/delivery_method_serializer.rb
index 4a702ca594..e541f43742 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/delivery_method_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/delivery_method_serializer.rb
@@ -28,9 +28,7 @@ module Spree
# Which seller runs this method, so the operator's list can say
# whose it is. Null is the marketplace's own
# (docs/plans/6.0-multi-vendor-marketplace.md, Decision 13).
- attribute :seller_id do |record|
- record.seller&.prefixed_id
- end
+ prefixed_id_attributes :seller
attribute :seller_name do |record|
record.seller&.name
@@ -42,21 +40,7 @@ module Spree
# eligibility without a request per method.
many :delivery_method_rules, key: :rules, resource: proc { Spree.api.admin_delivery_method_rule_serializer }
- attribute :tax_category_id do |record|
- record.tax_category&.prefixed_id
- end
-
- attribute :delivery_profile_id do |record|
- record.delivery_profile&.prefixed_id
- end
-
- attribute :delivery_origin_group_id do |record|
- record.delivery_origin_group&.prefixed_id
- end
-
- attribute :delivery_zone_id do |record|
- record.delivery_zone&.prefixed_id
- end
+ prefixed_id_attributes :tax_category, :delivery_profile, :delivery_origin_group, :delivery_zone
attribute :stock_location_ids do |record|
record.pickup_locations.map(&:prefixed_id)
diff --git a/spree/api/app/serializers/spree/api/v3/admin/delivery_origin_group_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/delivery_origin_group_serializer.rb
index 2032786ae6..60e77fa7a0 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/delivery_origin_group_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/delivery_origin_group_serializer.rb
@@ -11,9 +11,7 @@ module Spree
attributes :name, :position,
created_at: :iso8601, updated_at: :iso8601
- attribute :delivery_profile_id do |record|
- record.delivery_profile&.prefixed_id
- end
+ prefixed_id_attributes :delivery_profile
# Empty means every store location.
attribute :stock_location_ids do |record|
diff --git a/spree/api/app/serializers/spree/api/v3/admin/delivery_rate_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/delivery_rate_serializer.rb
index 3575c31da3..2f8db9e02c 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/delivery_rate_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/delivery_rate_serializer.rb
@@ -10,7 +10,7 @@ module Spree
attributes :metadata
attributes created_at: :iso8601, updated_at: :iso8601
- one :delivery_method, resource: proc { Spree.api.admin_delivery_method_serializer }, if: proc { expand?('delivery_method') }
+ expandable :one, :delivery_method, :admin_delivery_method_serializer
# An admin twin, so this package carries its own type rather
# than importing the store one.
diff --git a/spree/api/app/serializers/spree/api/v3/admin/delivery_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/delivery_serializer.rb
index 53f4539d0e..70be29e246 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/delivery_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/delivery_serializer.rb
@@ -10,9 +10,7 @@ module Spree
# Operational detail, so admin-only.
attributes :details, created_at: :iso8601, updated_at: :iso8601
- attribute :shipping_label_id do |delivery|
- delivery.shipping_label&.prefixed_id
- end
+ prefixed_id_attributes :shipping_label
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/delivery_zone_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/delivery_zone_serializer.rb
index 6fb1159293..0329990221 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/delivery_zone_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/delivery_zone_serializer.rb
@@ -9,19 +9,13 @@ module Spree
attributes created_at: :iso8601, updated_at: :iso8601
- attribute :delivery_profile_id do |record|
- record.delivery_profile&.prefixed_id
- end
-
- attribute :delivery_origin_group_id do |record|
- record.delivery_origin_group&.prefixed_id
- end
+ prefixed_id_attributes :delivery_profile, :delivery_origin_group
attribute :delivery_method_ids do |record|
record.delivery_methods.map(&:prefixed_id)
end
- many :members, resource: proc { Spree.api.admin_delivery_zone_member_serializer }, if: proc { expand?('members') }
+ expandable :many, :members, :admin_delivery_zone_member_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/exchange_line_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/exchange_line_item_serializer.rb
index 20295621de..73c325e1f7 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/exchange_line_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/exchange_line_item_serializer.rb
@@ -7,8 +7,8 @@ module Spree
class ExchangeLineItemSerializer < V3::ExchangeLineItemSerializer
attributes created_at: :iso8601, updated_at: :iso8601
- one :original_variant, resource: proc { Spree.api.admin_variant_serializer }, if: proc { expand?('original_variant') }
- one :new_variant, resource: proc { Spree.api.admin_variant_serializer }, if: proc { expand?('new_variant') }
+ expandable :one, :original_variant, :admin_variant_serializer
+ expandable :one, :new_variant, :admin_variant_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/exchange_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/exchange_serializer.rb
index 2fc3986817..80c2fa5167 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/exchange_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/exchange_serializer.rb
@@ -13,20 +13,16 @@ module Spree
attributes :memo, :metadata, created_at: :iso8601, updated_at: :iso8601
- attribute :stock_location_id do |exchange|
- exchange.stock_location&.prefixed_id
- end
+ prefixed_id_attributes :stock_location
actor_attributes :created_by
- many :exchange_line_items,
- resource: proc { Spree.api.admin_exchange_line_item_serializer },
- if: proc { expand?('exchange_line_items') }
+ expandable :many, :exchange_line_items, :admin_exchange_line_item_serializer
- one :reason, resource: proc { Spree.api.admin_return_reason_serializer }, if: proc { expand?('reason') }
- one :order, resource: proc { Spree.api.admin_order_serializer }, if: proc { expand?('order') }
- one :stock_location, resource: proc { Spree.api.admin_stock_location_serializer }, if: proc { expand?('stock_location') }
- many :refunds, resource: proc { Spree.api.admin_refund_serializer }, if: proc { expand?('refunds') }
+ expandable :one, :reason, :admin_return_reason_serializer
+ expandable :one, :order, :admin_order_serializer
+ expandable :one, :stock_location, :admin_stock_location_serializer
+ expandable :many, :refunds, :admin_refund_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/export_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/export_serializer.rb
index 0f0f28374d..9dca656310 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/export_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/export_serializer.rb
@@ -23,13 +23,7 @@ module Spree
# it — whose it is. A null `seller_id` means the operator's own.
# The name rides along so the list can show who without a second
# request per row.
- attribute :store_id do |export|
- export.store&.prefixed_id
- end
-
- attribute :seller_id do |export|
- export.seller&.prefixed_id
- end
+ prefixed_id_attributes :store, :seller
attribute :seller_name do |export|
export.seller&.name
diff --git a/spree/api/app/serializers/spree/api/v3/admin/fulfillment_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/fulfillment_item_serializer.rb
index 3fd10b7663..ec717482f9 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/fulfillment_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/fulfillment_item_serializer.rb
@@ -17,13 +17,7 @@ module Spree
attributes :quantity, :status
- attribute :variant_id do |item|
- item.variant&.prefixed_id
- end
-
- attribute :line_item_id do |item|
- item.line_item&.prefixed_id
- end
+ prefixed_id_attributes :variant, :line_item
attribute :name do |item|
item.variant&.product&.name
diff --git a/spree/api/app/serializers/spree/api/v3/admin/fulfillment_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/fulfillment_serializer.rb
index 60cfa61cec..a3d5afd5d1 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/fulfillment_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/fulfillment_serializer.rb
@@ -23,13 +23,7 @@ module Spree
attributes :metadata, :adjustment_total, :pre_tax_amount,
created_at: :iso8601, updated_at: :iso8601
- attribute :order_id do |fulfillment|
- fulfillment.order&.prefixed_id
- end
-
- attribute :stock_location_id do |fulfillment|
- fulfillment.stock_location&.prefixed_id
- end
+ prefixed_id_attributes :order, :stock_location
# Customs forms and other paperwork the provider produced beside the
# label; the labels themselves are listed under +labels+.
@@ -48,20 +42,16 @@ module Spree
# Override inherited associations to use admin serializers
many :deliveries, resource: proc { Spree.api.admin_delivery_serializer }
- one :delivery_method, resource: proc { Spree.api.admin_delivery_method_serializer }, if: proc { expand?('delivery_method') }
- one :stock_location, resource: proc { Spree.api.admin_stock_location_serializer }, if: proc { expand?('stock_location') }
- many :delivery_rates, resource: proc { Spree.api.admin_delivery_rate_serializer }, if: proc { expand?('delivery_rates') }
- many :tax_lines, resource: proc { Spree.api.admin_tax_line_serializer }, if: proc { expand?('tax_lines') }
+ expandable :one, :delivery_method, :admin_delivery_method_serializer
+ expandable :one, :stock_location, :admin_stock_location_serializer
+ expandable :many, :delivery_rates, :admin_delivery_rate_serializer
+ expandable :many, :tax_lines, :admin_tax_line_serializer
# The units in this fulfillment — the dashboard needs them to offer
# what can actually be returned or exchanged.
- many :fulfillment_items,
- resource: proc { Spree.api.admin_fulfillment_item_serializer },
- if: proc { expand?('fulfillment_items') }
+ expandable :many, :fulfillment_items, :admin_fulfillment_item_serializer
- one :order,
- resource: proc { Spree.api.admin_order_serializer },
- if: proc { expand?('order') }
+ expandable :one, :order, :admin_order_serializer
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/gift_card_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/gift_card_serializer.rb
index 8f82ffd504..a508f433b0 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/gift_card_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/gift_card_serializer.rb
@@ -24,25 +24,15 @@ module Spree
params[:gift_card_codes] ? gift_card.display_code : gift_card.masked_code
end
- attribute :customer_id do |gift_card|
- gift_card.customer&.prefixed_id
- end
-
- attribute :created_by_id do |gift_card|
- gift_card.created_by&.prefixed_id
- end
+ prefixed_id_attributes :customer, :created_by
# Customer the card was issued to. Gated behind `expand?` to keep
# the list payload thin — the SPA's list view passes
# `expand=customer,created_by` to populate the row chips.
- one :customer,
- resource: proc { Spree.api.admin_customer_serializer },
- if: proc { expand?('customer') }
+ expandable :one, :customer, :admin_customer_serializer
# Admin who issued the card.
- one :created_by,
- resource: proc { Spree.api.admin_admin_user_serializer },
- if: proc { expand?('created_by') }
+ expandable :one, :created_by, :admin_admin_user_serializer
# Batch the card was issued as part of (bulk-issue flow). The
# `Spree::GiftCard#batch` association is keyed off
@@ -54,9 +44,7 @@ module Spree
if: proc { expand?('gift_card_batch') }
# Orders that consumed the card. Detail-only — pass `expand=orders`.
- many :orders,
- resource: proc { Spree.api.admin_order_serializer },
- if: proc { expand?('orders') }
+ expandable :many, :orders, :admin_order_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/line_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/line_item_serializer.rb
index ef12565c43..e422bea600 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/line_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/line_item_serializer.rb
@@ -44,9 +44,7 @@ module Spree
# Empty on a shop-price or hand-negotiated line. Names ride along
# beside the ids so a page of lines does not cost a request each to
# label, as `company_name` already does.
- attribute :price_list_id do |line_item|
- line_item.price_list&.prefixed_id
- end
+ prefixed_id_attributes :price_list
attribute :price_list_name do |line_item|
line_item.price_list&.name
@@ -64,28 +62,20 @@ module Spree
line_item.cost_price&.to_s
end
- attribute :tax_category_id do |line_item|
- line_item.tax_category&.prefixed_id
- end
+ prefixed_id_attributes :tax_category
# Override inherited associations to use admin serializers
many :option_values, resource: proc { Spree.api.admin_option_value_serializer }
many :digital_links, resource: proc { Spree.api.admin_digital_link_serializer }
- many :tax_lines, resource: proc { Spree.api.admin_tax_line_serializer }, if: proc { expand?('tax_lines') }
+ expandable :many, :tax_lines, :admin_tax_line_serializer
# `seller_id` comes from the store serializer; the expand resolves
# to the operator's view of the seller rather than the public one.
- one :seller,
- resource: proc { Spree.api.admin_seller_serializer },
- if: proc { expand?('seller') }
+ expandable :one, :seller, :admin_seller_serializer
- one :variant,
- resource: proc { Spree.api.admin_variant_serializer },
- if: proc { expand?('variant') }
+ expandable :one, :variant, :admin_variant_serializer
- one :tax_category,
- resource: proc { Spree.api.admin_tax_category_serializer },
- if: proc { expand?('tax_category') }
+ expandable :one, :tax_category, :admin_tax_category_serializer
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/media_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/media_serializer.rb
index 8d2d26378d..0cccb2a449 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/media_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/media_serializer.rb
@@ -57,9 +57,7 @@ module Spree
asset.attachment_blob&.signed_id
end
- attribute :viewable_id do |asset|
- asset.viewable&.prefixed_id
- end
+ prefixed_id_attributes :viewable
# Forces Content-Disposition: attachment so admins downloading from
# cloud storage (S3) get a save-as instead of an inline view. Mirrors
diff --git a/spree/api/app/serializers/spree/api/v3/admin/option_type_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/option_type_serializer.rb
index ee0b252051..0fdb93d47b 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/option_type_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/option_type_serializer.rb
@@ -10,9 +10,7 @@ module Spree
attributes :metadata, :filterable,
created_at: :iso8601, updated_at: :iso8601
- many :option_values,
- resource: proc { Spree.api.admin_option_value_serializer },
- if: proc { expand?('option_values') }
+ expandable :many, :option_values, :admin_option_value_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/option_value_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/option_value_serializer.rb
index e7c76d8ef0..09b7a3f125 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/option_value_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/option_value_serializer.rb
@@ -8,9 +8,7 @@ module Spree
attributes :metadata,
created_at: :iso8601, updated_at: :iso8601
- one :option_type,
- resource: proc { Spree.api.admin_option_type_serializer },
- if: proc { expand?('option_type') }
+ expandable :one, :option_type, :admin_option_type_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/order_cancellation_reason_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/order_cancellation_reason_serializer.rb
index c730901af8..e793fc6c66 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/order_cancellation_reason_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/order_cancellation_reason_serializer.rb
@@ -19,9 +19,7 @@ module Spree
# Lets the dashboard hide destructive controls instead of offering a
# delete that the model will refuse.
- attribute :can_be_deleted do |reason|
- reason.can_be_deleted?
- end
+ attribute :can_be_deleted, &:can_be_deleted?
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/order_group_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/order_group_serializer.rb
index 8c9db627fd..82a562250e 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/order_group_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/order_group_serializer.rb
@@ -17,9 +17,7 @@ module Spree
store_owner_notification_delivered: :boolean,
created_at: :string, updated_at: :string
- attribute :customer_id do |group|
- group.customer&.prefixed_id
- end
+ prefixed_id_attributes :customer
attribute :cart_id do |group|
Spree::Cart.prefixed_id_for(group.cart_id)
@@ -28,13 +26,9 @@ module Spree
# How many sellers this checkout reached — the operator's headline
# question about a group, and cheaper than counting the orders client
# side once a group is large.
- attribute :seller_count do |group|
- group.seller_count
- end
+ attributes :seller_count
- attribute :includes_first_party do |group|
- group.includes_first_party?
- end
+ attribute :includes_first_party, &:includes_first_party?
# A split checkout is confirmed once, from here — every child order
# places silently, so their own flags are false and only the group
diff --git a/spree/api/app/serializers/spree/api/v3/admin/order_routing_rule_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/order_routing_rule_serializer.rb
index 19f308f663..3db676f3c0 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/order_routing_rule_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/order_routing_rule_serializer.rb
@@ -22,9 +22,7 @@ module Spree
rule.class.api_type
end
- attribute :channel_id do |rule|
- rule.channel&.prefixed_id
- end
+ prefixed_id_attributes :channel
attribute :preferences, &:serialized_preferences
attribute :preference_schema, &:serialized_preference_schema
diff --git a/spree/api/app/serializers/spree/api/v3/admin/order_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/order_serializer.rb
index 8a6aca0962..801a83abaa 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/order_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/order_serializer.rb
@@ -74,9 +74,7 @@ module Spree
canceled_at: :iso8601, approved_at: :iso8601,
created_at: :iso8601, updated_at: :iso8601
- attribute :preferred_stock_location_id do |order|
- order.preferred_stock_location&.prefixed_id
- end
+ prefixed_id_attributes :preferred_stock_location
# Our own endpoint rather than a pre-signed storage URL: the
# controller streams the bytes, so admin auth runs on every download
@@ -90,9 +88,7 @@ module Spree
# Which company node the order is for, so the dashboard can show and
# change it. Read back from the column rather than #resolved_company:
# a placed order must report what it was stamped with.
- attribute :company_id do |order|
- order.company&.prefixed_id
- end
+ prefixed_id_attributes :company
attribute :company_name do |order|
order.company&.name
@@ -100,13 +96,9 @@ module Spree
# Whose sale this is — nil on the operator's own goods. The full
# profile is `?expand=seller`.
- attribute :seller_id do |order|
- order.seller&.prefixed_id
- end
+ prefixed_id_attributes :seller
- one :seller,
- resource: proc { Spree.api.admin_seller_serializer },
- if: proc { expand?('seller') }
+ expandable :one, :seller, :admin_seller_serializer
# The checkout this order was placed in, when it was placed alongside
# others.
@@ -136,9 +128,7 @@ module Spree
# secret key names the key.
actor_attributes :approver, :canceler, :created_by
- attribute :cancel_reason_id do |order|
- order.cancel_reason&.prefixed_id
- end
+ prefixed_id_attributes :cancel_reason
# The reason's name alongside its id, so an order list can show why
# each canceled order was called off without expanding a record per
@@ -147,9 +137,7 @@ module Spree
order.cancel_reason&.name
end
- attribute :customer_id do |order|
- order.customer&.prefixed_id
- end
+ prefixed_id_attributes :customer
# Override inherited associations to use admin serializers
# Renamed from the store's `discounts` key: on the admin surface that
@@ -163,44 +151,32 @@ module Spree
_attributes.delete(:fees)
many :order_promotions, key: :applied_promotions, resource: proc { Spree.api.admin_applied_promotion_serializer }, if: proc { expand?('applied_promotions') }
many :line_items, key: :items, resource: proc { Spree.api.admin_line_item_serializer }, if: proc { expand?('items') }
- many :fulfillments, resource: proc { Spree.api.admin_fulfillment_serializer }, if: proc { expand?('fulfillments') }
- many :payments, resource: proc { Spree.api.admin_payment_serializer }, if: proc { expand?('payments') }
+ expandable :many, :fulfillments, :admin_fulfillment_serializer
+ expandable :many, :payments, :admin_payment_serializer
# An order from a split checkout has no payments of its own; what it
# has is a share of each payment made against its group.
- many :payment_splits, resource: proc { Spree.api.admin_payment_split_serializer }, if: proc { expand?('payment_splits') }
+ expandable :many, :payment_splits, :admin_payment_split_serializer
- one :billing_address, resource: proc { Spree.api.admin_address_serializer }, if: proc { expand?('billing_address') }
- one :shipping_address, resource: proc { Spree.api.admin_address_serializer }, if: proc { expand?('shipping_address') }
+ expandable :one, :billing_address, :admin_address_serializer
+ expandable :one, :shipping_address, :admin_address_serializer
one :gift_card, resource: proc { Spree.api.admin_gift_card_serializer }
- one :cart, resource: proc { Spree.api.admin_cart_serializer }, if: proc { expand?('cart') }
+ expandable :one, :cart, :admin_cart_serializer
one :market, resource: proc { Spree.api.admin_market_serializer }
- one :channel, resource: proc { Spree.api.admin_channel_serializer }, if: proc { expand?('channel') }
- one :preferred_stock_location,
- resource: proc { Spree.api.admin_stock_location_serializer },
- if: proc { expand?('preferred_stock_location') }
+ expandable :one, :channel, :admin_channel_serializer
+ expandable :one, :preferred_stock_location, :admin_stock_location_serializer
- many :payment_methods, resource: proc { Spree.api.admin_payment_method_serializer }, if: proc { expand?('payment_methods') }
+ expandable :many, :payment_methods, :admin_payment_method_serializer
- one :customer,
- resource: proc { Spree.api.admin_customer_serializer },
- if: proc { expand?('customer') }
+ expandable :one, :customer, :admin_customer_serializer
- one :cancel_reason,
- resource: proc { Spree.api.admin_order_cancellation_reason_serializer },
- if: proc { expand?('cancel_reason') }
+ expandable :one, :cancel_reason, :admin_order_cancellation_reason_serializer
- many :returns,
- resource: proc { Spree.api.admin_return_serializer },
- if: proc { expand?('returns') }
+ expandable :many, :returns, :admin_return_serializer
- many :exchanges,
- resource: proc { Spree.api.admin_exchange_serializer },
- if: proc { expand?('exchanges') }
+ expandable :many, :exchanges, :admin_exchange_serializer
- many :claims,
- resource: proc { Spree.api.admin_claim_serializer },
- if: proc { expand?('claims') }
+ expandable :many, :claims, :admin_claim_serializer
# What the forwarder quoted against, frozen onto the rates this
# order shipped under. Back-office only: a buyer is told what their
diff --git a/spree/api/app/serializers/spree/api/v3/admin/package_type_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/package_type_serializer.rb
index 218c33c4ee..ec69c46f66 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/package_type_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/package_type_serializer.rb
@@ -39,9 +39,7 @@ module Spree
# Whose packaging this is: a seller's own, or (null) the
# marketplace's shared vocabulary
# (docs/plans/6.0-seller-package-types.md).
- attribute :seller_id do |package_type|
- package_type.seller&.prefixed_id
- end
+ prefixed_id_attributes :seller
attribute :seller_name do |package_type|
package_type.seller&.name
diff --git a/spree/api/app/serializers/spree/api/v3/admin/payment_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/payment_serializer.rb
index 81227babfa..d330ff6e0e 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/payment_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/payment_serializer.rb
@@ -17,16 +17,12 @@ module Spree
attributes :metadata, :avs_response, :cvv_response_code, :cvv_response_message,
created_at: :iso8601, updated_at: :iso8601
- attribute :captured_amount do |payment|
- payment.captured_amount.to_s
- end
+ string_attributes :captured_amount
- attribute :order_id do |payment|
- payment.order&.prefixed_id
- end
+ prefixed_id_attributes :order
# Override inherited associations to use admin serializers
- one :payment_method, resource: proc { Spree.api.admin_payment_method_serializer }, if: proc { expand?('payment_method') }
+ expandable :one, :payment_method, :admin_payment_method_serializer
attribute :source do |payment|
next nil if payment.source.blank?
@@ -43,19 +39,13 @@ module Spree
serializer.new(payment.source).to_h
end
- one :order,
- resource: proc { Spree.api.admin_order_serializer },
- if: proc { expand?('order') }
+ expandable :one, :order, :admin_order_serializer
- many :refunds,
- resource: proc { Spree.api.admin_refund_serializer },
- if: proc { expand?('refunds') }
+ expandable :many, :refunds, :admin_refund_serializer
# How a payment made against an order group is shared between the
# orders in it; empty on a payment made against a single order.
- many :payment_splits,
- resource: proc { Spree.api.admin_payment_split_serializer },
- if: proc { expand?('payment_splits') }
+ expandable :many, :payment_splits, :admin_payment_split_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/price_list_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/price_list_serializer.rb
index 734c873a8e..947a8e32c9 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/price_list_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/price_list_serializer.rb
@@ -53,9 +53,7 @@ module Spree
many :price_adjustment_tiers,
resource: proc { Spree.api.admin_price_adjustment_tier_serializer }
- many :price_rules,
- resource: proc { Spree.api.admin_price_rule_serializer },
- if: proc { expand?('price_rules') }
+ expandable :many, :price_rules, :admin_price_rule_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/price_rule_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/price_rule_serializer.rb
index 10e922d740..7086089a76 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/price_rule_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/price_rule_serializer.rb
@@ -17,9 +17,7 @@ module Spree
rule.class.api_type
end
- attribute :price_list_id do |rule|
- rule.price_list&.prefixed_id
- end
+ prefixed_id_attributes :price_list
attribute :preferences, &:serialized_preferences
attribute :preference_schema, &:serialized_preference_schema
diff --git a/spree/api/app/serializers/spree/api/v3/admin/price_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/price_serializer.rb
index 5b6410de88..2eea5be234 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/price_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/price_serializer.rb
@@ -18,9 +18,7 @@ module Spree
attributes created_at: :iso8601, updated_at: :iso8601
- one :variant,
- resource: proc { Spree.api.admin_variant_serializer },
- if: proc { expand?('variant') }
+ expandable :one, :variant, :admin_variant_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/product_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/product_serializer.rb
index 8dbf4d529d..4910e22517 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/product_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/product_serializer.rb
@@ -24,9 +24,7 @@ module Spree
:metadata, deleted_at: :iso8601,
created_at: :iso8601, updated_at: :iso8601
- attribute :delivery_profile_id do |product|
- product.delivery_profile&.prefixed_id
- end
+ prefixed_id_attributes :delivery_profile
# The live row in the review trail: who submitted, who decided,
# when, and what the seller was told. Expanded rather than always
@@ -43,17 +41,9 @@ module Spree
product.seller&.name
end
- one :seller,
- resource: proc { Spree.api.admin_seller_serializer },
- if: proc { expand?('seller') }
-
- attribute :product_type_id do |product|
- product.product_type&.prefixed_id
- end
+ expandable :one, :seller, :admin_seller_serializer
- attribute :tax_category_id do |product|
- product.tax_category&.prefixed_id
- end
+ prefixed_id_attributes :product_type, :tax_category
attribute :price do |product|
price = price_for(product.default_variant)
@@ -71,17 +61,11 @@ module Spree
end
# Admin uses admin variant serializer
- many :variants,
- resource: proc { Spree.api.admin_variant_serializer },
- if: proc { expand?('variants') }
+ expandable :many, :variants, :admin_variant_serializer
- one :default_variant,
- resource: proc { Spree.api.admin_variant_serializer },
- if: proc { expand?('default_variant') }
+ expandable :one, :default_variant, :admin_variant_serializer
- one :primary_media,
- resource: proc { Spree.api.admin_media_serializer },
- if: proc { expand?('primary_media') }
+ expandable :one, :primary_media, :admin_media_serializer
many :gallery_media,
key: :media,
@@ -90,17 +74,11 @@ module Spree
# Read/write symmetry: the product accepts inline `digital_assets` on
# create, so it exposes them (opt-in via ?expand=digital_assets).
- many :digital_assets,
- resource: proc { Spree.api.admin_digital_asset_serializer },
- if: proc { expand?('digital_assets') }
+ expandable :many, :digital_assets, :admin_digital_asset_serializer
- many :option_types,
- resource: proc { Spree.api.admin_option_type_serializer },
- if: proc { expand?('option_types') }
+ expandable :many, :option_types, :admin_option_type_serializer
- many :option_values,
- resource: proc { Spree.api.admin_option_value_serializer },
- if: proc { expand?('option_values') }
+ expandable :many, :option_values, :admin_option_value_serializer
many :categories,
proc { |categories, params|
@@ -110,25 +88,15 @@ module Spree
resource: proc { Spree.api.admin_category_serializer },
if: proc { expand?('categories') }
- many :collections,
- resource: proc { Spree.api.admin_collection_serializer },
- if: proc { expand?('collections') }
+ expandable :many, :collections, :admin_collection_serializer
- many :custom_fields,
- resource: proc { Spree.api.admin_custom_field_serializer },
- if: proc { expand?('custom_fields') }
+ expandable :many, :custom_fields, :admin_custom_field_serializer
- many :product_publications,
- resource: proc { Spree.api.admin_product_publication_serializer },
- if: proc { expand?('product_publications') }
+ expandable :many, :product_publications, :admin_product_publication_serializer
- many :channels,
- resource: proc { Spree.api.admin_channel_serializer },
- if: proc { expand?('channels') }
+ expandable :many, :channels, :admin_channel_serializer
- one :product_type,
- resource: proc { Spree.api.admin_product_type_serializer },
- if: proc { expand?('product_type') }
+ expandable :one, :product_type, :admin_product_type_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/product_submission_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/product_submission_serializer.rb
index 09afc0444f..31fd5b7161 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/product_submission_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/product_submission_serializer.rb
@@ -14,13 +14,7 @@ module Spree
attributes :metadata, updated_at: :iso8601
- attribute :submitted_by_id do |submission|
- submission.submitted_by&.prefixed_id
- end
-
- attribute :reviewed_by_id do |submission|
- submission.reviewed_by&.prefixed_id
- end
+ prefixed_id_attributes :submitted_by, :reviewed_by
# An operator reading the trail wants a name, not an id to resolve.
attribute :reviewed_by_name do |submission|
@@ -29,9 +23,7 @@ module Spree
# Distinguishes "the store approves listings automatically" from a
# decision whose author we failed to record.
- attribute :auto_approved do |submission|
- submission.auto_approved?
- end
+ attribute :auto_approved, &:auto_approved?
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/product_type_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/product_type_serializer.rb
index 71f04220ca..47a7664380 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/product_type_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/product_type_serializer.rb
@@ -15,9 +15,7 @@ module Spree
# The creation-time template: stamped onto products at creation,
# never synced afterwards.
- attribute :delivery_profile_id do |record|
- record.delivery_profile&.prefixed_id
- end
+ prefixed_id_attributes :delivery_profile
# Prefixed ids of the option types and categories this type seeds onto
# new products — the same payload the client sends back on PATCH.
diff --git a/spree/api/app/serializers/spree/api/v3/admin/promotion_action_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/promotion_action_serializer.rb
index 9448de4698..3495e86341 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/promotion_action_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/promotion_action_serializer.rb
@@ -22,9 +22,7 @@ module Spree
action.class.api_type
end
- attribute :promotion_id do |action|
- action.promotion&.prefixed_id
- end
+ prefixed_id_attributes :promotion
attribute :preferences, &:serialized_preferences
attribute :preference_schema, &:serialized_preference_schema
diff --git a/spree/api/app/serializers/spree/api/v3/admin/promotion_rule_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/promotion_rule_serializer.rb
index ad08637fda..b03392c8ae 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/promotion_rule_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/promotion_rule_serializer.rb
@@ -23,9 +23,7 @@ module Spree
rule.class.api_type
end
- attribute :promotion_id do |rule|
- rule.promotion&.prefixed_id
- end
+ prefixed_id_attributes :promotion
attribute :preferences, &:serialized_preferences
attribute :preference_schema, &:serialized_preference_schema
diff --git a/spree/api/app/serializers/spree/api/v3/admin/purchase_order_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/purchase_order_item_serializer.rb
index 37a1290c90..c3931675b5 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/purchase_order_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/purchase_order_item_serializer.rb
@@ -32,25 +32,13 @@ module Spree
item.unit_cost&.to_s
end
- attribute :total_cost do |item|
- item.total_cost.to_s
- end
-
- attribute :display_unit_cost do |item|
- item.display_unit_cost.to_s
- end
-
- attribute :display_total_cost do |item|
- item.display_total_cost.to_s
- end
+ string_attributes :total_cost, :display_unit_cost, :display_total_cost
attribute :purchase_order_id do |item|
Spree::PurchaseOrder.prefixed_id_for(item.purchase_order_id)
end
- attribute :variant_id do |item|
- item.variant&.prefixed_id
- end
+ prefixed_id_attributes :variant
# The product the line's variant belongs to, so a line can link
# straight to the screen where that SKU's stock lives.
diff --git a/spree/api/app/serializers/spree/api/v3/admin/purchase_order_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/purchase_order_serializer.rb
index d25e5a2a89..7f49c2a662 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/purchase_order_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/purchase_order_serializer.rb
@@ -56,37 +56,17 @@ module Spree
attribute :editable, &:editable?
- attribute :subtotal do |purchase_order|
- purchase_order.subtotal.to_s
- end
-
- attribute :display_subtotal do |purchase_order|
- purchase_order.display_subtotal.to_s
- end
+ string_attributes :subtotal, :display_subtotal
- attribute :supplier_id do |purchase_order|
- purchase_order.supplier&.prefixed_id
- end
-
- attribute :destination_location_id do |purchase_order|
- purchase_order.destination_location&.prefixed_id
- end
+ prefixed_id_attributes :supplier, :destination_location
- many :items,
- resource: proc { Spree.api.admin_purchase_order_item_serializer },
- if: proc { expand?('items') }
+ expandable :many, :items, :admin_purchase_order_item_serializer
- many :stock_receipts,
- resource: proc { Spree.api.admin_stock_receipt_serializer },
- if: proc { expand?('stock_receipts') }
+ expandable :many, :stock_receipts, :admin_stock_receipt_serializer
- one :supplier,
- resource: proc { Spree.api.admin_supplier_serializer },
- if: proc { expand?('supplier') }
+ expandable :one, :supplier, :admin_supplier_serializer
- one :destination_location,
- resource: proc { Spree.api.admin_stock_location_serializer },
- if: proc { expand?('destination_location') }
+ expandable :one, :destination_location, :admin_stock_location_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/refund_reason_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/refund_reason_serializer.rb
index e16b316b92..ea9c12d615 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/refund_reason_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/refund_reason_serializer.rb
@@ -17,9 +17,7 @@ module Spree
# Lets the dashboard hide destructive controls instead of offering a
# delete that the model will refuse.
- attribute :can_be_deleted do |reason|
- reason.can_be_deleted?
- end
+ attribute :can_be_deleted, &:can_be_deleted?
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/refund_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/refund_serializer.rb
index dfa43825e3..d028e33070 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/refund_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/refund_serializer.rb
@@ -14,17 +14,13 @@ module Spree
created_at: :iso8601, updated_at: :iso8601
# The tax inside the amount, when what was refunded carried tax.
- attribute :tax_amount do |refund|
- refund.tax_amount.to_s
- end
+ string_attributes :tax_amount
# Who issued it — an admin user, or the API key an integration
# refunded through.
actor_attributes :refunder
- one :payment,
- resource: proc { Spree.api.admin_payment_serializer },
- if: proc { expand?('payment') }
+ expandable :one, :payment, :admin_payment_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/return_line_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/return_line_item_serializer.rb
index 479661b7c1..55b65b1bdb 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/return_line_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/return_line_item_serializer.rb
@@ -7,9 +7,9 @@ module Spree
class ReturnLineItemSerializer < V3::ReturnLineItemSerializer
attributes created_at: :iso8601, updated_at: :iso8601
- one :variant, resource: proc { Spree.api.admin_variant_serializer }, if: proc { expand?('variant') }
- one :line_item, resource: proc { Spree.api.admin_line_item_serializer }, if: proc { expand?('line_item') }
- many :tax_lines, resource: proc { Spree.api.admin_tax_line_serializer }, if: proc { expand?('tax_lines') }
+ expandable :one, :variant, :admin_variant_serializer
+ expandable :one, :line_item, :admin_line_item_serializer
+ expandable :many, :tax_lines, :admin_tax_line_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/return_reason_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/return_reason_serializer.rb
index ab368be1ab..de8bedf08f 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/return_reason_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/return_reason_serializer.rb
@@ -11,9 +11,7 @@ module Spree
# Lets the dashboard hide destructive controls instead of offering a
# delete that the model will refuse.
- attribute :can_be_deleted do |reason|
- reason.can_be_deleted?
- end
+ attribute :can_be_deleted, &:can_be_deleted?
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/return_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/return_serializer.rb
index 3d5ea6bc48..997a0f50d7 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/return_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/return_serializer.rb
@@ -17,32 +17,18 @@ module Spree
attributes :memo, :metadata, created_at: :iso8601, updated_at: :iso8601
- attribute :stock_location_id do |return_record|
- return_record.stock_location&.prefixed_id
- end
+ prefixed_id_attributes :stock_location
actor_attributes :created_by
- attribute :refunded_total do |return_record|
- return_record.refunded_total.to_s
- end
-
- attribute :display_refunded_total do |return_record|
- return_record.display_refunded_total.to_s
- end
-
- attribute :refundable_total do |return_record|
- return_record.refundable_total.to_s
- end
+ string_attributes :refunded_total, :display_refunded_total, :refundable_total
- many :return_line_items,
- resource: proc { Spree.api.admin_return_line_item_serializer },
- if: proc { expand?('return_line_items') }
+ expandable :many, :return_line_items, :admin_return_line_item_serializer
- one :reason, resource: proc { Spree.api.admin_return_reason_serializer }, if: proc { expand?('reason') }
- one :order, resource: proc { Spree.api.admin_order_serializer }, if: proc { expand?('order') }
- one :stock_location, resource: proc { Spree.api.admin_stock_location_serializer }, if: proc { expand?('stock_location') }
- many :refunds, resource: proc { Spree.api.admin_refund_serializer }, if: proc { expand?('refunds') }
+ expandable :one, :reason, :admin_return_reason_serializer
+ expandable :one, :order, :admin_order_serializer
+ expandable :one, :stock_location, :admin_stock_location_serializer
+ expandable :many, :refunds, :admin_refund_serializer
# Paperwork the provider produced beside the label: a cross-border
# return is declared like any other export.
diff --git a/spree/api/app/serializers/spree/api/v3/admin/saved_report_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/saved_report_serializer.rb
index 4fe3fc186f..42b363fea1 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/saved_report_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/saved_report_serializer.rb
@@ -16,9 +16,7 @@ module Spree
attributes :name, :description, :query, :seeded, :created_at, :updated_at
- attribute :user_id do |report|
- report.user&.prefixed_id
- end
+ prefixed_id_attributes :user
# The same "name, else email" rule every actor answers, so a report's
# author and an order's canceler read alike.
diff --git a/spree/api/app/serializers/spree/api/v3/admin/seller_requirement_status_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/seller_requirement_status_serializer.rb
index 1fe8392a66..4d0132a9e7 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/seller_requirement_status_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/seller_requirement_status_serializer.rb
@@ -22,17 +22,13 @@ module Spree
# Whether this stands between the seller and approval. Serialized
# rather than left to each client to derive, so the dashboard's
# override warning and the approval gate cannot disagree.
- attribute :blocking do |status|
- status.blocking?
- end
+ attribute :blocking, &:blocking?
# The document this line asks for, and what the seller published
# against it. Embedded rather than left to a second request: the
# operator is deciding whether to approve, and a line that says
# "Done" without showing the text is not something to approve on.
- attribute :required_policy_name do |status|
- status.required_policy_name
- end
+ attributes :required_policy_name
one :submission,
resource: proc { Spree.api.admin_seller_requirement_submission_serializer },
diff --git a/spree/api/app/serializers/spree/api/v3/admin/seller_requirement_submission_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/seller_requirement_submission_serializer.rb
index f2686bf479..672694a9d5 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/seller_requirement_submission_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/seller_requirement_submission_serializer.rb
@@ -21,13 +21,7 @@ module Spree
created_at: :iso8601,
updated_at: :iso8601
- attribute :seller_id do |submission|
- submission.seller&.prefixed_id
- end
-
- attribute :requirement_id do |submission|
- submission.requirement&.prefixed_id
- end
+ prefixed_id_attributes :seller, :requirement
# The reviewer is looking at a queue of these and needs to know what
# each one answers without fetching the requirement.
diff --git a/spree/api/app/serializers/spree/api/v3/admin/seller_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/seller_serializer.rb
index c2dea0406a..7bafb73367 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/seller_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/seller_serializer.rb
@@ -43,20 +43,14 @@ module Spree
# Approved but away still cannot sell, and the list has to say so
# without the dashboard re-deriving the rule.
- attribute :on_holiday do |seller|
- seller.on_holiday?
- end
+ attribute :on_holiday, &:on_holiday?
- attribute :sellable do |seller|
- seller.sellable?
- end
+ attribute :sellable, &:sellable?
# Saves the dashboard a request per row for the two counts its list
# and header show. Read off the seller, which memoizes the SQL count
# so the minimum-products requirement asks the same question free.
- attribute :products_count do |seller|
- seller.products_count
- end
+ attributes :products_count
attribute :users_count do |seller|
seller.users.size
@@ -67,13 +61,9 @@ module Spree
# requirements themselves, with their submissions, stay on the
# heavier `onboarding` action; a list of sellers needs the number,
# not the rows behind it.
- attribute :onboarding_progress do |seller|
- seller.onboarding_progress
- end
+ attributes :onboarding_progress
- attribute :onboarding_complete do |seller|
- seller.onboarding_complete?
- end
+ attribute :onboarding_complete, &:onboarding_complete?
attribute :legal_name, &:legal_name
attribute :registration_number, &:registration_number
diff --git a/spree/api/app/serializers/spree/api/v3/admin/shipping_label_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/shipping_label_serializer.rb
index 4f2574c7d4..148b2ee531 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/shipping_label_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/shipping_label_serializer.rb
@@ -28,31 +28,19 @@ module Spree
attributes :source, :status, :carrier, :carrier_name, :service, :tracking_number, :currency, :format,
:external_id, :metadata, refunded_at: :iso8601, created_at: :iso8601, updated_at: :iso8601
- attribute :owner_id do |shipping_label|
- shipping_label.owner&.prefixed_id
- end
+ prefixed_id_attributes :owner
attribute :owner_type do |shipping_label|
shipping_label.owner_type == 'Spree::Return' ? 'return' : 'fulfillment'
end
- attribute :cost do |shipping_label|
- shipping_label.cost.to_s
- end
-
- attribute :display_cost do |shipping_label|
- shipping_label.display_cost.to_s
- end
+ string_attributes :cost, :display_cost
- attribute :integration_id do |shipping_label|
- shipping_label.integration&.prefixed_id
- end
+ prefixed_id_attributes :integration
# Whether the file is still being fetched from the carrier; the
# download proxies the provider's copy meanwhile.
- attribute :file_pending do |shipping_label|
- shipping_label.file_pending?
- end
+ attribute :file_pending, &:file_pending?
# Our own endpoint rather than a storage URL: the controller streams
# the bytes, so admin auth runs on every print.
diff --git a/spree/api/app/serializers/spree/api/v3/admin/stock_level_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/stock_level_serializer.rb
index 7fb4611909..0629015b98 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/stock_level_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/stock_level_serializer.rb
@@ -27,9 +27,7 @@ module Spree
stock_level.stock_location&.name
end
- attribute :product_id do |stock_level|
- stock_level.product&.prefixed_id
- end
+ prefixed_id_attributes :product
attribute :options_text do |stock_level|
stock_level.variant&.options_text.presence
@@ -51,13 +49,9 @@ module Spree
stock_level.available_count.to_i
end
- one :stock_location,
- resource: proc { Spree.api.admin_stock_location_serializer },
- if: proc { expand?('stock_location') }
+ expandable :one, :stock_location, :admin_stock_location_serializer
- one :variant,
- resource: proc { Spree.api.admin_variant_serializer },
- if: proc { expand?('variant') }
+ expandable :one, :variant, :admin_variant_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/stock_location_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/stock_location_serializer.rb
index 2c300d7912..e01557a842 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/stock_location_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/stock_location_serializer.rb
@@ -22,17 +22,13 @@ module Spree
:pickup_ready_in_minutes, :pickup_instructions,
created_at: :iso8601, updated_at: :iso8601
- attribute :seller_id do |stock_location|
- stock_location.seller&.prefixed_id
- end
+ prefixed_id_attributes :seller
attribute :seller_name do |stock_location|
stock_location.seller&.name
end
- one :seller,
- resource: proc { Spree.api.admin_seller_serializer },
- if: proc { expand?('seller') }
+ expandable :one, :seller, :admin_seller_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/stock_movement_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/stock_movement_serializer.rb
index 6fb5f67e2c..19281b29eb 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/stock_movement_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/stock_movement_serializer.rb
@@ -68,9 +68,7 @@ module Spree
Spree::StockTransfer.prefixed_id_for(movement.stock_transfer_id)
end
- attribute :stock_receipt_id do |movement|
- movement.stock_receipt&.prefixed_id
- end
+ prefixed_id_attributes :stock_receipt
attribute :purchase_order_id do |movement|
Spree::PurchaseOrder.prefixed_id_for(movement.purchase_order_id)
diff --git a/spree/api/app/serializers/spree/api/v3/admin/stock_receipt_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/stock_receipt_item_serializer.rb
index 57838baff9..5fd2fa6eb8 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/stock_receipt_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/stock_receipt_item_serializer.rb
@@ -25,13 +25,7 @@ module Spree
item.line_type.demodulize.underscore
end
- attribute :line_id do |item|
- item.line&.prefixed_id
- end
-
- attribute :variant_id do |item|
- item.variant&.prefixed_id
- end
+ prefixed_id_attributes :line, :variant
# The product the line's variant belongs to, so a delivery's line
# can link to the screen where that SKU's stock lives.
diff --git a/spree/api/app/serializers/spree/api/v3/admin/stock_receipt_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/stock_receipt_serializer.rb
index 83b75161ca..9b24d805ca 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/stock_receipt_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/stock_receipt_serializer.rb
@@ -28,9 +28,7 @@ module Spree
receipt.receivable_type.demodulize.underscore
end
- attribute :receivable_id do |receipt|
- receipt.receivable&.prefixed_id
- end
+ prefixed_id_attributes :receivable
actor_attributes :received_by
@@ -38,9 +36,7 @@ module Spree
receipt.items.size
end
- many :items,
- resource: proc { Spree.api.admin_stock_receipt_item_serializer },
- if: proc { expand?('items') }
+ expandable :many, :items, :admin_stock_receipt_item_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/stock_reservation_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/stock_reservation_serializer.rb
index ed8cba35bc..e38ba7f604 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/stock_reservation_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/stock_reservation_serializer.rb
@@ -34,9 +34,7 @@ module Spree
attributes :quantity, expires_at: :iso8601
- attribute :active do |reservation|
- reservation.active?
- end
+ attribute :active, &:active?
attributes created_at: :iso8601, updated_at: :iso8601
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/stock_transfer_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/stock_transfer_item_serializer.rb
index 84cbae9087..d8e908677d 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/stock_transfer_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/stock_transfer_item_serializer.rb
@@ -25,9 +25,7 @@ module Spree
Spree::StockTransfer.prefixed_id_for(item.stock_transfer_id)
end
- attribute :variant_id do |item|
- item.variant&.prefixed_id
- end
+ prefixed_id_attributes :variant
# The product the line's variant belongs to, so a line can link
# straight to the screen where that SKU's stock lives.
diff --git a/spree/api/app/serializers/spree/api/v3/admin/stock_transfer_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/stock_transfer_serializer.rb
index 1f38ef6f9b..88f9f856dd 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/stock_transfer_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/stock_transfer_serializer.rb
@@ -35,21 +35,13 @@ module Spree
attribute :editable, &:editable?
- many :items,
- resource: proc { Spree.api.admin_stock_transfer_item_serializer },
- if: proc { expand?('items') }
+ expandable :many, :items, :admin_stock_transfer_item_serializer
- many :stock_receipts,
- resource: proc { Spree.api.admin_stock_receipt_serializer },
- if: proc { expand?('stock_receipts') }
+ expandable :many, :stock_receipts, :admin_stock_receipt_serializer
- one :source_location,
- resource: proc { Spree.api.admin_stock_location_serializer },
- if: proc { expand?('source_location') }
+ expandable :one, :source_location, :admin_stock_location_serializer
- one :destination_location,
- resource: proc { Spree.api.admin_stock_location_serializer },
- if: proc { expand?('destination_location') }
+ expandable :one, :destination_location, :admin_stock_location_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/store_credit_event_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/store_credit_event_serializer.rb
index 7163666064..b1d083a210 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/store_credit_event_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/store_credit_event_serializer.rb
@@ -11,9 +11,7 @@ module Spree
attributes updated_at: :iso8601
- attribute :store_credit_id do |event|
- event.store_credit&.prefixed_id
- end
+ prefixed_id_attributes :store_credit
attribute :originator_type do |event|
Spree::Base.polymorphic_api_type(event.originator_type)
diff --git a/spree/api/app/serializers/spree/api/v3/admin/store_credit_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/store_credit_serializer.rb
index 4443c2d5b5..4765359593 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/store_credit_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/store_credit_serializer.rb
@@ -16,27 +16,15 @@ module Spree
attributes :memo, :metadata,
created_at: :iso8601, updated_at: :iso8601
- attribute :amount_authorized do |store_credit|
- store_credit.amount_authorized.to_s
- end
+ string_attributes :amount_authorized
# Answers the same question as the `outstanding` filter, so the row
# and the filter cannot disagree.
- attribute :outstanding do |store_credit|
- store_credit.outstanding?
- end
-
- attribute :display_amount_authorized do |store_credit|
- store_credit.display_amount_authorized.to_s
- end
+ attribute :outstanding, &:outstanding?
- attribute :customer_id do |store_credit|
- store_credit.customer&.prefixed_id
- end
+ string_attributes :display_amount_authorized
- attribute :created_by_id do |store_credit|
- store_credit.created_by&.prefixed_id
- end
+ prefixed_id_attributes :customer, :created_by
# Why the credit exists: the return, exchange, claim or gift card
# that issued it, or null when an admin issued it by hand. The type
@@ -56,13 +44,9 @@ module Spree
Spree::Base.polymorphic_prefixed_id(store_credit.originator_type, store_credit.originator_id)
end
- one :customer,
- resource: proc { Spree.api.admin_customer_serializer },
- if: proc { expand?('customer') }
+ expandable :one, :customer, :admin_customer_serializer
- one :created_by,
- resource: proc { Spree.api.admin_admin_user_serializer },
- if: proc { expand?('created_by') }
+ expandable :one, :created_by, :admin_admin_user_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/supplier_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/supplier_serializer.rb
index 9237971c62..94b718407c 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/supplier_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/supplier_serializer.rb
@@ -29,9 +29,7 @@ module Spree
# Lets the dashboard hide the delete control rather than offer one
# the model will refuse.
- attribute :can_be_deleted do |supplier|
- supplier.can_be_deleted?
- end
+ attribute :can_be_deleted, &:can_be_deleted?
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/tax_exemption_certificate_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/tax_exemption_certificate_serializer.rb
index cdcb06a1cd..1cc48e7b87 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/tax_exemption_certificate_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/tax_exemption_certificate_serializer.rb
@@ -19,9 +19,7 @@ module Spree
issued_at: :iso8601, expires_at: :iso8601, verified_at: :iso8601,
created_at: :iso8601, updated_at: :iso8601
- attribute :company_id do |certificate|
- certificate.company&.prefixed_id
- end
+ prefixed_id_attributes :company
# The jurisdiction the certificate holds in, in the same vocabulary the
# tax lines use.
@@ -33,14 +31,10 @@ module Spree
certificate.verified? && !certificate.lapsed?
end
- attribute :lapsed do |certificate|
- certificate.lapsed?
- end
+ attribute :lapsed, &:lapsed?
# Lets the dashboard hide a delete the model will refuse.
- attribute :can_be_deleted do |certificate|
- certificate.can_be_deleted?
- end
+ attribute :can_be_deleted, &:can_be_deleted?
attribute :document_filename do |certificate|
certificate.document.blob&.filename&.to_s if certificate.document.attached?
diff --git a/spree/api/app/serializers/spree/api/v3/admin/tax_identifier_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/tax_identifier_serializer.rb
index 3481c6717c..c058335f74 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/tax_identifier_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/tax_identifier_serializer.rb
@@ -18,9 +18,7 @@ module Spree
# Whether this installation can check a number of this kind at all —
# what tells a nil verdict "not checked yet" apart from "nothing here
# knows how to ask".
- attribute :validatable do |tax_identifier|
- tax_identifier.validatable?
- end
+ attribute :validatable, &:validatable?
# The owner, reported under the name of what it is, so a client can
# tell a customer's durable registration from a cart override or an
diff --git a/spree/api/app/serializers/spree/api/v3/admin/tax_line_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/tax_line_serializer.rb
index e9bed0d9a3..67159433d4 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/tax_line_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/tax_line_serializer.rb
@@ -17,9 +17,7 @@ module Spree
created_at: :iso8601, updated_at: :iso8601
# The sale row a credit gives back.
- attribute :original_tax_line_id do |record|
- record.original_tax_line&.prefixed_id
- end
+ prefixed_id_attributes :original_tax_line
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/tax_rate_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/tax_rate_serializer.rb
index e86a6f8f59..a0d668efd5 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/tax_rate_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/tax_rate_serializer.rb
@@ -30,13 +30,7 @@ module Spree
tax_rate.amount_percentage&.to_f
end
- attribute :tax_category_id do |tax_rate|
- tax_rate.tax_category&.prefixed_id
- end
-
- attribute :store_id do |tax_rate|
- tax_rate.store&.prefixed_id
- end
+ prefixed_id_attributes :tax_category, :store
# The jurisdiction the rate taxes, as codes: a null country means every
# country, and a country with no state means the whole country. Read
diff --git a/spree/api/app/serializers/spree/api/v3/admin/variant_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/variant_serializer.rb
index b72fefa25e..63dfcc36b5 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/variant_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/variant_serializer.rb
@@ -40,13 +40,9 @@ module Spree
preorder_ships_at: :iso8601, deleted_at: :iso8601,
created_at: :iso8601, updated_at: :iso8601
- attribute :preorderable do |variant|
- variant.preorderable?
- end
+ attribute :preorderable, &:preorderable?
- attribute :tax_category_id do |variant|
- variant.tax_category&.prefixed_id
- end
+ prefixed_id_attributes :tax_category
# Encoded from the foreign key: loading the carton row just to
# re-encode its id is a query per variant on the product listing.
@@ -82,9 +78,7 @@ module Spree
# seller's row ships; on an owned product the write is a no-op, since
# every variant ships as the product does. The dashboard need not
# know which.
- attribute :delivery_profile_id do |variant|
- variant.resolved_delivery_profile&.prefixed_id
- end
+ prefixed_id_attributes delivery_profile_id: :resolved_delivery_profile
one :seller,
resource: proc { Spree.api.admin_seller_serializer },
@@ -93,9 +87,7 @@ module Spree
end
# Override inherited associations to use admin serializers
- one :primary_media,
- resource: proc { Spree.api.admin_media_serializer },
- if: proc { expand?('primary_media') }
+ expandable :one, :primary_media, :admin_media_serializer
many :gallery_media,
key: :media,
@@ -105,17 +97,11 @@ module Spree
many :option_values, resource: proc { Spree.api.admin_option_value_serializer }
# All prices for this variant (for admin management)
- many :prices,
- resource: proc { Spree.api.admin_price_serializer },
- if: proc { expand?('prices') }
+ expandable :many, :prices, :admin_price_serializer
- many :custom_fields,
- resource: proc { Spree.api.admin_custom_field_serializer },
- if: proc { expand?('custom_fields') }
+ expandable :many, :custom_fields, :admin_custom_field_serializer
- many :stock_levels,
- resource: proc { Spree.api.admin_stock_level_serializer },
- if: proc { expand?('stock_levels') }
+ expandable :many, :stock_levels, :admin_stock_level_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/webhook_delivery_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/webhook_delivery_serializer.rb
index 52d689b0de..b1ac1b2803 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/webhook_delivery_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/webhook_delivery_serializer.rb
@@ -38,9 +38,7 @@ module Spree
Spree::WebhookPayloadRedaction.split(delivery.payload).first
end
- attribute :webhook_endpoint_id do |delivery|
- delivery.webhook_endpoint&.prefixed_id
- end
+ prefixed_id_attributes :webhook_endpoint
# Delegated from the parent endpoint — saves callers from having to
# join the endpoint payload to show "where did this delivery go?".
diff --git a/spree/api/app/serializers/spree/api/v3/applied_promotion_serializer.rb b/spree/api/app/serializers/spree/api/v3/applied_promotion_serializer.rb
index 86bff09a09..2642611ec3 100644
--- a/spree/api/app/serializers/spree/api/v3/applied_promotion_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/applied_promotion_serializer.rb
@@ -6,11 +6,9 @@ module Spree
# the typed Spree::Discount money rows.
class AppliedPromotionSerializer < BaseSerializer
typelize name: :string, description: [:string, nullable: true], code: [:string, nullable: true],
- amount: [:string, nullable: true], display_amount: [:string, nullable: true], promotion_id: :string
+ promotion_id: :string
- attribute :promotion_id do |record|
- record.promotion&.prefixed_id
- end
+ prefixed_id_attributes :promotion
attributes :name, :description, :code
diff --git a/spree/api/app/serializers/spree/api/v3/base_serializer.rb b/spree/api/app/serializers/spree/api/v3/base_serializer.rb
index f679f96a61..054c308cb0 100644
--- a/spree/api/app/serializers/spree/api/v3/base_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/base_serializer.rb
@@ -22,11 +22,38 @@ module Spree
# (product prices AND cart/order/line-item totals) is gated from one
# place instead of per-attribute opt-in.
def self.money_attributes(*names)
+ typelize(**names.index_with { [:string, nullable: true] })
+
names.each do |name|
attribute(name) { |object| object.public_send(name) unless params[:hide_prices] }
end
end
+ # Declares `<association>_id` attributes carrying the associated
+ # record's prefixed id, or nil when there is none. Pass
+ # `seller_id: :resolved_seller` when the attribute name and the
+ # association it reads differ.
+ def self.prefixed_id_attributes(*associations, **renamed)
+ associations.index_by { |association| :"#{association}_id" }.merge(renamed).each do |name, association|
+ attribute(name) { |object| object.public_send(association)&.prefixed_id }
+ end
+ end
+
+ # Declares attributes rendered as strings, so decimals and money keep
+ # their exact form instead of becoming JSON numbers.
+ def self.string_attributes(*names)
+ names.each do |name|
+ attribute(name) { |object| object.public_send(name).to_s }
+ end
+ end
+
+ # Declares an association rendered only when the request expands it
+ # (`?expand=customer`). `serializer` names the `Spree.api` setting
+ # resolving the serializer class, so host apps can swap it.
+ def self.expandable(kind, name, serializer)
+ public_send(kind, name, resource: proc { Spree.api.public_send(serializer) }, if: proc { expand?(name.to_s) })
+ end
+
# Declares the wire form of an `acted_by` association: the actor's
# prefixed id, the kind of actor it is, and the expansion. Both
# halves read off the columns, so naming an actor costs no query and
diff --git a/spree/api/app/serializers/spree/api/v3/cart_serializer.rb b/spree/api/app/serializers/spree/api/v3/cart_serializer.rb
index ef07be35ce..225a448776 100644
--- a/spree/api/app/serializers/spree/api/v3/cart_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/cart_serializer.rb
@@ -4,58 +4,36 @@ module Spree
# Store API Cart Serializer
# Pre-purchase cart data with checkout progression info
class CartSerializer < BaseSerializer
- typelize number: :string, current_step: :string, completed_steps: 'string[]', token: :string, email: [:string, nullable: true],
- customer_note: [:string, nullable: true], market_id: [:string, nullable: true], channel_id: [:string, nullable: true],
- currency: :string, locale: [:string, nullable: true], total_quantity: :number,
- coupon_code: [:string, nullable: true],
- preferred_stock_location_id: [:string, nullable: true],
- company_id: [:string, nullable: true], company_name: [:string, nullable: true],
- po_number: [:string, nullable: true], po_number_required: :boolean,
- po_document_filename: [:string, nullable: true],
- po_document_byte_size: ['number | null'],
- order_minimum: ['number | null'], order_minimum_shortfall: ['number | null'],
- below_order_minimum: ['boolean | null'],
+ typelize number: :string, current_step: :string, completed_steps: 'string[]', token: :string,
+ email: [:string, nullable: true], customer_note: [:string, nullable: true],
+ market_id: [:string, nullable: true], channel_id: [:string, nullable: true], currency: :string,
+ locale: [:string, nullable: true], total_quantity: :number, coupon_code: [:string, nullable: true],
+ preferred_stock_location_id: [:string, nullable: true], company_id: [:string, nullable: true],
+ company_name: [:string, nullable: true], po_number: [:string, nullable: true],
+ po_number_required: :boolean, po_document_filename: [:string, nullable: true],
+ po_document_byte_size: ['number | null'], order_minimum: ['number | null'],
+ order_minimum_shortfall: ['number | null'], below_order_minimum: ['boolean | null'],
freight_summary: [:FreightSummary, nullable: true],
requirements: 'Array<{step: string, field: string, code: string, message: string}>',
- item_total: [:string, nullable: true], display_item_total: [:string, nullable: true],
- delivery_total: [:string, nullable: true], display_delivery_total: [:string, nullable: true],
- adjustment_total: [:string, nullable: true], display_adjustment_total: [:string, nullable: true],
- discount_total: [:string, nullable: true], display_discount_total: [:string, nullable: true],
- tax_total: [:string, nullable: true], display_tax_total: [:string, nullable: true],
- included_tax_total: [:string, nullable: true], display_included_tax_total: [:string, nullable: true],
- additional_tax_total: [:string, nullable: true], display_additional_tax_total: [:string, nullable: true],
- fee_total: [:string, nullable: true], display_fee_total: [:string, nullable: true],
store_credit_total: [:string, nullable: true], display_store_credit_total: [:string, nullable: true],
- gift_card_total: [:string, nullable: true], display_gift_card_total: [:string, nullable: true],
- covered_by_store_credit: :boolean,
- total: [:string, nullable: true], display_total: [:string, nullable: true],
- amount_due: [:string, nullable: true], display_amount_due: [:string, nullable: true],
- shipping_eq_billing_address: :boolean,
+ covered_by_store_credit: :boolean, shipping_eq_billing_address: :boolean,
warnings: 'Array<{code: string, message: string, line_item_id?: string, variant_id?: string, item_index?: number}>',
billing_address: { nullable: true }, shipping_address: { nullable: true },
gift_card: { nullable: true }, market: { nullable: true }
- attribute :market_id do |order|
- order.market&.prefixed_id
- end
+ prefixed_id_attributes :market
# Which surface this cart belongs to — lets a multi-channel storefront
# verify a cookie-persisted cart against its own channel before
# adopting it (see the wholesale reference storefront's cart guard).
- attribute :channel_id do |order|
- order.channel&.prefixed_id
- end
+ prefixed_id_attributes :channel
# Pickup selection — mirrors the writable param on cart update.
- attribute :preferred_stock_location_id do |cart|
- cart.preferred_stock_location&.prefixed_id
- end
+ prefixed_id_attributes :preferred_stock_location
# Which company node the purchase is for — mirrors the writable
# `company_id` param. Read from the column, never re-resolved.
- attribute :company_id do |cart|
- cart.company&.prefixed_id
- end
+ prefixed_id_attributes :company
attribute :company_name do |cart|
cart.company&.name
@@ -64,9 +42,7 @@ module Spree
# The buyer's own purchase-order reference, and whether their company
# demands one — the storefront marks the field required from this
# rather than fetching the company to ask.
- attribute :po_number_required do |cart|
- cart.po_number_required?
- end
+ attribute :po_number_required, &:po_number_required?
attribute :po_document_filename do |cart|
cart.po_document.blob&.filename&.to_s if cart.po_document.attached?
@@ -101,9 +77,7 @@ module Spree
order.display_total_applied_store_credit.to_s unless params[:hide_prices]
end
- attribute :covered_by_store_credit do |order|
- order.covered_by_store_credit?
- end
+ attribute :covered_by_store_credit, &:covered_by_store_credit?
attribute :current_step do |order|
order.current_checkout_step
@@ -153,9 +127,7 @@ module Spree
# withhold.
one :freight_summary, resource: proc { Spree.api.freight_summary_serializer }
- attribute :shipping_eq_billing_address do |order|
- order.shipping_eq_billing_address?
- end
+ attribute :shipping_eq_billing_address, &:shipping_eq_billing_address?
many :order_promotions, key: :discounts, resource: proc { Spree.api.applied_promotion_serializer }
# Itemized charges (duties, surcharges, COD, handling). Storefronts
diff --git a/spree/api/app/serializers/spree/api/v3/category_serializer.rb b/spree/api/app/serializers/spree/api/v3/category_serializer.rb
index 4fe23d8b66..631a3a0ee5 100644
--- a/spree/api/app/serializers/spree/api/v3/category_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/category_serializer.rb
@@ -13,17 +13,13 @@ module Spree
:meta_title, :meta_description, :meta_keywords,
:children_count
- attribute :parent_id do |category|
- category.parent&.prefixed_id
- end
+ prefixed_id_attributes :parent
attribute :description do |category|
Spree::RichTextHelper.to_plain_text(category.description)
end
- attribute :description_html do |category|
- category.description_html
- end
+ attributes :description_html
attribute :image_url do |category|
image_url_for(category.image)
@@ -33,32 +29,20 @@ module Spree
image_url_for(category.square_image)
end
- attribute :is_root do |category|
- category.root?
- end
+ attribute :is_root, &:root?
- attribute :is_child do |category|
- category.child?
- end
+ attribute :is_child, &:child?
- attribute :is_leaf do |category|
- category.leaf?
- end
+ attribute :is_leaf, &:leaf?
# Conditional associations
# Note: We pass empty expand to nested categories to prevent infinite recursion
# (e.g., ancestors trying to load their own ancestors)
- one :parent,
- resource: proc { Spree.api.category_serializer },
- if: proc { expand?('parent') }
+ expandable :one, :parent, :category_serializer
- many :children,
- resource: proc { Spree.api.category_serializer },
- if: proc { expand?('children') }
+ expandable :many, :children, :category_serializer
- many :ancestors,
- resource: proc { Spree.api.category_serializer },
- if: proc { expand?('ancestors') }
+ expandable :many, :ancestors, :category_serializer
many :storefront_custom_fields,
key: :custom_fields,
diff --git a/spree/api/app/serializers/spree/api/v3/claim_line_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/claim_line_item_serializer.rb
index 1b035932f5..caeb99b05c 100644
--- a/spree/api/app/serializers/spree/api/v3/claim_line_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/claim_line_item_serializer.rb
@@ -20,50 +20,17 @@ module Spree
attributes :quantity, :send_replacement, :description
- attribute :refund_amount do |line|
- line.refund_amount.to_s
- end
+ string_attributes :refund_amount
# What the customer actually paid for these units, tax included — the
# ceiling the resolve workflow enforces, and what the dashboard offers
# when the claim carries no explicit amount.
- attribute :paid_amount do |line|
- line.paid_amount.to_s
- end
+ string_attributes :paid_amount, :pre_tax_amount, :included_tax_total, :additional_tax_total, :tax_total,
+ :display_refund_amount
- attribute :pre_tax_amount do |line|
- line.pre_tax_amount.to_s
- end
+ prefixed_id_attributes :variant, :replacement_variant, :line_item
- attribute :included_tax_total do |line|
- line.included_tax_total.to_s
- end
-
- attribute :additional_tax_total do |line|
- line.additional_tax_total.to_s
- end
-
- attribute :tax_total do |line|
- line.tax_total.to_s
- end
-
- attribute :display_refund_amount do |line|
- line.display_refund_amount.to_s
- end
-
- attribute :variant_id do |line|
- line.variant&.prefixed_id
- end
-
- attribute :replacement_variant_id do |line|
- line.replacement_variant&.prefixed_id
- end
-
- attribute :line_item_id do |line|
- line.line_item&.prefixed_id
- end
-
- one :variant, resource: proc { Spree.api.variant_serializer }, if: proc { expand?('variant') }
+ expandable :one, :variant, :variant_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/claim_serializer.rb b/spree/api/app/serializers/spree/api/v3/claim_serializer.rb
index 7edb7bcb5b..b22cfa0047 100644
--- a/spree/api/app/serializers/spree/api/v3/claim_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/claim_serializer.rb
@@ -19,21 +19,9 @@ module Spree
attributes :number, :status, :resolution
- attribute :order_id do |claim|
- claim.order&.prefixed_id
- end
-
- attribute :reason_id do |claim|
- claim.reason&.prefixed_id
- end
+ prefixed_id_attributes :order, :reason
- attribute :refund_total do |claim|
- claim.refund_total.to_s
- end
-
- attribute :display_refund_total do |claim|
- claim.display_refund_total.to_s
- end
+ string_attributes :refund_total, :display_refund_total
attribute :approved_at do |claim|
claim.approved_at&.iso8601
@@ -51,11 +39,9 @@ module Spree
claim.canceled_at&.iso8601
end
- one :reason, resource: proc { Spree.api.claim_reason_serializer }, if: proc { expand?('reason') }
+ expandable :one, :reason, :claim_reason_serializer
- many :claim_line_items,
- resource: proc { Spree.api.claim_line_item_serializer },
- if: proc { expand?('claim_line_items') }
+ expandable :many, :claim_line_items, :claim_line_item_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/collection_serializer.rb b/spree/api/app/serializers/spree/api/v3/collection_serializer.rb
index bff6c49c2f..a5074adbe1 100644
--- a/spree/api/app/serializers/spree/api/v3/collection_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/collection_serializer.rb
@@ -19,9 +19,7 @@ module Spree
Spree::RichTextHelper.to_plain_text(collection.description)
end
- attribute :description_html do |collection|
- collection.description_html
- end
+ attributes :description_html
attribute :image_url do |collection|
image_url_for(collection.image)
diff --git a/spree/api/app/serializers/spree/api/v3/company_serializer.rb b/spree/api/app/serializers/spree/api/v3/company_serializer.rb
index 4153b28300..1c0952a223 100644
--- a/spree/api/app/serializers/spree/api/v3/company_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/company_serializer.rb
@@ -15,9 +15,7 @@ module Spree
# the PO field required from it.
attributes :name, :kind, :po_number_required
- attribute :parent_id do |company|
- company.parent&.prefixed_id
- end
+ prefixed_id_attributes :parent
# The path above this node, root first — lets a client render
# "Acme / EMEA / Berlin" without a request per level. Bounded by the
diff --git a/spree/api/app/serializers/spree/api/v3/delivery_rate_serializer.rb b/spree/api/app/serializers/spree/api/v3/delivery_rate_serializer.rb
index 0179dbe526..aa223af288 100644
--- a/spree/api/app/serializers/spree/api/v3/delivery_rate_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/delivery_rate_serializer.rb
@@ -14,9 +14,7 @@ module Spree
unpriced: :boolean,
freight_summary: [:FreightSummary, nullable: true]
- attribute :delivery_method_id do |deliver_rate|
- deliver_rate.delivery_method&.prefixed_id
- end
+ prefixed_id_attributes :delivery_method
# Carrier, service level and delivery date come from the rate provider
# and are what the customer chooses between; nil on calculator-priced
@@ -35,25 +33,8 @@ module Spree
# froze it here when it quoted.
one :freight_summary, resource: proc { Spree.api.freight_summary_serializer }
- attribute :display_cost do |deliver_rate|
- deliver_rate.display_cost.to_s
- end
-
- attribute :display_total do |deliver_rate|
- deliver_rate.display_total.to_s
- end
-
- attribute :display_additional_tax_total do |deliver_rate|
- deliver_rate.display_additional_tax_total.to_s
- end
-
- attribute :display_included_tax_total do |deliver_rate|
- deliver_rate.display_included_tax_total.to_s
- end
-
- attribute :display_tax_total do |deliver_rate|
- deliver_rate.display_tax_total.to_s
- end
+ string_attributes :display_cost, :display_total, :display_additional_tax_total, :display_included_tax_total,
+ :display_tax_total
one :delivery_method, resource: proc { Spree.api.delivery_method_serializer }
end
diff --git a/spree/api/app/serializers/spree/api/v3/delivery_zone_serializer.rb b/spree/api/app/serializers/spree/api/v3/delivery_zone_serializer.rb
index 9e01e75fb2..c3fd355ead 100644
--- a/spree/api/app/serializers/spree/api/v3/delivery_zone_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/delivery_zone_serializer.rb
@@ -6,7 +6,7 @@ module Spree
attributes :name, :description
- many :members, resource: proc { Spree.api.delivery_zone_member_serializer }, if: proc { expand?('members') }
+ expandable :many, :members, :delivery_zone_member_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/digital_asset_serializer.rb b/spree/api/app/serializers/spree/api/v3/digital_asset_serializer.rb
index 6d1cd1481f..923a6fdfaa 100644
--- a/spree/api/app/serializers/spree/api/v3/digital_asset_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/digital_asset_serializer.rb
@@ -8,9 +8,7 @@ module Spree
filename: [:string, nullable: true],
content_type: [:string, nullable: true]
- attribute :variant_id do |digital_asset|
- digital_asset.variant&.prefixed_id
- end
+ prefixed_id_attributes :variant
attribute :filename do |digital_asset|
digital_asset.filename&.to_s
diff --git a/spree/api/app/serializers/spree/api/v3/digital_link_serializer.rb b/spree/api/app/serializers/spree/api/v3/digital_link_serializer.rb
index b975581122..6620db34d3 100644
--- a/spree/api/app/serializers/spree/api/v3/digital_link_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/digital_link_serializer.rb
@@ -16,17 +16,11 @@ module Spree
digital_link.expires_at&.iso8601
end
- attribute :authorizable do |digital_link|
- digital_link.authorizable?
- end
+ attribute :authorizable, &:authorizable?
- attribute :expired do |digital_link|
- digital_link.expired?
- end
+ attribute :expired, &:expired?
- attribute :access_limit_exceeded do |digital_link|
- digital_link.access_limit_exceeded?
- end
+ attribute :access_limit_exceeded, &:access_limit_exceeded?
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/discount_serializer.rb b/spree/api/app/serializers/spree/api/v3/discount_serializer.rb
index 33d59d4983..ec063b7d03 100644
--- a/spree/api/app/serializers/spree/api/v3/discount_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/discount_serializer.rb
@@ -7,7 +7,6 @@ module Spree
class DiscountSerializer < BaseSerializer
typelize label: :string, kind: [:string, enum: Spree::Discount::KINDS], code: [:string, nullable: true],
value: [:string, nullable: true], value_type: [:string, nullable: true],
- amount: [:string, nullable: true], display_amount: [:string, nullable: true],
promotion_id: [:string, nullable: true], line_item_id: [:string, nullable: true],
fulfillment_id: [:string, nullable: true]
@@ -17,17 +16,7 @@ module Spree
record.value&.to_s
end
- attribute :promotion_id do |record|
- record.promotion&.prefixed_id
- end
-
- attribute :line_item_id do |record|
- record.line_item&.prefixed_id
- end
-
- attribute :fulfillment_id do |record|
- record.fulfillment&.prefixed_id
- end
+ prefixed_id_attributes :promotion, :line_item, :fulfillment
money_attributes :amount, :display_amount
end
diff --git a/spree/api/app/serializers/spree/api/v3/exchange_line_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/exchange_line_item_serializer.rb
index 303681a672..f5436a297d 100644
--- a/spree/api/app/serializers/spree/api/v3/exchange_line_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/exchange_line_item_serializer.rb
@@ -21,45 +21,15 @@ module Spree
# What the customer paid for the units coming back, after discounts
# and with their tax.
- attribute :original_price do |line|
- line.original_price.to_s
- end
+ string_attributes :original_price
# The replacement at the same discount, with its own tax.
- attribute :new_variant_price do |line|
- line.new_variant_price.to_s
- end
+ string_attributes :new_variant_price, :price_difference, :original_tax_total, :new_tax_total
- attribute :price_difference do |line|
- line.price_difference.to_s
- end
+ prefixed_id_attributes :original_variant, :new_variant, :line_item, :fulfillment_item
- attribute :original_tax_total do |line|
- line.original_tax_total.to_s
- end
-
- attribute :new_tax_total do |line|
- line.new_tax_total.to_s
- end
-
- attribute :original_variant_id do |line|
- line.original_variant&.prefixed_id
- end
-
- attribute :new_variant_id do |line|
- line.new_variant&.prefixed_id
- end
-
- attribute :line_item_id do |line|
- line.line_item&.prefixed_id
- end
-
- attribute :fulfillment_item_id do |line|
- line.fulfillment_item&.prefixed_id
- end
-
- one :original_variant, resource: proc { Spree.api.variant_serializer }, if: proc { expand?('original_variant') }
- one :new_variant, resource: proc { Spree.api.variant_serializer }, if: proc { expand?('new_variant') }
+ expandable :one, :original_variant, :variant_serializer
+ expandable :one, :new_variant, :variant_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/exchange_serializer.rb b/spree/api/app/serializers/spree/api/v3/exchange_serializer.rb
index ed45677b93..6a73c7345b 100644
--- a/spree/api/app/serializers/spree/api/v3/exchange_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/exchange_serializer.rb
@@ -18,21 +18,9 @@ module Spree
attributes :number, :status
- attribute :order_id do |exchange|
- exchange.order&.prefixed_id
- end
-
- attribute :reason_id do |exchange|
- exchange.reason&.prefixed_id
- end
+ prefixed_id_attributes :order, :reason
- attribute :price_difference do |exchange|
- exchange.price_difference.to_s
- end
-
- attribute :display_price_difference do |exchange|
- exchange.display_price_difference.to_s
- end
+ string_attributes :price_difference, :display_price_difference
attribute :approved_at do |exchange|
exchange.approved_at&.iso8601
@@ -50,11 +38,9 @@ module Spree
exchange.canceled_at&.iso8601
end
- one :reason, resource: proc { Spree.api.return_reason_serializer }, if: proc { expand?('reason') }
+ expandable :one, :reason, :return_reason_serializer
- many :exchange_line_items,
- resource: proc { Spree.api.exchange_line_item_serializer },
- if: proc { expand?('exchange_line_items') }
+ expandable :many, :exchange_line_items, :exchange_line_item_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/export_serializer.rb b/spree/api/app/serializers/spree/api/v3/export_serializer.rb
index 3aeed93a02..85cac687cf 100644
--- a/spree/api/app/serializers/spree/api/v3/export_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/export_serializer.rb
@@ -18,9 +18,7 @@ module Spree
Spree::Export.api_type_for(export.type)
end
- attribute :user_id do |export|
- export.user&.prefixed_id
- end
+ prefixed_id_attributes :user
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/fee_serializer.rb b/spree/api/app/serializers/spree/api/v3/fee_serializer.rb
index e8ac5d4e10..41fee5f956 100644
--- a/spree/api/app/serializers/spree/api/v3/fee_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/fee_serializer.rb
@@ -5,20 +5,12 @@ module Spree
# Order-level when both adjustable IDs are null.
class FeeSerializer < BaseSerializer
typelize label: :string,
- kind: [:string, enum: Spree::Fee::KINDS, enum_type_name: 'FeeKind',
- comment: 'What sort of charge this is. `duty` is a customs duty on a cross-border order and is not taxed; the other kinds are. Extensions may register further kinds.'],
- amount: [:string, nullable: true], display_amount: [:string, nullable: true],
+ kind: [:string, enum: Spree::Fee::KINDS, enum_type_name: 'FeeKind', comment: 'What sort of charge this is. `duty` is a customs duty on a cross-border order and is not taxed; the other kinds are. Extensions may register further kinds.'],
line_item_id: [:string, nullable: true], fulfillment_id: [:string, nullable: true]
attributes :label, :kind
- attribute :line_item_id do |record|
- record.line_item&.prefixed_id
- end
-
- attribute :fulfillment_id do |record|
- record.fulfillment&.prefixed_id
- end
+ prefixed_id_attributes :line_item, :fulfillment
money_attributes :amount, :display_amount
end
diff --git a/spree/api/app/serializers/spree/api/v3/fulfillment_serializer.rb b/spree/api/app/serializers/spree/api/v3/fulfillment_serializer.rb
index a37516cb90..9c238bc9e2 100644
--- a/spree/api/app/serializers/spree/api/v3/fulfillment_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/fulfillment_serializer.rb
@@ -2,18 +2,11 @@ module Spree
module Api
module V3
class FulfillmentSerializer < BaseSerializer
- typelize number: :string, status: [:string, enum: Spree::Fulfillment.statuses, enum_type_name: 'FulfillmentStatus'],
+ typelize number: :string,
+ status: [:string, enum: Spree::Fulfillment.statuses, enum_type_name: 'FulfillmentStatus'],
fulfillment_type: [:string, enum: %w[shipping digital pickup pickup_point]],
- tracking: [:string, nullable: true],
- tracking_url: [:string, nullable: true], fulfilled_at: [:string, nullable: true],
- delivered_at: [:string, nullable: true],
- cost: [:string, nullable: true], display_cost: [:string, nullable: true],
- unpriced: :boolean,
- total: [:string, nullable: true], display_total: [:string, nullable: true],
- discount_total: [:string, nullable: true], display_discount_total: [:string, nullable: true],
- additional_tax_total: [:string, nullable: true], display_additional_tax_total: [:string, nullable: true],
- included_tax_total: [:string, nullable: true], display_included_tax_total: [:string, nullable: true],
- tax_total: [:string, nullable: true], display_tax_total: [:string, nullable: true],
+ tracking: [:string, nullable: true], tracking_url: [:string, nullable: true],
+ fulfilled_at: [:string, nullable: true], delivered_at: [:string, nullable: true], unpriced: :boolean,
items: 'Array<{ item_id: string; variant_id: string; quantity: number }>',
pickup_point_data: ['Record<string, unknown>', nullable: true],
selected_delivery_rate_id: [:string, nullable: true]
@@ -65,7 +58,7 @@ module Spree
one :delivery_method, resource: proc { Spree.api.delivery_method_serializer }
one :stock_location, resource: proc { Spree.api.stock_location_serializer }
many :delivery_rates, resource: proc { Spree.api.delivery_rate_serializer }
- many :tax_lines, resource: proc { Spree.api.tax_line_serializer }, if: proc { expand?('tax_lines') }
+ expandable :many, :tax_lines, :tax_line_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/gift_card_batch_serializer.rb b/spree/api/app/serializers/spree/api/v3/gift_card_batch_serializer.rb
index e7555755bd..2bc8338723 100644
--- a/spree/api/app/serializers/spree/api/v3/gift_card_batch_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/gift_card_batch_serializer.rb
@@ -19,9 +19,7 @@ module Spree
batch.expires_at&.iso8601
end
- attribute :created_by_id do |batch|
- batch.created_by&.prefixed_id
- end
+ prefixed_id_attributes :created_by
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/gift_card_serializer.rb b/spree/api/app/serializers/spree/api/v3/gift_card_serializer.rb
index 5e9e52983f..c3c543d3db 100644
--- a/spree/api/app/serializers/spree/api/v3/gift_card_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/gift_card_serializer.rb
@@ -4,17 +4,9 @@ module Spree
class GiftCardSerializer < BaseSerializer
typelize code: :string,
status: [:string, enum: Spree::GiftCard::DISPLAY_STATUSES, enum_type_name: 'GiftCardStatus'],
- amount: [:string, nullable: true],
- amount_used: [:string, nullable: true],
- amount_authorized: [:string, nullable: true],
- amount_remaining: [:string, nullable: true],
- display_amount: [:string, nullable: true],
- display_amount_used: [:string, nullable: true],
- display_amount_remaining: [:string, nullable: true],
- currency: :string,
- expires_at: [:string, nullable: true],
- redeemed_at: [:string, nullable: true],
- expired: :boolean,
+ display_amount: [:string, nullable: true], display_amount_used: [:string, nullable: true],
+ display_amount_remaining: [:string, nullable: true], currency: :string,
+ expires_at: [:string, nullable: true], redeemed_at: [:string, nullable: true], expired: :boolean,
active: :boolean
# A bearer credential: masked when the order is shown to someone other
@@ -53,13 +45,9 @@ module Spree
gift_card.redeemed_at&.iso8601
end
- attribute :expired do |gift_card|
- gift_card.expired?
- end
+ attribute :expired, &:expired?
- attribute :active do |gift_card|
- gift_card.active?
- end
+ attribute :active, &:active?
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/import_row_serializer.rb b/spree/api/app/serializers/spree/api/v3/import_row_serializer.rb
index 66602f1c43..e10dd0dd91 100644
--- a/spree/api/app/serializers/spree/api/v3/import_row_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/import_row_serializer.rb
@@ -11,18 +11,14 @@ module Spree
attributes :row_number, :status, :validation_errors,
created_at: :iso8601, updated_at: :iso8601
- attribute :import_id do |row|
- row.import&.prefixed_id
- end
+ prefixed_id_attributes :import
# `"product"` / `"variant"`, not the polymorphic class name.
attribute :item_type do |row|
Spree::Base.polymorphic_api_type(row.item_type)
end
- attribute :item_id do |row|
- row.item&.prefixed_id
- end
+ prefixed_id_attributes :item
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/import_serializer.rb b/spree/api/app/serializers/spree/api/v3/import_serializer.rb
index fb8f515c6d..95674e2596 100644
--- a/spree/api/app/serializers/spree/api/v3/import_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/import_serializer.rb
@@ -21,19 +21,11 @@ module Spree
Spree::Import.api_type_for(import.type)
end
- attribute :status do |import|
- import.status.to_s
- end
+ string_attributes :status
# Which marketplace this import belongs to, and — when a seller ran it —
# whose it is. A null `seller_id` means the operator's own.
- attribute :store_id do |import|
- import.store&.prefixed_id
- end
-
- attribute :seller_id do |import|
- import.seller&.prefixed_id
- end
+ prefixed_id_attributes :store, :seller
# @deprecated Read `store_id` / `seller_id` — removed in 6.1. Emitted
# from the pair above rather than the dropped columns, so a client
@@ -46,9 +38,7 @@ module Spree
(import.seller || import.store)&.prefixed_id
end
- attribute :user_id do |import|
- import.user&.prefixed_id
- end
+ prefixed_id_attributes :user
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/invitation_serializer.rb b/spree/api/app/serializers/spree/api/v3/invitation_serializer.rb
index 100fb6fc81..ad75910bed 100644
--- a/spree/api/app/serializers/spree/api/v3/invitation_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/invitation_serializer.rb
@@ -14,9 +14,7 @@ module Spree
attributes :email,
created_at: :iso8601, updated_at: :iso8601
- attribute :status do |invitation|
- invitation.status.to_s
- end
+ string_attributes :status
# `"store"` / `"admin_user"`, not the polymorphic class names.
attribute :resource_type do |invitation|
@@ -31,21 +29,7 @@ module Spree
Spree::Base.polymorphic_api_type(invitation.invitee_type)
end
- attribute :resource_id do |invitation|
- invitation.resource&.prefixed_id
- end
-
- attribute :inviter_id do |invitation|
- invitation.inviter&.prefixed_id
- end
-
- attribute :invitee_id do |invitation|
- invitation.invitee&.prefixed_id
- end
-
- attribute :role_id do |invitation|
- invitation.role&.prefixed_id
- end
+ prefixed_id_attributes :resource, :inviter, :invitee, :role
attribute :expires_at do |invitation|
invitation.expires_at&.iso8601
diff --git a/spree/api/app/serializers/spree/api/v3/line_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/line_item_serializer.rb
index dec83c36f2..c402bfbef1 100644
--- a/spree/api/app/serializers/spree/api/v3/line_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/line_item_serializer.rb
@@ -2,32 +2,18 @@ module Spree
module Api
module V3
class LineItemSerializer < BaseSerializer
- typelize variant_id: :string, quantity: :number, currency: :string,
- name: :string, slug: :string, options_text: :string,
- price: [:string, nullable: true], display_price: [:string, nullable: true],
- total: [:string, nullable: true], display_total: [:string, nullable: true],
- adjustment_total: [:string, nullable: true], display_adjustment_total: [:string, nullable: true],
- additional_tax_total: [:string, nullable: true], display_additional_tax_total: [:string, nullable: true],
- included_tax_total: [:string, nullable: true], display_included_tax_total: [:string, nullable: true],
- discount_total: [:string, nullable: true], display_discount_total: [:string, nullable: true],
- pre_tax_amount: [:string, nullable: true], display_pre_tax_amount: [:string, nullable: true],
- discounted_amount: [:string, nullable: true], display_discounted_amount: [:string, nullable: true],
- compare_at_amount: [:string, nullable: true], display_compare_at_amount: [:string, nullable: true],
- thumbnail_url: [:string, nullable: true],
- preorder: :boolean, preorder_ships_at: [:string, nullable: true],
- seller_id: [:string, nullable: true]
+ typelize variant_id: :string, quantity: :number, currency: :string, name: :string, slug: :string,
+ options_text: :string, compare_at_amount: [:string, nullable: true],
+ thumbnail_url: [:string, nullable: true], preorder: :boolean,
+ preorder_ships_at: [:string, nullable: true], seller_id: [:string, nullable: true]
- attribute :variant_id do |line_item|
- line_item.variant&.prefixed_id
- end
+ prefixed_id_attributes :variant
# Which seller this line was bought from, snapshotted when it was
# added — nil is the operator's own first-party item. Always present
# so a storefront can group a multi-seller cart without paying for the
# expand; `?expand=seller` adds the public profile.
- attribute :seller_id do |line_item|
- line_item.seller&.prefixed_id
- end
+ prefixed_id_attributes :seller
# True when the line item's variant is currently a pre-order, so the
# cart/checkout can flag it as shipping later.
@@ -66,9 +52,7 @@ module Spree
image_url_for(line_item.thumbnail)
end
- one :seller,
- resource: proc { Spree.api.seller_serializer },
- if: proc { expand?('seller') }
+ expandable :one, :seller, :seller_serializer
many :option_values, resource: proc { Spree.api.option_value_serializer }
# Download links carry a bearer token; only the buyer gets them.
@@ -76,7 +60,7 @@ module Spree
# Tax hangs off its adjustable, never off the cart or order: the
# exactly-one-adjustable rule makes the nested view complete, and the
# owner already carries the tax totals.
- many :tax_lines, resource: proc { Spree.api.tax_line_serializer }, if: proc { expand?('tax_lines') }
+ expandable :many, :tax_lines, :tax_line_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/media_event_serializer.rb b/spree/api/app/serializers/spree/api/v3/media_event_serializer.rb
index 2608696851..4e05fd70a0 100644
--- a/spree/api/app/serializers/spree/api/v3/media_event_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/media_event_serializer.rb
@@ -11,9 +11,7 @@ module Spree
viewable_id: :string, position: [:number, nullable: true],
alt: [:string, nullable: true]
- attribute :viewable_id do |asset|
- asset.viewable&.prefixed_id
- end
+ prefixed_id_attributes :viewable
# `"product"` / `"variant"`, not the polymorphic class name.
attribute :viewable_type do |asset|
diff --git a/spree/api/app/serializers/spree/api/v3/media_serializer.rb b/spree/api/app/serializers/spree/api/v3/media_serializer.rb
index 75a00c7c5d..281405319c 100644
--- a/spree/api/app/serializers/spree/api/v3/media_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/media_serializer.rb
@@ -18,9 +18,7 @@ module Spree
large_url: [:string, nullable: true], xlarge_url: [:string, nullable: true],
og_image_url: [:string, nullable: true]
- attribute :product_id do |asset|
- asset.product&.prefixed_id
- end
+ prefixed_id_attributes :product
# Returns prefixed IDs of variants this media is associated with.
# Two paths coexist in 5.5:
diff --git a/spree/api/app/serializers/spree/api/v3/newsletter_subscriber_serializer.rb b/spree/api/app/serializers/spree/api/v3/newsletter_subscriber_serializer.rb
index e4014772e9..8e2980d843 100644
--- a/spree/api/app/serializers/spree/api/v3/newsletter_subscriber_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/newsletter_subscriber_serializer.rb
@@ -10,17 +10,13 @@ module Spree
attributes :email, created_at: :iso8601, updated_at: :iso8601
- attribute :verified do |subscriber|
- subscriber.verified?
- end
+ attribute :verified, &:verified?
attribute :verified_at do |subscriber|
subscriber.verified_at&.iso8601
end
- attribute :customer_id do |subscriber|
- subscriber.customer&.prefixed_id
- end
+ prefixed_id_attributes :customer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/option_value_serializer.rb b/spree/api/app/serializers/spree/api/v3/option_value_serializer.rb
index f2d4f5fab4..22673c9190 100644
--- a/spree/api/app/serializers/spree/api/v3/option_value_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/option_value_serializer.rb
@@ -6,9 +6,7 @@ module Spree
option_type_name: :string, option_type_label: :string,
color_code: 'string | null', image_url: 'string | null'
- attribute :option_type_id do |option_value|
- option_value.option_type&.prefixed_id
- end
+ prefixed_id_attributes :option_type
attributes :name, :label, :position, :color_code
diff --git a/spree/api/app/serializers/spree/api/v3/order_group_serializer.rb b/spree/api/app/serializers/spree/api/v3/order_group_serializer.rb
index f3f5467fc0..a98317f03f 100644
--- a/spree/api/app/serializers/spree/api/v3/order_group_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/order_group_serializer.rb
@@ -18,31 +18,11 @@ module Spree
attributes :number, :email, :currency
- attribute :total do |group|
- group.total.to_s
- end
-
- attribute :display_total do |group|
- group.display_total.to_s
- end
-
- attribute :item_total do |group|
- group.item_total.to_s
- end
-
- attribute :display_item_total do |group|
- group.display_item_total.to_s
- end
+ string_attributes :total, :display_total, :item_total, :display_item_total
# Rolled up across the children rather than stored, so it can never
# disagree with the orders it describes.
- attribute :fulfillment_status do |group|
- group.fulfillment_status
- end
-
- attribute :payment_status do |group|
- group.payment_status
- end
+ attributes :fulfillment_status, :payment_status
attribute :completed_at do |group|
group.created_at
diff --git a/spree/api/app/serializers/spree/api/v3/order_serializer.rb b/spree/api/app/serializers/spree/api/v3/order_serializer.rb
index 0600ad866b..11f055f290 100644
--- a/spree/api/app/serializers/spree/api/v3/order_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/order_serializer.rb
@@ -4,40 +4,22 @@ module Spree
# Store API Order Serializer
# Post-purchase order data (completed orders)
class OrderSerializer < BaseSerializer
- typelize cart_id: [:string, nullable: true],
- number: :string, email: :string,
- customer_note: [:string, nullable: true],
- market_id: [:string, nullable: true], channel_id: [:string, nullable: true],
- company_id: [:string, nullable: true], company_name: [:string, nullable: true],
- po_number: [:string, nullable: true],
- po_document_filename: [:string, nullable: true],
- po_document_byte_size: ['number | null'],
+ typelize cart_id: [:string, nullable: true], number: :string, email: :string,
+ customer_note: [:string, nullable: true], market_id: [:string, nullable: true],
+ channel_id: [:string, nullable: true], company_id: [:string, nullable: true],
+ company_name: [:string, nullable: true], po_number: [:string, nullable: true],
+ po_document_filename: [:string, nullable: true], po_document_byte_size: ['number | null'],
currency: :string, locale: [:string, nullable: true], total_quantity: :number,
coupon_code: [:string, nullable: true],
fulfillment_status: [:string, nullable: true, enum: Spree::Order::FULFILLMENT_STATUSES],
payment_status: [:string, nullable: true, enum: Spree::Order::PAYMENT_STATUSES],
- item_total: [:string, nullable: true], display_item_total: [:string, nullable: true],
- delivery_total: [:string, nullable: true], display_delivery_total: [:string, nullable: true],
- adjustment_total: [:string, nullable: true], display_adjustment_total: [:string, nullable: true],
- discount_total: [:string, nullable: true], display_discount_total: [:string, nullable: true],
- tax_total: [:string, nullable: true], display_tax_total: [:string, nullable: true],
- included_tax_total: [:string, nullable: true], display_included_tax_total: [:string, nullable: true],
- additional_tax_total: [:string, nullable: true], display_additional_tax_total: [:string, nullable: true],
- fee_total: [:string, nullable: true], display_fee_total: [:string, nullable: true],
store_credit_total: [:string, nullable: true], display_store_credit_total: [:string, nullable: true],
- gift_card_total: [:string, nullable: true], display_gift_card_total: [:string, nullable: true],
- covered_by_store_credit: :boolean,
- total: [:string, nullable: true], display_total: [:string, nullable: true],
- amount_due: [:string, nullable: true], display_amount_due: [:string, nullable: true],
- completed_at: [:string, nullable: true],
- withdrawal_period_ends_at: [:string, nullable: true],
- within_withdrawal_period: :boolean,
+ covered_by_store_credit: :boolean, completed_at: [:string, nullable: true],
+ withdrawal_period_ends_at: [:string, nullable: true], within_withdrawal_period: :boolean,
billing_address: { nullable: true }, shipping_address: { nullable: true },
gift_card: { nullable: true }, market: { nullable: true }
- attribute :market_id do |order|
- order.market&.prefixed_id
- end
+ prefixed_id_attributes :market
# The EU cooling-off deadline. Customer-facing by design: a buyer
# deciding whether they can still send something back should not have
@@ -46,9 +28,7 @@ module Spree
order.withdrawal_period_ends_at&.iso8601
end
- attribute :within_withdrawal_period do |order|
- order.within_withdrawal_period?
- end
+ attribute :within_withdrawal_period, &:within_withdrawal_period?
# The checkout handle this order was born from (nil for admin drafts).
# Lets abandonment tooling match cart.* events to the conversion.
@@ -58,14 +38,10 @@ module Spree
Spree::Cart.prefixed_id_for(order.cart_id)
end
- attribute :channel_id do |order|
- order.channel&.prefixed_id
- end
+ prefixed_id_attributes :channel
# Which company node the order was placed for — frozen at completion.
- attribute :company_id do |order|
- order.company&.prefixed_id
- end
+ prefixed_id_attributes :company
attribute :company_name do |order|
order.company&.name
@@ -106,9 +82,7 @@ module Spree
order.display_total_applied_store_credit.to_s unless params[:hide_prices]
end
- attribute :covered_by_store_credit do |order|
- order.covered_by_store_credit?
- end
+ attribute :covered_by_store_credit, &:covered_by_store_credit?
many :order_promotions, key: :discounts, resource: proc { Spree.api.applied_promotion_serializer }
# Itemized charges (duties, surcharges, COD, handling) — see the cart
diff --git a/spree/api/app/serializers/spree/api/v3/payment_method_serializer.rb b/spree/api/app/serializers/spree/api/v3/payment_method_serializer.rb
index 2c6ca9eeb2..8ddaff5c2f 100644
--- a/spree/api/app/serializers/spree/api/v3/payment_method_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/payment_method_serializer.rb
@@ -11,13 +11,9 @@ module Spree
payment_method.class.api_type
end
- attribute :session_required do |payment_method|
- payment_method.session_required?
- end
+ attribute :session_required, &:session_required?
- attribute :source_required do |payment_method|
- payment_method.source_required?
- end
+ attribute :source_required, &:source_required?
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/payment_serializer.rb b/spree/api/app/serializers/spree/api/v3/payment_serializer.rb
index f08dbe8b67..dee230d5db 100644
--- a/spree/api/app/serializers/spree/api/v3/payment_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/payment_serializer.rb
@@ -2,15 +2,12 @@ module Spree
module Api
module V3
class PaymentSerializer < BaseSerializer
- typelize status: [:string, enum: Spree::Payment.statuses, enum_type_name: 'PaymentStatus'], payment_method_id: :string, response_code: [:string, nullable: true],
- number: :string, amount: [:string, nullable: true], display_amount: [:string, nullable: true],
+ typelize status: [:string, enum: Spree::Payment.statuses, enum_type_name: 'PaymentStatus'],
+ payment_method_id: :string, response_code: [:string, nullable: true], number: :string,
source_type: [:string, nullable: true, enum: %w[credit_card store_credit payment_source]],
- source_id: [:string, nullable: true],
- source: 'CreditCard | StoreCredit | PaymentSource | null'
+ source_id: [:string, nullable: true], source: 'CreditCard | StoreCredit | PaymentSource | null'
- attribute :payment_method_id do |payment|
- payment.payment_method&.prefixed_id
- end
+ prefixed_id_attributes :payment_method
attributes :response_code, :number, :status
@@ -31,9 +28,7 @@ module Spree
end
end
- attribute :source_id do |payment|
- payment.source&.prefixed_id
- end
+ prefixed_id_attributes :source
attribute :source do |payment|
next nil if payment.source.blank?
diff --git a/spree/api/app/serializers/spree/api/v3/payment_session_serializer.rb b/spree/api/app/serializers/spree/api/v3/payment_session_serializer.rb
index e9979a36ff..67eef86aee 100644
--- a/spree/api/app/serializers/spree/api/v3/payment_session_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/payment_session_serializer.rb
@@ -16,19 +16,13 @@ module Spree
session.amount&.to_s
end
- attribute :payment_method_id do |session|
- session.payment_method&.prefixed_id
- end
+ prefixed_id_attributes :payment_method
# Bridge: reports the owner (cart during checkout, order after
# completion) until clients migrate to cart_id/order_id.
- attribute :order_id do |session|
- session.owner&.prefixed_id
- end
+ prefixed_id_attributes order_id: :owner
- attribute :cart_id do |session|
- session.cart&.prefixed_id
- end
+ prefixed_id_attributes :cart
one :payment_method, resource: proc { Spree.api.payment_method_serializer }
one :payment, resource: proc { Spree.api.payment_serializer },
diff --git a/spree/api/app/serializers/spree/api/v3/payment_setup_session_serializer.rb b/spree/api/app/serializers/spree/api/v3/payment_setup_session_serializer.rb
index 2a918cbea4..3535496aba 100644
--- a/spree/api/app/serializers/spree/api/v3/payment_setup_session_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/payment_setup_session_serializer.rb
@@ -9,21 +9,11 @@ module Spree
attributes :status, :external_id, :external_client_secret, :external_data
- attribute :payment_method_id do |session|
- session.payment_method&.prefixed_id
- end
+ prefixed_id_attributes :payment_method, :payment_source
- attribute :payment_source_id do |session|
- session.payment_source&.prefixed_id
- end
+ attributes :payment_source_type
- attribute :payment_source_type do |session|
- session.payment_source_type
- end
-
- attribute :customer_id do |session|
- session.customer&.prefixed_id
- end
+ prefixed_id_attributes :customer
one :payment_method, resource: proc { Spree.api.payment_method_serializer }
end
diff --git a/spree/api/app/serializers/spree/api/v3/policy_serializer.rb b/spree/api/app/serializers/spree/api/v3/policy_serializer.rb
index 56d4117c80..4e272d0db4 100644
--- a/spree/api/app/serializers/spree/api/v3/policy_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/policy_serializer.rb
@@ -11,9 +11,7 @@ module Spree
Spree::RichTextHelper.to_plain_text(policy.body)
end
- attribute :body_html do |policy|
- policy.body_html
- end
+ attributes :body_html
# The one timestamp a store serializer carries. When a legal document
# last changed is what a shopper is entitled to see on the page —
diff --git a/spree/api/app/serializers/spree/api/v3/price_history_serializer.rb b/spree/api/app/serializers/spree/api/v3/price_history_serializer.rb
index 2d566e2b17..4085d3c722 100644
--- a/spree/api/app/serializers/spree/api/v3/price_history_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/price_history_serializer.rb
@@ -12,9 +12,7 @@ module Spree
attributes :amount, :amount_in_cents, :currency
- attribute :display_amount do |price_history|
- price_history.display_amount
- end
+ attributes :display_amount
attribute :recorded_at do |price_history|
price_history.recorded_at&.iso8601
diff --git a/spree/api/app/serializers/spree/api/v3/price_serializer.rb b/spree/api/app/serializers/spree/api/v3/price_serializer.rb
index 655c39d8ff..0477a1e626 100644
--- a/spree/api/app/serializers/spree/api/v3/price_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/price_serializer.rb
@@ -25,9 +25,7 @@ module Spree
price.display_compare_at_amount&.to_s
end
- attribute :price_list_id do |price|
- price.price_list&.prefixed_id
- end
+ prefixed_id_attributes :price_list
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/product_publication_serializer.rb b/spree/api/app/serializers/spree/api/v3/product_publication_serializer.rb
index 8548530924..4bf54a9414 100644
--- a/spree/api/app/serializers/spree/api/v3/product_publication_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/product_publication_serializer.rb
@@ -9,13 +9,7 @@ module Spree
attributes published_at: :iso8601, unpublished_at: :iso8601
- attribute :product_id do |publication|
- publication.product&.prefixed_id
- end
-
- attribute :channel_id do |publication|
- publication.channel&.prefixed_id
- end
+ prefixed_id_attributes :product, :channel
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/product_serializer.rb b/spree/api/app/serializers/spree/api/v3/product_serializer.rb
index e2b48b648b..77956fc31d 100644
--- a/spree/api/app/serializers/spree/api/v3/product_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/product_serializer.rb
@@ -24,27 +24,17 @@ module Spree
:variant_count,
available_on: :iso8601, preorder_ships_at: :iso8601
- attribute :purchasable do |product|
- product.purchasable?
- end
+ attribute :purchasable, &:purchasable?
# True when this product is currently offered as a pre-order on the
# requesting channel.
- attribute :preorder do |product|
- product.preorder?
- end
+ attribute :preorder, &:preorder?
- attribute :in_stock do |product|
- product.in_stock?
- end
+ attribute :in_stock, &:in_stock?
- attribute :backorderable do |product|
- product.backorderable?
- end
+ attribute :backorderable, &:backorderable?
- attribute :available do |product|
- product.available?
- end
+ attribute :available, &:available?
attribute :description do |product|
next if product.description.blank?
@@ -60,9 +50,7 @@ module Spree
# buy-box winner: that moves with price and stock, and a client that
# cached or linked this id must not find it pointing at a different
# row tomorrow. On a single-seller catalog the two coincide anyway.
- attribute :default_variant_id do |product|
- product.default_variant&.prefixed_id
- end
+ prefixed_id_attributes :default_variant
# The offer a storefront should lead with when several sellers share
# the listing — the buy-box winner in the request's currency. Nil when
@@ -109,39 +97,25 @@ module Spree
# Nil on the marketplace's own first-party products. The id is always
# present so a storefront can group or link by seller without paying
# for the expand; `?expand=seller` adds the public profile.
- attribute :seller_id do |product|
- product.seller&.prefixed_id
- end
+ prefixed_id_attributes :seller
# Conditional associations
- one :seller,
- resource: proc { Spree.api.seller_serializer },
- if: proc { expand?('seller') }
+ expandable :one, :seller, :seller_serializer
- one :primary_media,
- resource: proc { Spree.api.media_serializer },
- if: proc { expand?('primary_media') }
+ expandable :one, :primary_media, :media_serializer
many :gallery_media,
key: :media,
resource: proc { Spree.api.media_serializer },
if: proc { expand?('media') }
- many :variants,
- resource: proc { Spree.api.variant_serializer },
- if: proc { expand?('variants') }
+ expandable :many, :variants, :variant_serializer
- one :default_variant,
- resource: proc { Spree.api.variant_serializer },
- if: proc { expand?('default_variant') }
+ expandable :one, :default_variant, :variant_serializer
- many :option_types,
- resource: proc { Spree.api.option_type_serializer },
- if: proc { expand?('option_types') }
+ expandable :many, :option_types, :option_type_serializer
- many :option_values,
- resource: proc { Spree.api.option_value_serializer },
- if: proc { expand?('option_values') }
+ expandable :many, :option_values, :option_value_serializer
many :categories,
proc { |categories, params|
diff --git a/spree/api/app/serializers/spree/api/v3/refund_serializer.rb b/spree/api/app/serializers/spree/api/v3/refund_serializer.rb
index 0d7ad95321..8e42b2e165 100644
--- a/spree/api/app/serializers/spree/api/v3/refund_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/refund_serializer.rb
@@ -14,23 +14,13 @@ module Spree
refund.amount&.to_s
end
- attribute :payment_id do |refund|
- refund.payment&.prefixed_id
- end
-
- attribute :refund_reason_id do |refund|
- refund.reason&.prefixed_id
- end
+ prefixed_id_attributes :payment, refund_reason_id: :reason
# What triggered this refund — a Return, Exchange or Claim; nil for a
# manual refund.
- attribute :originator_id do |refund|
- refund.originator&.prefixed_id
- end
+ prefixed_id_attributes :originator
- attribute :originator_type do |refund|
- refund.originator_type
- end
+ attributes :originator_type
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/return_line_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/return_line_item_serializer.rb
index 8ad6f85281..9ee49c9e91 100644
--- a/spree/api/app/serializers/spree/api/v3/return_line_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/return_line_item_serializer.rb
@@ -21,53 +21,16 @@ module Spree
attributes :quantity, :received_quantity, :resellable
- attribute :pre_tax_amount do |line|
- line.pre_tax_amount.to_s
- end
-
- attribute :display_pre_tax_amount do |line|
- line.display_pre_tax_amount.to_s
- end
-
- attribute :included_tax_total do |line|
- line.included_tax_total.to_s
- end
-
- attribute :additional_tax_total do |line|
- line.additional_tax_total.to_s
- end
-
- attribute :tax_total do |line|
- line.tax_total.to_s
- end
-
- attribute :display_tax_total do |line|
- line.display_tax_total.to_s
- end
+ string_attributes :pre_tax_amount, :display_pre_tax_amount, :included_tax_total, :additional_tax_total,
+ :tax_total, :display_tax_total
# What the line refunds, tax included — for the units that arrived
# once the warehouse has counted.
- attribute :refund_amount do |line|
- line.refund_amount.to_s
- end
-
- attribute :display_refund_amount do |line|
- line.display_refund_amount.to_s
- end
-
- attribute :variant_id do |line|
- line.variant&.prefixed_id
- end
-
- attribute :line_item_id do |line|
- line.line_item&.prefixed_id
- end
+ string_attributes :refund_amount, :display_refund_amount
- attribute :fulfillment_item_id do |line|
- line.fulfillment_item&.prefixed_id
- end
+ prefixed_id_attributes :variant, :line_item, :fulfillment_item
- one :variant, resource: proc { Spree.api.variant_serializer }, if: proc { expand?('variant') }
+ expandable :one, :variant, :variant_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/return_serializer.rb b/spree/api/app/serializers/spree/api/v3/return_serializer.rb
index a680beaad9..b729913f60 100644
--- a/spree/api/app/serializers/spree/api/v3/return_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/return_serializer.rb
@@ -21,30 +21,12 @@ module Spree
attributes :number, :status
- attribute :order_id do |return_record|
- return_record.order&.prefixed_id
- end
+ prefixed_id_attributes :order, :reason
- attribute :reason_id do |return_record|
- return_record.reason&.prefixed_id
- end
-
- attribute :refund_total do |return_record|
- return_record.refund_total.to_s
- end
-
- attribute :display_refund_total do |return_record|
- return_record.display_refund_total.to_s
- end
+ string_attributes :refund_total, :display_refund_total
# The tax inside refund_total.
- attribute :refund_tax_total do |return_record|
- return_record.refund_tax_total.to_s
- end
-
- attribute :display_refund_tax_total do |return_record|
- return_record.display_refund_tax_total.to_s
- end
+ string_attributes :refund_tax_total, :display_refund_tax_total
attribute :approved_at do |return_record|
return_record.approved_at&.iso8601
@@ -62,11 +44,9 @@ module Spree
return_record.canceled_at&.iso8601
end
- one :reason, resource: proc { Spree.api.return_reason_serializer }, if: proc { expand?('reason') }
+ expandable :one, :reason, :return_reason_serializer
- many :return_line_items,
- resource: proc { Spree.api.return_line_item_serializer },
- if: proc { expand?('return_line_items') }
+ expandable :many, :return_line_items, :return_line_item_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/seller/claim_line_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/seller/claim_line_item_serializer.rb
index 67a062ebcd..7aac7e4b81 100644
--- a/spree/api/app/serializers/spree/api/v3/seller/claim_line_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller/claim_line_item_serializer.rb
@@ -13,7 +13,7 @@ module Spree
line.line_item&.name || line.variant&.name
end
- one :variant, resource: proc { Spree.api.seller_variant_serializer }, if: proc { expand?('variant') }
+ expandable :one, :variant, :seller_variant_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/seller/claim_serializer.rb b/spree/api/app/serializers/spree/api/v3/seller/claim_serializer.rb
index 80df34d85c..19009fd94d 100644
--- a/spree/api/app/serializers/spree/api/v3/seller/claim_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller/claim_serializer.rb
@@ -13,11 +13,9 @@ module Spree
attributes :memo
- many :claim_line_items,
- resource: proc { Spree.api.seller_claim_line_item_serializer },
- if: proc { expand?('claim_line_items') }
+ expandable :many, :claim_line_items, :seller_claim_line_item_serializer
- one :reason, resource: proc { Spree.api.seller_reason_serializer }, if: proc { expand?('reason') }
+ expandable :one, :reason, :seller_reason_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/seller/delivery_method_serializer.rb b/spree/api/app/serializers/spree/api/v3/seller/delivery_method_serializer.rb
index 02504a840d..56bf8b3ee1 100644
--- a/spree/api/app/serializers/spree/api/v3/seller/delivery_method_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller/delivery_method_serializer.rb
@@ -37,13 +37,7 @@ module Spree
record.seller_id.present?
end
- attribute :delivery_profile_id do |record|
- record.delivery_profile&.prefixed_id
- end
-
- attribute :delivery_zone_id do |record|
- record.delivery_zone&.prefixed_id
- end
+ prefixed_id_attributes :delivery_profile, :delivery_zone
attribute :calculator_type do |record|
record.calculator&.class&.api_type
diff --git a/spree/api/app/serializers/spree/api/v3/seller/delivery_rate_serializer.rb b/spree/api/app/serializers/spree/api/v3/seller/delivery_rate_serializer.rb
index 061ff806ca..960c6e7840 100644
--- a/spree/api/app/serializers/spree/api/v3/seller/delivery_rate_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller/delivery_rate_serializer.rb
@@ -21,13 +21,7 @@ module Spree
attributes :name, :selected, :cost, :total,
:carrier, :service_level, :estimated_delivery_date
- attribute :display_cost do |delivery_rate|
- delivery_rate.display_cost.to_s
- end
-
- attribute :display_total do |delivery_rate|
- delivery_rate.display_total.to_s
- end
+ string_attributes :display_cost, :display_total
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/seller/delivery_serializer.rb b/spree/api/app/serializers/spree/api/v3/seller/delivery_serializer.rb
index 1891852ebf..db99e8cce2 100644
--- a/spree/api/app/serializers/spree/api/v3/seller/delivery_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller/delivery_serializer.rb
@@ -7,9 +7,7 @@ module Spree
attributes created_at: :iso8601, updated_at: :iso8601
- attribute :shipping_label_id do |delivery|
- delivery.shipping_label&.prefixed_id
- end
+ prefixed_id_attributes :shipping_label
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/seller/delivery_zone_serializer.rb b/spree/api/app/serializers/spree/api/v3/seller/delivery_zone_serializer.rb
index b0b9d97329..add7aee29c 100644
--- a/spree/api/app/serializers/spree/api/v3/seller/delivery_zone_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller/delivery_zone_serializer.rb
@@ -16,9 +16,7 @@ module Spree
# What the panel filters the picker by, so a zone is only offered
# under the profile it belongs to.
- attribute :delivery_profile_id do |record|
- record.delivery_profile&.prefixed_id
- end
+ prefixed_id_attributes :delivery_profile
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/seller/exchange_line_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/seller/exchange_line_item_serializer.rb
index 5539256b8e..30d9bb3dd5 100644
--- a/spree/api/app/serializers/spree/api/v3/seller/exchange_line_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller/exchange_line_item_serializer.rb
@@ -18,10 +18,8 @@ module Spree
line.new_variant&.name
end
- one :original_variant, resource: proc { Spree.api.seller_variant_serializer },
- if: proc { expand?('original_variant') }
- one :new_variant, resource: proc { Spree.api.seller_variant_serializer },
- if: proc { expand?('new_variant') }
+ expandable :one, :original_variant, :seller_variant_serializer
+ expandable :one, :new_variant, :seller_variant_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/seller/exchange_serializer.rb b/spree/api/app/serializers/spree/api/v3/seller/exchange_serializer.rb
index e2adeb8d4a..f4a9161556 100644
--- a/spree/api/app/serializers/spree/api/v3/seller/exchange_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller/exchange_serializer.rb
@@ -14,15 +14,11 @@ module Spree
attributes :memo
- attribute :stock_location_id do |exchange|
- exchange.stock_location&.prefixed_id
- end
+ prefixed_id_attributes :stock_location
- many :exchange_line_items,
- resource: proc { Spree.api.seller_exchange_line_item_serializer },
- if: proc { expand?('exchange_line_items') }
+ expandable :many, :exchange_line_items, :seller_exchange_line_item_serializer
- one :reason, resource: proc { Spree.api.seller_reason_serializer }, if: proc { expand?('reason') }
+ expandable :one, :reason, :seller_reason_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/seller/fulfillment_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/seller/fulfillment_item_serializer.rb
index 8e6c992f6e..2afe9c7c50 100644
--- a/spree/api/app/serializers/spree/api/v3/seller/fulfillment_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller/fulfillment_item_serializer.rb
@@ -17,13 +17,7 @@ module Spree
attributes :quantity
- attribute :line_item_id do |item|
- item.line_item&.prefixed_id
- end
-
- attribute :variant_id do |item|
- item.variant&.prefixed_id
- end
+ prefixed_id_attributes :line_item, :variant
attribute :name do |item|
item.line_item&.name
diff --git a/spree/api/app/serializers/spree/api/v3/seller/fulfillment_serializer.rb b/spree/api/app/serializers/spree/api/v3/seller/fulfillment_serializer.rb
index ee7f441694..0f5fda2fe5 100644
--- a/spree/api/app/serializers/spree/api/v3/seller/fulfillment_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller/fulfillment_serializer.rb
@@ -47,9 +47,7 @@ module Spree
# The id as well as the name, so a seller moving the parcel to
# another of their shelves can see which one it is on now.
- attribute :stock_location_id do |fulfillment|
- fulfillment.stock_location&.prefixed_id
- end
+ prefixed_id_attributes :stock_location
# Deliberately not `items`: the store's fulfillment answers with a
# manifest under that name, and the shared OpenAPI patch rewrites it
@@ -60,9 +58,7 @@ module Spree
# The consignments and labels on this parcel — what a seller adds
# when they ship it themselves.
- attribute :selected_delivery_rate_id do |fulfillment|
- fulfillment.selected_delivery_rate&.prefixed_id
- end
+ prefixed_id_attributes :selected_delivery_rate
# What this parcel could be carried by from where it currently sits.
many :delivery_rates, resource: proc { Spree.api.seller_delivery_rate_serializer }
diff --git a/spree/api/app/serializers/spree/api/v3/seller/invitation_serializer.rb b/spree/api/app/serializers/spree/api/v3/seller/invitation_serializer.rb
index 46468c4eb9..a1b1112b61 100644
--- a/spree/api/app/serializers/spree/api/v3/seller/invitation_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller/invitation_serializer.rb
@@ -10,9 +10,7 @@ module Spree
attributes :email,
created_at: :iso8601, expires_at: :iso8601, accepted_at: :iso8601
- attribute :status do |invitation|
- invitation.status.to_s
- end
+ string_attributes :status
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/seller/order_line_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/seller/order_line_item_serializer.rb
index 45811d13dc..a2408bfab9 100644
--- a/spree/api/app/serializers/spree/api/v3/seller/order_line_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller/order_line_item_serializer.rb
@@ -11,17 +11,9 @@ module Spree
# packing a box, and each of which would pull another serializer into
# this branch's generated types.
class OrderLineItemSerializer < V3::BaseSerializer
- typelize name: :string,
- sku: [:string, nullable: true],
- options_text: [:string, nullable: true],
- quantity: :number,
- currency: :string,
- variant_id: [:string, nullable: true],
- thumbnail_url: [:string, nullable: true],
- price: [:string, nullable: true], display_price: [:string, nullable: true],
- discounted_amount: [:string, nullable: true], display_discounted_amount: [:string, nullable: true],
- additional_tax_total: [:string, nullable: true],
- total: [:string, nullable: true], display_total: [:string, nullable: true]
+ typelize name: :string, sku: [:string, nullable: true], options_text: [:string, nullable: true],
+ quantity: :number, currency: :string, variant_id: [:string, nullable: true],
+ thumbnail_url: [:string, nullable: true]
attributes :name, :options_text, :quantity, :currency
@@ -29,9 +21,7 @@ module Spree
money_attributes :price, :display_price, :discounted_amount, :display_discounted_amount,
:additional_tax_total, :total, :display_total
- attribute :variant_id do |line_item|
- line_item.variant&.prefixed_id
- end
+ prefixed_id_attributes :variant
# How a seller finds the item on their own shelf.
attribute :sku do |line_item|
diff --git a/spree/api/app/serializers/spree/api/v3/seller/order_serializer.rb b/spree/api/app/serializers/spree/api/v3/seller/order_serializer.rb
index 424eaa802d..b9d0e5a3ea 100644
--- a/spree/api/app/serializers/spree/api/v3/seller/order_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller/order_serializer.rb
@@ -21,34 +21,13 @@ module Spree
# the one contact detail that lets a marketplace's customer be taken
# off it, and it is not needed to pack, post or invoice.
class OrderSerializer < V3::BaseSerializer
- typelize number: :string,
- customer_note: [:string, nullable: true],
- currency: :string,
+ typelize number: :string, customer_note: [:string, nullable: true], currency: :string,
total_quantity: :number,
fulfillment_status: [:string, nullable: true, enum: Spree::Order::FULFILLMENT_STATUSES],
payment_status: [:string, nullable: true, enum: Spree::Order::PAYMENT_STATUSES],
- status: [:string, enum: Spree::Order::STATUSES],
- item_total: [:string, nullable: true], display_item_total: [:string, nullable: true],
- delivery_total: [:string, nullable: true], display_delivery_total: [:string, nullable: true],
- discount_total: [:string, nullable: true], display_discount_total: [:string, nullable: true],
- adjustment_total: [:string, nullable: true], display_adjustment_total: [:string, nullable: true],
- included_tax_total: [:string, nullable: true], display_included_tax_total: [:string, nullable: true],
- additional_tax_total: [:string, nullable: true], display_additional_tax_total: [:string, nullable: true],
- tax_total: [:string, nullable: true], display_tax_total: [:string, nullable: true],
- total: [:string, nullable: true], display_total: [:string, nullable: true],
- payment_total: [:string, nullable: true], display_payment_total: [:string, nullable: true],
- amount_due: [:string, nullable: true], display_amount_due: [:string, nullable: true],
- commission_amount_total: [:string, nullable: true],
- display_commission_amount_total: [:string, nullable: true],
- commission_tax_total: [:string, nullable: true],
- display_commission_tax_total: [:string, nullable: true],
- commission_total: [:string, nullable: true],
- display_commission_total: [:string, nullable: true],
- canceled_at: [:string, nullable: true],
- cancel_reason_name: [:string, nullable: true],
- cancel_note: [:string, nullable: true],
- internal_note: [:string, nullable: true],
- internal_note_html: [:string, nullable: true]
+ status: [:string, enum: Spree::Order::STATUSES], canceled_at: [:string, nullable: true],
+ cancel_reason_name: [:string, nullable: true], cancel_note: [:string, nullable: true],
+ internal_note: [:string, nullable: true], internal_note_html: [:string, nullable: true]
attributes :number, :customer_note, :currency, :total_quantity,
:status, :fulfillment_status, :payment_status,
@@ -107,8 +86,7 @@ module Spree
# page reads it, the list never does. Empty on an order that did not
# split — a single-seller basket keeps the payment on the order
# itself, and that payment stays the marketplace's.
- many :payment_splits, resource: proc { Spree.api.seller_payment_split_serializer },
- if: proc { expand?('payment_splits') }
+ expandable :many, :payment_splits, :seller_payment_split_serializer
many :fulfillments, resource: proc { Spree.api.seller_fulfillment_serializer }
one :shipping_address, resource: proc { Spree.api.address_serializer }
one :billing_address, resource: proc { Spree.api.address_serializer }
diff --git a/spree/api/app/serializers/spree/api/v3/seller/product_serializer.rb b/spree/api/app/serializers/spree/api/v3/seller/product_serializer.rb
index 13690acc02..0848db66b6 100644
--- a/spree/api/app/serializers/spree/api/v3/seller/product_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller/product_serializer.rb
@@ -20,30 +20,18 @@ module Spree
attributes :status, :metadata, created_at: :iso8601, updated_at: :iso8601
- attribute :product_type_id do |product|
- product.product_type&.prefixed_id
- end
+ prefixed_id_attributes :product_type, :delivery_profile
- attribute :delivery_profile_id do |product|
- product.delivery_profile&.prefixed_id
- end
+ expandable :many, :variants, :seller_variant_serializer
- many :variants,
- resource: proc { Spree.api.seller_variant_serializer },
- if: proc { expand?('variants') }
-
- one :default_variant,
- resource: proc { Spree.api.seller_variant_serializer },
- if: proc { expand?('default_variant') }
+ expandable :one, :default_variant, :seller_variant_serializer
many :gallery_media,
key: :media,
resource: proc { Spree.api.seller_media_serializer },
if: proc { expand?('media') }
- many :option_types,
- resource: proc { Spree.api.option_type_serializer },
- if: proc { expand?('option_types') }
+ expandable :many, :option_types, :option_type_serializer
# Why the marketplace sent this back, so the panel can show it
# against a rejected listing without a second request. Expanded
diff --git a/spree/api/app/serializers/spree/api/v3/seller/product_submission_serializer.rb b/spree/api/app/serializers/spree/api/v3/seller/product_submission_serializer.rb
index 7e8b5dbb5b..59773c4480 100644
--- a/spree/api/app/serializers/spree/api/v3/seller/product_submission_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller/product_submission_serializer.rb
@@ -20,9 +20,7 @@ module Spree
# Carried for the event payload, which is this serializer's other
# job: a subscriber holding only the submission id would have to
# fetch the row back to learn which product was decided on.
- attribute :product_id do |submission|
- submission.product&.prefixed_id
- end
+ prefixed_id_attributes :product
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/seller/profile_serializer.rb b/spree/api/app/serializers/spree/api/v3/seller/profile_serializer.rb
index f0d8802d27..1493e9d6fd 100644
--- a/spree/api/app/serializers/spree/api/v3/seller/profile_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller/profile_serializer.rb
@@ -36,17 +36,11 @@ module Spree
# shape of a policy (with `created_at`), which is what the seller
# SDK's generated type and this branch's OpenAPI schema promise.
_attributes.delete(:policies)
- many :policies,
- resource: proc { Spree.api.seller_policy_serializer },
- if: proc { expand?('policies') }
+ expandable :many, :policies, :seller_policy_serializer
- attribute :on_holiday do |seller|
- seller.on_holiday?
- end
+ attribute :on_holiday, &:on_holiday?
- attribute :sellable do |seller|
- seller.sellable?
- end
+ attribute :sellable, &:sellable?
# What this seller prices in. Theirs by way of the marketplace: a
# seller has no currency of their own, so the store's is the answer
diff --git a/spree/api/app/serializers/spree/api/v3/seller/requirement_status_serializer.rb b/spree/api/app/serializers/spree/api/v3/seller/requirement_status_serializer.rb
index 91f2bdff0e..a92c437654 100644
--- a/spree/api/app/serializers/spree/api/v3/seller/requirement_status_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller/requirement_status_serializer.rb
@@ -18,9 +18,7 @@ module Spree
attributes :id, :kind, :name, :description, :required, :position, :status, :action_url, :blocker
- attribute :blocking do |status|
- status.blocking?
- end
+ attribute :blocking, &:blocking?
attribute :accepts_submissions do |status|
status.requirement.class.accepts_submissions?
@@ -36,15 +34,11 @@ module Spree
# The document this line asks for, so the panel can offer to create
# exactly that policy. Null for every other kind.
- attribute :required_policy_name do |status|
- status.required_policy_name
- end
+ attributes :required_policy_name
# The marketplace terms this line asks the seller to accept. Null
# for every other kind, and null while nothing has been written.
- attribute :terms_html do |status|
- status.terms_html
- end
+ attributes :terms_html
one :submission,
resource: proc { Spree.api.seller_requirement_submission_serializer },
diff --git a/spree/api/app/serializers/spree/api/v3/seller/return_line_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/seller/return_line_item_serializer.rb
index 2a173edb3c..dd130d86b0 100644
--- a/spree/api/app/serializers/spree/api/v3/seller/return_line_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller/return_line_item_serializer.rb
@@ -16,7 +16,7 @@ module Spree
line.line_item&.name || line.variant&.name
end
- one :variant, resource: proc { Spree.api.seller_variant_serializer }, if: proc { expand?('variant') }
+ expandable :one, :variant, :seller_variant_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/seller/return_serializer.rb b/spree/api/app/serializers/spree/api/v3/seller/return_serializer.rb
index 94bc861d11..3126c5f073 100644
--- a/spree/api/app/serializers/spree/api/v3/seller/return_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller/return_serializer.rb
@@ -21,29 +21,17 @@ module Spree
attributes :memo
- attribute :stock_location_id do |return_record|
- return_record.stock_location&.prefixed_id
- end
+ prefixed_id_attributes :stock_location
- attribute :refunded_total do |return_record|
- return_record.refunded_total.to_s
- end
+ string_attributes :refunded_total
# What the refund dialog opens on — never more than this may be
# given back, whatever amount is typed.
- attribute :refundable_total do |return_record|
- return_record.refundable_total.to_s
- end
+ string_attributes :refundable_total, :display_refunded_total
- attribute :display_refunded_total do |return_record|
- return_record.display_refunded_total.to_s
- end
+ expandable :many, :return_line_items, :seller_return_line_item_serializer
- many :return_line_items,
- resource: proc { Spree.api.seller_return_line_item_serializer },
- if: proc { expand?('return_line_items') }
-
- one :reason, resource: proc { Spree.api.seller_reason_serializer }, if: proc { expand?('reason') }
+ expandable :one, :reason, :seller_reason_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/seller/stock_level_serializer.rb b/spree/api/app/serializers/spree/api/v3/seller/stock_level_serializer.rb
index 86bc765f99..180664cfe0 100644
--- a/spree/api/app/serializers/spree/api/v3/seller/stock_level_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller/stock_level_serializer.rb
@@ -17,9 +17,7 @@ module Spree
stock_level.available_count.to_i
end
- one :stock_location,
- resource: proc { Spree.api.seller_stock_location_serializer },
- if: proc { expand?('stock_location') }
+ expandable :one, :stock_location, :seller_stock_location_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/seller/variant_serializer.rb b/spree/api/app/serializers/spree/api/v3/seller/variant_serializer.rb
index 6be48ca80b..0e34db95d7 100644
--- a/spree/api/app/serializers/spree/api/v3/seller/variant_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller/variant_serializer.rb
@@ -48,22 +48,16 @@ module Spree
variant.total_on_hand.to_i if variant.should_track_inventory?
end
- one :primary_media,
- resource: proc { Spree.api.seller_media_serializer },
- if: proc { expand?('primary_media') }
+ expandable :one, :primary_media, :seller_media_serializer
many :gallery_media,
key: :media,
resource: proc { Spree.api.seller_media_serializer },
if: proc { expand?('media') }
- many :prices,
- resource: proc { Spree.api.price_serializer },
- if: proc { expand?('prices') }
+ expandable :many, :prices, :price_serializer
- many :stock_levels,
- resource: proc { Spree.api.seller_stock_level_serializer },
- if: proc { expand?('stock_levels') }
+ expandable :many, :stock_levels, :seller_stock_level_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/seller_serializer.rb b/spree/api/app/serializers/spree/api/v3/seller_serializer.rb
index a82403c2ee..d19e2faa9b 100644
--- a/spree/api/app/serializers/spree/api/v3/seller_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/seller_serializer.rb
@@ -21,9 +21,7 @@ module Spree
Spree::RichTextHelper.to_plain_text(seller.about)
end
- attribute :about_html do |seller|
- seller.about_html
- end
+ attributes :about_html
attribute :logo_url do |seller|
image_url_for(seller.logo)
@@ -41,9 +39,7 @@ module Spree
# because a policy body is a whole legal document: a marketplace's
# seller listing would otherwise carry every seller's full text on
# every page. A product page reaches them as `expand=seller.policies`.
- many :policies,
- resource: proc { Spree.api.policy_serializer },
- if: proc { expand?('policies') }
+ expandable :many, :policies, :policy_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/stock_level_serializer.rb b/spree/api/app/serializers/spree/api/v3/stock_level_serializer.rb
index 50ad9bd492..0123aa44f0 100644
--- a/spree/api/app/serializers/spree/api/v3/stock_level_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/stock_level_serializer.rb
@@ -9,13 +9,7 @@ module Spree
attributes :count_on_hand, :backorderable
- attribute :stock_location_id do |stock_level|
- stock_level.stock_location&.prefixed_id
- end
-
- attribute :variant_id do |stock_level|
- stock_level.variant&.prefixed_id
- end
+ prefixed_id_attributes :stock_location, :variant
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/stock_movement_serializer.rb b/spree/api/app/serializers/spree/api/v3/stock_movement_serializer.rb
index 79c81d3ace..7104cb4cc2 100644
--- a/spree/api/app/serializers/spree/api/v3/stock_movement_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/stock_movement_serializer.rb
@@ -13,9 +13,7 @@ module Spree
attributes :quantity, :kind, :reason,
created_at: :iso8601, updated_at: :iso8601
- attribute :stock_level_id do |movement|
- movement.stock_level&.prefixed_id
- end
+ prefixed_id_attributes :stock_level
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/stock_transfer_serializer.rb b/spree/api/app/serializers/spree/api/v3/stock_transfer_serializer.rb
index f5efacb9aa..f69e1f85e5 100644
--- a/spree/api/app/serializers/spree/api/v3/stock_transfer_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/stock_transfer_serializer.rb
@@ -15,13 +15,7 @@ module Spree
attributes :number, :reference,
created_at: :iso8601, updated_at: :iso8601
- attribute :source_location_id do |transfer|
- transfer.source_location&.prefixed_id
- end
-
- attribute :destination_location_id do |transfer|
- transfer.destination_location&.prefixed_id
- end
+ prefixed_id_attributes :source_location, :destination_location
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/store_credit_event_serializer.rb b/spree/api/app/serializers/spree/api/v3/store_credit_event_serializer.rb
index bafbb9371c..50001f42ec 100644
--- a/spree/api/app/serializers/spree/api/v3/store_credit_event_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/store_credit_event_serializer.rb
@@ -10,17 +10,9 @@ module Spree
attributes :action, :authorization_code
- attribute :display_action do |event|
- event.display_action
- end
+ attributes :display_action
- attribute :amount do |event|
- event.amount.to_s
- end
-
- attribute :display_amount do |event|
- event.display_amount.to_s
- end
+ string_attributes :amount, :display_amount
attributes created_at: :iso8601
end
diff --git a/spree/api/app/serializers/spree/api/v3/store_credit_serializer.rb b/spree/api/app/serializers/spree/api/v3/store_credit_serializer.rb
index 2a87963dff..5ce832cd24 100644
--- a/spree/api/app/serializers/spree/api/v3/store_credit_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/store_credit_serializer.rb
@@ -6,29 +6,8 @@ module Spree
display_amount: :string, display_amount_used: :string, display_amount_remaining: :string,
currency: :string
- attribute :amount do |store_credit|
- store_credit.amount.to_s
- end
-
- attribute :amount_used do |store_credit|
- store_credit.amount_used.to_s
- end
-
- attribute :amount_remaining do |store_credit|
- store_credit.amount_remaining.to_s
- end
-
- attribute :display_amount do |store_credit|
- store_credit.display_amount.to_s
- end
-
- attribute :display_amount_used do |store_credit|
- store_credit.display_amount_used.to_s
- end
-
- attribute :display_amount_remaining do |store_credit|
- store_credit.display_amount_remaining.to_s
- end
+ string_attributes :amount, :amount_used, :amount_remaining, :display_amount, :display_amount_used,
+ :display_amount_remaining
attributes :currency
end
diff --git a/spree/api/app/serializers/spree/api/v3/tax_line_serializer.rb b/spree/api/app/serializers/spree/api/v3/tax_line_serializer.rb
index 17f8420f56..1af987c4f5 100644
--- a/spree/api/app/serializers/spree/api/v3/tax_line_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/tax_line_serializer.rb
@@ -6,7 +6,6 @@ module Spree
# back (`credit`) or charges on an exchange's replacement.
class TaxLineSerializer < BaseSerializer
typelize label: :string, rate: :string, included: :boolean, credit: :boolean,
- amount: [:string, nullable: true], display_amount: [:string, nullable: true],
tax_rate_id: [:string, nullable: true], line_item_id: [:string, nullable: true],
fulfillment_id: [:string, nullable: true], fee_id: [:string, nullable: true],
return_line_item_id: [:string, nullable: true], claim_line_item_id: [:string, nullable: true],
@@ -18,33 +17,8 @@ module Spree
record.rate&.to_s
end
- attribute :tax_rate_id do |record|
- record.tax_rate&.prefixed_id
- end
-
- attribute :line_item_id do |record|
- record.line_item&.prefixed_id
- end
-
- attribute :fulfillment_id do |record|
- record.fulfillment&.prefixed_id
- end
-
- attribute :fee_id do |record|
- record.fee&.prefixed_id
- end
-
- attribute :return_line_item_id do |record|
- record.return_line_item&.prefixed_id
- end
-
- attribute :claim_line_item_id do |record|
- record.claim_line_item&.prefixed_id
- end
-
- attribute :exchange_line_item_id do |record|
- record.exchange_line_item&.prefixed_id
- end
+ prefixed_id_attributes :tax_rate, :line_item, :fulfillment, :fee, :return_line_item, :claim_line_item,
+ :exchange_line_item
money_attributes :amount, :display_amount
end
diff --git a/spree/api/app/serializers/spree/api/v3/variant_serializer.rb b/spree/api/app/serializers/spree/api/v3/variant_serializer.rb
index e92b4f2db1..8bc33e256d 100644
--- a/spree/api/app/serializers/spree/api/v3/variant_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/variant_serializer.rb
@@ -17,9 +17,7 @@ module Spree
purchase_unit: [:string, enum: Spree::Variant::PURCHASE_UNITS], units_per_carton: ['number | null'],
seller_id: [:string, nullable: true]
- attribute :product_id do |variant|
- variant.product&.prefixed_id
- end
+ prefixed_id_attributes :product
attributes :sku, :options_text, :track_inventory, :media_count
@@ -34,21 +32,13 @@ module Spree
image_url_for(variant.primary_media)
end
- attribute :purchasable do |variant|
- variant.purchasable?
- end
+ attribute :purchasable, &:purchasable?
- attribute :in_stock do |variant|
- variant.in_stock?
- end
+ attribute :in_stock, &:in_stock?
- attribute :backorderable do |variant|
- variant.backorderable?
- end
+ attribute :backorderable, &:backorderable?
- attribute :preorder do |variant|
- variant.preorder?
- end
+ attribute :preorder, &:preorder?
attribute :weight do |variant|
variant.weight&.to_f
@@ -93,9 +83,7 @@ module Spree
variant.purchase_unit.presence || 'unit'
end
- attribute :units_per_carton do |variant|
- variant.units_per_carton
- end
+ attributes :units_per_carton
# Price object - calculated price with price list resolution
attribute :price do |variant|
@@ -119,9 +107,7 @@ module Spree
# listing) or the row itself (a master shared by several sellers). Nil
# is first-party. Shoppers comparing offers on one page group by this,
# so it is a plain attribute rather than an expand.
- attribute :seller_id do |variant|
- variant.resolved_seller&.prefixed_id
- end
+ prefixed_id_attributes seller_id: :resolved_seller
one :seller,
resource: proc { Spree.api.seller_serializer },
@@ -130,9 +116,7 @@ module Spree
end
# Conditional associations
- one :primary_media,
- resource: proc { Spree.api.media_serializer },
- if: proc { expand?('primary_media') }
+ expandable :one, :primary_media, :media_serializer
many :gallery_media,
key: :media,
diff --git a/spree/api/app/serializers/spree/api/v3/wishlist_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/wishlist_item_serializer.rb
index 629aa3e8a3..9e92b7bdb3 100644
--- a/spree/api/app/serializers/spree/api/v3/wishlist_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/wishlist_item_serializer.rb
@@ -5,23 +5,12 @@ module Spree
typelize variant_id: :string, wishlist_id: :string, quantity: :number,
product_id: :string
- attribute :variant_id do |wishlist_item|
- wishlist_item.variant&.prefixed_id
- end
-
- attribute :product_id do |wishlist_item|
- wishlist_item.product&.prefixed_id
- end
-
- attribute :wishlist_id do |wishlist_item|
- wishlist_item.wishlist&.prefixed_id
- end
+ prefixed_id_attributes :variant, :product, :wishlist
attributes :quantity
one :variant, resource: proc { Spree.api.variant_serializer }
- one :product, resource: proc { Spree.api.product_serializer },
- if: proc { expand?('product') }
+ expandable :one, :product, :product_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/wishlist_serializer.rb b/spree/api/app/serializers/spree/api/v3/wishlist_serializer.rb
index b8786c93c9..3feb189568 100644
--- a/spree/api/app/serializers/spree/api/v3/wishlist_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/wishlist_serializer.rb
@@ -6,13 +6,9 @@ module Spree
attributes :name, :token
- attribute :is_default do |wishlist|
- wishlist.is_default?
- end
+ attribute :is_default, &:is_default?
- attribute :is_private do |wishlist|
- wishlist.is_private?
- end
+ attribute :is_private, &:is_private?
many :wishlist_items,
key: :items,