rbs 3.9.5 → 3.10.0.pre.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.
Files changed (171) hide show
  1. checksums.yaml +4 -4
  2. data/.clang-format +74 -0
  3. data/.clangd +2 -0
  4. data/.github/workflows/c-check.yml +54 -0
  5. data/.github/workflows/comments.yml +3 -3
  6. data/.github/workflows/ruby.yml +34 -19
  7. data/.github/workflows/typecheck.yml +1 -1
  8. data/.github/workflows/windows.yml +1 -1
  9. data/.gitignore +4 -0
  10. data/README.md +38 -1
  11. data/Rakefile +152 -23
  12. data/config.yml +190 -62
  13. data/core/array.rbs +44 -43
  14. data/core/dir.rbs +2 -2
  15. data/core/encoding.rbs +3 -2
  16. data/core/enumerable.rbs +89 -2
  17. data/core/errno.rbs +8 -0
  18. data/core/errors.rbs +28 -1
  19. data/core/exception.rbs +2 -2
  20. data/core/fiber.rbs +3 -3
  21. data/core/file.rbs +26 -11
  22. data/core/float.rbs +1 -1
  23. data/core/gc.rbs +422 -281
  24. data/core/hash.rbs +1024 -727
  25. data/core/io/wait.rbs +11 -33
  26. data/core/io.rbs +6 -4
  27. data/core/kernel.rbs +49 -43
  28. data/core/marshal.rbs +1 -1
  29. data/core/match_data.rbs +1 -1
  30. data/core/math.rbs +42 -3
  31. data/core/method.rbs +14 -6
  32. data/core/module.rbs +71 -11
  33. data/core/nil_class.rbs +3 -3
  34. data/core/numeric.rbs +8 -8
  35. data/core/object.rbs +3 -3
  36. data/core/object_space.rbs +13 -0
  37. data/{stdlib/pathname/0 → core}/pathname.rbs +253 -352
  38. data/core/proc.rbs +15 -8
  39. data/core/process.rbs +2 -2
  40. data/core/ractor.rbs +278 -437
  41. data/core/range.rbs +6 -7
  42. data/core/rbs/unnamed/argf.rbs +1 -1
  43. data/core/rbs/unnamed/env_class.rbs +1 -1
  44. data/core/rbs/unnamed/random.rbs +4 -2
  45. data/core/regexp.rbs +22 -17
  46. data/core/ruby_vm.rbs +6 -4
  47. data/core/rubygems/errors.rbs +3 -70
  48. data/core/rubygems/rubygems.rbs +11 -79
  49. data/core/set.rbs +439 -332
  50. data/core/string.rbs +2897 -1117
  51. data/core/struct.rbs +1 -1
  52. data/core/symbol.rbs +4 -4
  53. data/core/thread.rbs +83 -20
  54. data/core/time.rbs +35 -9
  55. data/core/unbound_method.rbs +14 -6
  56. data/docs/aliases.md +79 -0
  57. data/docs/collection.md +2 -2
  58. data/docs/gem.md +0 -1
  59. data/docs/sigs.md +3 -3
  60. data/ext/rbs_extension/ast_translation.c +1016 -0
  61. data/ext/rbs_extension/ast_translation.h +37 -0
  62. data/ext/rbs_extension/class_constants.c +157 -0
  63. data/{include/rbs/constants.h → ext/rbs_extension/class_constants.h} +7 -1
  64. data/ext/rbs_extension/compat.h +10 -0
  65. data/ext/rbs_extension/extconf.rb +25 -1
  66. data/ext/rbs_extension/legacy_location.c +317 -0
  67. data/ext/rbs_extension/legacy_location.h +45 -0
  68. data/ext/rbs_extension/main.c +365 -14
  69. data/ext/rbs_extension/rbs_extension.h +6 -21
  70. data/ext/rbs_extension/rbs_string_bridging.c +9 -0
  71. data/ext/rbs_extension/rbs_string_bridging.h +24 -0
  72. data/include/rbs/ast.h +687 -0
  73. data/include/rbs/defines.h +86 -0
  74. data/include/rbs/lexer.h +199 -0
  75. data/include/rbs/location.h +59 -0
  76. data/include/rbs/parser.h +135 -0
  77. data/include/rbs/string.h +49 -0
  78. data/include/rbs/util/rbs_allocator.h +59 -0
  79. data/include/rbs/util/rbs_assert.h +20 -0
  80. data/include/rbs/util/rbs_buffer.h +83 -0
  81. data/include/rbs/util/rbs_constant_pool.h +6 -67
  82. data/include/rbs/util/rbs_encoding.h +282 -0
  83. data/include/rbs/util/rbs_unescape.h +23 -0
  84. data/include/rbs.h +1 -2
  85. data/lib/rbs/annotate/formatter.rb +3 -13
  86. data/lib/rbs/annotate/rdoc_annotator.rb +3 -1
  87. data/lib/rbs/annotate/rdoc_source.rb +1 -1
  88. data/lib/rbs/cli/validate.rb +2 -2
  89. data/lib/rbs/cli.rb +1 -1
  90. data/lib/rbs/collection/config/lockfile_generator.rb +1 -0
  91. data/lib/rbs/definition_builder/ancestor_builder.rb +5 -5
  92. data/lib/rbs/environment.rb +64 -59
  93. data/lib/rbs/environment_loader.rb +1 -1
  94. data/lib/rbs/errors.rb +1 -1
  95. data/lib/rbs/parser_aux.rb +5 -0
  96. data/lib/rbs/resolver/constant_resolver.rb +2 -2
  97. data/lib/rbs/resolver/type_name_resolver.rb +124 -38
  98. data/lib/rbs/test/type_check.rb +13 -0
  99. data/lib/rbs/types.rb +3 -1
  100. data/lib/rbs/version.rb +1 -1
  101. data/lib/rbs.rb +1 -1
  102. data/lib/rdoc/discover.rb +1 -1
  103. data/lib/rdoc_plugin/parser.rb +3 -3
  104. data/sig/annotate/formatter.rbs +2 -2
  105. data/sig/annotate/rdoc_annotater.rbs +1 -1
  106. data/sig/environment.rbs +57 -6
  107. data/sig/manifest.yaml +0 -1
  108. data/sig/parser.rbs +20 -0
  109. data/sig/resolver/type_name_resolver.rbs +38 -7
  110. data/sig/types.rbs +4 -1
  111. data/src/ast.c +1256 -0
  112. data/src/lexer.c +2956 -0
  113. data/src/lexer.re +147 -0
  114. data/src/lexstate.c +205 -0
  115. data/src/location.c +71 -0
  116. data/src/parser.c +3495 -0
  117. data/src/string.c +90 -0
  118. data/src/util/rbs_allocator.c +152 -0
  119. data/src/util/rbs_assert.c +21 -0
  120. data/src/util/rbs_buffer.c +54 -0
  121. data/src/util/rbs_constant_pool.c +16 -86
  122. data/src/util/rbs_encoding.c +21308 -0
  123. data/src/util/rbs_unescape.c +131 -0
  124. data/stdlib/cgi/0/core.rbs +2 -396
  125. data/stdlib/cgi/0/manifest.yaml +1 -0
  126. data/stdlib/cgi-escape/0/escape.rbs +153 -0
  127. data/stdlib/coverage/0/coverage.rbs +3 -1
  128. data/stdlib/delegate/0/delegator.rbs +10 -7
  129. data/stdlib/erb/0/erb.rbs +737 -347
  130. data/stdlib/fileutils/0/fileutils.rbs +18 -13
  131. data/stdlib/forwardable/0/forwardable.rbs +3 -0
  132. data/stdlib/json/0/json.rbs +67 -48
  133. data/stdlib/net-http/0/net-http.rbs +3 -0
  134. data/stdlib/objspace/0/objspace.rbs +8 -3
  135. data/stdlib/open-uri/0/open-uri.rbs +40 -0
  136. data/stdlib/openssl/0/openssl.rbs +182 -149
  137. data/stdlib/optparse/0/optparse.rbs +3 -3
  138. data/stdlib/rdoc/0/code_object.rbs +2 -2
  139. data/stdlib/rdoc/0/comment.rbs +2 -0
  140. data/stdlib/rdoc/0/options.rbs +76 -0
  141. data/stdlib/rdoc/0/rdoc.rbs +7 -5
  142. data/stdlib/rdoc/0/store.rbs +1 -1
  143. data/stdlib/resolv/0/resolv.rbs +25 -68
  144. data/stdlib/ripper/0/ripper.rbs +5 -2
  145. data/stdlib/singleton/0/singleton.rbs +3 -0
  146. data/stdlib/socket/0/socket.rbs +13 -1
  147. data/stdlib/socket/0/tcp_socket.rbs +10 -2
  148. data/stdlib/stringio/0/stringio.rbs +412 -80
  149. data/stdlib/strscan/0/string_scanner.rbs +31 -31
  150. data/stdlib/tempfile/0/tempfile.rbs +1 -1
  151. data/stdlib/tsort/0/cyclic.rbs +3 -0
  152. data/stdlib/uri/0/common.rbs +11 -2
  153. data/stdlib/uri/0/file.rbs +1 -1
  154. data/stdlib/uri/0/generic.rbs +16 -15
  155. data/stdlib/uri/0/rfc2396_parser.rbs +6 -7
  156. data/stdlib/zlib/0/zstream.rbs +1 -0
  157. metadata +41 -18
  158. data/ext/rbs_extension/lexer.c +0 -2728
  159. data/ext/rbs_extension/lexer.h +0 -179
  160. data/ext/rbs_extension/lexer.re +0 -147
  161. data/ext/rbs_extension/lexstate.c +0 -175
  162. data/ext/rbs_extension/location.c +0 -325
  163. data/ext/rbs_extension/location.h +0 -85
  164. data/ext/rbs_extension/parser.c +0 -2982
  165. data/ext/rbs_extension/parser.h +0 -18
  166. data/ext/rbs_extension/parserstate.c +0 -411
  167. data/ext/rbs_extension/parserstate.h +0 -163
  168. data/ext/rbs_extension/unescape.c +0 -32
  169. data/include/rbs/ruby_objs.h +0 -72
  170. data/src/constants.c +0 -153
  171. data/src/ruby_objs.c +0 -799
@@ -0,0 +1,131 @@
1
+ #include "rbs/util/rbs_unescape.h"
2
+ #include <string.h>
3
+ #include <stdlib.h>
4
+ #include <ctype.h>
5
+
6
+ // Define the escape character mappings
7
+ // TODO: use a switch instead
8
+ static const struct {
9
+ const char *from;
10
+ const char *to;
11
+ } TABLE[] = {
12
+ { "\\a", "\a" },
13
+ { "\\b", "\b" },
14
+ { "\\e", "\033" },
15
+ { "\\f", "\f" },
16
+ { "\\n", "\n" },
17
+ { "\\r", "\r" },
18
+ { "\\s", " " },
19
+ { "\\t", "\t" },
20
+ { "\\v", "\v" },
21
+ { "\\\"", "\"" },
22
+ { "\\'", "'" },
23
+ { "\\\\", "\\" },
24
+ { "\\", "" }
25
+ };
26
+
27
+ // Helper function to convert hex string to integer
28
+ static int hex_to_int(const char *hex, int length) {
29
+ int result = 0;
30
+ for (int i = 0; i < length; i++) {
31
+ result = result * 16 + (isdigit(hex[i]) ? hex[i] - '0' : tolower(hex[i]) - 'a' + 10);
32
+ }
33
+ return result;
34
+ }
35
+
36
+ // Helper function to convert octal string to integer
37
+ static int octal_to_int(const char *octal, int length) {
38
+ int result = 0;
39
+ for (int i = 0; i < length; i++) {
40
+ result = result * 8 + (octal[i] - '0');
41
+ }
42
+ return result;
43
+ }
44
+
45
+ int rbs_utf8_codelen(unsigned int c) {
46
+ if (c <= 0x7F) return 1;
47
+ if (c <= 0x7FF) return 2;
48
+ if (c <= 0xFFFF) return 3;
49
+ if (c <= 0x10FFFF) return 4;
50
+ return 1; // Invalid Unicode codepoint, treat as 1 byte
51
+ }
52
+
53
+ rbs_string_t unescape_string(rbs_allocator_t *allocator, const rbs_string_t string, bool is_double_quote) {
54
+ if (!string.start) return RBS_STRING_NULL;
55
+
56
+ size_t len = string.end - string.start;
57
+ const char *input = string.start;
58
+
59
+ char *output = rbs_allocator_alloc_many(allocator, len + 1, char);
60
+ if (!output) return RBS_STRING_NULL;
61
+
62
+ size_t i = 0, j = 0;
63
+ while (i < len) {
64
+ if (input[i] == '\\' && i + 1 < len) {
65
+ if (is_double_quote) {
66
+ if (isdigit(input[i + 1])) {
67
+ // Octal escape
68
+ int octal_len = 1;
69
+ while (octal_len < 3 && i + 1 + octal_len < len && isdigit(input[i + 1 + octal_len]))
70
+ octal_len++;
71
+ int value = octal_to_int(input + i + 1, octal_len);
72
+ output[j++] = (char) value;
73
+ i += octal_len + 1;
74
+ } else if (input[i + 1] == 'x' && i + 3 < len) {
75
+ // Hex escape
76
+ int hex_len = isxdigit(input[i + 3]) ? 2 : 1;
77
+ int value = hex_to_int(input + i + 2, hex_len);
78
+ output[j++] = (char) value;
79
+ i += hex_len + 2;
80
+ } else if (input[i + 1] == 'u' && i + 5 < len) {
81
+ // Unicode escape
82
+ int value = hex_to_int(input + i + 2, 4);
83
+ output[j++] = (char) value;
84
+ i += 6;
85
+ } else {
86
+ // Other escapes
87
+ int found = 0;
88
+ for (size_t k = 0; k < sizeof(TABLE) / sizeof(TABLE[0]); k++) {
89
+ if (strncmp(input + i, TABLE[k].from, strlen(TABLE[k].from)) == 0) {
90
+ output[j++] = TABLE[k].to[0];
91
+ i += strlen(TABLE[k].from);
92
+ found = 1;
93
+ break;
94
+ }
95
+ }
96
+ if (!found) {
97
+ output[j++] = input[i++];
98
+ }
99
+ }
100
+ } else {
101
+ /* Single quote: only escape ' and \ */
102
+ if (input[i + 1] == '\'' || input[i + 1] == '\\') {
103
+ output[j++] = input[i + 1];
104
+ i += 2;
105
+ } else {
106
+ output[j++] = input[i++];
107
+ }
108
+ }
109
+ } else {
110
+ output[j++] = input[i++];
111
+ }
112
+ }
113
+ output[j] = '\0';
114
+ return rbs_string_new(output, output + j);
115
+ }
116
+
117
+ rbs_string_t rbs_unquote_string(rbs_allocator_t *allocator, rbs_string_t input) {
118
+ unsigned int first_char = rbs_utf8_string_to_codepoint(input);
119
+ size_t byte_length = rbs_string_len(input);
120
+
121
+ ptrdiff_t start_offset = 0;
122
+ if (first_char == '"' || first_char == '\'' || first_char == '`') {
123
+ int bs = rbs_utf8_codelen(first_char);
124
+ start_offset += bs;
125
+ byte_length -= 2 * bs;
126
+ }
127
+
128
+ const char *new_start = input.start + start_offset;
129
+ rbs_string_t string = rbs_string_new(new_start, new_start + byte_length);
130
+ return unescape_string(allocator, string, first_char == '"');
131
+ }
@@ -1,274 +1,5 @@
1
- # <!-- rdoc-file=lib/cgi.rb -->
2
- # ## Overview
3
- #
4
- # The Common Gateway Interface (CGI) is a simple protocol for passing an HTTP
5
- # request from a web server to a standalone program, and returning the output to
6
- # the web browser. Basically, a CGI program is called with the parameters of
7
- # the request passed in either in the environment (GET) or via $stdin (POST),
8
- # and everything it prints to $stdout is returned to the client.
9
- #
10
- # This file holds the CGI class. This class provides functionality for
11
- # retrieving HTTP request parameters, managing cookies, and generating HTML
12
- # output.
13
- #
14
- # The file CGI::Session provides session management functionality; see that
15
- # class for more details.
16
- #
17
- # See http://www.w3.org/CGI/ for more information on the CGI protocol.
18
- #
19
- # ## Introduction
20
- #
21
- # CGI is a large class, providing several categories of methods, many of which
22
- # are mixed in from other modules. Some of the documentation is in this class,
23
- # some in the modules CGI::QueryExtension and CGI::HtmlExtension. See
24
- # CGI::Cookie for specific information on handling cookies, and cgi/session.rb
25
- # (CGI::Session) for information on sessions.
26
- #
27
- # For queries, CGI provides methods to get at environmental variables,
28
- # parameters, cookies, and multipart request data. For responses, CGI provides
29
- # methods for writing output and generating HTML.
30
- #
31
- # Read on for more details. Examples are provided at the bottom.
32
- #
33
- # ## Queries
34
- #
35
- # The CGI class dynamically mixes in parameter and cookie-parsing functionality,
36
- # environmental variable access, and support for parsing multipart requests
37
- # (including uploaded files) from the CGI::QueryExtension module.
38
- #
39
- # ### Environmental Variables
40
- #
41
- # The standard CGI environmental variables are available as read-only attributes
42
- # of a CGI object. The following is a list of these variables:
43
- #
44
- # AUTH_TYPE HTTP_HOST REMOTE_IDENT
45
- # CONTENT_LENGTH HTTP_NEGOTIATE REMOTE_USER
46
- # CONTENT_TYPE HTTP_PRAGMA REQUEST_METHOD
47
- # GATEWAY_INTERFACE HTTP_REFERER SCRIPT_NAME
48
- # HTTP_ACCEPT HTTP_USER_AGENT SERVER_NAME
49
- # HTTP_ACCEPT_CHARSET PATH_INFO SERVER_PORT
50
- # HTTP_ACCEPT_ENCODING PATH_TRANSLATED SERVER_PROTOCOL
51
- # HTTP_ACCEPT_LANGUAGE QUERY_STRING SERVER_SOFTWARE
52
- # HTTP_CACHE_CONTROL REMOTE_ADDR
53
- # HTTP_FROM REMOTE_HOST
54
- #
55
- # For each of these variables, there is a corresponding attribute with the same
56
- # name, except all lower case and without a preceding HTTP_. `content_length`
57
- # and `server_port` are integers; the rest are strings.
58
- #
59
- # ### Parameters
60
- #
61
- # The method #params() returns a hash of all parameters in the request as
62
- # name/value-list pairs, where the value-list is an Array of one or more values.
63
- # The CGI object itself also behaves as a hash of parameter names to values,
64
- # but only returns a single value (as a String) for each parameter name.
65
- #
66
- # For instance, suppose the request contains the parameter "favourite_colours"
67
- # with the multiple values "blue" and "green". The following behavior would
68
- # occur:
69
- #
70
- # cgi.params["favourite_colours"] # => ["blue", "green"]
71
- # cgi["favourite_colours"] # => "blue"
72
- #
73
- # If a parameter does not exist, the former method will return an empty array,
74
- # the latter an empty string. The simplest way to test for existence of a
75
- # parameter is by the #has_key? method.
76
- #
77
- # ### Cookies
78
- #
79
- # HTTP Cookies are automatically parsed from the request. They are available
80
- # from the #cookies() accessor, which returns a hash from cookie name to
81
- # CGI::Cookie object.
82
- #
83
- # ### Multipart requests
84
- #
85
- # If a request's method is POST and its content type is multipart/form-data,
86
- # then it may contain uploaded files. These are stored by the QueryExtension
87
- # module in the parameters of the request. The parameter name is the name
88
- # attribute of the file input field, as usual. However, the value is not a
89
- # string, but an IO object, either an IOString for small files, or a Tempfile
90
- # for larger ones. This object also has the additional singleton methods:
91
- #
92
- # #local_path()
93
- # : the path of the uploaded file on the local filesystem
94
- #
95
- # #original_filename()
96
- # : the name of the file on the client computer
97
- #
98
- # #content_type()
99
- # : the content type of the file
100
- #
101
- #
102
- # ## Responses
103
- #
104
- # The CGI class provides methods for sending header and content output to the
105
- # HTTP client, and mixes in methods for programmatic HTML generation from
106
- # CGI::HtmlExtension and CGI::TagMaker modules. The precise version of HTML to
107
- # use for HTML generation is specified at object creation time.
108
- #
109
- # ### Writing output
110
- #
111
- # The simplest way to send output to the HTTP client is using the #out() method.
112
- # This takes the HTTP headers as a hash parameter, and the body content via a
113
- # block. The headers can be generated as a string using the #http_header()
114
- # method. The output stream can be written directly to using the #print()
115
- # method.
116
- #
117
- # ### Generating HTML
118
- #
119
- # Each HTML element has a corresponding method for generating that element as a
120
- # String. The name of this method is the same as that of the element, all
121
- # lowercase. The attributes of the element are passed in as a hash, and the
122
- # body as a no-argument block that evaluates to a String. The HTML generation
123
- # module knows which elements are always empty, and silently drops any passed-in
124
- # body. It also knows which elements require matching closing tags and which
125
- # don't. However, it does not know what attributes are legal for which
126
- # elements.
127
- #
128
- # There are also some additional HTML generation methods mixed in from the
129
- # CGI::HtmlExtension module. These include individual methods for the different
130
- # types of form inputs, and methods for elements that commonly take particular
131
- # attributes where the attributes can be directly specified as arguments, rather
132
- # than via a hash.
133
- #
134
- # ### Utility HTML escape and other methods like a function.
135
- #
136
- # There are some utility tool defined in cgi/util.rb . And when include, you can
137
- # use utility methods like a function.
138
- #
139
- # ## Examples of use
140
- #
141
- # ### Get form values
142
- #
143
- # require "cgi"
144
- # cgi = CGI.new
145
- # value = cgi['field_name'] # <== value string for 'field_name'
146
- # # if not 'field_name' included, then return "".
147
- # fields = cgi.keys # <== array of field names
148
- #
149
- # # returns true if form has 'field_name'
150
- # cgi.has_key?('field_name')
151
- # cgi.has_key?('field_name')
152
- # cgi.include?('field_name')
153
- #
154
- # CAUTION! `cgi['field_name']` returned an Array with the old cgi.rb(included in
155
- # Ruby 1.6)
156
- #
157
- # ### Get form values as hash
158
- #
159
- # require "cgi"
160
- # cgi = CGI.new
161
- # params = cgi.params
162
- #
163
- # cgi.params is a hash.
164
- #
165
- # cgi.params['new_field_name'] = ["value"] # add new param
166
- # cgi.params['field_name'] = ["new_value"] # change value
167
- # cgi.params.delete('field_name') # delete param
168
- # cgi.params.clear # delete all params
169
- #
170
- # ### Save form values to file
171
- #
172
- # require "pstore"
173
- # db = PStore.new("query.db")
174
- # db.transaction do
175
- # db["params"] = cgi.params
176
- # end
177
- #
178
- # ### Restore form values from file
179
- #
180
- # require "pstore"
181
- # db = PStore.new("query.db")
182
- # db.transaction do
183
- # cgi.params = db["params"]
184
- # end
185
- #
186
- # ### Get multipart form values
187
- #
188
- # require "cgi"
189
- # cgi = CGI.new
190
- # value = cgi['field_name'] # <== value string for 'field_name'
191
- # value.read # <== body of value
192
- # value.local_path # <== path to local file of value
193
- # value.original_filename # <== original filename of value
194
- # value.content_type # <== content_type of value
195
- #
196
- # and value has StringIO or Tempfile class methods.
197
- #
198
- # ### Get cookie values
199
- #
200
- # require "cgi"
201
- # cgi = CGI.new
202
- # values = cgi.cookies['name'] # <== array of 'name'
203
- # # if not 'name' included, then return [].
204
- # names = cgi.cookies.keys # <== array of cookie names
205
- #
206
- # and cgi.cookies is a hash.
207
- #
208
- # ### Get cookie objects
209
- #
210
- # require "cgi"
211
- # cgi = CGI.new
212
- # for name, cookie in cgi.cookies
213
- # cookie.expires = Time.now + 30
214
- # end
215
- # cgi.out("cookie" => cgi.cookies) {"string"}
216
- #
217
- # cgi.cookies # { "name1" => cookie1, "name2" => cookie2, ... }
218
- #
219
- # require "cgi"
220
- # cgi = CGI.new
221
- # cgi.cookies['name'].expires = Time.now + 30
222
- # cgi.out("cookie" => cgi.cookies['name']) {"string"}
223
- #
224
- # ### Print http header and html string to $DEFAULT_OUTPUT ($>)
225
- #
226
- # require "cgi"
227
- # cgi = CGI.new("html4") # add HTML generation methods
228
- # cgi.out do
229
- # cgi.html do
230
- # cgi.head do
231
- # cgi.title { "TITLE" }
232
- # end +
233
- # cgi.body do
234
- # cgi.form("ACTION" => "uri") do
235
- # cgi.p do
236
- # cgi.textarea("get_text") +
237
- # cgi.br +
238
- # cgi.submit
239
- # end
240
- # end +
241
- # cgi.pre do
242
- # CGI.escapeHTML(
243
- # "params: #{cgi.params.inspect}\n" +
244
- # "cookies: #{cgi.cookies.inspect}\n" +
245
- # ENV.collect do |key, value|
246
- # "#{key} --> #{value}\n"
247
- # end.join("")
248
- # )
249
- # end
250
- # end
251
- # end
252
- # end
253
- #
254
- # # add HTML generation methods
255
- # CGI.new("html3") # html3.2
256
- # CGI.new("html4") # html4.01 (Strict)
257
- # CGI.new("html4Tr") # html4.01 Transitional
258
- # CGI.new("html4Fr") # html4.01 Frameset
259
- # CGI.new("html5") # html5
260
- #
261
- # ### Some utility methods
262
- #
263
- # require 'cgi/util'
264
- # CGI.escapeHTML('Usage: foo "bar" <baz>')
265
- #
266
- # ### Some utility methods like a function
267
- #
268
- # require 'cgi/util'
269
- # include CGI::Util
270
- # escapeHTML('Usage: foo "bar" <baz>')
271
- # h('Usage: foo "bar" <baz>') # alias
1
+ # <!-- rdoc-file=lib/cgi/escape.rb -->
2
+ # :stopdoc
272
3
  #
273
4
  class CGI
274
5
  include CGI::Util
@@ -906,66 +637,6 @@ class CGI
906
637
  | (Hash[String, untyped] options_hash) -> void
907
638
  end
908
639
 
909
- module Escape
910
- # <!--
911
- # rdoc-file=ext/cgi/escape/escape.c
912
- # - CGI.escape(string) -> string
913
- # -->
914
- # Returns URL-escaped string (`application/x-www-form-urlencoded`).
915
- #
916
- def escape: (string str) -> String
917
-
918
- # <!--
919
- # rdoc-file=ext/cgi/escape/escape.c
920
- # - CGI.escapeHTML(string) -> string
921
- # -->
922
- # Returns HTML-escaped string.
923
- #
924
- def escapeHTML: (string str) -> String
925
-
926
- # <!--
927
- # rdoc-file=ext/cgi/escape/escape.c
928
- # - CGI.escapeURIComponent(string) -> string
929
- # -->
930
- # Returns URL-escaped string following RFC 3986.
931
- #
932
- def escapeURIComponent: (string) -> String
933
-
934
- # <!-- rdoc-file=ext/cgi/escape/escape.c -->
935
- # Returns URL-escaped string following RFC 3986.
936
- #
937
- alias escape_uri_component escapeURIComponent
938
-
939
- # <!--
940
- # rdoc-file=ext/cgi/escape/escape.c
941
- # - CGI.unescape(string, encoding=@@accept_charset) -> string
942
- # -->
943
- # Returns URL-unescaped string (`application/x-www-form-urlencoded`).
944
- #
945
- def unescape: (string str, ?encoding encoding) -> String
946
-
947
- # <!--
948
- # rdoc-file=ext/cgi/escape/escape.c
949
- # - CGI.unescapeHTML(string) -> string
950
- # -->
951
- # Returns HTML-unescaped string.
952
- #
953
- def unescapeHTML: (string str) -> String
954
-
955
- # <!--
956
- # rdoc-file=ext/cgi/escape/escape.c
957
- # - CGI.unescapeURIComponent(string, encoding=@@accept_charset) -> string
958
- # -->
959
- # Returns URL-unescaped string following RFC 3986.
960
- #
961
- def unescapeURIComponent: (string) -> String
962
-
963
- # <!-- rdoc-file=ext/cgi/escape/escape.c -->
964
- # Returns URL-unescaped string following RFC 3986.
965
- #
966
- alias unescape_uri_component unescapeURIComponent
967
- end
968
-
969
640
  # <!-- rdoc-file=lib/cgi/core.rb -->
970
641
  # Exception raised when there is an invalid encoding detected
971
642
  #
@@ -1182,45 +853,6 @@ class CGI
1182
853
  end
1183
854
 
1184
855
  module Util
1185
- include CGI::Escape
1186
-
1187
- # <!--
1188
- # rdoc-file=lib/cgi/util.rb
1189
- # - escapeElement(string, *elements)
1190
- # -->
1191
- # Escape only the tags of certain HTML elements in `string`.
1192
- #
1193
- # Takes an element or elements or array of elements. Each element is specified
1194
- # by the name of the element, without angle brackets. This matches both the
1195
- # start and the end tag of that element. The attribute list of the open tag will
1196
- # also be escaped (for instance, the double-quotes surrounding attribute
1197
- # values).
1198
- #
1199
- # print CGI.escapeElement('<BR><A HREF="url"></A>', "A", "IMG")
1200
- # # "<BR>&lt;A HREF=&quot;url&quot;&gt;&lt;/A&gt"
1201
- #
1202
- # print CGI.escapeElement('<BR><A HREF="url"></A>', ["A", "IMG"])
1203
- # # "<BR>&lt;A HREF=&quot;url&quot;&gt;&lt;/A&gt"
1204
- #
1205
- def escapeElement: (string string, *String | Array[String] elements) -> String
1206
-
1207
- # <!-- rdoc-file=lib/cgi/util.rb -->
1208
- # Synonym for CGI.escapeElement(str)
1209
- #
1210
- alias escape_element escapeElement
1211
-
1212
- # <!-- rdoc-file=lib/cgi/util.rb -->
1213
- # Synonym for CGI.escapeHTML(str)
1214
- #
1215
- alias escape_html escapeHTML
1216
-
1217
- # <!--
1218
- # rdoc-file=lib/cgi/util.rb
1219
- # - h(string)
1220
- # -->
1221
- #
1222
- alias h escapeHTML
1223
-
1224
856
  # <!--
1225
857
  # rdoc-file=lib/cgi/util.rb
1226
858
  # - pretty(string, shift = " ")
@@ -1255,32 +887,6 @@ class CGI
1255
887
  #
1256
888
  def rfc1123_date: (Time time) -> String
1257
889
 
1258
- # <!--
1259
- # rdoc-file=lib/cgi/util.rb
1260
- # - unescapeElement(string, *elements)
1261
- # -->
1262
- # Undo escaping such as that done by CGI.escapeElement()
1263
- #
1264
- # print CGI.unescapeElement(
1265
- # CGI.escapeHTML('<BR><A HREF="url"></A>'), "A", "IMG")
1266
- # # "&lt;BR&gt;<A HREF="url"></A>"
1267
- #
1268
- # print CGI.unescapeElement(
1269
- # CGI.escapeHTML('<BR><A HREF="url"></A>'), ["A", "IMG"])
1270
- # # "&lt;BR&gt;<A HREF="url"></A>"
1271
- #
1272
- def unescapeElement: (string string, *String | Array[String] elements) -> String
1273
-
1274
- # <!-- rdoc-file=lib/cgi/util.rb -->
1275
- # Synonym for CGI.unescapeElement(str)
1276
- #
1277
- alias unescape_element unescapeElement
1278
-
1279
- # <!-- rdoc-file=lib/cgi/util.rb -->
1280
- # Synonym for CGI.unescapeHTML(str)
1281
- #
1282
- alias unescape_html unescapeHTML
1283
-
1284
890
  # Abbreviated day-of-week names specified by RFC 822
1285
891
  RFC822_DAYS: Array[String]
1286
892
 
@@ -1,3 +1,4 @@
1
1
  dependencies:
2
2
  - name: tempfile
3
3
  - name: stringio
4
+ - name: cgi-escape