nitro 0.31.0 → 0.40.0

data/doc/{AUTHORS → CONTRIBUTORS}

@@ -1,11 +1,13 @@
 LEAD DEVELOPER:
 
-* George K. Moschovitis <gm@navel.gr>
+* George K. Moschovitis <george.moschovitis@gmail.com>
   Project leader, architecture and design, main coder, 
   documentation, maintainer (http://www.gmosx.com).
 
 
-NITRO DEVELOPMENT TEAM:
+TEAM NITRO:
+
+Team Nitro is group of important contributors to the project.
 
 * Jonas Pfenniger <zimba.tm@gmail.com>
   Patches, new features, bug fixes.
@@ -17,18 +19,29 @@ NITRO DEVELOPMENT TEAM:
 * Guillaume Pierronnet <guillaume.pierronnet@laposte.net>
   Patches, new features, bug fixes.
 
-* Rob Pitt <rob@motionpath.co.uk>
-  Patches, Bug fixes, Scaffolding improvements.
+* Thomas Sawyer <transfire@gmail.com>
+  Small bug fixes, patches.
+  
+* Jonathan Buch <jonathan.buch@gmail.net>
+  Patches, documentation.
 
-* Aidan Rogers <aidan@infurious.com>
-  Documentation, Bug reports, patches.
-      
+* Fabian Buch <fabian@fabian-buch.de>
+  FeedHelper, various patches.
 
+* Michael Fellinger <m.fellinger@gmail.com>
+  Patches, bug fixes.
+  
 IDEAS, ADDITIONAL CODING, SUPPORT:
 
+* Rob Pitt <rob@motionpath.co.uk>
+  Patches, Bug fixes, Scaffolding improvements.
+      
 * Chris Farmiloe <chris.farmiloe@farmiloe.com>
   Patches, new features, bug fixes.
   
+* Aidan Rogers <aidan@infurious.com>
+  Documentation, Bug reports, patches.
+
 * James Britt <james_b@neurogami.com>
   Evangelising, documentation, design, additional code, bug reports.
 
@@ -37,58 +50,57 @@ IDEAS, ADDITIONAL CODING, SUPPORT:
 
 * Brian Bugh <brian@xsi-design.com>
   Fixes, Patches.
+
+* Gabriele Renzi <surrender_it@yahoo.it>
+  Patches, new features.
+
+* Fang Sun <nusgnaf@gmail.com>
+  Patches.
+  
+* <neokolor@gmx.de>
+  Patches.
   
 * Zed A. Shaw <zedshaw@zedshaw.com>
   SCGI adapter.
 
 * Peter Abrahamsen <rainhead@gmail.com>  
   Documentation, small patches.
-  
-* Anastasios Koutoumanos <ak@navel.gr>
-  Design, bug reports.
-  
-* TRANS <transfire@gmail.com>
-  Small bug fixes, patches.
 
-* Kashia Buch <kashia@vfemail.net>
-  Patches, documentation.
-  
 * Massimo Maria Ghisalberti 
   Patches.
 
+* John A. Lambert
+  Patches.
+  
 * Dan Yoder <dan@zeraweb.com>
   Original 'Elements' implementation, bug reports.
     
 * Joshua Hoke
   Patches.
-  
-* Kostas Nasis <kostas@nasis.com>
-  Ideas and bug reports.
 
+* Michael Neumann <mneumann@ntecs.de>
+  Wee integration, patches.
 
-INTEGRATED LIBRARIES:
+* Alexander Lazic <al-nitrogen@none.at>
+  Patches, bug reports.
 
-Nitro integrates several open source libraries:
+* Darrick W <darrick@innatesoftware.com>
+  Patches.
+    
+* Anastasios Koutoumanos <ak@navel.gr>
+  Ideas, bug reports.
 
-* Facets: The best collection of
-  Ruby extensions/utilities.
-  Tomas Sawyer, http://nano.rubyforge.org, http://mega.rubyforge.org
-  
-* Prototype: Object Oriented Javascript library
-  Sam Stepherson, http://www.conio.net
+* Kostas Nasis <kostas@nasis.com>
+  Ideas and bug reports.
   
-* Script.aculo.us: Special FX Javascript library
-  Thomas Fuchs, http://script.aculo.us
 
-* Breakpointer
+DONATIONS:
 
+The following people have genereously donated money for the
+advancement of the Nitro project:
 
-CODE FROM OTHER PROJECTS:
+* Jonas Pfenniger <zimba.tm@gmail.com>
 
-Occasionaly, Nitro may include code from other open source
-projects. Such code is often temporary and typically 
-reimplemented at a later day. Nitro integrates *minor* code 
-snippets from:
+* Emmanuel Piperakis
 
-* Ruby On Rails,
-  David Hanson, http://www.rubyonrails.com
+* Matt Bowen <matt.bowen@farweststeel.com>

data/doc/LIBRARIES

@@ -0,0 +1,13 @@
+
+Nitro integrates several open source libraries:
+
+* Facets: The best collection of Ruby extensions/utilities.
+  Tomas Sawyer, http://nano.rubyforge.org, http://mega.rubyforge.org
+  
+* Prototype: Object Oriented Javascript library
+  Sam Stepherson, http://www.conio.net
+  
+* Script.aculo.us: Special FX Javascript library
+  Thomas Fuchs, http://script.aculo.us
+
+* Breakpointer

data/doc/LICENSE

@@ -1,7 +1,6 @@
 The BSD License
 
-Copyright (c) 2004-2005, George 'gmosx' Moschovitis. (http://www.gmosx.com)
-Copyright (c) 2004-2005, Navel Ltd. (http://www.navel.gr)
+Copyright (c) 2004-2006, George K. Moschovitis. (http://www.gmosx.com)
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without 
@@ -15,7 +14,7 @@ notice, this list of conditions and the following disclaimer.
 notice, this list of conditions and the following disclaimer in the 
 documentation and/or other materials provided with the distribution.
   
-* Neither the name of Navel nor the names of its contributors may be 
+* Neither the name of Nitro nor the names of its contributors may be 
 used to endorse or promote products derived from this software 
 without specific prior written permission.
 

data/doc/MIGRATION

@@ -10,6 +10,51 @@ For more help, send your question to the mailing list:
 http://rubyforge.org/mailman/listinfo/nitro-general
 
 
+== 0.40.0 <- 0.31.0
+
+This version was in the making for ages, so there are some changes
+you need to make to port your application to the new version. Here 
+come some tips to help you:
+
+- Prefer to use 
+
+  $ nitro
+
+  instead of 
+
+  $ ruby run.rb
+
+  to start your application.
+
+- The 'Markup' compiler is renamed to 'MarkupCompiler' 
+
+- Use attr_accessor instead of property or prop_accessor.
+
+- Prefer to define elements like this:
+
+  class Nitro::Element
+    class MyElement
+    ..
+    end
+  end
+
+  instead of
+
+  class MyElement < Nitro::Element
+  end
+
+- Change
+  
+  def my_action
+    ..
+  end
+  ann :my_action, :view => :another_template
+  
+  to
+  
+  ann :my_action, :template => :another_template
+  
+  
 == 0.29.0 <- 0.28.0
 
 1. Please notice that Tag now resides in the Glue namespace, you 

data/doc/RELEASES

@@ -1,20 +1,140 @@
-== Version 0.31.0
+== Version 0.40.0
 
-* Mongrel adapter updated to work with latest versions of Mongrel.
+This is the biggest release yet! Tons of new wonderful features,
+code refactoring, bug fixes, documentation improvements and so
+much more.
 
-* Fixed a long-standing bug where the template root wasn't determined correctly (would result in blank pages).
+Special thanks for this release fly to Jonas Pfeniger, 
+Jonathan/Fabian Buch and Michael Fellinger.
 
-* Added sendfile support.
+Most notable changes:
+
+* Fully transparent Og managed objects. No need to use the 
+  special property notation. Just use the standard attr_accessor
+  macro:
+  
+  class User
+    attr_accessor :name, String, :sql => 'VARCHAR(32)
+    attr_accessor :password, String
+    attr_accessor :age, :login_count, Fixnum
+  
+    belongs_to :group
+    has_many :comments
+    joins_many :categories
+  end
+  
+  Og automatically detects and manages this class!
+  
+* The Og adapter model was re-engineered from scratch. The new
+  adapter code is better refactored. It is now extremely easy to
+  write new adapters for various RDBMS systems.
+  
+* Og build mode. This avoids multiple sql queries when you are
+  'building' (ie attaching related objects) a new object.
+
+* You can now easily lookup Og entities by name:
+
+  u = User[1] # classic
+  
+  or
+  
+  u = User['gmosx'] # this works as well!
+  
+  for the new method to work you need to annotate the attribute
+  to use for named lookups:
+  
+  class User
+    attr_accessor :name, String, :key => true
+    ..
+  end  
+
+* Og set attribute, a nice helper to set only some attributes.
+
+  b = Book[1]
+  b.set_attribute :title => 'Hello' # updates only title in the DB
+  b.instance_attribute_set '@title', 'Hello' # Ruby style
+  b.set_attributes :title => '1', :hits => 3
+
+* Much more intelligent dispatcher now handles nested controllers
+  and many 'edge' cases. For example:
+  
+  Server.map = {
+    '/' => SiteController,
+    '/users' => UserController,
+    '/users/categories' => UserCategoryController,
+    '/users/comments' => UserCommentController
+    ...
+  }
+
+* Introduced the notion of Controls as extensions of the Elements
+  feature. The auto administration part was recoded to utilize 
+  the Controls system. Ooh, and the admin screens now display
+  validation errors.
+  
+* Introduced Console/Script adapter. This is a new adapter that
+  allows you to programmatically send http requests to Nitro. You
+  can send GET/POST/etc request to any action you like with 
+  any request parameters.
+  
+  This adapter is used in the console mode. You can access it 
+  through the $app variable.
+  
+  You can also use this adapter to perform sophisticated testing,
+  our specialized  automation scripts.
+
+* New and improved nitro command. Among many new features the
+  new command supports:
+  
+  * Easy setup of clusters:
+  
+    nitro --cluster 3 
+    
+    if the default port is 9000 starts 3 instances of the application
+    listening on 9000, 9001, 9002. This command is smart enough
+    to also name the instances for easy identification when you
+    give 'ps aux'.
+    
+    Useful for Mongrel/FastCGI deployment.
+    
+  * Automatic start of state servers. You need a 'state' server
+  if tou use Mongrel/Nitro to keep the distributed session and 
+  global variables and any other common data you want to use.
+  
+* Output cache cleanup. Just start the console
+
+  nitro console
 
-* Fixed strip_path support. When this setting is set to a path, it will be stripped from urls. Given, 
+  and give:
 
-  Router.strip_path = '/nitro-apps'
+  $cache.cleanup
+
+
+* More flexible elements namespace selection, you can easier 
+  have multiple skins in your web app, per controller, per 
+  controller group etc. A low level example: 
+  
+  class MyController 
+    ann :self, :elements => CustomSkin
+  end
+    
+* More flexible configuration system. See the updated examples
+  for the details.
+  
+* Further improvements in the form builder. Among other things,
+  it now works better with flash parameters and handle errors.
+  
+* Greatly improved the Mongrel adapter. In fact nitro+mongrel
+  running behind apache is now the reference deployment method.
+  We have removed the unsupported SCGI adapter, please use
+  Mongrel instead.
+  
+* The StaticInclude compiler now handles recursive includes.
 
-when the dispatcher gets a url like /nitro-apps/blog it will strip out /nitro-apps and resolve to the controller for /blog.
+* Brand new automatic administration part.The new implementation 
+  is much simpler, elegant and easier to extend. 
 
-* Wee helper is removed.
+* Many more bug fixes and smaller improvements.
 
-* Updated Nitro start page with links to the examples.
 
 == Version 0.30.0
 
@@ -2121,7 +2241,7 @@ and an AJAX example are also included.
 
   class MyMailer < Mailer
     def registration_email(to, username, password)
-      @from = 'system@navel.gr'
+      @from = 'system@nitroproject.org'
       @to = to
       @subject = 'Registration information'
       @body.username = username
@@ -2137,7 +2257,7 @@ and an AJAX example are also included.
 
   Then use it like this:
 
-  MyMailer.deliver_registration_email('gmosx@navel.gr', 'gmosx', 'rulez')
+  MyMailer.deliver_registration_email('gmosx@nitroproject.org', 'gmosx', 'rulez')
 
   For more information, check out the updated blog example.
 

data/doc/TODO

@@ -0,0 +1,67 @@
+
+
+
+h2. Nitro
+
+* the examples require *serious* updating.
+* move markup back to glue.
+* Optimize settings lookup.
+* In elements compiler, Class.by_name also returns top level 
+  classes, how can we fix this?
+* add method to setup error responses (set http response status)
+* automatically set a template root relative to the controller definition file location.
+* check for autoreloads in custom template roots.
+* keep nitro mode in environment, dont pass as param.
+* deploy copies files in root dir, not in lib to get rid of LOAD_PATH unshifts.
+* store caching relation hints.
+* auto load controller files for loaded models.
+* setup with yaml
+* if a template is added (and didn't exist) the autoreloader does
+  not detected (cannot 'link' it with an action)
+* device to delete all cached pages related to object / all.
+* move flash in session.
+* use catch/throw to exit from actions.
+* user customizable session crypt.
+* dont load by default files that are not usually needed (like og evolution for example)
+* new 'local' hash (like session/flash) but stores values in a cookie.
+* refactor common code between webrick/mongrel.
+* 'nitro console' uses live and drinks errors.
+* better R, no need to pass controller, pass only controller, and no need to pass param key.
+* allow multiple controllers to be mounted to the same mount point.
+
+h2. Og
+
+* no need for :condition keyword in Entity.all / Entity.find
+* use one version of write_attr/quote and update quote for all adapters.
+* if no database exists, reset create_schema to true!
+* how to avoid excessivly calling the validation code.
+* no more excessive og.saves when setting relations (even trigger excessive sweepers)
+* when destroying a class remove from entities.
+* og device to allow removal of all tables related to a class.
+* og save/create drinks errors on invalid fields.
+* option to add automatic counter property for many_to_many and
+  joins_many relations.
+
+h2. Glue
+
+* Configuration.Module.Class barks.
+
+h2. Gen
+
+* web based application creator.
+* auto create styleguide using a css as input.
+
+-----
+
+h2. Done
+
+* make 'nitro mongrel' work.
+* allow: self.set_attribute(:status, true)
+  use instance_variable_set!
+* add option to skip rewrites in webrick/mongrel adapters if running behinf lighttpd.
+
+h2. Rejected
+
+* allow port setting like this: Server.cache_port = '+50' 
+  relative to application base port.
+* allow for port ranges for drb server, session servers and stuff like that.