From 1b442ebf7fde0be1634e756f812c7e53fb87d930 Mon Sep 17 00:00:00 2001
From: Vytautas Stankevicius <vytautas.stankevicius@vinted.com>
Date: Mon, 18 Dec 2023 13:34:10 +0200
Subject: [PATCH] Create mdbook-open-gh-issue from mdbook-open-on-gh

---
 .github/workflows/deploy.yml                  |  2 +-
 Cargo.lock                                    | 36 +++++++++------
 Cargo.toml                                    | 17 ++++---
 README.md                                     | 34 +++++++-------
 ...-open-on-gh.rs => mdbook-open-gh-issue.rs} | 32 +++++++------
 src/lib.rs                                    | 46 +++++++++++--------
 6 files changed, 95 insertions(+), 72 deletions(-)
 rename src/bin/{mdbook-open-on-gh.rs => mdbook-open-gh-issue.rs} (54%)

diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
index aa7ecf3..f69f852 100644
--- a/.github/workflows/deploy.yml
+++ b/.github/workflows/deploy.yml
@@ -7,7 +7,7 @@ on:
       - "*"
 
 env:
-  CRATE_NAME: mdbook-open-on-gh
+  CRATE_NAME: mdbook-open-gh-issue
 
 jobs:
   # Build sources for every OS
diff --git a/Cargo.lock b/Cargo.lock
index 015d275..4f38cc9 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -272,9 +272,9 @@ dependencies = [
 
 [[package]]
 name = "crossbeam-channel"
-version = "0.5.8"
+version = "0.5.9"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a33c2bf77f2df06183c3aa30d1e96c0695a313d4f9c453cc3762a6db39f99200"
+checksum = "14c3242926edf34aec4ac3a77108ad4854bffaa2e4ddc1824124ce59231302d5"
 dependencies = [
  "cfg-if",
  "crossbeam-utils",
@@ -282,9 +282,9 @@ dependencies = [
 
 [[package]]
 name = "crossbeam-deque"
-version = "0.8.3"
+version = "0.8.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ce6fd6f855243022dcecf8702fef0c297d4338e226845fe067f6341ad9fa0cef"
+checksum = "fca89a0e215bab21874660c67903c5f143333cab1da83d041c7ded6053774751"
 dependencies = [
  "cfg-if",
  "crossbeam-epoch",
@@ -293,22 +293,21 @@ dependencies = [
 
 [[package]]
 name = "crossbeam-epoch"
-version = "0.9.15"
+version = "0.9.16"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ae211234986c545741a7dc064309f67ee1e5ad243d0e48335adc0484d960bcc7"
+checksum = "2d2fe95351b870527a5d09bf563ed3c97c0cffb87cf1c78a591bf48bb218d9aa"
 dependencies = [
  "autocfg",
  "cfg-if",
  "crossbeam-utils",
  "memoffset",
- "scopeguard",
 ]
 
 [[package]]
 name = "crossbeam-utils"
-version = "0.8.16"
+version = "0.8.17"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5a22b2d63d4d1dc0b7f1b6b2747dd0088008a9be28b6ddf0b1e7d335e3037294"
+checksum = "c06d96137f14f244c37f989d9fff8f95e6c18b918e71f36638f8c49112e4c78f"
 dependencies = [
  "cfg-if",
 ]
@@ -888,13 +887,14 @@ dependencies = [
 ]
 
 [[package]]
-name = "mdbook-open-on-gh"
-version = "2.4.2"
+name = "mdbook-open-gh-issue"
+version = "0.1.0"
 dependencies = [
  "clap",
  "env_logger",
  "log",
  "mdbook",
+ "semver",
  "serde_json",
  "toml",
 ]
@@ -1355,6 +1355,12 @@ version = "1.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49"
 
+[[package]]
+name = "semver"
+version = "1.0.20"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "836fa6a3e1e547f9a2c4040802ec865b5d85f4014efe00555d7090a3dcaa1090"
+
 [[package]]
 name = "serde"
 version = "1.0.193"
@@ -1566,18 +1572,18 @@ dependencies = [
 
 [[package]]
 name = "thiserror"
-version = "1.0.50"
+version = "1.0.51"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f9a7210f5c9a7156bb50aa36aed4c95afb51df0df00713949448cf9e97d382d2"
+checksum = "f11c217e1416d6f036b870f14e0413d480dbf28edbee1f877abaf0206af43bb7"
 dependencies = [
  "thiserror-impl",
 ]
 
 [[package]]
 name = "thiserror-impl"
-version = "1.0.50"
+version = "1.0.51"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "266b2e40bc00e5a6c09c3584011e08b06f123c00362c92b975ba9843aaaa14b8"
+checksum = "01742297787513b79cf8e29d1056ede1313e2420b7b3b15d0a768b4921f549df"
 dependencies = [
  "proc-macro2",
  "quote",
diff --git a/Cargo.toml b/Cargo.toml
index 1747fee..66afc73 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,17 +1,22 @@
 [package]
-name = "mdbook-open-on-gh"
-version = "2.4.2"
-authors = ["Jan-Erik Rediger <janerik@fnordig.de>"]
+name = "mdbook-open-gh-issue"
+version = "0.1.0"
+authors = ["Vytautas Stankevičius <vytstank@gmail.com>"]
 description = "mdbook preprocessor to add a open-on-github link on every page"
 license = "MPL-2.0"
-homepage = "https://github.com/badboy/mdbook-open-on-gh"
-repository = "https://github.com/badboy/mdbook-open-on-gh"
+homepage = "https://github.com/vytstank/mdbook-open-gh-issue"
+repository = "https://github.com/vytstank/mdbook-open-gh-issue"
+documentation = "https://github.com/slowsage/mdbook-pagetoc"
+readme = "README.md"
+keywords = ["mdbook"]
+exclude = [".github/"]
 edition = "2018"
 
 [dependencies]
 mdbook = "0.4.36"
-env_logger = "0.10.0"
+env_logger = "0.10"
 log = "0.4"
 clap = { version = "4.1.0", features = ["cargo"] }
 serde_json = "1.0"
 toml = "0.5.11"
+semver = "1.0.20"
diff --git a/README.md b/README.md
index d73152a..5438610 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
-# mdbook-open-on-gh
+# mdbook-open-gh-issue
 
-A preprocessor for [mdbook][] to add a open-on-github link on every page.
+A preprocessor for [mdbook][] to add a "open github issue link" on every page.
 
 [mdbook]: https://github.com/rust-lang/mdBook
 
-It adds an "Edit this file on GitHub" link on the bottom of every page, linking directly to the source file.
+It adds an "Open issue on GitHub for this file" link on the bottom of every page, linking directly to the source file.
 It uses the configured `git-repository-url` as the base.
 
 ## Installation
@@ -12,43 +12,43 @@ It uses the configured `git-repository-url` as the base.
 If you want to use only this preprocessor, install the tool:
 
 ```
-cargo install mdbook-open-on-gh
+cargo install mdbook-open-gh-issue
 ```
 
 Add it as a preprocessor to your `book.toml`:
 
 ```
-[preprocessor.open-on-gh]
-command = "mdbook-open-on-gh"
+[preprocessor.open-gh-issue]
+command = "mdbook-open-gh-issue"
 renderer = ["html"]
 ```
 
 ## Configuration
 
-`mdbook-open-on-gh` is configured using additional options under `[output.html]`:
-
+`mdbook-open-gh-issue` is configured using additional options under `[output.html]`:
 
 ```toml
 [output.html]
 # Required: Your repository URL used in the link.
 git-repository-url = "https://github.com/$user/$project"
 
-# Your git branch. Defaults to `main`
-git-branch = "main"
-
 # The text to use in the footer.
 # The link text is marked by `[]`
-open-on-text = "Found a bug? [Edit this page on GitHub.]"
+gh-issue-text = "Outdated info? [Open issue on GitHub.]"
+
+# The issue template to use. Defaults to "issue-template.yaml"
+# New issue will get "file" parameter set to the current page.
+gh-issue-template = "issue-template.yaml"
 ```
 
 To style the footer add a custom CSS file for your HTML output:
 
 ```toml
 [output.html]
-additional-css = ["open-in.css"]
+additional-css = ["gh-issue-open.css"]
 ```
 
-And in `open-in.css` style the `<footer>` element or directly the CSS element id `open-on-gh`:
+And in `gh-issue-open.css` style the `<footer>` element or directly the CSS element id `gh-issue-open`:
 
 ```css
 footer {
@@ -62,14 +62,12 @@ footer {
 This code block shrinks the text size, center-aligns it under the rest of the content
 and adds a small horizontal bar above the text to separate it from the page content.
 
-
 Finally, build your book as normal:
 
 ```
 mdbook path/to/book
 ```
 
-## License
+## Acknowledgments
 
-MPL. See [LICENSE](LICENSE).  
-Copyright (c) 2020-2022 Jan-Erik Rediger <janerik@fnordig.de>
+- [mdbook-open-on-gh](https://github.com/badboy/mdbook-open-on-gh)
diff --git a/src/bin/mdbook-open-on-gh.rs b/src/bin/mdbook-open-gh-issue.rs
similarity index 54%
rename from src/bin/mdbook-open-on-gh.rs
rename to src/bin/mdbook-open-gh-issue.rs
index edb53ae..5872f71 100644
--- a/src/bin/mdbook-open-on-gh.rs
+++ b/src/bin/mdbook-open-gh-issue.rs
@@ -1,15 +1,16 @@
 use clap::{crate_version, Arg, ArgMatches, Command};
 use mdbook::errors::Error;
 use mdbook::preprocess::{CmdPreprocessor, Preprocessor};
-use mdbook_open_on_gh::OpenOn;
+use mdbook_open_gh_issue::OpenGhIssue;
+use semver::{Version, VersionReq};
 
 use std::io;
 use std::process;
 
 pub fn make_app() -> Command {
-    Command::new("mdbook-open-on-gh")
+    Command::new("mdbook-open-gh-issue")
         .version(crate_version!())
-        .about("mdbook preprocessor to add links to open the page on GitHub")
+        .about("mdbook preprocessor to add links to open issue on GitHub")
         .subcommand(
             Command::new("supports")
                 .arg(Arg::new("renderer").required(true))
@@ -21,40 +22,43 @@ fn main() {
     env_logger::init();
 
     let matches = make_app().get_matches();
+    let preprocessor = OpenGhIssue::new();
 
     if let Some(sub_args) = matches.subcommand_matches("supports") {
-        handle_supports(sub_args);
-    } else if let Err(e) = handle_preprocessing() {
+        handle_supports(&preprocessor, sub_args);
+    } else if let Err(e) = handle_preprocessing(&preprocessor) {
         eprintln!("{}", e);
         process::exit(1);
     }
 }
 
-fn handle_preprocessing() -> Result<(), Error> {
+fn handle_preprocessing(pre: &dyn Preprocessor) -> Result<(), Error> {
     let (ctx, book) = CmdPreprocessor::parse_input(io::stdin())?;
 
-    if ctx.mdbook_version != mdbook::MDBOOK_VERSION {
+    let book_version = Version::parse(&ctx.mdbook_version)?;
+    let version_req = VersionReq::parse(mdbook::MDBOOK_VERSION)?;
+
+    if !version_req.matches(&book_version) {
         eprintln!(
-            "Warning: The mdbook-open-on-gh preprocessor was built against version \
-             {} of mdbook, but we're being called from version {}",
+            "Warning: The {} plugin was built against version {} of mdbook, \
+             but we're being called from version {}",
+            pre.name(),
             mdbook::MDBOOK_VERSION,
             ctx.mdbook_version
         );
     }
 
-    let processed_book = OpenOn.run(&ctx, book)?;
+    let processed_book = pre.run(&ctx, book)?;
     serde_json::to_writer(io::stdout(), &processed_book)?;
 
     Ok(())
 }
 
-fn handle_supports(sub_args: &ArgMatches) -> ! {
+fn handle_supports(pre: &dyn Preprocessor, sub_args: &ArgMatches) -> ! {
     let renderer = sub_args
         .get_one::<String>("renderer")
         .expect("Required argument");
-    let supported = OpenOn.supports_renderer(renderer);
-
-    // Signal whether the renderer is supported by exiting with 1 or 0.
+    let supported = pre.supports_renderer(renderer);
     if supported {
         process::exit(0);
     } else {
diff --git a/src/lib.rs b/src/lib.rs
index 1344958..e9532f9 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -4,9 +4,15 @@ use mdbook::book::{Book, BookItem, Chapter};
 use mdbook::errors::{Error, Result};
 use mdbook::preprocess::{Preprocessor, PreprocessorContext};
 
-pub struct OpenOn;
+pub struct OpenGhIssue;
 
-impl Preprocessor for OpenOn {
+impl OpenGhIssue {
+    pub fn new() -> OpenGhIssue {
+        OpenGhIssue
+    }
+}
+
+impl Preprocessor for OpenGhIssue {
     fn name(&self) -> &str {
         "open-on-gh"
     }
@@ -33,19 +39,18 @@ impl Preprocessor for OpenOn {
             return Ok(book);
         }
 
-        let branch = match ctx.config.get("output.html.git-branch") {
-            None => "main",
+        let template_name = match ctx.config.get("output.html.issue-template") {
+            None => "issue-template.yaml",
             Some(toml::Value::String(b)) => b,
             _ => return Ok(book),
         };
-        log::debug!("Git Branch: {}", branch);
 
-        let open_on_text = match ctx.config.get("output.html.open-on-text") {
-            None => "Found a bug? [Edit this page on GitHub.]",
+        let issue_text = match ctx.config.get("output.html.issue-text") {
+            None => "Outdated info? [Open issue on GitHub.]",
             Some(toml::Value::String(b)) => b,
             _ => return Ok(book),
         };
-        log::debug!("Footer text: {}", open_on_text);
+        log::debug!("Footer text: {}", issue_text);
 
         let mut res = None;
         book.for_each_mut(|item: &mut BookItem| {
@@ -55,12 +60,12 @@ impl Preprocessor for OpenOn {
 
             if let BookItem::Chapter(ref mut chapter) = *item {
                 res = Some(
-                    open_on(
+                    issue_open(
                         &git_root,
                         &src_root,
                         repository_url,
-                        branch,
-                        open_on_text,
+                        template_name,
+                        issue_text,
                         chapter,
                     )
                     .map(|md| {
@@ -87,17 +92,17 @@ fn parse_footer_text(text: &str) -> Option<(&str, &str, &str)> {
     Some((pre, link_text, post))
 }
 
-fn open_on(
+fn issue_open(
     git_root: &Path,
     src_root: &Path,
     base_url: &str,
-    branch: &str,
-    open_on_text: &str,
+    template_name: &str,
+    issue_text: &str,
     chapter: &mut Chapter,
 ) -> Result<String> {
     let content = &chapter.content;
 
-    let footer_start = "<footer id=\"open-on-gh\">";
+    let footer_start = "<footer id=\"gh-issue-open\">";
     if content.contains(footer_start) {
         return Ok(content.into());
     }
@@ -106,7 +111,7 @@ fn open_on(
         None => return Ok("".into()),
         Some(path) => path,
     };
-    let path = match src_root.join(&path).canonicalize() {
+    let path = match src_root.join(path).canonicalize() {
         Ok(path) => path,
         Err(_) => return Ok(content.into()),
     };
@@ -114,10 +119,15 @@ fn open_on(
     log::trace!("Chapter path: {}", path.display());
     log::trace!("Relative path: {}", relpath.display());
 
-    let url = format!("{}/edit/{}/{}", base_url, branch, relpath.display());
+    let url = format!(
+        "{}/issues/new?template={}&file={}",
+        base_url,
+        template_name,
+        relpath.display()
+    );
     log::trace!("URL: {}", url);
 
-    let (pre, link_text, post) = match parse_footer_text(open_on_text) {
+    let (pre, link_text, post) = match parse_footer_text(issue_text) {
         Some(parsed) => parsed,
         None => Err(Error::msg(
             "can't parse footer text. Missing `[link text]`?",