pumi 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 17f74d68e427a1e24638f6b243057647b4f4d6a73e99f91f16248ff974a41ae2
+  data.tar.gz: fb80152d500f3f83d36ff6c9b3a551269dea4d298127c5c293fe2876b0ceb64a
+SHA512:
+  metadata.gz: '038bb2cb0ec0c7308ce96bf4df841de3c1fb696b5a9bb90d944a098abf1b17928f9f7bc501624ed88069a0d194ae576ad06a3a7690c7442e5702b1ada81f28db'
+  data.tar.gz: e7a0cec8036bbccfc7c69c2f50aac41ccd3a8fa2c8f4576b4d16436941d9933789b89d0076db6751245c86cbac40709ac48deb0c19737e83732dd83235e2f9c1

data/.github/actions/fetch_data/Dockerfile

@@ -0,0 +1,8 @@
+FROM alpine:latest
+
+RUN apk update && apk upgrade && apk add --update --no-cache curl gnumeric font-noto-khmer ttf-opensans
+
+COPY entrypoint.sh /entrypoint.sh
+
+# Code file to execute when the docker container starts up (`entrypoint.sh`)
+ENTRYPOINT ["/entrypoint.sh"]

data/.github/actions/fetch_data/action.yml

@@ -0,0 +1,17 @@
+name: Fetch Data
+description: Fetches the latest data
+inputs:
+  num_provinces:
+    description: Number of provinces to fetch
+    required: true
+    default: 25
+  url:
+    description: URL to fetch the data
+    required: true
+    default: 'http://db.ncdd.gov.kh/gazetteer/province/downloadprovince.castle?pv=${province_code}'
+runs:
+  using: docker
+  image: Dockerfile
+  args:
+    - ${{ inputs.num_provinces }}
+    - ${{ inputs.url }}

data/.github/actions/fetch_data/entrypoint.sh

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+set -e
+set -o pipefail
+
+PLACEHOLDER='${province_code}'
+
+num_provinces=$1
+url=$2
+
+for province_code in `seq 1 $num_provinces`
+do
+  province_url=$(echo $url | sed -e s/$PLACEHOLDER/$province_code/g)
+  curl -s $province_url > "tmp/p$province_code.xls"
+  ssconvert "tmp/p$province_code.xls" "tmp/p$province_code.csv"
+done

data/.github/workflows/build.yml

@@ -0,0 +1,25 @@
+name: Build
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Install Dependencies
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+
+    - name: Run Specs
+      run: |
+        bundle exec rake

data/.github/workflows/bump_version.yml

@@ -0,0 +1,37 @@
+name: Create Release
+on:
+  push:
+    branches:
+      - release_new_gems
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Install Dependencies
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+
+    - name: Set up Git
+      run: |
+        git config --global user.email "dwilkie@gmail.com"
+        git config --global user.name "David Wilkie"
+
+    - name: Bump version and publish release
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        GEM_HOST_API_KEY: ${{ secrets.GEM_HOST_API_KEY }}
+      run: |
+        mkdir -p ~/.gem
+        echo -e "---\r\n:rubygems_api_key: $GEM_HOST_API_KEY" > ~/.gem/credentials
+        chmod 0600 ~/.gem/credentials
+        bundle exec bump patch --tag
+        git push --tags
+        bundle exec rake release

data/.github/workflows/update_data.yml

@@ -0,0 +1,38 @@
+name: Update Data
+
+on:
+  schedule:
+    - cron: '0 0 * * 0'
+
+jobs:
+  fetch_data:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Setup Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: '2.x'
+
+      - name: Fetch Data
+        uses: ./.github/actions/fetch_data
+
+      - name: Parse Data
+        run: ./bin/parse_data
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v1
+        with:
+          token: ${{ secrets.REPO_TOKEN }}
+          commit-message: "Update pumi data"
+          title: "Update pumi data"
+          labels: "update_data"
+          base: "master"
+
+      - name: Upload Data
+        uses: actions/upload-artifact@v1
+        with:
+          name: data_files
+          path: tmp

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+spec/dummy/tmp
+spec/dummy/log
+/tmp/*
+!/tmp/.keep
+vendor/ruby
+.DS_Store

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,22 @@
+require: rubocop-rspec
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 100
+
+Style/Documentation:
+  Enabled: false
+
+MultipleExpectations:
+  Enabled: false
+
+ExampleLength:
+  Max: 10
+
+RSpec/DescribedClass:
+  Enabled: false

data/.tool-versions

@@ -0,0 +1,2 @@
+ruby 2.6.5
+nodejs 10.16.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dwilkie@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 David Wilkie
+
+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,177 @@
+# Pumi
+
+![](https://github.com/dwilkie/pumi/workflows/Build/badge.svg)
+
+Pumi (ភូមិ pronounced Poom, which means Village in Khmer) is an Open Source library containing Geodata for administrative regions in Cambodia including Provinces, Districts, Communes and Villages.
+
+![Khmer Village](https://raw.githubusercontent.com/dwilkie/pumi/master/pumi.jpg)
+
+## Demo and API
+
+A [JSON API](https://pumiapp.herokuapp.com) is available to if you're not using Ruby or if you just don't want to install a local copy of the data. The [API Start Page](https://pumiapp.herokuapp.com) also shows a Demo of a UI for for entering any location in Cambodia.
+
+## Usage
+
+### Rails
+
+Using Pumi with Rails gives you some javascript helpers as well as an API to filter and select Provinces (ខេត្ត), Districts (ស្រុក / ខណ្ឌ), Communes (ឃុំ / សង្កាត់) and Villages (ភូមិ) in both latin and Khmer as seen below and in the [Pumi API Start Page](https://pumiapp.herokuapp.com)
+
+![Pumi UI Latin](https://raw.githubusercontent.com/dwilkie/pumi/master/pumi_ui_en.png)
+![Pumi UI Khmer](https://raw.githubusercontent.com/dwilkie/pumi/master/pumi_ui_km.png)
+
+To use Pumi with Rails first, require `"pumi/rails"` in your Gemfile:
+
+```ruby
+gem 'pumi', github: "dwilkie/pumi", require: "pumi/rails"
+```
+
+Next, mount the Pumi routes in `config/routes`
+
+```ruby
+# config/routes.rb
+
+mount Pumi::Engine => "/pumi"
+```
+
+Then require the pumi javascript in `app/assets/javascripts/application.js`
+
+```js
+//= require jquery
+//= require pumi
+```
+
+Note: `jquery` is a dependency of pumi and must be required before `pumi`
+
+Finally setup your view with selects for the province, district, commune and village. See the [dummy application](https://github.com/dwilkie/pumi/blob/master/spec/dummy/app/views/addresses/new.html.erb) for an example and refer to the [configuration](#configuration) below.
+
+### Plain Ol' Ruby
+
+Rails is not a dependency of Pumi so you can use it with Plain Ol' Ruby if you don't need the javascript and route helpers.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pumi', :github => "dwilkie/pumi"
+```
+
+And then execute:
+
+    $ bundle
+
+```ruby
+  require 'pumi'
+
+  # Working with Provinces (ខេត្ត)
+
+  # Get all provinces
+  Pumi::Province.all
+
+  # Find a province by id
+  Pumi::Province.find_by_id("12")
+
+  # Find a province by its latin name
+  Pumi::Province.where(name_latin: "Phnom Penh")
+
+  # Find a province by its Khmer name
+  Pumi::Province.where(name_km: "បន្ទាយមានជ័យ")
+
+  # Working with Districts (ស្រុក / ខណ្ឌ)
+
+  # Get all districts
+  Pumi::District.all
+
+  # Get all districts by province_id
+  Pumi::District.where(province_id: "12")
+
+  # Find district by its Khmer name and Province ID
+  district = Pumi::District.where(province_id: "12", name_km: "ចំការមន").first
+
+  # Return the district's province name in latin
+  district.province.name_latin
+  # => Phnom Penh
+
+  # Working with Communes (ឃុំ / សង្កាត់)
+
+  # Get all communes by district_id
+  Pumi::Commune.where(district_id: "1201")
+
+  # Find a commune by its latin name and District ID
+  commune = Pumi::Commune.where(district_id: "1201", name_latin: "Tonle Basak").first
+
+  # Return the commune's district name in Khmer
+  commune.district.name_km
+  # => "ចំការមន"
+
+  # Return the commune's province name in Khmer
+  commune.province.name_km
+  # => "ភ្នំពេញ"
+
+  # Working with Villages (ភូមិ)
+
+  # Get all villages by commune_id
+  Pumi::Village.where(commune_id: "010201")
+
+  # Find a village by it's Khmer name and Commune ID
+  village = Pumi::Village.where(commune_id: "010201", name_km: "អូរធំ").first
+
+  # Return the village's commune name in latin
+  village.commune.name_latin
+  # => "Banteay Neang"
+
+  # Return the village's district name in Khmer
+  village.district.name_km
+  => "មង្គលបូរី"
+
+  # Return the village's province name in Khmer
+  village.province.name_km
+  # => "បន្ទាយមានជ័យ"
+
+  # Get the villages address in Latin
+  village.address_latin
+  # => "Phum Ou Thum, Khum Banteay Neang, Srok Mongkol Borei, Khaet Banteay Meanchey"
+
+  # In English
+  village.address_en
+  # => "Ou Thum Village, Banteay Neang Commune, Mongkol Borei District, Banteay Meanchey Province"
+
+  # In Khmer
+  village.address_en
+  # => "ភូមិអូរធំ ឃុំបន្ទាយនាង ស្រុកមង្គលបូរី ខេត្តបន្ទាយមានជ័យ"
+```
+
+## Configuration
+
+The following html5 data-attributes can be used to configure Pumi.
+
+<dl>
+  <dt><code>data-pumi-select-id</code></dt>
+  <dd>A unique id of the select input which is looked up by <code>data-pumi-select-target</code></dd>
+  <dt><code>data-pumi-select-target</code></dt>
+  <dd>The <code>data-pumi-select-id</code> of the select input in which to update the options when this input is changed</dd>
+  <dt><code>data-pumi-select-collection-url</code></dt>
+  <dd>The url in which to lookup the values for this select input. If this option is not given then no ajax request will be made. Hint: You can use the Rails url helpers here e.g. <code>pumi.districts_path(:province_id => "FILTER")</code></dd>
+  <dt><code>data-pumi-select-collection-url-filter-interpolation-key</code></dt>
+  <dd>The key value to interpolate for filtering via the collection url. E.g. if you set <code>data-pumi-select-collection-url="/pumi/districts?province_id=FILTER"</code>, then a value of <code>"FILTER"</code> here will replace the collection URL with the value of the select input which this select input is the target of</dd>
+  <dt><code>data-pumi-select-collection-label-method</code></dt>
+  <dd>The name of the label method. E.g. <code>data-pumi-select-collection-label-method="name_en"</code> will display the labels in Latin or <code>data-pumi-select-collection-label-method="name_km"</code> will display the labels in Khmer</dd>
+  <dt><code>data-pumi-select-collection-value-method</code></dt>
+  <dd>The name of the value method. E.g. <code>data-pumi-select-collection-value-method="id"</code> will set the value of the select input to the Pumi of the location</dd>
+  <dt><code>data-pumi-select-disabled-target</code></dt>
+  <dd>The target of a parent selector in which to apply the class <code>data-pumi-select-disabled-class</code> to when the input is disabled</dd>
+  <dt><code>data-pumi-select-disabled-class</code></dt>
+  <dd>When the input is disabled this class will be applied to <code>data-pumi-select-disabled-target</code></dd>
+  <dt><code>data-pumi-select-populate-on-load</code></dt>
+  <dd>Set to true to populate the select input with options on load. Default: false</dd>
+  <dt><code>data-pumi-select-has-hidden-value</code></dt>
+  <dd>Set to true if you also have a hidden field for this input with the same name. Useful for remembering the selection across page reloads. Default: false</dd>
+</dl>
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dwilkie/pumi.

data/Rakefile

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

data/app/assets/javascripts/pumi.js.coffee

@@ -0,0 +1,97 @@
+$(document).ready ->
+  pumi.setup()
+
+pumi =
+  dataAttributeTag: (attribute, selector) ->
+    tag = "pumi-select-#{attribute}"
+    tag = if !!selector then "[data-#{tag}]" else tag
+
+  setDataAttribute: (element, attribute, value) ->
+    element.data(pumi.dataAttributeTag(attribute), value)
+
+  getDataAttribute: (element, attribute, value) ->
+    element.data(pumi.dataAttributeTag(attribute))
+
+  removeDataAttribute: (element, attribute) ->
+    element.removeData(pumi.dataAttributeTag(attribute))
+
+  toggleEnableSelect: (select, enable) ->
+    wrapperTarget = select.closest(pumi.getDataAttribute(select, 'disabled-target'))
+    disabledClass = pumi.getDataAttribute(select, 'disabled-class')
+
+    if !!enable
+      wrapperTarget.removeClass(disabledClass)
+      select.removeAttr("disabled")
+    else
+      wrapperTarget.addClass(disabledClass)
+      select.attr("disabled", "disabled")
+
+  selectPopulateOnLoad: ->
+    $(pumi.dataAttributeTag('populate-on-load', true))
+
+  selectTargets: ->
+    $(pumi.dataAttributeTag('id', true))
+
+  selectHasTarget: ->
+    $(pumi.dataAttributeTag('target', true))
+
+  selectTarget: (id) ->
+    $(pumi.dataAttributeTag("id=#{id}", true))
+
+  selectHasHiddenValue: =>
+    $(pumi.dataAttributeTag('has-hidden-value', true))
+
+  setupOnLoad: ->
+    pumi.selectPopulateOnLoad().each ->
+      pumi.populateFromAjax($(this))
+
+    pumi.selectHasHiddenValue().each ->
+      select = $(this)
+      pumi.setDataAttribute(select, 'default-value', $($.find("[name='#{select.attr('name')}']")).val())
+
+  populateFromAjax: (select, filterValue) ->
+    collectionUrl = pumi.getDataAttribute(select, 'collection-url')
+    if !!collectionUrl
+      filterInterpolationKey = pumi.getDataAttribute(select, 'collection-url-filter-interpolation-key')
+      labelMethod = pumi.getDataAttribute(select, 'collection-label-method')
+      valueMethod = pumi.getDataAttribute(select, 'collection-value-method')
+      $.getJSON collectionUrl.replace(filterInterpolationKey, filterValue), (data) ->
+        $.each data, (index, item) ->
+          select.append($('<option>').text(item[labelMethod]).val(item[valueMethod]))
+        defaultValue = pumi.getDataAttribute(select, 'default-value')
+        if !!defaultValue
+          select.val(defaultValue)
+          pumi.removeDataAttribute(select, 'default-value')
+          select.trigger("change")
+
+  setupTargets: (selects) ->
+    selects.each ->
+      select = $(this)
+      options = []
+      select.find('option').each ->
+        options.push
+          value: @value
+          text: @text
+
+      pumi.setDataAttribute(select, 'options', options)
+      pumi.toggleEnableSelect(select, false)
+
+  filterSelectByValue: (select, filterValue) ->
+    staticPumiOptions = pumi.getDataAttribute(select, 'options')
+    select.empty()
+
+    pumi.toggleEnableSelect(select, !!filterValue)
+    select.trigger("change")
+
+    $.each staticPumiOptions, (i) ->
+      pumiOption = staticPumiOptions[i]
+      select.append($('<option>').text(pumiOption.text).val(pumiOption.value)) if !pumiOption.value || pumiOption.value.match(///^#{filterValue}///)
+
+    pumi.populateFromAjax(select, filterValue) if !!filterValue
+
+  setup: ->
+    pumi.setupOnLoad()
+    pumi.setupTargets(pumi.selectTargets())
+
+    pumi.selectHasTarget().change ->
+      pumi.filterSelectByValue(pumi.selectTarget(pumi.getDataAttribute($(this), 'target')), @value)

data/app/controllers/pumi/communes_controller.rb

@@ -0,0 +1,7 @@
+module Pumi
+  class CommunesController < ActionController::Base
+    def index
+      render(json: ResponseSerializer.new(Commune.where(request.query_parameters)))
+    end
+  end
+end

data/app/controllers/pumi/districts_controller.rb

@@ -0,0 +1,7 @@
+module Pumi
+  class DistrictsController < ActionController::Base
+    def index
+      render(json: ResponseSerializer.new(District.where(request.query_parameters)))
+    end
+  end
+end

data/app/controllers/pumi/provinces_controller.rb

@@ -0,0 +1,7 @@
+module Pumi
+  class ProvincesController < ActionController::Base
+    def index
+      render(json: ResponseSerializer.new(Province.where(request.query_parameters)))
+    end
+  end
+end

data/app/controllers/pumi/villages_controller.rb

@@ -0,0 +1,7 @@
+module Pumi
+  class VillagesController < ActionController::Base
+    def index
+      render(json: ResponseSerializer.new(Village.where(request.query_parameters)))
+    end
+  end
+end

data/app/serializers/pumi/response_serializer.rb

@@ -0,0 +1,15 @@
+module Pumi
+  class ResponseSerializer
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def as_json(*)
+      data.map do |location|
+        location.attributes.except(:province, :district, :commune, :village)
+      end
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pumi"
+
+# 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(__FILE__)