nayyar 0.1.0

data/lib/nayyar.rb

@@ -0,0 +1,7 @@
+require "nayyar/version"
+require "nayyar/state"
+require "nayyar/district"
+require "nayyar/township"
+
+module Nayyar
+end

data/lib/nayyar/district.rb

@@ -0,0 +1,122 @@
+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
+end
+class Nayyar::DistrictNotFound < StandardError; end;

data/lib/nayyar/state.rb

@@ -0,0 +1,107 @@
+class Nayyar::State
+	attr_reader :data
+
+  @@states = nil
+  @@pcode_index = []
+  @@iso_index = []
+  @@alpha3_index = []
+
+	attributes = [
+		:pcode,
+		:iso,
+		:alpha3,
+		: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)
+		@data[key]
+	end
+
+  def districts
+  	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
+end
+class Nayyar::StateNotFound < StandardError; end;

data/lib/nayyar/township.rb

@@ -0,0 +1,119 @@
+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
+end
+class Nayyar::TownshipNotFound < StandardError; end;

data/lib/nayyar/version.rb

@@ -0,0 +1,3 @@
+module Nayyar
+  VERSION = "0.1.0"
+end

data/nayyar.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nayyar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nayyar"
+  spec.version       = Nayyar::VERSION
+  spec.authors       = ["mmhan"]
+  spec.email         = ["mmhan2u@gmail.com"]
+
+  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.
+
+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"
+
+  # 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
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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 'pry', '>= 0.10'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: nayyar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mmhan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-20 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !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'
+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/)
+email:
+- mmhan2u@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/data/.gitkeep
+- lib/data/districts.yml
+- lib/data/extract.rb
+- lib/data/locations.csv
+- lib/data/states.yml
+- lib/data/townships.yml
+- lib/nayyar.rb
+- lib/nayyar/district.rb
+- lib/nayyar/state.rb
+- lib/nayyar/township.rb
+- lib/nayyar/version.rb
+- nayyar.gemspec
+homepage: https://github.com/mmhan/nayyar
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: 
+specification_version: 4
+summary: Nayyar gives you access to State/Regions, Districts and Townships of Myanmar.
+test_files: []