phil_locator 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2afacfcf46e8fb8e86447b0070dc11040997719d295208ecea39728837e49f67
-  data.tar.gz: 345d4046c2963b6147d24f931799196fd811139eeb08f10183204e948b8833c6
+  metadata.gz: 8c30061908794e2bb4cc7d73036f509ca97aa87f1a3ab1e869ef8e7d346ba3c8
+  data.tar.gz: d981ed1ec4118c495543e73130ff24088e3050e4dd5df7232980b7e26e753563
 SHA512:
-  metadata.gz: 7b5bb5b14e94e486c0b1b0e494a066c91ff19fb761a7c6d3163a24c5bc5f707f03666391e82861a39b55236ed42a6e04dca8110a7c84cc88b7724ea7402b7abe
-  data.tar.gz: f60bc55905e3b1fcc0ab0f75fc2185854df363c061129daeb7297c2580d013fea53f2ff65fb9978612a25629f43d3956352e38635b3c0f8039448adc77bddf5b
+  metadata.gz: ef3047b18073a0416bb2da98dbd2c5281e9548dd6e82360bd09211b021decb245d0dc127c907959082a77778f96d4d12a70071a2bea7bf919a25324bc71f72a0
+  data.tar.gz: 72aef4cda826b411a716b7d1df41abb512d12b5cf4f8229a6175c711f1309e3ad4c55310de121a82db7f0dfad21a6db5c4c6c0ae6f633c740576b8ababa719ae

data/.github/workflows/rubocop.yml

@@ -0,0 +1,27 @@
+name: RuboCop
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.7
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - name: Cache gems
+      uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-rubocop-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-rubocop-
+    - name: Install gems
+      run: |
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+    - name: Run RuboCop
+      run: bundle exec rubocop --parallel

data/.github/workflows/update-copyright-years-in-license-file.yml

@@ -0,0 +1,10 @@
+name: Update copyright year(s) in license file
+
+on:
+  schedule:
+    - cron: "0 0 1 * *"
+  workflow_dispatch:
+
+jobs:
+  update_license:
+    uses: tenshiAMD/.github/.github/workflows/update-copyright-years-in-license-file.yml@master

data/.gitignore

@@ -4,4 +4,3 @@
 .rubocop-*
 
 *.gem
-Gemfile.lock

data/.rubocop.yml

@@ -1,7 +1,3 @@
-require:
-  - rubocop-performance
-  - rubocop-rails
-
 inherit_from:
   - 'https://raw.githubusercontent.com/rails/rails/master/.rubocop.yml'
 

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+## [Unreleased](https://github.com/tenshiAMD/phil_locator/tree/HEAD)
+
+[Full Changelog](https://github.com/tenshiAMD/phil_locator/compare/v1.3.0...HEAD)
+
+## [v1.3.0](https://github.com/tenshiAMD/phil_locator/tree/v1.3.0) (2023-11-10)
+
+- Implement `island_groups`, `municipalities`, `districts` (Metro Manila Only), `sub_municipalities` (Metro Manila Only)
+- Improve and fix model associations
+- Set ruby version to `2.7`
+- Fix `rubocop` issues
+
+[Full Changelog](https://github.com/tenshiAMD/phil_locator/compare/v1.2.1...v1.3.0)
+
+## [v1.2.1](https://github.com/tenshiAMD/phil_locator/tree/v1.2.1) (2020-03-11)
+
+- Fix `code` for `Region 5` in data
+
+[Full Changelog](https://github.com/tenshiAMD/phil_locator/compare/v1.2.0...v1.2.1)
+
+## [v1.2.0](https://github.com/tenshiAMD/phil_locator/tree/v1.2.0) (2019-10-21)
+
+- Implement `data_root_path` configuration
+- Implement configuration via `configure` block
+
+[Full Changelog](https://github.com/tenshiAMD/phil_locator/compare/v1.1.0...v1.2.0)
+
+## [v1.1.0](https://github.com/tenshiAMD/phil_locator/tree/v1.1.0) (2019-10-18)
+
+- Update relations for `regions`, `cities`, and `provinces`
+- Implement `barangays`
+
+[Full Changelog](https://github.com/tenshiAMD/phil_locator/compare/v1.0.0.pre...v1.1.0)
+
+## [v1.0.0.pre](https://github.com/tenshiAMD/phil_locator/tree/v1.0.0.pre) (2019-10-17)
+
+- Initial release
+
+[Full Changelog](https://github.com/tenshiAMD/phil_locator/compare/71934c50b3182f605cd06d0ce539a265f50c4886...v1.0.0.pre)
+

data/Gemfile

@@ -8,8 +8,10 @@ end
 gemspec
 
 group :development, :test do
-  gem "rubocop", ">= 0.74.0", require: false
-  gem "rubocop-junit-formatter"
+  gem "rubocop", ">= 1.25.1", require: false
+  gem "rubocop-minitest", require: false
+  gem "rubocop-packaging", require: false
   gem "rubocop-performance", require: false
-  gem "rubocop-rails", "~> 2.0.1", require: false
+  gem "rubocop-rails", require: false
+  gem "rubocop-md", require: false
 end

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    phil_locator (1.3.0)
+      active_hash (~> 2.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    active_hash (2.3.0)
+      activesupport (>= 5.0.0)
+    activesupport (7.1.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.1.1)
+    bigdecimal (3.1.4)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    drb (2.1.1)
+      ruby2_keywords
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    minitest (5.20.0)
+    mutex_m (0.1.2)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rack (3.0.8)
+    rainbow (3.1.1)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    rubocop (1.57.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-md (1.2.1)
+      rubocop (>= 1.0)
+    rubocop-minitest (0.33.0)
+      rubocop (>= 1.39, < 2.0)
+    rubocop-packaging (0.5.2)
+      rubocop (>= 1.33, < 2.0)
+    rubocop-performance (1.19.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.22.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  phil_locator!
+  rubocop (>= 1.25.1)
+  rubocop-md
+  rubocop-minitest
+  rubocop-packaging
+  rubocop-performance
+  rubocop-rails
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Angel Aviel Domaoan
+Copyright (c) 2019-2023 Angel Aviel Domaoan
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,24 +1,31 @@
 # Phil Locator
 
 [![Gem Version](https://badge.fury.io/rb/phil_locator.svg)](https://badge.fury.io/rb/phil_locator)
-
-## Build Status
-[![Maintainability](https://api.codeclimate.com/v1/badges/9cc2694e0d4b21080edc/maintainability)](https://codeclimate.com/github/tenshiAMD/phil_locator/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/9cc2694e0d4b21080edc/test_coverage)](https://codeclimate.com/github/tenshiAMD/phil_locator/test_coverage)
+[![Known Vulnerabilities](https://snyk.io/test/github/tenshiAMD/phil_locator/badge.svg?targetFile=Gemfile.lock)](https://snyk.io/test/github/tenshiAMD/phil_locator?targetFile=Gemfile.lock)
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FtenshiAMD%2Fphil_locator.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2FtenshiAMD%2Fphil_locator?ref=badge_shield&issueType=license)
 
 ## Description
-Provides registry records for `regions`, `cities`, `provinces`, and `barangays` in the Philippines.
+Provides registry records in the Philippines which the data came from PSA (PSGC).
+
+- `regions`
+- `cities` 
+- `provinces`
+- `barangays`
+- `island_group`
+- `municipality`
+- `districts` (Metro Manila Only)
+- `sub_municipality` (Metro Manila Only)
 
 ## Installation
 
 In Gemfile:
 ```
-gem "phil_locator", "~> 1.2.0"
+gem "phil_locator", "~> 1.3.0"
 ```
 
 Or, from the command line:
 ```
-gem install phil_locator -v "~> 1.2.0"
+gem install phil_locator -v "~> 1.3.0"
 ```
     
 ## Usage
@@ -44,10 +51,14 @@ Create an initializer `phil_locator.rb` to configure the options, here's a sampl
 ```
 PhilLocator.configure do |config|
     # This overrides the default data directory
-    config.data_root_path = Rails.root.join("data").to_s
+    config.data_root_path = Rails.root.join("datasets").to_s
 end
 ```
 
 ## Copyright
 
-Copyright (c) 2019 Angel Aviel Domaoan, released under the [MIT license](/LICENSE).
+This project is released under the [MIT license](/LICENSE).
+
+
+## License
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FtenshiAMD%2Fphil_locator.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FtenshiAMD%2Fphil_locator?ref=badge_large)

data/VERSION

@@ -1 +1 @@
-1.2.1
+1.3.0

data/app/models/phil_locator/barangay.rb

@@ -2,29 +2,35 @@ module PhilLocator
   class Barangay < ActiveYaml::Base
     include ActiveHash::Associations
 
-    set_root_path self.module_parent.data_root_path
+    set_root_path module_parent.data_root_path(:yaml)
     set_filename "barangays"
 
-    belongs_to :city, class_name: "PhilLocator::City", foreign_key: :city_code, primary_key: :code
+    belongs_to :province, class_name: "PhilLocator::Province",
+                          foreign_key: :province_code, primary_key: :province_code
+    delegate :region, to: :province
 
-    def cities
-      PhilLocator::City.where(region_code: code.to_i.to_s)
-    end
+    has_many :barangays, class_name: "PhilLocator::Barangay",
+                         foreign_key: :province_code, primary_key: :province_code
 
-    def province
-      return if city.blank?
+    alias_attribute :psgcCode, :code
 
-      city.province
+    def type
+      self[:urbanRural].upcase == "U" ? "urban" : "rural"
     end
 
-    def psgcCode
-      code.ljust(9, "0")
+    def method_missing(method_name, *args, &block)
+      case method_name.to_sym
+      when :city
+        PhilLocator::City.find_by(city_code: urbanRuralCode)
+      when :municipality
+        PhilLocator::Municipality.find_by(municipality_code: urbanRuralCode)
+      else
+        super
+      end
     end
 
-    def region
-      return if province.blank?
-
-      province.region
+    def respond_to_missing?(_method_name, _include_private = false)
+      true
     end
   end
 end

data/app/models/phil_locator/city.rb

@@ -2,19 +2,13 @@ module PhilLocator
   class City < ActiveYaml::Base
     include ActiveHash::Associations
 
-    set_root_path self.module_parent.data_root_path
+    set_root_path module_parent.data_root_path(:yaml)
     set_filename "cities"
 
-    belongs_to :province, class_name: "PhilLocator::Province", foreign_key: :province_code, primary_key: :code
+    belongs_to :province, class_name: "PhilLocator::Province",
+                          foreign_key: :province_code, primary_key: :province_code
+    delegate :region, to: :province
 
-    def psgcCode
-      code.ljust(9, "0")
-    end
-
-    def region
-      return if province.blank?
-
-      province.region
-    end
+    alias_attribute :psgcCode, :code
   end
 end

data/app/models/phil_locator/district.rb

@@ -0,0 +1,13 @@
+module PhilLocator
+  class District < ActiveYaml::Base
+    include ActiveHash::Associations
+
+    set_root_path module_parent.data_root_path(:yaml)
+    set_filename "districts"
+
+    has_many :sub_municipalities, class_name: "PhilLocator::SubMunicipality",
+                                  foreign_key: :district_code, primary_key: :district_code
+
+    alias_attribute :psgcCode, :code
+  end
+end

data/app/models/phil_locator/island_group.rb

@@ -0,0 +1,8 @@
+module PhilLocator
+  class IslandGroup < ActiveYaml::Base
+    include ActiveHash::Associations
+
+    set_root_path module_parent.data_root_path(:yaml)
+    set_filename "island_groups"
+  end
+end

data/app/models/phil_locator/municipality.rb

@@ -0,0 +1,13 @@
+module PhilLocator
+  class Municipality < ActiveYaml::Base
+    include ActiveHash::Associations
+
+    set_root_path module_parent.data_root_path(:yaml)
+    set_filename "municipalities"
+
+    belongs_to :province, class_name: "PhilLocator::Province", foreign_key: :province_code, primary_key: :province_code
+    delegate :region, to: :province
+
+    alias_attribute :psgcCode, :code
+  end
+end

data/app/models/phil_locator/province.rb

@@ -2,15 +2,18 @@ module PhilLocator
   class Province < ActiveYaml::Base
     include ActiveHash::Associations
 
-    set_root_path self.module_parent.data_root_path
+    set_root_path module_parent.data_root_path(:yaml)
     set_filename "provinces"
 
-    belongs_to :region, class_name: "PhilLocator::Region", foreign_key: :region_code, primary_key: :code
+    belongs_to :region, class_name: "PhilLocator::Region",
+                        foreign_key: :region_code, primary_key: :region_code
 
-    has_many :cities, class_name: "PhilLocator::City", foreign_key: :province_code, primary_key: :code
+    has_many :cities, class_name: "PhilLocator::City",
+                      foreign_key: :province_code, primary_key: :province_code
 
-    def psgcCode
-      code.ljust(9, "0")
-    end
+    has_many :barangays, class_name: "PhilLocator::Barangay",
+                         foreign_key: :province_code, primary_key: :province_code
+
+    alias_attribute :psgcCode, :code
   end
 end

data/app/models/phil_locator/region.rb

@@ -2,17 +2,27 @@ module PhilLocator
   class Region < ActiveYaml::Base
     include ActiveHash::Associations
 
-    set_root_path self.module_parent.data_root_path
+    set_root_path module_parent.data_root_path(:yaml)
     set_filename "regions"
 
-    has_many :provinces, class_name: "PhilLocator::Province", foreign_key: :region_code, primary_key: :code
+    has_many :provinces, class_name: "PhilLocator::Province", foreign_key: :region_code, primary_key: :region_code
+
+    alias_attribute :psgcCode, :code
+
+    def alias
+      self[:name].split("(").last.strip.gsub(/\(|\)/, "")
+    end
 
     def cities
-      PhilLocator::City.where(region_code: code.to_i.to_s)
+      PhilLocator::City.where(province_code: provinces.map(&:province_code))
+    end
+
+    def municipalities
+      PhilLocator::Municipality.where(province_code: provinces.map(&:province_code))
     end
 
-    def psgcCode
-      code.ljust(9, "0")
+    def name
+      self[:name].split("(").first.delete("(").strip
     end
   end
 end

data/app/models/phil_locator/sub_municipality.rb

@@ -0,0 +1,13 @@
+module PhilLocator
+  class SubMunicipality < ActiveYaml::Base
+    include ActiveHash::Associations
+
+    set_root_path module_parent.data_root_path(:yaml)
+    set_filename "sub_municipalities"
+
+    belongs_to :district, class_name: "PhilLocator::District",
+                          foreign_key: :district_code, primary_key: :district_code
+
+    alias_attribute :psgcCode, :code
+  end
+end