Class: Spree::Zone

Inherits:
Base
  • Object
show all
Includes:
UniqueName, Webhooks::HasWebhooks
Defined in:
app/models/spree/zone.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

belongs_to_required_by_default, for_store, has_many_inversing, json_api_columns, json_api_permitted_attributes, json_api_type, page, spree_base_scopes, spree_base_uniqueness_scope

Methods included from Preferences::Preferable

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

Class Method Details

.default_checkout_zone ⇒ Object 



76
77
78
79
80
 
# File 'app/models/spree/zone.rb', line 76

def self.default_checkout_zone
  Spree::Deprecation.warn('Spree::Zone.default_checkout_zone is deprecated and will be removed in Spree 5')

  first
end

.default_tax ⇒ Object 



30
31
32
33
34
 
# File 'app/models/spree/zone.rb', line 30

def self.default_tax
  Rails.cache.fetch('default_tax') do
    find_by(default_tax: true)
  end
end

.match(address) ⇒ Object

Returns the matching zone with the highest priority zone type (State, Country, Zone.) Returns nil in the case of no matches.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'app/models/spree/zone.rb', line 58

def self.match(address)
  return unless address &&
    matches = includes(:zone_members).
                order('spree_zones.zone_members_count', 'spree_zones.created_at').
                where("(spree_zone_members.zoneable_type = 'Spree::Country' AND " \
                      'spree_zone_members.zoneable_id = ?) OR ' \
                      "(spree_zone_members.zoneable_type = 'Spree::State' AND " \
                      'spree_zone_members.zoneable_id = ?)', address.country_id, address.state_id).
                references(:zones)

  %w[state country].each do |zone_kind|
    if match = matches.detect { |zone| zone_kind == zone.kind }
      return match
    end
  end
  matches.first
end

.potential_matching_zones(zone) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'app/models/spree/zone.rb', line 36

def self.potential_matching_zones(zone)
  if zone.country?
    # Match zones of the same kind with similar countries
    joins(countries: :zones).
      where('zone_members_spree_countries_join.zone_id = ?', zone.id).
      distinct
  else
    # Match zones of the same kind with similar states in AND match zones
    # that have the states countries in
    joins(:zone_members).where(
      "(spree_zone_members.zoneable_type = 'Spree::State' AND
        spree_zone_members.zoneable_id IN (?))
       OR (spree_zone_members.zoneable_type = 'Spree::Country' AND
        spree_zone_members.zoneable_id IN (?))",
      zone.state_ids,
      zone.states.pluck(:country_id)
    ).distinct
  end
end

Instance Method Details

#<=>(other) ⇒ Object 



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

def <=>(other)
  name <=> other.name
end

#contains?(target) ⇒ Boolean

Indicates whether the specified zone falls entirely within the zone performing the check.

Returns:

  • (Boolean) 


159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'app/models/spree/zone.rb', line 159

def contains?(target)
  return false if state? && target.country?
  return false if zone_members.empty? || target.zone_members.empty?

  if kind == target.kind
    if state?
      return false if (target.states.pluck(:id) - states.pluck(:id)).present?
    elsif country?
      return false if (target.countries.pluck(:id) - countries.pluck(:id)).present?
    end
  else
    return false if (target.states.pluck(:country_id) - countries.pluck(:id)).present?
  end
  true
end

#country? ⇒ Boolean

Returns:

  • (Boolean) 


92
93
94
 
# File 'app/models/spree/zone.rb', line 92

def country?
  kind == 'country'
end

#country_ids ⇒ Object 



133
134
135
136
137
138
139
 
# File 'app/models/spree/zone.rb', line 133

def country_ids
  if country?
    members.pluck(:zoneable_id)
  else
    []
  end
end

#country_ids=(ids) ⇒ Object 



149
150
151
 
# File 'app/models/spree/zone.rb', line 149

def country_ids=(ids)
  set_zone_members(ids, 'Spree::Country')
end

#country_list ⇒ Object

convenience method for returning the countries contained within a zone



114
115
116
117
118
119
120
121
 
# File 'app/models/spree/zone.rb', line 114

def country_list
  @countries ||= case kind
                 when 'country' then
                   Country.where(id: country_ids)
                 when 'state' then
                   Country.where(id: zoneables.collect(&:country_id))
                 end
end

#include?(address) ⇒ Boolean

Returns:

  • (Boolean) 


100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'app/models/spree/zone.rb', line 100

def include?(address)
  return false unless address

  members.any? do |zone_member|
    case zone_member.zoneable_type
    when 'Spree::Country'
      zone_member.zoneable_id == address.country_id
    when 'Spree::State'
      zone_member.zoneable_id == address.state_id
    end
  end
end

#kind ⇒ Object 



82
83
84
85
86
87
88
89
90
 
# File 'app/models/spree/zone.rb', line 82

def kind
  if self[:kind].present?
    self[:kind]
  else
    not_nil_scope = members.where.not(zoneable_type: nil)
    zone_type = not_nil_scope.order('created_at ASC').pluck(:zoneable_type).last
    zone_type&.demodulize&.underscore
  end
end

#state? ⇒ Boolean

Returns:

  • (Boolean) 


96
97
98
 
# File 'app/models/spree/zone.rb', line 96

def state?
  kind == 'state'
end

#state_ids ⇒ Object 



141
142
143
144
145
146
147
 
# File 'app/models/spree/zone.rb', line 141

def state_ids
  if state?
    members.pluck(:zoneable_id)
  else
    []
  end
end

#state_ids=(ids) ⇒ Object 



153
154
155
 
# File 'app/models/spree/zone.rb', line 153

def state_ids=(ids)
  set_zone_members(ids, 'Spree::State')
end

#state_list ⇒ Object 



175
176
177
178
179
180
181
182
 
# File 'app/models/spree/zone.rb', line 175

def state_list
  case kind
  when 'country'
    zoneables.map(&:states)
  when 'state'
    zoneables
  end.flatten.compact.uniq
end

#state_list_for(country) ⇒ Object 



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

def state_list_for(country)
  state_list.select { |state| state.country == country }
end

#zoneables ⇒ Object

All zoneables belonging to the zone members. Will be a collection of either countries or states depending on the zone type.



129
130
131
 
# File 'app/models/spree/zone.rb', line 129

def zoneables
  members.includes(:zoneable).collect(&:zoneable)
end