Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wdhowe/clj-contrib
A library of Clojure functions to enhance clojure.core.
https://github.com/wdhowe/clj-contrib
clj clojure lein leiningen
Last synced: about 1 month ago
JSON representation
A library of Clojure functions to enhance clojure.core.
- Host: GitHub
- URL: https://github.com/wdhowe/clj-contrib
- Owner: wdhowe
- License: epl-2.0
- Created: 2021-03-05T01:02:43.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-27T23:51:51.000Z (9 months ago)
- Last Synced: 2024-10-19T18:23:54.776Z (2 months ago)
- Topics: clj, clojure, lein, leiningen
- Language: Clojure
- Homepage:
- Size: 26.4 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# clj-contrib
[![Build Status][gh-actions-badge]][gh-actions] [![Clojars Project][clojars-badge]][clojars] [![Clojure version][clojure-v]](project.clj)
A library of functions to enhance clojure.core.
## Getting Started
Using the clj-contrib library.
### Installation
See [Clojars for adding this library][clojars] to various project types (lein, boot, deps.edn, etc).
### Include the Library
In the REPL
```clojure
(require '[clj-contrib.core :as cc])
(require '[clj-contrib.core.async :as cca])
```
In your application
```clojure
(ns my-app.core
(:require [clj-contrib.core :as cc])
(:require [clj-contrib.core.async :as cca]))
```
### Use the Library
A few usage examples.
clj-contrib.core
```clojure
;;; Simple Values
;; Numbers
; Check if two numbers are within a threshold.
(same-ish? 1.001 1.003 0.005)
;; Booleans
; Get the boolean value of the argument.
(bool "true")
;;; Operations
;; Flow Control
; as->, with the nil checking of some->.
(as-some-> {:one 1, :two 2} mythings
(:one mythings)
(inc mythings)
(str "These " mythings " things and more!"))
;;; Collections
;; Maps
; count the errors in a collection.
(errors [{:error "foo"}, {:success "foo"}])
(errors {:success "foo"})
; count the success (non-errors) in a collection.
(success [{:success "foo"}, {:success "foo"}])
(success {:error "foo"})
```
clj-contrib.core.async
```clojure
;;; loop-until: Take from an async channel and execute a function against the value.
;;; Stop if the function returns falsey or the max is exceeded.
;; Stops early when the :error is encountered.
(let [ch (async/chan)
stop-on-error (fn [result] (println result) (not (contains? result :error)))]
(async/put! ch {:success "some data"})
(async/put! ch {:error "bad data"})
(async/put! ch {:success "more data"})
(async/put! ch {:success "data trifecta"})
(loop-until ch stop-on-error 3))
;; Executes to the max of 3.
(let [ch (async/chan)
stop-on-error (fn [result] (println result) (not (contains? result :error)))]
(async/put! ch {:success "some data"})
(async/put! ch {:success "more data"})
(async/put! ch {:success "data trifecta"})
(async/put! ch {:error "bad data"})
(loop-until ch stop-on-error 3))
```
[gh-actions-badge]: https://github.com/wdhowe/clj-contrib/workflows/ci%2Fcd/badge.svg
[gh-actions]: https://github.com/wdhowe/clj-contrib/actions
[cljdoc-badge]: https://cljdoc.org/badge/com.github.wdhowe/clj-contrib
[cljdoc-link]: https://cljdoc.org/d/com.github.wdhowe/clj-contrib/CURRENT
[clojure-v]: https://img.shields.io/badge/clojure-1.11.1-blue.svg
[clojars]: https://clojars.org/com.github.wdhowe/clj-contrib
[clojars-badge]: https://img.shields.io/clojars/v/com.github.wdhowe/clj-contrib.svg