Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tk3369/BinaryTraits.jl
Can do or not? It's easy. See https://tk3369.github.io/BinaryTraits.jl/dev/
https://github.com/tk3369/BinaryTraits.jl
design-patterns interface julia-language julialang traits
Last synced: 3 months ago
JSON representation
Can do or not? It's easy. See https://tk3369.github.io/BinaryTraits.jl/dev/
- Host: GitHub
- URL: https://github.com/tk3369/BinaryTraits.jl
- Owner: tk3369
- License: mit
- Created: 2020-03-02T07:27:37.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-16T03:32:38.000Z (almost 2 years ago)
- Last Synced: 2024-07-12T16:47:32.356Z (4 months ago)
- Topics: design-patterns, interface, julia-language, julialang, traits
- Language: Julia
- Homepage:
- Size: 1.05 MB
- Stars: 49
- Watchers: 3
- Forks: 3
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-software-engineering - BinaryTraits.jl
README
# BinaryTraits.jl
[](https://tk3369.github.io/BinaryTraits.jl/dev)
[](https://github.com/tk3369/BinaryTraits.jl/actions?query=workflow%3ACI)
[](http://codecov.io/github/tk3369/BinaryTraits.jl?branch=master)
BinaryTraits focuses on usability - traits should be simple to understand and easy to use.
For that reason, every trait is binary. An object either has the trait (positive) or does not
have the trait (negative).
The design is heavily influenced by the Holy Traits pattern as explained in my
[Holy Traits book excerpt](https://ahsmart.com/pub/holy-traits-design-patterns-and-best-practice-book.html)
as well as in Julia manual's
[trait-based dispatch section](https://docs.julialang.org/en/v1/manual/methods/#Trait-based-dispatch-1).
If you think about Holy Traits as the powerful manual transmission, then BinaryTraits
gives you automatic transmission. The machinery is the same but it is a lot more pleasant
to use.
*NOTE:* This package is under active development and we may introduce breaking
changes. Please follow the
[issues list](https://github.com/tk3369/BinaryTraits.jl/issues)
if you would like to contribute to the project or have a stake in
the design.
## Motivation
Just a quick example below. More details can be found
in our [documentation](https://tk3369.github.io/BinaryTraits.jl/dev).
```julia
# Use package and import desired positive/negative trait type aliases
using BinaryTraits
using BinaryTraits.Prefix: Can
# Define a trait and its interface contracts
@trait Fly
@implement Can{Fly} by fly(_, destination::Location, speed::Float64)
# Define your data type and implementation
struct Bird end
fly(::Bird, destination::Location, speed::Float64) = "Wohoo! Arrived! π¦"
# Assign your data type to a trait
@assign Bird with Can{Fly}
# Verify that your implementation is correct
@check(Bird)
# Dispatch for all flying things
@traitfn flap(::Can{Fly}, freq::Float64) = "Flapping wings at $freq Hz"
```
## Main Features
Current features are listed below. Additional features are planned and
logged in the issues list.
* Define traits and assigning them to your own data types
* Define composite traits that exhibits all of the underlying traits
* Define interface contracts required for a trait
* Verify that your data type fully implements all interface contracts
* Define traits/interfaces in one module and use them from another module
* Define trait dispatch functions easily
## Credits
* [Klaus Crusius](https://github.com/KlausC) for his ideas, articulation, and significant contributions to this project
* [JΔnis Erdmanis](https://github.com/akels) for his proposal of a new design based upon parametric types
## Related Projects
There are quite a few traits libraries around. If this package isn't for
you, take a look at these others:
* [Traits.jl](https://github.com/schlichtanders/Traits.jl)
* [SimpleTraits.jl](https://github.com/mauro3/SimpleTraits.jl)
* [CanonicalTraits.jl](https://github.com/thautwarm/CanonicalTraits.jl)
* [TraitWrappers.jl](https://github.com/xiaodaigh/TraitWrappers.jl)