Class: Spree::Address

Inherits:
Base
  • Object
show all
Defined in:
app/models/spree/address.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

page

Methods included from Preferences::Preferable

#clear_preferences, #default_preferences, #defined_preferences, #get_preference, #has_preference!, #has_preference?, #preference_default, #preference_type, #set_preference

Class Method Details

.build_defaultObject


19
20
21
22
# File 'app/models/spree/address.rb', line 19

def self.build_default
  country = Spree::Country.find(Spree::Config[:default_country_id]) rescue Spree::Country.first
  new(country: country)
end

.default(user = nil, kind = "bill") ⇒ Object


24
25
26
27
28
29
30
# File 'app/models/spree/address.rb', line 24

def self.default(user = nil, kind = "bill")
  if user && user_address = user.send(:"#{kind}_address")
    user_address.clone
  else
    build_default
  end
end

Instance Method Details

#==(other_address) ⇒ Object


60
61
62
63
64
65
66
67
# File 'app/models/spree/address.rb', line 60

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

#active_merchant_hashObject

Generates an ActiveMerchant compatible address hash


74
75
76
77
78
79
80
81
82
83
84
85
# File 'app/models/spree/address.rb', line 74

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

#cloneObject


56
57
58
# File 'app/models/spree/address.rb', line 56

def clone
  self.class.new(self.attributes.except('id', 'updated_at', 'created_at'))
end

#empty?Boolean

Returns:

  • (Boolean)

69
70
71
# File 'app/models/spree/address.rb', line 69

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

#full_nameObject

Can modify an address if it's not been used in an order (but checkouts controller has finer control) def editable?

new_record? || (shipments.empty? && checkouts.empty?)

end


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

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

#require_phone?Boolean

Returns:

  • (Boolean)

87
88
89
# File 'app/models/spree/address.rb', line 87

def require_phone?
  true
end

#require_zipcode?Boolean

Returns:

  • (Boolean)

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

def require_zipcode?
  true
end

#same_as?(other) ⇒ Boolean Also known as: same_as

Returns:

  • (Boolean)

45
46
47
48
# File 'app/models/spree/address.rb', line 45

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

#state_textObject


41
42
43
# File 'app/models/spree/address.rb', line 41

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

#to_sObject


52
53
54
# File 'app/models/spree/address.rb', line 52

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