tg_geometry 0.1.0 → 0.2.0

data/docs/RACTOR.md

@@ -1,40 +0,0 @@
-# Ractor investigation
-
-This document covers Expansion Block I.
-
-## Current result
-
-`tg_geometry` does not claim Ractor support.
-
-The current native wrappers are frozen and immutable for normal Ruby thread reads, but they are not Ractor-shareable Ruby objects. The test suite records this boundary with `Ractor.shareable?` and `Ractor.make_shareable` checks for:
-
-- `TG::Geometry::Geom`
-- `TG::Geometry::Rect`
-- `TG::Geometry::Index`
-
-This is an explicit unsupported boundary, not a partial support claim.
-
-## Shareability rules
-
-Current rule for public docs and code comments:
-
-- Normal Ruby thread read-only use is supported by immutable object design and tests.
-- Ractor support is not supported and not advertised.
-- Do not use `TG::Geometry::Geom`, `TG::Geometry::Rect`, `TG::Geometry::Index`, or borrowed low-level wrappers as cross-Ractor shareable objects.
-- Do not add Ractor-specific code paths without a new explicit design and tests.
-
-## Why no support claim is made
-
-The extension stores native pointers and Ruby `VALUE` references inside TypedData wrappers. The current contract validates GC marking, compaction, ownership, and normal thread read-only access. It does not define or validate cross-Ractor transfer/share semantics for those wrappers.
-
-## Required before changing this status
-
-Before any future Ractor support claim:
-
-1. Define shareability rules for owned and borrowed `TG::Geometry::Geom` wrappers.
-2. Define shareability rules for `TG::Geometry::Index` entries and id `VALUE`s.
-3. Define behavior for borrowed Line/Ring/Polygon/Segment wrappers.
-4. Add Ractor tests that pass on the supported Ruby matrix.
-5. Document whether objects are shareable directly, require duplication, or are unsupported.
-
-Until those items exist, Ractor remains unsupported.

data/docs/REGISTRY.md

@@ -1,37 +0,0 @@
-# Registry
-
-`TG::Geometry::Registry` is Ruby-side application sugar over immutable `TG::Geometry::Index`.
-
-It does not add a mutable native index. `reload!` always builds a new Index and then swaps a Ruby reference:
-
-```ruby
-class DeliveryZones < TG::Geometry::Registry
-  source do
-    [
-      [:zone_a, '{"type":"Polygon","coordinates":[[[0,0],[10,0],[10,10],[0,10],[0,0]]]}']
-    ]
-  end
-end
-
-registry = DeliveryZones.new(via: :geojson, strategy: :rtree)
-registry.reload!
-registry.find_covering(5, 5)
-```
-
-Readers capture the current immutable Index. An active reader can continue using the old Index while `reload!` builds and swaps a new one.
-
-## API
-
-- `source { ... }` on a subclass defines the entry source.
-- `index_options(...)` on a subclass sets default Index options.
-- `reload!` builds and swaps a new Index.
-- `find_covering`, `covering_ids`, `intersecting_rect`, and `covering_ids_batch_packed` delegate to the current Index.
-- `index`, `size`, `bbox`, and `loaded?` expose current state.
-
-The source must return the strict first-release entry format:
-
-```ruby
-[[id, object], [id, object], ...]
-```
-
-No Redis dependency, no Rails dependency, no global native singleton, and no in-place Index mutation are introduced.

data/docs/RELEASE_CHECKLIST.md

@@ -1,39 +0,0 @@
-# First public release checklist
-
-This checklist is intentionally conservative. Do not publish until every required item is satisfied.
-
-## Required state before release
-
-- [ ] All release-core specs pass locally.
-- [ ] GC.stress specs pass.
-- [ ] GC.compact specs pass.
-- [ ] ASAN status is documented.
-- [ ] Valgrind status is documented.
-- [ ] Benchmark scripts exist and have been run for the full scenario matrix.
-- [ ] README and docs are complete.
-- [ ] Gem metadata is final:
-  - gem name: `tg_geometry`;
-  - author: `Roman Haydarov`;
-  - email: `romnhajdarov@gmail.com`;
-  - repository: `https://github.com/roman-haidarov/tg_geometry`.
-- [ ] Vendored TG and rtree versions are pinned in `VERSION` files.
-- [ ] Upstream license files are included under `ext/tg_geometry/vendor/*/LICENSE`.
-- [ ] `CHANGELOG.md` exists.
-
-## Do not release if any of these are true
-
-- [ ] Any OPEN QUESTION affects correctness.
-- [ ] Any memory accounting path is approximate.
-- [ ] Any failed build path waits for GC instead of immediate dispose.
-- [ ] `strategy: :auto` is enabled without benchmark-derived threshold.
-- [ ] Public API differs from the contract without Roman approval.
-- [ ] Ractor support is claimed.
-- [ ] Performance claims are present without project-owned benchmark output.
-
-## OPEN QUESTION: ASAN setup
-
-ASAN setup is not fully specified in the contract and the worker must not research it independently. The repository contains a placeholder CI job that fails with an explicit message until Roman approves the exact ASAN approach.
-
-## OPEN QUESTION: Valgrind setup
-
-Valgrind setup can vary by CI image and Ruby build. The repository contains a placeholder CI job that installs/runs nothing by default and asks for approval before adding a final Valgrind configuration.