move vendored functionalities to more descriptive modules

move the different functionalities vendored from older protobuf versions into
more descriptive modules within the util module.

Signed-off-by: Jorge Prendes <jorge.prendes@gmail.com>

Author: jprendes

compiler/src/codegen.rs

@@ -43,8 +43,7 @@ use std::{
 };
 
 use crate::{
-    vendored::{proto_path_to_rust_mod, CodeWriter, RootScope},
-    Customize,
+    util::proto_path_to_rust_mod, util::scope::RootScope, util::writer::CodeWriter, Customize,
 };
 use protobuf::{
     descriptor::*,

compiler/src/lib.rs

@@ -26,7 +26,6 @@
 pub mod codegen;
 pub mod prost_codegen;
 mod util;
-mod vendored;
 
 /// Customize generated code.
 #[derive(Default, Debug, Clone)]

compiler/src/util.rs renamed to compiler/src/util/mod.rs

@@ -16,7 +16,10 @@
 use std::fmt;
 use std::str;
 
-use crate::vendored::CodeWriter;
+pub mod scope;
+pub mod writer;
+
+use writer::CodeWriter;
 
 // A struct that divide a name into serveral parts that meets rust's guidelines.
 struct NameSpliter<'a> {
@@ -132,6 +135,15 @@ where
     async_fn_block(w, false, sig, cb);
 }
 
+// proto_name_to_rs is constructor as "{proto_path_to_rust_mod}.rs"
+// see https://github.com/stepancheg/rust-protobuf/blob/v3.7.2/protobuf-codegen/src/gen/paths.rs#L43
+pub fn proto_path_to_rust_mod(path: &str) -> String {
+    protobuf_codegen::proto_name_to_rs(path)
+        .strip_suffix(".rs")
+        .unwrap()
+        .to_string()
+}
+
 pub enum MethodType {
     Unary,
     ClientStreaming,

compiler/src/vendored.rs renamed to compiler/src/util/scope.rs

@@ -3,16 +3,6 @@
 //! The missing functionalities have been reimplemented in this module.
 
 use protobuf::descriptor::{DescriptorProto, FileDescriptorProto};
-use protobuf_codegen::proto_name_to_rs;
-
-// proto_name_to_rs is constructor as "{proto_path_to_rust_mod}.rs"
-// see https://github.com/stepancheg/rust-protobuf/blob/v3.7.2/protobuf-codegen/src/gen/paths.rs#L43
-pub fn proto_path_to_rust_mod(path: &str) -> String {
-    proto_name_to_rs(path)
-        .strip_suffix(".rs")
-        .unwrap()
-        .to_string()
-}
 
 // vendered from https://github.com/stepancheg/rust-protobuf/blob/v3.7.2/protobuf-codegen/src/gen/rust/keywords.rs
 fn is_rust_keyword(ident: &str) -> bool {
@@ -78,82 +68,6 @@ fn is_rust_keyword(ident: &str) -> bool {
     RUST_KEYWORDS.contains(&ident)
 }
 
-// adapted from https://github.com/stepancheg/rust-protobuf/blob/v3.7.2/protobuf-codegen/src/gen/code_writer.rs#L12
-#[derive(Default)]
-pub struct CodeWriter {
-    writer: String,
-    indent: String,
-}
-
-impl CodeWriter {
-    pub fn new() -> CodeWriter {
-        Self::default()
-    }
-
-    pub fn code(&self) -> &str {
-        &self.writer
-    }
-
-    pub fn take_code(&mut self) -> String {
-        std::mem::take(&mut self.writer)
-    }
-
-    pub fn write_line(&mut self, line: impl AsRef<str>) {
-        if line.as_ref().is_empty() {
-            self.writer.push('\n');
-        } else {
-            self.writer.push_str(&self.indent);
-            self.writer.push_str(line.as_ref());
-            self.writer.push('\n');
-        }
-    }
-
-    pub fn block(
-        &mut self,
-        first_line: impl AsRef<str>,
-        last_line: impl AsRef<str>,
-        cb: impl FnOnce(&mut CodeWriter),
-    ) {
-        self.write_line(first_line);
-        self.indented(cb);
-        self.write_line(last_line);
-    }
-
-    pub fn expr_block(&mut self, prefix: impl AsRef<str>, cb: impl FnOnce(&mut CodeWriter)) {
-        self.block(format!("{} {{", prefix.as_ref()), "}", cb);
-    }
-
-    pub fn indented(&mut self, cb: impl FnOnce(&mut CodeWriter)) {
-        self.indent.push_str("    ");
-        cb(self);
-        self.indent.truncate(self.indent.len() - 4);
-    }
-
-    pub fn pub_fn(&mut self, sig: impl AsRef<str>, cb: impl FnOnce(&mut CodeWriter)) {
-        self.expr_block(format!("pub fn {}", sig.as_ref()), cb)
-    }
-
-    pub fn def_fn(&mut self, sig: impl AsRef<str>, cb: impl FnOnce(&mut CodeWriter)) {
-        self.expr_block(format!("fn {}", sig.as_ref()), cb)
-    }
-
-    pub fn pub_struct(&mut self, name: impl AsRef<str>, cb: impl FnOnce(&mut CodeWriter)) {
-        self.expr_block(format!("pub struct {}", name.as_ref()), cb);
-    }
-
-    pub fn field_decl(&mut self, name: impl AsRef<str>, field_type: impl AsRef<str>) {
-        self.write_line(format!("{}: {},", name.as_ref(), field_type.as_ref()));
-    }
-
-    pub fn impl_self_block(&mut self, name: impl AsRef<str>, cb: impl FnOnce(&mut CodeWriter)) {
-        self.expr_block(format!("impl {}", name.as_ref()), cb);
-    }
-
-    pub fn pub_trait(&mut self, name: impl AsRef<str>, cb: impl FnOnce(&mut CodeWriter)) {
-        self.expr_block(format!("pub trait {}", name.as_ref()), cb);
-    }
-}
-
 // reimplementation based on https://github.com/stepancheg/rust-protobuf/blob/v3.7.2/protobuf-codegen/src/gen/scope.rs#L26
 // it only implements the `find_message` method with not extra dependencies
 pub struct RootScope<'a> {
@@ -198,7 +112,7 @@ impl ScopedMessage<'_> {
     pub fn rust_fq_name(&self) -> String {
         format!(
             "{}::{}",
-            proto_path_to_rust_mod(self.fd.name()),
+            super::proto_path_to_rust_mod(self.fd.name()),
             self.rust_name()
         )
     }

compiler/src/util/writer.rs

@@ -0,0 +1,79 @@
+//! This module contains functionalities that where previously available in
+//! the protobuf / protobuf-codegen crates, but were then removed.
+//! The missing functionalities have been reimplemented in this module.
+
+// adapted from https://github.com/stepancheg/rust-protobuf/blob/v3.7.2/protobuf-codegen/src/gen/code_writer.rs#L12
+#[derive(Default)]
+pub struct CodeWriter {
+    writer: String,
+    indent: String,
+}
+
+impl CodeWriter {
+    pub fn new() -> CodeWriter {
+        Self::default()
+    }
+
+    pub fn code(&self) -> &str {
+        &self.writer
+    }
+
+    pub fn take_code(&mut self) -> String {
+        std::mem::take(&mut self.writer)
+    }
+
+    pub fn write_line(&mut self, line: impl AsRef<str>) {
+        if line.as_ref().is_empty() {
+            self.writer.push('\n');
+        } else {
+            self.writer.push_str(&self.indent);
+            self.writer.push_str(line.as_ref());
+            self.writer.push('\n');
+        }
+    }
+
+    pub fn block(
+        &mut self,
+        first_line: impl AsRef<str>,
+        last_line: impl AsRef<str>,
+        cb: impl FnOnce(&mut CodeWriter),
+    ) {
+        self.write_line(first_line);
+        self.indented(cb);
+        self.write_line(last_line);
+    }
+
+    pub fn expr_block(&mut self, prefix: impl AsRef<str>, cb: impl FnOnce(&mut CodeWriter)) {
+        self.block(format!("{} {{", prefix.as_ref()), "}", cb);
+    }
+
+    pub fn indented(&mut self, cb: impl FnOnce(&mut CodeWriter)) {
+        self.indent.push_str("    ");
+        cb(self);
+        self.indent.truncate(self.indent.len() - 4);
+    }
+
+    pub fn pub_fn(&mut self, sig: impl AsRef<str>, cb: impl FnOnce(&mut CodeWriter)) {
+        self.expr_block(format!("pub fn {}", sig.as_ref()), cb)
+    }
+
+    pub fn def_fn(&mut self, sig: impl AsRef<str>, cb: impl FnOnce(&mut CodeWriter)) {
+        self.expr_block(format!("fn {}", sig.as_ref()), cb)
+    }
+
+    pub fn pub_struct(&mut self, name: impl AsRef<str>, cb: impl FnOnce(&mut CodeWriter)) {
+        self.expr_block(format!("pub struct {}", name.as_ref()), cb);
+    }
+
+    pub fn field_decl(&mut self, name: impl AsRef<str>, field_type: impl AsRef<str>) {
+        self.write_line(format!("{}: {},", name.as_ref(), field_type.as_ref()));
+    }
+
+    pub fn impl_self_block(&mut self, name: impl AsRef<str>, cb: impl FnOnce(&mut CodeWriter)) {
+        self.expr_block(format!("impl {}", name.as_ref()), cb);
+    }
+
+    pub fn pub_trait(&mut self, name: impl AsRef<str>, cb: impl FnOnce(&mut CodeWriter)) {
+        self.expr_block(format!("pub trait {}", name.as_ref()), cb);
+    }
+}