Merge pull request #6245 from mamhoff/current-user-roles-helper

Refactor load_user_roles into current_user_roles helper

Author: tvdeyen

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-05-28 15:33:32 UTC using RuboCop version 1.75.7.
+# on 2025-05-29 09:46:52 UTC using RuboCop version 1.75.7.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -51,7 +51,7 @@ Layout/ClosingHeredocIndentation:
   Exclude:
     - 'core/solidus_core.gemspec'
 
-# Offense count: 94
+# Offense count: 95
 # This cop supports safe autocorrection (--autocorrect).
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
@@ -343,12 +343,11 @@ Rails/FilePath:
 Rails/HasManyOrHasOneDependent:
   Enabled: false
 
-# Offense count: 30
+# Offense count: 29
 # Configuration parameters: Include.
 # Include: **/app/helpers/**/*.rb
 Rails/HelperInstanceVariable:
   Exclude:
-    - 'api/app/helpers/spree/api/api_helpers.rb'
     - 'backend/app/helpers/spree/admin/base_helper.rb'
     - 'backend/app/helpers/spree/admin/orders_helper.rb'
     - 'core/app/helpers/spree/base_helper.rb'

api/app/controllers/spree/api/base_controller.rb

@@ -26,7 +26,8 @@ class BaseController < ActionController::Base
       before_action :load_user
       before_action :authorize_for_order, if: proc { order_token.present? }
       before_action :authenticate_user
-      before_action :load_user_roles
+      # This is deprecated and will be removed in Spree 5.0
+      before_action :load_deprecated_user_roles
 
       rescue_from ActionController::ParameterMissing, with: :parameter_missing_error
       rescue_from ActiveRecord::RecordNotFound, with: :not_found
@@ -35,6 +36,7 @@ class BaseController < ActionController::Base
       rescue_from StateMachines::InvalidTransition, with: :invalid_transition
 
       helper Spree::Api::ApiHelpers
+      helper_method :current_user_roles
 
       private
 
@@ -75,8 +77,16 @@ def authenticate_user
         end
       end
 
-      def load_user_roles
-        @current_user_roles = if @current_api_user
+      def load_deprecated_user_roles
+        @current_user_roles = if Rails.version < Gem::Version.new("7.2.0")
+          ActiveSupport::Deprecation::DeprecatedInstanceVariableProxy.new(self, :current_user_roles, :@current_user_roles, Spree.deprecator)
+        else
+          ActiveSupport::Deprecation::DeprecatedInstanceVariableProxy.new(self, :current_user_roles, :@current_user_roles, deprecator: Spree.deprecator)
+        end
+      end
+
+      def current_user_roles
+        @_current_user_roles ||= if @current_api_user
           @current_api_user.spree_roles.pluck(:name)
         else
           []

api/app/controllers/spree/api/line_items_controller.rb

@@ -66,7 +66,7 @@ def line_items_attributes
       def extract_metadata
         metadata = { customer_metadata: line_item_params[:customer_metadata] }
 
-        if @current_user_roles&.include?("admin")
+        if current_user_roles&.include?("admin")
           metadata[:admin_metadata] = line_item_params[:admin_metadata]
         end
 

api/app/helpers/spree/api/api_helpers.rb

@@ -67,7 +67,7 @@ def required_fields_for(model)
 
       def variant_attributes
         preference_attributes = Spree::Api::Config.variant_attributes
-        if @current_user_roles&.include?("admin")
+        if current_user_roles&.include?("admin")
           preference_attributes + [:cost_price]
         else
           preference_attributes

api/app/views/spree/api/payments/source_views/_gateway.json.jbuilder

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 attrs = [:id, :month, :year, :cc_type, :last_digits, :name]
-if @current_user_roles.include?("admin")
+if current_user_roles.include?("admin")
   attrs += [:gateway_customer_profile_id, :gateway_payment_profile_id]
 end
 

api/app/views/spree/api/products/_product.json.jbuilder

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 @product_attributes ||= product_attributes
-json.cache! [I18n.locale, @current_user_roles.include?('admin'), current_pricing_options, @product_attributes, @exclude_data, product] do
+json.cache! [I18n.locale, current_user_roles.include?('admin'), current_pricing_options, @product_attributes, @exclude_data, product] do
   json.(product, *(@product_attributes - [:total_on_hand]))
   json.total_on_hand(total_on_hand_for(product))
   json.price(product.price_for_options(current_pricing_options)&.amount)