ke_counties 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a23ca5515924858c355789d65540fbbaba3a30368609861cca6a9de2c995dcc9
-  data.tar.gz: c3f99fc697e4484f038885b4e94c17b2a38cdd3580ff0d51d98a1e61812fbddb
+  metadata.gz: cf99fa284a462a4a183fee4c1e3c44ed17818369d8ae108cc36d99c7f2ced9b1
+  data.tar.gz: 1d955b1c1955202ece741df81f59dc3842b35b15858af45736119313b0dce3e5
 SHA512:
-  metadata.gz: e7e2c4ab68d6968c500bf44ca7ddc956ff8f0e5737e42f58341088d31b38a8e7beb37727ea28e1d940bc9e790c31ea4477e1473511538085c20bae7ff8bfbb73
-  data.tar.gz: e2dfc0c2842f3c2edc6609b004d27bc7bfe60ae07e206776493842715c6e803e5bf8b11a55e0f8cfb61f763a9f31d3ca6807b58af01d5ae5d06e7487cd76eeea
+  metadata.gz: 8965f478c15541c531299ef11f0242bdebfaa59fa75f3e3dfcfceab0aea287e05ca0f20bfb77a94e5a109aa9c884f57327a5a9b04865826c1fc93529a54c5859
+  data.tar.gz: ede6c85e6c5ddfb0134c17a5efb5a7da4a858aba8c85b87161ae7436d529c1e853ec3086ad930c06219b141c92cda493ced0336b157d724584341468f2a2a35c

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/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

@@ -58,19 +58,19 @@ module KeCounties
     end
 
     def self.code(cty)
-      HASH[cty][:code]
+      HASH.dig(cty, :code)
     end
 
     def self.abbr(cty)
-      HASH[cty][:abbrv]
+      HASH.dig(cty, :abbrv)
     end
 
     def self.capital(cty)
-      HASH[cty][:capital]
+      HASH.dig(cty, :capital)
     end
 
     def self.province(cty)
-      HASH[cty][:province]
+      HASH.dig(cty, :province)
     end
 
     def self.content

data/lib/ke_counties/version.rb

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

data/lib/ke_counties.rb

@@ -1,10 +1,10 @@
 require_relative 'ke_counties/version'
 require_relative 'ke_counties/counties'
 
-module KeCounties 
+module KeCounties
   class << self
-    
-    def all 
+
+    def all
      counties.all
     end
 
@@ -36,11 +36,10 @@ module KeCounties
       counties.content.map{ |i| i[:abbrv]}
     end
 
-
     private
 
     def counties
       KeCounties::Counties
     end
-  end 
-end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ke_counties
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  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,29 +30,30 @@ 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: []