1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
use std::path::PathBuf;
use crate::utils::utils::{
lines_from_file, parse_comma_separated, some_kind_of_uppercase_first_letter,
};
use crate::{IndexType, GOAT_URL, TAXONOMY, UPPER_CLI_FILE_LIMIT};
use anyhow::{bail, Result};
/// The lookup struct
#[derive(Clone, Debug)]
pub struct Lookup {
/// the users search
pub search: String,
/// The size for each search (default = 10)
pub size: u64,
/// The index type, currently taxon or
/// assembly
pub index_type: IndexType,
}
impl Lookup {
/// From our lookup struct we can make an individual URL.
pub fn make_url(&self) -> String {
let mut url = String::new();
// add the base
url += &GOAT_URL;
// add lookup
url += "lookup?";
// add the search term
let search_term = format!("searchTerm={}", self.search);
url += &search_term;
// add size
let size = format!("&size={}", self.size);
url += &size;
// hardcode the rest for now
url += &format!("&result={}&taxonomy={}", self.index_type, &*TAXONOMY);
url
}
}
/// A vector of [`Lookup`] structs.
#[derive(Debug)]
pub struct Lookups {
/// The entries in [`Lookups`].
pub entries: Vec<Lookup>,
}
// throw warnings if there are no hits
impl Lookups {
/// Constructor which takes the CLI args and returns
/// `Self`.
pub fn new(matches: &clap::ArgMatches, index_type: IndexType) -> Result<Self> {
let tax_name_op = matches.get_one::<String>("taxon");
let filename_op = matches.get_one::<PathBuf>("file");
// safe to unwrap, as default is defined.
let no_hits = *matches.get_one::<u64>("size").expect("cli default = 10");
let tax_name_vector: Vec<String>;
match tax_name_op {
Some(s) => tax_name_vector = parse_comma_separated(s),
None => match filename_op {
Some(s) => {
tax_name_vector = lines_from_file(s)?;
// check length of vector and bail if > 1000
if tax_name_vector.len() > *UPPER_CLI_FILE_LIMIT {
bail!(
"Number of taxa specified cannot exceed {}.",
*UPPER_CLI_FILE_LIMIT
)
}
}
None => bail!("One of -f (--file) or -t (--taxon) should be specified."),
},
}
let mut res = Vec::new();
for el in tax_name_vector {
res.push(Lookup {
search: el,
size: no_hits,
index_type,
})
}
Ok(Self { entries: res })
}
// make urls, these are slightly different, and simpler than those
// made for the main search program
/// Make URLs calls [`Lookup::make_url`] on each element.
pub fn make_urls(&self) -> Vec<(String, String)> {
let mut url_vector = Vec::new();
for el in &self.entries {
let id = el.search.clone();
url_vector.push((el.make_url(), id));
}
url_vector
}
}
/// Took this out of `print_result` as
fn format_suggestion_string(suggestions: &Vec<Option<String>>) -> Result<()> {
let mut suggestion_str = String::new();
for el in suggestions {
match el {
Some(s) => {
suggestion_str += &some_kind_of_uppercase_first_letter(&s[..]);
suggestion_str += ", ";
}
None => {}
}
}
// remove last comma
if suggestion_str.len() > 2 {
suggestion_str.drain(suggestion_str.len() - 2..);
bail!("Did you mean: {}?", suggestion_str)
} else {
bail!("There are no results.")
}
}
/// Collect the results from concurrent `goat-cli taxon lookup`
/// queries.
#[derive(Clone)]
pub struct TaxonCollector {
/// User search value.
pub search: Option<String>,
/// The taxon id that we fetch.
/// Can return multiple taxon id's.
pub taxon_id: Vec<Option<String>>,
/// The taxon rank.
pub taxon_rank: Vec<Option<String>>,
/// A vector of optional taxon names.
///
/// Decomposed this is a vector of Some vector of a
/// two-element tuple:
/// - The name of the taxon
/// - The class of the taxon name
pub taxon_names: Vec<Option<Vec<(String, String)>>>,
/// The suggestions vector.
pub suggestions: Option<Vec<Option<String>>>,
}
impl TaxonCollector {
/// Print the result from a collector struct.
/// add an index, so we don't repeat headers
pub fn print_result(&self, index: usize) -> Result<()> {
// if we got a hit
match &self.search {
Some(search) => {
// if we got a suggestion
match &self.suggestions {
// we end up here even if there are no *actual* suggestions.
Some(suggestions) => format_suggestion_string(suggestions),
// no suggestion, so we got a hit
None => {
// Vec<Option<String>> -> Option<Vec<String>>
// these vecs should all be the same length?
let taxon_id = self.taxon_id.clone();
let taxon_rank = self.taxon_rank.clone();
let taxon_names = self.taxon_names.clone();
let taxon_ids_op: Option<Vec<String>> = taxon_id.into_iter().collect();
let taxon_ranks_op: Option<Vec<String>> = taxon_rank.into_iter().collect();
// same but for nested vec.
let taxon_names_op: Option<Vec<Vec<(String, String)>>> =
taxon_names.into_iter().collect();
// print headers for first result only.
if index == 0 {
println!("taxon\trank\tsearch_query\tname\ttype");
}
match taxon_names_op {
Some(n) => {
// get taxon_ids and taxon_ranks
let taxon_ids = match taxon_ids_op {
Some(t) => t,
// empty vec
None => vec![],
};
let taxon_ranks = match taxon_ranks_op {
Some(t) => t,
// empty vec
None => vec![],
};
// zip these vectors together
let zipped_taxon_vectors =
taxon_ids.iter().zip(taxon_ranks.iter()).zip(n.iter());
// this may not be the best way to print
// as everything has to be loaded into mem
// however, each result string should be small.
let mut whole_res_string = String::new();
for ((taxon_id, taxon_rank), taxon_ranks) in zipped_taxon_vectors {
for el in taxon_ranks {
let row = format!(
"{}\t{}\t{}\t{}\t{}\n",
taxon_id, taxon_rank, search, el.0, el.1
);
whole_res_string += &row;
}
}
// remove trailing newline
whole_res_string.pop();
Ok(println!("{}", whole_res_string))
}
None => bail!("There were no taxon names."),
}
}
}
}
None => bail!("No results."),
}
}
}
/// Collect the results from concurrent `goat-cli taxon lookup`
/// queries.
#[derive(Clone)]
pub struct AssemblyCollector {
/// User search value.
pub search: Option<String>,
/// The taxon id that we fetch.
/// Can return multiple taxon id's.
pub taxon_id: Vec<Option<String>>,
/// The identifiers, which is an enumeration of all
/// of the identifier:class pairs. This could be a Map.
pub identifiers: Vec<Option<Vec<(String, String)>>>,
/// The suggestions vector.
pub suggestions: Option<Vec<Option<String>>>,
}
impl AssemblyCollector {
/// Print the result from a collector struct.
/// add an index, so we don't repeat headers
pub fn print_result(&self, index: usize) -> Result<()> {
// if we got a hit
match &self.search {
Some(search) => {
// if we got a suggestion
match &self.suggestions {
// we end up here even if there are no *actual* suggestions.
Some(suggestions) => format_suggestion_string(suggestions),
// no suggestion, so we got a hit
None => {
// Vec<Option<String>> -> Option<Vec<String>>
// these vecs should all be the same length?
let taxon_id = self.taxon_id.clone();
let assembly_identifiers = self.identifiers.clone();
let taxon_ids_op: Option<Vec<String>> = taxon_id.into_iter().collect();
// same but for nested vec.
let assembly_identifiers_op: Option<Vec<Vec<(String, String)>>> =
assembly_identifiers.into_iter().collect();
// print headers for first result only.
if index == 0 {
println!("taxon\tsearch_query\tidentifier\ttype");
}
match assembly_identifiers_op {
Some(n) => {
// get taxon_ids and taxon_ranks
let taxon_ids = match taxon_ids_op {
Some(t) => t,
// empty vec
None => vec![],
};
// zip these vectors together
let zipped_taxon_vectors = taxon_ids.iter().zip(n.iter());
// this may not be the best way to print
// as everything has to be loaded into mem
// however, each result string should be small.
let mut whole_res_string = String::new();
for (taxon_id, taxon_ranks) in zipped_taxon_vectors {
for el in taxon_ranks {
let row = format!(
"{}\t{}\t{}\t{}\n",
taxon_id, search, el.0, el.1
);
whole_res_string += &row;
}
}
// remove trailing newline
whole_res_string.pop();
Ok(println!("{}", whole_res_string))
}
None => bail!("There were no taxon names."),
}
}
}
}
None => bail!("No results."),
}
}
}
/// A wrapper so we can return the same from our request.
/// Otherwise I am going to have to do extensive changes above
/// which I decided against.
pub enum Collector {
/// The taxon results.
Taxon(Result<TaxonCollector>),
/// The assembly results.
Assembly(Result<AssemblyCollector>),
}