nosj 0.2.0 → 0.3.1
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 +4 -4
- data/CHANGELOG.md +112 -0
- data/Cargo.lock +3 -3
- data/README.md +220 -19
- data/ext/nosj/Cargo.toml +2 -2
- data/ext/nosj/fuzz/Cargo.toml +41 -0
- data/ext/nosj/fuzz/fuzz_targets/lines.rs +9 -0
- data/ext/nosj/fuzz/fuzz_targets/patch.rs +10 -0
- data/ext/nosj/fuzz/fuzz_targets/reformat.rs +10 -0
- data/ext/nosj/fuzz/src/lib.rs +48 -0
- data/ext/nosj/fuzz/src/prelude.rb +400 -0
- data/ext/nosj/src/errors.rs +171 -0
- data/ext/nosj/src/files.rs +29 -7
- data/ext/nosj/src/gen/errors.rs +2 -9
- data/ext/nosj/src/gen/mod.rs +156 -12
- data/ext/nosj/src/gen/opts.rs +88 -10
- data/ext/nosj/src/gen/ruby.rs +51 -0
- data/ext/nosj/src/gen/walker.rs +97 -59
- data/ext/nosj/src/lazy.rs +42 -22
- data/ext/nosj/src/lib.rs +30 -0
- data/ext/nosj/src/lines.rs +90 -0
- data/ext/nosj/src/parse.rs +55 -14
- data/ext/nosj/src/patch.rs +547 -0
- data/ext/nosj/src/pointer.rs +12 -5
- data/ext/nosj/src/reformat.rs +320 -0
- data/ext/nosj/src/sink.rs +11 -0
- data/ext/nosj/src/stats.rs +301 -0
- data/lib/nosj/json.rb +30 -6
- data/lib/nosj/multi_json.rb +1 -1
- data/lib/nosj/rails.rb +76 -0
- data/lib/nosj/version.rb +1 -1
- data/lib/nosj.rb +351 -5
- data/sig/nosj.rbs +66 -0
- metadata +16 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7152dbc291ed6d291977555ba6a6b36f6d3d52dad57348a0baf8271212d1bb25
|
|
4
|
+
data.tar.gz: '083bd8ca6fac180455b4847c1634f4ac28455db8e6e85def4e14393700e3008f'
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 254595b89839c50a48adedc03f8ec70498cc0cf6876390565f3dd188cc5dfca564c498443d0091c23bbf6562bb11b1724a25c073fa9e76986b8b1779cc91765d
|
|
7
|
+
data.tar.gz: 4d321fb92d1199649dc10f84853aa3124e40cc642b3da680772f392c315374116f04d09882f4fd95f2c445941b384f15e23ab89fc3c735edebd8868855cb8582
|
data/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,115 @@
|
|
|
1
|
+
## [0.3.1] - 2026-07-17
|
|
2
|
+
|
|
3
|
+
- Fixed: `NOSJ.minify` / `NOSJ.reformat` produced unparseable output
|
|
4
|
+
for a float that overflows to Infinity—a huge-exponent literal like
|
|
5
|
+
`1e999`, or a ~300-digit integer with an exponent (such literals
|
|
6
|
+
parse to Infinity even in strict mode, matching the `json` gem).
|
|
7
|
+
The pipe emitted a bare `Infinity` token; it now raises the same
|
|
8
|
+
`GeneratorError` that `generate` would
|
|
9
|
+
(`"Infinity not allowed in JSON"`). With `allow_nan: true` the
|
|
10
|
+
literal still passes through as `Infinity`. Found by fuzzing.
|
|
11
|
+
- Fixed (second manifestation, also found by fuzzing): the same
|
|
12
|
+
unparseable output could appear with the overflowing literal hidden
|
|
13
|
+
behind a duplicate object key. Because the reformat pipe
|
|
14
|
+
deliberately preserves duplicate-key entries, it now refuses such
|
|
15
|
+
documents with the same `GeneratorError` even though
|
|
16
|
+
`generate(parse(x))` succeeds there (last-key-wins parsing discards
|
|
17
|
+
the shadowed value)—a documented divergence.
|
|
18
|
+
- Differential fuzzing for the native extension (`ext/nosj/fuzz`):
|
|
19
|
+
three cargo-fuzz targets—reformat, NDJSON framing, and
|
|
20
|
+
byte-splicing/JSON Patch—each drive the real entry points on an
|
|
21
|
+
embedded Ruby VM and compare every input against pure-Ruby
|
|
22
|
+
reference implementations, with committed seed corpora and a weekly
|
|
23
|
+
CI workflow (`fuzz.yml`).
|
|
24
|
+
|
|
25
|
+
## [0.3.0] - 2026-07-17
|
|
26
|
+
|
|
27
|
+
- Reformat without parsing. `NOSJ.minify(json, opts)` and
|
|
28
|
+
`NOSJ.reformat(json, opts)` (plus `NOSJ.reformat_file`) pipe the
|
|
29
|
+
parser's events straight into the emission kernels: zero Ruby
|
|
30
|
+
objects are allocated for the document, and output is exactly
|
|
31
|
+
`generate(parse(json))`—canonical numbers, normalized escapes, the
|
|
32
|
+
full set of `generate` formatting and escape options, with
|
|
33
|
+
`pretty: true` as a `pretty_generate` shorthand—except duplicate
|
|
34
|
+
object keys pass through and lone-surrogate string values re-escape
|
|
35
|
+
as `\uXXXX` instead of raising (the output must always reparse).
|
|
36
|
+
Acceptance options apply per `parse` (`allow_trailing_comma`
|
|
37
|
+
normalizes the commas away). Measured on the 631 KB twitter.json:
|
|
38
|
+
409µs, 3.4× faster than `NOSJ.generate(NOSJ.parse(x))`, 3.9× faster
|
|
39
|
+
than gem json's cycle, 5.3× faster than Oj's, and 1.4× the cost of
|
|
40
|
+
`NOSJ.valid?`.
|
|
41
|
+
- Byte-splicing edits and JSON Patch. `NOSJ.splice(json, pointer =>
|
|
42
|
+
value, ...)` replaces values directly in the text: every target
|
|
43
|
+
resolves in one forward pass and the result is rebuilt copying all
|
|
44
|
+
bytes outside the target spans untouched (formatting, key order, and
|
|
45
|
+
number spellings elsewhere survive exactly). Measured on
|
|
46
|
+
twitter.json: 10× faster than parse-mutate-generate for a late
|
|
47
|
+
field, 51× for an early one. Missing targets raise KeyError,
|
|
48
|
+
overlapping targets ArgumentError. `NOSJ.patch(json, ops)` applies
|
|
49
|
+
RFC 6902 JSON Patch (add/remove/replace/move/copy/test, String or
|
|
50
|
+
Symbol op keys) to the raw string the same way, with structural ops
|
|
51
|
+
walking only the parent container's span; application failures raise
|
|
52
|
+
the new `NOSJ::PatchError`, malformed patch documents ArgumentError.
|
|
53
|
+
`NOSJ.merge_patch(json, patch)` applies RFC 7386 JSON Merge Patch
|
|
54
|
+
(semantic form). Inserted values are byte-identical to
|
|
55
|
+
`NOSJ.generate` and accept its options; the RFC 6902 appendix-A
|
|
56
|
+
suite and the full RFC 7386 test table are in the specs.
|
|
57
|
+
- NDJSON / JSON Lines. `NOSJ.each_line(source, opts)` yields one
|
|
58
|
+
parsed value per line (Enumerator without a block, so
|
|
59
|
+
`.first(10)`/`.lazy` walk only what they consume), skipping blank
|
|
60
|
+
lines and enforcing one value per line; a malformed line raises the
|
|
61
|
+
rich `ParserError` whose `#line` is the physical line number in the
|
|
62
|
+
stream. `NOSJ.generate_lines(values, opts)` emits one compact
|
|
63
|
+
newline-terminated document per element in a single buffer pass
|
|
64
|
+
(measured 4.1× faster than the map-generate-join idiom on twitter
|
|
65
|
+
statuses; `each_line` is 1.6× faster than line-split +
|
|
66
|
+
`JSON.parse`), rejecting formatting options that would break line
|
|
67
|
+
framing. File forms: `NOSJ.each_line_file` streams over a read-only
|
|
68
|
+
memory map, `NOSJ.write_lines` generates straight to disk and
|
|
69
|
+
returns the byte count. Parse options apply per line; pass a frozen
|
|
70
|
+
string to `each_line` for zero-copy iteration.
|
|
71
|
+
- `NOSJ.stats(source, opts)` / `NOSJ.stats_file(path, opts)`: document
|
|
72
|
+
statistics from one counting pass through the null-sink machinery,
|
|
73
|
+
answering "what is this 40 MB blob" without building any Ruby values
|
|
74
|
+
for the document (measured ~1.3× faster than a full parse). Reports
|
|
75
|
+
`byte_size`, `root` kind, `max_depth`, value counts by type, key
|
|
76
|
+
totals, a key histogram sorted by count, largest container sizes,
|
|
77
|
+
and string byte totals. Nesting is unlimited by default (pass
|
|
78
|
+
`max_nesting` to enforce a limit); `allow_nan` and
|
|
79
|
+
`allow_trailing_comma` are honored; malformed documents raise the
|
|
80
|
+
rich `ParserError`. The file form memory-maps, so the document never
|
|
81
|
+
enters Ruby at all.
|
|
82
|
+
- Rich parse errors. Parse failures now raise `NOSJ::ParserError`
|
|
83
|
+
(previously a bare `RuntimeError`) carrying the failure position,
|
|
84
|
+
computed only when a parse fails: `#byte_offset`, 1-based `#line`,
|
|
85
|
+
character-based `#column`, and a caret `#snippet` showing the
|
|
86
|
+
offending line (windowed when the line is long, as minified JSON
|
|
87
|
+
usually is). Positions are absolute within the document you passed,
|
|
88
|
+
including through partial parsing (`dig`, `at_pointer`, batches),
|
|
89
|
+
lazy documents, and the file APIs. `#detailed_message` appends the
|
|
90
|
+
snippet, so unrescued errors print it. Failures with no position
|
|
91
|
+
(encoding refusals) leave the accessors nil. Exceeding `max_nesting`
|
|
92
|
+
during parsing now raises `NOSJ::NestingError`, matching the gem's
|
|
93
|
+
class (generation already did); rescues of the old `RuntimeError`
|
|
94
|
+
need updating to `NOSJ::ParserError`/`NOSJ::Error`.
|
|
95
|
+
- Rails mode: `require "nosj/rails"` accelerates a Rails application
|
|
96
|
+
in both directions. It installs a nosj-backed ActiveSupport JSON
|
|
97
|
+
encoder, so `obj.to_json`, `render json:`, and `ActiveSupport::JSON.encode` walk the object tree natively—values recurse through `as_json` exactly
|
|
98
|
+
like ActiveSupport's own encoder. It also loads the `nosj/json` drop-in, so
|
|
99
|
+
`ActiveSupport::JSON.decode` and JSON request-body parsing take the
|
|
100
|
+
fast path (including on Rails 7.x, whose `quirks_mode` option the
|
|
101
|
+
drop-in now accepts; the drop-in also accepts valid-UTF-8 BINARY
|
|
102
|
+
strings now, which is what Rack delivers request bodies as). The
|
|
103
|
+
HTML-safety escaping is fused into the SIMD string-emission kernels,
|
|
104
|
+
so escaped output costs the same single pass as unescaped. Measured
|
|
105
|
+
against stock ActiveSupport encoding: ×1.7 on small documents up to
|
|
106
|
+
×5.2 on large trees and ×14 on HTML-heavy content
|
|
107
|
+
(`rake bench:rails`). In a Rails Gemfile:
|
|
108
|
+
`gem "nosj", require: "nosj/rails"`.
|
|
109
|
+
- `JSON::Fragment` values now splice their pre-rendered JSON
|
|
110
|
+
everywhere the `json` gem does: in default mode, under `strict:
|
|
111
|
+
true`, and through the Rails encoder.
|
|
112
|
+
|
|
1
113
|
## [0.2.0] - 2026-07-16
|
|
2
114
|
|
|
3
115
|
- File APIs. `NOSJ.load_file(path, opts)` parses a file directly
|
data/Cargo.lock
CHANGED
|
@@ -189,16 +189,16 @@ dependencies = [
|
|
|
189
189
|
|
|
190
190
|
[[package]]
|
|
191
191
|
name = "nosj"
|
|
192
|
-
version = "0.
|
|
192
|
+
version = "0.2.0"
|
|
193
193
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
194
|
-
checksum = "
|
|
194
|
+
checksum = "d25913644b7871b36095cc3da27daf95ebf9508189c5d8ccfb16da3bdb9f802f"
|
|
195
195
|
dependencies = [
|
|
196
196
|
"fast-float2",
|
|
197
197
|
]
|
|
198
198
|
|
|
199
199
|
[[package]]
|
|
200
200
|
name = "nosj_native"
|
|
201
|
-
version = "0.
|
|
201
|
+
version = "0.3.1"
|
|
202
202
|
dependencies = [
|
|
203
203
|
"ahash",
|
|
204
204
|
"magnus",
|
data/README.md
CHANGED
|
@@ -13,11 +13,14 @@ faster than Yajl—[see Benchmarks](#benchmarks).
|
|
|
13
13
|
- It has **lazy documents**: `NOSJ.lazy` wraps a document and parses a value only when you touch it—repeated access costs nanoseconds, and everything you never read is never parsed.
|
|
14
14
|
- It has a **partial parsing mode**: JSON Pointer lookups that pull single values out of big documents in microseconds, skipping everything else.
|
|
15
15
|
- It has **file APIs**: parse, generate, dig, and lazy-wrap files directly—no throwaway file-sized Ruby String, and the partial modes memory-map the file so unread pages never even leave the disk.
|
|
16
|
+
- It does **byte-splicing edits**: `NOSJ.splice` changes a field inside a passing payload 10–51× faster than parse-mutate-generate, and RFC 6902 JSON Patch / RFC 7386 merge patch apply straight to the raw string.
|
|
17
|
+
- It is **great to debug with**: parse errors carry line, column, and a caret snippet pointing at the break, and `NOSJ.stats` X-rays a mystery blob (depth, value counts, key histogram) faster than parsing it.
|
|
18
|
+
- It accelerates a **Rails** application in both encoding and decoding.
|
|
16
19
|
- It comes **precompiled** (platform gems built with per-platform optimizations,
|
|
17
20
|
nothing to compile on install).
|
|
18
21
|
- Otherwise, same API and option names as gem json.
|
|
19
22
|
|
|
20
|
-
**And there's more**: validate documents without building a single Ruby object, resolve whole batches of paths in one pass, and accelerate an entire application with a one-line drop-in.
|
|
23
|
+
**And there's more**: validate documents without building a single Ruby object, minify and pretty-print without parsing, resolve whole batches of paths in one pass, stream NDJSON / JSON Lines in both directions, and accelerate an entire application with a one-line drop-in.
|
|
21
24
|
|
|
22
25
|
- [Requirements](#requirements)
|
|
23
26
|
- [Getting started](#getting-started)
|
|
@@ -26,6 +29,7 @@ nothing to compile on install).
|
|
|
26
29
|
- [Switching from the json gem](#switching-from-the-json-gem)
|
|
27
30
|
- [How it works](#how-it-works)
|
|
28
31
|
- [Development](#development)
|
|
32
|
+
- [Acknowledgements](#acknowledgements)
|
|
29
33
|
- [License](#license)
|
|
30
34
|
|
|
31
35
|
## Requirements
|
|
@@ -50,6 +54,8 @@ NOSJ.generate({"a" => [1, true]}) #=> '{"a":[1,true]}'
|
|
|
50
54
|
|
|
51
55
|
That's it—if you know the `json` gem, you already know `nosj`.
|
|
52
56
|
|
|
57
|
+
### gem json compatibility
|
|
58
|
+
|
|
53
59
|
Want the speedup without touching your code? One line reroutes
|
|
54
60
|
`JSON.parse`, `JSON.generate`, `JSON.pretty_generate`, and `JSON.dump`
|
|
55
61
|
through nosj:
|
|
@@ -65,18 +71,39 @@ Gemfile you can do this:
|
|
|
65
71
|
gem "nosj", require: "nosj/json"
|
|
66
72
|
```
|
|
67
73
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
74
|
+
A MultiJson adapter ships too:
|
|
75
|
+
|
|
76
|
+
```ruby
|
|
77
|
+
require "nosj/multi_json"
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
And then `MultiJson.use NOSJ::MultiJsonAdapter`.
|
|
81
|
+
|
|
82
|
+
### Ruby on Rails
|
|
83
|
+
|
|
84
|
+
In a Rails app, use this for "Rails mode":
|
|
85
|
+
|
|
86
|
+
```ruby
|
|
87
|
+
gem "nosj", require: "nosj/rails"
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
That installs a nosj-backed ActiveSupport JSON encoder, so `obj.to_json`, `render json:`, and `ActiveSupport::JSON.encode` walk the object tree natively:
|
|
91
|
+
values that aren't JSON-native recurse through `as_json` exactly like
|
|
92
|
+
ActiveSupport's own encoder, non-finite floats encode as `null`, and
|
|
93
|
+
HTML-safety escaping (`escape_html_entities_in_json`) behaves
|
|
94
|
+
identically—verified differentially against ActiveSupport's encoder.
|
|
95
|
+
It loads the drop-in too, so `ActiveSupport::JSON.decode` and JSON
|
|
96
|
+
request-body parsing ride the fast path.
|
|
97
|
+
|
|
98
|
+
Measured against ActiveSupport's own encoder: ×1.9 on small documents
|
|
99
|
+
up to ×5.2 on large trees and ×14 on HTML-heavy content—see
|
|
100
|
+
[Benchmarks → Rails mode](#rails-mode).
|
|
76
101
|
|
|
77
102
|
## What's in the box
|
|
78
103
|
|
|
79
|
-
|
|
104
|
+
### json API
|
|
105
|
+
|
|
106
|
+
The `json` gem API, on the `NOSJ` module:
|
|
80
107
|
|
|
81
108
|
```ruby
|
|
82
109
|
NOSJ.parse(src, symbolize_names: true) # also: freeze, max_nesting,
|
|
@@ -85,7 +112,9 @@ NOSJ.generate(obj) # indent, space, object_nl, ...,
|
|
|
85
112
|
NOSJ.pretty_generate(obj) # ascii_only, script_safe, strict
|
|
86
113
|
```
|
|
87
114
|
|
|
88
|
-
|
|
115
|
+
### Lazy documents
|
|
116
|
+
|
|
117
|
+
`NOSJ.lazy` wraps a document in a lazy view: read
|
|
89
118
|
a field and only that path is parsed—containers stay lazy, scalars
|
|
90
119
|
arrive as plain Ruby values, and repeated reads are cached:
|
|
91
120
|
|
|
@@ -101,8 +130,9 @@ Pass a frozen string and creating the view is practically free—
|
|
|
101
130
|
nanoseconds, even on a megabyte document. Malformed content raises
|
|
102
131
|
when it is first read, not at wrap time.
|
|
103
132
|
|
|
133
|
+
### Partial parsing
|
|
104
134
|
|
|
105
|
-
|
|
135
|
+
Pull values out of a document without
|
|
106
136
|
materializing the rest—skipped content is stepped over at SIMD block
|
|
107
137
|
speed, so a lookup costs what it skips, not what the document weighs:
|
|
108
138
|
|
|
@@ -122,7 +152,9 @@ at the far end of a 570 KB document costs ~71µs, still 13× faster
|
|
|
122
152
|
than parse-then-dig. Misses return nil; matched subtrees materialize
|
|
123
153
|
with the same options as `parse` (`symbolize_names:`, `freeze:`).
|
|
124
154
|
|
|
125
|
-
|
|
155
|
+
### Files API
|
|
156
|
+
|
|
157
|
+
Every mode has a file-native form, so a document never
|
|
126
158
|
round-trips through a throwaway Ruby String:
|
|
127
159
|
|
|
128
160
|
```ruby
|
|
@@ -138,10 +170,89 @@ read are never loaded from disk. Missing files raise the usual
|
|
|
138
170
|
`Errno` exceptions. Measured numbers live in
|
|
139
171
|
[Benchmarks → File APIs](#file-apis).
|
|
140
172
|
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
and
|
|
144
|
-
|
|
173
|
+
### Reformat without parsing
|
|
174
|
+
|
|
175
|
+
`NOSJ.minify` and `NOSJ.reformat` pipe the parser's events straight
|
|
176
|
+
into the emission kernels: **zero Ruby objects** are built for the
|
|
177
|
+
document (the specs assert it), SIMD in and SIMD out. Minifying the
|
|
178
|
+
631 KB twitter.json takes 409µs—3.4× faster than a
|
|
179
|
+
`generate(parse(x))` round-trip, 3.9× faster than gem json's cycle,
|
|
180
|
+
and only 1.4× the cost of `valid?`:
|
|
181
|
+
|
|
182
|
+
```ruby
|
|
183
|
+
NOSJ.minify(json) # compact
|
|
184
|
+
NOSJ.reformat(json, pretty: true) # pretty_generate layout
|
|
185
|
+
NOSJ.reformat(json, ascii_only: true) # escape-transcode, no parse
|
|
186
|
+
NOSJ.reformat_file("big.json") # straight off a memory map
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
Output is exactly `generate(parse(json))`—canonical number spellings,
|
|
190
|
+
normalized escapes, same formatting options—except duplicate keys pass
|
|
191
|
+
through (a reformatter must not silently drop data) and lone-surrogate
|
|
192
|
+
strings re-escape instead of raising. Acceptance options apply too:
|
|
193
|
+
`minify(src, allow_trailing_comma: true)` normalizes the commas away.
|
|
194
|
+
|
|
195
|
+
### Byte-splicing edits and JSON Patch
|
|
196
|
+
|
|
197
|
+
Change a field in a passing payload without the parse → mutate →
|
|
198
|
+
generate cycle: `NOSJ.splice` skips to the target spans (one pass for
|
|
199
|
+
the whole batch) and rebuilds the string around them—every byte
|
|
200
|
+
outside the targets is copied untouched, so formatting, key order,
|
|
201
|
+
and number spellings survive exactly. On twitter.json this is
|
|
202
|
+
**10×–51× faster** than parse-mutate-generate (129µs for a late
|
|
203
|
+
field, 26µs for an early one, vs ~1.3ms):
|
|
204
|
+
|
|
205
|
+
```ruby
|
|
206
|
+
NOSJ.splice(json, "/config/timeout" => 30)
|
|
207
|
+
NOSJ.splice(json, "/a" => 1, "/b/c" => [true]) # batch, one pass
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
On top of the same machinery: **RFC 6902 JSON Patch** applied to the
|
|
211
|
+
raw string (`add`, `remove`, `replace`, `move`, `copy`, `test`—the
|
|
212
|
+
whole appendix-A suite is in the specs), and **RFC 7386 JSON Merge
|
|
213
|
+
Patch**:
|
|
214
|
+
|
|
215
|
+
```ruby
|
|
216
|
+
NOSJ.patch(json, [
|
|
217
|
+
{"op" => "test", "path" => "/a", "value" => 1},
|
|
218
|
+
{"op" => "replace", "path" => "/a", "value" => 2},
|
|
219
|
+
{"op" => "add", "path" => "/list/-", "value" => "x"}
|
|
220
|
+
])
|
|
221
|
+
NOSJ.merge_patch(json, {"config" => {"legacy" => nil, "timeout" => 30}})
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
Missing splice targets raise `KeyError` (use `patch` `add` to
|
|
225
|
+
insert); failed patches raise `NOSJ::PatchError`; inserted values are
|
|
226
|
+
byte-identical to `NOSJ.generate`'s output.
|
|
227
|
+
|
|
228
|
+
### NDJSON / JSON Lines
|
|
229
|
+
|
|
230
|
+
Logs, data pipelines, LLM batch files—one JSON document per line.
|
|
231
|
+
`NOSJ.each_line` streams values out (1.6× faster than the
|
|
232
|
+
line-split-and-`JSON.parse` idiom on twitter statuses), and
|
|
233
|
+
`NOSJ.generate_lines` builds the whole stream in one buffer pass
|
|
234
|
+
(4.1× faster than map-generate-join):
|
|
235
|
+
|
|
236
|
+
```ruby
|
|
237
|
+
NOSJ.each_line(log) { |event| ingest(event) } # or an Enumerator:
|
|
238
|
+
NOSJ.each_line(log).first(10) # walks only 10 lines
|
|
239
|
+
|
|
240
|
+
NOSJ.generate_lines(events) #=> %({"a":1}\n{"b":2}\n...)
|
|
241
|
+
NOSJ.each_line_file("events.ndjson") { |e| } # over a memory map
|
|
242
|
+
NOSJ.write_lines("out.ndjson", events) # straight to disk
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
Blank lines are skipped, one value per line is enforced, and a
|
|
246
|
+
malformed line raises a [rich `ParserError`](#rich-parse-errors) whose
|
|
247
|
+
`#line` is the physical line in the stream. Parse options apply per
|
|
248
|
+
line—`NOSJ.each_line(log, freeze: true)` yields Ractor-shareable
|
|
249
|
+
values.
|
|
250
|
+
|
|
251
|
+
### Validation without parsing
|
|
252
|
+
|
|
253
|
+
`NOSJ.valid?` runs the full parser—tokenizers, string decode,
|
|
254
|
+
number validation—into a null sink and allocates no Ruby objects
|
|
255
|
+
at all. It is 2-4× faster than `NOSJ.parse`:
|
|
145
256
|
|
|
146
257
|
```ruby
|
|
147
258
|
NOSJ.valid?('{"a":1}') #=> true
|
|
@@ -149,6 +260,46 @@ NOSJ.valid?('{"a":}') #=> false
|
|
|
149
260
|
NOSJ.valid?(src, max_nesting: false) # same options as parse
|
|
150
261
|
```
|
|
151
262
|
|
|
263
|
+
### Document statistics
|
|
264
|
+
|
|
265
|
+
`NOSJ.stats` answers "what is this 40 MB blob": one counting pass
|
|
266
|
+
through the same null-sink machinery—no Ruby value is built for
|
|
267
|
+
the document, and it costs _less_ than a parse (~1.3× faster on `twitter.json`):
|
|
268
|
+
|
|
269
|
+
```ruby
|
|
270
|
+
s = NOSJ.stats(blob) # or NOSJ.stats_file("huge.json")
|
|
271
|
+
s[:byte_size] #=> 631514
|
|
272
|
+
s[:root] #=> :object
|
|
273
|
+
s[:max_depth] #=> 10
|
|
274
|
+
s[:values] #=> {total: 13914, objects: 1264, arrays: 1050,
|
|
275
|
+
# strings: 4754, integers: 2108, ...}
|
|
276
|
+
s[:keys] #=> {total: 13345, unique: 94}
|
|
277
|
+
s[:key_histogram].first(3) #=> [["id", 447], ["id_str", 447], ["urls", 364]]
|
|
278
|
+
s[:containers] #=> {max_object_entries: 40, max_array_length: 100}
|
|
279
|
+
s[:strings] #=> {bytes: 200716, max_bytes: 463}
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
Nesting is unlimited by default (a deep blob is exactly what a
|
|
283
|
+
diagnostic should describe); malformed documents raise the usual rich
|
|
284
|
+
`ParserError`.
|
|
285
|
+
|
|
286
|
+
### Rich parse errors
|
|
287
|
+
|
|
288
|
+
A failed parse raises `NOSJ::ParserError`
|
|
289
|
+
carrying where the document broke—`#byte_offset`, `#line`, `#column`,
|
|
290
|
+
and a caret `#snippet`—computed only when a parse fails, so success
|
|
291
|
+
pays nothing. Positions stay absolute through partial parsing, lazy
|
|
292
|
+
documents, and the file APIs; unrescued errors print the snippet:
|
|
293
|
+
|
|
294
|
+
```ruby
|
|
295
|
+
NOSJ.parse(%({\n "a": 1,\n "b": }))
|
|
296
|
+
# NOSJ::ParserError: unexpected character at byte 19
|
|
297
|
+
# e.line #=> 3
|
|
298
|
+
# e.column #=> 8
|
|
299
|
+
# e.snippet #=> "b": }
|
|
300
|
+
# ^
|
|
301
|
+
```
|
|
302
|
+
|
|
152
303
|
## Benchmarks
|
|
153
304
|
|
|
154
305
|
Every installed JSON gem, benchmark-ips: AWS EC2 c7a.2xlarge (AMD EPYC 9R14, Zen 4), Ruby 4.0.6 + YJIT, json 2.21.1, Oj 3.17.4, RapidJSON 0.4.0, FastJsonparser 0.6.0, Yajl 1.4.3, PGO build, 2026-07-16. `×N` = times slower than nosj.
|
|
@@ -209,6 +360,27 @@ Silicon dev box, Ruby 4.0.6 + YJIT, PGO build, 2026-07-16):
|
|
|
209
360
|
too much for an honest multiplier; what it saves is the intermediate
|
|
210
361
|
file-sized Ruby String.
|
|
211
362
|
|
|
363
|
+
### Rails mode
|
|
364
|
+
|
|
365
|
+
`ActiveSupport::JSON.encode` with the nosj encoder installed, against
|
|
366
|
+
stock ActiveSupport (Apple Silicon dev box, Ruby 4.0.6 + YJIT,
|
|
367
|
+
activesupport 8.1, medians of 5 interleaved per-process rounds,
|
|
368
|
+
outputs verified byte-identical first, 2026-07-17;
|
|
369
|
+
`rake bench:rails`):
|
|
370
|
+
|
|
371
|
+
| workload | nosj (i/s) | vs ActiveSupport |
|
|
372
|
+
|---|---:|---|
|
|
373
|
+
| twitter tree (570 KB) | 4.5k | ×5.2 |
|
|
374
|
+
| 100-record index (with timestamps) | 33.7k | ×1.7 |
|
|
375
|
+
| HTML-heavy user content | 177.7k | ×14.2 |
|
|
376
|
+
| Time/Date/BigDecimal hash | 1.1M | ×3.0 |
|
|
377
|
+
| small API hash | 4.2M | ×1.9 |
|
|
378
|
+
| small hash `to_json` | 4.1M | ×1.9 |
|
|
379
|
+
|
|
380
|
+
The HTML-safety escaping that dominates stock encodes of
|
|
381
|
+
user-generated content is fused into the SIMD string-emission kernels
|
|
382
|
+
here: escaped output costs the same single pass as unescaped.
|
|
383
|
+
|
|
212
384
|
Reproduce with `rake bench` (the parity-gated comparison, after a PGO retrain—the shipping configuration) or `rake bench:ips` (the multi-gem shoot-out).
|
|
213
385
|
|
|
214
386
|
## Switching from the json gem
|
|
@@ -222,8 +394,10 @@ You mostly don't have to do anything. Some differences:
|
|
|
222
394
|
UTF-8) follow the strict semantics instead.
|
|
223
395
|
- Unlike `Array#dig`, negative indices in `NOSJ.dig` return nil (JSON
|
|
224
396
|
Pointer has no equivalent).
|
|
225
|
-
- Parse
|
|
226
|
-
|
|
397
|
+
- Parse errors raise `NOSJ::ParserError` (`NOSJ::NestingError` past
|
|
398
|
+
`max_nesting`, like the gem); messages use byte offsets rather than
|
|
399
|
+
the gem's phrasing, and the exception carries `#line`, `#column`,
|
|
400
|
+
and a caret `#snippet`.
|
|
227
401
|
|
|
228
402
|
Everything else—including the gem's exact float formatting, which is
|
|
229
403
|
not the shortest-round-trip form most libraries emit—matches
|
|
@@ -260,6 +434,33 @@ bundle exec rake bench:fast # the sweep without retraining
|
|
|
260
434
|
bundle exec rake "bench:ips[twitter]" # multi-gem shoot-out (benchmark-ips); no args = full corpus
|
|
261
435
|
```
|
|
262
436
|
|
|
437
|
+
The native layer is differentially fuzzed on an embedded VM
|
|
438
|
+
(reformat pipe, NDJSON framing, splice/patch span arithmetic against
|
|
439
|
+
pure-Ruby reference implementations)—see
|
|
440
|
+
[ext/nosj/fuzz/README.md](ext/nosj/fuzz/README.md).
|
|
441
|
+
|
|
442
|
+
## Acknowledgements
|
|
443
|
+
|
|
444
|
+
Thanks to [Jean Boussier](https://github.com/byroot), [Florian Frank](https://github.com/flori), [Hiroshi Shibata](https://github.com/hsbt), [Nobuyoshi Nakada](https://github.com/nobu), [Étienne Barrié](https://github.com/etiennebarrie), and the other authors and maintainers of the [json gem](https://github.com/ruby/json)—for their work on the gem itself, for optimization ideas, and for some of the JSON documents in the benchmark corpus.
|
|
445
|
+
|
|
446
|
+
Thanks to [Mat Sadler](https://github.com/matsadler) for [magnus](https://github.com/matsadler/magnus).
|
|
447
|
+
|
|
448
|
+
Thanks to the authors of the projects credited in [NOTICE](NOTICE) and the
|
|
449
|
+
crate's NOTICE: [fpconv](https://github.com/night-shift/fpconv) and
|
|
450
|
+
Florian Loitsch's Grisu2,
|
|
451
|
+
[fast_float](https://github.com/fastfloat/fast_float) and
|
|
452
|
+
[fast_double_parser](https://github.com/lemire/fast_double_parser)
|
|
453
|
+
(Daniel Lemire et al.),
|
|
454
|
+
[simdjson](https://github.com/simdjson/simdjson) (Daniel Lemire, Geoff
|
|
455
|
+
Langdale, and contributors), and the architectural lineage of
|
|
456
|
+
[yyjson](https://github.com/ibireme/yyjson),
|
|
457
|
+
[simd-json](https://github.com/simd-lite/simd-json), and
|
|
458
|
+
[sonic-rs](https://github.com/cloudwego/sonic-rs).
|
|
459
|
+
|
|
460
|
+
## Assisted by
|
|
461
|
+
|
|
462
|
+
Claude Fable 5, Claude Opus 4.8.
|
|
463
|
+
|
|
263
464
|
## License
|
|
264
465
|
|
|
265
466
|
MIT. The underlying Rust crate is `MIT AND BSL-1.0 AND Apache-2.0`; its
|
data/ext/nosj/Cargo.toml
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
# required by lib/nosj.rb as "nosj/nosj" (Init_nosj set explicitly in
|
|
6
6
|
# lib.rs). Gem name, module, and API are plain nosj.
|
|
7
7
|
name = "nosj_native"
|
|
8
|
-
version = "0.
|
|
8
|
+
version = "0.3.1"
|
|
9
9
|
edition = "2021"
|
|
10
10
|
authors = ["Yaroslav Markin <yaroslav@markin.net>"]
|
|
11
11
|
license = "MIT"
|
|
@@ -25,4 +25,4 @@ memmap2 = "0.9"
|
|
|
25
25
|
# First-party SIMD JSON parse/generate library (github.com/yaroslav/nosj).
|
|
26
26
|
# For coordinated crate+gem work, temporarily flip to
|
|
27
27
|
# { path = "../../../nosj" } and restore before any commit or release.
|
|
28
|
-
nosj = "0.
|
|
28
|
+
nosj = "0.2.0"
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
[package]
|
|
2
|
+
name = "nosj-ruby-fuzz"
|
|
3
|
+
version = "0.0.0"
|
|
4
|
+
publish = false
|
|
5
|
+
edition = "2021"
|
|
6
|
+
|
|
7
|
+
[package.metadata]
|
|
8
|
+
cargo-fuzz = true
|
|
9
|
+
|
|
10
|
+
[dependencies]
|
|
11
|
+
libfuzzer-sys = "0.4"
|
|
12
|
+
# Must match the extension's own magnus line so cargo unifies the
|
|
13
|
+
# rb-sys link (one libruby, one VM).
|
|
14
|
+
magnus = { git = "https://github.com/matsadler/magnus", features = ["embed", "rb-sys"] }
|
|
15
|
+
# The extension as an rlib; its lib target is named `nosj` (the bundle
|
|
16
|
+
# name), so rename the dependency to keep fuzz code readable.
|
|
17
|
+
nosj_ext = { path = "..", package = "nosj_native" }
|
|
18
|
+
|
|
19
|
+
# Prevent this from being interpreted as part of a parent workspace.
|
|
20
|
+
[workspace]
|
|
21
|
+
|
|
22
|
+
[[bin]]
|
|
23
|
+
name = "reformat"
|
|
24
|
+
path = "fuzz_targets/reformat.rs"
|
|
25
|
+
test = false
|
|
26
|
+
doc = false
|
|
27
|
+
bench = false
|
|
28
|
+
|
|
29
|
+
[[bin]]
|
|
30
|
+
name = "lines"
|
|
31
|
+
path = "fuzz_targets/lines.rs"
|
|
32
|
+
test = false
|
|
33
|
+
doc = false
|
|
34
|
+
bench = false
|
|
35
|
+
|
|
36
|
+
[[bin]]
|
|
37
|
+
name = "patch"
|
|
38
|
+
path = "fuzz_targets/patch.rs"
|
|
39
|
+
test = false
|
|
40
|
+
doc = false
|
|
41
|
+
bench = false
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
//! Byte-splicing edits and RFC 6902 patch vs a pure-Ruby tree
|
|
2
|
+
//! reference. Input is "document \0 spec": an object spec drives
|
|
3
|
+
//! splice, an array spec drives patch.
|
|
4
|
+
#![no_main]
|
|
5
|
+
|
|
6
|
+
use libfuzzer_sys::fuzz_target;
|
|
7
|
+
|
|
8
|
+
fuzz_target!(|data: &[u8]| {
|
|
9
|
+
nosj_ruby_fuzz::drive("patch_case", data);
|
|
10
|
+
});
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
//! Reformat pipe vs whole-document parse: acceptance must agree
|
|
2
|
+
//! (valid?/stats included), minify must round-trip and be idempotent,
|
|
3
|
+
//! pretty must round-trip.
|
|
4
|
+
#![no_main]
|
|
5
|
+
|
|
6
|
+
use libfuzzer_sys::fuzz_target;
|
|
7
|
+
|
|
8
|
+
fuzz_target!(|data: &[u8]| {
|
|
9
|
+
nosj_ruby_fuzz::drive("reformat_case", data);
|
|
10
|
+
});
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
//! Shared harness for the extension fuzz targets: boot one embedded
|
|
2
|
+
//! Ruby VM per process, register the extension exactly as `require
|
|
3
|
+
//! "nosj/nosj"` would, and load the Ruby-side differential checks.
|
|
4
|
+
//!
|
|
5
|
+
//! The targets exercise the gem-side byte-manipulation layers the
|
|
6
|
+
//! parser crate's own fuzzers never see (reformat, NDJSON framing,
|
|
7
|
+
//! splice/patch span arithmetic). The checking logic lives in
|
|
8
|
+
//! prelude.rb; a raised Ruby exception surfaces here as an Err and
|
|
9
|
+
//! aborts the run.
|
|
10
|
+
|
|
11
|
+
use std::sync::Once;
|
|
12
|
+
|
|
13
|
+
use magnus::prelude::*;
|
|
14
|
+
use magnus::{RModule, Ruby, Value};
|
|
15
|
+
|
|
16
|
+
static VM: Once = Once::new();
|
|
17
|
+
|
|
18
|
+
const PRELUDE: &str = include_str!("prelude.rb");
|
|
19
|
+
|
|
20
|
+
/// Run one fuzz iteration with the VM up and the checks defined.
|
|
21
|
+
/// libFuzzer drives every input on the same thread, which is the
|
|
22
|
+
/// thread the VM was initialized on.
|
|
23
|
+
pub fn with_vm<F: FnOnce(&Ruby, RModule)>(f: F) {
|
|
24
|
+
VM.call_once(|| {
|
|
25
|
+
let cluster = unsafe { magnus::embed::init() };
|
|
26
|
+
// The VM must outlive every future iteration.
|
|
27
|
+
std::mem::forget(cluster);
|
|
28
|
+
let ruby = Ruby::get().expect("VM just initialized on this thread");
|
|
29
|
+
unsafe { nosj_ext::Init_nosj() };
|
|
30
|
+
ruby.eval::<Value>(PRELUDE).expect("fuzz prelude must load");
|
|
31
|
+
});
|
|
32
|
+
let ruby = Ruby::get().expect("fuzz iterations run on the VM thread");
|
|
33
|
+
let checks = ruby
|
|
34
|
+
.define_module("NOSJFuzz")
|
|
35
|
+
.expect("prelude defines NOSJFuzz");
|
|
36
|
+
f(&ruby, checks);
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
/// Feed raw bytes to a single-argument check; any raised exception
|
|
40
|
+
/// (an assertion failure or an unexpected error class) aborts.
|
|
41
|
+
pub fn drive(check: &str, data: &[u8]) {
|
|
42
|
+
with_vm(|ruby, checks| {
|
|
43
|
+
let input = ruby.str_from_slice(data);
|
|
44
|
+
if let Err(e) = checks.funcall::<_, _, Value>(check, (input,)) {
|
|
45
|
+
panic!("{check}: {e}");
|
|
46
|
+
}
|
|
47
|
+
});
|
|
48
|
+
}
|