nayyar 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2b73ccd19ba2f9ea0124304341c983edb9363ec0
-  data.tar.gz: e9c7e00c72547ed8904b1db7d03433e2185e0418
+SHA256:
+  metadata.gz: 8877dd83a8a2ba5c4efc6ce025c6afc79e072d2361008d02e2cc4eebad49c027
+  data.tar.gz: dd7f9602d9cb86f1447017101f014b5c652d47b71e7394363260a476b3d33ccd
 SHA512:
-  metadata.gz: 475405f6bed972be38687570dc18cfff97354c499de93f33c096010a447aa3cd40478ec5c07ca05ebcdf1a3a1b4eee90f86ba8f1d67e60062829d347d33f30a4
-  data.tar.gz: 10476a3b59b57050c366257fdc422fc3819eab5fc1add2305dc9c9b5bd8e9012457bd443dce26aa3919b3093c38dd016aacc0b60c445baa68ba845d9c0d04f54
+  metadata.gz: 2ac406af5aab9869fcaeb709c8a08f25105b62c8ba1528b0ef836b15ba4c923d629e2431a970b761ae552ecd32f5ae41e69dfbad557e340eaf6e02257017c8ee
+  data.tar.gz: df07064162e9a98507b12a075b5ae17cd690453587bd20c2bd08107fcf7730483de97e52a7b79cd189ae36a911b9187c7ab31e700377e6b76b1442f25b0c07a3

data/.circleci/config.yml

@@ -0,0 +1,35 @@
+# 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.4.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.0
+    executor: ruby/default
+    steps:
+      - checkout
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      - run:
+          name: bundle install
+          command: bundle install
+      - 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,10 @@
+AllCops:
+    NewCops: enable
+
+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,13 +1,12 @@
 # Nayyar / နေရာ
-[![Build Status](https://travis-ci.org/mmhan/nayyar.png)](https://travis-ci.org/mmhan/nayyar.png)
-[![Gem Version](https://badge.fury.io/rb/nayyar.svg)](http://badge.fury.io/rb/nayyar)
+[![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
 
@@ -134,29 +133,20 @@ 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.
 
 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
 
@@ -164,4 +154,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/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,14 @@ 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?
+CSV.foreach('locations.csv') do |iso, s_pcode, alpha3, state, d_pcode, district, t_pcode, township| # rubocop:disable Metrics/ParameterLists
+  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?
 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)

data/lib/nayyar/district.rb

@@ -1,122 +1,129 @@
+# frozen_string_literal: true
+
+# Represents a District in Myanmar
 class Nayyar::District
-	attr_reader :data
-
-	@@districts = nil
-	@@state_index = {}
-
-	@@attributes = [
-		:pcode,
-		:name
-	]
-
-	def initialize(data)
-		@data = data
-	end
-
-	# define getters
-	@@attributes.each do |attr|
-		define_method attr do
-			@data[attr]
-		end
-	end
-
-	# allow the values to be retrieved as an array
-	def [](key)
-		if @@attributes.include? key
-			@data[key]
-		elsif :state == key.to_sym
-			state
-		end
-	end
-
-	def state
-		Nayyar::State.find_by_pcode(@data[:state])
-	end
-
-	def townships
-		Nayyar::Township.of_district(self)
-	end
-
-	class << self
-		INDICES = %w(pcode)
-
-		def all
-			self.districts
-		end
-
-		def of_state(state)
-			state_pcode = state.pcode
-			districts = self.districts
-			@@state_index[state_pcode].map do |index|
-				districts[index]
-			end
-		end
-
-		def find_by(query)
-			key = get_key(query)
-			(index = send("#{key}_index".to_sym).index(query[key])) && districts[index]
-		end
-
-		def find_by!(query)
-			if district = find_by(query)
-				district
-			else
-				key = get_key(query)
-				raise Nayyar::DistrictNotFound.new("Cannot find State with given #{key}: #{query[key]}")
-			end
-		end
-
-		INDICES.each do |index|
-	  	define_method("find_by_#{index}") do |query|
-	  		find_by(index.to_sym => query)
-	  	end
-	  	define_method("find_by_#{index}!") do |query|
-	  		find_by!(index.to_sym => query)
-	  	end
-	  end
-
-		protected
-			def districts
-	    	unless @@districts
-					require "yaml"
-	    		data = YAML.load_file(File.join(File.dirname(__FILE__), '..', 'data', 'districts.yml'))
-	    		indices = INDICES.inject({}) { |memo, index| memo.merge index => [] }
-	    		i = 0
-	    		@@districts= data.map do |district_row|
-	    			state_pcode = district_row[:state]
-	    			district = new(district_row)
-	    			INDICES.each do |index|
-	    				indices[index] << district.send(index)
-	    			end
-	    			@@state_index[state_pcode] ||= []
-	    			@@state_index[state_pcode] << i
-	    			i += 1
-		    		district
-	    		end
-
-	    		INDICES.each do |index|
-	    			class_variable_set("@@#{index}_index", indices[index])
-	    		end
-	    	end
-	    	@@districts
-			end
-
-	    ## define private methods for internal use of indexed array
-	    INDICES.each do |index|
-		    define_method("#{index}_index") do
-		    	districts
-		    	class_variable_get("@@#{index}_index")
-		    end
-	    end
-
-	    ## return the index for query given to find_by/find_by! method
-		  def get_key(data)
-		    keys = data.keys
-		    if keys.length != 1 || INDICES.none? { |key| key.to_sym == keys.first.to_sym }
-		      raise ArgumentError.new("`find_by` accepts only one of #{INDICES.join(" or ")} as argument. none provided")
-		    end
-		    keys.first
-		  end
-	end
+  attr_reader :data
+
+  @districts = nil
+  @state_index = {}
+
+  ATTRIBUTES = %i[
+    pcode
+    name
+  ].freeze
+
+  INDICES = %w[pcode].freeze
+
+  def initialize(data)
+    @data = data
+  end
+
+  # define getters
+  ATTRIBUTES.each do |attr|
+    define_method attr do
+      @data[attr]
+    end
+  end
+
+  # allow the values to be retrieved as an array
+  def [](key)
+    if ATTRIBUTES.include? key
+      @data[key]
+    elsif key.to_sym == :state
+      state
+    end
+  end
+
+  def state
+    Nayyar::State.find_by_pcode(@data[:state])
+  end
+
+  def townships
+    Nayyar::Township.of_district(self)
+  end
+
+  class << self
+    def all
+      districts
+    end
+
+    def of_state(state)
+      state_pcode = state.pcode
+      districts = self.districts
+      @state_index[state_pcode].map do |index|
+        districts[index]
+      end
+    end
+
+    def find_by(query)
+      key = get_key(query)
+      (index = send("#{key}_index".to_sym).index(query[key])) && districts[index]
+    end
+
+    def find_by!(query)
+      if (district = find_by(query))
+        district
+      else
+        key = get_key(query)
+        raise Nayyar::DistrictNotFound, "Cannot find State with given #{key}: #{query[key]}"
+      end
+    end
+
+    INDICES.each do |index|
+      define_method("find_by_#{index}") do |query|
+        find_by(index.to_sym => query)
+      end
+      define_method("find_by_#{index}!") do |query|
+        find_by!(index.to_sym => query)
+      end
+    end
+
+    protected
+
+    def districts
+      unless @districts
+        indices = INDICES.inject({}) { |memo, index| memo.merge index => [] }
+        @districts = data.each_with_index.map do |district_data, i|
+          new(district_data).tap { |district| build_indices(indices, district, district_data[:state], i) }
+        end
+
+        INDICES.each do |index|
+          class_variable_set("@@#{index}_index", indices[index]) # rubocop:disable Style/ClassVars
+        end
+      end
+      @districts
+    end
+
+    def data
+      YAML.load_file(File.join(File.dirname(__FILE__), '..', 'data', 'districts.yml'))
+    end
+
+    def build_indices(indices, district, state_pcode, reference_index)
+      INDICES.each do |index|
+        indices[index] << district.send(index)
+      end
+      @state_index[state_pcode] ||= []
+      @state_index[state_pcode] << reference_index
+    end
+
+    ## define private methods for internal use of indexed array
+    INDICES.each do |index|
+      define_method("#{index}_index") do
+        districts
+        class_variable_get("@@#{index}_index")
+      end
+    end
+
+    ## return the index for query given to find_by/find_by! method
+    def get_key(data)
+      keys = data.keys
+      if keys.length != 1 || INDICES.none? { |key| key.to_sym == keys.first.to_sym }
+        raise ArgumentError, "`find_by` accepts only one of #{INDICES.join(' or ')} as argument. none provided"
+      end
+
+      keys.first
+    end
+  end
 end
-class Nayyar::DistrictNotFound < StandardError; end;
+
+class Nayyar::DistrictNotFound < StandardError; end

data/lib/nayyar/state.rb

@@ -1,107 +1,110 @@
+# frozen_string_literal: true
+
+# Represents a State in Myanmar
 class Nayyar::State
-	attr_reader :data
+  attr_reader :data
 
-  @@states = nil
-  @@pcode_index = []
-  @@iso_index = []
-  @@alpha3_index = []
+  @states = nil
+  @pcode_index = []
+  @iso_index = []
+  @alpha3_index = []
 
-	attributes = [
-		:pcode,
-		:iso,
-		:alpha3,
-		:name
-	]
+  ATTRIBUTES = %i[
+    pcode
+    iso
+    alpha3
+    name
+  ].freeze
 
-	def initialize(data)
-		@data = data
-	end
+  INDICES = %w[pcode iso alpha3].freeze
 
+  def initialize(data)
+    @data = data
+  end
 
-	# define getters
-	attributes.each do |attr|
-		define_method attr do
-			@data[attr]
-		end
-	end
+  # define getters
+  ATTRIBUTES.each do |attr|
+    define_method attr do
+      @data[attr]
+    end
+  end
 
-	# allow the values to be retrieved as an array
-	def [](key)
-		@data[key]
-	end
+  # allow the values to be retrieved as an array
+  def [](key)
+    @data[key]
+  end
 
   def districts
-  	Nayyar::District.of_state self
+    Nayyar::District.of_state self
   end
 
-
-	class << self
-	  INDICES = %w(pcode iso alpha3)
-
-		def all
-			states
-		end
-
-	  def find_by(query)
-	    key = get_key(query)
-	    (index = send("#{key}_index".to_sym).index(query[key])) && states[index]
-	  end
-
-	  def find_by!(query)
-	    if state = find_by(query)
-	      state
-	    else
-	      key = get_key(query)
-	      raise Nayyar::StateNotFound.new("Cannot find State with given #{key}: #{query[key]}")
-	    end
-	  end
-
-	  INDICES.each do |index|
-	  	define_method("find_by_#{index}") do |query|
-	  		find_by(index.to_sym => query)
-	  	end
-	  	define_method("find_by_#{index}!") do |query|
-	  		find_by!(index.to_sym => query)
-	  	end
-	  end
-
-
-	  protected
-	    def states
-	    	unless @@states
-					require "yaml"
-	    		data = YAML.load_file(File.join(File.dirname(__FILE__), '..', 'data', 'states.yml'))
-	    		indices = INDICES.inject({}) { |memo, index| memo.merge index => [] }
-	    		@@states = data.map do |state|
-	    			state = new(state)
-	    			INDICES.each do |index|
-	    				indices[index] << state.send(index)
-	    			end
-	    			state
-	    		end
-	    		INDICES.each do |index|
-	    			class_variable_set("@@#{index}_index", indices[index])
-	    		end
-	    	end
-	    	@@states
-	    end
-
-	    ## define private methods for internal use of indexed array
-	    INDICES.each do |index|
-		    define_method("#{index}_index") do
-		    	states
-		    	class_variable_get("@@#{index}_index")
-		    end
-	    end
-
-	    ## return the index for query given to find_by/find_by! method
-		  def get_key(data)
-		    keys = data.keys
-		    if keys.length != 1 || INDICES.none? { |key| key.to_sym == keys.first.to_sym }
-		      raise ArgumentError.new("`find_by` accepts only one of #{INDICES.join(" or ")} as argument. None provided")
-		    end
-		    keys.first
-		  end
-	end
+  class << self
+    def all
+      states
+    end
+
+    def find_by(query)
+      key = get_key(query)
+      (index = send("#{key}_index".to_sym).index(query[key])) && states[index]
+    end
+
+    def find_by!(query)
+      if (state = find_by(query))
+        state
+      else
+        key = get_key(query)
+        raise Nayyar::StateNotFound, "Cannot find State with given #{key}: #{query[key]}"
+      end
+    end
+
+    INDICES.each do |index|
+      define_method("find_by_#{index}") do |query|
+        find_by(index.to_sym => query)
+      end
+      define_method("find_by_#{index}!") do |query|
+        find_by!(index.to_sym => query)
+      end
+    end
+
+    protected
+
+    def states
+      unless @states
+        indices = INDICES.inject({}) { |memo, index| memo.merge index => [] }
+        @states = data.map do |state_data|
+          new(state_data).tap { |state| build_indices(indices, state) }
+        end
+        INDICES.each { |index| class_variable_set(:"@@#{index}_index", indices[index]) } # rubocop:disable Style/ClassVars
+      end
+      @states
+    end
+
+    def data
+      YAML.load_file(File.join(File.dirname(__FILE__), '..', 'data', 'states.yml'))
+    end
+
+    def build_indices(indices, state)
+      INDICES.each { |index| indices[index] << state.send(index) }
+    end
+
+    ## define private methods for internal use of indexed array
+    INDICES.each do |index|
+      define_method("#{index}_index") do
+        states
+        class_variable_get(:"@@#{index}_index")
+      end
+    end
+
+    ## return the index for query given to find_by/find_by! method
+    def get_key(data)
+      keys = data.keys
+      if keys.length != 1 || INDICES.none? { |key| key.to_sym == keys.first.to_sym }
+        raise ArgumentError, "`find_by` accepts only one of #{INDICES.join(' or ')} as argument. None provided"
+      end
+
+      keys.first
+    end
+  end
 end
-class Nayyar::StateNotFound < StandardError; end;
+
+class Nayyar::StateNotFound < StandardError; end

data/lib/nayyar/township.rb

@@ -1,119 +1,125 @@
+# frozen_string_literal: true
+
+# Represents a Township in Myanmar
 class Nayyar::Township
-	attr_reader :data
-
-	@@townships = nil
-	@@district_index = {}
-
-	@@attributes = [
-		:pcode,
-		:name
-	]
-
-	def initialize(data)
-		@data = data
-	end
-
-	# define getters
-	@@attributes.each do |attr|
-		define_method attr do
-			@data[attr]
-		end
-	end
-
-	# allow the values to be retrieved as an array
-	def [](key)
-		if @@attributes.include? key
-			@data[key]
-		elsif :district == key.to_sym
-			district
-		end
-	end
-
-	def district
-		Nayyar::District.find_by_pcode(@data[:district])
-	end
-
-	class << self
-		INDICES = %w(pcode)
-
-		def all
-			townships
-		end
-
-		def of_district(district)
-			state_pcode = district.pcode
-			townships = self.townships
-			@@district_index[state_pcode].map do |index|
-				townships[index]
-			end
-		end
-
-		def find_by(query)
-			key = get_key(query)
-			(index = send("#{key}_index".to_sym).index(query[key])) && townships[index]
-		end
-
-		def find_by!(query)
-			if district = find_by(query)
-				district
-			else
-				key = get_key(query)
-				raise Nayyar::TownshipNotFound.new("Cannot find State with given #{key}: #{query[key]}")
-			end
-		end
-
-		INDICES.each do |index|
-	  	define_method("find_by_#{index}") do |query|
-	  		find_by(index.to_sym => query)
-	  	end
-	  	define_method("find_by_#{index}!") do |query|
-	  		find_by!(index.to_sym => query)
-	  	end
-	  end
-
-		protected
-			def townships
-	    	unless @@townships
-					require "yaml"
-	    		data = YAML.load_file(File.join(File.dirname(__FILE__), '..', 'data', 'townships.yml'))
-	    		indices = INDICES.inject({}) { |memo, index| memo.merge index => [] }
-	    		i = 0
-	    		@@townships= data.map do |township_row|
-	    			district_pcode = township_row[:district]
-	    			district = new(township_row)
-	    			INDICES.each do |index|
-	    				indices[index] << district.send(index)
-	    			end
-	    			@@district_index[district_pcode] ||= []
-	    			@@district_index[district_pcode] << i
-	    			i += 1
-		    		district
-	    		end
-
-
-	    		INDICES.each do |index|
-	    			class_variable_set("@@#{index}_index", indices[index])
-	    		end
-	    	end
-	    	@@townships
-			end
-
-	    ## define private methods for internal use of indexed array
-	    INDICES.each do |index|
-		    define_method("#{index}_index") do
-			    townships
-		    	class_variable_get("@@#{index}_index")
-		    end
-	    end
-
-	    ## return the index for query given to find_by/find_by! method
-		  def get_key(data)
-		    keys = data.keys
-		    if keys.length != 1 || INDICES.none? { |key| key.to_sym == keys.first.to_sym }
-		      raise ArgumentError.new("`find_by` accepts only one of #{INDICES.join(" or ")} as argument. none provided")
-		    end
-		    keys.first
-		  end
-	end
+  attr_reader :data
+
+  @townships = nil
+  @district_index = {}
+
+  ATTRIBUTES = %i[
+    pcode
+    name
+  ].freeze
+
+  INDICES = %w[pcode].freeze
+
+  def initialize(data)
+    @data = data
+  end
+
+  # define getters
+  ATTRIBUTES.each do |attr|
+    define_method attr do
+      @data[attr]
+    end
+  end
+
+  # allow the values to be retrieved as an array
+  def [](key)
+    if ATTRIBUTES.include? key
+      @data[key]
+    elsif key.to_sym == :district
+      district
+    end
+  end
+
+  def district
+    Nayyar::District.find_by_pcode(@data[:district])
+  end
+
+  class << self
+    def all
+      townships
+    end
+
+    def of_district(district)
+      state_pcode = district.pcode
+      townships = self.townships
+      @district_index[state_pcode].map do |index|
+        townships[index]
+      end
+    end
+
+    def find_by(query)
+      key = get_key(query)
+      (index = send("#{key}_index".to_sym).index(query[key])) && townships[index]
+    end
+
+    def find_by!(query)
+      if (district = find_by(query))
+        district
+      else
+        key = get_key(query)
+        raise Nayyar::TownshipNotFound, "Cannot find State with given #{key}: #{query[key]}"
+      end
+    end
+
+    INDICES.each do |index|
+      define_method("find_by_#{index}") do |query|
+        find_by(index.to_sym => query)
+      end
+      define_method("find_by_#{index}!") do |query|
+        find_by!(index.to_sym => query)
+      end
+    end
+
+    protected
+
+    def townships
+      unless @townships
+        indices = INDICES.inject({}) { |memo, index| memo.merge index => [] }
+        @townships = data.each_with_index.map do |township_row, i|
+          new(township_row).tap { |township| build_indices(indices, township, township_row[:district], i) }
+        end
+
+        INDICES.each do |index|
+          class_variable_set(:"@@#{index}_index", indices[index]) # rubocop:disable Style/ClassVars
+        end
+      end
+      @townships
+    end
+
+    def data
+      YAML.load_file(File.join(File.dirname(__FILE__), '..', 'data', 'townships.yml'))
+    end
+
+    def build_indices(indices, township, district_pcode, reference_index)
+      INDICES.each do |index|
+        indices[index] << township.send(index)
+      end
+      @district_index[district_pcode] ||= []
+      @district_index[district_pcode] << reference_index
+    end
+
+    ## define private methods for internal use of indexed array
+    INDICES.each do |index|
+      define_method("#{index}_index") do
+        townships
+        class_variable_get("@@#{index}_index")
+      end
+    end
+
+    ## return the index for query given to find_by/find_by! method
+    def get_key(data)
+      keys = data.keys
+      if keys.length != 1 || INDICES.none? { |key| key.to_sym == keys.first.to_sym }
+        raise ArgumentError, "`find_by` accepts only one of #{INDICES.join(' or ')} as argument. none provided"
+      end
+
+      keys.first
+    end
+  end
 end
-class Nayyar::TownshipNotFound < StandardError; end;
+
+class Nayyar::TownshipNotFound < StandardError; end

data/lib/nayyar/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nayyar
-  VERSION = "0.1.1"
+  VERSION = '0.1.2'
 end

data/lib/nayyar.rb

@@ -1,7 +1,11 @@
-require "nayyar/version"
-require "nayyar/state"
-require "nayyar/district"
-require "nayyar/township"
+# frozen_string_literal: true
 
+require 'yaml'
+require 'nayyar/version'
+require 'nayyar/state'
+require 'nayyar/district'
+require 'nayyar/township'
+
+# Top-level module for Nayyar.
 module Nayyar
-end
+end

data/nayyar.gemspec

@@ -1,39 +1,43 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'nayyar/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "nayyar"
+  spec.name          = 'nayyar'
   spec.version       = Nayyar::VERSION
-  spec.authors       = ["mmhan"]
-  spec.email         = ["mmhan2u@gmail.com"]
+  spec.authors       = ['mmhan']
+  spec.email         = ['mmhan2u@gmail.com']
+  spec.required_ruby_version = '>= 2.7.0'
 
-  spec.summary       = %q{Nayyar gives you access to State/Regions, Districts and Townships of Myanmar.}
-  spec.description   = %q{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.
+  spec.summary       = 'Nayyar gives you access to State/Regions, Districts and Townships of Myanmar.'
+  spec.description   = "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/)}
-  spec.homepage      = "https://github.com/mmhan/nayyar"
-  spec.license       = "MIT"
+Uses [Semantic Versioning](http://semver.org/)"
+  spec.homepage      = 'https://github.com/mmhan/nayyar'
+  spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
-  end
+  raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.' unless spec.respond_to?(:metadata)
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency 'rspec', '>= 3'
+  spec.add_development_dependency 'bundler', '>= 2.3.10'
   spec.add_development_dependency 'pry', '>= 0.10'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rspec', '>= 3'
+  spec.add_development_dependency 'rubocop', '~> 1.27.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.9.0'
 end

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: nayyar
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - mmhan
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2015-06-20 00:00:00.000000000 Z
+date: 2022-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: 2.3.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: 2.3.10
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -53,34 +67,51 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 1.27.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 1.27.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.0
 description: |-
-  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.
+  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/)
+  Uses [Semantic Versioning](http://semver.org/)
 email:
 - mmhan2u@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -105,7 +136,8 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,16 +145,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.3
-signing_key: 
+rubygems_version: 3.3.11
+signing_key:
 specification_version: 4
 summary: Nayyar gives you access to State/Regions, Districts and Townships of Myanmar.
 test_files: []