shuck-linter 0.0.43

use shuck_ast::Span;

use crate::{Checker, Diagnostic, Edit, Fix, FixAvailability, Rule, Violation};

pub struct UnquotedArraySplit;

impl Violation for UnquotedArraySplit {
    const FIX_AVAILABILITY: FixAvailability = FixAvailability::Always;

    fn rule() -> Rule {
        Rule::UnquotedArraySplit
    }

    fn message(&self) -> String {
        "quote array assignment expansions to avoid accidental splitting".to_owned()
    }

    fn fix_title(&self) -> Option<String> {
        Some("quote the array-assignment expansion".to_owned())
    }
}

pub fn unquoted_array_split(checker: &mut Checker) {
    let source = checker.source();
    let diagnostics = checker
        .facts()
        .words()
        .array_assignment_split_word_facts()
        .flat_map(|fact| {
            let candidate_spans = fact
                .array_assignment_split_scalar_expansion_spans()
                .iter()
                .copied()
                .chain(fact.unquoted_array_expansion_spans().iter().copied())
                .collect::<Vec<_>>();
            let command_substitution_spans = fact.command_substitution_spans();
            fact.parts_with_spans()
                .filter_map(|(part, part_span)| {
                    candidate_spans
                        .contains(&part_span)
                        .then_some((part, part_span))
                })
                .filter(|(_part, part_span)| {
                    !command_substitution_spans
                        .iter()
                        .any(|outer| span_contains(*outer, *part_span))
                        && !is_excluded_special_parameter_span(*part_span, source)
                })
                .map(|(_, part_span)| part_span)
                .collect::<Vec<_>>()
        })
        .map(|span| {
            Diagnostic::new(UnquotedArraySplit, span)
                .with_fix(Fix::unsafe_edit(double_quote_span_edit(span, source)))
        })
        .collect::<Vec<_>>();

    for diagnostic in diagnostics {
        checker.report_diagnostic_dedup(diagnostic);
    }
}

fn span_contains(outer: Span, inner: Span) -> bool {
    outer.start.offset <= inner.start.offset && outer.end.offset >= inner.end.offset
}

fn is_excluded_special_parameter_span(span: Span, source: &str) -> bool {
    matches!(span.slice(source), "$!" | "$?" | "$$" | "$#" | "$-")
}

fn double_quote_span_edit(span: Span, source: &str) -> Edit {
    Edit::replacement(format!("\"{}\"", span.slice(source)), span)
}

#[cfg(test)]
mod tests {
    use crate::test::{test_snippet, test_snippet_with_fix};
    use crate::{Applicability, LinterSettings, Rule, ShellDialect};

    #[test]
    fn reports_unquoted_expansions_in_array_assignments() {
        let source = "\
#!/bin/bash
x='a b'
arr=($x ${x} prefix$x $@ $* ${items[@]} ${items[*]} ${x:-a b} $HOME/*.txt)
declare listed=($x)
arr+=($tail)
";
        let diagnostics = test_snippet(source, &LinterSettings::for_rule(Rule::UnquotedArraySplit));

        assert_eq!(
            diagnostics
                .iter()
                .map(|diagnostic| diagnostic.span.slice(source))
                .collect::<Vec<_>>(),
            vec![
                "$x",
                "${x}",
                "$x",
                "$@",
                "$*",
                "${items[@]}",
                "${items[*]}",
                "${x:-a b}",
                "$HOME",
                "$x",
                "$tail"
            ]
        );
    }

    #[test]
    fn applies_unsafe_fix_by_quoting_array_assignment_expansions() {
        let source = "#!/bin/bash\narr=($x ${items[@]})\n";
        let result = test_snippet_with_fix(
            source,
            &LinterSettings::for_rule(Rule::UnquotedArraySplit),
            Applicability::Unsafe,
        );

        assert_eq!(result.fixes_applied, 2);
        assert_eq!(
            result.fixed_source,
            "#!/bin/bash\narr=(\"$x\" \"${items[@]}\")\n"
        );
        assert!(result.fixed_diagnostics.is_empty());
    }

    #[test]
    fn ignores_quoted_scalar_assignments_and_keyed_entries() {
        let source = "\
#!/bin/bash
value=$x
arr=(\"$x\" \"${items[@]}\" \"${x:-a b}\")
arr=([0]=$x [1]=\"${y}\")
declare -A map=([k]=$x)
";
        let diagnostics = test_snippet(source, &LinterSettings::for_rule(Rule::UnquotedArraySplit));

        assert!(diagnostics.is_empty());
    }

    #[test]
    fn leaves_command_substitution_spans_for_s018() {
        let source = "\
#!/bin/bash
arr=($(cmd))
arr=(foo $(cmd)$x bar)
arr=(\"$(cmd)\" \"$x\")
";
        let diagnostics = test_snippet(source, &LinterSettings::for_rule(Rule::UnquotedArraySplit));

        assert_eq!(
            diagnostics
                .iter()
                .map(|diagnostic| diagnostic.span.slice(source))
                .collect::<Vec<_>>(),
            vec!["$x"]
        );
    }

    #[test]
    fn ignores_quoted_command_substitutions_with_quoted_inner_expansions() {
        let source = "\
#!/bin/bash
arr=(\"$(printf '%s\\n' \"$x\")\")
";
        let diagnostics = test_snippet(source, &LinterSettings::for_rule(Rule::UnquotedArraySplit));
        let slices = diagnostics
            .iter()
            .map(|diagnostic| diagnostic.span.slice(source))
            .collect::<Vec<_>>();
        assert_eq!(slices, Vec::<&str>::new());
    }

    #[test]
    fn ignores_expansions_inside_quoted_pipelined_heredoc_substitutions() {
        let source = r#"# shellcheck shell=bash
project=owner/repo
graphql_request=(
  -X POST
  -d "$(
    cat <<-EOF | tr '\n' ' '
      {
        "query": "query {
          repository(owner: \"${project%/*}\", name: \"${project##*/}\") {
            refs(refPrefix: \"refs/tags/\")
          }
        }"
      }
EOF
  )"
)
"#;
        let diagnostics = test_snippet(source, &LinterSettings::for_rule(Rule::UnquotedArraySplit));
        let slices = diagnostics
            .iter()
            .map(|diagnostic| diagnostic.span.slice(source))
            .collect::<Vec<_>>();
        assert_eq!(slices, Vec::<&str>::new());
    }

    #[test]
    fn ignores_safe_special_parameters() {
        let source = "\
#!/bin/bash
arr=($! $? $$ $# $-)
arr=($0 $1)
";
        let diagnostics = test_snippet(source, &LinterSettings::for_rule(Rule::UnquotedArraySplit));

        assert_eq!(
            diagnostics
                .iter()
                .map(|diagnostic| diagnostic.span.slice(source))
                .collect::<Vec<_>>(),
            vec!["$0", "$1"]
        );
    }

    #[test]
    fn ignores_use_replacement_expansions_in_array_assignments() {
        let source = "\
#!/bin/bash
arr=(${flag:+-f} ${flag:+$fallback} ${name:+\"$name\" \"$regex\"} ${items[@]+\"${items[@]}\"})
";
        let diagnostics = test_snippet(source, &LinterSettings::for_rule(Rule::UnquotedArraySplit));

        assert!(diagnostics.is_empty());
    }

    #[test]
    fn skips_native_zsh_scalar_array_elements_without_split_behavior() {
        let source = "arr=($name)\nsetopt sh_word_split\narr=($name)\n";
        let diagnostics = test_snippet(
            source,
            &LinterSettings::for_rule(Rule::UnquotedArraySplit).with_shell(ShellDialect::Zsh),
        );

        assert_eq!(
            diagnostics
                .iter()
                .map(|diagnostic| diagnostic.span.slice(source))
                .collect::<Vec<_>>(),
            vec!["$name"]
        );
    }

    #[test]
    fn ignores_expansions_inside_brace_expansion_templates() {
        let source = "\
#!/bin/bash
arr=({$XDG_CONFIG_HOME,$HOME}/{alacritty,}/{.,}alacritty.ym?)
arr=($prefix{a,b} {a,b}$suffix {pre$inside,other})
";
        let diagnostics = test_snippet(source, &LinterSettings::for_rule(Rule::UnquotedArraySplit));

        assert_eq!(
            diagnostics
                .iter()
                .map(|diagnostic| diagnostic.span.slice(source))
                .collect::<Vec<_>>(),
            vec!["$prefix", "$suffix"]
        );
    }

    #[test]
    fn reports_expansions_inside_literal_braces_for_sh() {
        let source = "\
# shellcheck shell=sh
arr=({pre$inside,other})
";
        let diagnostics = test_snippet(
            source,
            &LinterSettings::for_rule(Rule::UnquotedArraySplit).with_shell(ShellDialect::Sh),
        );

        assert_eq!(
            diagnostics
                .iter()
                .map(|diagnostic| diagnostic.span.slice(source))
                .collect::<Vec<_>>(),
            vec!["$inside"]
        );
    }
}