rwanda 0.4.0 → 0.5.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NGRkMTI3NzFiM2ZmMGNmYzQyZDAwZjUwNzdjYWJkZWM0NTAwNTAwZQ==
+    ZDJmYjJlYmJhNTc1MmEyNTg0ODRiZDk5NjFiODFhNmIzNGNlN2IwZg==
   data.tar.gz: !binary |-
-    MzEwNDc5MDViZDBjNmM4ZDlhYzQ5NzllM2Q4NzFjMGY0YWNkMTJmZg==
+    OTNhM2I3NDQ4ZDVkYTc5MzYwNGU4ODc0MWM2N2YyYjJhYTEwZDJlYQ==
 SHA512:
   metadata.gz: !binary |-
-    ZjM2MTdiNzgyODQ2ZTE4ZjIzZmQyYmNmNTZjOWQ2MDViNGIyNDc5MDhjMGUw
-    MWY5MGE0NzU1NzZmZjFmNWFlZmVmOWQxYmNlN2VkNGEwNTVhOTUyNDM3N2U5
-    NDIwNmNiNmY2MmE2MGE1ZDI5NzRiNWRlZjVlZTcxOWM5YjJlMWQ=
+    YzhkYWY4NjNkMGNlZmZlMDFhNzk5NWE3MjRhZWI1MjE0NjczM2ZiZTlhMDY4
+    OTg2ZTMzOTk1YjRmNjU0NjQ3YzY1MGE0OTQ0NzM0ZGZlZGQ2NzI1YzIwMGRl
+    ZDA2NWM5Yjg3YjliYTExYzlhNWY2MjRlNzQ4NWU0ZGMyN2NlNTc=
   data.tar.gz: !binary |-
-    MWZlZWVkZmRkMzQzM2FmNmZjYzc2YjU1ZjQzNDU3ZmQ5M2QwM2FjN2VhNzFl
-    NDUxZmQ4Njk1MjM4OGZlM2MyMjc1ZmRlM2M4YjNmODRmMzgyYjM2N2I0NzBm
-    ZDVlNDkzYzZjNmY3Y2I4ZDVhOTE3MzJiY2E4OTY5NmMyZmM5YmY=
+    MzEyN2NiNWQwOTk4NTExMmQ5YzRmYzU1MDlhOGJiZDdiNTYwMzJmOTA2NWIy
+    MzkyZmU3MmE4NTgyYjdhNWZlNzQ0M2QwMGMzMDNhOGE0NTg4MzY2OWU4ZjQ1
+    ZThjMzdiMWU3NzZkODEyZjNiZGMxYzQ0OWM1ODBiZGY5Njk2NmQ=

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.5.2
+ * Fix serious bug in .where_is? that gave incorrect information
+
+## 0.5.0
+ * Add .where_is? to enable fast general queries of the dataset
+ * allow .exists? as a synonym of .exist?
+
 ## 0.4.0
  * Add case-insensitivity to all division lookups (#1)
  * Add translation of province names between English and Kinyarwanda

data/README.md

@@ -18,10 +18,17 @@ Or install it yourself as:
 
     $ gem install rwanda
 
+Then you can try it on the command line:
+
+    $ pry
+    > gem 'rwanda'
+    > require 'rwanda'
+
 ## Usage
 
 ```ruby
 rw = Rwanda.new
+rw.where_is? 'Gasabo'
 rw.provinces
 rw.sectors_of 'Gasabo'
 rw.district_of 'Giheke'
@@ -60,6 +67,7 @@ If you are not familiar with this data set, it's worth noting the following feat
  * sector, cell and village names are often repeated: two sectors in different districts may have the same name, or a sector, cell and village may all have the same name
  * cells and villages may be named after the sectors and cells that they are in
  * at the cell or village level, there may be multiple villages with the same name, differentiated by a number (in roman numerals) e.g. Matimba cell has seven "Umudugudu Wa"s
+ * you might find where_is? helpful for inspecting ambiguity: it lists all divisions at all levels that share the name you give it (try `rw.where_is? 'Gatsibo'`)
 
 ## Contributing
 

data/lib/rwanda.rb

@@ -26,6 +26,19 @@ class Village
   def to_s
     "#{@province}/#{@district}/#{@sector}/#{@cell}/#{@village}"
   end
+  def match(str)
+    matches = []
+    Rwanda::DIVISIONS.each do |div|
+      if str.downcase == self.send(div).downcase
+        matches.push div
+      end
+    end
+    matches
+  end
+  def [](n)
+    raise "Division index #{n} out of range!  Permitted indices 0 (province) to 4 (village)" unless (0..4).include? n
+    self.send(Rwanda::DIVISIONS[n])
+  end
 end
 
 class Rwanda
@@ -74,7 +87,23 @@ class Rwanda
   end
   def villages_of(district, sector, cell)
     @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    
+  end
+  def subdivisions_of(arr)
+    case arr.length
+      when 1
+        sectors_of *arr
+      when 2
+        cells_of *arr
+      when 3
+        villages_of *arr
+      else
+        raise "subdivisions_of requires an array of between 1 and 3 elements (do NOT include a province): received #{arr}"
+    end
+  end
+  # )) Calleds ((
+  #def districts_called(district)
+  #  @villages
+  #end
   # )) Lists ((
   def provinces; @villages.collect{|v| v.province}.uniq; end
   def districts; @villages.collect{|v| v.district}.uniq; end
@@ -107,9 +136,9 @@ class Rwanda
       @villages.any? {|v| v.send(division).downcase == argument.downcase}
     end
   end
-  def exist?(district, sector=false, cell=false, village=false)
+  def exist?(district=false, sector=false, cell=false, village=false)
     villages = @villages.dup
-    return false unless district
+    return nil unless district
     {district: district, sector: sector, cell: cell, village: village}.each_pair do |division_name,division|
       #binding.pry
       return true unless division
@@ -118,6 +147,7 @@ class Rwanda
     end
     true    
   end
+  def exists?(*p); exist?(*p); end
   
   # )) Translation ((
   def translate(province)
@@ -134,5 +164,48 @@ class Rwanda
     #  nil
     #end
   end
+  
+  # )) Where is...? ((
+  def where_is?(division)
+    matching = { province: [], district: [], sector: [], cell: [], village: [] }
+    lines = []
+    @villages.each do |village|
+      matches = village.match(division)
+      unless matches.empty?
+        matches.each do |div|
+          matching[div].push village
+          # convert villages into lines
+          new_line = "  #{village.send(div)} is a #{div}#{' in' unless div==:province}"
+          unless div == :province
+            (0...Rwanda::DIVISIONS.index(div)).to_a.reverse.each do |n|
+              new_line << " #{village[n]}#{' '+Rwanda::DIVISIONS[n].to_s.capitalize+',' unless n==0}"
+            end
+          end
+          lines << new_line
+        end
+      end
+    end
+    lines.uniq!
+    output = ''
+    
+    # summary line
+    if lines.empty?
+      output += "Rwanda has no divisions called #{division.capitalize}\n"
+    else
+      output += 'Rwanda has'
+      n = []
+      comma = ''
+      (0..3).each do |i|
+        n = lines.count { |l| l.count(',') == i }
+        output << "#{comma} #{i == 3 ? 'and ' : ''}#{n} #{Rwanda::DIVISIONS[i+1]}#{n == 1 ? '' : 's'}"
+        comma = ','
+      end
+      output << " called #{division.capitalize}:\n"
+    end
+    
+    # detail
+    lines.each { |line| output << line << "\n" }
+    puts output
+  end
 end
 

data/lib/rwanda/version.rb

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

data/spec/rwanda_spec.rb

@@ -64,6 +64,13 @@ describe Rwanda do
     end
   end
   
+  describe '.subdivisions_of' do
+    it 'knows the sub-divisions of a district, sector or cell' do
+      expect(r.subdivisions_of(['Ruhango', 'Ruhango', 'Gikoma'])).to eq ['Gatengeri', 'Gikumba', 'Karama', 'Murambi', 'Nangurugomo', 'Nyarusange', 'Rebero', 'Rubiha', 'Rurembo', 'Ryabonyinka', 'Wimana']
+      expect(r.subdivisions_of(['RuhANgo', 'RUHANGO', 'GIKOMA'])).to eq ['Gatengeri', 'Gikumba', 'Karama', 'Murambi', 'Nangurugomo', 'Nyarusange', 'Rebero', 'Rubiha', 'Rurembo', 'Ryabonyinka', 'Wimana']    
+    end
+  end
+  
   # Lists
   
   describe '.provinces' do
@@ -137,6 +144,10 @@ describe Rwanda 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
+
+      # .exists? is an acceptable synonym
+      expect(r.exists?('Karongi','Bwishyura','Kiniha','Nyarurembo')).to eq true
+      expect(r.exists?('karongi')).to eq true
     end
   end
   
@@ -157,7 +168,16 @@ describe Rwanda do
       expect(r.translate('umujyi wa kigali')).to eq 'Kigali City'
     end
   end
-    
+  
+  describe '.where_is?' do
+    it 'can list all of the divisions by a certain name' do
+      expect(STDOUT).to receive(:puts).with("Rwanda has 0 districts, 1 sector, 1 cell, and 1 village called Ndego:\n  Ndego is a sector in Kayonza District, Eastern Province\n  Ndego is a cell in Karama Sector, Nyagatare District, Eastern Province\n  Ndego is a village in Ndego Cell, Karama Sector, Nyagatare District, Eastern Province\n")
+      r.where_is? 'ndego'
+      expect(STDOUT).to receive(:puts).with("Rwanda has no divisions called Foobar\n")
+      r.where_is? 'Foobar'
+    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.4.0
+  version: 0.5.3
 platform: ruby
 authors:
 - Dan Hetherington
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-13 00:00:00.000000000 Z
+date: 2015-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler