0.3.0

Author: qtfkwk

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+* 0.1.0 (2020-02-03): Initial release
+* 0.2.1 (2020-02-09): Produce `.sha256` files compatible w/ `sha256sum -c`
+* 0.2.2 (2020-11-18): Update sha2 crate version
+* 0.3.0 (2023-01-07): Modernize
+

Cargo.toml

@@ -1,17 +1,14 @@
 [package]
 name = "fhc"
-description = "file hash checker (SHA256)"
+version = "0.3.0"
+edition = "2021"
+description = "File hash checker (SHA256)"
+repository = "https://github.com/qtfkwk/fhc"
+license = "MIT"
 keywords = ["sha256sum", "sha256", "integrity"]
 categories = ["command-line-utilities"]
-version = "0.2.2"
-license = "MIT"
-repository = "https://github.com/qtfkwk/fhc"
-authors = ["qtfkwk <qtfkwk+fhc@gmail.com>"]
-edition = "2018"
-include = [
-    "Cargo.toml",
-    "src",
-]
 
 [dependencies]
-sha2 = "0.8.1"
+anyhow = "1.0.79"
+clap = { version = "4.4.13", features = ["derive", "wrap_help"] }
+sha2 = "0.10.8"

LICENSE.txt

@@ -0,0 +1,135 @@
+# build
+
+* clippy
+* `README.md`
+* test
+
+```
+cargo build --release
+```
+
+# `README.md`
+
+* `t/README.md`
+* `Cargo.toml`
+* `CHANGELOG.md`
+* `src/**/*.rs`
+
+```
+cargo build --release
+kapow {0} >{target}
+```
+
+# clippy
+
+```
+cargo clippy -- -D clippy::all
+```
+
+# test
+
+```
+cargo test -- --nocapture --test-threads=1
+```
+
+# check
+
+```
+cargo outdated --exit-code 1
+cargo audit
+```
+
+# update
+
+```
+cargo upgrade --incompatible
+cargo update
+```
+
+# install
+
+* `README.md`
+
+```
+cargo install --path .
+```
+
+# uninstall
+
+```
+cargo uninstall $(toml get -r Cargo.toml package.name)
+```
+
+# install-deps
+
+```
+cargo install cargo-audit cargo-edit cargo-outdated cocomo dtg kapow tokei toml-cli
+```
+
+# scaffold
+
+```bash -eo pipefail
+if ! toml get -r Cargo.toml package.description >/dev/null; then
+toml set Cargo.toml package.description "Insert a description here" >Cargo.toml.new
+mv Cargo.toml.new Cargo.toml
+echo Edit package description in Cargo.toml, then rerun \`mkrs scaffold\`.
+exit 0
+fi
+mkdir -p t
+if [ ! -e t/README.md ]; then
+NAME=$(toml get -r Cargo.toml package.name)
+ABOUT=$(toml get -r Cargo.toml package.description)
+cat <<EOF >t/README.md
+# About
+
+$ABOUT
+
+# Usage
+
+~~~text
+\$ $NAME -V
+!run:../target/release/$NAME -V 2>&1
+~~~
+
+~~~text
+\$ $NAME -h
+!run:../target/release/$NAME -h 2>&1
+~~~
+
+!inc:../CHANGELOG.md
+
+EOF
+fi
+if [ ! -e CHANGELOG.md ]; then
+VERSION=$(toml get -r Cargo.toml package.version)
+TODAY=$(dtg -n %Y-%m-%d)
+cat <<EOF >CHANGELOG.md
+# Changelog
+
+* $VERSION ($TODAY): Initial release
+
+EOF
+fi
+```
+
+# clean
+
+```
+cargo clean
+```
+
+# cocomo
+
+```bash -eo pipefail
+tokei; echo
+cocomo -o sloccount
+cocomo
+```
+
+# full
+
+* update
+* check
+* build
+* install
+

Makefile.md

@@ -1,11 +1,11 @@
 # About
 
-File hash checker ("fhc") represents a minimal solution meeting the following
+File hash checker represents a minimal solution meeting the following
 requirements:
 
-* Calculate the SHA256 hash of one or more files in parallel
-* Minimal external dependencies:
-    * [sha2](https://crates.io/crates/sha2)
+* Calculate the SHA256 hashes of one or more files in sequence or parallel
+  (threading or messaging)
+* Minimal external dependencies: [`sha2`], [`anyhow`], [`clap`]
 * Provide a library function than returns the SHA256 hash as a hex string for a
   string path
 * Provide a CLI utiility:
@@ -15,36 +15,26 @@ requirements:
     * Compare the current SHA256 hash to an adjacent `.sha256` file (if it
       exists)
 
-# Installation
-
-## User
-
-```bash
-cargo install fhc
-```
-
-## Developer
-
-```bash
-git clone https://github.com/qtfkwk/fhc.git
-cd fhc
-cargo install --path=.
-```
+[anyhow]: https://crates.io/crates/anyhow
+[clap]: https://crates.io/crates/clap
+[sha2]: https://crates.io/crates/sha2
 
 # Usage
 
 ```
 $ fhc -h
-# fhc (file hash checker), 0.2.2, 2020-11-18
+File hash checker (SHA256)
+
+Usage: fhc [OPTIONS] [FILES]...
 
-Usage: `fhc [-h|--help] [--version] [-p|--process OPTION] [file]`
+Arguments:
+  [FILES]...  File(s)
 
-Option/argument       | Description
-----------------------|--------------------------------------------------
-`-h|--help`           | show help
-`--version`           | show version/date
-`-p|--process OPTION` | process option: messaging*, threading, sequential
-`file`                | one or more file paths
+Options:
+  -p, --process <PROCESS>  Process option [default: messaging] [possible values:
+                           sequential, threading, messaging]
+  -h, --help               Print help
+  -V, --version            Print version
 ```
 
 # Example
@@ -55,14 +45,10 @@ Option/argument       | Description
    `.sha256` files to re-calculate the SHA256 hash for each file and report `OK`
    if the hashes match and `FAILED` if the hashes do not match.
 
-# Tests
-
-The [test.log](test.log) file saves the output of
-`cargo test 2>&1 |tee test.log` at each commit.
-
 # Changelog
 
-* 0.1.0 (2020-02-03): initial public release
-* 0.2.1 (2020-02-09): produce `.sha256` files compatible w/ `sha256sum -c`
-* 0.2.2 (2020-11-18): update sha2 crate version
+* 0.1.0 (2020-02-03): Initial release
+* 0.2.1 (2020-02-09): Produce `.sha256` files compatible w/ `sha256sum -c`
+* 0.2.2 (2020-11-18): Update sha2 crate version
+* 0.3.0 (2023-01-07): Modernize
 

README.md

@@ -1,30 +1,89 @@
-/*
+use anyhow::Result;
+use clap::Parser;
+use fhc::*;
+use std::path::PathBuf;
 
-Copyright 2020 qtfkwk <qtfkwk+fhc@gmail.com>
+#[derive(Clone, Debug, clap::ValueEnum)]
+enum ProcessOption {
+    Sequential,
+    Threading,
+    Messaging,
+}
+
+use ProcessOption::*;
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of 
-this software and associated documentation files (the "Software"), to deal in 
-the Software without restriction, including without limitation the rights to 
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 
-of the Software, and to permit persons to whom the Software is furnished to do 
-so, subject to the following conditions:
+#[derive(Parser)]
+#[command(about, version, max_term_width = 80)]
+struct Cli {
+    /// Process option
+    #[arg(short, long, default_value = "messaging")]
+    process: ProcessOption,
 
-The above copyright notice and this permission notice shall be included in all 
-copies or substantial portions of the Software.
+    /// File(s)
+    files: Vec<PathBuf>,
+}
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
-SOFTWARE.
+fn main() -> Result<()> {
+    let cli = Cli::parse();
 
-*/
+    let process = if cli.files.len() == 1 {
+        Sequential
+    } else {
+        cli.process.clone()
+    };
 
-use fhc::cli;
+    match process {
+        Sequential => {
+            for file in &cli.files {
+                match process_file(file) {
+                    Ok(r) => println!("{}", r),
+                    Err(e) => {
+                        eprintln!("ERROR: {}", e);
+                    }
+                }
+            }
+        }
+        Threading => {
+            let mut handles = vec![];
+            for file in cli.files.iter().cloned() {
+                handles.push(std::thread::spawn(move || process_file(file)));
+            }
+            for handle in handles {
+                match handle.join() {
+                    Ok(t) => match t {
+                        Ok(r) => println!("{}", r),
+                        Err(e) => {
+                            eprintln!("ERROR: {}", e);
+                        }
+                    },
+                    Err(e) => {
+                        eprintln!("ERROR: {:?}", e);
+                    }
+                }
+            }
+        }
+        Messaging => {
+            let mut rxs = vec![];
+            for file in cli.files.iter().cloned() {
+                let (tx, rx) = std::sync::mpsc::channel();
+                rxs.push(rx);
+                std::thread::spawn(move || tx.send(process_file(file)).unwrap());
+            }
+            for rx in rxs {
+                match rx.recv() {
+                    Ok(t) => match t {
+                        Ok(r) => println!("{}", r),
+                        Err(e) => {
+                            eprintln!("ERROR: {}", e);
+                        }
+                    },
+                    Err(e) => {
+                        eprintln!("ERROR: {:?}", e);
+                    }
+                }
+            }
+        }
+    }
 
-fn main() {
-    cli().unwrap();
+    Ok(())
 }
-