https://github.com/parser3/als.path
Path Component.
https://github.com/parser3/als.path
als package parser3
Last synced: 5 months ago
JSON representation
Path Component.
- Host: GitHub
- URL: https://github.com/parser3/als.path
- Owner: parser3
- License: other
- Created: 2016-11-07T17:36:03.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-12-01T08:03:27.000Z (over 9 years ago)
- Last Synced: 2025-10-02T18:47:46.263Z (9 months ago)
- Topics: als, package, parser3
- Language: OpenEdge ABL
- Size: 10.7 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Als/Path
Path Component.
---
## Documentations
### Properties
* [$delimiter](#property-delimiter)
* [$separator](#property-separator)
* [$cwd](#property-cwd)
---
### Methods
* [@basename](#method-basename)
* [@dirname](#method-dirname)
* [@extname](#method-extname)
* [@format](#method-format)
* [@isAbsolute](#method-isAbsolute)
* [@join](#method-join)
* [@normalize](#method-normalize)
* [@parse](#method-parse)
* [@relative](#method-relative)
* [@resolve](#method-resolve)
--------------------------------------------------------------------------------
## $PROPERTY: delimiter
Provides the path delimiter.
---
#### Example
```ruby
${Als/Path:delimiter}
#--> ':'
$env:PATH
#--> '/usr/local/bin:/usr/bin:/bin'
$paths[^env:PATH.split[${Als/Path:delimiter};h]]
#--> |/usr/local/bin|/usr/bin|/bin|
```
--------------------------------------------------------------------------------
## $PROPERTY: separator
Provides the path segment separator.
---
#### Example
```ruby
${Als/Path:separator}
#--> '/'
$path[/assets/images/icons.png]
$parts[^path.split[${Als/Path:separator};h]]
#--> |assets|images|icons.png|
```
--------------------------------------------------------------------------------
## $PROPERTY: cwd
Contains the absolute path of the 'DOCUMENT_ROOT'.
---
#### Example
```ruby
${Als/Path:cwd}
#--> '/home/username/host/www'
```
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
## @METHOD: basename
The `^Als/Path:basename[]` methods returns the last portion of a `path`, similar to the Unix `basename` command.
---
### Syntax
`^Als/Path:basename[path[;ext]]`
### Params
* $path ``
* $ext `` An optional file extension.
### Example
```ruby
^Als/Path:basename[/foo/bar/baz/asdf/quux.html]
#--> 'quux.html'
^Als/Path:basename[/foo/bar/baz/asdf/quux.html;.html]
#--> 'quux'
```
--------------------------------------------------------------------------------
## @METHOD: dirname
The `^Als/Path:dirname[]` method returns the directory name of a `path`, similar to the Unix `dirname` command.
---
### Syntax
`^Als/Path:dirname[path]`
### Params
* $path ``
### Example
```ruby
^Als/Path:dirname[/foo/bar/baz/asdf/quux]
#--> '/foo/bar/baz/asdf'
```
--------------------------------------------------------------------------------
## @METHOD: extname
The `^Als/Path:extname[]` method returns the extension of the `path`, from the last occurance of the `.` (period) character to end of string in the last portion of the `path`. If there is no `.` in the last portion of the `path`, or if the first character of the basename of `path` (see [`^Als/Path:basename[]`](#method-basename)) is `.`, then an empty string is returned.
---
### Syntax
`^Als/Path:extname[path]`
### Params
* $path ``
### Example
```ruby
^Als/Path:extname[index.html]
#--> '.html'
^Als/Path:extname[index.coffee.md]
#--> '.md'
^Als/Path:extname[index.]
#--> '.'
^Als/Path:extname[index]
#--> ''
^Als/Path:extname[.index]
#--> ''
```
--------------------------------------------------------------------------------
## @METHOD: format
The `^Als/Path:format[]` method returns a path string from an ``. This is the opposite of [`^Als/Path:parse[]`](#method-parse).
---
### Syntax
`^Als/Path:format[hPath]`
### Params
* $hPath ``
* $.dir ``
* $.root ``
* $.base ``
* $.name ``
* $.ext ``
---
The following process is used when constructing the path string:
- `$result` is set to an empty string.
- If `$.dir[]` is specified, `$.dir[]` is appended to `$result` followed by the value of [`$Als/Path:separator`](#property-separator);
- Otherwise, if `$.root[]` is specified, `$.root[]` is appended to `$result`.
- If `$.base[]` is specified, `$.base[]` is appended to `$result`;
- Otherwise:
- If `$.name[]` is specified, `$.name[]` is appended to `$result`
- If `$.ext[]` is specified, `$.ext[]` is appended to `$result`.
- Return `$result`
### Example
```ruby
# If 'dir' and 'base' are provided:
# ${dir}${separator}${base}
# will be returned.
^Als/Path:format[
$.dir[/home/user/dir]
$.base[file.txt]
]
//--> '/home/user/dir/file.txt'
# 'root will be used if 'dir' is not specified.
# If only 'root' is provided or 'dir' is equal to 'root'
# then the separator will not be included.
^Als/Path:format[
$.root[/]
$.base[file.txt]
]
#--> '/file.txt'
# `name` + `ext` will be used if `base` is not specified.
^Als/Path:format[
$.root[/]
$.name[file]
$.ext[.txt]
]
#--> '/file.txt'
# `base` will be returned if `dir` or `root` are not provided.
^Als/Path:format[
$.base[file.txt]
]
#--> 'file.txt'
```
--------------------------------------------------------------------------------
## @METHOD: isAbsolute
The `^Als/Path:isAbsolute[]` method determines if `path` is an absolute path.
If the given `path` is a zero-length string, `false` will be returned.
---
### Syntax
`^Als/Path:isAbsolute[path]`
### Params
* path ``
### Example
```ruby
^Als/Path:isAbsolute[/foo/bar]
#--> true
^Als/Path:isAbsolute[/baz/..]
#--> true
^Als/Path:isAbsolute[qux/]
#--> false
^Als/Path:isAbsolute[.]
#--> false
```
--------------------------------------------------------------------------------
## @METHOD: join
The `^Als/Path:join[]` method join all given `path` segments together using the [`$Als/Path:separator`](#property-separator) as a delimiter, then [@normalize](#method-normalize)s the resulting path.
Zero-length `path` segments are ignored. If the joined path string is a zero-length string then `'.'` will be returned, representing the current working directory.
---
### Syntax
`^Als/Path:join[path1;path2[;...]]`
### Params
* path[, ...] `` A sequence of path segments.
### Example
```ruby
^Als/Path:join[/foo;bar;baz/asdf;quux;..]
#--> '/foo/bar/baz/asdf'
^Als/Path:join[foo; $.path[123] ;bar]
#--> throws 'invalid.argument' error.
```
--------------------------------------------------------------------------------
## @METHOD: normalize
The `^Als/Path:normalize[]` method normalizes the given `path`, resolving `'..'` and `'.'` segments.
When multiple, sequential path segment separation characters are found, they are replaced by a single instance of the path segment separator. Trailing separators are preserved.
If the path is a zero-length string, `'.'` is returned, representing the current working directory.
---
### Syntax
`^Als/Path:normalize[path]`
### Params
* path ``
### Example
```ruby
^Als/Path:normalize[/foo/bar//baz/asdf/quux/..]
#--> '/foo/bar/baz/asdf'
```
--------------------------------------------------------------------------------
## @METHOD: parse
The `^Als/Path:parse[]` method returns an `` whose properties represent significant elements of the path.
The returned `` will have the following properties:
* $.root ``
* $.dir ``
* $.base ``
* $.ext ``
* $.name ``
---
### Syntax
`^Als/Path:parse[path]`
### Params
* path ``
### Example
```ruby
^Als/Path:parse[/home/user/dir/file.txt]
#-->
# $.root[/]
# $.dir[/home/user/dir]
# $.base[file.txt]
# $.ext[.txt]
# $.name[file]
```
--------------------------------------------------------------------------------
## @METHOD: relative
The `^Als/Path:relative[]` method returns the relative path from `from` to `to`. If `from` and `to` each resolve to the same path (after calling [`^Als/Path:resolve[]`](#method-resolve) on each), a zero-length string is returned.
If a zero-length string is passed as `from` or `to`, the current working directory will be used instead of the zero-length strings.
---
### Syntax
`^Als/Path:relative[from;to]`
### Params
* from ``
* to ``
### Example
```ruby
^Als/Path:relative[/home/user/test/aaa;/home/user/impl/bbb]
#--> '../../impl/bbb'
```
--------------------------------------------------------------------------------
## @METHOD: resolve
The `^Als/Path:resolve[]` method resolves a sequence of paths or path segments into an absolute path.
The given sequence of paths is processed from right to left, with each subsequent `path` prepended until an absolute path is constructed. For instance, given the sequence of path segments: `/foo`, `/bar`, `baz`, calling `^Als/Path:resolve[/foo;/bar;baz]` would return `/bar/baz`.
If after processing all given `path` segments an absolute path has not yet been generated, the current working directory is used.
The resulting path is normalized and trailing slashes are removed unless the path is resolved to the root directory.
Zero-length `path` segments are ignored.
If no `path` segments are passed, `^Als/Path:resolve[]` will return the absolute path of the current working directory.
---
### Syntax
`^Als/Path:resolve[[path[; ...]]`
### Params
* path[, ...] `` A sequence of paths or path segments
### Example
```ruby
^Als/Path:resolve[/foo/bar;./baz]
#--> '/foo/bar/baz'
^Als/Path:resolve[/foo/bar;/tmp/file/]
#--> '/tmp/file'
# if the current working directory is '/home/myself/node'
^Als/Path:resolve[wwwroot;static_files/png/;../gif/image.gif]
#--> '/home/myself/node/wwwroot/static_files/gif/image.gif'
```
---
---
## References
- Questions to Leonid Knyazev |
- Bug reports and Feature requests to Issues.
---