Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/green-coder/diffuse
Diffuse is a library to create, use and manipulate diffs, to build the change you wish to see in your data.
https://github.com/green-coder/diffuse
clojure clojurescript data-structures diff
Last synced: 6 days ago
JSON representation
Diffuse is a library to create, use and manipulate diffs, to build the change you wish to see in your data.
- Host: GitHub
- URL: https://github.com/green-coder/diffuse
- Owner: green-coder
- License: epl-2.0
- Created: 2020-08-04T17:39:02.000Z (over 4 years ago)
- Default Branch: made-in-taiwan
- Last Pushed: 2024-07-23T18:18:23.000Z (5 months ago)
- Last Synced: 2024-12-09T05:47:58.257Z (15 days ago)
- Topics: clojure, clojurescript, data-structures, diff
- Language: Clojure
- Homepage:
- Size: 67.4 KB
- Stars: 48
- Watchers: 8
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## Diffuse
[](https://circleci.com/gh/green-coder/diffuse)
[](https://clojars.org/diffuse)
[](https://cljdoc.org/d/diffuse/diffuse/CURRENT)
[](https://clojars.org/diffuse)
> “We but mirror the world. All the tendencies present in the
> outer world are to be found in the world of our body.
> If we could change ourselves, the tendencies in the world would also change.
> As a man changes his own nature, so does the attitude of the world
> change towards him. This is the divine mystery supreme.
> A wonderful thing it is and the source of our happiness.
> We need not wait to see what others do.”
>
> – Mahatma Gandhi
Diffuse is a library to create, use and manipulate diffs,
to build the change you wish to see in your data.
### Usage
#### Create diffs
Diffs are pure data. You can create them via some helper functions or write them directly.
```clojure
(require '[diffuse.helper :as h])
(h/map-assoc
:foo "hello"
:bar [1 2 3])
;=> {:type :map
; :key-op {:foo [:assoc "hello"]
; :bar [:assoc [1 2 3]]}}
(h/map-update
:who/members (h/set-conj :country/taiwan))
;=> {:type :map
; :key-op {:who/members [:update {:type :set
; :conj #{:country/taiwan}}]}}
```
#### Operate on diffs
```clojure
(require '[diffuse.core :as d])
;; Combine diffs together to get a new diff.
(d/comp-diff diff-1 diff-2)
;; Apply a diff to get an updated data.
(d/apply-diff data diff)
```
#### Example
On sets:
```clojure
(d/apply-diff #{:pam :poum}
(d/comp-diff (h/set-disj :pam)
(h/set-conj :pim)))
;=> #{:pim :poum}
```
On maps:
```clojure
(d/apply-diff {:a 2, :c #{1}, :d 4}
(d/comp-diff (h/map-dissoc :d)
(h/map-update :c (h/set-conj 2))
(h/map-assoc :a 1, :b 2)))
;=> {:a 1, :b 2, :c #{1 2}}
```
On vectors:
```clojure
;; With diffuse, you can correct the ISO 3166 which is plainly wrong.
;; https://www.change.org/p/iso-change-the-present-taiwan-province-of-china-to-taiwan-4
(d/apply-diff '[Taiwan province of China])
(h/vec-remove 1 3))
;=> [Taiwan]
;; You can also correct it with true official information, regardless of how confusing it can be.
(d/apply-diff '[Taiwan province of China]
(h/vec-assoc 1 'Republic))
;=> [Taiwan Republic of China]
;; You can also declare your love for Taiwan.
(d/apply-diff '[Taiwan province of China]
(h/vec-remsert 1 3 '[number 1 !!!]))
;=> [Taiwan number 1 !!!]
;; You can also use it to promote the best beer of Taiwan.
(d/apply-diff '[Taiwan province of China]
(d/comp-diff (h/vec-remove 1 3)
(h/vec-insert 1 '[number 1 !!!])
(h/vec-insert 1 '[Beer])))
;=> [Taiwan Beer number 1 !!!]
```
### Use cases
You certainly wonder why this library was built, that's understandable.
Sometimes things exist, are beautiful, and still don't make sense. That's how it is.
If you really want to find an answer to your question, ask deep inside yourself ... why ??
Please open an issue if you find an answer, sharing is caring.
### Other diff libraries
The focus of Diffuse is to:
- manually build a representation of data structure differences,
- compose them together,
- and apply them on data (this action is also known as "patching").
You use Diffuse when you know the difference and want to use it,
hence the name "diff ... use".
On the opposite, When you have 2 versions of a data structure and
you don't know their difference, you can calculate it via one of
those libraries:
- [deep-diff2](https://github.com/lambdaisland/deep-diff2)
- [Editscript](https://github.com/juji-io/editscript), whose
author wrote the very useful blogpost
"[Comparing Clojure Diff Libraries](https://juji.io/blog/comparing-clojure-diff-libraries/)".
### Status
Alpha quality, lack of error messages, tested, no known bug, usable.
Note: While still in alpha, the API and data format may change.
### License
The Diffuse library is developed by Vincent Cantin.
It is distributed under the terms of the Eclipse Public License version 2.0.