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