Getting Started with SAS Packages

recompiled with new version of the framework

README.md

@@ -6,7 +6,7 @@ A **SAS package** is an automatically generated, single, stand alone *zip* file
 
 The *purpose of a package* is to be a simple, and easy to access, code sharing medium, which will allow: on the one hand, to separate the code complex dependencies created by the developer from the user experience with the final product and, on the other hand, reduce developer's and user's unnecessary frustration related to a remote deployment process.
 
-In this repository we are presenting the **SAS Packages Framework** which allows to develop and use SAS packages. The latest version of SPF is `20200807`.  
+In this repository we are presenting the **SAS Packages Framework** which allows to develop and use SAS packages. The latest version of SPF is `20200811`.  
 
 To get started with SAS Packages try this [**`Getting Started with SAS Packages`**](https://github.com/yabwon/SAS_PACKAGES/blob/master/SPF/Documentation/Getting_Started_with_SAS_Packages.pdf "Getting Started with SAS Packages") presentation (see the `./SPF/Documentation` directory).
 
@@ -88,7 +88,7 @@ run;
   %end;
 ```
 
-- **BasePlus**\[0.52\] adds a bunch of functionalities I am missing in BASE SAS, such as:
+- **BasePlus**\[0.53\] adds a bunch of functionalities I am missing in BASE SAS, such as:
 ```
 call arrMissToRight(myArray); 
 call arrFillMiss(17, myArray); 
@@ -100,7 +100,7 @@ string = catXFn("date9.", "#", myArray);
 
 format x bool.;
 
-%put %getVars(sashelp.class, patern = ght$, sep = +, varRange = _numeric_);
+%put %getVars(sashelp.class, pattern = ght$, sep = +, varRange = _numeric_);
 ```
 
 - **dynMacroArray**\[0.2\], set of macros (wrappers for a hash table) emulating dynamic array in the data step (macro predecessor of DFA)

SPF/SPFinit.sas

@@ -42,7 +42,7 @@
    - to unload, or
    - to generate SAS packages.
 
-  Version 20200807.
+  Version 20200811.
   See examples below.
 
    A SAS package is a zip file containing a group of files
@@ -81,16 +81,22 @@
                                        */
 )/secure 
 /*** HELP END ***/
-des = 'Macro to load SAS package, version 20200807. Run %loadPackage() for help info.'
+des = 'Macro to load SAS package, version 20200811. Run %loadPackage() for help info.'
 ;
-%if %superq(packageName) = %then
+%if (%superq(packageName) = ) OR (%qupcase(&packageName.) = HELP) %then
   %do;
+    %local options_tmp ;
+    %let options_tmp = ls=%sysfunc(getoption(ls))ps=%sysfunc(getoption(ps))
+     %sysfunc(getoption(notes)) %sysfunc(getoption(source))
+     msglevel=%sysfunc(getoption(msglevel))
+    ;
+    options NOnotes NOsource ls=MAX ps=MAX msglevel=N;
     %put ;
     %put ###############################################################################;
     %put #        This is short help information for the loadPackage macro             #;
     %put ###############################################################################;
     %put #                                                                             #;
-    %put # Macro to load SAS packages, version 20200807                                #;
+    %put # Macro to load SAS packages, version 20200811                                #;
     %put #                                                                             #;
     %put # A SAS package is a zip file containing a group                              #;
     %put # of SAS codes (macros, functions, data steps generating                      #;
@@ -158,6 +164,7 @@ des = 'Macro to load SAS package, version 20200807. Run %loadPackage() for help
     %put ;
     %put ###############################################################################;
     %put ;
+    options &options_tmp.;
     %RETURN;
   %end;
   %local ls_tmp ps_tmp notes_tmp source_tmp fullstimer_tmp stimer_tmp msglevel_tmp;
@@ -235,16 +242,22 @@ des = 'Macro to load SAS package, version 20200807. Run %loadPackage() for help
                                        */
 )/secure
 /*** HELP END ***/
-des = 'Macro to unload SAS package, version 20200807. Run %unloadPackage() for help info.'
+des = 'Macro to unload SAS package, version 20200811. Run %unloadPackage() for help info.'
 ;
-%if %superq(packageName) = %then
+%if (%superq(packageName) = ) OR (%qupcase(&packageName.) = HELP) %then
   %do;
+    %local options_tmp ;
+    %let options_tmp = ls=%sysfunc(getoption(ls))ps=%sysfunc(getoption(ps))
+     %sysfunc(getoption(notes)) %sysfunc(getoption(source))
+     msglevel=%sysfunc(getoption(msglevel))
+    ;
+    options NOnotes NOsource ls=MAX ps=MAX msglevel=N;
     %put ;
     %put ###############################################################################;
     %put #        This is short help information for the unloadPackage macro           #;
     %put ###############################################################################;
     %put #                                                                             #;
-    %put # Macro to unload SAS packages, version 20200807                              #;
+    %put # Macro to unload SAS packages, version 20200811                              #;
     %put #                                                                             #;
     %put # A SAS package is a zip file containing a group                              #;
     %put # of SAS codes (macros, functions, data steps generating                      #;
@@ -303,6 +316,7 @@ des = 'Macro to unload SAS package, version 20200807. Run %unloadPackage() for h
     %put ;
     %put ###############################################################################;
     %put ;
+    options &options_tmp.;
     %RETURN;
   %end;
   %local ls_tmp ps_tmp notes_tmp source_tmp msglevel_tmp;
@@ -362,16 +376,22 @@ des = 'Macro to unload SAS package, version 20200807. Run %unloadPackage() for h
                                        */
 )/secure
 /*** HELP END ***/
-des = 'Macro to get help about SAS package, version 20200807. Run %helpPackage() for help info.'
+des = 'Macro to get help about SAS package, version 20200811. Run %helpPackage() for help info.'
 ;
-%if %superq(packageName) = %then
+%if (%superq(packageName) = ) OR (%qupcase(&packageName.) = HELP) %then
   %do;
+    %local options_tmp ;
+    %let options_tmp = ls=%sysfunc(getoption(ls))ps=%sysfunc(getoption(ps))
+     %sysfunc(getoption(notes)) %sysfunc(getoption(source))
+     msglevel=%sysfunc(getoption(msglevel))
+    ;
+    options NOnotes NOsource ls=MAX ps=MAX msglevel=N;
     %put ;
     %put ###############################################################################;
     %put #        This is short help information for the helpPackage macro             #;
     %put ###############################################################################;
     %put #                                                                             #;
-    %put # Macro to get help about SAS packages, version 20200807                      #;
+    %put # Macro to get help about SAS packages, version 20200811                      #;
     %put #                                                                             #;
     %put # A SAS package is a zip file containing a group                              #;
     %put # of SAS codes (macros, functions, data steps generating                      #;
@@ -435,6 +455,7 @@ des = 'Macro to get help about SAS package, version 20200807. Run %helpPackage()
     %put ;
     %put ###############################################################################;
     %put ;
+    options &options_tmp.;
     %RETURN;
   %end;
   %local ls_tmp ps_tmp notes_tmp source_tmp msglevel_tmp;
@@ -475,7 +496,7 @@ TODO:
 - add MD5(&packageName.) value hash instead "package" word in filenames [DONE]
 */
 
-/* Macros to install SAS packages, version 20200807  */
+/* Macros to install SAS packages, version 20200811  */
 /* A SAS package is a zip file containing a group of files
    with SAS code (macros, functions, data steps generating 
    data, etc.) wrapped up together and %INCLUDEed by
@@ -490,16 +511,22 @@ TODO:
 )
 /secure  
 /*** HELP END ***/
-des = 'Macro to install SAS package, version 20200807. Run %%installPackage() for help info.'
+des = 'Macro to install SAS package, version 20200811. Run %%installPackage() for help info.'
 ;
-%if %superq(packageName) = %then
+%if (%superq(packageName) = ) OR (%qupcase(&packageName.) = HELP) %then
   %do;
+    %local options_tmp ;
+    %let options_tmp = ls=%sysfunc(getoption(ls))ps=%sysfunc(getoption(ps))
+     %sysfunc(getoption(notes)) %sysfunc(getoption(source))
+     msglevel=%sysfunc(getoption(msglevel))
+    ;
+    options NOnotes NOsource ls=MAX ps=MAX msglevel=N;
     %put ;
     %put ########################################################################################;
     %put #        This is short help information for the installPackage macro                   #;
     %put ########################################################################################;
     %put #                                                                                      #;
-    %put # Macro to install SAS packages, version 20200807                                      #;
+    %put # Macro to install SAS packages, version 20200811                                      #;
     %put #                                                                                      #;
     %put # A SAS package is a zip file containing a group                                       #;
     %put # of SAS codes (macros, functions, data steps generating                               #;
@@ -551,6 +578,7 @@ des = 'Macro to install SAS package, version 20200807. Run %%installPackage() fo
     %put ;
     %put ########################################################################################;
     %put ;
+    options &options_tmp.;
     %RETURN;
   %end; 
   %local ls_tmp ps_tmp notes_tmp source_tmp fullstimer_tmp stimer_tmp msglevel_tmp;
@@ -762,7 +790,7 @@ des = 'Macro to install SAS package, version 20200807. Run %%installPackage() fo
 
 /* Macro to list SAS packages in packages folder. 
 
-  Version 20200807 
+  Version 20200811 
 
   A SAS package is a zip file containing a group 
   of SAS codes (macros, functions, data steps generating 
@@ -782,16 +810,22 @@ des = 'Macro to install SAS package, version 20200807. Run %%installPackage() fo
 
 
 %macro listPackages()/PARMBUFF
-des = 'Macro to list SAS packages from `packages` fileref, type %listPackages(HELP) for help, version 20200807.'
+des = 'Macro to list SAS packages from `packages` fileref, type %listPackages(HELP) for help, version 20200811.'
 ;
 %if %QUPCASE(&SYSPBUFF.) = %str(%(HELP%)) %then
   %do;
+    %local options_tmp ;
+    %let options_tmp = ls=%sysfunc(getoption(ls))ps=%sysfunc(getoption(ps))
+     %sysfunc(getoption(notes)) %sysfunc(getoption(source))
+     msglevel=%sysfunc(getoption(msglevel))
+    ;
+    options NOnotes NOsource ls=MAX ps=MAX msglevel=N;
     %put ;
     %put ########################################################################################;
     %put #        This is short help information for the listPackages macro                     #;
     %put ########################################################################################;
     %put #                                                                                      #;
-    %put # Macro to list available SAS packages, version 20200807                               #;
+    %put # Macro to list available SAS packages, version 20200811                               #;
     %put #                                                                                      #;
     %put # A SAS package is a zip file containing a group                                       #;
     %put # of SAS codes (macros, functions, data steps generating                               #;
@@ -828,6 +862,7 @@ des = 'Macro to list SAS packages from `packages` fileref, type %listPackages(HE
     %put ;
     %put ########################################################################################;
     %put ;
+    options &options_tmp.;
     %RETURN;
   %end;
 
@@ -884,7 +919,7 @@ data _null_;
                     _INFILE_ = scan(_INFILE_,1,":") !! ":" !! scan(_INFILE_,2,":");
                     putlog " *  " _INFILE_;
                   end;
-                if strip(_INFILE_) = "DESCRIPTION START:" then leave;
+                if upcase(strip(_INFILE_)) =: "DESCRIPTION START:" then leave;
             end; 
       end;
     
@@ -907,7 +942,7 @@ options ls = &ls_tmp. ps = &ps_tmp. &notes_tmp. &source_tmp.;
 
 /* Macro to generate SAS packages.
 
-   Version 20200807
+   Version 20200811
 
    A SAS package is a zip file containing a group 
    of SAS codes (macros, functions, data steps generating 
@@ -922,7 +957,7 @@ options ls = &ls_tmp. ps = &ps_tmp. &notes_tmp. &source_tmp.;
 
 /*** HELP START ***/
 %macro generatePackage(
- filesLocation=  /* location of package files 
+ filesLocation   /* location of package files 
                     e.g. %sysfunc(pathname(work))/%lowcase(&packageName.) */
 ,testPackage=Y   /* indicator if tests should be executed, 
                     default value Y means "execute tests" */
@@ -930,16 +965,22 @@ options ls = &ls_tmp. ps = &ps_tmp. &notes_tmp. &source_tmp.;
                     dependencies in loading */
 )/secure
 /*** HELP END ***/
-des = 'Macro to generate SAS packages, version 20200807. Run %generatePackage() for help info.'
+des = 'Macro to generate SAS packages, version 20200811. Run %generatePackage() for help info.'
 ;
-%if %superq(filesLocation) = %then
+%if (%superq(filesLocation) = ) OR (%qupcase(&filesLocation.) = HELP) %then
   %do;
+    %local options_tmp ;
+    %let options_tmp = ls=%sysfunc(getoption(ls))ps=%sysfunc(getoption(ps))
+     %sysfunc(getoption(notes)) %sysfunc(getoption(source))
+     msglevel=%sysfunc(getoption(msglevel))
+    ;
+    options NOnotes NOsource ls=MAX ps=MAX msglevel=N;
     %put ;
     %put ###############################################################################;
     %put #        This is short help information for the generatePackage macro         #;
     %put ###############################################################################;
     %put #                                                                             #;
-    %put # Macro to generate SAS packages, version 20200807                            #;
+    %put # Macro to generate SAS packages, version 20200811                            #;
     %put #                                                                             #;
     %put # A SAS package is a zip file containing a group                              #;
     %put # of SAS codes (macros, functions, data steps generating                      #;
@@ -970,6 +1011,7 @@ des = 'Macro to generate SAS packages, version 20200807. Run %generatePackage()
     %put #                                                                             #;
     %put ###############################################################################;
     %put ;
+    options &options_tmp.;
     %RETURN;
   %end;
 
@@ -1014,7 +1056,7 @@ filename &_LIC_.   "&filesLocation./license.sas" lrecl = 256;
         when(upcase(scan(_INFILE_, 1, ":")) = "REQPACKAGES") call symputX("packageReqPackages", scan(_INFILE_, 2, ":"),"L");
 
         /* stop at the beginning of description */
-        when(upcase(scan(_INFILE_, 1, ":")) = "DESCRIPTION START") stop;
+        when ( upcase(scan(_INFILE_, 1, ":")) = "DESCRIPTION START" ) stop;
         otherwise;
       end;
     run;
@@ -1402,6 +1444,7 @@ data _null_;
   put '  , path = %sysfunc(pathname(packages)) /* location of a package */        ';
   put '  , options = %str(LOWCASE_MEMNAME)     /* possible options for ZIP */     ';
   put '  , zip = zip                           /* file ext. */                    ';
+  put '  , requiredVersion = .                 /* required version */             ';
   put '  , source2 = /* source2*/                                                 ';
   put '  )/secure;                                                                ';
   put '    %PUT ** NOTE: Package ' "&packageName." ' loaded in ICE mode **;       ';
@@ -1412,10 +1455,22 @@ data _null_;
   put '    ;                                                                      ';
   put '    %include &_PackageFileref_.(packagemetadata.sas) / &source2.;          ';
   put '    filename &_PackageFileref_. clear;                                     ';
+
+                 /* test if required version of package is "good enough" */
+  put '    %if %sysevalf(&requiredVersion. > &packageVersion.) %then              ';
+  put '      %do;                                                                 ';
+  put '        %put ERROR: Required version is &requiredVersion.;                 ';
+  put '        %put ERROR- Provided version is &packageVersion.;                  ';
+  put '        %ABORT;                                                            '; 
+  put '      %end;                                                                ';
+
+
   put '    filename &_PackageFileref_. &ZIP.                                      ';
   put '      "&path./%lowcase(&packageName.).&zip." %unquote(&options.)           ';
   put '      ENCODING =                                                           ';
-  put '        %if %bquote(&packageEncoding.) NE %then &packageEncoding. ;;       ';
+  put '        %if %bquote(&packageEncoding.) NE %then &packageEncoding. ;        ';
+  put '                                          %else utf8 ;                     ';
+  put '    ;                                                                      ';
   put '    %include &_PackageFileref_.(load.sas) / &source2.;                     ';
   put '    filename &_PackageFileref_. clear;                                     ';
   put '  %mend ICEloadPackage;                                                    ';
@@ -1542,18 +1597,24 @@ data _null_;
       put '    vers = input(compress(scan(req,-1, "("), ".", "KD"),best32.);                             ';
       put '    _RC_ = LP.add();                                                                          ';
       put '  end;                                                                                        ';
+      /* check if elements of the framewor are available */
+      put '       LoadPackageExist = input(resolve(''%SYSMACEXIST(   loadPackage)''), best.);            ';
+      put '    ICELoadPackageExist = input(resolve(''%SYSMACEXIST(ICEloadPackage)''), best.);            '; 
 
       put '  do req = ' / packageReqPackages / ' ;                                                       ';
 /*    put '    req = compress(req, "(.)", "KDF");                                                        ';*/
       put '    name = lowcase(strip(scan(req, 1, "(")));                                                 ';
       put '    verR = input(compress(scan(req,-1, "("), ".", "KD"),best32.); vers = .;                   ';
       put '    LP_find = LP.find();                                                                      ';
-      put '    if (LP_find ne 0) or (LP_find = 0 and . < vers < verR) then                               ';
-      put '     do;                                                                                      ';
-      put '      put "NOTE: Trying to install required SAS package " req;                                ';
-      put '      call execute(cats(''%nrstr(%loadPackage('', name, ", requiredVersion = ", verR, "))")); ';
-      put '     end ;                                                                                    ';
-      put '  end ;                                                                                       ';
+      put '    if (LP_find ne 0) or (LP_find = 0 and . < vers < verR) then                                       ';
+      put '     do;                                                                                              ';
+      put '      put "NOTE: Trying to load required SAS package " req;                                           ';
+      put '       if LoadPackageExist then                                                                       ';
+      put '         call execute(cats(''%nrstr(%loadPackage('', name, ", requiredVersion = ", verR, "))"));      ';
+      put '       else if ICELoadPackageExist then                                                               ';
+      put '         call execute(cats(''%nrstr(%ICEloadPackage('', name, ", requiredVersion = ", verR, "))"));   ';
+      put '     end ;                                                                                            ';
+      put '  end ;                                                                                               ';
       put ' stop;                                                                                        ';
       put 'run;                                                                                          ';
 
@@ -1769,14 +1830,18 @@ data _null_;
   put 'data _null_;';
   put ' length lazyData $ 32767; lazyData = lowcase(symget("lazyData"));';
   do until(eof);
-    set &filesWithCodes.(where=( upcase(type) =: 'LAZYDATA' )) end = EOF nobs=NOBS;
-
-    put 'if lazyData="*" OR findw(lazyData, "' fileshort +(-1) '") then';
-    put 'do;';
-    put ' put "NOTE- Dataset ' fileshort 'from the file ""' file +(-1) '"" will be loaded";';
-    put ' call execute(''%nrstr(%include' " &_PackageFileref_.(_" folder +(-1) "." file +(-1) ') / nosource2;)'');';
-    put 'end;';
+    set &filesWithCodes. end = EOF nobs=NOBS;
+    
+    if ( upcase(type) =: 'LAZYDATA' ) then
+      do;
+        put 'if lazyData="*" OR findw(lazyData, "' fileshort +(-1) '") then';
+        put 'do;';
+        put ' put "NOTE- Dataset ' fileshort 'from the file ""' file +(-1) '"" will be loaded";';
+        put ' call execute(''%nrstr(%include' " &_PackageFileref_.(_" folder +(-1) "." file +(-1) ') / nosource2;)'');';
+        put 'end;';
+      end;
   end;
+
   put 'run;';
 
   put '%put NOTE- ;';
@@ -2030,16 +2095,16 @@ data _null_;
   put 'options ls = MAX ps = MAX nonotes nosource;        ';
   put '%include' " &_PackageFileref_.(packagemetadata.sas) / nosource2; " /;
 
-  put 'data _null_;                                                              ';
-  put '  if strip(symget("helpKeyword")) = " " then                              ';
-  put '    do until (EOF);                                                       ';
-  put "      infile &_PackageFileref_.(description.sas) end = EOF;               ";
-  put '      input;                                                              ';
-  put '      if upcase(strip(_infile_)) = "DESCRIPTION END:" then printer = 0;   ';
-  put '      if printer then put "*> " _infile_;                                 ';
-  put '      if upcase(strip(_infile_)) = "DESCRIPTION START:" then printer = 1; ';
-  put '    end;                                                                  ';
-  put '  else stop;                                                              ';
+  put 'data _null_;                                                               ';
+  put '  if strip(symget("helpKeyword")) = " " then                               ';
+  put '    do until (EOF);                                                        ';
+  put "      infile &_PackageFileref_.(description.sas) end = EOF;                ";
+  put '      input;                                                               ';
+  put '      if upcase(strip(_infile_)) =: "DESCRIPTION END:" then printer = 0;   ';
+  put '      if printer then put "*> " _infile_;                                  ';
+  put '      if upcase(strip(_infile_)) =: "DESCRIPTION START:" then printer = 1; ';
+  put '    end;                                                                   ';
+  put '  else stop;                                                               ';
 
 
   put '  put ; put "  Package contains: "; ';
@@ -2074,7 +2139,7 @@ data _null_;
     put '  end ;                                                                 ';
   %end;
 
-  put 'put "***"; put "* SAS package generated by generatePackage, version 20200807 *"; put "***";';
+  put 'put "***"; put "* SAS package generated by generatePackage, version 20200811 *"; put "***";';
 
   put 'run;                                                                      ' /;
 
@@ -2112,9 +2177,10 @@ data _null_;
 
     select;
       when (upcase(type) in ("DATA" "LAZYDATA")) fileshort2 = fileshort;
-      when (upcase(type) = "MACRO")              fileshort2 = cats('%',fileshort,'()');
-      when (upcase(type) =:"FUNCTION")           fileshort2 = cats(fileshort,'()');
-      when (upcase(type) = "FORMAT")             fileshort2 = cats('$',fileshort);
+      when (upcase(type) = "MACRO")              fileshort2 = cats('''%',fileshort,'()''');
+      when (upcase(type) =:"FUNCTION")           fileshort2 = cats("'",fileshort,"()'");
+      when (upcase(type) =:"IMLMODULE")          fileshort2 = cats("'",fileshort,"()'");
+      when (upcase(type) = "FORMAT")             fileshort2 = cats("'$",fileshort,".'");
       otherwise fileshort2 = fileshort;
     end;
     strX = catx('/', folder, order, type, file, fileshort, fileshort2);

packages/README.md

@@ -1,7 +1,7 @@
-## SAS Packages:
+## SAS Packages: 
 To get started with SAS Packages try this [**`Getting Started with SAS Packages`**](https://github.com/yabwon/SAS_PACKAGES/blob/master/SPF/Documentation/Getting_Started_with_SAS_Packages.pdf "Getting Started with SAS Packages") presentation (see the `./SPF/Documentation` directory).
 
-## Available packages:
+## Available packages: 
 Currently the following packages are available:
 
 - **SQLinDS**\[2.1\], based on Mike Rhoads' article *Use the Full Power of SAS in Your Function-Style Macros*. The package allows to write SQL queries in the data step, e.g.
@@ -19,7 +19,7 @@ run;
 
 - **DFA** (Dynamic Function Arrays)\[0.2\], contains set of macros and FCMP functions which implement: a dynamically allocated array, a stack, a fifo queue, an ordered stack, and a priority queue, run `%helpPackage(DFA,createDFArray)` to find examples.
 ```
-%createDFArray(ArrDynamic, resizefactor=17);
+%createDFArray(ArrDynamic, resizefactor=17); 
 
 data _null_;
   call ArrDynamic("Allocate", -2, 2);
@@ -60,7 +60,7 @@ run;
   %end;
 ```
 
-- **BasePlus**\[0.52\] adds a bunch of functionalities I am missing in BASE SAS, such as:
+- **BasePlus**\[0.53\] adds a bunch of functionalities I am missing in BASE SAS, such as: 
 ```
 call arrMissToRight(myArray); 
 call arrFillMiss(17, myArray); 
@@ -72,7 +72,7 @@ string = catXFn("date9.", "#", myArray);
 
 format x bool.;
 
-%put %getVars(sashelp.class, patern = ght$, sep = +, varRange = _numeric_);
+%put %getVars(sashelp.class, pattern = ght$, sep = +, varRange = _numeric_);
 ```
 
 - **dynMacroArray**\[0.2\], set of macros (wrappers for a hash table) emulating dynamic array in the data step (macro predecessor of DFA)