spree_core 4.0.0 → 4.5.1

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

@@ -2,25 +2,19 @@ module Spree
   module Core
     module Search
       class Base
-        attr_accessor :properties
-        attr_accessor :current_user
-        attr_accessor :current_currency
+        attr_accessor :properties, :current_user, :current_currency, :current_store, :taxon
 
         def initialize(params)
-          self.current_currency = Spree::Config[:currency]
           @properties = {}
+          @current_store = params[:current_store] || Spree::Store.default
+          @current_currency = @current_store.default_currency
+          @taxon = params[:taxon]
+
           prepare(params)
         end
 
         def retrieve_products
-          @products = get_base_scope
-          curr_page = page || 1
-
-          unless Spree::Config.show_products_without_price
-            @products = @products.where('spree_prices.amount IS NOT NULL').
-                        where('spree_prices.currency' => current_currency)
-          end
-          @products = @products.page(curr_page).per(per_page)
+          @products = extended_base_scope.page(page || 1).per(per_page)
         end
 
         def method_missing(name)
@@ -33,41 +27,49 @@ module Spree
 
         protected
 
-        def get_base_scope
-          base_scope = Spree::Product.spree_base_scopes.active
-          base_scope = base_scope.in_taxon(taxon) unless taxon.blank?
+        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(**product_finder_params(base_scope)).execute
           base_scope = add_search_scopes(base_scope)
-          base_scope = add_eagerload_scopes(base_scope)
-          base_scope
+          add_eagerload_scopes(base_scope)
+        end
+
+        def product_finder_params(base_scope)
+          {
+            scope: base_scope,
+            params: {
+              store: current_store,
+              filter: {
+                price: price,
+                option_value_ids: option_value_ids,
+                properties: product_properties,
+                taxons: taxon&.id,
+                currency: current_currency
+              },
+              sort_by: sort_by
+            }
+          }
         end
 
         def add_eagerload_scopes(scope)
-          # TL;DR Switch from `preload` to `includes` as soon as Rails starts honoring
-          # `order` clauses on `has_many` associations when a `where` constraint
-          # affecting a joined table is present (see
-          # https://github.com/rails/rails/issues/6769).
-          #
-          # Ideally this would use `includes` instead of `preload` calls, leaving it
-          # up to Rails whether associated objects should be fetched in one big join
-          # or multiple independent queries. However as of Rails 4.1.8 any `order`
-          # defined on `has_many` associations are ignored when Rails builds a join
-          # query.
-          #
-          # Would we use `includes` in this particular case, Rails would do
-          # separate queries most of the time but opt for a join as soon as any
-          # `where` constraints affecting joined tables are added to the search;
-          # which is the case as soon as a taxon is added to the base scope.
-          scope = scope.preload(:tax_category)
-          scope = scope.preload(master: :prices)
-          scope = scope.preload(master: :images) if include_images
-          scope
+          scope.includes(
+            :tax_category,
+            variants: [
+              { images: { attachment_attachment: :blob } }
+            ],
+            master: [
+              :prices,
+              { images: { attachment_attachment: :blob } }
+            ]
+          )
         end
 
         def add_search_scopes(base_scope)
           if search.is_a?(ActionController::Parameters)
             search.each do |name, scope_attribute|
               scope_name = name.to_sym
+
               base_scope = if base_scope.respond_to?(:search_scopes) && base_scope.search_scopes.include?(scope_name.to_sym)
                              base_scope.send(scope_name, *scope_attribute)
                            else
@@ -81,15 +83,48 @@ module Spree
         # method should return new scope based on base_scope
         def get_products_conditions_for(base_scope, query)
           unless query.blank?
-            base_scope = base_scope.like_any([:name, :description], query.split)
+            base_scope = base_scope.like_any([:name, :description], [query])
+          end
+          base_scope
+        end
+
+        def get_products_option_values_conditions(base_scope, option_value_ids)
+          unless option_value_ids.blank?
+            base_scope = base_scope.joins(variants: :option_values).where(spree_option_values: { id: option_value_ids })
           end
           base_scope
         end
 
+        def get_price_range(price_param)
+          return if price_param.blank?
+
+          less_than_string = I18n.t('activerecord.attributes.spree/product.less_than')
+
+          if price_param.include? less_than_string
+            low_price = 0
+            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 = BigDecimal::INFINITY if high_price&.zero?
+          end
+
+          "#{low_price},#{high_price}"
+        end
+
+        def build_option_value_ids(params)
+          filter_params = Spree::OptionType.filterable.map(&:filter_param)
+
+          filter_params.reduce([]) do |acc, filter_param|
+            acc + params[filter_param].to_s.split(',')
+          end
+        end
+
         def prepare(params)
-          @properties[:taxon] = params[:taxon].blank? ? nil : Spree::Taxon.find(params[:taxon])
           @properties[:keywords] = params[:keywords]
+          @properties[:option_value_ids] = build_option_value_ids(params)
+          @properties[:price] = get_price_range(params[:price])
           @properties[:search] = params[:search]
+          @properties[:sort_by] = params[:sort_by] || 'default'
           @properties[:include_images] = params[:include_images]
 
           per_page = params[:per_page].to_i
@@ -99,6 +134,7 @@ module Spree
                                else
                                  1
                                end
+          @properties[:product_properties] = params[:properties]
         end
       end
     end

data/lib/spree/core/version.rb

@@ -1,5 +1,7 @@
 module Spree
+  VERSION = '4.5.1'.freeze
+
   def self.version
-    '4.0.0'
+    VERSION
   end
 end

data/lib/spree/core.rb

@@ -1,25 +1,31 @@
-require 'rails/all'
+require 'action_controller/railtie'
+require 'action_view/railtie'
+require 'active_job/railtie'
+require 'active_model/railtie'
+require 'active_record/railtie'
+require 'active_storage/engine'
+
 require 'active_merchant'
 require 'acts_as_list'
+require 'auto_strip_attributes'
 require 'awesome_nested_set'
 require 'cancan'
 require 'friendly_id'
 require 'kaminari'
-require 'mail'
 require 'monetize'
 require 'paranoia'
-require 'mini_magick'
-require 'premailer/rails'
 require 'ransack'
-require 'responders'
 require 'state_machines-activerecord'
+require 'active_storage_validations'
+require 'activerecord-typedstore'
 
 # This is required because ActiveModel::Validations#invalid? conflicts with the
 # invalid state of a Payment. In the future this should be removed.
 StateMachines::Machine.ignore_method_conflicts = true
 
 module Spree
-  mattr_accessor :user_class
+  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)
@@ -29,19 +35,44 @@ module Spree
     end
   end
 
-  def self.admin_path
-    Spree::Config[:admin_path]
+  def self.admin_user_class(constantize: true)
+    @@admin_user_class ||= @@user_class
+
+    if @@admin_user_class.is_a?(Class)
+      raise 'Spree.admin_user_class MUST be a String or Symbol object, not a Class object.'
+    elsif @@admin_user_class.is_a?(String) || @@admin_user_class.is_a?(Symbol)
+      constantize ? @@admin_user_class.to_s.constantize : @@admin_user_class.to_s
+    end
   end
 
-  # Used to configure admin_path for Spree
-  #
-  # Example:
-  #
-  # write the following line in `config/initializers/spree.rb`
-  #   Spree.admin_path = '/custom-path'
+  def self.private_storage_service_name
+    if @@private_storage_service_name
+      if @@private_storage_service_name.is_a?(String) || @@private_storage_service_name.is_a?(Symbol)
+        @@private_storage_service_name.to_sym
+      else
+        raise 'Spree.private_storage_service_name MUST be a String or Symbol object.'
+      end
+    end
+  end
 
-  def self.admin_path=(path)
-    Spree::Config[:admin_path] = path
+  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.
@@ -92,7 +123,7 @@ require 'spree/localized_number'
 require 'spree/money'
 require 'spree/permitted_attributes'
 require 'spree/service_module'
-require 'spree/dependencies_helper'
+require 'spree/database_type_utilities'
 
 require 'spree/core/importer'
 require 'spree/core/query_filters'
@@ -103,3 +134,8 @@ require 'spree/core/controller_helpers/order'
 require 'spree/core/controller_helpers/search'
 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/database_type_utilities.rb

@@ -0,0 +1,12 @@
+module Spree
+  module DatabaseTypeUtilities
+    def self.maximum_value_for(data_type)
+      case data_type
+      when :integer
+        ActiveModel::Type::Integer.new.instance_eval { range.max }
+      else
+        raise ArgumentError, 'Currently only :integer argument is acceptable'
+      end
+    end
+  end
+end

data/lib/spree/i18n.rb

@@ -1,35 +1,33 @@
 require 'i18n'
 require 'active_support/core_ext/array/extract_options'
-require 'spree/i18n/base'
+require 'action_view'
 
 module Spree
-  extend ActionView::Helpers::TranslationHelper
-  extend ActionView::Helpers::TagHelper
+  class TranslationHelperWrapper
+    include ActionView::Helpers::TranslationHelper
+  end
 
   class << self
     # Add spree namespace and delegate to Rails TranslationHelper for some nice
     # extra functionality. e.g return reasonable strings for missing translations
-    def translate(*args)
-      @virtual_path = virtual_path
+    def translate(key, options = {})
+      options[:scope] = [*options[:scope]].unshift(:spree).uniq
 
-      options = args.extract_options!
-      options[:scope] = [*options[:scope]].unshift(:spree)
-      args << options
-      super(*args)
+      TranslationHelperWrapper.new.translate(key, **options)
     end
 
-    alias t translate
+    def available_locales
+      locales_from_i18n = I18n.available_locales
+      locales =
+        if defined?(SpreeI18n)
+          (SpreeI18n::Locale.all << :en).map(&:to_sym)
+        else
+          [Rails.application.config.i18n.default_locale, I18n.locale, :en]
+        end
 
-    def context
-      Spree::ViewContext.context
+      (locales + locales_from_i18n).uniq.compact
     end
 
-    def virtual_path
-      if context
-        path = context.instance_variable_get('@virtual_path')
-
-        path&.gsub(/spree/, '')
-      end
-    end
+    alias t translate
   end
 end

data/lib/spree/money.rb

@@ -1,10 +1,11 @@
 require 'money'
 
 Money.locale_backend = :i18n
+Money.rounding_mode = BigDecimal::ROUND_HALF_UP
 
 module Spree
   class Money
-    class <<self
+    class << self
       attr_accessor :default_formatting_rules
     end
 
@@ -15,10 +16,12 @@ module Spree
     }
 
     attr_reader :money
+
     delegate    :cents, :currency, to: :money
 
     def initialize(amount, options = {})
-      @money   = Monetize.parse([amount, (options[:currency] || Spree::Config[:currency])].join)
+      use_default_currency
+      @money   = Monetize.parse([amount, (options[:currency] || Spree::Store.default.default_currency)].join)
       @options = Spree::Money.default_formatting_rules.merge(options)
     end
 
@@ -27,7 +30,7 @@ module Spree
     end
 
     def to_s
-      money.format(options)
+      money&.format(options)
     end
 
     # 1) prevent blank, breaking spaces
@@ -62,6 +65,11 @@ module Spree
       money == obj.money
     end
 
+    def use_default_currency
+      currency = Spree::Store.default.default_currency
+      ::Money.default_currency = currency
+    end
+
     private
 
     attr_reader :options

data/lib/spree/permitted_attributes.rb

@@ -3,10 +3,17 @@ module Spree
     ATTRIBUTES = [
       :address_attributes,
       :checkout_attributes,
+      :classification_attributes,
+      :cms_page_attributes,
+      :cms_section_attributes,
       :customer_return_attributes,
+      :digital_attributes,
+      :digital_link_attributes,
       :image_attributes,
       :inventory_unit_attributes,
       :line_item_attributes,
+      :menu_attributes,
+      :menu_item_attributes,
       :option_type_attributes,
       :option_value_attributes,
       :payment_attributes,
@@ -24,26 +31,43 @@ module Spree
       :taxon_attributes,
       :taxonomy_attributes,
       :user_attributes,
-      :variant_attributes
+      :variant_attributes,
+      :wishlist_attributes,
+      :wished_item_attributes
     ]
 
-    mattr_reader *ATTRIBUTES
+    mattr_reader(*ATTRIBUTES)
 
     @@address_attributes = [
       :id, :firstname, :lastname, :first_name, :last_name,
       :address1, :address2, :city, :country_iso, :country_id, :state_id,
       :zipcode, :phone, :state_name, :alternative_phone, :company,
-      :user_id, :deleted_at,
-      country: [:iso, :name, :iso3, :iso_name],
-      state: [:name, :abbr]
+      :user_id, :deleted_at, :label,
+      { country: [:iso, :name, :iso3, :iso_name],
+        state: [:name, :abbr] }
     ]
 
     @@checkout_attributes = [
-      :coupon_code, :email, :shipping_method_id, :special_instructions, :use_billing, 
+      :coupon_code, :email, :shipping_method_id, :special_instructions, :use_billing,
       :user_id, :bill_address_id, :ship_address_id
     ]
 
-    @@customer_return_attributes = [:stock_location_id, return_items_attributes: [:id, :inventory_unit_id, :return_authorization_id, :returned, :pre_tax_amount, :acceptance_status, :exchange_variant_id, :resellable]]
+    @@classification_attributes = [
+      :position, :taxon_id, :product_id
+    ]
+
+    @@cms_page_attributes = [:title, :meta_title, :content, :meta_description, :visible, :slug, :locale]
+
+    @@cms_section_attributes = [:name, :cms_page_id, :fit, :destination, { content: {}, settings: {} }]
+
+    @@customer_return_attributes = [:stock_location_id, {
+      return_items_attributes: [:id, :inventory_unit_id, :return_authorization_id, :returned, :pre_tax_amount,
+                                :acceptance_status, :exchange_variant_id, :resellable]
+    }]
+
+    @@digital_attributes = [:attachment, :variant_id]
+
+    @@digital_link_attributes = [:access_counter]
 
     @@image_attributes = [:alt, :attachment, :position, :viewable_type, :viewable_id]
 
@@ -51,6 +75,11 @@ module Spree
 
     @@line_item_attributes = [:id, :variant_id, :quantity]
 
+    @@menu_attributes = [:name, :locale, :location]
+
+    @@menu_item_attributes = [:name, :subtite, :destination, :new_window, :item_type,
+                              :linked_resource_type, :linked_resource_id, :code, :menu_id]
+
     @@option_type_attributes = [:name, :presentation, :option_values_attributes]
 
     @@option_value_attributes = [:name, :presentation]
@@ -60,17 +89,18 @@ 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,
-      :cost_currency, :cost_price,
-      option_type_ids: [], taxon_ids: []
+      :cost_currency, :cost_price, :compare_at_price,
+      { option_type_ids: [], taxon_ids: [] }
     ]
 
     @@property_attributes = [:name, :presentation]
 
-    @@return_authorization_attributes = [:amount, :memo, :stock_location_id, :inventory_units_attributes, :return_authorization_reason_id]
+    @@return_authorization_attributes = [:amount, :memo, :stock_location_id, :inventory_units_attributes,
+                                         :return_authorization_reason_id]
 
     @@shipment_attributes = [
       :order, :special_instructions, :stock_location_id, :id,
@@ -97,26 +127,38 @@ module Spree
     ]
 
     @@store_attributes = [:name, :url, :seo_title, :code, :meta_keywords,
-                          :meta_description, :default_currency, :mail_from_address]
+                          :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, :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]
 
     @@taxonomy_attributes = [:name]
 
     @@taxon_attributes = [
-      :name, :parent_id, :position, :icon, :description, :permalink, :taxonomy_id,
-      :meta_description, :meta_keywords, :meta_title, :child_index
+      :name, :parent_id, :position, :icon, :description, :permalink, :hide_from_nav,
+      :taxonomy_id, :meta_description, :meta_keywords, :meta_title, :child_index
     ]
 
     # TODO: Should probably use something like Spree.user_class.attributes
-    @@user_attributes = [:email, :password, :password_confirmation]
+    @@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,
-      :weight, :height, :width, :depth, :sku, :cost_currency,
-      options: [:name, :value], option_value_ids: []
+      :product_id, :product, :option_values_attributes, :price, :compare_at_price,
+      :weight, :height, :width, :depth, :sku, :barcode, :cost_currency,
+      { options: [:name, :value], option_value_ids: [] }
     ]
+
+    @@wishlist_attributes = [:name, :is_default, :is_private]
+
+    @@wished_item_attributes = [:variant_id, :quantity]
   end
 end

data/lib/spree/service_module.rb

@@ -1,8 +1,8 @@
 module Spree
   module ServiceModule
     module Callable
-      def call(*args)
-        new.call(*args).tap do |result|
+      def call(*args, **kwargs)
+        new.call(*args, **kwargs).tap do |result|
           return yield(result) if block_given?
         end
       end
@@ -47,7 +47,11 @@ module Spree
       def call(input = nil)
         input ||= {}
         @_passed_input = Result.new(true, input)
-        result = super
+        result = if input.is_a?(Hash)
+                   super(**input)
+                 else
+                   super(input)
+                 end
         @_passed_input = result if result.is_a? Result
         enforce_data_format
         @_passed_input
@@ -71,7 +75,7 @@ module Spree
         end
 
         begin
-          @_passed_input = callable.call(@_passed_input.value)
+          @_passed_input = callable.call(**@_passed_input.value)
         rescue ArgumentError => e
           if e.message.include? 'missing'
             raise IncompatibleParamsPassed, "You didn't pass #{e.message} to callable '#{callable.name}'"

data/lib/spree/testing_support/authorization_helpers.rb

@@ -27,29 +27,37 @@ module Spree
 
         def stub_authorization!
           ability = build_ability
+          ability_class = Spree::Dependencies.ability_class.constantize
 
           after(:all) do
-            Spree::Ability.remove_ability(ability)
+            ability_class.remove_ability(ability)
           end
 
           before(:all) do
-            Spree::Ability.register_ability(ability)
+            ability_class.register_ability(ability)
           end
 
+          let(:admin_app) { Spree::OauthApplication.create!(name: 'Admin Panel', scopes: 'admin') }
+          let(:admin_token) { Spree::OauthAccessToken.create!(application: admin_app, scopes: 'admin').token }
+
           before do
-            allow(Spree.user_class).to receive(:find_by).
-              with(hash_including(:spree_api_key)).
-              and_return(Spree.user_class.new)
+            allow(Spree.user_class).to receive(:find_by).and_return(Spree.user_class.new)
+            if defined?(Spree::Admin)
+              allow_any_instance_of(Spree::Admin::BaseController).to receive(:admin_oauth_application).and_return(admin_app)
+              allow_any_instance_of(Spree::Admin::BaseController).to receive(:admin_oauth_token).and_return(admin_token)
+            end
           end
         end
 
         def custom_authorization!(&block)
           ability = build_ability(&block)
+          ability_class = Spree::Dependencies.ability_class.constantize
+
           after(:all) do
-            Spree::Ability.remove_ability(ability)
+            ability_class.remove_ability(ability)
           end
           before(:all) do
-            Spree::Ability.register_ability(ability)
+            ability_class.register_ability(ability)
           end
         end
       end

data/lib/spree/testing_support/capybara_config.rb

@@ -1,26 +1,23 @@
 require 'capybara-screenshot/rspec'
 
-Capybara.save_path = ENV['CIRCLE_ARTIFACTS'] if ENV['CIRCLE_ARTIFACTS']
+Capybara.configure do |config|
+  config.save_path = ENV['CIRCLE_ARTIFACTS'] if ENV['CIRCLE_ARTIFACTS']
+  config.server = :puma
+  config.default_driver = :rack_test
+  config.javascript_driver = :selenium_chrome_headless
+  config.default_max_wait_time = ENV.fetch('CAPYBARA_MAX_WAIT_TIME', 45).to_i
+  config.always_include_port = true
+  config.match = :smart
+  config.ignore_hidden_elements = true
+end
 
 if ENV['WEBDRIVER'] == 'accessible'
   require 'capybara/accessible'
   Capybara.javascript_driver = :accessible
-else
-  Capybara.register_driver :chrome do |app|
-    Selenium::WebDriver.logger.level = :error
-
-    Capybara::Selenium::Driver.new app,
-      browser: :chrome,
-      options: Selenium::WebDriver::Chrome::Options.new(
-        args: %w[no-sandbox disable-dev-shm-usage disable-popup-blocking headless disable-gpu window-size=1920,1080 --enable-features=NetworkService,NetworkServiceInProcess --disable-features=VizDisplayCompositor],
-        log_level: :error
-      )
-  end
-  Capybara.javascript_driver = :chrome
+end
 
-  Capybara::Screenshot.register_driver(:chrome) do |driver, path|
-    driver.browser.save_screenshot(path)
+RSpec.configure do |config|
+  config.before(:each, js: true) do
+    Capybara.page.driver.browser.manage.window.resize_to(1400, 900)
   end
 end
-Capybara.default_max_wait_time = 45
-Capybara.server = :webrick