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.

Fixed querying by metadata fields and added more tests (#11609)

Damian Legawiec2da4b3bd4bd7
diff --git a/core/app/models/concerns/spree/metadata.rb b/core/app/models/concerns/spree/metadata.rb
index 6bc5111a22..e00dc79ab0 100644
--- a/core/app/models/concerns/spree/metadata.rb
+++ b/core/app/models/concerns/spree/metadata.rb
@@ -3,8 +3,21 @@ module Spree
extend ActiveSupport::Concern
included do
- store :public_metadata, coder: JSON
- store :private_metadata, coder: JSON
+ attribute :public_metadata, default: {}
+ attribute :private_metadata, default: {}
+ serialize :public_metadata, HashSerializer
+ serialize :private_metadata, HashSerializer
+ end
+
+ # https://nandovieira.com/using-postgresql-and-jsonb-with-ruby-on-rails
+ class HashSerializer
+ def self.dump(hash)
+ hash
+ end
+
+ def self.load(hash)
+ (hash || {}).with_indifferent_access
+ end
end
end
end
diff --git a/core/lib/spree/testing_support/metadata.rb b/core/lib/spree/testing_support/metadata.rb
index fcc4dc0d03..467c88c840 100644
--- a/core/lib/spree/testing_support/metadata.rb
+++ b/core/lib/spree/testing_support/metadata.rb
@@ -4,10 +4,13 @@ shared_examples_for 'metadata' do |factory: described_class.name.demodulize.unde
it { expect(subject.has_attribute?(:public_metadata)).to be_truthy }
it { expect(subject.has_attribute?(:private_metadata)).to be_truthy }
- it { expect(subject.public_metadata.class).to eq(HashWithIndifferentAccess) }
- it { expect(subject.private_metadata.class).to eq(HashWithIndifferentAccess) }
+ it { expect(subject.public_metadata).to eq({}) }
+ it { expect(subject.private_metadata).to eq({}) }
- it do
+ it { expect(subject.public_metadata.class).to eq(ActiveSupport::HashWithIndifferentAccess) }
+ it { expect(subject.private_metadata.class).to eq(ActiveSupport::HashWithIndifferentAccess) }
+
+ it 'reads data as symbolized keys' do
string = subject.public_metadata[:color] = 'red'
number = subject.public_metadata[:priority] = 1
array = subject.public_metadata[:keywords] = ['k1', 'k2']
@@ -20,4 +23,32 @@ shared_examples_for 'metadata' do |factory: described_class.name.demodulize.unde
expect(subject.public_metadata[:keywords]).to eq(array)
expect(subject.public_metadata[:additional_data]).to eq(hash.stringify_keys)
end
+
+ it 'reads data as not symbolized keys' do
+ string = subject.public_metadata[:color] = 'red'
+ number = subject.public_metadata[:priority] = 1
+ array = subject.public_metadata[:keywords] = ['k1', 'k2']
+ hash = subject.public_metadata[:additional_data] = { size: 'big', material: 'wool' }
+
+ subject.save!
+
+ expect(subject.public_metadata['color']).to eq(string)
+ expect(subject.public_metadata['priority']).to eq(number)
+ expect(subject.public_metadata['keywords']).to eq(array)
+ expect(subject.public_metadata['additional_data']).to eq(hash.stringify_keys)
+ end
+
+ it 'can query records by metadata properties', skip: ENV['DB'] == 'mysql' do
+ subject.public_metadata[:color] = 'red'
+ subject.public_metadata[:priority] = 1
+ subject.public_metadata[:keywords] = ['k1', 'k2']
+ subject.public_metadata[:additional_data] = { size: 'big', material: 'wool' }
+
+ subject.save!
+
+ expect(described_class.where("public_metadata->>'color' = ?", 'red').count).to eq(1)
+ expect(described_class.where("public_metadata->>'priority' = ?", '1').count).to eq(1)
+ expect(described_class.where("public_metadata -> 'keywords' ? :keyword", keyword: 'k1').count).to eq(1)
+ expect(described_class.where("public_metadata -> 'additional_data' ->> 'size' = :size", size: 'big').count).to eq(1)
+ end
end