Merge pull request #9 from jakewilliami/use-clap-derive

Use clap `Derive` for cleaner command line interface

Author: jakewilliami

Cargo.toml

@@ -1,21 +1,20 @@
 [package]
 name = "rohe"
-version = "2.0.0"
+version = "2.0.1"
 authors = ["Jake W. Ireland <jakewilliami@icloud.com>"]
 edition = "2018"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-# tokio = {version = "0.2", features = ["full"]}
-tokio = { version = "1", features = ["full"] }
-# async-std = { verson = "1", features = ["attributes", "tokio1"] }
-base64 = "0.13.0"
-reqwest = "0.11.4"
+base64 = "0.13.1"
+clap = { version = "4.0.19", features = ["cargo", "wrap_help", "derive"] }
+hyper = "0.14.22"
 lazy_static = "1.4.0"
-clap = "2.33.3"
-hyper = "0.14.11"
-serde_json = "1.0.66"
-serde = { version = "1.0", features = ["derive"] }
+reqwest = "0.11.12"
+serde = { version = "1.0.147", features = ["derive"] }
 # serde = "1.0.127"
-
+serde_json = "1.0.87"
+# tokio = {version = "0.2", features = ["full"]}
+tokio = { version = "1.21.2", features = ["full"] }
+# async-std = { verson = "1", features = ["attributes", "tokio1"] }

src/main.rs

@@ -8,53 +8,65 @@ use postcodes::*;
 use response::*;
 
 extern crate clap;
-use clap::{Arg, App, crate_version};
+use clap::{ArgAction, crate_version, Parser};
+
+#[derive(Parser)]
+#[command(
+	name = "rohe",
+	author = "Jake·W.·Ireland.·<jakewilliami@icloud.com>",
+	version = crate_version!(),
+	about = "A command line interface for NZP's locator API.",
+	long_about = "A command line interface for NZP's locator API.  The name 'rohe' is the Māori word for 'areas'.",
+)]
+struct Cli {
+	/// Takes address as input.  Default return value is the address' associated postcode
+	#[arg(
+		short = 'a',
+		long = "address",
+		action = ArgAction::Set,
+		num_args = 0..=1,
+		value_name = "address",
+	)]
+	addr: Option<String>,
+
+	/// Takes postcode as input.  Default return value is the postcode's associated region
+	#[arg(
+		short = 'p',
+		long = "postcode",
+		action = ArgAction::Set,
+		num_args = 0..=1,
+		value_name = "postcode"
+	)]
+	postcode: Option<String>,
+
+	/// Return address as (latitude, longitude)
+	#[arg(
+		short = 'c',
+		long = "coordinates",
+		action = ArgAction::Set,
+		num_args = 0..=1,
+		value_name = "address",
+	)]
+	coords: Option<String>,
+}
 
 #[tokio::main]
 async fn main() {
-    let matches = App::new("rohe")
-                      .version(crate_version!())
-                      .author("Jake W. Ireland. <jakewilliami@icloud.com>")
-                      .about("A command line interface for NZP's locator API.  The name 'rohe' is the Māori word for 'areas'.")
-							.arg(Arg::with_name("ADDR")
-								.short("a")
-								.long("address")
-								.help("Takes address as input.  Default return value is the address' associated postcode.")
-								.takes_value(true)
-								.required(false)
-								.multiple(false)
-							)
-							.arg(Arg::with_name("POSTCODE")
-								.short("p")
-								.long("postcode")
-								.help("Takes postcode as input.  Default return value is the postcode's associated region.")
-								.takes_value(true)
-								.required(false)
-								.multiple(false)
-						   	)
-							.arg(Arg::with_name("ADDR_FOR_COORDS")
-								.short("c")
-								.long("coordinates")
-								.help("Return addresses as (latitude, longitude).")
-								.takes_value(true)
-								.required(false)
-								.multiple(false)
-						   	)
-							.get_matches();
+	let cli = Cli::parse();
 
 	// Find postcode information
-	if matches.is_present("POSTCODE") {
+	if let Some(postcode_str) = cli.postcode {
 		let bad_response: &str = "There was no postcode in the database that matched your input.";
 
 		// get value of postcode
-		let postcode = matches.value_of("POSTCODE").unwrap().parse_postcode();
+		let postcode = postcode_str.parse_postcode();
 
 		// request postcodes from the API
 		let matched_postcodes: Option<Vec<EachPostcode>> = request::get_suggested_postcodes(postcode).await;
 
 		// initialise the response string
 		let mut resp = String::new();
-		if matched_postcodes.as_ref().is_none() || matched_postcodes.as_ref().unwrap().len() == 0 {
+		if matched_postcodes.as_ref().is_none() || matched_postcodes.as_ref().unwrap().is_empty() {
 			resp.push_str(bad_response);
 		} else {
 			let postcodes = &matched_postcodes.unwrap();
@@ -69,15 +81,15 @@ async fn main() {
 				let details: Option<serde_json::Map<String, serde_json::Value>> = request::get_postcode_details(*unique_id).await;
 
 				// construct the response string
-				if details.is_none() {
-					resp.push_str(bad_response);
-				} else {
+				if let Some(details) = details {
 					resp.push_str(full_partial);
 					resp.push_str(" ∈ ");
-					resp.push_str(details.unwrap()["CityTown"].as_str().unwrap());
+					resp.push_str(details["CityTown"].as_str().unwrap());
 					if i != (postcodes.len() - 1) {
-						resp.push_str("\n")
+						resp.push('\n');
 					}
+				} else {
+					resp.push_str(bad_response);
 				}
 			}
 		}
@@ -86,10 +98,14 @@ async fn main() {
 	}
 
 	// Find address information
-	if matches.is_present("ADDR") {
+	if let Some(addr) = cli.addr {
 		// get value of address
-		let addr = matches.value_of("ADDR").unwrap();
-		let resp: Option<Vec<EachAddress>> = request::get_suggested_addresses(addr.to_string()).await;
+		let resp: Option<Vec<EachAddress>> = request::get_suggested_addresses(addr).await;
 		println!("{:?}", resp);
 	}
+
+	// Get address coordinated
+	if let Some(_addr_for_coords) = cli.coords {
+		todo!();
+	}
 }

tests/tests.rs

@@ -0,0 +1,6 @@
+// https://doc.rust-lang.org/book/ch11-03-test-organization.html#the-tests-directory
+
+#[test]
+fn test() {
+	true;
+}