graphlite 0.0.1

GraphLite - A lightweight ISO GQL Graph Database
Documentation
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
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
// Copyright (c) 2024-2025 DeepGraph Inc.
// SPDX-License-Identifier: Apache-2.0
//
//! Consolidated string function implementations
//!
//! This module contains all string manipulation functions:
//! - UPPER: Converts strings to uppercase
//! - LOWER: Converts strings to lowercase  
//! - TRIM: Removes leading/trailing characters
//! - SUBSTRING: Extracts substrings
//! - REPLACE: Replaces substring occurrences
//! - REVERSE: Reverses string characters

use super::function_trait::{Function, FunctionContext, FunctionError, FunctionResult};
use crate::storage::Value;

// ==============================================================================
// UPPER FUNCTION
// ==============================================================================

/// UPPER function - converts string values to uppercase
#[derive(Debug)]
pub struct UpperFunction;

impl UpperFunction {
    pub fn new() -> Self {
        Self
    }
}

impl Function for UpperFunction {
    fn name(&self) -> &str {
        "UPPER"
    }

    fn description(&self) -> &str {
        "Converts string values to uppercase"
    }

    fn argument_count(&self) -> usize {
        1 // UPPER(column)
    }

    fn execute(&self, context: &FunctionContext) -> FunctionResult<Value> {
        // Get the actual value argument (not column name)
        let value = context.get_argument(0)?;

        if value.is_null() {
            return Ok(Value::Null);
        }

        // Handle both strings and numbers - convert to string first
        let string_val = if let Some(s) = value.as_string() {
            s.to_string()
        } else if let Some(n) = value.as_number() {
            n.to_string()
        } else {
            // Try to convert other types to string representation
            match value {
                Value::Boolean(b) => b.to_string(),
                _ => return Ok(Value::Null), // Return null for non-convertible types
            }
        };

        Ok(Value::String(string_val.to_uppercase()))
    }

    fn return_type(&self) -> &str {
        "String"
    }

    fn graph_context_required(&self) -> bool {
        false // String functions are pure scalar functions
    }
}

// ==============================================================================
// LOWER FUNCTION
// ==============================================================================

/// LOWER function - converts string values to lowercase
#[derive(Debug)]
pub struct LowerFunction;

impl LowerFunction {
    pub fn new() -> Self {
        Self
    }
}

impl Function for LowerFunction {
    fn name(&self) -> &str {
        "LOWER"
    }

    fn description(&self) -> &str {
        "Converts string values to lowercase"
    }

    fn argument_count(&self) -> usize {
        1 // LOWER(column)
    }

    fn execute(&self, context: &FunctionContext) -> FunctionResult<Value> {
        // Get the actual value argument (not column name)
        let value = context.get_argument(0)?;

        if value.is_null() {
            return Ok(Value::Null);
        }

        // Handle both strings and numbers - convert to string first
        let string_val = if let Some(s) = value.as_string() {
            s.to_string()
        } else if let Some(n) = value.as_number() {
            n.to_string()
        } else {
            // Try to convert other types to string representation
            match value {
                Value::Boolean(b) => b.to_string(),
                _ => return Ok(Value::Null), // Return null for non-convertible types
            }
        };

        Ok(Value::String(string_val.to_lowercase()))
    }

    fn return_type(&self) -> &str {
        "String"
    }

    fn graph_context_required(&self) -> bool {
        false // String functions are pure scalar functions
    }
}

// ==============================================================================
// TRIM FUNCTION
// ==============================================================================

/// Enum representing the TRIM mode
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum TrimMode {
    Both,
    Leading,
    Trailing,
}

/// TRIM function - removes leading/trailing characters from string
/// Supports ISO GQL syntax: TRIM([LEADING|TRAILING|BOTH] [character FROM] string)
#[derive(Debug)]
pub struct TrimFunction;

impl TrimFunction {
    pub fn new() -> Self {
        Self
    }

    /// Parse trim mode from a string value
    fn parse_trim_mode(s: &str) -> Option<TrimMode> {
        match s.to_uppercase().as_str() {
            "LEADING" => Some(TrimMode::Leading),
            "TRAILING" => Some(TrimMode::Trailing),
            "BOTH" => Some(TrimMode::Both),
            _ => None,
        }
    }

    /// Perform the actual trimming based on mode
    fn trim_string(input: &str, trim_chars: &str, mode: TrimMode) -> String {
        match mode {
            TrimMode::Leading => input
                .trim_start_matches(|c: char| trim_chars.contains(c))
                .to_string(),
            TrimMode::Trailing => input
                .trim_end_matches(|c: char| trim_chars.contains(c))
                .to_string(),
            TrimMode::Both => input
                .trim_matches(|c: char| trim_chars.contains(c))
                .to_string(),
        }
    }
}

impl Function for TrimFunction {
    fn name(&self) -> &str {
        "TRIM"
    }

    fn description(&self) -> &str {
        "Removes leading and/or trailing characters from a string"
    }

    fn argument_count(&self) -> usize {
        1 // Minimum 1, but can accept up to 3 arguments
    }

    fn execute(&self, context: &FunctionContext) -> FunctionResult<Value> {
        let arg_count = context.arguments.len();
        if arg_count == 0 || arg_count > 3 {
            return Err(FunctionError::InvalidArgumentType {
                message: "TRIM function expects 1 to 3 arguments".to_string(),
            });
        }

        // Handle different argument patterns
        if arg_count == 1 {
            // TRIM(string) - trim whitespace from both ends
            let value = context.get_argument(0)?;
            if value.is_null() {
                return Ok(Value::Null);
            }

            let string_val = self.value_to_string(value)?;
            Ok(Value::String(string_val.trim().to_string()))
        } else if arg_count == 2 {
            // TRIM(mode, string) OR TRIM(string, character)
            let first_arg = context.get_argument(0)?;
            let second_arg = context.get_argument(1)?;

            // Check if first argument is a trim mode
            if let Some(mode_str) = first_arg.as_string() {
                if let Some(mode) = Self::parse_trim_mode(&mode_str) {
                    // TRIM(mode, string) - trim whitespace with specified mode
                    if second_arg.is_null() {
                        return Ok(Value::Null);
                    }
                    let string_val = self.value_to_string(second_arg)?;
                    let result = Self::trim_string(&string_val, " \t\n\r", mode);
                    return Ok(Value::String(result));
                }
            }

            // Otherwise treat as TRIM(string, character) - trim specified character from both ends
            if first_arg.is_null() {
                return Ok(Value::Null);
            }

            let string_val = self.value_to_string(first_arg)?;
            let trim_char = self.extract_trim_char(second_arg)?;
            Ok(Value::String(
                string_val.trim_matches(trim_char).to_string(),
            ))
        } else {
            // arg_count == 3: TRIM FROM syntax: mode, trim_char, string
            // Arguments are: [mode_string, trim_char_string, target_string]
            let mode_value = context.get_argument(0)?;
            let char_value = context.get_argument(1)?;
            let string_value = context.get_argument(2)?;

            if string_value.is_null() {
                return Ok(Value::Null);
            }

            let string_val = self.value_to_string(string_value)?;
            let trim_chars = self.value_to_string(char_value)?;
            let mode_str = if let Some(s) = mode_value.as_string() {
                s
            } else {
                "BOTH"
            };

            let mode = Self::parse_trim_mode(&mode_str).unwrap_or(TrimMode::Both);
            let result = Self::trim_string(&string_val, &trim_chars, mode);

            Ok(Value::String(result))
        }
    }

    fn return_type(&self) -> &str {
        "String"
    }

    fn graph_context_required(&self) -> bool {
        false // String functions are pure scalar functions
    }
}

impl TrimFunction {
    /// Helper method to convert value to string consistently
    fn value_to_string(&self, value: &Value) -> FunctionResult<String> {
        let string_val = if let Some(s) = value.as_string() {
            s.to_string()
        } else if let Some(n) = value.as_number() {
            n.to_string()
        } else {
            match value {
                Value::Boolean(b) => b.to_string(),
                _ => return Ok(String::new()), // Return empty for non-convertible types
            }
        };
        Ok(string_val)
    }

    /// Helper method to extract trim character from value
    fn extract_trim_char(&self, value: &Value) -> FunctionResult<char> {
        let trim_char = if let Some(s) = value.as_string() {
            if s.is_empty() {
                ' ' // Default to space if empty string
            } else {
                s.chars().next().unwrap_or(' ')
            }
        } else {
            ' ' // Default to space for non-string values
        };
        Ok(trim_char)
    }
}

// ==============================================================================
// SUBSTRING FUNCTION
// ==============================================================================

/// SUBSTRING function - extracts substring from string
#[derive(Debug)]
pub struct SubstringFunction;

impl SubstringFunction {
    pub fn new() -> Self {
        Self
    }
}

impl Function for SubstringFunction {
    fn name(&self) -> &str {
        "SUBSTRING"
    }

    fn description(&self) -> &str {
        "Extracts a substring from a string starting at a position with optional length"
    }

    fn argument_count(&self) -> usize {
        // Variable arguments: SUBSTRING(string, position) or SUBSTRING(string, position, length)
        // Return minimum required arguments (2), actual validation happens in execute()
        2
    }

    fn execute(&self, context: &FunctionContext) -> FunctionResult<Value> {
        // Handle 2 or 3 arguments: SUBSTRING(string, start) or SUBSTRING(string, start, length)
        let arg_count = context.arguments.len();
        if arg_count < 2 || arg_count > 3 {
            return Err(FunctionError::InvalidArgumentType {
                message: "SUBSTRING function expects 2 or 3 arguments".to_string(),
            });
        }

        let value = context.get_argument(0)?;

        if value.is_null() {
            return Ok(Value::Null);
        }

        // Convert to string
        let string_val = if let Some(s) = value.as_string() {
            s.to_string()
        } else if let Some(n) = value.as_number() {
            n.to_string()
        } else {
            match value {
                Value::Boolean(b) => b.to_string(),
                _ => return Ok(Value::Null),
            }
        };

        // Get start position (1-based in GQL, 0-based in Rust)
        let start_value = context.get_argument(1)?;
        let start_pos = if let Some(n) = start_value.as_number() {
            let pos = n as i32;
            if pos <= 0 {
                0
            } else {
                (pos - 1) as usize // Convert to 0-based
            }
        } else {
            return Err(FunctionError::InvalidArgumentType {
                message: "SUBSTRING start position must be a number".to_string(),
            });
        };

        // Convert to character array for proper Unicode handling
        let chars: Vec<char> = string_val.chars().collect();

        // Check if start position is beyond string length (in characters, not bytes)
        if start_pos >= chars.len() {
            return Ok(Value::String("".to_string()));
        }

        // Get length if provided
        let result_string = if arg_count == 3 {
            let length_value = context.get_argument(2)?;
            let length = if let Some(n) = length_value.as_number() {
                let len = n as i32;
                if len <= 0 {
                    return Ok(Value::String("".to_string()));
                }
                len as usize
            } else {
                return Err(FunctionError::InvalidArgumentType {
                    message: "SUBSTRING length must be a number".to_string(),
                });
            };

            // Extract substring with length, ensuring we don't exceed string bounds
            let end_pos = std::cmp::min(start_pos + length, chars.len());
            chars[start_pos..end_pos].iter().collect()
        } else {
            // Extract substring from start to end
            chars[start_pos..].iter().collect()
        };

        Ok(Value::String(result_string))
    }

    fn return_type(&self) -> &str {
        "String"
    }

    fn graph_context_required(&self) -> bool {
        false // String functions are pure scalar functions
    }
}

// ==============================================================================
// REPLACE FUNCTION
// ==============================================================================

/// REPLACE function - replaces occurrences of a substring with another substring
#[derive(Debug)]
pub struct ReplaceFunction;

impl ReplaceFunction {
    pub fn new() -> Self {
        Self
    }
}

impl Function for ReplaceFunction {
    fn name(&self) -> &str {
        "REPLACE"
    }

    fn description(&self) -> &str {
        "Replaces all occurrences of a substring with another substring"
    }

    fn argument_count(&self) -> usize {
        3 // REPLACE(string, search, replacement)
    }

    fn execute(&self, context: &FunctionContext) -> FunctionResult<Value> {
        // Validate argument count
        if context.arguments.len() != 3 {
            return Err(FunctionError::InvalidArgumentCount {
                expected: 3,
                actual: context.arguments.len(),
            });
        }

        let string_value = context.get_argument(0)?;
        let search_value = context.get_argument(1)?;
        let replacement_value = context.get_argument(2)?;

        // Handle null values
        if string_value.is_null() || search_value.is_null() || replacement_value.is_null() {
            return Ok(Value::Null);
        }

        // Helper function to convert value to string (consistent with UPPER/LOWER)
        let to_string = |value: &Value| -> Option<String> {
            if let Some(s) = value.as_string() {
                Some(s.to_string())
            } else if let Some(n) = value.as_number() {
                Some(n.to_string())
            } else {
                match value {
                    Value::Boolean(b) => Some(b.to_string()),
                    _ => None,
                }
            }
        };

        // Convert all arguments to strings
        let string_val =
            to_string(string_value).ok_or_else(|| FunctionError::InvalidArgumentType {
                message: "First argument must be convertible to string".to_string(),
            })?;

        let search_val =
            to_string(search_value).ok_or_else(|| FunctionError::InvalidArgumentType {
                message: "Search argument must be convertible to string".to_string(),
            })?;

        let replacement_val =
            to_string(replacement_value).ok_or_else(|| FunctionError::InvalidArgumentType {
                message: "Replacement argument must be convertible to string".to_string(),
            })?;

        // If search string is empty, return original string
        if search_val.is_empty() {
            return Ok(Value::String(string_val));
        }

        // Perform replacement
        let result = string_val.replace(&search_val, &replacement_val);

        Ok(Value::String(result))
    }

    fn return_type(&self) -> &str {
        "String"
    }

    fn graph_context_required(&self) -> bool {
        false // String functions are pure scalar functions
    }
}

// ==============================================================================
// REVERSE FUNCTION
// ==============================================================================

/// REVERSE function - reverses a string
#[derive(Debug)]
pub struct ReverseFunction;

impl ReverseFunction {
    pub fn new() -> Self {
        Self
    }
}

impl Function for ReverseFunction {
    fn name(&self) -> &str {
        "REVERSE"
    }

    fn description(&self) -> &str {
        "Reverses the characters in a string"
    }

    fn argument_count(&self) -> usize {
        1 // REVERSE(string)
    }

    fn execute(&self, context: &FunctionContext) -> FunctionResult<Value> {
        // Validate argument count
        context.validate_argument_count(1)?;

        let value = context.get_argument(0)?;

        if value.is_null() {
            return Ok(Value::Null);
        }

        // Convert to string
        let string_val = if let Some(s) = value.as_string() {
            s.to_string()
        } else if let Some(n) = value.as_number() {
            n.to_string()
        } else {
            match value {
                Value::Boolean(b) => b.to_string(),
                _ => return Ok(Value::Null),
            }
        };

        // Reverse the string using proper Unicode handling
        let reversed: String = string_val.chars().rev().collect();

        Ok(Value::String(reversed))
    }

    fn return_type(&self) -> &str {
        "String"
    }

    fn graph_context_required(&self) -> bool {
        false // String functions are pure scalar functions
    }
}