diff --git a/box.cabal b/box.cabal --- a/box.cabal +++ b/box.cabal @@ -1,6 +1,6 @@ cabal-version: 3.0 name: box -version: 0.9.3.2 +version: 0.9.3.3 license: BSD-3-Clause license-file: LICENSE copyright: Tony Day (c) 2017 @@ -11,68 +11,90 @@ bug-reports: https://github.com/tonyday567/box/issues synopsis: A profunctor effect system? description: - This might be a profunctor effect system, but is unlike all the others, so it's hard to say for sure. + This might be a profunctor effect system, but is unlike all the others, so it's hard to say for sure. + build-type: Simple tested-with: - , GHC == 9.10.1 - , GHC == 9.8.2 - , GHC == 9.6.5 + ghc ==9.6.7 + ghc ==9.8.4 + ghc ==9.10.2 + ghc ==9.12.2 + extra-doc-files: - ChangeLog.md - readme.md + ChangeLog.md + readme.md source-repository head - type: git - location: https://github.com/tonyday567/box + type: git + location: https://github.com/tonyday567/box common ghc-options-stanza - ghc-options: - -Wall - -Wcompat - -Wincomplete-record-updates - -Wincomplete-uni-patterns - -Wredundant-constraints + ghc-options: + -Wall + -Wcompat + -Wincomplete-record-updates + -Wincomplete-uni-patterns + -Wredundant-constraints -common ghc2021-stanza - default-language: GHC2021 +common ghc2024-additions + default-extensions: + DataKinds + DerivingStrategies + DisambiguateRecordFields + ExplicitNamespaces + GADTs + LambdaCase + MonoLocalBinds + RoleAnnotations +common ghc2024-stanza + if impl(ghc >=9.10) + default-language: + GHC2024 + else + import: ghc2024-additions + default-language: + GHC2021 + library - import: ghc-options-stanza - import: ghc2021-stanza - hs-source-dirs: src - build-depends: - , async >=2.2 && <2.3 - , base >=4.7 && <5 - , bytestring >=0.11.3 && <0.13 - , containers >=0.6 && <0.8 - , contravariant >=1.5 && <1.6 - , dlist >=1.0 && <1.1 - , exceptions >=0.10 && <0.11 - , kan-extensions >=5.2 && <5.3 - , mtl >=2.2.2 && <2.4 - , profunctors >=5.6.2 && <5.7 - , semigroupoids >=5.3 && <6.1 - , stm >=2.5.1 && <2.6 - , text >=1.2 && <2.2 - , time >=1.10 && <1.15 - exposed-modules: - Box - Box.Box - Box.Codensity - Box.Committer - Box.Connectors - Box.Emitter - Box.Functor - Box.IO - Box.Queue - Box.Time + import: ghc-options-stanza + import: ghc2024-stanza + hs-source-dirs: src + build-depends: + async >=2.2 && <2.3, + base >=4.7 && <5, + bytestring >=0.11.3 && <0.13, + containers >=0.6 && <0.9, + contravariant >=1.5 && <1.6, + dlist >=1.0 && <1.1, + exceptions >=0.10 && <0.11, + kan-extensions >=5.2 && <5.3, + mtl >=2.2.2 && <2.4, + profunctors >=5.6.2 && <5.7, + semigroupoids >=5.3 && <6.1, + stm >=2.5.1 && <2.6, + text >=1.2 && <2.2, + time >=1.10 && <1.15, + exposed-modules: + Box + Box.Box + Box.Codensity + Box.Committer + Box.Connectors + Box.Emitter + Box.Functor + Box.IO + Box.Queue + Box.Time + test-suite doctests - import: ghc2021-stanza - main-is: doctests.hs - hs-source-dirs: test - build-depends: - , base >=4.14 && <5 - , doctest-parallel >=0.3 && <0.4 - ghc-options: -threaded - type: exitcode-stdio-1.0 + import: ghc2024-stanza + main-is: doctests.hs + hs-source-dirs: test + build-depends: + base >=4.14 && <5, + doctest-parallel >=0.3 && <0.5, + + ghc-options: -threaded + type: exitcode-stdio-1.0 diff --git a/readme.md b/readme.md --- a/readme.md +++ b/readme.md @@ -6,8 +6,6 @@ > What is all this stuff around me; this stream of experiences that I seem to be having all the time? Throughout history there have been people who say it is all illusion. ~ S Blackmore - - # Usage :set -XOverloadedStrings @@ -43,13 +41,8 @@ echo: echo - - # Library Design - - - ### Resource Coinduction Haskell has an affinity with [coinductive functions](https://www.reddit.com/r/haskell/comments/j3kbge/comment/g7foelq/?utm_source=share&utm_medium=web2x&context=3); functions should expose destructors and allow for infinite data. @@ -66,9 +59,6 @@ These are the destructors that need to be transparently exposed if effects are to be good citizens in Haskell. - - - ### What is a Box? A Box is simply the product of a consumer destructor and a producer destructor. @@ -78,9 +68,6 @@ emitter :: Emitter m e } - - - ### Committer The library denotes a consumer by wrapping a consumption destructor and calling it a Committer. Like much of base, there is failure hidden in the getLine example type. A better approach, for a consumer, is to signal whether consumption actually occurred. @@ -106,9 +93,6 @@ echoC :: Committer IO Text echoC = contramap (Text.unpack . ("echo: "<>)) stdC - - - ### Emitter The library denotes a producer by wrapping a production destructor and calling it an Emitter. @@ -134,8 +118,6 @@ defined at :49:1 - - ### Box duality A Box represents a duality in two ways: @@ -164,9 +146,6 @@ fuse (pure . pure) stdIO - - - ### Continuation As with many operators in the library, `qList` is actually a continuation: @@ -231,9 +210,6 @@ b c - - - # Explicit Continuation Yield-style streaming libraries are [coroutines](https://rubenpieters.github.io/assets/papers/JFP20-pipes.pdf), sum types that embed and mix continuation logic in with other stuff like effect decontruction. `box` sticks to a corner case of a product type representing a consumer and producer. The major drawback of eschewing coroutines is that continuations become explicit and difficult to hide. One example; taking the first n elements of an Emitter: @@ -251,30 +227,18 @@ glueES :: (Monad m) => s -> Committer m a -> Emitter (StateT s m) a -> m () glueES s c e = flip evalStateT s $ glue (foist lift c) e - - - # Future directions The design and concepts contained within the box library is a hodge-podge, but an interesting mess, being at quite a busy confluence of recent developments. - - - ## Optics A Box is an adapter in the [language of optics](http://www.cs.ox.ac.uk/people/jeremy.gibbons/publications/poptics.pdf) and the relationship between a resource’s committer and emitter could be modelled by other optics. - - - ## Categorical Profunctor The deprecation of Box.Functor awaits the development of [categorical functors](https://github.com/haskell/core-libraries-committee/issues/91#issuecomment-1325337471). Similarly to Filterable the type of a Box could be something like `FunctorOf Op(Kleisli Maybe) (Kleisli Maybe) (->)`. Or it could be something like the SISO type in [Programming with Monoidal Profunctors and Semiarrows](https://papers.ssrn.com/sol3/papers.cfm?abstract_id=4496714). - - - ## Wider Types Alternatively, the types could be widened: @@ -303,9 +267,6 @@ type CommitterB m a = Committer (MaybeT m) a type EmitterB m a = Emitter (MaybeT m) a type BoxB m b a = Box (MaybeT m) (MaybeT m) b a - - - ## Introduce a [nucleus](https://golem.ph.utexas.edu/category/2013/08/the_nucleus_of_a_profunctor_so.html) diff --git a/src/Box/Emitter.hs b/src/Box/Emitter.hs --- a/src/Box/Emitter.hs +++ b/src/Box/Emitter.hs @@ -1,5 +1,3 @@ -{-# LANGUAGE ExplicitNamespaces #-} - -- | 'Emitter' wraps a producer destructor. -- -- "Every Thought emits a Dice Throw" ~ Stéphane Mallarmé diff --git a/src/Box/IO.hs b/src/Box/IO.hs --- a/src/Box/IO.hs +++ b/src/Box/IO.hs @@ -46,7 +46,7 @@ import Data.IORef import Data.Sequence qualified as Seq import Data.String -import Data.Text as Text hiding (null) +import Data.Text as Text hiding (null, show) import Data.Text.Encoding import Data.Text.IO as Text import System.IO as IO