[tech] Add a precise git_version to transit-model

Cargo.toml

@@ -63,6 +63,7 @@ typed_index_collection = "1"
 walkdir = "2"
 wkt = "0.8"
 zip = { version = "0.5", default-features = false, features = ["deflate"] }
+git-version = "0.3"
 
 [[test]]
 name = "write_netex_france"

gtfs2netexfr/Cargo.toml

@@ -23,3 +23,4 @@ slog-stdlog = "4.0"
 slog-term = "2.4"
 structopt = "0.3"
 transit_model = { version = "0.34", path = "../", features = ["proj"] }
+lazy_static = "1"

gtfs2netexfr/src/main.rs

@@ -23,8 +23,16 @@ use std::path::PathBuf;
 use structopt::StructOpt;
 use transit_model::{read_utils, Result};
 
+lazy_static::lazy_static! {
+    pub static ref GIT_VERSION: String = transit_model::binary_full_version(env!("CARGO_PKG_VERSION"));
+}
+
+fn get_version() -> &'static str {
+    &GIT_VERSION
+}
+
 #[derive(Debug, StructOpt)]
-#[structopt(name = "gtfs2netexfr", about = "Convert a GTFS to NeTEx France.")]
+#[structopt(name = "gtfs2netexfr", about = "Convert a GTFS to NeTEx France.", version = get_version())]
 struct Opt {
     /// Input directory.
     #[structopt(short, long, parse(from_os_str), default_value = ".")]

gtfs2ntfs/Cargo.toml

@@ -23,3 +23,4 @@ slog-stdlog = "4.0"
 slog-term = "2.4"
 structopt = "0.3"
 transit_model = { version = "0.34", path = "../" }
+lazy_static = "1"

gtfs2ntfs/src/main.rs

@@ -23,8 +23,16 @@ use std::path::PathBuf;
 use structopt::StructOpt;
 use transit_model::{read_utils, transfers::generates_transfers, PrefixConfiguration, Result};
 
+lazy_static::lazy_static! {
+    pub static ref GIT_VERSION: String = transit_model::binary_full_version(env!("CARGO_PKG_VERSION"));
+}
+
+fn get_version() -> &'static str {
+    &GIT_VERSION
+}
+
 #[derive(Debug, StructOpt)]
-#[structopt(name = "gtfs2ntfs", about = "Convert a GTFS to an NTFS.")]
+#[structopt(name = "gtfs2ntfs", about = "Convert a GTFS to an NTFS.", version = get_version())]
 struct Opt {
     /// Input directory.
     #[structopt(short, long, parse(from_os_str), default_value = ".")]

ntfs2gtfs/Cargo.toml

@@ -23,3 +23,4 @@ slog-stdlog = "4.0"
 slog-term = "2.4"
 structopt = "0.3"
 transit_model = { version = "0.34", path = "../" }
+lazy_static = "1"

ntfs2gtfs/src/main.rs

@@ -22,8 +22,16 @@ use std::path::PathBuf;
 use structopt::StructOpt;
 use transit_model::Result;
 
+lazy_static::lazy_static! {
+    pub static ref GIT_VERSION: String = transit_model::binary_full_version(env!("CARGO_PKG_VERSION"));
+}
+
+fn get_version() -> &'static str {
+    &GIT_VERSION
+}
+
 #[derive(Debug, StructOpt)]
-#[structopt(name = "ntfs2gtfs", about = "Convert an NTFS to a GTFS.")]
+#[structopt(name = "ntfs2gtfs", about = "Convert an NTFS to a GTFS.", version = get_version())]
 struct Opt {
     /// Input directory.
     #[structopt(short, long, parse(from_os_str), default_value = ".")]

ntfs2netexfr/Cargo.toml

@@ -23,3 +23,4 @@ slog-stdlog = "4.0"
 slog-term = "2.4"
 structopt = "0.3"
 transit_model = { version = "0.34", path = "../", features = ["proj"] }
+lazy_static = "1"

ntfs2netexfr/src/main.rs

@@ -22,8 +22,16 @@ use std::path::PathBuf;
 use structopt::StructOpt;
 use transit_model::Result;
 
+lazy_static::lazy_static! {
+    pub static ref GIT_VERSION: String = transit_model::binary_full_version(env!("CARGO_PKG_VERSION"));
+}
+
+fn get_version() -> &'static str {
+    &GIT_VERSION
+}
+
 #[derive(Debug, StructOpt)]
-#[structopt(name = "ntfs2netexfr", about = "Convert a NTFS to NeTEx France.")]
+#[structopt(name = "ntfs2netexfr", about = "Convert a NTFS to NeTEx France.", version = get_version())]
 struct Opt {
     /// Input directory.
     #[structopt(short, long, parse(from_os_str), default_value = ".")]

ntfs2ntfs/Cargo.toml

@@ -23,3 +23,4 @@ slog-stdlog = "4.0"
 slog-term = "2.4"
 structopt = "0.3"
 transit_model = { version = "0.34", path = "../" }
+lazy_static = "1"

ntfs2ntfs/src/main.rs

@@ -22,8 +22,16 @@ use std::path::PathBuf;
 use structopt::StructOpt;
 use transit_model::{transfers::generates_transfers, Result};
 
+lazy_static::lazy_static! {
+    pub static ref GIT_VERSION: String = transit_model::binary_full_version(env!("CARGO_PKG_VERSION"));
+}
+
+fn get_version() -> &'static str {
+    &GIT_VERSION
+}
+
 #[derive(Debug, StructOpt)]
-#[structopt(name = "ntfs2ntfs", about = "Convert an NTFS to an NTFS.")]
+#[structopt(name = "ntfs2ntfs", about = "Convert an NTFS to an NTFS.", version = get_version())]
 struct Opt {
     /// Input directory.
     #[structopt(short = "i", long = "input", parse(from_os_str), default_value = ".")]

src/lib.rs

@@ -56,6 +56,7 @@ pub mod read_utils;
 pub mod test_utils;
 pub mod transfers;
 pub mod validity_period;
+mod version_utils;
 pub mod vptranslator;
 
 /// Current version of the NTFS format
@@ -82,3 +83,5 @@ pub type Error = failure::Error;
 pub type Result<T, E = Error> = std::result::Result<T, E>;
 
 pub use crate::model::Model;
+
+pub use crate::version_utils::{binary_full_version, GIT_VERSION};

src/version_utils.rs

@@ -0,0 +1,25 @@
+// Copyright (C) 2017 Kisio Digital and/or its affiliates.
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU Affero General Public License as published by the
+// Free Software Foundation, version 3.
+
+// This program is distributed in the hope that it will be useful, but WITHOUT
+// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+// FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+// details.
+
+// You should have received a copy of the GNU Affero General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>
+//! Some utility to get the transit_model version
+
+/// Precise git version of transit_model
+/// the version will be:
+/// v{last github tag}-{commit number}-{commit hash}{"-modified" if some changes have been done since last commit}
+pub const GIT_VERSION: &str =
+    git_version::git_version!(args = ["--tags", "--dirty=-modified"], fallback = "unknown");
+
+/// get the binary version and the transit_model version
+pub fn binary_full_version(binary_version: &str) -> String {
+    format!("{} (transit_model = {})", binary_version, GIT_VERSION)
+}