carpentry/path
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

fix for newest carp

Browse Source
This commit is contained in:
Veit Heller
2022-01-27 12:01:03 +01:00
parent 03aab46ab5
commit c734c582d4
3 changed files with 454 additions and 442 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -5,7 +5,7 @@ is a simple file path library for Carp.
## Installation ## Installation
```clojure ```clojure
(load "https://veitheller.de/git/carpentry/path@0.0.3") (load "git@git.veitheller.de:carpentry/path.git@0.0.4")
``` ```
### Usage ### Usage
@@ -16,7 +16,7 @@ has some functions to work with the `PATH` environment variable.
It assumes either Windows or POSIX-style separators. It assumes either Windows or POSIX-style separators.
Look at [the documentation](https://veitheller.de/path) for more information. Look at [the documentation](https://carpentry.dev/path) for more information.
<hr/> <hr/>

888
docs/Path.html
View File

@@ -25,477 +25,488 @@
</ul> </ul>
</div> </div>
</div> </div>
<h1> <div class="module">
Path <h1>
</h1> Path
<div class="module-description"> </h1>
<div class="module-description">
</div> <p>is a simple file path library for Carp.</p>
<div class="binder"> <h2>Installation</h2>
<a class="anchor" href="#&lt;/&gt;"> <pre><code class="language-clojure">(load &quot;git@git.veitheller.de:carpentry/path.git@0.0.4&quot;)
<h3 id="&lt;/&gt;"> </code></pre>
&lt;/&gt; <h3>Usage</h3>
</h3> <p>The <code>Path</code> module mostly operates on <code>String</code> arguments. It allows you to
</a> split, join, and merge paths and extensions in a lot of different ways. It also
<div class="description"> has some functions to work with the <code>PATH</code> environment variable.</p>
defn <p>It assumes either Windows or POSIX-style separators.</p>
</div>
<p class="sig">
(Fn [a, b] String)
</p>
<pre class="args">
(&lt;/&gt; before after)
</pre>
<p class="doc">
<p>joins <code>before</code> and <code>after</code> using the default path separator.</p>
</p>
</div>
<div class="binder">
<a class="anchor" href="#absolute">
<h3 id="absolute">
absolute
</h3>
</a>
<div class="description">
defn
</div> </div>
<p class="sig"> <div class="binder">
(Fn [(Ref String a)] (Maybe String)) <a class="anchor" href="#&lt;/&gt;">
</p> <h3 id="&lt;/&gt;">
<pre class="args"> &lt;/&gt;
(absolute p) </h3>
</pre> </a>
<p class="doc"> <div class="description">
defn
</p> </div>
</div> <p class="sig">
<div class="binder"> (Fn [a, b] String)
<a class="anchor" href="#absolute?"> </p>
<h3 id="absolute?"> <pre class="args">
absolute? (&lt;/&gt; before after)
</h3> </pre>
</a> <p class="doc">
<div class="description"> <p>joins <code>before</code> and <code>after</code> using the default path separator.</p>
defn
</p>
</div> </div>
<p class="sig"> <div class="binder">
(Fn [(Ref String a)] Bool) <a class="anchor" href="#absolute">
</p> <h3 id="absolute">
<pre class="args"> absolute
(absolute? p) </h3>
</pre> </a>
<p class="doc"> <div class="description">
<p>checks whether a path is absolute.</p> defn
</div>
<p class="sig">
(Fn [(Ref String a)] (Maybe String))
</p>
<pre class="args">
(absolute p)
</pre>
<p class="doc">
<p>makes an absolute path from <code>p</code>.</p>
</p>
</div>
<div class="binder">
<a class="anchor" href="#absolute?">
<h3 id="absolute?">
absolute?
</h3>
</a>
<div class="description">
defn
</div>
<p class="sig">
(Fn [(Ref String a)] Bool)
</p>
<pre class="args">
(absolute? p)
</pre>
<p class="doc">
<p>checks whether a path is absolute.</p>
<p>As such, it is the inverse to <a href="#relative?">relative?</a>.</p> <p>As such, it is the inverse to <a href="#relative?">relative?</a>.</p>
</p> </p>
</div>
<div class="binder">
<a class="anchor" href="#add-extension">
<h3 id="add-extension">
add-extension
</h3>
</a>
<div class="description">
defn
</div> </div>
<p class="sig"> <div class="binder">
(Fn [(Ref String a), (Ref String b)] String) <a class="anchor" href="#add-extension">
</p> <h3 id="add-extension">
<pre class="args"> add-extension
(add-extension p ext) </h3>
</pre> </a>
<p class="doc"> <div class="description">
<p>adds an extension <code>ext</code> to a path <code>p</code>.</p> defn
</div>
<p class="sig">
(Fn [(Ref String a), (Ref String b)] String)
</p>
<pre class="args">
(add-extension p ext)
</pre>
<p class="doc">
<p>adds an extension <code>ext</code> to a path <code>p</code>.</p>
</p> </p>
</div>
<div class="binder">
<a class="anchor" href="#basename">
<h3 id="basename">
basename
</h3>
</a>
<div class="description">
defn
</div> </div>
<p class="sig"> <div class="binder">
(Fn [(Ref String a)] String) <a class="anchor" href="#basename">
</p> <h3 id="basename">
<pre class="args"> basename
(basename p) </h3>
</pre> </a>
<p class="doc"> <div class="description">
<p>gets the basename of the path <code>p</code>.</p> defn
</div>
<p class="sig">
(Fn [(Ref String a)] String)
</p>
<pre class="args">
(basename p)
</pre>
<p class="doc">
<p>gets the basename of the path <code>p</code>.</p>
</p> </p>
</div>
<div class="binder">
<a class="anchor" href="#cwd">
<h3 id="cwd">
cwd
</h3>
</a>
<div class="description">
defn
</div> </div>
<p class="sig"> <div class="binder">
(Fn [] (Maybe String)) <a class="anchor" href="#cwd">
</p> <h3 id="cwd">
<pre class="args"> cwd
(cwd) </h3>
</pre> </a>
<p class="doc"> <div class="description">
<p>returns the current working directory as a <code>Maybe</code>. The ways in defn
</div>
<p class="sig">
(Fn [] (Maybe String))
</p>
<pre class="args">
(cwd)
</pre>
<p class="doc">
<p>returns the current working directory as a <code>Maybe</code>. The ways in
which it can fail are OS-dependent, but it should happen relatively rare.</p> which it can fail are OS-dependent, but it should happen relatively rare.</p>
</p> </p>
</div>
<div class="binder">
<a class="anchor" href="#drop-extension">
<h3 id="drop-extension">
drop-extension
</h3>
</a>
<div class="description">
defn
</div> </div>
<p class="sig"> <div class="binder">
(Fn [(Ref String a)] String) <a class="anchor" href="#drop-extension">
</p> <h3 id="drop-extension">
<pre class="args"> drop-extension
(drop-extension p) </h3>
</pre> </a>
<p class="doc"> <div class="description">
<p>drops the extension of a path <code>p</code>. Does nothing if there defn
</div>
<p class="sig">
(Fn [(Ref String a)] String)
</p>
<pre class="args">
(drop-extension p)
</pre>
<p class="doc">
<p>drops the extension of a path <code>p</code>. Does nothing if there
is none.</p> is none.</p>
</p> </p>
</div>
<div class="binder">
<a class="anchor" href="#extension">
<h3 id="extension">
extension
</h3>
</a>
<div class="description">
defn
</div> </div>
<p class="sig"> <div class="binder">
(Fn [(Ref String a)] (Maybe String)) <a class="anchor" href="#extension">
</p> <h3 id="extension">
<pre class="args"> extension
(extension p) </h3>
</pre> </a>
<p class="doc"> <div class="description">
<p>gets the extension of a file as a <code>Maybe</code>.</p> defn
</div>
<p class="sig">
(Fn [(Ref String a)] (Maybe String))
</p>
<pre class="args">
(extension p)
</pre>
<p class="doc">
<p>gets the extension of a file as a <code>Maybe</code>.</p>
</p> </p>
</div>
<div class="binder">
<a class="anchor" href="#filename">
<h3 id="filename">
filename
</h3>
</a>
<div class="description">
defn
</div> </div>
<p class="sig"> <div class="binder">
(Fn [(Ref String a)] (Maybe String)) <a class="anchor" href="#filename">
</p> <h3 id="filename">
<pre class="args"> filename
(filename p) </h3>
</pre> </a>
<p class="doc"> <div class="description">
<p>gets the filename of the path <code>p</code> as a <code>(Maybe String)</code>.</p> defn
</div>
<p class="sig">
(Fn [(Ref String a)] (Maybe String))
</p>
<pre class="args">
(filename p)
</pre>
<p class="doc">
<p>gets the filename of the path <code>p</code> as a <code>(Maybe String)</code>.</p>
<p>It will return <code>Nothing</code> if an empty string is passed.</p> <p>It will return <code>Nothing</code> if an empty string is passed.</p>
</p> </p>
</div>
<div class="binder">
<a class="anchor" href="#get-search-path">
<h3 id="get-search-path">
get-search-path
</h3>
</a>
<div class="description">
defn
</div> </div>
<p class="sig"> <div class="binder">
(Fn [] (Maybe (Array String))) <a class="anchor" href="#get-search-path">
</p> <h3 id="get-search-path">
<pre class="args"> get-search-path
(get-search-path) </h3>
</pre> </a>
<p class="doc"> <div class="description">
<p>gets the <code>PATH</code> environment variable and splits it.</p> defn
</div>
<p class="sig">
(Fn [] (Maybe (Array String)))
</p>
<pre class="args">
(get-search-path)
</pre>
<p class="doc">
<p>gets the <code>PATH</code> environment variable and splits it.</p>
</p> </p>
</div>
<div class="binder">
<a class="anchor" href="#has-extension?">
<h3 id="has-extension?">
has-extension?
</h3>
</a>
<div class="description">
defn
</div> </div>
<p class="sig"> <div class="binder">
(Fn [(Ref String a)] Bool) <a class="anchor" href="#has-extension?">
</p> <h3 id="has-extension?">
<pre class="args"> has-extension?
(has-extension? p) </h3>
</pre> </a>
<p class="doc"> <div class="description">
<p>cheks whether the path <code>p</code> has an extension.</p> defn
</div>
<p class="sig">
(Fn [(Ref String a)] Bool)
</p>
<pre class="args">
(has-extension? p)
</pre>
<p class="doc">
<p>cheks whether the path <code>p</code> has an extension.</p>
</p> </p>
</div>
<div class="binder">
<a class="anchor" href="#is-extension?">
<h3 id="is-extension?">
is-extension?
</h3>
</a>
<div class="description">
defn
</div> </div>
<p class="sig"> <div class="binder">
(Fn [(Ref String a), (Ref String b)] Bool) <a class="anchor" href="#is-extension?">
</p> <h3 id="is-extension?">
<pre class="args"> is-extension?
(is-extension? p ext) </h3>
</pre> </a>
<p class="doc"> <div class="description">
<p>checks whether the path <code>p</code> has the extension <code>ext</code>.</p> defn
</div>
<p class="sig">
(Fn [(Ref String a), (Ref String b)] Bool)
</p>
<pre class="args">
(is-extension? p ext)
</pre>
<p class="doc">
<p>checks whether the path <code>p</code> has the extension <code>ext</code>.</p>
</p> </p>
</div>
<div class="binder">
<a class="anchor" href="#join">
<h3 id="join">
join
</h3>
</a>
<div class="description">
defn
</div> </div>
<p class="sig"> <div class="binder">
(Fn [(Ref (Array String) a)] String) <a class="anchor" href="#join">
</p> <h3 id="join">
<pre class="args"> join
(join ps) </h3>
</pre> </a>
<p class="doc"> <div class="description">
<p>joins the path components <code>ps</code> into a path.</p> defn
</div>
<p class="sig">
(Fn [(Ref (Array String) a)] String)
</p>
<pre class="args">
(join ps)
</pre>
<p class="doc">
<p>joins the path components <code>ps</code> into a path.</p>
<p>As such, it is the inverse to <a href="#split">split</a>.</p> <p>As such, it is the inverse to <a href="#split">split</a>.</p>
</p> </p>
</div>
<div class="binder">
<a class="anchor" href="#path-max">
<h3 id="path-max">
path-max
</h3>
</a>
<div class="description">
external
</div> </div>
<p class="sig"> <div class="binder">
Int <a class="anchor" href="#path-max">
</p> <h3 id="path-max">
<span> path-max
</h3>
</span> </a>
<p class="doc"> <div class="description">
<p>defines the maximum path length on this OS.</p> external
</div>
<p class="sig">
Int
</p>
<span>
</span>
<p class="doc">
<p>defines the maximum path length on this OS.</p>
</p> </p>
</div>
<div class="binder">
<a class="anchor" href="#relative?">
<h3 id="relative?">
relative?
</h3>
</a>
<div class="description">
defn
</div> </div>
<p class="sig"> <div class="binder">
(Fn [(Ref String a)] Bool) <a class="anchor" href="#relative?">
</p> <h3 id="relative?">
<pre class="args"> relative?
(relative? p) </h3>
</pre> </a>
<p class="doc"> <div class="description">
<p>checks whether a path is relative.</p> defn
</div>
<p class="sig">
(Fn [(Ref String a)] Bool)
</p>
<pre class="args">
(relative? p)
</pre>
<p class="doc">
<p>checks whether a path is relative.</p>
<p>As such, it is the inverse to <a href="#absolute?">absolute?</a>.</p> <p>As such, it is the inverse to <a href="#absolute?">absolute?</a>.</p>
</p> </p>
</div>
<div class="binder">
<a class="anchor" href="#replace-extension">
<h3 id="replace-extension">
replace-extension
</h3>
</a>
<div class="description">
defn
</div> </div>
<p class="sig"> <div class="binder">
(Fn [(Ref String a), (Ref String b)] String) <a class="anchor" href="#replace-extension">
</p> <h3 id="replace-extension">
<pre class="args"> replace-extension
(replace-extension p ext) </h3>
</pre> </a>
<p class="doc"> <div class="description">
<p>replaces the extension of a path <code>p</code> with <code>ext</code>. Adds defn
</div>
<p class="sig">
(Fn [(Ref String a), (Ref String b)] String)
</p>
<pre class="args">
(replace-extension p ext)
</pre>
<p class="doc">
<p>replaces the extension of a path <code>p</code> with <code>ext</code>. Adds
an extension if there previously was none.</p> an extension if there previously was none.</p>
</p> </p>
</div>
<div class="binder">
<a class="anchor" href="#search-path-separator">
<h3 id="search-path-separator">
search-path-separator
</h3>
</a>
<div class="description">
def
</div> </div>
<p class="sig"> <div class="binder">
Char <a class="anchor" href="#search-path-separator">
</p> <h3 id="search-path-separator">
<span> search-path-separator
</h3>
</span> </a>
<p class="doc"> <div class="description">
<p>is the separator for the <code>PATH</code> environment def
</div>
<p class="sig">
Char
</p>
<span>
</span>
<p class="doc">
<p>is the separator for the <code>PATH</code> environment
variable we use on this OS.</p> variable we use on this OS.</p>
</p> </p>
</div>
<div class="binder">
<a class="anchor" href="#search-path-separator?">
<h3 id="search-path-separator?">
search-path-separator?
</h3>
</a>
<div class="description">
defn
</div> </div>
<p class="sig"> <div class="binder">
(Fn [Char] Bool) <a class="anchor" href="#search-path-separator?">
</p> <h3 id="search-path-separator?">
<pre class="args"> search-path-separator?
(search-path-separator? c) </h3>
</pre> </a>
<p class="doc"> <div class="description">
defn
</p> </div>
</div> <p class="sig">
<div class="binder"> (Fn [Char] Bool)
<a class="anchor" href="#separator"> </p>
<h3 id="separator"> <pre class="args">
separator (search-path-separator? c)
</h3> </pre>
</a> <p class="doc">
<div class="description">
def </p>
</div> </div>
<p class="sig"> <div class="binder">
Char <a class="anchor" href="#separator">
</p> <h3 id="separator">
<span> separator
</h3>
</span> </a>
<p class="doc"> <div class="description">
<p>is the default separator we use on this OS.</p> def
</div>
<p class="sig">
Char
</p>
<span>
</span>
<p class="doc">
<p>is the default separator we use on this OS.</p>
</p> </p>
</div>
<div class="binder">
<a class="anchor" href="#separator?">
<h3 id="separator?">
separator?
</h3>
</a>
<div class="description">
defn
</div> </div>
<p class="sig"> <div class="binder">
(Fn [(Ref Char StaticLifetime)] Bool) <a class="anchor" href="#separator?">
</p> <h3 id="separator?">
<pre class="args"> separator?
(separator? c) </h3>
</pre> </a>
<p class="doc"> <div class="description">
<p>checks whether the character <code>c</code> is a separator for the defn
</div>
<p class="sig">
(Fn [(Ref Char StaticLifetime)] Bool)
</p>
<pre class="args">
(separator? c)
</pre>
<p class="doc">
<p>checks whether the character <code>c</code> is a separator for the
<code>PATH</code> environment variable on this OS.</p> <code>PATH</code> environment variable on this OS.</p>
</p> </p>
</div>
<div class="binder">
<a class="anchor" href="#separators">
<h3 id="separators">
separators
</h3>
</a>
<div class="description">
def
</div> </div>
<p class="sig"> <div class="binder">
(Array Char) <a class="anchor" href="#separators">
</p> <h3 id="separators">
<span> separators
</h3>
</span> </a>
<p class="doc"> <div class="description">
<p>is the possible separators we could use on this OS.</p> def
</div>
<p class="sig">
(Array Char)
</p>
<span>
</span>
<p class="doc">
<p>is the possible separators we could use on this OS.</p>
</p> </p>
</div>
<div class="binder">
<a class="anchor" href="#split">
<h3 id="split">
split
</h3>
</a>
<div class="description">
defn
</div> </div>
<p class="sig"> <div class="binder">
(Fn [(Ref String a)] (Array String)) <a class="anchor" href="#split">
</p> <h3 id="split">
<pre class="args"> split
(split p) </h3>
</pre> </a>
<p class="doc"> <div class="description">
<p>splits the path <code>p</code> into its components.</p> defn
</div>
<p class="sig">
(Fn [(Ref String a)] (Array String))
</p>
<pre class="args">
(split p)
</pre>
<p class="doc">
<p>splits the path <code>p</code> into its components.</p>
<p>As such, it is the inverse to <a href="#join">join</a>.</p> <p>As such, it is the inverse to <a href="#join">join</a>.</p>
</p> </p>
</div>
<div class="binder">
<a class="anchor" href="#split-extension">
<h3 id="split-extension">
split-extension
</h3>
</a>
<div class="description">
defn
</div> </div>
<p class="sig"> <div class="binder">
(Fn [(Ref String a)] (Maybe (Pair String String))) <a class="anchor" href="#split-extension">
</p> <h3 id="split-extension">
<pre class="args"> split-extension
(split-extension p) </h3>
</pre> </a>
<p class="doc"> <div class="description">
<p>splits the path <code>p</code> on its extension.</p> defn
</div>
<p class="sig">
(Fn [(Ref String a)] (Maybe (Pair String String)))
</p>
<pre class="args">
(split-extension p)
</pre>
<p class="doc">
<p>splits the path <code>p</code> on its extension.</p>
<p>It will return a <code>(Maybe (Pair String String))</code>. <code>Maybe</code> because there might not <p>It will return a <code>(Maybe (Pair String String))</code>. <code>Maybe</code> because there might not
be an extension, and <code>Pair</code> because it will return the part before and after be an extension, and <code>Pair</code> because it will return the part before and after
the extension.</p> the extension.</p>
@@ -514,27 +525,28 @@ the extension.</p>
; =&gt; (Maybe.Just (Pair &quot;file/path.txt.bob&quot; &quot;fred&quot;)) ; =&gt; (Maybe.Just (Pair &quot;file/path.txt.bob&quot; &quot;fred&quot;))
</code></pre> </code></pre>
</p> </p>
</div>
<div class="binder">
<a class="anchor" href="#split-search-path">
<h3 id="split-search-path">
split-search-path
</h3>
</a>
<div class="description">
defn
</div> </div>
<p class="sig"> <div class="binder">
(Fn [(Ref String a)] (Array String)) <a class="anchor" href="#split-search-path">
</p> <h3 id="split-search-path">
<pre class="args"> split-search-path
(split-search-path p) </h3>
</pre> </a>
<p class="doc"> <div class="description">
<p>splits a <code>PATH</code> environment variable <code>p</code>.</p> defn
</div>
<p class="sig">
(Fn [(Ref String a)] (Array String))
</p>
<pre class="args">
(split-search-path p)
</pre>
<p class="doc">
<p>splits a <code>PATH</code> environment variable <code>p</code>.</p>
</p> </p>
</div>
</div> </div>
</div> </div>
</body> </body>

4
path.carp
View File

@@ -3,7 +3,7 @@
## Installation ## Installation
```clojure ```clojure
(load \"https://veitheller.de/git/carpentry/path@0.0.3\") (load \"git@git.veitheller.de:carpentry/path.git@0.0.4\")
``` ```
### Usage ### Usage
@@ -148,5 +148,5 @@ an extension if there previously was none.")
(defn split-search-path [p] (String.split-by p &[search-path-separator])) (defn split-search-path [p] (String.split-by p &[search-path-separator]))
(doc get-search-path "gets the `PATH` environment variable and splits it.") (doc get-search-path "gets the `PATH` environment variable and splits it.")
(defn get-search-path [] (defn get-search-path []
(Maybe.apply (IO.getenv @"PATH") &(fn [p] (split-search-path &p)))) (Maybe.apply (IO.getenv "PATH") &(fn [p] (split-search-path &p))))
) )