From 773423fcf49c27617be0b0cfce5478d7ceec9674 Mon Sep 17 00:00:00 2001 From: Joseph T Lyons Date: Wed, 28 Sep 2022 16:25:37 -0400 Subject: [PATCH 1/6] Initial work to add settings to journal feature --- Cargo.lock | 1 + assets/settings/default.json | 7 +++ crates/journal/Cargo.toml | 1 + crates/journal/src/journal.rs | 80 +++++++++++++++++++++++++++++---- crates/settings/src/settings.rs | 29 ++++++++++++ 5 files changed, 109 insertions(+), 9 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 363ee93c14..28fc8fcb61 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2764,6 +2764,7 @@ dependencies = [ "editor", "gpui", "log", + "settings", "util", "workspace", ] diff --git a/assets/settings/default.json b/assets/settings/default.json index a12cf44d94..25117521bf 100644 --- a/assets/settings/default.json +++ b/assets/settings/default.json @@ -74,6 +74,13 @@ "hard_tabs": false, // How many columns a tab should occupy. "tab_size": 4, + // TODO + "journal": { + // TODO + "journal_directory": "always_home", + // TODO + "hour_format": "hour12" + }, // Settings specific to the terminal "terminal": { // What shell to use when opening a terminal. May take 3 values: diff --git a/crates/journal/Cargo.toml b/crates/journal/Cargo.toml index 94dcf8e407..091aadd12e 100644 --- a/crates/journal/Cargo.toml +++ b/crates/journal/Cargo.toml @@ -15,3 +15,4 @@ workspace = { path = "../workspace" } chrono = "0.4" dirs = "4.0" log = { version = "0.4.16", features = ["kv_unstable_serde"] } +settings = { path = "../settings" } diff --git a/crates/journal/src/journal.rs b/crates/journal/src/journal.rs index 8135950e50..3a44345b70 100644 --- a/crates/journal/src/journal.rs +++ b/crates/journal/src/journal.rs @@ -1,7 +1,8 @@ -use chrono::{Datelike, Local, Timelike}; +use chrono::{Datelike, Local, NaiveTime, Timelike}; use editor::{Autoscroll, Editor}; use gpui::{actions, MutableAppContext}; -use std::{fs::OpenOptions, sync::Arc}; +use settings::{HourFormat, JournalDirectory, Settings}; +use std::{fs::OpenOptions, path::PathBuf, str::FromStr, sync::Arc}; use util::TryFutureExt as _; use workspace::AppState; @@ -12,24 +13,23 @@ pub fn init(app_state: Arc, cx: &mut MutableAppContext) { } pub fn new_journal_entry(app_state: Arc, cx: &mut MutableAppContext) { - let now = Local::now(); - let home_dir = match dirs::home_dir() { - Some(home_dir) => home_dir, + let settings = cx.global::(); + let journal_dir = match get_journal_dir(&settings.journal_overrides.journal_directory) { + Some(journal_dir) => journal_dir, None => { log::error!("can't determine home directory"); return; } }; - let journal_dir = home_dir.join("journal"); + let now = Local::now(); let month_dir = journal_dir .join(format!("{:02}", now.year())) .join(format!("{:02}", now.month())); let entry_path = month_dir.join(format!("{:02}.md", now.day())); let now = now.time(); - let (pm, hour) = now.hour12(); - let am_or_pm = if pm { "PM" } else { "AM" }; - let entry_heading = format!("# {}:{:02} {}\n\n", hour, now.minute(), am_or_pm); + let hour_format = &settings.journal_overrides.hour_format; + let entry_heading = get_heading_entry(now, &hour_format); let create_entry = cx.background().spawn(async move { std::fs::create_dir_all(month_dir)?; @@ -64,6 +64,7 @@ pub fn new_journal_entry(app_state: Arc, cx: &mut MutableAppContext) { editor.insert("\n\n", cx); } editor.insert(&entry_heading, cx); + editor.insert("\n\n", cx); }); } } @@ -74,3 +75,64 @@ pub fn new_journal_entry(app_state: Arc, cx: &mut MutableAppContext) { }) .detach(); } + +fn get_journal_dir(a: &Option) -> Option { + let journal_default_dir = dirs::home_dir()?.join("journal"); + + let journal_dir = match a { + Some(JournalDirectory::Always { directory }) => { + PathBuf::from_str(&directory).unwrap_or(journal_default_dir) + } + _ => journal_default_dir, + }; + + Some(journal_dir) +} + +fn get_heading_entry(now: NaiveTime, hour_format: &Option) -> String { + match hour_format { + Some(HourFormat::Hour24) => { + let hour = now.hour(); + format!("# {}:{:02}", hour, now.minute()) + } + _ => { + let (pm, hour) = now.hour12(); + let am_or_pm = if pm { "PM" } else { "AM" }; + format!("# {}:{:02} {}", hour, now.minute(), am_or_pm) + } + } +} + +#[cfg(test)] +mod tests { + mod heading_entry_tests { + use super::super::*; + + #[test] + fn test_heading_entry_defaults_to_hour_12() { + let naive_time = NaiveTime::from_hms_milli(15, 0, 0, 0); + let actual_heading_entry = get_heading_entry(naive_time, &None); + let expected_heading_entry = "# 3:00 PM"; + + assert_eq!(actual_heading_entry, expected_heading_entry); + } + + #[test] + fn test_heading_entry_is_hour_12() { + let naive_time = NaiveTime::from_hms_milli(15, 0, 0, 0); + let actual_heading_entry = get_heading_entry(naive_time, &Some(HourFormat::Hour12)); + let expected_heading_entry = "# 3:00 PM"; + + assert_eq!(actual_heading_entry, expected_heading_entry); + } + + #[test] + fn test_heading_entry_is_hour_24() { + let naive_time = NaiveTime::from_hms_milli(15, 0, 0, 0); + let actual_heading_entry = get_heading_entry(naive_time, &Some(HourFormat::Hour24)); + let expected_heading_entry = "# 15:00"; + + assert_eq!(actual_heading_entry, expected_heading_entry); + } + } +} diff --git a/crates/settings/src/settings.rs b/crates/settings/src/settings.rs index e346ff60e6..5d4195d3b2 100644 --- a/crates/settings/src/settings.rs +++ b/crates/settings/src/settings.rs @@ -32,6 +32,8 @@ pub struct Settings { pub default_dock_anchor: DockAnchor, pub editor_defaults: EditorSettings, pub editor_overrides: EditorSettings, + pub journal_defaults: JournalSettings, + pub journal_overrides: JournalSettings, pub terminal_defaults: TerminalSettings, pub terminal_overrides: TerminalSettings, pub language_defaults: HashMap, EditorSettings>, @@ -101,6 +103,26 @@ pub enum Autosave { OnWindowChange, } +#[derive(Clone, Debug, Default, Deserialize, JsonSchema)] +pub struct JournalSettings { + pub journal_directory: Option, + pub hour_format: Option, +} + +#[derive(Clone, Debug, Deserialize, JsonSchema)] +#[serde(rename_all = "snake_case")] +pub enum JournalDirectory { + AlwaysHome, + Always { directory: String }, +} + +#[derive(Clone, Debug, Deserialize, JsonSchema)] +#[serde(rename_all = "snake_case")] +pub enum HourFormat { + Hour12, + Hour24, +} + #[derive(Clone, Debug, Default, Deserialize, JsonSchema)] pub struct TerminalSettings { pub shell: Option, @@ -194,6 +216,8 @@ pub struct SettingsFileContent { #[serde(flatten)] pub editor: EditorSettings, #[serde(default)] + pub journal: JournalSettings, + #[serde(default)] pub terminal: TerminalSettings, #[serde(default)] #[serde(alias = "language_overrides")] @@ -252,6 +276,8 @@ impl Settings { enable_language_server: required(defaults.editor.enable_language_server), }, editor_overrides: Default::default(), + journal_defaults: Default::default(), + journal_overrides: Default::default(), terminal_defaults: Default::default(), terminal_overrides: Default::default(), language_defaults: defaults.languages, @@ -303,6 +329,7 @@ impl Settings { } self.editor_overrides = data.editor; + self.journal_overrides = data.journal; self.terminal_defaults.font_size = data.terminal.font_size; self.terminal_overrides = data.terminal; self.language_overrides = data.languages; @@ -380,6 +407,8 @@ impl Settings { enable_language_server: Some(true), }, editor_overrides: Default::default(), + journal_defaults: Default::default(), + journal_overrides: Default::default(), terminal_defaults: Default::default(), terminal_overrides: Default::default(), language_defaults: Default::default(), From fbe5f9225c97cd4de35750eb24143e66c07bd76d Mon Sep 17 00:00:00 2001 From: Joseph T Lyons Date: Wed, 28 Sep 2022 16:52:15 -0400 Subject: [PATCH 2/6] Add descriptions to journal settings --- assets/settings/default.json | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/assets/settings/default.json b/assets/settings/default.json index 25117521bf..d46dc11df5 100644 --- a/assets/settings/default.json +++ b/assets/settings/default.json @@ -74,11 +74,14 @@ "hard_tabs": false, // How many columns a tab should occupy. "tab_size": 4, - // TODO + // Settings specific to journaling "journal": { - // TODO + // The directory in which the journal entries are created "journal_directory": "always_home", - // TODO + // What format to present the hours in + // May take 2 values: + // 1. hour12 + // 2. hour24 "hour_format": "hour12" }, // Settings specific to the terminal From f8da5ab2e76503e1f94b79dc0f6b21f00005e3a3 Mon Sep 17 00:00:00 2001 From: Joseph T Lyons Date: Wed, 28 Sep 2022 17:07:11 -0400 Subject: [PATCH 3/6] Remove "get" prefix from function names --- crates/journal/src/journal.rs | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/crates/journal/src/journal.rs b/crates/journal/src/journal.rs index 3a44345b70..c6e33d1134 100644 --- a/crates/journal/src/journal.rs +++ b/crates/journal/src/journal.rs @@ -14,7 +14,7 @@ pub fn init(app_state: Arc, cx: &mut MutableAppContext) { pub fn new_journal_entry(app_state: Arc, cx: &mut MutableAppContext) { let settings = cx.global::(); - let journal_dir = match get_journal_dir(&settings.journal_overrides.journal_directory) { + let journal_dir = match journal_dir(&settings.journal_overrides.journal_directory) { Some(journal_dir) => journal_dir, None => { log::error!("can't determine home directory"); @@ -29,7 +29,7 @@ pub fn new_journal_entry(app_state: Arc, cx: &mut MutableAppContext) { let entry_path = month_dir.join(format!("{:02}.md", now.day())); let now = now.time(); let hour_format = &settings.journal_overrides.hour_format; - let entry_heading = get_heading_entry(now, &hour_format); + let entry_heading = heading_entry(now, &hour_format); let create_entry = cx.background().spawn(async move { std::fs::create_dir_all(month_dir)?; @@ -76,7 +76,7 @@ pub fn new_journal_entry(app_state: Arc, cx: &mut MutableAppContext) { .detach(); } -fn get_journal_dir(a: &Option) -> Option { +fn journal_dir(a: &Option) -> Option { let journal_default_dir = dirs::home_dir()?.join("journal"); let journal_dir = match a { @@ -89,7 +89,7 @@ fn get_journal_dir(a: &Option) -> Option { Some(journal_dir) } -fn get_heading_entry(now: NaiveTime, hour_format: &Option) -> String { +fn heading_entry(now: NaiveTime, hour_format: &Option) -> String { match hour_format { Some(HourFormat::Hour24) => { let hour = now.hour(); @@ -111,7 +111,7 @@ mod tests { #[test] fn test_heading_entry_defaults_to_hour_12() { let naive_time = NaiveTime::from_hms_milli(15, 0, 0, 0); - let actual_heading_entry = get_heading_entry(naive_time, &None); + let actual_heading_entry = heading_entry(naive_time, &None); let expected_heading_entry = "# 3:00 PM"; assert_eq!(actual_heading_entry, expected_heading_entry); @@ -120,7 +120,7 @@ mod tests { #[test] fn test_heading_entry_is_hour_12() { let naive_time = NaiveTime::from_hms_milli(15, 0, 0, 0); - let actual_heading_entry = get_heading_entry(naive_time, &Some(HourFormat::Hour12)); + let actual_heading_entry = heading_entry(naive_time, &Some(HourFormat::Hour12)); let expected_heading_entry = "# 3:00 PM"; assert_eq!(actual_heading_entry, expected_heading_entry); @@ -129,7 +129,7 @@ mod tests { #[test] fn test_heading_entry_is_hour_24() { let naive_time = NaiveTime::from_hms_milli(15, 0, 0, 0); - let actual_heading_entry = get_heading_entry(naive_time, &Some(HourFormat::Hour24)); + let actual_heading_entry = heading_entry(naive_time, &Some(HourFormat::Hour24)); let expected_heading_entry = "# 15:00"; assert_eq!(actual_heading_entry, expected_heading_entry); From 3c62de34f73f9b7d3e769b2fa61f9da173f42b4d Mon Sep 17 00:00:00 2001 From: Joseph T Lyons Date: Thu, 29 Sep 2022 16:18:16 -0400 Subject: [PATCH 4/6] Change journal location setting name to "path" and default to ~ --- Cargo.lock | 1 + assets/settings/default.json | 8 ++++---- crates/journal/Cargo.toml | 1 + crates/journal/src/journal.rs | 31 ++++++++++++++++++------------- crates/settings/src/settings.rs | 22 +++++++++++++++------- 5 files changed, 39 insertions(+), 24 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 28fc8fcb61..8859966acb 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2765,6 +2765,7 @@ dependencies = [ "gpui", "log", "settings", + "shellexpand", "util", "workspace", ] diff --git a/assets/settings/default.json b/assets/settings/default.json index d46dc11df5..d88d229dfb 100644 --- a/assets/settings/default.json +++ b/assets/settings/default.json @@ -76,10 +76,10 @@ "tab_size": 4, // Settings specific to journaling "journal": { - // The directory in which the journal entries are created - "journal_directory": "always_home", - // What format to present the hours in - // May take 2 values: + // The path of the directory where journal entries are stored + "path": "~", + // What format to display the hours in + // May take 2 values: // 1. hour12 // 2. hour24 "hour_format": "hour12" diff --git a/crates/journal/Cargo.toml b/crates/journal/Cargo.toml index 091aadd12e..8c900d9f4a 100644 --- a/crates/journal/Cargo.toml +++ b/crates/journal/Cargo.toml @@ -16,3 +16,4 @@ chrono = "0.4" dirs = "4.0" log = { version = "0.4.16", features = ["kv_unstable_serde"] } settings = { path = "../settings" } +shellexpand = "2.1.0" \ No newline at end of file diff --git a/crates/journal/src/journal.rs b/crates/journal/src/journal.rs index c6e33d1134..4269556251 100644 --- a/crates/journal/src/journal.rs +++ b/crates/journal/src/journal.rs @@ -1,8 +1,12 @@ use chrono::{Datelike, Local, NaiveTime, Timelike}; use editor::{Autoscroll, Editor}; use gpui::{actions, MutableAppContext}; -use settings::{HourFormat, JournalDirectory, Settings}; -use std::{fs::OpenOptions, path::PathBuf, str::FromStr, sync::Arc}; +use settings::{HourFormat, Settings}; +use std::{ + fs::OpenOptions, + path::{Path, PathBuf}, + sync::Arc, +}; use util::TryFutureExt as _; use workspace::AppState; @@ -14,10 +18,10 @@ pub fn init(app_state: Arc, cx: &mut MutableAppContext) { pub fn new_journal_entry(app_state: Arc, cx: &mut MutableAppContext) { let settings = cx.global::(); - let journal_dir = match journal_dir(&settings.journal_overrides.journal_directory) { + let journal_dir = match journal_dir(&settings) { Some(journal_dir) => journal_dir, None => { - log::error!("can't determine home directory"); + log::error!("Can't determine journal directory"); return; } }; @@ -76,17 +80,18 @@ pub fn new_journal_entry(app_state: Arc, cx: &mut MutableAppContext) { .detach(); } -fn journal_dir(a: &Option) -> Option { - let journal_default_dir = dirs::home_dir()?.join("journal"); +fn journal_dir(settings: &Settings) -> Option { + let journal_dir = settings + .journal_overrides + .path + .as_ref() + .unwrap_or(settings.journal_defaults.path.as_ref()?); - let journal_dir = match a { - Some(JournalDirectory::Always { directory }) => { - PathBuf::from_str(&directory).unwrap_or(journal_default_dir) - } - _ => journal_default_dir, - }; + let expanded_journal_dir = shellexpand::full(&journal_dir) //TODO handle this better + .ok() + .map(|dir| Path::new(&dir.to_string()).to_path_buf().join("journal")); - Some(journal_dir) + return expanded_journal_dir; } fn heading_entry(now: NaiveTime, hour_format: &Option) -> String { diff --git a/crates/settings/src/settings.rs b/crates/settings/src/settings.rs index 5d4195d3b2..69a1ea9441 100644 --- a/crates/settings/src/settings.rs +++ b/crates/settings/src/settings.rs @@ -103,17 +103,19 @@ pub enum Autosave { OnWindowChange, } -#[derive(Clone, Debug, Default, Deserialize, JsonSchema)] +#[derive(Clone, Debug, Deserialize, JsonSchema)] pub struct JournalSettings { - pub journal_directory: Option, + pub path: Option, pub hour_format: Option, } -#[derive(Clone, Debug, Deserialize, JsonSchema)] -#[serde(rename_all = "snake_case")] -pub enum JournalDirectory { - AlwaysHome, - Always { directory: String }, +impl Default for JournalSettings { + fn default() -> Self { + Self { + path: Some("~".into()), + hour_format: Some(Default::default()), + } + } } #[derive(Clone, Debug, Deserialize, JsonSchema)] @@ -123,6 +125,12 @@ pub enum HourFormat { Hour24, } +impl Default for HourFormat { + fn default() -> Self { + Self::Hour12 + } +} + #[derive(Clone, Debug, Default, Deserialize, JsonSchema)] pub struct TerminalSettings { pub shell: Option, From 6d020a3ee98a7a6dba693f802681d7c37f2526da Mon Sep 17 00:00:00 2001 From: Joseph T Lyons Date: Sun, 16 Oct 2022 12:51:34 -0400 Subject: [PATCH 5/6] Do not derive Default on JournalSettings --- crates/settings/src/settings.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crates/settings/src/settings.rs b/crates/settings/src/settings.rs index 48ba35f4d3..9280a20600 100644 --- a/crates/settings/src/settings.rs +++ b/crates/settings/src/settings.rs @@ -124,7 +124,7 @@ pub enum Autosave { OnWindowChange, } -#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema)] +#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema)] pub struct JournalSettings { pub path: Option, pub hour_format: Option, From 0717c168d9a0f9bcc57aa3df05853c232c9ea393 Mon Sep 17 00:00:00 2001 From: Joseph T Lyons Date: Sun, 16 Oct 2022 12:51:48 -0400 Subject: [PATCH 6/6] Derive Serialize on HourFormat --- crates/settings/src/settings.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crates/settings/src/settings.rs b/crates/settings/src/settings.rs index 9280a20600..63bc5962fa 100644 --- a/crates/settings/src/settings.rs +++ b/crates/settings/src/settings.rs @@ -139,7 +139,7 @@ impl Default for JournalSettings { } } -#[derive(Clone, Debug, Deserialize, JsonSchema)] +#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema)] #[serde(rename_all = "snake_case")] pub enum HourFormat { Hour12,