Merge branch 'master' into andrea/remove-cabal-file

Author: andreabedini

.github/workflows/bootstrap.yml

@@ -34,7 +34,7 @@ jobs:
           key: bootstrap-${{ runner.os }}-${{ matrix.ghc }}-20221115-${{ github.sha }}
           restore-keys: bootstrap-${{ runner.os }}-${{ matrix.ghc }}-20221115-
 
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       # See https://github.com/haskell/cabal/pull/8739
       - name: Sudo chmod to permit ghcup to update its cache
         run: |

.github/workflows/changelogs.yml

@@ -50,7 +50,7 @@ jobs:
         run: cabal v2-update
       # Cannot install it from tarball due to
       # https://github.com/haskell/cabal/issues/7360
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           repository: "fgaz/changelog-d"
           path: "changelog-d"
@@ -59,7 +59,7 @@ jobs:
           pushd changelog-d
           cabal v2-install
           popd
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Run changelog-d
         run: |
           changelog-d changelog.d

.github/workflows/format.yml

@@ -9,7 +9,7 @@ jobs:
   fourmolu:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: haskell-actions/run-fourmolu@v8
       with:
         pattern: |

.github/workflows/lint.yml

@@ -8,7 +8,7 @@ jobs:
   hlint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: haskell/actions/hlint-setup@v2
       with:
         version: "3.5"

.github/workflows/quick-jobs.yml

@@ -48,7 +48,7 @@ jobs:
         run: cabal v2-update
       - name: Install alex
         run: cabal v2-install alex --constraint='alex ==3.2.7.3'
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Regenerate files
         run: |
           make -B lexer
@@ -87,7 +87,7 @@ jobs:
           ghcup install cabal --set latest
       - name: Update Hackage index
         run: cabal v2-update
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install doctest
         run: make doctest-install
       - name: Doctest

.github/workflows/users-guide.yml

@@ -49,7 +49,7 @@ jobs:
         python-version: ['3.10']
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         submodules: recursive
 

.github/workflows/validate.yml

@@ -55,7 +55,7 @@ jobs:
 
     steps:
 
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       #  See the following link for a breakdown of the following step
       #  https://github.com/haskell/actions/issues/7#issuecomment-745697160
@@ -197,7 +197,7 @@ jobs:
       # cause it does not work with the git version included in it, see:
       # https://github.com/actions/checkout/issues/170
       # https://github.com/actions/checkout/issues/295
-      # - uses: actions/checkout@v3
+      # - uses: actions/checkout@v4
       - name: Checkout
         run: |
           echo $GITHUB_REF $GITHUB_SHA
@@ -251,7 +251,7 @@ jobs:
         ghc: ${{ fromJSON (needs.validate.outputs.GHC_FOR_RELEASE) }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       # See https://github.com/haskell/cabal/pull/8739
       - name: Sudo chmod to permit ghcup to update its cache

.gitlab/brew.sh

@@ -9,7 +9,7 @@ brew_dir="${CI_PROJECT_DIR}/.brew"
 
 if [ ! -e "${brew_dir}" ]; then
     mkdir -p "${brew_dir}"
-    curl -L "https://github.com/Homebrew/brew/archive/refs/tags/${BREW_VERSION}.tar.gz" | tar xz --strip 1 -C "${brew_dir}"
+    curl --fail -L "https://github.com/Homebrew/brew/archive/refs/tags/${BREW_VERSION}.tar.gz" | tar xz --strip 1 -C "${brew_dir}"
 fi
 
 export PATH="${brew_dir}/bin:${brew_dir}/sbin:$PATH"

.readthedocs.yml

@@ -3,7 +3,11 @@ version: 2
 sphinx:
   configuration: doc/conf.py
 
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.8"
+
 python:
-  version: 3.8
   install:
     - requirements: doc/requirements.txt

CONTRIBUTING.md

@@ -15,6 +15,13 @@ If not, you aren't able to build the testsuite, so you need to disable the defau
 cabal build --project-file=cabal.project.release cabal
 ```
 
+> **Note**
+> If you're using Nix, you might find it convenient to work within a shell that has all the `Cabal` development dependencies:
+> ```
+> $ nix-shell -p cabal-install ghc ghcid haskellPackages.fourmolu_0_12_0_0 pkgconfig zlib.dev
+> ```
+> A Nix flake developer shell with these dependencies is also available, supported solely by the community, through the command `nix develop github:yvan-sraka/cabal.nix`.
+
 The location of your build products will vary depending on which version of
 cabal-install you use to build; see the documentation section
 [Where are my build products?](http://cabal.readthedocs.io/en/latest/nix-local-build.html#where-are-my-build-products)

Cabal-QuickCheck/src/Test/QuickCheck/Instances/Cabal.hs

@@ -5,8 +5,8 @@ module Test.QuickCheck.Instances.Cabal () where
 
 import Control.Applicative        (liftA2)
 import Data.Bits                  (shiftR)
-import Data.Char                  (isAlphaNum, isDigit)
-import Data.List                  (intercalate)
+import Data.Char                  (isAlphaNum, isDigit, toLower)
+import Data.List                  (intercalate, (\\))
 import Data.List.NonEmpty         (NonEmpty (..))
 import Distribution.Utils.Generic (lowercase)
 import Test.QuickCheck
@@ -405,6 +405,10 @@ instance (Arbitrary a, Ord a) => Arbitrary (NubList a) where
 -- InstallDirs
 -------------------------------------------------------------------------------
 
+-- these are wrong because they bottom out in String. We should really use
+-- the modern FilePath at some point, so we get QC instances that don't include
+-- invalid characters or path components
+
 instance Arbitrary a => Arbitrary (InstallDirs a) where
     arbitrary = InstallDirs
         <$> arbitrary <*> arbitrary <*> arbitrary <*> arbitrary --  4
@@ -506,11 +510,20 @@ arbitraryShortToken :: Gen String
 arbitraryShortToken = arbitraryShortStringWithout "{}[]"
 
 arbitraryShortPath :: Gen String
-arbitraryShortPath = arbitraryShortStringWithout "{}[],"
+arbitraryShortPath = arbitraryShortStringWithout "{}[],<>:|*?" `suchThat` (not . winDevice)
+    where
+        -- split path components on dots
+        -- no component can be empty or a device name
+        -- this blocks a little too much (both "foo..bar" and "foo.con" are legal)
+        -- but for QC being a little conservative isn't harmful
+        winDevice = any (any (`elem` ["","con", "aux", "prn", "com", "lpt", "nul"]) . splitBy ".") . splitBy "\\/" . map toLower
+        splitBy _ "" = []
+        splitBy seps str = let (part,rest) = break (`elem` seps) str
+                            in part : if length rest == 1 then [""] else splitBy seps (drop 1 rest)
 
 arbitraryShortStringWithout :: String -> Gen String
 arbitraryShortStringWithout excludeChars =
-    shortListOf1 5 $ elements [c | c <- ['#' ..  '~' ], c `notElem` excludeChars ]
+    shortListOf1 5 $ elements $ ['#' .. '~'] \\ excludeChars
 
 -- |
 intSqrt :: Int -> Int

Cabal-syntax/Cabal-syntax.cabal

@@ -31,15 +31,15 @@ library
     array      >= 0.4.0.1  && < 0.6,
     base       >= 4.9      && < 5,
     binary     >= 0.7      && < 0.9,
-    bytestring >= 0.10.0.0 && < 0.12,
+    bytestring >= 0.10.0.0 && < 0.13,
     containers >= 0.5.0.0  && < 0.7,
     deepseq    >= 1.3.0.1  && < 1.6,
     directory  >= 1.2      && < 1.4,
     filepath   >= 1.3.0.1  && < 1.5,
     mtl        >= 2.1      && < 2.4,
     parsec     >= 3.1.13.0 && < 3.2,
     pretty     >= 1.1.1    && < 1.2,
-    text       (>= 1.2.3.0 && < 1.3) || (>= 2.0 && < 2.1),
+    text       (>= 1.2.3.0 && < 1.3) || (>= 2.0 && < 2.2),
     time       >= 1.4.0.1  && < 1.13,
     -- transformers-0.4.0.0 doesn't have record syntax e.g. for Identity
     -- See also https://github.com/ekmett/transformers-compat/issues/35