-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
params.cr
399 lines (363 loc) · 10.5 KB
/
params.cr
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
require "./encoding"
class URI
# An ordered multi-value mapped collection representing generic URI parameters.
struct Params
include Enumerable({String, String})
# Parses an URI query string into a `URI::Params`
#
# ```
# require "uri/params"
#
# URI::Params.parse("foo=bar&foo=baz&qux=zoo")
# # => #<URI::Params @raw_params = {"foo" => ["bar", "baz"], "qux" => ["zoo"]}>
# ```
def self.parse(query : String) : self
parsed = {} of String => Array(String)
parse(query) do |key, value|
ary = parsed[key] ||= [] of String
ary.push value
end
Params.new(parsed)
end
# Parses an URI query and yields each key-value pair.
#
# ```
# require "uri/params"
#
# query = "foo=bar&foo=baz&qux=zoo"
# URI::Params.parse(query) do |key, value|
# # ...
# end
# ```
def self.parse(query : String)
return if query.empty?
key = nil
buffer = IO::Memory.new
i = 0
first_equal = true
bytesize = query.bytesize
while i < bytesize
byte = query.unsafe_byte_at(i)
char = byte.unsafe_chr
case char
when '='
if first_equal
key = buffer.to_s
buffer.clear
i += 1
first_equal = false
else
i = decode_one_www_form_component query, bytesize, i, byte, char, buffer
end
when '&', ';'
value = buffer.to_s
buffer.clear
if key
yield key.not_nil!, value
else
yield value, "" unless value.empty?
end
key = nil
first_equal = true
i += 1
else
i = decode_one_www_form_component query, bytesize, i, byte, char, buffer
end
end
if key
yield key.not_nil!, buffer.to_s
else
yield buffer.to_s, "" unless buffer.empty?
end
end
# Returns the given key value pairs as a url-encoded URI form/query.
#
# ```
# require "uri/params"
#
# URI::Params.encode({"foo" => "bar", "baz" => ["quux", "quuz"]}) # => "foo=bar&baz=quux&baz=quuz"
# ```
def self.encode(hash : Hash(String, String | Array(String))) : String
build do |builder|
hash.each do |key, value|
builder.add key, value
end
end
end
# Returns the given key value pairs as a url-encoded URI form/query.
#
# ```
# require "uri/params"
#
# URI::Params.encode({foo: "bar", baz: ["quux", "quuz"]}) # => "foo=bar&baz=quux&baz=quuz"
# ```
def self.encode(named_tuple : NamedTuple)
build do |builder|
named_tuple.each do |key, value|
builder.add key.to_s, value
end
end
end
# Builds an url-encoded URI form/query.
#
# The yielded object has an `add` method that accepts two arguments,
# a key (`String`) and a value (`String` or `Nil`).
# Keys and values are escaped using `URI.encode_www_form`.
#
# ```
# require "uri/params"
#
# params = URI::Params.build do |form|
# form.add "color", "black"
# form.add "name", "crystal"
# form.add "year", "2012 - today"
# end
# params # => "color=black&name=crystal&year=2012+-+today"
# ```
def self.build(&block : Builder ->) : String
String.build do |io|
yield Builder.new(io)
end
end
protected getter raw_params
# Returns an empty `URI::Params`.
def initialize
@raw_params = {} of String => Array(String)
end
def initialize(@raw_params : Hash(String, Array(String)))
end
def_equals_and_hash @raw_params
# Returns a copy of this `URI::Params` instance.
#
# ```
# require "uri/params"
#
# original = URI::Params{"name" => "Jamie"}
# updated = original.dup
# updated["name"] = "Ary"
#
# original["name"] # => "Jamie"
# ```
#
# Identical to `#clone`.
def dup : self
# Since the component types (keys and values) are immutable, there's no
# difference between deep and shallow copy, so we can just use `clone`
# here.
clone
end
# Returns a copy of this `URI::Params` instance.
#
# ```
# require "uri/params"
#
# original = URI::Params{"name" => "Jamie"}
# updated = original.clone
# updated["name"] = "Ary"
#
# original["name"] # => "Jamie"
# ```
#
# Identical to `#dup`.
def clone : self
self.class.new(raw_params.clone)
end
# Returns first value for specified param name.
#
# ```
# require "uri/params"
#
# params = URI::Params.parse("email=john@example.org")
# params["email"] # => "john@example.org"
# params["non_existent_param"] # KeyError
# ```
def [](name) : String
fetch(name) { raise KeyError.new "Missing param name: #{name.inspect}" }
end
# Returns first value or `nil` for specified param *name*.
#
# ```
# params["email"]? # => "john@example.org"
# params["non_existent_param"]? # nil
# ```
def []?(name) : String?
fetch(name, nil)
end
# Returns `true` if param with provided name exists.
#
# ```
# params.has_key?("email") # => true
# params.has_key?("garbage") # => false
# ```
delegate has_key?, to: raw_params
# Returns `true` if params is empty.
#
# ```
# URI::Params.new.empty? # => true
# URI::Params.parse("foo=bar&foo=baz&qux=zoo").empty? # => false
# ```
delegate empty?, to: raw_params
# Sets the *name* key to *value*.
#
# ```
# require "uri/params"
#
# params = URI::Params{"a" => ["b", "c"]}
# params["a"] = "d"
# params["a"] # => "d"
# params.fetch_all("a") # => ["d"]
#
# params["a"] = ["e", "f"]
# params["a"] # => "e"
# params.fetch_all("a") # => ["e", "f"]
# ```
def []=(name, value : String | Array(String))
raw_params[name] =
case value
in String then [value]
in Array(String) then value
end
end
# Returns all values for specified param *name*.
#
# ```
# params.set_all("item", ["pencil", "book", "workbook"])
# params.fetch_all("item") # => ["pencil", "book", "workbook"]
# ```
def fetch_all(name) : Array(String)
raw_params.fetch(name) { [] of String }
end
# Returns first value for specified param *name*. Falls back to provided
# *default* value when there is no such param.
#
# ```
# params["email"] = "john@example.org"
# params.fetch("email", "none@example.org") # => "john@example.org"
# params.fetch("non_existent_param", "default value") # => "default value"
# ```
def fetch(name, default)
fetch(name) { default }
end
# Returns first value for specified param *name*. Falls back to return value
# of provided block when there is no such param.
#
# ```
# params.delete("email")
# params.fetch("email") { raise "Email is missing" } # raises "Email is missing"
# params.fetch("non_existent_param") { "default computed value" } # => "default computed value"
# ```
def fetch(name)
return yield name unless has_key?(name)
raw_params[name].first
end
# Appends new value for specified param *name*.
# Creates param when there was no such param.
#
# ```
# params.add("item", "keychain")
# params.fetch_all("item") # => ["pencil", "book", "workbook", "keychain"]
# ```
def add(name, value)
raw_params[name] ||= [] of String
raw_params[name] = [] of String if raw_params[name] == [""]
raw_params[name] << value
end
# Sets all *values* for specified param *name* at once.
#
# ```
# params.set_all("item", ["keychain", "keynote"])
# params.fetch_all("item") # => ["keychain", "keynote"]
# ```
def set_all(name, values)
raw_params[name] = values
end
# Allows to iterate over all name-value pairs.
#
# ```
# params.each do |name, value|
# puts "#{name} => #{value}"
# end
#
# # Outputs:
# # email => john@example.org
# # item => keychain
# # item => keynote
# ```
def each
raw_params.each do |name, values|
values.each do |value|
yield({name, value})
end
end
end
# Deletes first value for provided param *name*. If there are no values left,
# deletes param itself. Returns deleted value.
#
# ```
# params.delete("item") # => "keychain"
# params.fetch_all("item") # => ["keynote"]
#
# params.delete("item") # => "keynote"
# params["item"] # KeyError
#
# params.delete("non_existent_param") # KeyError
# ```
def delete(name) : String
value = raw_params[name].shift
raw_params.delete(name) if raw_params[name].size == 0
value
end
# Deletes all values for provided param *name*. Returns array of deleted
# values.
#
# ```
# params.set_all("comments", ["hello, world!", ":+1:"])
# params.delete_all("comments") # => ["hello, world!", ":+1:"]
# params.has_key?("comments") # => false
# ```
def delete_all(name) : Array(String)?
raw_params.delete(name)
end
# Serializes to string representation as http url-encoded form.
#
# ```
# require "uri/params"
#
# params = URI::Params.parse("item=keychain&item=keynote&email=john@example.org")
# params.to_s # => "item=keychain&item=keynote&email=john%40example.org"
# ```
def to_s(io : IO) : Nil
builder = Builder.new(io)
each do |name, value|
builder.add(name, value)
end
end
# :nodoc:
def self.decode_one_www_form_component(query, bytesize, i, byte, char, buffer)
URI.decode_one query, bytesize, i, byte, char, buffer, true
end
# URI params builder.
#
# Every parameter added is directly written to an `IO`,
# where keys and values are properly escaped.
class Builder
def initialize(@io : IO)
@first = true
end
# Adds a key-value pair to the params being built.
def add(key, value : String?)
@io << '&' unless @first
@first = false
URI.encode_www_form key, @io
@io << '='
URI.encode_www_form value, @io if value
self
end
# Adds all of the given *values* as key-value pairs to the params being built.
def add(key, values : Array)
values.each { |value| add(key, value) }
self
end
end
end
end