mirror/ crowbook
1
0
Fork 0
mirror of https://github.com/lise-henry/crowbook synced 2024-05-28 05:46:23 +02:00
Code Issues

Add progress bar to single format rendering too

This commit is contained in:
Elisabeth Henry 2017-10-06 00:09:24 +02:00
parent e57332c520
commit 7292620ba2
2 changed files with 102 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/bin/real_main.rs
View File

@ -30,7 +30,7 @@ use std::fs::File;
use simplelog::{Config, TermLogger, LogLevel, LogLevelFilter, SimpleLogger, WriteLogger};
/// Render a book to specific format
fn render_format(book: &mut Book, matches: &ArgMatches, format: &str) -> ! {
fn render_format(book: &mut Book, matches: &ArgMatches, format: &str) {
let mut key = String::from("output.");
key.push_str(format);
@ -49,7 +49,7 @@ fn render_format(book: &mut Book, matches: &ArgMatches, format: &str) -> ! {
let result = match(file, res, stdout) {
(Some(file), _, _) |
(None, Ok(file), false) => book.render_format_to_file(format, file, None),
(None, Ok(file), false) => book.render_format_to_file(format, file),
(None, Err(_), _) |
(None, _, true)
@ -57,10 +57,8 @@ fn render_format(book: &mut Book, matches: &ArgMatches, format: &str) -> ! {
};
match result {
Err(err) => print_error_and_exit(&format!("{}", err)),
Ok(_) => {
exit(0);
}
Err(err) => print_error(&format!("{}", err)),
Ok(_) => {}
}
}
@ -186,10 +184,10 @@ pub fn try_main() -> Result<()> {
match res {
Ok(..) => {},
Err(err) => {
book.set_error(&format!("{}", err));
return Err(err);
}
Err(err) => {
book.set_error(&format!("{}", err));
return Err(err);
}
}
}

139
src/lib/book.rs
View File

@ -219,7 +219,7 @@ impl Book {
}
/// Sets an error message to the progress bar, if it is set
pub fn set_error(&mut self, msg: &str) {
pub fn set_error(&self, msg: &str) {
if let Some(ref mainbar) = self.mainbar {
let sty = ProgressStyle::default_spinner()
.tick_chars("/|\\-X")
@ -228,6 +228,18 @@ impl Book {
mainbar.set_message(msg);
}
}
/// Sets a finished message to the progress bar, if it is set
pub fn set_finished(&self, msg: &str) {
if let Some(ref bar) = self.mainbar {
let sty = ProgressStyle::default_spinner()
.tick_chars("/|\\-V")
.template("{spinner:.dim.bold.cyan} {wide_msg}");
bar.set_style(sty);
bar.set_message(msg);
}
}
/// Adds a progress bar where where info should be written.
@ -770,25 +782,13 @@ impl Book {
if let Some(bar) = bar {
bar.set_message(&lformat!("rendering..."));
}
let result = self.render_format_to_file(format, path, bar);
let result = self.render_format_to_file_with_bar(format, path, bar);
if let Err(err) = result {
if let Some(bar) = bar {
bar.set_style(ProgressStyle::default_spinner()
.tick_chars("/|\\-X")
.template(&format!("{{spinner:.dim.bold.red}} {format}: {{wide_msg:.red}}",
format = format)));
bar.finish_with_message(&format!("{}", err));
self.finish_spinner_error(bar, format, &format!("{}", err));
}
error!("{}", lformat!("Error rendering {name}: {error}", name = format, error = err));
}
} else {
if let Some(bar) = bar {
bar.set_style(ProgressStyle::default_spinner()
.tick_chars("/|\\- ")
.template(&format!("{{spinner:.dim.bold.cyan}} {format}: {{wide_msg:.cyan}}",
format = format)));
bar.finish_with_message(&lformat!("skipped"));
}
}
}
@ -853,20 +853,8 @@ impl Book {
let mut bars = vec![];
if let Some(ref multibar) = self.multibar {
if let Some(ref mainbar) = self.mainbar {
mainbar.set_message(&lformat!("Rendering..."));
}
for key in &keys {
let bar = multibar.add(ProgressBar::new_spinner());
let sty = ProgressStyle::default_spinner()
.tick_chars("/|\\-X")
.template(&format!("{{spinner:.dim.bold.yellow}} {format}: {{wide_msg:.yellow}}",
format = key));
bar.set_style(sty);
bar.enable_steady_tick(200);
bar.set_message(&lformat!("waiting..."));
bar.tick();
let bar = self.add_spinner_to_multibar(multibar, key);
bars.push(bar);
}
}
@ -881,13 +869,7 @@ impl Book {
}
});
if let Some(ref bar) = self.mainbar {
let sty = ProgressStyle::default_spinner()
.tick_chars("/|\\-V")
.template("{spinner:.dim.bold.cyan} {wide_msg}");
bar.set_style(sty);
bar.set_message(&lformat!("Finished"));
}
self.set_finished(&lformat!("Finished"));
// if handles.is_empty() {
// Logger::display_warning(lformat!("Crowbook generated no file because no output file was \
@ -912,7 +894,17 @@ impl Book {
format = format));
match self.formats.get(format) {
Some(&(ref description, ref renderer)) => {
renderer.render(self, f)?;
if let Some(ref multibar) = self.multibar {
let bar = self.add_spinner_to_multibar(multibar, format);
renderer.render(self, f)?;
self.finish_spinner_success(&bar,
format,
&lformat!("generated {format}",
format = format));
self.set_finished(&lformat!("Finished"));
} else {
renderer.render(self, f)?;
}
info!("{}", lformat!("Succesfully generated {format}",
format = description));
Ok(())
@ -941,10 +933,31 @@ impl Book {
/// * `render_format_to`, which writes in any `Write`able object.
/// * `render_format`, which won't do anything if `output.{format}` isn't specified
/// in the book configuration file.
pub fn render_format_to_file<P:Into<PathBuf>>(&self,
format: &str,
path: P,
bar: Option<&ProgressBar>) -> Result<()> {
path: P) -> Result<()> {
if let Some(ref multibar) = self.multibar {
let bar = self.add_spinner_to_multibar(multibar, format);
let path = path.into();
let normalized = misc::normalize(&path);
self.render_format_to_file_with_bar(format, path, Some(&bar))?;
self.finish_spinner_success(&bar,
format,
&lformat!("generated {path}",
path = normalized));
self.set_finished(&lformat!("Finished"));
Ok(())
} else {
self.render_format_to_file_with_bar(format, path, None)
}
}
fn render_format_to_file_with_bar<P:Into<PathBuf>>(&self,
format: &str,
path: P,
bar: Option<&ProgressBar>) -> Result<()> {
debug!("{}", lformat!("Attempting to generate {format}...",
format = format));
let path = path.into();
@ -975,13 +988,10 @@ impl Book {
path = &path);
info!("{}", &msg);
if let Some(bar) = bar {
let sty = ProgressStyle::default_spinner()
.tick_chars("/|\\-V")
.template(&format!("{{spinner:.dim.bold.cyan}} {format}: {{wide_msg:.cyan}}",
format = format));
bar.set_style(sty);
bar.finish_with_message(&lformat!("generated {path}",
path = path));
self.finish_spinner_success(bar,
format,
&lformat!("generated {path}",
path = path));
}
Ok(())
},
@ -1555,6 +1565,43 @@ impl Book {
self.cleaner = Box::new(Off);
}
}
/// Adds a spinner labeled key to the multibar, and set mainbar to "rendering"
fn add_spinner_to_multibar(&self, multibar: &MultiProgress, key: &str) -> ProgressBar {
if let Some(ref mainbar) = self.mainbar {
mainbar.set_message(&lformat!("Rendering..."));
}
let bar = multibar.add(ProgressBar::new_spinner());
let sty = ProgressStyle::default_spinner()
.tick_chars("/|\\-X")
.template(&format!("{{spinner:.dim.bold.yellow}} {format}: {{wide_msg:.yellow}}",
format = key));
bar.set_style(sty);
bar.enable_steady_tick(200);
bar.set_message(&lformat!("waiting..."));
bar.tick();
bar
}
// Finish a spinner with an error message
fn finish_spinner_error(&self, bar: &ProgressBar, key: &str, msg: &str) {
bar.set_style(ProgressStyle::default_spinner()
.tick_chars("/|\\-X")
.template(&format!("{{spinner:.dim.bold.red}} {format}: {{wide_msg:.red}}",
format = key)));
bar.finish_with_message(msg);
}
// Finish a spinner with success message
fn finish_spinner_success(&self, bar: &ProgressBar, key: &str, msg: &str) {
let sty = ProgressStyle::default_spinner()
.tick_chars("/|\\-V")
.template(&format!("{{spinner:.dim.bold.cyan}} {format}: {{wide_msg:.cyan}}",
format = key));
bar.set_style(sty);
bar.finish_with_message(msg);
}
}
@ -1570,6 +1617,8 @@ impl Drop for Book {
}
}
/// Calls mustache::compile_str but catches panics and returns a result
pub fn compile_str<O>(template: &str, source: O, template_name: &str) -> Result<mustache::Template>
where O: Into<Source>