Merge branch 'release/1.0.3'

Author: samharrison7

.github/workflows/fair-software.yml

@@ -0,0 +1,15 @@
+name: fair-software
+
+on: push
+
+jobs:
+  verify:
+    name: "fair-software"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: fair-software/howfairis-github-action@main
+        name: Measure compliance with fair-software.eu recommendations
+        env:
+          PYCHARM_HOSTED: "Trick colorama into displaying colored output" 
+        with:
+          MY_REPO_URL: "https://github.com/${{ github.repository }}"

CHANGELOG.md

@@ -1,25 +1,33 @@
 # Changelog
-Notable changes to the Fortran Error Handler will be documented here.
+Notable changes to the Fortran Error Handler are documented here.
 
 ## [Unreleased]
 
+## [1.0.3] - 2021-12-31
+
+### Added
+- Added option to compile with fpm (Fortran Package Manager) and updated README.md accordingly.
+
 ## [1.0.2] - 2020-11-11
 
 No changes to code. Release is only to archive on Zenodo.
 
 ## [1.0.1] - 2020-06-30
+
 ### Added
 - Option to turn off printing of non-critical (warning) errors on trigger. Configured by `triggerWarnings` parameter on `ErrorHandler%init(...)`.
 - This CHANGELOG.
 
 ### Fixed
 - A few corrections to documentation.
 
-## [1.0] - 2020-06-05
+## [1.0.0] - 2020-06-05
+
 ### Added
 - First major release.
 
-[Unreleased]: https://github.com/samharrison7/fortran-error-handler/tree/develop 
-[1.0.2]: https://github.com/samharrison7/fortran-error-handler/tree/1.0.2
-[1.0.1]: https://github.com/samharrison7/fortran-error-handler/tree/1.0.1
-[1.0]: https://github.com/samharrison7/fortran-error-handler/tree/1.0 
+[Unreleased]: https://github.com/samharrison7/fortran-error-handler/compare/1.0.3...HEAD 
+[1.0.3]: https://github.com/samharrison7/fortran-error-handler/releases/tag/1.0.3
+[1.0.2]: https://github.com/samharrison7/fortran-error-handler/releases/tag/1.0.2
+[1.0.1]: https://github.com/samharrison7/fortran-error-handler/releases/tag/1.0.1
+[1.0.0]: https://github.com/samharrison7/fortran-error-handler/releases/tag/1.0 

README.md

@@ -1,5 +1,8 @@
 # Fortran Error Handler
 
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4268263.svg)](https://doi.org/10.5281/zenodo.4268263)
+[![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8B%20%20%E2%97%8F%20%20%E2%97%8B-orange)](https://fair-software.eu)
+
 Fortran error handling frameworks are few and far between, and those that do exist often implement only parts of the error handling process, or rely on pre-processors. The goal of this error handling framework is to provide a universal and comprehensive solution for applications requiring functional and robust error handling, utilising the power of modern object-oriented Fortran.
 
 - [Getting started](#getting-started)
@@ -12,9 +15,42 @@ Fortran error handling frameworks are few and far between, and those that do exi
 <a name="getting-started"></a>
 ## Getting started
 
-If you wish to use the Fortran Error Handler in a project, the simplest way to do so is to include the source files (in `src/`) at the start of your compilation setup. Source files should be compiled in this order: `ErrorInstance.f90`, `ErrorHandler.f90`, `ErrorCriteria.f90`, `Result.f90`. An example [Makefile.example](./Makefile.example) is included, which can be altered according to your compiler and preferences. 
+There are a few ways to get the Fortran Error Handler into your project.
+
+### `fpm` - Fortran Package Manager
+
+The simplest way is to use [fpm (Fortran Package Manager)](https://fpm.fortran-lang.org/en/index.html). You can either directly include the Fortran Error Handler as a dependency in your `fpm.toml` file:
+
+```toml
+[dependencies]
+feh = { git = "https://github.com/samharrison7/fortran-error-handler" }
+```
+
+Or you can clone the repo and build the library yourself using fpm:
 
-The code can also be compiled using `cmake`, which creates an example executable (using `example/example_usage.f90`), an executable of unit tests (using `tests/run_tests.f90`), and a library of the framework:
+```bash
+$ git clone https://github.com/samharrison7/fortran-error-handler
+$ cd fortran-error-handler
+$ fpm build --flag="-fbackslash"
+```
+
+A static library (e.g. `libfeh.a` on Linux) and `.mod` files will be generated in the `build` directory for you to use. An example executable (using `example/example_usage.f90`) will also be generated. Running `fpm test` will run tests (using `tests/run_tests.f90`) for the framework. The `-fbackslash` flag is a GFortran flag to enable coloured terminal output, and is only needed if the `bashColors` option is `.true.` (default). The equivalent `ifort` flag is `/assume:bscc`.
+
+You can also get fpm to install the Fortran Error Handler locally (e.g. to `/home/<user>/.local`):
+
+```bash
+$ fpm install --flag="-fbackslash"
+```
+
+Fpm can easily be installed using Conda: `conda install -c conda-forge fpm`.
+
+### Grab the files
+
+Another simple method is to simple grab a copy of the source files (in `src/`) and include at the start of your compilation setup. Source files should be compiled in this order: `ErrorInstance.f90`, `ErrorHandler.f90`, `ErrorCriteria.f90`, `Result.f90`. An example [Makefile.example](./Makefile.example) is included, which can be altered according to your compiler and preferences. 
+
+### `cmake`
+
+The code can also be compiled using `cmake`, which generates a library and `.mod` files, an example executable, and executable of unit tests.
 
 ```bash
 $ mkdir build
@@ -27,12 +63,6 @@ $ ./test
 $ ./example
 ```
 
-Whether the library is shared or not is specified by the `BUILD_SHARED_LIBS` variable. If you wish to build a shared library, then pass the `BUILD_SHARED_LIBS` option as on:
-
-```bash
-$ cmake .. -DBUILD_SHARED_LIBS=ON
-```
-
 The framework has been tested using GFortran 7 upwards and Intel Fortran 18.
 
 <a name="usage"></a>
@@ -171,4 +201,4 @@ integer :: i = 1
 real :: r = 1.0
 real(dp) :: r_dp = 1.0_dp
 real(qp) :: r_qp = 1.0_qp
-```
+```

codemeta.json

@@ -47,5 +47,5 @@
   "keywords": "Fortran, error handling",
   "license": "MIT",
   "title": "Fortran Error Handler",
-  "version": "v1.0.0"
-}
+  "version": "v1.0.3"
+}

example/CustomErrorCriteria.f90

@@ -20,20 +20,27 @@ module CustomErrorCriteriaModule
     !! the parent ErrorCriteria (and thus ErrorHandler), setting custom errors
     !! and default error criteria errors.
     subroutine initCustomErrorCriteria(this, &
-                                        errors, &
-                                        criticalPrefix, &
-                                        warningPrefix, &
-                                        messageSuffix, &
-                                        bashColors)
+                                       errors, &
+                                       criticalPrefix, &
+                                       warningPrefix, &
+                                       messageSuffix, &
+                                       bashColors, &
+                                       printErrorCode, &
+                                       triggerWarnings, &
+                                       on)
         class(CustomErrorCriteria), intent(inout)   :: this                 !> This ErrorCriteria instance
         type(ErrorInstance), intent(in), optional   :: errors(:)            !> Custom defined errors
         character(len=*), intent(in), optional      :: criticalPrefix       !> Prefix to critical error messages
         character(len=*), intent(in), optional      :: warningPrefix        !> Prefix to warning error messages
         character(len=*), intent(in), optional      :: messageSuffix        !> Suffix to error messages
         logical, intent(in), optional               :: bashColors           !> Should prefixes be colored in bash shells?
+        logical, intent(in), optional               :: printErrorCode       !! Should error messages be prefixed with the error code?
+        logical, intent(in), optional               :: triggerWarnings      !! Should warnings be printing on trigger?
+        logical, intent(in), optional               :: on                   !! Should the ErrorHandler output errors?
 
         !> We must initialise the parent ErrorCriteria for the default criteria to be set                                                              
-        call this%ErrorCriteria%init(errors,criticalPrefix,warningPrefix,messageSuffix,bashColors)
+        call this%ErrorCriteria%init(errors, criticalPrefix, warningPrefix, messageSuffix, bashColors, &
+                                     printErrorCode, triggerWarnings, on)
         ! Add our new error criterion. Make sure you include a function(s) that corresponds to this!
         call this%addErrorCriteria( &
             codes = [110,111], &
@@ -45,7 +52,7 @@ subroutine initCustomErrorCriteria(this, &
     end subroutine
 
     !> Test whether an integer value is a factor of criterion
-    pure function integerFactor(this, value, criterion, message, traceMessage) result(error)
+    function integerFactor(this, value, criterion, message, traceMessage) result(error)
         class(CustomErrorCriteria), intent(in)  :: this             !> The ErrorCriteria class
         integer, intent(in)                     :: value            !> The value to test
         integer, intent(in)                     :: criterion            !> The value to test
@@ -86,7 +93,7 @@ pure function integerFactor(this, value, criterion, message, traceMessage) resul
     end function
 
     !> Test whether an integer value is a multiple of criterion
-    pure function integerMultiple(this, value, criterion, message, traceMessage) result(error)
+    function integerMultiple(this, value, criterion, message, traceMessage) result(error)
         class(CustomErrorCriteria), intent(in)  :: this             !> The ErrorCriteria class
         integer, intent(in)                     :: value            !> The value to test
         integer, intent(in)                     :: criterion            !> The value to test

fpm.toml

@@ -0,0 +1,18 @@
+name = "feh"
+version = "1.0.3"
+license = "MIT"
+author = "Sam Harrison"
+maintainer = "[email protected]"
+
+[[ example ]]
+name = "example"
+source-dir = "example"
+main = "example_usage.f90"
+
+[[ test ]]
+name = "tests"
+source-dir = "tests"
+main = "run_tests.f90"
+
+[install]
+library = true

src/ErrorCriteria.f90

@@ -133,14 +133,14 @@ module ErrorCriteriaModule
         !> Initialise the ErrorCriteria and at the same time initialise
         !! the parent ErrorHandler, setting custom errors.
         subroutine initErrorCriteria(this, &
-                        errors, &
-                        criticalPrefix, &
-                        warningPrefix, &
-                        messageSuffix, &
-                        bashColors, &
-                        printErrorCode, &
-                        triggerWarnings, &
-                        on)
+                                     errors, &
+                                     criticalPrefix, &
+                                     warningPrefix, &
+                                     messageSuffix, &
+                                     bashColors, &
+                                     printErrorCode, &
+                                     triggerWarnings, &
+                                     on)
             class(ErrorCriteria), intent(inout)         :: this                 !! This ErrorCriteria instance
             type(ErrorInstance), intent(in), optional   :: errors(:)            !! Custom defined errors
             character(len=*), intent(in), optional      :: criticalPrefix       !! Prefix to critical error messages

src/ErrorInstance.f90

@@ -55,15 +55,12 @@ function init(code, message, isCritical, trace) result(this)
         !! and https://stackoverflow.com/questions/44385909/adding-to-an-array-of-characters-in-fortran
         subroutine addToTrace(this, message)
             class(ErrorInstance), intent(inout) :: this
-            character(len=*), intent(in) :: message
-            character(len=256) :: tempMessage
-
-            tempMessage = message       ! Make character length 256
+            character(len=*), intent(in)        :: message
             ! Check if this is the first time something has been added to
             ! the trace or not. If it is, allocate as null array.
             if (.not. allocated(this%trace)) allocate(this%trace(0))
             ! Add the new node to the trace array.
-            this%trace = [this%trace, tempMessage]
+            this%trace = [character(len=256) :: this%trace, message]
         end subroutine
 
         !> Return the error code.