| 1 |
Revision history for CLI::Framework |
| 2 |
|
| 3 |
0.01 2009-06-18 |
| 4 |
|
| 5 |
Initial release. |
| 6 |
|
| 7 |
0.02 2009-06-18 |
| 8 |
|
| 9 |
Documentation corrections. |
| 10 |
|
| 11 |
0.03 2009-09-20 |
| 12 |
|
| 13 |
* Corrected broken dependencies (Exception::Class) |
| 14 |
|
| 15 |
* Documentation improvements |
| 16 |
+ refined existing documentation |
| 17 |
+ added Tutorial |
| 18 |
|
| 19 |
* Concept of "session" replaced with the "cache" (which can hold data shared |
| 20 |
between separate components of a CLIF application) |
| 21 |
|
| 22 |
* Now supporting custom error handling capability (new handle_exception() hook) |
| 23 |
|
| 24 |
* Built-in command CLI::Framework::Command::Menu improved for better |
| 25 |
formatting |
| 26 |
|
| 27 |
* New features |
| 28 |
+ inline declaration of CLIF subclasses (both Application and |
| 29 |
Command classes) is now supported (one file can contain everything) |
| 30 |
+ new built-in command CLI::Framework::Command::Alias |
| 31 |
|
| 32 |
*** |
| 33 |
*** ATTENTION: interface has changed! Most noteworthy changes follow... |
| 34 |
*** |
| 35 |
|
| 36 |
* REPLACED CLI::Framework::Application::is_valid_command() |
| 37 |
WITH is_valid_command_pkg() |
| 38 |
AND is_valid_command_name() |
| 39 |
* REMOVED CLI::Framework::Application::command_search_path() |
| 40 |
(no longer needed with the new command registration strategy) |
| 41 |
* CHANGED CLI::Framework::Application::get_registered_command_names() |
| 42 |
TO registered_command_names() |
| 43 |
* REMOVED CLI::Framework::Command::get_registered_command_names() |
| 44 |
* CHANGED CLI::Framework::Command::get_registered_command() |
| 45 |
TO registered_command_object() |
| 46 |
* CHANGED CLI::Framework::Command::get_registered_subcommand() |
| 47 |
TO registered_subcommand_object() |
| 48 |
* REMOVED CLI::Framework::Command::register_command() |
| 49 |
* ADDED CLI::Framework::Command::package_is_registered() |
| 50 |
* CHANGED CLI::Framework::Application::is_interactive() |
| 51 |
TO get_interactivity_mode() |
| 52 |
* CHANGED CLI::Framework::Command::Meta::app() changed |
| 53 |
TO get_app() |
| 54 |
* REPLACED CLI::Framework::Application::valid_commands() |
| 55 |
WITH CLI::Framework::Application::command_map() |
| 56 |
(a hash mapping command names to package names) |
| 57 |
|
| 58 |
* CLI::Framework::Application::run() now accepts param 'initialize' |
| 59 |
|
| 60 |
0.04 2010-03-31 |
| 61 |
|
| 62 |
* Fixed inconsistency in exception handling (http://cpanforum.com/posts/12419) |
| 63 |
|
| 64 |
* Fixed failing tests (some test scripts depended on DBI and DBD::SQLite, |
| 65 |
which are not (and should not be) dependencies of the distribution) |
| 66 |
|
| 67 |
* Added CLI::Framework package to satisfy CPAN's requirements for |
| 68 |
finding the ABSTRACT for a distribution |
| 69 |
+ ***NOTE***: CLIF Application classes can now inherit from |
| 70 |
CLI::Framework instead of CLI::Framework::Application (both work |
| 71 |
equivalently) |
| 72 |
|
| 73 |
* documentation updates |
| 74 |
+ link corrections, better explanation of some concepts |
| 75 |
+ moved general framework documentation from |
| 76 |
CLI::Framework::Application POD to CLI::Framework POD |
| 77 |
+ added class diagram |
| 78 |
|
| 79 |
*** |
| 80 |
*** ATTENTION: one (minor) interface change: |
| 81 |
*** |
| 82 |
* in CLI::Framework::Exceptions, changed throw_app_args_exception() to |
| 83 |
throw_invalid_cmd_exception() |
| 84 |
|
| 85 |
0.05 2011-03-10 |
| 86 |
|
| 87 |
* RT #56882: Fixed to use autohistory if the system's local ReadLine |
| 88 |
supports it. |
| 89 |
|
| 90 |
* RT #56885: EOF now treated like a quit signal |
| 91 |
|
| 92 |
*** ATTENTION: updates that affect the interface... |
| 93 |
|
| 94 |
* RT #56887: The order of the commands shown in the built-in interactive |
| 95 |
menu is now determined by the order the commands are |
| 96 |
declared in command_map. |
| 97 |
|
| 98 |
The Application hook method "command_map" should now |
| 99 |
return a (hash-worthy) list, not a HASH ref. |
| 100 |
|
| 101 |
To upgrade a CLIF app to be compatible with this release, |
| 102 |
change the definition of command_map() to return a list |
| 103 |
(see documentation for CLI::Framework::Application::command_map) |
| 104 |
and remember to change calls to that method if necessary. |
| 105 |
|
| 106 |
Also see the new CLIF Application method, command_map_hashref(). |
| 107 |
|
| 108 |
* New method CLI::Framework::Application::command_map_hashref() |
| 109 |
returns a HASH ref constructed from the command_map() list. |