facets 1.3.1 → 1.3.2

data/lib/facets/more/builderobject.rb

@@ -1,20 +1,31 @@
 #--
-# BuilderFactory
+# BuilderObject
 # 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.
+#
+# ==========================================================================
+# Revision Notes
+# --------------------------------------------------------------------------
+#  2006-04-18  trans  Created.
+# ==========================================================================
 #++
 
-require 'rexml/document'
 
-require 'facets/core/hash/keys_to_s'
-require 'facets/core/kernel/own'
-require 'facets/more/functor' # already requires basicobject
+#require 'facets/more/basicobject'
+require 'facets/more/functor'
+
 
 # :title: BuilderObject
 #
-# Build structures programatically with Ruby and Ruby's blocks.
+# Build content programatically with Ruby and Ruby's blocks.
 #
 # Builders can use either an implict or explicit receiver.
 # Explicit is the default. To use implicit pass the :implicit
@@ -31,186 +42,58 @@ require 'facets/more/functor' # already requires basicobject
 # routes all builder method vis the #out method.
 #
 # NOTE The name of this method (#out) may be changed.
+#
+# AUTHORS:: Thomas Sawyer
+#
 
 class BuilderObject < BasicObject
 
-  # Builder mixin.
-
   def self.builder
-    @builder ||= Module.new
+    @builder ||= Class.new
   end
 
-  def self.builder_include( *mod )
-    builder.module_eval { extend *mod }
+  def self.builder_include( mod )
+    builder.class_eval { include mod }
   end
 
-private
-
-  def builder
-    self.__class__.builder
-  end
-
-  # Prepare builder.
-
-  def initialize( *options )
-    # initialize options
-    @options = (Hash === options.last ? options.pop : {} )
-    options.each { |o| @options[o] = true }
-    # initialize stack
+  def initialize
     @stack = []
-    # initialize buffer
-    @target = builder.new( @options )
-  end
-
-  # Core of Builder's functionality.
-
-  def method_missing( tag, *args, &block )
-    if @current and block_given?
-      @stack << @target
-      @target = @current
-      if @options[:implicit]
-        instance_eval( &block )
-      else
-        block.call
-      end
-      @target = @stack.pop
-    end
-    @target
-  end
-
-  # Creates object via builder modules,
-  # stores as current and appends to buffer.
-
-  def +( op, *args, &blk )
-    obj = builder.send( op, *args, &blk )
-    @current = obj
-    @target << obj
-    self
+    @buffer = ''
   end
 
-public
-
-  # raw insert
-
-  def <<( str )
-    r = builder.raw( str )
-    if Array === r
-      r.each { |e| @target << e }
-    else
-      @target << r
-    end
-    self
+  def builder
+    @builder ||= self.__class__.builder.new
   end
 
-  # Redirection functor.
-  #--
-  # TODO Better name?
-  #++
-
   def out( str=nil )
     if str
-      self << str
+      @buffer << str
     else
       @builder_functor ||= Functor.new( &__method__(:+) )
     end
   end
 
-  # text output
+  def +( op, *args, &blk )
+    @buffer << builder.send( op, *args, &blk )
+  end
 
   def to_s
-    @target.to_s
+    @buffer
   end
 
 end
 
 
-# Some prebuilt mixin modules for creating builders.
-# These could also be used without builder.
-
-module BuilderObject::REXML
 
-  extend self
-
-  # Add raw XML markup
-
-  def raw( str )
-    REXML::Document.new( "<root>#{str}</root>" ).root.to_a
-  end
-
-  # New REXML document.
-
-  def document( options={} )
-    @options = options
-    doc = REXML::Document.new
-    # xml declaration
-    if options[:version]
-      doc << xml(
-        options[:version],
-        options[:encoding],
-        options[:standalone]
-      )
-    end
-    doc
-  end
-
-  # Used for initial buffer value in a builder.
-
-  alias_method :new, :document
-
-  # XML declaration
-
-  def xml( version=nil, *args )
-    REXML::XMLDecl.new( version=nil, *args )
-  end
-
-  def element( tag, *args )
-    keys = (Hash === args.last ? args.pop : {})
-    e = REXML::Element.new( tag )
-    e.add_attributes( keys.keys_to_s )
-    e.add_text(args.join(' ')) unless args.empty?
-    e
-  end
-
-  def instruct( name, *args )
-    keys = (Hash === args.last ? args.pop : {})
-    content = ( args + keys.collect{ |k,v| %{#{k}="#{v}"} } ).join(' ')
-    REXML::Instruction.new( name, content.strip )
-  end
-  alias_method :instruction, :instruct
-  alias_method :pi, :instruct
-
-  def text( str, *args )
-    REXML::Text.new( str, *args )
-  end
-
-  def comment( str, *args )
-    REXML::Comment.new( str, *args )
-  end
-
-  def cdata( str, *args )
-    REXML::CData.new( str, *args )
-  end
-
-  # DTD declarations
-
-  def doctype!( *args )
-    REXML::DocType.new( *args )
-  end
-
-  def element!( *args )
-    REXML::ElementDecl.new( *args )
-  end
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
 
-  def attlist!( *args )
-    REXML::AttlistDecl.new( *args )
-  end
+# TODO
 
-  def entity!( *args )
-    REXML::EntityDecl.new( *args )
-  end
+=begin
+=end
 
-  def notation!( *args )
-    REXML::NotationDecl.new( *args )
-  end
-
-end

data/lib/facets/more/downloader.rb

@@ -25,7 +25,7 @@ require 'digest/md5'
 require 'open-uri'
 
 require 'facet/string/unbracket'
-require 'calib/progressbar'
+require 'facets/more/progressbar'
 
 # :title: Downloader
 #

data/lib/facets/more/functor.rb

@@ -71,6 +71,7 @@ class Functor < BasicObject
 end
 
 
+
 #  _____         _
 # |_   _|__  ___| |_
 #   | |/ _ \/ __| __|

data/lib/facets/more/htmlbuilder.rb

@@ -0,0 +1,83 @@
+#--
+# HTMLBuilder
+# 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.
+#
+# ==========================================================================
+# Revision History
+# --------------------------------------------------------------------------
+#  2006-04-18  trans  Created.
+# ==========================================================================
+#++
+
+require 'facets/more/builderobject.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.
+#
+# Author::   Thomas Sawyer
+# Copright:: Copyright (c) 2006 Thomas Sawyer
+# License::  Ruby License
+
+class HTMLBuilder < BuilderObject
+
+  builder_include HTMLHelper
+
+  def method_missing( op, *args, &block )
+    if block_given?
+      @stack << @buffer
+      @buffer = ''
+      body = block.call
+      @buffer = @stack.pop
+      @buffer << builder.element( op, body, *args )
+    else
+      @buffer << builder.element( op, *args )
+    end
+  end
+
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test rdoc
+
+  require 'test/unit'
+
+  class TCHTMLBuilder < Test::Unit::TestCase
+
+    def test_01
+      x = HTMLBuilder.new
+      doc = x.html {
+        x.head {
+          x.title "Test"
+        }
+        x.body {
+          x.p "Hello"
+          x.out.text "Test"
+        }
+      }
+      r = "<html><head><title>Test</title></head><body><p>Hello</p>Test</body></html>"
+      assert_equal( r, doc )
+      assert_equal( r, x.to_s )
+    end
+
+  end
+
+=end

data/lib/facets/more/htmlhelper.rb

@@ -0,0 +1,9 @@
+require 'facets/more/xmlhelper.rb'
+
+module HTMLHelper
+  include XMLHelper
+
+end
+
+# :vim: indent=2
+

data/lib/facets/more/multiton.rb

@@ -1,6 +1,5 @@
 #--
 # Multiton
-#
 # Copyright (c) 2005 Florian Frank, Thomas Sawyer
 #
 # Ruby License
@@ -12,9 +11,8 @@
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.
 #
-#
 # ==========================================================================
-# Revision History ::
+# Revision Notes
 # --------------------------------------------------------------------------
 #  2005-11-27   trans    * Simplifed variations to one.
 #  2005-08-01   trans    * Minor modifications to documentation.
@@ -208,7 +206,6 @@ end
 
   end
 
-
   #
   # EXAMPLE B - MODIFY AN EXISTING CLASS, SHARED FILEHANDLES
   #

data/lib/facets/more/rexmlbuilder.rb

@@ -1,13 +1,10 @@
 #--
-# XmlBuilder
-# Copyright (c) 2006 Thomas Sawyer
-#
-# Ruby License
-#
+# REXMLBuilder
 #++
 
 require 'rexml/document'
-require 'facets/more/builderobject'
+
+require 'facets/more/functor' # already requires basicobject
 
 # :title: REXMLBuilder
 #
@@ -49,9 +46,7 @@ require 'facets/more/builderobject'
 # the array.
 #
 
-class REXMLBuilder < BuilderObject
-
-  builder_include BuilderObject::REXML
+class REXMLBuilder < BasicObject
 
   # Output XML document.
 
@@ -61,7 +56,56 @@ class REXMLBuilder < BuilderObject
     o
   end
 
-  # Reroute to output.
+  # raw insert
+
+  def <<( str )
+    r = builder.raw( str )
+    if Array === r
+      r.each { |e| @target << e }
+    else
+      @target << r
+    end
+    self
+  end
+
+  # Redirection functor.
+  #--
+  # TODO Better name?
+  #++
+
+  def out( str=nil )
+    if str
+      self << str
+    else
+      @builder_functor ||= Functor.new( &__method__(:+) )
+    end
+  end
+
+  # text output
+
+  def to_s
+    @target.to_s
+  end
+
+private
+
+  def builder
+    REXMLUtil
+  end
+
+  # Prepare builder.
+
+  def initialize( *options )
+    # initialize options
+    @options = (Hash === options.last ? options.pop : {} )
+    options.each { |o| @options[o] = true }
+    # initialize stack
+    @stack = []
+    # initialize buffer
+    @target = builder.new( @options )
+  end
+
+  # Reroute -- Core functionality.
 
   def method_missing( tag, *args, &block )
     tag = tag.to_s
@@ -73,7 +117,119 @@ class REXMLBuilder < BuilderObject
     else
       out.element( tag, *args )
     end
-    super
+    if @current and block_given?
+      @stack << @target
+      @target = @current
+      if @options[:implicit]
+        instance_eval( &block )
+      else
+        block.call
+      end
+      @target = @stack.pop
+    end
+    @target
+  end
+
+  # Creates object via builder module,
+  # stores as current and appends to buffer.
+
+  def +( op, *args, &blk )
+    obj = builder.send( op, *args, &blk )
+    @current = obj
+    @target << obj
+    self
+  end
+
+end
+
+# Module provides the build methods in
+# an independent namespace.
+
+module REXMLBuilder::REXMLUtil
+
+  extend self
+
+  # Add raw XML markup
+
+  def raw( str )
+    REXML::Document.new( "<root>#{str}</root>" ).root.to_a
+  end
+
+  # New REXML document.
+
+  def document( options={} )
+    #@options = options
+    doc = REXML::Document.new
+    # xml declaration
+    if options[:version]
+      doc << xml(
+        options[:version],
+        options[:encoding],
+        options[:standalone]
+      )
+    end
+    doc
+  end
+
+  # Used for initial taget in builder.
+  alias_method :new, :document
+
+  # XML declaration instruction.
+
+  def xml( version=nil, *args )
+    REXML::XMLDecl.new( version=nil, *args )
+  end
+
+  def element( tag, *args )
+    keys = (Hash === args.last ? args.pop : {})
+    skeys = {}
+    keys.each { |k,v| skeys[k.to_s] =  v.to_s }
+    e = REXML::Element.new( tag )
+    e.add_attributes( skeys )
+    e.add_text(args.join(' ')) unless args.empty?
+    e
+  end
+
+  def instruct( name, *args )
+    keys = (Hash === args.last ? args.pop : {})
+    content = ( args + keys.collect{ |k,v| %{#{k}="#{v}"} } ).join(' ')
+    REXML::Instruction.new( name, content.strip )
+  end
+  alias_method :instruction, :instruct
+  alias_method :pi, :instruct
+
+  def text( str, *args )
+    REXML::Text.new( str, *args )
+  end
+
+  def comment( str, *args )
+    REXML::Comment.new( str, *args )
+  end
+
+  def cdata( str, *args )
+    REXML::CData.new( str, *args )
+  end
+
+  # DTD declarations
+
+  def doctype!( *args )
+    REXML::DocType.new( *args )
+  end
+
+  def element!( *args )
+    REXML::ElementDecl.new( *args )
+  end
+
+  def attlist!( *args )
+    REXML::AttlistDecl.new( *args )
+  end
+
+  def entity!( *args )
+    REXML::EntityDecl.new( *args )
+  end
+
+  def notation!( *args )
+    REXML::NotationDecl.new( *args )
   end
 
 end
@@ -82,7 +238,7 @@ end
 
 # TODO
 
-#=begin
+=begin
 
 x = REXMLBuilder.new( :version => '1.0' )
 
@@ -101,4 +257,4 @@ x.html {
 
 puts x
 
-#=end
+=end