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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Convert added money attributes to string (#11523)
seb4392e99f1343
diff --git a/api/app/serializers/concerns/spree/api/v2/resource_serializer_concern.rb b/api/app/serializers/concerns/spree/api/v2/resource_serializer_concern.rbindex d29f3fffb0..6ab80a2a26 100644--- a/api/app/serializers/concerns/spree/api/v2/resource_serializer_concern.rb+++ b/api/app/serializers/concerns/spree/api/v2/resource_serializer_concern.rb@@ -12,9 +12,21 @@ module Spree# include standard attributesbase.attributes(*model_klazz.json_api_columns)# include money attributes- base.attributes(*model_klazz.new.methods.find_all do |m|- m.to_s.match(/display_/) && !m.to_s.match(/\=/) && !([Spree::Product, Spree::Variant].include?(model_klazz) && m == :display_amount)- end)+ display_getter_methods(model_klazz).each do |method_name|+ base.attribute(method_name) do |object|+ object.public_send(method_name).to_s+ end+ end+ end++ def self.display_getter_methods(model_klazz)+ model_klazz.new.methods.find_all do |method_name|+ next unless method_name.to_s.start_with?('display_')+ next if method_name.to_s.end_with?('=')+ next if [Spree::Product, Spree::Variant].include?(model_klazz) && method_name == :display_amount++ method_name+ endendendenddiff --git a/api/app/serializers/spree/api/v2/platform/price_serializer.rb b/api/app/serializers/spree/api/v2/platform/price_serializer.rbindex ef65845217..3cc6657437 100644--- a/api/app/serializers/spree/api/v2/platform/price_serializer.rb+++ b/api/app/serializers/spree/api/v2/platform/price_serializer.rb@@ -6,11 +6,11 @@ module Spreeinclude ResourceSerializerConcernattribute :display_price_including_vat_for do |price, params|- price.display_price_including_vat_for(params[:price_options].presence || {})+ price.display_price_including_vat_for(params[:price_options].presence || {}).to_sendattribute :display_compare_at_price_including_vat_for do |price, params|- price.display_compare_at_price_including_vat_for(params[:price_options].presence || {})+ price.display_compare_at_price_including_vat_for(params[:price_options].presence || {}).to_sendendenddiff --git a/api/spec/serializers/spree/api/v2/platform/price_serializer_spec.rb b/api/spec/serializers/spree/api/v2/platform/price_serializer_spec.rbindex f2bffc7db0..16c6bbf572 100644--- a/api/spec/serializers/spree/api/v2/platform/price_serializer_spec.rb+++ b/api/spec/serializers/spree/api/v2/platform/price_serializer_spec.rb@@ -3,29 +3,33 @@ require 'spec_helper'describe Spree::Api::V2::Platform::PriceSerializer doinclude_context 'API v2 serializers params'- subject { described_class.new(price, params: serializer_params) }+ subject { described_class.new(resource, params: serializer_params) }- let(:price) { create(:price) }+ let(:resource) { create(:price) }+ let(:type) { :price }- it { expect(subject.serializable_hash).to be_kind_of(Hash) }-- # serializable_hash is returned with a different key order,- # making the tests fail if is compared to a pre-defined hashit do- serializable_hash = subject.serializable_hash- expect(serializable_hash[:data][:id]).to eq(price.id.to_s)- expect(serializable_hash[:data][:type]).to eq(:price)- expect(serializable_hash[:data][:attributes][:amount]).to eq(price.amount)- expect(serializable_hash[:data][:attributes][:currency]).to eq(price.currency)- expect(serializable_hash[:data][:attributes][:deleted_at]).to eq(price.deleted_at)- expect(serializable_hash[:data][:attributes][:created_at]).to eq(price.created_at)- expect(serializable_hash[:data][:attributes][:updated_at]).to eq(price.updated_at)- expect(serializable_hash[:data][:attributes][:compare_at_amount]).to eq(price.compare_at_amount)- expect(serializable_hash[:data][:attributes][:display_compare_at_price]).to eq(Spree::Money.new(0, currency: price.currency))- expect(serializable_hash[:data][:attributes][:display_amount]).to eq(price.display_amount)- expect(serializable_hash[:data][:attributes][:display_price]).to eq(price.display_price)- expect(serializable_hash[:data][:attributes][:display_compare_at_price_including_vat_for]).to eq(Spree::Money.new(price.compare_at_amount, currency: price.currency))- expect(serializable_hash[:data][:attributes][:display_compare_at_amount]).to eq(Spree::Money.new(0, currency: price.currency))- expect(serializable_hash[:data][:attributes][:display_price_including_vat_for]).to eq(Spree::Money.new(price.amount, currency: price.currency))+ expect(subject.serializable_hash).to(+ eq(+ data: {+ id: resource.id.to_s,+ type: type,+ attributes: {+ amount: resource.amount,+ currency: resource.currency,+ deleted_at: resource.deleted_at,+ created_at: resource.created_at,+ updated_at: resource.updated_at,+ compare_at_amount: resource.compare_at_amount,+ display_compare_at_price: resource.display_compare_at_price.to_s,+ display_amount: resource.display_amount.to_s,+ display_price: resource.display_price.to_s,+ display_compare_at_amount: resource.display_compare_at_amount.to_s,+ display_compare_at_price_including_vat_for: resource.display_compare_at_price_including_vat_for({}).to_s,+ display_price_including_vat_for: resource.display_price_including_vat_for({}).to_s+ }+ }+ )+ )endenddiff --git a/api/spec/serializers/spree/api/v2/platform/reimbursement_serializer_spec.rb b/api/spec/serializers/spree/api/v2/platform/reimbursement_serializer_spec.rbindex e17ef9d014..a801790fbd 100644--- a/api/spec/serializers/spree/api/v2/platform/reimbursement_serializer_spec.rb+++ b/api/spec/serializers/spree/api/v2/platform/reimbursement_serializer_spec.rb@@ -21,7 +21,7 @@ describe Spree::Api::V2::Platform::ReimbursementSerializer dototal: resource.total,created_at: resource.created_at,updated_at: resource.updated_at,- display_total: resource.display_total,+ display_total: resource.display_total.to_s,},relationships: {order: {diff --git a/api/spec/serializers/spree/api/v2/resource_serializer_concern_spec.rb b/api/spec/serializers/spree/api/v2/resource_serializer_concern_spec.rbnew file mode 100644index 0000000000..62ca4a587c--- /dev/null+++ b/api/spec/serializers/spree/api/v2/resource_serializer_concern_spec.rb@@ -0,0 +1,124 @@+require 'spec_helper'++module Spree+ TestOrder = Struct.new(:adjustment_total, :id, :item_total, :outstanding_balance, keyword_init: true) do+ extend Spree::DisplayMoney++ money_methods :adjustment_total, :item_total, :outstanding_balance++ # Just for testing setter methods aren't added+ def display_item_total=+ end++ def self.json_api_type+ to_s.demodulize.underscore+ end++ def self.json_api_columns+ %w[created_at updated_at]+ end+ end++ module Api+ module V2+ module Platform+ class TestOrderSerializer < ::Spree::Api::V2::BaseSerializer+ include Spree::Api::V2::ResourceSerializerConcern+ end+ end+ end+ end+end++describe Spree::Api::V2::ResourceSerializerConcern do+ describe '.included' do+ let(:adjustment_total) { 100.0 }+ let(:created_at) { 1.day.ago }+ let(:id) { 1 }+ let(:item_total) { 110.0 }+ let(:outstanding_balance) { 10.0 }+ let(:serializable_hash) { Spree::Api::V2::Platform::TestOrderSerializer.new(test_order).serializable_hash }+ let(:test_order) do+ Spree::TestOrder.new(+ adjustment_total: adjustment_total,+ id: id,+ item_total: item_total,+ outstanding_balance: outstanding_balance+ )+ end+ let(:updated_at) { Time.now }++ before { allow(test_order).to receive_messages(created_at: created_at, updated_at: updated_at) }++ it do+ expect(serializable_hash).to(+ eq(+ data: {+ id: test_order.id.to_s,+ type: :test_order,+ attributes: {+ created_at: created_at,+ display_adjustment_total: test_order.display_adjustment_total.to_s,+ display_item_total: test_order.display_item_total.to_s,+ display_outstanding_balance: test_order.display_outstanding_balance.to_s,+ updated_at: updated_at+ }+ }+ )+ )+ end++ it 'sets the base type' do+ expect(serializable_hash[:data][:type]).to eq(:test_order)+ end++ it 'adds the model class json_api_columns as attributes' do+ expect(serializable_hash[:data][:attributes][:created_at]).to eq(created_at)+ expect(serializable_hash[:data][:attributes][:updated_at]).to eq(updated_at)+ end++ it 'adds all the display instance methods the class has' do+ expect(serializable_hash[:data][:attributes].key?(:display_adjustment_total)).to eq(true)+ expect(serializable_hash[:data][:attributes].key?(:display_item_total)).to eq(true)+ expect(serializable_hash[:data][:attributes].key?(:display_outstanding_balance)).to eq(true)+ end++ it 'converts to string the display money attributes' do+ expect(serializable_hash[:data][:attributes][:display_outstanding_balance]).to(+ eq(test_order.display_outstanding_balance.to_s)+ )+ expect(serializable_hash[:data][:attributes][:display_adjustment_total]).to(+ eq(test_order.display_adjustment_total.to_s)+ )+ expect(serializable_hash[:data][:attributes][:display_item_total]).to(+ eq(test_order.display_item_total.to_s)+ )+ end++ it 'does not add display setter methods - ending with "="' do+ expect(serializable_hash[:data][:attributes].key?(:display_item_total=)).to eq(false)+ end++ context 'when model class is a Spree::Product' do+ context 'display_amount method' do+ let(:product) { create(:product) }+ let(:serializable_hash) { Spree::Api::V2::Platform::ProductSerializer.new(product).serializable_hash }++ it 'does not add the display_amount method' do+ expect(serializable_hash[:data][:attributes].key?(:display_amount)).to eq(false)+ end+ end+ end++ context 'when model class is a Spree::Variant' do+ context 'display_amount method' do+ let(:variant) { create(:variant) }+ let(:serializable_hash) { Spree::Api::V2::Platform::VariantSerializer.new(variant).serializable_hash }++ it 'does not add the display_amount method' do+ expect(serializable_hash[:data][:attributes].key?(:display_amount)).to eq(false)+ end+ end+ end+ end+end