lots of polishing, regular maintenance, preparing for 0.4 (or 1.0?) release

.github/workflows/ci.yml

@@ -0,0 +1,124 @@
+name: ci
+on:
+  pull_request:
+  push:
+    branches:
+    - master
+  schedule:
+  - cron: '00 01 * * *'
+jobs:
+  test:
+    name: test
+    env:
+      # For some builds, we use cross to test on 32-bit and big-endian
+      # systems.
+      CARGO: cargo
+      # When CARGO is set to CROSS, TARGET is set to `--target matrix.target`.
+      TARGET:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        build:
+        - pinned
+        - stable
+        - stable-32
+        - stable-mips
+        - beta
+        - nightly
+        - macos
+        - win-msvc
+        - win-gnu
+        include:
+        - build: pinned
+          os: ubuntu-18.04
+          rust: 1.40.0
+        - build: stable
+          os: ubuntu-18.04
+          rust: stable
+        - build: stable-32
+          os: ubuntu-18.04
+          rust: stable
+          target: i686-unknown-linux-gnu
+        - build: stable-mips
+          os: ubuntu-18.04
+          rust: stable
+          target: mips64-unknown-linux-gnuabi64
+        - build: beta
+          os: ubuntu-18.04
+          rust: beta
+        - build: nightly
+          os: ubuntu-18.04
+          rust: nightly
+        - build: macos
+          os: macos-latest
+          rust: stable
+        - build: win-msvc
+          os: windows-2019
+          rust: stable
+        - build: win-gnu
+          os: windows-2019
+          rust: stable-x86_64-gnu
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v1
+      with:
+        fetch-depth: 1
+
+    - name: Install Rust
+      uses: actions-rs/toolchain@v1
+      with:
+        toolchain: ${{ matrix.rust }}
+        profile: minimal
+        override: true
+
+    - name: Use Cross
+      if: matrix.target != ''
+      run: |
+        # FIXME: to work around bugs in latest cross release, install master.
+        # See: https://github.com/rust-embedded/cross/issues/357
+        cargo install --git https://github.com/rust-embedded/cross
+        echo "::set-env name=CARGO::cross"
+        echo "::set-env name=TARGET::--target ${{ matrix.target }}"
+
+    - name: Show command used for Cargo
+      run: |
+        echo "cargo command is: ${{ env.CARGO }}"
+        echo "target flag is: ${{ env.TARGET }}"
+
+    - name: Build
+      run: ${{ env.CARGO }} build --verbose ${{ env.TARGET }}
+
+    - name: Build docs
+      run: ${{ env.CARGO }} doc --verbose ${{ env.TARGET }}
+
+    - name: Run tests
+      run: ${{ env.CARGO }} test --verbose --all ${{ env.TARGET }}
+
+    - name: Run tests without default features
+      run: ${{ env.CARGO }} test --verbose --lib --no-default-features ${{ env.TARGET }}
+
+    # Disable this for now until we publish regex-automata with fst support.
+    # - name: Build fst CLI tool
+      # run: ${{ env.CARGO }} build --verbose --manifest-path fst-bin/Cargo.toml ${{ env.TARGET }}
+
+    - name: Compile benchmarks
+      run: ${{ env.CARGO }} bench --manifest-path bench/Cargo.toml --verbose ${{ env.TARGET }} -- --test
+
+  rustfmt:
+    name: rustfmt
+    runs-on: ubuntu-18.04
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v1
+      with:
+        fetch-depth: 1
+    - name: Install Rust
+      uses: actions-rs/toolchain@v1
+      with:
+        toolchain: stable
+        override: true
+        profile: minimal
+        components: rustfmt
+    - name: Check formatting
+      run: |
+        cargo fmt --all -- --check

Cargo.toml

@@ -12,38 +12,31 @@ repository = "https://github.com/BurntSushi/fst"
 readme = "README.md"
 keywords = ["search", "information", "retrieval", "dictionary", "map"]
 license = "Unlicense/MIT"
+edition = "2018"
 
-[features]
-mmap = ["memmap"]
-default = ["mmap"]
-
-[[bench]]
-name = "build"
-path = "./benches/build.rs"
-test = false
-bench = true
+[workspace]
+members = ["bench"]
+exclude = ["fst-bin"]
 
-[[bench]]
-name = "search"
-path = "./benches/search.rs"
-test = false
-bench = true
+[features]
+default = []
+levenshtein = ["utf8-ranges"]
 
 [dependencies]
-byteorder = "1"
-memmap = { version = "0.6.0", optional = true }
+utf8-ranges = { version = "1.0.4", optional = true }
 
 [dev-dependencies]
-fnv = "1.0.5"
-fst-levenshtein = { version = "0.2", path = "fst-levenshtein" }
-fst-regex = { version = "0.2", path = "fst-regex" }
-lazy_static = "0.2.8"
-quickcheck = { version = "0.7", default-features = false }
-rand = "0.5"
+doc-comment = "0.3.1"
+fnv = "1.0.6"
+memmap = "0.7"
+quickcheck = { version = "0.9.2", default-features = false }
+rand = "0.7.3"
 
 [profile.release]
 debug = true
 
 [profile.bench]
-opt-level = 3
 debug = true
+
+[package.metadata.docs.rs]
+features = ["levenshtein"]

README.md

@@ -12,23 +12,21 @@ Check out my blog post
 Rust](http://blog.burntsushi.net/transducers/)
 for extensive background, examples and experiments.
 
-[![Linux build status](https://travis-ci.org/BurntSushi/fst.svg?branch=master)](https://travis-ci.org/BurntSushi/fst)
-[![Windows build status](https://ci.appveyor.com/api/projects/status/github/BurntSushi/fst?svg=true)](https://ci.appveyor.com/project/BurntSushi/fst)
+[![Build status](https://github.com/BurntSushi/fst/workflows/ci/badge.svg)](https://github.com/BurntSushi/fst/actions)
 [![](http://meritbadge.herokuapp.com/fst)](https://crates.io/crates/fst)
 
 Dual-licensed under MIT or the [UNLICENSE](http://unlicense.org).
 
 
 ### Documentation
 
-[Full API documentation and examples.](http://burntsushi.net/rustdoc/fst/)
+https://docs.rs/fst
 
 The
-[`fst-regex`](https://docs.rs/fst-regex)
-and
-[`fst-levenshtein`](https://docs.rs/fst-levenshtein)
-crates provide regular expression matching and fuzzy searching on FSTs,
-respectively.
+[`regex-automata`](https://docs.rs/regex-automata)
+crate provides implementations of the `fst::Automata` trait when its
+`transducer` feature is enabled. This permits using DFAs compiled by
+`regex-automata` to search finite state transducers produced by this crate.
 
 
 ### Installation
@@ -37,33 +35,21 @@ Simply add a corresponding entry to your `Cargo.toml` dependency list:
 
 ```toml,ignore
 [dependencies]
-fst = "0.3"
-```
-
-And add this to your crate root:
-
-```rust,ignore
-extern crate fst;
+fst = "0.4"
 ```
 
 
 ### Example
 
 This example demonstrates building a set in memory and executing a fuzzy query
-against it. You'll need `fst = "0.3"` and `fst-levenshtein = "0.2"` in your
-`Cargo.toml`.
+against it. You'll need `fst = "0.4"` with the `levenshtein` feature enabled in
+your `Cargo.toml`.
 
 ```rust
-extern crate fst;
-extern crate fst_levenshtein;
-
-use std::error::Error;
-use std::process;
-
 use fst::{IntoStreamer, Set};
-use fst_levenshtein::Levenshtein;
+use fst::automaton::Levenshtein;
 
-fn try_main() -> Result<(), Box<Error>> {
+fn main() -> Result<(), Box<dyn std::error::Error>> {
   // A convenient way to create sets in memory.
   let keys = vec!["fa", "fo", "fob", "focus", "foo", "food", "foul"];
   let set = Set::from_iter(keys)?;
@@ -78,13 +64,13 @@ fn try_main() -> Result<(), Box<Error>> {
   assert_eq!(keys, vec!["fo", "fob", "foo", "food"]);
   Ok(())
 }
-
-fn main() {
-  if let Err(err) = try_main() {
-    eprintln!("{}", err);
-    process::exit(1);
-  }
-}
 ```
 
 Check out the documentation for a lot more examples!
+
+
+### Cargo features
+
+* `levenshtein` - **Disabled** by default. This adds the `Levenshtein`
+  automaton to the `automaton` sub-module. This includes an additional
+  dependency on `utf8-ranges`.

bench/Cargo.toml

@@ -0,0 +1,23 @@
+[package]
+publish = false
+name = "fst-bench"
+version = "0.0.1"
+authors = ["Andrew Gallant <jamslam@gmail.com>"]
+description = "Criterion benchmark suite for fst."
+homepage = "https://github.com/BurntSushi/fst"
+repository = "https://github.com/BurntSushi/fst"
+license = "BSD-3-Clause"
+edition = "2018"
+
+[lib]
+bench = false
+
+[[bench]]
+name = "fst"
+harness = false
+path = "src/bench.rs"
+
+[dependencies]
+criterion = "0.3.1"
+fnv = "1.0.6"
+fst = { version = "*", path = "..", features = ["levenshtein"] }