Merge branch 'master' of https://github.com/jacobwilliams/json-fortran into increase-coverage

Author: jacobwilliams

README.md

@@ -22,13 +22,8 @@ A Fortran 2008 JSON API
 Status
 ------
 [![Build Status](https://img.shields.io/travis/jacobwilliams/json-fortran/master.svg?style=plastic)](https://travis-ci.org/jacobwilliams/json-fortran)
-[![Codecov](https://codecov.io/gh/jacobwilliams/json-fortran/branch/master/graph/badge.svg)](https://codecov.io/gh/jacobwilliams/json-fortran)
-
 [![GitHub issues](https://img.shields.io/github/issues/jacobwilliams/json-fortran.png?style=plastic)](https://github.com/jacobwilliams/json-fortran/issues)
-[![Blocked by Vendor Bug](https://badge.waffle.io/jacobwilliams/json-fortran.png?label=vendor%20bug&title=Blocked%20by%20Vendor%20Bug)](https://waffle.io/jacobwilliams/json-fortran)
-[![Ready in backlog](https://badge.waffle.io/jacobwilliams/json-fortran.png?label=Ready&title=Ready)](https://github.com/jacobwilliams/json-fortran/#contributing)
-[![In Progress](https://badge.waffle.io/jacobwilliams/json-fortran.png?label=In%20Progress&title=In%20Progress)](https://waffle.io/jacobwilliams/json-fortran)
-[![Needs Review](https://badge.waffle.io/jacobwilliams/json-fortran.png?label=Needs%20Review&title=Needs%20Review)](https://waffle.io/jacobwilliams/json-fortran)
+[![Codecov](https://codecov.io/gh/jacobwilliams/json-fortran/branch/master/graph/badge.svg)](https://codecov.io/gh/jacobwilliams/json-fortran)
 
 Take a look at the
 [CHANGELOG](https://github.com/jacobwilliams/json-fortran/blob/master/CHANGELOG.md#unreleased)
@@ -47,7 +42,7 @@ Download
 --------------------
 
 [![GitHub release](https://img.shields.io/github/release/jacobwilliams/json-fortran.svg?style=plastic)](https://github.com/jacobwilliams/json-fortran/releases)
-[![homebrew version](https://img.shields.io/homebrew/v/json-fortran.svg?maxAge=2592000)](http://braumeister.org/formula/json-fortran)
+[![homebrew version](https://img.shields.io/homebrew/v/json-fortran.svg?style=plastic)](http://braumeister.org/formula/json-fortran)
 
 Download the official versioned releases
 [here](https://github.com/jacobwilliams/json-fortran/releases/latest).
@@ -158,6 +153,9 @@ Contributing
 ------------
 
 [![Ready in backlog](https://badge.waffle.io/jacobwilliams/json-fortran.png?label=Ready&title=Ready)](https://github.com/jacobwilliams/json-fortran/blob/master/.github/CONTRIBUTING.md)
+[![Blocked by Vendor Bug](https://badge.waffle.io/jacobwilliams/json-fortran.png?label=vendor%20bug&title=Blocked%20by%20Vendor%20Bug)](https://waffle.io/jacobwilliams/json-fortran)
+[![In Progress](https://badge.waffle.io/jacobwilliams/json-fortran.png?label=In%20Progress&title=In%20Progress)](https://waffle.io/jacobwilliams/json-fortran)
+[![Needs Review](https://badge.waffle.io/jacobwilliams/json-fortran.png?label=Needs%20Review&title=Needs%20Review)](https://waffle.io/jacobwilliams/json-fortran)
 
 Want to help?  Take a quick look at our [contributing guidelines](https://github.com/jacobwilliams/json-fortran/blob/master/.github/CONTRIBUTING.md) then claim something in [the "ready" column on our Waffle.io](https://waffle.io/jacobwilliams/json-fortran) and [Fork. Commit. Pull request.](https://help.github.com/articles/fork-a-repo/)
 

pages/development-resources/release-checklist.md

@@ -52,7 +52,7 @@ remain accurate.
 	 1. Add `pages/releases/index.md` to the git index: `git add pages/releases/index.md`
  1. Update the version string in remaining files requiring manual edits:
      1. Edit the `.VERSION` file
-     1. Edit the CMake example on line 129 of `README.md`
+     1. Edit the CMake example on line 124 of `README.md`
 	 1. Add both files to the git index: `git add .VERSION
      README.md`
  1. Commit the changes to the master branch: `git commit`

src/json_value_module.F90

@@ -176,7 +176,10 @@ module json_value_module
                                                    !! when an error is thrown in the class.
                                                    !! Many of the methods will check this
                                                    !! and return immediately if it is true.
-        character(kind=CK,len=:),allocatable :: err_message !! the error message
+        character(kind=CK,len=:),allocatable :: err_message
+                                                   !! the error message.
+                                                   !! if `exception_thrown=False` then
+                                                   !! this variable is not allocated.
 
         integer(IK) :: char_count = 0    !! character position in the current line
         integer(IK) :: line_count = 1    !! lines read counter
@@ -463,11 +466,11 @@ module json_value_module
         !    type(json_core) :: json
         !    type(json_value) :: p
         !    !...
-        !    call json%print(p,'test.json')  !this is [[json_print_2]]
+        !    call json%print(p,'test.json')  !this is [[json_print_to_filename]]
         !````
-        generic,public :: print => json_print_1,json_print_2
-        procedure :: json_print_1
-        procedure :: json_print_2
+        generic,public :: print => json_print_to_unit,json_print_to_filename
+        procedure :: json_print_to_unit
+        procedure :: json_print_to_filename
 
         !>
         !  Destructor routine for a [[json_value]] pointer.
@@ -1804,7 +1807,7 @@ pure subroutine json_clear_exceptions(json)
 
     !clear the flag and message:
     json%exception_thrown = .false.
-    json%err_message = CK_''
+    if (allocated(json%err_message)) deallocate(json%err_message)
 
     end subroutine json_clear_exceptions
 !*****************************************************************************************
@@ -1908,25 +1911,27 @@ end subroutine wrap_json_throw_exception
 !
 !### See also
 !  * [[json_failed]]
+!  * [[json_throw_exception]]
 
-    subroutine json_check_for_errors(json,status_ok,error_msg)
+    pure subroutine json_check_for_errors(json,status_ok,error_msg)
 
     implicit none
 
-    class(json_core),intent(inout) :: json
-    logical(LK),intent(out) :: status_ok !! true if there were no errors
-    character(kind=CK,len=:),allocatable,intent(out) :: error_msg !! the error message (if there were errors)
+    class(json_core),intent(in) :: json
+    logical(LK),intent(out),optional :: status_ok !! true if there were no errors
+    character(kind=CK,len=:),allocatable,intent(out),optional :: error_msg !! the error message.
+                                                                           !! (not allocated if
+                                                                           !! there were no errors)
 
-    status_ok = .not. json%exception_thrown
+    if (present(status_ok)) status_ok = .not. json%exception_thrown
 
-    if (.not. status_ok) then
-        if (allocated(json%err_message)) then
+    if (present(error_msg)) then
+        if (json%exception_thrown) then
+            ! if an exception has been thrown,
+            ! then this will always be allocated
+            ! [see json_throw_exception]
             error_msg = json%err_message
-        else
-            error_msg = 'Unknown error.'
         end if
-    else
-        error_msg = CK_''
     end if
 
     end subroutine json_check_for_errors
@@ -5225,7 +5230,7 @@ end subroutine json_value_to_string
 !
 !  Print the [[json_value]] structure to a file.
 
-    subroutine json_print_1(json,p,iunit)
+    subroutine json_print_to_unit(json,p,iunit)
 
     implicit none
 
@@ -5234,15 +5239,16 @@ subroutine json_print_1(json,p,iunit)
     integer(IK),intent(in)               :: iunit   !! the file unit (the file must
                                                     !! already have been opened, can't be -1).
 
-    character(kind=CK,len=:),allocatable :: dummy
+    character(kind=CK,len=:),allocatable :: dummy !! dummy for `str` argument
+                                                  !! to [[json_value_print]]
 
     if (iunit/=unit2str) then
         call json%json_value_print(p,iunit,str=dummy, indent=1_IK, colon=.true.)
     else
-        call json%throw_exception('Error in json_print_1: iunit must not be -1.')
+        call json%throw_exception('Error in json_print_to_unit: iunit must not be -1.')
     end if
 
-    end subroutine json_print_1
+    end subroutine json_print_to_unit
 !*****************************************************************************************
 
 !*****************************************************************************************
@@ -5251,7 +5257,7 @@ end subroutine json_print_1
 !
 !  Print the [[json_value]] structure to a file.
 
-    subroutine json_print_2(json,p,filename)
+    subroutine json_print_to_filename(json,p,filename)
 
     implicit none
 
@@ -5260,18 +5266,19 @@ subroutine json_print_2(json,p,filename)
     character(kind=CDK,len=*),intent(in) :: filename  !! the filename to print to
                                                       !! (should not already be open)
 
-    integer(IK) :: iunit,istat
+    integer(IK) :: iunit  !! file unit for `open` statement
+    integer(IK) :: istat  !! `iostat` code for `open` statement
 
     open(newunit=iunit,file=filename,status='REPLACE',iostat=istat FILE_ENCODING )
     if (istat==0) then
         call json%print(p,iunit)
         close(iunit,iostat=istat)
     else
-        call json%throw_exception('Error in json_print_2: could not open file: '//&
+        call json%throw_exception('Error in json_print_to_filename: could not open file: '//&
                               trim(filename))
     end if
 
-    end subroutine json_print_2
+    end subroutine json_print_to_filename
 !*****************************************************************************************
 
 !*****************************************************************************************
@@ -5291,16 +5298,17 @@ recursive subroutine json_value_print(json,p,iunit,str,indent,&
 
     class(json_core),intent(inout)       :: json
     type(json_value),pointer,intent(in)  :: p
-    integer(IK),intent(in)               :: iunit             !! file unit to write to (6=console)
+    integer(IK),intent(in)               :: iunit             !! file unit to write to (the
+                                                              !! file is assumed to be open)
     integer(IK),intent(in),optional      :: indent            !! indention level
     logical(LK),intent(in),optional      :: is_array_element  !! if this is an array element
     logical(LK),intent(in),optional      :: need_comma        !! if it needs a comma after it
     logical(LK),intent(in),optional      :: colon             !! if the colon was just written
     character(kind=CK,len=:),intent(inout),allocatable :: str
-                                                      !! if `iunit==unit2str` (-1) then the structure is
-                                                      !! printed to this string rather than
-                                                      !! a file. This mode is used by
-                                                      !! [[json_value_to_string]].
+                                                      !! if `iunit==unit2str` (-1) then
+                                                      !! the structure is printed to this
+                                                      !! string rather than a file. This mode
+                                                      !! is used by [[json_value_to_string]].
     logical(LK),intent(in),optional :: is_compressed_vector  !! if True, this is an element
                                                              !! from an array being printed
                                                              !! on one line [default is False]
@@ -5326,6 +5334,16 @@ recursive subroutine json_value_print(json,p,iunit,str,indent,&
 
     if (.not. json%exception_thrown) then
 
+        if (.not. associated(p)) then
+            ! note: a null() pointer will trigger this error.
+            ! However, if the pointer is undefined, then this will
+            ! crash (if this wasn't here it would crash below when
+            ! we try to access the contents)
+            call json%throw_exception('Error in json_value_print: '//&
+                                      'the pointer is not associated')
+            return
+        end if
+
         if (present(is_compressed_vector)) then
             is_vector = is_compressed_vector
         else
@@ -5420,6 +5438,7 @@ recursive subroutine json_value_print(json,p,iunit,str,indent,&
                     ! recursive print of the element
                     call json%json_value_print(element, iunit=iunit, indent=tab + 1, &
                                     need_comma=i<count, colon=.true., str=str)
+                    if (json%exception_thrown) return
 
                     ! get the next child the list:
                     element => element%next
@@ -5500,6 +5519,8 @@ recursive subroutine json_value_print(json,p,iunit,str,indent,&
                         call json%json_value_print(element, iunit=iunit, indent=tab,&
                                         need_comma=i<count, is_array_element=.true., str=str)
                     end if
+                    if (json%exception_thrown) return
+
                     ! get the next child the list:
                     element => element%next
 
@@ -8859,8 +8880,8 @@ subroutine annotate_invalid_json(json,iunit,str)
         end if
 
         !create the error message:
-        json%err_message = json%err_message//newline//&
-                           'line: '//trim(adjustl(line_str))//', '//&
+        if (allocated(json%err_message)) json%err_message = json%err_message//newline
+        json%err_message = 'line: '//trim(adjustl(line_str))//', '//&
                            'character: '//trim(adjustl(char_str))//newline//&
                            trim(line)//newline//arrow_str
 

src/tests/jf_test_02.F90

@@ -51,6 +51,16 @@ subroutine test_2(error_cnt)
         error_cnt = error_cnt + 1
     end if
 
+    ! first we test an incorrect usage case:
+    ! [trying to print a null json_value pointer]
+    nullify(p)
+    call json%print(p,error_unit)
+    if (.not. json%failed()) then
+        write(error_unit,'(A)') 'Error: printing a null pointer should have raised an exception.'
+        error_cnt = error_cnt + 1
+    end if
+    call json%initialize()  ! clears exceptions
+
     !root:
     call json%create_object(p,dir//filename2)    ! create the value and associate the pointer
                                                  ! add the file name as the name of the overall structure

src/tests/jf_test_15.F90

@@ -52,10 +52,16 @@ subroutine test_15(error_cnt)
     call json%get(p2,'logical',d)
     call json%get(p2,'integer',tf)
     call json%get(p2,'real',   tf)
+
     call json%check_for_errors(status_ok, error_msg)  !error condition true
+    call json%check_for_errors(status_ok)             !error condition true
+    call json%check_for_errors(error_msg=error_msg)   !error condition true
+
     call json%initialize(print_signs=.true.)  !print signs flag
 
     call json%check_for_errors(status_ok, error_msg)  !error condition false
+    call json%check_for_errors(status_ok)             !error condition false
+    call json%check_for_errors(error_msg=error_msg)   !error condition false - not allocated
 
     call file1%move(file2) !should throw an exception since points are not associated
     call file1%initialize()