spree_core 4.4.0 → 4.5.0

data/lib/spree/core/engine.rb

@@ -1,3 +1,6 @@
+require_relative 'dependencies'
+require_relative 'configuration'
+
 module Spree
   module Core
     class Engine < ::Rails::Engine
@@ -19,13 +22,44 @@ module Spree
       end
 
       initializer 'spree.environment', before: :load_config_initializers do |app|
-        app.config.spree = Environment.new(SpreeCalculators.new, Spree::AppConfiguration.new, Spree::AppDependencies.new)
+        app.config.spree = Environment.new(SpreeCalculators.new, Spree::Core::Configuration.new, Spree::Core::Dependencies.new)
+        app.config.active_record.yaml_column_permitted_classes = [Symbol, BigDecimal]
         Spree::Config = app.config.spree.preferences
         Spree::Dependencies = app.config.spree.dependencies
       end
 
-      initializer 'spree.register.calculators' do |app|
-        app.config.spree.calculators.shipping_methods = [
+      initializer 'spree.register.calculators', before: :after_initialize do |app|
+      end
+
+      initializer 'spree.register.stock_splitters', before: :load_config_initializers do |app|
+      end
+
+      initializer 'spree.register.line_item_comparison_hooks', before: :load_config_initializers do |app|
+        app.config.spree.line_item_comparison_hooks = Set.new
+      end
+
+      initializer 'spree.register.payment_methods', after: 'acts_as_list.insert_into_active_record' do |app|
+      end
+
+      initializer 'spree.register.adjustable_adjusters' do |app|
+      end
+
+      # We need to define promotions rules here so extensions and existing apps
+      # can add their custom classes on their initializer files
+      initializer 'spree.promo.environment' do |app|
+        app.config.spree.promotions = PromoEnvironment.new
+        app.config.spree.promotions.rules = []
+      end
+
+      initializer 'spree.promo.register.promotion.calculators' do |app|
+      end
+
+      # Promotion rules need to be evaluated on after initialize otherwise
+      # Spree.user_class would be nil and users might experience errors related
+      # to malformed model associations (Spree.user_class is only defined on
+      # the app initializer)
+      config.after_initialize do
+        Rails.application.config.spree.calculators.shipping_methods = [
           Spree::Calculator::Shipping::FlatPercentItemTotal,
           Spree::Calculator::Shipping::FlatRate,
           Spree::Calculator::Shipping::FlexiRate,
@@ -34,48 +68,29 @@ module Spree
           Spree::Calculator::Shipping::DigitalDelivery,
         ]
 
-        app.config.spree.calculators.tax_rates = [
+        Rails.application.config.spree.calculators.tax_rates = [
           Spree::Calculator::DefaultTax
         ]
-      end
 
-      initializer 'spree.register.stock_splitters', before: :load_config_initializers do |app|
-        app.config.spree.stock_splitters = [
+        Rails.application.config.spree.stock_splitters = [
           Spree::Stock::Splitter::ShippingCategory,
           Spree::Stock::Splitter::Backordered,
           Spree::Stock::Splitter::Digital
         ]
-      end
-
-      initializer 'spree.register.line_item_comparison_hooks', before: :load_config_initializers do |app|
-        app.config.spree.line_item_comparison_hooks = Set.new
-      end
 
-      initializer 'spree.register.payment_methods', after: 'acts_as_list.insert_into_active_record' do |app|
-        app.config.spree.payment_methods = [
+        Rails.application.config.spree.payment_methods = [
           Spree::Gateway::Bogus,
           Spree::Gateway::BogusSimple,
           Spree::PaymentMethod::Check,
           Spree::PaymentMethod::StoreCredit
         ]
-      end
 
-      initializer 'spree.register.adjustable_adjusters' do |app|
-        app.config.spree.adjusters = [
+        Rails.application.config.spree.adjusters = [
           Spree::Adjustable::Adjuster::Promotion,
           Spree::Adjustable::Adjuster::Tax
         ]
-      end
-
-      # We need to define promotions rules here so extensions and existing apps
-      # can add their custom classes on their initializer files
-      initializer 'spree.promo.environment' do |app|
-        app.config.spree.promotions = PromoEnvironment.new
-        app.config.spree.promotions.rules = []
-      end
 
-      initializer 'spree.promo.register.promotion.calculators' do |app|
-        app.config.spree.calculators.promotion_actions_create_adjustments = [
+        Rails.application.config.spree.calculators.promotion_actions_create_adjustments = [
           Spree::Calculator::FlatPercentItemTotal,
           Spree::Calculator::FlatRate,
           Spree::Calculator::FlexiRate,
@@ -83,18 +98,12 @@ module Spree
           Spree::Calculator::TieredFlatRate
         ]
 
-        app.config.spree.calculators.promotion_actions_create_item_adjustments = [
+        Rails.application.config.spree.calculators.promotion_actions_create_item_adjustments = [
           Spree::Calculator::PercentOnLineItem,
           Spree::Calculator::FlatRate,
           Spree::Calculator::FlexiRate
         ]
-      end
 
-      # Promotion rules need to be evaluated on after initialize otherwise
-      # Spree.user_class would be nil and users might experience errors related
-      # to malformed model associations (Spree.user_class is only defined on
-      # the app initializer)
-      config.after_initialize do
         Rails.application.config.spree.promotions.rules.concat [
           Spree::Promotion::Rules::ItemTotal,
           Spree::Promotion::Rules::Product,
@@ -106,10 +115,8 @@ module Spree
           Spree::Promotion::Rules::OptionValue,
           Spree::Promotion::Rules::Country
         ]
-      end
 
-      initializer 'spree.promo.register.promotions.actions' do |app|
-        app.config.spree.promotions.actions = [
+        Rails.application.config.spree.promotions.actions = [
           Promotion::Actions::CreateAdjustment,
           Promotion::Actions::CreateItemAdjustments,
           Promotion::Actions::CreateLineItems,
@@ -117,6 +124,9 @@ module Spree
         ]
       end
 
+      initializer 'spree.promo.register.promotions.actions' do |app|
+      end
+
       # filter sensitive information during logging
       initializer 'spree.params.filter' do |app|
         app.config.filter_parameters += [

data/{app/models/spree → lib/spree/core}/preferences/configuration.rb

@@ -20,6 +20,9 @@
 # a.preferred_color
 #
 #
+
+require 'spree/core/preferences/preferable'
+
 module Spree::Preferences
   class Configuration
     include Spree::Preferences::Preferable

data/{app/models/spree → lib/spree/core}/preferences/preferable.rb

@@ -31,6 +31,9 @@
 #
 #   # Save the changes. All handled by activerecord
 #   s.save!
+
+require 'spree/core/preferences/preferable_class_methods'
+
 module Spree::Preferences::Preferable
   extend ActiveSupport::Concern
 

data/lib/spree/core/search/base.rb

@@ -30,7 +30,13 @@ module Spree
         def extended_base_scope
           base_scope = current_store.products.spree_base_scopes
           base_scope = get_products_conditions_for(base_scope, keywords)
-          base_scope = Spree::Dependencies.products_finder.constantize.new(
+          base_scope = Spree::Dependencies.products_finder.constantize.new(**product_finder_params(base_scope)).execute
+          base_scope = add_search_scopes(base_scope)
+          add_eagerload_scopes(base_scope)
+        end
+
+        def product_finder_params(base_scope)
+          {
             scope: base_scope,
             params: {
               store: current_store,
@@ -43,9 +49,7 @@ module Spree
               },
               sort_by: sort_by
             }
-          ).execute
-          base_scope = add_search_scopes(base_scope)
-          add_eagerload_scopes(base_scope)
+          }
         end
 
         def add_eagerload_scopes(scope)
@@ -101,7 +105,7 @@ module Spree
             high_price = Monetize.parse(price_param.remove("#{less_than_string} ")).to_i
           else
             low_price, high_price = Monetize.parse_collection(price_param).map(&:to_i)
-            high_price = Float::INFINITY if high_price&.zero?
+            high_price = BigDecimal::INFINITY if high_price&.zero?
           end
 
           "#{low_price},#{high_price}"

data/lib/spree/core/version.rb

@@ -1,5 +1,5 @@
 module Spree
-  VERSION = '4.4.0'.freeze
+  VERSION = '4.5.0'.freeze
 
   def self.version
     VERSION

data/lib/spree/core.rb

@@ -14,7 +14,6 @@ require 'friendly_id'
 require 'kaminari'
 require 'monetize'
 require 'paranoia'
-require 'mini_magick'
 require 'ransack'
 require 'state_machines-activerecord'
 require 'active_storage_validations'
@@ -25,7 +24,8 @@ require 'activerecord-typedstore'
 StateMachines::Machine.ignore_method_conflicts = true
 
 module Spree
-  mattr_accessor :user_class, :admin_user_class, :private_storage_service_name
+  mattr_accessor :user_class, :admin_user_class, :private_storage_service_name,
+                 :public_storage_service_name, :cdn_host, :searcher_class
 
   def self.user_class(constantize: true)
     if @@user_class.is_a?(Class)
@@ -55,6 +55,26 @@ module Spree
     end
   end
 
+  def self.public_storage_service_name
+    if @@public_storage_service_name
+      if @@public_storage_service_name.is_a?(String) || @@public_storage_service_name.is_a?(Symbol)
+        @@public_storage_service_name.to_sym
+      else
+        raise 'Spree.public_storage_service_name MUST be a String or Symbol object.'
+      end
+    end
+  end
+
+  def self.searcher_class(constantize: true)
+    @@searcher_class ||= 'Spree::Core::Search::Base'
+
+    if @@searcher_class.is_a?(Class)
+      raise 'Spree.searcher_class MUST be a String or Symbol object, not a Class object.'
+    elsif @@searcher_class.is_a?(String) || @@searcher_class.is_a?(Symbol)
+      constantize ? @@searcher_class.to_s.constantize : @@searcher_class.to_s
+    end
+  end
+
   # Used to configure Spree.
   #
   # Example:
@@ -105,9 +125,6 @@ require 'spree/permitted_attributes'
 require 'spree/service_module'
 require 'spree/database_type_utilities'
 
-require 'spree/core/dependencies_helper'
-require 'spree/core/app_dependencies'
-
 require 'spree/core/importer'
 require 'spree/core/query_filters'
 require 'spree/core/product_duplicator'
@@ -119,3 +136,6 @@ require 'spree/core/controller_helpers/store'
 require 'spree/core/controller_helpers/strong_parameters'
 require 'spree/core/controller_helpers/locale'
 require 'spree/core/controller_helpers/currency'
+
+require 'spree/core/preferences/store'
+require 'spree/core/preferences/scoped_store'

data/lib/spree/permitted_attributes.rb

@@ -89,7 +89,7 @@ module Spree
     @@product_properties_attributes = [:property_name, :value, :position]
 
     @@product_attributes = [
-      :name, :description, :available_on, :discontinue_on, :permalink, :meta_description,
+      :name, :description, :available_on, :make_active_at, :discontinue_on, :permalink, :meta_description,
       :meta_keywords, :price, :sku, :deleted_at, :prototype_id,
       :option_values_hash, :weight, :height, :width, :depth,
       :shipping_category_id, :tax_category_id,
@@ -126,14 +126,15 @@ module Spree
       :quantity, :stock_item, :stock_item_id, :originator, :action
     ]
 
-    @@store_attributes = [:name, :url, :seo_title, :code, :meta_keywords, :logo,
+    @@store_attributes = [:name, :url, :seo_title, :code, :meta_keywords,
                           :meta_description, :default_currency, :mail_from_address,
                           :customer_support_email, :facebook, :twitter, :instagram,
                           :description, :address, :contact_phone, :supported_locales,
                           :default_locale, :default_country_id, :supported_currencies,
-                          :new_order_notifications_email, :mailer_logo, :favicon_image,
-                          :checkout_zone_id, :seo_robots, :digital_asset_authorized_clicks,
-                          :digital_asset_authorized_days, :limit_digital_download_count, :limit_digital_download_days]
+                          :new_order_notifications_email, :checkout_zone_id, :seo_robots,
+                          :digital_asset_authorized_clicks, :digital_asset_authorized_days,
+                          :limit_digital_download_count, :limit_digital_download_days, :digital_asset_link_expire_time,
+                          { mailer_logo_attributes: {}, favicon_image_attributes: {}, logo_attributes: {} }]
 
     @@store_credit_attributes = %i[amount currency category_id memo]
 
@@ -145,13 +146,14 @@ module Spree
     ]
 
     # TODO: Should probably use something like Spree.user_class.attributes
-    @@user_attributes = [:email, :bill_address_id, :ship_address_id, :password, :password_confirmation, { public_metadata: {}, private_metadata: {} }]
+    @@user_attributes = [:email, :bill_address_id, :ship_address_id, :password, :first_name, :last_name,
+                         :password_confirmation, { public_metadata: {}, private_metadata: {} }]
 
     @@variant_attributes = [
       :name, :presentation, :cost_price, :discontinue_on, :lock_version,
       :position, :track_inventory,
       :product_id, :product, :option_values_attributes, :price, :compare_at_price,
-      :weight, :height, :width, :depth, :sku, :cost_currency,
+      :weight, :height, :width, :depth, :sku, :barcode, :cost_currency,
       { options: [:name, :value], option_value_ids: [] }
     ]
 

data/lib/spree/testing_support/common_rake.rb

@@ -44,6 +44,7 @@ namespace :common do
     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

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/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/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!

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' }

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/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/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/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|
@@ -21,8 +22,8 @@ FactoryBot.define do
         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/store_factory.rb

@@ -20,7 +20,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/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

@@ -9,6 +9,10 @@ FactoryBot.define do
     password              { 'secret' }
     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 { {} }
 

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

@@ -18,6 +18,10 @@ 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)]) }

data/lib/spree_core.rb

@@ -1,2 +1,3 @@
-require 'friendly_id/slug_rails5_patch'
+require 'friendly_id/paranoia'
+
 require 'spree/core'

data/lib/tasks/core.rake

@@ -185,3 +185,15 @@ use rake db:load_file[/absolute/path/to/sample/filename.rb]}
     end
   end
 end
+
+namespace :core do
+  desc 'Set "active" status on draft products where make_active_at is in the past'
+  task activate_products: :environment do |_t, _args|
+    Spree::Product.where('make_active_at <= ?', Time.current).where(status: 'draft').update_all(status: 'active', updated_at: Time.current)
+  end
+
+  desc 'Set "archived" status on active products where discontinue_on is in the past'
+  task archive_products: :environment do |_t, _args|
+    Spree::Product.where('discontinue_on <= ?', Time.current).where.not(status: 'archived').update_all(status: 'archived', updated_at: Time.current)
+  end
+end

data/spree_core.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |s|
     actionpack actionview activejob activemodel activerecord
     activestorage activesupport railties
   ].each do |rails_gem|
-    s.add_dependency rails_gem, '>= 5.2'
+    s.add_dependency rails_gem, '>= 6.1'
   end
 
   s.add_dependency 'activemerchant', '~> 1.67'
@@ -45,13 +45,12 @@ Gem::Specification.new do |s|
   s.add_dependency 'money', '~> 6.13'
   s.add_dependency 'monetize', '~> 1.9'
   s.add_dependency 'paranoia', '~> 2.4'
-  s.add_dependency 'ransack', '~> 2.3'
+  s.add_dependency 'ransack', '>= 2.3', '< 3.0'
   s.add_dependency 'rexml'
   s.add_dependency 'state_machines-activerecord', '~> 0.6'
   s.add_dependency 'state_machines-activemodel', '~> 0.7'
   s.add_dependency 'stringex'
   s.add_dependency 'validates_zipcode'
-  s.add_dependency 'mini_magick', '~> 4.9', '>= 4.9.4'
   s.add_dependency 'image_processing', '~> 1.2'
   s.add_dependency 'active_storage_validations', '~> 0.9', '<= 0.9.5'
   s.add_dependency 'activerecord-typedstore'