File: projection.rb

package info (click to toggle)
ruby-yajl 1.4.3-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 4,036 kB
  • sloc: ansic: 3,068; ruby: 2,619; makefile: 4; sh: 3
file content (498 lines) | stat: -rw-r--r-- 12,011 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')

require 'stringio'
require 'json'

describe "projection" do
  it "should work" do
    stream = StringIO.new('{"name": "keith", "age": 27}')
    projector = Yajl::Projector.new(stream)
    projection = projector.project({"name" => nil})
    expect(projection['name']).to eql("keith")
  end

  it "should filter" do
    stream = StringIO.new('{"name": "keith", "age": 27}')
    projector = Yajl::Projector.new(stream)
    projection = projector.project({"name" => nil})
    expect(projection['age']).to eql(nil)
  end

  it "should raise an exception and not leak memory" do
    stream = StringIO.new('foo')
    projector = Yajl::Projector.new(stream)
    expect {
      projector.project({"name" => nil})
    }.to raise_error(Yajl::ParseError)
  end

  it "should raise an exception and not segv" do
    stream = StringIO.new('[,,,,]')
    projector = Yajl::Projector.new(stream)
    expect {
      projector.project({"name" => nil})
    }.to raise_error(Yajl::ParseError)
  end

  it "should raise an exception and not segv on colons" do
    stream = StringIO.new('[::::]')
    projector = Yajl::Projector.new(stream)
    expect {
      projector.project({"name" => nil})
    }.to raise_error(Yajl::ParseError)
  end

  it "should behave the same way as the regular parser on bad tokens like comma" do
    bad_json = '{"name": "keith", "age":, 27}'
    stream = StringIO.new(bad_json)
    projector = Yajl::Projector.new(stream)
    expect {
      projector.project({"name" => nil})
    }.to raise_error(capture_exception_for(bad_json).class)
  end

  it "should behave the same way as the regular parser on bad tokens like colon" do
    bad_json = '{"name": "keith", "age":: 27}'
    stream = StringIO.new(bad_json)
    projector = Yajl::Projector.new(stream)
    expect {
      projector.project({"name" => nil})
    }.to raise_error(capture_exception_for(bad_json).class)
  end

  it "should behave the same way as the regular parser on not enough json" do
    bad_json = '{"name": "keith", "age":'
    stream = StringIO.new(bad_json)
    projector = Yajl::Projector.new(stream)
    expect {
      projector.project({"name" => nil})
    }.to raise_error(capture_exception_for(bad_json).class)
  end

  def capture_exception_for(bad_json)
    Yajl::Parser.new.parse(bad_json)
  rescue Exception => e
    e
  end

  def project(schema, over: "", json: nil, stream: nil)
    if stream.nil?
      if json.nil?
        json = over.to_json
      end

      stream = StringIO.new(json)
    end

    Yajl::Projector.new(stream).project(schema)
  end

  it "filters arrays" do
    json = {
      "users" => [
        {
          "name" => "keith",
          "company" => "internet plumbing inc",
          "department" => "janitorial",
        },
        {
          "name" => "justin",
          "company" => "big blue",
          "department" => "programming?",
        },
        {
          "name" => "alan",
          "company" => "different colour of blue",
          "department" => "drop bear containment",
        }
      ]
    }.to_json

    puts json

    schema = {
      # /users is an array of objects, each having many keys we only want name
      "users" => {
        "name" => nil,
      }
    }

    expect(project(schema, json: json)).to eql({
      "users" => [
        { "name" => "keith" },
        { "name" => "justin" },
        { "name" => "alan" }
      ]
    })
  end

  it "filters top level arrays" do
    json = [
      {
        "name" => "keith",
        "personal detail" => "thing",
      },
      {
        "name" => "cory",
        "phone number" => "unknown",
      }
    ]

    schema = {
      "name" => nil,
    }

    expect(project(schema, over: json)).to eql([
      { "name" => "keith" },
      { "name" => "cory" },
    ])
  end

  it "filters nested schemas" do
    json = {
      "foo" => 42,

      "bar" => {
        "name" => "keith",
        "occupation" => "professional computering",
        "age" => 26,
        "hobbies" => [
          "not computering",
        ]
      },

      "qux" => {
        "quux" => [
          {
            "name" => "Reactive X",
            "members" => "many",
          },
          {
            "name" => "lstoll",
            "members" => "such",
          },
          {
            "name" => "github",
            "members" => "very",
          },
          {
            "name" => "theleague",
            "members" => "numerous",
          }
        ],

        "corge" => {
          "name" => "Brighton",
          "address" =>"Buckingham Road",
        },
      },

      "grault" => nil,

      "waldo" => true,
    }

    schema = {
      # include the /foo subtree (is a single number)
      "foo" => nil,

      # ignore the bar subtree (is an object)
      # "bar" => ???

      # include some of the /qux subtree (is an object)
      "qux" => {
        # include the whole /qux/quux subtree (is an array of objects)
        "quux" => nil,

        # include some of the /qux/corge subtree (is another object)
        "corge" => {
          # include name (is a string)
          "name" => nil,
          # include age (is missing from source doc)
          "age" => nil,
          # ignore address
          # "address" => ???
        },
      },

      # include the /grault subtree (is a null literal)
      "grault" => nil,

      # include the /waldo subtree (is a boolean literal)
      "waldo" => nil,
    }

    expect(project(schema, over: json)).to eql({
      "foo" => 42,

      "qux" => {
        "quux" => [
          {
            "name" => "Reactive X",
            "members" => "many",
          },
          {
            "name" => "lstoll",
            "members" => "such",
          },
          {
            "name" => "github",
            "members" => "very",
          },
          {
            "name" => "theleague",
            "members" => "numerous",
          }
        ],

        "corge" => {
          "name" => "Brighton",
        },
      },

      "grault" => nil,

      "waldo" => true,
    })
  end

  it "supports incompatible schemas" do
    json = {
      # surprise! the json doesn't include an object under the foo key
      "foo" => 42,
    }

    schema = {
      # include some of the /foo subtree
      "foo" => {
        # include the whole /foo/baz subtree
        "baz" => nil,
      }
    }

    # expect the 42 to be pulled out
    expect(project(schema, over: json)).to eql({
      "foo" => 42
    })
  end

  it "supports nil schema" do
    json = {
      "foo" => "bar",
    }

    expect(project(nil, over: json)).to eql({
      "foo" => "bar"
    })
  end

  it "supports empty schema" do
    json = {
      "foo" => "bar",
    }
    expect(project({}, over: json)).to eql({})
  end

  it "supports object projection" do
    json = {
      "foo" => "bar",
      "qux" => "quux",
    }

    schema = {
      "foo" => nil,
    }

    expect(project(schema, over: json)).to eql({
      "foo" => "bar"
    })
  end

  it "projects the readme example" do
    json = <<-EOJ
    [
      {
        "user": {
          "name": "keith",
          "age": 26,
          "jobs": [
            {
              "title": "director of overworking",
              "company": "south coast software",
              "department": "most"
            },
            {
              "title": "some kind of computering",
              "company": "github the website dot com",
              "department": true
            }
          ]
        },
        "another key": {

        },
        "woah this document is huge": {

        },
        "many megabytes": {

        },
        "etc": {

        }
      }
    ]
EOJ

    schema = {
      "user" => {
        "name" => nil,
        "jobs" => {
          "title" => nil,
        },
      },
    }

    expect(project(schema, json: json)).to eql([{
      "user" => {
        "name" => "keith",
        "jobs" => [
          { "title" => "director of overworking" },
          { "title" => "some kind of computering" },
        ]
      }
    }])
  end

  it "errors with invalid json" do
    expect {
      project({"b" => nil}, json: '{"a":, "b": 2}')
    }.to raise_error(StandardError)
  end

  it "errors with ignored unbalanced object syntax" do
    expect {
      project({"b" => nil}, json: '{"a": {{, "b": 2}')
    }.to raise_error(StandardError)
  end

  it "errors with accepted unbalanced object tokens" do
    expect {
      project({"a" => nil}, json: '{"a": {"b": 2}')
    }.to raise_error(Yajl::ParseError)
  end

  it "errors when projecting if an object comma is missing" do
    expect {
      project({"a" => nil}, json: '{"a": 1 "b": 2}')
    }.to raise_error(Yajl::ParseError)
  end

  it "errors when building if an object comma is missing" do
    expect {
      project(nil, json: '{"a": {"b": 2 "c": 3}}')
    }.to raise_error(Yajl::ParseError)
  end

  it "errors when eof instead of simple value" do
    expect {
      project(nil, json: '[')
    }.to raise_error(Yajl::ParseError)
  end

  it "errors when arrays don't have a comma between elements" do
    expect {
      project(nil, json: '[1 2]')
    }.to raise_error(Yajl::ParseError)
  end

  it "supports parsing empty array" do
    expect(project(nil, json: '[]')).to eql([])
  end

  it "supports parsing empty object" do
    expect(project(nil, json: '{}')).to eql({})
  end

  it "reads a full buffer" do
    json = "[" + "1,"*2046 + "1 ]"
    expect(json.size).to eql(4096)
    expect(project(nil, json: json)).to eql(Array.new(2047, 1))
  end

  it "reads into a second buffer" do
    json = "[" + "1,"*2047 + "1 ]"
    expect(json.size).to eql(4098)
    expect(JSON.parse(json)).to eql(Array.new(2048, 1))
    expect(project(nil, json: json)).to eql(Array.new(2048, 1))
  end

  it "supports parsing big strings" do
    json = [
      "a",
      "b"*10_000,
      "c",
    ]
    expect(project(nil, over: json)).to eql(json)
  end

  it "supports bigger read buffers" do
    json = {
      "a"*10_000 => "b"*10_000
    }.to_json
    stream = StringIO.new(json)
    expect(Yajl::Projector.new(stream, 8192).project(nil)).to have_key("a"*10_000)
  end

  it "errors if starting with closing object" do
    expect {
      project(nil, json: '}')
    }.to raise_error(Yajl::ParseError)
  end

  it "handles objects with utf16 escape sequences as keys" do
    projection = project(nil, json: '{"\ud83d\ude00": "grinning face"}')
    literal = {"😀" => "grinning face"}
    expect(projection).to eql(literal)
  end

  it "handles objects with non-ascii utf8 bytes as keys" do
    expect(project(nil, json: '{"😀": "grinning face"}')).to eql({"😀" => "grinning face"})
  end

  it "handles strings with utf16 escape sequences as object values" do
    expect(project(nil, json: '{"grinning face": "\ud83d\ude00"}')).to eql({"grinning face" => "😀"})
  end

  it "handles strings with utf16 escape sequences as array values" do
    projection = project(nil, json: '["\ud83d\ude00"]')
    puts projection.first.inspect
    puts projection.first.bytes

    literal = ["😀"]
    puts literal.first.inspect
    puts literal.first.bytes

    expect(projection).to eql(literal)
  end

  it "handles strings with non-ascii utf8 bytes as array values" do
    projection = project(nil, json: '["😀"]')
    puts projection.first.inspect
    puts projection.first.bytes

    literal = ["😀"]
    puts literal.first.inspect
    puts literal.first.bytes

    expect(projection).to eql(literal)
  end

  it "ignores strings with utf16 escape sequences" do
    expect(project({"grinning face with open mouth" => nil}, json: '{"grinning face": "\ud83d\ude00", "grinning face with open mouth": "\ud83d\ude03"}')).to eql({"grinning face with open mouth" => "😃"})
  end

  it "handles objects whose second key has escape sequences" do
    expect(project(nil, json: '{"foo": "bar", "\ud83d\ude00": "grinning face"}')).to eql({"foo" => "bar", "😀" => "grinning face"})
  end
end