nayyar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 080fe4ea4cca3830776db05bc161573574ce2040
+  data.tar.gz: fefda208dc6000e1e6fb556e1b419410ca4180cc
+SHA512:
+  metadata.gz: 19c22e4015599bdae5058bdb8a55e7de45d859c9aa5825779b6172b7f7b132a9278fd69a8e7a582af93d01f2c85664b472e955f7f879acaa4438921ed89e89de
+  data.tar.gz: 3812e732b7f5aaf96c19b0651010ce9a6d5a94e0d9000bc345007803fa9155e8c2aeb5c79e35e6887d6fcb74c27064ccadcf9c65b46a0df621eb2adf0e42c4e2

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nayyar.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 mmhan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,158 @@
+# Nayyar / နေရာ
+[![Build Status](https://travis-ci.org/mmhan/nayyar.png)](https://travis-ci.org/mmhan/nayyar.png)
+
+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/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nayyar'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nayyar
+
+## Usage
+
+### States
+
+Find all states using
+
+```ruby
+Nayyar::State.all
+```
+
+Find states using MIMU's pcodes:
+
+```ruby
+Nayyar::State.find_by_pcode("MMR013")
+# => <Nayyar::State:0x007fd05cc79e60 @data={:iso=>"MM-06", :pcode=>"MMR013", :alpha3=>"YGN", :name=>"Yangon"}>
+```
+
+Find states using ISO3166-2:MM:
+
+```ruby
+Nayyar::State.find_by_iso("MM-01")
+# => #<Nayyar::State:0x007fd05cc7a040 @data={:iso=>"MM-01", :pcode=>"MMR005", :alpha3=>"SGG", :name=>"Sagaing"}>
+```
+
+
+Find states using alpha3
+
+```ruby
+Nayyar::State.find_by_alpha3("SHN")
+# => #<Nayyar::State:0x007fd05cc79e38     @data={:iso=>"MM-17", :pcode=>"MMR222", :alpha3=>"SHN", :name=>"Shan"}>
+```
+
+Or you can use a generic finder with an index
+
+```ruby
+Nayyar::State.find_by(pcode: "MMR013") #or iso: or alpha3:
+```
+
+Use any of the `find_by` or `find_by_**index_name**` with a bang `!` to trigger `Nayyar::StateNotFound` error.
+
+### 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
+shan_state.districts
+# or
+Nayyar::District.of_state(shan_state)
+```
+
+Find a district using pcode
+```ruby
+Nayyar::District.find_by_pcode("MMR001D001")
+# or
+Nayyar::District.find_by(pcode:"MMR001D001")
+
+# => #<Nayyar::District:0x007f9bf5361418 @data={:pcode=>"MMR001D001", :name=>"Myitkyina", :state=>"MMR001"}>
+```
+
+Find the state that a district belongs to using
+```ruby
+Nayyar::District.find_by(pcode:"MMR001D001").state
+
+# => <Nayyar::State:0x007f9bf532fc60 @data={:iso=>"MM-11", :pcode=>"MMR001", :alpha3=>"KCN", :name=>"Kachin"}>
+```
+
+Use any of the `find_by` or `find_by_**index_name**` with a bang `!` to trigger `Nayyar::DistrictNotFound` error.
+
+### 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
+ygn_east.townships
+# or
+Nayyar::Township.of_district(ygn_east)
+```
+
+Find a township using pcode
+```ruby
+Nayyar::Township.find_by_pcode("MMR013017")
+# or
+Nayyar::Township.find_by(pcode:"MMR013017")
+
+# => #<Nayyar::Township:0x007fb8a5b605e8 @data={:pcode=>"MMR013017", :name=>"Botahtaung", :district=>"MMR013D002"}>
+```
+
+Find the district that a township belongs to using
+```ruby
+Nayyar::Township.find_by(pcode:"MMR013017").township
+
+# => <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.
+
+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.
+
+## Contributing
+
+1. Fork it ( https://github.com/mmhan/nayyar/fork )
+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

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/data/districts.yml

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