Item14237: Major changes to Foswiki::Class

- options are now defined as -opt
- support for -role option - create a role, not a class
- new API for registering custom sugars
- extension related sugars are now registered by ExtManager
- two new default sugars: roleInit and classInit.
  Basically, it's one function named depending on what is module type.
- callback_names sugar is renamed to callbackNames and is now registered
  by Callbacks role.
- AppObject and Callbacks role are now under Foswiki::Role:: namespace.

CommentPlugin/lib/Foswiki/Configure/Checkers/Plugins/CommentPlugin/GuestCanComment.pm

@@ -1,8 +1,7 @@
 # See bottom of file for license and copyright information
 package Foswiki::Configure::Checkers::Plugins::CommentPlugin::GuestCanComment;
-use v5.14;
 
-use Moo;
+use Foswiki::Class;
 extends qw(Foswiki::Configure::Checker);
 
 sub check {

CommentPlugin/lib/Foswiki/Configure/Checkers/Plugins/CommentPlugin/RequiredForSave.pm

@@ -1,8 +1,7 @@
 # See bottom of file for license and copyright information
 package Foswiki::Configure::Checkers::Plugins::CommentPlugin::RequiredForSave;
-use v5.14;
 
-use Moo;
+use Foswiki::Class;
 extends qw(Foswiki::Configure::Checker);
 
 sub check {

CommentPlugin/lib/Foswiki/Plugins/CommentPlugin/JQuery.pm

@@ -3,9 +3,8 @@
 # See Plugin topic for history and plugin information
 
 package Foswiki::Plugins::CommentPlugin::JQuery;
-use v5.14;
 
-use Moo;
+use Foswiki::Class;
 extends qw( Foswiki::Plugins::JQueryPlugin::Plugin );
 
 around BUILDARGS => sub {

ConfigurePlugin/lib/Foswiki/Plugins/ConfigurePlugin/JQuery.pm

@@ -3,10 +3,8 @@
 # See Plugin topic for history and plugin information
 
 package Foswiki::Plugins::ConfigurePlugin::JQuery;
-use v5.14;
 
-use Moo;
-use namespace::clean;
+use Foswiki::Class;
 extends qw( Foswiki::Plugins::JQueryPlugin::Plugin );
 
 around BUILDARGS => sub {

DBConfigExtension/lib/Foswiki/Extension/DBConfig.pm

@@ -44,7 +44,7 @@ use Try::Tiny;
 
 use Foswiki::FeatureSet;
 
-use Foswiki::Class qw(extension);
+use Foswiki::Class -extension;
 extends qw(Foswiki::Extension);
 
 use version 0.77; our $VERSION = version->declare(0.1.1);

EmptyExtension/lib/Foswiki/Extension/Empty.pm

@@ -16,7 +16,7 @@ details directly influencing a new extension development.
 
 use Foswiki::FeatureSet;
 
-use Foswiki::Class qw(extension);
+use Foswiki::Class -extension;
 extends qw(Foswiki::Extension);
 
 =begin TML
@@ -70,7 +70,7 @@ with the following lines:
 <verbatim>
 package Foswiki::Extension::<your chosen name>;
 
-use Foswiki::Class qw(extension);
+use Foswiki::Class -extension;
 extends qw(Foswiki::Extension);
 
 use version 0.77; our $VERSION = version->declare(0.0.1);
@@ -264,7 +264,7 @@ subroutine to declare pluggable methods:
 
 <verbatim>
 package Foswiki::CoreClass;
-use Foswiki::Class qw(extensible);
+use Foswiki::Class -extensible;
 extends qw(Foswiki::Object);
 
 ...
@@ -282,17 +282,17 @@ pluggable someMethod => sub {
 
 Method overriding can only work within properly initialized %WIKITOOLNAME%
 application environment. I.e. it requires initialized extensions on application
-object. On the other hand not only classes with =%PERLDOC{Foswiki::AppObject}%=
+object. On the other hand not only classes with =%PERLDOC{Foswiki::Role::AppObject}%=
 role applied can use this feature. This is because
 =Foswiki::Util::_ExtensibleRole= implicitly adds =__appObj= attribute to the
-class it is applied to. In distinction to =%PERLDOC{"Foswiki::AppObject"
+class it is applied to. In distinction to =%PERLDOC{"Foswiki::Role::AppObject"
 attr="app"}%= attribute =__appObj= is not required and can remain undefined.
 
-For a non =Foswiki::AppObject= class to get the feature enabled it is mandatory
+For a non =Foswiki::Role::AppObject= class to get the feature enabled it is mandatory
 to have objects of the class created with =%PERLDOC{"Foswiki::App"
-method="create"}%= or =%PERLDOC{"Foswiki::AppObject" method="create"}%= methods.
+method="create"}%= or =%PERLDOC{"Foswiki::Role::AppObject" method="create"}%= methods.
 For example (consider the above sample and assume that the code below belongs
-to a class with =Foswiki::AppObject= role):
+to a class with =Foswiki::Role::AppObject= role):
 
 <verbatim>
 plugBefore "Foswiki::CoreClass::someMethod" => sub {

JQueryPlugin/lib/Foswiki/Plugins/JQueryPlugin/Plugin.pm

@@ -1,6 +1,5 @@
 # See bottom of file for license and copyright information
 package Foswiki::Plugins::JQueryPlugin::Plugin;
-use v5.14;
 
 use Foswiki::Plugins::JQueryPlugin::Plugins ();
 use Foswiki::Func                           ();
@@ -9,10 +8,8 @@ use Assert;
 
 use constant TRACE => 0;
 
-use Moo;
-use namespace::clean;
+use Foswiki::Class -app;
 extends qw(Foswiki::Object);
-with qw(Foswiki::AppObject);
 
 has author => ( is => 'rw', default => 'unknown', );
 has css => ( is => 'rw', default => sub { [] }, );

JsonRpcContrib/lib/Foswiki/Contrib/JsonRpcContrib/Request.pm

@@ -25,10 +25,8 @@ use Foswiki::Func    ();
 use Foswiki::Plugins ();
 use constant TRACE => 0;    # toggle me
 
-use Moo;
-use namespace::clean;
+use Foswiki::Class -app;
 extends qw(Foswiki::Object);
-with qw(Foswiki::AppObject);
 
 has data => (
     is      => 'rw',

JsonRpcContrib/lib/Foswiki/Contrib/JsonRpcContrib/Response.pm

@@ -22,7 +22,7 @@ use Assert;
 use Compress::Zlib ();
 use JSON           ();
 
-use Foswiki::Class qw(app);
+use Foswiki::Class -app;
 extends qw(Foswiki::Object);
 
 use constant TRACE => 0;    # toggle me

JsonRpcContrib/lib/Foswiki/Contrib/JsonRpcContrib/Server.pm

@@ -15,17 +15,14 @@
 # As per the GPL, removal of this notice is prohibited.
 
 package Foswiki::Contrib::JsonRpcContrib::Server;
-use v5.14;
 
 use Try::Tiny;
 use Foswiki::Func                              ();
 use Foswiki::Contrib::JsonRpcContrib::Error    ();
 use Foswiki::Contrib::JsonRpcContrib::Response ();
 
-use Moo;
-use namespace::clean;
+use Foswiki::Class -app;
 extends qw(Foswiki::Object);
-with qw(Foswiki::AppObject);
 
 use constant TRACE => 0;    # toggle me
 

PlainFileStoreContrib/lib/Foswiki/Configure/Checkers/Extensions/PlainFileStoreContrib/CheckForRCS.pm

@@ -1,8 +1,7 @@
 # See bottom of file for license and copyright information
 package Foswiki::Configure::Checkers::Extensions::PlainFileStoreContrib::CheckForRCS;
-use v5.14;
 
-use Moo;
+use Foswiki::Class;
 extends qw(Foswiki::Configure::Checker);
 
 my @required = (

PlainFileStoreContrib/lib/Foswiki/Configure/Checkers/Store/PlainFile/Implementation.pm

@@ -1,8 +1,7 @@
 # See bottom of file for license and copyright information
 package Foswiki::Configure::Checkers::Store::PlainFile::Implementation;
-use v5.14;
 
-use Moo;
+use Foswiki::Class;
 extends qw(Foswiki::Configure::Checker);
 
 sub check_current_value {

TopicUserMappingContrib/lib/Foswiki/Users/TopicUserMapping.pm

@@ -33,7 +33,7 @@ use Try::Tiny;
 use Foswiki::ListIterator ();
 use Foswiki::Func         ();
 
-use Foswiki::Class qw(app);
+use Foswiki::Class -app;
 extends qw(Foswiki::Object);
 with qw(Foswiki::UserMapping);
 

UnitTestContrib/lib/Unit/FoswikiTestRole.pm

@@ -571,13 +571,13 @@ application with =_set_app()= method.
 
 *NOTE* No responsibility is taken if a reference to the application is stored in
 any other attribute or object's hash key. To make sure that a instance of your
-class is handled properly by this core apply =Foswiki::AppObject= role.
+class is handled properly by this core apply =Foswiki::Role::AppObject= role.
 
 See also: =Unit::TestApp=
 
 =cut
 
-# Correct all Foswiki::AppObject to use currently active Foswiki::App object.
+# Correct all Foswiki::Role::AppObject to use currently active Foswiki::App object.
 # SMELL Hacky but shall be transparent for any derived test case class.
 sub _fixupAppObjects {
     my $this = shift;

UnitTestContrib/lib/Unit/TestApp.pm

@@ -21,7 +21,7 @@ use Assert;
 use Scalar::Util qw(blessed weaken refaddr);
 use Try::Tiny;
 
-use Foswiki::Class qw(callbacks);
+use Foswiki::Class -callbacks;
 extends qw(Foswiki::App);
 
 =begin TML
@@ -46,7 +46,7 @@ No =params= are sent to the handler.
 
 =cut
 
-callback_names qw(testPreHandleRequest testPostHandleRequest);
+callbackNames qw(testPreHandleRequest testPostHandleRequest);
 
 =begin TML
 
@@ -130,13 +130,13 @@ around BUILDARGS => sub {
 sub BUILD {
     my $this = shift;
 
-    # Fixup Foswiki::AppObject descendants which have been cloned from objects
-    # on another Foswiki::App instance.
+    # Fixup Foswiki::Role::AppObject descendants which have been cloned from
+    # objects on another Foswiki::App instance.
     foreach my $attr ( keys %$this ) {
         if (
                blessed( $this->{$attr} )
             && $this->$attr->isa('Foswiki::Object')
-            && $this->$attr->does('Foswiki::AppObject')
+            && $this->$attr->does('Foswiki::Role::AppObject')
             && ( !defined( $this->$attr->app )
                 || ( $this->$attr->app != $this ) )
           )

UnitTestContrib/test/unit/AccessControlTests.pm

@@ -7,8 +7,7 @@ use Foswiki::Configure::Dependency ();
 # For Anchor test
 use Foswiki::UI ();
 
-use Moo;
-use namespace::clean;
+use Foswiki::Class;
 extends 'FoswikiFnTestCase';
 
 my $post11 = 0;

UnitTestContrib/test/unit/AdminOnlyAccessControlTests.pm

@@ -10,8 +10,7 @@ use Assert;
 # For Anchor test
 use Foswiki::UI ();
 
-use Moo;
-use namespace::clean;
+use Foswiki::Class;
 extends qw(FoswikiFnTestCase);
 
 my $post11 = 0;

UnitTestContrib/test/unit/AttrsTests.pm

@@ -1,9 +1,7 @@
 package AttrsTests;
-use v5.14;
 
 use Foswiki::Attrs();
-use Moo;
-use namespace::clean;
+use Foswiki::Class;
 extends qw(FoswikiTestCase);
 
 sub test_isEmpty {

UnitTestContrib/test/unit/CacheTests.pm

@@ -1,5 +1,4 @@
 package CacheTests;
-use v5.14;
 use utf8;
 
 use Foswiki();
@@ -8,8 +7,7 @@ use Foswiki::OopsException();
 use Foswiki::PageCache();
 use Benchmark qw(:hireswallclock);
 
-use Moo;
-use namespace::clean;
+use Foswiki::Class;
 extends qw(FoswikiFnTestCase);
 
 has testAction => ( is => 'rw', );

UnitTestContrib/test/unit/CallbackTests.pm

@@ -2,10 +2,10 @@
 
 package CBTest::Provider;
 
-use Foswiki::Class qw(callbacks);
+use Foswiki::Class -callbacks;
 extends qw(Foswiki::Object);
 
-callback_names qw(testCB);
+callbackNames qw(testCB);
 
 sub methodWithCB {
     my $this = shift;
@@ -17,7 +17,7 @@ package CBTest::Handler;
 
 use Scalar::Util qw(weaken);
 
-use Foswiki::Class qw(callbacks);
+use Foswiki::Class -callbacks;
 extends qw(Foswiki::Object);
 
 sub BUILD {

UnitTestContrib/test/unit/ClientTests.pm

@@ -1,5 +1,4 @@
 package ClientTests;
-use v5.14;
 
 # This is woefully incomplete, but it does at least check that
 # LoginManager.pm compiles okay.
@@ -10,8 +9,7 @@ use Try::Tiny;
 use Digest::MD5 qw(md5_hex);
 use Scalar::Util qw(blessed);
 
-use Moo;
-use namespace::clean;
+use Foswiki::Class;
 extends qw( FoswikiFnTestCase );
 
 my $agent = $Foswiki::cfg{Register}{RegistrationAgentWikiName};

UnitTestContrib/test/unit/ExceptionTests.pm

@@ -4,7 +4,10 @@ use v5.14;
 use Try::Tiny;
 use Foswiki::OopsException();
 use Foswiki::AccessControlException();
+use Foswiki::Exception ();
 use Scalar::Util qw<blessed>;
+use Types::Standard qw<InstanceOf Str>;
+use Type::Utils -all;
 
 use Foswiki::Class;
 extends qw( FoswikiFnTestCase );
@@ -227,7 +230,8 @@ sub test_ObjectThrowNoText {
         $this->assert( blessed($e), "unblessed exception object" );
         $this->assert_str_equals( 'Foswiki::Exception::TestException',
             ref($e), "incorrect exception class " . ref($e) );
-        $this->assert_equals( $e->text, "text attribute hasn't been set" );
+        $this->assert_equals( "exception text attribute hasn't been set",
+            $e->text );
     };
 }