Rename to sha1_smol and modernize

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [mitsuhiko]

.github/workflows/clippy.yml

@@ -0,0 +1,18 @@
+name: Clippy
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          profile: minimal
+          components: clippy, rustfmt
+          override: true
+      - name: Run clippy
+        run: cargo clippy

.github/workflows/rustfmt.yml

@@ -0,0 +1,18 @@
+name: Rustfmt
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          profile: minimal
+          components: clippy, rustfmt
+          override: true
+      - name: Run rustfmt
+        run: cargo fmt --check

.github/workflows/tests.yml

@@ -0,0 +1,32 @@
+name: Tests
+
+on: [push]
+
+jobs:
+  test-latest:
+    name: Test on Latest
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          profile: minimal
+          override: true
+      - name: Test
+        run: cargo test
+
+  build-stable:
+    name: Build on 1.31.0
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: 1.31.0
+          profile: minimal
+          override: true
+      - name: Build
+        run: cargo check

Cargo.toml

@@ -1,11 +1,12 @@
 [package]
-name = "sha1"
+name = "sha1_smol"
 version = "0.6.0"
 authors = ["Armin Ronacher <[email protected]>"]
 keywords = ["sha1"]
-description = "Minimal implementation of SHA1 for Rust."
+description = "Minimal dependency free implementation of SHA1 for Rust."
 license = "BSD-3-Clause"
-repository = "https://github.com/mitsuhiko/rust-sha1"
+repository = "https://github.com/mitsuhiko/sha1-smol"
+edition = "2018"
 
 [features]
 std = []

README.md

@@ -1,8 +1,32 @@
-# rust-sha1
+# sha1-smol
 
-Minimal implementation of SHA1 for Rust.
+[![Build Status](https://github.com/mitsuhiko/sha1-smol/workflows/Tests/badge.svg?branch=master)](https://github.com/mitsuhiko/sha1-smol/actions?query=workflow%3ATests)
+[![Crates.io](https://img.shields.io/crates/d/sha1-smol.svg)](https://crates.io/crates/sha1-smol)
+[![License](https://img.shields.io/github/license/mitsuhiko/sha1-smol)](https://github.com/mitsuhiko/sha1-smol/blob/master/LICENSE)
+[![rustc 1.31.0](https://img.shields.io/badge/rust-1.31%2B-orange.svg)](https://img.shields.io/badge/rust-1.31%2B-orange.svg)
+[![Documentation](https://docs.rs/sha1-smol/badge.svg)](https://docs.rs/sha1-smol)
 
-Right now SHA1 is quite frequently used and many things want to have an
-implementation of it, that does not pull in too much other stuff.
+Minimal and dependency free implementation of SHA1 for Rust.
+
+SHA1 is not exactly a good choice for crypto hashes these days but unfortunately
+SHA1 continues to be needed for a handful of situations due to legacy functionality.
+If you have the need for a SHA1 implementation that does not pull in large dependency chains
+you might want to consider this crate.
+
+In all other cases use the new [`sha1`](https://crates.io/crates/sha1) crate
+by the RustCrypto project instead.
+
+## sha1 crate
+
+This crate used to be published as `sha1` but in recent years a large ecosystem
+of hash libraries was built around [`RustCrypto`](https://github.com/RustCrypto)
+so the crate name was given to that project instead.  Versions newer than `0.6`
+of `sha1`.
 
 This is largely based on the hash code in crypto-rs by Koka El Kiwi.
+
+## License and Links
+
+- [Documentation](https://docs.rs/sha1-smol/)
+- [Issue Tracker](https://github.com/mitsuhiko/sha1-smol/issues)
+- License: [3 Clause BDS](https://github.com/mitsuhiko/sha1-smol/blob/master/LICENSE)

bench/bench.rs

@@ -1,15 +1,16 @@
-extern crate sha1;
 extern crate ring;
+extern crate sha1_smol as sha1;
 
 use std::env;
 use std::fs;
 use std::io::{Read, Write};
-use std::time::{Instant, Duration};
 use std::process::{Command, Stdio};
+use std::time::{Duration, Instant};
 
 fn time<F, FMT>(desc: &str, f: F, fmt: FMT)
-    where F: Fn(),
-          FMT: Fn(Duration) -> String
+where
+    F: Fn(),
+    FMT: Fn(Duration) -> String,
 {
     let start = Instant::now();
     f();
@@ -37,32 +38,38 @@ fn main() {
     };
 
     if env::var("WITHOUT_SHA1SUM") != Ok("1".into()) {
-        time("sha1sum program",
-             || {
-            let mut child = Command::new("sha1sum")
-                .stdin(Stdio::piped())
-                .spawn()
-                .unwrap();
-            if let Some(ref mut stdin) = child.stdin {
-                stdin.write(&out).unwrap();
-            }
-            child.wait().unwrap();
-        },
-             &throughput);
+        time(
+            "sha1sum program",
+            || {
+                let mut child = Command::new("sha1sum")
+                    .stdin(Stdio::piped())
+                    .spawn()
+                    .unwrap();
+                if let Some(ref mut stdin) = child.stdin {
+                    stdin.write(&out).unwrap();
+                }
+                child.wait().unwrap();
+            },
+            &throughput,
+        );
     }
 
-    time("sha1 crate",
-         || {
-             let mut sha1 = sha1::Sha1::new();
-             sha1.update(&out);
-             println!("{}", sha1.digest());
-         },
-         &throughput);
+    time(
+        "sha1 crate",
+        || {
+            let mut sha1 = sha1::Sha1::new();
+            sha1.update(&out);
+            println!("{}", sha1.digest());
+        },
+        &throughput,
+    );
 
-    time("ring crate",
-         || {
-             let digest = ring::digest::digest(&ring::digest::SHA1, &out);
-             println!("{:?}", digest);
-         },
-         &throughput);
+    time(
+        "ring crate",
+        || {
+            let digest = ring::digest::digest(&ring::digest::SHA1, &out);
+            println!("{:?}", digest);
+        },
+        &throughput,
+    );
 }