rjspotter-ramaze 2009.06.29

data/doc/INSTALL

@@ -0,0 +1,92 @@
+* via RubyGems
+
+  The simplest way of installing Ramaze is via the gem.
+
+  [Rubygems](http://rubygems.org) is the package manager for ruby apps and
+  libraries and provides you with the last tagged version of Ramaze.
+
+      $ gem install ramaze
+
+  Versions are made as we see fit and get an announcment out (usually that's
+  the major obstacle as there is a lot to announce).
+
+  If you want to install the nightly gem of Ramaze you can do this with:
+
+      $ gem install ramaze --source=http://gem.ramaze.net/
+
+  We also use the gem building process on github, which locates gems at
+  http://gems.github.com - so you can get a version from there as well:
+
+      $ gem install manveru-ramaze --source=http://gems.github.com/
+
+* via git
+
+  To get the latest and sweetest, you can just pull from the repository and run
+  Ramaze that way.
+
+      $ git clone git://github.com/manveru/ramaze.git
+
+  Please read the `man git` or `git help` for more information about updating
+  and creating your own patches.
+  This is at the moment the premier way to use Ramaze, since it is the way I
+  use it.
+
+  Some hints for the usage of Git.
+
+  * use `require 'ramaze'` from everywhere
+
+    Simply add the path to your repository to the RUBYLIB environment variable.
+    If you are using bash you can simply put following line into your .bashrc:
+
+        $ export RUBYLIB="$HOME/path/to/repo/lib/"
+
+    Of course you should put the real path instead, you can also add multiple
+    paths, or create your personal `site_ruby`:
+
+        $ export RUBYLIB="$HOME/ruby/ramaze/lib:$HOME/.site_ruby:$HOME/ruby/bacon/lib"
+
+  * use `require 'ramaze'` systemwide from everywhere
+
+    add a file to your `site_ruby` directory named 'ramaze.rb'
+    the content should be: `require '/path/to/git/repo/ramaze/lib/ramaze'`
+
+  * Pull the latest version
+
+        $ git pull
+
+  * Reset the repo to original state (if you screw up something)
+
+        $ git reset --hard # resets the whole repo
+
+  * Revert changes to (for example) lib/ramaze.rb only
+
+        $ git checkout master lib/ramaze.rb
+
+  * Add and commit all changes.
+
+        $ git commit -a
+
+  * Adding only specific changes.
+
+        # Add hunks you want to commit to the staging area (index)
+        $ git add -p
+
+  * Commit the changes into the history of your repository
+
+        # Create a commit from the hunks added
+        $ git commit
+
+  * output your patches into a bundle ready to be mailed (compress it before
+    sending to make sure it arrives in the way you sent it)
+
+    At the end of this process you will have a tar.bz2 for all your changes
+    that you can mail to ramaze@googlegroups.com
+
+        # make sure you are on latest revision to avoid conflicts
+        $ git pull
+
+        # create 00xx-blah.patch files against the remote repo
+        $ git format-patch origin/HEAD
+
+        # From here on you can use either git-send-email or go the manual route
+        $ tar -cjf ramaze_bundle.tar.bz2 *.patch

data/doc/LEGAL

@@ -0,0 +1,26 @@
+This is a list of files included into ramaze but under different licenses.
+Also included are files that are not under the copyright from Michael Fellinger.
+
+lib/ramaze/helper/pager.rb
+  License: BSD License
+  Author: George K. Moschovitis
+
+lib/ramaze/snippets/dictionary.rb
+  License: Ruby License
+  Authors: Jan Molic and Thomas Sawyer
+
+lib/proto/js/jquery.js
+  License: Dual licensed under MIT and GPL
+  Author: John Resig
+
+lib/ramaze/spec/helper/simple_http.rb
+  License: Ruby
+  Author: Tim Becker
+
+lib/ramaze/template/xslt.rb
+  License: Ruby
+  Author: Stephan Maka
+
+lib/vendor/bacon.rb
+  License: MIT
+  Author: Christian Neukirchen

data/doc/TODO

@@ -0,0 +1,29 @@
+This list is programmaticly generated by `rake todolist`
+If you want to add/remove items from the list, change them at the
+position specified in the list.
+
+/home/manveru/prog/projects/ramaze/lib/ramaze/template/ezamar/morpher.rb
+- Add pure Ruby implementation as a fall-back.
+
+/home/manveru/prog/projects/ramaze/lib/ramaze/helper/pager.rb
+  ++
+
+/home/manveru/prog/projects/ramaze/spec/ramaze/action/basics.rb
+
+/home/manveru/prog/projects/ramaze/lib/ramaze/template/ezamar/engine.rb
+- provide C version or maybe use erbuis
+
+/home/manveru/prog/projects/ramaze/lib/ramaze/template/xslt.rb
+  * Error handling
+  * Maybe prevent extFunction to be called by HTTP
+
+/home/manveru/prog/projects/ramaze/lib/ramaze/helper/identity.rb
+- maybe using StackHelper, but this is a really minimal overlap?
+
+/home/manveru/prog/projects/ramaze/spec/snippets/ramaze/caller_info.rb
+
+/home/manveru/prog/projects/ramaze/lib/ramaze/snippets/dictionary.rb
+  ++
+
+/home/manveru/prog/projects/ramaze/lib/ramaze/helper/redirect.rb
+- maybe some more options, like a delay

data/doc/meta/announcement.txt

@@ -0,0 +1,146 @@
+The Ramaze development team is happy to announce version 2009.06 of Ramaze, the
+light and modular open source web framework that tries to stay out of your way.
+
+This release features a lot of work directly from our community and we are
+really greatful for everybody who helped in testing, patching and contributing
+exciting new features.
+
+Our extensive set of specs and docs now covers almost every detail of
+implementation and usage. Ramaze is under development by a growing community
+and in production use at companies.
+
+There have been too many changes since the last official announcement in
+2008.07, so I will only list changes since the last release.
+
+
+== Metadata
+
+Home page:       http://ramaze.net
+Wiki:            http://wiki.ramaze.net
+
+Repository:      http://github.com/manveru/ramaze
+
+Git clone:       git://github.com/manveru/ramaze
+Current tarball: http://github.com/manveru/ramaze/tarball/master
+
+IRC: #ramaze on irc.freenode.net
+
+
+Simple example:
+
+  require 'ramaze'
+
+  class MainController
+    def index
+      'Hello, World!'
+    end
+  end
+
+  Ramaze.start
+
+
+== Around 80 commits since 2009.05
+
+- Improved bin/ramaze with lots of specs, should work now even on windows.
+- Middleware order has been inverted.
+- Support for Webrat out of the box.
+- Fixed MemCache caching and sessions.
+- Removed a whole lot of methods that were marked deprecated.
+- New default Layout helper
+
+
+== Summarized changes with their respective commits
+
+- Antti Tuomi 
+  - Link helper did not set the prefix, added spec and fixed the behaviour
+    [ af753a0 | bae2b53 | eba4734 ]
+
+- Michael Fellinger (manveru)
+  - Fix bug that made default port/handler break in bin/ramaze [ e6715e1 ]
+  - Remove deprecated methods on Ramaze::Controller, Helper::Cache,
+    Helper::Link, and Helper::Auth. Also remove the deprecated methods
+    Object#acquire, String#/, and Symbol#/
+    [ 272fced | 1e4ac92 | a0a9329 | 68242b3 | 57e7a85 | 31b809a | 3fc4622 ]
+  - The bacon scope :mock was renamed to :rack_test, added shared :webrat, so
+    you can run your specs with that as well. Also move the bacon-specific code
+    to ramaze/spec/bacon, prepare for test-framework-agnostic behaviour.
+    [ f1a2669 | c12a0a4 | fdde916 ]
+  - Fix ordering of middleware [ 508bffc ]
+  - Warn and fix the ttl if someone exceeds the maximum ttl allowed by MemCache
+    [ 3124879 | bc08091 ]
+  - Comaptibility with localmemcache 0.4.0 [ 096f051 ]
+  - Fixed Cache::Sequel to work with 3.1.0 [ d2c2b85 ]
+  - Fix bug with memcache on 1.9, make sure the Etag middleware works on it
+    [ 21763df | 1d0dff5 ]
+  - A little bit of example-usage for Helper::Form#form_select, improve by
+    allowing :multiple => 10 [ a634582 | de73014 ]
+  - Avoid useless iteration and fix ambigous linking in helper/paginate
+    [ 6fb74df | 9b73450 ]
+  - Respect preset options for port/adapter on ramaze start [ 6efaaaa ]
+  - Preserve file permissions during `ramaze create` [ 3e3bc0a ]
+  - Implement and spec the lonely controller rule [ fdfe5b9 | 4dd866b ]
+  - Fix "bug" pointed out by druby [ 796627a ]
+  - Output to logger in ramaze/setup if Log is available, don't output the
+    require exception twice. Avoid infinite recursion when a
+    gem name does not match it's lib name [ b9fa0c4 | 7bc9d65 | e6b4996 ]
+  - Put a notice into config.ru making clear that the handler cannot be set
+    inside [ b4bad57 ]
+  - Some mods to contrib, fix facebook.rb syntax for ruby 1.9 and adding
+    Ramaze::AddressableRoute for great profit!  [ c7fbf0c | cafe657 ]
+  - Don't write a file to /tmp during the bin/ramaze spec [ eb5e4ef ]
+
+- Pistos 
+  - Explicitly state top-level namespace for ::File in config.ru, since
+    otherwise it is confused for Rack::File.
+    [ 5509950 ]
+  - Added Layout helper with specs and documentation
+    [ a84f675 | 41ad023 | 4f23d16 ]
+
+- TJ Vanderpoel (bougyman)
+  - Added some specs for ramaze/bin, correcting a require bug already in
+    bin/ramaze. [ 8bbb8e8 | 9a3edf3 | 33fa3aa ]
+
+A complete Changelog is available at
+http://github.com/manveru/ramaze/tree/master/doc/CHANGELOG?raw=true
+
+
+== Known issues
+
+- Some problems may show up when running the specs, these are mostly caused
+  by the gem-versions of Rack::Test and Rack, they only affect the specs and
+  should have no influence on the actual runtime.
+
+
+== Ramaze Features
+
+- Builds on top of the Rack library, which provides easy use of adapters like
+  Mongrel, WEBrick, LiteSpeed, Thin, CGI or FCGI.
+
+- Supports a wide range of templating-engines like: ERB, Erubis, Haml, Liquid,
+  Maruku, Redcloth, Remarkably, Sass, Tagz, Tenjin. And its own engines called
+  Etanni, Ezamar, Gestalt, and Nagoro.
+
+- Highly modular structure: you can just use the parts you like. This also
+  means that it's very simple to add your own customizations.
+
+- A variety of helpers is already available, giving you things like advanced
+  caching, OpenID-authentication or aspect-oriented programming for your
+  controllers.
+
+- It is possible to use the ORM you like, be it Sequel, DataMapper,
+  ActiveRecord, Og, Kansas or something more simplistic like DBI, or a wrapper
+  around YAML::Store.
+
+- Good documentation: although we don't have 100% documentation right now (dcov
+  says around 75%), just about every part of Ramaze is covered with basic and
+  advanced docs. There are a variety of examples, screencasts and a tutorial
+  available.
+
+- Friendly community: there are people from all over the world using Ramaze, so
+  you can get almost instant help and info.
+
+
+For more information please come to http://ramaze.net or ask directly on IRC
+irc://irc.freenode.net/#ramaze
+
+Thank you, Michael 'manveru' Fellinger and the Ramaze community

data/doc/meta/configuration.txt

@@ -0,0 +1,163 @@
+This chapter covers how to do configuration in Ramaze for your application.
+
+
+### Global
+
+The object holding most configuration is called Global. It resides in the Ramaze
+module/name space.
+
+Global is an instance of GlobalStruct, which itself is an instance of Struct.
+There have been some changes to it to suit its purpose.
+
+Before covering some of the available options let us see how to actually use it.
+
+For the examples shown here we will assume that you did include Ramaze
+into your main into your main name space. If you don't do that, just prefix
+Global with Ramaze so it is written Ramaze::Global.
+
+
+#### Basic assignment:
+
+  Global.port = 10
+
+if you do that before calling Ramaze::start Ramaze will choose the given number
+as port.
+
+
+#### Multiple assignment:
+
+  Global.setup :adapter => :mongrel,
+               :cache   => :memcached
+
+So you can pass a Hash of all the options you want to change.
+In this case you would use Mongrel as the adapter and use memcached for your
+sessions and general caching.
+
+
+#### Block assignment:
+
+  Global.setup do |g|
+    g.error_page = false
+    g.host = '127.0.0.1'
+    g.port = 7070
+  end
+
+This method is similar to the hash-assignment, but may be preferred for some
+applications.
+
+
+#### Pass on Ramaze.start
+
+  Ramaze.start :run_loose => true
+
+This way you can save a line or two in a small script.
+Please note that the values passed here have precedence over the ones directly
+set on Global and will overwrite them if you set them before, that is mostly
+useful to quickly test some configuration.
+
+
+### Global options
+
+This listing is here to provide you with descriptions of the most common
+configurations in alphabetical order per section showing the default value next
+to the key.
+
+This chapter has been shrunk a lot to cover only essentials, please look at
+lib/ramaze/global.rb to see all available options.
+
+Date of last update: 2007-05-20
+
+#### General Configuration:
+
+:sourcereload => 3
+
+SourceReload is a nifty mechanism that takes advantage of the dynamics of Ruby,
+it's basically a Thread that runs in the background and polls for files in the
+application and framework that have changed (using mtime). The value specifies
+roughly how fast your changes are going to be loaded and should be a number.
+If you set this to false, it will not start.
+
+
+:adapter => :webrick
+
+The adapter is the server Ramaze runs to serve your application. This can be any
+of mongrel/webrick/fcgi/cgi, please note that so far neither fcgi nor cgi have
+received the necessary testing, but, as they are only wrappers around the
+underlying Rack library, should work fine. Both fcgi and mongrel require
+additional libraries to be installed, webrick and cgi run out of the box.
+Generally the most supported and recommended for deployment is Mongrel.
+
+
+:cache => :memory
+
+Possible: :memory, :memcached, :yaml
+The cache is one of the more important things for deployment, the default for
+this is MemoryCache, a simple Hash.
+What you specify here will be used by Ramaze::Cache and is used throughout
+Ramaze to cache various things, like sessions, page- and value-caching.
+Included in Ramaze are the MemoryCache and YAMLStoreCache, after you install
+'memcached' you can also use the much more performant MemcachedCache that also
+makes it easy to use the same cache between different applications (sharing
+sessions is one of the most obvious uses).
+
+
+:cache_all => false
+
+Setting this value to true would enable caching for all pages served from the
+Controller (all actions).
+This is a very powerful setting and you might want to enable it if all pages
+you serve are only built once and have no further dynamics, the key for this
+cache consists of the controller and parameters, when repeated requests are
+made it will always serve the same (now static) page.
+
+
+:sessions => true
+
+Enables creation of sessions and automatic creation/setting of cookies.
+Please note that many functionalities of Ramaze depend on an intact session and
+you will have to be careful not to use these.
+This is most likely useful in combination with `cache_all`
+
+
+:error_page => true
+
+Enables the default Error page of Ramaze which is mostly useful for manual
+testing and faster debugging. In most deployment-scenarios you will however
+want to use your own Error page and so you can safely disable this setting.
+
+:host => '0.0.0.0'
+
+Tell the adapter where it accepts requests from, 0.0.0.0 says that every
+IP will be accepted, 127.0.0.1 would accept only requests from loopback.
+
+
+:mapping => {}
+
+This is a very central and special setting, it contains key/value pairs
+that define routes to your controllers, the keys are simple strings and
+start with '/', which means http://yourhost.com/ - '/foo/bar' would point
+to http://yourhost.com/foo/bar.
+The value is the class of your controller.
+
+
+:port => 7000
+
+The port Ramaze runs on, if you can think of more information about this feel
+free to tell us.
+
+
+:run_loose => false
+
+This option is mostly used to run the specs, it means that Ramaze will not
+join the adapter-threads and therefor you are free to run any code you want
+afterwards. You won't have to use this in most cases, example usage is in
+spec/spec_helper.
+
+
+:template_root => 'template'
+
+The template_root is the point your templates are located relative to the
+location of the entry-file (usually start.rb)
+It is also worth to mention that inside this directory the `mapping` is used
+to locate templates for each controller, only the controller mapped to '/' uses
+the templates directly from the `template_root`