wee 0.4.0 → 0.5.0

data/ChangeLog

@@ -0,0 +1,75 @@
+Wed Jan 26 20:22:55 CET 2005	Michael Neumann <mneumann@ntecs.de>
+
+	* Raised version up to 0.5.0 (nearing a release)
+
+	* Fixed test cases.
+
+Wed Jan 26 18:19:39 CET 2005	Michael Neumann	<mneumann@ntecs.de>
+
+	* updated docs
+
+	* made Component#call's marshallable by using an object of class
+	  Wee::Component::OnAnswer instead of a Proc.  
+
+	* Moved all continuation-dependent code into directory
+	  wee/continuation. By default Wee uses no continuations, you have to
+	  require 'wee/continuation' to enable them.
+
+Wed Jan 26 13:51:22 CET 2005	Michael Neumann	<mneumann@ntecs.de>
+
+	* If you pass nil to an attribute method of a Brush, e.g.
+
+	    r.table_data.width(nil)
+
+	  This will remove the 'width' attribute from the tag.
+	
+	* Method HtmlCanvas#javascript added:
+
+	    # external javascript resource
+	    r.javascript.src('/test.js') 
+
+	    # internal javascript 
+	    r.javascript.with('function js() { ... }')
+
+	* Method Presenter.uses_property added. Used to declare required
+	  properties. This has actually no effect. It's sole purpose is to 
+	  describe the dependencies.
+
+NO DATE AVAILABLE		Michael Neumann <mneumann@ntecs.de>
+
+	* Enable Socket.do_not_reverse_lookup in WEBrickAdaptor by default, as
+	  this has been the reason for much slowliness
+
+	* Method Component#add_child returns the child so that the following
+	  code becomes possible:
+
+	    @pager = add_child Pager.new(...)
+
+	* Added experimental property system.
+
+	* Added methods GenericTagBrush#onclick_callback, HtmlCanvas#link_css,
+	  lots of refactoring
+
+	* New examples: hw.rb, live-update.rb, calculator.rb  
+
+	* Wee::Brush::InputTag: methods #disabled and #readonly added
+
+	* Wee::Utils.app_for takes now (optionally) a block.
+
+	* Wee::MessageBox, Wee::WrapperDecoration, Wee::FromDecoration added
+
+	* Wee::Session#current_page, #current_context methods added
+
+	* added ground-work for live-updates (see examples/live-update.rb)
+
+	* added wee/databases/og.rb, which defines OgApplication and
+	  OgSession, as well as a generic (but still very limited)
+	  OgScaffolder. 
+
+	* Methods Wee::Session#sleep and #awake added, which are called before and
+	  after the request is handled. They can be used for example to setup
+	  and release a database connection.
+
+	* Wee::Helper.app_for is now Wee::Utils.app_for
+
+	* require 'wee/utils' will load all utility methods.

data/README

@@ -10,12 +10,15 @@ different terms.
 
 == Status and Bugs
 
-Wee is not considered production ready! It should only be used for small
-things. 
+Wee is now considered pretty stable (if you don't use continuations).
+Nevertheless I wouldn't use it yet for mission-critical applications ;-)
 
 Known Bugs:
 
-* Continuations leak memory!
+* Using continuations might leak memory, at least they did in the past. The
+latest memory stress-test has not showed up any memory problems, but since I
+haven't changed anything at the continuation implementation, I can't say for
+sure whether the problem has been fixed or not. 
 
 == Introduction
 
@@ -80,11 +83,12 @@ can be any object, e.g. whole components:
    items = labels.collect {|m| MessageBox.new(m)}
    r.select_list(items).labels(labels).callback {|choosen| call choosen.first} 
 
-=== Continuation based (Optional)
+=== Optional use of Continuations
 
-<b>IMPORTANT:</b> <i>The current implementation of continuations in Ruby might lead
-to memory leaks, if you use continuations. Furthermore, if you use
-continuations, it's no longer possible to store the session state to disk.</i>
+<b>IMPORTANT:</b> <i>The current implementation of continuations in Ruby (or
+their use in Wee) might lead to memory leaks, if you use continuations.
+Furthermore, if you use continuations, it's no longer possible to store the
+session state to disk.</i>
 
 Continuation-based frameworks are also known as _modal_ frameworks. You can
 write code like the one shown below (taken from one of Avi's emails) where each
@@ -104,6 +108,10 @@ method displays a new page:
 Try to implement the same in a non-continuation based framework and show me
 your code... ;-)
 
+To enable continuations, you have to require:
+
+  require 'wee/continuation'
+
 === Fully Marshallable (drops Continuation support)
 
 If you don't need continuations, Wee can be made fully marshallable. It is not
@@ -119,8 +127,8 @@ yet fully marshallable (it was in the past), but it can be made, if required.
   DragonFly[www.dragonflybsd.org]. But with this approach it's still impossible
   to store sessions _selectively_ to disk. 
 
-* Each session runs in it's own (light-weigth) thread (this is a neccessity
-  when using continuations).
+* When using continuations, each session runs in it's own (light-weigth)
+  thread. This is not the case if you don't use continuations.
 
 * Only one action callback can be invoked per request (a former version of Wee
   was able to invoke multiple callback, and answer even from multiple

data/Rakefile

@@ -22,8 +22,8 @@ task :package do
 end
 
 task :local_install => [:package] do
-  sh 'gem uninstall wee || true'
-  sh 'gem install wee-*.gem'
+  sh '(yes | gem uninstall wee) || true'
+  sh 'gem install --no-rdoc wee-*.gem'
 end
 
 task :clean => [:clobber_rdoc]

data/TODO

@@ -1,3 +1,23 @@
+* OgScaffolder: cache fields
+
+* LiteralMethodCallback: use a simple symbol instead?
+
+* brushes.rb: tags as constants
+
+* Session.new(application)
+
+* live updates
+
+* transactions
+
+* use it with databases 
+
+* diverting html-renderer
+
+* Add unit-tests for new global/local decorations
+
+* MessageBox: Buttons: OK_Cancel, YES_NO, Confirm  
+
 * req-handler gc interval
 
 * use LiteralMethod object instead of block if callback(:method_name) is given

data/benchmark/Makefile

@@ -1,4 +1,6 @@
 N=2000
+PORT=2000
+COUNTERS=10
 
 RUBY=ruby
 
@@ -7,21 +9,24 @@ all: bench1 bench2
 
 start_counter:
 	# start the counter app
-	$(RUBY) counter.rb 2000 > /dev/null 2> /dev/null &
+	$(RUBY) counter.rb $(PORT) $(COUNTERS) > /dev/null 2> /dev/null &
 	sleep 3
 
 stop_counter:
-	kill -9 `cat counter.2000.pid`
-	rm -f counter.2000.pid
+	kill -9 `cat counter.$(PORT).pid`
+	rm -f counter.$(PORT).pid
 	rm -f dump
 
 bench_counter:
 	# generate initial session and first page
-	fetch -o counter.html http://localhost:2000/counter
+	fetch -o counter.html http://localhost:$(PORT)/counter
 
 	# perform benchmark
-	ab -n ${N} http://localhost:2000/counter/s:1/p:1 > result.${N}.counter.render
-	ab -n ${N} http://localhost:2000/counter/s:1/p:1/h:1 > result.${N}.counter.action
+	ab -n ${N} http://localhost:$(PORT)/counter/@1/1 > result.${N}.counter.render
+	ab -n ${N} http://localhost:$(PORT)/counter/@1/1?4 > result.${N}.counter.action
+
+report_counter:
+	$(RUBY) report_req.rb result.$(N).counter.render result.$(N).counter.action
 
 start_filehandler:
 	# start the filehandler app
@@ -33,16 +38,16 @@ stop_filehandler:
 	rm -f filehandler.pid
 
 bench_filehandler:
-	ab -n ${N} http://localhost:2000/counter.html > result.${N}.filehandler
+	ab -n ${N} http://localhost:$(PORT)/counter.html > result.${N}.filehandler
 
 clean:
-	rm -f counter.2000.pid
+	rm -f counter.$(PORT).pid
 	rm -f filehandler.pid
 	rm -f dump
 	rm -f result.${N}.*
 	rm -f counter.html
 
-bench1: start_counter bench_counter stop_counter
+bench1: start_counter bench_counter stop_counter report_counter
 bench2: start_filehandler bench_filehandler stop_filehandler
 
 

data/benchmark/counter.rb

@@ -1,7 +1,7 @@
 $LOAD_PATH.unshift '../lib'
 require 'wee'
-require 'wee/webrick'
-require 'wee/utils/cache'
+require 'wee/adaptors/webrick'
+require 'wee/utils'
 
 class Counter < Wee::Component 
   def initialize(cnt)
@@ -24,18 +24,18 @@ class Counter < Wee::Component
   end
 
   def render
-    r.form.action(:submit).with do
-      r.anchor.action(:dec).with("--")
+    r.form.callback(:submit).with do
+      r.anchor.callback(:dec).with("--")
       r.space
 
       if @show_edit_field
-        r.text_input.assign(:cnt=).value(@cnt).size(6)
+        r.text_input.callback(:cnt=).value(@cnt).size(6)
       else
-        r.anchor.action(:submit).with(@cnt) 
+        r.anchor.callback(:submit).with(@cnt) 
       end
 
       r.space
-      r.anchor.action(:inc).with("++")
+      r.anchor.callback(:inc).with("++")
     end
   end
 
@@ -57,7 +57,7 @@ end
 class Main < Wee::Component
   def initialize
     super()
-    @counters = (1..20).map {|i| Counter.new(i)}
+    @counters = (1..COUNTERS).map {|i| Counter.new(i)}
     children.push(*@counters)
   end
 
@@ -68,29 +68,10 @@ class Main < Wee::Component
   end
 end
 
-class MySession < Wee::Session
-  def initialize
-    super do
-      self.root_component = Main.new
-      self.page_store = Wee::Utils::LRUCache.new(10) # backtrack up to 10 pages
-    end
-  end
-end
-
-class MyApplication < Wee::Application
-  def setup_session_id_generator
-    @session_cnt = 0
-  end
-end
-
-
 if __FILE__ == $0
   PORT = (ARGV[0] || 2000).to_i
+  COUNTERS = (ARGV[1] || 20).to_i
   File.open("counter.#{ PORT }.pid", 'w+') {|f| f.puts($$.to_s) }
-  MyApplication.new {|app|
-    app.name = 'Counter'
-    app.path = '/counter'
-    app.session_class = MySession
-    app.session_store = Wee::Utils::LRUCache.new(100) # handle up to 100 sessions
-  }.start(:Port => PORT) 
+  app = Wee::Utils.app_for(Main, :id_seed => 0, :page_cache_capacity => 10)
+  Wee::WEBrickAdaptor.register('/counter' => app).start(:Port => PORT) 
 end

data/benchmark/report_req.rb

@@ -0,0 +1,12 @@
+sum = 0.0
+
+ARGV.each do |f|
+  data = File.read(f)
+  if data =~ /^Requests per second:\s+(\d+.\d+)/
+    sum += 1/$1.to_f
+  else
+    raise "no req/sec found"
+  end
+end
+
+puts 1/sum

data/doc/rdoc/classes/Array.html

@@ -88,8 +88,8 @@
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000004">restore_snapshot</a>&nbsp;&nbsp;
-      <a href="#M000003">take_snapshot</a>&nbsp;&nbsp;
+      <a href="#M000006">restore_snapshot</a>&nbsp;&nbsp;
+      <a href="#M000005">take_snapshot</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -111,19 +111,19 @@
     <div id="methods">
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000004" class="method-detail">
-        <a name="M000004"></a>
+      <div id="method-M000006" class="method-detail">
+        <a name="M000006"></a>
 
         <div class="method-heading">
-          <a href="#M000004" class="method-signature">
+          <a href="#M000006" 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('M000004-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000004-source">
+            onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000006-source">
 <pre>
 <span class="ruby-comment cmt"># File lib/wee/snapshot_ext.rb, line 22</span>
   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">restore_snapshot</span>(<span class="ruby-identifier">snap</span>)
@@ -134,19 +134,19 @@
         </div>
       </div>
 
-      <div id="method-M000003" class="method-detail">
-        <a name="M000003"></a>
+      <div id="method-M000005" class="method-detail">
+        <a name="M000005"></a>
 
         <div class="method-heading">
-          <a href="#M000003" class="method-signature">
+          <a href="#M000005" 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('M000003-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000003-source">
+            onclick="toggleCode('M000005-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000005-source">
 <pre>
 <span class="ruby-comment cmt"># File lib/wee/snapshot_ext.rb, line 18</span>
   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">take_snapshot</span>

data/doc/rdoc/classes/Cache/StorageCache.html

@@ -101,13 +101,13 @@ protocol that the <em>store</em> must understand is:
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000010">[]</a>&nbsp;&nbsp;
-      <a href="#M000011">[]=</a>&nbsp;&nbsp;
-      <a href="#M000007">delete</a>&nbsp;&nbsp;
-      <a href="#M000008">fetch</a>&nbsp;&nbsp;
-      <a href="#M000006">has_key?</a>&nbsp;&nbsp;
-      <a href="#M000005">new</a>&nbsp;&nbsp;
-      <a href="#M000009">store</a>&nbsp;&nbsp;
+      <a href="#M000012">[]</a>&nbsp;&nbsp;
+      <a href="#M000013">[]=</a>&nbsp;&nbsp;
+      <a href="#M000009">delete</a>&nbsp;&nbsp;
+      <a href="#M000010">fetch</a>&nbsp;&nbsp;
+      <a href="#M000008">has_key?</a>&nbsp;&nbsp;
+      <a href="#M000007">new</a>&nbsp;&nbsp;
+      <a href="#M000011">store</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -129,19 +129,19 @@ protocol that the <em>store</em> must understand is:
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000005" class="method-detail">
-        <a name="M000005"></a>
+      <div id="method-M000007" class="method-detail">
+        <a name="M000007"></a>
 
         <div class="method-heading">
-          <a href="#M000005" class="method-signature">
+          <a href="#M000007" class="method-signature">
           <span class="method-name">new</span><span class="method-args">(strategy, store=Hash.new, store_on_update=false)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000005-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000005-source">
+            onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000007-source">
 <pre>
 <span class="ruby-comment cmt"># File lib/cache/cache.rb, line 114</span>
   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">strategy</span>, <span class="ruby-identifier">store</span>=<span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>, <span class="ruby-identifier">store_on_update</span>=<span class="ruby-keyword kw">false</span>)
@@ -156,8 +156,8 @@ protocol that the <em>store</em> must understand is:
 
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000010" class="method-detail">
-        <a name="M000010"></a>
+      <div id="method-M000012" class="method-detail">
+        <a name="M000012"></a>
 
         <div class="method-heading">
           <span class="method-name">[]</span><span class="method-args">(key, default_value=nil)</span>
@@ -165,13 +165,13 @@ protocol that the <em>store</em> must understand is:
       
         <div class="method-description">
           <p>
-Alias for <a href="StorageCache.html#M000008">fetch</a>
+Alias for <a href="StorageCache.html#M000010">fetch</a>
 </p>
         </div>
       </div>
 
-      <div id="method-M000011" class="method-detail">
-        <a name="M000011"></a>
+      <div id="method-M000013" class="method-detail">
+        <a name="M000013"></a>
 
         <div class="method-heading">
           <span class="method-name">[]=</span><span class="method-args">(key, value)</span>
@@ -179,24 +179,24 @@ Alias for <a href="StorageCache.html#M000008">fetch</a>
       
         <div class="method-description">
           <p>
-Alias for <a href="StorageCache.html#M000009">store</a>
+Alias for <a href="StorageCache.html#M000011">store</a>
 </p>
         </div>
       </div>
 
-      <div id="method-M000007" class="method-detail">
-        <a name="M000007"></a>
+      <div id="method-M000009" class="method-detail">
+        <a name="M000009"></a>
 
         <div class="method-heading">
-          <a href="#M000007" class="method-signature">
+          <a href="#M000009" class="method-signature">
           <span class="method-name">delete</span><span class="method-args">(key)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000007-source">
+            onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000009-source">
 <pre>
 <span class="ruby-comment cmt"># File lib/cache/cache.rb, line 124</span>
   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">delete</span>(<span class="ruby-identifier">key</span>)
@@ -213,19 +213,19 @@ Alias for <a href="StorageCache.html#M000009">store</a>
         </div>
       </div>
 
-      <div id="method-M000008" class="method-detail">
-        <a name="M000008"></a>
+      <div id="method-M000010" class="method-detail">
+        <a name="M000010"></a>
 
         <div class="method-heading">
-          <a href="#M000008" class="method-signature">
+          <a href="#M000010" class="method-signature">
           <span class="method-name">fetch</span><span class="method-args">(key, default_value=nil)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000008-source">
+            onclick="toggleCode('M000010-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000010-source">
 <pre>
 <span class="ruby-comment cmt"># File lib/cache/cache.rb, line 134</span>
   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">default_value</span>=<span class="ruby-keyword kw">nil</span>)
@@ -243,19 +243,19 @@ Alias for <a href="StorageCache.html#M000009">store</a>
         </div>
       </div>
 
-      <div id="method-M000006" class="method-detail">
-        <a name="M000006"></a>
+      <div id="method-M000008" class="method-detail">
+        <a name="M000008"></a>
 
         <div class="method-heading">
-          <a href="#M000006" class="method-signature">
+          <a href="#M000008" class="method-signature">
           <span class="method-name">has_key?</span><span class="method-args">(key)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000006-source">
+            onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000008-source">
 <pre>
 <span class="ruby-comment cmt"># File lib/cache/cache.rb, line 120</span>
   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">key</span>)
@@ -266,19 +266,19 @@ Alias for <a href="StorageCache.html#M000009">store</a>
         </div>
       </div>
 
-      <div id="method-M000009" class="method-detail">
-        <a name="M000009"></a>
+      <div id="method-M000011" class="method-detail">
+        <a name="M000011"></a>
 
         <div class="method-heading">
-          <a href="#M000009" class="method-signature">
+          <a href="#M000011" class="method-signature">
           <span class="method-name">store</span><span class="method-args">(key, value)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000009-source">
+            onclick="toggleCode('M000011-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000011-source">
 <pre>
 <span class="ruby-comment cmt"># File lib/cache/cache.rb, line 145</span>
   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">store</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>)