json 2.6.3 → 2.11.3

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.
Files changed (46) hide show
  1. checksums.yaml +4 -4
  2. data/BSDL +22 -0
  3. data/CHANGES.md +188 -17
  4. data/LEGAL +8 -0
  5. data/README.md +67 -224
  6. data/ext/json/ext/fbuffer/fbuffer.h +144 -95
  7. data/ext/json/ext/generator/extconf.rb +8 -2
  8. data/ext/json/ext/generator/generator.c +1043 -810
  9. data/ext/json/ext/parser/extconf.rb +6 -27
  10. data/ext/json/ext/parser/parser.c +1227 -3209
  11. data/ext/json/ext/vendor/fpconv.c +479 -0
  12. data/ext/json/ext/vendor/jeaiii-ltoa.h +267 -0
  13. data/json.gemspec +48 -52
  14. data/lib/json/add/bigdecimal.rb +39 -10
  15. data/lib/json/add/complex.rb +29 -6
  16. data/lib/json/add/core.rb +1 -1
  17. data/lib/json/add/date.rb +27 -7
  18. data/lib/json/add/date_time.rb +26 -9
  19. data/lib/json/add/exception.rb +25 -7
  20. data/lib/json/add/ostruct.rb +32 -9
  21. data/lib/json/add/range.rb +33 -8
  22. data/lib/json/add/rational.rb +28 -6
  23. data/lib/json/add/regexp.rb +26 -8
  24. data/lib/json/add/set.rb +25 -6
  25. data/lib/json/add/struct.rb +29 -7
  26. data/lib/json/add/symbol.rb +34 -7
  27. data/lib/json/add/time.rb +29 -15
  28. data/lib/json/common.rb +648 -249
  29. data/lib/json/ext/generator/state.rb +106 -0
  30. data/lib/json/ext.rb +34 -4
  31. data/lib/json/generic_object.rb +7 -3
  32. data/lib/json/truffle_ruby/generator.rb +690 -0
  33. data/lib/json/version.rb +3 -7
  34. data/lib/json.rb +25 -21
  35. metadata +17 -26
  36. data/VERSION +0 -1
  37. data/ext/json/ext/generator/depend +0 -1
  38. data/ext/json/ext/generator/generator.h +0 -174
  39. data/ext/json/ext/parser/depend +0 -1
  40. data/ext/json/ext/parser/parser.h +0 -96
  41. data/ext/json/ext/parser/parser.rl +0 -986
  42. data/ext/json/extconf.rb +0 -3
  43. data/lib/json/pure/generator.rb +0 -479
  44. data/lib/json/pure/parser.rb +0 -337
  45. data/lib/json/pure.rb +0 -15
  46. /data/{LICENSE → COPYING} +0 -0
@@ -0,0 +1,267 @@
1
+ /*
2
+
3
+ This file is released under the terms of the MIT License. It is based on the
4
+ work of James Edward Anhalt III, with the original license listed below.
5
+
6
+ MIT License
7
+
8
+ Copyright (c) 2024,2025 Enrico Thierbach - https://github.com/radiospiel
9
+ Copyright (c) 2022 James Edward Anhalt III - https://github.com/jeaiii/itoa
10
+
11
+ Permission is hereby granted, free of charge, to any person obtaining a copy
12
+ of this software and associated documentation files (the "Software"), to deal
13
+ in the Software without restriction, including without limitation the rights
14
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15
+ copies of the Software, and to permit persons to whom the Software is
16
+ furnished to do so, subject to the following conditions:
17
+
18
+ The above copyright notice and this permission notice shall be included in all
19
+ copies or substantial portions of the Software.
20
+
21
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27
+ SOFTWARE.
28
+ */
29
+
30
+ #ifndef JEAIII_TO_TEXT_H_
31
+ #define JEAIII_TO_TEXT_H_
32
+
33
+ #include <stdint.h>
34
+
35
+ typedef uint_fast32_t u32_t;
36
+ typedef uint_fast64_t u64_t;
37
+
38
+ #define u32(x) ((u32_t)(x))
39
+ #define u64(x) ((u64_t)(x))
40
+
41
+ struct digit_pair
42
+ {
43
+ char dd[2];
44
+ };
45
+
46
+ static const struct digit_pair *digits_dd = (struct digit_pair *)(
47
+ "00" "01" "02" "03" "04" "05" "06" "07" "08" "09"
48
+ "10" "11" "12" "13" "14" "15" "16" "17" "18" "19"
49
+ "20" "21" "22" "23" "24" "25" "26" "27" "28" "29"
50
+ "30" "31" "32" "33" "34" "35" "36" "37" "38" "39"
51
+ "40" "41" "42" "43" "44" "45" "46" "47" "48" "49"
52
+ "50" "51" "52" "53" "54" "55" "56" "57" "58" "59"
53
+ "60" "61" "62" "63" "64" "65" "66" "67" "68" "69"
54
+ "70" "71" "72" "73" "74" "75" "76" "77" "78" "79"
55
+ "80" "81" "82" "83" "84" "85" "86" "87" "88" "89"
56
+ "90" "91" "92" "93" "94" "95" "96" "97" "98" "99"
57
+ );
58
+
59
+ static const struct digit_pair *digits_fd = (struct digit_pair *)(
60
+ "0_" "1_" "2_" "3_" "4_" "5_" "6_" "7_" "8_" "9_"
61
+ "10" "11" "12" "13" "14" "15" "16" "17" "18" "19"
62
+ "20" "21" "22" "23" "24" "25" "26" "27" "28" "29"
63
+ "30" "31" "32" "33" "34" "35" "36" "37" "38" "39"
64
+ "40" "41" "42" "43" "44" "45" "46" "47" "48" "49"
65
+ "50" "51" "52" "53" "54" "55" "56" "57" "58" "59"
66
+ "60" "61" "62" "63" "64" "65" "66" "67" "68" "69"
67
+ "70" "71" "72" "73" "74" "75" "76" "77" "78" "79"
68
+ "80" "81" "82" "83" "84" "85" "86" "87" "88" "89"
69
+ "90" "91" "92" "93" "94" "95" "96" "97" "98" "99"
70
+ );
71
+
72
+ static const u64_t mask24 = (u64(1) << 24) - 1;
73
+ static const u64_t mask32 = (u64(1) << 32) - 1;
74
+ static const u64_t mask57 = (u64(1) << 57) - 1;
75
+
76
+ #define COPY(buffer, digits) memcpy(buffer, &(digits), sizeof(struct digit_pair))
77
+
78
+ static char *
79
+ jeaiii_ultoa(char *b, u64_t n)
80
+ {
81
+ if (n < u32(1e2)) {
82
+ COPY(b, digits_fd[n]);
83
+ return n < 10 ? b + 1 : b + 2;
84
+ }
85
+
86
+ if (n < u32(1e6)) {
87
+ if (n < u32(1e4)) {
88
+ u32_t f0 = u32((10 * (1 << 24) / 1e3 + 1) * n);
89
+ COPY(b, digits_fd[f0 >> 24]);
90
+
91
+ b -= n < u32(1e3);
92
+ u32_t f2 = (f0 & mask24) * 100;
93
+ COPY(b + 2, digits_dd[f2 >> 24]);
94
+
95
+ return b + 4;
96
+ }
97
+
98
+ u64_t f0 = u64(10 * (1ull << 32ull)/ 1e5 + 1) * n;
99
+ COPY(b, digits_fd[f0 >> 32]);
100
+
101
+ b -= n < u32(1e5);
102
+ u64_t f2 = (f0 & mask32) * 100;
103
+ COPY(b + 2, digits_dd[f2 >> 32]);
104
+
105
+ u64_t f4 = (f2 & mask32) * 100;
106
+ COPY(b + 4, digits_dd[f4 >> 32]);
107
+ return b + 6;
108
+ }
109
+
110
+ if (n < u64(1ull << 32ull)) {
111
+ if (n < u32(1e8)) {
112
+ u64_t f0 = u64(10 * (1ull << 48ull) / 1e7 + 1) * n >> 16;
113
+ COPY(b, digits_fd[f0 >> 32]);
114
+
115
+ b -= n < u32(1e7);
116
+ u64_t f2 = (f0 & mask32) * 100;
117
+ COPY(b + 2, digits_dd[f2 >> 32]);
118
+
119
+ u64_t f4 = (f2 & mask32) * 100;
120
+ COPY(b + 4, digits_dd[f4 >> 32]);
121
+
122
+ u64_t f6 = (f4 & mask32) * 100;
123
+ COPY(b + 6, digits_dd[f6 >> 32]);
124
+
125
+ return b + 8;
126
+ }
127
+
128
+ u64_t f0 = u64(10 * (1ull << 57ull) / 1e9 + 1) * n;
129
+ COPY(b, digits_fd[f0 >> 57]);
130
+
131
+ b -= n < u32(1e9);
132
+ u64_t f2 = (f0 & mask57) * 100;
133
+ COPY(b + 2, digits_dd[f2 >> 57]);
134
+
135
+ u64_t f4 = (f2 & mask57) * 100;
136
+ COPY(b + 4, digits_dd[f4 >> 57]);
137
+
138
+ u64_t f6 = (f4 & mask57) * 100;
139
+ COPY(b + 6, digits_dd[f6 >> 57]);
140
+
141
+ u64_t f8 = (f6 & mask57) * 100;
142
+ COPY(b + 8, digits_dd[f8 >> 57]);
143
+
144
+ return b + 10;
145
+ }
146
+
147
+ // if we get here U must be u64 but some compilers don't know that, so reassign n to a u64 to avoid warnings
148
+ u32_t z = n % u32(1e8);
149
+ u64_t u = n / u32(1e8);
150
+
151
+ if (u < u32(1e2)) {
152
+ // u can't be 1 digit (if u < 10 it would have been handled above as a 9 digit 32bit number)
153
+ COPY(b, digits_dd[u]);
154
+ b += 2;
155
+ }
156
+ else if (u < u32(1e6)) {
157
+ if (u < u32(1e4)) {
158
+ u32_t f0 = u32((10 * (1 << 24) / 1e3 + 1) * u);
159
+ COPY(b, digits_fd[f0 >> 24]);
160
+
161
+ b -= u < u32(1e3);
162
+ u32_t f2 = (f0 & mask24) * 100;
163
+ COPY(b + 2, digits_dd[f2 >> 24]);
164
+ b += 4;
165
+ }
166
+ else {
167
+ u64_t f0 = u64(10 * (1ull << 32ull) / 1e5 + 1) * u;
168
+ COPY(b, digits_fd[f0 >> 32]);
169
+
170
+ b -= u < u32(1e5);
171
+ u64_t f2 = (f0 & mask32) * 100;
172
+ COPY(b + 2, digits_dd[f2 >> 32]);
173
+
174
+ u64_t f4 = (f2 & mask32) * 100;
175
+ COPY(b + 4, digits_dd[f4 >> 32]);
176
+ b += 6;
177
+ }
178
+ }
179
+ else if (u < u32(1e8)) {
180
+ u64_t f0 = u64(10 * (1ull << 48ull) / 1e7 + 1) * u >> 16;
181
+ COPY(b, digits_fd[f0 >> 32]);
182
+
183
+ b -= u < u32(1e7);
184
+ u64_t f2 = (f0 & mask32) * 100;
185
+ COPY(b + 2, digits_dd[f2 >> 32]);
186
+
187
+ u64_t f4 = (f2 & mask32) * 100;
188
+ COPY(b + 4, digits_dd[f4 >> 32]);
189
+
190
+ u64_t f6 = (f4 & mask32) * 100;
191
+ COPY(b + 6, digits_dd[f6 >> 32]);
192
+
193
+ b += 8;
194
+ }
195
+ else if (u < u64(1ull << 32ull)) {
196
+ u64_t f0 = u64(10 * (1ull << 57ull) / 1e9 + 1) * u;
197
+ COPY(b, digits_fd[f0 >> 57]);
198
+
199
+ b -= u < u32(1e9);
200
+ u64_t f2 = (f0 & mask57) * 100;
201
+ COPY(b + 2, digits_dd[f2 >> 57]);
202
+
203
+ u64_t f4 = (f2 & mask57) * 100;
204
+ COPY(b + 4, digits_dd[f4 >> 57]);
205
+
206
+ u64_t f6 = (f4 & mask57) * 100;
207
+ COPY(b + 6, digits_dd[f6 >> 57]);
208
+
209
+ u64_t f8 = (f6 & mask57) * 100;
210
+ COPY(b + 8, digits_dd[f8 >> 57]);
211
+ b += 10;
212
+ }
213
+ else {
214
+ u32_t y = u % u32(1e8);
215
+ u /= u32(1e8);
216
+
217
+ // u is 2, 3, or 4 digits (if u < 10 it would have been handled above)
218
+ if (u < u32(1e2)) {
219
+ COPY(b, digits_dd[u]);
220
+ b += 2;
221
+ }
222
+ else {
223
+ u32_t f0 = u32((10 * (1 << 24) / 1e3 + 1) * u);
224
+ COPY(b, digits_fd[f0 >> 24]);
225
+
226
+ b -= u < u32(1e3);
227
+ u32_t f2 = (f0 & mask24) * 100;
228
+ COPY(b + 2, digits_dd[f2 >> 24]);
229
+
230
+ b += 4;
231
+ }
232
+ // do 8 digits
233
+ u64_t f0 = (u64((1ull << 48ull) / 1e6 + 1) * y >> 16) + 1;
234
+ COPY(b, digits_dd[f0 >> 32]);
235
+
236
+ u64_t f2 = (f0 & mask32) * 100;
237
+ COPY(b + 2, digits_dd[f2 >> 32]);
238
+
239
+ u64_t f4 = (f2 & mask32) * 100;
240
+ COPY(b + 4, digits_dd[f4 >> 32]);
241
+
242
+ u64_t f6 = (f4 & mask32) * 100;
243
+ COPY(b + 6, digits_dd[f6 >> 32]);
244
+ b += 8;
245
+ }
246
+
247
+ // do 8 digits
248
+ u64_t f0 = (u64((1ull << 48ull) / 1e6 + 1) * z >> 16) + 1;
249
+ COPY(b, digits_dd[f0 >> 32]);
250
+
251
+ u64_t f2 = (f0 & mask32) * 100;
252
+ COPY(b + 2, digits_dd[f2 >> 32]);
253
+
254
+ u64_t f4 = (f2 & mask32) * 100;
255
+ COPY(b + 4, digits_dd[f4 >> 32]);
256
+
257
+ u64_t f6 = (f4 & mask32) * 100;
258
+ COPY(b + 6, digits_dd[f6 >> 32]);
259
+
260
+ return b + 8;
261
+ }
262
+
263
+ #undef u32
264
+ #undef u64
265
+ #undef COPY
266
+
267
+ #endif // JEAIII_TO_TEXT_H_
data/json.gemspec CHANGED
@@ -1,67 +1,63 @@
1
- # -*- encoding: utf-8 -*-
1
+ # frozen_string_literal: true
2
+
3
+ version = File.foreach(File.join(__dir__, "lib/json/version.rb")) do |line|
4
+ /^\s*VERSION\s*=\s*'(.*)'/ =~ line and break $1
5
+ end rescue nil
6
+
7
+ spec = Gem::Specification.new do |s|
8
+ java_ext = Gem::Platform === s.platform && s.platform =~ 'java' || RUBY_ENGINE == 'jruby'
2
9
 
3
- Gem::Specification.new do |s|
4
10
  s.name = "json"
5
- s.version = File.read(File.expand_path('../VERSION', __FILE__)).chomp
11
+ s.version = version
6
12
 
7
13
  s.summary = "JSON Implementation for Ruby"
8
- s.description = "This is a JSON implementation as a Ruby extension in C."
14
+ s.homepage = "https://github.com/ruby/json"
15
+ s.metadata = {
16
+ 'bug_tracker_uri' => 'https://github.com/ruby/json/issues',
17
+ 'changelog_uri' => 'https://github.com/ruby/json/blob/master/CHANGES.md',
18
+ 'documentation_uri' => 'https://docs.ruby-lang.org/en/master/JSON.html',
19
+ 'homepage_uri' => s.homepage,
20
+ 'source_code_uri' => 'https://github.com/ruby/json',
21
+ }
22
+
23
+ s.required_ruby_version = Gem::Requirement.new(">= 2.7")
24
+
25
+ if java_ext
26
+ s.description = "A JSON implementation as a JRuby extension."
27
+ s.author = "Daniel Luz"
28
+ s.email = "dev+ruby@mernen.com"
29
+ else
30
+ s.description = "This is a JSON implementation as a Ruby extension in C."
31
+ s.authors = ["Florian Frank"]
32
+ s.email = "flori@ping.de"
33
+ end
34
+
9
35
  s.licenses = ["Ruby"]
10
- s.authors = ["Florian Frank"]
11
- s.email = "flori@ping.de"
12
36
 
13
- s.extensions = ["ext/json/ext/generator/extconf.rb", "ext/json/ext/parser/extconf.rb", "ext/json/extconf.rb"]
14
37
  s.extra_rdoc_files = ["README.md"]
15
38
  s.rdoc_options = ["--title", "JSON implementation for Ruby", "--main", "README.md"]
39
+
16
40
  s.files = [
17
41
  "CHANGES.md",
18
- "LICENSE",
42
+ "COPYING",
43
+ "BSDL",
44
+ "LEGAL",
19
45
  "README.md",
20
- "VERSION",
21
- "ext/json/ext/fbuffer/fbuffer.h",
22
- "ext/json/ext/generator/depend",
23
- "ext/json/ext/generator/extconf.rb",
24
- "ext/json/ext/generator/generator.c",
25
- "ext/json/ext/generator/generator.h",
26
- "ext/json/ext/parser/depend",
27
- "ext/json/ext/parser/extconf.rb",
28
- "ext/json/ext/parser/parser.c",
29
- "ext/json/ext/parser/parser.h",
30
- "ext/json/ext/parser/parser.rl",
31
- "ext/json/extconf.rb",
32
46
  "json.gemspec",
33
- "lib/json.rb",
34
- "lib/json/add/bigdecimal.rb",
35
- "lib/json/add/complex.rb",
36
- "lib/json/add/core.rb",
37
- "lib/json/add/date.rb",
38
- "lib/json/add/date_time.rb",
39
- "lib/json/add/exception.rb",
40
- "lib/json/add/ostruct.rb",
41
- "lib/json/add/range.rb",
42
- "lib/json/add/rational.rb",
43
- "lib/json/add/regexp.rb",
44
- "lib/json/add/set.rb",
45
- "lib/json/add/struct.rb",
46
- "lib/json/add/symbol.rb",
47
- "lib/json/add/time.rb",
48
- "lib/json/common.rb",
49
- "lib/json/ext.rb",
50
- "lib/json/generic_object.rb",
51
- "lib/json/pure.rb",
52
- "lib/json/pure/generator.rb",
53
- "lib/json/pure/parser.rb",
54
- "lib/json/version.rb",
47
+ *Dir["lib/**/*.rb"],
55
48
  ]
56
- s.homepage = "http://flori.github.com/json"
57
- s.metadata = {
58
- 'bug_tracker_uri' => 'https://github.com/flori/json/issues',
59
- 'changelog_uri' => 'https://github.com/flori/json/blob/master/CHANGES.md',
60
- 'documentation_uri' => 'http://flori.github.io/json/doc/index.html',
61
- 'homepage_uri' => 'http://flori.github.io/json/',
62
- 'source_code_uri' => 'https://github.com/flori/json',
63
- 'wiki_uri' => 'https://github.com/flori/json/wiki'
64
- }
65
49
 
66
- s.required_ruby_version = Gem::Requirement.new(">= 2.3")
50
+ if java_ext
51
+ s.platform = 'java'
52
+ s.files += Dir["lib/json/ext/**/*.jar"]
53
+ else
54
+ s.extensions = Dir["ext/json/**/extconf.rb"]
55
+ s.files += Dir["ext/json/**/*.{c,h}"]
56
+ end
57
+ end
58
+
59
+ if RUBY_ENGINE == 'jruby' && $0 == __FILE__
60
+ Gem::Builder.new(spec).build
61
+ else
62
+ spec
67
63
  end
@@ -1,29 +1,58 @@
1
- #frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
3
3
  require 'json'
4
4
  end
5
- defined?(::BigDecimal) or require 'bigdecimal'
5
+ begin
6
+ require 'bigdecimal'
7
+ rescue LoadError
8
+ end
6
9
 
7
10
  class BigDecimal
8
- # Import a JSON Marshalled object.
9
- #
10
- # method used for JSON marshalling support.
11
+
12
+ # See #as_json.
11
13
  def self.json_create(object)
12
14
  BigDecimal._load object['b']
13
15
  end
14
16
 
15
- # Marshal the object to JSON.
17
+ # Methods <tt>BigDecimal#as_json</tt> and +BigDecimal.json_create+ may be used
18
+ # to serialize and deserialize a \BigDecimal object;
19
+ # see Marshal[https://docs.ruby-lang.org/en/master/Marshal.html].
20
+ #
21
+ # \Method <tt>BigDecimal#as_json</tt> serializes +self+,
22
+ # returning a 2-element hash representing +self+:
23
+ #
24
+ # require 'json/add/bigdecimal'
25
+ # x = BigDecimal(2).as_json # => {"json_class"=>"BigDecimal", "b"=>"27:0.2e1"}
26
+ # y = BigDecimal(2.0, 4).as_json # => {"json_class"=>"BigDecimal", "b"=>"36:0.2e1"}
27
+ # z = BigDecimal(Complex(2, 0)).as_json # => {"json_class"=>"BigDecimal", "b"=>"27:0.2e1"}
28
+ #
29
+ # \Method +JSON.create+ deserializes such a hash, returning a \BigDecimal object:
30
+ #
31
+ # BigDecimal.json_create(x) # => 0.2e1
32
+ # BigDecimal.json_create(y) # => 0.2e1
33
+ # BigDecimal.json_create(z) # => 0.2e1
16
34
  #
17
- # method used for JSON marshalling support.
18
35
  def as_json(*)
19
36
  {
20
37
  JSON.create_id => self.class.name,
21
- 'b' => _dump,
38
+ 'b' => _dump.force_encoding(Encoding::UTF_8),
22
39
  }
23
40
  end
24
41
 
25
- # return the JSON value
42
+ # Returns a JSON string representing +self+:
43
+ #
44
+ # require 'json/add/bigdecimal'
45
+ # puts BigDecimal(2).to_json
46
+ # puts BigDecimal(2.0, 4).to_json
47
+ # puts BigDecimal(Complex(2, 0)).to_json
48
+ #
49
+ # Output:
50
+ #
51
+ # {"json_class":"BigDecimal","b":"27:0.2e1"}
52
+ # {"json_class":"BigDecimal","b":"36:0.2e1"}
53
+ # {"json_class":"BigDecimal","b":"27:0.2e1"}
54
+ #
26
55
  def to_json(*args)
27
56
  as_json.to_json(*args)
28
57
  end
29
- end
58
+ end if defined?(::BigDecimal)
@@ -1,18 +1,31 @@
1
- #frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
3
3
  require 'json'
4
4
  end
5
5
 
6
6
  class Complex
7
7
 
8
- # Deserializes JSON string by converting Real value <tt>r</tt>, imaginary
9
- # value <tt>i</tt>, to a Complex object.
8
+ # See #as_json.
10
9
  def self.json_create(object)
11
10
  Complex(object['r'], object['i'])
12
11
  end
13
12
 
14
- # Returns a hash, that will be turned into a JSON object and represent this
15
- # object.
13
+ # Methods <tt>Complex#as_json</tt> and +Complex.json_create+ may be used
14
+ # to serialize and deserialize a \Complex object;
15
+ # see Marshal[https://docs.ruby-lang.org/en/master/Marshal.html].
16
+ #
17
+ # \Method <tt>Complex#as_json</tt> serializes +self+,
18
+ # returning a 2-element hash representing +self+:
19
+ #
20
+ # require 'json/add/complex'
21
+ # x = Complex(2).as_json # => {"json_class"=>"Complex", "r"=>2, "i"=>0}
22
+ # y = Complex(2.0, 4).as_json # => {"json_class"=>"Complex", "r"=>2.0, "i"=>4}
23
+ #
24
+ # \Method +JSON.create+ deserializes such a hash, returning a \Complex object:
25
+ #
26
+ # Complex.json_create(x) # => (2+0i)
27
+ # Complex.json_create(y) # => (2.0+4i)
28
+ #
16
29
  def as_json(*)
17
30
  {
18
31
  JSON.create_id => self.class.name,
@@ -21,7 +34,17 @@ class Complex
21
34
  }
22
35
  end
23
36
 
24
- # Stores class name (Complex) along with real value <tt>r</tt> and imaginary value <tt>i</tt> as JSON string
37
+ # Returns a JSON string representing +self+:
38
+ #
39
+ # require 'json/add/complex'
40
+ # puts Complex(2).to_json
41
+ # puts Complex(2.0, 4).to_json
42
+ #
43
+ # Output:
44
+ #
45
+ # {"json_class":"Complex","r":2,"i":0}
46
+ # {"json_class":"Complex","r":2.0,"i":4}
47
+ #
25
48
  def to_json(*args)
26
49
  as_json.to_json(*args)
27
50
  end
data/lib/json/add/core.rb CHANGED
@@ -1,4 +1,4 @@
1
- #frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  # This file requires the implementations of ruby core's custom objects for
3
3
  # serialisation/deserialisation.
4
4
 
data/lib/json/add/date.rb CHANGED
@@ -1,4 +1,4 @@
1
- #frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
3
3
  require 'json'
4
4
  end
@@ -6,16 +6,29 @@ require 'date'
6
6
 
7
7
  class Date
8
8
 
9
- # Deserializes JSON string by converting Julian year <tt>y</tt>, month
10
- # <tt>m</tt>, day <tt>d</tt> and Day of Calendar Reform <tt>sg</tt> to Date.
9
+ # See #as_json.
11
10
  def self.json_create(object)
12
11
  civil(*object.values_at('y', 'm', 'd', 'sg'))
13
12
  end
14
13
 
15
14
  alias start sg unless method_defined?(:start)
16
15
 
17
- # Returns a hash, that will be turned into a JSON object and represent this
18
- # object.
16
+ # Methods <tt>Date#as_json</tt> and +Date.json_create+ may be used
17
+ # to serialize and deserialize a \Date object;
18
+ # see Marshal[https://docs.ruby-lang.org/en/master/Marshal.html].
19
+ #
20
+ # \Method <tt>Date#as_json</tt> serializes +self+,
21
+ # returning a 2-element hash representing +self+:
22
+ #
23
+ # require 'json/add/date'
24
+ # x = Date.today.as_json
25
+ # # => {"json_class"=>"Date", "y"=>2023, "m"=>11, "d"=>21, "sg"=>2299161.0}
26
+ #
27
+ # \Method +JSON.create+ deserializes such a hash, returning a \Date object:
28
+ #
29
+ # Date.json_create(x)
30
+ # # => #<Date: 2023-11-21 ((2460270j,0s,0n),+0s,2299161j)>
31
+ #
19
32
  def as_json(*)
20
33
  {
21
34
  JSON.create_id => self.class.name,
@@ -26,8 +39,15 @@ class Date
26
39
  }
27
40
  end
28
41
 
29
- # Stores class name (Date) with Julian year <tt>y</tt>, month <tt>m</tt>, day
30
- # <tt>d</tt> and Day of Calendar Reform <tt>sg</tt> as JSON string
42
+ # Returns a JSON string representing +self+:
43
+ #
44
+ # require 'json/add/date'
45
+ # puts Date.today.to_json
46
+ #
47
+ # Output:
48
+ #
49
+ # {"json_class":"Date","y":2023,"m":11,"d":21,"sg":2299161.0}
50
+ #
31
51
  def to_json(*args)
32
52
  as_json.to_json(*args)
33
53
  end
@@ -1,4 +1,4 @@
1
- #frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
3
3
  require 'json'
4
4
  end
@@ -6,9 +6,7 @@ require 'date'
6
6
 
7
7
  class DateTime
8
8
 
9
- # Deserializes JSON string by converting year <tt>y</tt>, month <tt>m</tt>,
10
- # day <tt>d</tt>, hour <tt>H</tt>, minute <tt>M</tt>, second <tt>S</tt>,
11
- # offset <tt>of</tt> and Day of Calendar Reform <tt>sg</tt> to DateTime.
9
+ # See #as_json.
12
10
  def self.json_create(object)
13
11
  args = object.values_at('y', 'm', 'd', 'H', 'M', 'S')
14
12
  of_a, of_b = object['of'].split('/')
@@ -23,8 +21,21 @@ class DateTime
23
21
 
24
22
  alias start sg unless method_defined?(:start)
25
23
 
26
- # Returns a hash, that will be turned into a JSON object and represent this
27
- # object.
24
+ # Methods <tt>DateTime#as_json</tt> and +DateTime.json_create+ may be used
25
+ # to serialize and deserialize a \DateTime object;
26
+ # see Marshal[https://docs.ruby-lang.org/en/master/Marshal.html].
27
+ #
28
+ # \Method <tt>DateTime#as_json</tt> serializes +self+,
29
+ # returning a 2-element hash representing +self+:
30
+ #
31
+ # require 'json/add/datetime'
32
+ # x = DateTime.now.as_json
33
+ # # => {"json_class"=>"DateTime", "y"=>2023, "m"=>11, "d"=>21, "sg"=>2299161.0}
34
+ #
35
+ # \Method +JSON.create+ deserializes such a hash, returning a \DateTime object:
36
+ #
37
+ # DateTime.json_create(x) # BUG? Raises Date::Error "invalid date"
38
+ #
28
39
  def as_json(*)
29
40
  {
30
41
  JSON.create_id => self.class.name,
@@ -39,9 +50,15 @@ class DateTime
39
50
  }
40
51
  end
41
52
 
42
- # Stores class name (DateTime) with Julian year <tt>y</tt>, month <tt>m</tt>,
43
- # day <tt>d</tt>, hour <tt>H</tt>, minute <tt>M</tt>, second <tt>S</tt>,
44
- # offset <tt>of</tt> and Day of Calendar Reform <tt>sg</tt> as JSON string
53
+ # Returns a JSON string representing +self+:
54
+ #
55
+ # require 'json/add/datetime'
56
+ # puts DateTime.now.to_json
57
+ #
58
+ # Output:
59
+ #
60
+ # {"json_class":"DateTime","y":2023,"m":11,"d":21,"sg":2299161.0}
61
+ #
45
62
  def to_json(*args)
46
63
  as_json.to_json(*args)
47
64
  end