Refactor the parser code into its own crate for future development

This will inform #46
rtyler · Nov 29, 2020 · 127d3b7 · 127d3b7
1 parent 9a39ea0
commit 127d3b7
Show file tree

Hide file tree

Showing 18 changed files with 38 additions and 12 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -6,6 +6,7 @@ members = [
 
     "crates/agent",
     "crates/models",
+    "crates/parser",
 
     "services/auctioneer",
     "services/eventbus",

diff --git a/crates/parser/Cargo.toml b/crates/parser/Cargo.toml
@@ -0,0 +1,13 @@
+[package]
+name = "otto-parser"
+version = "0.1.0"
+authors = ["R. Tyler Croy <[email protected]>"]
+edition = "2018"
+
+[dependencies]
+log = "~0.4.11"
+otto-models = { path = "../models" }
+pest = "~2.1.3"
+pest_derive = "~2.1.0"
+serde_json = "~1.0.59"
+uuid = { version = "~0.8.1", features = ["v4", "serde"]}
diff --git a/crates/parser/README.adoc b/crates/parser/README.adoc
@@ -0,0 +1,6 @@
+= Otto Parser
+
+The Otto Parser service is basically a parser engine that speaks HTTP. In the
+`src/` directory you will find the `.pest` grammar definition which outlines
+the Otto Pipeline syntax.
+
diff --git a/services/parser/src/lib.rs → crates/parser/src/lib.rs b/services/parser/src/lib.rs → crates/parser/src/lib.rs
@@ -9,6 +9,9 @@ use pest::iterators::{Pair, Pairs};
 use pest::Parser;
 use uuid::Uuid;
 
+pub use pest::error::ErrorVariant;
+pub use pest::error::LineColLocation;
+
 #[derive(Parser)]
 #[grammar = "pipeline.pest"]
 struct PipelineParser;

diff --git a/services/parser/src/pipeline.pest → crates/parser/src/pipeline.pest b/services/parser/src/pipeline.pest → crates/parser/src/pipeline.pest
diff --git a/...es/parser/test_data/invalid/00_empty.otto → ...es/parser/test_data/invalid/00_empty.otto b/...es/parser/test_data/invalid/00_empty.otto → ...es/parser/test_data/invalid/00_empty.otto
diff --git a/...r/test_data/invalid/01_missing_steps.otto → ...r/test_data/invalid/01_missing_steps.otto b/...r/test_data/invalid/01_missing_steps.otto → ...r/test_data/invalid/01_missing_steps.otto
diff --git a/...r/test_data/valid/00_multiple_stages.otto → ...r/test_data/valid/00_multiple_stages.otto b/...r/test_data/valid/00_multiple_stages.otto → ...r/test_data/valid/00_multiple_stages.otto
diff --git a/...er/test_data/valid/00_pipeline_block.otto → ...er/test_data/valid/00_pipeline_block.otto b/...er/test_data/valid/00_pipeline_block.otto → ...er/test_data/valid/00_pipeline_block.otto
diff --git a/...ces/parser/test_data/valid/00_simple.otto → crates/parser/test_data/valid/00_simple.otto b/...ces/parser/test_data/valid/00_simple.otto → crates/parser/test_data/valid/00_simple.otto
diff --git a/...ser/test_data/valid/00_simple_kwargs.otto → ...ser/test_data/valid/00_simple_kwargs.otto b/...ser/test_data/valid/00_simple_kwargs.otto → ...ser/test_data/valid/00_simple_kwargs.otto
diff --git a/...rser/test_data/valid/91_orphan_steps.otto → ...rser/test_data/valid/91_orphan_steps.otto b/...rser/test_data/valid/91_orphan_steps.otto → ...rser/test_data/valid/91_orphan_steps.otto
diff --git a/...ata/valid/92_orphan_steps_and_stages.otto → ...ata/valid/92_orphan_steps_and_stages.otto b/...ata/valid/92_orphan_steps_and_stages.otto → ...ata/valid/92_orphan_steps_and_stages.otto
diff --git a/services/parser/tests/valid.rs → crates/parser/tests/valid.rs b/services/parser/tests/valid.rs → crates/parser/tests/valid.rs
diff --git a/services/parser/Cargo.toml b/services/parser/Cargo.toml
@@ -1,13 +1,9 @@
 [package]
-name = "otto-parser"
+name = "otto-parser-service"
 version = "0.1.0"
 authors = ["R. Tyler Croy <[email protected]>"]
 edition = "2018"
 
-[lib]
-name = "otto_parser"
-path = "src/lib.rs"
-
 [[bin]]
 name = "otto-parser"
 path = "src/main.rs"
@@ -16,8 +12,7 @@ path = "src/main.rs"
 async-std = { version = "1.6.5", features = ["attributes"]}
 log = "~0.4.11"
 otto-models = { path = "../../crates/models" }
-pest = "~2.1.3"
-pest_derive = "~2.1.0"
+otto-parser = { path = "../../crates/parser" }
 pretty_env_logger = "~0.4.0"
 serde_json = "~1.0.59"
 tide = "~0.15.0"

diff --git a/services/parser/README.adoc b/services/parser/README.adoc
@@ -1,8 +1,6 @@
 = Parser service
 
-The Otto Parser service is basically a parser engine that speaks HTTP. In the
-`src/` directory you will find the `.pest` grammar definition which outlines
-the Otto Pipeline syntax.
+The Otto Parser Service presents the parser crate as an HTTP service.
 
 The `apispec.yml` is an link:https://en.wikipedia.org/wiki/Open_API[OpenAPI]
 specification that describes the public HTTP endpoints that the parser service

diff --git a/services/parser/src/main.rs b/services/parser/src/main.rs
@@ -16,7 +16,6 @@ async fn parse(mut req: Request<()>) -> tide::Result {
 
         match parsed {
             Err(e) => {
-                use pest::error::*;
                 error!("Failed to parse: {:?}", e);
 
                 let variant = match e.variant {