ramaze 0.1.3 → 0.1.4

data/doc/meta/announcement.txt

@@ -1,46 +1,59 @@
-This time we are proud to announce Version 0.1.3 of the Ramaze framework, a
+This time we are proud to announce Version 0.1.4 of the Ramaze framework, a
 light and modular open source web framework.
 
-Since the last release some polishing and improvments have been made, it seems
-like Ramaze is now mostly feature-complete.
+Since the last release hundreds of lines of documentation and specs have been
+written. Ramaze was ported to JRuby and received lots of special love regarding
+bugfixes and polishing the overall API.
 
 An extensive set of specs is covering almost every detail of the implementation
 and usage. It is developed by several people and already in production-use at
 some companies.
 
+Special (alphabetic) thanks go to:
+
+Aman 'tmm1' Gupta         - specs, Sass support
+Fabian Buch               - porting to JRuby
+Gabriele 'riffraff' Renzi - specs, documentation, cleanup
+Jonathan 'Kashia' Buch    - documentation
+Riku Räisänen             - extensive testing
+
 
 Home page: http://ramaze.rubyforge.org
 IRC: #ramaze on irc.freenode.net
 
 
-Short summary of changes from 0.1.2 to 0.1.3:
+Short summary of changes from 0.1.3 to 0.1.4:
+
+  - Even better error handling.
+
+  - Many bugs fixed.
 
-  - Better error handling
+  - Support for Sass CSS templates.
 
-  - Many bugs fixed
+  - Layouts for actions.
 
-  - Some speedup
+  - Close to 100% documented methods/classes/methods.
 
-  - Lots of docs added
+  - Primitive filebased action-cache.
 
-  - Smoother sourcereload
+  - Runs on JRuby.
 
-  - New Wiki example
+  - Easier integration of ramazes spec-helpers for your own applications.
 
-  - jQuery 1.1.3.1
+  - Dirlisting functionality.
 
 
-A complete Changelog is available at http://manveru.mine.nu/ramaze/doc/CHANGELOG
+A complete Changelog is available at http://manveru.net/ramaze/doc/CHANGELOG
 
 
 Known issues:
 
-  - Haml: either use Haml version 1.5.2 or require ActionPack.
+  - none yet, waiting for your reports :)
 
 
 Features:
-  - Builds on top of the recently released Rack library, which provides easy use
-    of adapters like Mongrel, WEBrick, CGI or FCGI.
+  - Builds on top of the Rack library, which provides easy use of adapters like
+    Mongrel, WEBrick, CGI or FCGI.
 
   - Supports a wide range of templating-engines like:
       Amrita2, Erubis, Haml, Liquid, Markaby, Remarkably and its own engine

data/doc/meta/configuration.txt

@@ -110,9 +110,9 @@ cache consists of the controller and parameters, when repeated requests are
 made it will always serve the same (now static) page.
 
 
-:cookies => true
+:sessions => true
 
-Enables sending cookies by setting this to false.
+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`
@@ -156,7 +156,7 @@ 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 main.rb)
+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`

data/doc/meta/internals.txt

@@ -45,10 +45,10 @@ this path. In our example the file found is a favicon.ico from
 Global.public_proto.
 
 The contents of FILTER have to return a Ramaze::Response, either the (possibly
-modified) original (Dispatcher::build_response helps with that) or a totally new
+modified) original (Response#build helps with that) or a totally new
 one.
 
-In our case, Dispatcher::File uses build_response with an opened filehandler as
+In our case, Dispatcher::File uses response#build with an opened filehandler as
 body, '200 OK' as status and the Content-Type set to what Tool::MIME.type_for
 tells it is the correct mimetype for this file.
 

data/doc/meta/users.kml

@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<kml xmlns="http://earth.google.com/kml/2.1">
+  <Placemark>
+    <name>manveru</name>
+    <description><![CDATA[ <img src="http://manveru.mine.nu/public/me.png" /><br />
+          Tokyo, Japan ]]>
+      </description>
+    <Point>
+      <coordinates>139.667846,35.614759</coordinates>
+    </Point>
+  </Placemark>
+  <Placemark>
+    <name>Pistos</name>
+    <description>
+    <![CDATA[
+        <img src="http://purepistos.net/favicon32.png" alt="Pistos" /><br />
+        Toronto, Canada<br />
+        <a href="http://blog.purepistos.net">blog.purepistos.net</a>
+    ]]>
+    </description>
+    <Point>
+      <coordinates>-79.386985,43.642515,0</coordinates>
+    </Point>
+  </Placemark>
+  <Placemark>
+    <name>MonoDelDiablo</name>
+    <description><![CDATA[ Seattle, Washington, United States ]]></description>
+    <Point>
+      <coordinates>-122.266881,47.682765,0</coordinates>
+    </Point>
+  </Placemark>
+  <Placemark>
+    <name>Kashia</name>
+    <description><![CDATA[ Helsinki, Etela-Suomen Laani, Finland ]]></description>
+    <Point>
+      <coordinates>8.447204,49.028928,0</coordinates>
+    </Point>
+  </Placemark>
+  <Placemark>
+    <name>zenix</name>
+    <description><![CDATA[ Gaithersburg, Maryland, United States ]]></description>
+    <Point>
+      <coordinates>-77.183338,39.137049,0</coordinates>
+    </Point>
+  </Placemark>
+  <Placemark>
+    <name>tmm1</name>
+    <description><![CDATA[ <img src="http://tmm1.net/me.jpg" /><br />
+          Boston, Massachussetts ]]>
+      </description>
+    <Point>
+      <coordinates>-71.084371,42.365975,0</coordinates>
+    </Point>
+  </Placemark>
+  <Placemark>
+  	<name>riffraff</name>
+  	<description><![CDATA[ Rome, Italia ]]></description>
+  	<Point>
+  		<coordinates>41.993372,12.087193,0</coordinates>
+  	</Point>
+  </Placemark>
+</kml>

data/doc/readme_chunks/examples.txt

@@ -10,7 +10,7 @@ Or:
   $ cd examples/blog
   $ ramaze
 
-Since ramaze uses the main.rb by default if you don't pass anything else.
+Since ramaze uses the start.rb by default if you don't pass anything else.
 
 For more information about the usage of ramaze try:
 

data/doc/readme_chunks/features.txt

@@ -55,6 +55,11 @@ Ramaze offers following features at the moment:
 
     Markaby means Markup as Ruby.
 
+  * [Sass](http://haml.hamptoncatlin.com/docs/sass)
+
+    Sass is a meta-language on top of CSS that‘s used to describe the style of
+    a document cleanly and structurally, with more power than flat CSS allows. 
+
   * Ezamar
 
     A simple homage to [Nitro](http://nitroproject.org)s templating, is shipped
@@ -101,14 +106,6 @@ Ramaze offers following features at the moment:
 
       Easy caching Actions and values.
 
-    * Feed
-
-      Programmatically generate feeds from any Class.
-
-    * Form
-
-      In development, help appreciated.
-
     * Identity
 
       For ease of use of the OpenID authentication mechanism.
@@ -131,6 +128,14 @@ Ramaze offers following features at the moment:
 
       Authentication via OpenID made easy.
 
+    * Pager
+
+      Displays a collection of entitities in multiple pages.
+
+    * Partial
+
+      Renders so-called partials.
+
     * Stack
 
       Allows you to use a call/answer mechanism for things like redirection to the

data/doc/tutorial/todolist.html

@@ -617,7 +617,7 @@ options, since they are bound to change over time.</p>
 
 <p>First of all, the default port Ramaze runs on is 7000, but to make it a usual
 webserver it has to run on port 80.  So, let's add following line in your
-main.rb right after the lines of require you added before:</p>
+start.rb right after the lines of require you added before:</p>
 
 <pre><code>Ramaze::Global.port = 80
 </code></pre>
@@ -645,7 +645,7 @@ options, which is either using flags on the ramaze executable, or like this:</p>
 </code></pre>
 
 <p>We haven't started Ramaze directly as of yet, but this allows you to ignore the
-ramaze executable and just run your application by <code>ruby main.rb</code>.</p>
+ramaze executable and just run your application by <code>ruby start.rb</code>.</p>
 
 <a name="Eleventh_Step,_Refactor_with_AspectHelper"><h2>Eleventh Step, Refactor with AspectHelper</h2></a>
 

data/doc/tutorial/todolist.mkd

@@ -549,7 +549,7 @@ options, since they are bound to change over time.
 
 First of all, the default port Ramaze runs on is 7000, but to make it a usual
 webserver it has to run on port 80.  So, let's add following line in your
-main.rb right after the lines of require you added before:
+start.rb right after the lines of require you added before:
 
     Ramaze::Global.port = 80
 
@@ -573,7 +573,7 @@ options, which is either using flags on the ramaze executable, or like this:
     Ramaze.start :port => 80, :adapter => :mongrel
 
 We haven't started Ramaze directly as of yet, but this allows you to ignore the
-ramaze executable and just run your application by `ruby main.rb`.
+ramaze executable and just run your application by `ruby start.rb`.
 
 
 ## Eleventh Step, Refactor with AspectHelper

data/examples/blog/README

@@ -0,0 +1,3 @@
+a simple blog engine which uses Og as the persistence layer.
+Og uses sqlite as the default DBMS engine and will create the database 
+automatically on startup.

data/examples/blog/spec/blog.rb

@@ -0,0 +1,101 @@
+require 'ramaze/spec/helper'
+
+# if these libraries are missing there is no sense in running the tests,
+# cause they won't work at all. 
+testcase_requires 'og'
+testcase_requires 'hpricot'
+
+# Og sets this in the global namespace and uses the STDERR to write messages
+# We can replace it with Ramaze's logger that does The Right Thing (TM)
+class Logger
+  @@global_logger = Ramaze::Inform
+end
+$:.unshift 'examples/blog'
+require 'start'
+
+# fix the paths to template and public for the spec
+# this is not needed usually, but this tests are also part of ramaze's suite
+class MainController
+  template_root __DIR__ / '../template'
+end
+
+describe 'blog' do
+
+  def check_page(name)
+    page = get('/'+name)
+    page.status.should == 200
+    page.body.should_not be_nil
+
+    doc = Hpricot(page.body)
+    doc.at('title').inner_html.should == 'bl_Og'
+    doc.at('h1').inner_html.should == 'bl_Og'
+
+    doc.search('div#entries').length.should == 1
+
+    doc
+  end
+
+  it 'should start' do
+    ramaze :public_root => 'examples/blog/public', :port => 7001
+    get('/').status.should == 200
+  end
+
+  it 'should have main page' do
+    doc = check_page('')
+    doc.at('div#actions>a').inner_html.should == 'new entry'
+    doc.search('div.entry').length.should == 1
+  end
+
+  it 'should have new entry page' do
+    doc = check_page('new')
+    form = doc.at('div.entry>form')
+    form.at('input[@name=title]')['value'].should == ''
+    form.at('textarea').inner_html.should == ''
+    form.at('input[@type=submit]')['value'].should == 'Add Entry'
+  end
+
+  def create_page(title,content)
+    page = post('/create','title'=>title,'content'=>content)
+    page.status.should == 303
+    page.location.should == '/'
+  end
+  
+  it 'should add new pages' do
+    create_page('new page', 'cool! a new page')
+    doc = check_page('')
+    entry = doc.search('div.entry')
+    entry.length.should == 2
+    entry = entry.last
+
+    entry.at('div.title').inner_html == 'new page'
+    entry.at('div.content').inner_html == 'cool! a new page'
+  end
+
+  it 'should edit existing pages' do
+    create_page('new page', 'cool! a new page')
+    post('/save','oid'=>'2','title'=>'new title','content'=>'bla bla')
+    doc = check_page('')
+    entry = doc.search('div.entry')
+    entry.length.should == 2
+    entry = entry.first
+
+    entry.at('div.title').inner_html == 'new title'
+    entry.at('div.content').inner_html == 'bla bla'
+  end
+
+  it 'should delete existing pages' do
+    create_page("page to delete", 'content')
+    check_page('').search('div.entry').length.should == 2
+    page = get('/delete/2')
+    page.status.should == 303
+    page.location.should == '/'
+    check_page('').search('div.entry').length.should == 1
+  end
+
+  after do
+    Entry.all.each do |e|
+      e.delete unless e.oid == 1
+    end
+  end
+
+end

data/examples/caching.rb

@@ -7,14 +7,25 @@ class MainController < Controller
   helper :cache
   trait :actions_cached => [:index]
 
-  def index(n1 = 100_000, n2 = 100_00)
-    %[
-Hello, i'm a little method with this calculation:
-#{n1} ** #{n2} = #{n1.to_i ** n2.to_i}
-    ].strip
+  def index
+%[
+<html>
+  <head><title>examples/caching</title></head>
+  <body>
+    <p>
+      This action just shows you a random number: #{rand * 100}.<br />
+      If you <a href="/">refresh</a> the page it won't change since you see a cached version.<br />
+      But if you <a href="/invalidate">invalidate</a> it, the page will be regenerated.
+    </p>
+  </body>
+</html>
+]
   end
 
   def invalidate
     action_cache.clear
+    redirect :/
   end
 end
+
+Ramaze.start

data/examples/layout.rb

@@ -0,0 +1,41 @@
+require 'ramaze'
+include Ramaze
+
+class SideBar < Ezamar::Element
+  def render
+    %{
+     <div class="sidebar">
+       <a href="http://something.com">something</a>
+     </div>
+     }
+  end
+end
+
+class MainController < Controller
+  map '/'
+  layout :page
+
+  def index
+    @title = "Test"
+    %{
+    <SideBar />
+    <p>Hello, World!</p>
+    }
+  end
+
+  def page
+    %{
+<html>
+  <head>
+    <title>examples/element</title>
+  </head>
+  <body>
+    <h1>#@title</h1>
+    #@content
+  </body>
+</html>
+    }
+  end
+end
+
+Ramaze.start