Architectural redesign and concurrent execution

.editorconfig

@@ -0,0 +1,34 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 80
+
+[*.md]
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = false
+max_line_length = off
+
+[*.rs]
+indent_style = space
+indent_size = 4
+
+[*.feature]
+indent_style = space
+indent_size = 2
+
+[*.toml]
+indent_style = space
+indent_size = 4
+
+[*.{yaml,yml}]
+indent_style = space
+indent_size = 2
+
+[Makefile]
+indent_style = tab
+indent_size = 4

.github/workflows/ci.yml

@@ -1,33 +1,214 @@
-on: [push, pull_request]
-
 name: CI
 
+on:
+  push:
+    branches: ["main"]
+    tags: ["v*"]
+  pull_request:
+    branches: ["main"]
+
+env:
+  RUST_BACKTRACE: 1
+
 jobs:
-  build:
+
+  ##########################
+  # Linting and formatting #
+  ##########################
+
+  clippy:
+    if: ${{ github.ref == 'refs/heads/main'
+            || startsWith(github.ref, 'refs/tags/v')
+            || !contains(github.event.head_commit.message, '[skip ci]') }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          components: clippy
+
+      - run: make cargo.lint
+
+  rustfmt:
+    if: ${{ github.ref == 'refs/heads/main'
+            || startsWith(github.ref, 'refs/tags/v')
+            || !contains(github.event.head_commit.message, '[skip ci]') }}
     runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: nightly
+          components: rustfmt
+
+      - run: make cargo.fmt check=yes
+
+
+
+
+  ###########
+  # Testing #
+  ###########
+
+  test:
+    if: ${{ github.ref == 'refs/heads/main'
+            || startsWith(github.ref, 'refs/tags/v')
+            || !contains(github.event.head_commit.message, '[skip ci]') }}
     strategy:
+      fail-fast: false
       matrix:
-        rust:
+        crate:
+          - cucumber_rust_codegen
+          - cucumber_rust
+        os:
+          - ubuntu
+          - macOS
+          - windows
+        toolchain:
           - stable
           - beta
           - nightly
+    runs-on: ${{ matrix.os }}-latest
     steps:
       - uses: actions/checkout@v2
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: ${{ matrix.rust }}
+          toolchain: ${{ matrix.toolchain }}
           override: true
-          components: rustfmt, clippy
-      - uses: actions-rs/cargo@v1
+
+      - run: make test.cargo crate=${{ matrix.crate }}
+
+  test-book:
+    if: ${{ github.ref == 'refs/heads/main'
+            || startsWith(github.ref, 'refs/tags/v')
+            || !contains(github.event.head_commit.message, '[skip ci]') }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
         with:
-          command: build
-          args: --all-features
-      - uses: actions-rs/cargo@v1
+          profile: minimal
+          toolchain: stable
+
+      - run: make test.book
+
+
+
+
+  #################
+  # Documentation #
+  #################
+
+  rustdoc:
+    if: ${{ github.ref == 'refs/heads/main'
+            || startsWith(github.ref, 'refs/tags/v')
+            || !contains(github.event.head_commit.message, '[skip ci]') }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+
+      - run: make cargo.doc open=no
+
+
+
+
+  #############
+  # Releasing #
+  #############
+
+  release-github:
+    name: Release on GitHub
+    needs: ["clippy", "rustfmt", "rustdoc", "test", "test-book"]
+    if: ${{ startsWith(github.ref, 'refs/tags/v') }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Parse release version
+        id: release
+        run: echo ::set-output name=VERSION::${GITHUB_REF#refs/tags/v}
+
+      - name: Verify release version matches `cucumber_rust_codegen` Cargo manifest
+        run: >-
+          test "${{ steps.release.outputs.VERSION }}" \
+            == "$(grep -m1 'version = "' codegen/Cargo.toml | cut -d '"' -f2)"
+      - name: Verify release version matches `cucumber_rust` Cargo manifest
+        run: >-
+          test "${{ steps.release.outputs.VERSION }}" \
+            == "$(grep -m1 'version = "' Cargo.toml | cut -d '"' -f2)"
+
+      - name: Parse CHANGELOG link
+        id: changelog
+        run: echo ::set-output
+          name=LINK::https://github.com/${{ github.repository }}/blob/v${{ steps.release.outputs.VERSION }}/CHANGELOG.md#$(sed -n '/^### \[${{ steps.release.outputs.VERSION }}\]/{s/^### \[\(.*\)\][^0-9]*\([0-9].*\)/\1--\2/;s/[^0-9a-z-]*//g;p;}' CHANGELOG.md)
+
+      - uses: softprops/action-gh-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          name: ${{ steps.release.outputs.VERSION }}
+          body: |
+            [API docs](https://docs.rs/cucumber_rust/${{ steps.release.outputs.VERSION }})
+            [Changelog](${{ steps.changelog.outputs.LINK }})
+          prerelease: ${{ contains(steps.release.outputs.VERSION, '-') }}
+
+  release-crate:
+    name: Release on crates.io
+    needs: ["release-github"]
+    if: ${{ startsWith(github.ref, 'refs/tags/v') }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
         with:
-          command: test
-          args: -p cucumber_rust_codegen
-      - uses: actions-rs/cargo@v1
+          profile: minimal
+          toolchain: stable
+
+      - name: Publish `cucumber_rust_codegen` crate
+        run: cargo publish --token ${{ secrets.CRATESIO_TOKEN }}
+        working-directory: ./codegen
+
+      - name: Wait crates.io index is updated
+        run: sleep 120
+
+      - name: Publish `cucumber_rust` crate
+        run: cargo publish --token ${{ secrets.CRATESIO_TOKEN }}
+        working-directory: ./
+
+
+
+
+  ##########
+  # Deploy #
+  ##########
+
+  deploy-book:
+    name: Deploy Book
+    needs: ["test-book"]
+    if: ${{ github.ref == 'refs/heads/main'
+            || startsWith(github.ref, 'refs/tags/v') }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: peaceiris/actions-mdbook@v1
+
+      - run: make book.build out=gh-pages/main
+        if: ${{ github.ref == 'refs/heads/main' }}
+
+      - run: make book.build out=gh-pages/current
+        if: ${{ startsWith(github.ref, 'refs/tags/v') }}
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
         with:
-          command: test
-          args: --all-features
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          keep_files: true
+          publish_dir: book/gh-pages

.gitignore

@@ -1,9 +1,8 @@
+/.idea/
+/.vscode/launch.json
+/*.iml
+.DS_Store
 
-/target
+/target/
+/Cargo.lock
 **/*.rs.bk
-
-/target
-**/*.rs.bk
-Cargo.lock
-.idea/
-.vscode/launch.json

.rustfmt.toml

@@ -0,0 +1,16 @@
+# Project configuration for rustfmt Rust code formatter.
+# See full list of configurations at:
+# https://github.com/rust-lang/rustfmt/blob/master/Configurations.md
+
+max_width = 80
+format_strings = false
+imports_granularity = "Crate"
+
+format_code_in_doc_comments = true
+format_macro_matchers = true
+use_try_shorthand = true
+
+error_on_line_overflow = true
+error_on_unformatted = true
+
+unstable_features = true

CHANGELOG.md

@@ -4,53 +4,72 @@
 
 - `Scenario Outline` is treated the same as `Outline` or `Example` in the parser ([gherkin/#19](https://github.com/bbqsrc/gherkin-rust/issues/19))
 
-### 0.9.0 — 2021-07-19
+### [0.10.0] — ???
+[0.10.0]: /../../tree/v0.10.0
+
+- **Breaking change** Complete redesign:
+  - Introduce new abstractions: `Parser`, `Runner`, `Writer`.
+  - Provide reference implementations for those abstractions.
+  - Add ability to run `Scenario`s concurrently.
+  - Update book to reflect redesign.
+
+### [0.9.0] — 2021-07-19
+[0.9.0]: /../../tree/v0.9.0
 
 - **Breaking change:** the second parameter in the test callbacks is now a `StepContext` object, which contains the `Step` as a `step` field.
 - Feature: Add `before` and `after` lifecycle functions to the Cucumber builder
   - This function takes a selector for determining when to run 'before' or 'after', and a callback
 - Fix: literal paths to .feature files will now work in the Cucumber builder
 - Fix: remove unnecessary internal `Rc<T>` usage.
 
-### 0.8.4 — 2021-02-18
+### [0.8.4] — 2021-02-18
+[0.8.4]: /../../tree/v0.8.4
 
 - Feature: add `language` argument to Cucumber builder to set default language for all feature files
 - Feature: add `--debug` flag to always print stdout and stderr per step
 
-### 0.8.3 — 2021-02-09
+### [0.8.3] — 2021-02-09
+[0.8.3]: /../../tree/v0.8.3
 
 - Update `t!` macro to support specifying type of world argument in closure
 
-### 0.8.2 — 2021-01-30
+### [0.8.2] — 2021-01-30
+[0.8.2]: /../../tree/v0.8.2
 
 - Re-export `async_trait::async_trait` and `futures` crate for convenience
 - Update examples to use `tokio`
 
-### 0.8.1 — 2021-01-30
+### [0.8.1] — 2021-01-30
+[0.8.1]: /../../tree/v0.8.1
 
 - Added proper i18n support via gherkin 0.9
 
-### 0.8.0 — 2021-01-18
+### [0.8.0] — 2021-01-18
+[0.8.0]: /../../tree/v0.8.0
 
 - Fixed filtering of tests by tag ([#67](https://github.com/bbqsrc/cucumber-rust/issues/67))
 - Implemented failure reporting ([#91](https://github.com/bbqsrc/cucumber-rust/issues/91))
 - Removed unnecessary dependent traits from `World` trait
 - Added proc-macro variant (thanks Ilya Solovyiov and Kai Ren)
 
-### 0.7.3 — 2020-09-20
+### [0.7.3] — 2020-09-20
+[0.7.3]: /../../tree/v0.7.3
 
 - Fix missing mut in t! macro for regexes ([#68](https://github.com/bbqsrc/cucumber-rust/issues/68)) — thanks [@stefanpieck](https://github.com/stefanpieck)!
 
-### 0.7.2 — 2020-09-14
+### [0.7.2] — 2020-09-14
+[0.7.2]: /../../tree/v0.7.2
 
 - Enforce `UnwindSafe` on async test types
 
-### 0.7.1 — 2020-09-09
+### [0.7.1] — 2020-09-09
+[0.7.1]: /../../tree/v0.7.1
 
 - Fix issue with `t!` macro for unbraced blocks
 
-### 0.7.0 — 2020-09-07
+### [0.7.0] — 2020-09-07
+[0.7.0]: /../../tree/v0.7.0
 
 - **Breaking changes**: the macro approach provided in 0.6.x and lower has been entirely removed. It was hard to maintain and limited maintenance of the tests themselves.
 - A new builder approach has been implemented.
-- Support for asynchronous tests has been implemented — this is runtime agnostic.
+- Support for asynchronous tests has been implemented — this is runtime agnostic.