reparcs 0.1.0

data/lib/reparcs/elements/text_elements.rb

@@ -0,0 +1,438 @@
+include Base
+
+#XHTML Text elements
+module TextElements
+  
+  #An Abbreviation '<abbr></abbr>'
+  #Use: Define an abbreviation.
+  class Abbreviation < ContainerElement
+    #Create a new Abbreviation element, takes a optional hash of attributes as parameter.
+    def initialize(attrs={})
+      aattrs = [
+        "class", "id", "title", "dir", "xml:lang",
+        "onclick", "ondblclick", "onkeydown", "onkeypress",
+        "onkeyup", "onmousedown", "onmousemove", "onmouseout",
+        "onmouseover", "onmouseup"
+      ]
+      childs = [
+        "a", "abbr", "acronym", "b", "bdo", "big",
+        "br", "button", "cite", "code", "del", "dfn",
+        "em", "i", "img", "input", "ins", "kbd", "label",
+        "map", "object", "q", "samp", "script", "select",
+        "small", "span", "strong", "sub", "sup", "textarea",
+        "tt", "var"
+      ]
+      super("abbr", aattrs, childs, attrs)
+      @start_element = "<abbr"
+      @end_element = "</abbr>"
+    end
+  end
+  
+  #An acronym element '<acronym></acronym>'
+  #Use: Define an acronym.
+  class Acronym < ContainerElement
+    #Create a new Acronym element, takes a optional hash of attributes as parameter.
+    def initialize(attrs={})
+      aattrs = [
+        "class", "id", "title", "dir", "xml:lang",
+        "onclick", "ondblclick", "onkeydown", "onkeypress",
+        "onkeyup", "onmousedown", "onmousemove", "onmouseout",
+        "onmouseover", "onmouseup"
+      ]
+      childs = [
+        "a", "abbr", "acronym", "b", "bdo", "big",
+        "br", "button", "cite", "code", "del", "dfn",
+        "em", "i", "img", "input", "ins", "kbd", "label",
+        "map", "object", "q", "samp", "script", "select",
+        "small", "span", "strong", "sub", "sup", "textarea",
+        "tt", "var"
+      ]
+      super("acronym", aattrs, childs, attrs)
+      @start_element = "<acronym"
+      @end_element = "</acronym>"
+    end
+  end
+  
+  #An address element '<address></address>'
+  #Use: Define contact information for a document.
+  class Address < ContainerElement
+    #Create a new Address element, takes a optional hash of attributes as parameter.
+    def initialize(attrs={})
+      aattrs = [
+        "class", "id", "dir", "xml:lang",
+        "onclick", "ondblclick", "onkeydown",
+        "onkeypress", "onkeyup", "onmousedown",
+        "onmousemove", "onmouseout", "onmouseover",
+        "onmouseup"
+      ]
+      childs = [
+        "a", "abbr", "acronym", "b", "bdo", "big", "br",
+        "button", "cite", "code", "del", "dfn", "em",
+        "i", "img", "input", "ins", "kbd", "label",
+        "map", "object", "q", "samp", "script", "select",
+        "small", "span", "strong", "sub", "sup",
+        "textarea", "tt", "var"
+      ]
+      super("address", aattrs, childs, attrs)
+      @start_element = "<address"
+      @end_element = "</address>"
+    end
+  end
+  
+  #A block quote element '<blockquote></blockquote>'
+  #Use: Define a long quotation.
+  class BlockQuote < ContainerElement
+    #Create a new BlockQuote element, takes a optional hash of attributes as parameter.
+    def initialize(attrs={})
+      aattrs = [
+        "class", "id", "title", "dir", "xml:lang",
+        "onclick", "ondblclick", "onkeydown", "onkeypress",
+        "onkeyup", "onmousedown", "onmousemove", "onmouseout",
+        "onmouseover", "onmouseup", "cite"
+      ]
+      childs = [
+        "address", "blockquote", "del", "div", "fieldset", "form",
+        "h1", "h2", "h3", "h4", "h5", "h6", "hr", "ins", "noscript",
+        "ol", "p", "pre", "script", "table", "ul"
+      ]
+      super("blockquote", aattrs, childs, attrs)
+      @start_element = "<blockquote"
+      @end_element = "</blockquote>"
+    end
+  end
+  
+  #A Line break '<br />'
+  #Use: Insert a blank line.
+  class LineBreak < Element
+    #Create a new LineBreak element, takes a optional hash of attributes as parameter.
+    def initialize(attrs={})
+      aattrs = ["class", "id", "title"]
+      super("br", aattrs, attrs)
+      @start_element = "<br"
+      @end_element = " />"
+    end
+  end
+  
+  #A citation '<cite></cite>'
+  #Use: Define a citation.
+  class Citation < ContainerElement
+    #Create a new Citation element, takes a optional hash of attributes as parameter.
+    def initialize(attrs={})
+      aattrs = [
+        "class", "id", "title", "dir", "xml:lang",
+        "onclick", "ondblclick", "onkeydown", "onkeypress",
+        "onkeyup", "onmousedown", "onmousemove", "onmouseout",
+        "onmouseover", "onmouseup"
+      ]
+      childs = [
+        "a", "abbr", "acronym", "b", "bdo", "big", "br", "button",
+        "cite", "code", "del", "dfn", "em", "i", "img", "input", "ins",
+        "kbd", "label", "map", "object", "q", "samp", "script", "select",
+        "small", "span", "strong", "sub", "sup", "textarea", "tt", "var"
+      ]
+      super("cite", aattrs, childs, attrs)
+      @start_element = "<cite"
+      @end_element = "</cite>"
+    end
+  end
+
+  #A code element '<code></code>'
+  #Use: Define computer code text
+  class Code < ContainerElement
+    #Create a new Code element, takes a optional hash of attributes as parameter.
+    def initialize(attrs={})
+      aattrs = [
+        "class", "id", "title", "dir", "xml:lang",
+        "onclick", "ondblclick", "onkeydown", "onkeypress",
+        "onkeyup", "onmousedown", "onmousemove", "onmouseout",
+        "onmouseover", "onmouseup"
+      ]
+      childs = [
+        "a", "abbr", "acronym", "b", "bdo", "big", "br", "button",
+        "cite", "code", "del", "dfn", "em", "i", "img", "input", 
+        "ins", "kbd", "label", "map", "object", "q", "samp", "script",
+        "select", "small", "span", "strong", "sub", "sup", "textarea",
+        "tt", "var"
+      ]
+      super("code", aattrs, childs, attrs)
+      @start_element = "<code"
+      @end_element = "</code>"
+    end
+  end
+
+  #A Division element '<div></div>'
+  #Use: Define a divison(usually refered to as a layer or div).
+  class Division < ContainerElement
+    #Create a new Division element, takes a optional hash of attributes as parameter.
+    def initialize(attrs={})
+      aattrs = [
+        "class", "id", "title", "dir", "xml:lang",
+        "onclick", "ondblclick", "onkeydown", "onkeypress",
+        "onkeyup", "onmousedown", "onmousemove", "onmouseout",
+        "onmouseover", "onmouseup" 
+      ]
+      childs = [
+        "a", "abbr", "acronym", "address", "b", "bdo", "big", "blockquote",
+        "br", "button", "cite", "code", "del" ,"dfn", "div", "dl", "em",
+        "fieldset", "form", "h1", "h2", "h3", "h4", "h5", "h6", "hr", "i",
+        "img", "input", "ins", "kbd", "label", "map", "noscript", "object",
+        "ol", "p", "pre", "q", "samp", "script", "select", "small", "span",
+        "strong", "sub", "sup", "textarea", "tt", "ul", "var"
+      ]
+      super("div", aattrs, childs, attrs)
+      @start_element = "<div"
+      @end_element = "</div>"
+    end
+  end
+
+  #A emphasized element '<em></em>'
+  #Use: Emphasizes text.
+  class Emphasized < ContainerElement
+    #Create a new Emphasized element, takes a optional hash of attributes as parameter.
+    def initialize(attrs={})
+      aattrs = [
+        "class", "id", "title", "dir", "xml:lang",
+        "onclick", "ondblclick", "onkeydown", "onkeypress",
+        "onkeyup", "onmousedown", "onmousemove", "onmouseout",
+        "onmouseover", "onmouseup"
+      ]
+      childs = [
+        "a", "abbr", "acronym", "b", "bdo", "big", "br", "button",
+        "cite", "code", "del", "dfn", "em", "i", "img", "input",
+        "ins", "kbd", "label", "map", "object", "q", "samp", "script",
+        "select", "small", "span", "strong", "sub", "sup", "textarea",
+        "tt", "var"
+      ]
+      super("em", aattrs, childs, attrs)
+      @start_element = "<em"
+      @end_element = "</em>"
+    end
+  end
+
+  #A header element '<h1-6></h1-6>'
+  #Use: Defines a header
+  class Header < ContainerElement
+    #Create a new heade element, takes the size(1-6) and a optional hash of attributes as parameter.
+    def initialize(size, attrs={})
+      allowed = false
+      [1, 2, 3, 4, 5, 6].each do |s|
+        if s == size
+          allowed = true
+          break
+        end
+      end
+      unless allowed
+        raise "Headers come in six sizes 1-6, #{size.to_s} is not one of them."
+      end
+      aattrs = [
+          "class", "id", "title", "dir", "xml:lang",
+          "onclick", "ondblclick", "onkeydown", "onkeypress",
+          "onkeyup", "onmousedown", "onmousemove", "onmouseout",
+          "onmouseover", "onmouseup"
+      ]
+      childs = [
+          "a", "abbr", "acronym", "b", "bdo", "big", "br", "button",
+          "cite", "code", "del", "dfn", "em", "i", "img", "input",
+          "ins", "kbd", "label", "map", "object", "q", "samp", "script",
+          "select", "small", "span", "strong", "sub", "sup", "textarea",
+          "tt", "var"
+      ]
+      super("h#{size.to_s}", aattrs, childs, attrs)
+      @start_element = "<h#{size.to_s}"
+      @end_element = "</h#{size.to_s}>"
+    end
+  end
+
+  #A keyboard element '<kbd></kbd>'
+  #Use: Defines keyboard text
+  class Keyboard < ContainerElement
+    #Create a new Keyboard element,
+    #takes a optional hash of attributes as parameter.
+    def initialize(attrs={})
+      aattrs = [
+        "class", "id", "title", "dir", "xml:lang",
+        "onclick", "ondblclick", "onkeydown", "onkeypress",
+        "onkeyup", "onmousedown", "onmousemove", "onmouseout",
+        "onmouseover", "onmouseup"
+      ]
+      childs = [
+        "a", "abbr", "acronym", "b", "bdo", "big", "br", "button",
+        "cite", "code", "del" ,"dfn", "em", "i", "img", "input",
+        "ins", "kbd", "label", "map", "object", "q", "samp", "script",
+        "select", "small", "span", "strong", "sub", "sup", "textarea",
+        "tt", "var"
+      ]
+      super("kbd", aattrs, childs, attrs)
+      @start_element = "<kbd"
+      @end_element = "</kbd>"
+    end
+  end
+
+  #A paragraph element '<p></p>'
+  #Use: Define a new paragraph.
+  class Paragraph < ContainerElement
+    #Create a new Paragraph element, takes a optional hash of attributes as parameter.
+    def initialize(attrs={})
+      aattrs = [
+        "class", "id", "title", "dir", "xml:lang",
+        "onclick", "ondblclick", "onkeydown", "onkeypress",
+        "onkeyup", "onmousedown", "onmousemove", "onmouseout",
+        "onmouseover", "onmouseup"
+      ]
+      childs = [
+        "a", "abbr", "acronym", "b", "bdo", "big", "br", "button",
+        "cite", "code", "del", "dfn", "em", "i", "img", "input",
+        "ins", "kbd", "label", "map", "object", "q", "samp", "script",
+        "select", "small", "span", "strong", "sub", "sup", "textarea",
+        "tt", "var"
+      ]
+      super("p", aattrs, childs, attrs)
+      @start_element = "<p"
+      @end_element = "</p>"
+    end
+  end
+
+  #A Preformat element
+  #Use: define preformatted text
+  class Preformat < ContainerElement
+    #Create a new Preformat element, takes a optional hash of attributes as parameter.
+    def initialize(attrs={})
+      aattrs = [
+        "class", "id", "title", "dir", "xml:lang",
+        "onclick", "ondblclick", "onkeydown", "onkeypress",
+        "onkeyup", "onmousedown", "onmousemove", "onmouseout",
+        "onmouseover", "onmouseup"
+      ]
+      childs = [
+        "a", "abbr", "acronym", "b", "bdo", "big", "br", "button",
+        "cite", "code", "del", "dfn", "em", "i", "input", "ins",
+        "kbd", "label", "map", "q", "samp" ,"script", "select", 
+        "small", "span", "strong", "sub", "sup", "textarea", "tt", "var"
+      ]
+      super("pre", aattrs, childs, attrs)
+      @start_element = "<pre"
+      @end_element = "</pre>"
+    end
+  end
+
+  #A quotaton element
+  #Use: Define a quotation.
+  class Quotation < ContainerElement
+    #Create a new Quotation element, takes a optional hash of attributes as parameter.
+    def initialize(attrs={})
+      aattrs = [
+        "class", "id", "title", "dir", "xml:lang",
+        "onclick", "ondblclick", "onkeydown", "onkeypress",
+        "onkeyup", "onmousedown", "onmousemove", "onmouseout",
+        "onmouseover", "onmouseup"
+      ]
+      childs = [
+        "a", "abbr", "acronym", "b", "bdo", "big", "br", "button",
+        "cite", "code", "del", "dfn", "em" ,"i", "img", "input",
+        "ins", "kbd", "label", "map" ,"object", "q", "samp", "script",
+        "select", "small" ,"span" ,"strong" ,"sub", "sup", "textarea",
+        "tt", "var"
+      ]
+      super("q", aattrs, childs, attrs)
+      @start_element = "<q"
+      @end_element = "</q>"
+    end
+  end
+
+  #A sample element
+  #Use: Define a sample code text.
+  class Sample < ContainerElement
+    #Create a new Sample element, takes a optional hash of attributes as parameter.
+    def initialize(attrs={})
+      aattrs = [
+        "class" ,"id" ,"title", "dir", "xml:lang",
+        "onclick", "ondblclick", "onkeydown", "onkeypress",
+        "onkeyup", "onmousedown", "onmousemove", "onmouseout",
+        "onmouseover", "onmouseup"
+      ]
+      childs = [
+        "a", "abbr", "acronym", "b", "bdo", "big", "br", "button",
+        "cite", "code", "del", "dfn", "em", "i", "img" , "input",
+        "ins", "kbd", "label", "map", "object", "q", "samp", "script",
+        "select", "small", "span", "strong", "sub", "sup",
+        "textarea", "tt", "var"
+      ]
+      super("samp", aattrs, childs, attrs)
+      @start_element = "<samp"
+      @end_element = "</samp>"
+    end
+  end
+
+  #A span element
+  #Use: define a inline grouping of elements.
+  class Span < ContainerElement
+    #Create a new Span element, takes a optional hash of attributes as parameter.
+    def initialize(attrs={})
+      aattrs = [
+        "class", "id" ,"title", "dir", "xml:lang",
+        "onclick", "ondblclick", "onkeydown", "onkeypress",
+        "onkeyup", "onmousedown", "onmousemove", "onmouseout",
+        "onmouseover", "onmouseup"
+      ]
+      childs = [
+        "a", "abbr", "acronym", "b", "bdo", "big", "br", "button",
+        "cite", "code", "del", "dfn", "em" ,"i", "img", "input",
+        "ins", "kbd", "label", "map", "object", "q", "samp", "script",
+        "select", "small", "span", "strong", "sub", "sup", "textarea",
+        "tt", "var"
+      ]
+      super("span", aattrs, childs, attrs)
+      @start_element = "<span"
+      @end_element = "</span>"
+    end
+  end
+
+  #A strong element
+  #Use: Defines a strong emphasized.
+  class Strong < ContainerElement
+    #Create a new Strong element, takes a optional hash of attributes as parameter.
+    def initialize(attrs={})
+      aattrs = [
+        "class", "id", "title", "dir", "xml:lang",
+        "onclick", "ondblclick", "onkeydown", "onkeypress",
+        "onkeyup", "onmousedown", "onmousemove", "onmouseout",
+        "onmouseover", "onmouseup"
+      ]
+      childs = [
+        "a", "abbr", "acronym", "b" ,"bdo" ,"big", "br" ,"button",
+        "cite", "code", "del", "dfn", "em", "i", "img", "input",
+        "ins", "kbd", "label", "map", "object", "q", "samp", "script",
+        "select", "small", "span", "strong", "sub", "sup", "textarea",
+        "tt", "var"
+      ]
+      super("strong", aattrs, childs, attrs)
+      @start_element = "<strong"
+      @end_element = "</strong>"
+    end
+  end
+  
+  #A variable element
+  #Use: Defines a variable.
+  class Variable < ContainerElement
+    #Create a new Variable element, takes a optional hash of attributes as parameter.
+    def initialize(attrs={})
+      aattrs = [
+        "class", "id", "title", "dir", "xml:lang",
+        "onclick", "ondblclick", "onkeydown", "onkeypress",
+        "onkeyup", "onmousedown", "onmousemove", "onmouseout",
+        "onmouseover", "onmouseup"
+      ]
+      childs = [
+        "a", "abbr", "acronym", "b", "bdo" ,"big", "br" ,"button",
+        "cite", "code", "del", "dfn", "em", "i", "img", "input",
+        "ins", "kbd", "label", "map", "object", "q", "samp", "script",
+        "select", "small", "span", "strong", "sub", "sup", "textarea",
+        "tt", "var"
+      ]
+      super("var", aattrs, childs, attrs)
+      @start_element = "<var"
+      @end_element = "</var>"
+    end
+  end
+  
+end

data/lib/reparcs/projects.rb

@@ -0,0 +1,54 @@
+include Base
+
+#The Projects module contains the classes that act as good starting points for
+#reparcs projects.
+module Projects
+  
+  #A Page(or document). If you project requires you to make
+  #a single html page, this is where you should start.
+  class Page < ContainerElement
+    #Create a new Page
+    def initialize
+      super("html")
+      @xml_lang = "en"
+      @lang = "en"
+      @xmlns = "http://www.w3.org/1999/xhtml"
+      @charset = "utf-8"
+      @start_element = %{<!DOCTYPE html PUBLIC 
+        "-//W3C//DTD XHTML 1.0 Transitional//EN"
+        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+        <html 
+          xml:lang=\"#{@xml_lang}\"
+          lang=\"#{@lang}\"
+          xmlns=\"#{@xmlns}\"}.strip()
+      @end_element = "</html>"
+      ["head", "body"].each do |c|
+        @allowed_child_elements << c
+      end
+      @head = Head.new
+      append(@head)
+      @body = Body.new
+      append(@body)
+      c_type = Meta.new
+      c_type.set_attribute("http-equiv", "Content-Type")
+      c_type.set_attribute("content", "text/html;charset=#{@charset}")
+      @head.append(c_type)
+    end
+    #'puts' the string representation(the entire xhtml tree)
+    def to_puts
+      puts to_s
+    end
+    #----->
+    attr_accessor :head, :body, :xml_lang, :lang, :xmlns, :charset
+  end
+  
+  #A Project, a good starting point for larger projects, that require
+  #other files, etc.
+  class Project
+    #Create a new Project.
+    def initialize
+      
+    end
+  end
+  
+end

data/lib/reparcs/shortcuts.rb

@@ -0,0 +1,106 @@
+include StructureElements
+include TextElements
+
+#A collection of shortcut methods for reparcs
+module Shortcuts
+  
+  #A shortcut for creating a anchor
+  #takes the url, and the text as parameter
+  def shortcut_anchor(href, text)
+    anchor = Anchor.new({:href => href})
+    anchor.append(text)
+    return anchor
+  end
+  
+  #A shortcut for creating a header
+  #takes the header size, and the header text as parameters.
+  def shortcut_header(size, heading)
+    head = Header.new(size)
+    head.append(heading)
+    return head
+  end
+  
+  #A shortcut for creating a unordered list 'ul'
+  #takes an array of elements or strings for the list items.
+  def shortcut_unordered_list(array)
+    ul = UnorderedList.new
+    array.each do |i|
+      li = ListItem.new
+      li.append(i)
+      ul.append(li)
+    end
+    return ul
+  end
+  
+  #A shortcut for creating a select '<select></select>'
+  #takes a hash object as parameter.
+  def shortcut_select(hash)
+    select = Select.new
+    hash.each do |key, val|
+      option = Option.new({:value => val})
+      option.append(key)
+      select.append(option)
+    end
+    return select
+  end
+  
+  #A shortcut for creating a script '<script type="text/javascript"></script>'
+  #takes the javascipt code as parameter
+  def shortcut_script(code)
+    script = Script.new({:type => 'text/javascript'})
+    script.append(code)
+    return script
+  end
+  
+  #A shortcut for creating a style '<style type="text/css"></style>
+  #takes the css code as parameter
+  def shortcut_style(css)
+    style = Style.new({:type => 'text/css'})
+    style.append(css)
+    return style
+  end
+  
+  #A shortcut for creating a title, takes the titles text as parameter.
+  def shortcut_title(text)
+    title = Title.new
+    title.append(text)
+    return title
+  end
+  
+  #A shortcut for creating a meta data element '<meta http-equiv="?" conten="?" />
+  #takes the http-equiv type, and the content as parameters
+  def shortcut_meta(equiv, content)
+    meta = Meta.new({:content => content})
+    meta.set_attribute("http-equiv", equiv)
+    return meta
+  end
+  
+  #A shortcut for creating a table of data,
+  #takes an array of headers, and a multidimensional array
+  # of the table data.
+  def shortcut_table(headers, data)
+    tbl = Table.new
+    tbl_hdrs = TableHeader.new
+    tbl_hdr_row = TableRow.new
+    headers.each do |h|
+      tc = TableHeaderCell.new
+      tc.append(h)
+      tbl_hdr_row.append(tc)
+    end
+    tbl_hdrs.append(tbl_hdr_row)
+    tbl.append(tbl_hdrs)
+    tbl_bdy = TableBody.new
+    data.each do |r|
+      tr = TableRow.new
+      r.each do |c|
+        tc = TableCell.new
+        tc.append(c)
+        tr.append(tc)
+      end
+      tbl_bdy.append(tr)
+    end
+    tbl.append(tbl_bdy)
+    return tbl
+  end
+  
+end

data/lib/reparcs/utilities.rb

@@ -0,0 +1,4 @@
+#Useful utilities
+module Utilities
+
+end

data/lib/reparcs/xml_entities.rb

@@ -0,0 +1,9 @@
+#XML entities
+module XMLEntities
+  ENTITIES = {
+    "£" => '£',
+    "&" => '&',
+    "<" => '&lt;',
+    ">" => '&gt;'
+  }
+end

data/lib/reparcs.rb

@@ -0,0 +1,46 @@
+require 'reparcs/base'
+
+require 'reparcs/elements/base_elements'
+require 'reparcs/elements/structure_elements'
+require 'reparcs/elements/text_elements'
+require 'reparcs/elements/hypertext_elements'
+require 'reparcs/elements/link_elements'
+require 'reparcs/elements/list_elements'
+require 'reparcs/elements/object_elements'
+require 'reparcs/elements/presentation_elements'
+require 'reparcs/elements/edit_elements'
+require 'reparcs/elements/form_elements'
+require 'reparcs/elements/table_elements'
+require 'reparcs/elements/image_elements'
+require 'reparcs/elements/meta_elements'
+require 'reparcs/elements/scripting_elements'
+require 'reparcs/elements/stylesheet_elements'
+
+require 'reparcs/xml_entities'
+require 'reparcs/projects'
+require 'reparcs/utilities'
+require 'reparcs/shortcuts'
+
+include Projects
+
+include BaseElements
+include StructureElements
+include TextElements
+include HypertextElements
+include LinkElements
+include ListElements
+include ObjectElements
+include PresentationElements
+include EditElements
+include FormElements
+include TableElements
+include ImageElements
+include MetaElements
+include ScriptingElements
+include StylesheetElements
+
+include Shortcuts
+
+module Reparcs
+  VERSION = "0.1.0"
+end