semigroupoids-do (empty) → 1.0

raw patch · 6 files changed

+449/−0 lines, 6 filesdep +basedep +semigroupoidssetup-changed

Dependencies added: base, semigroupoids

Files

• CHANGELOG.md +5/−0
• LICENSE.md +201/−0
• README.md +86/−0
• Setup.hs +3/−0
• semigroupoids-do.cabal +42/−0
• src/Semigroupoids/Do.hs +112/−0

@@ -0,0 +1,5 @@+# Revision history for semigroupoids-do++## 1.0 -- 2021-09-26++* First version. Released on an unsuspecting world.

@@ -0,0 +1,201 @@+Apache License+                           Version 2.0, January 2004+                        http://www.apache.org/licenses/++   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION++   1. Definitions.++      "License" shall mean the terms and conditions for use, reproduction,+      and distribution as defined by Sections 1 through 9 of this document.++      "Licensor" shall mean the copyright owner or entity authorized by+      the copyright owner that is granting the License.++      "Legal Entity" shall mean the union of the acting entity and all+      other entities that control, are controlled by, or are under common+      control with that entity. For the purposes of this definition,+      "control" means (i) the power, direct or indirect, to cause the+      direction or management of such entity, whether by contract or+      otherwise, or (ii) ownership of fifty percent (50%) or more of the+      outstanding shares, or (iii) beneficial ownership of such entity.++      "You" (or "Your") shall mean an individual or Legal Entity+      exercising permissions granted by this License.++      "Source" form shall mean the preferred form for making modifications,+      including but not limited to software source code, documentation+      source, and configuration files.++      "Object" form shall mean any form resulting from mechanical+      transformation or translation of a Source form, including but+      not limited to compiled object code, generated documentation,+      and conversions to other media types.++      "Work" shall mean the work of authorship, whether in Source or+      Object form, made available under the License, as indicated by a+      copyright notice that is included in or attached to the work+      (an example is provided in the Appendix below).++      "Derivative Works" shall mean any work, whether in Source or Object+      form, that is based on (or derived from) the Work and for which the+      editorial revisions, annotations, elaborations, or other modifications+      represent, as a whole, an original work of authorship. For the purposes+      of this License, Derivative Works shall not include works that remain+      separable from, or merely link (or bind by name) to the interfaces of,+      the Work and Derivative Works thereof.++      "Contribution" shall mean any work of authorship, including+      the original version of the Work and any modifications or additions+      to that Work or Derivative Works thereof, that is intentionally+      submitted to Licensor for inclusion in the Work by the copyright owner+      or by an individual or Legal Entity authorized to submit on behalf of+      the copyright owner. For the purposes of this definition, "submitted"+      means any form of electronic, verbal, or written communication sent+      to the Licensor or its representatives, including but not limited to+      communication on electronic mailing lists, source code control systems,+      and issue tracking systems that are managed by, or on behalf of, the+      Licensor for the purpose of discussing and improving the Work, but+      excluding communication that is conspicuously marked or otherwise+      designated in writing by the copyright owner as "Not a Contribution."++      "Contributor" shall mean Licensor and any individual or Legal Entity+      on behalf of whom a Contribution has been received by Licensor and+      subsequently incorporated within the Work.++   2. Grant of Copyright License. Subject to the terms and conditions of+      this License, each Contributor hereby grants to You a perpetual,+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable+      copyright license to reproduce, prepare Derivative Works of,+      publicly display, publicly perform, sublicense, and distribute the+      Work and such Derivative Works in Source or Object form.++   3. Grant of Patent License. Subject to the terms and conditions of+      this License, each Contributor hereby grants to You a perpetual,+      worldwide, non-exclusive, no-charge, royalty-free, irreocable+      (except as stated in this section) patent license to make, have made,+      use, offer to sell, sell, import, and otherwise transfer the Work,+      where such license applies only to those patent claims licensable+      by such Contributor that are necessarily infringed by their+      Contribution(s) alone or by combination of their Contribution(s)+      with the Work to which such Contribution(s) was submitted. If You+      institute patent litigation against any entity (including a+      cross-claim or counterclaim in a lawsuit) alleging that the Work+      or a Contribution incorporated within the Work constitutes direct+      or contributory patent infringement, then any patent licenses+      granted to You under this License for that Work shall terminate+      as of the date such litigation is filed.++   4. Redistribution. You may reproduce and distribute copies of the+      Work or Derivative Works thereof in any medium, with or without+      modifications, and in Source or Object form, provided that You+      meet the following conditions:++      (a) You must give any other recipients of the Work or+          Derivative Works a copy of this License; and++      (b) You must cause any modified files to carry prominent notices+          stating that You changed the files; and++      (c) You must retain, in the Source form of any Derivative Works+          that You distribute, all copyright, patent, trademark, and+          attribution notices from the Source form of the Work,+          excluding those notices that do not pertain to any part of+          the Derivative Works; and++      (d) If the Work includes a "NOTICE" text file as part of its+          distribution, then any Derivative Works that You distribute must+          include a readable copy of the attribution notices contained+          within such NOTICE file, excluding those notices that do not+          pertain to any part of the Derivative Works, in at least one+          of the following places: within a NOTICE text file distributed+          as part of the Derivative Works; within the Source form or+          documentation, if provided along with the Derivative Works; or,+          within a display generated by the Derivative Works, if and+          wherever such third-party notices normally appear. The contents+          of the NOTICE file are for informational purposes only and+          do not modify the License. You may add Your own attribution+          notices within Derivative Works that You distribute, alongside+          or as an addendum to the NOTICE text from the Work, provided+          that such additional attribution notices cannot be construed+          as modifying the License.++      You may add Your own copyright statement to Your modifications and+      may provide additional or different license terms and conditions+      for use, reproduction, or distribution of Your modifications, or+      for any such Derivative Works as a whole, provided Your use,+      reproduction, and distribution of the Work otherwise complies with+      the conditions stated in this License.++   5. Submission of Contributions. Unless You explicitly state otherwise,+      any Contribution intentionally submitted for inclusion in the Work+      by You to the Licensor shall be under the terms and conditions of+      this License, without any additional terms or conditions.+      Notwithstanding the above, nothing herein shall supersede or modify+      the terms of any separate license agreement you may have executed+      with Licensor regarding such Contributions.++   6. Trademarks. This License does not grant permission to use the trade+      names, trademarks, service marks, or product names of the Licensor,+      except as required for reasonable and customary use in describing the+      origin of the Work and reproducing the content of the NOTICE file.++   7. Disclaimer of Warranty. Unless required by applicable law or+      agreed to in writing, Licensor provides the Work (and each+      Contributor provides its Contributions) on an "AS IS" BASIS,+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+      implied, including, without limitation, any warranties or conditions+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+      PARTICULAR PURPOSE. You are solely responsible for determining the+      appropriateness of using or redistributing the Work and assume any+      risks associated with Your exercise of permissions under this License.++   8. Limitation of Liability. In no event and under no legal theory,+      whether in tort (including negligence), contract, or otherwise,+      unless required by applicable law (such as deliberate and grossly+      negligent acts) or agreed to in writing, shall any Contributor be+      liable to You for damages, including any direct, indirect, special,+      incidental, or consequential damages of any character arising as a+      result of this License or out of the use or inability to use the+      Work (including but not limited to damages for loss of goodwill,+      work stoppage, computer failure or malfunction, or any and all+      other commercial damages or losses), even if such Contributor+      has been advised of the possibility of such damages.++   9. Accepting Warranty or Additional Liability. While redistributing+      the Work or Derivative Works thereof, You may choose to offer,+      and charge a fee for, acceptance of support, warranty, indemnity,+      or other liability obligations and/or rights consistent with this+      License. However, in accepting such obligations, You may act only+      on Your own behalf and on Your sole responsibility, not on behalf+      of any other Contributor, and only if You agree to indemnify,+      defend, and hold each Contributor harmless for any liability+      incurred by, or claims asserted against, such Contributor by reason+      of your accepting any such warranty or additional liability.++   END OF TERMS AND CONDITIONS++   APPENDIX: How to apply the Apache License to your work.++      To apply the Apache License to your work, attach the following+      boilerplate notice, with the fields enclosed by brackets "[]"+      replaced with your own identifying information. (Don't include+      the brackets!)  The text should be enclosed in the appropriate+      comment syntax for the file format. We also recommend that a+      file or class name and description of purpose be included on the+      same "printed page" as the copyright notice for easier+      identification within third-party archives.++   Copyright [yyyy] [name of copyright owner]++   Licensed under the Apache License, Version 2.0 (the "License");+   you may not use this file except in compliance with the License.+   You may obtain a copy of the License at++       http://www.apache.org/licenses/LICENSE-2.0++   Unless required by applicable law or agreed to in writing, software+   distributed under the License is distributed on an "AS IS" BASIS,+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+   See the License for the specific language governing permissions and+   limitations under the License.

@@ -0,0 +1,86 @@+# `semigroupoids-do` ++## What is this thing?++With GHC 9, we finally got the+[QualifiedDo](https://ghc.gitlab.haskell.org/ghc/doc/users_guide/exts/qualified_do.html)+extension, allowing us to overload do-notation in a convenient way. This has a+range of uses; in our case, we are interested in being able to use do-notation+in a more general context than would normally be possible.++[`semigroupoids`](https://hackage.haskell.org/package/semigroupoids) as a+package is designed to generalize certain common type classes, such as+`Applicative` and `Monad`. This can be convenient: for example, something could +be an `Apply` or `Bind`, but not an `Applicative` or `Monad` if no sensible +definition for `pure` exists. However, without the convenience of do-notation, +such instances mean significantly less, as they are awkward to use. This is an +unnecessary restriction at least in this example, as nothing about do-notation+requires `pure`.++In this package, we provide a set of definitions suitable for use with+`QualifiedDo`, generalizing all the necessary operations to their+`semigroupoids` equivalents. Specifically:++* It is now possible to use do-notation when you only have a+  [`Bind`](https://hackage.haskell.org/package/semigroupoids-5.3.5/docs/Data-Functor-Bind.html#t:Bind).+* With `ApplicativeDo`, in some cases, you can use do-notation when you only+  have an+  [`Apply`](https://hackage.haskell.org/package/semigroupoids-5.3.5/docs/Data-Functor-Bind.html#t:Apply),+  subject to the same conditions as using `Applicative` for do-notation.+* You can use refutable patterns when you only have+  [`Plus`](https://hackage.haskell.org/package/semigroupoids-5.3.5/docs/Data-Functor-Plus.html#t:Plus).++## What are the goals of this project?++Our only goal is to provide `QualifiedDo` support for `semigroupoid`+generalizations; no more, no less.++## How do I use this?++```haskell+{-# LANGUAGE QualifiedDo #-}++module MyModule where++import Data.Functor.Bind (Bind)+import qualified Semigroupoids.Do as S++foo :: (Bind m) => m a+foo = S.do+  ...+```++## Wait, haven't I seen this somewhere before?++You are probably thinking of+[`semigroupoids-syntax`](https://hackage.haskell.org/package/semigroupoids-syntax).+It is true that we take inspiration from it. However, we differ from it in a+couple of ways:++* We only support the subset of syntax modification allowed by `QualifiedDo`;+  `semigroupoids-syntax` goes beyond this, supplying a range of+  `RebindableSyntax` capabilities.+* `semigroupoids-syntax` hasn't been updated since 2014.+* `semigroupoids-syntax` has support going back to much older GHCs; we limit+  ourselves only to GHCs that have `QualifiedDo`.++In short, this is a maintained, small, and simple package, to do only one task.++## What does this run on?++We support (and CI check) only those versions of GHC which support+`QualifiedDo`. Currently, that list is:++* 9.0.1++We check on the following platforms:++* Windows+* Linux+* MacOS++## What can I do with this?++The project is licensed Apache 2.0 (SPDX code+[`Apache-2.0`](https://spdx.org/licenses/Apache-2.0.html)). For more details,+please see the `LICENSE.md` file.

@@ -0,0 +1,3 @@+import Distribution.Simple++main = defaultMain

@@ -0,0 +1,42 @@+cabal-version:      3.0+name:               semigroupoids-do+version:            1.0+synopsis:           Support for QualifiedDo with semigroupoids classes.+description:+  Provides support for QualifiedDo using the more generalized type classes from+  the semigroupoids package.++homepage:           https://github.com/kozross/semigroupoids-do+license:            Apache-2.0+license-file:       LICENSE.md+author:             Koz Ross+maintainer:         koz.ross@retro-freedom.nz+bug-reports:        https://github.com/kozross/semigroupoids-do/issues+copyright:          (C) Koz Ross 2021+category:           Semigroupoids+tested-with:        GHC ==9.0.1+build-type:         Simple+extra-source-files:+  CHANGELOG.md+  README.md++-- Common section++common lang+  ghc-options:+    -Wall -Wcompat -Wincomplete-record-updates+    -Wincomplete-uni-patterns -Wredundant-constraints+    -Wmissing-export-lists -Wmissing-deriving-strategies++  default-language: Haskell2010++-- Library++library+  import:          lang+  exposed-modules: Semigroupoids.Do+  build-depends:+    , base           >=4.15  && <5+    , semigroupoids  ^>=5.3.5++  hs-source-dirs:  src

@@ -0,0 +1,112 @@+{-# LANGUAGE KindSignatures #-}+{-# LANGUAGE ScopedTypeVariables #-}++-- |+-- Module: Semigroupoids.Do+-- Copyright: (C) Koz Ross 2021+-- License: Apache 2.0+-- Maintainer: koz.ross@retro-freedom.nz+-- Stability: Experimental+-- Portability: GHC only+--+-- Provides definitions needed to use do-notation (by way of @QualifiedDo@)+-- using the more general type classes provided by @semigroupoids@.+--+-- To use this module, enable @QualifiedDo@, import this module qualified, and+-- then prefix @do@ with the qualified name:+--+-- > {-# LANGUAGE QualifiedDo #-}+-- >+-- > module MyModule where+-- >+-- > import Data.Functor.Bind (Bind)+-- > import qualified Semigroupoids.Do as S+-- >+-- > foo :: (Bind m) => m a+-- > foo = S.do+-- >  ...+--+-- This module is designed to work correctly (and similarly generally) with+-- @ApplicativeDo@ and @RecursiveDo@ (inasfar as that is possible).+module Semigroupoids.Do+  ( (>>=),+    (>>),+    fail,+    fmap,+    (<*>),+    join,+    mfix,+    return,+  )+where++import Control.Monad.Fix (mfix)+import Data.Functor.Apply (Apply ((<.>)))+import Data.Functor.Bind (Bind ((>>-)))+import qualified Data.Functor.Bind as Bind+import Data.Functor.Plus (Plus (zero))+import Data.Kind (Type)+import Prelude hiding+  ( fail,+    return,+    (<*>),+    (>>),+    (>>=),+  )++-- | @since 1.0+(>>=) ::+  forall (m :: Type -> Type) (a :: Type) (b :: Type).+  (Bind m) =>+  m a ->+  (a -> m b) ->+  m b+(>>=) = (>>-)++-- | @since 1.0+(>>) ::+  forall (m :: Type -> Type) (a :: Type) (b :: Type).+  (Bind m) =>+  m a ->+  m b ->+  m b+x >> y = x >>- const y++-- | = Important note+--+-- This /ignores/ whatever 'String' you give it. It is a bad idea to use 'fail'+-- as a form of labelled error; instead, it should only be defaulted to when a+-- pattern match fails.+--+-- @since 1.0+fail ::+  forall (m :: Type -> Type) (a :: Type).+  (Plus m) =>+  String ->+  m a+fail _ = zero++-- | @since 1.0+(<*>) ::+  forall (f :: Type -> Type) (a :: Type) (b :: Type).+  (Apply f) =>+  f (a -> b) ->+  f a ->+  f b+(<*>) = (<.>)++-- | @since 1.0+join ::+  forall (m :: Type -> Type) (a :: Type).+  (Bind m) =>+  m (m a) ->+  m a+join = Bind.join++-- | @since 1.0+return ::+  forall (f :: Type -> Type) (a :: Type).+  (Applicative f) =>+  a ->+  f a+return = pure