xan 0.54.0

use std::io::{stdout, Write};

use colored::Colorize;
use lazy_static::lazy_static;
use regex::{Captures, Regex};
use textwrap::{fill, indent};

use crate::util;
use crate::CliResult;

fn wrap(string: &str) -> String {
    fill(string, 81)
}

fn get_cheatsheet_str() -> &'static str {
    include_str!("../moonblade/doc/cheatsheet.md")
}

fn get_operators_json_str() -> &'static str {
    include_str!("../moonblade/doc/operators.json")
}

fn get_functions_help_prelude_str() -> &'static str {
    include_str!("../moonblade/doc/functions_prelude.txt")
}

fn get_functions_help_json_str() -> &'static str {
    include_str!("../moonblade/doc/functions.json")
}

fn get_aggs_help_prelude_str() -> &'static str {
    include_str!("../moonblade/doc/aggs_prelude.txt")
}

fn get_aggs_help_json_str() -> &'static str {
    include_str!("../moonblade/doc/aggs.json")
}

fn get_scraping_cheatsheet_str() -> &'static str {
    include_str!("../moonblade/doc/scraping.md")
}

fn get_scraping_functions_json_str() -> &'static str {
    include_str!("../moonblade/doc/scraping.json")
}

fn get_window_help_prelude_str() -> &'static str {
    include_str!("../moonblade/doc/window_prelude.txt")
}

fn get_window_help_json_str() -> &'static str {
    include_str!("../moonblade/doc/window.json")
}

fn escape_markdown_argument(string: &str) -> String {
    string
        .replace("*", "\\*")
        .replace("<", "\\<")
        .replace(">", "\\>")
}

fn escape_markdown_linebreaks(string: &str) -> String {
    string.replace("\n\n", "<br>").replace("\n", "<br>")
}

fn slug(string: &str) -> String {
    string
        .to_lowercase()
        .replace(|c: char| c != ' ' && !c.is_ascii_alphanumeric(), "")
        .replace(' ', "-")
}

#[derive(Deserialize, Debug)]
struct OperatorHelpSections(Vec<OperatorHelpSection>);

impl OperatorHelpSections {
    fn txt_summary(&self) -> String {
        let mut string = String::new();

        string.push_str("- Operators\n");

        string.push_str(
            &self
                .0
                .iter()
                .map(|section| format!("    - {}", section.title))
                .collect::<Vec<_>>()
                .join("\n"),
        );

        string.push('\n');

        string
    }

    fn md_summary(&self) -> String {
        let mut string = String::new();

        string.push_str("- [Operators](#operators)\n");

        string.push_str(
            &self
                .0
                .iter()
                .map(|section| format!("    - [{}](#{})", section.title, slug(&section.title)))
                .collect::<Vec<_>>()
                .join("\n"),
        );

        string.push('\n');

        string
    }

    fn to_txt(&self) -> String {
        let mut string = String::new();

        string.push_str("## Operators\n\n");

        for section in self.0.iter() {
            string.push_str(&section.to_txt());
        }

        string
    }

    fn to_md(&self) -> String {
        let mut string = String::new();

        string.push_str("## Operators\n\n");

        for section in self.0.iter() {
            string.push_str(&section.to_md());
        }

        string
    }
}

#[derive(Deserialize, Debug)]
struct OperatorHelpSection {
    title: String,
    prelude: Option<String>,
    examples: Vec<OperatorExample>,
}

impl OperatorHelpSection {
    fn to_txt(&self) -> String {
        let mut string = String::new();

        string.push_str(&format!("### {}\n\n", self.title));

        if let Some(prelude) = self.prelude.as_ref() {
            string.push_str(&wrap(prelude));
            string.push_str("\n\n");
        }

        let max_width = self
            .examples
            .iter()
            .map(|example| example.snippet.len())
            .max()
            .unwrap();

        for example in self.examples.iter() {
            string.push_str(&indent(&example.to_txt(max_width), "    "));
            string.push('\n');
        }

        string.push_str("\n\n");

        string
    }

    fn to_md(&self) -> String {
        let mut string = String::new();

        string.push_str(&format!("### {}\n\n", self.title));

        if let Some(prelude) = self.prelude.as_ref() {
            string.push_str(prelude);
            string.push_str("\n\n");
        }

        let max_width = self
            .examples
            .iter()
            .map(|example| example.snippet.len())
            .max()
            .unwrap();

        string.push_str("```txt\n");

        for example in self.examples.iter() {
            string.push_str(&example.to_txt(max_width));
            string.push('\n');
        }

        string.push_str("```\n\n");

        string
    }
}

#[derive(Deserialize, Debug)]
struct OperatorExample {
    snippet: String,
    help: Option<String>,
}

impl OperatorExample {
    fn to_txt(&self, width: usize) -> String {
        match &self.help {
            Some(help) => format!("{:<width$} - {}", self.snippet, help, width = width),
            None => self.snippet.clone(),
        }
    }
}

#[derive(Deserialize, Debug)]
struct FunctionHelpSections(Vec<FunctionHelpSection>);

impl FunctionHelpSections {
    fn to_txt(&self, operator_sections: &OperatorHelpSections, section: &Option<String>) -> String {
        let mut should_keep_operators = true;

        let filtered_sections: Vec<&FunctionHelpSection> = if let Some(query) = section {
            if !"operators".contains(&query.to_lowercase()) {
                should_keep_operators = false;
            }

            self.0
                .iter()
                .filter(|s| s.title.to_lowercase().contains(&query.to_lowercase()))
                .collect()
        } else {
            self.0.iter().collect()
        };

        let mut string = String::new();

        // Prelude
        string.push_str(&colorize_functions_help(get_functions_help_prelude_str()));
        string.push('\n');

        // Summary
        if should_keep_operators {
            string.push_str(&operator_sections.txt_summary());
        }
        string.push_str(
            &filtered_sections
                .iter()
                .map(|section| format!("- {}", section.title))
                .collect::<Vec<_>>()
                .join("\n"),
        );
        string.push_str("\n\n");

        // Operators
        if should_keep_operators {
            string.push_str(&colorize_functions_help(&operator_sections.to_txt()));
        }

        // Sections
        string.push_str(
            &filtered_sections
                .iter()
                .map(|section| section.to_txt())
                .collect::<Vec<_>>()
                .join(""),
        );

        string
    }

    fn to_md(&self, operator_sections: &OperatorHelpSections) -> String {
        let mut string = String::new();

        // Prelude
        string.push_str(get_functions_help_prelude_str());
        string.push('\n');

        // Summary
        string.push_str(&operator_sections.md_summary());
        string.push_str(
            &self
                .0
                .iter()
                .map(|section| format!("- [{}](#{})", section.title, slug(&section.title)))
                .collect::<Vec<_>>()
                .join("\n"),
        );
        string.push_str("\n\n");

        // Operators
        string.push_str(&operator_sections.to_md());
        string.push('\n');

        // Sections
        string.push_str(
            &self
                .0
                .iter()
                .map(|section| section.to_md())
                .collect::<Vec<_>>()
                .join(""),
        );

        string
    }
}

#[derive(Deserialize, Debug)]
struct FunctionHelpSection {
    title: String,
    functions: Vec<FunctionHelp>,
}

impl FunctionHelpSection {
    fn to_txt(&self) -> String {
        let mut string = String::new();

        string.push_str(&format!("## {}\n\n", self.title).yellow().to_string());

        for function in self.functions.iter() {
            string.push_str(&indent(&function.to_txt(), "    "));
        }

        string.push('\n');
        string
    }

    fn to_md(&self) -> String {
        let mut string = String::new();

        string.push_str(&format!("## {}\n\n", self.title));

        for function in self.functions.iter() {
            string.push_str(&function.to_md());
        }

        string.push('\n');
        string
    }
}

#[derive(Deserialize, Debug)]
struct FunctionHelp {
    name: String,
    arguments: Option<Vec<String>>,
    returns: String,
    help: String,
    aliases: Option<Vec<String>>,
    alternatives: Option<Vec<Vec<String>>>,
}

fn join_arguments(args: &[String]) -> String {
    args.iter()
        .map(|arg| {
            if arg.starts_with('<') {
                arg.dimmed().to_string()
            } else {
                arg.red().to_string()
            }
        })
        .collect::<Vec<_>>()
        .join(", ")
}

impl FunctionHelp {
    fn to_txt(&self) -> String {
        fn single_form(
            name: &str,
            aliases: Option<&Vec<String>>,
            args_opt: Option<&Vec<String>>,
            returns: &str,
        ) -> String {
            if let Some(args) = args_opt {
                format!(
                    "- {}{}({}) -> {}\n",
                    name.cyan(),
                    if let Some(names) = aliases {
                        ", ".to_string()
                            + &names
                                .iter()
                                .map(|name| name.cyan().to_string())
                                .collect::<Vec<_>>()
                                .join(", ")
                    } else {
                        "".to_string()
                    },
                    join_arguments(args),
                    returns.magenta()
                )
            } else {
                format!("- {} -> {}\n", name.cyan(), returns.magenta())
            }
        }

        let mut string = String::new();

        // Main call
        string.push_str(&single_form(
            &self.name,
            self.aliases.as_ref(),
            self.arguments.as_ref(),
            &self.returns,
        ));

        // Alternatives
        for alternative in self.alternatives.iter().flatten() {
            string.push_str(&single_form(
                &self.name,
                self.aliases.as_ref(),
                Some(alternative),
                &self.returns,
            ));
        }

        string.push_str(&colorize_functions_help(&indent(&wrap(&self.help), "    ")));
        string.push_str("\n\n");

        string
    }

    fn to_md(&self) -> String {
        fn single_form(
            name: &str,
            args_opt: Option<&Vec<String>>,
            returns: &str,
            help: &str,
            aliases: &Option<Vec<String>>,
        ) -> String {
            format!(
                "- **{}**{} -> `{}`{}: {}",
                name,
                match args_opt {
                    Some(args) => {
                        format!(
                            "({})",
                            args.iter()
                                .map(|arg| format!("*{}*", escape_markdown_argument(arg)))
                                .collect::<Vec<_>>()
                                .join(", ")
                        )
                    }
                    None => "".to_string(),
                },
                returns,
                if let Some(names) = aliases {
                    format!(
                        " (aliases: {})",
                        names
                            .iter()
                            .map(|name| format!("**{}**", name))
                            .collect::<Vec<_>>()
                            .join(", ")
                    )
                } else {
                    String::new()
                },
                escape_markdown_linebreaks(help)
            )
        }

        let mut string = String::new();

        // Main call
        string.push_str(&single_form(
            &self.name,
            self.arguments.as_ref(),
            &self.returns,
            &self.help,
            &self.aliases,
        ));

        // Alternatives
        for alternative in self.alternatives.iter().flatten() {
            string.push('\n');
            string.push_str(&single_form(
                &self.name,
                Some(alternative),
                &self.returns,
                &self.help,
                &self.aliases,
            ));
        }

        string.push('\n');

        string
    }
}

#[derive(Debug, Deserialize)]
struct Aggs(&'static str, Vec<FunctionHelp>);

impl Aggs {
    fn to_txt(&self) -> String {
        let mut string = String::new();

        string.push_str(&colorize_functions_help(self.0));
        string.push('\n');

        string.push_str(
            &self
                .1
                .iter()
                .map(|help| indent(&help.to_txt(), "    "))
                .collect::<Vec<_>>()
                .join(""),
        );

        string
    }

    fn to_md(&self) -> String {
        let mut string = String::new();

        string.push_str(self.0);
        string.push('\n');

        string.push_str(
            &self
                .1
                .iter()
                .map(|help| help.to_md())
                .collect::<Vec<_>>()
                .join(""),
        );

        string
    }
}

#[derive(Debug, Deserialize)]
struct ScrapingHelp {
    selectors: Vec<FunctionHelp>,
    extractors: Vec<FunctionHelp>,
}

impl ScrapingHelp {
    fn to_txt(&self) -> String {
        let mut string = String::new();

        string.push_str(&recombobulate_cheatsheet(get_scraping_cheatsheet_str()));
        string.push_str(&format!("\n\n{}\n\n", "## Selector functions".yellow()));

        string.push_str(
            &self
                .selectors
                .iter()
                .map(|help| indent(&help.to_txt(), "    "))
                .collect::<Vec<_>>()
                .join(""),
        );

        string.push_str(&format!("\n{}\n\n", "## Extractor functions".yellow()));

        string.push_str(
            &self
                .extractors
                .iter()
                .map(|help| indent(&help.to_txt(), "    "))
                .collect::<Vec<_>>()
                .join(""),
        );

        string
    }

    fn to_md(&self) -> String {
        let mut string = String::new();

        string.push_str(get_scraping_cheatsheet_str());
        string.push_str("\n\n## Selector functions\n\n");

        string.push_str(
            &self
                .selectors
                .iter()
                .map(|help| help.to_md())
                .collect::<Vec<_>>()
                .join(""),
        );

        string.push_str("\n## Extractor functions\n\n");

        string.push_str(
            &self
                .extractors
                .iter()
                .map(|help| help.to_md())
                .collect::<Vec<_>>()
                .join(""),
        );

        string
    }
}

lazy_static! {
    static ref LINK_REGEX: Regex = Regex::new(r"- \[([^\]]+)\]\(#[^)]+\)").unwrap();
    static ref CODE_FENCE_REGEX: Regex =
        Regex::new(r"```(?:python|scss|javascript)(\n[^`]+)```").unwrap();
    static ref COMMENT_REGEX: Regex = Regex::new(r"(?m)^    (?:\x1b\[[0-9;]*m)?#.+").unwrap();
    static ref NUMBER_REGEX: Regex = Regex::new(r"(?m)\b-?[0-9][0-9._]*\b").unwrap();
    static ref SPECIAL_REGEX: Regex = Regex::new(r"true|false|null|/john/i?").unwrap();
    static ref FUNCTION_CALL_REGEX: Regex = Regex::new(r"([a-z_]+)\(").unwrap();
    static ref OPERATORS_REGEX: Regex = Regex::new(r" (=>|eq|in|as|\|\||[<>/+]) ").unwrap();
    static ref ANSI_COLOR_REGEX: Regex = Regex::new(r"\x1b\[[0-9;]*m").unwrap();
}

fn strip_ansi_colors(string: &str) -> String {
    ANSI_COLOR_REGEX.replace_all(string, "").into_owned()
}

fn recombobulate_cheatsheet(help: &str) -> String {
    let help = help.replace(
        "[`xan help functions`](./functions.md)",
        "`xan help functions`",
    );
    let help = help.replace(
        "[`xan help cheatsheet`](./cheatsheet.md)",
        "`xan help cheatsheet`",
    );
    let help = help.replace("[`xan help aggs`](./aggs.md)", "`xan help aggs`");
    let help = NUMBER_REGEX.replace_all(&help, |caps: &Captures| caps[0].red().to_string());

    let help = colorize_functions_help(&help);

    let help = LINK_REGEX.replace_all(&help, "- $1");

    let help = CODE_FENCE_REGEX.replace_all(&help, |caps: &Captures| {
        let text = SPECIAL_REGEX.replace_all(&caps[1], |c: &Captures| c[0].yellow().to_string());
        let text =
            FUNCTION_CALL_REGEX.replace_all(&text, |c: &Captures| format!("{}(", c[1].blue()));
        let text = OPERATORS_REGEX.replace_all(&text, |c: &Captures| format!(" {} ", c[1].cyan()));

        indent(&text, "    ")
    });

    let help = COMMENT_REGEX.replace_all(&help, |caps: &Captures| {
        strip_ansi_colors(&caps[0]).dimmed().to_string()
    });

    help.into_owned()
}

lazy_static! {
    static ref MAIN_SECTION_REGEX: Regex = Regex::new("(?m)^##{0,2} .+").unwrap();
    static ref FLAG_REGEX: Regex = Regex::new(r"--[\w\-]+").unwrap();
    static ref UNARY_OPERATOR_REGEX: Regex = Regex::new(r"([!-])x").unwrap();
    static ref BINARY_OPERATOR_REGEX: Regex = Regex::new(
        r"x (==|!=|<=?|>=?|&&|\|\||and|or|not in|in|eq|ne|lt|le|gt|ge|//|\*\*|\+\+|[+\-*/%]) y"
    )
    .unwrap();
    static ref URL_REGEX: Regex = Regex::new(r"https?://\S+").unwrap();
    static ref PIPELINE_OPERATOR_REGEX: Regex = Regex::new(r"(trim\(name\) )\|").unwrap();
    static ref SLICE_REGEX: Regex = Regex::new(r"x\[([a-z:]+)\]").unwrap();
    static ref QUOTE_REGEX: Regex = Regex::new(r#"(?m)"[^"\n]+"|'[^'\n]+'|`[^`\n]+`"#).unwrap();
}

fn colorize_functions_help(help: &str) -> String {
    let help = QUOTE_REGEX.replace_all(help, |caps: &Captures| caps[0].green().to_string());

    let help =
        MAIN_SECTION_REGEX.replace_all(&help, |caps: &Captures| caps[0].yellow().to_string());

    let help = URL_REGEX.replace_all(&help, |caps: &Captures| caps[0].blue().to_string());

    let help = UNARY_OPERATOR_REGEX.replace_all(&help, |caps: &Captures| {
        caps[1].cyan().to_string() + &"x".red().to_string()
    });

    let help = BINARY_OPERATOR_REGEX.replace_all(&help, |caps: &Captures| {
        "x".red().to_string() + " " + &caps[1].cyan().to_string() + " " + &"y".red().to_string()
    });

    let help = PIPELINE_OPERATOR_REGEX.replace_all(&help, |caps: &Captures| {
        caps[1].to_string() + &"|".cyan().to_string()
    });

    let help = SLICE_REGEX.replace_all(&help, |caps: &Captures| {
        "x".red().to_string()
            + "["
            + &caps[1]
                .split(':')
                .map(|part| part.cyan().to_string())
                .collect::<Vec<_>>()
                .join(":")
            + "]"
    });

    let help = FLAG_REGEX.replace_all(&help, |caps: &Captures| caps[0].cyan().to_string());

    help.into_owned()
}

fn get_colorized_cheatsheet() -> String {
    recombobulate_cheatsheet(get_cheatsheet_str())
}

fn parse_functions_help() -> FunctionHelpSections {
    let json_str = get_functions_help_json_str();
    serde_json::from_str(json_str).unwrap()
}

fn parse_operators_help() -> OperatorHelpSections {
    let json_str = get_operators_json_str();
    serde_json::from_str(json_str).unwrap()
}

fn parse_aggs_help() -> Aggs {
    let json_str = get_aggs_help_json_str();
    let help: Vec<FunctionHelp> = serde_json::from_str(json_str).unwrap();
    Aggs(get_aggs_help_prelude_str(), help)
}

fn parse_window_help() -> Aggs {
    let json_str = get_window_help_json_str();
    let help: Vec<FunctionHelp> = serde_json::from_str(json_str).unwrap();
    Aggs(get_window_help_prelude_str(), help)
}

fn parse_scraping_help() -> ScrapingHelp {
    let json_str = get_scraping_functions_json_str();
    serde_json::from_str(json_str).unwrap()
}

static USAGE: &str = "
Print help about the `xan` expression language.

`xan help cheatsheet` will print a short cheatsheet about
how the language works. It can also be found online here:
https://github.com/medialab/xan/blob/master/docs/moonblade/cheatsheet.md

`xan help functions` will print the reference of all of the language's
functions (used in `xan select -e`, `xan map`, `xan filter`, `xan transform`,
`xan flatmap` etc.). It can also be found online here:
https://github.com/medialab/xan/blob/master/docs/moonblade/functions.md

`xan help aggs` will print the reference of all of the language's
aggregation functions (as used in `xan agg` and `xan groupby` mostly).
It can also be found online here:
https://github.com/medialab/xan/blob/master/docs/moonblade/aggs.md

`xan help scraping` will print information about the DSL used
by `xan scrape` and the related functions. It can also be found online here:
https://github.com/medialab/xan/blob/master/docs/moonblade/scraping.md

`xan help window` will print the reference of all of the language's
window aggregation functions (as used in `xan window`).
It can also be found online here:
https://github.com/medialab/xan/blob/master/docs/moonblade/window.md

Use the -p/--pager flag to open desired documentation in a suitable
pager.

Use the -O/--open to read the desired documentation online (might
be slightly out of date!).

Usage:
    xan help cheatsheet [options]
    xan help functions [options]
    xan help aggs [options]
    xan help scraping [options]
    xan help window [options]
    xan help --help

help options:
    -O, --open             Open the desired docs in a web browser.
    -p, --pager            Pipe the help into a pager (Same as piping
                           with forced colors into `less -SRi`).
    -S, --section <query>  Filter the `functions` doc to only include
                           sections matching the given case-insensitive
                           query.
    --json                 Dump the help as JSON data.
    --md                   Dump the help as Markdown.

Common options:
    -h, --help             Display this message
";

#[derive(Deserialize)]
struct Args {
    cmd_cheatsheet: bool,
    cmd_functions: bool,
    cmd_aggs: bool,
    cmd_scraping: bool,
    cmd_window: bool,
    flag_open: bool,
    flag_pager: bool,
    flag_section: Option<String>,
    flag_json: bool,
    flag_md: bool,
}

impl Args {
    fn open(&self) {
        let url = format!(
            "https://github.com/medialab/xan/blob/master/docs/moonblade/{}.md",
            if self.cmd_cheatsheet {
                "cheatsheet"
            } else if self.cmd_functions {
                "functions"
            } else if self.cmd_aggs {
                "aggs"
            } else if self.cmd_scraping {
                "scraping"
            } else if self.cmd_window {
                "window"
            } else {
                unreachable!()
            }
        );

        opener::open_browser(url).expect("could not open browser");
    }

    fn setup_pager(&self) -> CliResult<()> {
        if !self.flag_pager {
            return Ok(());
        }

        #[cfg(not(windows))]
        {
            colored::control::set_override(true);
            pager::Pager::with_pager("less -SRi").setup();
            Ok(())
        }

        #[cfg(windows)]
        {
            Err("The -p/--pager flag does not work on windows, sorry :'(".to_string())?
        }
    }
}

pub fn run(argv: &[&str]) -> CliResult<()> {
    let args: Args = util::get_args(USAGE, argv)?;

    if args.flag_open {
        args.open();

        return Ok(());
    }

    if args.flag_pager && (args.flag_json || args.flag_md) {
        Err("-p/--pager does not work with --json nor --md!")?;
    }

    if args.flag_section.is_some() && !args.cmd_functions {
        Err("-S/--section <query> only works with the `functions` subcommand!")?;
    }

    let mut out = stdout();

    if args.cmd_cheatsheet {
        if args.flag_json {
            Err("cheatsheet does not support --json!")?;
        }

        if args.flag_md {
            writeln!(&mut out, "{}", get_cheatsheet_str())?;
        } else {
            args.setup_pager()?;
            writeln!(&mut out, "{}", get_colorized_cheatsheet())?;
        }
    } else if args.cmd_functions {
        if args.flag_json {
            writeln!(&mut out, "{}", get_functions_help_json_str())?;
        } else if args.flag_md {
            write!(
                &mut out,
                "{}",
                parse_functions_help().to_md(&parse_operators_help())
            )?;
        } else {
            args.setup_pager()?;
            write!(
                &mut out,
                "{}",
                parse_functions_help().to_txt(&parse_operators_help(), &args.flag_section)
            )?;
        }
    } else if args.cmd_aggs {
        if args.flag_json {
            writeln!(&mut out, "{}", get_aggs_help_json_str())?;
        } else if args.flag_md {
            write!(&mut out, "{}", parse_aggs_help().to_md())?;
        } else {
            args.setup_pager()?;
            write!(&mut out, "{}", parse_aggs_help().to_txt())?;
        }
    } else if args.cmd_scraping {
        if args.flag_json {
            writeln!(&mut out, "{}", get_scraping_functions_json_str())?;
        } else if args.flag_md {
            write!(&mut out, "{}", parse_scraping_help().to_md())?;
        } else {
            args.setup_pager()?;
            write!(&mut out, "{}", parse_scraping_help().to_txt())?;
        }
    } else if args.cmd_window {
        if args.flag_json {
            writeln!(&mut out, "{}", get_window_help_json_str())?;
        } else if args.flag_md {
            write!(&mut out, "{}", parse_window_help().to_md())?;
        } else {
            args.setup_pager()?;
            write!(&mut out, "{}", parse_window_help().to_txt())?;
        }
    }

    Ok(())
}