Item14237: Implemented support for application in Foswiki::Object

Merged functionality of extensible and AppObject roles.

Implemented create() on Foswiki::Object. So, any object can now create
new instances by calling $this->create().

core/lib/Foswiki/App.pm

@@ -1031,7 +1031,8 @@ Before actually create an object this method:
 
 =cut
 
-sub create {
+around create => sub {
+    my $orig  = shift;
     my $this  = shift;
     my $class = shift;
 
@@ -1056,7 +1057,7 @@ sub create {
     }
 
     return $object;
-}
+};
 
 =begin TML
 

core/lib/Foswiki/AppObject.pm

@@ -32,9 +32,7 @@ use Moo::Role;
 
 ---+++ ObjectAttribute app
 
-Reference to the parent application object.
-
-Required.
+Modifies %PERLDOC{"Foswiki::Object" attr="app"} attribute, makes it required.
 
 =cut
 
@@ -43,15 +41,9 @@ has app => (
     predicate => 1,
     weak_ref  => 1,
     isa => Foswiki::Object::isaCLASS( 'app', 'Foswiki::App', noUndef => 1, ),
-    required => 1,
-    clearer  => 1,
-    handles  => [qw(create)],
+    clearer => 1,
 );
 
-sub _clone_app {
-    return $_[0]->app;
-}
-
 1;
 __END__
 Foswiki - The Free and Open Source Wiki, http://foswiki.org/

core/lib/Foswiki/Object.pm

@@ -75,6 +75,7 @@ require Carp;
 require Foswiki::Exception;
 use Try::Tiny;
 use Scalar::Util qw(blessed refaddr reftype weaken isweak);
+use Foswiki qw<indentInc indentMsg>;
 
 use Foswiki::Class;
 
@@ -84,10 +85,26 @@ use Assert;
 
 =begin TML
 
----++ Attributes
+---++ ATTRIBUTES
 
 =cut
 
+=begin TML
+
+---+++ ObjectAttribute app
+
+Reference to the parent application object.
+
+=cut
+
+has app => (
+    is        => 'rwp',
+    predicate => 1,
+    weak_ref  => 1,
+    isa       => Foswiki::Object::isaCLASS( 'app', 'Foswiki::App', ),
+    clearer   => 1,
+);
+
 # Debug-only attributes for recording object's origins; i.e. the location in the
 # core where it was created. Useful for tracking down the source of problems.
 has __orig_file  => ( is => 'rw', clearer => 1, );
@@ -122,7 +139,7 @@ has __clone_heap =>
 
 =begin TML
 
----++ Methods
+---++ METHODS
 
 =cut
 
@@ -190,6 +207,30 @@ sub DEMOLISH {
     }
 }
 
+=begin TML
+
+---+++ ObjectMethod create( $className, @params ) -> $object
+
+Creates a new object of class =$className=. If application object could be
+guessed with %PERLDOC{"Foswiki::Object" method="guessApp"}% then its
+%PERLDOC{"Foswiki::App" method="create" text="create()"}% method would be used.
+Otherwise the =$object= would be created with =$className='s =new()= method.
+
+=cut
+
+sub create {
+    my $this = shift;
+
+    my $app = $this->guessApp;
+
+    if ( defined $app ) {
+        return $app->create(@_);
+    }
+
+    my $class = shift;
+    return $class->new(@_);
+}
+
 sub _cloneData {
     my $this = shift;
     my ( $val, $attr ) = @_;
@@ -441,6 +482,42 @@ sub clone {
 
 =begin TML
 
+---+++ ObjectMethod getApp -> $app
+
+Returns application object depending on current object's status:
+
+   1 for a %PERLDOC{"Foswiki::App"}% object returns itself
+   1 if =app= attribute is set then returns its value.
+   1 otherwise returns undef
+
+=cut
+
+sub getApp {
+    my $this = shift;
+    return (
+          $this->isa('Foswiki::App')
+        ? $this
+        : ( $this->has_app ? $this->app : undef )
+    );
+}
+
+=begin TML
+
+---+++ ObjectMethod guessApp -> $app
+
+Similar to the =getApp()= method above but tries harder and returns
+=$Foswiki::app= when getApp() returns undef. Note that in some cases this
+could be _undef_ too.
+
+=cut
+
+sub guessApp {
+    my $this = shift;
+    return $this->getApp // $Foswiki::app;
+}
+
+=begin TML
+
 ---++ ObjectMethod to_str => $string
 
 This method is used to overload stringification operator "" (see
@@ -670,6 +747,10 @@ sub _traceMsg {
     }
 }
 
+sub _clone_app {
+    return $_[0]->app;
+}
+
 1;
 __END__
 Foswiki - The Free and Open Source Wiki, http://foswiki.org/

core/lib/Foswiki/Util/Callbacks.pm

@@ -244,7 +244,7 @@ before DEMOLISH => sub {
 
     # Cleanup all callbacks registed by this object.
     unless ($in_global) {
-        my $app = $this->_getApp;
+        my $app = $this->guessApp;
 
         # The application object could have been already destroyed at this
         # moment. This is normal for auto-destruction.
@@ -270,20 +270,6 @@ sub _splitCBName {
     return ( $1, $2 );
 }
 
-# Returns currently active Foswiki::App object.
-sub _getApp {
-    my $this = shift;
-
-    return (
-        $this->isa('Foswiki::App') ? $this
-        : (
-            $this->does('Foswiki::AppObject') ? $this->app
-            : (      $this->does('Foswiki::Util::_ExtensibleRole')
-                  && $this->_has__appObj ? $this->__appObj : $Foswiki::app )
-        )
-    );
-}
-
 # Normilizes callback name to it's full form of 'namespace::cbName'. If cbName
 # is short (i.e. doesn't contain ::) then namespace if fetched from index. If
 # more than one namespace registered a callback with the same name then assert
@@ -348,7 +334,7 @@ sub registerCallback {
         obj  => $this->__id,
     };
 
-    my $app = $this->_getApp;
+    my $app = $this->guessApp;
 
     ASSERT( defined $app,
         "Callback cannot be registered without an active application object" );
@@ -379,7 +365,7 @@ sub deregisterCallback {
     ASSERT( $_registeredCBNames{$name}, "unknown callback '$name'" );
 
     my $objId   = $this->__id;
-    my $appHeap = $this->_getApp->heap;
+    my $appHeap = $this->guessApp->heap;
     my $oldList = $appHeap->{_aux_registered_callbacks}{$name};
     my $newList = [];
 
@@ -414,7 +400,7 @@ sub callback {
     ASSERT( ref($params) eq 'HASH', "callback params must be a hashref" );
 
     my $lastException;
-    my $cbList = $this->_getApp->heap->{_aux_registered_callbacks}{$name};
+    my $cbList = $this->guessApp->heap->{_aux_registered_callbacks}{$name};
 
     return unless $cbList;
 

core/lib/Foswiki/Util/Localize.pm

@@ -45,10 +45,10 @@ use v5.14;
 
 use Foswiki::Util::Holder ();
 
-use Moo::Role;
-
 use Try::Tiny;
 
+use Moo::Role;
+
 # _dataStack is a storage for configurations active upon localize() method
 # calls.
 has _dataStack => ( is => 'rw', lazy => 1, default => sub { [] }, );

core/lib/Foswiki/Util/_ExtensibleRole.pm

@@ -7,37 +7,6 @@ use Moo::Role;
 
 # This role is not to be applied manually but by Foswiki::Class only!
 
-# Though this attribute is seemingly duplicating Foswiki::AppObject app
-# attribute but it's purpose to be optional and apply cleanly to classes which
-# are not Foswiki::App-dependant.
-has __appObj => (
-    is        => 'rw',
-    lazy      => 1,
-    predicate => 1,
-    isa       => Foswiki::Object::isaCLASS( '__appObj', 'Foswiki::App' ),
-    weak_ref  => 1,
-);
-
-around BUILD => sub {
-    my $orig     = shift;
-    my $this     = shift;
-    my ($params) = @_;
-
-    #$this->_traceMsg("Storing app for extensible objet");
-
-    if ( defined $params->{app} && $params->{app}->isa('Foswiki::App') ) {
-        $this->__appObj( $params->{app} );
-    }
-
-    return $orig->( $this, @_ );
-};
-
-# Foswiki::Object::clone support.
-# Avoid full app cloning.
-sub _clone__appObj {
-    return $_[0]->__appObj;
-}
-
 1;
 __END__
 Foswiki - The Free and Open Source Wiki, http://foswiki.org/