pumi 0.1.1

data/lib/pumi/administrative_unit.rb

@@ -0,0 +1,3 @@
+module Pumi
+  AdministrativeUnit = Struct.new(:name_km, :name_latin, :name_en, keyword_init: true)
+end

data/lib/pumi/commune.rb

@@ -0,0 +1,3 @@
+module Pumi
+  class Commune < Location; end
+end

data/lib/pumi/data_store.rb

@@ -0,0 +1,7 @@
+module Pumi
+  class DataStore
+    def load(type, *args)
+      Parser.new(type, *args).load
+    end
+  end
+end

data/lib/pumi/district.rb

@@ -0,0 +1,3 @@
+module Pumi
+  class District < Location; end
+end

data/lib/pumi/location.rb

@@ -0,0 +1,42 @@
+module Pumi
+  Location = Struct.new(
+    :id, :province_id, :district_id, :commune_id, :village_id,
+    :province, :district, :commune,
+    :name_km, :full_name_km,
+    :name_latin, :full_name_latin,
+    :name_en, :full_name_en,
+    :address_km, :address_latin, :address_en,
+    :administrative_unit, keyword_init: true
+  ) do
+    class << self
+      attr_accessor :data_store_key
+
+      def all
+        data.values
+      end
+
+      def find_by_id(id)
+        data[id]
+      end
+
+      def where(params)
+        data.values.select do |location|
+          (params.transform_keys(&:to_s).to_a - location.attributes.transform_keys(&:to_s).to_a).empty?
+        end
+      end
+
+      private
+
+      def data
+        Pumi.data_store.load(self)
+      end
+    end
+
+    attr_accessor :attributes
+
+    def initialize(attributes)
+      @attributes = attributes
+      super
+    end
+  end
+end

data/lib/pumi/parser.rb

@@ -0,0 +1,135 @@
+require "yaml"
+require "pathname"
+
+module Pumi
+  class Parser
+    DATA_DIRECTORY = Pathname.new(File.expand_path("..", File.dirname(__dir__))).join("data")
+
+    AdministrativeDivision = Struct.new(:type, :name, :data_key, :id_length, :parent_divisions, keyword_init: true)
+    PROVINCE = AdministrativeDivision.new(
+      type: Province,
+      name: :province,
+      data_key: :provinces,
+      id_length: 2
+    )
+    DISTRICT = AdministrativeDivision.new(
+      type: District,
+      name: :district,
+      data_key: :districts,
+      id_length: 4,
+      parent_divisions: [PROVINCE]
+    )
+    COMMUNE = AdministrativeDivision.new(
+      type: Commune,
+      name: :commune,
+      data_key: :communes,
+      id_length: 6,
+      parent_divisions: [DISTRICT, PROVINCE]
+    )
+    VILLAGE = AdministrativeDivision.new(
+      type: Village,
+      name: :village,
+      data_key: :villages,
+      id_length: 8,
+      parent_divisions: [COMMUNE, DISTRICT, PROVINCE]
+    )
+
+    ADMINISTRATIVE_DIVISIONS = {
+      Province => PROVINCE,
+      District => DISTRICT,
+      Commune => COMMUNE,
+      Village => VILLAGE
+    }.freeze
+
+    AddressType = Struct.new(:locale, :default_delimiter, keyword_init: true)
+    ADDRESS_TYPES = [
+      AddressType.new(locale: :km, default_delimiter: " "),
+      AddressType.new(locale: :latin, default_delimiter: ", "),
+      AddressType.new(locale: :en, default_delimiter: ", ")
+    ].freeze
+
+    attr_reader :type, :administrative_division
+
+    def initialize(type)
+      @type = type
+      @administrative_division = ADMINISTRATIVE_DIVISIONS.fetch(type)
+    end
+
+    def load
+      data = YAML.load_file(
+        DATA_DIRECTORY.join("#{administrative_division.data_key}.yml")
+      ).fetch(administrative_division.data_key.to_s)
+
+      data.each_with_object({}) do |(id, attributes), result|
+        location_data = build_location_data(id, attributes)
+        add_parent_divisions(location_data)
+        add_addresses(location_data)
+
+        result[id] = type.new(location_data)
+      end
+    end
+
+    private
+
+    def build_location_data(id, attributes)
+      name = attributes.fetch("name")
+      name_km = name.fetch("km")
+      name_latin = name.fetch("latin")
+      administrative_unit = build_administrative_unit(
+        attributes.fetch("administrative_unit")
+      )
+
+      {
+        id: id,
+        administrative_unit: administrative_unit,
+        name_km: name_km,
+        name_latin: name_latin,
+        name_en: name_latin,
+        full_name_km: [
+          administrative_unit_name(name_km, administrative_unit.name_km),
+          name_km
+        ].compact.join,
+        full_name_latin: [
+          administrative_unit_name(name_latin, administrative_unit.name_latin),
+          name_latin
+        ].compact.join(" "),
+        full_name_en: [name_latin, administrative_unit.name_en].join(" ")
+      }
+    end
+
+    def add_parent_divisions(attributes)
+      Array(administrative_division.parent_divisions).each do |parent|
+        parent_id = attributes.fetch(:id).chars.first(parent.id_length).join
+        attributes[:"#{parent.name}_id"] = parent_id
+        attributes[parent.name] = parent.type.find_by_id(parent_id)
+      end
+    end
+
+    def add_addresses(attributes)
+      ADDRESS_TYPES.each do |address_type|
+        address_part_key = :"full_name_#{address_type.locale}"
+        division_address = attributes.fetch(address_part_key)
+        parent_addresses = Array(administrative_division.parent_divisions).map do |parent|
+          attributes.fetch(parent.name).attributes.fetch(address_part_key)
+        end
+
+        attributes[:"address_#{address_type.locale}"] = [
+          division_address,
+          parent_addresses
+        ].reject(&:empty?).compact.join(address_type.default_delimiter)
+      end
+    end
+
+    def build_administrative_unit(attributes)
+      AdministrativeUnit.new(
+        name_km: attributes.fetch("km"),
+        name_latin: attributes.fetch("latin"),
+        name_en: attributes.fetch("en")
+      )
+    end
+
+    def administrative_unit_name(name, administrative_unit_name)
+      administrative_unit_name unless name.start_with?(administrative_unit_name)
+    end
+  end
+end

data/lib/pumi/province.rb

@@ -0,0 +1,3 @@
+module Pumi
+  class Province < Location; end
+end

data/lib/pumi/rails/engine.rb

@@ -0,0 +1,6 @@
+module Pumi
+  class Engine < ::Rails::Engine
+    require "jquery-rails"
+    isolate_namespace(Pumi)
+  end
+end

data/lib/pumi/rails.rb

@@ -0,0 +1,2 @@
+require_relative "../pumi"
+require_relative "rails/engine"

data/lib/pumi/store_cache.rb

@@ -0,0 +1,17 @@
+module Pumi
+  class StoreCache < SimpleDelegator
+    attr_reader :cached
+
+    def initialize(data_store)
+      super(data_store)
+
+      @cached = {}
+    end
+
+    def load(type, *args)
+      cached.fetch(type) do
+        cached[type] = super
+      end
+    end
+  end
+end

data/lib/pumi/version.rb

@@ -0,0 +1,3 @@
+module Pumi
+  VERSION = "0.1.1".freeze
+end

data/lib/pumi/village.rb

@@ -0,0 +1,3 @@
+module Pumi
+  class Village < Location; end
+end

data/lib/pumi.rb

@@ -0,0 +1,25 @@
+require_relative "pumi/store_cache"
+require_relative "pumi/data_store"
+
+module Pumi
+  class << self
+    def data_store
+      @data_store ||= reset_data_store!
+    end
+
+    private
+
+    def reset_data_store!
+      @data_store = StoreCache.new(DataStore.new)
+    end
+  end
+end
+
+require_relative "pumi/version"
+require_relative "pumi/administrative_unit"
+require_relative "pumi/location"
+require_relative "pumi/province"
+require_relative "pumi/district"
+require_relative "pumi/commune"
+require_relative "pumi/village"
+require_relative "pumi/parser"

data/pumi.gemspec

@@ -0,0 +1,40 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pumi/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pumi"
+  spec.version       = Pumi::VERSION
+  spec.authors       = ["David Wilkie"]
+  spec.email         = ["dwilkie@gmail.com"]
+  spec.summary       = "Villages (ភូមិ), Communes (ឃុំ - សង្កាត់), Districts (ស្រុក - ខណ្ឌ) and Provinces (ខេត្ត) in Cambodia"
+  spec.homepage      = "https://github.com/dwilkie/pumi"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bump"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "capybara"
+  spec.add_development_dependency "coffee-rails"
+  spec.add_development_dependency "jquery-rails"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "puma"
+  spec.add_development_dependency "rails", ">= 5.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-rails", "~> 3.0"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "selenium-webdriver"
+  spec.add_development_dependency "webdrivers"
+end

metadata

@@ -0,0 +1,302 @@
+--- !ruby/object:Gem::Specification
+name: pumi
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- David Wilkie
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webdrivers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- dwilkie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/actions/fetch_data/Dockerfile"
+- ".github/actions/fetch_data/action.yml"
+- ".github/actions/fetch_data/entrypoint.sh"
+- ".github/workflows/build.yml"
+- ".github/workflows/bump_version.yml"
+- ".github/workflows/update_data.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".tool-versions"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/pumi.js.coffee
+- app/controllers/pumi/communes_controller.rb
+- app/controllers/pumi/districts_controller.rb
+- app/controllers/pumi/provinces_controller.rb
+- app/controllers/pumi/villages_controller.rb
+- app/serializers/pumi/response_serializer.rb
+- bin/console
+- bin/parse_data
+- bin/setup
+- config/routes.rb
+- data/communes.yml
+- data/districts.yml
+- data/provinces.yml
+- data/villages.yml
+- lib/pumi.rb
+- lib/pumi/administrative_unit.rb
+- lib/pumi/commune.rb
+- lib/pumi/data_store.rb
+- lib/pumi/district.rb
+- lib/pumi/location.rb
+- lib/pumi/parser.rb
+- lib/pumi/province.rb
+- lib/pumi/rails.rb
+- lib/pumi/rails/engine.rb
+- lib/pumi/store_cache.rb
+- lib/pumi/version.rb
+- lib/pumi/village.rb
+- pumi.gemspec
+- pumi.jpg
+- pumi_ui_en.png
+- pumi_ui_km.png
+- tmp/.keep
+homepage: https://github.com/dwilkie/pumi
+licenses: []
+metadata:
+  homepage_uri: https://github.com/dwilkie/pumi
+  source_code_uri: https://github.com/dwilkie/pumi
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Villages (ភូមិ), Communes (ឃុំ - សង្កាត់), Districts (ស្រុក - ខណ្ឌ) and Provinces
+  (ខេត្ត) in Cambodia
+test_files: []