wee 2.0.0 → 2.1.0

data/examples/recipe/migrations/001_create_recipes.rb

@@ -0,0 +1,13 @@
+class CreateRecipes < Sequel::Migration
+  def up
+    create_table :recipes do
+      primary_key :id
+      text :title
+      text :instructions
+    end
+  end
+
+  def down
+    drop_table :recipes
+  end
+end

data/examples/recipe/model.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'sequel'
+$LOAD_PATH.unshift "../../lib"
+require 'wee'
+
+DB = Sequel.postgres :database => 'cookbook', :user => 'mneumann',
+  :password => '', :host => '/var/run/postgresql'
+
+require 'models/recipe'
+require 'recipe_editor'
+
+Sequel::Migrator.apply(DB, 'migrations')
+
+class MainPage < Wee::Component
+  def initialize
+    super()
+    @child = add_child RecipeEditor.new(Recipe.new)
+  end
+
+  def render(r)
+    r.page.title('Recipes').with {
+      r.render @child
+    }
+  end
+end
+
+Wee.run(MainPage)

data/examples/recipe/models/recipe.rb

@@ -0,0 +1,18 @@
+class Recipe < Sequel::Model(:recipes)
+
+  describe :title, String
+  describe :instructions, String
+
+=begin
+  def self.describe_title
+    StringDescription.new(SymbolAccessor.new(:title, :title=))
+  end
+
+  def self.describe_instructions
+    StringDescription.new
+  end
+
+  def self.describe_self
+  end
+=end
+end

data/examples/recipe/recipe_editor.rb

@@ -0,0 +1,28 @@
+class RecipeEditor < Wee::Component
+  def initialize(instance)
+    super()
+    @instance = instance 
+  end
+
+  def render(r)
+    if @instance.new?
+      r.h1("New #{@instance.class}")
+    else
+      r.h1("Edit #{@instance.class}")
+    end
+
+    r.form do 
+      r.text "Title"
+      r.break
+      r.text_input.value(@instance.title || '').callback{|v| @instance.title = v}
+      r.paragraph
+
+      r.text "Instructions"
+      r.break
+      r.text_area.callback{|v| @instance.instructions = v}.with(@instance.instructions || '')
+      r.paragraph
+
+      r.submit_button.value(@instance.new? ? 'Create' : 'Update').callback { @instance.save }
+    end 
+  end
+end

data/lib/wee.rb

@@ -1,5 +1,5 @@
 module Wee
-  Version = "2.0.0"
+  Version = "2.1.0"
 end
 
 require 'rack'
@@ -25,12 +25,6 @@ if RUBY_VERSION >= "1.9"
     require 'continuation'
   rescue LoadError
   end
-  unless String.instance_methods.include?(:each)
-    # required by Rack
-    class String
-      def each() yield self end
-    end
-  end
 end
 
 Wee::DefaultRenderer = Wee::HtmlCanvas

data/lib/wee/component.rb

@@ -13,12 +13,7 @@ module Wee
     #
     # Initializes a newly created component.
     #
-    # Call this method from your own components' <i>initialize</i> method using
-    # +super+, before setting up anything else! 
-    #
-    def initialize() # :notnew:
-      @decoration = self
-      @children = nil
+    def initialize
     end
 
     #
@@ -33,26 +28,6 @@ module Wee
     def render(r)
     end
 
-    #
-    # Process and invoke all callbacks specified for this component and all of
-    # it's child components. 
-    #
-    def process_callbacks(callbacks)
-      callbacks.input_callbacks.each_triggered(self) do |callback, value|
-        callback.call(value)
-      end
-
-      # process callbacks of all children
-      each_child do |child|
-        child.decoration.process_callbacks(callbacks)
-      end
-
-      callbacks.action_callbacks.each_triggered(self) do |callback, value|
-        callback.call
-        session.send_response(nil) # prematurely end callback processing
-      end
-    end
-
     #
     # Take snapshots of objects that should correctly be backtracked.
     #
@@ -65,72 +40,60 @@ module Wee
     # <i>marshal_load</i>). Overwrite them if you want to define special
     # behaviour. 
     #
-    # For example if you dynamically add children to your component, you might
-    # want to backtrack the children array: 
-    #
-    #   def backtrack(state)
-    #     super
-    #     backtrack_children(state)
-    #   end
-    #
     # By default only the decoration chain is backtracked. This is
     # required to correctly backtrack called components. To disable
     # backtracking of the decorations, change method
-    # Component#backtrack_decoration to a no-operation:
+    # Component#state_decoration to a no-operation:
     #
-    #   def backtrack_decoration(state)
+    #   def state_decoration(s)
     #     # nothing here
     #   end
     #
-    # [+state+]
+    # [+s+]
     #    An object of class State
     #
-    def backtrack(state)
-      backtrack_decoration(state)
-      each_child do |child|
-        child.decoration.backtrack(state)
+    def state(s)
+      state_decoration(s)
+      for child in self.children
+        child.decoration.state(s)
       end
     end
 
-    protected
-
-    def backtrack_decoration(state)
-      state.add_ivar(self, :@decoration, @decoration)
-    end
-
-    def backtrack_children(state)
-      state.add_ivar(self, :@children, (@children and @children.dup))
-    end
-
+    NO_CHILDREN = [].freeze
+    #
+    # Return all child components.
     #
-    # Iterates over all direct child components. 
+    # *OVERWRITE* this method and return all child components
+    # collected in an array.
     #
-    def each_child(&block)
-      @children.each(&block) if @children
+    def children
+      return NO_CHILDREN
     end
 
     #
-    # Add a child to the component. Example:
-    # 
-    #   class YourComponent < Wee::Component
-    #     def initialize
-    #       super()
-    #       add_child ChildComponent.new
-    #     end
-    #   end
-    #
-    # If you dynamically add child components to a component at run-time (not in
-    # initialize), then you should consider to backtrack the children array (of
-    # course only if you want backtracking at all): 
-    #   
-    #   def backtrack(state)
-    #     super
-    #     state.add(self.children)
-    #   end
+    # Process and invoke all callbacks specified for this component and all of
+    # it's child components. 
     #
-    def add_child(child)
-      (@children ||= []) << child
-      child
+    def process_callbacks(callbacks)
+      callbacks.input_callbacks.each_triggered(self) do |callback, value|
+        callback.call(value)
+      end
+
+      # process callbacks of all children
+      for child in self.children
+        child.decoration.process_callbacks(callbacks)
+      end
+
+      callbacks.action_callbacks.each_triggered(self) do |callback, value|
+        callback.call
+        session.send_response(nil) # prematurely end callback processing
+      end
+    end
+
+    protected
+
+    def state_decoration(s)
+      s.add_ivar(self, :@decoration, @decoration)
     end
 
     include Wee::DecorationMixin

data/lib/wee/decoration.rb

@@ -4,7 +4,7 @@ module Wee
 
   #
   # Abstract base class of all decorations. Forwards the methods
-  # #process_callbacks, #render_on and #backtrack to the next decoration in
+  # #process_callbacks, #render_on and #state to the next decoration in
   # the chain. Subclasses should provide special behaviour in these methods,
   # otherwise the decoration does not make sense.
   #
@@ -62,16 +62,17 @@ module Wee
     # answer-decoration has the advantage to be able to call a component more
     # than once!
     #
-    def backtrack(state)
-      @next.backtrack(state)
-      state.add_ivar(self, :@next, @next)
+    def state(s)
+      @next.state(s)
+      s.add_ivar(self, :@next, @next)
     end
 
   end # class Decoration
 
   module DecorationMixin
 
-    attr_accessor :decoration
+    def decoration=(d) @decoration = d end
+    def decoration() @decoration || self end 
 
     #
     # Iterates over all decorations (note that the component itself is excluded). 
@@ -95,8 +96,8 @@ module Wee
     #
     def add_decoration(d)
       if d.global?
-        d.next = @decoration
-        @decoration = d
+        d.next = self.decoration
+        self.decoration = d
       else
         last_global = nil
         each_decoration {|i| 
@@ -108,8 +109,8 @@ module Wee
         }
         if last_global.nil?
           # no global decorations specified -> add in front
-          d.next = @decoration
-          @decoration = d
+          d.next = self.decoration
+          self.decoration = d
         else
           # add after last_global
           d.next = last_global.next
@@ -127,10 +128,10 @@ module Wee
     # decoration chain.
     #
     def remove_decoration(d)
-      if d == @decoration  # 'd' is in front
-        @decoration = d.next
+      if d == self.decoration  # 'd' is in front
+        self.decoration = d.next
       else
-        last_decoration = @decoration
+        last_decoration = self.decoration
         next_decoration = nil
         loop do
           return nil if last_decoration == self or last_decoration.nil?
@@ -161,7 +162,7 @@ module Wee
 
   #
   # A Wee::Delegate breaks the decoration chain and forwards the methods
-  # #process_callbacks, #render_on and #backtrack to the corresponding *chain*
+  # #process_callbacks, #render_on and #state to the corresponding *chain*
   # method of it's _delegate_ component (a Wee::Component).
   #
   class Delegate < Decoration
@@ -191,9 +192,9 @@ module Wee
     # _delegate_ component. We also take snapshots of all non-visible
     # components, thus we follow the @next decoration (via super).
     #
-    def backtrack(state)
+    def state(s)
       super
-      @delegate.decoration.backtrack(state)
+      @delegate.decoration.state(s)
     end
 
   end # class Delegate

data/lib/wee/html_brushes.rb

@@ -554,27 +554,26 @@ module Wee
       # A callback was specified. We have to wrap it inside another
       # callback, as we want to perform some additional actions.
       #
-      name(@canvas.register_callback(:input, proc {|input|
-        input = [input] unless input.kind_of?(Array)
-        choosen = input.map {|idx| get_item(idx) }
-
-        if @attributes.has_key?(:multiple)
-          @callback.call(choosen)
-        elsif choosen.size > 1
-          raise "more than one element was choosen from a not-multiple SelectListTag" 
-        else
-          @callback.call(choosen.first)
-        end
-      }))
+      name(@canvas.register_callback(:input, method(:handler)) + "[]") 
     end
 
-    def get_item(idx)
-      idx = Integer(idx)
-      raise IndexError if idx < 0 or idx > @items.size
-      @items[idx]
+    def handler(input)
+      choosen = input.map {|idx|
+        idx = Integer(idx)
+        raise IndexError if idx < 0 or idx > @items.size
+        @items[idx]
+      }
+
+      if @attributes.has_key?(:multiple)
+        @callback.call(choosen)
+      elsif choosen.size > 1
+        raise "more than one element was choosen from a not-multiple SelectListTag" 
+      else
+        @callback.call(choosen.first)
+      end
     end
 
-    protected :get_item
+    protected :handler
 
     def with
       @labels ||= @items.collect {|i| i.to_s}

data/lib/wee/presenter.rb

@@ -14,7 +14,8 @@ module Wee
     end
 
     def render(r); raise end
-    def backtrack(state); raise end
+    def state(s); raise end
+
     def process_callbacks(callbacks); raise end
 
     #

data/lib/wee/response.rb

@@ -17,7 +17,7 @@ module Wee
     end
   end
 
-  class RedirectResponse < GenericResponse
+  class RedirectResponse < Response
     LOCATION_HEADER = 'Location'.freeze
 
     def initialize(location)
@@ -27,9 +27,9 @@ module Wee
     end
   end
 
-  class RefreshResponse < GenericResponse
+  class RefreshResponse < Response
     def initialize(message, location, seconds=5)
-      super(%[<html>
+      super([%[<html>
         <head>
           <meta http-equiv="REFRESH" content="#{seconds};URL=#{location}">
           <title>#{message}</title>
@@ -39,7 +39,7 @@ module Wee
           You are being redirected to <a href="#{location}">#{location}</a> 
           in #{seconds} seconds.
         </body>
-        </html>])
+        </html>]])
     end
   end
 

data/lib/wee/session.rb

@@ -332,8 +332,8 @@ module Wee
     # and returns it.
     #
     def take_snapshot
-      @root_component.decoration.backtrack(state = Wee::State.new)
-      return state.freeze
+      @root_component.decoration.state(s = Wee::State.new)
+      return s.freeze
     end
 
   end # class Session

data/lib/wee/state.rb

@@ -4,9 +4,9 @@ module Wee
   # This class is for backtracking the state of components (or
   # decorations/presenters).  Components that want an undo-facility to be
   # implemented (triggered for example by a browsers back-button), have to
-  # overwrite the Component#backtrack method. Class Wee::State simply
+  # overwrite the Component#state method. Class Wee::State simply
   # represents a collection of objects from which snapshots were taken via
-  # methods take_snapshot. 
+  # methods take_snapshot.
   #
   class State
     class Snapshot < Struct.new(:object, :snapshot); end