solidus_core_devise_token_auth 2.8.0.alpha.0

data/lib/spree/core/controller_helpers/common.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'carmen'
+
+module Spree
+  module Core
+    module ControllerHelpers
+      module Common
+        extend ActiveSupport::Concern
+        included do
+          helper_method :title
+          helper_method :title=
+          helper_method :accurate_title
+
+          layout :get_layout
+
+          before_action :set_user_language
+        end
+
+        protected
+
+        # can be used in views as well as controllers.
+        # e.g. <% self.title = 'This is a custom title for this view' %>
+        attr_writer :title
+
+        def title
+          title_string = @title.present? ? @title : accurate_title
+          if title_string.present?
+            if Spree::Config[:always_put_site_name_in_title]
+              [title_string, default_title].join(' - ')
+            else
+              title_string
+            end
+          else
+            default_title
+          end
+        end
+
+        def default_title
+          current_store.name
+        end
+
+        # this is a hook for subclasses to provide title
+        def accurate_title
+          current_store.seo_title
+        end
+
+        private
+
+        def set_user_language_locale_key
+          :locale
+        end
+
+        def set_user_language
+          available_locales = Spree.i18n_available_locales
+          locale = [
+            params[:locale],
+            session[set_user_language_locale_key],
+            (config_locale if respond_to?(:config_locale, true)),
+            I18n.default_locale
+          ].detect do |candidate|
+            candidate &&
+              available_locales.include?(candidate.to_sym)
+          end
+          session[:locale] = locale
+          I18n.locale = locale
+          Carmen.i18n_backend.locale = locale
+        end
+
+        # Returns which layout to render.
+        #
+        # You can set the layout you want to render inside your Spree configuration with the +:layout+ option.
+        #
+        # Default layout is: +app/views/spree/layouts/spree_application+
+        #
+        def get_layout
+          Spree::Config[:layout]
+        end
+      end
+    end
+  end
+end

data/lib/spree/core/controller_helpers/order.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'spree/core/controller_helpers/pricing'
+
+module Spree
+  module Core
+    module ControllerHelpers
+      module Order
+        extend ActiveSupport::Concern
+        include ControllerHelpers::Pricing
+
+        included do
+          helper_method :current_order
+          helper_method :simple_current_order
+        end
+
+        def simple_current_order
+          return @simple_current_order if @simple_current_order
+
+          @simple_current_order = find_order_by_token_or_user
+
+          if @simple_current_order
+            @simple_current_order.last_ip_address = ip_address
+            return @simple_current_order
+          else
+            @simple_current_order = Spree::Order.new(current_order_params)
+          end
+        end
+        deprecate simple_current_order: :current_order, deprecator: Spree::Deprecation
+
+        # The current incomplete order from the guest_token for use in cart and during checkout
+        def current_order(options = {})
+          options[:create_order_if_necessary] ||= false
+
+          return @current_order if @current_order
+
+          @current_order = find_order_by_token_or_user(options)
+
+          if options[:create_order_if_necessary] && (@current_order.nil? || @current_order.completed?)
+            @current_order = Spree::Order.new(new_order_params)
+            @current_order.user ||= try_spree_current_user
+            # See issue https://github.com/spree/spree/issues/3346 for reasons why this line is here
+            @current_order.created_by ||= try_spree_current_user
+            @current_order.save!
+          end
+
+          if @current_order
+            @current_order.record_ip_address(ip_address)
+            return @current_order
+          end
+        end
+
+        def associate_user
+          @order ||= current_order
+          if try_spree_current_user && @order
+            @order.associate_user!(try_spree_current_user) if @order.user.blank? || @order.email.blank?
+          end
+        end
+
+        def set_current_order
+          if try_spree_current_user && current_order
+            try_spree_current_user.orders.by_store(current_store).incomplete.where('id != ?', current_order.id).each do |order|
+              current_order.merge!(order, try_spree_current_user)
+            end
+          end
+        end
+
+        def ip_address
+          request.remote_ip
+        end
+
+        private
+
+        def last_incomplete_order
+          @last_incomplete_order ||= try_spree_current_user.last_incomplete_spree_order(store: current_store)
+        end
+
+        def current_order_params
+          { currency: current_pricing_options.currency, guest_token: cookies.signed[:guest_token], store_id: current_store.id, user_id: try_spree_current_user.try(:id) }
+        end
+
+        def new_order_params
+          current_order_params.merge(last_ip_address: ip_address)
+        end
+
+        def find_order_by_token_or_user(options = {}, with_adjustments = false)
+          options[:lock] ||= false
+
+          # Find any incomplete orders for the guest_token
+          if with_adjustments
+            Spree::Deprecation.warn "The second argument to find_order_by_token_or_user is deprecated, and will be removed in a future version."
+            order = Spree::Order.incomplete.includes(:adjustments).lock(options[:lock]).find_by(current_order_params)
+          else
+            order = Spree::Order.incomplete.lock(options[:lock]).find_by(current_order_params)
+          end
+
+          # Find any incomplete orders for the current user
+          if order.nil? && try_spree_current_user
+            order = last_incomplete_order
+          end
+
+          order
+        end
+      end
+    end
+  end
+end

data/lib/spree/core/controller_helpers/payment_parameters.rb

@@ -0,0 +1,221 @@
+# frozen_string_literal: true
+
+module Spree
+  module Core::ControllerHelpers::PaymentParameters
+    # This method handles the awkwardness of how the html forms are currently
+    # set up for frontend.
+    #
+    # This method expects a params hash in the format of:
+    #
+    #  {
+    #    payment_source: {
+    #      # The keys here are spree_payment_method.id's
+    #      '1' => {...source attributes for payment method 1...},
+    #      '2' => {...source attributes for payment method 2...},
+    #    },
+    #    order: {
+    #      # Note that only a single entry is expected/handled in this array
+    #      payments_attributes: [
+    #        {
+    #          payment_method_id: '1',
+    #        },
+    #      ],
+    #      ...other params...
+    #    },
+    #    ...other params...
+    #  }
+    #
+    # And this method modifies the params into the format of:
+    #
+    #  {
+    #    order: {
+    #      payments_attributes: [
+    #        {
+    #          payment_method_id: '1',
+    #          source_attributes: {...source attributes for payment method 1...}
+    #        },
+    #      ],
+    #      ...other params...
+    #    },
+    #    ...other params...
+    #  }
+    #
+    def move_payment_source_into_payments_attributes(params)
+      # Step 1: Gather all the information and ensure all the pieces are there.
+
+      return params if params[:payment_source].blank?
+
+      payment_params = params[:order] &&
+                       params[:order][:payments_attributes] &&
+                       params[:order][:payments_attributes].first
+      return params if payment_params.blank?
+
+      payment_method_id = payment_params[:payment_method_id]
+      return params if payment_method_id.blank?
+
+      source_params = params[:payment_source][payment_method_id]
+      return params if source_params.blank?
+
+      # Step 2: Perform the modifications.
+
+      payment_params[:source_attributes] = source_params
+      params.delete(:payment_source)
+
+      params
+    end
+
+    # This method handles the awkwardness of how the html forms are currently
+    # set up for frontend.
+    #
+    # This method expects a params hash in the format of:
+    #
+    #  {
+    #    order: {
+    #      existing_card: '123',
+    #      ...other params...
+    #    },
+    #    cvc_confirm: '456', # optional
+    #    ...other params...
+    #  }
+    #
+    # And this method modifies the params into the format of:
+    #
+    #  {
+    #    order: {
+    #      payments_attributes: [
+    #        {
+    #          source_attributes: {
+    #            existing_card_id: '123',
+    #            verification_value: '456',
+    #          },
+    #        },
+    #      ]
+    #      ...other params...
+    #    },
+    #    ...other params...
+    #  }
+    #
+    def move_existing_card_into_payments_attributes(params)
+      return params if params[:order].blank?
+
+      card_id = params[:order][:existing_card].presence
+      cvc_confirm = params[:cvc_confirm].presence
+
+      return params if card_id.nil?
+
+      params[:order][:payments_attributes] = [
+        {
+          source_attributes: {
+            existing_card_id: card_id,
+            verification_value: cvc_confirm
+          }
+        }
+      ]
+
+      params[:order].delete(:existing_card)
+      params.delete(:cvc_confirm)
+
+      params
+    end
+
+    # This method handles the awkwardness of how the html forms are currently
+    # set up for frontend.
+    #
+    # This method expects a params hash in the format of:
+    #
+    #  {
+    #    order: {
+    #      wallet_payment_source_id: '123',
+    #      ...other params...
+    #    },
+    #    cvc_confirm: '456', # optional
+    #    ...other params...
+    #  }
+    #
+    # And this method modifies the params into the format of:
+    #
+    #  {
+    #    order: {
+    #      payments_attributes: [
+    #        {
+    #          source_attributes: {
+    #            wallet_payment_source_id: '123',
+    #            verification_value: '456',
+    #          },
+    #        },
+    #      ]
+    #      ...other params...
+    #    },
+    #    ...other params...
+    #  }
+    #
+    def move_wallet_payment_source_id_into_payments_attributes(params)
+      return params if params[:order].blank?
+
+      wallet_payment_source_id = params[:order][:wallet_payment_source_id].presence
+      cvc_confirm = params[:cvc_confirm].presence
+
+      return params if wallet_payment_source_id.nil?
+
+      params[:order][:payments_attributes] = [
+        {
+          source_attributes: {
+            wallet_payment_source_id: wallet_payment_source_id,
+            verification_value: cvc_confirm
+          }
+        }
+      ]
+
+      params[:order].delete(:wallet_payment_source_id)
+      params.delete(:cvc_confirm)
+
+      params
+    end
+
+    # This is a strange thing to do since an order can have multiple payments
+    # but we always assume that it only has a single payment and that its
+    # amount should be the current order total.  Also, this is pretty much
+    # overridden when the order transitions to confirm by the logic inside of
+    # Order#add_store_credit_payments.
+    # We should reconsider this method and its usage at some point.
+    #
+    # This method expects a params hash in the format of:
+    #
+    #  {
+    #    order: {
+    #      # Note that only a single entry is expected/handled in this array
+    #      payments_attributes: [
+    #        {
+    #          ...params...
+    #        },
+    #      ],
+    #      ...other params...
+    #    },
+    #    ...other params...
+    #  }
+    #
+    # And this method modifies the params into the format of:
+    #
+    #  {
+    #    order: {
+    #      payments_attributes: [
+    #        {
+    #          ...params...
+    #          amount: <the order total>,
+    #        },
+    #      ],
+    #      ...other params...
+    #    },
+    #    ...other params...
+    #  }
+    #
+    def set_payment_parameters_amount(params, order)
+      return params if params[:order].blank?
+      return params if params[:order][:payments_attributes].blank?
+
+      params[:order][:payments_attributes].first[:amount] = order.total
+
+      params
+    end
+  end
+end

data/lib/spree/core/controller_helpers/pricing.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'spree/deprecation'
+
+module Spree
+  module Core
+    module ControllerHelpers
+      module Pricing
+        extend ActiveSupport::Concern
+
+        included do
+          helper_method :current_currency
+          helper_method :current_pricing_options
+        end
+
+        def current_pricing_options
+          Spree::Config.pricing_options_class.new(
+            currency: current_store.try!(:default_currency).presence || Spree::Config[:currency],
+            country_iso: current_store.try!(:cart_tax_country_iso).presence
+          )
+        end
+
+        def current_currency
+          current_pricing_options.currency
+        end
+        deprecate current_currency: :current_pricing_options, deprecator: Spree::Deprecation
+      end
+    end
+  end
+end

data/lib/spree/core/controller_helpers/search.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Spree
+  module Core
+    module ControllerHelpers
+      module Search
+        def build_searcher(params)
+          Spree::Config.searcher_class.new(params).tap do |searcher|
+            searcher.current_user = try_spree_current_user
+            searcher.pricing_options = current_pricing_options
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spree/core/controller_helpers/store.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Spree
+  module Core
+    module ControllerHelpers
+      module Store
+        extend ActiveSupport::Concern
+
+        included do
+          helper_method :current_store
+        end
+
+        def current_store
+          @current_store ||= Spree::Config.current_store_selector_class.new(request).store
+        end
+      end
+    end
+  end
+end

data/lib/spree/core/controller_helpers/strong_parameters.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Spree
+  module Core
+    module ControllerHelpers
+      module StrongParameters
+        def permitted_attributes
+          Spree::PermittedAttributes
+        end
+
+        delegate(*Spree::PermittedAttributes::ATTRIBUTES,
+                 to: :permitted_attributes,
+                 prefix: :permitted)
+
+        def permitted_credit_card_update_attributes
+          permitted_attributes.credit_card_update_attributes + [
+            address_attributes: permitted_address_attributes
+          ]
+        end
+
+        def permitted_payment_attributes
+          permitted_attributes.payment_attributes + [
+            source_attributes: permitted_source_attributes
+          ]
+        end
+
+        def permitted_source_attributes
+          permitted_attributes.source_attributes + [
+            address_attributes: permitted_address_attributes
+          ]
+        end
+
+        def permitted_checkout_attributes
+          permitted_attributes.checkout_attributes + [
+            bill_address_attributes: permitted_address_attributes,
+            ship_address_attributes: permitted_address_attributes,
+            payments_attributes: permitted_payment_attributes,
+            shipments_attributes: permitted_shipment_attributes
+          ]
+        end
+
+        def permitted_order_attributes
+          permitted_checkout_attributes + [
+            line_items_attributes: permitted_line_item_attributes
+          ]
+        end
+
+        def permitted_product_attributes
+          permitted_attributes.product_attributes + [
+            product_properties_attributes: permitted_product_properties_attributes
+          ]
+        end
+
+        def permitted_user_attributes
+          permitted_attributes.user_attributes + [
+            bill_address_attributes: permitted_address_attributes,
+            ship_address_attributes: permitted_address_attributes
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/spree/core/current_store.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Default class for deciding what the current store is, given an HTTP request
+# This is an extension point used in Spree::Core::ControllerHelpers::Store
+# Custom versions of this class must respond to a store instance method
+module Spree
+  module Core
+    class CurrentStore
+      def initialize(request)
+        @request = request
+        @current_store_selector = Spree::Config.current_store_selector_class.new(request)
+        Spree::Deprecation.warn "Using Spree::Core::CurrentStore is deprecated. Use Spree::Config.current_store_selector_class instead", caller
+      end
+
+      # Delegate store selection to Spree::Config.current_store_selector_class
+      # Using this class is deprecated.
+      #
+      # @return [Spree::Store]
+      def store
+        @current_store_selector.store
+      end
+    end
+  end
+end

data/lib/spree/core/engine.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'spree/config'
+
+module Spree
+  module Core
+    class Engine < ::Rails::Engine
+      CREDIT_CARD_NUMBER_PARAM = /payment.*source.*\.number$/
+      CREDIT_CARD_VERIFICATION_VALUE_PARAM = /payment.*source.*\.verification_value$/
+
+      isolate_namespace Spree
+      engine_name 'spree'
+
+      config.generators do |g|
+        g.test_framework :rspec
+      end
+
+      initializer "spree.environment", before: :load_config_initializers do |app|
+        app.config.spree = Spree::Config.environment
+      end
+
+      # leave empty initializers for backwards-compatability. Other apps might still rely on these events
+      initializer "spree.default_permissions", before: :load_config_initializers do; end
+      initializer "spree.register.calculators", before: :load_config_initializers do; end
+      initializer "spree.register.stock_splitters", before: :load_config_initializers do; end
+      initializer "spree.register.payment_methods", before: :load_config_initializers do; end
+      initializer 'spree.promo.environment', before: :load_config_initializers do; end
+      initializer 'spree.promo.register.promotion.calculators', before: :load_config_initializers do; end
+      initializer 'spree.promo.register.promotion.rules', before: :load_config_initializers do; end
+      initializer 'spree.promo.register.promotions.actions', before: :load_config_initializers do; end
+      initializer 'spree.promo.register.promotions.shipping_actions', before: :load_config_initializers do; end
+
+      # Filter sensitive information during logging
+      initializer "spree.params.filter", before: :load_config_initializers do |app|
+        app.config.filter_parameters += [
+          %r{^password$},
+          %r{^password_confirmation$},
+          CREDIT_CARD_NUMBER_PARAM,
+          CREDIT_CARD_VERIFICATION_VALUE_PARAM,
+        ]
+      end
+
+      initializer "spree.core.checking_migrations", before: :load_config_initializers do |_app|
+        Migrations.new(config, engine_name).check
+      end
+
+      # Load in mailer previews for apps to use in development.
+      # We need to make sure we call `Preview.all` before requiring our
+      # previews, otherwise any previews the app attempts to add need to be
+      # manually required.
+      if Rails.env.development?
+        initializer "spree.mailer_previews" do
+          ActionMailer::Preview.all
+          Dir[root.join("lib/spree/mailer_previews/**/*_preview.rb")].each do |file|
+            require_dependency file
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spree/core/environment/calculators.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Spree
+  module Core
+    class Environment
+      class Calculators
+        include EnvironmentExtension
+
+        add_class_set :shipping_methods
+        add_class_set :tax_rates
+
+        add_class_set :promotion_actions_create_adjustments
+        add_class_set :promotion_actions_create_item_adjustments
+        add_class_set :promotion_actions_create_quantity_adjustments
+      end
+    end
+  end
+end

data/lib/spree/core/environment.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'spree/core/environment_extension'
+
+module Spree
+  module Core
+    class Environment
+      include EnvironmentExtension
+
+      add_class_set :payment_methods
+      add_class_set :stock_splitters
+
+      attr_accessor :calculators, :preferences, :promotions
+
+      def initialize(spree_config)
+        @calculators = Calculators.new
+        @preferences = spree_config
+        @promotions = Spree::Promo::Environment.new
+      end
+    end
+  end
+end

data/lib/spree/core/environment_extension.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'spree/core/class_constantizer'
+
+module Spree
+  module Core
+    module EnvironmentExtension
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def add_class_set(name)
+          define_method(name) do
+            set = instance_variable_get("@#{name}")
+            set ||= send("#{name}=", [])
+            set
+          end
+
+          define_method("#{name}=") do |klasses|
+            set = ClassConstantizer::Set.new
+            set.concat(klasses)
+            instance_variable_set("@#{name}", set)
+          end
+        end
+      end
+
+      def add_class(name)
+        singleton_class.send(:add_class_set, name)
+      end
+    end
+  end
+end