solidus_core 2.11.7 → 2.11.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4d85b2e48b45c5f20a8de9e1152813de4731e283946bb69c1bef2c01b8b9455
-  data.tar.gz: 78b9982563a8722a9892313dc8c3a4f2631d291679cad631c482c13b25279090
+  metadata.gz: e0d36b03697769f4d9449dfeac2da6004e9d06b7d1575489abbbecf5497dfae1
+  data.tar.gz: a0de4d86e474402ac44765317ab8ffb2967dbb4de6675491616af185e17fb3dd
 SHA512:
-  metadata.gz: ae52ba5c560040d3e6096d129dafc377b59de4ac7a536728f28c5099846d727e511ae2604f72f47473117cdc25e6b69e3aa690aeecc3df9d57a66b592cd73b80
-  data.tar.gz: 2662be65dd3122d1f35bbd272b2b341ec4a54f123bde9acadb5145b726164a8bed4b4956d62c9577527ce9f130c040ffff0958bd576525c29eb7690d7bbf8ea6
+  metadata.gz: 6f1a2577af4ea0108060bb3e9d81e81fa7114813b6ce5b1d925f53378da6b2f9c41b5e22d67d65389d2ee4e3d57719c79855fa4bbbb820f0cac68b63afeb313a
+  data.tar.gz: f4bf3efd9563905b2eca58c6df0b95c9c1591b0a46c07cbc4bfaaed0000cd691f2e9333dc7f860c78a0a450c38f38f2a74d1b8ab63f15e188ac46de5d7080520

data/app/models/spree/base.rb

@@ -1,28 +1,50 @@
 # frozen_string_literal: true
 
+require 'spree/preferences/persistable'
+
 class Spree::Base < ActiveRecord::Base
-  include Spree::Preferences::Preferable
   include Spree::Core::Permalinks
   include Spree::RansackableAttributes
 
-  def preferences
-    read_attribute(:preferences) || self.class.preferences_coder_class.new
+  def self.preference(*args)
+    Spree::Deprecation.warn <<~WARN
+      #{name} has a `preferences` column, but does not explicitly (de)serialize this column.
+      In order to make #{name} work with future versions of Solidus (and Rails), please add the
+      following line to your class:
+      ```
+      class #{name}
+        include Spree::Preferences::Persistable
+        ...
+      end
+      ```
+    WARN
+    include Spree::Preferences::Persistable
+    preference(*args)
   end
 
-  def initialize_preference_defaults
-    if has_attribute?(:preferences)
-      self.preferences = default_preferences.merge(preferences)
-    end
-  end
+  def preferences
+    value = read_attribute(:preferences)
+    if !value.is_a?(Hash)
+      Spree::Deprecation.warn <<~WARN
+        #{self.class.name} has a `preferences` column, but does not explicitly (de)serialize this column.
+        In order to make #{self.class.name} work with future versions of Solidus (and Rails), please add the
+        following lines to your class:
+        ```
+        class #{self.class.name}
+          include Spree::Preferences::Persistable
+          ...
+        end
+        ```
+      WARN
+      self.class.include Spree::Preferences::Persistable
 
-  # Only run preference initialization on models which requires it. Improves
-  # performance of record initialization slightly.
-  def self.preference(*args)
-    # after_initialize can be called multiple times with the same symbol, it
-    # will only be called once on initialization.
-    serialize :preferences, preferences_coder_class
-    after_initialize :initialize_preference_defaults
-    super
+      ActiveRecord::Type::Serialized.new(
+        ActiveRecord::Type::Text.new,
+        ActiveRecord::Coders::YAMLColumn.new(:preferences, Hash)
+      ).deserialize(value)
+    else
+      value
+    end
   end
 
   if Kaminari.config.page_method_name != :page
@@ -35,10 +57,6 @@ class Spree::Base < ActiveRecord::Base
     end
   end
 
-  def self.preferences_coder_class
-    Hash
-  end
-
   self.abstract_class = true
 
   # Provides a scope that should be included any time products

data/app/models/spree/calculator.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
+require 'spree/preferences/persistable'
+
 module Spree
   class Calculator < Spree::Base
+    include Spree::Preferences::Persistable
+
     belongs_to :calculable, polymorphic: true, optional: true
 
     # This method calls a compute_<computable> method. must be overriden in concrete calculator.

data/app/models/spree/payment_method.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'spree/preferences/persistable'
 require 'spree/preferences/statically_configurable'
 
 module Spree
@@ -11,6 +12,8 @@ module Spree
   # This class is not meant to be instantiated. Please create instances of concrete payment methods.
   #
   class PaymentMethod < Spree::Base
+    include Spree::Preferences::Persistable
+
     preference :server, :string, default: 'test'
     preference :test_mode, :boolean, default: true
 

data/app/models/spree/promotion_action.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
+require 'spree/preferences/persistable'
+
 module Spree
   # Base class for all types of promotion action.
   #
   # PromotionActions perform the necessary tasks when a promotion is activated
   # by an event and determined to be eligible.
   class PromotionAction < Spree::Base
+    include Spree::Preferences::Persistable
     include Spree::SoftDeletable
 
     belongs_to :promotion, class_name: 'Spree::Promotion', inverse_of: :promotion_actions, optional: true

data/app/models/spree/promotion_rule.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
+require 'spree/preferences/persistable'
+
 module Spree
   # Base class for all promotion rules
   class PromotionRule < Spree::Base
+    include Spree::Preferences::Persistable
+
     belongs_to :promotion, class_name: 'Spree::Promotion', inverse_of: :promotion_rules, optional: true
 
     scope :of_type, ->(type) { where(type: type) }

data/lib/spree/core/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Spree
-  VERSION = "2.11.7"
+  VERSION = "2.11.8"
 
   def self.solidus_version
     VERSION

data/lib/spree/preferences/persistable.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Spree
+  module Preferences
+    module Persistable
+      extend ActiveSupport::Concern
+
+      included do
+        include Spree::Preferences::Preferable
+        serialize :preferences, Hash
+        after_initialize :initialize_preference_defaults
+      end
+
+      private
+
+      def initialize_preference_defaults
+        if has_attribute?(:preferences)
+          self.preferences = default_preferences.merge(preferences)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus_core
 version: !ruby/object:Gem::Version
-  version: 2.11.7
+  version: 2.11.8
 platform: ruby
 authors:
 - Solidus Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-18 00:00:00.000000000 Z
+date: 2021-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -829,6 +829,7 @@ files:
 - lib/spree/permission_sets/user_management.rb
 - lib/spree/permitted_attributes.rb
 - lib/spree/preferences/configuration.rb
+- lib/spree/preferences/persistable.rb
 - lib/spree/preferences/preferable.rb
 - lib/spree/preferences/preferable_class_methods.rb
 - lib/spree/preferences/scoped_store.rb