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.

Add json_api_type backwards-compatible alias to Spree::Base (#14034)

Damian Legawiec3ea56688913b
diff --git a/spree/core/app/models/spree/base.rb b/spree/core/app/models/spree/base.rb
index 0c087319d1..a85dfa5b59 100644
--- a/spree/core/app/models/spree/base.rb
+++ b/spree/core/app/models/spree/base.rb
@@ -80,6 +80,12 @@ class Spree::Base < ApplicationRecord
to_s.demodulize.underscore
end
+ # Backwards-compatible alias for `.api_type`. Delegates so subclass
+ # overrides of `api_type` are honored.
+ def self.json_api_type
+ api_type
+ end
+
def self.to_tom_select_json
pluck(:name, :id).map do |name, id|
{
diff --git a/spree/core/spec/models/spree/base_spec.rb b/spree/core/spec/models/spree/base_spec.rb
index fb57b98018..ac3d015975 100644
--- a/spree/core/spec/models/spree/base_spec.rb
+++ b/spree/core/spec/models/spree/base_spec.rb
@@ -51,6 +51,24 @@ describe Spree::Base do
it { expect(Spree::Address.api_type).to eq('address') }
end
+ describe '.json_api_type' do
+ # Backwards-compatible alias retained for extensions that still call
+ # the old name; must delegate so subclass overrides (e.g.
+ # `Spree::Gateway.api_type`) propagate.
+ it { expect(Spree::InventoryUnit.json_api_type).to eq('inventory_unit') }
+ it { expect(Spree::Address.json_api_type).to eq('address') }
+
+ it 'honors subclass overrides of .api_type' do
+ klass = Class.new(Spree::Base) do
+ def self.api_type
+ 'overridden'
+ end
+ end
+
+ expect(klass.json_api_type).to eq('overridden')
+ end
+ end
+
describe '.json_api_columns' do
it 'skips sensitive data' do
expect(Spree::LegacyUser.json_api_columns).not_to include('password')