Class: Spree::Address
- Extended by:
- ActiveModel::ForbiddenAttributesProtection
- Defined in:
- app/models/spree/address.rb
Constant Summary collapse
- DB_ONLY_ATTRS =
%w(id updated_at created_at)
- TAXATION_ATTRS =
%w(state_id country_id zipcode)
Class Method Summary collapse
- .build_default ⇒ Object
- .default(user = nil, kind = "bill") ⇒ Object
-
.factory(attributes) ⇒ Address
An equal address already in the database or a newly created one.
-
.immutable_merge(existing_address, new_attributes) ⇒ Address
@note, this may return existing_address if there are no changes to value equality.
-
.value_attributes(base_attributes, merge_attributes = nil) ⇒ Hash
Hash of attributes contributing to value equality with optional merge.
Instance Method Summary collapse
-
#==(other_address) ⇒ Boolean
True if the two addresses have the same address fields.
-
#active_merchant_hash ⇒ Hash
An ActiveMerchant compatible address hash.
-
#country_iso=(iso) ⇒ Country
Setter that sets self.country to the Country with a matching 2 letter iso.
- #empty? ⇒ Boolean
-
#full_name ⇒ String
The full name on this address.
-
#readonly? ⇒ Boolean
This is set in order to preserve immutability of Addresses.
-
#require_phone? ⇒ true
Whether or not the address requires a phone number to be valid.
-
#require_zipcode? ⇒ true
Whether or not the address requires a zipcode to be valid.
- #same_as(other_address) ⇒ Object
- #same_as?(other_address) ⇒ Boolean
-
#state_text ⇒ String
A string representation of this state.
- #taxation_attributes ⇒ Object
- #to_s ⇒ Object
-
#value_attributes ⇒ Hash
Hash of attributes contributing to value equality.
Methods inherited from Base
display_includes, #initialize_preference_defaults, page, preference
Methods included from Preferences::Preferable
#default_preferences, #defined_preferences, #get_preference, #has_preference!, #has_preference?, #preference_default, #preference_type, #set_preference
Class Method Details
.build_default ⇒ Object
28 29 30 |
# File 'app/models/spree/address.rb', line 28 def self.build_default new(country: Spree::Country.default) end |
.default(user = nil, kind = "bill") ⇒ Object
32 33 34 35 36 37 38 39 |
# File 'app/models/spree/address.rb', line 32 def self.default(user = nil, kind = "bill") Spree::Deprecation.warn("Address.default is deprecated. Use User.default_address or Address.build_default", caller) if user user.send(:"#{kind}_address") || build_default else build_default end end |
.factory(attributes) ⇒ Address
Returns an equal address already in the database or a newly created one.
42 43 44 45 |
# File '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
49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# File '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 = nil) ⇒ Hash
Returns hash of attributes contributing to value equality with optional merge.
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'app/models/spree/address.rb', line 65 def self.value_attributes(base_attributes, merge_attributes = nil) # dup because we may modify firstname/lastname. base = base_attributes.dup base.stringify_keys! if merge_attributes base.merge!(merge_attributes.stringify_keys) end # TODO: Deprecate these aliased attributes base['firstname'] = base.delete('first_name') if base.key?('first_name') base['lastname'] = base.delete('last_name') if base.key?('last_name') base.except!(*DB_ONLY_ATTRS) end |
Instance Method Details
#==(other_address) ⇒ Boolean
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.
108 109 110 111 |
# File 'app/models/spree/address.rb', line 108 def ==(other_address) return false unless other_address && other_address.respond_to?(:value_attributes) value_attributes == other_address.value_attributes end |
#active_merchant_hash ⇒ Hash
Returns an ActiveMerchant compatible address hash.
128 129 130 131 132 133 134 135 136 137 138 139 |
# File 'app/models/spree/address.rb', line 128 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 |
#country_iso=(iso) ⇒ Country
Returns setter that sets self.country to the Country with a matching 2 letter iso.
164 165 166 |
# File 'app/models/spree/address.rb', line 164 def country_iso=(iso) self.country = Country.find_by!(iso: iso) end |
#empty? ⇒ Boolean
123 124 125 |
# File 'app/models/spree/address.rb', line 123 def empty? attributes.except('id', 'created_at', 'updated_at', 'country_id').all? { |_, v| v.nil? } end |
#full_name ⇒ String
Returns the full name on this address.
92 93 94 |
# File 'app/models/spree/address.rb', line 92 def full_name "#{firstname} #{lastname}".strip 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.
157 158 159 |
# File 'app/models/spree/address.rb', line 157 def readonly? persisted? end |
#require_phone? ⇒ true
Remove this from the public API if possible.
Returns whether or not the address requires a phone number to be valid.
144 145 146 |
# File 'app/models/spree/address.rb', line 144 def require_phone? true end |
#require_zipcode? ⇒ true
Remove this from the public API if possible.
Returns whether or not the address requires a zipcode to be valid.
150 151 152 |
# File 'app/models/spree/address.rb', line 150 def require_zipcode? true end |
#same_as(other_address) ⇒ Object
118 119 120 121 |
# File 'app/models/spree/address.rb', line 118 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
113 114 115 116 |
# File '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 |
#state_text ⇒ String
Returns a string representation of this state.
97 98 99 |
# File 'app/models/spree/address.rb', line 97 def state_text state.try(:abbr) || state.try(:name) || state_name end |
#taxation_attributes ⇒ Object
87 88 89 |
# File 'app/models/spree/address.rb', line 87 def taxation_attributes self.class.value_attributes(attributes.slice(*TAXATION_ATTRS)) end |
#to_s ⇒ Object
101 102 103 |
# File 'app/models/spree/address.rb', line 101 def to_s "#{full_name}: #{address1}" end |
#value_attributes ⇒ Hash
Returns hash of attributes contributing to value equality.
83 84 85 |
# File 'app/models/spree/address.rb', line 83 def value_attributes self.class.value_attributes(attributes) end |