[Koha-bugs] [Bug 24631] Plugin metadata should be outside the main class

[bugzilla-daemon at bugs.koha-community.org]

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=24631

Victor Grousset/tuxayo <victor at tuxayo.net> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
 Attachment #104266|0                           |1
        is obsolete|                            |

--- Comment #59 from Victor Grousset/tuxayo <victor at tuxayo.net> ---
Created attachment 104270
  -->
https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=104270&action=edit
Bug 24631: Plugin metadata should be outside the main class

Currently, plugin metadata is stored within the main plugin class file but this
means one has to load the class to read it.  We should pull this data out into
a manifest/metadata file in a standard format (JSON/YAML) to allow simpler
external parsing.

Test Plan:
 1) Apply this patch
 2) Install the latest Kitchen Sink plugin:
https://github.com/bywatersolutions/koha-plugin-kitchen-sink/releases/download/v2.1.39/koha-plugin-kitchen-sink-v2.1.39.kpz
 3) Look in plugin_data for the new "__METADATA__" key, note it has the
metadata in it
 4) Alter the metadata in KitchenSink.pm, delete __METADATA__ from plugin_data
    Restart Plack
 5) Browse to your pluginsdir, find the KitchenSink.pm file for the Kitchen
Sink plugin, edit some of the metadata
 6) Delete the plugin_data metadata again
    Restart Plack
 7) Reload the plugins home
 8) Note the metdata has been updated
 9) Remove lines 28-40, 47-49 from KitchenSink.pm, this will cause Koha to look
at PLUGIN.yml instead
10) Clear the metadata from plugin_data again
    Restart Plack
11) Reload the plugins home
12) Note again the metadata is regenerated in plugin_data
13) Browse to your pluginsdir, find the PLUGIN.yml file for the Kitchen Sink
plugin, edit some of the metadata
14) Clear the metadata from plugin_data again
    Restart Plack
15) Reload the plugins home
16) Note again the metadata is regenerated in plugin_data
17) Reload the plugins home page, note your changes to PLUGIN.yml appear in the
plugins table!
18) Test that you can enable/disable the plugin
19) Test that all the plugin methods ( configure, report, tool ) still work
20) Test that you can uninstall the plugin

Signed-off-by: Victor Grousset/tuxayo <victor at tuxayo.net>

-- 
You are receiving this mail because:
You are watching all bug changes.