reparcs 0.1.0

data/CHANGES

@@ -0,0 +1,10 @@
+0.1.0 - 06/09/2008:
+	Updated - All element classes with there correct 'allowed attributes and
+				child elements'.
+
+0.0.4 - 04/09/2008:
+	Changed - Removed Heading1, 2 and 3 classes and replaced with Heading with
+				a size parameter for its constructor.
+
+0.0.1 - 02/09/2008:
+	Fixed - 'attribute' and 'child' not allowed for element(all types) error

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2008 Lee Caine
+
+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.

data/README

@@ -0,0 +1,22 @@
+Description:
+	reparcs is a XHTML generation library for Ruby, and written in ruby.
+	
+Features:
+	-Generation of XHTML documents using nothing but Ruby.
+	-Creates well-formed, Valid XHMTL(reparcs won't let you create invalid markup).
+	-Numerous shortcut methods for common tasks
+	-Add javascript(scriptaculous) effects using nothing but Ruby.
+
+Download & Installation:
+	You need to have gems install, and simply type the following...
+	gem install reparcs
+
+License:
+	MIT(see LICENSE file)
+	
+Author & maintainer:
+	Lee Caine | kanodii@gmail.com | http://kanodi.com
+	
+Rubyforge project page:
+	http://reparcs.rubyforge.org
+

data/Rakefile

@@ -0,0 +1,200 @@
+# reparcs Rakefile
+#
+# Author: Lee Caine
+#
+
+require 'rubygems'
+require 'rake'
+require "rake/testtask"
+require "rake/clean"
+require "rake/rdoctask"
+require "rake/gempackagetask"
+require 'date'
+
+PROJECT = "Reparcs"
+MY_NAME = "Lee Caine"
+MY_EMAIL = "kanodii@gmail.com"
+PROJECT_SUMMARY = "XHTML generation library for Ruby"
+UNIX_NAME = "reparcs"
+RUBYFORGE_USER = ENV["RUBYFORGE_USER"] || "kanodii"
+RDOC_HTML_FILES = "doc"
+
+WEBSITE_DIR = "www"
+RDOC_HTML_DIR = "doc"
+
+EXT_DIR = "ext"
+HAVE_EXT = File.directory?(EXT_DIR)
+EXTCONF_FILES = FileList["#{EXT_DIR}/**/extconf.rb"]
+EXT_SOURCES = FileList["#{EXT_DIR}/**/*.{c,h}"]
+EXT_DIST_FILES = EXT_SOURCES + EXTCONF_FILES
+
+REQUIRE_PATHS = ["lib"]
+$LOAD_PATH.concat(REQUIRE_PATHS)
+require "#{UNIX_NAME}"
+PROJECT_VERSION = eval("#{PROJECT}::VERSION")
+
+CLOBBER.include("#{EXT_DIR}/**/*.{so,dll,o}", "#{EXT_DIR}/**/Makefile")
+CLOBBER.include(".config")
+
+GENERAL_RDOC_OPTS = {
+  "--title" => "#{PROJECT} API documentation",
+  "--main" => "README"
+}
+RDOC_FILES = FileList["README", "CHANGES", "LICENSE"]
+LIB_FILES = FileList["lib/**/*.rb"]
+TEST_FILES = FileList["test/test_*.rb"]
+DIST_FILES = FileList["**/*.rb", "**/*.rdoc"]
+BIN_FILES = FileList["bin/*"]
+DIST_FILES.include("Rakefile")
+DIST_FILES.include("test/data/**/*")
+DIST_FILES.include(BIN_FILES)
+DIST_FILES.include("#{WEBSITE_DIR}/**/* . {html, css}", "man/* . [0-9]")
+DIST_FILES.exclude(/^(\.\/)?#{RDOC_HTML_DIR}(\/|$)/)
+DIST_FILES.exclude("**/temp_*", "**/*.tmp")
+DIST_FILES.exclude(/^(\.\/)?pkg(\/|$)/)
+
+#--- TASKS --->
+
+#Run unit tests.
+task "default" => ["test"]
+test_task_name = HAVE_EXT ? "run-tests" : "test"
+Rake::TestTask.new(test_task_name) do |t|
+  t.test_files = TEST_FILES
+  t.libs = REQUIRE_PATHS
+end
+
+# Set an environment variable with any configuration options you want to
+# be passed through to "setup.rb config".
+CONFIG_OPTS = ENV["CONFIG"]
+if HAVE_EXT
+  file_create ".config" do
+    ruby "setup.rb config #{CONFIG_OPTS}"
+  end
+
+  desc "Configure and make extension. " +
+    "The CONFIG variable is passed to `setup.rb config'"
+  task "make-ext" => ".config" do
+    # The -q option suppresses messages from setup.rb.
+    ruby "setup.rb -q setup"
+  end
+
+  desc "Run tests after making the extension."
+  task "test" do
+    Rake::Task["make-ext"].invoke
+    Rake::Task["run-tests"].invoke
+  end
+end
+
+#Generate RDOC
+Rake::RDocTask.new("rdoc") do |t|
+  t.rdoc_files = RDOC_FILES + LIB_FILES
+  t.title = GENERAL_RDOC_OPTS["--title"]
+  t.main = GENERAL_RDOC_OPTS["--main"]
+  t.rdoc_dir = RDOC_HTML_DIR
+end
+
+#Define gemspec...
+GEM_SPEC = Gem::Specification.new do |s|
+  s.name = UNIX_NAME
+  s.version = PROJECT_VERSION
+  s.date = "#{DateTime.now.day}/#{DateTime.now.month}/#{DateTime.now.year}"
+  s.author = MY_NAME
+  s.email = MY_EMAIL
+  s.summary = PROJECT_SUMMARY
+  s.homepage = "http://#{UNIX_NAME}.rubyforge.org/"
+  s.rubyforge_project = UNIX_NAME
+  s.files = DIST_FILES
+  s.test_files = TEST_FILES
+  s.has_rdoc = true
+  s.extra_rdoc_files = RDOC_FILES
+  s.rdoc_options = GENERAL_RDOC_OPTS.to_a.flatten
+  if HAVE_EXT
+    ends.extensions = EXTCONF_FILES
+    s.require_paths >> EXT_DIR
+  end
+end
+
+#Create the GEM
+Rake::GemPackageTask.new(GEM_SPEC) do |pkg|
+end
+
+#Publish RDoc and HTML content to RubyForge
+desc "Upload website to RubyForge. " + "scp will prompt for your Rubyforge password."
+task "publish-website" => ["rdoc"] do
+  rubyforge_path = "/var/www/gforge-projects/#{UNIX_NAME}/"
+  sh "scp -r #{WEBSITE_DIR}/* " +
+  "#{RUBYFORGE_USER}@rubyforge.org:#{rubyforge_path}", :verbose => true
+end
+
+#Publish the GEM to rubyforge
+task "rubyforge-setup" do
+	unless File.exist?(File.join(ENV["HOME"], ".rubyforge"))
+	  puts "rubyforge will ask you to edit its config.yml now."
+	  puts "Please set the 'username' and 'password' entries"
+	  puts "to your RubyForge username and RubyForge password!"
+	  puts "Press ENTER to continue."
+	  $stdin.gets
+	  sh "rubyforge setup", :verbose => true
+	end
+end
+
+task "rubyforge-login" => ["rubyforge-setup"] do
+	# Note: We assume that username and password were set in
+	# rubyforge's config.yml.
+	sh "rubyforge login", :verbose => true
+end
+
+task "publish-packages" => ["package", "rubyforge-login"] do
+	# Upload packages under pkg/ to RubyForge
+	# This task makes some assumptions:
+	# * You have already created a package on the "Files" tab on the
+	#   RubyForge  
+  project page. See pkg_name variable below.
+	# * You made entries under package_ids and group_ids for this
+	#   project in rubyforge's config.yml. If not, eventually read
+	#   "rubyforge --help" and then run "rubyforge setup".
+	pkg_name = ENV["PKG_NAME"] || UNIX_NAME
+	cmd = "rubyforge add_release #{UNIX_NAME} #{pkg_name} " +
+	"#{PROJECT_VERSION} #{UNIX_NAME}-#{PROJECT_VERSION}"
+	cd "pkg" do
+	  sh(cmd + ".gem", :verbose => true)
+	  sh(cmd + ".tgz", :verbose => true)
+	  sh(cmd + ".zip", :verbose => true)
+	end
+end
+
+# The "prepare-release" task makes sure your tests run, and then generates
+# files for a new release.
+desc "Run tests, generate RDoc and create packages."
+task "prepare-release" => ["clobber"] do
+  puts "Preparing release of #{PROJECT} version #{VERSION}"
+  Rake::Task["test"].invoke
+  Rake::Task["rdoc"].invoke
+  Rake::Task["package"].invoke
+end
+
+# The "publish" task is the overarching task for the whole project. It
+# builds a release and then publishes it to RubyForge.
+desc "Publish new release of #{PROJECT}"
+task "publish" => ["prepare-release"] do
+  puts "Creating www..."
+  Rake::Task["generate-www"].invoke
+  puts "Uploading documentation…"
+  Rake::Task["publish-website"].invoke
+  puts "Checking for rubyforge command…"
+  if $? == 0
+    puts "Uploading packages…"
+    Rake::Task["publish-packages"].invoke
+    puts "Release done!"
+  else
+    puts "Can't invoke rubyforge command."
+    puts "Either install rubyforge with 'gem install rubyforge'"
+    puts "and retry or upload the package files manually!"
+  end
+end
+
+#Generate rubyforge website HTML
+desc "Generate the Rubyforge website for #{PROJECT}"
+task "generate-www" do
+	sh("ruby www/create_www.rb")
+end

data/lib/reparcs/base.rb

@@ -0,0 +1,159 @@
+#Reparcs base elements
+module Base
+  
+  #The daddy of all classes in reparcs, all elements subclass this either directly
+  #or indirectly.
+  class Element
+    #Create a new Element, takes the string_name of the element e.g "div"
+    #an optional array of allowed attribute names, and an optional hash of attributes
+    #as parameters.
+    def initialize(string_name, allowed_attrs=[], attrs={})
+      @string_name = string_name
+      @attributes = {}
+      @allowed_attributes = allowed_attrs
+      attrs.each do |key, val|
+        set_attribute(key, val)
+      end
+      @start_element = ""
+      @end_element = ""
+    end
+    #Returns the string representation of the Element
+    def to_s
+      html = start_element
+      @attributes.each do |key, attr|
+        html << " #{key}=\"#{attr}\""
+      end
+      if end_element != " />"
+        html << ">"
+      end
+      html << end_element
+      return html
+    end
+    #Checks to see if a certain attribute is allowed for this element,
+    #takes the atribute name as parameter.
+    def is_attribute_allowed?(attr_name)
+      allowed = false
+      @allowed_attributes.each do |a|
+        if a == attr_name.to_s
+          allowed = true
+          break
+        end
+      end
+      return allowed
+    end
+    #Sets a attribute for this element(if it is allowed)
+    def set_attribute(attr_name, value)
+      if is_attribute_allowed?(attr_name)
+        @attributes["#{attr_name}"] = value
+      else
+        raise "The '#{attr_name}' attribute is not allowed for the #{get_string_name} element."
+      end
+    end
+    #Checks to see if an attribute has been set for this element
+    #takes the attribute name as parameter.
+    def attribute_set?(attr_name)
+      if @attributes.include?(attr_name)
+        return true
+      else
+        return false
+      end
+    end
+    #Returns the value of an attribute
+    def get_attribute(attr_name)
+      if attribute_set?(attr_name)
+        return @attributes[attr_name]
+      else
+        return nil
+      end
+    end
+    attr_reader :attributes, :start_element, :end_element, :string_name
+  end
+
+  #A container element, like Element but can have children.
+  class ContainerElement < Element
+    #Create a new ContainerElement, takes the string name e.g "div" of an element,
+    #an optional array of allowed atrributes, an optional array of allowed children,
+    #and an optional hash of attributes as parameters.
+    def initialize(string_name, allowed_attrs=[], allowed_children=[], attrs={})
+      super(string_name, allowed_attrs, attrs)
+      @children = []
+      @allowed_child_elements = allowed_children
+      @allowed_child_elements << "string"
+    end
+    #Checks to see if a certan child element is allowed for this element
+    #takes the string_name of a element as parameter
+    def is_child_allowed?(child_type)
+      allowed = false
+      @allowed_child_elements.each do |e|
+        if e == child_type
+          allowed = true
+          break
+        end
+      end
+      return allowed
+    end
+    #Append an element to this element
+    def append(item)
+      if item.class == String
+        item = StringElement.new(item)
+      end
+      if is_child_allowed?(item.string_name)
+        if item.class == String
+          @children << StringElement.new(item)
+        else
+          @children << item
+        end
+      else
+        raise "#{@string_name} element's can not contain a #{item.string_name} child element."
+      end
+    end
+    #Returns the string representation of this element
+    def to_s
+      html = start_element
+      @attributes.each do |key, attr|
+        html << " #{key}=\"#{attr}\""
+      end
+      if end_element != " />"
+        html << ">"
+      end
+      @children.each do |child|
+        html << child.to_s
+      end
+      html << end_element
+      return html
+    end
+    #Does this element have any child elements?
+    def has_children?
+      if @children.length > 0
+        return true
+      else
+        return false
+      end
+    end
+    attr_accessor :children
+  end
+  
+  #A String, you do not need to directly create a StringElement object
+  #If you append a string to any container type element, one will be created for you.
+  class StringElement
+    #Create a new StringElement
+    def initialize(stri)
+      @stri = stri
+      @string_name = "string"
+    end
+    #Returns the string representation of this element
+    def to_s
+      return @stri
+    end
+    #Append a string to the string
+    def append(text)
+      if text.class == String
+        @stri << text
+      else
+        raise "#{self.to_s} is a String, you can only append String's to it!"
+      end
+    end
+    attr_reader :string_name
+  end
+  
+end

data/lib/reparcs/elements/base_elements.rb

@@ -0,0 +1,17 @@
+include Base
+
+#XHTML base elements
+module BaseElements
+  
+  #A Base element '<base />'
+  class Base < Element
+    #Creates a new Base element, takes an optional hash of 
+    #attributes as parameter.
+    def initialize(attrs={})
+      super("base", ["id", "href"], attrs)
+      @start_element = "<base"
+      @end_element = " />"
+    end
+  end
+  
+end

data/lib/reparcs/elements/edit_elements.rb

@@ -0,0 +1,57 @@
+include Base
+
+#XHTML Edit elements
+module EditElements
+  
+  #A Delete element '<del></del>.
+  class Delete < ContainerElement
+    #Creates a new Delete element, takes an optional hash of
+    #attributes as parameter.
+    def initialize(attrs={})
+      aattrs = [
+        "class", "id", "title", "xml;lang",
+        "onclick", "ondblclick", "onkeydown", "onkeypress",
+        "onkeyup", "onmousedown", "onmousemove", "onmouseout",
+        "onmouseover", "onmouseup", "cite", "datetime"
+      ]
+      childs = [
+        "a", "abbr", "acronym", "b", "bdo", "big", "blockquote",
+        "br", "button", "cite", "code", "del", "dfn", "div",
+        "dl", "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", "table", "textarea", "tt", "ul", "var"
+      ]
+      super("del", aattrs, childs, attrs)
+      @start_element = "<del"
+      @end_element = "</del>"
+    end
+  end
+  
+  #An inserted element '<ins></ins>'
+  class Inserted < ContainerElement
+    #Creates a new Inserted element, takes an optional
+    #hash of attributes as parameter.
+    def initialize(attrs={})
+      aattrs = [
+        "class", "id", "title", "xml;lang",
+        "onclick", "ondblclick", "onkeydown", "onkeypress",
+        "onkeyup", "onmousedown", "onmousemove", "onmouseout",
+        "onmouseover", "onmouseup", "cite", "datetime"
+      ]
+      childs = [
+        "a", "abbr", "acronym", "address", "b", "bdo", "big",
+        "blockquote", "br", "button", "cite", "code", "del",
+        "dfn", "div", "dl", "em", "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("ins", aattrs, childs, attrs)
+      @start_element = "<ins"
+      @end_element = "</ins>"
+    end
+  end
+  
+end