solidus_core 4.6.1 → 4.7.0

data/lib/spree/core.rb

@@ -9,27 +9,27 @@ require "active_record/railtie"
 require "active_storage/engine"
 require "sprockets/railtie"
 
-require 'active_support/deprecation'
-require 'spree/deprecated_instance_variable_proxy'
-require 'spree/deprecator'
-require 'acts_as_list'
-require 'awesome_nested_set'
-require 'cancan'
-require 'friendly_id'
-require 'kaminari/activerecord'
-require 'monetize'
-require 'paperclip'
-require 'ransack'
-require 'state_machines-activerecord'
+require "active_support/deprecation"
+require "spree/deprecated_instance_variable_proxy"
+require "spree/deprecator"
+require "acts_as_list"
+require "awesome_nested_set"
+require "cancan"
+require "friendly_id"
+require "kaminari/activerecord"
+require "monetize"
+require "paperclip"
+require "ransack"
+require "state_machines-activerecord"
 
 # 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
-  autoload :Deprecation, 'spree/deprecation'
+  autoload :Deprecation, "spree/deprecation"
 
-  mattr_accessor :user_class, default: 'Spree::LegacyUser'
+  mattr_accessor :user_class, default: "Spree::LegacyUser"
 
   def self.user_class
     if @@user_class.is_a?(Class)
@@ -69,18 +69,18 @@ module Spree
 
   module Core
     # @api private
-    def self.has_install_generator_been_run?(rails_paths: Rails.application.paths, initializer_name: 'spree.rb', dummy_app_name: 'DummyApp::Application')
+    def self.has_install_generator_been_run?(rails_paths: Rails.application.paths, initializer_name: "spree.rb", dummy_app_name: "DummyApp::Application")
       does_spree_initializer_exist?(rails_paths, initializer_name) ||
         running_solidus_test_suite_with_dummy_app?(dummy_app_name)
     end
 
     def self.running_solidus_test_suite_with_dummy_app?(dummy_app_name)
-      Rails.env.test? && Rails.application.class.name == dummy_app_name
+      Rails.env.test? && Rails.application.class.name == dummy_app_name # standard:disable Style/ClassEqualityComparison
     end
     private_class_method :running_solidus_test_suite_with_dummy_app?
 
     def self.does_spree_initializer_exist?(rails_paths, initializer_name)
-      rails_paths['config/initializers'].any? do |path|
+      rails_paths["config/initializers"].any? do |path|
         File.exist?(Pathname.new(path).join(initializer_name))
       end
     end
@@ -90,35 +90,35 @@ module Spree
   end
 end
 
-require 'spree/core/version'
-
-require 'spree/core/active_merchant_dependencies'
-require 'spree/core/class_constantizer'
-require 'spree/core/environment_extension'
-require 'spree/core/environment/calculators'
-require 'spree/core/environment/promotions'
-require 'spree/core/environment'
-require 'spree/migrations'
-require 'spree/migration_helpers'
-require 'spree/bus'
-require 'spree/config'
-require 'spree/core/engine'
-require 'spree/zero'
-
-require 'spree/i18n'
-require 'spree/localized_number'
-require 'spree/permitted_attributes'
-
-require 'spree/core/importer'
-require 'spree/core/permalinks'
-require 'spree/core/product_duplicator'
-require 'spree/core/role_configuration'
-require 'spree/core/state_machines'
-require 'spree/core/stock_configuration'
-require 'spree/core/null_promotion_configuration'
-require 'spree/core/validators/email'
-require 'spree/user_class_handle'
-
-require 'spree/preferences/store'
-require 'spree/preferences/static_model_preferences'
-require 'spree/preferences/scoped_store'
+require "spree/core/version"
+
+require "spree/core/active_merchant_dependencies"
+require "spree/core/class_constantizer"
+require "spree/core/environment_extension"
+require "spree/core/environment/calculators"
+require "spree/core/environment/promotions"
+require "spree/core/environment"
+require "spree/migrations"
+require "spree/migration_helpers"
+require "spree/bus"
+require "spree/config"
+require "spree/core/engine"
+require "spree/zero"
+
+require "spree/i18n"
+require "spree/localized_number"
+require "spree/permitted_attributes"
+
+require "spree/core/importer"
+require "spree/core/permalinks"
+require "spree/core/product_duplicator"
+require "spree/core/role_configuration"
+require "spree/core/state_machines"
+require "spree/core/stock_configuration"
+require "spree/core/null_promotion_configuration"
+require "spree/core/validators/email"
+require "spree/user_class_handle"
+
+require "spree/preferences/store"
+require "spree/preferences/static_model_preferences"
+require "spree/preferences/scoped_store"

data/lib/spree/deprecated_instance_variable_proxy.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'active_support/deprecation'
+require "active_support/deprecation"
 
 module Spree
   # This DeprecatedInstanceVariableProxy transforms instance variable to

data/lib/spree/deprecation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'spree/core'
+require "spree/core"
 
 module Spree
   Deprecation = Spree.deprecator

data/lib/spree/deprecator.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'active_support/deprecation'
+require "active_support/deprecation"
 
 module Spree
   def self.deprecator
-    @deprecator ||= ActiveSupport::Deprecation.new('5.0', 'Solidus')
+    @deprecator ||= ActiveSupport::Deprecation.new("5.0", "Solidus")
   end
 end

data/lib/spree/i18n.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'i18n'
+require "i18n"
 
 module Spree
   def self.i18n_available_locales
     I18n.available_locales.select do |locale|
-      I18n.t('spree.i18n.this_file_language', locale:, fallback: false, default: nil)
+      I18n.t("spree.i18n.this_file_language", locale:, fallback: false, default: nil)
     end
   end
 

data/lib/spree/localized_number.rb

@@ -14,14 +14,14 @@ module Spree
 
       # I18n.t('number.currency.format.delimiter') could be useful here, but is
       # unnecessary as it is stripped by the non_number_characters gsub.
-      separator = I18n.t(:'number.currency.format.separator')
+      separator = I18n.t(:"number.currency.format.separator")
       non_number_characters = /[^0-9\-#{separator}]/
 
       # strip everything else first
-      number = number.gsub(non_number_characters, '')
+      number = number.gsub(non_number_characters, "")
 
       # then replace the locale-specific decimal separator with the standard separator if necessary
-      number = number.gsub(separator, '.') unless separator == '.'
+      number = number.gsub(separator, ".") unless separator == "."
 
       # Handle empty string for ruby 2.4 compatibility
       BigDecimal(number.presence || 0)

data/lib/spree/manipulative_query_monitor.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Spree
+  class ManipulativeQueryMonitor
+    def self.call(&block)
+      counter = ::DBQueryMatchers::QueryCounter.new({matches: [/^\ *(INSERT|UPDATE|DELETE\ FROM)/]})
+      ActiveSupport::Notifications.subscribed(counter.to_proc,
+        "sql.active_record",
+        &block)
+      if counter.count > 0
+        message = "Detected #{counter.count} manipulative queries. #{counter.log.join(", ")}\n"
+
+        message += caller.select { |line| line.include?(Rails.root.to_s) || line.include?("solidus") }.join("\n")
+
+        Rails.logger.warn(message)
+      end
+    end
+  end
+end

data/lib/spree/migrations.rb

@@ -25,12 +25,12 @@ module Spree
     def check
       return unless File.directory?(app_dir)
       return if missing_migrations.empty?
-      return if ENV['SOLIDUS_SKIP_MIGRATIONS_CHECK']
+      return if ENV["SOLIDUS_SKIP_MIGRATIONS_CHECK"]
 
       prefix = "[WARNING #{engine_name.capitalize}]"
       warn <<~WARN
         #{prefix} Missing migrations.
-        #{missing_migrations.map {|m| "#{prefix} - #{m}"}.join("\n")}
+        #{missing_migrations.map { |m| "#{prefix} - #{m}" }.join("\n")}
         #{prefix}
         #{prefix} Run `bin/rails railties:install:migrations` to get them.
         #{prefix} You can silence this warning by setting the `SOLIDUS_SKIP_MIGRATIONS_CHECK` environment variable.

data/lib/spree/permitted_attributes.rb

@@ -89,13 +89,13 @@ module Spree
     @@property_attributes = [:name, :presentation]
 
     @@return_authorization_attributes = [:memo, :stock_location_id, :return_reason_id,
-                                         customer_metadata: {},
-                                         return_items_attributes: [
-                                           :inventory_unit_id,
-                                           :exchange_variant_id,
-                                           :return_reason_id,
-                                           :preferred_reimbursement_type_id
-                                         ]]
+      customer_metadata: {},
+      return_items_attributes: [
+        :inventory_unit_id,
+        :exchange_variant_id,
+        :return_reason_id,
+        :preferred_reimbursement_type_id
+      ]]
 
     @@shipment_attributes = [
       :special_instructions, :stock_location_id, :id, :tracking,
@@ -123,9 +123,9 @@ module Spree
     ]
 
     @@store_attributes = [:name, :url, :seo_title, :meta_keywords,
-                          :meta_description, :default_currency,
-                          :mail_from_address, :cart_tax_country_iso,
-                          :bcc_email, :reverse_charge_status]
+      :meta_description, :default_currency,
+      :mail_from_address, :cart_tax_country_iso,
+      :bcc_email, :reverse_charge_status]
 
     @@taxonomy_attributes = [:name]
 

data/lib/spree/preferences/configuration.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/core/versioned_value'
-require 'spree/preferences/preferable'
+require "spree/core/versioned_value"
+require "spree/preferences/preferable"
 
 module Spree::Preferences
   # This takes the preferrable methods and adds some
@@ -107,10 +107,10 @@ module Spree::Preferences
       set(default_preferences)
     end
 
-    alias :[] :get_preference
-    alias :[]= :set_preference
+    alias_method :[], :get_preference
+    alias_method :[]=, :set_preference
 
-    alias :get :get_preference
+    alias_method :get, :get_preference
 
     # @param preferences [Hash] a hash of preferences to set
     def set(preferences)

data/lib/spree/preferences/preferable.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'spree/preferences/preferable_class_methods'
-require 'active_support/concern'
-require 'active_support/core_ext/hash/keys'
+require "spree/preferences/preferable_class_methods"
+require "active_support/concern"
+require "active_support/core_ext/hash/keys"
 
 module Spree
   module Preferences
@@ -117,11 +117,9 @@ module Spree
       # This may raise an infinite loop error if any of the defaults are
       # dependent on other preferences defaults.
       def default_preferences
-        Hash[
-          defined_preferences.map do |preference|
-            [preference, preference_default(preference)]
-          end
-        ]
+        defined_preferences.map do |preference|
+          [preference, preference_default(preference)]
+        end.to_h
       end
 
       # Preference names representable as form fields in Solidus backend
@@ -165,8 +163,8 @@ module Spree
           value.to_i
         when :boolean
           if !value ||
-             value.to_s =~ /\A(f|false|0|^)\Z/i ||
-             (value.respond_to?(:empty?) && value.empty?)
+              value.to_s =~ /\A(f|false|0|^)\Z/i ||
+              (value.respond_to?(:empty?) && value.empty?)
             false
           else
             true

data/lib/spree/preferences/preferable_class_methods.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'spree/encryptor'
+require "spree/encryptor"
 
 module Spree::Preferences
   module PreferableClassMethods
-    DEFAULT_ADMIN_FORM_PREFERENCE_TYPES = %i(
+    DEFAULT_ADMIN_FORM_PREFERENCE_TYPES = %i[
       boolean
       decimal
       integer
@@ -12,7 +12,7 @@ module Spree::Preferences
       string
       text
       encrypted_string
-    )
+    ]
 
     def defined_preferences
       []
@@ -27,13 +27,13 @@ module Spree::Preferences
       end
 
       default = begin
-                  given = options[:default]
-                  if given.is_a?(Proc)
-                    given
-                  else
-                    proc { given }
-                  end
-                end
+        given = options[:default]
+        if given.is_a?(Proc)
+          given
+        else
+          proc { given }
+        end
+      end
 
       # The defined preferences on a class are all those defined directly on
       # that class as well as those defined on ancestors.
@@ -76,25 +76,25 @@ module Spree::Preferences
     end
 
     def preference_getter_method(name)
-      "preferred_#{name}".to_sym
+      :"preferred_#{name}"
     end
 
     def preference_setter_method(name)
-       "preferred_#{name}=".to_sym
+      :"preferred_#{name}="
     end
 
     def preference_default_getter_method(name)
-      "preferred_#{name}_default".to_sym
+      :"preferred_#{name}_default"
     end
 
     def preference_type_getter_method(name)
-      "preferred_#{name}_type".to_sym
+      :"preferred_#{name}_type"
     end
 
     def preference_encryptor(options)
       key = options[:encryption_key] ||
-            ENV['SOLIDUS_PREFERENCES_MASTER_KEY'] ||
-            Rails.application.credentials.secret_key_base
+        ENV["SOLIDUS_PREFERENCES_MASTER_KEY"] ||
+        Rails.application.credentials.secret_key_base
 
       Spree::Encryptor.new(key)
     end

data/lib/spree/preferences/preference_differentiator.rb

@@ -19,7 +19,7 @@ module Spree
             changes
           else
             changes.merge(
-              pref_key => { from: value_from, to: value_to }
+              pref_key => {from: value_from, to: value_to}
             )
           end
         end

data/lib/spree/preferences/scoped_store.rb

@@ -26,11 +26,11 @@ module Spree::Preferences
     private
 
     def key_for(key)
-      [rails_cache_id, @prefix, key, @suffix].compact.join('/')
+      [rails_cache_id, @prefix, key, @suffix].compact.join("/")
     end
 
     def rails_cache_id
-      ENV['RAILS_CACHE_ID']
+      ENV["RAILS_CACHE_ID"]
     end
   end
 end

data/lib/spree/preferences/static_model_preferences.rb

@@ -55,8 +55,8 @@ module Spree
           next if extra_keys.empty?
 
           raise \
-            "Unexpected keys found for #{klass} under #{name}: #{extra_keys.sort.join(', ')} " \
-            "(expected keys: #{klass_keys.sort.join(', ')})"
+            "Unexpected keys found for #{klass} under #{name}: #{extra_keys.sort.join(", ")} " \
+            "(expected keys: #{klass_keys.sort.join(", ")})"
         end
       end
     end

data/lib/spree/preferences/store.rb

@@ -3,7 +3,7 @@
 # Use singleton class Spree::Preferences::Store.instance to access
 #
 
-require 'singleton'
+require "singleton"
 
 module Spree::Preferences
   class StoreInstance
@@ -35,19 +35,19 @@ module Spree::Preferences
         # has been cleared from the cache
 
         # does it exist in the database?
-        if preference = Spree::Preference.find_by(key:)
+        val = if (preference = Spree::Preference.find_by(key:))
           # it does exist
-          val = preference.value
+          preference.value
         else
           # use the fallback value
-          val = yield
+          yield
         end
 
         # Cache either the value from the db or the fallback value.
         # This avoids hitting the db with subsequent queries.
         @cache.write(key, val)
 
-        return val
+        val
       else
         yield
       end
@@ -77,7 +77,7 @@ module Spree::Preferences
       return unless should_persist?
 
       preference = Spree::Preference.find_by(key: cache_key)
-      preference.destroy if preference
+      preference&.destroy
     end
 
     def should_persist?

data/lib/spree/testing_support/ability_helpers.rb

@@ -1,107 +1,107 @@
 # frozen_string_literal: true
 
-RSpec.shared_examples_for 'access granted' do
-  it 'should allow show' do
+RSpec.shared_examples_for "access granted" do
+  it "should allow show" do
     expect(ability).to be_able_to(:show, resource, token) if token
     expect(ability).to be_able_to(:show, resource) unless token
   end
 
-  it 'should allow create' do
+  it "should allow create" do
     expect(ability).to be_able_to(:create, resource, token) if token
     expect(ability).to be_able_to(:create, resource) unless token
   end
 
-  it 'should allow update' do
+  it "should allow update" do
     expect(ability).to be_able_to(:update, resource, token) if token
     expect(ability).to be_able_to(:update, resource) unless token
   end
 end
 
-RSpec.shared_examples_for 'access denied' do
-  it 'should not allow show' do
+RSpec.shared_examples_for "access denied" do
+  it "should not allow show" do
     expect(ability).to_not be_able_to(:show, resource)
   end
 
-  it 'should not allow create' do
+  it "should not allow create" do
     expect(ability).to_not be_able_to(:create, resource)
   end
 
-  it 'should not allow update' do
+  it "should not allow update" do
     expect(ability).to_not be_able_to(:update, resource)
   end
 end
 
-RSpec.shared_examples_for 'admin granted' do
-  it 'should allow admin' do
+RSpec.shared_examples_for "admin granted" do
+  it "should allow admin" do
     expect(ability).to be_able_to(:admin, resource, token) if token
     expect(ability).to be_able_to(:admin, resource) unless token
   end
 end
 
-RSpec.shared_examples_for 'admin denied' do
-  it 'should not allow admin' do
+RSpec.shared_examples_for "admin denied" do
+  it "should not allow admin" do
     expect(ability).to_not be_able_to(:admin, resource)
   end
 end
 
-RSpec.shared_examples_for 'index allowed' do
-  it 'should allow index' do
+RSpec.shared_examples_for "index allowed" do
+  it "should allow index" do
     expect(ability).to be_able_to(:index, resource)
   end
 end
 
-RSpec.shared_examples_for 'no index allowed' do
-  it 'should not allow index' do
+RSpec.shared_examples_for "no index allowed" do
+  it "should not allow index" do
     expect(ability).to_not be_able_to(:index, resource)
   end
 end
 
-RSpec.shared_examples_for 'create only' do
-  it 'should allow create' do
+RSpec.shared_examples_for "create only" do
+  it "should allow create" do
     expect(ability).to be_able_to(:create, resource)
   end
 
-  it 'should not allow show' do
+  it "should not allow show" do
     expect(ability).to_not be_able_to(:show, resource)
   end
 
-  it 'should not allow update' do
+  it "should not allow update" do
     expect(ability).to_not be_able_to(:update, resource)
   end
 
-  it 'should not allow index' do
+  it "should not allow index" do
     expect(ability).to_not be_able_to(:index, resource)
   end
 end
 
-RSpec.shared_examples_for 'read only' do
-  it 'should not allow create' do
+RSpec.shared_examples_for "read only" do
+  it "should not allow create" do
     expect(ability).to_not be_able_to(:create, resource)
   end
 
-  it 'should not allow update' do
+  it "should not allow update" do
     expect(ability).to_not be_able_to(:update, resource)
   end
 
-  it 'should allow index' do
+  it "should allow index" do
     expect(ability).to be_able_to(:index, resource)
   end
 end
 
-RSpec.shared_examples_for 'update only' do
-  it 'should not allow create' do
+RSpec.shared_examples_for "update only" do
+  it "should not allow create" do
     expect(ability).to_not be_able_to(:create, resource)
   end
 
-  it 'should not allow show' do
+  it "should not allow show" do
     expect(ability).to_not be_able_to(:show, resource)
   end
 
-  it 'should allow update' do
+  it "should allow update" do
     expect(ability).to be_able_to(:update, resource)
   end
 
-  it 'should not allow index' do
+  it "should not allow index" do
     expect(ability).to_not be_able_to(:index, resource)
   end
 end

data/lib/spree/testing_support/authorization_helpers.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
-require 'cancan'
+require "cancan"
 
 module Spree
   module TestingSupport
     module AuthorizationHelpers
       module CustomAbility
         def build_ability(&block)
-          block ||= proc{ |_u| can :manage, :all }
+          block ||= proc { |_u| can :manage, :all }
           Class.new do
             include CanCan::Ability
+
             define_method(:initialize, block)
           end
         end
@@ -41,9 +42,9 @@ module Spree
           end
 
           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)
+              .with(hash_including(:spree_api_key))
+              .and_return(Spree.user_class.new)
           end
         end