readmer 0.0.6

Compose README.md files from Liquid or Jinja2 templates.
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

// This is free and unencumbered software released into the public domain.

use super::Context;
use crate::{
    Git, TempContext, Utf8Path, Workspace,
    model::{LoadError, Package},
};
use alloc::{format, string::String};
use core::result::Result;
use serde_json::{Map, Value, json};

#[derive(Clone, Debug, Default)]
pub struct DirContext {
    pub workspace: Workspace,
}

impl DirContext {
    pub fn load(&self) -> Result<TempContext, LoadError> {
        let mut output = TempContext::new();

        let workspace_config = self.workspace.config();

        let root_project = workspace_config.project();
        if let Some(project) = root_project {
            output.define("project", project.into_json());
        }

        let git_remote_url = Git::default().remote_get_url();
        if let Ok(ref url) = git_remote_url {
            output.define(
                "git",
                json!({ "remote": { "url": url } }),
                // TODO: git.branch
            );
        }

        let prefix = &self.workspace.0.down;
        if !prefix.as_str().is_empty() {
            let cwd_project = workspace_config.subproject(prefix);
            if let Some(project) = cwd_project {
                output.define("subproject", project.into_json());
            }
        }

        //let package_path = project.unwrap_or_else(|| ".".into()); // TODO
        if let Some(package) = Package::locate(".").ok() {
            if let Some(link) = package.repository.as_ref()
                && link.contains("github.com")
            {
                output.define(
                    "github",
                    json!({
                        // TODO: account
                        "repository": {
                            "link": link,
                            "url": format!("{}.git", link),
                        }
                    }),
                );
            }
            package.metadata.as_ref().map(|metadata| {
                metadata.get("readmer").map(|readmer| {
                    output.merge(json!(readmer));
                });
            });
            output.define("package", package.into_json());
        }

        if !output.has_defined("github")
            && let Ok(url) = git_remote_url
            && url.contains("github.com")
        {
            let slug = if let Some(path) = url.strip_prefix("https://github.com/") {
                // For example: "https://github.com/artob/readmer"
                // For example: "https://github.com/artob/readmer.git"
                Some(path.strip_suffix(".git").unwrap_or(path))
            } else if let Some(path) = url.strip_prefix("ssh://git@github.com/") {
                // For example: "ssh://git@github.com/artob/readmer.git"
                Some(path.strip_suffix(".git").unwrap_or(path))
            } else if let Some(path) = url.strip_prefix("git@github.com:") {
                // For example: "git@github.com:artob/readmer.git"
                Some(path.strip_suffix(".git").unwrap_or(path))
            } else {
                None // unknown URL formt
            };
            if let Some(slug) = slug {
                let link = format!("https://github.com/{}", slug);
                let url = format!("{}.git", link);
                output.define(
                    "github",
                    json!({ "repository": { "link": link, "url": url } }),
                );
            }
        }

        Ok(output)
    }

    pub fn to_json(&self) -> Value {
        self.clone().into_json()
    }

    pub fn into_json(self) -> Value {
        json!({}) // TODO
    }
}

impl Context for DirContext {
    fn to_json(&self) -> Value {
        self.to_json()
    }
}