bson 4.2.0.rc1 → 4.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (55) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +1 -4
  3. data.tar.gz.sig +0 -0
  4. data/lib/bson/array.rb +1 -1
  5. data/lib/bson/binary.rb +4 -2
  6. data/lib/bson/code.rb +1 -1
  7. data/lib/bson/code_with_scope.rb +1 -1
  8. data/lib/bson/date.rb +1 -1
  9. data/lib/bson/date_time.rb +1 -1
  10. data/lib/bson/decimal128.rb +1 -1
  11. data/lib/bson/false_class.rb +1 -1
  12. data/lib/bson/float.rb +1 -1
  13. data/lib/bson/hash.rb +1 -1
  14. data/lib/bson/integer.rb +1 -1
  15. data/lib/bson/object_id.rb +1 -1
  16. data/lib/bson/open_struct.rb +1 -1
  17. data/lib/bson/regexp.rb +86 -18
  18. data/lib/bson/specialized.rb +1 -1
  19. data/lib/bson/string.rb +1 -1
  20. data/lib/bson/symbol.rb +1 -1
  21. data/lib/bson/time.rb +1 -1
  22. data/lib/bson/timestamp.rb +1 -1
  23. data/lib/bson/true_class.rb +1 -1
  24. data/lib/bson/version.rb +1 -1
  25. data/spec/bson/array_spec.rb +1 -1
  26. data/spec/bson/binary_spec.rb +2 -1
  27. data/spec/bson/corpus_spec.rb +68 -0
  28. data/spec/bson/raw_spec.rb +540 -0
  29. data/spec/bson/regexp_spec.rb +7 -7
  30. data/spec/spec_helper.rb +1 -0
  31. data/spec/support/corpus-tests/array.json +43 -0
  32. data/spec/support/corpus-tests/boolean.json +27 -0
  33. data/spec/support/corpus-tests/code.json +67 -0
  34. data/spec/support/corpus-tests/code_w_scope.json +78 -0
  35. data/spec/support/corpus-tests/document.json +36 -0
  36. data/spec/support/corpus-tests/double.json +69 -0
  37. data/spec/support/corpus-tests/failures/binary.json +69 -0
  38. data/spec/support/corpus-tests/failures/datetime.json +31 -0
  39. data/spec/support/corpus-tests/failures/dbpointer.json +42 -0
  40. data/spec/support/corpus-tests/failures/int64.json +38 -0
  41. data/spec/support/corpus-tests/failures/symbol.json +62 -0
  42. data/spec/support/corpus-tests/failures/undefined.json +13 -0
  43. data/spec/support/corpus-tests/int32.json +38 -0
  44. data/spec/support/corpus-tests/maxkey.json +12 -0
  45. data/spec/support/corpus-tests/minkey.json +12 -0
  46. data/spec/support/corpus-tests/null.json +12 -0
  47. data/spec/support/corpus-tests/oid.json +28 -0
  48. data/spec/support/corpus-tests/regex.json +37 -0
  49. data/spec/support/corpus-tests/string.json +67 -0
  50. data/spec/support/corpus-tests/timestamp.json +18 -0
  51. data/spec/support/corpus-tests/top.json +62 -0
  52. data/spec/support/corpus.rb +265 -0
  53. data/spec/support/shared_examples.rb +1 -1
  54. metadata +51 -3
  55. metadata.gz.sig +0 -0
data/spec/support/corpus.rb ADDED
@@ -0,0 +1,265 @@
1
+ # Copyright (C) 2016 MongoDB, Inc.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'json'
16
+
17
+ module BSON
18
+ module Corpus
19
+
20
+ # Represents a test from the driver BSON Corpus.
21
+ #
22
+ # @since 4.2.0
23
+ class Spec
24
+
25
+ # The spec description.
26
+ #
27
+ # @return [ String ] The spec description.
28
+ #
29
+ # @since 4.2.0
30
+ attr_reader :description
31
+
32
+ # The document key of the object to test.
33
+ #
34
+ # @return [ String ] The document key.
35
+ #
36
+ # @since 4.2.0
37
+ attr_reader :test_key
38
+
39
+ # Instantiate the new spec.
40
+ #
41
+ # @example Create the spec.
42
+ # Spec.new(file)
43
+ #
44
+ # @param [ String ] file The name of the json file.
45
+ #
46
+ # @since 4.2.0
47
+ def initialize(file)
48
+ @spec = ::JSON.parse(File.read(file))
49
+ @valid = @spec['valid'] || []
50
+ @invalid = @spec['decodeErrors'] || []
51
+ @description = @spec['description']
52
+ @test_key = @spec['test_key']
53
+ end
54
+
55
+ # Get a list of tests that are expected to pass.
56
+ #
57
+ # @example Get the list of valid tests.
58
+ # spec.valid_tests
59
+ #
60
+ # @return [ Array<BSON::Corpus::Test> ] The list of valid Tests.
61
+ #
62
+ # @since 4.2.0
63
+ def valid_tests
64
+ @valid_tests ||=
65
+ @valid.collect do |test|
66
+ BSON::Corpus::Test.new(self, test)
67
+ end
68
+ end
69
+
70
+ # Get a list of tests that raise exceptions.
71
+ #
72
+ # @example Get the list of invalid tests.
73
+ # spec.invalid_tests
74
+ #
75
+ # @return [ Array<BSON::Corpus::Test> ] The list of invalid Tests.
76
+ #
77
+ # @since 4.2.0
78
+ def invalid_tests
79
+ @invalid_tests ||=
80
+ @invalid.collect do |test|
81
+ BSON::Corpus::Test.new(self, test)
82
+ end
83
+ end
84
+
85
+ # The class of the bson object to test.
86
+ #
87
+ # @example Get the class of the object to test.
88
+ # spec.klass
89
+ #
90
+ # @return [ Class ] The object class.
91
+ #
92
+ # @since 4.2.0
93
+ def klass
94
+ @klass ||= BSON.const_get(description)
95
+ end
96
+ end
97
+
98
+ # Represents a single BSON Corpus test.
99
+ #
100
+ # @since 4.2.0
101
+ class Test
102
+
103
+ # The test description.
104
+ #
105
+ # @return [ String ] The test description.
106
+ #
107
+ # @since 4.2.0
108
+ attr_reader :description
109
+
110
+ # Name of a field in a valid test case extjson document that should be
111
+ # checked against the case's string field.
112
+ #
113
+ # @return [ String ] The json representation of the object.
114
+ #
115
+ # @since 4.2.0
116
+ attr_reader :test_key
117
+
118
+ # Instantiate the new Test.
119
+ #
120
+ # @example Create the test.
121
+ # Test.new(test)
122
+ #
123
+ # @param [ Corpus::Spec ] spec The test specification.
124
+ # @param [ Hash ] test The test specification.
125
+ #
126
+ # @since 4.2.0
127
+ def initialize(spec, test)
128
+ @spec = spec
129
+ @description = test['description']
130
+ @canonical_bson = test['canonical_bson']
131
+ @extjson = ::JSON.parse(test['extjson']) if test['extjson']
132
+ @bson = test['bson']
133
+ @test_key = spec.test_key
134
+ end
135
+
136
+ # The correct representation of the subject as bson.
137
+ #
138
+ # @example Get the correct representation of the subject as bson.
139
+ # test.correct_bson
140
+ #
141
+ # @return [ String ] The correct bson bytes.
142
+ #
143
+ # @since 4.2.0
144
+ def correct_bson
145
+ @correct_bson ||= decode_hex(@canonical_bson || @bson)
146
+ end
147
+
148
+ # Given the hex representation of bson, decode it into a Document,
149
+ # then reencoded it to bson.
150
+ #
151
+ # @example Decoded the bson hex representation, then reencode.
152
+ # test.reencoded_bson
153
+ #
154
+ # @return [ String ] The reencoded bson bytes.
155
+ #
156
+ # @since 4.2.0
157
+ def reencoded_bson
158
+ bson_bytes = decode_hex(@bson)
159
+ buffer = BSON::ByteBuffer.new(bson_bytes)
160
+ BSON::Document.from_bson(buffer).to_bson.to_s
161
+ end
162
+
163
+ # Given the hex representation of the canonical bson, decode it into a Document,
164
+ # then reencoded it to bson.
165
+ #
166
+ # @example Decoded the canonical bson hex representation, then reencode.
167
+ # test.reencoded_canonical_bson
168
+ #
169
+ # @return [ String ] The reencoded canonical bson bytes.
170
+ #
171
+ # @since 4.2.0
172
+ def reencoded_canonical_bson
173
+ bson_bytes = decode_hex(@canonical_bson)
174
+ buffer = BSON::ByteBuffer.new(bson_bytes)
175
+ BSON::Document.from_bson(buffer).to_bson.to_s
176
+ end
177
+
178
+ # Whether the canonical bson should be tested.
179
+ #
180
+ # @example Determine if the canonical bson should be tested.
181
+ # test.test_canonical_bson?
182
+ #
183
+ # @return [ true, false ] Whether the canonical bson should be tested.
184
+ #
185
+ # @since 4.2.0
186
+ def test_canonical_bson?
187
+ @canonical_bson && (@bson != @canonical_bson)
188
+ end
189
+
190
+ # The correct representation of the subject as extended json.
191
+ #
192
+ # @example Get the correct representation of the subject as extended json.
193
+ # test.correct_extjson
194
+ #
195
+ # @return [ String ] The correct extended json representation.
196
+ #
197
+ # @since 4.2.0
198
+ def correct_extjson
199
+ @canonical_extjson || @extjson
200
+ end
201
+
202
+ # Whether the extended json should be tested.
203
+ #
204
+ # @example Determine if the extended json should be tested.
205
+ # test.test_extjson?
206
+ #
207
+ # @return [ true, false ] Whether the extended json should be tested.
208
+ #
209
+ # @since 4.2.0
210
+ def test_extjson?
211
+ !!@extjson
212
+ end
213
+
214
+ # Get the extended json representation of the decoded doc from the provided
215
+ # bson hex representation.
216
+ #
217
+ # @example Get the extended json representation of the decoded doc.
218
+ # test.extjson_from_encoded_bson
219
+ #
220
+ # @return [ Hash ] The extended json representation.
221
+ #
222
+ # @since 4.2.0
223
+ def extjson_from_bson
224
+ subject = decode_hex(@bson)
225
+ buffer = BSON::ByteBuffer.new(subject)
226
+ ::JSON.parse(BSON::Document.from_bson(buffer).to_json)
227
+ end
228
+
229
+ # Get the extended json representation of the decoded doc from the provided
230
+ # canonical bson hex representation.
231
+ #
232
+ # @example Get the extended json representation of the canonical decoded doc.
233
+ # test.extjson_from_canonical_bson
234
+ #
235
+ # @return [ Hash ] The extended json representation.
236
+ #
237
+ # @since 4.2.0
238
+ def extjson_from_canonical_bson
239
+ subject = decode_hex(@canonical_bson)
240
+ buffer = BSON::ByteBuffer.new(subject)
241
+ ::JSON.parse(BSON::Document.from_bson(buffer).to_json)
242
+ end
243
+
244
+ # Get the extended json representation of the decoded doc from the provided
245
+ # extended json representation. (Verifies roundtrip)
246
+ #
247
+ # @example Get the extended json representation of the canonical decoded doc.
248
+ # test.extjson_from_encoded_extjson
249
+ #
250
+ # @return [ Hash ] The extended json representation.
251
+ #
252
+ # @since 4.2.0
253
+ def extjson_from_encoded_extjson
254
+ doc = BSON::Document.new(@extjson)
255
+ ::JSON.parse(doc.to_json)
256
+ end
257
+
258
+ private
259
+
260
+ def decode_hex(obj)
261
+ [ obj ].pack('H*')
262
+ end
263
+ end
264
+ end
265
+ end
data/spec/support/shared_examples.rb CHANGED
@@ -50,7 +50,7 @@ shared_examples_for "a deserializable bson element" do
50
50
  end
51
51
 
52
52
  let(:result) do
53
- described_class.from_bson(io)
53
+ (defined?(klass) ? klass : described_class).from_bson(io)
54
54
  end
55
55
 
56
56
  it "deserializes from bson" do
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: bson
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.2.0.rc1
4
+ version: 4.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tyler Brock
@@ -34,7 +34,7 @@ cert_chain:
34
34
  yVPbgNJA2D/PnLe8ZFMhgJf+VIA1V4oybP/o+9aqlghTtNfYHJpRCAluUiaywwXl
35
35
  KzD4mmIBpxtbWrWB3hx7tsVJmWx5zgO9aDAfvWnXfoo=
36
36
  -----END CERTIFICATE-----
37
- date: 2016-11-01 00:00:00.000000000 Z
37
+ date: 2016-11-29 00:00:00.000000000 Z
38
38
  dependencies: []
39
39
  description: A full featured BSON specification implementation, in Ruby
40
40
  email:
@@ -96,6 +96,7 @@ files:
96
96
  - spec/bson/code_spec.rb
97
97
  - spec/bson/code_with_scope_spec.rb
98
98
  - spec/bson/config_spec.rb
99
+ - spec/bson/corpus_spec.rb
99
100
  - spec/bson/date_spec.rb
100
101
  - spec/bson/date_time_spec.rb
101
102
  - spec/bson/decimal128_spec.rb
@@ -114,6 +115,7 @@ files:
114
115
  - spec/bson/object_id_spec.rb
115
116
  - spec/bson/object_spec.rb
116
117
  - spec/bson/open_struct_spec.rb
118
+ - spec/bson/raw_spec.rb
117
119
  - spec/bson/regexp_spec.rb
118
120
  - spec/bson/registry_spec.rb
119
121
  - spec/bson/string_spec.rb
@@ -125,6 +127,28 @@ files:
125
127
  - spec/bson_spec.rb
126
128
  - spec/spec_helper.rb
127
129
  - spec/support/common_driver.rb
130
+ - spec/support/corpus-tests/array.json
131
+ - spec/support/corpus-tests/boolean.json
132
+ - spec/support/corpus-tests/code.json
133
+ - spec/support/corpus-tests/code_w_scope.json
134
+ - spec/support/corpus-tests/document.json
135
+ - spec/support/corpus-tests/double.json
136
+ - spec/support/corpus-tests/failures/binary.json
137
+ - spec/support/corpus-tests/failures/datetime.json
138
+ - spec/support/corpus-tests/failures/dbpointer.json
139
+ - spec/support/corpus-tests/failures/int64.json
140
+ - spec/support/corpus-tests/failures/symbol.json
141
+ - spec/support/corpus-tests/failures/undefined.json
142
+ - spec/support/corpus-tests/int32.json
143
+ - spec/support/corpus-tests/maxkey.json
144
+ - spec/support/corpus-tests/minkey.json
145
+ - spec/support/corpus-tests/null.json
146
+ - spec/support/corpus-tests/oid.json
147
+ - spec/support/corpus-tests/regex.json
148
+ - spec/support/corpus-tests/string.json
149
+ - spec/support/corpus-tests/timestamp.json
150
+ - spec/support/corpus-tests/top.json
151
+ - spec/support/corpus.rb
128
152
  - spec/support/driver-spec-tests/decimal128/decimal128-1.json
129
153
  - spec/support/driver-spec-tests/decimal128/decimal128-2.json
130
154
  - spec/support/driver-spec-tests/decimal128/decimal128-3.json
@@ -153,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
153
177
  version: 1.3.6
154
178
  requirements: []
155
179
  rubyforge_project: bson
156
- rubygems_version: 2.5.1
180
+ rubygems_version: 2.4.5.1
157
181
  signing_key:
158
182
  specification_version: 4
159
183
  summary: Ruby Implementation of the BSON specification
@@ -165,6 +189,7 @@ test_files:
165
189
  - spec/bson/code_spec.rb
166
190
  - spec/bson/code_with_scope_spec.rb
167
191
  - spec/bson/config_spec.rb
192
+ - spec/bson/corpus_spec.rb
168
193
  - spec/bson/date_spec.rb
169
194
  - spec/bson/date_time_spec.rb
170
195
  - spec/bson/decimal128_spec.rb
@@ -183,6 +208,7 @@ test_files:
183
208
  - spec/bson/object_id_spec.rb
184
209
  - spec/bson/object_spec.rb
185
210
  - spec/bson/open_struct_spec.rb
211
+ - spec/bson/raw_spec.rb
186
212
  - spec/bson/regexp_spec.rb
187
213
  - spec/bson/registry_spec.rb
188
214
  - spec/bson/string_spec.rb
@@ -194,6 +220,28 @@ test_files:
194
220
  - spec/bson_spec.rb
195
221
  - spec/spec_helper.rb
196
222
  - spec/support/common_driver.rb
223
+ - spec/support/corpus-tests/array.json
224
+ - spec/support/corpus-tests/boolean.json
225
+ - spec/support/corpus-tests/code.json
226
+ - spec/support/corpus-tests/code_w_scope.json
227
+ - spec/support/corpus-tests/document.json
228
+ - spec/support/corpus-tests/double.json
229
+ - spec/support/corpus-tests/failures/binary.json
230
+ - spec/support/corpus-tests/failures/datetime.json
231
+ - spec/support/corpus-tests/failures/dbpointer.json
232
+ - spec/support/corpus-tests/failures/int64.json
233
+ - spec/support/corpus-tests/failures/symbol.json
234
+ - spec/support/corpus-tests/failures/undefined.json
235
+ - spec/support/corpus-tests/int32.json
236
+ - spec/support/corpus-tests/maxkey.json
237
+ - spec/support/corpus-tests/minkey.json
238
+ - spec/support/corpus-tests/null.json
239
+ - spec/support/corpus-tests/oid.json
240
+ - spec/support/corpus-tests/regex.json
241
+ - spec/support/corpus-tests/string.json
242
+ - spec/support/corpus-tests/timestamp.json
243
+ - spec/support/corpus-tests/top.json
244
+ - spec/support/corpus.rb
197
245
  - spec/support/driver-spec-tests/decimal128/decimal128-1.json
198
246
  - spec/support/driver-spec-tests/decimal128/decimal128-2.json
199
247
  - spec/support/driver-spec-tests/decimal128/decimal128-3.json
metadata.gz.sig CHANGED
Binary file