jmespath-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cf530e6a526f4e83cc7fd29f7f527fedf0b28add8d0e57b362db7ac96b379cb7
+  data.tar.gz: 29b4682722f6371663cd0c84f29119db2c1fd89943ad60db395aead75adc2456
+SHA512:
+  metadata.gz: 40f6a36ceb35cb72fe6dd62651f51ae41a8b79f204f71b6941c754f93ac5a2dd18e08ef9f2ee98791073bae4493b636ebd79ef8196541cccd3b92853310faa22
+  data.tar.gz: 8a4e7dfa8ea63e0e6c5e073f7e893a34d76de3267a6300ba5e60cd27d51cc9566be26985dd7e56b51bf31b7b5160bd2e41e634c9f8358483e358631a43357424

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+## 0.1.0 - 2026-11-01
+
+Initial implementation for Ruby 3.3 and later.
+
+- Implement the JMESPath language and all 26 standard functions.
+- Preserve the public `require "jmespath"` and `JMESPath.search` entry points under the `jmespath-ruby` package name.
+- Add immutable compiled expressions, bounded synchronized caching, and immutable custom function registries.
+- Save custom function registries and error-handling defaults in compiled expressions; expose `Expression#call` as an alias for `search`.
+- Compile common evaluation operations and reduce repeated allocation, field lookup, and function-validation costs.
+- Support Ruby hashes, symbol keys, Struct values, explicit conversion protocols, streams, and paths.
+- Include both command-line executable names, public RBS signatures, and executable YARD examples.
+- Validate pinned Python and Ruby compliance fixtures, declared compatibility corrections, and production-only gem installation.
+- Include reproducible speed and process-memory comparisons across MRI 3.3, 3.4, and 4.0 with default GC settings.
+
+The compatibility guide documents intentional corrections and limits.
+Applications that depend on the gem name `jmespath` must change that dependency explicitly.

data/CONTRIBUTING.md

@@ -0,0 +1,57 @@
+# Development
+
+Use Ruby 3.3 or later.
+Install the locked development bundle with `bundle install`.
+
+## Checks
+
+```sh
+bundle exec rake
+bundle exec rake docs
+bundle exec rake audit
+```
+
+The default task runs RuboCop, RBS validation, Steep, RSpec, fresh coverage, CRAP analysis, and documentation checks.
+Coverage requires 100% lines and branches.
+Every measurable library method must score at most 10 in coverage-aware CRAP analysis.
+A missing coverage report fails the check.
+Unmeasurable methods are reported for review.
+
+Run `bundle exec rspec spec/unit/parser_spec.rb` for a focused test cycle.
+Focused RSpec runs collect coverage without enforcing full-suite thresholds.
+Keep expected values independent of implementation code.
+Add a failing regression test before fixing behavior.
+
+## Compatibility fixtures
+
+Imported fixtures live under `spec/fixtures/upstream`.
+Their manifest records source commits, paths, licenses, and SHA-256 hashes.
+Preserve imported bytes.
+Place local regression cases and supplemental benchmark expectations outside the imported files.
+
+Use `script/differential.rb` with explicit pinned reference checkouts for comparisons.
+Normal tests require neither network access nor Python.
+
+## Documentation and releases
+
+Write YARD types and executable examples for public APIs.
+Examples ending in `#=>` or `# raises ErrorClass` run through documentation checks.
+Keep private implementation surfaces marked with `@api private`.
+
+Use Conventional Commits and focused commits.
+Build and validate an isolated gem before a release.
+Publishing and remote repository operations require separate authorization.
+
+## Release
+
+Update `lib/jmespath/version.rb` and `CHANGELOG.md` together.
+Run `bundle exec rake release:check` before creating a release tag.
+Push a `vVERSION` tag that exactly matches `JMESPath::VERSION`.
+The release workflow runs the full quality matrix, verifies the tag, archives the built gem, and publishes through RubyGems trusted publishing.
+
+The trusted publisher is restricted to `svyatov/jmespath-ruby`, workflow `release.yml`, and GitHub environment `release`.
+The environment accepts release tags matching `v*`.
+The token exchange declares the account's immutable RubyGems owner ID, `71752`, which is required for the first publication.
+No long-lived RubyGems API key is required.
+After publication, create the GitHub release from the archived gem and its matching changelog entry.
+If only GitHub release creation fails, reuse that artifact; do not republish the gem.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Leonid Svyatov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSES/python-MIT.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013 Amazon.com, Inc. or its affiliates.  All Rights Reserved
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSES/ruby-Apache-2.0.txt

@@ -0,0 +1,174 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.

data/README.md

@@ -0,0 +1,122 @@
+# jmespath-ruby
+
+A pure Ruby implementation of JMESPath for Ruby 3.3 and later.
+
+Search JSON-compatible values, compile expressions for reuse, and register typed custom functions.
+The package keeps `require "jmespath"` and `JMESPath.search` while using the gem name `jmespath-ruby`.
+
+## Install
+
+Add the gem to your Gemfile:
+
+```ruby
+gem "jmespath-ruby", "~> 0.1.0"
+```
+
+Or install it directly:
+
+```sh
+gem install jmespath-ruby
+```
+
+### Install from this checkout
+
+```sh
+bundle install
+bundle exec rake build
+gem install ./pkg/jmespath-ruby-0.1.0.gem
+```
+
+For a local Bundler application:
+
+```ruby
+gem "jmespath-ruby", path: "/path/to/jmespath-ruby"
+```
+
+Use one provider per bundle.
+A dependency on the package named `jmespath` needs its own dependency change; this gem cannot satisfy that name automatically.
+
+## Search
+
+```ruby
+require "jmespath"
+
+data = {people: [{name: "Ada", active: true}, {name: "Lin", active: false}]}
+JMESPath.search("people[?active].name", data) #=> ["Ada"]
+JMESPath.search("people[*].name", data) #=> ["Ada", "Lin"]
+JMESPath.search("missing", data) #=> nil
+```
+
+Missing fields return nil.
+Projections omit nil results and retain false values.
+The library preserves selected input objects and does not mutate the input.
+
+## Compile once
+
+```ruby
+expression = JMESPath.compile("user.name")
+expression.search({user: {name: "Ada"}}) #=> "Ada"
+expression.search({user: {name: "Lin"}}) #=> "Lin"
+```
+
+Compiled expressions are immutable and safe to share between threads.
+Each search uses separate evaluation state.
+Custom callbacks and input objects remain the caller's responsibility.
+
+Save evaluation options when compiling a query, then use `search` or its `call` alias:
+
+```ruby
+query = JMESPath.compile("length(name)", disable_visit_errors: true)
+query.call({name: "Ada"}) #=> 3
+query.call({name: nil}) #=> nil
+```
+
+## Custom functions
+
+```ruby
+functions = JMESPath::Functions.default.with("double", signature: [[:number]]) { |number| number * 2 }
+JMESPath.search("double(price)", {price: 12}, functions: functions) #=> 24
+```
+
+Registration returns a separate immutable registry.
+An existing function requires `override: true` to replace it.
+Every argument, including variadic arguments, is validated before the callback runs.
+
+## Command line
+
+Both `jmespath` and `jmespath.rb` accept an expression and a JSON document on standard input.
+
+```sh
+printf '%s\n' '{"user":{"name":"Ada"}}' | jmespath 'user.name'
+```
+
+The result goes to standard output as JSON.
+Errors go to standard error with a nonzero status.
+
+## Guides
+
+- [Search semantics](docs/guides/search.md)
+- [Compilation, caching, and threading](docs/guides/compilation.md)
+- [Built-in and custom functions](docs/guides/functions.md)
+- [Errors and limits](docs/guides/errors.md)
+- [Compatibility and migration](docs/guides/compatibility.md)
+- [Performance measurements](docs/guides/performance.md)
+- [Development](CONTRIBUTING.md)
+
+## Verify and document
+
+```sh
+bundle exec rake
+bundle exec rake docs
+bundle exec rake audit
+```
+
+The default task checks tests, fresh coverage, RuboCop, RBS, Steep, coverage-aware CRAP scores, and documentation.
+The gates require 100% line and branch coverage, and a CRAP score at most 10 per measurable library method.
+The audit task separately refreshes the dependency advisory database.
+YARD output is written to `doc/index.html`.
+
+## License
+
+[MIT](LICENSE) for authored code.
+Imported compliance fixtures retain their [upstream licenses](LICENSES/).

data/SECURITY.md

@@ -0,0 +1,16 @@
+# Security
+
+Search evaluates JMESPath syntax without executing Ruby query text.
+Input adapters and custom functions execute caller-supplied Ruby code.
+They are trusted application extensions, not a sandbox boundary.
+
+Use finite JSON numbers and avoid cyclic input when comparing or serializing entire values.
+Set a smaller `max_depth` for applications that need a lower nesting limit.
+Bound request sizes and runtime resources at the application boundary.
+
+Run `bundle exec rake audit` to refresh the dependency advisory database and check the lockfile.
+A failed database update fails the audit.
+
+Report security concerns through a private maintainer contact channel.
+Do not post credentials or private application data in public reports.
+Private repository reporting must be configured before publication.

data/VERSIONING.md

@@ -0,0 +1,12 @@
+# Versioning
+
+The initial package version is 0.1.0.
+The public contract includes the documented Ruby API, language behavior, error categories, options, CLI, and minimum Ruby version.
+Private implementation classes are outside that contract.
+
+Before 1.0, a breaking public change requires a minor version.
+After 1.0, a breaking public change requires a major version.
+Dropping Ruby 3.3 support after 1.0 requires a major release.
+
+Document corrected reference defects and migration consequences in the changelog.
+A tag or successful build alone does not establish publication.

data/docs/guides/compatibility.md

@@ -0,0 +1,84 @@
+# Compatibility
+
+The package is named `jmespath-ruby`. It provides `require "jmespath"` and `JMESPath.search`.
+Select one JMESPath provider in an application bundle.
+
+A dependency on the package named `jmespath` does not resolve to `jmespath-ruby` automatically.
+Dependencies that declare that name need their own dependency change before replacing the provider.
+Loading both providers in one process is unsupported because their require paths and constants overlap.
+
+## Ruby inputs
+
+Search accepts hashes with string or symbol keys, arrays, JSON scalars, Structs, Pathname, IO, and StringIO.
+Objects implementing `to_hash`, `to_ary`, or `to_str` use explicit conversion boundaries.
+A malformed conversion raises TypeError; exceptions from application conversion methods propagate.
+
+String keys with non-nil values take precedence over matching symbol keys.
+A nil string-key value allows lookup of an existing symbol key.
+Queries never create symbols or invoke arbitrary Struct methods.
+Selected values preserve their Ruby object identity.
+Constructed arrays, hashes, and literal values belong to each search result.
+
+Stream input starts at the current position and remains open after the search.
+Pathname input is opened and closed by the library.
+Invalid JSON retains the JSON parser's error class.
+
+## Options and errors
+
+The third positional argument remains an options hash; keyword options are also accepted.
+Conflicting duplicate options and unknown option names raise ArgumentError.
+Supported options are `cache_expressions`, `disable_visit_errors`, `functions`, and `max_depth`.
+
+The named error classes remain under `JMESPath::Errors`.
+Function validation errors can use subclasses of InvalidTypeError and InvalidArityError.
+Error message wording and private parser objects are outside the compatibility contract.
+Function names resolve during evaluation so compiled expressions can use different custom registries.
+
+With `disable_visit_errors: true`, library argument-type and arity failures return nil.
+Syntax, invalid-value, unknown-function, conversion, and application callback failures still raise.
+A callback's exception object and backtrace remain intact.
+
+## Deliberate corrections
+
+| Behavior | Result |
+| --- | --- |
+| Surplus arguments to `reverse` | InvalidArityError |
+| Missing or surplus arguments to `to_array` | InvalidArityError |
+| `min_by` or `max_by` on an empty array | nil |
+| Invalid trailing variadic arguments | InvalidTypeError |
+| Indexes beyond native machine integer range | nil, without a Ruby RangeError |
+
+Legacy bare backtick literals and ordering between strings remain supported.
+Numeric operations accept finite integers and floats; non-finite values are outside the JSON number domain.
+Cyclic values raise InvalidValueError when structural comparison or serialization encounters the cycle.
+
+## Limits
+
+Expression nesting defaults to 128 and can be reduced with `max_depth`.
+The maximum supported setting is 128.
+Nested arrays and objects in JSON literals count toward this limit.
+Compiled searches also check literal depth when a caller requests a lower limit.
+Flat field chains use iterative evaluation and do not consume that nesting budget per field.
+The compilation cache holds at most 32 entries and 1,048,576 source bytes.
+Oversized expressions bypass caching without becoming invalid.
+
+## Verification
+
+Pinned fixture sources are recorded with SHA-256 hashes in `spec/fixtures/upstream/sources.json`.
+Python reference: `2812594e69d43098ef60f81f4efc404c071b0418`.
+Ruby reference: `5e86ea7da2e954cc12f5b3a8383a43c0a65acba7`.
+
+Both compliance corpora run with plain inputs and supported Ruby wrappers.
+Error cases also run with visit-error suppression enabled.
+Benchmark-only cases use separate expectations where the upstream file omits a result.
+Imported fixture bytes remain unchanged.
+
+Differential verification checked 1,192 distinct and generated cases against both references.
+There were no unexpected differences.
+The two accepted differences were Ruby's empty-array errors for `min_by` and `max_by`.
+
+To repeat the comparison with the pinned library checkouts:
+
+```sh
+bundle exec ruby script/differential.rb --python-root /path/to/python --ruby-root /path/to/ruby
+```

data/docs/guides/compilation.md

@@ -0,0 +1,63 @@
+# Compilation and concurrency
+
+`JMESPath.compile` parses an expression into an immutable `JMESPath::Expression`.
+Each call to `Expression#search` reuses that syntax with separate evaluation state.
+
+```ruby
+expression = JMESPath.compile("items[*].name")
+expression.search({items: [{name: "Ada"}]}) #=> ["Ada"]
+expression.search({items: [{name: "Lin"}]}) #=> ["Lin"]
+```
+
+The expression owns a frozen copy of the query text.
+Changing the caller's original string does not change the compiled expression.
+Mutable literal results are copied for each evaluation.
+
+## Saved options
+
+Pass `functions:` and `disable_visit_errors:` to `compile` to save defaults for repeated searches.
+Configuration is validated once, and compiled operations use the selected registry.
+The `call` method is an alias for `search`.
+
+```ruby
+functions = JMESPath::Functions.default.with("double", signature: [[:number]]) { |value| value * 2 }
+query = JMESPath.compile("double(price)", functions: functions, disable_visit_errors: true)
+query.call({price: 12}) #=> 24
+query.search({price: nil}) #=> nil
+query.search({price: 7}, disable_visit_errors: false) #=> 14
+```
+
+Per-call options override the saved values for that call only.
+Omitted options retain their saved values.
+Conflicting positional and keyword options raise `ArgumentError`.
+Custom registries and configured expressions never enter the shared syntax cache.
+Unknown function names still raise during evaluation, after their arguments are evaluated.
+
+## Cache behavior
+
+Convenience searches use a synchronized least-recently-used compilation cache.
+The cache retains at most 32 expressions and 1,048,576 source bytes.
+Oversized expressions are parsed without entering the cache.
+Failed parses, input documents, search results, and custom registries are never cached.
+
+```ruby
+JMESPath.search("x", {x: 1}, cache_expressions: false) #=> 1
+JMESPath.compile("x", cache_expressions: false).search({x: 2}) #=> 2
+```
+
+Disabling caching changes parsing cost, not query semantics.
+The same option is accepted by a compiled expression; it already owns parsed syntax.
+
+## Threads and callbacks
+
+Compiled expressions and immutable function registries can be shared between threads.
+Callers must synchronize changes to input objects and state captured by custom callbacks.
+Returned input objects remain caller-owned and mutable.
+The library does not provide callback timeouts or a security sandbox.
+
+## Nesting
+
+The default and maximum supported nesting limit is 128.
+Use `max_depth` to select a smaller positive limit when compiling or searching.
+A compiled expression validates a requested search limit without reparsing.
+Flat field chains and pipes use iterative evaluation.

data/docs/guides/errors.md

@@ -0,0 +1,30 @@
+# Errors and diagnostics
+
+The common base class is `JMESPath::Errors::Error`.
+SyntaxError derives from that base; evaluation errors derive from RuntimeError.
+
+| Error | Meaning |
+| --- | --- |
+| `SyntaxError` | Invalid expression syntax, encoding, or nesting |
+| `InvalidTypeError` | Unsupported argument or expression-key type |
+| `InvalidArityError` | Incorrect number of function arguments |
+| `InvalidValueError` | Invalid slice step or cyclic value during structural processing |
+| `UnknownFunctionError` | Function absent from the supplied registry |
+
+SyntaxError exposes the expression, a zero-based byte position, and one-based line and character column.
+This distinguishes byte offsets from Unicode display positions.
+
+```ruby
+JMESPath.search("length(@)", 7) # raises JMESPath::Errors::InvalidTypeError
+JMESPath.search("unknown()", {}) # raises JMESPath::Errors::UnknownFunctionError
+JMESPath.search("[::0]", []) # raises JMESPath::Errors::InvalidValueError
+JMESPath.search("length(@)", 7, disable_visit_errors: true) #=> nil
+```
+
+Only library argument-type and arity failures are suppressed by `disable_visit_errors`.
+Syntax, unknown-function, invalid-value, adapter, and callback failures remain visible.
+Missing fields and out-of-range indices normally return nil.
+
+Invalid JSON streams raise the JSON parser's error class.
+Invalid options raise ArgumentError.
+The CLI translates expected input failures to status 1 and usage failures to status 2.