freer-simple/changelog.md

# Change Log

All notable changes to this project will be documented in this file.

## [Unreleased]

* Introducing `replaceRelay` and `replaceRelayS`.
  [PR #27](https://github.com/IxpertaSolutions/freer-effects/pull/27)
* Fix: `Control.Monad.forever` causes `<<loop>>`
  [#23](https://github.com/IxpertaSolutions/freer-effects/issues/23)

## [0.3.0.0] (March 06, 2017)

* Package renamed to `freer-effects` to distinguish it from original `freer`.
  [#4](https://github.com/IxpertaSolutions/freer-effects/issues/4)
* Fix `Could not deduce: effs ~ (r : rs)` that may occur when using
  a `Member` contraint (a regression introduced in 0.2.4.0)
  [freer!12](https://gitlab.com/queertypes/freer/merge_requests/12)
* Add `runNatS` convenience function
  [freer!13](https://gitlab.com/queertypes/freer/merge_requests/13)
* Add `evalState` and `execState` convenience functions
  [freer!14](https://gitlab.com/queertypes/freer/merge_requests/14)
* Data constructors of `Yield`, `CutFalse`, `Fresh`, `State` and `Trace`
  are now exposed in addition to `Exc`, `Reader` and `Writer`
* Generalised type signature of `asks`.
  [#7](https://github.com/IxpertaSolutions/freer-effects/issues/7)
* Renamed modules `Data.Open.Union.*` to `Data.OpenUnion.*`.
  [#8](https://github.com/IxpertaSolutions/freer-effects/issues/8)
* `NonDetEff` separated into its own module and renamed to `NonDet`.
  [#11](https://github.com/IxpertaSolutions/freer-effects/issues/11)
* Reimplement `Union` using
  <http://okmij.org/ftp/Haskell/extensible/OpenUnion51.hs> as a basis.
  [#14](https://github.com/IxpertaSolutions/freer-effects/issues/14)
* Renamed `Teletype` example DSL to `Console`.

## [0.2.4.1] (November 25, 2016)

* Restore GHC (7.8, 7.10) compatibility

## 0.2.4.0 (November 25, 2016)

* Internal reorg
  * In particular, hide implementation details in Union.Internal
  * Rewrite interpreters in terms of `extract` instead of `decomp`
* Add `runNat` convenience function

## 0.2.3.0 (June 25, 2016)

* Add GHC 8 support

## 0.2.2.2 (Sep. 14, 2015)

* Use local `data Nat` for `Data.Open.Union`
  * Using GHC.TypeLits lead to overlapping instances

## 0.2.2.1 (Sep. 14, 2015)

* Document ALL THE THINGS

## 0.2.2.0 (Sep. 13, 2015)

* Add bench suite

## 0.2.1.0 (Sep. 13, 2015)

* Add test suite

## 0.2.0.2 (Sep. 12, 2015)

* Clean up language extensions per file
* Add Teletype DSL to the README

## 0.2.0.1 (Sep. 12, 2015)

* Add Teletype DSL example
* Expose `send` in public interface

## 0.2.0.0 (Sep. 12, 2015)

* Implement NonDetEff
* Separate Cut/Coroutine out from Internals
  * Partial implementation: won't compile yet
* Extract remaining examples from Internal comments

## 0.1.1.0 (Sep. 12, 2015)

* Warnings clean up
* Examples separated from primary implementation
* Initial project documentation added

## 0.1.0.0 (Sep. 12, 2015)

* Initial release

[Unreleased]: https://github.com/IxpertaSolutions/freer/compare/0.3.0.0...HEAD
[0.3.0.0]: https://github.com/IxpertaSolutions/freer/compare/0.2.4.1...0.3.0.0
[0.2.4.1]: https://github.com/IxpertaSolutions/freer/compare/0.2.4.0...0.2.4.1
README/changelog/cabal cleanup 2017-01-28 14:00:16 +03:00			`# Change Log`
Updated changelog regarding #4 and #7 2017-02-02 22:53:37 +03:00
README/changelog/cabal cleanup 2017-01-28 14:00:16 +03:00			`All notable changes to this project will be documented in this file.`

Recreated section for unreleased changes in ChangeLog 2017-03-06 03:21:00 +03:00			`## [Unreleased]`

Coding style; updated ChangeLog 2017-03-15 12:59:34 +03:00			* Introducing `replaceRelay` and `replaceRelayS`.
			`[PR #27](https://github.com/IxpertaSolutions/freer-effects/pull/27)`
Updated ChangeLog regarding issue #23 Addresses #23 2017-03-15 13:05:01 +03:00			* Fix: `Control.Monad.forever` causes `<<loop>>`
			`[#23](https://github.com/IxpertaSolutions/freer-effects/issues/23)`
Coding style; updated ChangeLog 2017-03-15 12:59:34 +03:00
Updated changelog for 0.3.0.0 release 2017-03-06 02:59:56 +03:00			`## [0.3.0.0] (March 06, 2017)`
README/changelog/cabal cleanup 2017-01-28 14:00:16 +03:00
Updated changelog regarding #4 and #7 2017-02-02 22:53:37 +03:00			* Package renamed to `freer-effects` to distinguish it from original `freer`.
			`[#4](https://github.com/IxpertaSolutions/freer-effects/issues/4)`
Fix "Could not deduce: effs ~ (r : rs)" errors Commit 42604669292e093e41005792791f89a772fa518c added the "r has at least two elements" constraint to the `Member' t r ('S n)` instance but `Member t effs` with a general (unknown) effs isn't enough to deduce that effs is non-empty, so this doesn't typecheck: f :: Eff (IO ': effs) () -> Eff effs () f = undefined g :: (Member Maybe effs) => Eff effs () g = undefined h :: (Member Maybe effs) => Eff effs () h = f g GHC complains that it could not deduce: `effs ~ (r : rs)` arising from the use of `g`. It can be worked around by using this instead: h :: (Member Maybe (e ': es)) => Eff (e ': es) () h = f g but I don't think this is a good user experience, and it's a regression from 0.2.3.0 that would normally require a major version bump to 0.3 as it breaks existing code. Therefore a fix should go in quickly and should get into lts-7 asap. This commit adds the "effs is non-empty" constraint to `Member t effs` so the above typechecks again. 2017-01-05 12:29:55 +03:00			* Fix `Could not deduce: effs ~ (r : rs)` that may occur when using
			a `Member` contraint (a regression introduced in 0.2.4.0)
Fix gitlab refs in changelog gitlab really does have separate number series for merge requests and issues. 2017-02-06 14:28:32 +03:00			`[freer!12](https://gitlab.com/queertypes/freer/merge_requests/12)`
Add `runNatS` convenience function `runNatS` is to `runNat` as `handleRelayS` is to `handleRelay`. 2017-01-16 22:21:38 +03:00			* Add `runNatS` convenience function
Fix gitlab refs in changelog gitlab really does have separate number series for merge requests and issues. 2017-02-06 14:28:32 +03:00			`[freer!13](https://gitlab.com/queertypes/freer/merge_requests/13)`
Update changelog 2017-01-29 13:20:16 +03:00			* Add `evalState` and `execState` convenience functions
Fix gitlab refs in changelog gitlab really does have separate number series for merge requests and issues. 2017-02-06 14:28:32 +03:00			`[freer!14](https://gitlab.com/queertypes/freer/merge_requests/14)`
Expose data constructors of all included effects I've seen people use unsafeCoerce to write their own interpreter for the State effect. Ugh. :-) https://github.com/trskop/freer-extra/blob/d27099c8ee69e12c983de91a5886d76503429f17/src/Control/Monad/Freer/State/Extra.hs#L95 2017-01-28 14:36:15 +03:00			* Data constructors of `Yield`, `CutFalse`, `Fresh`, `State` and `Trace`
			are now exposed in addition to `Exc`, `Reader` and `Writer`
Updated changelog regarding #4 and #7 2017-02-02 22:53:37 +03:00			* Generalised type signature of `asks`.
			`[#7](https://github.com/IxpertaSolutions/freer-effects/issues/7)`
Renamed modules `Data.Open.Union.` to `Data.OpenUnion.` Each hierarchical part of module name should be significant, in its own right. In case of Data.Open.Union the Open part doesn't make much sense on its own. Resolves #8 2017-02-02 23:31:24 +03:00			* Renamed modules `Data.Open.Union.` to `Data.OpenUnion.`.
			`[#8](https://github.com/IxpertaSolutions/freer-effects/issues/8)`
Issue #11 Separate and rename `NonDetEff` 2017-02-16 16:24:44 +03:00			* `NonDetEff` separated into its own module and renamed to `NonDet`.
			`[#11](https://github.com/IxpertaSolutions/freer-effects/issues/11)`
Update README and changelog regarding OpenUnion51 Closes #14 2017-03-03 00:45:28 +03:00			* Reimplement `Union` using
			`<http://okmij.org/ftp/Haskell/extensible/OpenUnion51.hs> as a basis.`
			`[#14](https://github.com/IxpertaSolutions/freer-effects/issues/14)`
Rename Teletype in examples to Console 2017-03-03 18:23:51 +03:00			* Renamed `Teletype` example DSL to `Console`.
Fix "Could not deduce: effs ~ (r : rs)" errors Commit 42604669292e093e41005792791f89a772fa518c added the "r has at least two elements" constraint to the `Member' t r ('S n)` instance but `Member t effs` with a general (unknown) effs isn't enough to deduce that effs is non-empty, so this doesn't typecheck: f :: Eff (IO ': effs) () -> Eff effs () f = undefined g :: (Member Maybe effs) => Eff effs () g = undefined h :: (Member Maybe effs) => Eff effs () h = f g GHC complains that it could not deduce: `effs ~ (r : rs)` arising from the use of `g`. It can be worked around by using this instead: h :: (Member Maybe (e ': es)) => Eff (e ': es) () h = f g but I don't think this is a good user experience, and it's a regression from 0.2.3.0 that would normally require a major version bump to 0.3 as it breaks existing code. Therefore a fix should go in quickly and should get into lts-7 asap. This commit adds the "effs is non-empty" constraint to `Member t effs` so the above typechecks again. 2017-01-05 12:29:55 +03:00
README/changelog/cabal cleanup 2017-01-28 14:00:16 +03:00			`## [0.2.4.1] (November 25, 2016)`
fix: GHC 7.8 and 7.10 compatibility 2016-11-25 12:21:34 +03:00
			`* Restore GHC (7.8, 7.10) compatibility`

README/changelog/cabal cleanup 2017-01-28 14:00:16 +03:00			`## 0.2.4.0 (November 25, 2016)`
release: 0.2.4.0 2016-11-25 09:46:19 +03:00
			`* Internal reorg`
			`* In particular, hide implementation details in Union.Internal`
			* Rewrite interpreters in terms of `extract` instead of `decomp`
README/changelog/cabal cleanup 2017-01-28 14:00:16 +03:00			* Add `runNat` convenience function
release: 0.2.4.0 2016-11-25 09:46:19 +03:00
README/changelog/cabal cleanup 2017-01-28 14:00:16 +03:00			`## 0.2.3.0 (June 25, 2016)`
add: GHC 8 support 2016-06-25 22:08:34 +03:00
			`* Add GHC 8 support`

README/changelog/cabal cleanup 2017-01-28 14:00:16 +03:00			`## 0.2.2.2 (Sep. 14, 2015)`
release(0.2.2.2): fix Open.Union 2015-09-14 10:29:11 +03:00
			* Use local `data Nat` for `Data.Open.Union`
			`* Using GHC.TypeLits lead to overlapping instances`

README/changelog/cabal cleanup 2017-01-28 14:00:16 +03:00			`## 0.2.2.1 (Sep. 14, 2015)`
release(0.2.2.1): documentation 2015-09-14 10:08:03 +03:00
			`* Document ALL THE THINGS`

README/changelog/cabal cleanup 2017-01-28 14:00:16 +03:00			`## 0.2.2.0 (Sep. 13, 2015)`
add: bench support 2015-09-13 12:51:27 +03:00
			`* Add bench suite`

README/changelog/cabal cleanup 2017-01-28 14:00:16 +03:00			`## 0.2.1.0 (Sep. 13, 2015)`
release(0.2.1.0): add test suite 2015-09-13 08:00:16 +03:00
			`* Add test suite`

README/changelog/cabal cleanup 2017-01-28 14:00:16 +03:00			`## 0.2.0.2 (Sep. 12, 2015)`
release(0.2.0.2): Teletype, cleanup 2015-09-12 22:14:47 +03:00
			`* Clean up language extensions per file`
			`* Add Teletype DSL to the README`

README/changelog/cabal cleanup 2017-01-28 14:00:16 +03:00			`## 0.2.0.1 (Sep. 12, 2015)`
add(0.2.0): NonDetEff; more clean up * Implement NonDetEff * Separate Cut/Coroutine out from Internals * Partial implementation: won't compile yet * Extract remaining examples from Internal comments 2015-09-12 11:01:16 +03:00
release(0.2.0.1): Teletype example 2015-09-12 22:04:59 +03:00			`* Add Teletype DSL example`
			* Expose `send` in public interface

README/changelog/cabal cleanup 2017-01-28 14:00:16 +03:00			`## 0.2.0.0 (Sep. 12, 2015)`
release(0.2.0.1): Teletype example 2015-09-12 22:04:59 +03:00
add(0.2.0): NonDetEff; more clean up * Implement NonDetEff * Separate Cut/Coroutine out from Internals * Partial implementation: won't compile yet * Extract remaining examples from Internal comments 2015-09-12 11:01:16 +03:00			`* Implement NonDetEff`
			`* Separate Cut/Coroutine out from Internals`
			`* Partial implementation: won't compile yet`
			`* Extract remaining examples from Internal comments`

README/changelog/cabal cleanup 2017-01-28 14:00:16 +03:00			`## 0.1.1.0 (Sep. 12, 2015)`
docs: README, CoC, changelog 2015-09-12 09:41:06 +03:00
			`* Warnings clean up`
			`* Examples separated from primary implementation`
			`* Initial project documentation added`

README/changelog/cabal cleanup 2017-01-28 14:00:16 +03:00			`## 0.1.0.0 (Sep. 12, 2015)`
docs: README, CoC, changelog 2015-09-12 09:41:06 +03:00
			`* Initial release`
README/changelog/cabal cleanup 2017-01-28 14:00:16 +03:00
Recreated section for unreleased changes in ChangeLog 2017-03-06 03:21:00 +03:00			`[Unreleased]: https://github.com/IxpertaSolutions/freer/compare/0.3.0.0...HEAD`
Updated changelog for 0.3.0.0 release 2017-03-06 02:59:56 +03:00			`[0.3.0.0]: https://github.com/IxpertaSolutions/freer/compare/0.2.4.1...0.3.0.0`
README/changelog/cabal cleanup 2017-01-28 14:00:16 +03:00			`[0.2.4.1]: https://github.com/IxpertaSolutions/freer/compare/0.2.4.0...0.2.4.1`