Class: Municipitaly2::Region

Inherits:
Object
  • Object
show all
Includes:
DataCaller, ZoneDelegator
Defined in:
lib/municipitaly2/region.rb

Overview

Define data structure for a Region

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ZoneDelegator

#zone

Methods included from DataCaller

included

Constructor Details

#initialize(zone_code:, name:, istat:, partial_iso3166:) ⇒ Region

Returns a new instance of Region.



9
10
11
12
13
14
 
# File 'lib/municipitaly2/region.rb', line 9

def initialize(zone_code:, name:, istat:, partial_iso3166:)
  @zone_code = zone_code
  @name = name
  @istat = istat
  @partial_iso3166 = partial_iso3166
end

Instance Attribute Details

#istat ⇒ Object (readonly)

Returns the value of attribute istat.



16
17
18
 
# File 'lib/municipitaly2/region.rb', line 16

def istat
  @istat
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



16
17
18
 
# File 'lib/municipitaly2/region.rb', line 16

def name
  @name
end

#partial_iso3166 ⇒ Object (readonly)

Returns the value of attribute partial_iso3166.



16
17
18
 
# File 'lib/municipitaly2/region.rb', line 16

def partial_iso3166
  @partial_iso3166
end

#zone_code ⇒ Object (readonly)

Returns the value of attribute zone_code.



16
17
18
 
# File 'lib/municipitaly2/region.rb', line 16

def zone_code
  @zone_code
end

Class Method Details

.all ⇒ Object

returns an array of all Municipitaly2::Region objects.



19
20
21
 
# File 'lib/municipitaly2/region.rb', line 19

def self.all
  data.regions
end

Instance Method Details

#iso3166_2 ⇒ Object Also known as: iso3166

returns ISO 3166-2 code for current province.



36
37
38
 
# File 'lib/municipitaly2/region.rb', line 36

def iso3166_2
  "IT-#{partial_iso3166}"
end

#municipalities ⇒ Object

returns an array of all Municipitaly2::Municipality objects belongs to current region.



31
32
33
 
# File 'lib/municipitaly2/region.rb', line 31

def municipalities
  @municipalities ||= Search.municipalities_from_region_istat(istat)
end

#provinces ⇒ Object

returns an array of all Municipitaly2::Province objects belongs to current region.



25
26
27
 
# File 'lib/municipitaly2/region.rb', line 25

def provinces
  @provinces ||= Search.provinces_from_region_istat(istat)
end