spree_core 4.3.0 → 4.6.1

data/lib/spree/testing_support/common_rake.rb

@@ -14,6 +14,13 @@ namespace :common do
     ENV['RAILS_ENV'] = 'test'
     Rails.env = 'test'
 
+    if ENV['LIB_NAME'] == 'spree/backend'
+      puts 'Preparing NPM package...'
+      system('yarn install')
+      system('yarn build')
+      system('yarn link')
+    end
+
     Spree::DummyGenerator.start ["--lib_name=#{ENV['LIB_NAME']}", '--quiet']
     Spree::InstallGenerator.start [
       "--lib_name=#{ENV['LIB_NAME']}",
@@ -29,9 +36,16 @@ namespace :common do
     ]
 
     puts 'Setting up dummy database...'
-    system("bundle exec rake db:drop db:create > #{File::NULL}")
+    system('bin/rails db:environment:set RAILS_ENV=test')
+    system('bundle exec rake db:drop db:create')
     Spree::DummyModelGenerator.start
-    system("bundle exec rake db:migrate > #{File::NULL}")
+    system('bundle exec rake db:migrate')
+
+    unless ['spree/api', 'spree/core', 'spree/sample', 'spree/emails'].include?(ENV['LIB_NAME'])
+      puts 'Setting up node environment'
+      system('bin/rails javascript:install:esbuild')
+      system('bin/rails turbo:install')
+    end
 
     begin
       require "generators/#{ENV['LIB_NAME']}/install/install_generator"
@@ -42,13 +56,18 @@ namespace :common do
     end
 
     unless ['spree/api', 'spree/core', 'spree/sample'].include?(ENV['LIB_NAME'])
+      if ENV['LIB_NAME'] == 'spree/backend'
+        puts 'Installing node dependencies...'
+        system('yarn link @spree/dashboard')
+        system('yarn install')
+      end
       puts 'Precompiling assets...'
-      system("bundle exec rake assets:precompile > #{File::NULL}")
+      system('bundle exec rake assets:precompile')
     end
   end
 
   task :seed do |_t|
     puts 'Seeding ...'
-    system("bundle exec rake db:seed RAILS_ENV=test > #{File::NULL}")
+    system('bundle exec rake db:seed RAILS_ENV=test')
   end
 end

data/lib/spree/testing_support/factories/asset_factory.rb

@@ -0,0 +1,15 @@
+FactoryBot.define do
+  factory :asset, class: Spree::Asset do
+    viewable_type {}
+    viewable_id {}
+    attachment_width { 340 }
+    attachment_height { 280 }
+    attachment_file_size { 128 }
+    position { 1 }
+    attachment_content_type { '.jpg' }
+    attachment_file_name { 'attachment.jpg' }
+    type {}
+    attachment_updated_at {}
+    alt {}
+  end
+end

data/lib/spree/testing_support/factories/cms_section_factory.rb

@@ -1,8 +1,8 @@
 FactoryBot.define do
-  factory :cms_section, class: Spree::CmsSection do
+  factory :base_cms_section, class: Spree::CmsSection do
     name { generate(:random_string) }
 
-    association :cms_page, factory: :base_cms_page
+    association :cms_page, factory: :cms_feature_page
 
     factory :cms_hero_image_section do
       type { 'Spree::Cms::Sections::HeroImage' }

data/lib/spree/testing_support/factories/digital_factory.rb

@@ -0,0 +1,10 @@
+FactoryBot.define do
+  factory :digital, class: Spree::Digital do
+    after(:build) do |digital|
+      digital.attachment.attach(io: File.new("#{Spree::Core::Engine.root}/spec/fixtures/thinking-cat.jpg"),
+                                filename: 'thinking-cat.jpg')
+    end
+
+    variant
+  end
+end

data/lib/spree/testing_support/factories/digital_link_factory.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :digital_link, class: Spree::DigitalLink do
+    digital
+    line_item
+  end
+end

data/lib/spree/testing_support/factories/favicon_image_factory.rb

@@ -0,0 +1,9 @@
+FactoryBot.define do
+  factory :favicon_image, class: Spree::StoreFaviconImage do
+    transient do
+      filepath { Spree::Core::Engine.root.join('spec', 'fixtures', 'favicon.ico') }
+    end
+
+    attachment { Rack::Test::UploadedFile.new(filepath) }
+  end
+end

data/lib/spree/testing_support/factories/google_data_feed_factory.rb

@@ -0,0 +1,8 @@
+FactoryBot.define do
+  factory :google_data_feed, class: Spree::DataFeed::Google do
+    id             { 1 }
+    active         { true }
+    store          { create(:store) }
+    name           { 'test' }
+  end
+end

data/lib/spree/testing_support/factories/icon_factory.rb

@@ -1,7 +1,9 @@
 FactoryBot.define do
   factory :icon, class: Spree::Icon do
     before(:create) do |icon|
-      icon.attachment.attach(io: File.new(Spree::Core::Engine.root + 'spec/fixtures' + 'thinking-cat.jpg'), filename: 'thinking-cat.jpg')
+      if icon.respond_to? :attachment
+        icon.attachment.attach(io: File.new(Spree::Core::Engine.root + 'spec/fixtures' + 'thinking-cat.jpg'), filename: 'thinking-cat.jpg')
+      end
     end
   end
 end

data/lib/spree/testing_support/factories/image_factory.rb

@@ -1,7 +1,9 @@
 FactoryBot.define do
   factory :image, class: Spree::Image do
     before(:create) do |image|
-      image.attachment.attach(io: File.new(Spree::Core::Engine.root + 'spec/fixtures' + 'thinking-cat.jpg'), filename: 'thinking-cat.jpg')
+      if image.class.method_defined?(:attachment)
+        image.attachment.attach(io: File.new(Spree::Core::Engine.root + 'spec/fixtures' + 'thinking-cat.jpg'), filename: 'thinking-cat.jpg')
+      end
     end
   end
 end

data/lib/spree/testing_support/factories/log_entry_factory.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :log_entry, class: Spree::LogEntry do
+    source { build(:order) }
+    details { 'Some details' }
+  end
+end

data/lib/spree/testing_support/factories/menu_item_factory.rb

@@ -2,7 +2,7 @@ FactoryBot.define do
   factory :menu_item, class: Spree::MenuItem do
     sequence(:name) { |n| "Link no. #{n} To Somewhere" }
     item_type { 'Link' }
-    linked_resource_type { 'URL' }
+    linked_resource_type { 'Spree::Linkable::Uri' }
 
     menu
     icon

data/lib/spree/testing_support/factories/order_factory.rb

@@ -55,7 +55,8 @@ FactoryBot.define do
           order.line_items.reload
         end
 
-        create(:shipment, order: order, cost: evaluator.shipment_cost)
+        stock_location = order.line_items&.first&.variant&.stock_items&.first&.stock_location || create(:stock_location)
+        create(:shipment, order: order, cost: evaluator.shipment_cost, stock_location: stock_location)
         order.shipments.reload
 
         order.update_with_updater!
@@ -77,7 +78,10 @@ FactoryBot.define do
 
         factory :completed_order_with_store_credit_payment do
           after(:create) do |order|
-            create(:store_credit_payment, amount: order.total, order: order)
+            store_credit = create(:store_credit, amount: order.total, store: order.store, user: order.user)
+            payment_method = create(:store_credit_payment_method, stores: [order.store])
+
+            create(:store_credit_payment, amount: order.total, order: order, source: store_credit, payment_method: payment_method)
           end
         end
 

data/lib/spree/testing_support/factories/payment_capture_event_factory.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :payment_capture_event, class: Spree::PaymentCaptureEvent do
+    payment
+    amount { 10.0 }
+  end
+end

data/lib/spree/testing_support/factories/payment_factory.rb

@@ -5,7 +5,7 @@ FactoryBot.define do
     state         { 'checkout' }
     response_code { '12345' }
 
-    association(:payment_method, factory: :credit_card_payment_method)
+    payment_method { create(:credit_card_payment_method, stores: [order.store]) }
     association(:source, factory: :credit_card)
 
     factory :payment_with_refund do
@@ -24,7 +24,7 @@ FactoryBot.define do
   end
 
   factory :store_credit_payment, class: Spree::Payment, parent: :payment do
-    association(:payment_method, factory: :store_credit_payment_method)
-    association(:source, factory: :store_credit)
+    payment_method { create(:store_credit_payment_method, stores: [order.store]) }
+    source { create(:store_credit, store: order.store, user: order.user) }
   end
 end

data/lib/spree/testing_support/factories/product_factory.rb

@@ -1,13 +1,15 @@
 FactoryBot.define do
   factory :base_product, class: Spree::Product do
-    sequence(:name)   { |n| "Product ##{n} - #{Kernel.rand(9999)}" }
+    sequence(:name)   { |n| "Product #{n}#{Kernel.rand(9999)}" }
     description       { generate(:random_description) }
     price             { 19.99 }
     cost_price        { 17.00 }
     sku               { generate(:sku) }
     available_on      { 1.year.ago }
+    make_active_at    { 1.year.ago }
     deleted_at        { nil }
     shipping_category { |r| Spree::ShippingCategory.first || r.association(:shipping_category) }
+    status            { 'active' }
 
     # ensure stock item will be created for this products master
     # also attach this product to the default store if no stores are passed in
@@ -21,6 +23,9 @@ FactoryBot.define do
         product.stores << [store]
       end
     end
+    after(:create) do |product|
+      Spree::StockLocation.all.each { |stock_location| stock_location.propagate_variant(product.master) unless stock_location.stock_items.exists?(variant: product.master) }
+    end
 
     factory :custom_product do
       name  { 'Custom Product' }
@@ -47,6 +52,12 @@ FactoryBot.define do
       factory :product_with_option_types do
         after(:create) { |product| create(:product_option_type, product: product) }
       end
+      factory :product_with_properties do
+        after(:create) do |product|
+          create(:property, :brand, id: 10)
+          create(:product_property, product: product, property_id: 10, value: 'Epsilon')
+        end
+      end
     end
   end
 end

data/lib/spree/testing_support/factories/product_property_factory.rb

@@ -1,6 +1,7 @@
 FactoryBot.define do
   factory :product_property, class: Spree::ProductProperty do
     product { create(:product, stores: [create(:store)]) }
+    value { "val-#{rand(50)}" }
     property
   end
 end

data/lib/spree/testing_support/factories/product_translation_factory.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :product_translation, class: Spree::Product::Translation do
+    sequence(:name) { |n| "Product #{n}" }
+    description { generate(:random_description) }
+  end
+end

data/lib/spree/testing_support/factories/promotion_action_factory.rb

@@ -0,0 +1,5 @@
+FactoryBot.define do
+  factory :promotion_action, class: Spree::PromotionAction do
+    association :promotion
+  end
+end

data/lib/spree/testing_support/factories/refund_factory.rb

@@ -15,7 +15,7 @@ FactoryBot.define do
   end
 
   factory :refund_reason, class: Spree::RefundReason do
-    sequence(:name) { |n| "Refund for return ##{n}" }
+    sequence(:name) { |n| "Refund for return #{n}" }
     active  { true }
     mutable { false }
   end

data/lib/spree/testing_support/factories/reimbursement_credit_factory.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :reimbursement_credit, class: Spree::Reimbursement::Credit do
+    reimbursement
+
+    amount { 100.00 }
+  end
+end

data/lib/spree/testing_support/factories/return_authorization_factory.rb

@@ -14,7 +14,7 @@ FactoryBot.define do
   end
 
   factory :return_authorization_reason, class: Spree::ReturnAuthorizationReason do
-    sequence(:name) { |n| "Defect ##{n}" }
+    sequence(:name) { |n| "Defect #{n}" }
     active          { true }
     mutable         { false }
   end

data/lib/spree/testing_support/factories/role_factory.rb

@@ -1,6 +1,6 @@
 FactoryBot.define do
   factory :role, class: Spree::Role do
-    sequence(:name) { |n| "Role ##{n}" }
+    sequence(:name) { |n| "Role #{n}" }
 
     factory :admin_role do
       name { 'admin' }

data/lib/spree/testing_support/factories/shipping_category_factory.rb

@@ -1,5 +1,5 @@
 FactoryBot.define do
   factory :shipping_category, class: Spree::ShippingCategory do
-    sequence(:name) { |n| "ShippingCategory ##{n}" }
+    sequence(:name) { |n| "ShippingCategory #{n}" }
   end
 end

data/lib/spree/testing_support/factories/shipping_rate_factory.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :shipping_rate, class: Spree::ShippingRate do
+    cost { BigDecimal(10) }
+    shipping_method
+    shipment
+  end
+end

data/lib/spree/testing_support/factories/state_change_factory.rb

@@ -0,0 +1,8 @@
+FactoryBot.define do
+  factory :state_change, class: Spree::StateChange do
+    stateful { build(:order) }
+    previous_state { 'cart' }
+    next_state { 'address' }
+    user { build(:user) }
+  end
+end

data/lib/spree/testing_support/factories/stock_item_factory.rb

@@ -4,6 +4,13 @@ FactoryBot.define do
     stock_location
     variant
 
+    before(:create) do |stock_item|
+      Spree::StockItem.find_by(
+        variant: stock_item.variant,
+        stock_location: stock_item.stock_location
+      )&.destroy
+    end
+
     after(:create) { |object| object.adjust_count_on_hand(10) }
   end
 end

data/lib/spree/testing_support/factories/stock_location_factory.rb

@@ -7,6 +7,7 @@ FactoryBot.define do
     phone                 { '(202) 456-1111' }
     active                { true }
     backorderable_default { true }
+    propagate_all_variants { false }
 
     country  { |stock_location| Spree::Country.first || stock_location.association(:country) }
     state do |stock_location|
@@ -17,12 +18,12 @@ FactoryBot.define do
       after(:create) do |stock_location, _evaluator|
         # variant will add itself to all stock_locations in an after_create
         # creating a product will automatically create a master variant
-        store = create(:store)
+        store = Spree::Store.first || create(:store)
         product_1 = create(:product, stores: [store])
         product_2 = create(:product, stores: [store])
 
-        stock_location.stock_items.where(variant_id: product_1.master.id).first.adjust_count_on_hand(10)
-        stock_location.stock_items.where(variant_id: product_2.master.id).first.adjust_count_on_hand(20)
+        stock_location.stock_item_or_create(product_1.master).adjust_count_on_hand(10)
+        stock_location.stock_item_or_create(product_2.master).adjust_count_on_hand(20)
       end
     end
   end

data/lib/spree/testing_support/factories/stock_transfer_factory.rb

@@ -0,0 +1,9 @@
+FactoryBot.define do
+  factory :stock_transfer, class: Spree::StockTransfer do
+    destination_location {}
+    number {}
+    reference {}
+    source_location {}
+    type {}
+  end
+end

data/lib/spree/testing_support/factories/store_credit_factory.rb

@@ -8,7 +8,7 @@ FactoryBot.define do
     amount { 150.00 }
     currency { 'USD' }
     credit_type { create(:primary_credit_type) }
-    store { create(:store) }
+    store { Spree::Store.default || create(:store) }
   end
 
   factory :store_credits_order_without_user, class: Spree::Order do

data/lib/spree/testing_support/factories/store_credit_type_factory.rb

@@ -4,6 +4,11 @@ FactoryBot.define do
     priority  { '1' }
   end
 
+  factory :store_credit_type, class: Spree::StoreCreditType do
+    name      { Spree::StoreCreditType::DEFAULT_TYPE_NAME }
+    priority  { '1' }
+  end
+
   factory :secondary_credit_type, class: Spree::StoreCreditType do
     name      { 'Non-expiring' }
     priority  { '2' }

data/lib/spree/testing_support/factories/store_factory.rb

@@ -12,6 +12,7 @@ FactoryBot.define do
     facebook               { 'spreecommerce' }
     twitter                { 'spreecommerce' }
     instagram              { 'spreecommerce' }
+    meta_description       { 'Sample store description.' }
 
     trait :with_favicon do
       transient do
@@ -20,7 +21,7 @@ FactoryBot.define do
       end
 
       favicon_image do
-        Rack::Test::UploadedFile.new(filepath, image_type)
+        create(:favicon_image, attachment: Rack::Test::UploadedFile.new(filepath, image_type))
       end
     end
   end

data/lib/spree/testing_support/factories/tax_rate_factory.rb

@@ -1,5 +1,6 @@
 FactoryBot.define do
   factory :tax_rate, class: Spree::TaxRate do
+    name { "TaxRate - #{rand(999_999)}" }
     zone
     tax_category
     amount { 0.1 }

data/lib/spree/testing_support/factories/taxon_image_factory.rb

@@ -1,7 +1,9 @@
 FactoryBot.define do
   factory :taxon_image, class: Spree::TaxonImage do
     before(:create) do |taxon_image|
-      taxon_image.attachment.attach(io: File.new(Spree::Core::Engine.root + 'spec/fixtures/thinking-cat.jpg'), filename: 'thinking-cat.jpg')
+      if taxon_image.class.method_defined?(:attachment)
+        taxon_image.attachment.attach(io: File.new(Spree::Core::Engine.root + 'spec/fixtures/thinking-cat.jpg'), filename: 'thinking-cat.jpg')
+      end
     end
   end
 end

data/lib/spree/testing_support/factories/user_factory.rb

@@ -10,6 +10,12 @@ FactoryBot.define do
     password_confirmation { password }
     authentication_token  { generate(:user_authentication_token) } if Spree.user_class.attribute_method? :authentication_token
 
+    first_name { FFaker::Name.first_name }
+    last_name  { FFaker::Name.last_name }
+
+    public_metadata { {} }
+    private_metadata { {} }
+
     factory :admin_user do
       spree_roles { [Spree::Role.find_by(name: 'admin') || create(:role, name: 'admin')] }
     end

data/lib/spree/testing_support/factories/variant_factory.rb

@@ -18,9 +18,17 @@ FactoryBot.define do
     # ensure stock item will be created for this variant
     before(:create) { create(:stock_location) unless Spree::StockLocation.any? }
 
+    after(:create) do |variant|
+      Spree::StockLocation.all.each { |stock_location| stock_location.propagate_variant(variant) }
+    end
+
     factory :variant do
       # on_hand 5
       product { |p| p.association(:product, stores: [create(:store)]) }
+
+      factory :with_image_variant do
+        images { create_list(:image, 1) }
+      end
     end
 
     factory :master_variant do

data/lib/spree/testing_support/factories/wished_variant_factory.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :wished_item, class: Spree::WishedItem do
+    variant
+    wishlist
+  end
+end

data/lib/spree/testing_support/factories/wishlist_factory.rb

@@ -0,0 +1,18 @@
+FactoryBot.define do
+  factory :wishlist, class: Spree::Wishlist do
+    user
+
+    sequence(:name) { |n| "Wishlist_#{n}" }
+    is_private { true }
+    is_default { false }
+
+    before(:create) do |wishlist|
+      if wishlist.store.nil?
+        default_store = Spree::Store.default.persisted? ? Spree::Store.default : nil
+        store = default_store || create(:store)
+
+        wishlist.store = store
+      end
+    end
+  end
+end

data/lib/spree/testing_support/jobs.rb

@@ -0,0 +1,9 @@
+RSpec.configure do |config|
+  config.before(:each, :job) do
+    ActiveJob::Base.queue_adapter = :test
+  end
+
+  config.after(:each, :job) do
+    ActiveJob::Base.queue_adapter = :inline
+  end
+end

data/lib/spree/testing_support/metadata.rb

@@ -0,0 +1,54 @@
+shared_examples_for 'metadata' do |factory: described_class.name.demodulize.underscore.to_sym|
+  subject { FactoryBot.create(factory) }
+
+  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).to eq({}) }
+  it { expect(subject.private_metadata).to eq({}) }
+
+  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']
+    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 '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

data/lib/spree/translation_migrations.rb

@@ -0,0 +1,40 @@
+module Spree
+  class TranslationMigrations
+    def initialize(resource_class, default_locale)
+      @resource_class = resource_class
+      @translations_table = resource_class::Translation.table_name
+      @translatable_fields = resource_class.translatable_fields.join(', ')
+      @foreign_key = "#{resource_class.table_name.singularize}_id"
+      @default_locale = default_locale
+    end
+
+    def transfer_translation_data
+      nullify_translatable_fields = @resource_class.translatable_fields.map { |f| "#{f}=null" }.join(', ')
+
+      unless @resource_class::Translation.exists?
+        ActiveRecord::Base.connection.execute("
+          INSERT INTO #{@translations_table} (#{@translatable_fields}, #{@foreign_key}, locale, created_at, updated_at)
+          SELECT #{@translatable_fields}, id, '#{@default_locale}' as locale, created_at, updated_at FROM #{@resource_class.table_name};
+                                              ")
+        ActiveRecord::Base.connection.execute("
+          UPDATE #{@resource_class.table_name}
+          SET #{nullify_translatable_fields};
+                                              ")
+      end
+    end
+
+    def revert_translation_data_transfer
+      translation_table_fields = @resource_class.translatable_fields.map { |f| "#{@translations_table}.#{f}" }.join(', ')
+      row_expression = @resource_class.translatable_fields.count == 1 ? 'ROW' : ''
+
+      ActiveRecord::Base.connection.execute("
+          UPDATE #{@resource_class.table_name}
+          SET (#{@translatable_fields}) = #{row_expression}(#{translation_table_fields})
+          FROM #{@translations_table}
+          WHERE #{@translations_table}.#{@foreign_key} = #{@resource_class.table_name}.id
+                                            ")
+
+      ActiveRecord::Base.connection.execute("TRUNCATE TABLE #{@translations_table}")
+    end
+  end
+end

data/lib/spree_core.rb

@@ -1,2 +1,4 @@
-require 'friendly_id/slug_rails5_patch'
+require 'friendly_id/paranoia'
+require 'mobility/plugins/store_based_fallbacks'
+
 require 'spree/core'