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
use crate::prelude::*;
use nu_engine::WholeStreamCommand;
use nu_errors::ShellError;
use nu_protocol::{
ColumnPath, Primitive, ReturnSuccess, ShellTypeName, Signature, SyntaxShape, UntaggedValue,
Value,
};
use nu_source::{Tag, Tagged};
use nu_value_ext::ValueExt;
use chrono::{DateTime, FixedOffset, Local, LocalResult, Offset, TimeZone, Utc};
struct Arguments {
timezone: Option<Tagged<String>>,
offset: Option<Tagged<i16>>,
format: Option<Tagged<String>>,
column_paths: Vec<ColumnPath>,
}
#[derive(Clone)]
enum Zone {
Utc,
Local,
East(u8),
West(u8),
Error,
}
impl Zone {
fn new(i: i16) -> Self {
if i.abs() <= 12 {
if i >= 0 {
Self::East(i as u8)
} else {
Self::West(-i as u8)
}
} else {
Self::Error
}
}
fn from_string(s: String) -> Self {
match s.to_lowercase().as_str() {
"utc" | "u" => Self::Utc,
"local" | "l" => Self::Local,
_ => Self::Error,
}
}
}
pub struct SubCommand;
impl WholeStreamCommand for SubCommand {
fn name(&self) -> &str {
"str to-datetime"
}
fn signature(&self) -> Signature {
Signature::build("str to-datetime")
.named(
"timezone",
SyntaxShape::String,
"Specify timezone if the input is timestamp, like 'UTC/u' or 'LOCAL/l'",
Some('z'),
)
.named(
"offset",
SyntaxShape::Int,
"Specify timezone by offset if the input is timestamp, like '+8', '-4', prior than timezone",
Some('o'),
)
.named(
"format",
SyntaxShape::String,
"Specify date and time formatting",
Some('f'),
)
.rest(
"rest",
SyntaxShape::Any,
"optionally convert text into datetime by column paths",
)
}
fn usage(&self) -> &str {
"converts text into datetime"
}
fn run_with_actions(&self, args: CommandArgs) -> Result<ActionStream, ShellError> {
operate(args)
}
fn examples(&self) -> Vec<Example> {
vec![
Example {
description: "Convert to datetime",
example: "echo '16.11.1984 8:00 am +0000' | str to-datetime",
result: None,
},
Example {
description: "Convert to datetime",
example: "echo '2020-08-04T16:39:18+00:00' | str to-datetime",
result: None,
},
Example {
description: "Convert to datetime using a custom format",
example: "echo '20200904_163918+0000' | str to-datetime -f '%Y%m%d_%H%M%S%z'",
result: None,
},
Example {
description: "Convert timestamp (no larger than 8e+12) to datetime using a specified timezone",
example: "echo '1614434140' | str to-datetime -z 'UTC'",
result: None,
},
Example {
description:
"Convert timestamp (no larger than 8e+12) to datetime using a specified timezone offset (between -12 and 12)",
example: "echo '1614434140' | str to-datetime -o '+9'",
result: None,
},
]
}
}
#[derive(Clone)]
struct DatetimeFormat(String);
fn operate(args: CommandArgs) -> Result<ActionStream, ShellError> {
let options = Arguments {
timezone: args.get_flag("timezone")?,
offset: args.get_flag("offset")?,
format: args.get_flag("format")?,
column_paths: args.rest(0)?,
};
let input = args.input;
let zone_options = if let Some(Tagged {
item: zone_offset,
tag,
}) = &options.offset
{
Some(Tagged {
item: Zone::new(*zone_offset),
tag: tag.into(),
})
} else if let Some(Tagged { item: zone, tag }) = &options.timezone {
Some(Tagged {
item: Zone::from_string(zone.clone()),
tag: tag.into(),
})
} else {
None
};
let format_options = if let Some(Tagged { item: fmt, .. }) = &options.format {
Some(DatetimeFormat(fmt.to_string()))
} else {
None
};
Ok(input
.map(move |v| {
if options.column_paths.is_empty() {
ReturnSuccess::value(action(&v, &zone_options, &format_options, v.tag())?)
} else {
let mut ret = v;
for path in &options.column_paths {
let zone_options = zone_options.clone();
let format_options = format_options.clone();
ret = ret.swap_data_by_column_path(
path,
Box::new(move |old| action(old, &zone_options, &format_options, old.tag())),
)?;
}
ReturnSuccess::value(ret)
}
})
.into_action_stream())
}
fn action(
input: &Value,
timezone: &Option<Tagged<Zone>>,
dateformat: &Option<DatetimeFormat>,
tag: impl Into<Tag>,
) -> Result<Value, ShellError> {
match &input.value {
UntaggedValue::Primitive(Primitive::String(s)) => {
let ts = s.parse::<i64>();
if let Some(tz) = timezone {
const TIMESTAMP_BOUND: i64 = 8.2e+12 as i64;
if let Ok(t) = ts {
if t.abs() > TIMESTAMP_BOUND {
return Err(ShellError::labeled_error(
"could not parse input as a valid timestamp",
"given timestamp is out of range, it should between -8e+12 and 8e+12",
tag.into().span,
));
}
const HOUR: i32 = 3600;
let stampout = match tz.item {
Zone::Utc => UntaggedValue::date(Utc.timestamp(t, 0)),
Zone::Local => UntaggedValue::date(Local.timestamp(t, 0)),
Zone::East(i) => {
let eastoffset = FixedOffset::east((i as i32) * HOUR);
UntaggedValue::date(eastoffset.timestamp(t, 0))
}
Zone::West(i) => {
let westoffset = FixedOffset::west((i as i32) * HOUR);
UntaggedValue::date(westoffset.timestamp(t, 0))
}
Zone::Error => {
return Err(ShellError::labeled_error(
"could not continue to convert timestamp",
"given timezone or offset is invalid",
tz.tag().span,
));
}
};
return Ok(stampout.into_value(tag));
}
};
let out = match dateformat {
Some(dt) => match DateTime::parse_from_str(s, &dt.0) {
Ok(d) => UntaggedValue::date(d),
Err(reason) => {
return Err(ShellError::labeled_error(
format!("could not parse as datetime using format '{}'", dt.0),
reason.to_string(),
tag.into().span,
))
}
},
None => match dtparse::parse(s) {
Ok((native_dt, fixed_offset)) => {
let offset = match fixed_offset {
Some(fo) => fo,
None => FixedOffset::east(0).fix(),
};
match offset.from_local_datetime(&native_dt) {
LocalResult::Single(d) => UntaggedValue::date(d),
LocalResult::Ambiguous(d, _) => UntaggedValue::date(d),
LocalResult::None => {
return Err(ShellError::labeled_error(
"could not convert to a timezone-aware datetime",
"local time representation is invalid",
tag.into().span,
))
}
}
}
Err(reason) => {
return Err(ShellError::labeled_error(
"could not parse as datetime",
reason.to_string(),
tag.into().span,
))
}
},
};
Ok(out.into_value(tag))
}
other => {
let got = format!("got {}", other.type_name());
Err(ShellError::labeled_error(
"value is not string",
got,
tag.into().span,
))
}
}
}
#[cfg(test)]
mod tests {
use super::ShellError;
use super::{action, DatetimeFormat, SubCommand, Zone};
use nu_protocol::{Primitive, UntaggedValue};
use nu_source::{Tag, Tagged};
use nu_test_support::value::string;
#[test]
fn examples_work_as_expected() -> Result<(), ShellError> {
use crate::examples::test as test_examples;
test_examples(SubCommand {})
}
#[test]
fn takes_a_date_format() {
let date_str = string("16.11.1984 8:00 am +0000");
let fmt_options = Some(DatetimeFormat("%d.%m.%Y %H:%M %P %z".to_string()));
let actual = action(&date_str, &None, &fmt_options, Tag::unknown()).unwrap();
match actual.value {
UntaggedValue::Primitive(Primitive::Date(_)) => {}
_ => panic!("Didn't convert to date"),
}
}
#[test]
fn takes_iso8601_date_format() {
let date_str = string("2020-08-04T16:39:18+00:00");
let actual = action(&date_str, &None, &None, Tag::unknown()).unwrap();
match actual.value {
UntaggedValue::Primitive(Primitive::Date(_)) => {}
_ => panic!("Didn't convert to date"),
}
}
#[test]
fn takes_timestamp_offset() {
let date_str = string("1614434140");
let timezone_option = Some(Tagged {
item: Zone::East(8),
tag: Tag::unknown(),
});
let actual = action(&date_str, &timezone_option, &None, Tag::unknown()).unwrap();
match actual.value {
UntaggedValue::Primitive(Primitive::Date(_)) => {}
_ => panic!("Didn't convert to date"),
}
}
#[test]
fn takes_timestamp() {
let date_str = string("1614434140");
let timezone_option = Some(Tagged {
item: Zone::Local,
tag: Tag::unknown(),
});
let actual = action(&date_str, &timezone_option, &None, Tag::unknown()).unwrap();
match actual.value {
UntaggedValue::Primitive(Primitive::Date(_)) => {}
_ => panic!("Didn't convert to date"),
}
}
#[test]
fn takes_invalid_timestamp() {
let date_str = string("10440970000000");
let timezone_option = Some(Tagged {
item: Zone::Utc,
tag: Tag::unknown(),
});
let actual = action(&date_str, &timezone_option, &None, Tag::unknown());
assert!(actual.is_err());
}
#[test]
fn communicates_parsing_error_given_an_invalid_datetimelike_string() {
let date_str = string("16.11.1984 8:00 am Oops0000");
let fmt_options = Some(DatetimeFormat("%d.%m.%Y %H:%M %P %z".to_string()));
let actual = action(&date_str, &None, &fmt_options, Tag::unknown());
assert!(actual.is_err());
}
}