cheri 0.0.2

data/lib/cheri/builder/xml/charsets.rb

@@ -0,0 +1,154 @@
+#--
+# Copyright (C) 2007 William N Dortch <bill.dortch@gmail.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+#
+
+module Cheri
+module Xml
+module Charsets
+SPECIAL = /[\000-\010\013\014\016-\037\046\074\076\200-\377]/
+HIBYTES = /[\200-\377]/
+class << self
+  def special?(str)
+    str =~ SPECIAL  
+  end
+  # Returns a Charset if +str+ requires translation, else +nil+
+  def charset(str)
+    return nil unless str =~ SPECIAL
+    if str =~ HIBYTES
+      Utf8.detect?(str) ? Utf8 : Win1252
+    else
+      Iso8859    
+    end
+  end
+end #self
+module Charset
+  def xlat(i,o)
+    m = @map
+    i.each_byte do |b| o << m[b]; end
+  end
+  def map
+    @map  
+  end
+end
+
+module Win1252
+  extend Charset
+  @map = Array.new(256)
+  map = @map
+  0.upto(31) do |i| map[i] = 32; end
+  map[9] = ?\t
+  map[10] = ?\n
+  map[13] = ?\r
+  32.upto(127) do |i| map[i] = i; end
+  map[38] = '&amp;'
+  map[60] = '&lt;'
+  map[62] = '&gt;'
+  # windows-1252 mappings
+  map[128] = '&#x20AC;'
+  map[129] = '?' #undefined
+  map[130] = '&#x201A;'
+  map[131] = '&#x192;'
+  map[132] = '&#x201E;'
+  map[133] = '&#x2026;'
+  map[134] = '&#x2020;'
+  map[135] = '&#x2021;'
+  map[136] = '&#x2C6;'
+  map[137] = '&#x2030;'
+  map[138] = '&#x160;'
+  map[139] = '&#x2039;'
+  map[140] = '&#x152;'
+  map[141] = '?' #undefined
+  map[142] = '&#x17D;'
+  map[143] = '?' #undefined
+  map[144] = '?' #undefined
+  map[145] = '&#x2018;'
+  map[146] = '&#x2019;'
+  map[147] = '&#x201C;'
+  map[148] = '&#x201D;'
+  map[149] = '&#x2022;'
+  map[150] = '&#x2013;'
+  map[151] = '&#x2014;'
+  map[152] = '&#x2DC;'
+  map[153] = '&#x2122;'
+  map[154] = '&#x161;'
+  map[155] = '&#x203A;'
+  map[156] = '&#x153;'
+  map[157] = '?' #undefined
+  map[158] = '&#x17E;'
+  map[159] = '&#x178;'
+  # 160-255 same for windows-1252 & ISO 8859-1 (Latin-1)
+  160.upto(255) do |i| map[i] = "&##{i};"; end
+end
+
+module Iso8859
+  extend Charset
+  # using same map for windows-1252 & ISO 8859-1, since the
+  # only detectable difference is use of 0x80-0x9f
+  @map = Win1252.map
+end 
+
+module Utf8
+  extend Charset
+
+  # TODO: not quite correct for EO, F0, F4 ?
+  def self.detect?(str)
+    d = @detect
+    ct = 0
+    begin
+      str.each_byte do |b|
+        if b < 128
+          return false if ct > 0        
+        elsif b < 192
+          return false if (ct -= 1) < 0
+        else
+          return false unless ct == 0
+          ct += d[b]
+        end
+      end #each_byte
+      ct == 0
+    rescue
+      false    
+    end
+  end
+
+  @map = Array.new(256)
+  map = @map
+  0.upto(31) do |i| map[i] = 32; end
+  map[9] = ?\t
+  map[10] = ?\n
+  map[13] = ?\r
+  32.upto(255) do |i| map[i] = i; end
+  map[38] = '&amp;'
+  map[60] = '&lt;'
+  map[62] = '&gt;'
+
+  @detect = Array.new(256)
+  det = @detect
+  0x80.upto(0xBF) do |i| det[i] = -1; end
+  0xC2.upto(0xDF) do |i| det[i] = 1; end
+  0xE0.upto(0xEF) do |i| det[i] = 2; end
+  0xF0.upto(0xF4) do |i| det[i] = 3; end
+end
+end #Charsets
+end #Xml
+end #Cheri

data/lib/cheri/builder/xml/common.rb

@@ -0,0 +1,32 @@
+#--
+# Copyright (C) 2007 William N Dortch <bill.dortch@gmail.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+#
+
+
+module Cheri
+module Xml
+VERSION = Cheri::VERSION
+class XmlException < Cheri::CheriException; end
+class BuilderException < Cheri::Builder::BuilderException; end
+end #Xml
+end #Cheri

data/lib/cheri/builder/xml/connecter.rb

@@ -0,0 +1,42 @@
+#--
+# Copyright (C) 2007 William N Dortch <bill.dortch@gmail.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+#
+
+module Cheri
+module Xml
+
+XmlConnecter = Cheri::Builder::TypeConnecter.new do
+
+  type XmlElement do
+    connect XmlElement
+    connect Cheri::Builder::Content
+  end
+
+  type XmlRoot do
+    connect XmlElement
+  end
+
+end #XmlConnecter
+
+end #Xml
+end #Cheri

data/lib/cheri/builder/xml/element.rb

@@ -0,0 +1,189 @@
+#--
+# Copyright (C) 2007 William N Dortch <bill.dortch@gmail.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+#
+
+
+module Cheri
+module Xml
+
+# Marker 'interface' used by connecters.
+module XmlElement
+end #XmlElement
+
+# Included by all Cheri::Xml builders
+module XmlBuilder
+  CE = ' />'.freeze #:nodoc:
+
+  def empty_s(str='')
+    str << CE
+  end
+
+  def empty_io(ios)
+    ios << CE
+  end
+
+  def esc(inp,out=nil)
+    if @ctx[:xml_esc] && (cs = Charsets.charset(inp))
+      cs.xlat(inp,(out ||= ''))
+      out
+    elsif out
+      out << inp
+    else
+      inp
+    end
+  end  
+end #XmlBuilder
+
+class Elem
+  include Cheri::Builder::MarkupBuilder
+  include XmlBuilder
+  include XmlElement
+
+  def mod
+    Cheri::Xml  
+  end
+end
+
+class EmptyElem
+  include Cheri::Builder::EmptyMarkupBuilder
+  include XmlBuilder
+  include XmlElement
+
+  def mod
+    Cheri::Xml  
+  end
+
+  def content?(value)
+    raise XmlException,"content not allowed for empty element #{@sym}: #{value}"  
+  end
+end
+
+
+class TextElem
+  include Cheri::Builder::Builder
+  include Cheri::Builder::Content
+  include Cheri::Builder::ContentArgs
+  include XmlBuilder
+  
+  def mod
+    Cheri::Xml  
+  end
+
+  def object
+    self
+  end
+  
+  def run
+    value = @ctx.call(self,&@blk) if @blk
+    add(value) if String === value
+    #add(value) if value && !(Appendable === value || BaseProxy === value)
+    self
+  end
+
+  # Appends content to +str+, or to an empty string if +str+ is omitted.
+  # Returns the result.
+  def to_s(str='')
+    @cont.each do |c|
+      if String === c
+        esc(c,str)
+      else
+        esc(c.to_s,str)
+      end
+    end if @cont
+    str
+  end
+
+  # Appends content to +ios+. Returns the result.
+  def to_io(ios)
+    @cont.each do |c|
+      if String === c
+        ios << esc(c)
+      else
+        ios << esc(c.to_s)
+      end
+    end if @cont
+    ios
+  end
+
+end
+
+class EscElem < TextElem
+
+  def esc(inp,out=nil)
+    if (cs = Charsets.charset(inp))
+      cs.xlat(inp,(out ||= ''))
+      out
+    elsif out
+      out << inp
+    else
+      inp
+    end
+  end  
+
+end
+
+# TODO: special handling for these:
+
+class XmlRoot
+  XML = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n".freeze #:nodoc:
+  include Cheri::Builder::Builder
+  include Cheri::Builder::Content
+  include Cheri::Builder::ContentArgs
+  include XmlBuilder
+  
+  def mod
+    Cheri::Xml  
+  end
+
+  def object
+    self
+  end
+  
+  def run
+    @ctx.call(self,&@blk) if @blk
+    self
+  end
+
+  # Appends content to +str+ (or new String if +str+ is omitted). Returns the result.
+  def to_s(str='')
+    return to_io(str) unless String === str
+    str << XML
+    cont_s(str)
+    str
+  end
+
+  # Appends content to +ios+. Returns the result.
+  def to_io(ios)
+    ios << XML
+    cont_io(ios)
+    ios
+  end
+
+end
+
+
+class ProcElem < Elem
+end
+
+end #Xml
+end #Cheri

data/lib/cheri/builder/xml/main.rb

@@ -0,0 +1,130 @@
+#--
+# Copyright (C) 2007 William N Dortch <bill.dortch@gmail.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+#
+
+
+module Cheri
+module Xml
+
+include Cheri::Builder
+
+class << self
+  def append_features(clazz)
+    Cheri::Builder.module_included(self,clazz)
+    super
+  end
+  private :append_features
+
+  def factory
+    XmlFactory  
+  end
+
+  def connecter
+    XmlConnecter  
+  end  
+
+end #self
+
+  # Instance methods
+
+  # call-seq:
+  #   xml([*args] [, &block]) -> XmlProxy if no block given, else result of block
+  #   
+  def xml(*r,&k)
+    if (ctx = __cheri_ctx)
+      if k      
+        if ctx.tos(XmlBuilder)
+          XmlFrame.new(ctx,*r,&k).run
+        else
+          ctx.msend(Cheri::Xml,:xml,*r,&k)
+        end
+      else
+        ctx[:xml_proxy] ||= XmlProxy.new(ctx,*r)
+      end
+    end
+  end
+  private :xml
+
+
+module XmlFactory
+  def self.builder(ctx,sym,*r,&k)
+    if (clazz = Types[sym])
+      clazz.new(ctx,sym,*r,&k)
+    elsif ctx[:xml_any] || ((acc = ctx[:xml_accept]) && acc[sym])
+      Elem.new(ctx,sym,*r,&k)
+    else
+      nil    
+    end
+  end
+end #XmlFactory
+
+class XmlProxy < Cheri::Builder::BaseProxy
+
+  impl(Types.keys)
+  
+  def mod
+    Cheri::Xml  
+  end
+  private :mod
+  
+  def [](opts)
+    if Symbol === opts
+      case opts
+        when :any : @ctx[:xml_any] = true
+        when :esc : @ctx[:xml_esc] = true
+        else raise ArgumentError,"invalid simple xml option: :#{opts}"
+      end
+    elsif Hash === opts
+      @ctx[:xml_any] = opts[:any] != false if opts[:any] != nil
+      @ctx[:xml_esc] = opts[:esc] != false if opts[:esc] != nil
+      if (accept = opts[:accept])
+        raise Cheri.type_error(accept,Array) unless Array === accept
+        acc = {}
+        accept.each do |a|
+          raise Cheri.type_error(a,Symbol) unless Symbol === a
+          acc[a] = true
+        end
+        @ctx[:xml_accept] = acc
+        @ctx[:xml_any] = nil
+      end
+    else
+      raise Cheri.type_error(opts,Hash,Symbol)
+    end
+    nil
+  end
+
+end #XmlProxy
+
+class XmlFrame
+  include Cheri::Builder::Frame
+  def initialize(ctx,*r,&k)
+    super
+    @obj = ctx[:xml_proxy] ||= XmlProxy.new(ctx,*r)  
+  end
+  def mod
+    Cheri::Xml  
+  end
+end #XmlFrame
+
+end #Xml
+end #Cheri