wee 0.10.0 → 2.0.0

data/README.rdoc

@@ -0,0 +1,127 @@
+= Wee Web Framework
+
+== Copyright and License
+
+Copyright (c) 2004, 2005, 2009 by Michael Neumann (mneumann@ntecs.de).
+
+Released under the same terms of license as Ruby.
+
+== Introduction
+
+Wee is a light-weight, very high-level and modern web-framework that makes
+<b>W</b>eb <b>e</b>ngineering <b>e</b>asy. It mainly inherits many ideas and
+features from Seaside[http://seaside.st/], but was written from scratch
+without ever looking at the Seaside (or any other) sources. All code was
+developed from ideas and lots of discussions with Avi Bryant. 
+
+== Features
+
+=== Reusable components
+
+Wee has _real_ components, which are like widgets in a GUI. Once written, you
+can use them everywhere. They are completely independent and do not interfere
+with other components. Components encapsulate state, a view and actions. Of
+course you can use an external model or use templates for rendering.
+
+=== Backtracking
+
+See the <i>What is backtracking?</i> section below. In short, backtracking lets
+the browser's back and forward-button play well together with your application.
+
+=== Clean and concise
+
+Wee is well thought out, is written in *and* supports clean and concise code.
+Furthermore I think most parts are now very well documented.
+
+=== Templating-independent 
+
+Wee does not depend on a special templating-engine. You can use a different
+templating engine for each component if you want. 
+
+=== Powerful programmatic HTML generation 
+
+Wee ships with an easy to use and very powerful programmatic HTML-generation
+library. For example you can create a select list easily with this piece of
+code:
+
+   # select an object from these items
+   items = [1, 2, 3, 4]
+
+   # the labels shown to the user
+   labels = items.map {|i| i.to_s}
+
+   # render it
+   r.select_list(items).labels(labels).callback {|choosen| p choosen}
+
+   # render a multi-select list, with objects 2 and 4 selected
+   r.select_list(items).multi.labels(labels).selected([2,4])
+
+The callback is called with the selected objects from the _items_ array.  Items
+can be any object, even whole components:
+
+   labels = ["msg1", "msg2"]
+   items = labels.collect {|m| MessageBox.new(m)}
+   r.select_list(items).labels(labels).callback {|choosen| call choosen.first} 
+
+== Observations and Limitations
+
+* Components are thread-safe by nature as a fresh components-tree is created
+  for each session and requests inside a session are serialized.
+
+== What is backtracking?
+
+If you want, you can make the back-button of your browser work correctly
+together with your web-application. Imagine you have a simple counter
+application, which shows the current count and two links _inc_ and _dec_ with
+which you can increase or decrease the current count. Starting with an inital
+count of 0 you increase the counter up to 8, then click three times the back
+button of your browser (now displays 5). Finally you decrease by one and
+your counter shows what you'd have expected: 4. In contrast, traditional
+web applications would have shown 7, because the back button usually does
+not trigger a HTTP request and as such the server-side state still has
+a value of 8 for the counter when the request to decrease comes in.
+
+The solution to this problem is to take snapshots of the components state
+after an action is performed and restoring the state before peforming
+actions. Each action generates a new state, which is indicated by
+a so-called <i>page-id</i> within the URL.
+
+== Decorations
+
+Decorations are used to modify the look and behaviour of a component without
+modifying the components tree itself. A component can have more than one
+decoration. Decorations are implemented as a linked list (Wee::Decoration#next
+points to the next decoration), starting at Wee::Component#decoration, which
+either points to the next decoration in the chain, or to itself.
+
+== The request/response cycle
+
+The request/response cycle in Wee is actually split into two separate phases.
+
+=== Render Phase
+
+The rendering phase is assumed to be side-effect free! So, you as a programmer
+should take care to meet this assumption. Rendering is performed by method
+Wee::Component#render_on.
+
+=== Action Phase (Invoking Callbacks)
+
+Possible sources for callbacks are links (anchors) and all kinds of
+form-elements like submit buttons, input-fields etc. There are two different
+kinds of callbacks:
+
+* Input callbacks (input-fields)
+
+* Action callbacks (anchor, submit-button)
+
+The distinction between input and action callbacks is important, as action
+callbacks might depend on values of input-fields being assigned to instance
+variables of the controlling component. Hence, Wee first invokes all input
+callbacks before any action callback is triggered. Callback processing
+is performed by method Wee::Component#process_callbacks.
+
+The result of the action phase is an updated components state. As such, a
+snapshot is taken of the new state and stored under a new page-id. Then, a
+redirect requests is sent back to the client, including this new page-id.
+The client automatically follows this redirect and triggers a render phase of
+the new page.

data/Rakefile

@@ -1,46 +1,25 @@
 require 'rake/rdoctask'
-require 'rake/testtask'
 
 Rake::RDocTask.new do |rd|
-  rd.main = "README"
-  rd.rdoc_dir = 'doc/tmp'
-  rd.rdoc_files.include('lib/**/*.rb', 'README', 'INSTALL')
-  rd.options << '--all --inline-source' 
+  rd.main = "README.rdoc"
+  rd.rdoc_dir = 'doc/rdoc'
+  rd.rdoc_files.include('lib/**/*.rb', 'README.rdoc')
+  rd.options << '--inline-source' 
+  rd.options << '--all' 
+  rd.options << '--accessor=html_attr=HtmlAttribute'
+  rd.options << '--accessor=generic_tag=GenericTagBrush'
+  rd.options << '--accessor=generic_single_tag=GenericSingleTagBrush'
+  rd.options << '--accessor=brush_tag=Brush'
 end
 
-task :rdoc do
-  sh 'cpdup -o doc/tmp doc/rdoc' 
-end
-
-Rake::TestTask.new do |t|
-  t.test_files = FileList['test/test*.rb']
-  t.verbose = true
+task :test do
+  sh 'mspec -I./lib -f s test/component_spec.rb'
 end
 
 task :package do
   sh 'gem build wee.gemspec' 
 end
 
-task :gem_install => [:package] do
-  sh '(yes | gem uninstall wee) || true'
-  sh 'gem install --no-rdoc wee-*.gem'
-end
-
-task :install do
-  ruby 'install.rb'
-end
-
-task :tag do
-  if File.read('lib/wee.rb') =~ /Version\s+=\s+"(\d+\.\d+\.\d+)"/
-    version = $1
-  else
-    raise "no version"
-  end
-  baseurl = "svn+ssh://ntecs.de/data/projects/svn/public/Wee"
-
-  sh "svn cp -m 'tagged #{ version }' #{ baseurl }/trunk #{ baseurl }/tags/wee-#{ version }"
-end
-
 task :clean => [:clobber_rdoc]
 
 task :default => [:test, :rdoc, :clean]

data/doc/rdoc/classes/Array.html

@@ -1,12 +1,9 @@
-<?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">
-
+<!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>
-  <title>Class: Array</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <title>Class: Array [RDoc Documentation]</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <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">
@@ -25,7 +22,7 @@
       return false;
 
     elemStyle = elem.style;
-    
+
     if ( elemStyle.display != "block" ) {
       elemStyle.display = "block"
     } else {
@@ -34,10 +31,10 @@
 
     return true;
   }
-  
+
   // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }<\/style>" )
+
   // ]]>
   </script>
 
@@ -45,7 +42,6 @@
 <body>
 
 
-
     <div id="classHeader">
         <table class="header-table">
         <tr class="top-aligned-row">
@@ -55,45 +51,56 @@
         <tr class="top-aligned-row">
             <td><strong>In:</strong></td>
             <td>
-                <a href="../files/lib/wee/snapshot_ext_rb.html">
-                lib/wee/snapshot_ext.rb
+
+
+                <a href="../files/lib/wee/state_rb.html">
+
+                lib/wee/state.rb
+
                 </a>
+
+
         <br />
+
             </td>
         </tr>
 
+
         <tr class="top-aligned-row">
             <td><strong>Parent:</strong></td>
             <td>
+
                 <a href="Object.html">
+
                 Object
+
                </a>
+
             </td>
         </tr>
+
         </table>
     </div>
   <!-- banner header -->
 
   <div id="bodyContent">
 
-
-
   <div id="contextContent">
 
-
-
    </div>
 
 
   </div>
 
-
     <!-- if includes -->
+
     <div id="includes">
       <h3 class="section-bar">Included Modules</h3>
 
       <div id="includes-list">
+
         <span class="include-name"><a href="Wee/DupReplaceSnapshotMixin.html">Wee::DupReplaceSnapshotMixin</a></span>
+
       </div>
     </div>
 
@@ -102,19 +109,16 @@
 
 
 
-
-      
+    <!-- if method_list -->
 
 
-    <!-- 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>
+</html>

data/doc/rdoc/classes/Hash.html

@@ -1,12 +1,9 @@
-<?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">
-
+<!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>
-  <title>Class: Hash</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <title>Class: Hash [RDoc Documentation]</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <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">
@@ -25,7 +22,7 @@
       return false;
 
     elemStyle = elem.style;
-    
+
     if ( elemStyle.display != "block" ) {
       elemStyle.display = "block"
     } else {
@@ -34,10 +31,10 @@
 
     return true;
   }
-  
+
   // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }<\/style>" )
+
   // ]]>
   </script>
 
@@ -45,7 +42,6 @@
 <body>
 
 
-
     <div id="classHeader">
         <table class="header-table">
         <tr class="top-aligned-row">
@@ -55,45 +51,56 @@
         <tr class="top-aligned-row">
             <td><strong>In:</strong></td>
             <td>
-                <a href="../files/lib/wee/snapshot_ext_rb.html">
-                lib/wee/snapshot_ext.rb
+
+
+                <a href="../files/lib/wee/state_rb.html">
+
+                lib/wee/state.rb
+
                 </a>
+
+
         <br />
+
             </td>
         </tr>
 
+
         <tr class="top-aligned-row">
             <td><strong>Parent:</strong></td>
             <td>
+
                 <a href="Object.html">
+
                 Object
+
                </a>
+
             </td>
         </tr>
+
         </table>
     </div>
   <!-- banner header -->
 
   <div id="bodyContent">
 
-
-
   <div id="contextContent">
 
-
-
    </div>
 
 
   </div>
 
-
     <!-- if includes -->
+
     <div id="includes">
       <h3 class="section-bar">Included Modules</h3>
 
       <div id="includes-list">
+
         <span class="include-name"><a href="Wee/DupReplaceSnapshotMixin.html">Wee::DupReplaceSnapshotMixin</a></span>
+
       </div>
     </div>
 
@@ -102,19 +109,16 @@
 
 
 
-
-      
+    <!-- if method_list -->
 
 
-    <!-- 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>
+</html>

data/doc/rdoc/classes/Object.html

@@ -1,12 +1,9 @@
-<?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">
-
+<!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>
-  <title>Class: Object</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <title>Class: Object [RDoc Documentation]</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <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">
@@ -25,7 +22,7 @@
       return false;
 
     elemStyle = elem.style;
-    
+
     if ( elemStyle.display != "block" ) {
       elemStyle.display = "block"
     } else {
@@ -34,10 +31,10 @@
 
     return true;
   }
-  
+
   // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }<\/style>" )
+
   // ]]>
   </script>
 
@@ -45,7 +42,6 @@
 <body>
 
 
-
     <div id="classHeader">
         <table class="header-table">
         <tr class="top-aligned-row">
@@ -55,124 +51,81 @@
         <tr class="top-aligned-row">
             <td><strong>In:</strong></td>
             <td>
-                <a href="../files/lib/wee/snapshot_ext_rb.html">
-                lib/wee/snapshot_ext.rb
+
+
+                <a href="../files/lib/wee/state_rb.html">
+
+                lib/wee/state.rb
+
                 </a>
+
+
         <br />
+
             </td>
         </tr>
 
+
         <tr class="top-aligned-row">
             <td><strong>Parent:</strong></td>
             <td>
+
                 <a href="Object.html">
+
                 Object
+
                </a>
+
             </td>
         </tr>
+
         </table>
     </div>
   <!-- banner header -->
 
   <div id="bodyContent">
 
-
-
   <div id="contextContent">
 
+    <div id="description">
+      <p>
+Extend base classes with snapshot functionality
+</p>
 
+    </div>
 
    </div>
 
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
-
-      <div class="name-list">
-      <a href="#M000077">restore_snapshot</a>&nbsp;&nbsp;
-      <a href="#M000076">take_snapshot</a>&nbsp;&nbsp;
-      </div>
-    </div>
 
   </div>
 
-
     <!-- if includes -->
 
-    <div id="section">
+    <div id="includes">
+      <h3 class="section-bar">Included Modules</h3>
 
+      <div id="includes-list">
 
+        <span class="include-name"><a href="Wee/ObjectSnapshotMixin.html">Wee::ObjectSnapshotMixin</a></span>
 
+      </div>
+    </div>
 
+    <div id="section">
 
-      
 
 
-    <!-- if method_list -->
-    <div id="methods">
-      <h3 class="section-bar">Public Instance methods</h3>
-
-      <div id="method-M000077" class="method-detail">
-        <a name="M000077"></a>
-
-        <div class="method-heading">
-          <a href="#M000077" class="method-signature">
-          <span class="method-name">restore_snapshot</span><span class="method-args">(snap)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000077-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000077-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/wee/snapshot_ext.rb, line 10</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">restore_snapshot</span>(<span class="ruby-identifier">snap</span>)
-    <span class="ruby-identifier">instance_variables</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">iv</span><span class="ruby-operator">|</span>
-      <span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-identifier">iv</span>, <span class="ruby-identifier">snap</span>[<span class="ruby-identifier">iv</span>])
-    <span class="ruby-keyword kw">end</span>
-  <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
 
-      <div id="method-M000076" class="method-detail">
-        <a name="M000076"></a>
-
-        <div class="method-heading">
-          <a href="#M000076" class="method-signature">
-          <span class="method-name">take_snapshot</span><span class="method-args">()</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000076-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000076-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/wee/snapshot_ext.rb, line 2</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">take_snapshot</span>
-    <span class="ruby-identifier">snap</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>
-    <span class="ruby-identifier">instance_variables</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">iv</span><span class="ruby-operator">|</span>
-      <span class="ruby-identifier">snap</span>[<span class="ruby-identifier">iv</span>] = <span class="ruby-identifier">instance_variable_get</span>(<span class="ruby-identifier">iv</span>)
-    <span class="ruby-keyword kw">end</span>
-    <span class="ruby-identifier">snap</span>
-  <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
+    <!-- if method_list -->
 
 
-    </div>
 
 
   </div>
 
-
 <div id="validator-badges">
   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 </div>
 
 </body>
-</html>
+</html>