Item14237: Recording of sugar's owner

foswiki · May 18, 2018 · efb6a0d · efb6a0d
1 parent f615b55
commit efb6a0d
Showing 1 changed file with 19 additions and 2 deletions.
diff --git a/core/lib/Foswiki/Class.pm b/core/lib/Foswiki/Class.pm
@@ -233,9 +233,18 @@ my %_optionSet = (
 );
 
 # Predefined sugars
+# Format:
+# -option => {
+#    code => \&handlerSub,       # Sub implementing the sugar
+#    owner => 'Foswiki::Module', # What module registered it.
+# }
 my %_sugars = (
-    -sugar   => { newSugar    => { code => \&registerSugar, } },
-    -default => { stubMethods => { code => \&_handler_stubMethods }, },
+    -sugar =>
+      { newSugar => { code => \&registerSugar, owner => __PACKAGE__, } },
+    -default => {
+        stubMethods =>
+          { code => \&_handler_stubMethods, owner => __PACKAGE__, },
+    },
 );
 
 # Prepare %_sugars for use.
@@ -586,20 +595,28 @@ sub _rebuildSugars {
 sub registerSugar (%) {
     my %params = @_;
 
+    my $owner = caller;
+
     while ( my ( $option, $optData ) = each %params ) {
         while ( my ( $sgName, $sgParam ) = each %$optData ) {
+
             die "Bad parameters type for new sugar "
               . $sgName
               . ": must be a hash or code ref but got "
               . ( ref($sgParam) || ( defined $sgParam ? 'SCALAR' : '*undef*' ) )
               unless ref($sgParam) && ref($sgParam) =~ /^(?:CODE|HASH)$/;
+
             $sgParam = { code => $sgParam } if ref($sgParam) eq 'CODE';
+
             die "Sugar $sgName code either not defined or not a coderef"
               unless defined $sgParam->{code}
               && ref( $sgParam->{code} ) eq 'CODE';
+
             die "Trying to re-register sugar $sgName"
               if exists $_sugars{$option}{$sgName};
 
+            $sgParam->{owner} //= $owner;
+
             $_sugars{$option}{$sgName} = $sgParam;
             push @{ $_optionSet{$option}{sugars} }, $sgName;
         }