https://github.com/detachhead/kotlinxpath
kotlin typesafe builder for xpath
https://github.com/detachhead/kotlinxpath
hacktoberfest kotlin kotlin-typesafe-builder kotlin-xpath kotlin-xpath-builder xpath xpath-builder xpath-generator
Last synced: 6 months ago
JSON representation
kotlin typesafe builder for xpath
- Host: GitHub
- URL: https://github.com/detachhead/kotlinxpath
- Owner: DetachHead
- Created: 2020-06-06T12:15:57.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-10T11:21:07.000Z (almost 5 years ago)
- Last Synced: 2025-10-14T08:11:43.687Z (9 months ago)
- Topics: hacktoberfest, kotlin, kotlin-typesafe-builder, kotlin-xpath, kotlin-xpath-builder, xpath, xpath-builder, xpath-generator
- Language: Kotlin
- Homepage:
- Size: 500 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# kotlinxpath
A Kotlin typesafe builder for xpath with helpful shortcuts for handling the pain points, such as case sensitivity, quote escaping and HTML-specific helper functions.
[documentation](https://detachhead.github.io/kotlinxpath/kotlinxpath/index.html)
## Example
```kotlin
assertEquals(
"/descendant-or-self::node()/child::div[attribute::id = '1']/child::span",
xpath { any / div[{ attr("id") equal "1" }] / span }.toString()
)
```
## features
### helpers
this library includes several useful shortcuts to help with common patterns.
#### examples
##### textIs
converts all text to lowercase, automatically handles quote escaping and trims any whitespace
```kotlin
assertEquals(
"/descendant-or-self::node()/child::*[translate(normalize-space(self::node()),'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz') = concat('\"That',\"'\",'s mine\", he said.')]",
xpath {
anyNode[textIs("\"That's mine\", he said.")]
}.toString()
)
```
##### hasClass
checks whether the element has the given class
```kotlin
assertEquals(
"/descendant-or-self::node()/child::*[contains(concat(' ',attribute::class,' '),' foo ')]",
xpath { anyNode[hasClass("foo")] }.toString()
)
```
### shims
most implementations of xpath still use xpath 1.0 (including all the modern browsers), so this library includes shims for some functions available in xpath 2+
note: there's only a couple shims in here at the moment. intending to add more in the future.
#### examples
##### lower-case
```kotlin
assertEquals(
"translate('Foo','ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz') = 'foo'",
expression { `lower-case`("Foo") equal "foo" }.toString()
)
```
## setup
in your `build.gradle.kts`:
```kotlin
repositories {
maven("https://detachhead.github.io/maven")
}
```
### multiplatform projects
```kotlin
kotlin {
sourceSets {
val commonMain by getting {
dependencies {
implementation("io.github.detachhead:kotlinxpath:$version")
}
}
}
}
```