Class: Spree::Zone

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

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.default_tax ⇒ Object 



28
29
30
31
32
 
# File 'app/models/spree/zone.rb', line 28

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.



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

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 



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

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 



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

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

#contains?(target) ⇒ Boolean

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

Returns:

  • (Boolean) 


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'app/models/spree/zone.rb', line 151

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) 


84
85
86
 
# File 'app/models/spree/zone.rb', line 84

def country?
  kind == 'country'
end

#country_ids ⇒ Object 



125
126
127
128
129
130
131
 
# File 'app/models/spree/zone.rb', line 125

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

#country_ids=(ids) ⇒ Object 



141
142
143
 
# File 'app/models/spree/zone.rb', line 141

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

#country_list ⇒ Object

convenience method for returning the countries contained within a zone



106
107
108
109
110
111
112
113
 
# File 'app/models/spree/zone.rb', line 106

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) 


92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'app/models/spree/zone.rb', line 92

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 



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

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) 


88
89
90
 
# File 'app/models/spree/zone.rb', line 88

def state?
  kind == 'state'
end

#state_ids ⇒ Object 



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

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

#state_ids=(ids) ⇒ Object 



145
146
147
 
# File 'app/models/spree/zone.rb', line 145

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

#state_list ⇒ Object 



167
168
169
170
171
172
173
174
 
# File 'app/models/spree/zone.rb', line 167

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

#state_list_for(country) ⇒ Object 



176
177
178
 
# File 'app/models/spree/zone.rb', line 176

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.



121
122
123
 
# File 'app/models/spree/zone.rb', line 121

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