Rename protoc-rust-ttrpc and update it for publish

Change its name to ttrpc-codegen.

Signed-off-by: Tim Zhang <[email protected]>

Author: Tim-Zhang

protoc-rust-ttrpc/Cargo.toml

@@ -0,0 +1,19 @@
+[package]
+name = "ttrpc-codegen"
+version = "0.1.1"
+edition = "2018"
+authors = ["The AntFin Kata Team <[email protected]>"]
+license = "Apache-2.0"
+keywords = ["codegen", "ttrpc", "protobuf"]
+description = "Rust codegen for ttrpc using ttrpc-compiler crate"
+categories = ["network-programming", "development-tools::build-utils"]
+repository = "https://github.com/containerd/ttrpc-rust/tree/master/ttrpc-codegen"
+homepage = "https://github.com/containerd/ttrpc-rust/tree/master/ttrpc-codegen"
+readme = "README.md"
+
+
+[dependencies]
+protobuf = { version = "2.14.0" }
+protobuf-codegen-pure = "2.14.0"
+protobuf-codegen = "2.14.0"
+ttrpc-compiler = "0.3"

ttrpc-codegen/Cargo.toml

@@ -0,0 +1,21 @@
+
+Copyright (c) 2020 Ant Financial
+Copyright (c) 2019 Stepan Koltsov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+OR OTHER DEALINGS IN THE SOFTWARE.

ttrpc-codegen/LICENSE.txt

@@ -0,0 +1,36 @@
+# API to generate .rs files for ttrpc from protobuf
+
+API to generate `.rs` files to be used e. g. [from build.rs](../example/build.rs).
+
+Example code:
+
+```rust
+use ttrpc_codegen::Codegen;
+use ttrpc_codegen::Customize;
+
+fn main() {
+    Codegen::new()
+        .out_dir("protocols/sync")
+        .inputs(&protos)
+        .include("protocols/protos")
+        .rust_protobuf()
+        .customize(Customize {
+            ..Default::default()
+        })
+        .run()
+        .expect("Gen code failed.");
+}
+
+```
+
+And in `Cargo.toml`:
+
+```
+[build-dependencies]
+ttrpc-codegen = "0.3"
+```
+
+The alternative is to use
+[protoc-rust crate](https://github.com/stepancheg/rust-protobuf/tree/master/protoc-rust),
+which relies on `protoc` command to parse descriptors. Both crates should produce the same result,
+otherwise please file a bug report.

ttrpc-codegen/README.md

@@ -1,3 +1,25 @@
+//! API to generate .rs files for ttrpc from protobuf
+//!
+//!
+//!```
+//!use ttrpc_codegen::Codegen;
+//!use ttrpc_codegen::Customize;
+//!
+//!fn main() {
+//!    Codegen::new()
+//!        .out_dir("protocols/sync")
+//!        .inputs(&protos)
+//!        .include("protocols/protos")
+//!        .rust_protobuf()
+//!        .customize(Customize {
+//!            ..Default::default()
+//!        })
+//!        .run()
+//!        .expect("Gen code failed.");
+//!}
+//!
+//!```
+
 use protobuf_codegen::Customize as ProtobufCustomize;
 use std::collections::HashMap;
 use std::error::Error;
@@ -14,6 +36,7 @@ mod model;
 mod parser;
 mod str_lit;
 
+/// Invoke pure rust codegen.
 #[derive(Debug, Default)]
 pub struct Codegen {
     /// --lang_out= param
@@ -26,6 +49,7 @@ pub struct Codegen {
     rust_protobuf: bool,
     /// Customize rust-protobuf codegen
     pub rust_protobuf_customize: ProtobufCustomize,
+    /// Customize code generation
     customize: Customize,
 }
 
@@ -69,18 +93,19 @@ impl Codegen {
         self
     }
 
-    /// Generate rust-protobuf files along with rust-gprc.
+    /// Generate rust-protobuf files along with ttrpc-rust.
     pub fn rust_protobuf(&mut self) -> &mut Self {
         self.rust_protobuf = true;
         self
     }
 
-    /// Specify rust-protobuf generated code [`Customize`] object.
+    /// Customize code generated by rust-protobuf.
     pub fn rust_protobuf_customize(&mut self, customize: ProtobufCustomize) -> &mut Self {
         self.rust_protobuf_customize = customize;
         self
     }
 
+    /// Customize code generation.
     pub fn customize(&mut self, customize: Customize) -> &mut Self {
         self.customize = customize;
         self
@@ -102,13 +127,6 @@ impl Codegen {
                 .expect("Gen rust protobuf failed.");
         }
 
-        // let relative_paths: Vec<String> = p
-        //     .relative_paths
-        //     .iter()
-        //     .filter_map(|p| p.to_str())
-        //     .map(|p| p.to_string())
-        //     .collect();
-
         ttrpc_compiler::codegen::gen_and_write(
             &p.file_descriptors,
             &p.relative_paths,
@@ -118,21 +136,6 @@ impl Codegen {
     }
 }
 
-/// Arguments for pure rust codegen invocation.
-// TODO: merge with protoc-rust def
-#[derive(Debug, Default)]
-#[deprecated(since = "2.14", note = "Use Codegen object instead")]
-pub struct Args<'a> {
-    /// --lang_out= param
-    pub out_dir: &'a str,
-    /// -I args
-    pub includes: &'a [&'a str],
-    /// List of .proto files to compile
-    pub input: &'a [&'a str],
-    /// Customize code generation
-    pub customize: ProtobufCustomize,
-}
-
 /// Convert OS path to protobuf path (with slashes)
 /// Function is `pub(crate)` for test.
 pub(crate) fn relative_path_to_protobuf_path(path: &Path) -> String {
@@ -344,23 +347,6 @@ pub fn parse_and_typecheck(
     })
 }
 
-/// Like `protoc --rust_out=...` but without requiring `protoc` or `protoc-gen-rust`
-/// commands in `$PATH`.
-#[deprecated(since = "2.14", note = "Use Codegen instead")]
-#[allow(deprecated)]
-pub fn run(args: Args) -> io::Result<()> {
-    let includes: Vec<&Path> = args.includes.iter().map(|p| Path::new(p)).collect();
-    let inputs: Vec<&Path> = args.input.iter().map(|p| Path::new(p)).collect();
-    let p = parse_and_typecheck(&includes, &inputs)?;
-
-    protobuf_codegen::gen_and_write(
-        &p.file_descriptors,
-        &p.relative_paths,
-        &Path::new(&args.out_dir),
-        &args.customize,
-    )
-}
-
 #[cfg(test)]
 mod test {
     use super::*;