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

Compare commits

base: carpentry:0.0.2
Branches Tags
carpentry:master
carpentry:0.0.3 carpentry:0.0.2 carpentry:0.0.1
..
compare: carpentry:master
Branches Tags
carpentry:master
carpentry:0.0.3 carpentry:0.0.2 carpentry:0.0.1

6 Commits
0.0.2 ... master

Author SHA1 Message Date
Veit Heller
c734c582d4 fix for newest carp 2022-01-27 12:01:03 +01:00
hellerve
03aab46ab5 update docs 2021-01-19 10:56:58 +01:00
hellerve
4bf3e1c7c1 fix for new carp 2021-01-19 10:55:37 +01:00
hellerve
2d62dee4d0 docs: fix links between absolute? and relative? 2020-05-09 22:06:20 +02:00
hellerve
3eb542bdfd simplify tests 2020-05-05 14:33:45 +02:00
hellerve
5b87d0bf9a fix tests for new version of carp 2020-05-05 13:57:56 +02:00
5 changed files with 467 additions and 468 deletions
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.2") (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/>

52
docs/Path.html
View File

@@ -9,8 +9,8 @@
<body> <body>
<div class="content"> <div class="content">
<div class="logo"> <div class="logo">
<a href="http://github.com/carp-lang/Carp"> <a href="">
<img src="logo.png"> <img src="">
</a> </a>
<div class="title"> <div class="title">
path path
@@ -25,13 +25,14 @@
</ul> </ul>
</div> </div>
</div> </div>
<div class="module">
<h1> <h1>
Path Path
</h1> </h1>
<div class="module-description"> <div class="module-description">
<p>is a simple file path library for Carp.</p> <p>is a simple file path library for Carp.</p>
<h2>Installation</h2> <h2>Installation</h2>
<pre><code class="language-clojure">(load &quot;https://veitheller.de/git/carpentry/path@0.0.2&quot;) <pre><code class="language-clojure">(load &quot;git@git.veitheller.de:carpentry/path.git@0.0.4&quot;)
</code></pre> </code></pre>
<h3>Usage</h3> <h3>Usage</h3>
<p>The <code>Path</code> module mostly operates on <code>String</code> arguments. It allows you to <p>The <code>Path</code> module mostly operates on <code>String</code> arguments. It allows you to
@@ -50,7 +51,7 @@ has some functions to work with the <code>PATH</code> environment variable.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [a, b] String) (Fn [a, b] String)
</p> </p>
<pre class="args"> <pre class="args">
(&lt;/&gt; before after) (&lt;/&gt; before after)
@@ -70,7 +71,7 @@ has some functions to work with the <code>PATH</code> environment variable.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [(Ref String a)] (Maybe String)) (Fn [(Ref String a)] (Maybe String))
</p> </p>
<pre class="args"> <pre class="args">
(absolute p) (absolute p)
@@ -90,14 +91,14 @@ has some functions to work with the <code>PATH</code> environment variable.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [(Ref String a)] Bool) (Fn [(Ref String a)] Bool)
</p> </p>
<pre class="args"> <pre class="args">
(absolute? p) (absolute? p)
</pre> </pre>
<p class="doc"> <p class="doc">
<p>checks whether a path is absolute.</p> <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>
@@ -111,7 +112,7 @@ has some functions to work with the <code>PATH</code> environment variable.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [(Ref String a), (Ref String b)] String) (Fn [(Ref String a), (Ref String b)] String)
</p> </p>
<pre class="args"> <pre class="args">
(add-extension p ext) (add-extension p ext)
@@ -131,7 +132,7 @@ has some functions to work with the <code>PATH</code> environment variable.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [(Ref String a)] String) (Fn [(Ref String a)] String)
</p> </p>
<pre class="args"> <pre class="args">
(basename p) (basename p)
@@ -151,7 +152,7 @@ has some functions to work with the <code>PATH</code> environment variable.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [] (Maybe String)) (Fn [] (Maybe String))
</p> </p>
<pre class="args"> <pre class="args">
(cwd) (cwd)
@@ -172,7 +173,7 @@ which it can fail are OS-dependent, but it should happen relatively rare.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [(Ref String a)] String) (Fn [(Ref String a)] String)
</p> </p>
<pre class="args"> <pre class="args">
(drop-extension p) (drop-extension p)
@@ -193,7 +194,7 @@ is none.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [(Ref String a)] (Maybe String)) (Fn [(Ref String a)] (Maybe String))
</p> </p>
<pre class="args"> <pre class="args">
(extension p) (extension p)
@@ -213,7 +214,7 @@ is none.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [(Ref String a)] (Maybe String)) (Fn [(Ref String a)] (Maybe String))
</p> </p>
<pre class="args"> <pre class="args">
(filename p) (filename p)
@@ -234,7 +235,7 @@ is none.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [] (Maybe (Array String))) (Fn [] (Maybe (Array String)))
</p> </p>
<pre class="args"> <pre class="args">
(get-search-path) (get-search-path)
@@ -254,7 +255,7 @@ is none.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [(Ref String a)] Bool) (Fn [(Ref String a)] Bool)
</p> </p>
<pre class="args"> <pre class="args">
(has-extension? p) (has-extension? p)
@@ -274,7 +275,7 @@ is none.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [(Ref String a), (Ref String b)] Bool) (Fn [(Ref String a), (Ref String b)] Bool)
</p> </p>
<pre class="args"> <pre class="args">
(is-extension? p ext) (is-extension? p ext)
@@ -294,7 +295,7 @@ is none.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [(Ref (Array String) a)] String) (Fn [(Ref (Array String) a)] String)
</p> </p>
<pre class="args"> <pre class="args">
(join ps) (join ps)
@@ -335,14 +336,14 @@ is none.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [(Ref String a)] Bool) (Fn [(Ref String a)] Bool)
</p> </p>
<pre class="args"> <pre class="args">
(relative? p) (relative? p)
</pre> </pre>
<p class="doc"> <p class="doc">
<p>checks whether a path is relative.</p> <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>
@@ -356,7 +357,7 @@ is none.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [(Ref String a), (Ref String b)] String) (Fn [(Ref String a), (Ref String b)] String)
</p> </p>
<pre class="args"> <pre class="args">
(replace-extension p ext) (replace-extension p ext)
@@ -398,7 +399,7 @@ variable we use on this OS.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [Char] Bool) (Fn [Char] Bool)
</p> </p>
<pre class="args"> <pre class="args">
(search-path-separator? c) (search-path-separator? c)
@@ -437,7 +438,7 @@ variable we use on this OS.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [(Ref Char StaticLifetime)] Bool) (Fn [(Ref Char StaticLifetime)] Bool)
</p> </p>
<pre class="args"> <pre class="args">
(separator? c) (separator? c)
@@ -478,7 +479,7 @@ variable we use on this OS.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [(Ref String a)] (Array String)) (Fn [(Ref String a)] (Array String))
</p> </p>
<pre class="args"> <pre class="args">
(split p) (split p)
@@ -499,7 +500,7 @@ variable we use on this OS.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [(Ref String a)] (Maybe (Pair String String))) (Fn [(Ref String a)] (Maybe (Pair String String)))
</p> </p>
<pre class="args"> <pre class="args">
(split-extension p) (split-extension p)
@@ -536,7 +537,7 @@ the extension.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [(Ref String a)] (Array String)) (Fn [(Ref String a)] (Array String))
</p> </p>
<pre class="args"> <pre class="args">
(split-search-path p) (split-search-path p)
@@ -547,5 +548,6 @@ the extension.</p>
</p> </p>
</div> </div>
</div> </div>
</div>
</body> </body>
</html> </html>

15
gendocs.carp
View File

@@ -1,13 +1,10 @@
(load "path.carp") (load "path.carp")
(defndynamic gendocs [] (Project.config "title" "path")
(do (Project.config "docs-directory" "./docs/")
(Project.config "title" "path") (Project.config "docs-logo" "")
(Project.config "docs-directory" "./docs/") (Project.config "docs-styling" "style.css")
(Project.config "docs-logo" "") (Project.config "docs-generate-index" false)
(Project.config "docs-styling" "style.css") (save-docs Path)
(Project.config "docs-generate-index" false)
(save-docs Path)))
(gendocs)
(quit) (quit)

16
path.carp
View File

@@ -3,7 +3,7 @@
## Installation ## Installation
```clojure ```clojure
(load \"https://veitheller.de/git/carpentry/path@0.0.2\") (load \"git@git.veitheller.de:carpentry/path.git@0.0.4\")
``` ```
### Usage ### Usage
@@ -16,7 +16,7 @@ It assumes either Windows or POSIX-style separators.")
(defmodule Path (defmodule Path
(doc absolute? "checks whether a path is absolute. (doc absolute? "checks whether a path is absolute.
As such, it is the inverse to [relative](#relative).") As such, it is the inverse to [relative?](#relative?).")
(doc separator "is the default separator we use on this OS.") (doc separator "is the default separator we use on this OS.")
(doc separators "is the possible separators we could use on this OS.") (doc separators "is the possible separators we could use on this OS.")
(doc search-path-separator "is the separator for the `PATH` environment (doc search-path-separator "is the separator for the `PATH` environment
@@ -32,7 +32,7 @@ variable we use on this OS.")
(def search-path-separator \;) (def search-path-separator \;)
(def extension-pat #"\.[^\\/\.]*$") (def extension-pat #"\.[^\\/\.]*$")
(def sep-string "\\")) (def sep-string "\\"))
(not-on-windows (posix-only
(defn absolute? [p] (String.starts-with? p "/")) (defn absolute? [p] (String.starts-with? p "/"))
(def separator \/) (def separator \/)
(def separators [\/]) (def separators [\/])
@@ -42,7 +42,7 @@ variable we use on this OS.")
(doc relative? "checks whether a path is relative. (doc relative? "checks whether a path is relative.
As such, it is the inverse to [absolute](#absolute).") As such, it is the inverse to [absolute?](#absolute?).")
(defn relative? [p] (not (absolute? p))) (defn relative? [p] (not (absolute? p)))
(doc separator? "checks whether the character `c` is a path separator on this (doc separator? "checks whether the character `c` is a path separator on this
@@ -127,9 +127,9 @@ Examples on POSIX:
(doc drop-extension "drops the extension of a path `p`. Does nothing if there (doc drop-extension "drops the extension of a path `p`. Does nothing if there
is none.") is none.")
(defn drop-extension [p] (defn drop-extension [p]
@(match (split-extension p) (match (split-extension p)
(Maybe.Nothing) p (Maybe.Nothing) @p
(Maybe.Just pair) (Pair.a &pair))) (Maybe.Just pair) @(Pair.a &pair)))
(doc add-extension "adds an extension `ext` to a path `p`.") (doc add-extension "adds an extension `ext` to a path `p`.")
(defn add-extension [p ext] (String.concat &[@p @"." @ext])) (defn add-extension [p ext] (String.concat &[@p @"." @ext]))
@@ -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))))
) )

14
test/path.carp
View File

@@ -3,7 +3,7 @@
(use-all Path Test) (use-all Path Test)
(if (not (Dynamic.or (= "windows" (os)) (= "mingw32" (os)))) (posix-only
(deftest test (deftest test
(assert-equal test (assert-equal test
"path/joined" "path/joined"
@@ -41,11 +41,11 @@
"cwd works" "cwd works"
) )
; TODO why does this test not work? ; TODO why does this test not work?
;(assert-equal test (assert-equal test
; "file" "file"
; &(drop-extension "file.txt") &(drop-extension "file.txt")
; "drop-extension works if there is an extension" "drop-extension works if there is an extension"
;) )
(assert-equal test (assert-equal test
"file" "file"
&(drop-extension "file") &(drop-extension "file")
@@ -87,7 +87,7 @@
) )
) )
()) ())
(if (Dynamic.or (= "windows" (os)) (= "mingw32" (os))) (windows-only
(deftest test (deftest test
(assert-true test (assert-true test
false false