doc/rdoc/files/README.html in Capcode-0.4.0 vs doc/rdoc/files/README.html in Capcode-0.5.0
- old
+ new
@@ -67,10 +67,11 @@
<a href="http://greg.rubyfr.net">nil</a>].each do<br />
<a href="../classes/Capcode.html" title="Module: Capcode">Capcode</a>.view_html<br />
<a href="../classes/Capcode/Views.html" title="Module: Capcode::Views">Capcode::Views</a>.view_html<br />
<a href="../classes/Capcode/Helpers.html" title="Module: Capcode::Helpers">Capcode::Helpers</a>.view_html<br />
<a href="../classes/Capcode/HTTPError.html" title="Class: Capcode::HTTPError">Capcode::HTTPError</a>.view_html<br />
+<a href="../classes/Capcode/RenderError.html" title="Class: Capcode::RenderError">Capcode::RenderError</a>.view_html<br />
<a href="../classes/Capcode/RouteError.html" title="Class: Capcode::RouteError">Capcode::RouteError</a>.view_html<br />
<a href="../classes/Capcode/ParameterError.html" title="Class: Capcode::ParameterError">Capcode::ParameterError</a>.view_html<br />
end</strong>
</td></tr>
</table>
@@ -78,11 +79,11 @@
</div>
<div id="README" class="page_shade">
<div class="page">
<div class="header">
- <div class="path">README / Thu Apr 30 07:34:27 +0200 2009</div>
+ <div class="path">README / Thu May 07 15:41:00 +0200 2009</div>
</div>
<h1><a href="../classes/Capcode.html">Capcode</a></h1>
<p>
Copyright (C) 2009 Gregoire Lejeune
@@ -95,10 +96,19 @@
<h2>DESCRIPTION:</h2>
<p>
<a href="../classes/Capcode.html">Capcode</a> is a web microframework
</p>
<h2>FEATURES/PROBLEMS:</h2>
+<h3>0.5.0</h3>
+<ul>
+<li>Add Haml and Markaby renderer
+
+</li>
+<li>json is deprecated and replaced by render( :json => … )
+
+</li>
+</ul>
<h3>0.4.0</h3>
<ul>
<li>Major bug correction !
</li>
@@ -133,23 +143,23 @@
</li>
</ul>
<h2>SYNOPSIS:</h2>
<pre>
- # file: sample.rb
- require 'rubygems'
- require 'capcode'
+ # file: sample.rb
+ require 'rubygems'
+ require 'capcode'
- module Capcode
- class Hello < Route '/hello'
- def get
- "Hello World #{Time.now} !"
- end
- end
- end
+ module Capcode
+ class Hello < Route '/hello'
+ def get
+ "Hello World #{Time.now} !"
+ end
+ end
+ end
- Capcode.run( )
+ Capcode.run( )
</pre>
<h3>Running <a href="../classes/Capcode.html">Capcode</a> Apps</h3>
<ul>
<li>Run: <tt>ruby sample.rb</tt>
@@ -158,73 +168,149 @@
</li>
</ul>
<h3>Create model</h3>
<pre>
- require 'rubygems'
- require 'capcode'
- require 'capcode/base/dm' # or require 'capcode/base/couchdb'
+ require 'rubygems'
+ require 'capcode'
+ require 'capcode/base/dm' # or require 'capcode/base/couchdb'
- class Story < Capcode::Base
- include Capcode::Resource
+ class Story < Capcode::Base
+ include Capcode::Resource
- property :id, Integer, :serial => true # only with DataMapper !
- property :title, String
- property :body, String
- property :date, String
- end
+ property :id, Integer, :serial => true # only with DataMapper !
+ property :title, String
+ property :body, String
+ property :date, String
+ end
</pre>
<p>
See <tt>examples/blog-dm.rb</tt> and/or <tt>examples/blog-couchdb.rb</tt>
for complete examples.
</p>
<h3>Create View</h3>
<pre>
+ # file: sample.rb
+ require 'rubygems'
+ require 'capcode'
+
+ module Capcode
+ class Hello < Route '/hello'
+ def get
+ @t = Time.now
+ render :time
+ end
+ end
+ end
+
+ module Capcode::Views
+ def time
+ "Hello world #{@t}"
+ end
+ end
+
+ Capcode.run( )
+</pre>
+<h3>Create Helper</h3>
+<pre>
+ # file: sample.rb
+ require 'rubygems'
+ require 'capcode'
+
+ module Capcode
+ class Hello < Route '/hello'
+ def get
+ @t = Time.now
+ render :time
+ end
+ end
+ end
+
+ module Capcode::Helpers
+ def bold( &b )
+ "<b>"+yield+"</b>"
+ end
+ end
+
+ module Capcode::Views
+ def time
+ "Hello world " + bold { @t }
+ end
+ end
+
+ Capcode.run( )
+</pre>
+<h3>Render with Markaby</h3>
+<pre>
+ # file: sample.rb
+ require 'rubygems'
+ require 'capcode'
+ require 'capcode/render/markaby'
+
+ module Capcode
+ class Hello < Route '/hello'
+ def get
+ @t = Time.now
+ render :markaby => :time
+ end
+ end
+ end
+
+ module Capcode::Views
+ def time
+ # We use Markaby in Capcode::Views.time
+ html do
+ body do
+ p {
+ text "Hello World "
+ b @t
+ }
+ end
+ end
+ end
+ end
+
+ Capcode.run( )
+</pre>
+<h3>Render with Haml</h3>
+<pre>
# file: sample.rb
require 'rubygems'
require 'capcode'
+ require 'capcode/render/haml'
+ Capcode::Helpers.haml_path = "./my_haml_views"
module Capcode
class Hello < Route '/hello'
def get
@t = Time.now
- render :time
+ render :haml => :time
end
end
end
- module Capcode::Views
- def time
- "Hello world #{@t}"
- end
- end
-
Capcode.run( )
+
+ # ./my_haml_views/time.haml
+ %html
+ %body
+ %p
+ Hello World
+ = @t
</pre>
-<h3>Create Helper</h3>
+<h3>Render with JSON</h3>
<pre>
# file: sample.rb
require 'rubygems'
require 'capcode'
+ require 'capcode/render/json'
module Capcode
class Hello < Route '/hello'
def get
@t = Time.now
- render :time
+ render :json => { :time => @t }
end
- end
- end
-
- module Capcode::Helpers
- def bold( &b )
- "<b>"+yield+"</b>"
- end
- end
-
- module Capcode::Views
- def time
- "Hello world " + bold { @t }
end
end
Capcode.run( )
</pre>
\ No newline at end of file