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.

Remove deprecated QueryFilters, Search::Base, and ControllerHelpers::Search (#13674)

Damian Legawiecce2a484b298e
diff --git a/spree/core/lib/spree/core.rb b/spree/core/lib/spree/core.rb
index 87a0c49f35..ee8974aa18 100644
--- a/spree/core/lib/spree/core.rb
+++ b/spree/core/lib/spree/core.rb
@@ -113,14 +113,14 @@ module Spree
)
end
- def self.searcher_class(constantize: true)
- @@searcher_class ||= 'Spree::Core::Search::Base'
+ # @deprecated Spree.searcher_class is deprecated and will be removed in Spree 5.5.
+ def self.searcher_class=(value)
+ Spree::Deprecation.warn('Spree.searcher_class is deprecated and will be removed in Spree 5.5. Please remove it from your initializer.')
+ @@searcher_class = value
+ end
- 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
+ def self.searcher_class(constantize: true)
+ @@searcher_class
end
# Returns the events adapter class used for publishing and subscribing to events.
@@ -440,11 +440,9 @@ require 'spree/webhooks'
require 'spree/core/partials'
require 'spree/core/importer'
-require 'spree/core/query_filters'
require 'spree/core/controller_helpers/auth'
require 'spree/core/controller_helpers/common'
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'
diff --git a/spree/core/lib/spree/core/configuration.rb b/spree/core/lib/spree/core/configuration.rb
index 73a6c5153e..13f63bafc4 100644
--- a/spree/core/lib/spree/core/configuration.rb
+++ b/spree/core/lib/spree/core/configuration.rb
@@ -15,7 +15,6 @@
# a.get :color
# a.preferred_color
#
-require 'spree/core/search/base'
require 'spree/core/preferences/configuration' # for compatibility reasons
require 'spree/core/preferences/runtime_configuration'
require 'spree/core/preferences/preferable'
@@ -112,7 +111,6 @@ module Spree
preference :gift_card_batch_web_limit, :integer, default: 500 # number of gift card codes to be generated in the web process, more than this will be generated in a background job
preference :gift_card_batch_limit, :integer, default: 50_000
- attr_writer :searcher_class
end
end
end
diff --git a/spree/core/lib/spree/core/controller_helpers/search.rb b/spree/core/lib/spree/core/controller_helpers/search.rb
deleted file mode 100644
index ba55237253..0000000000
--- a/spree/core/lib/spree/core/controller_helpers/search.rb
+++ /dev/null
@@ -1,17 +0,0 @@
-module Spree
- module Core
- module ControllerHelpers
- module Search
- def build_searcher(params)
- Spree::Deprecation.warn("Spree::Core::ControllerHelpers::Search is deprecated and will be removed in Spree 5.5.")
-
- Spree.searcher_class.new(params).tap do |searcher|
- searcher.current_user = try_spree_current_user
- searcher.current_currency = current_currency&.upcase
- searcher.current_store = current_store
- end
- end
- end
- end
- end
-end
diff --git a/spree/core/lib/spree/core/query_filters.rb b/spree/core/lib/spree/core/query_filters.rb
deleted file mode 100644
index cce65fc455..0000000000
--- a/spree/core/lib/spree/core/query_filters.rb
+++ /dev/null
@@ -1,11 +0,0 @@
-module Spree
- module Core
- module QueryFilters
- end
- end
-end
-
-require 'spree/core/query_filters/comparable'
-require 'spree/core/query_filters/number'
-require 'spree/core/query_filters/date'
-require 'spree/core/query_filters/text'
diff --git a/spree/core/lib/spree/core/query_filters/comparable.rb b/spree/core/lib/spree/core/query_filters/comparable.rb
deleted file mode 100644
index 9cb49b8a1e..0000000000
--- a/spree/core/lib/spree/core/query_filters/comparable.rb
+++ /dev/null
@@ -1,50 +0,0 @@
-module Spree
- module Core
- module QueryFilters
- # @deprecated This class is deprecated and will be removed in Spree 5.5.
- class Comparable
- def initialize(attribute:)
- Spree::Deprecation.warn(
- "#{self.class.name} is deprecated and will be removed in Spree 5.5."
- )
- @attribute = attribute
- end
-
- def call(scope:, filter:)
- scope = gt(scope, filter[:gt])
- scope = gteq(scope, filter[:gteq])
- scope = lt(scope, filter[:lt])
- lteq(scope, filter[:lteq])
- end
-
- private
-
- attr_reader :attribute
-
- def gt(scope, value)
- return scope unless value
-
- scope.where(attribute.gt(value))
- end
-
- def gteq(scope, value)
- return scope unless value
-
- scope.where(attribute.gteq(value))
- end
-
- def lt(scope, value)
- return scope unless value
-
- scope.where(attribute.lt(value))
- end
-
- def lteq(scope, value)
- return scope unless value
-
- scope.where(attribute.lteq(value))
- end
- end
- end
- end
-end
diff --git a/spree/core/lib/spree/core/query_filters/date.rb b/spree/core/lib/spree/core/query_filters/date.rb
deleted file mode 100644
index 88a15ec76a..0000000000
--- a/spree/core/lib/spree/core/query_filters/date.rb
+++ /dev/null
@@ -1,8 +0,0 @@
-module Spree
- module Core
- module QueryFilters
- class Date < Comparable
- end
- end
- end
-end
diff --git a/spree/core/lib/spree/core/query_filters/number.rb b/spree/core/lib/spree/core/query_filters/number.rb
deleted file mode 100644
index b1c6e5a141..0000000000
--- a/spree/core/lib/spree/core/query_filters/number.rb
+++ /dev/null
@@ -1,8 +0,0 @@
-module Spree
- module Core
- module QueryFilters
- class Number < Comparable
- end
- end
- end
-end
diff --git a/spree/core/lib/spree/core/query_filters/text.rb b/spree/core/lib/spree/core/query_filters/text.rb
deleted file mode 100644
index 8489183146..0000000000
--- a/spree/core/lib/spree/core/query_filters/text.rb
+++ /dev/null
@@ -1,36 +0,0 @@
-module Spree
- module Core
- module QueryFilters
- # @deprecated This class is deprecated and will be removed in Spree 5.5.
- class Text
- def initialize(attribute:)
- Spree::Deprecation.warn(
- 'Spree::Core::QueryFilters::Text is deprecated and will be removed in Spree 5.5.'
- )
- @attribute = attribute
- end
-
- def call(scope:, filter:)
- scope = eq(scope, filter[:eq])
- contains(scope, filter[:contains])
- end
-
- private
-
- attr_reader :attribute
-
- def eq(scope, value)
- return scope unless value
-
- scope.where(attribute.eq(value))
- end
-
- def contains(scope, value)
- return scope unless value
-
- scope.where(attribute.matches("%#{value}%"))
- end
- end
- end
- end
-end
diff --git a/spree/core/lib/spree/core/search/base.rb b/spree/core/lib/spree/core/search/base.rb
deleted file mode 100644
index dfefbd541b..0000000000
--- a/spree/core/lib/spree/core/search/base.rb
+++ /dev/null
@@ -1,144 +0,0 @@
-module Spree
- module Core
- module Search
- class Base
- attr_accessor :properties, :current_user, :current_currency, :current_store, :taxon
-
- def initialize(params)
- Spree::Deprecation.warn("Spree::Core::Search::Base is deprecated and will be removed in Spree 5.5. Please use `Spree::Products::Find` finder instead.")
-
- @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 = extended_base_scope.page(page || 1).per(per_page)
- end
-
- def method_missing(name)
- if @properties.key? name
- @properties[name]
- else
- super
- end
- end
-
- protected
-
- def extended_base_scope
- base_scope = current_store.products.spree_base_scopes
- base_scope = get_products_conditions_for(base_scope, keywords)
- base_scope = Spree.products_finder.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,
- 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)
- 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
- base_scope.merge(Spree::Product.ransack(scope_name => scope_attribute).result)
- end
- end
- end
- base_scope
- end
-
- # method should return new scope based on base_scope
- def get_products_conditions_for(base_scope, query)
- unless query.blank?
- base_scope = base_scope.i18n { name.matches("%#{query}%").or(description.matches("%#{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[: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
- @properties[:per_page] = per_page > 0 ? per_page : Spree::Config[:products_per_page]
- @properties[:page] = if params[:page].respond_to?(:to_i)
- params[:page].to_i <= 0 ? 1 : params[:page].to_i
- else
- 1
- end
- @properties[:product_properties] = params[:properties]
- end
- end
- end
- end
-end
diff --git a/spree/core/spec/lib/search/base_spec.rb b/spree/core/spec/lib/search/base_spec.rb
deleted file mode 100644
index 678f0a92aa..0000000000
--- a/spree/core/spec/lib/search/base_spec.rb
+++ /dev/null
@@ -1,135 +0,0 @@
-require 'spec_helper'
-
-xdescribe Spree::Core::Search::Base do
- let(:product1) { create(:product, name: 'RoR Mug', price: 9.00) }
- let!(:product2) { create(:product, name: 'RoR Shirt', price: 11.00) }
- let(:taxon) { create(:taxon, name: 'Ruby on Rails') }
- before do
- product1.taxons << taxon
- end
-
- it 'returns all products by default' do
- params = { per_page: '' }
- searcher = described_class.new(params)
- expect(searcher.retrieve_products.count).to eq(2)
- end
-
- context 'when include_images is included in the initialization params' do
- subject { described_class.new(params).retrieve_products }
-
- let(:params) { { include_images: true, keyword: product1.name, taxon: taxon } }
-
- before do
- product1.master.images << create(:image, position: 2)
- product1.master.images << create(:image, position: 1)
- product1.reload
- end
-
- it 'returns images in correct order' do
- expect(subject.first).to eq product1
- expect(subject.first.images).to eq product1.master.images
- end
- end
-
- it 'switches to next page according to the page parameter' do
- @product3 = create(:product, name: 'RoR Pants', price: 14.00)
-
- params = { per_page: '2' }
- searcher = described_class.new(ActionController::Parameters.new(params))
- expect(searcher.retrieve_products.count).to eq(2)
-
- params[:page] = '2'
- searcher = described_class.new(ActionController::Parameters.new(params))
- expect(searcher.retrieve_products.count).to eq(1)
- end
-
- it 'uses ransack if scope not found' do
- params = { per_page: '', search: { 'name_not_cont' => 'Shirt' } }
- searcher = described_class.new(ActionController::Parameters.new(params))
- expect(searcher.retrieve_products.count).to eq(1)
- end
-
- it 'accepts a current user' do
- user = double
- searcher = described_class.new({})
- searcher.current_user = user
- expect(searcher.current_user).to eql(user)
- end
-
- it 'finds products in alternate currencies' do
- create(:price, currency: 'EUR', variant: product1.master)
- searcher = described_class.new({})
- searcher.current_currency = 'EUR'
- expect(searcher.retrieve_products).to eq([product1])
- end
-
- describe 'searching by a current store' do
- subject(:retrieved_products) { searcher.retrieve_products }
-
- let(:searcher) { described_class.new(params) }
-
- let(:eu_store) { create(:store, name: 'EU Store', default_currency: 'EUR') }
- let(:uk_store) { create(:store, name: 'UK Store', default_currency: 'GBP') }
- let(:spree_store) { create(:store, name: 'Spree Demo Site', default_currency: 'USD', default: true) }
-
- let!(:products_for_eu_store) do
- (1..3).map do |v|
- create(:product, name: "P-EU-#{v}", stores: [eu_store], currency: 'EUR')
- end
- end
-
- let!(:products_for_uk_store) do
- (1..2).map do |v|
- create(:product, name: "P-UK-#{v}", stores: [uk_store], currency: 'GBP')
- end
- end
-
- let!(:product_for_spree_store) { create(:product, name: 'P-Spree-1', stores: [spree_store]) }
-
- context 'current sture is given in params' do
- let(:params) { { current_store: current_store } }
-
- context 'when EU Store' do
- let(:current_store) { eu_store }
-
- it 'returns 3 products' do
- expect(retrieved_products.count).to eq(3)
- end
-
- it 'returns only products from EU store' do
- expect(retrieved_products).to contain_exactly(*products_for_eu_store)
- end
- end
-
- context 'when UK Store' do
- let(:current_store) { uk_store }
-
- it 'returns 2 products' do
- expect(retrieved_products.count).to eq(2)
- end
-
- it 'returns only products from UK store' do
- expect(retrieved_products).to contain_exactly(*products_for_uk_store)
- end
- end
-
- context 'when Spree Store' do
- let(:current_store) { spree_store }
-
- it 'returns 1 product' do
- expect(retrieved_products.count).to eq(1)
- end
-
- it 'returns only products from Spree store' do
- expect(retrieved_products).to contain_exactly(product_for_spree_store)
- end
- end
- end
- end
-
- it 'returns products with shirt in name when keyword set to shirt' do
- params = { keywords: 'shirt', include_images: true }
- searcher = described_class.new(ActionController::Parameters.new(params))
- expect(searcher.retrieve_products.first.name).to eq('RoR Shirt')
- end
-end
diff --git a/spree/core/spec/lib/spree/core/controller_helpers/search_spec.rb b/spree/core/spec/lib/spree/core/controller_helpers/search_spec.rb
deleted file mode 100644
index 6f33338309..0000000000
--- a/spree/core/spec/lib/spree/core/controller_helpers/search_spec.rb
+++ /dev/null
@@ -1,19 +0,0 @@
-require 'spec_helper'
-
-class FakesController < ApplicationController
- include Spree::Core::ControllerHelpers::Search
-end
-
-describe Spree::Core::ControllerHelpers::Search, type: :controller do
- controller(FakesController) {}
-
- let(:store) { @default_store }
-
- describe '#build_searcher' do
- it 'returns Spree::Core::Search::Base instance' do
- allow(controller).to receive_messages(try_spree_current_user: build(:user),
- current_currency: 'USD', current_store: store)
- expect(controller.build_searcher({}).class).to eq Spree::Core::Search::Base
- end
- end
-end
diff --git a/spree/core/spec/lib/spree/core/query_filters/comparable_spec.rb b/spree/core/spec/lib/spree/core/query_filters/comparable_spec.rb
deleted file mode 100644
index 79c2e138ab..0000000000
--- a/spree/core/spec/lib/spree/core/query_filters/comparable_spec.rb
+++ /dev/null
@@ -1,72 +0,0 @@
-require 'spec_helper'
-
-module Spree
- module Core
- describe QueryFilters::Comparable do
- let(:subject) do
- described_class.new(attribute: Spree::DummyModel.arel_table[:position])
- end
-
- let!(:dummy1) { Spree::DummyModel.create(name: '1', position: 3) }
- let!(:dummy2) { Spree::DummyModel.create(name: '2', position: 10) }
- let!(:dummy3) { Spree::DummyModel.create(name: '3', position: 4) }
- let(:scope) { Spree::DummyModel.all }
-
- context 'with greater than matcher' do
- let(:filter) do
- {
- position: { gt: 3 }
- }
- end
-
- it 'returns correct dummies' do
- result = subject.call(scope: scope, filter: filter[:position])
- expect(result).to include(dummy2, dummy3)
- expect(result).not_to include(dummy1)
- end
- end
-
- context 'with greater than or equal matcher' do
- let(:filter) do
- {
- position: { gteq: 4 }
- }
- end
-
- it 'returns correct dummies' do
- result = subject.call(scope: scope, filter: filter[:position])
- expect(result).to include(dummy2, dummy3)
- expect(result).not_to include(dummy1)
- end
- end
-
- context 'with lower than matcher' do
- let(:filter) do
- {
- position: { lt: 4 }
- }
- end
-
- it 'returns correct dummies' do
- result = subject.call(scope: scope, filter: filter[:position])
- expect(result).to include(dummy1)
- expect(result).not_to include(dummy2, dummy3)
- end
- end
-
- context 'with lower than or equal matcher' do
- let(:filter) do
- {
- position: { lteq: 4 }
- }
- end
-
- it 'returns correct dummies' do
- result = subject.call(scope: scope, filter: filter[:position])
- expect(result).to include(dummy1, dummy3)
- expect(result).not_to include(dummy2)
- end
- end
- end
- end
-end
diff --git a/spree/core/spec/lib/spree/core/query_filters/text_spec.rb b/spree/core/spec/lib/spree/core/query_filters/text_spec.rb
deleted file mode 100644
index 698f4a0dc3..0000000000
--- a/spree/core/spec/lib/spree/core/query_filters/text_spec.rb
+++ /dev/null
@@ -1,44 +0,0 @@
-require 'spec_helper'
-
-module Spree
- module Core
- describe QueryFilters::Text do
- let(:subject) do
- described_class.new(attribute: Spree::DummyModel.arel_table[:name])
- end
-
- let!(:dummy1) { Spree::DummyModel.create(name: 'TestName', position: 3) }
- let!(:dummy2) { Spree::DummyModel.create(name: 'Test', position: 10) }
- let!(:dummy3) { Spree::DummyModel.create(name: 'Something', position: 4) }
- let(:scope) { Spree::DummyModel.all }
-
- context 'with eq matcher' do
- let(:filter) do
- {
- position: { eq: 'TestName' }
- }
- end
-
- it 'returns correct dummies' do
- result = subject.call(scope: scope, filter: filter[:position])
- expect(result).to include(dummy1)
- expect(result).not_to include(dummy2, dummy3)
- end
- end
-
- context 'with contains matcher' do
- let(:filter) do
- {
- position: { contains: 'Test' }
- }
- end
-
- it 'returns correct dummies' do
- result = subject.call(scope: scope, filter: filter[:position])
- expect(result).to include(dummy1, dummy2)
- expect(result).not_to include(dummy3)
- end
- end
- end
- end
-end
diff --git a/spree/core/spec/lib/spree/core_spec.rb b/spree/core/spec/lib/spree/core_spec.rb
index e06bb7b2c0..36ca886982 100644
--- a/spree/core/spec/lib/spree/core_spec.rb
+++ b/spree/core/spec/lib/spree/core_spec.rb
@@ -107,41 +107,4 @@ describe Spree do
end
end
- describe '.searcher_class' do
- after do
- described_class.searcher_class = 'Spree::Core::Search::Base'
- end
-
- context 'when searcher_class is a Class instance' do
- it 'raises an error' do
- described_class.searcher_class = Spree::Core::Search::Base
-
- expect { described_class.searcher_class }.to raise_error(RuntimeError)
- end
- end
-
- context 'when searcher_class is a Symbol instance' do
- it 'returns the searcher_class constant' do
- described_class.searcher_class = :'Spree::Core::Search::Base'
-
- expect(described_class.searcher_class).to eq(Spree::Core::Search::Base)
- end
- end
-
- context 'when searcher_class is a String instance' do
- it 'returns the searcher_class constant' do
- described_class.searcher_class = 'Spree::Core::Search::Base'
-
- expect(described_class.searcher_class).to eq(Spree::Core::Search::Base)
- end
- end
-
- context 'when constantize is false' do
- it 'returns the searcher_class as a String' do
- described_class.searcher_class = 'Spree::Core::Search::Base'
-
- expect(described_class.searcher_class(constantize: false)).to eq('Spree::Core::Search::Base')
- end
- end
- end
end