Rename crates to cucumber and cucumber-codegen

Additionally:
- renew CHANGELOGs

Author: tyranron

.github/workflows/ci.yml

@@ -61,8 +61,8 @@ jobs:
       fail-fast: false
       matrix:
         crate:
-          - cucumber_rust_codegen
-          - cucumber_rust
+          - cucumber-codegen
+          - cucumber
         os:
           - ubuntu
           - macOS
@@ -136,11 +136,11 @@ jobs:
         id: release
         run: echo ::set-output name=VERSION::${GITHUB_REF#refs/tags/v}
 
-      - name: Verify release version matches `cucumber_rust_codegen` Cargo manifest
+      - name: Verify release version matches `cucumber-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
+      - name: Verify release version matches `cucumber` Cargo manifest
         run: >-
           test "${{ steps.release.outputs.VERSION }}" \
             == "$(grep -m1 'version = "' Cargo.toml | cut -d '"' -f2)"
@@ -156,7 +156,7 @@ jobs:
         with:
           name: ${{ steps.release.outputs.VERSION }}
           body: |
-            [API docs](https://docs.rs/cucumber_rust/${{ steps.release.outputs.VERSION }})
+            [API docs](https://docs.rs/cucumber/${{ steps.release.outputs.VERSION }})
             [Changelog](${{ steps.changelog.outputs.LINK }})
           prerelease: ${{ contains(steps.release.outputs.VERSION, '-') }}
 
@@ -172,14 +172,14 @@ jobs:
           profile: minimal
           toolchain: stable
 
-      - name: Publish `cucumber_rust_codegen` crate
+      - name: Publish `cucumber-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
+      - name: Publish `cucumber` crate
         run: cargo publish --token ${{ secrets.CRATESIO_TOKEN }}
         working-directory: ./
 

CHANGELOG.md

@@ -1,75 +1,184 @@
-### Current
+`cucumber` changelog
+====================
 
-#### Known issues:
+All user visible changes to `cucumber` crate will be documented in this file. This project uses [Semantic Versioning 2.0.0].
 
-- `Scenario Outline` is treated the same as `Outline` or `Example` in the parser ([gherkin/#19](https://github.com/bbqsrc/gherkin-rust/issues/19))
 
-### [0.10.0] — ???
+
+
+## [0.10.0] · 2021-??-??
 [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.
+[Diff](/../../compare/v0.9.0...v0.10.0)
+
+### BC Breaks
+
+- Renamed crate to `cucumber`.
+- Complete redesign: ([#128])
+    - Introduce new abstractions: `Parser`, `Runner`, `Writer`;
+    - Provide reference implementations for those abstractions.
+- Replaced `#[given(step)]`, `#[when(step)]` and `#[then(step)]` function argument attributes with a single `#[step]`. ([#128])
+
+### Added
+
+- Ability to run `Scenario`s concurrently. ([#128])
+
+[#128]: /../../pull/128
+
+
 
-### [0.9.0] — 2021-07-19
+
+## [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.
+[Diff](/../../compare/v0.8.4...v0.9.0)
+
+### BC Breaks
+
+- The second parameter in the test callbacks is now a `StepContext` object, which contains the `Step` as a `step` field.
+
+### Added
+
+- Add `before` and `after` lifecycle functions to the `Cucumber` builder. These functions take a selector for determining when to run `before` or `after`, and a callback.
+
+### Fixed
+
+- Literal paths to `.feature` files will now work in the `Cucumber` builder.
+- Removed 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
+[Diff](/../../compare/v0.8.3...v0.8.4)
+
+### Added
+
+- `language` argument to `Cucumber` builder to set default language for all `.feature` files.
+- `--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
+[Diff](/../../compare/v0.8.2...v0.8.3)
+
+### Changed
+
+- 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`
+[Diff](/../../compare/v0.8.1...v0.8.2)
+
+### Added
+
+- 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
+[Diff](/../../compare/v0.8.0...v0.8.1)
+
+### Added
+
+- Proper i18n support via [`gherkin_rust`] `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/cucumber-rs/cucumber/issues/67))
-- Implemented failure reporting ([#91](https://github.com/cucumber-rs/cucumber/issues/91))
-- Removed unnecessary dependent traits from `World` trait
-- Added proc-macro variant (thanks Ilya Solovyiov and Kai Ren)
+[Diff](/../../compare/v0.7.3...v0.8.0)
+
+### Added
+
+- Failure reporting. ([#91])
+- `macros` feature providing attributes: ([#81])
+    - [`given`](https://docs.rs/cucumber_rust/0.8.0/cucumber_rust/attr.given.html);
+    - [`when`](https://docs.rs/cucumber_rust/0.8.0/cucumber_rust/attr.when.html);
+    - [`then`](https://docs.rs/cucumber_rust/0.8.0/cucumber_rust/attr.then.html).
+
+### Fixed
+
+- Filtering of tests by tag. ([#67])
+- Removed unnecessary dependent traits from `World` trait.
+
+[#67]: /../../issues/67
+[#81]: /../../pull/81
+[#91]: /../../issues/91
+
 
-### [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/cucumber-rs/cucumber/issues/68)) — thanks [@stefanpieck](https://github.com/stefanpieck)!
+[Diff](/../../compare/v0.7.2...v0.7.3)
+
+### Fixed
+
+- Fix missing `mut` in `t!` macro for regexes — thanks [@stefanpieck](https://github.com/stefanpieck)! ([#68])
+
+[#68]: /../../issues/68
 
-### [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
+[Diff](/../../compare/v0.7.1...v0.7.2)
+
+### Added
 
-### [0.7.1] — 2020-09-09
+- Enforce `UnwindSafe` on async test types.
+
+
+
+
+## [0.7.1] · 2020-09-09
 [0.7.1]: /../../tree/v0.7.1
 
-- Fix issue with `t!` macro for unbraced blocks
+[Diff](/../../compare/v0.7.0...v0.7.1)
+
+### Fixed
+
+- 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.
+[Diff](/../../compare/v0.6.8...v0.7.0)
+
+### BC Breaks
+
+- 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.
+
+### Added
+
 - A new builder approach has been implemented.
 - Support for asynchronous tests has been implemented — this is runtime agnostic.
+
+
+
+
+[`gherkin_rust`]: https://docs.rs/gherkin_rust
+
+[Semantic Versioning 2.0.0]: https://semver.org

Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "cucumber_rust"
+name = "cucumber"
 version = "0.10.0"
 edition = "2018"
 resolver = "2"
@@ -13,7 +13,7 @@ authors = [
     "Ilya Solovyiov <ilya.solovyiov@gmail.com>",
     "Kai Ren <tyranron@gmail.com>",
 ]
-documentation = "https://docs.rs/cucumber_rust"
+documentation = "https://docs.rs/cucumber"
 homepage = "https://github.com/cucumber-rs/cucumber"
 repository = "https://github.com/cucumber-rs/cucumber"
 readme = "README.md"
@@ -26,7 +26,7 @@ rustdoc-args = ["--cfg", "docsrs"]
 
 [features]
 default = ["macros"]
-macros = ["cucumber_rust_codegen", "inventory"]
+macros = ["cucumber-codegen", "inventory"]
 
 [dependencies]
 async-trait = "0.1.40"
@@ -43,7 +43,7 @@ regex = "1.5"
 sealed = "0.3"
 
 # "macros" feature dependencies
-cucumber_rust_codegen = { version = "0.10", path = "./codegen", optional = true }
+cucumber-codegen = { version = "0.10", path = "./codegen", optional = true }
 inventory = { version = "0.1.10", optional = true }
 
 [dev-dependencies]

README.md

@@ -1,6 +1,7 @@
-# cucumber
+Cucumber testing framework for Rust
+===================================
 
-[![Documentation](https://docs.rs/cucumber_rust/badge.svg)](https://docs.rs/cucumber_rust)
+[![Documentation](https://docs.rs/cucumber/badge.svg)](https://docs.rs/cucumber)
 [![Actions Status](https://github.com/cucumber-rs/cucumber/workflows/CI/badge.svg)](https://github.com/cucumber-rs/cucumber/actions)
 [![Unsafe Forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/)
 
@@ -33,7 +34,7 @@ Implement `World` trait and describe steps:
 use std::{convert::Infallible, time::Duration};
 
 use async_trait::async_trait;
-use cucumber_rust::{self as cucumber, given, then, when, WorldInit};
+use cucumber::{given, then, when, WorldInit};
 use tokio::time::sleep;
 
 #[derive(Debug, WorldInit)]
@@ -101,6 +102,13 @@ The full gamut of Cucumber's [Gherkin] language is implemented by the [`gherkin-
 
 
 
+## Known issues
+
+- `Scenario Outline` is treated the same as `Outline` or `Example` in the parser ([gherkin/#19](https://github.com/bbqsrc/gherkin-rust/issues/19)).
+
+
+
+
 ## License
 
 This project is licensed under either of

book/README.md

@@ -1,6 +1,6 @@
 # cucumber book
 
-Book containing the [`cucumber_rust`](https://crates.io/crates/cucumber_rust) documentation.
+Book containing the [`cucumber`](https://crates.io/crates/cucumber) documentation.