Merge pull request #10 from input-output-hk/jdral/refactor

Refactoring

Author: jorisdral

.github/workflows/cabal.project.local.Linux

@@ -4,20 +4,25 @@ on:
   push:
     branches: [ "master" ]
   pull_request:
+  merge_group:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
 
 permissions:
   contents: read
 
 jobs:
+  # Build and test
   build:
-
     runs-on: ${{ matrix.os }}
 
     strategy:
       fail-fast: false
       matrix:
-        ghc: ["8.10.7", "9.2.5"]
-        cabal: ["3.8.1.0"]
+        ghc: ["8.10.7", "9.2.8", "9.4.8", "9.6.4", "9.8.2"]
+        cabal: ["3.10.3.0"]
         os: [ubuntu-latest, windows-latest, macOS-latest]
 
     steps:
@@ -34,12 +39,11 @@ jobs:
     - name: "MacOS: Install system dependencies (brew)"
       if: runner.os == 'macOS'
       run: |
+        brew update
         brew install pkg-config lmdb
-        cp ./.github/workflows/lmdb.pc /usr/local/lib/pkgconfig
 
     - name: "Windows: Install system dependencies via pacman (msys2)"
       if: runner.os == 'Windows'
-      shell: pwsh
       run: |
         ghcup run -- pacman --noconfirm -S `
           mingw-w64-x86_64-pkg-config `
@@ -53,48 +57,53 @@ jobs:
 
     - name: Setup Haskell
       id: setup-haskell
-      uses: haskell/actions/setup@v2
+      uses: haskell-actions/setup@v2
       with:
         ghc-version: ${{ matrix.ghc }}
         cabal-version: ${{ matrix.cabal }}
-        cabal-update: false
+        cabal-update: true
 
-    - name: "Linux/MacOS: Configure cabal.project.local"
-      if: runner.os != 'Windows'
-      run: |
-        cp .github/workflows/cabal.project.local.Linux cabal.project.local
-
-    - name: "Windows: configure cabal.project.local"
-      if: runner.os == 'Windows'
+    - name: Configure the build
       run: |
-        cp .github/workflows/cabal.project.local.Windows cabal.project.local
-
-    - name: Cabal update
-      run: cabal update
+        cabal configure --enable-tests --enable-benchmark --ghc-options="-Werror" --ghc-options="-fno-ignore-asserts"
+        cat cabal.project.local
 
     - name: Record cabal dependencies
       id: record-deps
       run: |
         cabal build all --dry-run
 
-    - name: Cache cabal store
-      uses: actions/cache@v3
+    - name: "Restore cache"
+      uses: actions/cache/restore@v4
+      id: restore-cabal-cache
       env:
-        cache-name: cache-cabal
+        cache-name: cache-cabal-build
       with:
         path: ${{ steps.setup-haskell.outputs.cabal-store }}
-        key: ${{ runner.os }}-${{ matrix.ghc }}-build-${{ env.cache-name }}-${{ hashFiles('**/*.cabal') }}-${{ hashFiles('**/cabal.project') }}
+        key: ${{ runner.os }}-${{ matrix.ghc }}-${{ env.cache-name }}-${{ hashFiles('**/*.cabal') }}-${{ hashFiles('**/cabal.project') }}
         restore-keys: |
-          ${{ runner.os }}-${{ matrix.ghc }}-build-${{ env.cache-name }}-
-          ${{ runner.os }}-${{ matrix.ghc }}-build-
-          ${{ runner.os }}-${{ matrix.ghc }}-
-          ${{ runner.os }}-
+          ${{ runner.os }}-${{ matrix.ghc }}-${{ env.cache-name }}-${{ hashFiles('**/*.cabal') }}-${{ hashFiles('**/cabal.project') }}
+          ${{ runner.os }}-${{ matrix.ghc }}-${{ env.cache-name }}-${{ hashFiles('**/*.cabal') }}-
+          ${{ runner.os }}-${{ matrix.ghc }}-${{ env.cache-name }}-
 
     - name: Install cabal dependencies
+      id: build-dependencies
       run: cabal build --only-dependencies --enable-tests --enable-benchmarks all
 
+    - name: "Save cache"
+      uses: actions/cache/save@v4
+      id: save-cabal-cache
+      # Note: cache-hit will be set to true only when cache hit occurs for the
+      # exact key match. For a partial key match via restore-keys or a cache
+      # miss, it will be set to false.
+      if: steps.build-dependencies.outcome == 'success' && steps.restore-cabal-cache.outputs.cache-hit != 'true'
+      with:
+        path: ${{ steps.setup-haskell.outputs.cabal-store }}
+        key:  ${{ steps.restore-cabal-cache.outputs.cache-primary-key }}
+
     - name: Build
-      run: cabal build --enable-tests --enable-benchmarks all
+      run: cabal build all
 
     - name: Run tests
-      run: cabal test all
+      run: |
+        cabal test -j1 --test-show-details=direct all

.github/workflows/cabal.project.local.Windows

@@ -1,3 +1,4 @@
+# Haskell
 dist
 dist-*
 cabal-dev

.github/workflows/haskell.yml

@@ -1,5 +1,32 @@
+## next release — ????-??-??
+
+### Breaking
+
+* Stricter bounds on `base` dependency: `base >= 4.14 && < 4.20`.
+* Stricter bounds on `lmdb` system package dependency: `lmdb >= 0.9 && <0.10`
+* Major, minor and patch field versions in `LMDB_Version` changed from `Int` to `CLong`.
+* Remove the `Ord` instance for `LMDB_Version`.
+* Change `Int` to `CInt` in the `e_code` field in `LMDB_Error`.
+* Remove the `Ord` instance for `LMDB_Error`.
+* Remove the `Ix` instance for `MDB_ErrCode`.
+* Remove `MDB_txnid`.
+* Change the type of the `mv_data` field in `MDB_val` from `Ptr Word8` to `Ptr
+  ()`.
+* Remove the `Ord` instances for `MDB_stat`.
+* Remove the `Ord` instance for `MDB_envinfo`.
+* `me_last_txnid` now returns `CSize` instead of `MDB_txnid`.
+* Remove the `Ix` instance for` MDB_EnvFlag`.
+* Remove the `Ix` instance for `MDB_DbFlag`.
+* Remove the `Ix` instance for `MDB_cursor_op`.
+* Remove the `Ix` instance for `MDB_WriteFlag`.
+
+### Non-breaking
+
+* No longer depends on the `array` package.
+* Add an `Enum` instance for `MDB_ErrCode`.
+* Add an `Enum` instance for `MDB_EnvFlag`.
+* Add an `Enum` instance for `MDB_DbFlag`.
 
-<a id='changelog-0.3.0.0'></a>
 ## 0.3.0.0 — 2023-02-17
 
 First release of `lmdb` fork. See

.github/workflows/lmdb.pc

@@ -1,3 +1,74 @@
-See [the contributing file in the `ouroboros-network` repository](
-https://github.com/input-output-hk/ouroboros-network/blob/master/CONTRIBUTING.md).
-We follow consensus guidelines where consensus and network diverge.
+# Contributing
+
+## Building
+
+Building the project requires LMDB to be installed on your system. Either build
+LMDB from source on any system, or use a package manager on Ubuntu/MacOS, or use
+`ghcup` on Windows.
+
+* **Ubuntu**:
+  ```
+  apt-get update
+  apt-get install pkg-config liblmdb-dev
+  ```
+* **MacOS**:
+  ```
+  brew update
+  brew install pkg-config lmdb
+  ```
+* **Windows**:
+  ```
+  ghcup run -- pacman --noconfirm -S `
+    mingw-w64-x86_64-pkg-config `
+    mingw-w64-x86_64-lmdb
+  ```
+  Make sure that the path to the install folder is included in your `PATH`
+  variable, e.g., "C:\msys64\bin".
+
+
+The project is built using `ghc` and `cabal`.
+
+```
+cabal update
+cabal build all
+```
+
+## Testing
+
+Tests are run using `cabal`.
+
+```
+cabal build all
+cabal test all
+```
+
+## Code style
+
+There is no strict code style, but try to keep the code style consistent
+throughout the repository and favour readability. Code should be well-documented and well-tested.
+
+## Formatting
+
+We enforce no formatter for Haskell or Cabal files, but try to keep the
+formatting consistent throughout the repository. We suggest using
+`stylish-haskell` and `cabal-fmt` to keep formatting consistent.
+
+## Pull requests
+
+The following are requirements for merging a PR into `master`:
+* Each commit should be small and should preferably address one thing. Commit messages should be useful.
+* Document and test your changes.
+* The PR should have a useful description, and it should link issues that it
+  resolves (if any).
+* Changes introduced by the PR should be recorded in the relevant changelog
+  files.
+* PRs should not bundle many unrelated changes.
+* PRs should be approved by at least 1 developer.
+* The PR should pass all CI checks.
+
+## Releases
+
+Releases follow the [Haskell Package Versioning Policy](https://pvp.haskell.org/). We use version numbers consisting of 4 parts, like `A.B.C.D`.
+* `A.B` is the *major* version number. A bump indicates a breaking change.
+* `C` is the *minor* version number. A bump indicates a non-breaking change.
+* `D` is the *patch* version number. A bump indicates a small, non-breaking patch.

.gitignore

@@ -1,5 +1,5 @@
-[![Haskell CI](https://img.shields.io/github/actions/workflow/status/input-output-hk/haskell-lmdb/haskell.yml?label=Build&style=for-the-badge)](https://github.com/input-output-hk/haskell-lmdb/actions/workflows/haskell.yml)
 [![handbook](https://img.shields.io/badge/policy-Cardano%20Engineering%20Handbook-informational?style=for-the-badge)](https://input-output-hk.github.io/cardano-engineering-handbook)
+[![Haskell CI](https://img.shields.io/github/actions/workflow/status/input-output-hk/haskell-lmdb/haskell.yml?label=Build&style=for-the-badge)](https://github.com/input-output-hk/haskell-lmdb/actions/workflows/haskell.yml)
 
 # Input-Ouptut fork haskell-lmdb
 

CHANGELOG.md

@@ -1,2 +1,7 @@
+index-state:
+  -- Bump this if you need newer packages from Hackage
+  -- current date: put reason of current date here
+  , hackage.haskell.org 2024-04-03T11:41:05Z
+
 packages:
   .