facets 1.3.3 → 1.4.0

data/lib/facets/more/floatstring.rb

@@ -1,43 +1,34 @@
-#--
-# FloatString
+# = floatstring.rb
 #
-# Copyright (c) 2004,2005 Thomas Sawyer
+# == Copyright (c) 2004 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.
 #
+# == Authors and Contributors
 #
-# ==========================================================================
-# Revision History ::
-# --------------------------------------------------------------------------
-#  04.11.01   Trans    * Complete first usable verion (still needs TLC)
-# ==========================================================================
-#++
-
-#:title: FloatString
-#
-# FloatString allows unlimited string insertion between string segments.
-#
-# == Usage
-#
-#   TODO: Comming soon.....
-#
-# == Notes
+# * Thomas Sawyer
 #
-# Although usable, it is still a very new idea, and therefore
-# has a much greater potential for change. If you decide it is useful
-# to you, please contribute to its improvement. Thanks.
+# == Developer Notes
 #
-# == Author(s)
+#   TODO This library still needs work to be truly useful.
+
+# Author::    Thomas Sawyer
+# Copyright:: Copyright (c) 2004 Thomas Sawyer
+# License::   Ruby License
+
+# = FloatString
 #
-# * Thomas Sawyer
+# FloatString is essentially a String but it allows unlimited
+# string insertion between string segments.
 #
+# NOTE This library is still expiremental.
 
 class FloatString
 
@@ -48,7 +39,7 @@ class FloatString
     while i < @str.length
       @float[i.to_f] = @str[i,1]
       i += 1
-    end 
+    end
   end
 
   def undo
@@ -70,7 +61,7 @@ class FloatString
 
   # these should probably check the decimal and start there
   # rather then startint at 0.5
-  
+
   def inner_insert(s, i)
     n = 0.5; i = i.to_f - n
     while @float.has_key?(i)
@@ -79,7 +70,7 @@ class FloatString
     end
     @float[i] = s
   end
-  
+
   def outer_insert(s, i)
     n = 0.5; i = i.to_f - 0.5
     while @float.has_key?(i)
@@ -88,7 +79,7 @@ class FloatString
     end
     @float[i] = s
   end
-  
+
   def inner_append(s, i)
     n = 0.5; i = i.to_f + 0.5
     while @float.has_key?(i)
@@ -97,7 +88,7 @@ class FloatString
     end
     @float[i] = s
   end
-  
+
   def outer_append(s, i)
     n = 0.5; i = i.to_f + 0.5
     while @float.has_key?(i)
@@ -108,7 +99,7 @@ class FloatString
   end
 
   # an inner and outer wrap method would be nice
-    
+
   def [](arg)
     if arg.kind_of?(Range)
       #r = Range.new(arg.first.to_f, arg.last.to_f, arg.exclude_end?)
@@ -121,11 +112,11 @@ class FloatString
       @float[arg.to_f]
     end
   end
-  
+
   def []=(arg,v)
     @float[arg.to_f] = v
   end
-  
+
   def fill(val, rng=0..-1)
     a = @float.to_a.sort_by{ |k,v| k }
     s = a.index( a.find{ |e| e[0] == rng.first.to_f } )
@@ -134,7 +125,7 @@ class FloatString
     x.each{ |k,v| @float[k] = val.to_s }
     self.to_s
   end
-  
+
   def empty(rng)
     fill('', rng)
   end
@@ -142,7 +133,7 @@ class FloatString
   def blank(rng)
     fill(' ', rng)
   end
-  
+
 end
 
 

data/lib/facets/more/functor.rb

@@ -1,33 +1,27 @@
-#--
-# Functor
-# Copyright (c) 2004,2005 Thomas Sawyer
+# = functor.rb
 #
-# Ruby License
+# == Copyright (c) 2004 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.
 #
-# ==========================================================================
-#  Revision History
-# ==========================================================================
-#  2006-04-15
-#    Code cleanup, changed instance_objects to instance_targets.
+#   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.
 #
-#  2005-09-22  trans
-#    Made a subclass of BasicObject.
+# == Author(s)
 #
-#  2005-01-10  trans
-#    Ported to Facets.
-# ==========================================================================
-#++
+# * Thomas Sawyer
+
+# Author::    Thomas Sawyer
+# Copyright:: Copyright (c) 2006 Thomas Sawyer
+# License::   Ruby License
 
 require 'facets/more/basicobject'
 
-#:title: Functor
+# = Functor
 #
 # By definition a Functor is simply a first class method, but these are common
 # in the form of Method and Proc. So here a Functor is a bit more specialized
@@ -44,10 +38,6 @@ require 'facets/more/basicobject'
 #   f * 2  #=> 2
 #   f * 3  #=> 9
 #
-# == Author(s)
-#
-# * Thomas Sawyer
-#
 
 class Functor < BasicObject
 

data/lib/facets/more/hashbuilder.rb

@@ -0,0 +1,76 @@
+# = hashbuilder.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
+
+# Author::    Thomas Sawyer
+# Copyright:: Copyright (c) 2006 Thomas Sawyer
+# License::   Ruby License
+
+require 'facets/more/basicobject.rb'
+
+# = Hash Builder
+#
+# Build a hash programmatically.
+#
+# Build a hash from missing method calls.
+
+class HashBuilder < BasicObject
+
+  def self.build( blockstr=nil, &block )
+    self.new.build( blockstr, &block ).to_h
+  end
+
+  def initialize( blockstr=nil, &block )
+    @hash = {}
+    @flag = {}
+  end
+
+  def build( blockstr=nil, &block )
+    raise "both string and block given" if blockstr and block_given?
+    if blockstr
+      instance_eval blockstr
+    else
+      instance_eval &block
+    end
+    self  # or to_h ?
+  end
+
+  def to_h ; @hash ; end
+
+  def method_missing( sym, *args, &block )
+    sym = sym.to_s.downcase.chomp('=')
+
+    if @hash.key?(sym)
+      unless @flag[sym]
+        @hash[sym] = [ @hash[sym] ]
+        @flag[sym] = true
+      end
+      if block_given?
+        @hash[sym] << self.__class__.new( &block ).to_h
+      else
+        @hash[sym] << args[0]
+      end
+    else
+      if block_given?
+        @hash[sym] = self.__class__.new( &block ).to_h
+      else
+        @hash[sym] = args[0]
+      end
+    end
+
+  end
+
+end

data/lib/facets/more/heap.rb

@@ -1,38 +1,44 @@
-#--
-# Heap
+# = heap.rb
+#
+# == Copyright (c) 2002 Renald Buter
+#
+#   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.
+#
+# == Special Thanks
 #
-# Copyright (c) 2002,2004 Renald Buter (Ruby Version)
 # [See Cormen1990 for original]
 #
-# Ruby License
+# Thanks to Nenad Ocelic for many suggestions.
+#
+# == Author(s)
 #
-# This module is free software. You may use, modify, and/or redistribute this
-# software under the same terms as Ruby.
+# * Ronald Butler
 #
-# 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.
+# == Reference
 #
+#   Cormen1990: Chapter 7 (Heapsort) of 'An introduction to algorithms', by
+#   Cormen, T.H; Leiserson, C.E.; Rivest, R.L; MIT Press, Cambridge, 1990
+#   ISBN 0-262-53091-0
 #
-# ==========================================================================
-# Revision History
-# --------------------------------------------------------------------------
-# 2005.04.28 trans
-#   Ported to Calibre and Documentatation.
-# ==========================================================================
+# == Developer Notes
 #
-# NOTE:
-#   Ruby Quiz has a simple Heap class and had a contest for writting 
+#   Ruby Quiz has a simple Heap class and had a contest for writting
 #   ascii-ast visual trees of the heap. If someone would like
 #   a small poject it would be cool to improve on this class, in general,
 #   and also see about integrating the best of those Ruby Quiz solutions.
-#
-# THANKS:
-#   Special thanks to Nenad Ocelic for many suggestions.
-#
-#++
 
-#:title: Heap
+# Author::    Renald Buter (buter at cwts nl)
+# Copyright:: Copyright (c) 2002 Renald Buter
+# License::   Ruby License
+
+# = Heap
 #
 # A simple Heap structure and sort.
 #
@@ -47,19 +53,6 @@
 # The +parent+, +left+ and +right+ methods do not check the supplied parameter,
 # but their result is _only_ valid if the supplied with an integer >=0 
 # for +left+ and +right+ and >0 for +parent+.
-#
-# == Reference
-#
-#   <quote>
-#   Cormen1990: Chapter 7 (Heapsort) of 'An introduction to algorithms', by
-#   Cormen, T.H; Leiserson, C.E.; Rivest, R.L; MIT Press, Cambridge, 1990
-#   ISBN 0-262-53091-0
-#   </quote>
-#
-# == Author(s)
-#
-# * Renald Buter (buter at cwts nl)
-#
 
 class Heap
 

data/lib/facets/more/htmlbuilder.rb

@@ -1,36 +1,34 @@
-#--
-# HTMLBuilder
-# Copyright (c) 2006 Thomas Sawyer
+# = htmlbuilder.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.
 #
-# ==========================================================================
-# Revision History
-# --------------------------------------------------------------------------
-#  2006-04-18  trans  Created.
-# ==========================================================================
-#++
+#   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 'facets/more/builderobject.rb'
+# Author::    Thomas Sawyer
+# Copyright:: Copyright (c) 2006 Thomas Sawyer
+# License::   Ruby License
+
+require 'facets/more/xmlbuilder.rb'
 require 'facets/more/htmlhelper.rb'
 
-#:title: HTMLBuilder
-#
-# HTMLBuilder follows the _Builder Pattern_ allowing XML markup to be
-# constructed via Ruby method calls and block structures.
+# = HTMLBuilder
 #
-# Author::   Thomas Sawyer
-# Copright:: Copyright (c) 2006 Thomas Sawyer
-# License::  Ruby License
+# HTMLBuilder follows the <em>Builder Pattern</em> allowing XML markup to be
+# constructed via Ruby method calls and block structures. HTMLBuilder is a
+# subclass of XMLBuilder --see XMLBuilder for more details.
 
-class HTMLBuilder < BuilderObject
+class HTMLBuilder < XMLBuilder
 
   builder_include HTMLHelper
 

data/lib/facets/more/htmlhelper.rb

@@ -1,7 +1,96 @@
+# = htmlhelper.rb
+#
+# == Copyright (c) 2005 George Moschovitis and 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)
+#
+# * George Moschovitis
+# * Thomas Sawyer
+
+# Author::    George Moschovitis and Thomas Sawyer
+# Copyright:: Copyright (c) 2005 George Moschovitis and Thomas Sawyer
+# License::   Ruby License
+
+# = HTMLHelper
+#
+# Helper methods for working with CGI forms and HTML/XHTML documents.
+#
+# == Synopsis
+#
+#   # TODO
+#
+
+require 'cgi' # TODO deprecate use
+
 require 'facets/more/xmlhelper.rb'
 
 module HTMLHelper
+
   include XMLHelper
 
+  ###############
+  module_function
+  ###############
+
+  # Create an hidden input field through which an object can can be marshalled.
+  # This makes it very easy to pass from data betwenn requests.
+  def marshal_to_cgi(name, iobj)
+    data = CGI.escape(Marshal.dump(iobj))
+    return %Q{<input type="hidden" name="__#{name}__" value="#{data}"/>\n}
+  end
+
+  # Create an hidden input field through which an object can can be marshalled.
+  # This makes it very easy to pass from data between requests.
+  def marshal_from_cgi(name)
+    if self.params.has_key?("__#{name}__")
+      return Marshal.load(CGI.unescape(self["__#{name}__"][0]))
+    end
+  end
+
+  # Are these two good enough to replace CGI.escape?
+
+  # Return an html "safe" version of the string,
+  # where every &, < and > are replaced with appropriate entities.
+  def esc(str)
+    str.gsub(/&/,'&amp;').gsub(/</,'&lt;').gsub(/>/,'&gt;')
+  end
+
+  # Calls #esc, and then further replaces carriage returns and quote characters with entities.
+  def escformat(str)
+    esc(str).gsub(/[\r\n]+/,'&#13;&#10;').gsub(%r|"|,'&quot;').gsub(%r|'|,'&#39;')
+  end
+
+end
+
+
+
+=begin
+
+if defined? CGI
+  class CGI
+   include CGISupport
+   class << self
+     alias :escape_html :escapeHTML
+     alias :unescape_html :unescapeHTML
+     alias :escape_element :escapeElement
+     alias :unescape_element :unescapeElement
+   end
+  end
+end
+
+if defined? FCGI
+  class FCGI
+    include CGISupport
+  end
 end
 
+=end