solidus_core 4.3.4 → 4.4.0

data/lib/spree/permission_sets/base.rb

@@ -18,11 +18,23 @@ module Spree
       end
 
       # Activate permissions on the ability. Put your can and cannot statements here.
-      # Must be overriden by subclasses
+      # Must be overridden by subclasses
       def activate!
         raise NotImplementedError.new
       end
 
+      # Provide the permission set privilege in the form of a :symbol.
+      # Must be overridden by subclasses.
+      def self.privilege
+        raise NotImplementedError, "Subclass #{name} must define a privilege using `self.privilege :symbol`"
+      end
+
+      # Provide the permission set category in the form of a :symbol.
+      # Must be overridden by subclasses.
+      def self.category
+        raise NotImplementedError, "Subclass #{name} must define a category using `self.category :symbol`"
+      end
+
       private
 
       attr_reader :ability

data/lib/spree/permission_sets/configuration_display.rb

@@ -22,6 +22,16 @@ module Spree
     # - Reimbursement types
     # - Return reasons
     class ConfigurationDisplay < PermissionSets::Base
+      class << self
+        def privilege
+          :display
+        end
+
+        def category
+          :configuration
+        end
+      end
+
       def activate!
           can [:read, :admin], Spree::TaxCategory
           can [:read, :admin], Spree::TaxRate

data/lib/spree/permission_sets/configuration_management.rb

@@ -21,6 +21,16 @@ module Spree
     # - Reimbursement types
     # - Return reasons
     class ConfigurationManagement < PermissionSets::Base
+      class << self
+        def privilege
+          :management
+        end
+
+        def category
+          :configuration
+        end
+      end
+
       def activate!
         can :manage, Spree::TaxCategory
         can :manage, Spree::TaxRate

data/lib/spree/permission_sets/dashboard_display.rb

@@ -8,7 +8,19 @@ module Spree
     # which may or not contain sensitive information depending on
     # customizations.
     class DashboardDisplay < PermissionSets::Base
+      class << self
+        def privilege
+          :other
+        end
+
+        def category
+          :dashboard_display
+        end
+      end
+
       def activate!
+          Spree.deprecator.warn "The #{self.class.name} module is deprecated. " \
+            "If you still use dashboards, please copy all controllers and views from #{self.class.name} to your application."
           can [:admin, :home], :dashboards
       end
     end

data/lib/spree/permission_sets/default_customer.rb

@@ -32,6 +32,16 @@ module Spree
     # with the same user, as well as reading and updating the user record and
     # their associated cards.
     class DefaultCustomer < PermissionSets::Base
+      class << self
+        def privilege
+          :other
+        end
+
+        def category
+          :default_customer
+        end
+      end
+
       def activate!
         can :read, Country
         can :read, OptionType
@@ -44,7 +54,7 @@ module Spree
           # via API, just like with show and update
           (order.guest_token.present? && token == order.guest_token)
         end
-        can [:show, :update], Order, Order.where(user: user) do |order, token|
+        can [:show, :update], Order, Order.where(user:) do |order, token|
           order.user == user || (order.guest_token.present? && token == order.guest_token)
         end
         cannot :update, Order do |order|

data/lib/spree/permission_sets/order_display.rb

@@ -22,6 +22,16 @@ module Spree
     # However, it does not allow any modifications to be made to any of these
     # resources.
     class OrderDisplay < PermissionSets::Base
+      class << self
+        def privilege
+          :display
+        end
+
+        def category
+          :order
+        end
+      end
+
       def activate!
         can [:read, :admin, :edit, :cart], Spree::Order
         can [:read, :admin], Spree::Payment

data/lib/spree/permission_sets/order_management.rb

@@ -21,6 +21,16 @@ module Spree
     #
     # It also allows reading reimbursement types, but not modifying them.
     class OrderManagement < PermissionSets::Base
+      class << self
+        def privilege
+          :management
+        end
+
+        def category
+          :order
+        end
+      end
+
       def activate!
         can :read, Spree::ReimbursementType
         can :manage, Spree::Order

data/lib/spree/permission_sets/product_display.rb

@@ -17,6 +17,16 @@ module Spree
     # - Taxonomies
     # - Taxons
     class ProductDisplay < PermissionSets::Base
+      class << self
+        def privilege
+          :display
+        end
+
+        def category
+          :product
+        end
+      end
+
       def activate!
         can [:read, :admin, :edit], Spree::Product
         can [:read, :admin], Spree::Image

data/lib/spree/permission_sets/product_management.rb

@@ -19,6 +19,16 @@ module Spree
     # - Classifications
     # - Prices
     class ProductManagement < PermissionSets::Base
+      class << self
+        def privilege
+          :management
+        end
+
+        def category
+          :product
+        end
+      end
+
       def activate!
         can :manage, Spree::Classification
         can :manage, Spree::Image

data/lib/spree/permission_sets/restricted_stock_display.rb

@@ -8,6 +8,16 @@ module Spree
     # locations, both of them limited to locations they have access to.
     # Permissions are also granted for the admin panel for items.
     class RestrictedStockDisplay < PermissionSets::Base
+      class << self
+        def privilege
+          :display
+        end
+
+        def category
+          :restricted_stock
+        end
+      end
+
       def activate!
         can [:read, :admin], Spree::StockItem, stock_location_id: location_ids
         can :read, Spree::StockLocation, id: location_ids

data/lib/spree/permission_sets/restricted_stock_management.rb

@@ -8,6 +8,16 @@ module Spree
     # access to their locations. Those locations are also readable by the
     # corresponding ability.
     class RestrictedStockManagement < PermissionSets::Base
+      class << self
+        def privilege
+          :management
+        end
+
+        def category
+          :restricted_stock
+        end
+      end
+
       def activate!
         can :manage, Spree::StockItem, stock_location_id: location_ids
         can :read, Spree::StockLocation, id: location_ids

data/lib/spree/permission_sets/stock_display.rb

@@ -7,6 +7,16 @@ module Spree
     # This permission set allows users to view information about stock items
     # (also from the admin panel) and stock locations.
     class StockDisplay < PermissionSets::Base
+      class << self
+        def privilege
+          :display
+        end
+
+        def category
+          :stock
+        end
+      end
+
       def activate!
         can [:read, :admin], Spree::StockItem
         can :read, Spree::StockLocation

data/lib/spree/permission_sets/stock_management.rb

@@ -7,6 +7,16 @@ module Spree
     # This permission set grants full control over all stock items and read
     # access to locations.
     class StockManagement < PermissionSets::Base
+      class << self
+        def privilege
+          :management
+        end
+
+        def category
+          :stock
+        end
+      end
+
       def activate!
         can :manage, Spree::StockItem
         can :read, Spree::StockLocation

data/lib/spree/permission_sets/super_user.rb

@@ -8,6 +8,16 @@ module Spree
     #
     # It grants permission to perform any read or write action on any resource.
     class SuperUser < PermissionSets::Base
+      class << self
+        def privilege
+          :other
+        end
+
+        def category
+          :super_user
+        end
+      end
+
       def activate!
         can :manage, :all
       end

data/lib/spree/permission_sets/user_display.rb

@@ -7,6 +7,16 @@ module Spree
     # This permission set allows users to view all related information about
     # users, roles and store credits, also from the admin panel.
     class UserDisplay < PermissionSets::Base
+      class << self
+        def privilege
+          :display
+        end
+
+        def category
+          :user
+        end
+      end
+
       def activate!
         can [:read, :admin, :edit, :addresses, :orders, :items], Spree.user_class
         can [:read, :admin], Spree::StoreCredit

data/lib/spree/permission_sets/user_management.rb

@@ -12,6 +12,16 @@ module Spree
     # - Roles
     # - API keys
     class UserManagement < PermissionSets::Base
+      class << self
+        def privilege
+          :management
+        end
+
+        def category
+          :user
+        end
+      end
+
       def activate!
         can [:admin, :read, :create, :update, :save_in_address_book, :remove_from_address_book, :addresses, :orders, :items], Spree.user_class
 

data/lib/spree/permission_sets.rb

@@ -9,8 +9,6 @@ require 'spree/permission_sets/order_display'
 require 'spree/permission_sets/order_management'
 require 'spree/permission_sets/product_display'
 require 'spree/permission_sets/product_management'
-require 'spree/permission_sets/promotion_display'
-require 'spree/permission_sets/promotion_management'
 require 'spree/permission_sets/restricted_stock_display'
 require 'spree/permission_sets/restricted_stock_management'
 require 'spree/permission_sets/stock_display'

data/lib/spree/permitted_attributes.rb

@@ -95,7 +95,7 @@ module Spree
       :number, :month, :year, :expiry, :verification_value,
       :first_name, :last_name, :cc_type, :gateway_customer_profile_id,
       :gateway_payment_profile_id, :last_digits, :name, :encrypted_data,
-      :wallet_payment_source_id, address_attributes: address_attributes
+      :wallet_payment_source_id, address_attributes:
     ]
 
     @@stock_item_attributes = [:variant, :stock_location, :backorderable, :variant_id]
@@ -153,7 +153,7 @@ module Spree
 
     @@checkout_payment_attributes = [
       payments_attributes: payment_attributes + [
-        source_attributes: source_attributes
+        source_attributes:
       ]
     ]
 

data/lib/spree/preferences/store.rb

@@ -19,7 +19,7 @@ module Spree::Preferences
 
     def exist?(key)
       @cache.exist?(key) ||
-        should_persist? && Spree::Preference.where(key: key).exists?
+        should_persist? && Spree::Preference.where(key:).exists?
     end
 
     def get(key)
@@ -35,7 +35,7 @@ module Spree::Preferences
         # has been cleared from the cache
 
         # does it exist in the database?
-        if preference = Spree::Preference.find_by(key: key)
+        if preference = Spree::Preference.find_by(key:)
           # it does exist
           val = preference.value
         else

data/lib/spree/testing_support/capybara_ext.rb

@@ -23,7 +23,7 @@ module Spree
             field.dispatchEvent(event);
           JS
         else
-          fill_in locator, with: with
+          fill_in locator, with:
         end
       end
 

data/lib/spree/testing_support/dummy_ability.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'cancan'
+
+class DummyAbility
+  include CanCan::Ability
+end

data/lib/spree/testing_support/dummy_app/database.yml

@@ -9,8 +9,8 @@
 
   db_host =
     case adapter
-    when 'mysql' then ENV['DB_MYSQL_HOST'] || ENV['DB_HOST']
-    when 'postgres' then ENV['DB_POSTGRES_HOST'] || ENV['DB_HOST']
+    when 'mysql2' then ENV['DB_MYSQL_HOST'] || ENV['DB_HOST']
+    when 'postgresql' then ENV['DB_POSTGRES_HOST'] || ENV['DB_HOST']
     else ENV['DB_HOST']
     end
 

data/lib/spree/testing_support/dummy_app/migrations.rb

@@ -4,21 +4,6 @@ module DummyApp
   module Migrations
     extend self
 
-    # Ensure database exists
-    def database_exists?
-      ActiveRecord::Base.connection
-    rescue ActiveRecord::NoDatabaseError
-      false
-    else
-      true
-    end
-
-    def needs_migration?
-      return true if !database_exists?
-
-      ActiveRecord::Base.connection.migration_context.needs_migration?
-    end
-
     def auto_migrate
       if needs_migration?
         puts "Configuration changed. Re-running migrations"
@@ -35,6 +20,14 @@ module DummyApp
 
     private
 
+    def needs_migration?
+      ActiveRecord::Migration.check_all_pending!
+    rescue ActiveRecord::PendingMigrationError, ActiveRecord::NoDatabaseError
+      true
+    else
+      false
+    end
+
     def sh(cmd)
       puts cmd
       system cmd

data/lib/spree/testing_support/dummy_app/rake_tasks.rb

@@ -10,8 +10,8 @@ module DummyApp
         require lib_name
         require 'spree/testing_support/dummy_app'
         DummyApp.setup(
-          gem_root: gem_root,
-          lib_name: lib_name,
+          gem_root:,
+          lib_name:,
           auto_migrate: false
         )
       end

data/lib/spree/testing_support/dummy_app.rb

@@ -20,6 +20,7 @@ end
 
 # @private
 class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
 end
 
 # @private
@@ -34,10 +35,19 @@ end
 module DummyApp
   def self.setup(gem_root:, lib_name:, auto_migrate: true)
     ENV["LIB_NAME"] = lib_name
-    DummyApp::Application.config.root = File.join(gem_root, 'spec', 'dummy')
+    root = Pathname(gem_root).join('spec/dummy')
+    root.join("app/assets/config").mkpath
+    root.join("app/assets/config/manifest.js").write("// Intentionally empty\n")
 
+    DummyApp::Application.config.root = root
     DummyApp::Application.initialize! unless DummyApp::Application.initialized?
 
+    # Raise on deprecation warnings.
+    # NOTE: This needs to happen after the application is initialized.
+    if ENV['SOLIDUS_RAISE_DEPRECATIONS'].present?
+      Spree.deprecator.behavior = :raise
+    end
+
     if auto_migrate
       DummyApp::Migrations.auto_migrate
     end
@@ -46,11 +56,6 @@ module DummyApp
   class Application < ::Rails::Application
     config.load_defaults("#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}")
 
-    if Rails.gem_version >= Gem::Version.new('7.1')
-      config.action_controller.raise_on_missing_callback_actions = true
-      config.action_dispatch.show_exceptions = :none
-    end
-
     # Make the test environment more production-like:
     config.action_controller.allow_forgery_protection = false
     config.action_controller.default_protect_from_forgery = false
@@ -68,8 +73,13 @@ module DummyApp
     config.cache_classes = true
 
     # Make debugging easier:
+    if Rails.gem_version >= Gem::Version.new('7.1')
+      config.action_controller.raise_on_missing_callback_actions = true
+      config.action_dispatch.show_exceptions = :none
+    else
+      config.action_dispatch.show_exceptions = false
+    end
     config.consider_all_requests_local = true
-    config.action_dispatch.show_exceptions = false # Should be :none for Rails 7.1+
     config.active_support.deprecation = :stderr
     config.log_level = :debug
 
@@ -148,8 +158,3 @@ Spree.config do |config|
     config.taxon_attachment_module = 'Spree::Taxon::PaperclipAttachment'
   end
 end
-
-# Raise on deprecation warnings
-if ENV['SOLIDUS_RAISE_DEPRECATIONS'].present?
-  Spree.deprecator.behavior = :raise
-end

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

@@ -7,7 +7,6 @@ FactoryBot.define do
     amount { 100.0 }
     label { 'Shipping' }
     association(:source, factory: :tax_rate)
-    eligible { true }
 
     after(:build) do |adjustment|
       adjustments = adjustment.adjustable.adjustments
@@ -31,7 +30,7 @@ FactoryBot.define do
             adjustment.source.tax_categories = []
           end
           adjustment.source.save
-          adjustment.recalculate
+          adjustment.update!(amount: adjustment.source.compute_amount(adjustment.adjustable))
         end
       end
     end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 FactoryBot.define do
-  factory :calculator, aliases: [:flat_rate_calculator], class: 'Spree::Calculator::FlatRate' do
+  factory :flat_rate_calculator, aliases: [:calculator], class: 'Spree::Calculator::FlatRate' do
     preferred_amount { 10.0 }
   end
 
@@ -22,8 +22,4 @@ FactoryBot.define do
   factory :shipping_no_amount_calculator, class: 'Spree::Calculator::Shipping::FlatRate' do
     preferred_amount { 0 }
   end
-
-  factory :percent_on_item_calculator, class: 'Spree::Calculator::PercentOnLineItem' do
-    preferred_percent { 10 }
-  end
 end

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

@@ -13,8 +13,8 @@ FactoryBot.define do
           # ensure the shipment uses the same stock location as the carton
           shipment: build(
             :shipment,
-            stock_location: stock_location,
-            shipping_method: shipping_method
+            stock_location:,
+            shipping_method:
           )
         )
       ]

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

@@ -7,13 +7,13 @@ FactoryBot.define do
     transient do
       line_items_count { 1 }
       return_items_count { line_items_count }
-      shipped_order { create :shipped_order, line_items_count: line_items_count }
+      shipped_order { create :shipped_order, line_items_count: }
       return_authorization { create :return_authorization, order: shipped_order }
     end
 
     before(:create) do |customer_return, evaluator|
       evaluator.shipped_order.inventory_units.take(evaluator.return_items_count).each do |inventory_unit|
-        customer_return.return_items << build(:return_item, inventory_unit: inventory_unit, return_authorization: evaluator.return_authorization)
+        customer_return.return_items << build(:return_item, inventory_unit:, return_authorization: evaluator.return_authorization)
       end
     end
 

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

@@ -10,15 +10,15 @@ FactoryBot.define do
     association :variant, strategy: :create
     line_item do
       if order
-        build(:line_item, variant: variant, order: order)
+        build(:line_item, variant:, order:)
       else
-        build(:line_item, variant: variant)
+        build(:line_item, variant:)
       end
     end
     state { 'on_hand' }
     shipment do
       if stock_location
-        build(:shipment, state: 'pending', order: line_item.order, stock_location: stock_location)
+        build(:shipment, state: 'pending', order: line_item.order, stock_location:)
       else
         build(:shipment, state: 'pending', order: line_item.order)
       end

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

@@ -43,36 +43,17 @@ FactoryBot.define do
         evaluator.stock_location # must evaluate before creating line items
 
         evaluator.line_items_attributes.each do |attributes|
-          attributes = { order: order, price: evaluator.line_items_price }.merge(attributes)
+          attributes = { order:, price: evaluator.line_items_price }.merge(attributes)
           create(:line_item, attributes)
         end
         order.line_items.reload
 
-        create(:shipment, order: order, cost: evaluator.shipment_cost, shipping_method: evaluator.shipping_method, stock_location: evaluator.stock_location)
+        create(:shipment, order:, cost: evaluator.shipment_cost, shipping_method: evaluator.shipping_method, stock_location: evaluator.stock_location)
         order.shipments.reload
 
         order.recalculate
       end
 
-      factory :completed_order_with_promotion do
-        transient do
-          completed_at { Time.current }
-          promotion { nil }
-        end
-
-        after(:create) do |order, evaluator|
-          promotion = evaluator.promotion || create(:promotion, code: "test")
-          promotion_code = promotion.codes.first || create(:promotion_code, promotion: promotion)
-
-          promotion.activate(order: order, promotion_code: promotion_code)
-          order.order_promotions.create!(promotion: promotion, promotion_code: promotion_code)
-
-          # Complete the order after the promotion has been activated
-          order.update_column(:completed_at, evaluator.completed_at)
-          order.update_column(:state, "complete")
-        end
-      end
-
       factory :order_ready_to_complete do
         state { 'confirm' }
         payment_state { 'checkout' }
@@ -84,7 +65,7 @@ FactoryBot.define do
         after(:create) do |order, evaluator|
           create(evaluator.payment_type, {
             amount: order.total,
-            order: order,
+            order:,
             state: order.payment_state
           })
 
@@ -107,7 +88,7 @@ FactoryBot.define do
 
         factory :completed_order_with_pending_payment do
           after(:create) do |order|
-            create(:payment, amount: order.total, order: order, state: 'pending')
+            create(:payment, amount: order.total, order:, state: 'pending')
           end
         end
 
@@ -120,7 +101,7 @@ FactoryBot.define do
           end
 
           after(:create) do |order, evaluator|
-            create(evaluator.payment_type, amount: order.total, order: order, state: 'completed')
+            create(evaluator.payment_type, amount: order.total, order:, state: 'completed')
             order.shipments.each do |shipment|
               shipment.update_column('state', 'ready')
             end

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

@@ -40,7 +40,7 @@ FactoryBot.define do
       end
 
       factory :product_with_option_types do
-        after(:create) { |product| create(:product_option_type, product: product) }
+        after(:create) { |product| create(:product_option_type, product:) }
       end
     end
   end

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

@@ -15,7 +15,7 @@ FactoryBot.define do
     after(:create) do |shipment, evaluator|
       shipping_method = evaluator.shipping_method || create(:shipping_method, cost: evaluator.cost)
       shipment.shipping_rates.create!(
-        shipping_method: shipping_method,
+        shipping_method:,
         cost: evaluator.cost,
         selected: true
       )