Sleeping over this revision problem in the context of the documentation there is another problem
with them in the case we must update the copyright notes in the files: each file that gets changed
and committed will get a new revision which does not reflect the revision of the last change of the
documentation.
Here an additional approach to solve this: if there is a file ${book}/revision_info.txt (this file
needs to be created by the script with the revision information as the only content and can then be
edited manually from then on) then use its content for the revision information and do not inspect
the revisions of the individual documentation files. If that ${book}/revision_info.txt is missing,
then go ahead and try to figure out the revision information with the current logic (and create
${book}/revision_info.txt with the revision information).
If one uses the current logic first (in addition will ignore the revision of "Authors_Group.xml") -
before updating the copyright information - and then creates those ${book}/revision_info.txt files
the revision information remains the same until sometimes in the future the file gets updated (to
run the fallback logic in the future one would need to rename or delete ${book}/revision_info.txt,
such that the fallback logic takes effect).
Enclosed the updated script (needs to go into tools).
---
If this is o.k. for everyone I would use it to set EDITION to "2022.12.24" (to distinguish it from
the current) and have the revision information created and appended to it, including creating
revision_info.txt which I would add to be committed as well (rerunning is almost instantaneous with it).
---rony
... cut ...
#!/usr/bin/env rexx
/*----------------------------------------------------------------------------*/
/* */
/* Copyright (c) 2022 Rexx Language Association. All rights reserved. */
/* */
/* This program and the accompanying materials are made available under */
/* the terms of the Common Public License v1.0 which accompanies this */
/* distribution. A copy is also available at the following address: */
/* http://www.oorexx.org/license.html */
/* */
/* Redistribution and use in source and binary forms, with or */
/* without modification, are permitted provided that the following */
/* conditions are met: */
/* */
/* Redistributions of source code must retain the above copyright */
/* notice, this list of conditions and the following disclaimer. */
/* Redistributions in binary form must reproduce the above copyright */
/* notice, this list of conditions and the following disclaimer in */
/* the documentation and/or other materials provided with the distribution. */
/* */
/* Neither the name of Rexx Language Association nor the names */
/* of its contributors may be used to endorse or promote products */
/* derived from this software without specific prior written permission. */
/* */
/* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS */
/* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT */
/* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS */
/* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT */
/* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, */
/* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED */
/* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, */
/* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY */
/* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING */
/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS */
/* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
/* */
/*----------------------------------------------------------------------------*/
/* purpose: - allow updating the entity values for YEAR, VERSION and EDITION
in the appropriate books (${book}/en-US/${book].ent)
usage: - no argument: show the current values of the entites YEAR, VERSION
and EDITION for each book
- arguments: [-r revisionNumber] [-y "year string"] [-v "version string"] [-e "edition string"] [directory]
... revisionNumber: do not honor revisionNumber or higher;
use revisionNumber of branches-creation, e.g. 12537 for branches/5.0.0 on 2022-12-14
date: 2022-12-21, 2022-12-22
version: 0.03
*/
-- using .sysCargs as this supplies the arguments like the shell:
-- updateEntityValues.rex -y "2022" ..
-- updateEntityValues.rex -v "5.0.0 -> 5.1.0" ..
-- updateEntityValues.rex -e "2022.12.24" ..
-- updateEntityValues.rex -r 12537 -e "2022.12.24" ..
if arg()=0 then -- show usage
do
say .resources~usage
exit
end
call analyzeArgs
if .argYear | .argVersion | .argEdition then -- update any of the entity values?
do
call updateEntityValues
end
exit
analyzeArgs: procedure
pkgLocal=.context~package~local
pkgLocal~dirSep=.rexxInfo~directorySeparator
pkgLocal~revInfoFileName="revision_info.txt"
pkgLocal~dir=.nil
argNum=.sysCargs~items
if argNum<2 then -- show values: either no argument (currDir) or directory argument
do
if argNum=0 then pkgLocal~dir="."
else pkgLocal~dir=.sysCArgs[1]
if \sysFileExists(.dir) then
do
.error~say("directory" pp(.dir) "does not exist, aborting ...")
exit -1
end
call showEntityValues
exit 0
end
if argNum//2=1 then -- uneven, last argument is the directory argument
do
pkgLocal~dir=.sysCargs[argNum] -- assign directory argument
if \sysFileExists(.dir) then
do
.error~say("directory" pp(.dir) "does not exist, aborting ...")
exit -2
end
argNum-=1 -- now only switch/value pairs if any
end
else if .dir~isNil then -- directory to work on is missing
do
.error~say("missing directory, must be last argument, aborting ...")
exit -3
end
pkgLocal~argYear =.false -- default values
pkgLocal~argVersion=.false
pkgLocal~argEdition=.false
pkgLocal~argRelease=.false
do i=1 to argNum by 2
select case .sysCargs[i]
when "-r" then -- latest year value: if alreay a year range, then change the upper year to the supplied one
do
pkgLocal~releaseValue =.sysCargs[i+1]~strip
pkgLocal~argRelease =.true
end
when "-y" then -- latest year value: if alreay a year range, then change the upper year to the supplied one
do
pkgLocal~yearValue =.sysCargs[i+1]~strip
pkgLocal~argYear =.true
end
when "-v" then -- replace for all
do
parse value .sysCargs[i+1] with currValue "->" newValue
if newValue<>"" then
do
pkgLocal~versionCurrValue=currValue~strip
pkgLocal~versionNewValue =newValue~strip
pkgLocal~argVersion =.true
end
end
when "-e" then
do
pkgLocal~editionValue=.sysCargs[i+1] -- replace for all plus add book's revision information
pkgLocal~argEdition =.true
end
otherwise
say "unknown switch" pp(.sysCargs[i]) "with value" pp(.sysCargs[i+1])", aborting ..."
exit -4
end
end
return
::routine showEntityValues -- show the entity values YEAR, VERSION and EDITION of all books
tgtDir=.dir || .dirSep
call sysFileTree tgtDir"*", "dirs.", "DO"
do i=1 to dirs.0
bookPath=dirs.i
book=FileSpec('name',dirs.i) -- get directory assume it is a book
-- say "... book:" pp(book) "bookPath="pp(bookPath)
entFile=bookPath || .dirSep || "en-US" || .dirSep || book".ent"
-- say "... book:" pp(book) "entFile:" pp(entFile)
if SysFileExists(entFile) then
do
res=analyzeEntFile(entFile) -- returns the values
say (book~left(17,'.')) res
end
else
say entFile": does not exist, skipping ..."
end
::routine analyzeEntFile
parse arg entFile
s=.stream~new(entFile)~~open("read")
str=s~arrayin~makeString -- get file's content
s~close
res=""
do ent over "YEAR", "VERSION", "EDITION"
needle1='<!ENTITY' ent
needle2='>'
res=res ent":"
pos=1 -- start out
do forever
-- say "... a) pos:" pp(pos) "needle1:" pp(needle1)
pos=pos(needle1,str,pos) -- look for the needle
-- say "... b) pos:" pp(pos) "needle1:" pp(needle1)
if pos=0 then
do
res=res pp("n/a") -- not available (maybe commented out)
-- say "... cannot find" pp(needle1) "..."
leave
end
posCommEnd=lastPos('-->',str,pos) -- in an XML comment?
if posCommEnd>0 then
do
posCommStart=lastPos('<!--',str,pos)
if posCommEnd<posCommStart then -- we are in a comment
do
pos=pos("-->",str,posCommStart) -- position on end of comment
if pos=0 then
do
res=res pp("problem: XML end comment '-->' missing!")
leave
end
iterate
end
end
-- o.k. outside of a comment
-- parse var str =(pos) (needle1) val (needle2)
parse var str 1 preStr +(pos-1) =(pos) (needle1) val (needle2)
-- say "... pos="pp(pos) "needle1="pp(needle1) "val="pp(val) "| str~substr(pos,10):" pp(str~substr(pos,10))
res = res val~strip
leave
end
end
return strip(res)
::routine updateEntityValues -- show the entity values YEAR, VERSION and EDITION of all books
tgtDir=.dir || .dirSep
call sysFileTree tgtDir"*", "dirs.", "DO"
do i=1 to dirs.0 -- for 1 -- NIXI
bookPath=dirs.i
book=FileSpec('name',dirs.i) -- get directory assume it is a book
-- say "... book:" pp(book) "bookPath="pp(bookPath)
entFile=bookPath || .dirSep || "en-US" || .dirSep || book".ent"
-- say "... book:" pp(book) "entFile:" pp(entFile)
if SysFileExists(entFile) then
do
res=updateEntFile(entFile, bookPath, book) -- returns the values
say (book~left(17,'.')) res
end
end
::routine updateEntFile
parse arg entFile, bookPath, book
s=.stream~new(entFile)~~open("read")
str=s~charIn(1,s~chars)
s~close
res=""
mb=.MutableBuffer~new
do ent over "YEAR", "VERSION", "EDITION"
select case ent -- skip entity ?
when 'YEAR' then if .argYear =.false then iterate
when 'VERSION' then if .argVersion=.false then iterate
when 'EDITION' then if .argEdition=.false then iterate
otherwise nop
end
needle1='<!ENTITY' ent
needle2='>'
res=res ent":"
pos=1 -- start out
do forever
-- say "... a) pos:" pp(pos) "needle1:" pp(needle1)
pos=pos(needle1,str,pos) -- look for the needle
-- say "... b) pos:" pp(pos) "needle1:" pp(needle1)
if pos=0 then
do
res=res pp("n/a") -- not available (maybe commented out)
-- say "... cannot find" pp(needle1) "..."
leave
end
posCommEnd=lastPos('-->',str,pos) -- in an XML comment?
if posCommEnd>0 then
do
posCommStart=lastPos('<!--',str,pos)
if posCommEnd<posCommStart then -- we are in a comment
do
pos=pos("-->",str,posCommStart) -- position on end of comment
if pos=0 then
do
res=res pp("problem: XML end comment '-->' missing!")
leave
end
iterate
end
end
-- o.k. outside of a comment
parse var str 1 preStr +(pos-1) =(pos) (needle1) '"' val '"' (needle2) str
-- say "... pos="pp(pos) "needle1="pp(needle1) "val="pp(val) "| str~substr(pos,10):" pp(str~substr(pos,10))
mb~append(preStr,needle1,' "')
select case ent -- process entity
when 'YEAR' then -- replace or change upper year
do
if val~pos("-")>0 then -- already a range, replace upper year
do
parse var val oldYear '-' currYear
mb~append(oldYear,'-',.yearValue)
end
else
do
if val<.yearValue then
mb~append(val~strip,"-",.yearValue) -- turn into range
else
mb~append(.yearValue)
end
end
when 'VERSION' then mb~append(val~changeStr(.versionCurrValue,.versionNewValue))
when 'EDITION' then
do
mb~append(.editionValue)
if .argRelease then -- if release supplied: ignore release or newer
do
revFileName=bookPath || .dirSep || .revInfoFileName
if sysFileExists(revFileName) then -- use first line of ${book}/revision_info.txt
do
sr=.stream~new(revFileName)~~open("read")
srArr=sr~arrayIn
sr~close
mb~append(" ",srArr[1]) -- write first line
end
else
do
revInfo=getRevInfo(bookPath, book) -- get revision information
mb~append(" ",revInfo)
-- save revision info in ${book}/revision_info.txt
.stream~new(revFileName)~~open("write")~~charout(revInfo)~~close
end
end
end
otherwise nop
end
mb~append('"',needle2)
res = res val~strip
leave
end
end
mb~append(str) -- append any left over
newContent=mb~string
-- replace file
.stream~new(entFile)~~open("replace")~~charout(newContent)~~close
return strip(res)
::requires "svnListRevisions.rex" -- get revision utility
::routine pp
return "["arg(1)"]"
::routine getRevInfo
use arg bookPath, book
-- look into the files in "en-US", ignore ${book}.ent file
tgtDir=bookPath || .dirSep || "en-US"
ignoreFiles=book".ent" "Author_Group.xml" -- add additional file names, if sensible
arr=getRevisionInfos(tgtDir)
maxRelease=.releaseValue-1 -- anything higher (= newer) gets ignored
tmpRelease=.nil
do revItem over arr
if revItem~revision>maxRelease then iterate
if wordPos(revItem~name,ignoreFiles)>0 then iterate
if tmpRelease=.nil then
tmpRelease=revItem
else if tmpRelease~date<revItem~date then
tmpRelease=revItem
end
parse value tmpRelease~date with date "T" time
return "(last revised on" date~changeStr("-","") "with r"tmpRelease~revision")"
::resource usage -- usage information (if no argument supplied)
List or change the values for the entities YEAR, VERSION, EDITION from/in
all the files ${book}/en-US/${book].ent
updateEntityValues [arguments]
no argument ... show this text
-y latestYear ... set the latest year in YEAR to latestYear (a number)
-v "version" ... set VERSION to the supplied string (can be anything)
-r revision ... all revisions smaller than revision (number) get honored,
takes effect when -e switch is supplied; note: if the
file ${book}/revision_info.txt exists, then its first
line will be used as the revision information string
-e "edition" ... set EDITION to the supplied string (can be anything);
if -r switch is not set, then no revision information
string gets appended
dir ... always the last argument, denotes the root of the docs
directory to work on (if dir contains spaces it needs
to be enquoted in double-quotes)
::END
_______________________________________________
Oorexx-devel mailing list
Oorexx-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/oorexx-devel
