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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
use super::DisplayByteString;
use crate::ArrayValue;
use crate::BoolValue;
use crate::FixnumValue;
use crate::HashValue;
use crate::NilValue;
use crate::ObjectValue;
use crate::StringValue;
use crate::SymbolValue;
use crate::UserDefinedValue;
use crate::Value;
use crate::ValueArena;
use crate::ValueHandle;
use crate::ValueKind;
use std::cell::RefCell;
use std::collections::BTreeMap;
use std::collections::HashMap;
use std::hash::Hash;

/// An error that may occur while creating a type from a Ruby Value.
#[derive(Debug)]
pub enum FromValueError {
    /// An already visited node was visited.
    Cycle {
        /// The already-visited node.
        handle: ValueHandle,
    },

    /// A given [`ValueHandle`] was invalid.
    InvalidValueHandle {
        /// The invalid handle
        handle: ValueHandle,
    },

    /// An unexpected value kind was encountered.
    UnexpectedValueKind {
        /// The unexpected value kind
        kind: ValueKind,

        /// The current path of value handles
        trace: Vec<ValueHandle>,
    },

    /// An object name was unexpected.
    UnexpectedObjectName {
        /// The object name.
        ///
        /// This may or may not be UTF-8.
        name: Vec<u8>,
    },

    /// A user defined value name was unexpected.
    UnexpectedUserDefinedName {
        /// The user defined name.
        ///
        /// This may or may not be UTF-8.
        name: Vec<u8>,
    },

    /// An instance variable was duplicated
    DuplicateInstanceVariable {
        /// The instance variable name.
        ///
        /// This may or may not be UTF-8.
        name: Vec<u8>,
    },

    /// An unknown instance variable was encountered.
    UnknownInstanceVariable {
        /// The instance variable name.
        ///
        /// This may or may not be UTF-8.
        name: Vec<u8>,
    },

    /// Missing an instance variable with the given name.
    MissingInstanceVariable {
        /// The instance variable name.
        ///
        /// This may or may not be UTF-8.
        name: Vec<u8>,
    },

    /// A hash key was provided twice.
    DuplicateHashKey {
        /// The key that was provided twice.
        ///
        /// This does not need to be a symbol.
        key: ValueHandle,
    },

    /// Another user-provided kind of error occured.
    Other {
        error: Box<dyn std::error::Error + Send + Sync + 'static>,
    },
}

impl FromValueError {
    /// Shorthand for creating a new `Other` error variant.
    pub fn new_other<E>(error: E) -> Self
    where
        E: Into<Box<dyn std::error::Error + Send + Sync + 'static>>,
    {
        Self::Other {
            error: error.into(),
        }
    }
}

impl std::fmt::Display for FromValueError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Cycle { .. } => write!(f, "attempted to extract recursively"),
            Self::InvalidValueHandle { .. } => write!(f, "a handle was invalid"),
            Self::UnexpectedValueKind { kind, .. } => write!(f, "unexpected value kind {kind:?}"),
            Self::UnexpectedObjectName { name } => {
                write!(f, "unexpected object name \"{}\"", DisplayByteString(name))
            }
            Self::UnexpectedUserDefinedName { name } => {
                write!(
                    f,
                    "unexpected user defined name \"{}\"",
                    DisplayByteString(name)
                )
            }
            Self::DuplicateInstanceVariable { name } => {
                write!(
                    f,
                    "instance variable \"{}\" was encountered twice",
                    DisplayByteString(name)
                )
            }
            Self::UnknownInstanceVariable { name } => {
                write!(
                    f,
                    "instance variable \"{}\" is not known",
                    DisplayByteString(name)
                )
            }
            Self::MissingInstanceVariable { name } => {
                write!(
                    f,
                    "instance variable \"{}\" is missing",
                    DisplayByteString(name)
                )
            }
            Self::DuplicateHashKey { .. } => {
                write!(f, "duplicate hash key")
            }
            Self::Other { .. } => write!(f, "a user-provided error was encountered"),
        }
    }
}

impl std::error::Error for FromValueError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            Self::Other { error } => Some(&**error),
            _ => None,
        }
    }
}

/// A context to manage extracting values.
pub struct FromValueContext<'a> {
    arena: &'a ValueArena,
    stack: RefCell<Vec<ValueHandle>>,
}

impl<'a> FromValueContext<'a> {
    /// Create a new context from an arena.
    pub fn new(arena: &'a ValueArena) -> Self {
        Self {
            arena,
            stack: RefCell::new(Vec::new()),
        }
    }

    fn begin_handle(&self, handle: ValueHandle) -> Result<(), FromValueError> {
        let mut stack = self.stack.borrow_mut();

        if stack.contains(&handle) {
            return Err(FromValueError::Cycle { handle });
        }

        stack.push(handle);

        Ok(())
    }

    fn end_handle(&self, handle: ValueHandle) {
        let stack_handle = self.stack.borrow_mut().pop();

        // This should always be Some.
        let stack_handle = stack_handle.unwrap();

        assert!(handle == stack_handle);
    }

    // The "value" here is a represented by the value handle.
    #[allow(clippy::wrong_self_convention)]
    /// Extract a type from a value.
    pub fn from_value<T>(&self, handle: ValueHandle) -> Result<T, FromValueError>
    where
        T: FromValue<'a>,
    {
        let guard = FromValueGuard::new(self, handle)?;
        let value = self
            .arena
            .get(handle)
            .ok_or(FromValueError::InvalidValueHandle { handle })?;
        let value = T::from_value(self, value)?;
        drop(guard);

        Ok(value)
    }

    /// Create a new UnexpectedValueKind error
    pub fn new_unexpected_value_kind_error(&self, kind: ValueKind) -> FromValueError {
        FromValueError::UnexpectedValueKind {
            kind,
            trace: self.stack.borrow().clone(),
        }
    }
}

/// A guard for a handle.
///
/// Do NOT drop this before you are done using the handle and its children.
pub struct FromValueGuard<'a, 'b> {
    ctx: &'a FromValueContext<'b>,
    handle: ValueHandle,
}

impl<'a, 'b> FromValueGuard<'a, 'b> {
    fn new(ctx: &'a FromValueContext<'b>, handle: ValueHandle) -> Result<Self, FromValueError> {
        ctx.begin_handle(handle)?;

        Ok(Self { ctx, handle })
    }
}

impl<'a, 'b> Drop for FromValueGuard<'a, 'b> {
    fn drop(&mut self) {
        self.ctx.end_handle(self.handle);
    }
}

/// Implemented for any type that can be created from a Ruby Value.
pub trait FromValue<'a>: Sized {
    /// Create this type from the given value from the [`ValueArena`].
    ///
    /// # Arguments
    /// 1. `ctx`: The value extraction context.
    /// 2. `handle`: The handle that points to the value to convert.
    fn from_value(ctx: &FromValueContext<'a>, value: &'a Value) -> Result<Self, FromValueError>;
}

impl<'a> FromValue<'a> for &'a Value {
    fn from_value(_ctx: &FromValueContext<'a>, value: &'a Value) -> Result<Self, FromValueError> {
        Ok(value)
    }
}

impl<'a> FromValue<'a> for &'a NilValue {
    fn from_value(ctx: &FromValueContext<'a>, value: &'a Value) -> Result<Self, FromValueError> {
        match value {
            Value::Nil(value) => Ok(value),
            value => Err(ctx.new_unexpected_value_kind_error(value.kind())),
        }
    }
}

impl<'a> FromValue<'a> for &'a BoolValue {
    fn from_value(ctx: &FromValueContext<'a>, value: &'a Value) -> Result<Self, FromValueError> {
        match value {
            Value::Bool(value) => Ok(value),
            value => Err(ctx.new_unexpected_value_kind_error(value.kind())),
        }
    }
}

impl<'a> FromValue<'a> for &'a FixnumValue {
    fn from_value(ctx: &FromValueContext<'a>, value: &'a Value) -> Result<Self, FromValueError> {
        match value {
            Value::Fixnum(value) => Ok(value),
            value => Err(ctx.new_unexpected_value_kind_error(value.kind())),
        }
    }
}

impl<'a> FromValue<'a> for &'a SymbolValue {
    fn from_value(ctx: &FromValueContext<'a>, value: &'a Value) -> Result<Self, FromValueError> {
        match value {
            Value::Symbol(value) => Ok(value),
            value => Err(ctx.new_unexpected_value_kind_error(value.kind())),
        }
    }
}

impl<'a> FromValue<'a> for &'a ArrayValue {
    fn from_value(ctx: &FromValueContext<'a>, value: &'a Value) -> Result<Self, FromValueError> {
        match value {
            Value::Array(value) => Ok(value),
            value => Err(ctx.new_unexpected_value_kind_error(value.kind())),
        }
    }
}

impl<'a> FromValue<'a> for &'a HashValue {
    fn from_value(ctx: &FromValueContext<'a>, value: &'a Value) -> Result<Self, FromValueError> {
        match value {
            Value::Hash(value) => Ok(value),
            value => Err(ctx.new_unexpected_value_kind_error(value.kind())),
        }
    }
}

impl<'a> FromValue<'a> for &'a ObjectValue {
    fn from_value(ctx: &FromValueContext<'a>, value: &'a Value) -> Result<Self, FromValueError> {
        match value {
            Value::Object(value) => Ok(value),
            value => Err(ctx.new_unexpected_value_kind_error(value.kind())),
        }
    }
}

impl<'a> FromValue<'a> for &'a StringValue {
    fn from_value(ctx: &FromValueContext<'a>, value: &'a Value) -> Result<Self, FromValueError> {
        match value {
            Value::String(value) => Ok(value),
            value => Err(ctx.new_unexpected_value_kind_error(value.kind())),
        }
    }
}

impl<'a> FromValue<'a> for &'a UserDefinedValue {
    fn from_value(ctx: &FromValueContext<'a>, value: &'a Value) -> Result<Self, FromValueError> {
        match value {
            Value::UserDefined(value) => Ok(value),
            value => Err(ctx.new_unexpected_value_kind_error(value.kind())),
        }
    }
}

impl<'a> FromValue<'a> for bool {
    fn from_value(ctx: &FromValueContext<'a>, value: &'a Value) -> Result<Self, FromValueError> {
        let value: &BoolValue = FromValue::from_value(ctx, value)?;
        Ok(value.value())
    }
}

impl<'a> FromValue<'a> for i32 {
    fn from_value(ctx: &FromValueContext<'a>, value: &'a Value) -> Result<Self, FromValueError> {
        let value: &FixnumValue = FromValue::from_value(ctx, value)?;
        Ok(value.value())
    }
}

impl<'a, T> FromValue<'a> for Option<T>
where
    T: FromValue<'a>,
{
    fn from_value(ctx: &FromValueContext<'a>, value: &'a Value) -> Result<Self, FromValueError> {
        match value {
            Value::Nil(_) => Ok(None),
            _ => T::from_value(ctx, value).map(Some),
        }
    }
}

impl<'a, T> FromValue<'a> for Vec<T>
where
    T: FromValue<'a>,
{
    fn from_value(ctx: &FromValueContext<'a>, value: &'a Value) -> Result<Self, FromValueError> {
        let array: &ArrayValue = FromValue::from_value(ctx, value)?;
        let array = array.value();

        let mut vec = Vec::with_capacity(array.len());
        for handle in array.iter().copied() {
            let value = ctx.from_value(handle)?;
            vec.push(value);
        }

        Ok(vec)
    }
}

/// An error that may occur while extracting a HashMap from a value.
#[derive(Debug)]
pub enum HashMapFromValueError {
    /// The HashMap cannot be extracted since it has a default value.
    HasDefaultValue {
        /// The default value
        value: ValueHandle,
    },
}

impl std::fmt::Display for HashMapFromValueError {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        match self {
            Self::HasDefaultValue { .. } => {
                write!(f, "HashValue has a default value")
            }
        }
    }
}

impl std::error::Error for HashMapFromValueError {}

impl<'a, K, V> FromValue<'a> for HashMap<K, V>
where
    K: FromValue<'a> + Hash + Eq,
    V: FromValue<'a>,
{
    fn from_value(ctx: &FromValueContext<'a>, value: &'a Value) -> Result<Self, FromValueError> {
        let value: &HashValue = FromValue::from_value(ctx, value)?;

        if let Some(default_value) = value.default_value() {
            return Err(FromValueError::new_other(
                HashMapFromValueError::HasDefaultValue {
                    value: default_value,
                },
            ));
        }

        let value = value.value();

        let mut map = HashMap::with_capacity(value.len());
        for (key_handle, value_handle) in value.iter().copied() {
            let key = ctx.from_value(key_handle)?;
            let value = ctx.from_value(value_handle)?;

            let old_value = map.insert(key, value);

            if old_value.is_some() {
                return Err(FromValueError::DuplicateHashKey { key: key_handle });
            }
        }

        Ok(map)
    }
}

/// An error that may occur while extracting a BTreeMap from a value.
#[derive(Debug)]
pub enum BTreeMapFromValueError {
    /// The BTreeMap cannot be extracted since it has a default value.
    HasDefaultValue {
        /// The default value
        value: ValueHandle,
    },
}

impl std::fmt::Display for BTreeMapFromValueError {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        match self {
            Self::HasDefaultValue { .. } => {
                write!(f, "HashValue has a default value")
            }
        }
    }
}

impl std::error::Error for BTreeMapFromValueError {}

impl<'a, K, V> FromValue<'a> for BTreeMap<K, V>
where
    K: FromValue<'a> + Eq + Ord,
    V: FromValue<'a>,
{
    fn from_value(ctx: &FromValueContext<'a>, value: &'a Value) -> Result<Self, FromValueError> {
        let value: &HashValue = FromValue::from_value(ctx, value)?;

        if let Some(default_value) = value.default_value() {
            return Err(FromValueError::new_other(
                BTreeMapFromValueError::HasDefaultValue {
                    value: default_value,
                },
            ));
        }

        let value = value.value();

        let mut map = BTreeMap::new();
        for (key_handle, value_handle) in value.iter().copied() {
            let key = ctx.from_value(key_handle)?;
            let value = ctx.from_value(value_handle)?;

            let old_value = map.insert(key, value);

            if old_value.is_some() {
                return Err(FromValueError::DuplicateHashKey { key: key_handle });
            }
        }

        Ok(map)
    }
}