maxmind-db-rust 0.5.0-x86_64-linux → 0.6.0-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4591f5b374ba228f60f15ade6d3678118fc5f0afe9754a9beac70747edc30896
-  data.tar.gz: fcbb9dbef604ad05b87b4e49ec15b27d6053e0b993ce2591c91d900c0592bca6
+  metadata.gz: 9a5acfd1e34141f95708f52bc8ded3d7c7a66f3e265de27f5f6622cc54937dfd
+  data.tar.gz: 57eed3dd6edfc9ecfc9fa460ec6bcc9de1d84d74cf9a40e02539bc37a24548bd
 SHA512:
-  metadata.gz: 302811a952700129f605a4bc7f5b7d791bfb113d52782b3269c9a7feea1050885c5c7f04cab7c87164ae5588a065492de91ab26b5f7170b8ac20e70834912d5a
-  data.tar.gz: 4ce1527671c972eb3eb49bc4a15cca9a93b7451068f8ac48590f33830b225d3284eee26fa6edaaf17769af771f18bee9f25f2aec001013ee2cd230d0afbf0d68
+  metadata.gz: e9081ef975be35d614db2ba467ace5729f2c0467bc5bac354d2e50d64526f7cfb48c87f152f1dbeea3eb4c816cfc97b5b5dedd5b0cbd7882b41367690df62611
+  data.tar.gz: fbf97ed0b4805005989354dcb972df5ffb59bb14f455273eec2e491746a4b074a0eebff7a00a456ffc67a7c11957e9ed5cecdca4fd5d5a10d7c7339f228d0300

data/CHANGELOG.md

@@ -5,6 +5,64 @@ 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).
 
+## [0.6.0] - 2026-07-19
+
+### Added
+
+- Added `Reader#verify` for opt-in comprehensive database integrity checks
+  using the verifier introduced by `maxminddb` 0.30.0.
+- Added iteration and shared-reader thread-scaling benchmarks, including a
+  cache-root retention check across thread churn.
+
+### Performance
+
+- Batched Ruby array and hash insertion while decoding MMDB records to reduce
+  protected Ruby C API calls during full-record lookups.
+- Replaced per-thread string caches with one fixed-size process cache that uses
+  its Ruby root array directly, improving reuse while bounding retained memory.
+- Batched `get_many` and `get_many_path` result construction to reduce Ruby
+  array insertion overhead for large input collections.
+- Improved `IPAddr` lookup performance by converting its public integer
+  representation directly instead of allocating packed address strings.
+- Avoided allocating a temporary candidate vector on parsed-path cache hits.
+
+### Changed
+
+- Upgraded the `maxminddb` crate to 0.30.0, improving selective path decoding
+  and hardening iteration and verification of corrupt databases.
+- Documented selective lookup and input-type performance guidance, and
+  clarified that thread-safe lookups remain serialized by MRI's global VM lock.
+- Documented the file-lifecycle safety contract for memory-mapped readers and
+  the requirement to atomically replace database paths during updates.
+- Simplified reader ownership by removing redundant outer `Arc` wrappers and a
+  duplicate closed flag while preserving atomic close semantics.
+- Removed the redundant extension-level Cargo lockfile; workspace builds use
+  the root lockfile as the single dependency lock.
+- Moved MMDB-to-Ruby decoding and string-cache logic into a focused Rust module.
+- Moved metadata storage and Ruby method registration into a focused Rust
+  module.
+- Moved parsed-path ownership, hashing, matching, and conversion into a focused
+  Rust module.
+- Moved reader behavior and Ruby method registration into a focused Rust module,
+  leaving the crate root responsible only for extension initialization.
+- Moved extension namespace and cache-root setup into a focused initialization
+  module.
+- Alternated baseline and candidate subprocesses between benchmark samples to
+  reduce order and thermal bias in git-ref comparisons.
+- Added fixed-record and prebuilt-`IPAddr` benchmark cases for cache-hot and
+  input-conversion performance comparisons.
+- Extended allocation benchmarking to cover selective batch lookups.
+
+### Fixed
+
+- Made decoded MMDB strings consistently frozen regardless of whether their
+  length qualifies for the bounded string cache.
+- Decoded MMDB UTF-8 strings and map keys directly into Ruby strings from raw
+  bytes, avoiding unchecked Rust strings while preserving Ruby's behavior for
+  invalid UTF-8 in corrupt databases.
+- Propagated Ruby hash insertion errors from `Metadata#description` instead of
+  silently returning a partial description.
+
 ## [0.5.0] - 2026-06-14
 
 ### Added
@@ -156,3 +214,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - MODE_FILE support (use MODE_MMAP instead)
 - File descriptor support in constructor
+
+[0.6.0]: https://github.com/oschwald/maxmind-db-rust-ruby/compare/v0.5.0...v0.6.0
+[0.5.0]: https://github.com/oschwald/maxmind-db-rust-ruby/compare/v0.4.0...v0.5.0
+[0.4.0]: https://github.com/oschwald/maxmind-db-rust-ruby/compare/v0.3.0...v0.4.0
+[0.3.0]: https://github.com/oschwald/maxmind-db-rust-ruby/compare/v0.2.1...v0.3.0
+[0.2.1]: https://github.com/oschwald/maxmind-db-rust-ruby/compare/v0.2.0...v0.2.1
+[0.2.0]: https://github.com/oschwald/maxmind-db-rust-ruby/compare/v0.1.4...v0.2.0
+[0.1.4]: https://github.com/oschwald/maxmind-db-rust-ruby/compare/v0.1.3...v0.1.4
+[0.1.3]: https://github.com/oschwald/maxmind-db-rust-ruby/compare/v0.1.2...v0.1.3
+[0.1.2]: https://github.com/oschwald/maxmind-db-rust-ruby/compare/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/oschwald/maxmind-db-rust-ruby/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/oschwald/maxmind-db-rust-ruby/releases/tag/v0.1.0

data/README.md

@@ -102,6 +102,9 @@ iso_codes = reader.get_many_path(ips, ['country', 'iso_code'])
 reader.close
 ```
 
+Decoded MMDB strings, including hash keys, are frozen. Call `dup` before
+modifying a decoded string.
+
 ### Using IPAddr Objects
 
 ```ruby
@@ -153,6 +156,11 @@ reader = MaxMind::DB::Rust::Reader.new(
 )
 ```
 
+`MODE_AUTO`, `MODE_FILE`, and `MODE_MMAP` require the underlying file not to be
+modified or truncated while the reader is alive. To refresh a database, write
+the replacement to a new file and atomically rename it over the old path. Use
+`MODE_MEMORY` if the file lifecycle cannot be controlled this way.
+
 ### Accessing Metadata
 
 ```ruby
@@ -290,6 +298,18 @@ Get metadata about the database.
 
 **Returns:** `MaxMind::DB::Rust::Metadata` instance
 
+#### `verify()`
+
+Perform a comprehensive validation of the database metadata, search tree, data
+section separator, and referenced data records. Verification traverses the
+entire database and may use memory proportional to the number of distinct
+referenced values, so it is intended for explicit integrity checks rather than
+the lookup hot path.
+
+**Returns:** `true` when the database passes verification
+
+**Raises:** `MaxMind::DB::Rust::InvalidDatabaseError` when verification fails
+
 #### `close()`
 
 Close the database and release resources.
@@ -365,8 +385,16 @@ Lookup performance depends on hardware, Ruby version, database, and workload.
 
 - In this project’s random-lookup benchmarks, this gem is consistently faster than the official Ruby implementation.
 - `MODE_MMAP` and `MODE_MEMORY` both perform well; which is faster can vary by environment.
+- Prefer `get_path` or `get_many_path` when only a small part of a record is
+  needed. Selective decoding avoids constructing the rest of the Ruby object
+  graph and can be substantially faster than a full-record lookup.
+- Textual IP address strings use the fastest input path. `IPAddr` objects are
+  supported but require Ruby method calls to extract their address family and
+  integer value.
 - For current, reproducible numbers on your own data and Ruby version, run `benchmark/compare_lookups.rb` against your database.
-- Safe for concurrent lookups across threads.
+- Readers are safe to share across Ruby threads. Ruby-facing lookup and decode
+  work currently runs under MRI's global VM lock, so additional Ruby threads do
+  not make one process perform lookups in parallel.
 
 ## Development
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maxmind-db-rust
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: x86_64-linux
 authors:
 - Gregory Oschwald
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-06-14 00:00:00.000000000 Z
+date: 2026-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement