solidus_core 2.5.2 → 2.6.0.rc1

data/app/models/spree/promotion/actions/free_shipping.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Spree
-  class Promotion
+  class Promotion < Spree::Base
     module Actions
       class FreeShipping < Spree::PromotionAction
         def perform(payload = {})

data/app/models/spree/promotion/rules/first_order.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Spree
-  class Promotion
+  class Promotion < Spree::Base
     module Rules
       class FirstOrder < PromotionRule
         attr_reader :user, :email

data/app/models/spree/promotion/rules/first_repeat_purchase_since.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Spree
-  class Promotion
+  class Promotion < Spree::Base
     module Rules
       class FirstRepeatPurchaseSince < PromotionRule
         preference :days_ago, :integer, default: 365
@@ -14,7 +16,6 @@ module Spree
         #
         # This is eligible if the user's most recently completed order is more than the preferred days ago
         # @param order [Spree::Order]
-        # @option options
         def eligible?(order, _options = {})
           return false unless order.user
 

data/app/models/spree/promotion/rules/item_total.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Spree
-  class Promotion
+  class Promotion < Spree::Base
     module Rules
       # A rule to apply to an order greater than (or greater than or equal to)
       # a specific amount

data/app/models/spree/promotion/rules/nth_order.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class Promotion
     module Rules
@@ -16,7 +18,6 @@ module Spree
         #
         # Use the first order rule if you want a promotion to be applied to the first order for a user.
         # @param order [Spree::Order]
-        # @option options
         def eligible?(order, _options = {})
           return false unless order.user
 

data/app/models/spree/promotion/rules/one_use_per_user.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Spree
-  class Promotion
+  class Promotion < Spree::Base
     module Rules
       class OneUsePerUser < PromotionRule
         def applicable?(promotable)

data/app/models/spree/promotion/rules/option_value.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Spree
-  class Promotion
+  class Promotion < Spree::Base
     module Rules
       class OptionValue < PromotionRule
         MATCH_POLICIES = %w(any)

data/app/models/spree/promotion/rules/product.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Spree
-  class Promotion
+  class Promotion < Spree::Base
     module Rules
       # A rule to limit a promotion based on products in the order.  Can
       # require all or any of the products to be present.  Valid products
@@ -63,8 +65,8 @@ module Spree
           product_ids.join(',')
         end
 
-        def product_ids_string=(s)
-          self.product_ids = s.to_s.split(',').map(&:strip)
+        def product_ids_string=(product_ids)
+          self.product_ids = product_ids.to_s.split(',').map(&:strip)
         end
       end
     end

data/app/models/spree/promotion/rules/store.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Spree
+  class Promotion
+    module Rules
+      class Store < PromotionRule
+        has_many :promotion_rule_stores, class_name: "Spree::PromotionRuleStore",
+                                         foreign_key: :promotion_rule_id,
+                                         dependent: :destroy
+        has_many :stores, through: :promotion_rule_stores, class_name: "Spree::Store"
+
+        def applicable?(promotable)
+          promotable.is_a?(Spree::Order)
+        end
+
+        def eligible?(order, _options = {})
+          stores.none? || stores.include?(order.store)
+        end
+      end
+    end
+  end
+end

data/app/models/spree/promotion/rules/taxon.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Spree
-  class Promotion
+  class Promotion < Spree::Base
     module Rules
       class Taxon < PromotionRule
         has_many :promotion_rule_taxons, class_name: 'Spree::PromotionRuleTaxon', foreign_key: :promotion_rule_id,
@@ -71,9 +73,9 @@ module Spree
           taxons.pluck(:id).join(',')
         end
 
-        def taxon_ids_string=(s)
-          ids = s.to_s.split(',').map(&:strip)
-          self.taxons = Spree::Taxon.find(ids)
+        def taxon_ids_string=(taxon_ids)
+          taxon_ids = taxon_ids.to_s.split(',').map(&:strip)
+          self.taxons = Spree::Taxon.find(taxon_ids)
         end
 
         private
@@ -95,7 +97,6 @@ module Spree
         def rule_taxon_ids_with_children
           taxons.flat_map { |taxon| taxon.self_and_descendants.ids }.uniq
         end
-
       end
     end
   end

data/app/models/spree/promotion/rules/user.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Spree
-  class Promotion
+  class Promotion < Spree::Base
     module Rules
       class User < PromotionRule
         has_many :promotion_rule_users, class_name: 'Spree::PromotionRuleUser',
@@ -19,8 +21,8 @@ module Spree
           user_ids.join(',')
         end
 
-        def user_ids_string=(s)
-          self.user_ids = s.to_s.split(',').map(&:strip)
+        def user_ids_string=(user_ids)
+          self.user_ids = user_ids.to_s.split(',').map(&:strip)
         end
       end
     end

data/app/models/spree/promotion/rules/user_logged_in.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Spree
-  class Promotion
+  class Promotion < Spree::Base
     module Rules
       class UserLoggedIn < PromotionRule
         def applicable?(promotable)

data/app/models/spree/promotion/rules/user_role.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Spree
-  class Promotion
+  class Promotion < Spree::Base
     module Rules
       class UserRole < PromotionRule
         preference :role_ids, :array, default: []

data/app/models/spree/promotion_action.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'discard'
 
 module Spree

data/app/models/spree/promotion_category.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class PromotionCategory < Spree::Base
     validates_presence_of :name

data/app/models/spree/promotion_chooser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class PromotionChooser
     def initialize(adjustments)

data/app/models/spree/promotion_code.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Spree::PromotionCode < Spree::Base
   belongs_to :promotion, inverse_of: :codes
   belongs_to :promotion_code_batch, class_name: "Spree::PromotionCodeBatch"

data/app/models/spree/promotion_code/batch_builder.rb

@@ -1,21 +1,39 @@
+# frozen_string_literal: true
+
 class ::Spree::PromotionCode::BatchBuilder
-  attr_reader :promotion_code_batch
+  attr_reader :promotion_code_batch, :options
   delegate :promotion, :number_of_codes, :base_code, to: :promotion_code_batch
 
-  class_attribute :random_code_length, :batch_size, :sample_characters, :join_characters
-  self.random_code_length = 6
-  self.batch_size = 1_000
-  self.sample_characters = ('a'..'z').to_a + (2..9).to_a.map(&:to_s)
-  self.join_characters = "_"
+  DEFAULT_OPTIONS = {
+    random_code_length: 6,
+    batch_size: 1000,
+    sample_characters: ('a'..'z').to_a + (2..9).to_a.map(&:to_s)
+  }
+
+  [:random_code_length, :batch_size, :sample_characters].each do |attr|
+    define_singleton_method(attr) do
+      Spree::Deprecation.warn "#{name}.#{attr} is deprecated. Use #{name}::DEFAULT_OPTIONS[:#{attr}] instead"
+      DEFAULT_OPTIONS[attr]
+    end
+
+    define_singleton_method(:"#{attr}=") do |val|
+      Spree::Deprecation.warn "#{name}.#{attr}= is deprecated. Use #{name}::DEFAULT_OPTIONS[:#{attr}]= instead"
+      DEFAULT_OPTIONS[attr] = val
+    end
+
+    delegate attr, to: self
+  end
 
-  def initialize(promotion_code_batch)
+  def initialize(promotion_code_batch, options = {})
     @promotion_code_batch = promotion_code_batch
+    options.assert_valid_keys(*DEFAULT_OPTIONS.keys)
+    @options = DEFAULT_OPTIONS.merge(options)
   end
 
   def build_promotion_codes
     generate_random_codes
     promotion_code_batch.update!(state: "completed")
-  rescue => e
+  rescue StandardError => e
     promotion_code_batch.update!(
       error: e.inspect,
       state: "failed"
@@ -27,9 +45,10 @@ class ::Spree::PromotionCode::BatchBuilder
 
   def generate_random_codes
     created_codes = 0
+    batch_size = @options[:batch_size]
 
     while created_codes < number_of_codes
-      max_codes_to_generate = [self.class.batch_size, number_of_codes - created_codes].min
+      max_codes_to_generate = [batch_size, number_of_codes - created_codes].min
 
       new_codes = Array.new(max_codes_to_generate) { generate_random_code }.uniq
       codes_for_current_batch = get_unique_codes(new_codes)
@@ -46,11 +65,11 @@ class ::Spree::PromotionCode::BatchBuilder
   end
 
   def generate_random_code
-    suffix = Array.new(self.class.random_code_length) do
-      sample_characters.sample
+    suffix = Array.new(@options[:random_code_length]) do
+      @options[:sample_characters].sample
     end.join
 
-    "#{base_code}#{join_characters}#{suffix}"
+    "#{base_code}#{@promotion_code_batch.join_characters}#{suffix}"
   end
 
   def get_unique_codes(code_set)

data/app/models/spree/promotion_code_batch.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class PromotionCodeBatch < ActiveRecord::Base
     class CantProcessStartedBatch < StandardError

data/app/models/spree/promotion_handler/cart.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   module PromotionHandler
     # Decides which promotion should be activated given the current order context

data/app/models/spree/promotion_handler/coupon.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   module PromotionHandler
     class Coupon
@@ -23,14 +25,14 @@ module Spree
         self
       end
 
-      def set_success_code(c)
-        @status_code = c
-        @success = I18n.t(c, scope: 'spree')
+      def set_success_code(status_code)
+        @status_code = status_code
+        @success = I18n.t(status_code, scope: 'spree')
       end
 
-      def set_error_code(c)
-        @status_code = c
-        @error = I18n.t(c, scope: 'spree')
+      def set_error_code(status_code)
+        @status_code = status_code
+        @error = I18n.t(status_code, scope: 'spree')
       end
 
       def promotion

data/app/models/spree/promotion_handler/free_shipping.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree::PromotionHandler
   FreeShipping = ActiveSupport::Deprecation::DeprecatedConstantProxy.new(
     'Spree::PromotionHandler::FreeShipping',

data/app/models/spree/promotion_handler/page.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   module PromotionHandler
     class Page

data/app/models/spree/promotion_handler/shipping.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   module PromotionHandler
     # Used for activating promotions with shipping rules

data/app/models/spree/promotion_rule.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   # Base class for all promotion rules
   class PromotionRule < Spree::Base

data/app/models/spree/promotion_rule_role.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class PromotionRuleRole < ActiveRecord::Base
     belongs_to :promotion_rule, class_name: 'Spree::PromotionRule'

data/app/models/spree/promotion_rule_store.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Spree
+  class PromotionRuleStore < Spree::Base
+    self.table_name = "spree_promotion_rules_stores"
+
+    belongs_to :promotion_rule, class_name: "Spree::PromotionRule"
+    belongs_to :store, class_name: "Spree::Store"
+  end
+end

data/app/models/spree/promotion_rule_taxon.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class PromotionRuleTaxon < Spree::Base
     belongs_to :promotion_rule

data/app/models/spree/promotion_rule_user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class PromotionRuleUser < Spree::Base
     self.table_name = 'spree_promotion_rules_users'

data/app/models/spree/property.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class Property < Spree::Base
     has_many :product_properties, dependent: :delete_all, inverse_of: :property

data/app/models/spree/refund.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class Refund < Spree::Base
     belongs_to :payment, inverse_of: :refunds

data/app/models/spree/refund_reason.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class RefundReason < Spree::Base
     include Spree::NamedType

data/app/models/spree/reimbursement.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class Reimbursement < Spree::Base
     class IncompleteReimbursementError < StandardError; end

data/app/models/spree/reimbursement/credit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class Reimbursement < Spree::Base
     class Credit < Spree::Base

data/app/models/spree/reimbursement/reimbursement_type_engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class Reimbursement::ReimbursementTypeEngine
     include Spree::Reimbursement::ReimbursementTypeValidator