Class: Spree::Address

Inherits:
Object
  • Object
show all
Includes:
Metadata, Metafields, Security::Addresses
Defined in:
app/models/spree/address.rb

Constant Summary collapse

STATES_REQUIRED =

The required states listed below match those used by PayPal and Shopify.

[
  'AU', 'AE', 'BR', 'CA', 'CN', 'ES', 'HK', 'IE', 'IN',
  'IT', 'MY', 'MX', 'NZ', 'PT', 'RO', 'TH', 'US', 'ZA'
].freeze
ADDRESS_FIELDS =

we’re not freezing this on purpose so developers can extend and manage those attributes depending of the logic of their applications

%w(firstname lastname company address1 address2 city state zipcode country phone)
EXCLUDED_KEYS_FOR_COMPARISON = 
%w(id updated_at created_at deleted_at label user_id public_metadata private_metadata)
FIELDS_TO_NORMALIZE = 
%w(firstname lastname phone alternative_phone company address1 address2 city zipcode)

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.required_fields ⇒ Object 



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

def self.required_fields
  Spree::Address.validators.map do |v|
    v.is_a?(ActiveModel::Validations::PresenceValidator) ? v.attributes : []
  end.flatten
end

Instance Method Details

#==(other) ⇒ Object 



150
151
152
153
154
 
# File 'app/models/spree/address.rb', line 150

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

  value_attributes == other.value_attributes
end

#active_merchant_hash ⇒ Object

Generates an ActiveMerchant compatible address hash



165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'app/models/spree/address.rb', line 165

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

#address_validators ⇒ Object 



75
76
77
78
79
 
# File 'app/models/spree/address.rb', line 75

def address_validators
  Spree.validators.addresses.each do |validator|
    validates_with validator
  end
end

#async_geocode ⇒ Object 



228
229
230
 
# File 'app/models/spree/address.rb', line 228

def async_geocode
  Spree::Addresses::GeocodeAddressJob.perform_later(id) if should_geocode?
end

#can_be_deleted? ⇒ Boolean

Returns:



208
209
210
 
# File 'app/models/spree/address.rb', line 208

def can_be_deleted?
  shipments.empty? && Order.complete.where('bill_address_id = ? OR ship_address_id = ?', id, id).none?
end

#check ⇒ Object 



212
213
214
215
216
 
# File 'app/models/spree/address.rb', line 212

def check
  attrs = attributes.except('id', 'updated_at', 'created_at')
  the_same_address = user&.addresses&.find_by(attrs)
  the_same_address || self
end

#clone ⇒ Object 



146
147
148
 
# File 'app/models/spree/address.rb', line 146

def clone
  self.class.new(value_attributes)
end

#destroy ⇒ Object 



218
219
220
221
222
223
224
225
226
 
# File 'app/models/spree/address.rb', line 218

def destroy
  assign_new_default_address_to_user

  if can_be_deleted?
    super
  else
    update_column :deleted_at, Time.current
  end
end

#editable? ⇒ Boolean

Returns:



204
205
206
 
# File 'app/models/spree/address.rb', line 204

def editable?
  new_record? || Order.complete.where('bill_address_id = ? OR ship_address_id = ?', id, id).none?
end

#empty? ⇒ Boolean

Returns:



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

def empty?
  attributes.except('id', 'created_at', 'updated_at', 'country_id').all? { |_, v| v.nil? }
end

#first_name ⇒ Object 



103
104
105
 
# File 'app/models/spree/address.rb', line 103

def first_name
  firstname
end

#first_name=(value) ⇒ Object 



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

def first_name=(value)
  self.firstname = value
end

#full_name ⇒ Object 



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

def full_name
  "#{firstname} #{lastname}".strip
end

#geocoder_address ⇒ Object 



232
233
234
 
# File 'app/models/spree/address.rb', line 232

def geocoder_address
  @geocoder_address ||= [street, city, state_text, country.to_s].compact.map(&:strip).join(', ')
end

#last_name ⇒ Object 



111
112
113
 
# File 'app/models/spree/address.rb', line 111

def last_name
  lastname
end

#last_name=(value) ⇒ Object 



115
116
117
 
# File 'app/models/spree/address.rb', line 115

def last_name=(value)
  self.lastname = value
end

#require_company? ⇒ Boolean

Returns:



192
193
194
 
# File 'app/models/spree/address.rb', line 192

def require_company?
  false
end

#require_name? ⇒ Boolean

Returns:



188
189
190
 
# File 'app/models/spree/address.rb', line 188

def require_name?
  !quick_checkout
end

#require_phone? ⇒ Boolean

Returns:



178
179
180
181
182
 
# File 'app/models/spree/address.rb', line 178

def require_phone?
  # We want to collect phone number for quick checkout but not to validate it
  # as it's not available before payment by browser.
  !quick_checkout && Spree::Config[:address_requires_phone]
end

#require_street? ⇒ Boolean

Returns:



196
197
198
 
# File 'app/models/spree/address.rb', line 196

def require_street?
  !quick_checkout
end

#require_zipcode? ⇒ Boolean

Returns:



184
185
186
 
# File 'app/models/spree/address.rb', line 184

def require_zipcode?
  !quick_checkout && (country ? country.zipcode_required? : true)
end

#show_company_address_field? ⇒ Boolean

Returns:



200
201
202
 
# File 'app/models/spree/address.rb', line 200

def show_company_address_field?
  Spree::Store.current.prefers_company_field_enabled?
end

#state_name_text ⇒ Object 



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

def state_name_text
  state_name.present? ? state_name : state&.name
end

#state_text ⇒ Object 



123
124
125
 
# File 'app/models/spree/address.rb', line 123

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

#street ⇒ Object 



131
132
133
 
# File 'app/models/spree/address.rb', line 131

def street
  [address1, address2].join(' ')
end

#to_s ⇒ Object 



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

def to_s
  [
    full_name,
    company,
    address1,
    address2,
    "#{city}, #{state_text} #{zipcode}",
    country.to_s
  ].reject(&:blank?).map { |attribute| ERB::Util.html_escape(attribute) }.join('<br/>')
end

#user_default_billing? ⇒ Boolean

Returns:



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

def user_default_billing?
  user.present? && id == user.bill_address_id
end

#user_default_shipping? ⇒ Boolean

Returns:



99
100
101
 
# File 'app/models/spree/address.rb', line 99

def user_default_shipping?
  user.present? && id == user.ship_address_id
end

#value_attributes ⇒ Object 



156
157
158
 
# File 'app/models/spree/address.rb', line 156

def value_attributes
  attributes.except(*EXCLUDED_KEYS_FOR_COMPARISON)
end