sqruff_lib/core/

rules.rs

pub mod context;
pub mod crawlers;
pub mod noqa;
pub mod reference;

use std::fmt::{self, Debug};
use std::ops::Deref;

use std::sync::Arc;

use hashbrown::{HashMap, HashSet};
use itertools::chain;
use sqruff_lib_core::dialects::Dialect;
use sqruff_lib_core::dialects::init::DialectKind;
use sqruff_lib_core::errors::{ErrorStructRule, SQLFluffUserError, SQLLintError};
use sqruff_lib_core::helpers::{Config, IndexMap};
use sqruff_lib_core::lint_fix::LintFix;
use sqruff_lib_core::parser::segments::{ErasedSegment, Tables};
use sqruff_lib_core::templaters::TemplatedFile;
use strum_macros::AsRefStr;

use crate::core::config::{FluffConfig, Value};
use crate::core::rules::context::RuleContext;
use crate::core::rules::crawlers::{BaseCrawler as _, Crawler};

pub struct LintResult {
    pub anchor: Option<ErasedSegment>,
    pub fixes: Vec<LintFix>,
    description: Option<String>,
    source: String,
}

#[derive(Debug, Clone, PartialEq, Copy, Hash, Eq, AsRefStr)]
#[strum(serialize_all = "lowercase")]
pub enum RuleGroups {
    All,
    Core,
    Aliasing,
    Ambiguous,
    Capitalisation,
    Convention,
    Jinja,
    Layout,
    References,
    Structure,
}

impl LintResult {
    pub fn new(
        anchor: Option<ErasedSegment>,
        fixes: Vec<LintFix>,
        description: Option<String>,
        source: Option<String>,
    ) -> Self {
        // let fixes = fixes.into_iter().filter(|f| !f.is_trivial()).collect();

        LintResult {
            anchor,
            fixes,
            description,
            source: source.unwrap_or_default(),
        }
    }

    /// Whether the anchor sits in a template-generated (non-literal) region.
    pub fn anchor_in_templated_section(&self) -> bool {
        self.anchor.as_ref().is_some_and(|anchor| {
            anchor
                .get_position_marker()
                .is_some_and(|marker| !marker.is_literal())
        })
    }

    pub fn to_linting_error(self, rule: &ErasedRule) -> Option<SQLLintError> {
        let anchor = self.anchor.clone()?;

        let description = self
            .description
            .as_deref()
            .unwrap_or_else(|| rule.description());

        let is_fixable = rule.is_fix_compatible();

        SQLLintError::new(description, anchor, is_fixable)
            .config(|this| {
                this.rule = Some(ErrorStructRule {
                    name: rule.name(),
                    code: rule.code(),
                })
            })
            .into()
    }
}

impl Debug for LintResult {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match &self.anchor {
            None => write!(f, "LintResult(<empty>)"),
            Some(anchor) => {
                let fix_coda = if !self.fixes.is_empty() {
                    format!("+{}F", self.fixes.len())
                } else {
                    "".to_string()
                };

                match &self.description {
                    Some(desc) => {
                        if !self.source.is_empty() {
                            write!(
                                f,
                                "LintResult({} [{}]: {:?}{})",
                                desc, self.source, anchor, fix_coda
                            )
                        } else {
                            write!(f, "LintResult({desc}: {anchor:?}{fix_coda})")
                        }
                    }
                    None => write!(f, "LintResult({anchor:?}{fix_coda})"),
                }
            }
        }
    }
}

#[derive(Debug, Clone, PartialEq)]
pub enum LintPhase {
    Main,
    Post,
}

pub trait Rule: Debug + 'static + Send + Sync {
    fn load_from_config(&self, _config: &HashMap<String, Value>) -> Result<ErasedRule, String>;

    fn lint_phase(&self) -> LintPhase {
        LintPhase::Main
    }

    fn name(&self) -> &'static str;

    fn config_ref(&self) -> &'static str {
        self.name()
    }

    fn description(&self) -> &'static str;

    fn long_description(&self) -> &'static str;

    /// All the groups this rule belongs to, including 'all' because that is a
    /// given. There should be no duplicates and 'all' should be the first
    /// element.
    fn groups(&self) -> &'static [RuleGroups];

    fn force_enable(&self) -> bool {
        false
    }

    /// Returns the set of dialects for which a particular rule should be
    /// skipped.
    fn dialect_skip(&self) -> &'static [DialectKind] {
        &[]
    }

    fn code(&self) -> &'static str {
        let name = std::any::type_name::<Self>();
        name.split("::")
            .last()
            .unwrap()
            .strip_prefix("Rule")
            .unwrap_or(name)
    }

    fn eval(&self, rule_cx: &RuleContext) -> Vec<LintResult>;

    fn is_fix_compatible(&self) -> bool {
        false
    }

    /// Whether this rule is designed to operate on template-generated regions.
    ///
    /// When `false` (the default) and `ignore_templated_areas` is enabled, any
    /// lint result whose anchor falls in a non-literal (templated) section is
    /// suppressed, matching SQLFluff's behaviour.
    fn targets_templated(&self) -> bool {
        false
    }

    fn crawl_behaviour(&self) -> Crawler;
}

/// Emits a `targets_templated` override returning `true`, for rules that
/// operate on template-generated regions (SQLFluff's `targets_templated`).
macro_rules! targets_templated {
    () => {
        fn targets_templated(&self) -> bool {
            true
        }
    };
}
pub(crate) use targets_templated;

pub struct Exception;

pub fn crawl(
    rule: &ErasedRule,
    tables: &Tables,
    dialect: &Dialect,
    templated_file: &TemplatedFile,
    tree: ErasedSegment,
    config: &FluffConfig,
    on_violation: &mut impl FnMut(LintResult),
) -> Result<(), Exception> {
    let mut root_context = RuleContext::new(tables, dialect, config, tree.clone());
    root_context.templated_file = Some(templated_file.clone());
    let mut has_exception = false;

    // TODO Will to return a note that rules were skipped
    if rule.dialect_skip().contains(&dialect.name) && !rule.force_enable() {
        return Ok(());
    }

    rule.crawl_behaviour()
        .crawl(&mut root_context, &mut |context| {
            let resp =
                std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| rule.eval(context)));

            let Ok(results) = resp else {
                has_exception = true;
                return;
            };

            for result in results {
                if !result
                    .fixes
                    .iter()
                    .any(|it| it.has_template_conflicts(templated_file))
                {
                    on_violation(result);
                }
            }
        });

    if has_exception {
        Err(Exception)
    } else {
        Ok(())
    }
}

#[derive(Debug, Clone)]
pub struct ErasedRule {
    erased: Arc<dyn Rule>,
}

impl PartialEq for ErasedRule {
    fn eq(&self, _other: &Self) -> bool {
        unimplemented!()
    }
}

impl Deref for ErasedRule {
    type Target = dyn Rule;

    fn deref(&self) -> &Self::Target {
        self.erased.as_ref()
    }
}

pub trait Erased {
    type Erased;

    fn erased(self) -> Self::Erased;
}

impl<T: Rule> Erased for T {
    type Erased = ErasedRule;

    fn erased(self) -> Self::Erased {
        ErasedRule {
            erased: Arc::new(self),
        }
    }
}

pub struct RuleManifest {
    pub code: &'static str,
    pub name: &'static str,
    pub description: &'static str,
    pub groups: &'static [RuleGroups],
    pub rule_class: ErasedRule,
}

#[derive(Clone)]
pub struct RulePack {
    pub(crate) rules: Vec<ErasedRule>,
    _reference_map: HashMap<&'static str, HashSet<&'static str>>,
}

impl RulePack {
    pub fn rules(&self) -> Vec<ErasedRule> {
        self.rules.clone()
    }
}

pub struct RuleSet {
    pub(crate) register: IndexMap<&'static str, RuleManifest>,
}

impl RuleSet {
    fn rule_reference_map(&self) -> HashMap<&'static str, HashSet<&'static str>> {
        let valid_codes: HashSet<_> = self.register.keys().copied().collect();

        let reference_map: HashMap<_, HashSet<_>> = valid_codes
            .iter()
            .map(|&code| (code, HashSet::from([code])))
            .collect();

        let name_map = {
            let mut name_map = HashMap::new();
            for manifest in self.register.values() {
                name_map
                    .entry(manifest.name)
                    .or_insert_with(HashSet::new)
                    .insert(manifest.code);
            }
            name_map
        };

        let name_collisions: HashSet<_> = {
            let name_keys: HashSet<_> = name_map.keys().copied().collect();
            name_keys.intersection(&valid_codes).copied().collect()
        };

        if !name_collisions.is_empty() {
            log::warn!(
                "The following defined rule names were found which collide with codes. Those \
                 names will not be available for selection: {name_collisions:?}",
            );
        }

        let reference_map: HashMap<_, _> = chain(name_map, reference_map).collect();

        let mut group_map: HashMap<_, HashSet<&'static str>> = HashMap::new();
        for manifest in self.register.values() {
            for group in manifest.groups {
                let group = group.as_ref();
                if let Some(codes) = reference_map.get(group) {
                    log::warn!(
                        "Rule {} defines group '{}' which is already defined as a name or code of \
                         {:?}. This group will not be available for use as a result of this \
                         collision.",
                        manifest.code,
                        group,
                        codes
                    );
                } else {
                    group_map
                        .entry(group)
                        .or_insert_with(HashSet::new)
                        .insert(manifest.code);
                }
            }
        }

        chain(group_map, reference_map).collect()
    }

    fn expand_rule_refs(
        &self,
        glob_list: Vec<String>,
        reference_map: &HashMap<&'static str, HashSet<&'static str>>,
    ) -> Result<HashSet<&'static str>, SQLFluffUserError> {
        let mut expanded_rule_set = HashSet::new();
        let mut unknown_rules = Vec::new();

        for r in glob_list {
            if reference_map.contains_key(r.as_str()) {
                expanded_rule_set.extend(reference_map[r.as_str()].clone());
            } else {
                unknown_rules.push(r);
            }
        }

        if !unknown_rules.is_empty() {
            let mut available_rules: Vec<_> = reference_map.keys().copied().collect();
            available_rules.sort();
            return Err(SQLFluffUserError::new(format!(
                "Unknown rule(s) in configuration: {}. Available rules are: {}",
                unknown_rules.join(", "),
                available_rules.join(", ")
            )));
        }

        Ok(expanded_rule_set)
    }

    pub(crate) fn get_rulepack(&self, config: &FluffConfig) -> Result<RulePack, SQLFluffUserError> {
        let reference_map = self.rule_reference_map();
        let rules = config.get_section("rules");
        let keylist = self.register.keys();
        let mut instantiated_rules = Vec::with_capacity(keylist.len());

        let allowlist: Vec<String> = match config.get("rule_allowlist", "core").as_array() {
            Some(array) => array
                .iter()
                .map(|it| it.as_string().unwrap().to_owned())
                .collect(),
            None => self.register.keys().map(|it| it.to_string()).collect(),
        };

        let denylist: Vec<String> = match config.get("rule_denylist", "core").as_array() {
            Some(array) => array
                .iter()
                .map(|it| it.as_string().unwrap().to_owned())
                .collect(),
            None => Vec::new(),
        };

        let expanded_allowlist = self.expand_rule_refs(allowlist, &reference_map)?;
        let expanded_denylist = self.expand_rule_refs(denylist, &reference_map)?;

        let keylist: Vec<_> = keylist
            .into_iter()
            .filter(|&&r| expanded_allowlist.contains(r) && !expanded_denylist.contains(r))
            .collect();

        for code in keylist {
            let rule = self.register[code].rule_class.clone();
            let rule_config_ref = rule.config_ref();

            let tmp = HashMap::new();

            let specific_rule_config = rules
                .get(rule_config_ref)
                .and_then(|section| section.as_map())
                .unwrap_or(&tmp);

            instantiated_rules.push(
                rule.load_from_config(specific_rule_config)
                    .map_err(SQLFluffUserError::new)?,
            );
        }

        Ok(RulePack {
            rules: instantiated_rules,
            _reference_map: reference_map,
        })
    }
}