Capcode 0.8.6 → 0.8.7

data/lib/capcode.rb

@@ -1,3 +1,5 @@
+# Please read the README.rdoc file !
+
 require 'rubygems'
 require 'rack'
 require 'json' ## DELETE THIS IN 1.0.0
@@ -9,11 +11,12 @@ require 'capcode/version'
 require 'capcode/core_ext'
 require 'capcode/helpers/auth'
 require 'capcode/render/text'
+require 'capcode/configuration'
 
 module Capcode
-  @@__ROUTES = {}
-  @@__STATIC_DIR = nil
-  @@__APP = nil
+  #@@__ROUTES = {}
+  #@@__STATIC_DIR = nil
+  #@@__APP = nil
   
   # @@__FILTERS = []
   # def self.before_filter( opts, &b )
@@ -36,7 +39,13 @@ module Capcode
   
   # Helpers contains methods available in your controllers
   module Helpers
-    @@__ARGS__ = nil
+    #@@__ARGS__ = nil
+    def self.args
+      @args ||= nil
+    end
+    def self.args=(x)
+      @args = x
+    end
     
     # Render a view
     # 
@@ -58,6 +67,10 @@ module Capcode
     # If you want to use a specific layout, you can specify it with option 
     #   :layout
     #
+    # If you want to change the Content-Type, you can specify it with option
+    #   :content_type
+    # Note that this will not work with the JSON renderer
+    #
     # If you use the WebDav renderer, you can use the option 
     #   :resource_class (see http://github.com/georgi/rack_dav for more informations)
     def render( hash )
@@ -82,6 +95,10 @@ module Capcode
         end
 
         render_name = hash.delete(render_type)
+        content_type = hash.delete(:content_type)
+        unless content_type.nil?
+          @response['Content-Type'] = content_type
+        end
 
         begin
           self.send( "render_#{render_type.to_s}", render_name, hash )
@@ -105,7 +122,7 @@ module Capcode
     #
     # <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 => ... )'" )
+      warn( "json is deprecated and will be removed in version 1.0, please use `render( :json => ... )'" )
       @response['Content-Type'] = 'application/json'
       d.to_json
     end
@@ -209,7 +226,8 @@ module Capcode
     #     end
     #   end
     def content_for( x )
-      if @@__ARGS__.map{|_| _.to_s }.include?(x.to_s)
+      #if @@__ARGS__.map{|_| _.to_s }.include?(x.to_s)
+      if Capcode::Helpers.args.map{|_| _.to_s }.include?(x.to_s)
         yield
       end
     end
@@ -262,7 +280,7 @@ module Capcode
   end
     
   class << self
-    attr :__auth__, true
+    attr :__auth__, true #:nodoc:
     
     # Add routes to a controller class
     # 
@@ -382,47 +400,47 @@ module Capcode
               }
             end
 
-            case @env["REQUEST_METHOD"]
-              when "GET"
-                finalPath = nil
-                finalArgs = nil
-                finalNArgs = nil
-                
-                aPath = @request.path.gsub( /^\//, "" ).split( "/" )
-                self.class.__urls__[0].each do |p, r|
-                  xPath = p.gsub( /^\//, "" ).split( "/" )
-                  if (xPath - aPath).size == 0
-                    diffArgs = aPath - xPath
-                    diffNArgs = diffArgs.size
-                    if finalNArgs.nil? or finalNArgs > diffNArgs
-                      finalPath = p
-                      finalNArgs = diffNArgs
-                      finalArgs = diffArgs
-                    end
-                  end
-                  
-                end
+            finalPath = nil
+            finalArgs = nil
+            finalNArgs = nil
             
-                nargs = self.class.__urls__[1]
-                regexp = Regexp.new( self.class.__urls__[0][finalPath] )
-                args = regexp.match( Rack::Utils.unescape(@request.path).gsub( Regexp.new( "^#{finalPath}" ), "" ).gsub( /^\//, "" ) )
-                if args.nil?
-                  raise Capcode::ParameterError, "Path info `#{@request.path_info}' does not match route regexp `#{regexp.source}'"
-                else
-                  args = args.captures.map { |x| (x.size == 0)?nil:x }
+            aPath = @request.path.gsub( /^\//, "" ).split( "/" )
+            self.class.__urls__[0].each do |p, r|
+              xPath = p.gsub( /^\//, "" ).split( "/" )
+              if (xPath - aPath).size == 0
+                diffArgs = aPath - xPath
+                diffNArgs = diffArgs.size
+                if finalNArgs.nil? or finalNArgs > diffNArgs
+                  finalPath = p
+                  finalNArgs = diffNArgs
+                  finalArgs = diffArgs
                 end
-                
-                while args.size < nargs
-                  args << nil
-                end
-                      
+              end
+              
+            end
+        
+            nargs = self.class.__urls__[1]
+            regexp = Regexp.new( self.class.__urls__[0][finalPath] )
+            args = regexp.match( Rack::Utils.unescape(@request.path).gsub( Regexp.new( "^#{finalPath}" ), "" ).gsub( /^\//, "" ) )
+            if args.nil?
+              raise Capcode::ParameterError, "Path info `#{@request.path_info}' does not match route regexp `#{regexp.source}'"
+            else
+              args = args.captures.map { |x| (x.size == 0)?nil:x }
+            end
+            
+            while args.size < nargs
+              args << nil
+            end
+
+            case @env["REQUEST_METHOD"]
+              when "GET"                      
                 get( *args )
               when "POST"
                 _method = params.delete( "_method" ) { |_| "post" }
-                send( _method.downcase.to_sym )
+                send( _method.downcase.to_sym, *args )
               else
                 _method = @env["REQUEST_METHOD"]
-                send( _method.downcase.to_sym )
+                send( _method.downcase.to_sym, *args )
             end
           }
           if r.respond_to?(:to_ary)
@@ -450,7 +468,25 @@ module Capcode
     #     Rack::File.new( "." )
     #   end
     def map( route, &b )
-      @@__ROUTES[route] = yield
+      #@@__ROUTES[route] = yield
+      Capcode.routes[route] = yield
+    end
+    
+    # This method allow you to use a Rack middleware
+    #
+    # Example :
+    #
+    #   module Capcode
+    #     ...
+    #     use Rack::Codehighlighter, :coderay, :element => "pre", 
+    #       :pattern => /\A:::(\w+)\s*\n/, :logging => false
+    #     ...
+    #   end
+    def use(middleware, *args, &block)
+      middlewares << [middleware, args, block]
+    end
+    def middlewares #:nodoc:
+      @middlewares ||= []
     end
 
     # Allow you to add and HTTP Authentication (Basic or Digest) to controllers for or specific route
@@ -490,25 +526,26 @@ module Capcode
   
     def configuration( args = {} ) #:nodoc:
       {
-        :port => args[:port]||3000, 
-        :host => args[:host]||"0.0.0.0",
-        :server => args[:server]||nil,
-        :log => args[:log]||$stdout,
-        :session => args[:session]||{},
-        :pid => args[:pid]||"#{$0}.pid",
-        :daemonize => args[:daemonize]||false,
-        :db_config => File.expand_path(args[:db_config]||"database.yml"),
-        :static => args[:static]||nil,
-        :root => args[:root]||File.expand_path(File.dirname($0)),
-        :static => args[:static]||args[:root]||File.expand_path(File.dirname($0)),
-        :verbose => args[:verbose]||false,
+        :port => args[:port]||Capcode.get(:port)||3000, 
+        :host => args[:host]||Capcode.get(:host)||"0.0.0.0",
+        :server => args[:server]||Capcode.get(:server)||nil,
+        :log => args[:log]||Capcode.get(:log)||$stdout,
+        :session => args[:session]||Capcode.get(:session)||{},
+        :pid => args[:pid]||Capcode.get(:pid)||"#{$0}.pid",
+        :daemonize => args[:daemonize]||Capcode.get(:daemonize)||false,
+        :db_config => File.expand_path(args[:db_config]||Capcode.get(:db_config)||"database.yml"),
+        :root => args[:root]||Capcode.get(:root)||File.expand_path(File.dirname($0)),
+        :static => args[:static]||Capcode.get(:static)||args[:root]||File.expand_path(File.dirname($0)),
+        :verbose => args[:verbose]||Capcode.get(:verbose)||false,
         :console => false
       }
     end
     
     # Return the Rack App.
     # 
-    # Options : same has Capcode.run
+    # Options : see Capcode.set
+    #
+    # Options set here replace the ones set globally
     def application( args = {} )
       conf = configuration(args)
       
@@ -517,8 +554,10 @@ module Capcode
           if eval "Capcode::#{k}.public_methods(true).include?( '__urls__' )"
             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
+              #raise Capcode::RouteError, "Route `#{current_route_path}' already define !", caller if @@__ROUTES.keys.include?(current_route_path)
+              raise Capcode::RouteError, "Route `#{current_route_path}' already define !", caller if Capcode.routes.keys.include?(current_route_path)
+              #@@__ROUTES[current_route_path] = klass.new
+              Capcode.routes[current_route_path] = klass.new
             end
           end
         rescue => e
@@ -527,15 +566,18 @@ module Capcode
       end
       
       # Set Static directory
-      @@__STATIC_DIR = (conf[:static][0].chr == "/")?conf[:static]:"/"+conf[:static] unless conf[:static].nil?
+      #@@__STATIC_DIR = (conf[:static][0].chr == "/")?conf[:static]:"/"+conf[:static] unless conf[:static].nil?
+      Capcode.static = (conf[:static][0].chr == "/")?conf[:static]:"/"+conf[:static] unless conf[:static].nil?
       
       # Initialize Rack App
       puts "** Map routes." if conf[:verbose]
-      app = Rack::URLMap.new(@@__ROUTES)
+      #app = Rack::URLMap.new(@@__ROUTES)
+      app = Rack::URLMap.new(Capcode.routes)
       puts "** Initialize static directory (#{conf[:static]})" if conf[:verbose]
       app = Rack::Static.new( 
         app, 
-        :urls => [@@__STATIC_DIR], 
+        #:urls => [@@__STATIC_DIR], 
+        :urls => [Capcode.static], 
         :root => File.expand_path(conf[:root]) 
       ) unless conf[:static].nil?
       puts "** Initialize session" if conf[:verbose]
@@ -547,6 +589,16 @@ module Capcode
       #app = Rack::Reloader.new(app) ## -- NE RELOAD QUE capcode.rb -- So !!!
       # app = Rack::CommonLogger.new( app, Logger.new(conf[:log]) )
       
+      middlewares.each do |mw|
+        middleware, args, block = mw
+        puts "** Load middleware #{middleware}" if conf[:verbose]
+        if block
+          app = middleware.new( app, *args, &block )
+        else
+          app = middleware.new( app, *args )
+        end
+      end
+      
       # Start database
       if self.methods.include? "db_connect"
         db_connect( conf[:db_config], conf[:log] )
@@ -561,19 +613,9 @@ module Capcode
     
     # Start your application.
     # 
-    # Options :
-    # * <tt>:port</tt> = Listen port (default: 3000)
-    # * <tt>:host</tt> = Listen host (default: 0.0.0.0)
-    # * <tt>:server</tt> = Server type (webrick or mongrel)
-    # * <tt>:log</tt> = Output logfile (default: STDOUT)
-    # * <tt>:session</tt> = Session parameters. See Rack::Session for more informations
-    # * <tt>:pid</tt> = PID file (default: $0.pid)
-    # * <tt>:daemonize</tt> = Daemonize application (default: false)
-    # * <tt>:db_config</tt> = database configuration file (default: database.yml)
-    # * <tt>:static</tt> = Static directory (default: none -- relative to the working directory)
-    # * <tt>:root</tt> = Root directory (default: directory of the main.rb) -- This is also the working directory !
-    # * <tt>:verbose</tt> = run in verbose mode
-    # * <tt>:auth</tt> = HTTP Basic Authentication options
+    # Options : see Capcode.set
+    #
+    # Options set here replace the ones set globally
     def run( args = {} )
       conf = configuration(args)
       
@@ -695,11 +737,18 @@ module Capcode
     end
 
     def routes #:nodoc:
-      @@__ROUTES
+      #@@__ROUTES
+      @routes ||= {}
     end
     
     def static #:nodoc:
-      @@__STATIC_DIR
-    end    
+      #@@__STATIC_DIR
+      @static_dir ||= nil
+    end
+    def static=(x) #:nodoc:
+      #@@__STATIC_DIR
+      @static_dir = x
+    end
+    
   end
 end

data/lib/capcode/configuration.rb

@@ -0,0 +1,39 @@
+module Capcode
+  class << self
+    # Set global configuration options
+    #
+    # Options :
+    # * <tt>:port</tt> = Listen port (default: 3000)
+    # * <tt>:host</tt> = Listen host (default: 0.0.0.0)
+    # * <tt>:server</tt> = Server type (webrick or mongrel)
+    # * <tt>:log</tt> = Output logfile (default: STDOUT)
+    # * <tt>:session</tt> = Session parameters. See Rack::Session for more informations
+    # * <tt>:pid</tt> = PID file (default: $0.pid)
+    # * <tt>:daemonize</tt> = Daemonize application (default: false)
+    # * <tt>:db_config</tt> = database configuration file (default: database.yml)
+    # * <tt>:static</tt> = Static directory (default: the working directory)
+    # * <tt>:root</tt> = Root directory (default: directory of the main.rb) -- This is also the working directory !
+    # * <tt>:verbose</tt> = run in verbose mode
+    # * <tt>:auth</tt> = HTTP Basic Authentication options 
+    #
+    # It can exist specifics options depending on a renderer, a helper, ...
+    # 
+    # Example : 
+    #
+    #   module Capcode
+    #     set :erb, "/path/to/erb/files"
+    #     ...
+    #   end
+    def set( key, value )
+      config[key] = value
+    end
+    
+    def get( key ) #:nodoc:
+      config[key] || nil
+    end
+    
+    def config
+      @configuration ||= {}
+    end
+  end
+end

data/lib/capcode/helpers/auth.rb

@@ -1,28 +1,27 @@
-# Because this helper was trully inspired by this post :
-# http://www.gittr.com/index.php/archive/sinatra-basic-authentication-selectively-applied/
-# and because the code in this post was extracted out of Wink, this file follow the 
-# Wink license :
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#  
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#  
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-
 module Capcode
   module Helpers
+    # Because this helper was trully inspired by this post :
+    # http://www.gittr.com/index.php/archive/sinatra-basic-authentication-selectively-applied/
+    # and because the code in this post was extracted out of Wink, this file follow the 
+    # Wink license :
+    #
+    # Permission is hereby granted, free of charge, to any person obtaining a copy
+    # of this software and associated documentation files (the "Software"), to deal
+    # in the Software without restriction, including without limitation the rights
+    # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    # copies of the Software, and to permit persons to whom the Software is
+    # furnished to do so, subject to the following conditions:
+    #  
+    # The above copyright notice and this permission notice shall be included in
+    # all copies or substantial portions of the Software.
+    #  
+    # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+    # THE SOFTWARE.
     module Authorization
       def auth #:nodoc:
         if @auth_type == :basic

data/lib/capcode/render/erb.rb

@@ -2,11 +2,11 @@ require 'erb'
 
 module Capcode
   module Helpers
-    @@__ERB_PATH__ = "."
-    
     # Set the path to ERB files. If this path is not set, Capcode will search in the static path.
-    def self.erb_path=( p ) #:nodoc:
-      @@__ERB_PATH__ = p
+    # This method is deprecated and will be removed in version 1.0
+    def self.erb_path=( p )
+      warn "Capcode::Helpers.erb_path is deprecated and will be removed in version 1.0, please use `set :erb'"
+      Capcode.set :erb, p
     end
     
     def get_binding #:nodoc:
@@ -14,8 +14,8 @@ module Capcode
     end
     
     def render_erb( f, opts ) #:nodoc:
-      if @@__ERB_PATH__.nil?
-        @@__ERB_PATH__ = "." + (Capcode.static.nil? == false)?Capcode.static():''
+      if @erb_path.nil?
+        @erb_path = Capcode.get( :erb ) || Capcode.static()
       end
       
       f = f.to_s
@@ -24,28 +24,35 @@ module Capcode
       end
       
       if /Windows/.match( ENV['OS'] )
-        unless( /.:\\/.match( @@__ERB_PATH__[0] ) )
-          @@__ERB_PATH__ = File.expand_path( File.join(".", @@__ERB_PATH__) )
+        unless( /.:\\/.match( @erb_path[0] ) )
+          @erb_path = File.expand_path( File.join(".", @erb_path) )
         end
       else
-        unless( @@__ERB_PATH__[0].chr == "/" )
-          @@__ERB_PATH__ = File.expand_path( File.join(".", @@__ERB_PATH__) )
+        unless( @erb_path[0].chr == "/" )
+          @erb_path = File.expand_path( File.join(".", @erb_path) )
         end
       end
 
+      # Get Layout
       layout = opts.delete(:layout)||:layout
-      layout_file = File.join( @@__ERB_PATH__, layout.to_s+".rhtml" )
+      layout_file = File.join( @erb_path, layout.to_s+".rhtml" )
 
+      # Get file
       f = f + ".rhtml" if File.extname( f ) != ".rhtml"
-      file = File.join( @@__ERB_PATH__, f )
+      file = File.join( @erb_path, f )
       
-      if( File.exist?( layout_file ) )
-        ERB.new(open(layout_file).read).result( get_binding { |*args| 
-          @@__ARGS__ = args
-          ERB.new(open(file).read).result(binding) 
-        } )
+      if( File.exist?( file ) )
+        if( File.exist?( layout_file ) )
+          ERB.new(open(layout_file).read).result( get_binding { |*args| 
+            #@@__ARGS__ = args
+            Capcode::Helpers.args = args
+            ERB.new(open(file).read).result(binding) 
+          } )
+        else
+          ERB.new(open(file).read).result(binding)
+        end
       else
-        ERB.new(open(file).read).result(binding)
+        raise Capcode::RenderError, "Error rendering `erb', #{file} does not exist !"
       end
     end
   end