Merge pull request #500 from awvwgk/version-file

Allow reading version number from file

Author: LKedward

ci/run_tests.sh

@@ -62,6 +62,11 @@ test ! -x ./build/gfortran_*/app/unused
 test ! -x ./build/gfortran_*/test/unused_test
 popd
 
+pushd version_file
+"$fpm" build
+"$fpm" run
+popd
+
 pushd with_c
 "$fpm" build
 "$fpm" run --target with_c

example_packages/README.md

@@ -22,5 +22,6 @@ the features demonstrated in each package and which versions of fpm are supporte
 | submodules          | Lib-only; submodules (3 levels)                               |            N            |  Y  |
 | link_external       | Link external library                                         |            N            |  Y  |
 | link_executable     | Link external library to a single executable                  |            N            |  Y  |
+| version_file        | Read version number from a file in the project root           |            N            |  Y  |
 | with_c              | Compile with `c` source files                                 |            N            |  Y  |
 | with_makefile       | External build command (makefile)                             |            Y            |  N  |

example_packages/version_file/VERSION

@@ -0,0 +1 @@
+5.42.1

example_packages/version_file/app/main.f90

@@ -0,0 +1,13 @@
+program stub
+  implicit none
+  logical :: exists
+  integer :: unit
+  character(len=100) :: line
+  inquire(file="VERSION", exist=exists)
+  if (.not.exists) error stop "File VERSION does not exist."
+  open(file="VERSION", newunit=unit)
+  read(unit, '(a)') line
+  close(unit)
+
+  print '(*(a))', "File VERSION contains '", trim(line), "'"
+end program stub

example_packages/version_file/fpm.toml

@@ -0,0 +1,2 @@
+name = "version_file"
+version = "VERSION"

manifest-reference.md

@@ -78,6 +78,14 @@ A standardized way to manage and specify versions is the [Semantic Versioning] s
 version = "1.0.0"
 ```
 
+The version entry can also contain a filename relative to the project root, which contains the version number of the project
+
+*Example:*
+
+```toml
+version = "VERSION"
+```
+
 [Semantic Versioning]: https://semver.org
 
 

src/fpm/cmd/new.f90

@@ -605,7 +605,7 @@ subroutine create_verified_basic_manifest(filename)
     call set_value(table, "copyright",  'Copyright '//date(1:4)//', Jane Doe')
     ! continue building of manifest
     ! ...
-    call new_package(package, table, error)
+    call new_package(package, table, error=error)
     if (allocated(error)) stop 3
     if(settings%verbose)then
        call table%accept(ser)

src/fpm/manifest.f90

@@ -113,7 +113,7 @@ subroutine get_package_data(package, file, error, apply_defaults)
             return
         end if
 
-        call new_package(package, table, error)
+        call new_package(package, table, dirname(file), error)
         if (allocated(error)) return
 
         if (present(apply_defaults)) then

src/fpm/manifest/package.f90

@@ -38,6 +38,7 @@ module fpm_manifest_package
     use fpm_manifest_library, only : library_config_t, new_library
     use fpm_manifest_install, only: install_config_t, new_install_config
     use fpm_manifest_test, only : test_config_t, new_test
+    use fpm_filesystem, only : exists, getline, join_path
     use fpm_error, only : error_t, fatal_error, syntax_error
     use fpm_toml, only : toml_table, toml_array, toml_key, toml_stat, get_value, &
         & len
@@ -99,14 +100,17 @@ module fpm_manifest_package
 
 
     !> Construct a new package configuration from a TOML data structure
-    subroutine new_package(self, table, error)
+    subroutine new_package(self, table, root, error)
 
         !> Instance of the package configuration
         type(package_config_t), intent(out) :: self
 
         !> Instance of the TOML data structure
         type(toml_table), intent(inout) :: table
 
+        !> Root directory of the manifest
+        character(len=*), intent(in), optional :: root
+
         !> Error handling
         type(error_t), allocatable, intent(out) :: error
 
@@ -116,8 +120,8 @@ subroutine new_package(self, table, error)
            achar(8) // achar(9) // achar(10) // achar(12) // achar(13)
         type(toml_table), pointer :: child, node
         type(toml_array), pointer :: children
-        character(len=:), allocatable :: version
-        integer :: ii, nn, stat
+        character(len=:), allocatable :: version, version_file
+        integer :: ii, nn, stat, io
 
         call check(table, error)
         if (allocated(error)) return
@@ -157,6 +161,25 @@ subroutine new_package(self, table, error)
 
         call get_value(table, "version", version, "0")
         call new_version(self%version, version, error)
+        if (allocated(error) .and. present(root)) then
+            version_file = join_path(root, version)
+            if (exists(version_file)) then
+                deallocate(error)
+                open(file=version_file, newunit=io, iostat=stat)
+                if (stat == 0) then
+                    call getline(io, version, iostat=stat)
+                end if
+                if (stat == 0) then
+                    close(io, iostat=stat)
+                end if
+                if (stat == 0) then
+                    call new_version(self%version, version, error)
+                else
+                    call fatal_error(error, "Reading version number from file '" &
+                        & //version_file//"' failed")
+                end if
+            end if
+        end if
         if (allocated(error)) return
 
         call get_value(table, "dependencies", child, requested=.false.)

src/fpm_filesystem.f90

@@ -184,6 +184,7 @@ function dirname(path) result (dir)
     character(:), allocatable :: dir
 
     dir = path(1:scan(path,'/\',back=.true.))
+    if (len_trim(dir) == 0) dir = "."
 
 end function dirname