rwanda 0.3.3 → 0.4.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OGVkMmVhNjViMDM3OTc3YWQ2ZTE4Yzk2MzczYjA3ZWRlNDllYmY4Yg==
+    NGRkMTI3NzFiM2ZmMGNmYzQyZDAwZjUwNzdjYWJkZWM0NTAwNTAwZQ==
   data.tar.gz: !binary |-
-    ODQ0OWJiYzJiNzgxZTc5YTZjMjg0ZjVkY2YxY2QzNDBiNjhlNGI4Zg==
+    MzEwNDc5MDViZDBjNmM4ZDlhYzQ5NzllM2Q4NzFjMGY0YWNkMTJmZg==
 SHA512:
   metadata.gz: !binary |-
-    NDU1OWYwOGRlMGU5Yjk4OGE5MTQ4ZjllNTQzYjBkZDdlZTNjMmJjZTBmZTdk
-    ZmJjZGEyODgyM2NlZTNkYjE1YmE5ZGMzMjYzZGJjMmFhY2E1ODhjODgwMTA3
-    MjI4OWE1MGExYzBjNWNiNDQwN2U0MzM1MDQ0NzIyNTI3ZDAwZjA=
+    ZjM2MTdiNzgyODQ2ZTE4ZjIzZmQyYmNmNTZjOWQ2MDViNGIyNDc5MDhjMGUw
+    MWY5MGE0NzU1NzZmZjFmNWFlZmVmOWQxYmNlN2VkNGEwNTVhOTUyNDM3N2U5
+    NDIwNmNiNmY2MmE2MGE1ZDI5NzRiNWRlZjVlZTcxOWM5YjJlMWQ=
   data.tar.gz: !binary |-
-    ZTM3MjQxNTFjMzVlZjA2NjFiNWUwYjdkMmQyZmJhM2FhYjcyZDJhNGVkYTNk
-    NzcwMDMwNGYxNmUxNjA2MjJjMmNjZTUzNzZhZmY2MTQzZGM2YWQwOTE5MDFk
-    MDkxNGFkZjdhYTg0ODkyYzFmMDU2NWJjNWU0OGVjMTU2NGZlNTY=
+    MWZlZWVkZmRkMzQzM2FmNmZjYzc2YjU1ZjQzNDU3ZmQ5M2QwM2FjN2VhNzFl
+    NDUxZmQ4Njk1MjM4OGZlM2MyMjc1ZmRlM2M4YjNmODRmMzgyYjM2N2I0NzBm
+    ZDVlNDkzYzZjNmY3Y2I4ZDVhOTE3MzJiY2E4OTY5NmMyZmM5YmY=

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+kigali-sez.txt

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## 0.4.0
+ * Add case-insensitivity to all division lookups (#1)
+ * Add translation of province names between English and Kinyarwanda
+
+## 0.3.3
+ * Fix relative path error
+ 
+## 0.3.1
+ * Include cells and villages using data from MINALOC
+
+## 0.1.0
+ * First release, covering only provinces, districts and sectors (data unavailable for cells and villages)

data/lib/rwanda/version.rb

@@ -1,3 +1,3 @@
 class Rwanda
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 end

data/lib/rwanda.rb

@@ -20,9 +20,7 @@ end
 class Village
   attr_accessor :province, :district, :sector, :cell, :village
   
-  #def initialize(province, district, sector, cell, village)
   def initialize(row)
-    #@province,@district,@sector,@cell,@village=province,district,sector,cell,village
     @province,@district,@sector,@cell,@village=row['province'],row['district'],row['sector'],row['cell'],row['village']
   end
   def to_s
@@ -47,9 +45,10 @@ class Rwanda
       villages << Village.new(row)
     end
   end
+
   # Singular Ofs ((
   def province_of(district, rw=false)
-    village = @villages.select_first {|v| v.district == district}
+    village = @villages.select_first {|v| v.district.downcase == district.downcase}
     if village
       if rw then RW[village.province] else village.province end
     else
@@ -57,24 +56,24 @@ class Rwanda
     end
   end
   def district_of(sector)
-    village = @villages.select_first {|v| v.sector == sector}
+    village = @villages.select_first {|v| v.sector.downcase == sector.downcase}
     village ? village.district : nil
   end
   # )) Plural Ofs ((
   def districts_of(province)
-    districts = @villages.select {|v| v.province == province }.collect {|v| v.district}.uniq
+    districts = @villages.select {|v| v.province.downcase == province.downcase }.collect {|v| v.district}.uniq
     #binding.pry
     districts.empty? ? nil : districts
   end
   def sectors_of(district)
-    sectors = @villages.select {|v| v.district == district }.collect {|v| v.sector}.uniq
+    sectors = @villages.select {|v| v.district.downcase == district.downcase }.collect {|v| v.sector}.uniq
     sectors.empty? ? nil : sectors
   end
   def cells_of(district, sector)
-    @villages.select {|v| v.district == district and v.sector == sector}.collect {|v| v.cell}.uniq
+    @villages.select {|v| v.district.downcase == district.downcase and v.sector.downcase == sector.downcase}.collect {|v| v.cell}.uniq
   end
   def villages_of(district, sector, cell)
-    @villages.select {|v| v.district == district and v.sector == sector and v.cell == cell}.collect {|v| v.village}
+    @villages.select {|v| v.district.downcase == district.downcase and v.sector.downcase == sector.downcase and v.cell.downcase == cell.downcase}.collect {|v| v.village}
   end    
   # )) Lists ((
   def provinces; @villages.collect{|v| v.province}.uniq; end
@@ -99,12 +98,13 @@ class Rwanda
     @fms ||= FuzzyMatch.new(sectors)
     @fms.find(sector)
   end
-  # )) Testing
+  
+  # )) Testing ((
   #def is_province?(province); @villages.any? {|v| v.province == province}; end
   # is_division?
   DIVISIONS.each do |division|
     define_method("is_#{division}?") do |argument|
-      @villages.any? {|v| v.send(division) == argument}
+      @villages.any? {|v| v.send(division).downcase == argument.downcase}
     end
   end
   def exist?(district, sector=false, cell=false, village=false)
@@ -113,10 +113,26 @@ class Rwanda
     {district: district, sector: sector, cell: cell, village: village}.each_pair do |division_name,division|
       #binding.pry
       return true unless division
-      villages.select! {|v| v.send(division_name) == division}
+      villages.select! {|v| v.send(division_name).downcase == division.downcase}
       return false if villages.empty?
     end
     true    
   end
+  
+  # )) Translation ((
+  def translate(province)
+    kin = RW.find { |eng,kin| eng.downcase == province.downcase } # returns [key, val]
+    return kin[1] if kin
+    eng = RW.find { |eng,kin| kin.downcase == province.downcase }
+    return eng[0] if eng
+    nil
+    #if RW.has_key? province
+    #  RW[province]
+    #elsif RW.has_value? province
+    #  RW.key province
+    #else
+    #  nil
+    #end
+  end
 end
 

data/spec/rwanda_spec.rb

@@ -12,26 +12,20 @@ describe Rwanda do
   # Singular Ofs
   
   describe '.district_of' do
-    let(:input) { 'Jali' }
-    let(:output) { r.district_of(input) }
-    let(:wrong_in) { 'Foobar' }
-    let(:wrong_out) { r.district_of(wrong_in) }
-  
     it 'knows the distict of a sector' do
-      expect(output).to eq 'Gasabo'
-      expect(wrong_out).to eq nil
+      expect(r.district_of('Jali')).to eq 'Gasabo'
+      expect(r.district_of('jAlI')).to eq 'Gasabo'
+      
+      expect(r.district_of('Foobar')).to eq nil
     end
   end
   
   describe '.province_of' do
-    let(:input) { 'Gasabo' }
-    let(:output) { r.province_of(input) }
-    let(:wrong_in) { 'Foobar' }
-    let(:wrong_out) { r.province_of(wrong_in) }
-    
-    it 'knows the province of a district' do 
-      expect(output).to eq 'Kigali City'
-      expect(wrong_out).to eq nil
+    it 'knows the province of a district, and can return it in Kinyarwanda' do 
+      expect(r.province_of('gaSABO')).to eq 'Kigali City'
+      expect(r.province_of('Foobar')).to eq nil
+      expect(r.province_of('gaSABO', true)).to eq 'Umujyi wa Kigali'
+      expect(r.province_of('Foobar')).to eq nil
     end
   end
   
@@ -40,16 +34,15 @@ describe Rwanda do
   describe '.districts_of' do
     it 'knows all the districts of each province' do
       expect(r.districts_of('Kigali City').sort).to eq ["Gasabo", "Kicukiro", "Nyarugenge"].sort
+      expect(r.districts_of('kigali city').sort).to eq ["Gasabo", "Kicukiro", "Nyarugenge"].sort
       expect(r.districts_of('Foobar')).to eq nil
     end
   end
   
   describe '.sectors_of' do
-    let(:input) { 'Gasabo' }
-    let(:output) { r.sectors_of(input) }
     
     it 'knows all the sectors of a district' do
-      expect(output.sort).to eq [ 'Bumbogo', 'Gatsata', 'Gikomero', 'Gisozi', 'Jabana', 'Jali', 'Kacyiru', 'Kimihurura', 'Kimironko', 'Kinyinya', 'Ndera', 'Nduba', 'Remera', 'Rusororo', 'Rutunga' ].sort
+      expect(r.sectors_of('GasABO').sort).to eq [ 'Bumbogo', 'Gatsata', 'Gikomero', 'Gisozi', 'Jabana', 'Jali', 'Kacyiru', 'Kimihurura', 'Kimironko', 'Kinyinya', 'Ndera', 'Nduba', 'Remera', 'Rusororo', 'Rutunga' ].sort
       expect(r.sectors_of('Foobar')).to eq nil
     end
   end
@@ -60,22 +53,22 @@ describe Rwanda do
     it 'knows all the cells of a sector' do
       # Nyagatare,Mimuri,Mahoro,Rubumba
       expect(r.cells_of('Nyagatare', 'Mimuri')).to eq ['Bibare', 'Gakoma', 'Mahoro', 'Mimuri', 'Rugari']
+      expect(r.cells_of('nyagatare', 'MIMURI')).to eq ['Bibare', 'Gakoma', 'Mahoro', 'Mimuri', 'Rugari']
     end
   end
   
   describe '.villages_of' do
     it 'knows all the villages of a cell' do
       expect(r.villages_of('Ruhango', 'Ruhango', 'Gikoma')).to eq ['Gatengeri', 'Gikumba', 'Karama', 'Murambi', 'Nangurugomo', 'Nyarusange', 'Rebero', 'Rubiha', 'Rurembo', 'Ryabonyinka', 'Wimana']
+      expect(r.villages_of('RuhANgo', 'RUHANGO', 'GIKOMA')).to eq ['Gatengeri', 'Gikumba', 'Karama', 'Murambi', 'Nangurugomo', 'Nyarusange', 'Rebero', 'Rubiha', 'Rurembo', 'Ryabonyinka', 'Wimana']
     end
   end
   
   # Lists
   
   describe '.provinces' do
-    let(:output) { r.provinces }
-    
     it 'can list the provinces of Rwanda' do
-      expect(output.sort).to eq ["Kigali City", "Western Province", "Northern Province", "Southern Province", "Eastern Province"].sort
+      expect(r.provinces.sort).to eq ["Kigali City", "Western Province", "Northern Province", "Southern Province", "Eastern Province"].sort
     end
   end
   
@@ -88,12 +81,8 @@ describe Rwanda do
   end
   
   describe '.sectors' do
-    #let (:output) { r.sectors }
-    
       it 'can list the sectors of Rwanda' do
       expect(r.sectors.count).to eq 416
-      #expect(r.sectors.sort).to eq SECTORS
-      #expect(SECTORS - r.sectors).to eq []
       r.sectors.each_with_index do |s,i|
         expect(s).to eq SECTORS[i]
       end
@@ -105,6 +94,7 @@ describe Rwanda do
   describe '.[division]_like' do
     it 'can offer suggestions for mis-typed provinces' do
       expect(r.province_like('Westrun Provinc')).to eq 'Western Province'
+      expect(r.province_like('westrun provinc')).to eq 'Western Province'
     end
     it 'can offer suggestions for mis-typed districts' do
       expect(r.district_like('Gasabu')).to eq 'Gasabo'
@@ -117,7 +107,7 @@ describe Rwanda do
   # Testing
   
   describe '.is_[division]?' do
-    it 'knows whether a division exists' do
+    it 'knows whether a division exists, even if the case is wrong' do
       expect(r.is_district? 'Karongi').to eq true
       expect(r.is_sector? 'Gashari').to eq true
       expect(r.is_cell? 'Musasa').to eq true
@@ -126,16 +116,48 @@ describe Rwanda do
       expect(r.is_sector? 'Gashariii').to eq false
       expect(r.is_cell? 'Musasasasasa').to eq false
       expect(r.is_village? 'Kaduhahaha').to eq false
+
+      expect(r.is_district? 'karongi').to eq true
+      expect(r.is_sector? 'gashari').to eq true
+      expect(r.is_cell? 'musasa').to eq true
+      expect(r.is_village? 'kaduha').to eq true
+      expect(r.is_district? 'karoooongi').to eq false
+      expect(r.is_sector? 'gashariii').to eq false
+      expect(r.is_cell? 'musasasasasa').to eq false
+      expect(r.is_village? 'kaduhahaha').to eq false
     end
   end
   
-  describe '.is_real' do
-    it 'knows whether a chain of divisions is legitimate' do
+  describe '.exist?' do
+    it 'knows whether a chain of divisions is legitimate, case insensitively' do
       expect(r.exist?('Karongi','Bwishyura','Kiniha','Nyarurembo')).to eq true
       expect(r.exist?('Karongi','Bwishyura','Nyarurembo')).to eq false
       expect(r.exist?('Karongi')).to eq true
+
+      expect(r.exist?('karongi','bwishyura','kiniha','nyarurembo')).to eq true
+      expect(r.exist?('karongi','bwishyura','nyarurembo')).to eq false
+      expect(r.exist?('karongi')).to eq true
     end
   end
+  
+  describe '.translate' do
+    it 'can translate a province from English to Kinyarwanda' do
+      expect(r.translate('Northern Province')).to eq 'Amajyaruguru'
+      expect(r.translate('Southern Province')).to eq 'Amajyepfo'
+      expect(r.translate('eastern province')).to eq 'Iburasirazuba'
+      expect(r.translate('WESTERN PROVINCE')).to eq 'Iburengerazuba'
+      expect(r.translate('Kigali City')).to eq 'Umujyi wa Kigali'
+      expect(r.translate('foobar')).to eq nil
+    end
+    it 'can translate a province from Kinyarwanda to English' do
+      expect(r.translate('Amajyaruguru')).to eq 'Northern Province'
+      expect(r.translate('AmajyePFO')).to eq 'Southern Province'
+      expect(r.translate('Iburasirazuba')).to eq 'Eastern Province'
+      expect(r.translate('Iburengerazuba')).to eq 'Western Province'
+      expect(r.translate('umujyi wa kigali')).to eq 'Kigali City'
+    end
+  end
+    
   #describe '.is_in?' do
   #  it 'knows whether a smaller division is inside a larger division' do
   #    expect(r.is_in?('Karongi','Gashari')).to eq true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rwanda
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Dan Hetherington
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2015-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md