Gitson.Util

Various functions used inside Gitson.

Documentation

documentPath :: FilePath -> String -> FilePath

Combines two paths and adds the .json extension.

>>> documentPath "things" "document"
"things/document.json"

>>> documentPath "things/" "document"
"things/document.json"

lockPath :: FilePath

Path to the transaction lock file, relative to the repo root.

filterFilenamesAsKeys :: [FilePath] -> [String]

Turns a list of filenames into a list of keys, ignoring non-JSON files.

>>> filterFilenamesAsKeys [".", "..", "k1.json", "unrelated.file"]
["k1"]

filterDirs :: [FilePath] -> IO [FilePath]

Filters a list of file paths, leaving only paths to existing non-hidden directories.

insideDirectory :: (MonadIO i, MonadBaseControl IO i) => FilePath -> i a -> i a

Returns an IO action that switches the current directory to a given path, executes the given IO action and switches the current directory back.

lastCommitText :: IO String

Returns the message of the last git commit in the repo where the current directory is located.

shell :: MonadIO i => String -> [String] -> i ()

Runs a shell command with stdin, stdout and stderr set to devnull.

intoFunctor :: Functor f => f a -> b -> f (a, b)

Appends a value to a functor, making the inside a tuple if it's a single value.

>>> intoFunctor (Just 1) 2
Just (1,2)

>>> intoFunctor Nothing 2
Nothing

maybeReadIntString :: String -> Maybe (Int, String)

Tries to extract the first int out of a string.

>>> maybeReadIntString "0123-hell0w0rld"
Just (123,"-hell0w0rld")

>>> maybeReadIntString "1"
Just (1,"")

>>> maybeReadIntString "hello"
Nothing

nextKeyId :: [String] -> Int

Returns the next numeric id in a sequence of keys.

>>> nextKeyId []
1

>>> nextKeyId ["aaaaarrrrrrrrrrr"]
1

>>> nextKeyId ["1-hell0-w0rld-123456.json", "002-my-second-post.json"]
3