ke_counties 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a23ca5515924858c355789d65540fbbaba3a30368609861cca6a9de2c995dcc9
-  data.tar.gz: c3f99fc697e4484f038885b4e94c17b2a38cdd3580ff0d51d98a1e61812fbddb
+  metadata.gz: eeecb8d2997b490e19aa4e11b7e3fd7fa616f9a954650ee3d123f71b530c9257
+  data.tar.gz: 3691770a5e074d572fcac4c686fec8a3c0d7a73bf8b3d02d3ca65e2e0a196ad0
 SHA512:
-  metadata.gz: e7e2c4ab68d6968c500bf44ca7ddc956ff8f0e5737e42f58341088d31b38a8e7beb37727ea28e1d940bc9e790c31ea4477e1473511538085c20bae7ff8bfbb73
-  data.tar.gz: e2dfc0c2842f3c2edc6609b004d27bc7bfe60ae07e206776493842715c6e803e5bf8b11a55e0f8cfb61f763a9f31d3ca6807b58af01d5ae5d06e7487cd76eeea
+  metadata.gz: c52af155aa92e0ae64d832f0a2726c8d2e9ef42d3439361e181b7cd23c982a9631eb575de1d41f047761b6456994c43c10d47767ec1eaa84222c6c95ba33c19c
+  data.tar.gz: 83c58e77b30c50671c3e83171d9ad427f09aaa99ba213754a95f33102fc445bf87cf71443479857a50c363398ba153c3c413ee89c7b62fc0f75c368625493533

data/README.md

@@ -1 +1,58 @@
-# 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
+
+RubyGems -  https://rubygems.org/gems/ke_counties

data/ke_counties.gemspec

@@ -6,13 +6,17 @@ 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"]
   s.homepage    = 'https://github.com/cesswairimu/ke_counties'
   s.license     = 'MIT'
-   s.files      = `git ls-files -z`.split("\x0").reject do |f|
+  s.metadata = {
+    'bug_tracker_uri'   => 'https://github.com/cesswairimu/ke_counties/issues',
+    'documentation_uri' => 'https://github.com/cesswairimu/ke_counties/blob/main/README.md',
+    'source_code_uri'   => 'https://github.com/cesswairimu/ke_counties/',
+  }
+  s.files      = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
 
@@ -21,7 +25,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

@@ -49,32 +49,8 @@ module KeCounties
              'Nairobi'         => { code: '047',  abbrv: 'NRB', capital: 'Nairobi',    province: 'Nairobi' }
             }.freeze
 
-    def self.all
+    def self.counties_hash
       HASH
     end
-
-    def self.names
-      HASH.keys
-    end
-
-    def self.code(cty)
-      HASH[cty][:code]
-    end
-
-    def self.abbr(cty)
-      HASH[cty][:abbrv]
-    end
-
-    def self.capital(cty)
-      HASH[cty][:capital]
-    end
-
-    def self.province(cty)
-      HASH[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.1"
+  VERSION = "0.0.3"
 end

data/lib/ke_counties.rb

@@ -1,46 +1,49 @@
 require_relative 'ke_counties/version'
 require_relative 'ke_counties/counties'
 
-module KeCounties 
+module KeCounties
   class << self
-    
-    def all 
-     counties.all
+
+    def all
+      counties
     end
 
     def names
-      counties.names
+      counties.keys
     end
 
     def code(cty)
-      counties.code(cty)
+      counties.dig(cty, :code)
     end
 
     def abbr(cty)
-      counties.abbr(cty)
+      counties.dig(cty, :abbrv)
     end
 
     def capital(cty)
-      counties.capital(cty)
+      counties.dig(cty, :capital)
     end
 
     def province(cty)
-     counties.province(cty)
+      counties.dig(cty, :province)
     end
 
     def codes
-      counties.content.map{ |i| i[:code]}
+      content.map{ |i| i[:code]}
     end
 
     def abbrvs
-      counties.content.map{ |i| i[:abbrv]}
+      content.map{ |i| i[:abbrv]}
     end
 
+    def content
+      counties.values
+    end
 
     private
 
     def counties
-      KeCounties::Counties
+      KeCounties::Counties.counties_hash
     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.3
 platform: ruby
 authors:
 - cess
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-28 00:00:00.000000000 Z
+date: 2024-04-04 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: []
@@ -72,7 +73,10 @@ files:
 homepage: https://github.com/cesswairimu/ke_counties
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/cesswairimu/ke_counties/issues
+  documentation_uri: https://github.com/cesswairimu/ke_counties/blob/main/README.md
+  source_code_uri: https://github.com/cesswairimu/ke_counties/
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -88,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Kenya Counties