Class: Spree::Address

Inherits:
Base
  • Object
show all
Extended by:
ActiveModel::ForbiddenAttributesProtection
Defined in:
core/app/models/spree/address.rb,
core/app/models/spree/address/name.rb

Overview

`Spree::Address` provides the foundational ActiveRecord model for recording and validating address information for `Spree::Order`, `Spree::Shipment`, `Spree::UserAddress`, and `Spree::Carton`.

Defined Under Namespace

Classes: Name

Constant Summary collapse

DB_ONLY_ATTRS =
%w(id updated_at created_at)
TAXATION_ATTRS =
%w(state_id country_id zipcode)
LEGACY_NAME_ATTRS =
%w(firstname lastname full_name)

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

display_includes, #initialize_preference_defaults, page, preference

Class Method Details

.build_default(*args, &block) ⇒ Address

Returns an address with default attributes.

Returns:

  • (Address)

    an address with default attributes



37
38
39
# File 'core/app/models/spree/address.rb', line 37

def self.build_default(*args, &block)
  where(country: Spree::Country.default).build(*args, &block)
end

.factory(attributes) ⇒ Address

Returns an equal address already in the database or a newly created one.

Returns:

  • (Address)

    an equal address already in the database or a newly created one



42
43
44
45
# File 'core/app/models/spree/address.rb', line 42

def self.factory(attributes)
  full_attributes = value_attributes(column_defaults, new(attributes).attributes)
  find_or_initialize_by(full_attributes)
end

.immutable_merge(existing_address, new_attributes) ⇒ Address

@note, this may return existing_address if there are no changes to value equality

Returns:

  • (Address)

    address from existing address plus new_attributes as diff



49
50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'core/app/models/spree/address.rb', line 49

def self.immutable_merge(existing_address, new_attributes)
  # Ensure new_attributes is a sanitized hash
  new_attributes = sanitize_for_mass_assignment(new_attributes)

  return factory(new_attributes) if existing_address.nil?

  merged_attributes = value_attributes(existing_address.attributes, new_attributes)
  new_address = factory(merged_attributes)
  if existing_address == new_address
    existing_address
  else
    new_address
  end
end

.value_attributes(base_attributes, merge_attributes = {}) ⇒ Hash

Returns hash of attributes contributing to value equality with optional merge.

Returns:

  • (Hash)

    hash of attributes contributing to value equality with optional merge



65
66
67
68
69
70
71
72
73
74
75
76
77
78
# File 'core/app/models/spree/address.rb', line 65

def self.value_attributes(base_attributes, merge_attributes = {})
  base = base_attributes.stringify_keys.merge(merge_attributes.stringify_keys)

  name_from_attributes = Spree::Address::Name.from_attributes(base)
  if base['firstname'].presence || base['first_name'].presence
    base['firstname'] = name_from_attributes.first_name
  end
  if base['lastname'].presence || base['last_name'].presence
    base['lastname'] = name_from_attributes.last_name
  end
  excluded_attributes = DB_ONLY_ATTRS + %w(first_name last_name)

  base.except(*excluded_attributes)
end

Instance Method Details

#==(other_address) ⇒ Boolean

Note:

This compares the addresses based on only the fields that make up the logical “address” and excludes the database specific fields (id, created_at, updated_at).

Returns true if the two addresses have the same address fields.

Returns:

  • (Boolean)

    true if the two addresses have the same address fields



101
102
103
104
# File 'core/app/models/spree/address.rb', line 101

def ==(other_address)
  return false unless other_address && other_address.respond_to?(:value_attributes)
  value_attributes == other_address.value_attributes
end

#active_merchant_hashHash

Returns an ActiveMerchant compatible address hash.

Returns:

  • (Hash)

    an ActiveMerchant compatible address hash



132
133
134
135
136
137
138
139
140
141
142
143
# File 'core/app/models/spree/address.rb', line 132

def active_merchant_hash
  {
    name: name,
    address1: address1,
    address2: address2,
    city: city,
    state: state_text,
    zip: zipcode,
    country: country.try(:iso),
    phone: phone
  }
end

#blank?Boolean

This exists because the default Object#blank?, checks empty? if it is defined, and we have defined empty. This should be removed once empty? is removed

Returns:

  • (Boolean)


127
128
129
# File 'core/app/models/spree/address.rb', line 127

def blank?
  false
end

#country_isoObject



172
173
174
# File 'core/app/models/spree/address.rb', line 172

def country_iso
  country && country.iso
end

#country_iso=(iso) ⇒ Country

Returns setter that sets self.country to the Country with a matching 2 letter iso.

Parameters:

  • iso (String)

    2 letter Country ISO

Returns:

  • (Country)

    setter that sets self.country to the Country with a matching 2 letter iso

Raises:

  • (ActiveRecord::RecordNotFound)

    if country with the iso doesn't exist



168
169
170
# File 'core/app/models/spree/address.rb', line 168

def country_iso=(iso)
  self.country = Spree::Country.find_by!(iso: iso)
end

#empty?Boolean

Deprecated.

Do not use this

Returns:

  • (Boolean)


119
120
121
122
# File 'core/app/models/spree/address.rb', line 119

def empty?
  Spree::Deprecation.warn("Address#empty? is deprecated.", caller)
  attributes.except('id', 'created_at', 'updated_at', 'country_id').all? { |_, value| value.nil? }
end

#nameString

Returns the full name on this address.

Returns:

  • (String)

    the full name on this address



177
178
179
# File 'core/app/models/spree/address.rb', line 177

def name
  Spree::Address::Name.new(firstname, lastname).value
end

#name=(value) ⇒ Object



181
182
183
184
185
186
187
# File 'core/app/models/spree/address.rb', line 181

def name=(value)
  return if value.nil?

  name_from_value = Spree::Address::Name.new(value)
  write_attribute(:firstname, name_from_value.first_name)
  write_attribute(:lastname, name_from_value.last_name)
end

#readonly?Boolean

This is set in order to preserve immutability of Addresses. Use #dup to create new records as required, but it probably won't be required as often as you think. Since addresses do not change, you won't accidentally alter historical data.

Returns:

  • (Boolean)


161
162
163
# File 'core/app/models/spree/address.rb', line 161

def readonly?
  persisted?
end

#require_phone?true

TODO:

Remove this from the public API if possible.

Returns whether or not the address requires a phone number to be valid.

Returns:

  • (true)

    whether or not the address requires a phone number to be valid



148
149
150
# File 'core/app/models/spree/address.rb', line 148

def require_phone?
  true
end

#require_zipcode?true

TODO:

Remove this from the public API if possible.

Returns whether or not the address requires a zipcode to be valid.

Returns:

  • (true)

    whether or not the address requires a zipcode to be valid



154
155
156
# File 'core/app/models/spree/address.rb', line 154

def require_zipcode?
  true
end

#same_as(other_address) ⇒ Object

Deprecated.

Do not use this. Use Address.== instead.



113
114
115
116
# File 'core/app/models/spree/address.rb', line 113

def same_as(other_address)
  Spree::Deprecation.warn("Address#same_as is deprecated. It's equivalent to Address.==", caller)
  self == other_address
end

#same_as?(other_address) ⇒ Boolean

Deprecated.

Do not use this. Use Address.== instead.

Returns:

  • (Boolean)


107
108
109
110
# File 'core/app/models/spree/address.rb', line 107

def same_as?(other_address)
  Spree::Deprecation.warn("Address#same_as? is deprecated. It's equivalent to Address.==", caller)
  self == other_address
end

#state_textString

Returns a string representation of this state.

Returns:

  • (String)

    a string representation of this state



90
91
92
# File 'core/app/models/spree/address.rb', line 90

def state_text
  state.try(:abbr) || state.try(:name) || state_name
end

#taxation_attributesObject



85
86
87
# File 'core/app/models/spree/address.rb', line 85

def taxation_attributes
  self.class.value_attributes(attributes.slice(*TAXATION_ATTRS))
end

#to_sObject



94
95
96
# File 'core/app/models/spree/address.rb', line 94

def to_s
  "#{name}: #{address1}"
end

#value_attributesHash

Returns hash of attributes contributing to value equality.

Returns:

  • (Hash)

    hash of attributes contributing to value equality



81
82
83
# File 'core/app/models/spree/address.rb', line 81

def value_attributes
  self.class.value_attributes(attributes)
end