ke_counties 0.0.0 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2137e67183bfc1334eb922f2c29fde54442e0d3e41b808f63680a1aeb8d2991d
-  data.tar.gz: a28de69649d55d5a29d6853b85b69e001f12c8b610cda1679dcce9079b12a11a
+  metadata.gz: cf99fa284a462a4a183fee4c1e3c44ed17818369d8ae108cc36d99c7f2ced9b1
+  data.tar.gz: 1d955b1c1955202ece741df81f59dc3842b35b15858af45736119313b0dce3e5
 SHA512:
-  metadata.gz: b7213f8e76e78bd35247012ffd30d47fa64324379a202530c1966e1bacb992a87e036872a6f4821b811e72198ddb76ddc43e2f77c5460deb6d713349ea0500f8
-  data.tar.gz: d6b6120cf8e07c7a22f3e31ff6a53e40cd79674022cbc3c73381966ce25871e6c30f640a0153acfd1efc264322261c83434799c490741a46dcb4ed2902f10566
+  metadata.gz: 8965f478c15541c531299ef11f0242bdebfaa59fa75f3e3dfcfceab0aea287e05ca0f20bfb77a94e5a109aa9c884f57327a5a9b04865826c1fc93529a54c5859
+  data.tar.gz: ede6c85e6c5ddfb0134c17a5efb5a7da4a858aba8c85b87161ae7436d529c1e853ec3086ad930c06219b141c92cda493ced0336b157d724584341468f2a2a35c

data/.gitignore

@@ -0,0 +1,2 @@
+ke_counties-*
+Gemfile.lock

data/README.md

@@ -1 +1,56 @@
-# KE COUNTIES
+## KE COUNTIES
+
+KeCounties is a tiny gem that provides the full list of Kenya county names, their codes, abbreviations and provinces(used popuraly used regions previously before the counties' formation).
+
+### Installation
+
+In a Gemfile:
+
+```
+gem 'ke_counties'
+```
+
+Globally in your machine:
+
+```
+gem install 'ke_counties'
+```
+
+### Usage
+
+You can get all the county names with
+
+```
+KeCounties.names
+```
+
+Get all county codes
+
+```
+KeCounties.codes
+```
+To get the whole hash mapping each county name to its code, abbreviation, province and capital ; use
+
+```
+KeCounties.all
+```
+
+Other methods provides are `.code`, `.abbr`, `.capital`, `.province` which returns the code, abbreviation, capital and province respectively if passed in a capitalized county name. E.g
+
+```
+KeCounties.code('Nakuru') # returns '032'
+
+KeCounties.province('Nakuru') # returns 'Rift Valley'
+```
+List of counties can be found in this [gist](https://gist.github.com/cesswairimu/56902588ed732b1abae2d7372e01f8fc)
+
+### Development
+
+- Run `rspec` to run tests
+- To install this gem locally on your machine, run `bundle exec rake install`.
+- To release a new version, update the version number in `lib/version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version. Push your commits and tags and push the gemspec file to rubygems.org
+- Then commit and make a PR to update the code on this repository
+
+### Contributing
+
+Bugs reports and pull requests are welcome at https://github.com/cesswairimu/ke_counties

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ke_counties"
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/ke_counties.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.name        = 'ke_counties'
   s.version     = KeCounties::VERSION
   s.summary     = 'Kenya Counties'
-  s.description = 'Collection of county codes, their names, capitals and provinces'
+  s.description = 'Collection of Kenya county names, their codes, capitals, abbreviations and provinces'
   s.authors     = ['cess']
   s.email       = 'cesswairimu@gmail.com'
   #s.files      = ["lib/ke_counties.rb"]
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_development_dependency 'rspec', '~> 3.13.0'
-  s.add_development_dependency 'rake', '~> 12.3.3'
-  s.add_development_dependency 'bundler', '~> 13.1.0'
+  s.add_development_dependency 'rake', '~> 13.2.0'
+  s.add_development_dependency 'bundler', '~> 2.5.7'
 end
 

data/lib/ke_counties/counties.rb

@@ -0,0 +1,80 @@
+module KeCounties
+  class Counties
+    HASH = { 'Mombasa'         => { code: '001',  abbrv: 'MSA', capital: "Mombasa",    province: 'Coast' },
+             'Kwale'           => { code: '002',  abbrv: 'KWL', capital: 'Kwale',      province: 'Coast' },
+             'Kilifi'          => { code: '003',  abbrv: 'KLF', capital: 'Kilifi',     province: 'Coast' },
+             'Tana River'      => { code: '004',  abbrv: 'TRV', capital: 'Hola',       province: 'Coast' },
+             'Lamu'            => { code: '005',  abbrv: 'LMU', capital: 'Lamu',       province: 'Coast' },
+             'Taita Taveta'    => { code: '006',  abbrv: 'TVT', capital: 'Wundanyi',   province: 'Coast' },
+             'Garissa'         => { code: '007',  abbrv: 'GRS', capital: 'Garissa',    province: 'North Eastern' },
+             'Wajir'           => { code: '008',  abbrv: 'WJR', capital: 'Wajir',      province: 'North Eastern' },
+             'Mandera'         => { code: '009',  abbrv: 'MDR', capital: 'Mandera',    province: 'North Eastern' },
+             'Marsabit'        => { code: '010',  abbrv: 'MRS', capital: 'Marsabit',   province: 'Eastern' },
+             'Isiolo'          => { code: '011',  abbrv: 'ISL', capital: 'Isiolo',     province: 'Eastern' },
+             'Meru'            => { code: '012',  abbrv: 'MRU', capital: 'Meru',       province: 'Eastern' },
+             'Tharaka-Nithi'   => { code: '013',  abbrv: 'TNT', capital: 'Kathwana',   province: 'Eastern' },
+             'Embu'            => { code: '014',  abbrv: 'EMB', capital: 'Embu',       province: 'Eastern' },
+             'Kitui'           => { code: '015',  abbrv: 'KTU', capital: 'Kitui',      province: 'Eastern' },
+             'Machakos'        => { code: '016',  abbrv: 'MCK', capital: 'Machakos',   province: 'Eastern' },
+             'Makueni'         => { code: '017',  abbrv: 'MKN', capital: 'Wote',       province: 'Eastern' },
+             'Nyandarua'       => { code: '018',  abbrv: 'NDR', capital: 'Ol Kalou',   province: 'Central' },
+             'Nyeri'           => { code: '019',  abbrv: 'NYR', capital: 'Nyeri',      province: 'Central' },
+             'Kirinyaga'       => { code: '020',  abbrv: 'KRG', capital: 'Kerogoya',   province: 'Central' },
+             "Murang'a"        => { code: '021',  abbrv: 'MRG', capital: "Murang'a",   province: 'Central' },
+             'Kiambu'          => { code: '022',  abbrv: 'KMB', capital: 'Kiambu',     province: 'Central' },
+             'Turkana'         => { code: '023',  abbrv: 'TRK', capital: 'Lodwar',     province: 'Rift Valley' },
+             'West Pokot'      => { code: '024',  abbrv: 'WPK', capital: 'Kapenguria', province: 'Rift Valley' },
+             'Samburu'         => { code: '025',  abbrv: 'SBR', capital: 'Maralal',    province: 'Rift Valley' },
+             'Trans-Nzoia'     => { code: '026',  abbrv: 'TNZ', capital: 'Kitale',     province: 'Rift Valley' },
+             'Uasin Gishu'     => { code: '027',  abbrv: 'UGS', capital: 'Eldoret',    province: 'Rift Valley' },
+             'Elgeyo-Marakwet' => { code: '028',  abbrv: 'EMK', capital: 'Iten',       province: 'Rift Valley' },
+             'Nandi'           => { code: '029',  abbrv: 'NDI', capital: 'Kapsabet',   province: 'Rift Valley' },
+             'Baringo'         => { code: '030',  abbrv: 'BRG', capital: 'Kabarnet',   province: 'Rift Valley' },
+             'Laikipia'        => { code: '031',  abbrv: 'LKP', capital: 'Rumuruti',   province: 'Rift Valley' },
+             'Nakuru'          => { code: '032',  abbrv: 'NKR', capital: 'Nakuru',     province: 'Rift Valley' },
+             'Narok'           => { code: '033',  abbrv: 'NRK', capital: 'Narok',      province: 'Rift Valley' },
+             'Kajiado'         => { code: '034',  abbrv: 'KJD', capital: 'Kajiado',    province: 'Rift Valley' },
+             'Kericho'         => { code: '035',  abbrv: 'KRC', capital: 'Kericho',    province: 'Rift Valley' },
+             'Bomet'           => { code: '036',  abbrv: 'BMT', capital: 'Bomet',      province: 'Rift Valley' },
+             'Kakamega'        => { code: '037',  abbrv: 'KKG', capital: 'Kakamega',   province: 'Western' },
+             'Vihiga'          => { code: '038',  abbrv: 'VHG', capital: 'Mbale',      province: 'Western' },
+             'Bungoma'         => { code: '039',  abbrv: 'BGM', capital: 'Bungoma',    province: 'Western' },
+             'Busia'           => { code: '040',  abbrv: 'BSA', capital: 'Busia',      province: 'Western' },
+             'Siaya'           => { code: '041',  abbrv: 'SYA', capital: 'Siaya',      province: 'Nyanza' },
+             'Kisumu'          => { code: '042',  abbrv: 'KSM', capital: 'Kisumu',     province: 'Nyanza' },
+             'Homa Bay'        => { code: '043',  abbrv: 'HBY', capital: 'Homa Bay',   province: 'Nyanza' },
+             'Migori'          => { code: '044',  abbrv: 'MGR', capital: 'Migori',     province: 'Nyanza' },
+             'Kisii'           => { code: '045',  abbrv: 'KSI', capital: 'Kisii',      province: 'Nyanza' },
+             'Nyamira'         => { code: '046',  abbrv: 'NMR', capital: 'Nyamira',    province: 'Nyanza' },
+             'Nairobi'         => { code: '047',  abbrv: 'NRB', capital: 'Nairobi',    province: 'Nairobi' }
+            }.freeze
+
+    def self.all
+      HASH
+    end
+
+    def self.names
+      HASH.keys
+    end
+
+    def self.code(cty)
+      HASH.dig(cty, :code)
+    end
+
+    def self.abbr(cty)
+      HASH.dig(cty, :abbrv)
+    end
+
+    def self.capital(cty)
+      HASH.dig(cty, :capital)
+    end
+
+    def self.province(cty)
+      HASH.dig(cty, :province)
+    end
+
+    def self.content
+      HASH.values
+    end
+  end
+end

data/lib/ke_counties/version.rb

@@ -1,3 +1,3 @@
 module KeCounties
-  VERSION = "0.0.0"
+  VERSION = "0.0.2"
 end

data/lib/ke_counties.rb

@@ -1,2 +1,45 @@
-require 'ke_counties/version'
-require 'ke_counties/counties'
+require_relative 'ke_counties/version'
+require_relative 'ke_counties/counties'
+
+module KeCounties
+  class << self
+
+    def all
+     counties.all
+    end
+
+    def names
+      counties.names
+    end
+
+    def code(cty)
+      counties.code(cty)
+    end
+
+    def abbr(cty)
+      counties.abbr(cty)
+    end
+
+    def capital(cty)
+      counties.capital(cty)
+    end
+
+    def province(cty)
+     counties.province(cty)
+    end
+
+    def codes
+      counties.content.map{ |i| i[:code]}
+    end
+
+    def abbrvs
+      counties.content.map{ |i| i[:abbrv]}
+    end
+
+    private
+
+    def counties
+      KeCounties::Counties
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ke_counties
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.2
 platform: ruby
 authors:
 - cess
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-28 00:00:00.000000000 Z
+date: 2024-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,40 +30,45 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: 13.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: 13.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.1.0
+        version: 2.5.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.1.0
-description: Collection of county codes, their names, capitals and provinces
+        version: 2.5.7
+description: Collection of Kenya county names, their codes, capitals, abbreviations
+  and provinces
 email: cesswairimu@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - ".rspec"
 - Gemfile
-- Gemfile.lock
 - README.md
+- Rakefile
+- bin/console
+- bin/setup
 - ke_counties.gemspec
 - lib/ke_counties.rb
+- lib/ke_counties/counties.rb
 - lib/ke_counties/version.rb
 homepage: https://github.com/cesswairimu/ke_counties
 licenses:

data/Gemfile.lock

@@ -1,36 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ke_counties (0.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.5.1)
-    rake (13.1.0)
-    rspec (3.13.0)
-      rspec-core (~> 3.13.0)
-      rspec-expectations (~> 3.13.0)
-      rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.0)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-
-PLATFORMS
-  ruby
-  x86_64-linux
-
-DEPENDENCIES
-  bundler (>= 2.5.3)
-  ke_counties!
-  rake (>= 12.3.3)
-  rspec (>= 3.13.0)
-
-BUNDLED WITH
-   2.5.3