pilipinas 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a0d4e9bce22ec277d0dc496465c5f78ac9f6470c8ea579832191b2bcecba289
-  data.tar.gz: 188a8a2c3d853c01da1eaa3d0609688b0a6612cd0db46fe600b5754d58864753
+  metadata.gz: 989723b7dcd5133a2d2240aa124e0c5400a981f521d0904d8b2858fb71f15e9e
+  data.tar.gz: c01c0377bf9572381844a38d1c77dbe45aed0e554076159a9964371f5f7aa851
 SHA512:
-  metadata.gz: c4d3910367c067e84aaae374d27a39de44acaf1eba461150f84e019f8e9e0f6fb0ff2341fe44101e4cfb3c7c3ac0b7a23495d8d285adf7ad53af96bccc51285e
-  data.tar.gz: f17c36621d5afce588b5bcf95eea17cea461abb0d5c2dfc6caac8b8905c5e9fe71827f33e469dc3616ca40f188f030544776393c921af7e6fa40f0d9339af658
+  metadata.gz: b2589f13688bd95ad3ad176d9dccc2412a0df9a3484a173129e3dc66e7f78dad67ea1f7920f7bee9136f412b5c6221a7776b2f7a682ef1e0fdb55d2ffd1cd307
+  data.tar.gz: 73bc97b32dcaa44f0a9181e63d450770535e12f73254fcea500551a46bb788a0dfe2bf9ed7de897a84ab1c22f0a19545d050e2b7a1c8cd76c7d3515a55b60d0d

data/CHANGELOG.md

@@ -0,0 +1,79 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+---
+
+## [1.1.0] - 2026-05-13
+
+### Added
+
+- `enforce_readonly` class attribute on the `StaticRecord` concern (default: `true`).
+  Subclasses can opt out of the read-only guard without stubbing:
+  ```ruby
+  class Locations::Barangay < Pilipinas::Db::Barangay
+    self.enforce_readonly = false
+  end
+  ```
+- `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`:
+  ```ruby
+  require 'pilipinas/testing/rspec'
+  ```
+- Spec coverage for `StaticRecord` — 8 examples covering default behaviour,
+  `enforce_readonly = false`, subclass inheritance, and class-level isolation.
+
+### Changed
+
+- `readonly?` now gates on `self.class.enforce_readonly && !new_record?` instead
+  of unconditionally returning `!new_record?`.
+
+---
+
+## [1.0.0] - 2026-05-12
+
+Complete rewrite of the gem. Zero runtime dependencies.
+
+### Added
+
+- In-memory layer with thread-safe `Pilipinas::Cache` (Mutex + double-checked
+  locking) and O(1) look-ups via separate code/name hash indices.
+- Immutable value objects — every entity instance is frozen.
+- `Pilipinas::Region`, `Province`, `City`, `Barangay` with `.all`, `.count`,
+  `.first`, `.last`, `.find_by`, `.find_by_code`, `.find_by_name`.
+- Hierarchy traversal: `region.provinces`, `province.cities`, `city.barangays`.
+- Optional ActiveRecord layer (`Pilipinas::Db::*`) with memory-efficient scopes
+  (`.lite`, `.by_code`, `.by_name`, `.find_lite_by_code`, `.find_lite_by_name`).
+- `StaticRecord` concern: disables STI, adds lean SELECT scopes, enforces
+  read-only on persisted records.
+- Migration generator (`rails generate pilipinas:migration`) and
+  `rake pilipinas:load` seeding task.
+- Full RSpec suite (57 examples).
+- GitHub Actions CI pipeline.
+
+### Changed
+
+- Requires Ruby ≥ 3.4 (developed against Ruby 4.0).
+- Removed all runtime gem dependencies (previously depended on `yaml_db` and
+  others).
+
+---
+
+## [0.0.1] - 2019-01-26
+
+### Added
+
+- Initial release.
+- YAML data for Philippine regions, provinces, cities, and barangays.
+- ActiveRecord models backed by `pilipinas_*` tables.
+- Migration template and Rake loader task.
+- Rails generator for migrations.
+- Railtie for automatic Rake task loading in Rails apps.
+
+[1.1.0]: https://github.com/denmarkmeralpis/pilipinas/compare/v1.0.0...v1.1.0
+[1.0.0]: https://github.com/denmarkmeralpis/pilipinas/compare/v0.0.1...v1.0.0
+[0.0.1]: https://github.com/denmarkmeralpis/pilipinas/releases/tag/v0.0.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pilipinas (1.0.0)
+    pilipinas (1.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -76,7 +76,7 @@ GEM
       prism (>= 1.3.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.19.5)
+    json (2.19.8)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
@@ -110,7 +110,7 @@ GEM
       prettyprint
     prettyprint (0.2.0)
     prism (1.9.0)
-    psych (5.3.1)
+    psych (5.4.0)
       date
       stringio
     public_suffix (7.0.5)
@@ -162,7 +162,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
-    rubocop (1.86.1)
+    rubocop (1.87.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -179,9 +179,10 @@ GEM
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
-    rubocop-rspec (3.9.0)
+    rubocop-rspec (3.10.2)
       lint_roller (~> 1.1)
-      rubocop (~> 1.81)
+      regexp_parser (>= 2.0)
+      rubocop (~> 1.86, >= 1.86.2)
     ruby-progressbar (1.13.0)
     securerandom (0.4.1)
     shoulda-matchers (6.5.0)
@@ -196,14 +197,14 @@ GEM
       terminal-table
     simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
-    sqlite3 (2.9.4-aarch64-linux-gnu)
-    sqlite3 (2.9.4-aarch64-linux-musl)
-    sqlite3 (2.9.4-arm-linux-gnu)
-    sqlite3 (2.9.4-arm-linux-musl)
-    sqlite3 (2.9.4-arm64-darwin)
-    sqlite3 (2.9.4-x86_64-darwin)
-    sqlite3 (2.9.4-x86_64-linux-gnu)
-    sqlite3 (2.9.4-x86_64-linux-musl)
+    sqlite3 (2.9.5-aarch64-linux-gnu)
+    sqlite3 (2.9.5-aarch64-linux-musl)
+    sqlite3 (2.9.5-arm-linux-gnu)
+    sqlite3 (2.9.5-arm-linux-musl)
+    sqlite3 (2.9.5-arm64-darwin)
+    sqlite3 (2.9.5-x86_64-darwin)
+    sqlite3 (2.9.5-x86_64-linux-gnu)
+    sqlite3 (2.9.5-x86_64-linux-musl)
     stringio (3.2.0)
     terminal-table (4.0.0)
       unicode-display_width (>= 1.1.1, < 4)
@@ -221,7 +222,7 @@ GEM
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.7.5)
+    zeitwerk (2.8.2)
 
 PLATFORMS
   aarch64-linux-gnu
@@ -279,7 +280,7 @@ CHECKSUMS
   i18n (1.14.8) sha256=285778639134865c5e0f6269e0b818256017e8cde89993fdfcbfb64d088824a5
   io-console (0.8.2) sha256=d6e3ae7a7cc7574f4b8893b4fca2162e57a825b223a177b7afa236c5ef9814cc
   irb (1.18.0) sha256=de9454a0703a54704b9811a5ef31a60c86949fbf4013fcf244fabc7c775248e3
-  json (2.19.5) sha256=218a18553e4801d579ca7e0f5bc72bafd776d7397238a1fb4e74db5b0a812c59
+  json (2.19.8) sha256=6354310fd76ef69b87d5bd1f38b40d730613baf90b6803d2d0a48f618d32dfaa
   language_server-protocol (3.17.0.5) sha256=fd1e39a51a28bf3eec959379985a72e296e9f9acfce46f6a79d31ca8760803cc
   lint_roller (1.1.0) sha256=2c0c845b632a7d172cb849cc90c1bce937a28c5c8ccccb50dfd46a485003cc87
   logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
@@ -295,11 +296,11 @@ CHECKSUMS
   nokogiri (1.19.3-x86_64-linux-musl) sha256=248c906d2166eca5efb56d52fdee5f9a1f51d69a72e2b64fdac647b4ce39ea3f
   parallel (2.1.0) sha256=b35258865c2e31134c5ecb708beaaf6772adf9d5efae28e93e99260877b09356
   parser (3.3.11.1) sha256=d17ace7aabe3e72c3cc94043714be27cc6f852f104d81aa284c2281aecc65d54
-  pilipinas (1.0.0)
+  pilipinas (1.1.1)
   pp (0.6.3) sha256=2951d514450b93ccfeb1df7d021cae0da16e0a7f95ee1e2273719669d0ab9df6
   prettyprint (0.2.0) sha256=2bc9e15581a94742064a3cc8b0fb9d45aae3d03a1baa6ef80922627a0766f193
   prism (1.9.0) sha256=7b530c6a9f92c24300014919c9dcbc055bf4cdf51ec30aed099b06cd6674ef85
-  psych (5.3.1) sha256=eb7a57cef10c9d70173ff74e739d843ac3b2c019a003de48447b2963d81b1974
+  psych (5.4.0) sha256=14f72d69a611af663d7d70e4a7b67d9eb1f3ae9f8d916b478961d5a0075ba5b7
   public_suffix (7.0.5) sha256=1a8bb08f1bbea19228d3bed6e5ed908d1cb4f7c2726d18bd9cadf60bc676f623
   racc (1.8.1) sha256=4a7f6929691dbec8b5209a0b373bc2614882b55fc5d2e447a21aaa691303d62f
   rack (3.2.6) sha256=5ed78e1f73b2e25679bec7d45ee2d4483cc4146eb1be0264fc4d94cb5ef212c2
@@ -320,10 +321,10 @@ CHECKSUMS
   rspec-expectations (3.13.5) sha256=33a4d3a1d95060aea4c94e9f237030a8f9eae5615e9bd85718fe3a09e4b58836
   rspec-mocks (3.13.8) sha256=086ad3d3d17533f4237643de0b5c42f04b66348c28bf6b9c2d3f4a3b01af1d47
   rspec-support (3.13.7) sha256=0640e5570872aafefd79867901deeeeb40b0c9875a36b983d85f54fb7381c47c
-  rubocop (1.86.1) sha256=44415f3f01d01a21e01132248d2fd0867572475b566ca188a0a42133a08d4531
+  rubocop (1.87.0) sha256=b9d9ddf55116a513f8ef2c7ae660662d8b49301f118d3f0df61865b33a5c188d
   rubocop-ast (1.49.1) sha256=4412f3ee70f6fe4546cc489548e0f6fcf76cafcfa80fa03af67098ffed755035
   rubocop-rake (0.7.1) sha256=3797f2b6810c3e9df7376c26d5f44f3475eda59eb1adc38e6f62ecf027cbae4d
-  rubocop-rspec (3.9.0) sha256=8fa70a3619408237d789aeecfb9beef40576acc855173e60939d63332fdb55e2
+  rubocop-rspec (3.10.2) sha256=0b3e2ecc592cd10ecbf0095bb58d1e357905276e069643523cc19eb7495f65e2
   ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
   securerandom (0.4.1) sha256=cc5193d414a4341b6e225f0cb4446aceca8e50d5e1888743fac16987638ea0b1
   shoulda-matchers (6.5.0) sha256=ef6b572b2bed1ac4aba6ab2c5ff345a24b6d055a93a3d1c3bfc86d9d499e3f44
@@ -331,14 +332,14 @@ CHECKSUMS
   simplecov-console (0.9.5) sha256=b1108bcfff5f210143e2b8301698c367b01586f20d25a73e95475a5df6fc6ff6
   simplecov-html (0.13.2) sha256=bd0b8e54e7c2d7685927e8d6286466359b6f16b18cb0df47b508e8d73c777246
   simplecov_json_formatter (0.1.4) sha256=529418fbe8de1713ac2b2d612aa3daa56d316975d307244399fa4838c601b428
-  sqlite3 (2.9.4-aarch64-linux-gnu) sha256=ecabed721e6eaad54601d2685f09029d90025efc8d931040dc89cb3f8a2080ec
-  sqlite3 (2.9.4-aarch64-linux-musl) sha256=ffb4255947fb54c8c3eeca97460c9702b40de91ce390455ef7367ca6a3929a31
-  sqlite3 (2.9.4-arm-linux-gnu) sha256=9ee2008b9fbec984c3c165b0d7eedd2bd2a415100b761bfa3a4c6fbec9208bf6
-  sqlite3 (2.9.4-arm-linux-musl) sha256=8dc1fe4da6977992cd62decf4a93ccf6cc2e124a5e6a340160d52092f70e837a
-  sqlite3 (2.9.4-arm64-darwin) sha256=1d5aad413a815d236e96d43f05a1acc600b6cd086800770342a3f9c2877499ff
-  sqlite3 (2.9.4-x86_64-darwin) sha256=f280c476e360b73e86165a5e59b72801385b4a6c3a47f8af5ecefb9d90bec17f
-  sqlite3 (2.9.4-x86_64-linux-gnu) sha256=537a3eda71b1df1336d0055cbebe55a7317c34870c192c7b6b9d8d0be6871847
-  sqlite3 (2.9.4-x86_64-linux-musl) sha256=3fc5e865b4be9a85d998203ef8d0c0fdcb92f20acf34a254346ff8a19088efec
+  sqlite3 (2.9.5-aarch64-linux-gnu) sha256=78075b6337d3d182c6d2b4691049ed45cd220826160c9ea18946bf6a1de200dc
+  sqlite3 (2.9.5-aarch64-linux-musl) sha256=18c801185deb4adc01ddb281e8f672a39e3d1729979ca91e39439cd3eac0402d
+  sqlite3 (2.9.5-arm-linux-gnu) sha256=1bdfca0c7d63998c60b0f4a8e3c8df2d33800ccc4abd2d612eddbbbc92a4c48b
+  sqlite3 (2.9.5-arm-linux-musl) sha256=bae1109d12b2e9f588455967729b008e1ff4feb7761749df695019c9079913c6
+  sqlite3 (2.9.5-arm64-darwin) sha256=d0cf444a70fc9395d513cfbcc1e6719e224aa645314e3824cb0474c721425aa2
+  sqlite3 (2.9.5-x86_64-darwin) sha256=8e9caae38bd7ebb29cbeee3e7ab1d12dc2327d9a1b92c7fcf0dda05589627a81
+  sqlite3 (2.9.5-x86_64-linux-gnu) sha256=233dbcb6714148dd23bc5aeb33e8efd6eac974969564ddd5794c23d5f52b231e
+  sqlite3 (2.9.5-x86_64-linux-musl) sha256=e7d3a7474e8af0f96150c21abc203fbab5437206bfcdf11deab7741c0ca516f2
   stringio (3.2.0) sha256=c37cb2e58b4ffbd33fe5cd948c05934af997b36e0b6ca6fdf43afa234cf222e1
   terminal-table (4.0.0) sha256=f504793203f8251b2ea7c7068333053f0beeea26093ec9962e62ea79f94301d2
   thor (1.5.0) sha256=e3a9e55fe857e44859ce104a84675ab6e8cd59c650a49106a05f55f136425e73
@@ -350,7 +351,7 @@ CHECKSUMS
   uri (1.1.1) sha256=379fa58d27ffb1387eaada68c749d1426738bd0f654d812fcc07e7568f5c57c6
   useragent (0.16.11) sha256=700e6413ad4bb954bb63547fa098dddf7b0ebe75b40cc6f93b8d54255b173844
   webmock (3.26.2) sha256=774556f2ea6371846cca68c01769b2eac0d134492d21f6d0ab5dd643965a4c90
-  zeitwerk (2.7.5) sha256=d8da92128c09ea6ec62c949011b00ed4a20242b255293dd66bf41545398f73dd
+  zeitwerk (2.8.2) sha256=7212a61311083c604184b1ea2574b9aa05cd14f855a0841c06985cabe9181d12
 
 BUNDLED WITH
   4.0.6

data/README.md

@@ -18,6 +18,8 @@ Region  →  Province  →  City / Municipality  →  Barangay
 - **O(1) look-ups** — separate hash indices keyed by code and by name; no linear scans.
 - **Immutable value objects** — every entity instance is frozen. Safe to share across threads and fibers without copying.
 - **Optional ActiveRecord integration** — a migration generator and Rake task seed the four `pilipinas_*` tables from the bundled YAML data.
+- **Read-only by default** — persisted AR model instances raise `ActiveRecord::ReadOnlyRecord` on accidental writes; opt out per-class via `enforce_readonly = false`.
+- **Test helper included** — `require 'pilipinas/testing/rspec'` disables the read-only guard for the entire RSpec suite with one line.
 - **Ruby ≥ 3.4** required; developed against Ruby 4.0.
 
 ---
@@ -172,6 +174,20 @@ This creates four tables: `pilipinas_regions`, `pilipinas_provinces`, `pilipinas
 rake pilipinas:load
 ```
 
+> **Upgrading from an older version?**
+>
+> If `rake pilipinas:load` raises
+> `Pilipinas::Error: pilipinas:load requires a unique index on the code column`,
+> your database was created with an earlier migration that did not include those
+> indexes. Add them with the dedicated generator:
+>
+> ```sh
+> rails generate pilipinas:code_indexes
+> rails db:migrate
+> ```
+>
+> Then re-run `rake pilipinas:load`.
+
 ### 3. Use the AR models
 
 ```ruby
@@ -184,6 +200,48 @@ province.cities          # has_many association
 
 > **Note:** The AR models are auto-loaded and require `activerecord` to be available.
 
+### Read-only behaviour
+
+All four `Pilipinas::Db::*` models are **read-only by default**. Any attempt to call `update!`, `save`, or `destroy` on a persisted record raises `ActiveRecord::ReadOnlyRecord`. This is intentional — the pilipinas tables are static reference data that should never be mutated after seeding.
+
+New (unsaved) records are always writable, so `create!` works normally in the Loader and in test factories.
+
+#### Opting a subclass out of read-only enforcement
+
+If your application inherits from a Pilipinas DB model and legitimately needs write access, set `enforce_readonly` to `false` on the subclass:
+
+```ruby
+class Locations::Barangay < Pilipinas::Db::Barangay
+  self.enforce_readonly = false
+end
+```
+
+This does not affect the parent class or any other model.
+
+---
+
+## Testing
+
+The gem ships a ready-made RSpec helper that turns off the read-only guard for the entire test suite — no stubbing required.
+
+```ruby
+# spec/rails_helper.rb  (or spec/support/pilipinas.rb)
+require 'pilipinas/testing/rspec'
+```
+
+This sets `enforce_readonly = false` on all four models (`Region`, `Province`, `City`, `Barangay`) inside a `before(:suite)` hook, so FactoryBot factories, fixtures, and any spec that writes to pilipinas tables work without extra setup.
+
+If you only need writable records in a specific context:
+
+```ruby
+around do |example|
+  Locations::Barangay.enforce_readonly = false
+  example.run
+ensure
+  Locations::Barangay.enforce_readonly = true
+end
+```
+
 ---
 
 ## Advanced
@@ -238,54 +296,8 @@ The gem is available as open source under the terms of the [MIT License](LICENSE
 
 ## Acknowledgements
 
-The geographic data used in this gem is derived from the Philippine Standard Geographic Code (PSGC) published by the Philippine Statistics Authority.
-
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'pilipinas'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install pilipinas
-
-## Usage
-
-```ruby
-# All Regions
-Pilipinas::Region.all
-
-# All Provinces
-Pilipinas::Province.all
-
-# All Cities/Municipalities
-Pilipinas::City.all
-
-# All Barangays
-Pilipinas::Barangay.all
-
-# Finding record thru find_by_(code/name) method
-region = Pilipinas::Region.find_by_name("REGION V (Bicol Region)")
-
-# Get provinces by region
-region.provinces
-```
-## Acknowledgement
-
 The data used in this gem is from `gem pinas`. Kudos!
 
-## TODO
-
-* Add a form helper
-
 ## 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.

data/lib/generators/pilipinas/code_indexes_generator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+require 'rails/generators/active_record'
+
+module Pilipinas
+  # Rails generator that adds unique indexes on the +code+ column to all four
+  # pilipinas_* tables.
+  #
+  # Run this if your database was created with an older version of the gem
+  # that did not include these indexes, and +rake pilipinas:load+ raises:
+  #
+  #   ArgumentError: No unique index found for code
+  #
+  # @example
+  #   rails generate pilipinas:code_indexes
+  #   rails db:migrate
+  #
+  class CodeIndexesGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path('..', __dir__)
+
+    def generate_migration
+      migration_template 'templates/add_pilipinas_code_indexes.rb',
+                         'db/migrate/add_pilipinas_code_indexes.rb'
+    end
+
+    # @param _dir [String] unused (required by the interface)
+    # @return [String]
+    def self.next_migration_number(_dir)
+      Time.now.utc.strftime('%Y%m%d%H%M%S')
+    end
+
+    private
+
+    # @return [String] migration version bracket, e.g. "[8.0]"
+    def migration_version
+      "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+    end
+  end
+end

data/lib/generators/templates/add_pilipinas_code_indexes.rb

@@ -0,0 +1,8 @@
+class AddPilipinasCodeIndexes < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_index :pilipinas_regions,   :code, unique: true, if_not_exists: true
+    add_index :pilipinas_provinces, :code, unique: true, if_not_exists: true
+    add_index :pilipinas_cities,    :code, unique: true, if_not_exists: true
+    add_index :pilipinas_barangays, :code, unique: true, if_not_exists: true
+  end
+end

data/lib/pilipinas/db/concerns/static_record.rb

@@ -25,10 +25,14 @@ module Pilipinas
       #
       # == Optimizations applied
       #
-      # * +readonly?+ returns +true+ for persisted records only — accidental
+      # * +readonly?+ returns +true+ for persisted records when
+      #   +enforce_readonly+ is +true+ (the default) — accidental
       #   +update!/save!/destroy+ on fetched rows raise
       #   +ActiveRecord::ReadOnlyRecord+; new records stay writable so the
       #   Loader and test fixtures can still call +create!+.
+      # * +enforce_readonly+ class attribute: opt a subclass out of the
+      #   read-only guard without touching production models — useful in test
+      #   environments where factories need to write to pilipinas tables.
       # * +self.inheritance_column = :_sti_disabled+: removes STI type-column
       #   look-up from every query.
       # * +.lite+ scope: selects only +id+, +location_id+, +code+, +name+ —
@@ -50,6 +54,11 @@ module Pilipinas
       #   province.cities    # SELECT id, location_id, parent_id, code, name …
       #   city.barangays     # SELECT id, location_id, parent_id, code, name …
       #
+      # @example Opting a subclass out of read-only enforcement (e.g. in tests)
+      #   class Locations::Barangay < Pilipinas::Db::Barangay
+      #     self.enforce_readonly = false
+      #   end
+      #
       module StaticRecord
         extend ActiveSupport::Concern
 
@@ -64,6 +73,16 @@ module Pilipinas
           # Removes the hidden "type" column check AR performs on every query.
           self.inheritance_column = :_sti_disabled
 
+          # ── Read-only enforcement ─────────────────────────────────────────
+          # Defaults to +true+.  Set to +false+ on a subclass (e.g. in a test
+          # environment or for a model that legitimately needs write access)
+          # without touching production behaviour:
+          #
+          #   class Locations::Barangay < Pilipinas::Db::Barangay
+          #     self.enforce_readonly = false
+          #   end
+          class_attribute :enforce_readonly, instance_writer: false, default: true
+
           # ── Memory-efficient query scopes ─────────────────────────────────
 
           # Select only the four columns needed for display and look-up.
@@ -97,19 +116,25 @@ module Pilipinas
           scope :find_lite_by_name, ->(name) { lite.by_name(name).first }
         end
 
-        # Persisted instances loaded from a pilipinas_* table are permanently
-        # read-only: +update!+, +save+, and +destroy+ all raise
-        # +ActiveRecord::ReadOnlyRecord+.  New (unsaved) objects are writable
-        # so that the Loader can still call +create!+ on the fallback path and
-        # so that specs can build fixtures with +create!+.
+        # Guards against accidental writes to static reference data.
+        #
+        # Returns +true+ (making the record read-only) when both conditions hold:
+        # 1. The record is persisted (+new_record?+ is +false+).
+        # 2. The class-level +enforce_readonly+ flag is +true+ (the default).
+        #
+        # New (unsaved) objects are always writable so the Loader and test
+        # factories can call +create!+.  To allow writes on a subclass — for
+        # example in a test environment — set:
+        #
+        #   self.enforce_readonly = false
         #
         # Overriding +readonly?+ is more efficient than an +after_initialize+
-        # callback because it is only called when AR is about to perform a
-        # write operation — it adds zero per-record overhead on reads.
+        # callback: it is only invoked when AR is about to perform a write
+        # operation, so it adds zero overhead on read paths.
         #
-        # @return [Boolean] +true+ for persisted records, +false+ for new ones
+        # @return [Boolean]
         def readonly?
-          !new_record?
+          self.class.enforce_readonly && !new_record?
         end
       end
     end

data/lib/pilipinas/loader.rb

@@ -73,7 +73,17 @@ module Pilipinas
       # @return [void]
       def bulk_insert(model, batch)
         if model.respond_to?(:upsert_all)
-          model.upsert_all(batch, unique_by: :code)
+          begin
+            model.upsert_all(batch, unique_by: :code)
+          rescue ArgumentError
+            raise Pilipinas::Error,
+                  'pilipinas:load requires a unique index on the `code` column, ' \
+                  "which is missing from #{model.table_name}. " \
+                  'Your database was likely created with an older version of the gem. ' \
+                  "Run the following to add the missing indexes and retry:\n\n  " \
+                  "rails generate pilipinas:code_indexes\n  " \
+                  "rails db:migrate\n"
+          end
         elsif model.respond_to?(:insert_all)
           model.insert_all(batch)
         else

data/lib/pilipinas/testing/rspec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'pilipinas'
+
+# Pilipinas::Testing::RSpec
+#
+# Optional RSpec helper that disables the read-only guard on all Pilipinas DB
+# models for the duration of the test suite.  Require this file once (e.g. in
+# +rails_helper.rb+ or +spec/support/pilipinas.rb+) and FactoryBot factories,
+# fixtures, or any spec that needs to write to pilipinas_* tables will work
+# without stubbing or subclass overrides.
+#
+# == Usage
+#
+#   # spec/rails_helper.rb  (or spec/support/pilipinas.rb)
+#   require 'pilipinas/testing/rspec'
+#
+# == What it does
+#
+# Calls +enforce_readonly = false+ on every Pilipinas DB model inside a
+# +before(:suite)+ hook so the flag is set once, before any example runs.
+# The models remain writable for the entire test process, which is the correct
+# behaviour for a test environment where factories seed the pilipinas_* tables.
+#
+# If you need write access only in a specific context, set the flag manually
+# with an +around+ hook instead of requiring this file globally.
+#
+# == Models affected
+#
+# * Pilipinas::Db::Region
+# * Pilipinas::Db::Province
+# * Pilipinas::Db::City
+# * Pilipinas::Db::Barangay
+
+require 'rspec/core'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    [
+      Pilipinas::Db::Region,
+      Pilipinas::Db::Province,
+      Pilipinas::Db::City,
+      Pilipinas::Db::Barangay
+    ].each { |model| model.enforce_readonly = false }
+  end
+end

data/lib/pilipinas/version.rb

@@ -4,5 +4,5 @@ module Pilipinas
   # Semantic version of the gem.
   #
   # Follows {https://semver.org Semantic Versioning}: MAJOR.MINOR.PATCH.
-  VERSION = '1.0.0'
+  VERSION = '1.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pilipinas
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Nujian Den Mark Meralpis
@@ -143,6 +143,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -1908,7 +1909,9 @@ files:
 - lib/data/regions/41165.yml
 - lib/data/regions/6398.yml
 - lib/data/regions/8808.yml
+- lib/generators/pilipinas/code_indexes_generator.rb
 - lib/generators/pilipinas/migration_generator.rb
+- lib/generators/templates/add_pilipinas_code_indexes.rb
 - lib/generators/templates/migration.rb
 - lib/pilipinas.rb
 - lib/pilipinas/barangay.rb
@@ -1924,6 +1927,7 @@ files:
 - lib/pilipinas/province.rb
 - lib/pilipinas/railtie.rb
 - lib/pilipinas/region.rb
+- lib/pilipinas/testing/rspec.rb
 - lib/pilipinas/version.rb
 - lib/tasks/pilipinas_tasks.rake
 - pilipinas.gemspec