nayyar 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 080fe4ea4cca3830776db05bc161573574ce2040
-  data.tar.gz: fefda208dc6000e1e6fb556e1b419410ca4180cc
+SHA256:
+  metadata.gz: b2214fdcbce8558b80e51d36d46ae9782ad6e2b1069b039b40cb77a26cbbc261
+  data.tar.gz: bb7a84322f286cd4b0df42f524dd9f0b1c38a5c0351b9b290d6eb9d9b27f023f
 SHA512:
-  metadata.gz: 19c22e4015599bdae5058bdb8a55e7de45d859c9aa5825779b6172b7f7b132a9278fd69a8e7a582af93d01f2c85664b472e955f7f879acaa4438921ed89e89de
-  data.tar.gz: 3812e732b7f5aaf96c19b0651010ce9a6d5a94e0d9000bc345007803fa9155e8c2aeb5c79e35e6887d6fcb74c27064ccadcf9c65b46a0df621eb2adf0e42c4e2
+  metadata.gz: 58fde7fc55bfafa3bec000b93a27d3ec4a604052df3595c5ab4792265f69e4a3e378a6ee9738cd6206b00b9f35244d884ea451c3ae1dfe7ccffda0ab41b76e00
+  data.tar.gz: 53d14ecff7dcc82f15f0ec86dfac166b31e0d0f2bbac43c773ced6c304ed57ac07fc89517f365336b051d8eddf06ca33aea689b4d59bb89b9076200039bd537a

data/.circleci/config.yml

@@ -0,0 +1,38 @@
+# Use the latest 2.1 version of CircleCI pipeline process engine.
+# See: https://circleci.com/docs/2.0/configuration-reference
+version: 2.1
+
+# Orbs are reusable packages of CircleCI configuration that you may share across projects, enabling you to create encapsulated, parameterized commands, jobs, and executors that can be used across multiple projects.
+# See: https://circleci.com/docs/2.0/orb-intro/
+orbs:
+  ruby: circleci/ruby@1.8.0
+
+# Define a job to be invoked later in a workflow.
+# See: https://circleci.com/docs/2.0/configuration-reference/#jobs
+jobs:
+  rspec:
+    docker:
+      - image: cimg/ruby:3.1.2
+    executor: ruby/default
+    steps:
+      - checkout
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      - run:
+          name: bundle install
+          command: bundle _2.3.11_ install
+      - run:
+          name: rubocop
+          command: rubocop 
+      - run:
+          name: rspec
+          command: rspec
+
+# Invoke jobs via workflows
+# See: https://circleci.com/docs/2.0/configuration-reference/#workflows
+workflows:
+  rspec: # This is the name of the workflow, feel free to change it to better match your workflow.
+    # Inside the workflow, you define the jobs you want to run.
+    jobs:
+      - rspec

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+    NewCops: enable
+    TargetRubyVersion: 2.7.0
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Metrics/BlockLength:
+  Exclude:
+    - 'nayyar.gemspec'
+    - 'spec/*.rb'

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in nayyar.gemspec

data/README.md

@@ -1,12 +1,12 @@
 # Nayyar / နေရာ
-[![Build Status](https://travis-ci.org/mmhan/nayyar.png)](https://travis-ci.org/mmhan/nayyar.png)
+[![CircleCI](https://circleci.com/gh/mmhan/nayyar/tree/master.svg?style=svg)](https://circleci.com/gh/mmhan/nayyar/tree/master)
 
 Nayyar is created with the intent of providing basic access to State/Regions, Districts or Townships of Myanmar, based on standards of Myanmar's country-wide census of 2014.
 
 15 States are indexed by MIMU's pcode, ISO3166-2:MM and alpha3 codes used in plate numbers by transportation authority.
 74 Districts and 413 Townships are indexed by MIMU's pcode.
 
-The current version is `0.1.0` and it uses [Semantic Versioning](http://semver.org/)
+The current version is [![Gem Version](https://badge.fury.io/rb/nayyar.svg)](http://badge.fury.io/rb/nayyar) and it uses [Semantic Versioning](http://semver.org/)
 
 ## Installation
 
@@ -67,11 +67,13 @@ Use any of the `find_by` or `find_by_**index_name**` with a bang `!` to trigger
 ### Districts
 
 Find all districts using
+
 ```ruby
 Nayyar::District.all
 ```
 
 Find districts under a certain state using
+
 ```ruby
 shan_state = Nayyar::State.find_by_alpha3("SHN")
 # get an array of all districts under Shan state using
@@ -81,6 +83,7 @@ Nayyar::District.of_state(shan_state)
 ```
 
 Find a district using pcode
+
 ```ruby
 Nayyar::District.find_by_pcode("MMR001D001")
 # or
@@ -90,6 +93,7 @@ Nayyar::District.find_by(pcode:"MMR001D001")
 ```
 
 Find the state that a district belongs to using
+
 ```ruby
 Nayyar::District.find_by(pcode:"MMR001D001").state
 
@@ -101,11 +105,13 @@ Use any of the `find_by` or `find_by_**index_name**` with a bang `!` to trigger
 ### Townships
 
 Find all townships using
+
 ```ruby
 Nayyar::Townships.all
 ```
 
 Find townships under a certain state using
+
 ```ruby
 ygn_east = Nayyar::District.find_by_pcode "MMR013D002"
 # get an array of all districts under Shan state using
@@ -115,6 +121,7 @@ Nayyar::Township.of_district(ygn_east)
 ```
 
 Find a township using pcode
+
 ```ruby
 Nayyar::Township.find_by_pcode("MMR013017")
 # or
@@ -124,30 +131,25 @@ Nayyar::Township.find_by(pcode:"MMR013017")
 ```
 
 Find the district that a township belongs to using
+
 ```ruby
-Nayyar::Township.find_by(pcode:"MMR013017").township
+Nayyar::Township.find_by(pcode:"MMR013017").district
 
 # => <Nayyar::District:0x007fb8a5ad14d8 @data={:pcode=>"MMR013D002", :name=>"Yangon (East)", :state=>"MMR013"}>
 ```
 
 Use any of the `find_by` or `find_by_**index_name**` with a bang `!` to trigger `Nayyar::TownshipNotFound` error.
-<!--
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+ 
+All data-related files are in the lib/data directory. `locations.csv` file is the source of truth, which includes States, Districts, and Townships data. YAML files are generated 
+by extracting the data from the `locations.csv` file. Do not update directly to YAML files. Any updates must be made in the `locations.csv` file and extracted to YAML files by running `bin/seed`.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
--->
-
-## Goals
-1. Make it work
-  - Create just enough API to allow creations of dropdowns/multiple-select options in HTML ✓
-2. Make it right
-  - Remove duplicate/similar codes across the three main classes using metaprogramming
-3. Make it fast
-  - Optimize memory footprint by refactoring the way data is stored/read/used
 
-If you feel that I have missed out your use-case or if you wanna add other goals, objectives [submit an issue](https://github.com/mmhan/nayyar/issues/new) so that I can plan it in.
+If you feel that I have missed out your use-case or find an issue with this gem [please submit an issue](https://github.com/mmhan/nayyar/issues/new).
 
 ## Contributing
 
@@ -155,4 +157,100 @@ If you feel that I have missed out your use-case or if you wanna add other goals
 2. Create your feature branch (`git checkout -b feature/my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin feature/my-new-feature`)
-5. Create a new Pull Request
+5. Create a new Pull Request
+
+
+## Documentation
+
+Since, this is a pretty small library, a documentation hasn't been created yet. Nonetheless, here's the rspec output with documentation format.
+
+```
+Nayyar
+  has a version number
+
+Nayyar::State
+  class methods
+    .all
+      should be a kind of Array
+      contains hashes of state data
+    .find_by
+      returns state when it finds it
+      will return nil if state is not found
+      will raise ArgumentError if no argument is provided
+      will raise ArgumentError if wrong argument is provided
+    .find_by!
+      should be a kind of Nayyar::State
+      will raise error if the state isn't found
+    .find_by_**indices**
+      returns state when it finds it
+      returns nil when it can't be found
+    .find_by_**indices**!
+      returns state when it finds it
+      raise error when it can't be found
+  #initialize
+    allows to create a state by providing hash data
+  attributes
+    allows its attributes to be accessed by methods
+    allows its attributes to be accessed as keys
+  #districts
+    return a list of districts under given state
+
+Nayyar::District
+  class methods
+    .all
+      should return all districts
+    .of_state
+      return a list of districts under given state
+    .find_by
+      should be a kind of Nayyar::District
+      returns nil if it's not found
+    .find_by!
+      should be a kind of Nayyar::District
+      raise error if it's not found
+    .find_by_**indices**
+      returns state when it finds it
+      returns nil when it can't be found
+    .find_by_**indices**!
+      returns state when it finds it
+      raise error when it can't be found
+  #initialize
+    allows to create a district by providing hash data
+  attributes
+    allows its attributes to be accessed by methods
+    allows its attributes to be accessed as keys
+  #state
+    should be a kind of Nayyar::State
+    expect it to be a correct state
+  .townships
+    return a list of districts under given district
+
+Nayyar::Township
+  class methods
+    .all
+      should return all township
+    .of_district
+      return a list of districts under given district
+    .find_by
+      should be a kind of Nayyar::Township
+      returns nil if it's not found
+    .find_by!
+      should be a kind of Nayyar::Township
+      raise error if it's not found
+    .find_by_**indices**
+      returns state when it finds it
+      returns nil when it can't be found
+    .find_by_**indices**!
+      returns state when it finds it
+      raise error when it can't be found
+  #initialize
+    allows to create a township by providing hash data
+  attributes
+    allows its attributes to be accessed by methods
+    allows its attributes to be accessed as keys
+  #district
+    should be a kind of Nayyar::District
+    expect it to be a correct state
+
+Finished in 0.1254 seconds (files took 0.1826 seconds to load)
+48 examples, 0 failures
+```

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "nayyar"
+require 'bundler/setup'
+require 'nayyar'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "nayyar"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/bin/seed

@@ -0,0 +1,11 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+# Parentheses are used to run the command in a subshell. Ruuning a command
+# in sub-shell allows you to stay on the current directory after running 
+# the command.
+
+(cd lib/data && bundle exec ruby extract.rb)
+
+echo "Seeding done"

data/lib/data/districts.yml

@@ -1,223 +1,297 @@
 ---
 - :pcode: MMR001D001
   :name: Myitkyina
+  :my_name: မြစ်ကြီးနား
   :state: MMR001
 - :pcode: MMR001D002
   :name: Mohnyin
+  :my_name: မိုးညှင်
   :state: MMR001
 - :pcode: MMR001D003
   :name: Bhamo
+  :my_name: ဗန်းမော်
   :state: MMR001
 - :pcode: MMR001D004
   :name: Puta-O
+  :my_name: ပူတာအို
   :state: MMR001
 - :pcode: MMR002D001
   :name: Loikaw
+  :my_name: လွိုင်ကော်
   :state: MMR002
 - :pcode: MMR002D002
   :name: Bawlake
+  :my_name: ဘော်လခဲ
   :state: MMR002
 - :pcode: MMR003D001
   :name: Hpa-An
+  :my_name: ဘားအံ
   :state: MMR003
 - :pcode: MMR003D004
   :name: Hpapun
+  :my_name: ဖာပွန်
   :state: MMR003
 - :pcode: MMR003D002
   :name: Myawaddy
+  :my_name: မြဝတီ
   :state: MMR003
 - :pcode: MMR003D003
   :name: Kawkareik
+  :my_name: ကော့ကရိတ်
   :state: MMR003
 - :pcode: MMR004D003
   :name: Hakha
+  :my_name: ဟားခါး
   :state: MMR004
 - :pcode: MMR004D001
   :name: Falam
+  :my_name: ဖလမ်း
   :state: MMR004
 - :pcode: MMR004D002
   :name: Mindat
+  :my_name: မင်းတပ်
   :state: MMR004
 - :pcode: MMR005D001
   :name: Sagaing
+  :my_name: စစ်ကိုင်း
   :state: MMR005
 - :pcode: MMR005D002
   :name: Shwebo
+  :my_name: ရွှေဘို
   :state: MMR005
 - :pcode: MMR005D003
   :name: Monywa
+  :my_name: မုံရွာ
   :state: MMR005
 - :pcode: MMR005D004
   :name: Katha
+  :my_name: ကသာ
   :state: MMR005
 - :pcode: MMR005D005
   :name: Kale
+  :my_name: ကလေး
   :state: MMR005
 - :pcode: MMR005D006
   :name: Tamu
+  :my_name: တမူး
   :state: MMR005
 - :pcode: MMR005D007
   :name: Mawlaik
+  :my_name: မော်လိုက်
   :state: MMR005
 - :pcode: MMR005D008
   :name: Hkamti
+  :my_name: ခန္တီး
   :state: MMR005
 - :pcode: MMR005D009
   :name: Yinmabin
+  :my_name: ယင်းမာပင်
   :state: MMR005
 - :pcode: MMR006D001
   :name: Dawei
+  :my_name: ထားဝယ်
   :state: MMR006
 - :pcode: MMR006D002
   :name: Myeik
+  :my_name: မြိတ်
   :state: MMR006
 - :pcode: MMR006D003
   :name: Kawthoung
+  :my_name: ကော့သောင်း
   :state: MMR006
 - :pcode: MMR007D001
   :name: Bago
+  :my_name: ပဲခူး
   :state: MMR111
 - :pcode: MMR007D002
   :name: Taungoo
+  :my_name: တောင်ငူ
   :state: MMR111
 - :pcode: MMR008D001
   :name: Pyay
+  :my_name: ပြည်
   :state: MMR111
 - :pcode: MMR008D002
   :name: Thayarwady
+  :my_name: သာယာဝတီ
   :state: MMR111
 - :pcode: MMR009D001
   :name: Magway
+  :my_name: မကွေး
   :state: MMR009
 - :pcode: MMR009D002
   :name: Minbu
+  :my_name: မင်းဘူး
   :state: MMR009
 - :pcode: MMR009D003
   :name: Thayet
+  :my_name: သရက်
   :state: MMR009
 - :pcode: MMR009D004
   :name: Pakokku
+  :my_name: ပခုက္ကူ
   :state: MMR009
 - :pcode: MMR009D005
   :name: Gangaw
+  :my_name: ဂန့်ဂေါ
   :state: MMR009
 - :pcode: MMR010D001
   :name: Mandalay
+  :my_name: မန္တလေး
   :state: MMR010
 - :pcode: MMR010D002
   :name: Pyinoolwin
+  :my_name: ပြင်ဦးလွင်
   :state: MMR010
 - :pcode: MMR010D003
   :name: Kyaukse
+  :my_name: ကျောက်ဆည်
   :state: MMR010
 - :pcode: MMR010D004
   :name: Myingyan
+  :my_name: မြင်းခြံ
   :state: MMR010
 - :pcode: MMR010D005
   :name: Nyaung-U
+  :my_name: ညောင်ဦး
   :state: MMR010
 - :pcode: MMR010D006
   :name: Yamethin
+  :my_name: ရမည်းသင်း
   :state: MMR010
 - :pcode: MMR010D007
   :name: Meiktila
+  :my_name: မိတ္ထီလာ
   :state: MMR010
 - :pcode: MMR011D001
   :name: Mawlamyine
+  :my_name: မော်လမြိုင်
   :state: MMR011
 - :pcode: MMR011D002
   :name: Thaton
+  :my_name: သထုံ
   :state: MMR011
 - :pcode: MMR012D001
   :name: Sittwe
+  :my_name: စစ်တွေ
   :state: MMR012
 - :pcode: MMR012D005
   :name: Mrauk-U
+  :my_name: မြောက်ဦး
   :state: MMR012
 - :pcode: MMR012D002
   :name: Maungdaw
+  :my_name: မောင်တော
   :state: MMR012
 - :pcode: MMR012D003
   :name: Kyaukpyu
+  :my_name: ကျောက်ဖြူ
   :state: MMR012
 - :pcode: MMR012D004
   :name: Thandwe
+  :my_name: သံတွဲ
   :state: MMR012
 - :pcode: MMR013D001
   :name: Yangon (North)
+  :my_name: ရန်ကုန်(မြောက်ပိုင်း)
   :state: MMR013
 - :pcode: MMR013D002
   :name: Yangon (East)
+  :my_name: ရန်ကုန်(အရှေ့ပိုင်း)
   :state: MMR013
 - :pcode: MMR013D003
   :name: Yangon (South)
+  :my_name: ရန်ကုန်(တောင်ပိုင်း)
   :state: MMR013
 - :pcode: MMR013D004
   :name: Yangon (West)
+  :my_name: ရန်ကုန်(အနောက်ပိုင်း)
   :state: MMR013
 - :pcode: MMR014D001
   :name: Taunggyi
+  :my_name: တောင်ကြီး
   :state: MMR222
 - :pcode: MMR014D002
   :name: Loilen
+  :my_name: လွိုင်လင်
   :state: MMR222
 - :pcode: MMR014D003
   :name: Langkho
+  :my_name: လင်းခေး
   :state: MMR222
 - :pcode: MMR015D001
   :name: Lashio
+  :my_name: လားရှိုး
   :state: MMR222
 - :pcode: MMR015D002
   :name: Muse
+  :my_name: မူစယ်
   :state: MMR222
 - :pcode: MMR015D003
   :name: Kyaukme
+  :my_name: ကျောက်မဲ
   :state: MMR222
 - :pcode: MMR015D004
   :name: Kunlong
+  :my_name: ကွမ်းလုံ
   :state: MMR222
 - :pcode: MMR015D005
   :name: Laukkaing
+  :my_name: လောက်ကိုင်
   :state: MMR222
 - :pcode: MMR015D006
   :name: Hopang
+  :my_name: ဟိုပန်
   :state: MMR222
 - :pcode: MMR015D007
   :name: Matman
+  :my_name: မက်မန်း
   :state: MMR222
 - :pcode: MMR016D001
   :name: Kengtung
+  :my_name: ကျိုင်းတုံ
   :state: MMR222
 - :pcode: MMR016D002
   :name: Monghsat
+  :my_name: မိုင်းဆတ်
   :state: MMR222
 - :pcode: MMR016D003
   :name: Tachileik
+  :my_name: တာချီလိတ်
   :state: MMR222
 - :pcode: MMR016D004
   :name: Monghpyak
+  :my_name: မိုင်းဖြတ်
   :state: MMR222
 - :pcode: MMR017D001
   :name: Pathein
+  :my_name: ပုသိမ်
   :state: MMR017
 - :pcode: MMR017D006
   :name: Pyapon
+  :my_name: ဖျာပုံ
   :state: MMR017
 - :pcode: MMR017D005
   :name: Maubin
+  :my_name: မအူပင်
   :state: MMR017
 - :pcode: MMR017D003
   :name: Myaungmya
+  :my_name: မြောင်းမြ
   :state: MMR017
 - :pcode: MMR017D004
   :name: Labutta
+  :my_name: လပွတ္တာ
   :state: MMR017
 - :pcode: MMR017D002
   :name: Hinthada
+  :my_name: ဟင်္သာတ
   :state: MMR017
 - :pcode: MMR018D001
   :name: Naypyitaw (North)
+  :my_name: နေပြည်တော်(မြောက်ပိုင်း)
   :state: MMR018
 - :pcode: MMR018D002
   :name: Naypyitaw (South)
+  :my_name: နေပြည်တော်(တောင်ပိုင်း)
   :state: MMR018

data/lib/data/extract.rb

@@ -1,3 +1,8 @@
+# frozen_string_literal: true
+
+# Extract data from locations.csv which will be the source of data for the gem
+# and create states.yml, districts.yml and townships.yml which will be read at runtime
+
 require 'csv'
 require 'pry'
 require 'psych'
@@ -6,14 +11,40 @@ states = []
 districts = []
 townships = []
 
-CSV.foreach("locations.csv") do |iso, s_pcode, alpha3, state, d_pcode, district, t_pcode, township|
-	states << {iso: iso, pcode: s_pcode, alpha3: alpha3, name: state}
-	districts << {pcode: d_pcode, name: district, state: s_pcode} unless d_pcode.nil?
-	townships << {pcode: t_pcode, name: township, district: d_pcode} unless t_pcode.nil?
+def state(location)
+  { iso: location[:iso], pcode: location[:s_pcode], alpha3: location[:alpha3], name: location[:state],
+    my_name: location[:state_in_my] }
+end
+
+def district?(location)
+  !location[:d_pcode].nil?
+end
+
+def district(location)
+  { pcode: location[:d_pcode], name: location[:district], my_name: location[:district_in_my],
+    state: location[:s_pcode] }
+end
+
+def township?(location)
+  !location[:t_pcode].nil?
+end
+
+def township(location)
+  { pcode: location[:t_pcode], name: location[:township], my_name: location[:township_in_my],
+    district: location[:d_pcode] }
+end
+
+CSV.foreach('locations.csv') do |location_csv_data|
+  keys = %i[iso s_pcode alpha3 state state_in_my d_pcode district district_in_my t_pcode township
+            township_in_my]
+  location = keys.zip(*location_csv_data).to_h
+  states << state(location)
+  districts << district(location) if district?(location)
+  townships << township(location) if township?(location)
 end
 states.uniq! { |state| state[:pcode] }
-districts.uniq! { |districts| districts[:pcode] }
+districts.uniq! { |district| district[:pcode] }
 
-File.open("states.yml", "w") { |f| f.write states.to_yaml }
-File.open("districts.yml", "w") { |f| f.write districts.to_yaml }
-File.open("townships.yml", "w") { |f| f.write townships.to_yaml }
+File.write('states.yml', states.to_yaml)
+File.write('districts.yml', districts.to_yaml)
+File.write('townships.yml', townships.to_yaml)