1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
// Copyright (c) 2018-2024 Brendan Molloy <brendan@bbqsrc.net>,
// Ilya Solovyiov <ilya.solovyiov@gmail.com>,
// Kai Ren <tyranron@gmail.com>
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
//! Tools for parsing [Gherkin] files.
//!
//! [Gherkin]: https://cucumber.io/docs/gherkin/reference
pub mod basic;
use std::sync::Arc;
use derive_more::{Display, Error};
use futures::Stream;
use crate::feature::ExpandExamplesError;
#[doc(inline)]
pub use self::basic::Basic;
/// Source of parsed [`Feature`]s.
///
/// [`Feature`]: gherkin::Feature
pub trait Parser<I> {
/// CLI options of this [`Parser`]. In case no options should be introduced,
/// just use [`cli::Empty`].
///
/// All CLI options from [`Parser`], [`Runner`] and [`Writer`] will be
/// merged together, so overlapping arguments will cause a runtime panic.
///
/// [`cli::Empty`]: crate::cli::Empty
/// [`Runner`]: crate::Runner
/// [`Writer`]: crate::Writer
type Cli: clap::Args;
/// Output [`Stream`] of parsed [`Feature`]s.
///
/// [`Feature`]: gherkin::Feature
type Output: Stream<Item = Result<gherkin::Feature>> + 'static;
/// Parses the given `input` into a [`Stream`] of [`Feature`]s.
///
/// [`Feature`]: gherkin::Feature
fn parse(self, input: I, cli: Self::Cli) -> Self::Output;
}
/// Result of parsing [Gherkin] files.
///
/// [Gherkin]: https://cucumber.io/docs/gherkin/reference
#[allow(clippy::absolute_paths)]
pub type Result<T> = std::result::Result<T, Error>;
/// [`Parser`] error.
#[derive(Clone, Debug, Display, Error)]
pub enum Error {
/// Failed to parse a [`Feature`].
///
/// [`Feature`]: gherkin::Feature
#[display(fmt = "Failed to parse feature: {}", _0)]
Parsing(Arc<gherkin::ParseFileError>),
/// Failed to expand [`Examples`]
///
/// [`Examples`]: gherkin::Examples
#[display(fmt = "Failed to expand examples: {}", _0)]
ExampleExpansion(Arc<ExpandExamplesError>),
}
impl From<gherkin::ParseFileError> for Error {
fn from(e: gherkin::ParseFileError) -> Self {
Self::Parsing(Arc::new(e))
}
}
impl From<ExpandExamplesError> for Error {
fn from(e: ExpandExamplesError) -> Self {
Self::ExampleExpansion(Arc::new(e))
}
}