Skip to content
  • joubu's avatar
    Bug 17600: Standardize our EXPORT_OK · 9d6d641d
    joubu authored
    On bug 17591 we discovered that there was something weird going on with
    the way we export and use subroutines/modules.
    This patch tries to standardize our EXPORT to use EXPORT_OK only.
    
    That way we will need to explicitely define the subroutine we want to
    use from a module.
    
    This patch is a squashed version of:
    Bug 17600: After export.pl
    Bug 17600: After perlimport
    Bug 17600: Manual changes
    Bug 17600: Other manual changes after second perlimports run
    Bug 17600: Fix tests
    
    And a lot of other manual changes.
    
    export.pl is a dirty script that can be found on bug 17600.
    
    "perlimport" is:
    git clone https://github.com/oalders/App-perlimports.git
    cd App-perlimports/
    cpanm --installdeps .
    export PERL5LIB="$PERL5LIB:/kohadevbox/koha/App-perlimports/lib"
    find . \( -name "*.pl" -o -name "*.pm" \) -exec perl App-perlimports/script/perlimports --inplace-edit --no-preserve-unused --filename {} \;
    
    The ideas of this patch are to:
    * use EXPORT_OK instead of EXPORT
    * perltidy the EXPORT_OK list
    * remove '&' before the subroutine names
    * remove some uneeded use statements
    * explicitely import the subroutines we need within the controllers or
    modules
    
    Note that the private subroutines (starting with _) should not be
    exported (and not used from outside of the module except from tests).
    
    EXPORT vs EXPORT_OK (from
    https://www.thegeekstuff.com/2010/06/perl-exporter-examples/)
    """
    Export allows to export the functions and variables of modules to user’s namespace using the standard import method. This way, we don’t need to create the objects for the modules to access it’s members.
    
    @export and @EXPORT_OK are the two main variables used during export operation.
    
    @export
    
     contains list of symbols (subroutines and variables) of the module to be exported into the caller namespace.
    
    @EXPORT_OK does export of symbols on demand basis.
    """
    
    If this patch caused a conflict with a patch you wrote prior to its
    push:
    * Make sure you are not reintroducing a "use" statement that has been
    removed
    * "$subroutine" is not exported by the C4::$MODULE module
    means that you need to add the subroutine to the @EXPORT_OK list
    * Bareword "$subroutine" not allowed while "strict subs"
    means that you didn't imported the subroutine from the module:
      - use $MODULE qw( $subroutine list );
    You can also use the fully qualified namespace: C4::$MODULE::$subroutine
    
    Signed-off-by: default avatarJonathan Druart <jonathan.druart@bugs.koha-community.org>
    9d6d641d