RubyGems - Capcode - Versions diffs - 0.9.9 → 1.0.0 - Mend

Capcode 0.9.9 → 1.0.0

Files changed (36) hide show

data/README.rdoc +3 -0
data/examples/rest.log +15 -0
data/examples/static.rb +12 -0
data/examples/static/static-index.html +1 -0
data/lib/capcode.rb +14 -344
data/lib/capcode/filters.rb +1 -0
data/lib/capcode/helpers.rb +246 -0
data/lib/capcode/http_error.rb +49 -0
data/lib/capcode/static_files.rb +68 -0
data/lib/capcode/version.rb +1 -1
metadata +46 -61
data/doc/rdoc/classes/Capcode.html +0 -1076
data/doc/rdoc/classes/Capcode/Base.html +0 -136
data/doc/rdoc/classes/Capcode/Configuration.html +0 -290
data/doc/rdoc/classes/Capcode/HTTPError.html +0 -148
data/doc/rdoc/classes/Capcode/Helpers.html +0 -674
data/doc/rdoc/classes/Capcode/Helpers/Authorization.html +0 -219
data/doc/rdoc/classes/Capcode/Resource.html +0 -111
data/doc/rdoc/classes/Capcode/StaticFiles.html +0 -199
data/doc/rdoc/classes/Capcode/Views.html +0 -112
data/doc/rdoc/created.rid +0 -1
data/doc/rdoc/files/AUTHORS.html +0 -107
data/doc/rdoc/files/COPYING.html +0 -531
data/doc/rdoc/files/README_rdoc.html +0 -887
data/doc/rdoc/files/lib/capcode/base/db_rb.html +0 -101
data/doc/rdoc/files/lib/capcode/configuration_rb.html +0 -101
data/doc/rdoc/files/lib/capcode/filters_rb.html +0 -101
data/doc/rdoc/files/lib/capcode/helpers/auth_rb.html +0 -101
data/doc/rdoc/files/lib/capcode/render/text_rb.html +0 -101
data/doc/rdoc/files/lib/capcode_rb.html +0 -144
data/doc/rdoc/fr_class_index.html +0 -35
data/doc/rdoc/fr_file_index.html +0 -35
data/doc/rdoc/fr_method_index.html +0 -56
data/doc/rdoc/index.html +0 -24
data/doc/rdoc/rdoc-style.css +0 -208
data/lib/capcode.rbSAVE +0 -881

data/README.rdoc CHANGED

@@ -12,6 +12,9 @@ Capcode is a web microframework
 == FEATURES/PROBLEMS:
+=== 1.0.0
+* json helper removed
 === 0.9.9
 * Better static files support {See example static.rb}[http://github.com/glejeune/Capcode/tree/master/examples/static.rb]
 * Rewrite routes loader

data/examples/rest.log ADDED

@@ -0,0 +1,15 @@
+# Logfile created on Mon Jan 17 12:47:10 +0100 2011 by logger.rb/22285
+127.0.0.1 - - [17/Jan/2011 12:47:14] "GET / HTTP/1.1" 200 586 0.1240
+127.0.0.1 - - [17/Jan/2011 12:47:14] "GET /favicon.ico HTTP/1.1" 404 23 0.0015
+GET...
+127.0.0.1 - - [17/Jan/2011 12:47:16] "GET /action?data=A HTTP/1.1" 200 619 0.0092
+127.0.0.1 - - [17/Jan/2011 12:47:16] "GET /favicon.ico HTTP/1.1" 404 23 0.0015
+POST...
+127.0.0.1 - - [17/Jan/2011 12:47:19] "POST /action HTTP/1.1" 200 620 0.0094
+127.0.0.1 - - [17/Jan/2011 12:47:19] "GET /favicon.ico HTTP/1.1" 404 23 0.0015
+DELETE...
+127.0.0.1 - - [17/Jan/2011 12:47:22] "POST /action HTTP/1.1" 200 622 0.0102
+127.0.0.1 - - [17/Jan/2011 12:47:22] "GET /favicon.ico HTTP/1.1" 404 23 0.0014
+PUT...
+127.0.0.1 - - [17/Jan/2011 12:47:25] "POST /action HTTP/1.1" 200 619 0.0104
+127.0.0.1 - - [17/Jan/2011 12:47:25] "GET /favicon.ico HTTP/1.1" 404 23 0.0015

data/examples/static.rb CHANGED

@@ -5,8 +5,20 @@ require 'rubygems'
 module Capcode
   set :static, "static"
+  before_filter :only_static, :only => [:StaticFiles]
+  def only_static
+    puts "-> Filter for static files!"
+    p session
+    puts "<- Filter for static files!"
+    return nil
+  end
   class Index < Route '/'
     def get
+      session['date'] = Time.now
       render :markaby => :index
     end
   end

data/examples/static/static-index.html CHANGED

@@ -2,5 +2,6 @@
 	<body>
 		Hello Index !<br />
 		<a href="/bye.html">Bye !</a>
+		<a href="/bulgroz.html">ERROR !!!</a>
 	</body>
 </html>

data/lib/capcode.rb CHANGED

@@ -9,8 +9,11 @@ require 'optparse'
 require 'irb'
 require 'capcode/version'
 require 'capcode/core_ext'
+require 'capcode/helpers'
 require 'capcode/helpers/auth'
 require 'capcode/render/text'
+require 'capcode/http_error'
+require 'capcode/static_files'
 require 'capcode/configuration'
 require 'capcode/filters'
 require 'capcode/ext/rack/urlmap'
@@ -32,347 +35,12 @@ module Capcode
   module Views; end
   # 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
-    # Help you to return a JSON response
-    #
-    #   module Capcode
-    #     class JsonResponse < Route '/json/([^\/]*)/(.*)'
-    #       def get( arg1, arg2 )
-    #         json( { :1 => arg1, :2 => arg2 })
-    #       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 and will be removed in version 1.0, please use `render( :json => ... )'" )
-      render :json => d
-    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)}, '']
-    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
+  module Helpers
     include Authorization
   end
   include Rack
-  # 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
-  # Static file loader
-  #
-  # Use :
-  #   set :static, "path/to/static"
-  class StaticFiles
-    def initialize(app)
-      @app = app
-    end
-    def call(env)
-      static = File.expand_path( File.join(Capcode::Configuration.get(:root), Capcode::Configuration.get(:static) ) )
-      file = File.join(static, env['REQUEST_PATH'].split("/") )
-      file = File.join(file, "index.html" ) if File.directory?(file)
-      if File.exist?(file)
-        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
-        }
-        return [200, header, body]
-      else
-        return @app.call(env)
-      end
-      return @app.call(env)
-    end
-  end
   class << self
     attr :__auth__, true #:nodoc:
@@ -458,7 +126,7 @@ module Capcode
         # Session hash
         def session
-          @env['rack.session']
+          env['rack.session']
         end
         # Return the Rack::Request object
@@ -693,16 +361,18 @@ module Capcode
 #      app = Rack::URLMap.new(Capcode.routes)
       app = Capcode::Ext::Rack::URLMap.new(Capcode.routes)
       puts "** Initialize static directory (#{Capcode.static}) in #{File.expand_path(Capcode::Configuration.get(:root))}" if Capcode::Configuration.get(:verbose)
-      app = Rack::Static.new(
-        app,
-        #:urls => [@@__STATIC_DIR],
-        :urls => [Capcode.static],
-        :root => File.expand_path(Capcode::Configuration.get(:root))
-      ) unless Capcode::Configuration.get(:static).nil?
+      #app = Rack::Static.new(
+      #  app,
+      #  #:urls => [@@__STATIC_DIR],
+      #  :urls => [Capcode.static],
+      #  :root => File.expand_path(Capcode::Configuration.get(:root))
+      #) unless Capcode::Configuration.get(:static).nil?
       puts "** Initialize session" if Capcode::Configuration.get(:verbose)
-      app = Rack::Session::Cookie.new( app, Capcode::Configuration.get(:session) )
       app = Capcode::StaticFiles.new(app)
       app = Capcode::HTTPError.new(app)
+      app = Rack::Session::Cookie.new( app, Capcode::Configuration.get(:session) )
       app = Rack::ContentLength.new(app)
       app = Rack::Lint.new(app)
       app = Rack::ShowExceptions.new(app)

data/lib/capcode/filters.rb CHANGED

@@ -33,6 +33,7 @@ module Capcode
       def execute( klass ) #:nodoc:
         klass_sym = "#{klass.class}".split( /::/)[-1].to_sym
         actions = []
         filters.each do |action, data|
           if (data[:only] and data[:only].include?(klass_sym)) or