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

#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

.default_tax ⇒ Object 



23
24
25
 
# File 'app/models/spree/zone.rb', line 23

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.



29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'app/models/spree/zone.rb', line 29

def self.match(address)
  return unless address and matches = self.includes(:zone_members).
    order(:zone_members_count, :created_at, :id).
    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 



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

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

#contains?(target) ⇒ Boolean

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

Returns:

  • (Boolean) 


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

def contains?(target)
  return true if self == 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_ids ⇒ Object 



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

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

#country_ids=(ids) ⇒ Object 



103
104
105
 
# File 'app/models/spree/zone.rb', line 103

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

#country_list ⇒ Object

convenience method for returning the countries contained within a zone



69
70
71
72
73
74
75
 
# File 'app/models/spree/zone.rb', line 69

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) 


53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'app/models/spree/zone.rb', line 53

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

#kind ⇒ Object 



43
44
45
46
47
 
# File 'app/models/spree/zone.rb', line 43

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

#kind=(value) ⇒ Object 



49
50
51
 
# File 'app/models/spree/zone.rb', line 49

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

#state_ids ⇒ Object 



95
96
97
98
99
100
101
 
# File 'app/models/spree/zone.rb', line 95

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

#state_ids=(ids) ⇒ Object 



107
108
109
 
# File 'app/models/spree/zone.rb', line 107

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

#zoneables ⇒ Object

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



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

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