getting rid of Compat

Author: schlichtanders

CHANGELOG.md

@@ -5,8 +5,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
+## [2.0.3] - 2023-07-01
 ### Changed
-- Compat compat now includes version 4
+- got rid of Compat dependency
+
 ## [2.0.2] - 2021-07-17
 ### Changed
 - reverting `Base.catch_backtrace()` to `Base.catch_stack()` everywhere. Apparently this is really only an issue on julia nightly and should not be changed in julia 1.6. Hence reverting everything.
@@ -18,7 +21,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [2.0.0] - 2021-07-15
 ### Added
 - `Base.get` and `Base.getindex` are now both implemented for `Const` (like they are implemented already for `Identity`), to simplify working with `Const`.
-- Vector conversions (`convert`) are now more generic and support AbstractArray in general 
+- Vector conversions (`convert`) are now more generic and support AbstractArray in general
 
 ### Fixed
 - `Option(3)` works now

Project.toml

@@ -3,11 +3,7 @@ uuid = "83eed652-29e8-11e9-12da-a7c29d64ffc9"
 authors = ["Sahm Stephan <stephan.sahm@gmx.de>"]
 version = "2.0.2"
 
-[deps]
-Compat = "34da2185-b29b-5c13-b0c7-acf172513d20"
-
 [compat]
-Compat = "2.1, 3, 4"
 julia = "1.6"
 
 [extras]

README.md

@@ -8,17 +8,31 @@
 This package defines julia implementations for the common types `Option` (aka `Maybe`), `Either` and `Try`, as well as one extra type `ContextManager` which mimics Python's `with`-ContextManager.
 
 
-## Installation
+## Usage
+
+Here an example using `Try` to handle errors programmatically. Similar to `Option`, a `Try` is either a `Const`, denoting an error, or an `Identity`
+value, which denotes success.
 
-The package is soon going to be registered at General, until then you can use it by adding a custom registry.
 ```julia
-using Pkg
-pkg"add DataTypesBasic"
+using DataTypesBasic  # defines Try
+
+@Try div(1, 0)  # Const(Thrown(DivideError()))
+@Try div(8, 3)  # Identity(2)
 ```
 
-Use it like
+Using another helper package [`Monadic`](https://github.com/JuliaFunctional/Monadic.jl/tree/main). We can combine these
+into nice syntax.
 ```julia
-using DataTypesBasic
+using Monadic  # defines @monadic
+
+# flatmap is also defined in TypeClasses.jl
+flatmap(f, x) = Iterators.flatten(map(f, x))
+tryit = @monadic map flatmap begin
+  a = @Try div(8, 3)
+  b = @Try isodd(a) ? 100 + a : error("fail")
+  @pure a, b
+end
+# Const(Thrown(ErrorException("fail")))
 ```
 
 For more details check out the [documentation](https://JuliaFunctional.github.io/DataTypesBasic.jl/dev/).

docs/src/manual.md

@@ -152,7 +152,7 @@ myeither = either("error", 2 > 3, 42)
 fe(myeither)  # "fallback behaviour 'error'"
 ```
 
-You also have support for `Iterators.flatten` in order to work "withing" Either, and combine everything correctly.
+You also have support for `Iterators.flatten` in order to work "within" Either, and combine everything correctly.
 ```julia
 check_threshold(a) = a < 15 ? Const((a, "threshold not reached")) : Identity("checked threshold successfully")
 

src/DataTypesBasic.jl

@@ -39,8 +39,6 @@ export Identity, isidentity, Const,
   Try, @Try, @TryCatch, istry, issuccess, isfailure, Thrown, MultipleExceptions,
   ContextManager, @ContextManager
 
-using Compat
-
 # type definitions
 include("Identity.jl")
 include("Const.jl")