Merge pull request #15 from phadej/prepare-0.2

Prepare-0.2

Author: phadej

.github/workflows/haskell-ci.yml

@@ -8,9 +8,9 @@
 #
 # For more information, see https://github.com/haskell-CI/haskell-ci
 #
-# version: 0.11.20210101
+# version: 0.11.20210222
 #
-# REGENDATA ("0.11.20210101",["github","cabal.project"])
+# REGENDATA ("0.11.20210222",["github","cabal.project"])
 #
 name: Haskell-CI
 on:
@@ -22,15 +22,17 @@ on:
       - master
 jobs:
   linux:
-    name: Haskell-CI Linux - GHC ${{ matrix.ghc }}
+    name: Haskell-CI - Linux - GHC ${{ matrix.ghc }}
     runs-on: ubuntu-18.04
     container:
       image: buildpack-deps:bionic
     continue-on-error: ${{ matrix.allow-failure }}
     strategy:
       matrix:
         include:
-          - ghc: 8.10.3
+          - ghc: 9.0.1
+            allow-failure: false
+          - ghc: 8.10.4
             allow-failure: false
           - ghc: 8.8.4
             allow-failure: false
@@ -62,7 +64,7 @@ jobs:
           apt-get install -y --no-install-recommends gnupg ca-certificates dirmngr curl git software-properties-common
           apt-add-repository -y 'ppa:hvr/ghc'
           apt-get update
-          apt-get install -y ghc-$GHC_VERSION cabal-install-3.2
+          apt-get install -y ghc-$GHC_VERSION cabal-install-3.4
         env:
           GHC_VERSION: ${{ matrix.ghc }}
       - name: Set PATH and environment variables
@@ -75,12 +77,13 @@ jobs:
           echo "HC=$HC" >> $GITHUB_ENV
           echo "HCPKG=/opt/ghc/$GHC_VERSION/bin/ghc-pkg" >> $GITHUB_ENV
           echo "HADDOCK=/opt/ghc/$GHC_VERSION/bin/haddock" >> $GITHUB_ENV
-          echo "CABAL=/opt/cabal/3.2/bin/cabal -vnormal+nowrap" >> $GITHUB_ENV
+          echo "CABAL=/opt/cabal/3.4/bin/cabal -vnormal+nowrap" >> $GITHUB_ENV
           HCNUMVER=$(${HC} --numeric-version|perl -ne '/^(\d+)\.(\d+)\.(\d+)(\.(\d+))?$/; print(10000 * $1 + 100 * $2 + ($3 == 0 ? $5 != 1 : $3))')
           echo "HCNUMVER=$HCNUMVER" >> $GITHUB_ENV
           if [ $((HCNUMVER >= 70400)) -ne 0 ] ; then echo "ARG_TESTS=--enable-tests" >> $GITHUB_ENV ; else echo "ARG_TESTS=--disable-tests" >> $GITHUB_ENV ; fi
           if [ $((HCNUMVER >= 70400)) -ne 0 ] ; then echo "ARG_BENCH=--enable-benchmarks" >> $GITHUB_ENV ; else echo "ARG_BENCH=--disable-benchmarks" >> $GITHUB_ENV ; fi
-          echo "ARG_COMPILER=--ghc --with-compiler=/opt/ghc/$GHC_VERSION/bin/ghc" >> $GITHUB_ENV
+          echo "HEADHACKAGE=false" >> $GITHUB_ENV
+          echo "ARG_COMPILER=--ghc --with-compiler=$HC" >> $GITHUB_ENV
           echo "GHCJSARITH=0" >> $GITHUB_ENV
         env:
           GHC_VERSION: ${{ matrix.ghc }}
@@ -115,11 +118,6 @@ jobs:
       - name: update cabal index
         run: |
           $CABAL v2-update -v
-      - name: cache (tools)
-        uses: actions/cache@v2
-        with:
-          key: ${{ runner.os }}-${{ matrix.ghc }}-tools-c0007cad
-          path: ~/.haskell-ci-tools
       - name: install cabal-plan
         run: |
           mkdir -p $HOME/.cabal/bin
@@ -129,18 +127,27 @@ jobs:
           rm -f cabal-plan.xz
           chmod a+x $HOME/.cabal/bin/cabal-plan
           cabal-plan --version
-      - name: install doctest
+      - name: install cabal-docspec
         run: |
-          if [ $((HCNUMVER >= 80400)) -ne 0 ] ; then $CABAL --store-dir=$HOME/.haskell-ci-tools/store v2-install $ARG_COMPILER --ignore-project -j2 doctest --constraint='doctest ^>=0.17' ; fi
-          if [ $((HCNUMVER >= 80400)) -ne 0 ] ; then doctest --version ; fi
+          mkdir -p $HOME/.cabal/bin
+          curl -sL https://github.com/phadej/cabal-extras/releases/download/cabal-docspec-0.0.0.20210111/cabal-docspec-0.0.0.20210111.xz > cabal-docspec.xz
+          echo '0829bd034fba901cbcfe491d98ed8b28fd54f9cb5c91fa8e1ac62dc4413c9562  cabal-docspec.xz' | sha256sum -c -
+          xz -d < cabal-docspec.xz > $HOME/.cabal/bin/cabal-docspec
+          rm -f cabal-docspec.xz
+          chmod a+x $HOME/.cabal/bin/cabal-docspec
+          cabal-docspec --version
       - name: checkout
         uses: actions/checkout@v2
         with:
           path: source
+      - name: initial cabal.project for sdist
+        run: |
+          touch cabal.project
+          echo "packages: $GITHUB_WORKSPACE/source/." >> cabal.project
+          cat cabal.project
       - name: sdist
         run: |
           mkdir -p sdist
-          cd source || false
           $CABAL sdist all --output-dir $GITHUB_WORKSPACE/sdist
       - name: unpack
         run: |
@@ -184,10 +191,10 @@ jobs:
       - name: tests
         run: |
           if [ $((HCNUMVER >= 70400)) -ne 0 ] ; then $CABAL v2-test $ARG_COMPILER $ARG_TESTS $ARG_BENCH all --test-show-details=direct ; fi
-      - name: doctest
+      - name: docspec
         run: |
-          if [ $((HCNUMVER >= 80400)) -ne 0 ] ; then cd ${PKGDIR_rere} || false ; fi
-          if [ $((HCNUMVER >= 80400)) -ne 0 ] ; then doctest  src ; fi
+          if [ $((HCNUMVER >= 80400)) -ne 0 ] ; then $CABAL v2-build $ARG_COMPILER $ARG_TESTS $ARG_BENCH all ; fi
+          if [ $((HCNUMVER >= 80400)) -ne 0 ] ; then cabal-docspec $ARG_COMPILER ; fi
       - name: cabal check
         run: |
           cd ${PKGDIR_rere} || false

cabal.haskell-ci

@@ -1,10 +1,10 @@
-branches: master
-tests: >=7.4
+branches:   master
+tests:      >=7.4
 benchmarks: >=7.4
-doctest: >=8.4
+docspec:    >=8.4
 
 constraint-set no-cfg
-  ghc: >=7.8
+  ghc:         >=7.8
   constraints: rere -rere-cfg
 
 constraint-set intersection

changelog.md

@@ -0,0 +1,3 @@
+# 0.2
+
+- Change LaTeX generation output

rere.cabal

@@ -1,7 +1,6 @@
 cabal-version:      2.2
 name:               rere
-version:            0.1
-x-revision:         1
+version:            0.2
 synopsis:
   Regular-expressions extended with fixpoints for context-free powers
 
@@ -14,8 +13,11 @@ author:             Oleg Grenrus <[email protected]>
 maintainer:         Oleg Grenrus <[email protected]>
 license:            BSD-3-Clause
 license-file:       LICENSE
-extra-source-files: jsverify.json
-data-files:         rere.sty
+extra-source-files:
+  changelog.md
+  jsverify.json
+  rere.sty
+
 tested-with:
   GHC ==7.0.4
    || ==7.2.2
@@ -28,49 +30,50 @@ tested-with:
    || ==8.4.4
    || ==8.6.5
    || ==8.8.4
-   || ==8.10.3
+   || ==8.10.4
+   || ==9.0.1
 
 source-repository head
   type:     git
   location: https://github.com/phadej/rere.git
 
 flag rere-cfg
-  description: CFG functionality, needs dependency on fin and vec
+  description: CFG functionality, adds dependency on fin and vec
   default:     True
   manual:      True
 
 flag rere-intersection
-  description: Add add intersection constructor. EXPERIMENTAL
+  description: Add intersection constructor. EXPERIMENTAL
   default:     False
   manual:      True
 
 library
-  default-language: Haskell2010
-  hs-source-dirs:   src
-  ghc-options:      -Wall
+  default-language:  Haskell2010
+  hs-source-dirs:    src
+  ghc-options:       -Wall
 
-  if impl(ghc >=8.10)
+  if impl(ghc >=9)
     ghc-options: -Wmissing-safe-haskell-mode -Winferred-safe-imports
 
-  -- GHC boot library
+  -- GHC boot libraries
   build-depends:
-    , base          >=4.3.0.0  && <4.15
+    , base          >=4.3.0.0  && <4.16
     , containers    ^>=0.4.0.0 || ^>=0.5.0.0 || ^>=0.6.0.1
     , parsec        ^>=3.1.12.0
     , transformers  ^>=0.3.0.0 || ^>=0.4.2.0 || ^>=0.5.2.0
 
   -- other dependencies
-  build-depends:    QuickCheck ^>=2.13.2 || ^>=2.14
+  build-depends:     QuickCheck ^>=2.14.2
 
   -- compat
   if !impl(ghc >=7.10)
-    build-depends: void ^>=0.7.2
+    build-depends: void ^>=0.7.3
 
   if !impl(ghc >=8.0)
-    build-depends: semigroups >=0.18.4 && <0.20
+    build-depends: semigroups >=0.18.5 && <0.20
 
   -- expose examples first, so `cabal repl` loads them.
-  exposed-modules:  RERE.Examples
+  exposed-modules:   RERE.Examples
 
   if (flag(rere-cfg) && impl(ghc >=7.8))
     exposed-modules: RERE.Examples.JSON
@@ -87,20 +90,23 @@ library
     RERE.Type
     RERE.Var
 
-  other-modules:    RERE.Tuples
+  other-modules:     RERE.Tuples
 
   if (flag(rere-cfg) && impl(ghc >=7.8))
     build-depends:
-      , fin  ^>=0.1.1
-      , vec  ^>=0.3
+      , fin  ^>=0.2
+      , vec  ^>=0.4
 
     exposed-modules: RERE.CFG
+
   else
-    cpp-options:     -DRERE_NO_CFG
+    cpp-options: -DRERE_NO_CFG
 
   if flag(rere-intersection)
     cpp-options: -DRERE_INTERSECTION
 
+  x-docspec-options: -XOverloadedStrings
+
 benchmark simple
   type:             exitcode-stdio-1.0
   default-language: Haskell2010
@@ -117,7 +123,7 @@ benchmark simple
     , rere
 
   if !(flag(rere-cfg) && impl(ghc >=7.8))
-    cpp-options:     -DRERE_NO_CFG
+    cpp-options: -DRERE_NO_CFG
 
   if flag(rere-intersection)
     cpp-options: -DRERE_INTERSECTION
@@ -175,7 +181,7 @@ test-suite properties
     , QuickCheck
     , quickcheck-instances  ^>=0.3.22
     , rere
-    , tasty                 ^>=1.2.3 || ^>=1.3.1
+    , tasty                 ^>=1.4.0.1
     , tasty-quickcheck      ^>=0.10.1.1
 
   if flag(rere-intersection)

src/RERE/CFG.hs

@@ -29,6 +29,9 @@ import Data.Traversable (Traversable (..))
 
 -- $setup
 -- >>> :set -XOverloadedStrings
+-- >>> import Data.Fin      (Fin (..))
+-- >>> import Data.Vec.Lazy (Vec (..))
+-- >>> import RERE
 
 -- | Context-free grammar represented as @n@ equations
 -- of 'RE' ('CFGBase') with @n@ variables.

src/RERE/Examples.hs

@@ -43,6 +43,7 @@ import Data.Semigroup (Semigroup (..))
 -- >>> import Test.QuickCheck.Random (mkQCGen)
 -- >>> import Test.QuickCheck.Gen (unGen)
 -- >>> import Control.Monad.ST (runST)
+-- >>> import RERE
 -- >>> let runGen seed = maybe "<<null>>" (\g' -> unGen g' (mkQCGen seed) 10)
 -- >>> let showRef re = matchDebugR re ""
 
@@ -92,11 +93,11 @@ syntaxExamples = do
 -- >>> matchR ex1 "ababa"
 -- False
 --
--- >>> runGen 42 (generate 10 20 ex1)
--- "ababab"
+-- >>> runGen 43 (generate 10 20 ex1)
+-- "abababababababababab"
 --
 -- >>> runGen 44 (generate 10 20 ex1)
--- "abababababababababab"
+-- "ababab"
 --
 ex1 :: RE Void
 ex1 = star_ (ch_ 'a' <> ch_ 'b')
@@ -124,7 +125,7 @@ ex1run1 = putLatexTrace ex1 "abab"
 -- True
 --
 -- >>> runGen 42 (generate 10 20 ex2)
--- "aaaaaaaaaaa"
+-- "aaaaaa"
 --
 -- >>> runGen 44 (generate 10 20 ex2)
 -- "aaaaaaaaaa"
@@ -158,11 +159,11 @@ ex2run1 = putLatexTrace ex2 "aaa"
 -- >>> matchR ex3 "ababa"
 -- False
 --
--- >>> runGen 42 (generate 10 20 ex3)
--- "ab"
+-- >>> runGen 43 (generate 10 20 ex3)
+-- "abababab"
 --
--- >>> runGen 50 (generate 10 20 ex3)
--- "ababab"
+-- >>> runGen 44 (generate 10 20 ex3)
+-- "abab"
 --
 ex3 :: RE Void
 ex3 = Fix "x" (Eps \/ ch_ 'a' <> ch_ 'b' <> Var B)
@@ -187,11 +188,11 @@ ex3run1 = putLatexTrace ex3 "abab"
 -- >>> matchR ex4 "aaaabbbb"
 -- True
 --
--- >>> runGen 42 (generate 10 20 ex4)
--- "aabb"
+-- >>> runGen 43 (generate 10 20 ex4)
+-- "ab"
 --
--- >>> runGen 45 (generate 10 20 ex4)
--- "aaabbb"
+-- >>> runGen 47 (generate 10 20 ex4)
+-- "aaaabbbb"
 --
 ex4 :: RE Void
 ex4 = Fix "x" (Eps \/ ch_ 'a' <> Var B <> ch_ 'b')
@@ -222,11 +223,11 @@ ex4run1 = putLatexTrace ex4 "aaaabbbb"
 -- >>> matchR ex5 "ababa"
 -- False
 --
--- >>> runGen 42 (generate 10 20 ex5)
+-- >>> runGen 43 (generate 10 20 ex5)
 -- "ab"
 --
--- >>> runGen 45 (generate 10 20 ex5)
--- "ababab"
+-- >>> runGen 51 (generate 10 20 ex5)
+-- "abab"
 --
 ex5 :: RE Void
 ex5 = Fix "x" (Eps \/ Var B <> ch_ 'a' <> ch_ 'b')
@@ -255,8 +256,8 @@ ex5run1 = putLatexTrace ex5 "abab"
 -- >>> matchR ex6 "(1+2)*3"
 -- True
 --
--- >>> runGen 42 (generate 5 5 ex6)
--- "96+(09493+90790)*19"
+-- >>> runGen 43 (generate 5 5 ex6)
+-- "74501+(534*19450)*(99050)"
 --
 ex6 :: RE Void
 ex6 = let_ "d" (Ch "0123456789")
@@ -312,8 +313,8 @@ exCfgN = "digit" ::: "digits" ::: "term" ::: "mult" ::: "expr" ::: VNil
 -- >>> charClasses ex7
 -- fromList "\NUL()*+,0:"
 --
--- >>> runGen 42 (generate 5 5 ex7)
--- "(0181+912595*00+((1228)+467+(80)+(216406))*(65)+4+5*5149+994734)"
+-- >>> runGen 43 (generate 5 5 ex7)
+-- "(3431*((0337+5+070346+4))+76848+((4126+350875)*98769+308194+270+03118)+888*(95+90904)+(301069+7+715835)+2809)"
 --
 ex7 :: Ord a => RE a
 ex7 = cfgToRE exCfgN exCfg

src/RERE/Examples/JSON.hs

@@ -24,6 +24,9 @@ import qualified RERE.CharSet as CS
 import Data.Semigroup (Semigroup (..))
 #endif
 
+-- $setup
+-- >>> import RERE
+
 -- | Size of JSON grammar, 22.
 type Size = N.Mult2 (N.Plus N.Nat5 N.Nat6)