Merge pull request #2178 from cbrunsdon/early_config

Move preferences to /lib

CHANGELOG.md

@@ -27,6 +27,8 @@
 
 - Remove Skeleton Grid CSS from the admin and complete its transition to Bootstrap. [\#2127](https://github.com/solidusio/solidus/pull/2127) ([graygilmore](https://github.com/graygilmore))
 
+- Move preferences namespace to /lib. Initializes the Spree::Config object in its own file. [\#2178](https://github.com/solidusio/solidus/pull/2178) ([cbrunsdon](https://github.com/cbrunsdon))
+
 ## Solidus 2.3.0 (unreleased)
 
 - Rails 5.1 [\#1895](https://github.com/solidusio/solidus/pull/1895) ([jhawthorn](https://github.com/jhawthorn))

core/app/models/spree/payment_method.rb

@@ -1,3 +1,5 @@
+require 'spree/preferences/statically_configurable'
+
 module Spree
   # A base class which is used for implementing payment methods.
   #

core/app/models/spree/app_configuration.rb → core/lib/spree/app_configuration.rb

@@ -17,6 +17,7 @@
 #
 require "spree/core/search/base"
 require "spree/core/search/variant"
+require 'spree/preferences/configuration'
 
 module Spree
   class AppConfiguration < Preferences::Configuration

core/lib/spree/config.rb

@@ -0,0 +1,3 @@
+require 'spree/app_configuration'
+
+Spree::Config = Spree::AppConfiguration.new

core/lib/spree/core.rb

@@ -86,3 +86,7 @@ class GatewayError < RuntimeError; end
 require 'spree/permission_sets'
 
 require 'spree/core/price_migrator'
+
+require 'spree/preferences/store'
+require 'spree/preferences/static_model_preferences'
+require 'spree/preferences/scoped_store'

core/lib/spree/core/engine.rb

@@ -10,7 +10,6 @@ class Engine < ::Rails::Engine
 
       initializer "spree.environment", before: :load_config_initializers do |app|
         app.config.spree = Spree::Core::Environment.new
-        Spree::Config = app.config.spree.preferences # legacy access
       end
 
       initializer "spree.default_permissions", before: :load_config_initializers do |_app|

core/lib/spree/core/environment.rb

@@ -1,3 +1,5 @@
+require 'spree/config'
+
 module Spree
   module Core
     class Environment
@@ -10,7 +12,7 @@ class Environment
 
       def initialize
         @calculators = Calculators.new
-        @preferences = Spree::AppConfiguration.new
+        @preferences = Spree::Config
         @promotions = Spree::Promo::Environment.new
       end
     end

core/app/models/spree/preferences/configuration.rb → core/lib/spree/preferences/configuration.rb

@@ -1,3 +1,5 @@
+require 'spree/preferences/preferable'
+
 module Spree::Preferences
   # This takes the preferrable methods and adds some
   # syntatic sugar to access the preferences

core/lib/spree/preferences/preferable.rb

@@ -0,0 +1,140 @@
+# Preferable allows defining preference accessor methods.
+#
+# A class including Preferable must implement #preferences which should return
+# an object responding to .fetch(key), []=(key, val), and .delete(key).
+#
+# The generated writer method performs typecasting before assignment into the
+# preferences object.
+#
+# Examples:
+#
+#   # Spree::Base includes Preferable and defines preferences as a serialized
+#   # column.
+#   class Settings < Spree::Base
+#     preference :color,       :string,  default: 'red'
+#     preference :temperature, :integer, default: 21
+#   end
+#
+#   s = Settings.new
+#   s.preferred_color # => 'red'
+#   s.preferred_temperature # => 21
+#
+#   s.preferred_color = 'blue'
+#   s.preferred_color # => 'blue'
+#
+#   # Typecasting is performed on assignment
+#   s.preferred_temperature = '24'
+#   s.preferred_color # => 24
+#
+#   # Modifications have been made to the .preferences hash
+#   s.preferences #=> {color: 'blue', temperature: 24}
+#
+#   # Save the changes. All handled by activerecord
+#   s.save!
+
+require 'spree/preferences/preferable_class_methods'
+
+module Spree
+  module Preferences
+    module Preferable
+      extend ActiveSupport::Concern
+
+      included do
+        extend Spree::Preferences::PreferableClassMethods
+      end
+
+      # Get a preference
+      # @param name [#to_sym] name of preference
+      # @return [Object] The value of preference +name+
+      def get_preference(name)
+        has_preference! name
+        send self.class.preference_getter_method(name)
+      end
+
+      # Set a preference
+      # @param name [#to_sym] name of preference
+      # @param value [Object] new value for preference +name+
+      def set_preference(name, value)
+        has_preference! name
+        send self.class.preference_setter_method(name), value
+      end
+
+      # @param name [#to_sym] name of preference
+      # @return [Symbol] The type of preference +name+
+      def preference_type(name)
+        has_preference! name
+        send self.class.preference_type_getter_method(name)
+      end
+
+      # @param name [#to_sym] name of preference
+      # @return [Object] The default for preference +name+
+      def preference_default(name)
+        has_preference! name
+        send self.class.preference_default_getter_method(name)
+      end
+
+      # Raises an exception if the +name+ preference is not defined on this class
+      # @param name [#to_sym] name of preference
+      def has_preference!(name)
+        raise NoMethodError.new "#{name} preference not defined" unless has_preference? name
+      end
+
+      # @param name [#to_sym] name of preference
+      # @return [Boolean] if preference exists on this class
+      def has_preference?(name)
+        defined_preferences.include?(name.to_sym)
+      end
+
+      # @return [Array<Symbol>] All preferences defined on this class
+      def defined_preferences
+        self.class.defined_preferences
+      end
+
+      # @return [Hash{Symbol => Object}] Default for all preferences defined on this class
+      def default_preferences
+        Hash[
+          defined_preferences.map do |preference|
+            [preference, preference_default(preference)]
+          end
+        ]
+      end
+
+      private
+
+      def convert_preference_value(value, type)
+        return nil if value.nil?
+        case type
+        when :string, :text
+          value.to_s
+        when :password
+          value.to_s
+        when :decimal
+          begin
+            value.to_s.to_d
+          rescue ArgumentError
+            BigDecimal.new(0)
+          end
+        when :integer
+          value.to_i
+        when :boolean
+          if !value ||
+             value == 0 ||
+             value =~ /\A(f|false|0)\Z/i ||
+             (value.respond_to?(:empty?) && value.empty?)
+            false
+          else
+            true
+          end
+        when :array
+          raise TypeError, "Array expected got #{value.inspect}" unless value.is_a?(Array)
+          value
+        when :hash
+          raise TypeError, "Hash expected got #{value.inspect}" unless value.is_a?(Hash)
+          value
+        else
+          value
+        end
+      end
+    end
+  end
+end