7 Commits
0.0.1 ... 0.0.3

Author SHA1 Message Date
4bf3e1c7c1 fix for new carp 2021-01-19 10:55:37 +01:00
2d62dee4d0 docs: fix links between absolute? and relative? 2020-05-09 22:06:20 +02:00
3eb542bdfd simplify tests 2020-05-05 14:33:45 +02:00
5b87d0bf9a fix tests for new version of carp 2020-05-05 13:57:56 +02:00
c822d2142e release 0.0.3 2020-02-12 11:43:10 +01:00
b80015bc4d update for new carp 2020-02-12 11:42:14 +01:00
b343ce830b add license 2020-01-25 16:36:33 +01:00
6 changed files with 63 additions and 45 deletions

21
LICENSE Normal file
View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2020 Veit Heller
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

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.1") (load "https://veitheller.de/git/carpentry/path@0.0.2")
``` ```
### Usage ### Usage

View File

@@ -31,7 +31,7 @@
<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.1&quot;) <pre><code class="language-clojure">(load &quot;https://veitheller.de/git/carpentry/path@0.0.2&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
@@ -70,7 +70,7 @@ has some functions to work with the <code>PATH</code> environment variable.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [&amp;String] (Maybe String)) (λ [(Ref String a)] (Maybe String))
</p> </p>
<pre class="args"> <pre class="args">
(absolute p) (absolute p)
@@ -90,14 +90,14 @@ has some functions to work with the <code>PATH</code> environment variable.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [&amp;String] Bool) (λ [(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 +111,7 @@ has some functions to work with the <code>PATH</code> environment variable.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [&amp;String, &amp;String] String) (λ [(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 +131,7 @@ has some functions to work with the <code>PATH</code> environment variable.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [&amp;String] String) (λ [(Ref String a)] String)
</p> </p>
<pre class="args"> <pre class="args">
(basename p) (basename p)
@@ -172,7 +172,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">
(λ [&amp;String] String) (λ [(Ref String a)] String)
</p> </p>
<pre class="args"> <pre class="args">
(drop-extension p) (drop-extension p)
@@ -193,7 +193,7 @@ is none.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [&amp;String] (Maybe String)) (λ [(Ref String a)] (Maybe String))
</p> </p>
<pre class="args"> <pre class="args">
(extension p) (extension p)
@@ -213,7 +213,7 @@ is none.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [&amp;String] (Maybe String)) (λ [(Ref String a)] (Maybe String))
</p> </p>
<pre class="args"> <pre class="args">
(filename p) (filename p)
@@ -254,7 +254,7 @@ is none.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [&amp;String] Bool) (λ [(Ref String a)] Bool)
</p> </p>
<pre class="args"> <pre class="args">
(has-extension? p) (has-extension? p)
@@ -274,7 +274,7 @@ is none.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [&amp;String, &amp;String] Bool) (λ [(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 +294,7 @@ is none.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [(Ref (Array String))] String) (λ [(Ref (Array String) a)] String)
</p> </p>
<pre class="args"> <pre class="args">
(join ps) (join ps)
@@ -335,14 +335,14 @@ is none.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [&amp;String] Bool) (λ [(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 +356,7 @@ is none.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [&amp;String, &amp;String] String) (λ [(Ref String a), (Ref String b)] String)
</p> </p>
<pre class="args"> <pre class="args">
(replace-extension p ext) (replace-extension p ext)
@@ -437,7 +437,7 @@ variable we use on this OS.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [&amp;Char] Bool) (λ [(Ref Char StaticLifetime)] Bool)
</p> </p>
<pre class="args"> <pre class="args">
(separator? c) (separator? c)
@@ -478,7 +478,7 @@ variable we use on this OS.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [&amp;String] (Array String)) (λ [(Ref String a)] (Array String))
</p> </p>
<pre class="args"> <pre class="args">
(split p) (split p)
@@ -499,7 +499,7 @@ variable we use on this OS.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [&amp;String] (Maybe (Pair String String))) (λ [(Ref String a)] (Maybe (Pair String String)))
</p> </p>
<pre class="args"> <pre class="args">
(split-extension p) (split-extension p)
@@ -536,7 +536,7 @@ the extension.</p>
defn defn
</div> </div>
<p class="sig"> <p class="sig">
(λ [&amp;String] (Array String)) (λ [(Ref String a)] (Array String))
</p> </p>
<pre class="args"> <pre class="args">
(split-search-path p) (split-search-path p)

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)

View File

@@ -3,7 +3,7 @@
## Installation ## Installation
```clojure ```clojure
(load \"https://veitheller.de/git/carpentry/path@0.0.1\") (load \"https://veitheller.de/git/carpentry/path@0.0.2\")
``` ```
### 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
@@ -85,7 +85,7 @@ It will return `Nothing` if an empty string is passed.")
(doc basename "gets the basename of the path `p`.") (doc basename "gets the basename of the path `p`.")
(defn basename [p] (defn basename [p]
(let [split (split p) (let [split (split p)
but-last (Array.prefix-array &split (dec (Array.length &split)))] but-last (Array.prefix &split (dec (Array.length &split)))]
(String.join sep-string &but-last))) (String.join sep-string &but-last)))
(doc split-extension "splits the path `p` on its extension. (doc split-extension "splits the path `p` on its extension.
@@ -113,7 +113,7 @@ Examples on POSIX:
(let [i (Pattern.find extension-pat p)] (let [i (Pattern.find extension-pat p)]
(if (= -1 i) (if (= -1 i)
(Maybe.Nothing) (Maybe.Nothing)
(Maybe.Just (Pair.init (prefix-string p i) (suffix-string p (inc i))))))) (Maybe.Just (Pair.init (prefix p i) (suffix p (inc i)))))))
(doc extension "gets the extension of a file as a `Maybe`.") (doc extension "gets the extension of a file as a `Maybe`.")
(defn extension [p] (defn extension [p]
@@ -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]))

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