Class: Spree::Zone

Inherits:
Base
  • Object
show all
Defined in:
app/models/spree/zone.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

.default_taxObject


14
15
16
# File 'app/models/spree/zone.rb', line 14

def self.default_tax
  where(default_tax: true).first
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.


20
21
22
23
24
25
26
27
28
29
30
31
32
# File 'app/models/spree/zone.rb', line 20

def self.match(address)
  return unless address and matches = self.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)

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

Instance Method Details

#<=>(other) ⇒ Object


68
69
70
# File 'app/models/spree/zone.rb', line 68

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

#contains?(target) ⇒ Boolean

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

Returns:

  • (Boolean)

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

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

  if kind == target.kind
    return false if (target.zoneables.collect(&:id) - zoneables.collect(&:id)).present?
  else
    return false if (target.zoneables.collect(&:country).collect(&:id) - zoneables.collect(&:id)).present?
  end
  true
end

#country_idsObject


78
79
80
81
82
83
84
# File 'app/models/spree/zone.rb', line 78

def country_ids
  if kind == 'country'
    members.pluck(:zoneable_id)
  else
    []
  end
end

#country_ids=(ids) ⇒ Object


94
95
96
# File 'app/models/spree/zone.rb', line 94

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

#country_listObject

convenience method for returning the countries contained within a zone


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

def country_list
  @countries ||= case kind
                 when 'country' then zoneables
                 when 'state' then zoneables.collect(&:country)
                 else []
                 end.flatten.compact.uniq
end

#include?(address) ⇒ Boolean

Returns:

  • (Boolean)

44
45
46
47
48
49
50
51
52
53
54
55
56
57
# File 'app/models/spree/zone.rb', line 44

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
    else
      false
    end
  end
end

#kindObject


34
35
36
37
38
# File 'app/models/spree/zone.rb', line 34

def kind
  if members.any? && !members.any? { |member| member.try(:zoneable_type).nil? }
    members.last.zoneable_type.demodulize.underscore
  end
end

#kind=(value) ⇒ Object


40
41
42
# File 'app/models/spree/zone.rb', line 40

def kind=(value)
  # do nothing - just here to satisfy the form
end

#state_idsObject


86
87
88
89
90
91
92
# File 'app/models/spree/zone.rb', line 86

def state_ids
  if kind == 'state'
    members.pluck(:zoneable_id)
  else
    []
  end
end

#state_ids=(ids) ⇒ Object


98
99
100
# File 'app/models/spree/zone.rb', line 98

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

#zoneablesObject

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


74
75
76
# File 'app/models/spree/zone.rb', line 74

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