Changes

   1 This file documents the revision history for Perl extension Maypole.
   2 For information about current developments and future releases, see:
   3     http://maypole.perl.org/?TheRoadmap
   4
   5 2.12  October 2006
   6    Fixed some db_colinfo test bugs
   7    Fixed typo in edit form template
   8    Now uses Class::C3 in all Classes to simplify inheritence
   9    Inheritence simpler and nicer and less hacked
  10    add_model_superclass method moves @ISA munging into the model
  11    new Class::DBI::DFV based model
  12    new test to check everything compiles
  13    Model inheritance re-organised
  14    New config method : additional, for stashing additional info, especially from additional_data method
  15    new warn method in maypole/request class/object, over-ridden by Apache::MVC, etc or own driver
  16    AsForm fixes to stringification _to_select
  17    new build_form_elements attribute for Maypole request and Maypole::Config, set it to 0 to avoid building cgi form if you don't need it
  18    made DFV and FromCGI warn instead of die on unexpected cgi params
  19    added CGI params to TT error template
  20    small improvements to some factory templates
  21    fix to path handling in mod_perl and CGI when location ends in /
  22    fixed template path ordering so i.e. /tablename/list is used before /list when provided with a tablename
  23    fixed template path with array refs
  24    fix to template being reset from path in plain templates (i.e. where no model), may affect those relying on the bug ( bug 23722 )
  25    added search_columns method to base cdbi model class, provides display_columns unless over-ridden
  26    fix to display_line macro in factory templates (bug 22920)
  27    fix to correct problem with LocationMatch and regex based Location directives in apache config.
  28    change to view::base to only call display_columns,  stringify_columns, to_cgi if model class can
  29    changed template path to only look for custom, factory, etc on first/only path provided
  30
  31 2.11 Mon 31 July 2006
  32
  33 SVN revision 519
  34
  35 Deprecated:
  36     Directly accessing the attributes of the request object, or the parameters
  37     in $r->params, or anything else, is DEPRECATED and likely to break in future
  38     releases. Be good, and use proper method calls.
  39
  40     Maypole no longer uses Class::DBI::AsForm, instead Maypole::Model::CDBI::AsForm
  41     has replaced it.
  42
  43     $config->{$table}{required_cols} is deprecated, please use $class->required_columns instead
  44
  45
  46 Incompatible API changes:
  47     Maypole
  48          - is_applicable() deprecated for is_model_applicable(). is_applicable is
  49          an alias for is_model_applicable now.
  50     Maypole::Constants
  51          - ERROR constant now 500, previously -1 (bug #18901)
  52     Maypole::Model
  53         - delete and search actions are now deprecated - use do_search and do_delete
  54           instead
  55     Maypole::View
  56         - table name rather than moniker is used to find templates
  57
  58 API additions and enhancements:
  59     Maypole::Application:
  60         - -Init flag (wishlist 14123)
  61         - recognises Maypole::HTTPD and installs Maypole::HTTPD::Frontend
  62             as its frontend
  63     Maypole::Headers:
  64         add() alias to push() (wishlist 14142)
  65     Maypole:
  66         - get_session() method (no-op)
  67         - get_user() method (no-op)
  68         - get_session() is called during handler_guts() before authenticate()
  69         - new preprocess_path() method added and called by parse_path(),
  70                 parse_path() will leave any properties set by preprocess_path() in
  71             place
  72         - start_request_hook() added
  73         - status() attribute added (though only used by start_request_hook()
  74             so far)
  75         - setup() split into setup(), setup_model(), and load_model_subclass()
  76         - added new path processing methods for ssl and default table/action
  77         - added make_path()
  78         - added make_uri()
  79         - improved exception handling
  80         - now uses File::MMagic::XS to guess mime type of output unless already set
  81         - new component method provides Maypole::Component functionality
  82         - new object method gets/sets first/only object in objects
  83      Maypole::Model
  84         - do_delete, do_search in place of delete/search actions
  85      Maypole::View::TT:
  86         - new report_error method
  87         - new embedded error report page in __DATA__
  88      Templates:
  89         - Improved pager macro/include
  90         - Improved factory templates
  91         - added the status() attribute, although it's not used in many places
  92             yet
  93         - Changed factory edit/view to use object instead of objects
  94      Maypole::Model::CDBI
  95         - improved error messages in do_edit action
  96         - new required_columns mutator method
  97         - new column_required accessor method
  98
  99 Bug fixes:
 100     Fix to cgi_maypole.t (bug 11346)
 101     Fix to TT error reporting (bug 13991)
 102     Template xhtml validation (bug 13975)
 103     Apache2 fixes in Apache::MVC (bug 13888)
 104     Fixed inheritance issues in Mp::Application - Mp::App now manipulates the
 105         caller's @ISA directly, and doesn't inject itself into the chain (bugs
 106         12923 & 14120)
 107     Improved Template error reporting (14133)
 108     Maypole::Session::generate_unique_id() now returns the id (bug 14124)
 109     Moved ar accessor to Apache::MVC (bug 14014)
 110     Refactored core to support further development in 2.11 and onwards
 111     Fixed related_class() method (bug 14566)
 112     Added a cgi() attribute in Maypole::CGI
 113     Factory templates now less vulnerable to XSS (bug 16659)
 114     Reduced risk of XSS in factory templates (bug 16659)
 115     model search/delete methods in model and subclassing the cdbi mode (bug 16661)
 116     fixed problems with stringify_self and untaint missing ignore columns (bug 15678)
 117     fixed Maypole::Model::CDBI::Plain to JustWork(TM) with plain CDBI Classes (bug 16977)
 118     some silent death scenarios resolved
 119         Now initializes template_args, stash, parmas, objects and others to correct data type. (bug 15147)
 120
 121 Documentation:
 122     Fix to documentation for CGI::Maypole (bug 7263)
 123     Simplified Net::Amazon example (bug 14073)
 124     Numerous major and minor updates to docs.
 125     Renamed Maypole::Manual::Request to Maypole::Manual::Cookbook
 126         Added Maypole::Manual::Install, with material removed from
 127             Maypole::Manual::About
 128         Added Maypole::Manual::Inheritance
 129         Added Maypole::Manual::Terminology
 130         - updated Maypole::Manual::View
 131         - updated Maypole::View:TT
 132     Examples of fancy forms and templates using new features
 133
 134 Requirements:
 135    HTTP::Body now required
 136    CGI::Untaint >= 1.26 now required rather than >= 0
 137
 138
 139 2.10 Tue 19 Jul 2005
 140     Multiple Template Paths added ( http://rt.cpan.org/NoAuth/Bug.html?id=13447 )
 141     Small fix to templates/factory/frontpage ( http://rt.cpan.org/NoAuth/Bug.html?id=11236 )
 142     MasonX support in Maypole::Application ( https://rt.cpan.org/NoAuth/Bug.html?id=12383 )
 143     Maypole::Model::CDBI::Plain / Maypole Config issue ( http://rt.cpan.org/NoAuth/Bug.html?id=11530 )
 144     Repeat Submission detection support ( Bug #6500 )
 145     Fix to setup_database in Maypole::Model::CDBI ( Bug #12384 )
 146     Fix to plugin to allow Maypole::Plugin::Config::YAML to work
 147     Fix to Maypole::Model::CDBI order sub from list
 148     Improvement to primary display column using CDBI
 149     Improved efficiency of finding stringified columns using new classmetadata field
 150     Fixed BeerDB to untaint pub fields
 151
 152     Additional Requirements : Digest::MD5
 153
 154 2.09  Mon Jan 25 22:00:00 2005
 155     Fixes:
 156     - Fixed plugin inheritance set up by Maypole::Application, added tests
 157
 158     Templates:
 159     - factory/addnew will only prefill values when there's a row creation error
 160
 161
 162 2.08  Mon Jan 24 20:45:00 2005
 163     - Added $r->config->template_extension() to set optional file extension
 164       for templates (Dave Howorth)
 165
 166     Fixes:
 167     - Maypole::Application adds plugin classes to caller's @ISA (Marcus Ramberg)
 168     - FETCH_CODE_ATRIBUTES in M::M::Base should return an empty list if there
 169       are no attributes
 170     - M::M::CDBI will warn() about Class::DBI::FromCGI errors
 171
 172
 173 2.07  Sun Jan 16 18:45:00 2005
 174     (This version was not uploaded to CPAN)
 175
 176     Internal changes:
 177     - Removed Maypole::Model->description. It didn't work as expected and
 178       clashed with 'description' columns in the database
 179
 180     Fixes:
 181     - Model->process() shouldn't set $r->objects() to a list with a single,
 182       undefined element
 183     - Fixed overriding $r->template_args->{classmetadata} in M::V::Base
 184       (Thanks to Dave Howorth for spotting the mistake)
 185     - #9473: Maypole::Model::CDBI->related_class (Thanks David Baird)
 186     - #9434: M::M::CDBI->search generated "uninitialized value" warnings
 187
 188     Templates:
 189     - The addnew template will attempt to prefill form fields with request
 190       parameters
 191     - edit template includes 'addnew' if there is no object to edit
 192
 193 2.06  Wed Dec 29 01:30:00 2004
 194     Fixes:
 195     - Minor restructuring of the manual so search.cpan.org indexes it better
 196     - #9129: Skip t/apache_mvc.t if Apache::Request isn't installed
 197
 198
 199 2.05  Fri Dec 24 03:20:00 2004
 200     - Revised and updated documentation. Many thanks to Dave Howorth for his
 201       hard work and 120kb documentation patches.
 202     - Added support for request and response HTTP headers with
 203       $r->headers_in & $r->headers_out (Maypole::Headers)
 204     - Support for compound primary keys for Maypole::Model::CDBI classes
 205     - Template toolkit objects are configurable with M::Config->view_options
 206     - Templating performance should be improved when running Maypole with
 207       mod_perl since compiled templates remain in memory. CGI users can use
 208       TT2's COMPILE_DIR or COMPILE_EXT options with
 209       Maypole::Config->view_options to improve performance
 210
 211     Internal changes:
 212     - Added a new override for the model: fetch_objects().
 213     - 'classmetadata' template variables can now be overriden individually
 214     - New unit tests for Maypole, CGI::Maypole, Maypole::Headers, and others.
 215       More to come.
 216
 217     Fixes:
 218     - Maypole::CLI is more tolerant of trailing slashes in the request/uri_base
 219     - fixed a bug in CGI::Maypole::parse_location() (Dave Howorth)
 220     - Also applied that fix to Apache::MVC (Marcus Ramberg)
 221     - some fixes for Maypole::Config, Maypole::Model::Base and
 222       Maypole::Model::CDBI::Plain (Dave Howorth)
 223     - Documented adding new accessors to Maypole::Config
 224     - Added Apache::RequestIO to Apache::MVC (michael#diaspora.gen.nz)
 225     - Applied patch to fix length of utf8 documents.
 226     - support compound primary keys in CDBI fetch_objects.
 227     - Check if has_a actually points to a Maypole::Model (Dave Howorth)
 228     - Make test suite work with DBD::SQLite2
 229     - default search() action removes empty fields from search parameters
 230     - #6622 - Maypole::Application will create a separate Maypole::Config for
 231       each application (instead of the current workaround for multiple apps
 232       under mod_perl)
 233     - #7643 - improve M::V::Base's error() messages. prefix error with label,
 234       and carp()
 235     - #7651 - minor POD improvements in M::M::CDBI (Dave Howorth)
 236     - #7834 - minor POD update in M::M::CDBI (Kevin Connor)
 237     - #7917 - if do_edit fails for object creation, try again with the correct
 238       template (addnew)
 239     - #7930 - handle Class::DBI constraint failures in do_edit.
 240
 241     Templates:
 242     - add support for compound primary keys in factory templates
 243       (Dagfinn Ilmari Mannsåker)
 244     - Only show buttons for public actions.
 245       (Dagfinn Ilmari Mannsåker)
 246     - Split the meat of the view template off to a view_item macro.
 247     - New login template
 248     - Other assorted css/template fixes
 249
 250
 251 2.04  Tue Oct 27 14:00:00 2004
 252     - fixed Apache::MVC version (Randal Schwartz)
 253     - fixed template_args (Dave Howorth)
 254     - new Maypole::Config documentation (Dave Howorth)
 255     - Maypole::Model::Base::process() no more steals you the first
 256       arg after fetching objects
 257
 258 2.03  Tue Oct 26 13:00:00 2004
 259     - increased version number of Apache::MVC
 260     - fixed display_tables bug (Steve Simms)
 261     - fixed templates, now again XHTML compliant
 262     - documentation fix (Dave Howorth)
 263     - only set charset for text/*
 264
 265 2.02  Mon Oct 25 13:00:00 2004
 266     - Fixed charset in http header.
 267     - replaced action links with forms in factory templates
 268
 269 2.01  Sun Oct 24 14:50:00 2004
 270     - documentation fix to make t/03podcoverage happy
 271
 272 2.0   Fri Oct 22 20:00:00 2004
 273     - added parse_args() (Simon Flack)
 274     - call additional_data() and authenticate() for plain templates
 275     - merged Apache2::MVC (mod_perl2 support) into Apache::MVC
 276     - added Maypole::Application universal front-end
 277     - config parameter handling for Maypole::Model::CDBI
 278     - $r->{query} is now deprecated, use $r->{params} for GET and POST
 279     - fixed multiple value handling (Simon Flack)
 280     - added exception handling (Simon Flack)
 281     - fixed documentation bugs
 282     - changed default documentencoding to utf8. Change with
 283       $r->config->{document_encoding}
 284     - removed Maypole::View::Mason as it's distributed separately on CPAN.
 285     - factory templates are now XHTML 1.1 compliant.
 286     - made the config hash into -> Maypole::Config
 287     - accessors for everything
 288     - win32 support
 289     - new documentation for Maypole.pm (Simon Flack)
 290     - moved doc/*.pod to lib/Maypole/Manual
 291     - added Maypole::Model::Base::is_public() to make it simple to overload
 292       :Exported behavior
 293     - added support for replacing use base qw/All My Modules/ with
 294       use Maypole::Application qw/Redirect AnotherPlugin/; note that this
 295       will only triggers with parameters to import, to preserve backwards
 296       compability.
 297     - fixed search ordering in Maypole::Model::CDBI and parameter
 298       handling in CGI::Maypole (Dave Slack)
 299     - sweet new factory templates (Danijel Milicevic)
 300     - zero search fix (Dave Slack)
 301
 302 1.7   Sat Jul 17 20:15:26 BST 2004
 303     - Emergency release - we lost the "use Maypole::Constants" from
 304       CLI.pm somehow
 305
 306 1.6   Fri Jul 16 23:51:21 BST 2004
 307     - Two very trivial fixes:
 308     - Put ::Plain in the MANIFEST, so it actually ships this time
 309     - Make CLI test == OK, not just true
 310
 311 1.5   Mon Jun 21 14:36:54 BST 2004
 312     - CLI mode correctly uses Constants module
 313     - Template footers as well as headers (Markus Ramberg)
 314     - Fix problems on failed object create (Jesse Sheidlower)
 315     - Fix related() to deal with latest version of Class::DBI (Markus)
 316     - Add sample CSS to distribution
 317     - Maypole::Model::CDBI::Plain, for those who already have a CDBI set
 318       of classes set up
 319     - Friendlier errors when a template can't be found
 320     - Don't authenticate without a model class
 321     - #6569 Passing DBI options in setup() (Mickael Joanne)
 322     - #6571 User-defined ok_tables: patch
 323     - #6572 Makefile patch: require up-to-date CBDI::AsForm (Markus Ramberg)
 324     - #6573 Set empty params to '' instead of undef (Jody Belka)
 325     - #6617 Required cols patch in CDBI.pm (Jesse Sheidlower)
 326
 327 1.4   Fri Apr 16 18:11:41 BST 2004
 328     - Much, much more documentation
 329     - CLI debugging mode
 330     - CGI frontend (CGI::Maypole)
 331     - Beginnings of a test suite
 332     - Maypole::Constants module to remove dependency on Apache
 333     - Refactoring of view classes to base/module-specific modules
 334     - HTML::Mason view class
 335     - Various small template bug fixes and enhancements
 336
 337 1.3   Fri Mar 26 19:16:33 GMT 2004
 338     - Fix serious order/CDBI::Page interaction bug.
 339     - Die if model/view class can't be compiled.
 340
 341 1.2   Thu Mar 25 12:35:21 GMT 2004
 342     - Ensure safety when dereferencing any ->objects
 343     - Support for the "frontpage" template
 344     - Maypole itself no longer uses ->{ar}, which is now completely
 345       refactored into the Apache::MVC class
 346     - The beginnings of the documentation framework
 347     - Support for paging and ordering in searches
 348     - Stringify column changed from magic "name" to customizable
 349       property
 350     - Move BeerDB to ex/
 351     - Fix SQLite dependency
 352
 353 1.1   Wed Feb 25 10:29:25 GMT 2004
 354     - Update CDBIL dependency
 355     - Don't stringify to "name" if there isn't one
 356     - Better support for authentication and template changes
 357     - Full set of templates
 358     - Allow passing of username and password to ->setup
 359     - display_columns method
 360
 361 1.0   Wed Feb 11 17:34:12 GMT 2004
 362     - Renamed from Apache::MVC to Maypole.
 363     - Clearer separation of model and view classes from controller
 364     - Factoring out of Apache-specific code back into Apache::MVC
 365
 366 0.2   Thu Feb  5 18:03:33 GMT 2004
 367     - This release adds paging of list results and ordering by column
 368       (ascending and descending)
 369
 370 0.01  Thu Jan  8 15:50:17 2004
 371         - original version; created by h2xs 1.22 with options
 372                 -AX -b 5.6.0 -n Apache::MVC
 373