Capcode 0.9.9 → 1.0.0

data/lib/capcode/helpers.rb

@@ -0,0 +1,246 @@
+module Capcode
+  # Helpers contains methods available in your controllers
+  module Helpers
+    def self.args
+      @args ||= nil
+    end
+    def self.args=(x)
+      @args = x
+    end
+    
+    # Render a view
+    # 
+    # render's parameter can be a Hash or a string. Passing a string is equivalent to do
+    #   render( :text => string )
+    # 
+    # If you want to use a specific renderer, use one of this options :
+    # 
+    # * :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.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
+    # * :webdav => /path/to/root
+    #
+    # Or you can use a "HTTP code" renderer :
+    #
+    #   render 200 => "Ok", :server => "Capcode #{Capcode::CAPCOD_VERION}", ...
+    #
+    # 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 )
+      if hash.class == Hash
+        render_type = nil
+        possible_code_renderer = nil
+        
+        hash.keys.each do |key|
+          begin
+            gem "capcode-render-#{key.to_s}"
+            require "capcode/render/#{key.to_s}"
+          rescue Gem::LoadError
+            nil
+          rescue LoadError
+            raise Capcode::RenderError, "Hum... The #{key} renderer is malformated! Please try to install a new version or use an other renderer!", caller
+          end
+        
+          if self.respond_to?("render_#{key.to_s}")
+            unless render_type.nil?
+              raise Capcode::RenderError, "Can't use multiple renderer (`#{render_type}' and `#{key}') !", caller
+            end
+            render_type = key
+          end
+          
+          if key.class == Fixnum
+            possible_code_renderer = key
+          end
+        end
+        
+        if render_type.nil? and possible_code_renderer.nil?
+          raise Capcode::RenderError, "Renderer type not specified!", caller
+        end
+        
+        unless self.respond_to?("render_#{render_type.to_s}")
+          if possible_code_renderer.nil?
+            raise Capcode::RenderError, "#{render_type} renderer not present ! please require 'capcode/render/#{render_type}'", caller
+          else
+            code = possible_code_renderer
+            body = hash.delete(possible_code_renderer)
+            header = {}
+            hash.each do |k, v|
+              k = k.to_s.split(/_/).map{|e| e.capitalize}.join("-")
+              header[k] = v
+            end
+            
+            [code, header, body]
+          end
+        else
+          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 )
+          rescue => e
+            raise Capcode::RenderError, "Error rendering `#{render_type.to_s}' : #{e.message}"#, caller
+          end
+        end
+      else
+        render( :text => hash )
+      end
+    end
+    
+    # Send a redirect response
+    #
+    #   module Capcode
+    #     class Hello < Route '/hello/(.*)'
+    #       def get( you )
+    #         if you.nil?
+    #           redirect( WhoAreYou )
+    #         else
+    #           ...
+    #         end
+    #       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 )
+      httpCode = 302
+
+      if( klass.class == Fixnum )
+        httpCode = klass
+        klass = a.shift
+      end
+
+      [httpCode, {'Location' => URL(klass, *a), 'Content-Type' => 'text/plain'}, '']
+    end
+    
+    # Builds an URL route to a controller or a path
+    #
+    # if you declare the controller Hello :
+    # 
+    #   module Capcode
+    #     class Hello < Route '/hello/(.*)'
+    #       ...
+    #     end
+    #   end
+    # 
+    # then
+    # 
+    #   URL( Capcode::Hello, "you" ) # => /hello/you
+    def URL( klass, *a )
+      path = nil
+      result = {}
+
+      a = a.delete_if{ |x| x.nil? }
+      
+      if klass.class == Class
+        klass.__urls__[0].each do |cpath, data|
+          args = a.clone
+          
+          n = Regexp.new( data[:regexp] ).number_of_captures
+          equart = (a.size - n).abs
+          
+          rtable = data[:regexp].dup.gsub( /\\\(/, "" ).gsub( /\\\)/, "" ).split( /\([^\)]*\)/ )
+          rtable.each do |r|
+            if r == ""
+              cpath = cpath + "/#{args.shift}"
+            else
+              cpath = cpath + "/#{r}"
+            end
+          end
+
+          cpath = (cpath + "/" + args.join( "/" )) if args.size > 0
+          cpath = cpath.gsub( /(\/){2,}/, "/" )
+          result[equart] = cpath
+        end
+
+        path = result[result.keys.min]
+      else
+        path = klass
+      end
+      
+      (ENV['RACK_BASE_URI']||'')+path
+    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 Capcode::Helpers.args.map{|_| _.to_s }.include?(x.to_s)
+        yield
+      end
+    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,
+        :path => File.expand_path( File.join(Capcode::Configuration.get(:root), Capcode::Configuration.get(:static) ) )
+      }
+    end
+    
+    # Use the Rack logger
+    #
+    #   log.write( "This is a log !" )
+    def log
+      Capcode.logger || env['rack.errors']
+    end
+  end
+end

data/lib/capcode/http_error.rb

@@ -0,0 +1,49 @@
+module Capcode
+  # HTTPError help you to create your own 404, 500 and/or 501 response
+  # 
+  # To create a custom 404 reponse, create a fonction HTTPError.r404 in
+  # your application :
+  #
+  #   module Capcode
+  #     class HTTPError
+  #       def r404(f)
+  #         "#{f} not found :("
+  #       end
+  #     end
+  #   end
+  #
+  # the rXXX method can also receive a second optional parameter corresponding 
+  # of the header's Hash :
+  #
+  #   module Capcode
+  #     class HTTPError
+  #       def r404(f, h)
+  #         h['Content-Type'] = 'text/plain'
+  #         "You are here ---> X (#{f} point)"
+  #       end
+  #     end
+  #   end
+  #
+  # Do the same (r500, r501, r403) to customize 500, 501, 403 errors
+  class HTTPError
+    def initialize(app) #:nodoc:
+      @app = app
+    end
+  
+    def call(env) #:nodoc:
+      status, headers, body = @app.call(env)
+      if self.methods.include? "r#{status}"
+        headers.delete('Content-Type') if headers.keys.include?('Content-Type')
+        body = begin
+          self.send( "r#{status}", env['REQUEST_PATH'], headers )
+        rescue
+          self.send( "r#{status}", env['REQUEST_PATH'] )
+        end
+        headers['Content-Length'] = body.length.to_s
+        headers['Content-Type'] = "text/html" unless headers.keys.include?('Content-Type')
+      end
+      
+      [status, headers, body]
+    end
+  end
+end

data/lib/capcode/static_files.rb

@@ -0,0 +1,68 @@
+require 'capcode/helpers'
+
+module Capcode
+  # Static file loader
+  #
+  # You can add declare a filter (with before_filter) using :StaticFiles
+  #
+  # Use : 
+  #   set :static, "path/to/static"
+  class StaticFiles
+    def initialize(app)
+      @app = app
+    end
+    
+    def session
+      env["rack.session"]
+    end
+    
+    def env
+      @env
+    end
+    
+    def log
+      env["rack.errors"]
+    end
+    
+    def request
+      @request
+    end
+    
+    def response
+      @response
+    end
+    
+    def call(env)
+      @env = env
+      @response = Rack::Response.new
+      @request = Rack::Request.new(@env)
+      
+      static = ::File.expand_path( ::File.join(Capcode::Configuration.get(:root), Capcode::Configuration.get(:static) ) )
+      file = ::File.join(static, request.path.gsub(/^[\/]?#{Capcode::Configuration.get(:static)}/, "").split("/") )
+      file = ::File.join(file, "index.html" ) if ::File.directory?(file)
+      
+      if ::File.exist?(file)
+        filter_output = Capcode::Filter.execute( self )        
+        if filter_output.nil?
+          body = [::File.read(file)]
+          header = {
+            "Last-Modified" => ::File.mtime(file).httpdate,
+            "Content-Type" => ::Rack::Mime.mime_type(::File.extname(file), 'text/plain'),
+            "Content-Length" => body.first.size.to_s,
+            "Cache-Control" => "no-cache, must-revalidate" 
+          }
+          
+          return [200, header, body]
+        else
+          return filter_output
+        end
+      else
+        return @app.call(env)
+      end
+      
+      return @app.call(env)
+    end
+  
+    include Capcode::Helpers
+  end
+end

data/lib/capcode/version.rb

@@ -1,3 +1,3 @@
 module Capcode
-  CAPCOD_VERION="0.9.9"
+  CAPCOD_VERION="1.0.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: Capcode
 version: !ruby/object:Gem::Version 
-  hash: 41
+  hash: 23
   prerelease: 
   segments: 
+  - 1
   - 0
-  - 9
-  - 9
-  version: 0.9.9
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - "Gr\xC3\xA9goire Lejeune"
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-17 00:00:00 +01:00
-default_executable: 
+date: 2011-05-31 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rack
@@ -57,6 +56,9 @@ extra_rdoc_files:
 - AUTHORS
 - COPYING
 - lib/capcode.rb
+- lib/capcode/helpers.rb
+- lib/capcode/http_error.rb
+- lib/capcode/static_files.rb
 - lib/capcode/configuration.rb
 - lib/capcode/base/db.rb
 - lib/capcode/render/text.rb
@@ -65,40 +67,18 @@ files:
 - README.rdoc
 - AUTHORS
 - setup.rb
-- doc/rdoc/classes/Capcode/Base.html
-- doc/rdoc/classes/Capcode/Configuration.html
-- doc/rdoc/classes/Capcode/Helpers/Authorization.html
-- doc/rdoc/classes/Capcode/Helpers.html
-- doc/rdoc/classes/Capcode/HTTPError.html
-- doc/rdoc/classes/Capcode/Resource.html
-- doc/rdoc/classes/Capcode/StaticFiles.html
-- doc/rdoc/classes/Capcode/Views.html
-- doc/rdoc/classes/Capcode.html
-- doc/rdoc/created.rid
-- doc/rdoc/files/AUTHORS.html
-- doc/rdoc/files/COPYING.html
-- doc/rdoc/files/lib/capcode/base/db_rb.html
-- doc/rdoc/files/lib/capcode/configuration_rb.html
-- doc/rdoc/files/lib/capcode/filters_rb.html
-- doc/rdoc/files/lib/capcode/helpers/auth_rb.html
-- doc/rdoc/files/lib/capcode/render/text_rb.html
-- doc/rdoc/files/lib/capcode_rb.html
-- doc/rdoc/files/README_rdoc.html
-- doc/rdoc/fr_class_index.html
-- doc/rdoc/fr_file_index.html
-- doc/rdoc/fr_method_index.html
-- doc/rdoc/index.html
-- doc/rdoc/rdoc-style.css
 - lib/capcode/base/db.rb
 - lib/capcode/configuration.rb
 - lib/capcode/core_ext.rb
 - lib/capcode/ext/rack/urlmap.rb
 - lib/capcode/filters.rb
 - lib/capcode/helpers/auth.rb
+- lib/capcode/helpers.rb
+- lib/capcode/http_error.rb
 - lib/capcode/render/text.rb
+- lib/capcode/static_files.rb
 - lib/capcode/version.rb
 - lib/capcode.rb
-- lib/capcode.rbSAVE
 - examples/auth-basic.rb
 - examples/auth-digest.rb
 - examples/erb/cf.rhtml
@@ -114,6 +94,7 @@ files:
 - examples/render-image.rb
 - examples/render-text.rb
 - examples/rest-run.rb
+- examples/rest.log
 - examples/rest.rb
 - examples/rest.ru
 - examples/route.rb
@@ -130,38 +111,42 @@ files:
 - examples/static/static-index.html
 - examples/static.rb
 - examples/upload.rb
-has_rdoc: true
 homepage: http://algorithmique.net
 licenses: []
 
-post_install_message: "\n\
-  !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\
-  !!                                           !!\n\
-  !!       0.9.0 WAS A MAJOR ENHANCEMENT       !!\n\
-  !!    -----------------------------------    !!\n\
-  !!                                           !!\n\
-  !!  YOU MUST UNINSTALL ALL PREVIOUS          !!\n\
-  !!  VERSIONS !!!                             !!\n\
-  !!                                           !!\n\
-  !!  gem uninstall Capode --version '< 0.9.0' !!\n\
-  !!                                           !!\n\
-  !!  IF YOU DON'T DO IT, THIS ONE WILL NOT    !!\n\
-  !!  WORK !!!                                 !!\n\
-  !!                                           !!\n\
-  !!  Moreover :                               !!\n\
-  !!                                           !!\n\
-  !!  Renderers and database accessors have    !!\n\
-  !!  been extracted and are now in the        !!\n\
-  !!  plugins repository :                     !!\n\
-  !!                                           !!\n\
-  !!  http://github.com/glejeune/Capcode.more  !!\n\
-  !!                                           !!\n\
-  !!  Each plugin is a gem that\xE2\x80\x99s can be       !!\n\
-  !!  installed separately.                    !!\n\
-  !!                                           !!\n\
-  !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n\
-  For more information about Capcode, see \n  http://capcode.rubyforge.org\n\n\
-  You can also read the Capcode book (fr) at\n  http://algorithmique.net/capcode.html\n\n"
+post_install_message: |+
+  
+  !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+  !!                                           !!
+  !!       1.0.0 HAS A MAJOR ENHANCEMENT       !!
+  !!    -----------------------------------    !!
+  !!                                           !!
+  !!  Statics files are now loaded with a new  !!
+  !!  class. So if you specify                 !!
+  !!                                           !!
+  !!  set :static, "static"                    !!
+  !!                                           !!
+  !!  All files in the "static" directory      !!
+  !!  will be loaded from the URI              !!
+  !!                                           !!
+  !!  http://server:port/<page>                !!
+  !!                                           !!
+  !!  Where <page> is any file in the static   !!
+  !!  directory. You no longer need to use     !!
+  !!                                           !!
+  !!  http://server:port/static/<page>         !!
+  !!                                           !!
+  !!  For more information, see example        !!
+  !!  static.rb                                !!
+  !!                                           !!
+  !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+  
+  For more information about Capcode, see 
+    http://capcode.rubyforge.org
+  
+  You can also read the Capcode book (fr) at
+    http://algorithmique.net/capcode.html
+  
 rdoc_options: 
 - --quiet
 - --title
@@ -197,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: capcode
-rubygems_version: 1.4.2
+rubygems_version: 1.8.4
 signing_key: 
 specification_version: 3
 summary: Capcode is a web microframework