feat: --ignore-fragments CLI parameter

This adds `--ignore-fragments` parameter to the command line, when
specified no fragment checking will be performed.

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## NEXT (UNRELEASED)
 
+#### Added
+
+ * `--ignore-fragments` CLI parameter to disable URL fagment checking [PR#108]
+
+[PR#108]: https://github.com/deadlinks/cargo-deadlinks/pull/108
+
 <a name="0.6.0"></a>
 ## 0.6.0 (2020-11-19)
 

src/bin/cargo-deadlinks.rs

@@ -21,6 +21,7 @@ Options:
     -h --help               Print this message.
     --dir                   Specify a directory to check (default is target/doc/<package>).
     --check-http            Check 'http' and 'https' scheme links.
+    --ignore-fragments      Don't check URL fragments.
     --no-build              Do not call `cargo doc` before running link checking. By default, deadlinks will call `cargo doc` if `--dir` is not passed.
     --debug                 Use debug output. This option is deprecated; use `RUST_LOG=debug` instead.
     -v --verbose            Use verbose output. This option is deprecated; use `RUST_LOG==info` instead.
@@ -34,13 +35,15 @@ struct MainArgs {
     flag_debug: bool,
     flag_check_http: bool,
     flag_no_build: bool,
+    flag_ignore_fragments: bool,
 }
 
 impl From<&MainArgs> for CheckContext {
     fn from(args: &MainArgs) -> CheckContext {
         CheckContext {
             check_http: args.flag_check_http,
             verbose: args.flag_debug,
+            check_fragments: !args.flag_ignore_fragments,
         }
     }
 }

src/bin/deadlinks.rs

@@ -16,6 +16,7 @@ Usage:
 Options:
     -h --help               Print this message
     --check-http            Check 'http' and 'https' scheme links
+    --ignore-fragments      Don't check URL fragments.
     --debug                 Use debug output
     -v --verbose            Use verbose output
     -V --version            Print version info and exit.
@@ -27,13 +28,15 @@ struct MainArgs {
     flag_verbose: bool,
     flag_debug: bool,
     flag_check_http: bool,
+    flag_ignore_fragments: bool,
 }
 
 impl From<MainArgs> for CheckContext {
     fn from(args: MainArgs) -> CheckContext {
         CheckContext {
             check_http: args.flag_check_http,
             verbose: args.flag_debug,
+            check_fragments: !args.flag_ignore_fragments,
         }
     }
 }

src/check.rs

@@ -189,7 +189,7 @@ fn is_fragment_available(
 }
 
 /// Check a URL with the "file" scheme for availability. Returns `false` if it is unavailable.
-fn check_file_url(url: &Url, _ctx: &CheckContext) -> Result<(), CheckError> {
+fn check_file_url(url: &Url, ctx: &CheckContext) -> Result<(), CheckError> {
     let path = url.to_file_path().unwrap();
 
     // determine the full path by looking if the path points to a directory,
@@ -206,6 +206,10 @@ fn check_file_url(url: &Url, _ctx: &CheckContext) -> Result<(), CheckError> {
         return Err(CheckError::File(path));
     };
 
+    if !ctx.check_fragments {
+        return Ok(());
+    }
+
     // The URL might contain a fragment. In that case we need a full GET
     // request to check if the fragment exists.
     match url.fragment() {
@@ -278,7 +282,7 @@ fn check_http_url(url: &Url, ctx: &CheckContext) -> Result<(), CheckError> {
 
     // The URL might contain a fragment. In that case we need a full GET
     // request to check if the fragment exists.
-    if url.fragment().is_none() {
+    if url.fragment().is_none() || !ctx.check_fragments {
         let resp = ureq::head(url.as_str()).call();
 
         handle_response(url, resp).map(|_: ureq::Response| ())
@@ -331,6 +335,7 @@ mod test {
             &CheckContext {
                 verbose: false,
                 check_http: false,
+                check_fragments: true,
             },
         )
     }
@@ -397,6 +402,7 @@ mod test {
             &CheckContext {
                 verbose: false,
                 check_http: false,
+                check_fragments: true,
             },
         )
         .unwrap();
@@ -409,6 +415,7 @@ mod test {
             &CheckContext {
                 verbose: false,
                 check_http: false,
+                check_fragments: true,
             },
         )
         .unwrap();
@@ -421,6 +428,7 @@ mod test {
             &CheckContext {
                 verbose: false,
                 check_http: false,
+                check_fragments: true,
             },
         ) {
             Err(CheckError::File(path)) => assert!(path.ends_with("tests/html/missing_index")),
@@ -443,6 +451,7 @@ mod test {
             &CheckContext {
                 verbose: false,
                 check_http: true,
+                check_fragments: true,
             },
         )
         .unwrap();
@@ -471,6 +480,7 @@ mod test {
             &CheckContext {
                 verbose: false,
                 check_http: true,
+                check_fragments: true,
             },
         )
         .unwrap();
@@ -497,6 +507,7 @@ mod test {
             &CheckContext {
                 verbose: false,
                 check_http: true,
+                check_fragments: true,
             },
         ) {
             Err(CheckError::Fragment(Link::Http(url), fragment, None)) => {
@@ -514,4 +525,39 @@ mod test {
 
         root.assert();
     }
+
+    #[test]
+    fn test_disabling_fragment_checks_file() {
+        check_file_url(
+            &url_for("tests/html/anchors.html#nonexistent"),
+            &CheckContext {
+                verbose: false,
+                check_http: false,
+                check_fragments: false,
+            },
+        )
+        .unwrap();
+    }
+
+    #[test]
+    fn test_disabling_fragment_checks_http() {
+        let root = mock("HEAD", "/test_disabling_fragment_checks_http")
+            .with_status(200)
+            .create();
+
+        let mut url = mockito::server_url();
+        url.push_str("/test_disabling_fragment_checks_http#missing");
+
+        is_available(
+            &Url::parse(&url).unwrap(),
+            &CheckContext {
+                verbose: false,
+                check_http: true,
+                check_fragments: false,
+            },
+        )
+        .unwrap();
+
+        root.assert();
+    }
 }

src/lib.rs

@@ -16,10 +16,21 @@ mod check;
 mod parse;
 
 // NOTE: this could be Copy, but we intentionally choose not to guarantee that.
-#[derive(Clone, Debug, Default)]
+#[derive(Clone, Debug)]
 pub struct CheckContext {
     pub check_http: bool,
     pub verbose: bool,
+    pub check_fragments: bool,
+}
+
+impl Default for CheckContext {
+    fn default() -> Self {
+        CheckContext {
+            check_http: false,
+            verbose: false,
+            check_fragments: true,
+        }
+    }
 }
 
 #[derive(Debug)]