logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Perl::Critic::Policy::Subroutines::ProhibitReturnSort - Behavior of "sort" is not defined if called in

Affiliation

       This Policy is part of the core Perl::Critic distribution.

Author

       Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>

Configuration

       This Policy is not configurable except for the standard options.

Credits

       This Policy was suggested by Ulrich Wisser and the <http://iis.se> team.

Description

       The behavior of the builtin "sort" function is not defined if called in scalar context.  So if you write
       a subroutine that directly "return"s the result of a "sort" operation, then your code will behave
       unpredictably if someone calls your subroutine in a scalar context.  This Policy emits a violation if the
       "return" keyword is directly followed by the "sort" function.  To safely return a sorted list of values
       from a subroutine, you should assign the sorted values to a temporary variable first.  For example:

          sub frobulate {

              return sort @list;  # not ok!

              my @sorted_list = sort @list;
              return @sorted_list # OK
          }

Known Bugs

       This Policy is not sensitive to the "wantarray" function.  So the following code would generate a false
       violation:

          sub frobulate {

              if (wantarray) {
                  return sort @list;
              }
              else{
                  return join @list;
              }
          }

Name

       Perl::Critic::Policy::Subroutines::ProhibitReturnSort - Behavior of "sort" is not defined if called in
       scalar context.

See Also