solidus_core 1.0.0.pre

data/app/models/spree/address.rb

@@ -0,0 +1,157 @@
+module Spree
+  class Address < Spree::Base
+    require 'twitter_cldr'
+
+    belongs_to :country, class_name: "Spree::Country"
+    belongs_to :state, class_name: "Spree::State"
+
+    has_many :shipments, inverse_of: :address
+    has_many :cartons, inverse_of: :address
+
+    validates :firstname, :lastname, :address1, :city, :country, presence: true
+    validates :zipcode, presence: true, if: :require_zipcode?
+    validates :phone, presence: true, if: :require_phone?
+
+    validate :state_validate, :postal_code_validate
+
+    alias_attribute :first_name, :firstname
+    alias_attribute :last_name, :lastname
+
+    def self.build_default
+      country = Spree::Country.find(Spree::Config[:default_country_id]) rescue Spree::Country.first
+      new(country: country)
+    end
+
+    def self.default(user = nil, kind = "bill")
+      if user && user_address = user.send(:"#{kind}_address")
+        user_address.dup
+      else
+        build_default
+      end
+    end
+
+    # @return [String] the full name on this address
+    def full_name
+      "#{firstname} #{lastname}".strip
+    end
+
+    # @return [String] a string representation of this state
+    def state_text
+      state.try(:abbr) || state.try(:name) || state_name
+    end
+
+    # @param other [Spree::Address, nil] the address we are comparing with
+    # @return [Boolean] true if this fields on this address match the fields on
+    #   the other address
+    def same_as?(other)
+      return false if other.nil?
+      attributes.except('id', 'updated_at', 'created_at') == other.attributes.except('id', 'updated_at', 'created_at')
+    end
+
+    alias same_as same_as?
+
+    # @return [String] the full name on the address followed by the first line
+    #   of the address
+    def to_s
+      "#{full_name}: #{address1}"
+    end
+
+    # @return [Spree::Address] a new address that is the same_as? this address
+    def clone
+      ActiveSupport::Deprecation.warn "Spree::Address.clone is deprecated and may be removed from future releases, Use Spree::Address.dup instead", caller
+      self.dup
+    end
+
+    # @note This compares the addresses based on only the fields that make up
+    #   the logical "address" and excludes their order IDs. Use #same_as? to
+    #   include the order IDs in the comparison
+    # @return [Boolean] true if the two addresses have the same address fields
+    def ==(other_address)
+      self_attrs = self.attributes
+      other_attrs = other_address.respond_to?(:attributes) ? other_address.attributes : {}
+
+      [self_attrs, other_attrs].each { |attrs| attrs.except!('id', 'created_at', 'updated_at', 'order_id') }
+
+      self_attrs == other_attrs
+    end
+
+    # @return [Boolean] true if the order is missing all of the address fields
+    #   are nil
+    def empty?
+      attributes.except('id', 'created_at', 'updated_at', 'order_id', 'country_id').all? { |_, v| v.nil? }
+    end
+
+    # @return [Hash] an ActiveMerchant compatible address hash
+    def active_merchant_hash
+      {
+        name: full_name,
+        address1: address1,
+        address2: address2,
+        city: city,
+        state: state_text,
+        zip: zipcode,
+        country: country.try(:iso),
+        phone: phone
+      }
+    end
+
+    # @todo Remove this from the public API if possible.
+    # @return [true] whether or not the address requires a phone number to be
+    #   valid
+    def require_phone?
+      true
+    end
+
+    # @todo Remove this from the public API if possible.
+    # @return [true] whether or not the address requires a zipcode to be valid
+    def require_zipcode?
+      true
+    end
+
+    private
+      def state_validate
+        # Skip state validation without country (also required)
+        # or when disabled by preference
+        return if country.blank? || !Spree::Config[:address_requires_state]
+        return unless country.states_required
+
+        # ensure associated state belongs to country
+        if state.present?
+          if state.country == country
+            self.state_name = nil #not required as we have a valid state and country combo
+          else
+            if state_name.present?
+              self.state = nil
+            else
+              errors.add(:state, :invalid)
+            end
+          end
+        end
+
+        # ensure state_name belongs to country without states, or that it matches a predefined state name/abbr
+        if state_name.present?
+          if country.states.present?
+            states = country.states.find_all_by_name_or_abbr(state_name)
+
+            if states.size == 1
+              self.state = states.first
+              self.state_name = nil
+            else
+              errors.add(:state, :invalid)
+            end
+          end
+        end
+
+        # ensure at least one state field is populated
+        errors.add :state, :blank if state.blank? && state_name.blank?
+      end
+
+      def postal_code_validate
+        return if country.blank? || country.iso.blank? || !require_zipcode?
+        return if !TwitterCldr::Shared::PostalCodes.territories.include?(country.iso.downcase.to_sym)
+
+        postal_code = TwitterCldr::Shared::PostalCodes.for_territory(country.iso)
+        errors.add(:zipcode, :invalid) if !postal_code.valid?(zipcode.to_s)
+      end
+  end
+end

data/app/models/spree/adjustment.rb

@@ -0,0 +1,143 @@
+module Spree
+  # Adjustments represent a change to the +item_total+ of an Order. Each
+  # adjustment has an +amount+ that can be either positive or negative.
+  #
+  # Adjustments can be "opened" or "closed". Once an adjustment is closed, it
+  # will not be automatically updated.
+  #
+  # == Boolean attributes
+  #
+  # 1. *mandatory*
+  #
+  #    If this flag is set to true then it means the the charge is required and
+  #    will not be removed from the order, even if the amount is zero. In other
+  #    words a record will be created even if the amount is zero. This is
+  #    useful for representing things such as shipping and tax charges where
+  #    you may want to make it explicitly clear that no charge was made for
+  #    such things.
+  #
+  # 2. *eligible?*
+  #
+  #    This boolean attributes stores whether this adjustment is currently
+  #    eligible for its order. Only eligible adjustments count towards the
+  #    order's adjustment total. This allows an adjustment to be preserved if
+  #    it becomes ineligible so it might be reinstated.
+  class Adjustment < Spree::Base
+    belongs_to :adjustable, polymorphic: true, touch: true
+    belongs_to :source, polymorphic: true
+    belongs_to :order, class_name: "Spree::Order"
+    belongs_to :promotion_code, :class_name => 'Spree::PromotionCode'
+
+    validates :adjustable, presence: true
+    validates :order, presence: true
+    validates :label, presence: true
+    validates :amount, numericality: true
+    validates :promotion_code, presence: true, if: :require_promotion_code?
+
+    state_machine :state, initial: :open do
+      event :close do
+        transition from: :open, to: :closed
+      end
+
+      event :open do
+        transition from: :closed, to: :open
+      end
+    end
+
+    after_create :update_adjustable_adjustment_total
+    after_destroy :update_adjustable_adjustment_total
+
+    scope :open, -> { where(state: 'open') }
+    scope :closed, -> { where(state: 'closed') }
+    scope :cancellation, -> { where(source_type: 'Spree::UnitCancel') }
+    scope :tax, -> { where(source_type: 'Spree::TaxRate') }
+    scope :non_tax, -> do
+      source_type = arel_table[:source_type]
+      where(source_type.not_eq('Spree::TaxRate').or source_type.eq(nil))
+    end
+    scope :price, -> { where(adjustable_type: 'Spree::LineItem') }
+    scope :shipping, -> { where(adjustable_type: 'Spree::Shipment') }
+    scope :optional, -> { where(mandatory: false) }
+    scope :eligible, -> { where(eligible: true) }
+    scope :charge, -> { where("#{quoted_table_name}.amount >= 0") }
+    scope :credit, -> { where("#{quoted_table_name}.amount < 0") }
+    scope :nonzero, -> { where("#{quoted_table_name}.amount != 0") }
+    scope :promotion, -> { where(source_type: 'Spree::PromotionAction') }
+    scope :non_promotion, -> { where.not(source_type: 'Spree::PromotionAction') }
+    scope :return_authorization, -> { where(source_type: "Spree::ReturnAuthorization") }
+    scope :is_included, -> { where(included: true) }
+    scope :additional, -> { where(included: false) }
+
+    extend DisplayMoney
+    money_methods :amount
+
+    def closed?
+      state == "closed"
+    end
+
+    def currency
+      adjustable ? adjustable.currency : Spree::Config[:currency]
+    end
+
+    # @return [Boolean] true when this is a promotion adjustment (Promotion adjustments have a {PromotionAction} source)
+    def promotion?
+      source_type == 'Spree::PromotionAction'
+    end
+
+    # @return [Boolean] true when this is a tax adjustment (Tax adjustments have a {TaxRate} source)
+    def tax?
+      source_type == 'Spree::TaxRate'
+    end
+
+    # @return [Boolean] true when this is a cancellation adjustment (Cancellation adjustments have a {UnitCancel} source)
+    def cancellation?
+      source_type == 'Spree::UnitCancel'
+    end
+
+    # Recalculate and persist the amount from this adjustment's source based on
+    # the adjustable ({Order}, {Shipment}, or {LineItem})
+    #
+    # If the adjustment has no source (such as when created manually from the
+    # admin) or is closed, this is a noop.
+    #
+    # @param target [Spree::LineItem,Spree::Shipment,Spree::Order] Deprecated: the target to calculate against
+    # @return [BigDecimal] New amount of this adjustment
+    def update!(target = nil)
+      if target
+        ActiveSupport::Deprecation.warn("Passing a target to Adjustment#update! is deprecated. The adjustment will use the correct target from it's adjustable association.", caller)
+      end
+      return amount if closed?
+
+      # If the adjustment has no source, do not attempt to re-calculate the amount.
+      # Chances are likely that this was a manually created adjustment in the admin backend.
+      if source.present?
+        self.amount = source.compute_amount(target || adjustable)
+
+        if promotion?
+          self.eligible = source.promotion.eligible?(adjustable, promotion_code: promotion_code)
+        end
+
+        # Persist only if changed
+        # This is only not a save! to avoid the extra queries to load the order
+        # (for validations) and to touch the adjustment.
+        update_columns(eligible: eligible, amount: amount, updated_at: Time.now) if changed?
+      end
+      amount
+    end
+
+    def currency
+      adjustable ? adjustable.currency : Spree::Config[:currency]
+    end
+
+    private
+
+    def update_adjustable_adjustment_total
+      # Cause adjustable's total to be recalculated
+      ItemAdjustments.new(adjustable).update
+    end
+
+    def require_promotion_code?
+      promotion? && source.promotion.codes.any?
+    end
+  end
+end

data/app/models/spree/app_configuration.rb

@@ -0,0 +1,253 @@
+# This is the primary location for defining spree preferences
+#
+# The expectation is that this is created once and stored in
+# the spree environment
+#
+# setters:
+# a.color = :blue
+# a[:color] = :blue
+# a.set :color = :blue
+# a.preferred_color = :blue
+#
+# getters:
+# a.color
+# a[:color]
+# a.get :color
+# a.preferred_color
+#
+require "spree/core/search/base"
+require "spree/core/search/variant"
+
+module Spree
+  class AppConfiguration < Preferences::Configuration
+    # Alphabetized to more easily lookup particular preferences
+
+    # @!attribute [rw] address_requires_state
+    #   @return [Boolean] should state/state_name be required
+    preference :address_requires_state, :boolean, default: true
+
+    # @!attribute [rw] admin_interface_logo
+    #   @return [String] URL of logo used in admin (default: +'logo/solidus_logo.png'+)
+    preference :admin_interface_logo, :string, default: 'logo/solidus_logo.png'
+
+    # @!attribute [rw] admin_products_per_page
+    #   @return [Integer] Number of products to display in admin (default: +10+)
+    preference :admin_products_per_page, :integer, default: 10
+
+    # @!attribute [rw] admin_variants_per_page
+    #   @return [Integer] Number of variants to display in admin (default: +20+)
+    preference :admin_variants_per_page, :integer, default: 20
+
+    # @!attribute [rw] allow_checkout_on_gateway_error
+    #   @return [Boolean] Allow checkout to complete after a failed payment (default: +false+)
+    preference :allow_checkout_on_gateway_error, :boolean, default: false
+
+    # @!attribute [rw] allow_guest_checkout
+    #   @return [Boolean] When false, customers must create an account to complete an order (default: +true+)
+    preference :allow_guest_checkout, :boolean, default: true
+
+    # @!attribute [rw] allow_return_item_amount_editing
+    #   @return [Boolean] Determines whether an admin is allowed to change a return item's pre-calculated amount (default: +false+)
+    preference :allow_return_item_amount_editing, :boolean, default: false
+
+    # @!attribute [rw] alternative_billing_phone
+    #   @return [Boolean] Request an extra phone number for bill address (default: +false+)
+    preference :alternative_billing_phone, :boolean, default: false
+
+    # @!attribute [rw] alternative_shipping_phone
+    #   @return [Boolean] Request an extra phone number for shipping address (default: +false+)
+    preference :alternative_shipping_phone, :boolean, default: false
+
+    # @!attribute [rw] always_put_site_name_in_title
+    #   @return [Boolean] When true, site name is always appended to titles on the frontend (default: +true+)
+    preference :always_put_site_name_in_title, :boolean, default: true
+
+    # @!attribute [rw] auto_capture
+    #   @note Setting this to true is not recommended. Performing an authorize
+    #     and later capture has far superior error handing. VISA and MasterCard
+    #     also require that shipments are sent within a certain time of the card
+    #     being charged.
+    #   @return [Boolean] Perform a sale/purchase transaction at checkout instead of a authorize and capture.
+    preference :auto_capture, :boolean, default: false
+
+    # @!attribute [rw] auto_capture_exchanges
+    # @return [Boolean] automatically capture the credit card (as opposed to just authorize and capture later) (default: +false+)
+    preference :auto_capture_exchanges, :boolean, default: false
+
+    # @!attribute [rw] binary_inventory_cache
+    #   Only invalidate product caches when they change from in stock to out of
+    #   stock. By default, caches are invalidated on any change of inventory
+    #   quantity. Setting this to true should make operations on inventory
+    #   faster.
+    #   (default: +false+)
+    #   @return [Boolean]
+    preference :binary_inventory_cache, :boolean, default: false
+
+    # @!attribute [rw] checkout_zone
+    #   @return [String] Name of a {Zone}, which limits available countries to those included in that zone. (default: +nil+)
+    preference :checkout_zone, :string, default: nil
+
+    # @!attribute [rw] company
+    #   @return [Boolean] Request company field for billing and shipping addresses. (default: +false+)
+    preference :company, :boolean, default: false
+
+    # @!attribute [rw] create_rma_for_unreturned_exchange
+    #   @return [Boolean] allows rma to be created for items after unreturned exchange charge has been made (default: +false+)
+    preference :create_rma_for_unreturned_exchange, :boolean, default: false
+
+    # @!attribute [rw] currency
+    #   Currency to use by default when not defined on the site (default: +"USD"+)
+    #   @return [String] ISO 4217 Three letter currency code
+    preference :currency, :string, default: "USD"
+
+    # @!attribute [rw] default_country_id
+    #   @deprecated
+    #   @return [Integer,nil] id of {Country} to be selected by default in dropdowns (default: nil)
+    preference :default_country_id, :integer
+
+    # @!attribute [rw] expedited_exchanges
+    #   Kicks off an exchange shipment upon return authorization save.
+    #   charge customer if they do not return items within timely manner.
+    #   @note this requires payment profiles to be supported on your gateway of
+    #     choice as well as a delayed job handler to be configured with
+    #     activejob.
+    #   @return [Boolean] Use expidited exchanges (default: +false+)
+    preference :expedited_exchanges, :boolean, default: false
+
+    # @!attribute [rw] expedited_exchanges_days_window
+    #   @return [Integer] Number of days the customer has to return their item
+    #     after the expedited exchange is shipped in order to avoid being
+    #     charged (default: +14+)
+    preference :expedited_exchanges_days_window, :integer, default: 14
+
+    # @!attribute [rw] layout
+    #   @return [String] template to use for layout on the frontend (default: +"spree/layouts/spree_application"+)
+    preference :layout, :string, default: 'spree/layouts/spree_application'
+
+    # @!attribute [rw] logo
+    #   @return [String] URL of logo used on frontend (default: +'logo/solidus_logo.png'+)
+    preference :logo, :string, default: 'logo/solidus_logo.png'
+
+    # @!attribute [rw] order_capturing_time_window
+    #   @return [Integer] the number of days to look back for fully-shipped/cancelled orders in order to charge for them
+    preference :order_capturing_time_window, :integer, default: 14
+
+    # @!attribute [rw] max_level_in_taxons_menu
+    #   @return [Integer] maximum nesting level in taxons menu (default: +1+)
+    preference :max_level_in_taxons_menu, :integer, default: 1
+
+    # @!attribute [rw] order_mutex_max_age
+    #   @return [Integer] Max age of {OrderMutex} in seconds (default: 2 minutes)
+    preference :order_mutex_max_age, :integer, default: 2.minutes
+
+    # @!attribute [rw] orders_per_page
+    #   @return [Integer] Orders to show per-page in the admin (default: +15+)
+    preference :orders_per_page, :integer, default: 15
+
+    # @!attribute [rw] properties_per_page
+    #   @return [Integer] Properties to show per-page in the admin (default: +15+)
+    preference :properties_per_page, :integer, default: 15
+
+    # @!attribute [rw] products_per_page
+    #   @return [Integer] Products to show per-page in the frontend (default: +12+)
+    preference :products_per_page, :integer, default: 12
+
+    # @!attribute [rw] promotions_per_page
+    #   @return [Integer] Promotions to show per-page in the admin (default: +15+)
+    preference :promotions_per_page, :integer, default: 15
+
+    # @!attribute [rw] customer_returns_per_page
+    #   @return [Integer] Customer returns to show per-page in the admin (default: +15+)
+    preference :customer_returns_per_page, :integer, default: 15
+
+    # @!attribute [rw] require_master_price
+    #   @return [Boolean] Require a price on the master variant of a product (default: +true+)
+    preference :require_master_price, :boolean, default: true
+
+    # @!attribute [rw] require_payment_to_ship
+    #   @return [Boolean] Allows shipments to be ready to ship regardless of the order being paid if false (default: +true+)
+    preference :require_payment_to_ship, :boolean, default: true # Allows shipments to be ready to ship regardless of the order being paid if false
+
+    # @!attribute [rw] return_eligibility_number_of_days
+    #   @return [Integer] default: 365
+    preference :return_eligibility_number_of_days, :integer, default: 365
+
+    # @!attribute [rw] shipping_instructions
+    #   @return [Boolean] Request instructions/info for shipping (default: +false+)
+    preference :shipping_instructions, :boolean, default: false
+
+    # @!attribute [rw] show_only_complete_orders_by_default
+    #   @return [Boolean] Only show completed orders by default in the admin (default: +true+)
+    preference :show_only_complete_orders_by_default, :boolean, default: true
+
+    # @!attribute [rw] show_variant_full_price
+    #   @return [Boolean] Displays variant full price or difference with product price. (default: +false+)
+    preference :show_variant_full_price, :boolean, default: false
+
+    # @!attribute [rw] show_products_without_price
+    #   @return [Boolean] Whether products without a price are visible in the frontend (default: +false+)
+    preference :show_products_without_price, :boolean, default: false
+
+    # @!attribute [rw] show_raw_product_description
+    #   @return [Boolean] Don't escape HTML of product descriptions. (default: +false+)
+    preference :show_raw_product_description, :boolean, :default => false
+
+    # @!attribute [rw] tax_using_ship_address
+    #   @return [Boolean] Use the shipping address rather than the billing address to determine tax (default: +true+)
+    preference :tax_using_ship_address, :boolean, default: true
+
+    # @!attribute [rw] track_inventory_levels
+    #   Determines whether to track on_hand values for variants / products. If
+    #   you do not track inventory, or have effectively unlimited inventory for
+    #   all products you can turn this on.
+    #   @return [] Track on_hand values for variants / products. (default: true)
+    preference :track_inventory_levels, :boolean, default: true
+
+    # Default mail headers settings
+
+    # @!attribute [rw] send_core_emails
+    #   @return [Boolean] Whether to send transactional emails (default: true)
+    preference :send_core_emails, :boolean, default: true
+
+    # @!attribute [rw] mails_from
+    #   @return [String] Email address used as +From:+ field in transactional emails.
+    preference :mails_from, :string, :default => 'spree@example.com'
+
+    # Store credits configurations
+
+    # @!attribute [rw] credit_to_new_allocation
+    #   @return [Boolean] Creates a new allocation anytime {StoreCredit#credit} is called
+    preference :credit_to_new_allocation, :boolean, default: false
+
+    # searcher_class allows spree extension writers to provide their own Search class
+    def searcher_class
+      @searcher_class ||= Spree::Core::Search::Base
+    end
+
+    def searcher_class=(sclass)
+      @searcher_class = sclass
+    end
+
+    # all the following can be deprecated when store prefs are no longer supported
+    # @private
+    DEPRECATED_STORE_PREFERENCES = {
+      site_name: :name,
+      site_url: :url,
+      default_meta_description: :meta_description,
+      default_meta_keywords: :meta_keywords,
+      default_seo_title: :seo_title,
+    }
+
+    DEPRECATED_STORE_PREFERENCES.each do |old_preference_name, store_method|
+      # Avoid warning about implementation details
+      bc = ActiveSupport::BacktraceCleaner.new
+      bc.add_silencer { |line| line =~ %r{spree/preferences} }
+
+      # support all the old preference methods with a warning
+      define_method "preferred_#{old_preference_name}" do
+        ActiveSupport::Deprecation.warn("#{old_preference_name} is no longer supported on Spree::Config, please access it through #{store_method} on Spree::Store", bc.clean(caller))
+        Store.default.send(store_method)
+      end
+    end
+  end
+end