-
-
Notifications
You must be signed in to change notification settings - Fork 519
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Always expand all paths (journals, templates, etc) #1468
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
import os.path | ||
|
||
|
||
def home_dir(): | ||
return os.path.expanduser("~") | ||
|
||
|
||
def expand_path(path): | ||
return os.path.expanduser(os.path.expandvars(path)) | ||
|
||
|
||
def absolute_path(path): | ||
return os.path.abspath(expand_path(path)) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
import pytest | ||
import random | ||
import string | ||
|
||
from os import getenv | ||
from unittest.mock import patch | ||
|
||
from jrnl.path import home_dir | ||
from jrnl.path import expand_path | ||
from jrnl.path import absolute_path | ||
|
||
|
||
@pytest.fixture | ||
def home_dir_str(monkeypatch): | ||
username = "username" | ||
monkeypatch.setenv("USERPROFILE", username) # for windows | ||
monkeypatch.setenv("HOME", username) # for *nix | ||
return username | ||
|
||
|
||
@pytest.fixture | ||
def random_test_var(monkeypatch): | ||
name = f"JRNL_TEST_{''.join(random.sample(string.ascii_uppercase, 10))}" | ||
val = "".join(random.sample(string.ascii_lowercase, 25)) | ||
monkeypatch.setenv(name, val) | ||
return (name, val) | ||
|
||
|
||
def test_home_dir(home_dir_str): | ||
assert home_dir() == home_dir_str | ||
|
||
|
||
@pytest.mark.on_posix | ||
@pytest.mark.parametrize( | ||
"path", | ||
["~"], | ||
) | ||
def test_expand_path_actually_expands_mac_linux(path): | ||
# makes sure that path isn't being returns as-is | ||
assert expand_path(path) != path | ||
|
||
|
||
@pytest.mark.on_win | ||
@pytest.mark.parametrize( | ||
"path", | ||
["~", "%USERPROFILE%"], | ||
) | ||
def test_expand_path_actually_expands_windows(path): | ||
# makes sure that path isn't being returns as-is | ||
assert expand_path(path) != path | ||
|
||
|
||
@pytest.mark.on_posix | ||
@pytest.mark.parametrize( | ||
"paths", | ||
[ | ||
["~", "HOME"], | ||
], | ||
) | ||
def test_expand_path_expands_into_correct_value_mac_linux(paths): | ||
input_path, expected_path = paths[0], paths[1] | ||
assert expand_path(input_path) == getenv(expected_path) | ||
|
||
|
||
@pytest.mark.on_win | ||
@pytest.mark.parametrize( | ||
"paths", | ||
[ | ||
["~", "USERPROFILE"], | ||
["%USERPROFILE%", "USERPROFILE"], | ||
], | ||
) | ||
def test_expand_path_expands_into_correct_value_windows(paths): | ||
input_path, expected_path = paths[0], paths[1] | ||
assert expand_path(input_path) == getenv(expected_path) | ||
|
||
|
||
@pytest.mark.on_posix | ||
@pytest.mark.parametrize("_", range(25)) | ||
def test_expand_path_expands_into_random_env_value_mac_linux(_, random_test_var): | ||
var_name, var_value = random_test_var[0], random_test_var[1] | ||
assert expand_path(var_name) == var_name | ||
assert expand_path(f"${var_name}") == var_value # mac & linux | ||
assert expand_path(f"${var_name}") == getenv(var_name) | ||
|
||
|
||
@pytest.mark.on_win | ||
@pytest.mark.parametrize("_", range(25)) | ||
def test_expand_path_expands_into_random_env_value_windows(_, random_test_var): | ||
var_name, var_value = random_test_var[0], random_test_var[1] | ||
assert expand_path(var_name) == var_name | ||
assert expand_path(f"%{var_name}%") == var_value # windows | ||
assert expand_path(f"%{var_name}%") == getenv(var_name) | ||
|
||
|
||
@patch("jrnl.path.expand_path") | ||
@patch("os.path.abspath") | ||
def test_absolute_path(mock_abspath, mock_expand_path): | ||
test_val = "test_value" | ||
|
||
assert absolute_path(test_val) == mock_abspath.return_value | ||
mock_expand_path.assert_called_with(test_val) | ||
mock_abspath.assert_called_with(mock_expand_path.return_value) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we could do with just
home_dir
andexpand_path
as long asexpand_path
also runsabspath
. Would you mind mergingexpand_path
andabsolute_path
into one function?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried that at first because I assumed that it wouldn't make a difference but I think that's not a great idea for a couple reasons.