Merge pull request #393 from sasjs/issue1403

feat: adding mp_replace option to mv_createfile

README.md

@@ -147,16 +147,17 @@ filename mc url "https://raw.githubusercontent.com/sasjs/core/main/all.sas";
 - macro names must be lowercase
 - one macro per file
 - prefixes:
-  - _mcf_ for macro compiled functions (proc fcmp)
-  - _mddl_ for macros containing DDL (Data Definition Language)
-  - _mf_ for macro functions (can be used in open code).
-  - _ml_ for macros that are used to compile LUA modules
-  - _mm_ for metadata macros (interface with the metadata server).
-  - _mmx_ for macros that use metadata and are XCMD enabled (working on both windows and unix)
-  - _mp_ for macro procedures (which generate sas code)
-  - _ms_ for macro procedures that will only work with [@sasjs/server](https://github.com/sasjs/server)
-  - _mv_ for macro procedures that will only work in Viya
-  - _mx_ for macros that work on Viya, SAS 9 EBI and SASjs Server
+  - _mcf__: macro compiled functions (proc fcmp)
+  - _mddl__: macros containing DDL (Data Definition Language)
+  - _mf__: macro functions (can be used in open code).
+  - _mfv__: macro functions that work only in Viya
+  - _ml__: macros that are used to compile LUA modules
+  - _mm__: metadata macros (interface with the metadata server).
+  - _mmx__: macros that use metadata and are XCMD enabled (working on both windows and unix)
+  - _mp__: macro procedures (which generate sas code)
+  - _ms__: macro procedures that will only work with [@sasjs/server](https://github.com/sasjs/server)
+  - _mv__: macro procedures that will only work in Viya
+  - _mx__: macros that work on Viya, SAS 9 EBI and SASjs Server
 - follow verb-noun convention
 - unix style line endings (lf)
 - individual lines should be no more than 80 characters long

all.sas

@@ -11828,7 +11828,8 @@ insert into &outds select distinct * from &append_ds;
   LUA, you can also use this macro: mp_gsubfile.sas
 
   @param [in] infile The QUOTED path to the file on which to perform the
-    substitution
+    substitution.  Note that you can extract the pathname from a fileref using
+    the pathname function, eg: `"%sysfunc(pathname(fref))"`;
   @param [in] findvar= Macro variable NAME containing the string to search for
   @param [in] replacevar= Macro variable NAME containing the replacement string
   @param [out] outfile= (0) Optional QUOTED path to the adjusted output file (to
@@ -24239,6 +24240,20 @@ run;
       run;
       %mv_createfile(path=/Public/temp,name=newfile.txt,inref=myfile)
 
+  The macro also supports find & replace (used by the SASjs Streaming App
+  build program).  This allows one string to be replaced by another at the
+  point at which the file is created.  This is done by passing in the NAMES of
+  the macro variables containing the values to be swapped, eg:
+
+      filename fref temp;
+      data _null_;
+        file fref;
+        put 'whenever life gets you down, Mrs Brown..';
+      run;
+      %let f=Mrs Brown;
+      %let r=just remember that you're standing on a planet that's evolving;
+      %mv_createfile(path=/Public,name=life.md,inref=fref,fin,swap=f r)
+
 
   @param [in] path= The parent (SAS Drive) folder in which to create the file
   @param [in] name= The name of the file to be created
@@ -24260,6 +24275,8 @@ run;
     @li sas_services
   @param [in] force= (YES) Will overwrite (delete / recreate) files by default.
     Set to NO to abort if a file already exists in that location.
+  @param pin] swap= (0) Provide two macro variable NAMES that contain the values
+    to be swapped, eg swap=find replace (see also the example above)
   @param [out] outds= (_null_) Output dataset with the uri of the new file
 
   @param [in] mdebug= (0) Set to 1 to enable DEBUG messages
@@ -24273,6 +24290,7 @@ run;
   @li mfv_getpathuri.sas
   @li mp_abort.sas
   @li mp_base64copy.sas
+  @li mp_replace.sas
   @li mv_createfolder.sas
 
   <h4> Related Macros</h4>
@@ -24291,6 +24309,7 @@ run;
     ,mdebug=0
     ,outds=_null_
     ,force=YES
+    ,swap=0
   );
 %local dbg;
 %if &mdebug=1 %then %do;
@@ -24335,6 +24354,12 @@ run;
 %end;
 %else %put %str(ERR)OR: invalid value for intype: &intype;
 
+%if "&swap" ne "0" %then %do;
+  %mp_replace("%sysfunc(pathname(&fref))"
+    ,findvar=%scan(&swap,1,%str( ))
+    ,replacevar=%scan(&swap,2,%str( ))
+  )
+%end;
 
 %if &mdebug=1 %then %do;
   data _null_;
@@ -24379,8 +24404,10 @@ run;
   %end;
         "Accept"="*/*";
   run;
-  %put &sysmacroname DELETE &base_uri&fileuri
-    &=SYS_PROCHTTP_STATUS_CODE &=SYS_PROCHTTP_STATUS_PHRASE;
+  %put &sysmacroname DELETE &base_uri&fileuri;
+  %if &SYS_PROCHTTP_STATUS_CODE ne 204 %then %do;
+    %put &=SYS_PROCHTTP_STATUS_CODE &=SYS_PROCHTTP_STATUS_PHRASE;
+  %end;
 %end;
 
 %local url mimetype ext;
@@ -24427,7 +24454,7 @@ run;
 %local libref2;
 %let libref2=%mf_getuniquelibref();
 libname &libref2 JSON fileref=&fname1;
-%put Grabbing the follow on link ;
+/* Grab the follow on link */
 data &outds;
   set &libref2..links end=last;
   if rel='createChild' then do;
@@ -24436,10 +24463,8 @@ data &outds;
   end;
 run;
 
-%put &sysmacroname: File &name successfully created:;%put;
-%put    &base_uri%mfv_getpathuri(&path/&name);%put;
+%put &sysmacroname: &name created at %mfv_getpathuri(&path/&name);%put;
 %put    &base_uri/SASJobExecution?_file=&path/&name;%put;
-%put &sysmacroname:;
 
 %mend mv_createfile;/**
   @file mv_createfolder.sas
@@ -24490,7 +24515,7 @@ run;
 %else %let dbg=*;
 
 %if %mfv_existfolder(&path)=1 %then %do;
-  %put &sysmacroname: &path already exists;
+  %&dbg.put &sysmacroname: &path already exists;
   data &outds;
     self_uri="%mfv_getpathuri(&path)";
     output;

base/mp_replace.sas

@@ -33,7 +33,8 @@
   LUA, you can also use this macro: mp_gsubfile.sas
 
   @param [in] infile The QUOTED path to the file on which to perform the
-    substitution
+    substitution.  Note that you can extract the pathname from a fileref using
+    the pathname function, eg: `"%sysfunc(pathname(fref))"`;
   @param [in] findvar= Macro variable NAME containing the string to search for
   @param [in] replacevar= Macro variable NAME containing the replacement string
   @param [out] outfile= (0) Optional QUOTED path to the adjusted output file (to

tests/viyaonly/mv_createfile.test.sas

@@ -23,7 +23,7 @@ data _null_;
   put 'hello testings';
 run;
 %mp_assertscope(SNAPSHOT)
-%mv_createfile(path=&mcTestAppLoc/temp, name=&file..txt,inref=somefile,mdebug=1)
+%mv_createfile(path=&mcTestAppLoc, name=&file..txt,inref=somefile,mdebug=1)
 %mp_assertscope(COMPARE
   ,ignorelist=MCLIB0_JADP1LEN MCLIB0_JADP2LEN MCLIB0_JADPNUM
     MCLIB0_JADVLEN MCLIB2_JADP1LEN
@@ -32,7 +32,7 @@ run;
 )
 
 %mp_assert(
-  iftrue=(%mfv_existfile(&mcTestAppLoc/temp/&file..txt)=1),
+  iftrue=(%mfv_existfile(&mcTestAppLoc/&file..txt)=1),
   desc=Check if created file exists
 )
 
@@ -42,10 +42,10 @@ data _null_;
   file f2;
   put '<html><body><p>Hello world</p></body></html>';
 run;
-%mv_createfile(path=&mcTestAppLoc/temp, name=test.html,inref=f2,mdebug=1)
+%mv_createfile(path=&mcTestAppLoc, name=test.html,inref=f2,mdebug=1)
 
 %mp_assert(
-  iftrue=(%mfv_existfile(&mcTestAppLoc/temp/test.html)=1),
+  iftrue=(%mfv_existfile(&mcTestAppLoc/test.html)=1),
   desc=Check if created file exists
 )
 
@@ -55,10 +55,10 @@ x=1;
 run;
 filename ds "%sysfunc(pathname(work))/temp.sas7bdat";
 
-%mv_createfile(path=&mcTestAppLoc/temp, name=&file..sas7bdat,inref=ds,mdebug=1)
+%mv_createfile(path=&mcTestAppLoc, name=&file..sas7bdat,inref=ds,mdebug=1)
 
 %mp_assert(
-  iftrue=(%mfv_existfile(&mcTestAppLoc/temp/&file..sas7bdat)=1),
+  iftrue=(%mfv_existfile(&mcTestAppLoc/&file..sas7bdat)=1),
   desc=Check if created dataset exists
 )
 
@@ -68,19 +68,44 @@ data _null_;
   file f4;
   put '%put hello FromSASStudioBailey; ';
 run;
-%mv_createfile(path=&mcTestAppLoc/temp, name=test4.sas,inref=f4,mdebug=1)
+%mv_createfile(path=&mcTestAppLoc, name=test4.sas,inref=f4,mdebug=1)
 
 %mp_assert(
-  iftrue=(%mfv_existfile(&mcTestAppLoc/temp/test4.sas)=1),
+  iftrue=(%mfv_existfile(&mcTestAppLoc/test4.sas)=1),
   desc=Check if created sas program exists
 )
 
 
 
 %put TEST 5 - reading from files service and writing back;
-filename sendfrom filesrvc folderpath="&mcTestAppLoc/temp" filename='test4.sas';
+filename sendfrom filesrvc folderpath="&mcTestAppLoc" filename='test4.sas';
 
 OPTIONS MERROR SYMBOLGEN MLOGIC MPRINT;
 
-%mv_createfile(path=&mcTestAppLoc/temp,name=test5.sas,inref=sendfrom,mdebug=1) ;
+%mv_createfile(path=&mcTestAppLoc,name=test5.sas,inref=sendfrom,mdebug=1) ;
 
+%put TEST 6 - try the find and replace;
+filename f6 temp;
+data _null_;
+  file f6;
+  put '//Hello world!';
+  put 'let var=/some/path/name;';
+run;
+%let in=/some/path/name;
+%let out=/final/destination;
+%mv_createfile(path=&mcTestAppLoc, name=test6.js,inref=f6,mdebug=1,swap=in out)
+
+filename getback filesrvc folderpath="&mcTestAppLoc" filename='test6.js';
+
+%let test6=0;
+data _null_;
+  infile getback;
+  input;
+  if _infile_="let var=&out;" then call symputx('test6',1);
+  putlog _infile_;
+run;
+
+%mp_assert(
+  iftrue=(&test6=1),
+  desc=Check if find & replace worked
+)

viya/mv_createfile.sas

@@ -17,6 +17,20 @@
       run;
       %mv_createfile(path=/Public/temp,name=newfile.txt,inref=myfile)
 
+  The macro also supports find & replace (used by the SASjs Streaming App
+  build program).  This allows one string to be replaced by another at the
+  point at which the file is created.  This is done by passing in the NAMES of
+  the macro variables containing the values to be swapped, eg:
+
+      filename fref temp;
+      data _null_;
+        file fref;
+        put 'whenever life gets you down, Mrs Brown..';
+      run;
+      %let f=Mrs Brown;
+      %let r=just remember that you're standing on a planet that's evolving;
+      %mv_createfile(path=/Public,name=life.md,inref=fref,fin,swap=f r)
+
 
   @param [in] path= The parent (SAS Drive) folder in which to create the file
   @param [in] name= The name of the file to be created
@@ -38,6 +52,8 @@
     @li sas_services
   @param [in] force= (YES) Will overwrite (delete / recreate) files by default.
     Set to NO to abort if a file already exists in that location.
+  @param pin] swap= (0) Provide two macro variable NAMES that contain the values
+    to be swapped, eg swap=find replace (see also the example above)
   @param [out] outds= (_null_) Output dataset with the uri of the new file
 
   @param [in] mdebug= (0) Set to 1 to enable DEBUG messages
@@ -51,6 +67,7 @@
   @li mfv_getpathuri.sas
   @li mp_abort.sas
   @li mp_base64copy.sas
+  @li mp_replace.sas
   @li mv_createfolder.sas
 
   <h4> Related Macros</h4>
@@ -69,6 +86,7 @@
     ,mdebug=0
     ,outds=_null_
     ,force=YES
+    ,swap=0
   );
 %local dbg;
 %if &mdebug=1 %then %do;
@@ -113,6 +131,12 @@
 %end;
 %else %put %str(ERR)OR: invalid value for intype: &intype;
 
+%if "&swap" ne "0" %then %do;
+  %mp_replace("%sysfunc(pathname(&fref))"
+    ,findvar=%scan(&swap,1,%str( ))
+    ,replacevar=%scan(&swap,2,%str( ))
+  )
+%end;
 
 %if &mdebug=1 %then %do;
   data _null_;
@@ -157,8 +181,10 @@ run;
   %end;
         "Accept"="*/*";
   run;
-  %put &sysmacroname DELETE &base_uri&fileuri
-    &=SYS_PROCHTTP_STATUS_CODE &=SYS_PROCHTTP_STATUS_PHRASE;
+  %put &sysmacroname DELETE &base_uri&fileuri;
+  %if &SYS_PROCHTTP_STATUS_CODE ne 204 %then %do;
+    %put &=SYS_PROCHTTP_STATUS_CODE &=SYS_PROCHTTP_STATUS_PHRASE;
+  %end;
 %end;
 
 %local url mimetype ext;
@@ -205,7 +231,7 @@ run;
 %local libref2;
 %let libref2=%mf_getuniquelibref();
 libname &libref2 JSON fileref=&fname1;
-%put Grabbing the follow on link ;
+/* Grab the follow on link */
 data &outds;
   set &libref2..links end=last;
   if rel='createChild' then do;
@@ -214,9 +240,7 @@ data &outds;
   end;
 run;
 
-%put &sysmacroname: File &name successfully created:;%put;
-%put    &base_uri%mfv_getpathuri(&path/&name);%put;
+%put &sysmacroname: &name created at %mfv_getpathuri(&path/&name);%put;
 %put    &base_uri/SASJobExecution?_file=&path/&name;%put;
-%put &sysmacroname:;
 
 %mend mv_createfile;

viya/mv_createfolder.sas

@@ -47,7 +47,7 @@
 %else %let dbg=*;
 
 %if %mfv_existfolder(&path)=1 %then %do;
-  %put &sysmacroname: &path already exists;
+  %&dbg.put &sysmacroname: &path already exists;
   data &outds;
     self_uri="%mfv_getpathuri(&path)";
     output;