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

use std::collections::HashMap;

use crate::core::config::FluffConfig;
use crate::core::errors::{SQLBaseError, SQLTemplaterError};
use crate::core::parser::segments::base::Segment;
use crate::core::templaters::base::TemplatedFile;

/// Rule Tuple object for describing rules.
#[derive(Debug, PartialEq, Clone)]
pub struct RuleTuple {
    code: String,
    name: String,
    description: String,
    groups: Vec<String>,
    aliases: Vec<String>,
}

/// Parsed version of a 'noqa' comment.
#[derive(Debug, PartialEq, Clone)]
pub struct NoQaDirective {
    /// Source line number
    line_no: u32,
    /// Affected rule names
    rules: Option<Vec<String>>,
    /// "enable", "disable", or "None"
    action: Option<String>,
}

/// An object to store the result of a templated file/string.
///
/// This is notable as it's the intermediate state between what happens
/// in the main process and the child processes when running in parallel mode.
#[derive(Debug, Clone)]
pub struct RenderedFile {
    pub templated_file: TemplatedFile,
    pub templater_violations: Vec<SQLTemplaterError>,
    pub config: FluffConfig,
    pub time_dict: HashMap<String, f64>,
    pub(crate) f_name: String,
    pub encoding: String,
    pub source_str: String,
}

/// An object to store the result of parsing a string.
#[derive(Debug)]
pub struct ParsedString {
    pub tree: Option<Box<dyn Segment + 'static>>,
    pub violations: Vec<SQLBaseError>,
    // TODO Implement time dict
    /// `time_dict` is a :obj:`dict` containing timings for how long each step
    /// took in the process.
    pub time_dict: HashMap<String, f64>,
    /// `templated_file` is a :obj:`TemplatedFile` containing the details of the
    /// templated file.
    pub templated_file: TemplatedFile,
    pub config: FluffConfig,
    pub f_name: String,
    pub source_str: String,
}