diff options
author | Sascha Grunert <mail@saschagrunert.de> | 2016-11-16 15:15:49 +0100 |
---|---|---|
committer | Sascha Grunert <mail@saschagrunert.de> | 2016-11-16 15:15:49 +0100 |
commit | 965e33ebe80791ea788714933e78ab4dfff8a815 (patch) | |
tree | 08f58d514eb5eb6b074dacbf2bd92b8815a7ac77 | |
parent | 19b93b6ad333536e8e66cb8e71ceda2f129a5025 (diff) |
Improved function name handling
-rw-r--r-- | src/config.rs | 4 | ||||
-rw-r--r-- | src/errors.rs | 6 | ||||
-rw-r--r-- | src/lib.rs | 4 | ||||
-rw-r--r-- | src/logger.rs | 4 | ||||
-rw-r--r-- | src/main.rs | 16 | ||||
-rw-r--r-- | src/parser.rs | 10 |
6 files changed, 22 insertions, 22 deletions
diff --git a/src/config.rs b/src/config.rs index da641de..79208f9 100644 --- a/src/config.rs +++ b/src/config.rs @@ -9,7 +9,7 @@ use std::fs::File; use std::path::PathBuf; use std::io::prelude::*; -use errors::{GitJournalResult, internal_error}; +use errors::{GitJournalResult, error}; /// The configuration structure for git-journal. #[derive(Default, Debug, Clone, PartialEq, RustcEncodable, RustcDecodable)] @@ -96,7 +96,7 @@ impl Config { let toml_string = encode_str(&Value::Table(encoder.toml)); let path_buf = self.get_path_with_filename(path); - let path_string = path_buf.to_str().ok_or(internal_error("IO", "Cannot convert path to string"))?; + let path_string = path_buf.to_str().ok_or(error("IO", "Cannot convert path to string"))?; let mut file = File::create(&path_buf)?; file.write_all(toml_string.as_bytes())?; diff --git a/src/errors.rs b/src/errors.rs index 303658b..473ab7a 100644 --- a/src/errors.rs +++ b/src/errors.rs @@ -43,7 +43,7 @@ impl Error for GitJournalError { } /// Raise an internal error -pub fn internal_error(error: &str, detail: &str) -> Box<Error> { +pub fn error(error: &str, detail: &str) -> Box<Error> { Box::new(GitJournalError { description: error.to_string(), detail: Some(detail.to_string()), @@ -51,7 +51,7 @@ pub fn internal_error(error: &str, detail: &str) -> Box<Error> { }) } -pub fn internal(error: &fmt::Display) -> Box<Error> { +pub fn bail(error: &fmt::Display) -> Box<Error> { Box::new(GitJournalError { description: error.to_string(), detail: None, @@ -61,6 +61,6 @@ pub fn internal(error: &fmt::Display) -> Box<Error> { macro_rules! bail { ($($fmt:tt)*) => ( - return Err(::errors::internal(&format_args!($($fmt)*))) + return Err(::errors::bail(&format_args!($($fmt)*))) ) } @@ -52,7 +52,7 @@ use rayon::prelude::*; use toml::Value; pub use config::Config; -pub use errors::{GitJournalResult, internal_error}; +pub use errors::{GitJournalResult, error}; use logger::Logger; use parser::{Parser, ParsedTag, Tags}; @@ -363,7 +363,7 @@ impl GitJournal { file.read_to_string(&mut toml_string)?; let toml = toml::Parser::new(&toml_string).parse() - .ok_or(internal_error("Verify", "Could not parse default toml template."))?; + .ok_or(error("Verify", "Could not parse default toml template."))?; let toml_tags = self.parser.get_tags_from_toml(&toml, vec![]); let invalid_tags = tags.into_iter().filter(|tag| !toml_tags.contains(tag)).collect::<Vec<String>>(); diff --git a/src/logger.rs b/src/logger.rs index 931e449..27aa6b9 100644 --- a/src/logger.rs +++ b/src/logger.rs @@ -4,7 +4,7 @@ use log::{Log, LogRecord, LogLevel, LogMetadata}; use term::stderr; use term::color::{BRIGHT_BLUE, GREEN, BRIGHT_YELLOW, RED}; -use errors::{GitJournalResult, internal_error}; +use errors::{GitJournalResult, error}; /// The logging structure pub struct Logger; @@ -28,7 +28,7 @@ impl Logger { // We have to create a new terminal on each log because // `term::Terminal<Output=std::io::Stderr> + Send + 'static` cannot be shared between // threads safely' - let mut t = stderr().ok_or(internal_error("Term", "Could not create terminal"))?; + let mut t = stderr().ok_or(error("Term", "Could not create terminal"))?; t.fg(BRIGHT_BLUE)?; write!(t, "[git-journal] ")?; match record.level() { diff --git a/src/main.rs b/src/main.rs index af2a80f..731c93d 100644 --- a/src/main.rs +++ b/src/main.rs @@ -10,7 +10,7 @@ use std::process::exit; use std::{env, fs, error}; use clap::{App, Shell}; -use gitjournal::{GitJournal, GitJournalResult, internal_error}; +use gitjournal::{GitJournal, GitJournalResult, error}; fn error_and_exit(string: &str, error: Box<error::Error>) { error!("{}: {}", string, error); @@ -40,7 +40,7 @@ fn run() -> GitJournalResult<()> { let yaml = load_yaml!("cli.yaml"); let mut app = App::from_yaml(yaml).version(crate_version!()); let matches = app.clone().get_matches(); - let path = matches.value_of("path").ok_or(internal_error("Cli", "No 'path' provided"))?; + let path = matches.value_of("path").ok_or(error("Cli", "No 'path' provided"))?; // Create the journal let mut journal = GitJournal::new(path)?; @@ -50,10 +50,10 @@ fn run() -> GitJournalResult<()> { Some("prepare") => { // Prepare a commit message before editing by the user if let Some(sub_matches) = matches.subcommand_matches("prepare") { - match journal.prepare(sub_matches.value_of("message").ok_or(internal_error("Cli", "No 'message' provided"))?, + match journal.prepare(sub_matches.value_of("message").ok_or(error("Cli", "No 'message' provided"))?, sub_matches.value_of("type")) { Ok(()) => info!("Commit message prepared."), - Err(error) => error_and_exit("Commit message preparation failed", error) + Err(error) => error_and_exit("Commit message preparation failed", error), } } } @@ -78,7 +78,7 @@ fn run() -> GitJournalResult<()> { Some("verify") => { // Verify a commit message if let Some(sub_matches) = matches.subcommand_matches("verify") { - match journal.verify(sub_matches.value_of("message").ok_or(internal_error("Cli", "No 'message' provided"))?) { + match journal.verify(sub_matches.value_of("message").ok_or(error("Cli", "No 'message' provided"))?) { Ok(()) => info!("Commit message valid."), Err(error) => error_and_exit("Commit message invalid", error), } @@ -87,10 +87,10 @@ fn run() -> GitJournalResult<()> { _ => { // Get all values of the given CLI parameters with default values let revision_range = matches.value_of("revision_range") - .ok_or(internal_error("Cli", "No 'revision_range' provided"))?; + .ok_or(error("Cli", "No 'revision_range' provided"))?; let tag_skip_pattern = matches.value_of("tag_skip_pattern") - .ok_or(internal_error("Cli", "No 'task_skip_pattern' provided"))?; - let tags_count = matches.value_of("tags_count").ok_or(internal_error("Cli", "No 'tags_count' provided"))?; + .ok_or(error("Cli", "No 'task_skip_pattern' provided"))?; + let tags_count = matches.value_of("tags_count").ok_or(error("Cli", "No 'tags_count' provided"))?; let max_tags = tags_count.parse::<u32>()?; // Parse the log diff --git a/src/parser.rs b/src/parser.rs index 1b9addf..e8a448a 100644 --- a/src/parser.rs +++ b/src/parser.rs @@ -11,7 +11,7 @@ use std::io::prelude::*; use std::{iter, str}; use config::Config; -use errors::{GitJournalResult, internal_error}; +use errors::{GitJournalResult, error}; pub static TOML_DEFAULT_KEY: &'static str = "default"; pub static TOML_FOOTERS_KEY: &'static str = "footers"; @@ -815,7 +815,7 @@ impl Parser { // Parse the summary line let summary_line = - commit_parts.nth(0).ok_or(internal_error("Summary line", "Commit message length too small."))?.trim(); + commit_parts.nth(0).ok_or(error("Summary line", "Commit message length too small."))?.trim(); let mut parsed_summary = match self.clone().parse_summary(summary_line.as_bytes()) { (_, IResult::Done(_, parsed)) => parsed, _ => bail!("Summary parsing failed: '{}'", summary_line), @@ -838,8 +838,8 @@ impl Parser { for cap in RE_FOOTER.captures_iter(part) { parsed_footer.push(FooterElement { oid: oid, - key: cap.at(1).ok_or(internal_error("Footer parsing", part))?.to_owned(), - value: cap.at(2).ok_or(internal_error("Footer parsing", part))?.to_owned(), + key: cap.at(1).ok_or(error("Footer parsing", part))?.to_owned(), + value: cap.at(2).ok_or(error("Footer parsing", part))?.to_owned(), }); } @@ -879,7 +879,7 @@ impl Parser { /// Prints the commits without any template pub fn print(&self, compact: &bool, template: Option<&str>) -> GitJournalResult<Vec<u8>> { - let mut term = term::stdout().ok_or(internal_error("Terminal", "Could not print to terminal"))?; + let mut term = term::stdout().ok_or(error("Terminal", "Could not print to terminal"))?; let mut vec = vec![]; // Print every tag |