trellis 0.0.1 → 0.0.2

data/README.txt

@@ -1,156 +0,0 @@
-= Project: Trellis
-
-Trellis is a component-based Web Application Framework written in Ruby. 
-Its main goal is to bring component-driven development to the micro-framework world. 
-The framework aims to be a zero-configuration framework. 
-
-It draws inspiration from:
-
-Ruby Web Frameworks
-===================
-* Rails
-* Camping
-* Merb
-* Iowa
-* Sinatra
-
-Java Web Frameworks
-===================
-* Tapesty
-* Wicket
-* The good parts of JSF (components)
-
-Others
-======
-* Seaside
-
-== Goals 
-Accomplished goals are marked with a (*)
-- * Pure HTML templates or in-line template creation with Markaby or HAML
-- * To abstract away the request-response nature of web development and replace 
-  with events and listeners
-- * Reusable, extensible components including invisible components (behavior 
-  providers), tags (stateless components) or stateful components
-- Easy component composition and markup inheritance
-- * Multi-threading support 
-- * Heavy CoC :-) (Convention Over Configuration) ala Rails
-- * No static code generation, no generators, just a Ruby file!
-- * Component Libraries as Gems
-- * Solid Ajax support attached to the event model using a single* massively tested
-  Ajax framework/toolkit such as JQuery
-- Skinnable components a la DotNet. That is the ability to apply a theme to a 
-  page and cascade that to the contained components
-- Support for continuations in a componentized fashion (maybe)
-- CRUD behaviours for Pages/Components and using Datamapper under the covers
-- Web-based debugging and administration of the application similar to what
-  Seaside provides
-
-== Development Goals (To-do's)
-
-- Keep the core framework in a single file
-- Keep the core components in another file
-- I have not done anything about exception handling (didn't wanted to litter the
-  code base). Currently I'm always sending an HTTP 200 back or I'm just letting 
-  the app blow chuncks and showing rack's exception page
-- Radius usage is really entrenched in the current component implementation need
-  to clean it up
-- Currently Trellis uses the Mongrel Rack Adapter. In the near future the 
-  particular web server would be configurable (one of the reasons to use Rack)
-
-== Classes
-
-Trellis::Application:: Base case for all Trellis applications
-Trellis::Page:: Base class for all application Pages
-Trellis::Renderer:: Renders XML/XHTML tags in the markup using Radius 
-Trellis::Component:: Base class for all Trellis components (work in progress)
-Trellis::DefaultRouter:: Encapsulates the default routing logic
-
-== <b>Notes</b>:: 
-
-* Event model is pretty shallow right now. Basically events are just
-  a convention of how the URLs are interpreted which results on a page method
-  being invoked. A given URL contains information about the target page, event, 
-  source of the event and possible context values.This information is used to 
-  map to a single method in the page.
-* Navigation is a la Tapestry; Page methods can return the instance of a 
-  injected Page or they can return self in which case the same page is 
-  re-rendered.
-* Component can register their event handlers with the page. The page wraps the
-  event handlers of the contained components and dispatches the events to the 
-  component instance. 
-* Currently the Application is a single object, the multi-threading (which I had 
-  nothing to do with is provided by Rack) happens in the request dispatching. 
-* Trellis is not a managed framework like Tapestry, in that sense it is more like 
-  Wicket. Pages instances are just created when needed, there is no pooling, 
-  or any of the complexity involved in activating/passivating objects to a pool.
-
-== Installation
-
-* <tt>gem install trellis</tt>
-
-A Trellis application consists of the Application class; a descendant of 
-Trellis::Application and one or more pages; descendants of Trellis::Page. The
-Application at a minimum needs to declare the starting or home page:
-
-  module Hello
-    class HelloWorld < Trellis::Application
-      home :home
-    end
-
-    class Home < Trellis::Page 
-      template do html { body { h1 "Hello World!" }} end
-    end
-  end
-
-To run the above application simply add the line:
-
-  Hello::HelloWorld.new.start
-
-That will start the application on Mongrel running on port 3000 by default. To 
-run on any other port pass the port number to the start method like:
-
-  Hello::HelloWorld.new.start 8282
-
-== Required Gems
-
-rack => http://rack.rubyforge.org
-mongrel => http://mongrel.rubyforge.org
-radius => http://radius.rubyforge.org
-builder => http://builder.rubyforge.org
-paginator => http://paginator.rubyforge.org
-hpricot => http://code.whytheluckystiff.net/hpricot
-extensions => http://extensions.rubyforge.org
-haml => http://haml.hamptoncatlin.com
-markaby => http://code.whytheluckystiff.net/markaby
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright &169;2001-2009 Integrallis Software, LLC.
-
-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.
-
-== Contact
-
-Author::     Brian Sam-Bodden
-Email::      bsbodden@integrallis.com
-Home Page::  http://integrallis.com
-License::    MIT Licence (http://www.opensource.org/licenses/mit-license.html)

data/website/index.html

@@ -1,124 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-  <title>
-      Trellis
-  </title>
-  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
-<style>
-
-</style>
-  <script type="text/javascript">
-    window.onload = function() {
-      settings = {
-          tl: { radius: 10 },
-          tr: { radius: 10 },
-          bl: { radius: 10 },
-          br: { radius: 10 },
-          antiAlias: true,
-          autoPad: true,
-          validTags: ["div"]
-      }
-      var versionBox = new curvyCorners(settings, document.getElementById("version"));
-      versionBox.applyCornersToAll();
-    }
-  </script>
-</head>
-<body>
-<div id="main">
-
-    <h1>Trellis</h1>
-    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/trellis"; return false'>
-      <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/trellis" class="numbers">0.0.1</a>
-    </div>
-    <h2>What</h2>
-<p>Trellis is an object-oriented, event-driven, page and component-based Web <br />
-Application Framework written in Ruby. Its main goal is to bring <br />
-component-driven development to the micro-framework world. <br />
-The framework is a zero configuration framework.</p>
-<p>It draws inspiration from:</p>
-<p>Ruby Web Frameworks<br />
-=======</p>
-<ul>
-	<li>Rails</li>
-	<li>Camping</li>
-	<li>Merb</li>
-	<li>Iowa</li>
-</ul>
-<p>Java Web Frameworks<br />
-=======</p>
-<ul>
-	<li>Tapesty</li>
-	<li>Wicket</li>
-	<li>The good parts of <span class="caps">JSF</span> (components)</li>
-	<li>Seam (session per conversation)</li>
-</ul>
-<h2>Installing</h2>
-<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">trellis</span></pre></p>
-<h2>The basics</h2>
-<p>A Trellis application consists of the Application class; a descendant of <br />
-Trellis::Application and one or more pages; descendants of Trellis::Page. The<br />
-Application at a minimum needs to declare the starting or home page:</p>
-<p><pre class='syntax'>
-  <span class="keyword">module </span><span class="module">Hello</span>
-    <span class="keyword">class </span><span class="class">HelloWorld</span> <span class="punct">&lt;</span> <span class="constant">Trellis</span><span class="punct">::</span><span class="constant">Application</span>
-      <span class="ident">home</span> <span class="symbol">:home</span>
-    <span class="keyword">end</span>
-
-    <span class="keyword">class </span><span class="class">Home</span> <span class="punct">&lt;</span> <span class="constant">Trellis</span><span class="punct">::</span><span class="constant">Page</span> 
-      <span class="ident">template_as_markaby</span> <span class="keyword">do</span> <span class="ident">html</span> <span class="punct">{</span> <span class="ident">body</span> <span class="punct">{</span> <span class="ident">h1</span> <span class="punct">&quot;</span><span class="string">Hello World!</span><span class="punct">&quot;</span> <span class="punct">}}</span> <span class="keyword">end</span>
-    <span class="keyword">end</span>
-  <span class="keyword">end</span>
-</pre></p>
-<h2>Demonstration of usage</h2>
-<p>To run the above application simply add the line:</p>
-<pre class='syntax'><span class="constant">Hello</span><span class="punct">::</span><span class="constant">HelloWorld</span><span class="punct">.</span><span class="ident">new</span><span class="punct">.</span><span class="ident">start</span></pre>
-<p>That will start the application on Mongrel running on port 3000 by default. To <br />
-run on any other port pass the port number to the start method like:</p>
-<pre class='syntax'><span class="constant">Hello</span><span class="punct">::</span><span class="constant">HelloWorld</span><span class="punct">.</span><span class="ident">new</span><span class="punct">.</span><span class="ident">start</span> <span class="number">8282</span></pre>
-<h2>Forum</h2>
-<p><a href="http://groups.google.com/group/trellis">http://groups.google.com/group/trellis</a></p>
-<h2>How to submit patches</h2>
-<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p>
-<p><span class="caps">TODO</span> &#8211; pick <span class="caps">SVN</span> or Git instructions</p>
-<p>The trunk repository is <code>svn://rubyforge.org/var/svn/trellis/trunk</code> for anonymous access.</p>
-<p><span class="caps">OOOORRRR</span></p>
-<p>You can fetch the source from either:</p>
-<ul>
-	<li>rubyforge: <span class="caps">MISSING</span> IN <span class="caps">ACTION</span></li>
-</ul>
-<p><span class="caps">TODO</span> &#8211; You can not created a RubyForge project, OR have not run <code>rubyforge config</code><br />
-yet to refresh your local rubyforge data with this projects&#8217; id information.</p>
-<p>When you do this, this message will magically disappear!</p>
-<p>Or you can hack website/index.txt and make it all go away!!</p>
-<ul>
-	<li>github: <a href="http://github.com/GITHUB_USERNAME/trellis/tree/master">http://github.com/GITHUB_USERNAME/trellis/tree/master</a></li>
-</ul>
-<pre>git clone git://github.com/GITHUB_USERNAME/trellis.git</pre>
-<p><span class="caps">TODO</span> &#8211; add &#8220;github_username: username&#8221; to ~/.rubyforge/user-config.yml and newgem will reuse it for future projects.</p>
-<ul>
-	<li>gitorious: <a href="git://gitorious.org/trellis/mainline.git">git://gitorious.org/trellis/mainline.git</a></li>
-</ul>
-<pre>git clone git://gitorious.org/trellis/mainline.git</pre>
-<h3>Build and test instructions</h3>
-<pre>cd trellis
-rake spec
-rake install_gem</pre>
-<h2>License</h2>
-<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
-<h2>Contact</h2>
-<p>Comments are welcome. Send an email to <a href="mailto:bsbodden@integrallis.com">Brian Sam-Bodden</a> email via the <a href="http://groups.google.com/group/trellis">forum</a></p>
-    <p class="coda">
-      <a href="FIXME email">FIXME full name</a>, 25th August 2008<br>
-      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
-    </p>
-</div>
-
-<!-- insert site tracking codes here, like Google Urchin -->
-
-</body>
-</html>

data/website/index.txt

@@ -1,119 +0,0 @@
-h1. Trellis
-
-h2. What
-
-Trellis is an object-oriented, event-driven, page and component-based Web 
-Application Framework written in Ruby. Its main goal is to bring 
-component-driven development to the micro-framework world. 
-The framework is a zero configuration framework.
-
-It draws inspiration from:
-
-Ruby Web Frameworks
-===================
-* Rails
-* Camping
-* Merb
-* Iowa
-
-Java Web Frameworks
-===================
-* Tapesty
-* Wicket
-* The good parts of JSF (components)
-* Seam (session per conversation)
-
-h2. Installing
-
-<pre syntax="ruby">sudo gem install trellis</pre>
-
-h2. The basics
-
-A Trellis application consists of the Application class; a descendant of 
-Trellis::Application and one or more pages; descendants of Trellis::Page. The
-Application at a minimum needs to declare the starting or home page:
-
-<pre syntax="ruby">
-  module Hello
-    class HelloWorld < Trellis::Application
-      home :home
-    end
-
-    class Home < Trellis::Page 
-      template_as_markaby do html { body { h1 "Hello World!" }} end
-    end
-  end
-</pre>
-
-h2. Demonstration of usage
-
-To run the above application simply add the line:
-
-  <pre syntax="ruby">Hello::HelloWorld.new.start</pre>
-
-That will start the application on Mongrel running on port 3000 by default. To 
-run on any other port pass the port number to the start method like:
-
-  <pre syntax="ruby">Hello::HelloWorld.new.start 8282</pre>
-
-h2. Forum
-
-"http://groups.google.com/group/trellis":http://groups.google.com/group/trellis
-
-h2. How to submit patches
-
-Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.
-
-TODO - pick SVN or Git instructions
-
-The trunk repository is <code>svn://rubyforge.org/var/svn/trellis/trunk</code> for anonymous access.
-
-OOOORRRR
-
-You can fetch the source from either:
-
-<% if rubyforge_project_id %>
-
-* rubyforge: "http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %>":http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %>
-
-<pre>git clone git://rubyforge.org/trellis.git</pre>
-
-<% else %>
-
-* rubyforge: MISSING IN ACTION
-
-TODO - You can not created a RubyForge project, OR have not run <code>rubyforge config</code>
-yet to refresh your local rubyforge data with this projects' id information.
-
-When you do this, this message will magically disappear!
-
-Or you can hack website/index.txt and make it all go away!!
-
-<% end %>
-
-* github: "http://github.com/GITHUB_USERNAME/trellis/tree/master":http://github.com/GITHUB_USERNAME/trellis/tree/master
-
-<pre>git clone git://github.com/GITHUB_USERNAME/trellis.git</pre>
-
-
-TODO - add "github_username: username" to ~/.rubyforge/user-config.yml and newgem will reuse it for future projects.
-
-
-* gitorious: "git://gitorious.org/trellis/mainline.git":git://gitorious.org/trellis/mainline.git
-
-<pre>git clone git://gitorious.org/trellis/mainline.git</pre>
-
-h3. Build and test instructions
-
-<pre>cd trellis
-rake spec
-rake install_gem</pre>
-
-h2. License
-
-This code is free to use under the terms of the MIT license. 
-
-h2. Contact
-
-Comments are welcome. Send an email to "Brian Sam-Bodden":mailto:bsbodden@integrallis.com email via the "forum":http://groups.google.com/group/trellis
-