pilipinas 1.1.1 → 1.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 989723b7dcd5133a2d2240aa124e0c5400a981f521d0904d8b2858fb71f15e9e
4
- data.tar.gz: c01c0377bf9572381844a38d1c77dbe45aed0e554076159a9964371f5f7aa851
3
+ metadata.gz: 3c053d3fbf05daa1c3bd6298945223e06a0c8154962f9958e8681701738a808b
4
+ data.tar.gz: 5613bb74fb432f59980cb54067d2d5fb0c2229807df82471e73131b884e00452
5
5
  SHA512:
6
- metadata.gz: b2589f13688bd95ad3ad176d9dccc2412a0df9a3484a173129e3dc66e7f78dad67ea1f7920f7bee9136f412b5c6221a7776b2f7a682ef1e0fdb55d2ffd1cd307
7
- data.tar.gz: 73bc97b32dcaa44f0a9181e63d450770535e12f73254fcea500551a46bb788a0dfe2bf9ed7de897a84ab1c22f0a19545d050e2b7a1c8cd76c7d3515a55b60d0d
6
+ metadata.gz: 5b1fb8a1a22541315c95dddf2f8f027e88c9455a7fbcde7dd8af9a8483c844247224321aae75d627eab1a15121ef075df01430cfe9a50448dbf9191e83c53851
7
+ data.tar.gz: 453835a9b952e40983c10e50ba5f7321efc669c59b11db7442943c29553d37c5d5d79defb697382ac7eac11298f87dc92d7e8dc1e0ad26e7cf5262b532ac97ac
data/CHANGELOG.md CHANGED
@@ -7,6 +7,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
 
8
8
  ---
9
9
 
10
+ ## [1.1.2] - 2026-06-12
11
+
12
+ ### Fixed
13
+
14
+ - `rake pilipinas:load` now seeds the ActiveRecord tables from `lib/data/pilipinas_data.yml`, the complete bundled data source. Previously the loader used the compact file-backed YAML files, so database rows were populated with only `code` and `name` while columns such as `location_id`, `parent_id`, `lft`, `rgt`, coordinates, and classification fields remained `NULL`.
15
+
16
+ - Re-running `rake pilipinas:load` now removes stale compact rows created by earlier loader versions. This fixes cases where old rows such as provinces with `location_id: nil` remained in the database because their compact internal codes did not match the full PSA-style codes used by `pilipinas_data.yml`.
17
+
18
+ ### Changed
19
+
20
+ - Improved loader memory behavior by transforming rows directly from the parsed full-data table and keeping only the current insert batch in memory.
21
+
22
+ ### Tests
23
+
24
+ - Added regression coverage for complete-column seeding, stale compact-row cleanup, legacy seed behavior, and exact batch-boundary inserts.
25
+
26
+ ---
27
+
28
+ ## [1.1.1] - 2026-06-11
29
+
30
+ ### Added
31
+
32
+ - `rails generate pilipinas:code_indexes` — new migration generator that adds `UNIQUE` indexes on the `code` column to all four `pilipinas_*` tables. Run this if your database was created with a pre-1.0 migration and `rake pilipinas:load` raises `ArgumentError: No unique index found for code`.
33
+
34
+ ### Fixed
35
+
36
+ - `Loader.bulk_insert` now rescues the bare `ArgumentError` raised by `upsert_all` when the unique index on `code` is absent, and re-raises it as a descriptive `Pilipinas::Error` that tells the user exactly which commands to run (`rails generate pilipinas:code_indexes && rails db:migrate`). Previously the error surfaced as an unguided `ArgumentError` from deep inside ActiveRecord.
37
+
38
+ ---
39
+
10
40
  ## [1.1.0] - 2026-05-13
11
41
 
12
42
  ### Added
@@ -18,19 +48,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
18
48
  self.enforce_readonly = false
19
49
  end
20
50
  ```
21
- - `lib/pilipinas/testing/rspec.rb` — a ready-made RSpec helper that disables
22
- the read-only guard on all four DB models for the entire test suite.
23
- Require it once in `rails_helper.rb`:
51
+ - `lib/pilipinas/testing/rspec.rb` — a ready-made RSpec helper that disables the read-only guard on all four DB models for the entire test suite. Require it once in `rails_helper.rb`:
24
52
  ```ruby
25
53
  require 'pilipinas/testing/rspec'
26
54
  ```
27
- - Spec coverage for `StaticRecord` — 8 examples covering default behaviour,
28
- `enforce_readonly = false`, subclass inheritance, and class-level isolation.
55
+ - Spec coverage for `StaticRecord` — 8 examples covering default behaviour, `enforce_readonly = false`, subclass inheritance, and class-level isolation.
29
56
 
30
57
  ### Changed
31
58
 
32
- - `readonly?` now gates on `self.class.enforce_readonly && !new_record?` instead
33
- of unconditionally returning `!new_record?`.
59
+ - `readonly?` now gates on `self.class.enforce_readonly && !new_record?` instead of unconditionally returning `!new_record?`.
34
60
 
35
61
  ---
36
62
 
@@ -40,26 +66,20 @@ Complete rewrite of the gem. Zero runtime dependencies.
40
66
 
41
67
  ### Added
42
68
 
43
- - In-memory layer with thread-safe `Pilipinas::Cache` (Mutex + double-checked
44
- locking) and O(1) look-ups via separate code/name hash indices.
69
+ - In-memory layer with thread-safe `Pilipinas::Cache` (Mutex + double-checked locking) and O(1) look-ups via separate code/name hash indices.
45
70
  - Immutable value objects — every entity instance is frozen.
46
- - `Pilipinas::Region`, `Province`, `City`, `Barangay` with `.all`, `.count`,
47
- `.first`, `.last`, `.find_by`, `.find_by_code`, `.find_by_name`.
71
+ - `Pilipinas::Region`, `Province`, `City`, `Barangay` with `.all`, `.count`, `.first`, `.last`, `.find_by`, `.find_by_code`, `.find_by_name`.
48
72
  - Hierarchy traversal: `region.provinces`, `province.cities`, `city.barangays`.
49
- - Optional ActiveRecord layer (`Pilipinas::Db::*`) with memory-efficient scopes
50
- (`.lite`, `.by_code`, `.by_name`, `.find_lite_by_code`, `.find_lite_by_name`).
51
- - `StaticRecord` concern: disables STI, adds lean SELECT scopes, enforces
52
- read-only on persisted records.
53
- - Migration generator (`rails generate pilipinas:migration`) and
54
- `rake pilipinas:load` seeding task.
73
+ - Optional ActiveRecord layer (`Pilipinas::Db::*`) with memory-efficient scopes (`.lite`, `.by_code`, `.by_name`, `.find_lite_by_code`, `.find_lite_by_name`).
74
+ - `StaticRecord` concern: disables STI, adds lean SELECT scopes, enforces read-only on persisted records.
75
+ - Migration generator (`rails generate pilipinas:migration`) and `rake pilipinas:load` seeding task.
55
76
  - Full RSpec suite (57 examples).
56
77
  - GitHub Actions CI pipeline.
57
78
 
58
79
  ### Changed
59
80
 
60
81
  - Requires Ruby ≥ 3.4 (developed against Ruby 4.0).
61
- - Removed all runtime gem dependencies (previously depended on `yaml_db` and
62
- others).
82
+ - Removed all runtime gem dependencies (previously depended on `yaml_db` and others).
63
83
 
64
84
  ---
65
85
 
@@ -74,6 +94,8 @@ Complete rewrite of the gem. Zero runtime dependencies.
74
94
  - Rails generator for migrations.
75
95
  - Railtie for automatic Rake task loading in Rails apps.
76
96
 
97
+ [1.1.2]: https://github.com/denmarkmeralpis/pilipinas/compare/v1.1.1...v1.1.2
98
+ [1.1.1]: https://github.com/denmarkmeralpis/pilipinas/compare/v1.1.0...v1.1.1
77
99
  [1.1.0]: https://github.com/denmarkmeralpis/pilipinas/compare/v1.0.0...v1.1.0
78
100
  [1.0.0]: https://github.com/denmarkmeralpis/pilipinas/compare/v0.0.1...v1.0.0
79
101
  [0.0.1]: https://github.com/denmarkmeralpis/pilipinas/releases/tag/v0.0.1
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- pilipinas (1.1.1)
4
+ pilipinas (1.1.2)
5
5
 
6
6
  GEM
7
7
  remote: https://rubygems.org/
@@ -296,7 +296,7 @@ CHECKSUMS
296
296
  nokogiri (1.19.3-x86_64-linux-musl) sha256=248c906d2166eca5efb56d52fdee5f9a1f51d69a72e2b64fdac647b4ce39ea3f
297
297
  parallel (2.1.0) sha256=b35258865c2e31134c5ecb708beaaf6772adf9d5efae28e93e99260877b09356
298
298
  parser (3.3.11.1) sha256=d17ace7aabe3e72c3cc94043714be27cc6f852f104d81aa284c2281aecc65d54
299
- pilipinas (1.1.1)
299
+ pilipinas (1.1.2)
300
300
  pp (0.6.3) sha256=2951d514450b93ccfeb1df7d021cae0da16e0a7f95ee1e2273719669d0ab9df6
301
301
  prettyprint (0.2.0) sha256=2bc9e15581a94742064a3cc8b0fb9d45aae3d03a1baa6ef80922627a0766f193
302
302
  prism (1.9.0) sha256=7b530c6a9f92c24300014919c9dcbc055bf4cdf51ec30aed099b06cd6674ef85
@@ -9,8 +9,9 @@ module Pilipinas
9
9
  # * **Idempotent** — uses +upsert_all+ (Rails 6.1+) so re-running the Rake
10
10
  # task is safe. Falls back to +insert_all+ (Rails 6.0) or individual
11
11
  # +create!+ calls on older versions.
12
- # * **Memory-efficient** — rows are inserted in batches of {BATCH_SIZE}
13
- # (default 500) so the process never holds a 42 k-row Array in memory.
12
+ # * **Memory-aware** — rows are transformed and inserted in batches of
13
+ # {BATCH_SIZE} (default 500) so the process never holds a full
14
+ # ActiveRecord insert payload in memory.
14
15
  # * **Atomic** — all four tables are seeded inside a single transaction; a
15
16
  # failure rolls back everything, leaving no partial data.
16
17
  #
@@ -21,22 +22,102 @@ module Pilipinas
21
22
  # Number of rows inserted per SQL statement.
22
23
  # 500 balances SQL statement size against the number of round-trips.
23
24
  BATCH_SIZE = 500
25
+ FULL_DATA_FILE = 'pilipinas_data.yml'
26
+ LOCATION_TABLE = 'pilipinas_locations'
27
+
28
+ FULL_DATA_SEEDS = [
29
+ ['Region', 'Locations::Region', %w[location_id lft rgt code name longitude latitude]],
30
+ ['Province', 'Locations::Province', %w[location_id parent_id lft rgt code name longitude latitude]],
31
+ [
32
+ 'City',
33
+ 'Locations::Town',
34
+ %w[location_id parent_id lft rgt code name city income_class urban_rural district longitude latitude]
35
+ ],
36
+ ['Barangay', 'Locations::Barangay', %w[location_id parent_id lft rgt code name urban_rural]]
37
+ ].freeze
38
+ private_constant :FULL_DATA_FILE, :LOCATION_TABLE, :FULL_DATA_SEEDS
24
39
 
25
40
  class << self
26
41
  # Seed all four geographic tables inside a single transaction.
27
42
  #
28
43
  # @return [void]
29
44
  def run
45
+ column_indexes, records = full_location_table
46
+
30
47
  ActiveRecord::Base.transaction do
31
- seed(Db::Region, 'regions.yml')
32
- seed(Db::Province, 'provinces.yml')
33
- seed(Db::City, 'cities.yml')
34
- seed(Db::Barangay, 'barangays.yml')
48
+ FULL_DATA_SEEDS.each do |model_name, type, attributes|
49
+ model = Db.const_get(model_name)
50
+ delete_stale_compact_rows(model)
51
+ seed_full_data(model, records, column_indexes, type, attributes)
52
+ end
35
53
  end
36
54
  end
37
55
 
38
56
  private
39
57
 
58
+ # Load the full Rails fixture-style location dump bundled with the gem.
59
+ #
60
+ # The older per-table YAML files only contain +code+ and +name+ for the
61
+ # file-backed API. Database seeding needs the complete dump so lft/rgt,
62
+ # parent links, coordinates, and classification fields are populated.
63
+ #
64
+ # @return [Array(Hash, Array<Array>)]
65
+ def full_location_table
66
+ data = Psych.load_file(File.join(DATA_DIR, FULL_DATA_FILE)) || {}
67
+ table = data.fetch(LOCATION_TABLE)
68
+ columns = table.fetch('columns').map(&:to_s)
69
+
70
+ [columns.each_with_index.to_h, table.fetch('records')]
71
+ end
72
+
73
+ # Insert or update rows for one split table from the full location dump.
74
+ #
75
+ # @param model [Class] ActiveRecord model class
76
+ # @param records [Array<Array>] full location dump rows
77
+ # @param column_indexes [Hash] source column names mapped to row indexes
78
+ # @param type [String] source STI type to select
79
+ # @param attributes [Array<String>] destination table attributes
80
+ # @return [void]
81
+ def seed_full_data(model, records, column_indexes, type, attributes)
82
+ type_index = column_indexes.fetch('type')
83
+ attribute_indexes = attributes.to_h { |attribute| [attribute, column_indexes.fetch(attribute)] }
84
+ now = timestamp
85
+ batch = []
86
+
87
+ records.each do |record|
88
+ next unless record[type_index] == type
89
+
90
+ batch << full_data_attributes(record, attribute_indexes, now)
91
+
92
+ next if batch.size < BATCH_SIZE
93
+
94
+ bulk_insert(model, batch)
95
+ batch = []
96
+ end
97
+
98
+ bulk_insert(model, batch) unless batch.empty?
99
+ end
100
+
101
+ # @param record [Array] full location dump row
102
+ # @param attribute_indexes [Hash] destination attributes mapped to row indexes
103
+ # @param now [Time] timestamp shared by the current table seed
104
+ # @return [Hash]
105
+ def full_data_attributes(record, attribute_indexes, now)
106
+ attribute_indexes.to_h { |attribute, index| [attribute, record[index]] }
107
+ .merge('created_at' => now, 'updated_at' => now)
108
+ end
109
+
110
+ # Older loader versions seeded compact file-backed rows with only +code+
111
+ # and +name+. Those rows cannot be upserted into the full-data records
112
+ # because their +code+ values differ from the PSA codes in
113
+ # +pilipinas_data.yml+, so remove them before inserting the canonical set.
114
+ #
115
+ # @param model [Class] ActiveRecord model class
116
+ # @return [void]
117
+ def delete_stale_compact_rows(model)
118
+ model.where(location_id: nil).delete_all
119
+ end
120
+
40
121
  # Insert or update rows for one table from a YAML file.
41
122
  #
42
123
  # @param model [Class] ActiveRecord model class
@@ -4,5 +4,5 @@ module Pilipinas
4
4
  # Semantic version of the gem.
5
5
  #
6
6
  # Follows {https://semver.org Semantic Versioning}: MAJOR.MINOR.PATCH.
7
- VERSION = '1.1.1'
7
+ VERSION = '1.1.2'
8
8
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: pilipinas
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.1
4
+ version: 1.1.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Nujian Den Mark Meralpis