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

Capcode 0.9.9 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

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/doc/rdoc/files/README_rdoc.html DELETED

@@ -1,887 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <title>File: README.rdoc</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-    elemStyle = elem.style;
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-    return true;
-  }
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  // ]]>
-  </script>
-</head>
-<body>
-  <div id="fileHeader">
-    <h1>README.rdoc</h1>
-    <table class="header-table">
-    <tr class="top-aligned-row">
-      <td><strong>Path:</strong></td>
-      <td>README.rdoc
-      </td>
-    </tr>
-    <tr class="top-aligned-row">
-      <td><strong>Last Update:</strong></td>
-      <td>Mon Jan 10 21:26:22 +0100 2011</td>
-    </tr>
-    </table>
-  </div>
-  <!-- banner header -->
-  <div id="bodyContent">
-  <div id="contextContent">
-    <div id="description">
-      <h1><a href="../classes/Capcode.html">Capcode</a></h1>
-<p>
-Copyright (C) 2009, 2010 Gregoire Lejeune
-</p>
-<ul>
-<li>home : <a href="http://capcode.rubyforge.org">capcode.rubyforge.org</a>
-</li>
-<li>doc : <a
-href="http://rdoc.info/projects/glejeune/Capcode">rdoc.info/projects/glejeune/Capcode</a>
-</li>
-<li>book (fr) : <a
-href="http://www.algorithmique.net/capcode">www.algorithmique.net/capcode</a>/
-</li>
-</ul>
-<h2>DESCRIPTION:</h2>
-<p>
-<a href="../classes/Capcode.html">Capcode</a> is a web microframework
-</p>
-<h2>FEATURES/PROBLEMS:</h2>
-<h3>0.9.9</h3>
-<ul>
-<li>Better static files support <a
-href="http://github.com/glejeune/Capcode/tree/master/examples/static.rb">See
-example static.rb</a>
-</li>
-<li>Rewrite routes loader
-</li>
-</ul>
-<h3>0.9.8</h3>
-<ul>
-<li>Add &quot;any&quot; to easly replace an <tt>alias_method :post, :get</tt>
-</li>
-<li>Bug correction in Filter : actions are now executed in the order they are
-declared
-</li>
-<li>Filters execution stop at the first non nul response
-</li>
-<li>Add &quot;log&quot; helper
-</li>
-<li>Add <a href="http://unicorn.bogomips.org/">Unicorn</a> and <a
-href="http://rainbows.rubyforge.org/">Rainbows</a> supports
-(<b>EXPERIMENTAL</b>)
-</li>
-<li>Add &#8212;server option
-</li>
-</ul>
-<h3>0.9.7</h3>
-<ul>
-<li>Major bug correction in Capcode.URL
-</li>
-</ul>
-<h3>0.9.6</h3>
-<ul>
-<li>More debug trace
-</li>
-<li>Bug correction in the custom version of Rack::URLmap
-</li>
-</ul>
-<h3>0.9.5</h3>
-<ul>
-<li>Major bug correction
-</li>
-</ul>
-<h3>0.9.4</h3>
-<ul>
-<li>You can now create a controler without specifying the root name. If so the
-name of the class will be used. <a
-href="http://github.com/glejeune/Capcode/tree/master/examples/route.rb">see
-example route.rb</a>.
-</li>
-<li>Major bug correction in Route
-</li>
-<li>render :text =&gt; &#8230; now really render text
-</li>
-<li>rXXX methods in HTTPError can now receive a second optional parameter
-corresponding to headers
-</li>
-<li>Huge bug correction in Capcode::Helpers.URL
-</li>
-<li>Use a custom version of Rack::URLmap
-</li>
-</ul>
-<h3>0.9.3</h3>
-<ul>
-<li>Major bug correction
-</li>
-</ul>
-<h3>0.9.2</h3>
-<ul>
-<li>Remove JSON dependency
-</li>
-<li>Add the &quot;HTTP code&quot; renderer, so you can now use something like
-this : render 200 =&gt; &quot;OK&quot;, :server =&gt; &quot;<a
-href="../classes/Capcode.html">Capcode</a>&quot;, &#8230;
-</li>
-<li>Reintroduce before_filter. <a
-href="http://github.com/glejeune/Capcode/tree/master/examples/filter.rb">See
-example filter.rb</a>.
-</li>
-<li>Remove mime-types dependency
-</li>
-</ul>
-<h3>0.9.1</h3>
-<ul>
-<li>You don&#8216;t need to require the renderers. This will be done by <a
-href="../classes/Capcode.html">Capcode</a> at use time.
-</li>
-<li>Major bug correction for jRuby
-</li>
-</ul>
-<h3>0.9.0</h3>
-<ul>
-<li><b>IMPORTANT</b>
-<ul>
-<li>THIS VERSION IS A MAJOR ENHANCEMENT : YOU MUST UNINSTALL ALL PREVIOUS
-VERSIONS !!!
-<pre>
-            gem uninstall Capode --version '&lt; 0.9.0'
-</pre>
-</li>
-<li>Renderers and database accessors have been extracted and are now in the <a
-href="http://github.com/glejeune/Capcode.more">plugins repository</a>. Each
-plugin is a gem that&#8216;s can be installed separately.
-</li>
-</ul>
-</li>
-<li><b>Important, but less!</b>
-<ul>
-<li>Add <a href="http://jashkenas.github.com/coffee-script/">Coffee-Script</a>
-renderer
-</li>
-<li>Update renderers options
-</li>
-<li>Rewrite configuration
-</li>
-<li>Bug corrections in all DB modules
-</li>
-</ul>
-</li>
-</ul>
-<h3>0.8.9</h3>
-<ul>
-<li>Add Thin support
-</li>
-<li>Add MongoDB support
-</li>
-<li>Major bug correction in Markaby renderer
-</li>
-</ul>
-<h3>0.8.8</h3>
-<ul>
-<li>Add mustache renderer
-</li>
-<li>Add AcriveRecord support (see example blog-ar.rb)
-</li>
-<li>Add Sequel support (see example blog-sq.rb)
-</li>
-<li>Add Binary renderer (see example render-binary.rb)
-</li>
-<li>Add Mail renderer (see example render-mail.rb)
-</li>
-<li>Add Redirect renderer (see examples render-redirect.rb and render-mail.rb)
-</li>
-<li>Add &quot;none&quot; renderer (return a 204 status code)
-</li>
-</ul>
-<h3>0.8.7</h3>
-<ul>
-<li>Route&#8216;s captures are now passed to all methods in a controller
-</li>
-<li>Add :content_type option to renderers (see render-image.rb)
-</li>
-<li>Add <a href="../classes/Capcode.html#M000013">Capcode.set</a> for
-configuration. So Capcode::Herpers#erb_path=, Capcode::Herpers#sass_path=
-and Capcode::Herpers#haml_path= are deprecated, you must now use `set :erb,
-&#8230;&#8217;, `set :sass, &#8230;&#8217; and `set :haml, &#8230;&#8217;
-(see render-erb.rb and render-haml_sass.rb)
-</li>
-<li>Add <a href="../classes/Capcode.html#M000008">Capcode.use</a> to allow
-usage of Rack middlewares (see render-use.rb)
-</li>
-</ul>
-<h3>0.8.6</h3>
-<ul>
-<li>HUGE bug correction
-</li>
-</ul>
-<h3>0.8.5</h3>
-<ul>
-<li><a href="../classes/Capcode.html">Capcode</a> now work with Phusion
-Passenger \o/
-</li>
-<li>Add WebDAV renderer (need rack_dav) (see examples render-webdav.rb and
-auth-webdav.rb)
-</li>
-<li>Change default listen host from localhost to 0.0.0.0
-</li>
-<li>Add require_auth helper for basic or digest HTTP Authentication (see
-examples auth-basic.rb and auth-digest.rb)
-</li>
-</ul>
-<h3>0.8.4</h3>
-<ul>
-<li>Major (really MAJOR) bugs corrections in renderers
-</li>
-<li>Add many renderer&#8217; examples
-</li>
-<li>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)
-</li>
-<li>redirect now accept an optional HTTP status code as first parameter
-</li>
-</ul>
-<h3>0.8.3</h3>
-<ul>
-<li>Add PUT and DELETE actions (see rest example)
-</li>
-</ul>
-<h3>0.8.2</h3>
-<ul>
-<li>Add XML renderer (see rss example)
-</li>
-<li>Major bug corrections
-</li>
-<li>Add Helpers.static
-</li>
-<li>New example : upload.rb
-</li>
-<li>The database&#8217; configuration file is no more relative to the root
-directory but to the main file
-</li>
-</ul>
-<h3>0.8.1</h3>
-<ul>
-<li>Sorry for 0.8.0 !!
-</li>
-</ul>
-<h3>0.8.0</h3>
-<ul>
-<li>Bugs corrections in haml and text renderer
-</li>
-<li>Text renderer is now automaticaly included
-</li>
-<li>Add sass renderer
-</li>
-<li>:working_directory is no more available
-</li>
-<li>:root is now the real root directory
-</li>
-<li>Add :static option to set the directory for static files
-</li>
-<li>Add -r and -s (for root and static directories) options
-</li>
-<li>Add static renderer
-</li>
-</ul>
-<h3>0.7.1</h3>
-<ul>
-<li>You need to include <a
-href="../classes/Capcode/Resource.html">Capcode::Resource</a> in your
-models !!!!
-</li>
-<li>Add option &#8212;version
-</li>
-</ul>
-<h3>0.7.0</h3>
-<ul>
-<li>You no more need to include <a
-href="../classes/Capcode/Resource.html">Capcode::Resource</a> in your
-models
-</li>
-<li><a href="../classes/Capcode.html#M000011">Capcode.run</a> now accept a
-block. The content of the block is executed just before the server start.
-</li>
-<li>Add options support : you can now change the defaults port and host,
-daemonize or not and run in console mode.
-</li>
-</ul>
-<h3>0.6.2</h3>
-<ul>
-<li>Add Markaby, Erb and Haml layout see Capcode::Helpers.render for more
-informations
-</li>
-<li>Add content_for&#8230;
-</li>
-<li>Major bugs corrections
-</li>
-</ul>
-<h3>0.6.1</h3>
-<ul>
-<li>Major bugs corrections in haml and erb renderer ($%&amp;! Windows)
-</li>
-<li>Major bugs corrections in Route.call
-</li>
-<li>Add Markaby layout support
-</li>
-<li>Rewrite blog-couchdb example (based on the very sympatic camping example :
-<a
-href="http://github.com/judofyr/camping/blob/master/examples/blog.rb">github.com/judofyr/camping/blob/master/examples/blog.rb</a>)
-</li>
-</ul>
-<h3>0.6.0</h3>
-<ul>
-<li>Add :root option to <a
-href="../classes/Capcode.html#M000011">Capcode.run</a>. This option allow
-you to specify the root directory for static files
-</li>
-<li>Add :working_directory option to <a
-href="../classes/Capcode.html#M000011">Capcode.run</a>. This option allow
-you to specify the working directory
-</li>
-<li>If &#8217;/&#8217; route is not defined but /index.html exist, display
-index
-</li>
-<li>add mime-types dependency
-</li>
-<li>Bug correction in erb and haml renderer
-</li>
-</ul>
-<h3>0.5.0</h3>
-<ul>
-<li>Add Haml and Markaby renderer
-</li>
-<li>json is deprecated and replaced by render( :json =&gt; &#8230; )
-</li>
-</ul>
-<h3>0.4.0</h3>
-<ul>
-<li>Major bug correction !
-</li>
-<li>Add views&#8230;
-</li>
-</ul>
-<h3>0.3.0</h3>
-<ul>
-<li>Work with Rack 1.0.0
-</li>
-</ul>
-<h3>0.2.0</h3>
-<ul>
-<li>Add models with DataMapper and couch_foo
-</li>
-<li>Add two new options : :daemonize and :pid
-</li>
-<li>Bug correction in Route.
-</li>
-</ul>
-<h3>0.1.0</h3>
-<ul>
-<li>First public release
-</li>
-<li>No models !!!
-</li>
-</ul>
-<h2>SYNOPSIS:</h2>
-<pre>
-  # file: sample.rb
-  require 'rubygems'
-  require 'capcode'
-  module Capcode
-    class Hello &lt; Route '/hello'
-      def get
-        &quot;Hello World #{Time.now} !&quot;
-      end
-    end
-  end
-  Capcode.run( )
-</pre>
-<h3>Running <a href="../classes/Capcode.html">Capcode</a> Apps</h3>
-<ul>
-<li>Run: <tt>ruby sample.rb</tt>
-</li>
-<li>Visit <a href="http://localhost:3000">localhost:3000</a>/
-</li>
-</ul>
-<h3>Create model</h3>
-<pre>
-  require 'rubygems'
-  require 'capcode'
-  require 'capcode/base/dm' # or require 'capcode/base/couchdb'
-  class Story &lt; Capcode::Base
-    include Capcode::Resource
-    property :id, Integer, :serial =&gt; 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 &lt; Route '/hello'
-      def get
-        @t = Time.now
-        render :time
-      end
-    end
-  end
-  module Capcode::Views
-    def time
-      &quot;Hello world #{@t}&quot;
-    end
-  end
-  Capcode.run( )
-</pre>
-<h3>Create Helper</h3>
-<pre>
-  # file: sample.rb
-  require 'rubygems'
-  require 'capcode'
-  module Capcode
-    class Hello &lt; Route '/hello'
-      def get
-        @t = Time.now
-        render :time
-      end
-    end
-  end
-  module Capcode::Helpers
-    def bold( &amp;b )
-      &quot;&lt;b&gt;&quot;+yield+&quot;&lt;/b&gt;&quot;
-    end
-  end
-  module Capcode::Views
-    def time
-      &quot;Hello world &quot; + bold { @t }
-    end
-  end
-  Capcode.run( )
-</pre>
-<h3>Render with Markaby</h3>
-<pre>
-  # file: sample.rb
-  require 'rubygems'
-  require 'capcode'
-  module Capcode
-    class Hello &lt; Route '/hello'
-      def get
-        @t = Time.now
-        # This implies that capcode-render-markaby is installed !
-        render :markaby =&gt; :time
-      end
-    end
-  end
-  module Capcode::Views
-    def time
-      # We use Markaby in Capcode::Views.time
-      html do
-        body do
-          p {
-            text &quot;Hello World &quot;
-            b @t
-          }
-        end
-      end
-    end
-  end
-  Capcode.run( )
-</pre>
-<h3>Render with Haml</h3>
-<pre>
-  # file: sample.rb
-  require 'rubygems'
-  require 'capcode'
-  module Capcode
-    set :haml, &quot;./my_haml_views&quot;
-    class Hello &lt; Route '/hello'
-      def get
-        @t = Time.now
-        # This implies that capcode-render-haml is installed !
-        render :haml =&gt; :time
-      end
-    end
-  end
-  Capcode.run( )
-  # ./my_haml_views/time.haml
-  %html
-    %body
-      %p
-        Hello World
-        = @t
-</pre>
-<h3>Render with JSON</h3>
-<pre>
-  # file: sample.rb
-  require 'rubygems'
-  require 'capcode'
-  module Capcode
-    class Hello &lt; Route '/hello'
-      def get
-        @t = Time.now
-        # This implies that capcode-render-json is installed !
-        render :json =&gt; { :time =&gt; @t }
-      end
-    end
-  end
-  Capcode.run( )
-</pre>
-<h3>Render with WebDAV</h3>
-<pre>
-  # file: sample.rb
-  require 'rubygems'
-  require 'capcode'
-  module Capcode
-    # !!! Render file from /Users/greg/temp !!!
-    class WebDav &lt; Route '/temp'
-      def get
-        # This implies that capcode-render-webdav is installed !
-        render :webdav =&gt; &quot;/Users/greg/temp&quot;
-      end
-      def method_missing(id, *a, &amp;b)
-        get
-      end
-    end
-    class Index &lt; Route '/'
-      def get
-        render &quot;WebDav server acces : &lt;a href='#{URL(Capcode::WebDav)}'&gt;#{URL(Capcode::WebDav)}&lt;/a&gt;&quot;
-      end
-    end
-  end
-  Capcode.run( )
-</pre>
-<h3>HTTP Authentication</h3>
-<pre>
-  # file: sample.rb
-  require 'rubygems'
-  require 'capcode'
-  module Capcode
-    class Public &lt; Route '/public'
-      def get
-        render &quot;This page is not protected&quot;
-      end
-    end
-    class Private &lt; Route '/private'
-      def get
-        http_authentication( :type =&gt; :digest, :realm =&gt; &quot;Private part&quot; ) {
-          { &quot;greg&quot; =&gt; &quot;p4ssw0rd&quot; }
-        }
-        render &quot;This page is private - Hello #{request.env['REMOTE_USER']}&quot;
-      end
-    end
-  end
-  Capcode.run( )
-</pre>
-<p>
-Second example :
-</p>
-<pre>
-  # file: sample.rb
-  require 'rubygems'
-  require 'capcode'
-  module Capcode
-    http_authentication( :type =&gt; :digest, :realm =&gt; &quot;Private part&quot;, :routes =&gt; ['/admin', '/private'] ) {
-      { &quot;greg&quot; =&gt; &quot;p4ssw0rd&quot; }
-    }
-    class Public &lt; Route '/public'
-      def get
-        render &quot;This page is not protected&quot;
-      end
-    end
-    class Private &lt; Route '/private'
-      def get
-        render &quot;This page is private - Hello #{request.env['REMOTE_USER']}&quot;
-      end
-    end
-    class PrivateAgain &lt; Route '/private/again'
-      def get
-        render &quot;This page is also private - Hello #{request.env['REMOTE_USER']}&quot;
-      end
-    end
-    class Admin &lt; Route '/admin'
-      def get
-        render &quot;This page is private - Hello #{request.env['REMOTE_USER']}&quot;
-      end
-    end
-  end
-  Capcode.run( )
-</pre>
-<h2>DEPLOYMENT</h2>
-<h3>With Passenger</h3>
-<p>
-First create the directory structure :
-</p>
-<pre>
-  my_app/
-  my_app/tmp
-  my_app/public
-</pre>
-<p>
-Then put your app in <tt>my_app/</tt> and comment or remove the line with
-<tt><a href="../classes/Capcode.html#M000011">Capcode.run</a></tt>
-</p>
-<p>
-Create a rack configuration file (<tt>config.ru</tt>) in <tt>my_app/</tt>
-</p>
-<pre>
-  require 'app'
-  run Capcode.application()
-</pre>
-<p>
-<tt><a href="../classes/Capcode.html#M000010">Capcode.application</a></tt>
-take the same parameters as <tt><a
-href="../classes/Capcode.html#M000011">Capcode.run</a></tt> (and block
-too). Be carefull, if you use static files (with the static renderer) you
-must set the <tt>:root</tt> option (<tt>:root =&gt;
-File.expand_path(File.dirname(<em>FILE</em>))</tt> is probably good)
-</p>
-<p>
-You can now deploy your application like a <a
-href="http://www.modrails.com/documentation/Users%20guide.html#_deploying_a_rack_based_ruby_application">"Rack-based
-Ruby application"</a>
-</p>
-<h2>REQUIREMENTS:</h2>
-<ul>
-<li>rack
-</li>
-</ul>
-<h2>INSTALL:</h2>
-<pre>
-  sudo gem install capcode
-</pre>
-<h2>LICENSE:</h2>
-<p>
-<a href="../classes/Capcode.html">Capcode</a> is freely distributable
-according to the terms of the GNU General Public License.
-</p>
-<p>
-This program is distributed without any warranty. See the file
-&#8216;COPYING&#8217; for details.
-</p>
-    </div>
-   </div>
-  </div>
-    <!-- if includes -->
-    <div id="section">
-    <!-- if method_list -->
-  </div>
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-</body>
-</html>