rubx 0.1.1

Rubx (Rust Basic Toolbox) is a library for command programs that features a toolbox with a series of basic functionalities.
Documentation
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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
use std::path::Path;

use crate::rux_debug::{dbg_call, dbg_ifis, dbg_lets, dbg_muts, dbg_reav};
use crate::rux_debug::{dbg_erro, dbg_step, dbg_tell};
use crate::RubxError;

pub fn has(path: &str) -> bool {
  dbg_call!(path);
  dbg_reav!(Path::new(path).exists())
}

pub fn is_dir(path: &str) -> bool {
  dbg_call!(path);
  dbg_reav!(Path::new(path).is_dir())
}

pub fn is_file(path: &str) -> bool {
  dbg_call!(path);
  dbg_reav!(Path::new(path).is_file())
}

pub fn is_absolute(path: &str) -> bool {
  dbg_call!(path);
  dbg_reav!(Path::new(path).is_absolute())
}

pub fn is_relative(path: &str) -> bool {
  dbg_call!(path);
  dbg_reav!(Path::new(path).is_relative())
}

pub fn is_symlink(path: &str) -> bool {
  dbg_call!(path);
  dbg_reav!(Path::new(path).is_symlink())
}

pub fn cd(path: &str) -> Result<(), RubxError> {
  dbg_call!(path);
  std::env::set_current_dir(path).map_err(|err| dbg_erro!(err, path))?;
  Ok(())
}

pub fn wd() -> Result<String, RubxError> {
  dbg_call!();
  dbg_reav!(Ok(format!(
    "{}",
    std::env::current_dir()
      .map_err(|err| dbg_erro!(err))?
      .display()
  )))
}

pub fn rn(origin: &str, destiny: &str) -> Result<(), RubxError> {
  dbg_call!(origin, destiny);
  std::fs::rename(origin, destiny).map_err(|err| dbg_erro!(err, origin, destiny))?;
  Ok(())
}

pub fn cp(origin: &str, destiny: &str) -> Result<(), RubxError> {
  dbg_call!(origin, destiny);
  let destiny = dbg_lets!(if dbg_ifis!(is_file(origin) && is_dir(destiny)) {
    path_join(destiny, path_name(origin)).map_err(|err| dbg_erro!(err, origin, destiny))?
  } else {
    destiny.to_string()
  });
  if dbg_ifis!(is_dir(origin)) {
    copy_directory(origin, &destiny).map_err(|err| dbg_erro!(err, origin, destiny))?;
  } else {
    copy_file(origin, &destiny).map_err(|err| dbg_erro!(err, origin, destiny))?;
  }
  Ok(())
}

fn copy_directory(origin: &str, destiny: &str) -> Result<(), RubxError> {
  dbg_call!(origin, destiny);
  std::fs::create_dir_all(destiny).map_err(|err| dbg_erro!(err, destiny))?;
  for entry in std::fs::read_dir(origin).map_err(|err| dbg_erro!(err, origin))? {
    let entry = entry.map_err(|err| dbg_erro!(err))?;
    let file_type = entry.file_type().map_err(|err| dbg_erro!(err))?;
    let entry_str = format!("{}", entry.path().display());
    let entry_name = path_name(&entry_str);
    let entry_dest =
      path_join(&destiny, &entry_name).map_err(|err| dbg_erro!(err, destiny, entry_name))?;
    if file_type.is_dir() {
      copy_directory(&entry_str, &entry_dest)
        .map_err(|err| dbg_erro!(err, entry_str, entry_dest))?;
    } else {
      std::fs::copy(&entry_str, &entry_dest)
        .map_err(|err| dbg_erro!(err, entry_str, entry_dest))?;
    }
  }
  Ok(())
}

fn copy_file(origin: &str, destiny: &str) -> Result<(), RubxError> {
  dbg_call!(origin, destiny);
  let parent = path_parent(destiny).map_err(|err| dbg_erro!(err, destiny))?;
  std::fs::create_dir_all(&parent).map_err(|err| dbg_erro!(err, parent))?;
  std::fs::copy(origin, destiny).map_err(|err| dbg_erro!(err, origin, destiny))?;
  Ok(())
}

pub fn cp_tmp(origin: &str, destiny: &str) -> Result<(), RubxError> {
  dbg_call!(origin, destiny);
  if has(destiny) {
    let file_name = path_name(destiny);
    let mut file_name = String::from(file_name);
    let mut destiny_tmp = std::env::temp_dir().join(&file_name);
    while destiny_tmp.exists() {
      file_name.push_str("_");
      destiny_tmp = std::env::temp_dir().join(&file_name);
    }
    let destiny_tmp = format!("{}", destiny_tmp.display());
    cp(destiny, &destiny_tmp).map_err(|err| dbg_erro!(err, destiny, destiny_tmp))?;
    rm(destiny).map_err(|err| dbg_erro!(err, destiny))?;
  }
  cp(origin, destiny).map_err(|err| dbg_erro!(err, origin, destiny))?;
  Ok(())
}

pub fn mv(origin: &str, destiny: &str) -> Result<(), RubxError> {
  dbg_call!(origin, destiny);
  cp(origin, destiny).map_err(|err| dbg_erro!(err, origin, destiny))?;
  rm(origin).map_err(|err| dbg_erro!(err, origin))?;
  Ok(())
}

pub fn rm(path: &str) -> Result<(), RubxError> {
  dbg_call!(path);
  if !has(path) {
    return Ok(());
  }
  if is_dir(path) {
    std::fs::remove_dir_all(path).map_err(|err| dbg_erro!(err))?;
  } else {
    std::fs::remove_file(path).map_err(|err| dbg_erro!(err))?;
  }
  Ok(())
}

pub fn mkdir(path: &str) -> Result<(), RubxError> {
  dbg_call!(path);
  std::fs::create_dir_all(path).map_err(|err| dbg_erro!(err))?;
  Ok(())
}

pub fn touch(path: &str) -> Result<(), RubxError> {
  dbg_call!(path);
  std::fs::OpenOptions::new()
    .create(true)
    .write(true)
    .open(path)
    .map_err(|err| dbg_erro!(err))?;
  Ok(())
}

pub fn os_sep() -> &'static char {
  dbg_call!();
  &std::path::MAIN_SEPARATOR
}

pub fn path_sep(path: &str) -> &'static str {
  dbg_call!(path);
  if path.contains("\\") {
    "\\"
  } else {
    "/"
  }
}

pub fn path_parts(path: &str) -> Vec<&str> {
  dbg_call!(path);
  let sep = path_sep(path);
  let mut result: Vec<&str> = path.split(sep).collect();
  if !result.is_empty() {
    if result[0].is_empty() {
      dbg_muts!(result[0], sep);
    }
  }
  result
}

pub fn path_parts_join(parts: &[&str]) -> String {
  dbg_call!(parts);
  if parts.is_empty() {
    return String::default();
  }
  if parts.len() == 1 {
    return String::from(parts[0]);
  }
  let mut result = String::new();
  let mut start = 1;

  let end = parts.len();
  if parts[0] == "/" {
    result.push('/');
    if end > 1 {
      result.push_str(parts[1].as_ref());
      start = 2;
    }
  } else {
    result.push_str(parts[0].as_ref());
  }
  let os_sep = if parts[0].contains(":") {
    '\\'
  } else if parts[0] == "/" {
    '/'
  } else {
    *os_sep()
  };
  for index in start..end {
    result.push(os_sep);
    result.push_str(parts[index].as_ref());
  }
  result
}

pub fn path_name(path: &str) -> &str {
  dbg_call!(path);
  let parts = path_parts(path);
  if parts.len() > 0 {
    let last_part = parts[parts.len() - 1];
    return last_part;
  }
  ""
}

pub fn path_stem(path: &str) -> &str {
  dbg_call!(path);
  let parts = path_parts(path);
  if parts.len() > 0 {
    let last_part = parts[parts.len() - 1];
    if let Some(last_dot) = last_part.rfind(".") {
      return &last_part[0..last_dot];
    }
  }
  ""
}

pub fn path_ext(path: &str) -> &str {
  dbg_call!(path);
  let parts = path_parts(path);
  if parts.len() > 0 {
    let last_part = parts[parts.len() - 1];
    if let Some(last_dot) = last_part.rfind(".") {
      return &last_part[last_dot..];
    }
  }
  ""
}

pub fn path_ext_is(path: &str, ext: &str) -> bool {
  dbg_call!(path, ext);
  path_ext(path).to_lowercase() == ext.to_lowercase()
}

pub fn path_ext_is_on(path: &str, exts: Vec<String>) -> bool {
  dbg_step!(path, exts);
  let ext = path_ext(path).to_lowercase();
  for case in exts {
    if ext == case.to_lowercase() {
      return true;
    }
  }
  false
}

pub fn path_absolute(path: &str) -> Result<String, RubxError> {
  dbg_call!(path);
  if is_absolute(path) {
    return Ok(String::from(path));
  }
  let working_dir = wd().map_err(|err| dbg_erro!(err))?;
  let mut base_parts = path_parts(&working_dir);
  let path_parts = path_parts(&path);
  for path_part in path_parts {
    if path_part == "." {
      continue;
    } else if path_part == ".." {
      if base_parts.pop().is_none() {
        return Err(dbg_erro!("The base path went empty", path));
      }
    } else {
      base_parts.push(path_part);
    }
  }
  Ok(path_parts_join(base_parts.as_slice()))
}

pub fn path_relative(path: &str, base: &str) -> Result<String, RubxError> {
  dbg_call!(path, base);
  if !is_absolute(path) {
    return Ok(String::from(path));
  }
  let base = if !is_absolute(base) {
    path_absolute(base).map_err(|err| dbg_erro!(err))?
  } else {
    String::from(base)
  };
  if !path.starts_with(&base) {
    return Err(dbg_erro!("The path must starts with the base", path, base));
  }
  let sep = path_sep(path);
  let result = &path[base.len()..];
  if result.starts_with(sep) {
    Ok(format!(".{}", result))
  } else {
    Ok(String::from(result))
  }
}

pub fn path_walk(path: &str) -> Result<String, RubxError> {
  dbg_call!(path);
  Ok(format!(
    "{}",
    std::fs::read_link(path)
      .map_err(|err| dbg_erro!(err, path))?
      .display(),
  ))
}

pub fn path_parent(path: &str) -> Result<String, RubxError> {
  dbg_call!(path);
  let path = path_absolute(path).map_err(|err| dbg_erro!(err))?;
  let mut parts = path_parts(&path);
  if parts.pop().is_none() {
    return Err(dbg_erro!("The path parts went empty", path));
  }
  Ok(path_parts_join(parts.as_slice()))
}

pub fn path_parent_find(path: &str, with_name: &str) -> Result<String, RubxError> {
  dbg_call!(path, with_name);
  let path = path_absolute(path).map_err(|err| dbg_erro!(err))?;
  let mut parts = path_parts(&path);
  loop {
    if let Some(part) = parts.pop() {
      if part == with_name {
        parts.push(part);
        return Ok(path_parts_join(parts.as_slice()));
      }
    } else {
      return Err(dbg_erro!("The path parts went empty", path));
    }
  }
}

pub fn path_join(path: &str, child: &str) -> Result<String, RubxError> {
  dbg_call!(path, child);
  if child.is_empty() {
    return Ok(String::from(path));
  }
  if is_absolute(child) {
    return Err(dbg_erro!("The child must be relative", child));
  }
  let mut base_parts = path_parts(path)
    .into_iter()
    .map(String::from)
    .collect::<Vec<String>>();
  let inital_size = base_parts.len();
  let has_more = !is_absolute(path);
  let mut take_more = false;
  let child_parts = path_parts(child);
  let mut child_index = 0;
  loop {
    if child_index >= child_parts.len() {
      break;
    }
    let part = child_parts[child_index];
    child_index = child_index + 1;
    if part == "." {
      continue;
    } else if part == ".." {
      if base_parts.pop().is_none() {
        if !take_more && has_more {
          let abs_path = path_absolute(path).map_err(|err| dbg_erro!(err))?;
          let abs_parts = path_parts(&abs_path);
          let dif_parts = abs_parts.len() - inital_size;
          for new_index in 0..dif_parts {
            base_parts.insert(new_index, abs_parts[new_index].into());
          }
          take_more = true;
          child_index = child_index - 1;
        } else {
          return Err(dbg_erro!("The path parts went empty", path, child));
        }
      }
    } else {
      base_parts.push(part.into());
    }
  }
  Ok(path_parts_join(
    base_parts
      .iter()
      .map(|p| p.as_ref())
      .collect::<Vec<&str>>()
      .as_slice(),
  ))
}

pub fn path_join_if_relative(base: &str, path: &str) -> Result<String, RubxError> {
  dbg_call!(base, path);
  if path.is_empty() {
    Ok(String::from(base))
  } else if is_relative(path) {
    path_join(base, path)
  } else {
    Ok(path.into())
  }
}

pub fn path_list(path: &str) -> Result<Vec<String>, RubxError> {
  dbg_call!(path);
  let mut results = Vec::new();
  let entries = std::fs::read_dir(path).map_err(|err| dbg_erro!(err))?;
  for entry in entries {
    let entry = entry.map_err(|err| dbg_erro!(err))?;
    results.push(format!("{}", entry.path().display()));
  }
  Ok(results)
}

pub fn path_list_in(path: &str) -> Result<Vec<String>, RubxError> {
  dbg_call!(path);
  let mut results = Vec::new();
  path_list_in_make(path, &mut results).map_err(|err| dbg_erro!(err))?;
  Ok(results)
}

fn path_list_in_make(path: &str, results: &mut Vec<String>) -> Result<(), RubxError> {
  for entry in std::fs::read_dir(path).map_err(|err| dbg_erro!(err))? {
    let entry = entry.map_err(|err| dbg_erro!(err))?;
    let file_type = entry.file_type().map_err(|err| dbg_erro!(err))?;
    let inside = format!("{}", entry.path().display());
    if file_type.is_dir() {
      path_list_in_make(&inside, results).map_err(|err| dbg_erro!(err))?;
    }
    results.push(inside);
  }
  Ok(())
}

pub fn path_list_dirs(path: &str) -> Result<Vec<String>, RubxError> {
  dbg_call!(path);
  let mut results = Vec::new();
  let entries = std::fs::read_dir(path).map_err(|err| dbg_erro!(err))?;
  for entry in entries {
    let entry = entry.map_err(|err| dbg_erro!(err))?;
    let file_type = entry.file_type().map_err(|err| dbg_erro!(err))?;
    if file_type.is_dir() {
      results.push(format!("{}", entry.path().display()));
    }
  }
  Ok(results)
}

pub fn path_list_dirs_in(path: &str) -> Result<Vec<String>, RubxError> {
  dbg_call!(path);
  let mut results = Vec::new();
  path_list_dirs_in_make(path, &mut results).map_err(|err| dbg_erro!(err))?;
  return Ok(results);
}

fn path_list_dirs_in_make(path: &str, results: &mut Vec<String>) -> Result<(), RubxError> {
  for entry in std::fs::read_dir(path).map_err(|err| dbg_erro!(err))? {
    let entry = entry.map_err(|err| dbg_erro!(err))?;
    let file_type = entry.file_type().map_err(|err| dbg_erro!(err))?;
    if file_type.is_dir() {
      let inside = format!("{}", entry.path().display());
      path_list_dirs_in_make(&inside, results).map_err(|err| dbg_erro!(err))?;
      results.push(inside);
    }
  }
  Ok(())
}

pub fn path_list_files(path: &str) -> Result<Vec<String>, RubxError> {
  dbg_call!(path);
  let mut results = Vec::new();
  let entries = std::fs::read_dir(path).map_err(|err| dbg_erro!(err))?;
  for entry in entries {
    let entry = entry.map_err(|err| dbg_erro!(err))?;
    let file_type = entry.file_type().map_err(|err| dbg_erro!(err))?;
    if file_type.is_file() {
      results.push(format!("{}", entry.path().display()));
    }
  }
  Ok(results)
}

pub fn path_list_files_in(path: &str) -> Result<Vec<String>, RubxError> {
  dbg_call!(path);
  let mut results = Vec::new();
  path_list_files_in_make(path, &mut results).map_err(|err| dbg_erro!(err))?;
  Ok(results)
}

fn path_list_files_in_make(path: &str, results: &mut Vec<String>) -> Result<(), RubxError> {
  for entry in std::fs::read_dir(path).map_err(|err| dbg_erro!(err))? {
    let entry = entry.map_err(|err| dbg_erro!(err))?;
    let file_type = entry.file_type().map_err(|err| dbg_erro!(err))?;
    let inside = format!("{}", entry.path().display());
    if file_type.is_dir() {
      path_list_files_in_make(&inside, results).map_err(|err| dbg_erro!(err))?;
    }
    if file_type.is_file() {
      results.push(inside);
    }
  }
  Ok(())
}

pub fn path_list_files_ext(path: &str, ext: &str) -> Result<Vec<String>, RubxError> {
  dbg_call!(path, ext);
  let mut results = Vec::new();
  let entries = std::fs::read_dir(path).map_err(|err| dbg_erro!(err))?;
  for entry in entries {
    let entry = entry.map_err(|err| dbg_erro!(err))?;
    let file_type = entry.file_type().map_err(|err| dbg_erro!(err))?;
    if file_type.is_file() {
      let name = format!("{}", entry.path().display());
      if name.to_lowercase().ends_with(&ext.to_lowercase()) {
        results.push(name);
      }
    }
  }
  Ok(results)
}

pub fn path_list_files_ext_in(path: &str, ext: &str) -> Result<Vec<String>, RubxError> {
  dbg_call!(path, ext);
  let mut results = Vec::new();
  path_list_files_ext_in_make(path, ext, &mut results).map_err(|err| dbg_erro!(err))?;
  Ok(results)
}

fn path_list_files_ext_in_make(
  path: &str,
  ext: &str,
  results: &mut Vec<String>,
) -> Result<(), RubxError> {
  for entry in std::fs::read_dir(path).map_err(|err| dbg_erro!(err))? {
    let entry = entry.map_err(|err| dbg_erro!(err))?;
    let file_type = entry.file_type().map_err(|err| dbg_erro!(err))?;
    let inside = format!("{}", entry.path().display());
    if file_type.is_dir() {
      path_list_files_ext_in_make(&inside, ext, results).map_err(|err| dbg_erro!(err))?;
    }
    if file_type.is_file() {
      if inside.to_lowercase().ends_with(&ext.to_lowercase()) {
        results.push(inside);
      }
    }
  }
  Ok(())
}

pub fn path_list_files_exts(path: &str, exts: &[&str]) -> Result<Vec<String>, RubxError> {
  dbg_call!(path, exts);
  let mut results = Vec::new();
  let entries = std::fs::read_dir(path).map_err(|err| dbg_erro!(err))?;
  for entry in entries {
    let entry = entry.map_err(|err| dbg_erro!(err))?;
    let file_type = entry.file_type().map_err(|err| dbg_erro!(err))?;
    if file_type.is_file() {
      let name = format!("{}", entry.path().display());
      for ext in exts {
        if name.to_lowercase().ends_with(&ext.to_lowercase()) {
          results.push(name);
          break;
        }
      }
    }
  }
  Ok(results)
}

pub fn path_list_files_exts_in(path: &str, exts: &[&str]) -> Result<Vec<String>, RubxError> {
  dbg_call!(path, exts);
  let mut results = Vec::new();
  path_list_files_exts_in_make(path, exts, &mut results).map_err(|err| dbg_erro!(err))?;
  Ok(results)
}

fn path_list_files_exts_in_make(
  path: &str,
  exts: &[&str],
  results: &mut Vec<String>,
) -> Result<(), RubxError> {
  for entry in std::fs::read_dir(path).map_err(|err| dbg_erro!(err))? {
    let entry = entry.map_err(|err| dbg_erro!(err))?;
    let file_type = entry.file_type().map_err(|err| dbg_erro!(err))?;
    let inside = format!("{}", entry.path().display());
    if file_type.is_dir() {
      path_list_files_exts_in_make(&inside, exts, results).map_err(|err| dbg_erro!(err))?;
    }
    if file_type.is_file() {
      let name = inside.to_lowercase();
      for ext in exts {
        if name.ends_with(&ext.to_lowercase()) {
          results.push(inside);
          break;
        }
      }
    }
  }
  Ok(())
}

pub fn path_env() -> Result<String, RubxError> {
  dbg_call!();
  let env_path = std::env::var("PATH").map_err(|err| dbg_erro!(err))?;
  dbg_reav!(Ok(env_path))
}

pub fn path_env_dirs() -> Result<Vec<String>, RubxError> {
  dbg_call!();
  let mut results = Vec::new();
  let env_path = std::env::var("PATH").map_err(|err| dbg_erro!(err))?;
  dbg_step!(env_path);
  let paths = env_path.split(if crate::rux_fires::is_win() { ';' } else { ':' });
  for path in paths {
    let path = path.to_string();
    dbg_tell!(path);
    results.push(path);
  }
  dbg_reav!(Ok(results))
}