Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/missingfaktor/akar
First-class patterns for Clojure. Made with love, functions, and just the right amount of syntax.
https://github.com/missingfaktor/akar
clojure functional-programming pattern-matching
Last synced: 4 days ago
JSON representation
First-class patterns for Clojure. Made with love, functions, and just the right amount of syntax.
- Host: GitHub
- URL: https://github.com/missingfaktor/akar
- Owner: missingfaktor
- License: apache-2.0
- Created: 2015-10-24T01:00:45.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-07-29T21:16:33.000Z (5 months ago)
- Last Synced: 2024-12-15T04:06:34.797Z (11 days ago)
- Topics: clojure, functional-programming, pattern-matching
- Language: Clojure
- Homepage:
- Size: 3.38 MB
- Stars: 176
- Watchers: 18
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Akar
[](https://clojars.org/akar)
[](https://clojars.org/akar/akar-core)
[](https://clojars.org/akar/akar-exceptions)
[](https://clojars.org/akar/akar-commons)
> \[Speech]
> Queen: Hmm...
>
> *Who's been painting my roses red?*
> *Who's been painting my roses red?*
>
> *Who dares to taint with vulgar paint*
> *the royal flower bed?*
>
> *For painting my roses red*
> *someone will lose his head.*
>
> \[Spoken]
> **Three:** Oh no, your majesty, please, it's all his fault!
> **Two:** Not me, Your Grace. The Ace! The Ace!
> **Queen:** You?
> **Ace:** No, Two!
> **Queen:** The Deuce, you say?
> **Two:** Not me, the Tres!
> **Queen:** That's enough! **Off with their heads!**
Akar is a [pattern matching](https://en.wikibooks.org/wiki/Haskell/Pattern_matching) library for Clojure, with focus on simplicity and abstraction.
Akar patterns are first-class values (just functions, actually), that can be manipulated, composed, abstracted over, like any other values. In fact, this is exactly how various pattern operations, such as guards, alternation, and views are implemented in Akar.
The library also features a syntactic layer that makes common use cases convenient, but at the same time stays true to the first-class spirit of the core model.
Akar (IPA: \[ɑkɑɾ], Devanagari: आकार) is a Sanskrit/Marathi word for shape. The logo is a [Saraswati](https://en.wikipedia.org/wiki/Saraswati) [Kolam](https://en.wikipedia.org/wiki/Kolam), a diagrammatic representation of Hindu goddess of wisdom.
To learn more, read the [Akar tutorial](TUTORIAL.md) and [FAQs](FAQs.md).
## Releases and Dependency Information
```clojure
# Specific Akar projects
[akar/akar-core "3.0.0"]
# All Akar projects
[akar "3.0.0"]
```
## Example
```clojure
(ns your.app
(:require [akar.syntax :refer [match]]
[clojure.data.xml :as xml]))
; Example borrowed from https://wiki.scala-lang.org/display/SYGN/Xml-pattern-matching
(defn italics [xml-node]
(match xml-node
{:tag :i :content (:seq [contents])} (println contents)
{:tag :node :content nodes} (doseq [child nodes] (italics child))
:_ nil))
(def xml-doc
(xml/parse (java.io.StringReader.
"
This is some text content.
This is deeper stuff.
I am some text.
I am a title.
This is a sentence with an italicized entry.
")))
(italics xml-doc)
; prints:
; some
; deeper
; italicized
```
## Contributing
Do you wish to contribute to Akar? Splendid! Get started [here](CONTRIBUTING.md).
## License
Copyright © 2024 Rahul Goma Phulore
Distributed under Apache License 2.0.