spree_core 5.2.0.rc3 → 5.2.1

data/app/models/spree/permission_sets/product_management.rb

@@ -0,0 +1,27 @@
+# Permission set for full product and catalog management.
+#
+# This permission set provides complete access to manage products, variants,
+# and related catalog models like taxonomies and properties.
+#
+# @example
+#   Spree.permissions.assign(:merchandiser, Spree::PermissionSets::ProductManagement)
+#
+module Spree
+  module PermissionSets
+    class ProductManagement < Base
+      def activate!
+        can :manage, Spree::Product
+        can :manage, Spree::Variant
+        can :manage, Spree::OptionType
+        can :manage, Spree::OptionValue
+        can :manage, Spree::Property
+        can :manage, Spree::ProductProperty
+        can :manage, Spree::Taxon
+        can :manage, Spree::Taxonomy
+        can :manage, Spree::Classification
+        can :manage, Spree::Price
+        can :manage, Spree::Asset
+      end
+    end
+  end
+end

data/app/models/spree/permission_sets/promotion_management.rb

@@ -0,0 +1,22 @@
+# Permission set for managing promotions and discounts.
+#
+# This permission set provides access to create and manage promotions,
+# coupon codes, and promotion rules.
+#
+# @example
+#   Spree.permissions.assign(:marketing, Spree::PermissionSets::PromotionManagement)
+#
+module Spree
+  module PermissionSets
+    class PromotionManagement < Base
+      def activate!
+        can :manage, Spree::Promotion
+        can :manage, Spree::PromotionRule
+        can :manage, Spree::PromotionAction
+        can :manage, Spree::PromotionCategory
+        can :manage, Spree::CouponCode
+        can [:read, :admin], Spree::Metafield
+      end
+    end
+  end
+end

data/app/models/spree/permission_sets/role_management.rb

@@ -0,0 +1,21 @@
+# Permission set for managing roles and permissions.
+#
+# This permission set provides access to manage roles and user assignments.
+# Note: The admin role cannot be modified.
+#
+# @example
+#   Spree.permissions.assign(:admin, Spree::PermissionSets::RoleManagement)
+#
+module Spree
+  module PermissionSets
+    class RoleManagement < Base
+      def activate!
+        can :manage, Spree::Role
+        can :manage, Spree::RoleUser
+
+        # Protect the admin role from modification
+        cannot [:update, :destroy], Spree::Role, name: ['admin']
+      end
+    end
+  end
+end

data/app/models/spree/permission_sets/stock_display.rb

@@ -0,0 +1,19 @@
+# Permission set for viewing stock and inventory information.
+#
+# This permission set provides read-only access to stock items,
+# locations, and movements.
+#
+# @example
+#   Spree.permissions.assign(:warehouse_viewer, Spree::PermissionSets::StockDisplay)
+#
+module Spree
+  module PermissionSets
+    class StockDisplay < Base
+      def activate!
+        can [:read, :admin, :index], Spree::StockItem
+        can [:read, :admin], Spree::StockLocation
+        can [:read, :admin], Spree::StockMovement
+      end
+    end
+  end
+end

data/app/models/spree/permission_sets/stock_management.rb

@@ -0,0 +1,19 @@
+# Permission set for full stock and inventory management.
+#
+# This permission set provides complete access to manage stock items,
+# locations, and movements.
+#
+# @example
+#   Spree.permissions.assign(:warehouse_manager, Spree::PermissionSets::StockManagement)
+#
+module Spree
+  module PermissionSets
+    class StockManagement < Base
+      def activate!
+        can :manage, Spree::StockItem
+        can :manage, Spree::StockLocation
+        can :manage, Spree::StockMovement
+      end
+    end
+  end
+end

data/app/models/spree/permission_sets/super_user.rb

@@ -0,0 +1,28 @@
+# Permission set granting full administrative access.
+#
+# This permission set provides unrestricted access to all resources,
+# with some safety restrictions for critical operations.
+#
+# @example
+#   Spree.permissions.assign(:admin, Spree::PermissionSets::SuperUser)
+#
+module Spree
+  module PermissionSets
+    class SuperUser < Base
+      def activate!
+        can :manage, :all
+
+        # Safety restrictions
+        cannot :cancel, Spree::Order
+        can :cancel, Spree::Order, &:allow_cancel?
+        cannot :destroy, Spree::Order
+        can :destroy, Spree::Order, &:can_be_deleted?
+        cannot [:edit, :update], Spree::RefundReason, mutable: false
+        cannot [:edit, :update], Spree::ReimbursementType, mutable: false
+
+        # Protect the admin role from modification
+        cannot [:update, :destroy], Spree::Role, name: ['admin']
+      end
+    end
+  end
+end

data/app/models/spree/permission_sets/user_display.rb

@@ -0,0 +1,19 @@
+# Permission set for viewing users and related information.
+#
+# This permission set provides read-only access to user accounts,
+# addresses, and credit cards.
+#
+# @example
+#   Spree.permissions.assign(:support_staff, Spree::PermissionSets::UserDisplay)
+#
+module Spree
+  module PermissionSets
+    class UserDisplay < Base
+      def activate!
+        can [:read, :admin, :index], Spree.user_class
+        can [:read, :admin], Spree::Address
+        can [:read, :admin], Spree::CreditCard
+      end
+    end
+  end
+end

data/app/models/spree/permission_sets/user_management.rb

@@ -0,0 +1,20 @@
+# Permission set for full user management.
+#
+# This permission set provides complete access to manage user accounts,
+# addresses, and credit cards.
+#
+# @example
+#   Spree.permissions.assign(:customer_service, Spree::PermissionSets::UserManagement)
+#
+module Spree
+  module PermissionSets
+    class UserManagement < Base
+      def activate!
+        can :manage, Spree.user_class
+        can :manage, Spree::Address
+        can :manage, Spree::CreditCard
+        can [:read, :admin], Spree::Metafield
+      end
+    end
+  end
+end

data/app/models/spree/product.rb

@@ -255,8 +255,6 @@ module Spree
     delegate :display_amount, :display_price, :has_default_price?, :track_inventory?,
              :display_compare_at_price, :images, to: :default_variant
 
-    delegate :name, to: :brand, prefix: true, allow_nil: true
-
     alias master_images images
 
     state_machine :status, initial: :draft do
@@ -550,7 +548,22 @@ module Spree
       super || variants_including_master.with_deleted.find_by(is_master: true)
     end
 
+    # Returns the brand for the product
+    # If a brand association is defined (e.g., belongs_to :brand), it will be used
+    # Otherwise, falls back to brand_taxon for compatibility
+    # @return [Spree::Brand, Spree::Taxon]
     def brand
+      if self.class.reflect_on_association(:brand)
+        super
+      else
+        Spree::Deprecation.warn('Spree::Product#brand is deprecated and will be removed in Spree 6. Please use Spree::Product#brand_taxon instead.')
+        brand_taxon
+      end
+    end
+
+    # Returns the brand taxon for the product
+    # @return [Spree::Taxon]
+    def brand_taxon
       @brand ||= if Spree.use_translations?
                    taxons.joins(:taxonomy).
                      join_translation_table(Taxonomy).
@@ -564,7 +577,28 @@ module Spree
                  end
     end
 
+    # Returns the brand name for the product
+    # @return [String]
+    def brand_name
+      brand&.name
+    end
+
+    # Returns the category for the product
+    # If a category association is defined (e.g., belongs_to :category), it will be used
+    # Otherwise, falls back to category_taxon for compatibility
+    # @return [Spree::Category, Spree::Taxon]
     def category
+      if self.class.reflect_on_association(:category)
+        super
+      else
+        Spree::Deprecation.warn('Spree::Product#category is deprecated and will be removed in Spree 6. Please use Spree::Product#category_taxon instead.')
+        category_taxon
+      end
+    end
+
+    # Returns the category taxon for the product
+    # @return [Spree::Taxon]
+    def category_taxon
       @category ||= if Spree.use_translations?
                       taxons.joins(:taxonomy).
                         join_translation_table(Taxonomy).
@@ -580,7 +614,7 @@ module Spree
     end
 
     def main_taxon
-      category || taxons.first
+      category_taxon || taxons.first
     end
 
     def taxons_for_store(store)

data/app/models/spree/stock/coordinator.rb

@@ -60,7 +60,7 @@ module Spree
 
       def splitters(_stock_location)
         # extension point to return custom splitters for a location
-        Rails.application.config.spree.stock_splitters
+        Spree.stock_splitters
       end
     end
   end

data/app/models/spree/taxon.rb

@@ -324,6 +324,7 @@ module Spree
     # indicate which filters should be used for a taxon
     # this method should be customized to your own site
     def applicable_filters
+      Spree::Deprecation.warn('applicable_filters is deprecated and will be removed in Spree 6.0')
       fs = []
       # fs << ProductFilters.taxons_below(self)
       ## unless it's a root taxon? left open for demo purposes

data/app/models/spree/theme.rb

@@ -56,7 +56,7 @@ module Spree
     #
     # @return [Array<Spree::Theme>]
     def self.available_themes
-      @available_themes ||= Rails.application.config.spree.themes.sort_by(&:display_name)
+      @available_themes ||= Spree.page_builder.themes.sort_by(&:display_name)
     end
 
     def self.metadata
@@ -98,7 +98,7 @@ module Spree
     end
 
     def create_default_pages
-      Rails.application.config.spree.pages.map(&:to_s).map(&:constantize).each do |page_class|
+      Spree.page_builder.pages.map(&:to_s).map(&:constantize).each do |page_class|
         next if page_class == Spree::Pages::Custom
 
         page_class.where(pageable: self).first_or_create!
@@ -160,7 +160,7 @@ module Spree
     # @return [Array<Class>]
     def available_layout_sections
       [
-        *Rails.application.config.spree.theme_layout_sections,
+        *Spree.page_builder.theme_layout_sections,
         *custom_layout_sections
       ]
     end
@@ -181,7 +181,7 @@ module Spree
       return @available_page_sections if @available_page_sections
 
       @available_page_sections ||= [
-        *Rails.application.config.spree.page_sections.find_all do |section_class|
+        *Spree.page_builder.page_sections.find_all do |section_class|
           section_class.role == 'content'
         end,
         *custom_page_sections

data/app/services/spree/compare_line_items.rb

@@ -4,7 +4,7 @@ module Spree
     prepend Spree::ServiceModule::Base
 
     def call(order:, line_item:, options: {}, comparison_hooks: nil)
-      comparison_hooks ||= Rails.application.config.spree.line_item_comparison_hooks
+      comparison_hooks ||= Spree.line_item_comparison_hooks
 
       legacy_part = comparison_hooks.all? do |hook|
         order.send(hook, line_item, options)

data/app/views/spree/shared/_base_mailer_stylesheets.html.erb

@@ -253,6 +253,11 @@
 
   .purchase_image {
     padding: 5px;
+    width: 100px;
+
+    img {
+      width: 100px;
+    }
   }
 
   .purchase_item p {

data/config/locales/en.yml

@@ -105,6 +105,8 @@ en:
         phone: Shipping address phone
         state: Shipping address state
         zipcode: Shipping address zipcode
+      spree/page_link:
+        open_in_new_tab: Open in new tab
       spree/payment:
         amount: Amount
         number: Number
@@ -200,6 +202,7 @@ en:
       spree/taxonomy:
         name: Name
       spree/user:
+        avatar: Avatar
         email: Email
         password: Password
         password_confirmation: Password Confirmation
@@ -621,6 +624,7 @@ en:
     add_new_style: Add New Style
     add_one: Add One
     add_option_value: Add Option Value
+    add_page_block: Add Block
     add_product: Add Product
     add_product_properties: Add Product Properties
     add_products: Add Products
@@ -1622,6 +1626,7 @@ en:
     payment_updated: Payment Updated
     payments: Payments
     payments_count: Payments count
+    payments_gateway_processing_errors: "%{payment_method_name} processing errors"
     pending: Pending
     pending_sale: Pending Sale
     percent: Percent

data/lib/friendly_id/history_decorator.rb

@@ -0,0 +1,26 @@
+module FriendlyId
+  module HistoryDecorator
+    private
+
+    # This a patch to friendly_id history module.
+    # Originally, it removes and re-creates a slug record if it already exists. The issue is that we use `acts_as_paranoid`
+    # for slugs so it sets the `deleted_at` timestamp instead of deleting the record. We need to delete the record instead.
+    def create_slug
+      return unless friendly_id
+      return if history_is_up_to_date?
+      # Allow reversion back to a previously used slug
+      relation = slugs.where(slug: friendly_id)
+      if friendly_id_config.uses?(:scoped)
+        relation = relation.where(scope: serialized_scope)
+      end
+      # Use `delete_all` instead of `destroy_all` to avoid the unique index error.
+      relation.delete_all unless relation.empty?
+      slugs.create! do |record|
+        record.slug = friendly_id
+        record.scope = serialized_scope if friendly_id_config.uses?(:scoped)
+      end
+    end
+  end
+end
+
+FriendlyId::History.prepend(FriendlyId::HistoryDecorator)

data/lib/generators/spree/cursor_rules/templates/spree_rules.mdc

@@ -255,7 +255,7 @@ bin/rails g spree:storefront:theme MyTheme
 
 ```ruby
 # Register theme in config/initializers/spree.rb
-Rails.application.config.spree.themes << Spree::Themes::MyTheme
+Spree.page_builder.themes << Spree::Themes::MyTheme
 ```
 
 #### View Overrides

data/lib/generators/spree/install/templates/config/initializers/spree.rb

@@ -61,33 +61,65 @@ end
 # uncomment lines below to add your own custom business logic
 # such as promotions, shipping methods, etc
 Rails.application.config.after_initialize do
-  # Rails.application.config.spree.shipping_methods << Spree::ShippingMethods::SuperExpensiveNotVeryFastShipping
-  # Rails.application.config.spree.payment_methods << Spree::PaymentMethods::VerySafeAndReliablePaymentMethod
+  # Payment methods and shipping calculators
+  # Spree.payment_methods << Spree::PaymentMethods::VerySafeAndReliablePaymentMethod
+  # Spree.calculators.shipping_methods << Spree::ShippingMethods::SuperExpensiveNotVeryFastShipping
+  # Spree.calculators.tax_rates << Spree::TaxRates::FinanceTeamForcedMeToCodeThis
 
-  # Rails.application.config.spree.calculators.tax_rates << Spree::TaxRates::FinanceTeamForcedMeToCodeThis
-
-  # Rails.application.config.spree.stock_splitters << Spree::Stock::Splitters::SecretLogicSplitter
-
-  # Rails.application.config.spree.adjusters << Spree::Adjustable::Adjuster::TaxTheRich
+  # Stock splitters and adjusters
+  # Spree.stock_splitters << Spree::Stock::Splitters::SecretLogicSplitter
+  # Spree.adjusters << Spree::Adjustable::Adjuster::TaxTheRich
 
   # Custom promotions
-  # Rails.application.config.spree.calculators.promotion_actions_create_adjustments << Spree::Calculators::PromotionActions::CreateAdjustments::AddDiscountForFriends
-  # Rails.application.config.spree.calculators.promotion_actions_create_item_adjustments << Spree::Calculators::PromotionActions::CreateItemAdjustments::FinanceTeamForcedMeToCodeThis
-  # Rails.application.config.spree.promotions.rules << Spree::Promotions::Rules::OnlyForVIPCustomers
-  # Rails.application.config.spree.promotions.actions << Spree::Promotions::Actions::GiftWithPurchase
-
-  # Rails.application.config.spree.taxon_rules << Spree::TaxonRules::ProductsWithColor
-
-  # Rails.application.config.spree.exports << Spree::Exports::Payments
-  # Rails.application.config.spree.reports << Spree::Reports::MassivelyOvercomplexReportForCfo
-
-  # Themes and page builder
-  # Rails.application.config.spree.themes << Spree::Themes::NewShinyTheme
-  # Rails.application.config.spree.theme_layout_sections << Spree::PageSections::SuperImportantCeoBio
-  # Rails.application.config.spree.page_sections << Spree::PageSections::ContactFormToGetInTouch
-  # Rails.application.config.spree.page_blocks << Spree::PageBlocks::BigRedButtonToCallSales
-
-  # Rails.application.config.spree_storefront.head_partials << 'spree/shared/that_js_snippet_that_marketing_forced_me_to_include'
+  # Spree.calculators.promotion_actions_create_adjustments << Spree::Calculators::PromotionActions::CreateAdjustments::AddDiscountForFriends
+  # Spree.calculators.promotion_actions_create_item_adjustments << Spree::Calculators::PromotionActions::CreateItemAdjustments::FinanceTeamForcedMeToCodeThis
+  # Spree.promotions.rules << Spree::Promotions::Rules::OnlyForVIPCustomers
+  # Spree.promotions.actions << Spree::Promotions::Actions::GiftWithPurchase
+
+  # Taxon rules
+  # Spree.taxon_rules << Spree::TaxonRules::ProductsWithColor
+
+  # Exports and reports
+  # Spree.export_types << Spree::Exports::Payments
+  # Spree.reports << Spree::Reports::MassivelyOvercomplexReportForCfo
+
+  # Page builder (themes, pages, sections, blocks)
+  # Spree.page_builder.themes << Spree::Themes::NewShinyTheme
+  # Spree.page_builder.theme_layout_sections << Spree::PageSections::SuperImportantCeoBio
+  # Spree.page_builder.pages << Spree::Pages::CustomLandingPage
+  # Spree.page_builder.page_sections << Spree::PageSections::ContactFormToGetInTouch
+  # Spree.page_builder.page_blocks << Spree::PageBlocks::BigRedButtonToCallSales
+
+  # Storefront partials
+  # Spree.storefront.partials.head << 'spree/shared/that_js_snippet_that_marketing_forced_me_to_include'
+
+  # Admin partials
+  # Spree.admin.partials.product_form << 'spree/admin/products/custom_section'
+
+  # Role-based permissions
+  # Configure which permission sets are assigned to each role
+  # More on permission sets: https://spreecommerce.org/docs/developer/customization/permissions
+  Spree.permissions.assign(:default, [Spree::PermissionSets::DefaultCustomer])
+  Spree.permissions.assign(:admin, [Spree::PermissionSets::SuperUser])
+
+  # Example: Create a custom role with specific permissions
+  # Spree.permissions.assign(:customer_service, [
+  #   Spree::PermissionSets::DashboardDisplay,
+  #   Spree::PermissionSets::OrderManagement,
+  #   Spree::PermissionSets::UserDisplay
+  # ])
+  #
+  # Available permission sets:
+  # - Spree::PermissionSets::SuperUser (full admin access)
+  # - Spree::PermissionSets::DefaultCustomer (storefront access)
+  # - Spree::PermissionSets::DashboardDisplay (view admin dashboard)
+  # - Spree::PermissionSets::OrderDisplay / OrderManagement
+  # - Spree::PermissionSets::ProductDisplay / ProductManagement
+  # - Spree::PermissionSets::UserDisplay / UserManagement
+  # - Spree::PermissionSets::StockDisplay / StockManagement
+  # - Spree::PermissionSets::PromotionManagement
+  # - Spree::PermissionSets::ConfigurationManagement
+  # - Spree::PermissionSets::RoleManagement
 end
 
 Spree.user_class = <%= (options[:user_class].blank? ? 'Spree::LegacyUser' : options[:user_class]).inspect %>

data/lib/generators/spree/model/model_generator.rb

@@ -0,0 +1,21 @@
+require "rails/generators/active_record/model/model_generator"
+
+module Spree
+  class ModelGenerator < ActiveRecord::Generators::ModelGenerator
+
+    def self.source_paths
+      paths = superclass.source_paths
+      paths << File.expand_path('templates', __dir__)
+      paths.flatten
+    end
+
+    class_option :parent, type: :string, default: "Spree::Base", desc: "The parent class for the generated model"
+
+    desc 'Creates a new Spree model'
+
+    # Override to prevent module file from being created
+    def create_module_file
+      return
+    end
+  end
+end

data/lib/generators/spree/model/templates/model.rb.tt

@@ -0,0 +1,22 @@
+module Spree
+  class <%= class_name.demodulize %> < <%= parent_class_name.classify %>
+<% attributes.select(&:reference?).each do |attribute| -%>
+    belongs_to :<%= attribute.name %><%= ", polymorphic: true" if attribute.polymorphic? %>
+<% end -%>
+<% attributes.select(&:rich_text?).each do |attribute| -%>
+    has_rich_text :<%= attribute.name %>
+<% end -%>
+<% attributes.select(&:attachment?).each do |attribute| -%>
+    has_one_attached :<%= attribute.name %>
+<% end -%>
+<% attributes.select(&:attachments?).each do |attribute| -%>
+    has_many_attached :<%= attribute.name %>
+<% end -%>
+<% attributes.select(&:token?).each do |attribute| -%>
+    has_secure_token<% if attribute.name != "token" %> :<%= attribute.name %><% end %>
+<% end -%>
+<% if attributes.any?(&:password_digest?) -%>
+    has_secure_password
+<% end -%>
+  end
+end

data/lib/generators/spree/model_decorator/model_decorator_generator.rb

@@ -0,0 +1,37 @@
+module Spree
+  class ModelDecoratorGenerator < Rails::Generators::NamedBase
+    desc 'Creates a model decorator for a Spree model'
+
+    argument :name, type: :string, required: true, banner: 'Spree::ModelName'
+
+    def self.source_paths
+      paths = superclass.source_paths
+      paths << File.expand_path('templates', __dir__)
+      paths.flatten
+    end
+
+    def create_model_decorator_file
+      template 'model_decorator.rb.tt', "app/models/#{file_path}_decorator.rb"
+    end
+
+    private
+
+    # Returns the model name without the Spree:: prefix
+    # e.g., "Spree::Product" => "Product", "Product" => "Product"
+    def model_name
+      name.sub(/^Spree::/, '').classify
+    end
+
+    # Returns the decorator module name
+    # e.g., "Spree::Product" => "ProductDecorator"
+    def decorator_name
+      "#{model_name}Decorator"
+    end
+
+    # Returns the file path for the decorator
+    # e.g., "Spree::Product" => "spree/product", "Product" => "spree/product"
+    def file_path
+      "spree/#{model_name.underscore}"
+    end
+  end
+end

data/lib/generators/spree/model_decorator/templates/model_decorator.rb.tt

@@ -0,0 +1,12 @@
+module Spree
+  module <%= decorator_name %>
+    def self.prepended(base)
+      # base.belongs_to :brand
+    end
+
+    # add custom methods here
+  end
+end
+
+Spree::<%= model_name %>.prepend Spree::<%= decorator_name %>
+

data/lib/spree/analytics.rb

@@ -1,11 +1,11 @@
 module Spree
   module Analytics
     def self.events
-      @@supported_events ||= Rails.application.config.spree.analytics_events
+      @@supported_events ||= Spree.analytics.events
     end
 
     def self.event_handlers
-      @@event_handlers ||= Rails.application.config.spree.analytics_event_handlers
+      @@event_handlers ||= Spree.analytics.handlers
     end
   end
 end

data/lib/spree/core/engine.rb

@@ -24,14 +24,14 @@ module Spree
                                :page_blocks,
                                :reports,
                                :translatable_resources,
-                               :metafield_types,
-                               :metafield_enabled_resources,
+                               :metafields,
                                :analytics_events,
                                :analytics_event_handlers,
                                :integrations)
       SpreeCalculators = Struct.new(:shipping_methods, :tax_rates, :promotion_actions_create_adjustments, :promotion_actions_create_item_adjustments)
       PromoEnvironment = Struct.new(:rules, :actions)
       SpreeValidators = Struct.new(:addresses)
+      MetafieldsEnvironment = Struct.new(:types, :enabled_resources)
       isolate_namespace Spree
       engine_name 'spree'
 
@@ -66,6 +66,12 @@ module Spree
       initializer 'spree.register.adjustable_adjusters' do |app|
       end
 
+      initializer 'spree.register.metafields' do |app|
+        app.config.spree.metafields = MetafieldsEnvironment.new
+        app.config.spree.metafields.types = []
+        app.config.spree.metafields.enabled_resources = []
+      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|
@@ -260,7 +266,7 @@ module Spree
           Spree::Policy
         ]
 
-        Rails.application.config.spree.metafield_types = [
+        Rails.application.config.spree.metafields.types = [
           Spree::Metafields::ShortText,
           Spree::Metafields::LongText,
           Spree::Metafields::RichText,
@@ -269,7 +275,7 @@ module Spree
           Spree::Metafields::Json
         ]
 
-        Rails.application.config.spree.metafield_enabled_resources = [
+        Rails.application.config.spree.metafields.enabled_resources = [
           Spree::Address,
           Spree::Asset,
           Spree::CreditCard,