ramaze 0.0.9 → 0.1.0

data/doc/INSTALL

@@ -26,7 +26,7 @@
   To get the latest and sweetest, you can just pull from the repository and run
   Ramaze that way.
 
-    $ darcs get http://manveru.mine.nu/ramaze
+    $ darcs get --partial http://manveru.mine.nu/ramaze
 
   Please read the man page or `darcs help` for more information about updating
   and creating your own patches.

data/doc/README

@@ -34,16 +34,14 @@ Ramaze offers following features at the moment:
 
    Rack supports at the moment:
 
-    * Mongrel
+    * [Mongrel](http://mongrel.rubyforge.org/)
 
-      http://mongrel.rubyforge.org/
       Mongrel is a fast HTTP library and server for Ruby that is intended for
       hosting Ruby web applications of any kind using plain HTTP rather than
       FastCGI or SCGI.
 
-    * WEBrick
+    * [WEBrick](http://www.webrick.org/)
 
-      http://www.webrick.org/
       WEBrick is a Ruby library program to build HTTP servers.
 
     * CGI
@@ -53,37 +51,31 @@ Ramaze offers following features at the moment:
 
 
 * Templates
-  * Amrita2
+  * [Amrita2](http://amrita2.rubyforge.org/)
 
-    http://amrita2.rubyforge.org/
     Amrita2 is a xml/xhtml template library for Ruby. It makes html documents
     from a template and a model data.
 
-  * Erubis
+  * [Erubis](http://rubyforge.org/projects/erubis)
 
-    http://rubyforge.org/projects/erubis
     Erubis is a fast, secure, and very extensible implementation of eRuby.
 
-  * Haml
+  * [Haml](http://haml.hamptoncatlin.com/)
 
-    http://haml.hamptoncatlin.com/
     Haml takes your gross, ugly templates and replaces them with veritable Haiku.
 
-  * Liquid
+  * [Liquid](http://home.leetsoft.com/liquid)
 
-    http://home.leetsoft.com/liquid
     Liquid's syntax and parse model are inspired by Django templates, as well
     as PHP's smarty.
 
-  * Markaby
+  * [Markaby](http://code.whytheluckystiff.net/markaby/)
 
-    http://code.whytheluckystiff.net/markaby/
     Markaby means Markup as Ruby.
 
   * Ezamar
 
-    A simple homage to Nitros templating. Please check out http://nitroproject.org
-    for more information.
+    A simple homage to [Nitro](http://nitroproject.org)s templating.
 
 * Cache
   * Hash
@@ -113,45 +105,60 @@ Ramaze offers following features at the moment:
 
 There are some basic principles that Ramaze tries to follow:
 
-* Test everything
+* KISS (Keep It Super Simple)
 
-  What use is a wonderful application if it doesn't work?
+  Ramaze doesn't introduce any major change of paradigm for everyone familiar
+  with Ruby and the basics of Web-development.
 
+* POLS (Principle Of Least Surprise)
 
-* Document everything
+  Ramaze tries to be intuitive and easy to learn. Most functionality is built in
+  a way to help, not to obfuscate or confuse.
 
-  Documentation is the glue between the code and the programmers brain
+* Modular design
 
+  Use what you want and how you want it.
 
-* Keep It Super Simple (KISS)
+  Through Ruby Ramaze provides one of the most powerful programming-languages
+  available, giving you full control over your system.
 
-  Most things should be understandable after reading them once
+  Even the most essential parts of Ramaze can easily be replaced and/or modified
+  without losing the advantage of the whole framework. 
 
+* Minimal dependencies
 
-* Principle Of Least Surprise (POLS)
+  Nothing besides Ruby is required for the basic features.
 
-  Going the way of ruby
+  Of course you can take advantage of several wonderful libraries, but Ramaze is
+  built in a way to be run on any basic setup.
 
+* Documentation
 
-* Modular design
+  Document everything, classes, modules, methods, configuration...
 
-  Making it as simple as possible to extract parts
+  Through 100% documentation Ramaze gives the developer easy and solid
+  understanding of the underlying concepts and functionality.
 
+* Open development
 
-* Minimal dependencies
+  Everyone is welcome to contribute to Ramaze in the easiest way possible. The
+  repository is open for patches passing the Test-suite.
 
-  In case a dependency is not met use a simple fall-back instead
+* Examples
 
+  Everyone learns different, some only read the source, others browse
+  documentation, but everyone loves examples for a quick and painless start.
 
-* Provide as many examples as possible
+  Ramaze addresses this need and offers a wide variety of examples of usage,
+  basic functionality, project-layout and more advanced applications.
 
-  Examples are a superior way of getting a quick start into everything
+* Fully BDD (Behaviour Driven Design)
 
+  Ramaze has a very complete set of so-called specifications built by RSpec.
+  These specs define the way Ramaze has to behave.
 
-* Open development
-
-  I happily accept all patches or feature-requests that you may have,
-  as long as they comply with these principles
+  The specs are checked every time a new patch is pushed into the repository,
+  deciding whether the changes the patch applies are valid and don't break the framework.
 
 
 = Installation
@@ -165,12 +172,13 @@ There are some basic principles that Ramaze tries to follow:
   in case you have RubyGems installed.
   (this will work as soon as I have registered on RubyForge ;)
 
+
 * via darcs
 
   To get the latest and sweetest, you can just pull from the repository and run
   Ramaze that way.
 
-    $ darcs get http://manveru.mine.nu/ramaze
+    $ darcs get --partial http://manveru.mine.nu/ramaze
 
   Please read the man page or `darcs help` for more information about updating
   and creating your own patches.
@@ -199,6 +207,11 @@ There are some basic principles that Ramaze tries to follow:
     $ gzip -c ramaze_bundle > ramaze_bundle.gz
 
 
+* via install.rb
+
+  Support for install.rb has been canceled and the file removed.
+
+
 = Getting Started
 
 Now that you have a vague idea of what you're about to get into you might just

data/doc/README.html

@@ -0,0 +1,637 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: README</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+  <div id="fileHeader">
+    <h1>README</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>doc/README
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Fri May 11 20:47:35 +0900 2007</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <pre>
+          Copyright (c) 2006 Michael Fellinger m.fellinger@gmail.com
+ All files in this distribution are subject to the terms of the Ruby license.
+</pre>
+<h1>About Ramaze</h1>
+<p>
+Ramaze is a very simple and straight-forward web-framework. The philosophy
+of it could be expressed in a mix of KISS and POLS, trying to make simple
+things simple and complex things possible.
+</p>
+<p>
+This of course is nothing new to anyone who knows some ruby, but is often
+forgotten in a chase for new functionality and features. Ramaze only tries
+to give you the ultimate tools, but you have to use them yourself to
+achieve perfect custom-tailored results.
+</p>
+<p>
+Another one of the goals during development of Ramaze was to make every
+part as modular and therefor reuasable as possible, not only to provide a
+basic understanding after the first glance, but also to make it as simple
+as possible to reuse parts of the code.
+</p>
+<p>
+The original purpose of Ramaze was to act as a kind of framework to build
+web-frameworks, this was made obsolete by the introduction of rack, which
+provides this feature at a better level without trying to enforce any
+structural layout of the resulting framework.
+</p>
+<h1>Features Overview</h1>
+<p>
+Ramaze offers following features at the moment:
+</p>
+<ul>
+<li>Adapters
+
+<pre>
+ Ramaze takes advantage of the rack library to provide a common way of
+ handling different ways to serve its content.
+
+ Rack supports at the moment:
+
+  * [Mongrel](http://mongrel.rubyforge.org/)
+
+    Mongrel is a fast HTTP library and server for Ruby that is intended for
+    hosting Ruby web applications of any kind using plain HTTP rather than
+    FastCGI or SCGI.
+
+  * [WEBrick](http://www.webrick.org/)
+
+    WEBrick is a Ruby library program to build HTTP servers.
+
+  * CGI
+
+    CGI is the Common Gateway Interface and is one of the most basic ways
+    to integrate into Webservers like Apache, Lighttpd or Nginx.
+</pre>
+</li>
+<li>Templates
+
+<ul>
+<li>[Amrita2](<a
+href="http://amrita2.rubyforge.org">amrita2.rubyforge.org</a>/)
+
+<p>
+Amrita2 is a xml/xhtml template library for Ruby. It makes html documents
+from a template and a model data.
+</p>
+</li>
+<li>[Erubis](<a
+href="http://rubyforge.org/projects/erubis">rubyforge.org/projects/erubis</a>)
+
+<p>
+Erubis is a fast, secure, and very extensible implementation of eRuby.
+</p>
+</li>
+<li>[Haml](<a href="http://haml.hamptoncatlin.com">haml.hamptoncatlin.com</a>/)
+
+<p>
+Haml takes your gross, ugly templates and replaces them with veritable
+Haiku.
+</p>
+</li>
+<li>[Liquid](<a
+href="http://home.leetsoft.com/liquid">home.leetsoft.com/liquid</a>)
+
+<p>
+Liquid&#8216;s syntax and parse model are inspired by Django templates, as
+well as PHP&#8216;s smarty.
+</p>
+</li>
+<li>[Markaby](<a
+href="http://code.whytheluckystiff.net/markaby">code.whytheluckystiff.net/markaby</a>/)
+
+<p>
+Markaby means Markup as Ruby.
+</p>
+</li>
+<li>Ezamar
+
+<p>
+A simple homage to [Nitro](<a
+href="http://nitroproject.org)s">nitroproject.org)s</a> templating.
+</p>
+</li>
+</ul>
+</li>
+<li>Cache
+
+<ul>
+<li>Hash
+
+</li>
+<li>YAML::Store
+
+</li>
+<li>MemCache
+
+</li>
+</ul>
+</li>
+<li>Helper
+
+<ul>
+<li>Aspect
+
+</li>
+<li>Auth
+
+</li>
+<li>Cache
+
+</li>
+<li>Feed
+
+</li>
+<li>Flash
+
+</li>
+<li>Form
+
+</li>
+<li>Link
+
+</li>
+<li>OpenID
+
+</li>
+<li>Redirect
+
+</li>
+<li>Stack
+
+</li>
+</ul>
+</li>
+<li>Various
+
+<ul>
+<li>Sessions
+
+</li>
+<li>Global configuration system
+
+</li>
+<li>Simple request/response handling
+
+</li>
+<li>Custom Error-handling
+
+</li>
+</ul>
+</li>
+</ul>
+<h1>Basic Principles</h1>
+<p>
+There are some basic principles that Ramaze tries to follow:
+</p>
+<ul>
+<li>KISS (Keep It Super Simple)
+
+<p>
+Ramaze doesn&#8216;t introduce any major change of paradigm for everyone
+familiar with Ruby and the basics of Web-development.
+</p>
+</li>
+<li>POLS (Principle Of Least Surprise)
+
+<p>
+Ramaze tries to be intuitive and easy to learn. Most functionality is built
+in a way to help, not to obfuscate or confuse.
+</p>
+</li>
+<li>Modular design
+
+<p>
+Use what you want and how you want it.
+</p>
+<p>
+Through Ruby Ramaze provides one of the most powerful programming-languages
+available, giving you full control over your system.
+</p>
+<p>
+Even the most essential parts of Ramaze can easily be replaced and/or
+modified without losing the advantage of the whole framework.
+</p>
+</li>
+<li>Minimal dependencies
+
+<p>
+Nothing besides Ruby is required for the basic features.
+</p>
+<p>
+Of course you can take advantage of several wonderful libraries, but Ramaze
+is built in a way to be run on any basic setup.
+</p>
+</li>
+<li>Documentation
+
+<p>
+Document everything, classes, modules, methods, configuration&#8230;
+</p>
+<p>
+Through 100% documentation Ramaze gives the developer easy and solid
+understanding of the underlying concepts and functionality.
+</p>
+</li>
+<li>Open development
+
+<p>
+Everyone is welcome to contribute to Ramaze in the easiest way possible.
+The repository is open for patches passing the Test-suite.
+</p>
+</li>
+<li>Examples
+
+<p>
+Everyone learns different, some only read the source, others browse
+documentation, but everyone loves examples for a quick and painless start.
+</p>
+<p>
+Ramaze addresses this need and offers a wide variety of examples of usage,
+basic functionality, project-layout and more advanced applications.
+</p>
+</li>
+<li>Fully BDD (Behaviour Driven Design)
+
+<p>
+Ramaze has a very complete set of so-called specifications built by RSpec.
+These specs define the way Ramaze has to behave.
+</p>
+<p>
+The specs are checked every time a new patch is pushed into the repository,
+deciding whether the changes the patch applies are valid and don&#8216;t
+break the framework.
+</p>
+</li>
+</ul>
+<h1>Installation</h1>
+<ul>
+<li>via RubyGems
+
+<p>
+The simplest way of installing Ramaze is via
+</p>
+<pre>
+  $ gem install ramaze
+</pre>
+<p>
+in case you have RubyGems installed. (this will work as soon as I have
+registered on RubyForge ;)
+</p>
+</li>
+<li>via darcs
+
+<p>
+To get the latest and sweetest, you can just pull from the repository and
+run Ramaze that way.
+</p>
+<pre>
+  $ darcs get --partial http://manveru.mine.nu/ramaze
+</pre>
+<p>
+Please read the man page or `darcs 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.
+</p>
+<p>
+Some hints for the usage of Darcs.
+</p>
+<ul>
+<li>use require &#8216;ramaze&#8217; from everywhere
+
+<p>
+add a file to your site_ruby named &#8216;ramaze.rb&#8217; the content
+should be: &quot;require
+&#8217;/path/to/darcs/repo/ramaze/lib/ramaze&#8217;&quot;
+</p>
+</li>
+<li>get the latest version (from inside the ramaze-directory)
+
+<p>
+$ darcs pull
+</p>
+</li>
+<li>record a patch
+
+<p>
+$ darcs record
+</p>
+</li>
+<li>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)
+
+<p>
+$ darcs send -o ramaze_bundle $ gzip -c ramaze_bundle &gt; ramaze_bundle.gz
+</p>
+</li>
+</ul>
+</li>
+<li>via install.rb
+
+<p>
+Support for install.rb has been canceled and the file removed.
+</p>
+</li>
+</ul>
+<h1>Getting Started</h1>
+<p>
+Now that you have a vague idea of what you&#8216;re about to get into you
+might just want to get a way to get up and running ASAP. Please read below
+for more information about installation.
+</p>
+<p>
+Depending on what you are planning to do you can either just go and start
+reading the source or directly get some hands-on experience by trying some
+of the examples. Most things will require dependencies though. The basic
+functionality is provided by the WEBrick adapter and the Template::Ramaze,
+which just run out of the box. For more features you will have to install
+some templating-engines and mongrel (<em>very</em> recommended). Ramaze
+will inform you when it needs further dependencies, so just go and try some
+things.
+</p>
+<p>
+Some places to get started are:
+</p>
+<ul>
+<li>Read the documentation.
+
+</li>
+<li>Run and read the test cases.
+
+</li>
+<li>Look at the examples and run/modify them.
+
+</li>
+</ul>
+<h1>A couple of Examples</h1>
+<p>
+There are some examples for your instant pleasure inside the
+examples-directory in the Ramaze-distribution. To start up an example, you
+can use the Ramaze binary located in bin/ramaze for example:
+</p>
+<pre>
+  $ ramaze examples/hello.rb
+</pre>
+<p>
+Or:
+</p>
+<pre>
+  $ cd examples/blog
+  $ ramaze
+</pre>
+<p>
+Since ramaze uses the main.rb by default if you don&#8216;t pass anything
+else.
+</p>
+<p>
+For more information about the usage of ramaze try:
+</p>
+<pre>
+  $ ramaze --help
+</pre>
+<p>
+Examples include:
+</p>
+<ul>
+<li>examples/hello.rb Hello, World!
+
+</li>
+<li>examples/simple.rb A bit more advanced than the hello-example, but still
+very basic.
+
+</li>
+<li>examples/blog Not yet fully functional, but coming along.
+
+</li>
+<li>examples/whywiki A basic examples of a minimalistic application, based on
+the Wiki of _why in his camping-framework.
+
+</li>
+<li>examples/templates examples of real usage of the templating-engines. Tries
+to implement the same functionality in each template_*.rb file using a
+different engine.
+
+</li>
+</ul>
+<h1>How to find Help</h1>
+<p>
+For help you can:
+</p>
+<ul>
+<li>Visit us in the channel ramaze on irc.freenode.net
+
+</li>
+<li>Join the Mailinglist at <a
+href="http://ramaze.rubyforge.org">ramaze.rubyforge.org</a>
+
+</li>
+</ul>
+<h1>Appendix</h1>
+<ul>
+<li>Nicer Error-pages
+
+<ul>
+<li>Install coderay (it&#8216;s a gem)
+
+</li>
+</ul>
+</li>
+<li>Performance
+
+<ul>
+<li>Serving
+
+<p>
+For best performance you should consider using Mongrel to host your
+application.
+</p>
+</li>
+<li>Caching
+
+<p>
+You can easily cache your pages using the CacheHelper. Also, using MemCache
+gives you high-end performance and security.
+</p>
+</li>
+</ul>
+</li>
+</ul>
+<h1>And thanks to&#8230;</h1>
+<p>
+There is a large number of people who made Ramaze possibe by their ongoing
+efforts in the world of open source and by encouraging and helping me.
+</p>
+<p>
+This list is by no means a full listing of all these people, but I try to
+get a good coverage despite that.
+</p>
+<p>
+I would like to thank:
+</p>
+<ul>
+<li>Yukihiro Matsumoto a.k.a matz
+
+<pre>
+  For giving the world Ruby and bringing fun back into programming.
+</pre>
+</li>
+<li>Zed Shawn a.k.a. zedas
+
+<pre>
+  For developing Mongrel, Ramaze started out as a simple Hello World based
+  on that awesome server.
+</pre>
+</li>
+<li>Christian Neukirchen a.k.a chris2
+
+<pre>
+  For building rack, which is just what the numerous web-developers had
+  anticipated and which will, with no doubt, change the world.
+</pre>
+</li>
+<li>Pistos
+
+<pre>
+  For continious encouragment and building the first real webpage on Ramaze.
+  His bugreports were invaluable.
+</pre>
+</li>
+<li>Jim Weirich
+
+<pre>
+  For Rake, which lifts off a lot of tasks from the shoulders of every
+  developer who uses it.
+</pre>
+</li>
+<li>Thomas Sawyer a.k.a Trans
+
+<pre>
+  Dragging me deep into the rabbit-hole and showing me how awesome Ruby
+  truely is through his work on facets, ratchets and tons of other projects.
+</pre>
+</li>
+<li>George Moschovitis a.k.a gmosx
+
+<pre>
+  For his tremendous efforts in the Nitro/Og framework, which is a source of
+  steady inspiration for Ramaze and brought me to Ruby in the first place.
+</pre>
+</li>
+<li>Rob Levin a.k.a. lilo
+
+<pre>
+  He founded the most excellent Freenode IRC-network, where the most important
+  channels for rubyists are located (as is #ramaze).
+  May he rest in peace.
+</pre>
+</li>
+<li>The guys (and gals) in the various channels on Freenode
+
+<pre>
+  As the people are way too many to be listed, here the channels that i call
+  my online home.
+  All the people in there deserve special thanks for getting me hooked to Ruby
+  and providing their help in a friendly and patient manner.
+
+  * #nitro
+  * #ruby-de
+  * #ruby-lang
+  * #rubyforce
+</pre>
+</li>
+</ul>
+
+    </div>
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>