Capcode 0.8.2 → 0.8.4

data/{README → README.rdoc}

@@ -2,7 +2,9 @@
 
 Copyright (C) 2009 Gregoire Lejeune
 
-* http://capcode.rubyforge.org
+* home : http://capcode.rubyforge.org
+* doc : http://rdoc.info/projects/glejeune/Capcode
+* book (fr) : http://www.algorithmique.net/capcode/
   
 == DESCRIPTION: 
 
@@ -10,6 +12,15 @@ Capcode is a web microframework
 
 == FEATURES/PROBLEMS:
 
+=== 0.8.4
+* Major (really MAJOR) bugs corrections in renderers
+* Add many renderer' examples
+* The static rendere now accept a new option : :exact_path. If :exact_path is set to true, the static rendere redirect you to the exact static url of the file. Else it just give the content of the file. Default is true. (see example render-static.rb) 
+* redirect now accept an optional HTTP status code as first parameter
+
+=== 0.8.3
+* Add PUT and DELETE actions (see rest example)
+
 === 0.8.2
 * Add XML renderer (see rss example)
 * Major bug corrections

data/examples/haml/cf_layout.haml

@@ -1,5 +1,6 @@
 %html
   %head
     = yield :header
+    %link{ :rel => "stylesheet", :href => "/style.css", :type => "text/css" }
   %body
     = yield :content

data/examples/haml/style.sass

@@ -0,0 +1,2 @@
+p
+  background-color: red

data/examples/render-erb.rb

@@ -0,0 +1,14 @@
+$:.unshift( "../lib" )
+require 'capcode'
+require 'capcode/render/erb'
+Capcode::Helpers.erb_path="erb"
+
+module Capcode
+  class Index < Route '/'
+    def get
+      render :erb => :cf, :layout => :cf_layout
+    end
+  end  
+end
+
+Capcode.run( )

data/examples/render-haml_sass.rb

@@ -0,0 +1,22 @@
+$:.unshift( "../lib" )
+require 'capcode'
+require 'capcode/render/haml'
+require 'capcode/render/sass'
+Capcode::Helpers.haml_path="haml"
+Capcode::Helpers.sass_path="haml"
+
+module Capcode
+  class Index < Route '/'
+    def get
+      render :haml => :cf, :layout => :cf_layout
+    end
+  end
+  
+  class CSS < Route '/style.css'
+    def get
+      render :sass => :style
+    end
+  end
+end
+
+Capcode.run( )

data/examples/render-json.rb

@@ -0,0 +1,13 @@
+$:.unshift( "../lib" )
+require 'capcode'
+require 'capcode/render/json'
+
+module Capcode
+  class Index < Route '/'
+    def get
+      render :json => { :hello => "Hello World", :values => [1, 2, 3] }
+    end
+  end  
+end
+
+Capcode.run( )

data/examples/render-markaby.rb

@@ -0,0 +1,27 @@
+$:.unshift( "../lib" )
+require 'capcode'
+require 'capcode/render/markaby'
+
+module Capcode
+  class Index < Route '/'
+    def get
+      render :markaby => :index
+    end
+  end  
+end
+
+module Capcode::Views
+  def glop
+    html do
+      body do
+        yield
+      end
+    end
+  end
+  
+  def index
+    h1 "Hello !"
+  end
+end
+
+Capcode.run( )

data/examples/render-static.rb

@@ -0,0 +1,18 @@
+$:.unshift( "../lib" )
+require 'capcode'
+require 'capcode/render/static'
+
+module Capcode
+  class Index < Route '/'
+    def get
+      render :static => "index.html"
+    end
+  end  
+  class Path < Route '/path'
+    def get
+      render :static => "index.html", :exact_path => false
+    end
+  end  
+end
+
+Capcode.run( :static => "static" )

data/examples/render-text.rb

@@ -0,0 +1,12 @@
+$:.unshift( "../lib" )
+require 'capcode'
+
+module Capcode
+  class Index < Route '/'
+    def get
+      render "Hello World"
+    end
+  end  
+end
+
+Capcode.run( )

data/examples/render-xml.rb

@@ -0,0 +1,24 @@
+$:.unshift( "../lib" )
+require 'capcode'
+require 'capcode/render/xml'
+
+module Capcode
+  class Index < Route '/'
+    def get
+      render :xml => :index
+    end
+  end  
+end
+
+module Capcode::Views
+  def index
+    xml? :version => '1.0'
+    html do
+      body do
+        h1 "Hello XML !"
+      end
+    end
+  end
+end
+
+Capcode.run( )

data/examples/rest.rb

@@ -0,0 +1,77 @@
+$:.unshift( "../lib" )
+require 'capcode'
+require 'capcode/render/markaby'
+
+module Capcode
+  class Index < Route '/'
+    def get
+      render :markaby => :index, :layout => :forms
+    end
+  end
+  
+  class Action < Route "/action"
+    def get( )
+      @method = env["REQUEST_METHOD"]
+      @data = params["data"]
+      render :markaby => :action, :layout => :forms
+    end
+   
+    alias_method :post, :get
+    
+    def delete
+      @method = "DELETE"
+      @data = params["data"]
+      render :markaby => :action, :layout => :forms
+    end
+    
+    def put
+      @method = "PUT"
+      @data = params["data"]
+      render :markaby => :action, :layout => :forms
+    end
+    
+  end
+end
+
+module Capcode::Views
+  def forms
+    html do
+      body do
+        yield
+        
+        form :method => "GET", :action => URL(Capcode::Action) do
+          input :type => "text", :name => "data";
+          input :type => "submit", :value => "GET"
+        end
+        
+        form :method => "POST", :action => URL(Capcode::Action) do
+          input :type => "text", :name => "data";
+          input :type => "submit", :value => "POST"
+        end
+
+        form :method => "POST", :action => URL(Capcode::Action) do
+          input :type => "hidden", :name => "_method", :value => "delete" ## <-- You need this 
+          input :type => "text", :name => "data";
+          input :type => "submit", :value => "DELETE"
+        end
+
+        form :method => "POST", :action => URL(Capcode::Action) do
+          input :type => "hidden", :name => "_method", :value => "put" ## <-- You need this 
+          input :type => "text", :name => "data";
+          input :type => "submit", :value => "PUT"
+        end
+      end
+    end
+  end
+  
+  def index
+    h1 "Hello !"
+  end
+  
+  def action
+    text "You send "; b @data; text " using a "; b @method; text " method!"; br
+  end
+  
+end
+
+Capcode.run( )

data/examples/upload.rb

@@ -1,4 +1,4 @@
-require 'rubygems'
+$:.unshift( "../lib" )
 require 'capcode'
 require 'capcode/render/markaby'
 require 'capcode/render/static'
@@ -34,6 +34,6 @@ module Capcode::Views
   end
 end
 
-FileUtils.mkdir_p 'data'
-
-Capcode.run( :static => "data" )
+Capcode.run( :static => "data" ) {
+  FileUtils.mkdir_p 'data'
+}

data/lib/capcode.rb

@@ -19,15 +19,17 @@ module Capcode
   #   @@__FILTERS << opts
   # end
   
-  class ParameterError < ArgumentError #:nodoc:
+  
+  class ParameterError < ArgumentError #:nodoc: all
   end
   
-  class RouteError < ArgumentError #:nodoc:
+  class RouteError < ArgumentError #:nodoc: all
   end
   
-  class RenderError < ArgumentError
+  class RenderError < ArgumentError #:nodoc: all
   end
   
+  # Views is an empty module in which you can store your markaby or xml views.
   module Views; end
   
   # Helpers contains methods available in your controllers
@@ -43,38 +45,45 @@ module Capcode
     # 
     # * :markaby => :my_func : :my_func must be defined in Capcode::Views
     # * :erb => :my_erb_file : this suppose that's my_erb_file.rhtml exist in erb_path
-    # * :haml => :my_haml_file : this suppose that's my_haml_file.rhtml exist in haml_path
+    # * :haml => :my_haml_file : this suppose that's my_haml_file.haml exist in haml_path
+    # * :sass => :my_sass_file : this suppose that's my_sass_file.sass exist in sass_path
     # * :text => "my text"
     # * :json => MyObject : this suppose that's MyObject respond to .to_json
+    # * :static => "my_file.xxx" : this suppose that's my_file.xxx exist in the static directory
+    # * :xml => :my_func : :my_func must be defined in Capcode::Views
     #
     # If you want to use a specific layout, you can specify it with option 
     #   :layout
-    def render( h )
-      if h.class == Hash
+    def render( hash )
+      if hash.class == Hash
         render_type = nil
         
-        h.keys.each do |k|
-          if self.respond_to?("render_#{k.to_s}")
+        hash.keys.each do |key|
+          if self.respond_to?("render_#{key.to_s}")
             unless render_type.nil?
-              raise Capcode::RenderError, "Can't use multiple renderer (`#{render_type}' and `#{k}') !", caller
+              raise Capcode::RenderError, "Can't use multiple renderer (`#{render_type}' and `#{key}') !", caller
             end
-            render_type = k
+            render_type = key
           end
         end
-
+        
         if render_type.nil?
           raise Capcode::RenderError, "Renderer type not specified!", caller
         end
 
-        render_name = h.delete(render_type)
+        unless self.respond_to?("render_#{render_type.to_s}")
+          raise Capcode::RenderError, "#{render_type} renderer not present ! please require 'capcode/render/#{render_type}'", caller
+        end
+
+        render_name = hash.delete(render_type)
 
         begin
-          self.send( "render_#{render_type.to_s}", render_name, h )
+          self.send( "render_#{render_type.to_s}", render_name, hash )
         rescue => e
           raise Capcode::RenderError, "Error rendering `#{render_type.to_s}' : #{e.message}", caller
         end
       else
-        render( :text => h )
+        render( :text => hash )
       end
     end
     
@@ -87,6 +96,8 @@ module Capcode
     #       end
     #     end
     #   end
+    #
+    # <b>DEPRECATED</b>, please use <tt>render( :json => o )</tt>
     def json( d ) ## DELETE THIS IN 1.0.0
       warn( "json is deprecated, please use `render( :json => ... )'" )
       @response['Content-Type'] = 'application/json'
@@ -106,8 +117,29 @@ module Capcode
     #       end
     #     end    
     #   end
+    #
+    # The first parameter can be a controller class name
+    #
+    #   redirect( MyController )
+    #
+    # it can be a string path
+    #
+    #   redirect( "/path/to/my/resource" )
+    #
+    # it can be an http status code (by default <tt>redirect</tt> use the http status code 302)
+    #
+    #   redirect( 304, MyController )
+    # 
+    # For more informations about HTTP status, see http://en.wikipedia.org/wiki/List_of_HTTP_status_codes#3xx_Redirection
     def redirect( klass, *a )
-      [302, {'Location' => URL(klass, *a)}, '']
+      httpCode = 302
+
+      if( klass.class == Fixnum )
+        httpCode = klass
+        klass = a.shift
+      end
+
+      [httpCode, {'Location' => URL(klass, *a)}, '']
     end
     
     # Builds an URL route to a controller or a path
@@ -122,7 +154,7 @@ module Capcode
     # 
     # then
     # 
-    #   URL( Hello, "you" ) # => /hello/you
+    #   URL( Capcode::Hello, "you" ) # => /hello/you
     def URL( klass, *a )
       path = nil
       a = a.delete_if{ |x| x.nil? }
@@ -139,6 +171,37 @@ module Capcode
     end
     
     # Calling content_for stores a block of markup in an identifier.
+    #
+    #   module Capcode
+    #     class ContentFor < Route '/'
+    #       def get
+    #         render( :markaby => :page, :layout => :layout )
+    #       end
+    #     end
+    #   end
+    #
+    #   module Capcode::Views
+    #     def layout
+    #       html do
+    #         head do
+    #           yield :header
+    #         end
+    #         body do
+    #           yield :content
+    #         end
+    #       end
+    #     end
+    #   
+    #     def page
+    #       content_for :header do
+    #         title "This is the title!"
+    #       end
+    #   
+    #       content_for :content do
+    #         p "this is the content!"
+    #       end
+    #     end
+    #   end
     def content_for( x )
       if @@__ARGS__.map{|_| _.to_s }.include?(x.to_s)
         yield
@@ -146,6 +209,9 @@ module Capcode
     end
     
     # Return information about the static directory
+    # 
+    # * <tt>static[:uri]</tt> give the static URI
+    # * <tt>static[:path]</tt> give the path to the static directory on the server
     def static
       { 
         :uri => Capcode.static,
@@ -171,7 +237,7 @@ module Capcode
   #
   # Do the same (r500, r501, r403) to customize 500, 501, 403 errors
   class HTTPError
-    def initialize(app)#:nodoc:
+    def initialize(app) #:nodoc:
       @app = app
     end
 
@@ -207,29 +273,36 @@ module Capcode
     # be set to <tt>you</tt> and <tt>arg2</tt> will be set to <tt>nil</tt>
     # 
     # If the regexp in the route does not match, all arguments will be <tt>nil</tt>
-    def Route *u
+    def Route *routes_paths
       Class.new {
-        meta_def(:__urls__){
-          # < Route '/hello/world/([^\/]*)/id(\d*)', '/hello/(.*)'
-          # # => [ {'/hello/world' => '([^\/]*)/id(\d*)', '/hello' => '(.*)'}, 2, <Capcode::Klass> ]
-          h = {}
-          max = 0
-          u.each do |_u|
-            m = /\/([^\/]*\(.*)/.match( _u )
-            if m.nil?
-              raise Capcode::RouteError, "Route `#{_u}' already defined with regexp `#{h[_u]}' !", caller if h.keys.include?(_u)
-              h[_u] = ''
+        meta_def(:__urls__) {
+          # < Route '/hello/world/([^\/]*)/id(\d*)', '/hello/(.*)', :agent => /Songbird (\d\.\d)[\d\/]*?/
+          # # => [ {'/hello/world' => '([^\/]*)/id(\d*)', '/hello' => '(.*)'}, 
+          #        2, 
+          #        <Capcode::Klass>, 
+          #        {:agent => /Songbird (\d\.\d)[\d\/]*?/} ]
+          hash_of_routes = {}
+          max_captures_for_routes = 0
+          routes_paths.each do |current_route_path|
+            if current_route_path.class == String
+              m = /\/([^\/]*\(.*)/.match( current_route_path )
+              if m.nil?
+                raise Capcode::RouteError, "Route `#{current_route_path}' already defined with regexp `#{hash_of_routes[current_route_path]}' !", caller if hash_of_routes.keys.include?(current_route_path)
+                hash_of_routes[current_route_path] = ''
+              else
+                _pre = m.pre_match
+                _pre = "/" if _pre.size == 0
+                raise Capcode::RouteError, "Route `#{_pre}' already defined with regexp `#{hash_of_routes[_pre]}' !", caller if hash_of_routes.keys.include?(_pre)
+                hash_of_routes[_pre] = m.captures[0]
+                max_captures_for_routes = Regexp.new(m.captures[0]).number_of_captures if max_captures_for_routes < Regexp.new(m.captures[0]).number_of_captures
+              end
             else
-              _pre = m.pre_match
-              _pre = "/" if _pre.size == 0
-              raise Capcode::RouteError, "Route `#{_pre}' already defined with regexp `#{h[_pre]}' !", caller if h.keys.include?(_pre)
-              h[_pre] = m.captures[0]
-              max = Regexp.new(m.captures[0]).number_of_captures if max < Regexp.new(m.captures[0]).number_of_captures
+              raise Capcode::ParameterError, "Bad route declaration !", caller
             end
           end
-          [h, max, self]
+          [hash_of_routes, max_captures_for_routes, self]
         }
-
+                
         # Hash containing all the request parameters (GET or POST)
         def params
           @request.params
@@ -240,7 +313,7 @@ module Capcode
           @env
         end
         
-        # Hash session
+        # Session hash
         def session
           @env['rack.session']
         end
@@ -311,7 +384,8 @@ module Capcode
                     
               get( *args )
             when "POST"
-              post
+              _method = params.delete( "_method" ) { |_| "post" }
+              send( _method.downcase.to_sym )
           end
           if r.respond_to?(:to_ary)
             @response.status = r[0]
@@ -336,8 +410,8 @@ module Capcode
     #   Capcode.map( "/file" ) do
     #     Rack::File.new( "." )
     #   end
-    def map( r, &b )
-      @@__ROUTES[r] = yield
+    def map( route, &b )
+      @@__ROUTES[route] = yield
     end
   
     # Start your application.
@@ -438,10 +512,10 @@ module Capcode
         Capcode.constants.each do |k|
           begin
             if eval "Capcode::#{k}.public_methods(true).include?( '__urls__' )"
-              u, m, c = eval "Capcode::#{k}.__urls__"
-              u.keys.each do |_u|
-                raise Capcode::RouteError, "Route `#{_u}' already define !", caller if @@__ROUTES.keys.include?(_u)
-                @@__ROUTES[_u] = c.new
+              hash_of_routes, max_captures_for_routes, klass = eval "Capcode::#{k}.__urls__"
+              hash_of_routes.keys.each do |current_route_path|
+                raise Capcode::RouteError, "Route `#{current_route_path}' already define !", caller if @@__ROUTES.keys.include?(current_route_path)
+                @@__ROUTES[current_route_path] = klass.new
               end
             end
           rescue => e
@@ -530,6 +604,6 @@ module Capcode
     
     def static #:nodoc:
       @@__STATIC_DIR
-    end
+    end    
   end
 end