facets 1.3.3 → 1.4.0

data/lib/facets/more/recorder.rb

@@ -1,28 +1,27 @@
-#--
-# Multiton
+# = multiton.rb
 #
-# Copyright (c) 2005 Thomas Sawyer
+# == Copyright (c) 2005 Thomas Sawyer
 #
-# Ruby License
+#   Ruby License
 #
-# This module is free software. You may use, modify, and/or redistribute this
-# software under the same terms as Ruby.
+#   This module is free software. You may use, modify, and/or redistribute this
+#   software under the same terms as Ruby.
 #
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.
+#   This program is distributed in the hope that it will be useful, but WITHOUT
+#   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+#   FOR A PARTICULAR PURPOSE.
 #
+# == Author(s)
 #
-# ==========================================================================
-# Revision History ::
-# --------------------------------------------------------------------------
-#  2006-04-04   trans    * Created
-# ==========================================================================
-#++
+# * Thomas Sawyer
+
+# Author::    Thomas Sawyer
+# Copyright:: Copyright (c) 2006 Thomas Sawyer
+# License::   Ruby License
 
 require 'facets/more/basicobject'
 
-#:title: Recorder
+# = Recorder
 #
 # Recorder is similar essentially a method probe. It records everthing
 # that happens to it, building an internal parse tree. You can then
@@ -50,10 +49,6 @@ require 'facets/more/basicobject'
 #
 #   true
 #
-# == Author(s)
-#
-# * Thomas Sawyer
-#
 
 class Recorder < BasicObject
 

data/lib/facets/more/reference.rb

@@ -1,36 +1,35 @@
-#--
-# Reference
+# = reference.rb
 #
-# Copyright (c) 2005 Thomas Sawyer
+# == Copyright (c) 2005 Thomas Sawyer
 #
-# Ruby License
+#   Ruby License
 #
-# This module is free software. You may use, modify, and/or redistribute this
-# software under the same terms as Ruby.
+#   This module is free software. You may use, modify, and/or redistribute this
+#   software under the same terms as Ruby.
 #
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.
+#   This program is distributed in the hope that it will be useful, but WITHOUT
+#   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+#   FOR A PARTICULAR PURPOSE.
 #
-# ==========================================================================
-#  Revision History
-# ==========================================================================
-#  2005.06.12    trans
-#  Changed name from Ref to Reference.
-# ==========================================================================
-#++
+# == Author(s)
+#
+# * Thomas Sawyer
 
 require 'facets/more/basicobject'
 
-#:title: Reference
+# = Reference
 #
-#   TODO
+# Reference provides a way to access object indirectly.
+# This allows for the object itself to be changed on the fly.
 #
 # == Synopsis
 #
-#   a = "Hello"
+#   a = "HELLO"
 #   b = ref(a)
-#   b.upcase  #=> "HELLO"
+#   puts b    #=> "HELLO"
+#   c = 10
+#   b.become(c)
+#   puts b    #=> "10"
 #
 
 class Reference < BasicObject
@@ -60,9 +59,13 @@ end
 
 
 module Kernel
+
+  # Shortcut reference constructor.
+
   def ref(x)
     Reference.new(x)
   end
+
 end
 
 
@@ -74,10 +77,10 @@ end
 #   |_|\___||___/\__|
 #
 
-# TODO
-
 =begin #test
 
   require 'test/unit'
 
+  # TODO
+
 =end

data/lib/facets/more/rexmlbuilder.rb

@@ -1,12 +1,28 @@
-#--
-# REXMLBuilder
-#++
+# = rexmlbuilder.rb
+#
+# == Copyright (c) 2006 Thomas Sawyer
+#
+#   Ruby License
+#
+#   This module is free software. You may use, modify, and/or redistribute this
+#   software under the same terms as Ruby.
+#
+#   This program is distributed in the hope that it will be useful, but WITHOUT
+#   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+#   FOR A PARTICULAR PURPOSE.
+#
+# == Author(s)
+#
+# * Thomas Sawyer
 
-require 'rexml/document'
+# Author::    Thomas Sawyer
+# Copyright:: Copyright (c) 2006 Thomas Sawyer
+# License::   Ruby License
 
+require 'rexml/document'
 require 'facets/more/functor' # already requires basicobject
 
-# :title: REXMLBuilder
+# = REXMLBuilder
 #
 # Build XML Documents programatically with Ruby and REXML
 # via the Builder Pattern --made possible by Ruby's blocks.
@@ -44,7 +60,6 @@ require 'facets/more/functor' # already requires basicobject
 # external values, ie. if 'favs' were used as in the previous
 # example, it would be interpreted as another tag entry, not
 # the array.
-#
 
 class REXMLBuilder < BasicObject
 

data/lib/facets/more/rtals.rb

@@ -1,20 +1,27 @@
-#--
-# RubyTals
-# Copyright (c) 2006 Thomas Sawyer
+# = rtals.rb
 #
-# Ruby License
+# == Copyright (c) 2006 Thomas Sawyer
 #
-# This module is free software. You may use, modify, and/or redistribute this
-# software under the same terms as Ruby.
+#   Ruby License
 #
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.
-#++
+#   This module is free software. You may use, modify, and/or redistribute this
+#   software under the same terms as Ruby.
+#
+#   This program is distributed in the hope that it will be useful, but WITHOUT
+#   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+#   FOR A PARTICULAR PURPOSE.
+#
+# == Author(s)
+#
+# * Thomas Sawyer
+
+# Author::    Thomas Sawyer
+# Copyright:: Copyright (c) 2006 Thomas Sawyer
+# License::   Ruby License
 
 require 'rexml/document'
 
-# RubyTals
+# = Tag Attribute Language for Ruby
 #
 # RubyTals is a Ruby variation on Zope Page Templates and it's TAL specification.
 # It differs from TAL in that it is specifically geared for use by Ruby.
@@ -42,7 +49,6 @@ require 'rexml/document'
 #   prg = RubyTals.compile( s )
 #   puts eval(prg)
 #
-#
 # == Note
 #
 # WARNING! This library is only minimally functional at this point.
@@ -69,24 +75,21 @@ require 'rexml/document'
 #     size > 1
 #   end
 #
-# It's a classic Saftey vs. Usability trade-off.
-# And something to consider for the future.
-#
-# == Author(s)
-#
-# * Thomas Sawyer
-#
+# It's a classic Saftey vs. Usability trade-off. Something to
+# consider for the future.
 
 module RubyTals
 
   def self.compile( xmlstr )
     rxml = REXML::Document.new( xmlstr.strip )
-    parse( rxml )
+    "out=''\n" + parse( rxml ) + "\nout"
   end
 
-  #def self.evaluate( xomp, out='' )
-  #  eval xomp
-  #end
+  def self.execute( script, data )
+    vars.each_pair { |k,v|
+    }
+    eval script
+  end
 
   def self.parse( xml )
     building = ''
@@ -101,7 +104,7 @@ module RubyTals
 
         attributes, ruby_attributes = {}, {}
         elem.attributes.each { |k, v|
-          if k =~ /^ruby:/i
+          if k =~ /^rtal:/i
             ruby_attributes[k.sub(/^rtal:/i,'')] = v
           else
             attributes[k] = v

data/lib/facets/more/semaphore.rb

@@ -1,41 +1,28 @@
-#--
-# Semaphore
+# = semaphore.rb
 #
-# Copyright (c) 2005 Fukumoto
+# == Copyright (c) 2005 Fukumoto
 #
-# Ruby License
+#   Ruby License
 #
-# This module is free software. You may use, modify, and/or redistribute this
-# software under the same terms as Ruby.
+#   This module is free software. You may use, modify, and/or redistribute this
+#   software under the same terms as Ruby.
 #
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.
+#   This program is distributed in the hope that it will be useful, but WITHOUT
+#   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+#   FOR A PARTICULAR PURPOSE.
 #
-# ==========================================================================
-#  Revision History
-# ==========================================================================
-#
-#  2005-04-28 Trans  - Ported to Calibre.
+# == Author(s)
 #
-# ==========================================================================
-#++
+# * Fukumoto
 
-#:title: Semaphore
+# Author::    Fukumoto
+# Copyright:: Copyright (c) 2005 Fukumoto
+# License::   Ruby License
+
+# = Semaphore
 #
 # Technically a semaphore is simply an integer variable which
 # has an execution queue associated with it.
-#
-# == Usage
-#
-#   s = Semaphore.new( 4 )
-#
-#   TODO
-#
-# == Author(s)
-#
-# * Fukumoto
-#
 
 class Semaphore
 

data/lib/facets/more/snapshot.rb

@@ -1,34 +1,35 @@
-#--
-# Snapshot
+# = snapshot.rb
+#
+# == Copyright (c) 2004 Michael Neumann
 #
-# Copyright (c) 2004 Michael Neumann
+#   Ruby License
 #
-# Ruby License
+#   This module is free software. You may use, modify, and/or redistribute this
+#   software under the same terms as Ruby.
 #
-# This module is free software. You may use, modify, and/or redistribute this
-# software under the same terms as Ruby.
+#   This program is distributed in the hope that it will be useful, but WITHOUT
+#   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+#   FOR A PARTICULAR PURPOSE.
 #
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.
+# == Author(s)
 #
-# ==========================================================================
-# Revision History ::
-# --------------------------------------------------------------------------
-#  2005.04.28  trans   * Ported to mega Modules
-# ==========================================================================
+# * Michael Neumann
 #
-# TODO Perhaps extend to offer multiple depths.
+# == Developer Notes
 #
-# TODO Should key consitancy be enforced? Currently
-#      Struct's will have symobl keys while other classes
-#      will have string keys in the form of "@name".
+#   TODO Perhaps extend to offer multiple depths.
 #
-# TODO Add other core classes.
+#   TODO Should key consitancy be enforced? Currently
+#        Struct's will have symobl keys while other classes
+#        will have string keys in the form of "@name".
 #
-#++
+#   TODO Add other core classes.
+
+# Author::    Michael Neumann
+# Copyright:: Copyright (c) 2004 Michael Neumann
+# License::   Ruby License
 
-##:title: Snapshot
+# = Snapshot
 #
 # A lightweight single-depth object state capture.
 # The #take_snapshot method reads the object's state, 
@@ -67,11 +68,6 @@
 # an undo-facility to be implemented (triggered for example by
 # a browsers back-button), have to overwrite the
 # Wee::Component#backtrack_state method.
-#
-# == Author(s)
-#
-# * Michael Neumann
-#
 
 class Snapshot
   def initialize
@@ -88,18 +84,15 @@ class Snapshot
   end
 end
 
-module DupReplaceSnapshotMixin
-  def take_snapshot
-    dup
-  end
-
-  def restore_snapshot(snap)
-    replace(snap)
-  end
-end
+# Simplist form of a snapshot.
+#
+#module SnapshotMixin
+#  def take_snapshot() dup end
+#  def restore_snapshot(snap) replace(snap) end
+#end
 
-# Implements a value holder. In Wee this is useful for 
-# backtracking the reference assigned to an instance variable 
+# Implements a value holder. In Wee this is useful for
+# backtracking the reference assigned to an instance variable
 # (not the object itself!). An example where this is used is the
 # <tt>@__decoration</tt> attribute of class Wee::Component.
 
@@ -122,7 +115,7 @@ end
 
 #--
 # Extend some base classes of Ruby (Object, Array, String, Hash, 
-# Struct) for the two methods #take_snapshot and 
+# Struct) for the two methods #take_snapshot and
 # #restore_snapshot, required by Snapshot.
 #++
 
@@ -142,9 +135,20 @@ class Object
   end
 end
 
-class Array  ; include DupReplaceSnapshotMixin ; end
-class String ; include DupReplaceSnapshotMixin ; end
-class Hash   ; include DupReplaceSnapshotMixin ; end
+class Array
+  def take_snapshot() dup end
+  def restore_snapshot(snap) replace(snap) end
+end
+
+class String
+  def take_snapshot() dup end
+  def restore_snapshot(snap) replace(snap) end
+end
+
+class Hash
+  def take_snapshot() dup end
+  def restore_snapshot(snap) replace(snap) end
+end
 
 class Struct
   def take_snapshot