reparcs 0.1.0 → 0.1.5

data/History.txt

@@ -0,0 +1,17 @@
+== 0.1.5 08/09/2008:
+	* 1 Fixed 
+	 	* A bug where if you called to_s on all elements more than once, the entire html of the element would be appended to its children.
+	* 2 Added 
+		* XML entities conversion for StringElements.
+
+== 0.1.0 06/09/2008:
+	* 1 Updated 
+		* All element classes with there correct 'allowed attributes and child elements'.
+
+== 0.0.4 04/09/2008:
+	* 1 Changed 
+		* Removed Heading1, 2 and 3 classes and replaced with Heading with a size parameter for its constructor.
+
+== 0.0.1 02/09/2008:
+	* 1 Fixed
+		* 'attribute' and 'child' not allowed for element(all types) error

data/Rakefile

@@ -19,7 +19,7 @@ UNIX_NAME = "reparcs"
 RUBYFORGE_USER = ENV["RUBYFORGE_USER"] || "kanodii"
 RDOC_HTML_FILES = "doc"
 
-WEBSITE_DIR = "www"
+WEBSITE_DIR = "doc"
 RDOC_HTML_DIR = "doc"
 
 EXT_DIR = "ext"
@@ -37,10 +37,10 @@ CLOBBER.include("#{EXT_DIR}/**/*.{so,dll,o}", "#{EXT_DIR}/**/Makefile")
 CLOBBER.include(".config")
 
 GENERAL_RDOC_OPTS = {
-  "--title" => "#{PROJECT} API documentation",
+  "--title" => "#{PROJECT} Library documentation",
   "--main" => "README"
 }
-RDOC_FILES = FileList["README", "CHANGES", "LICENSE"]
+RDOC_FILES = FileList["README", "History.txt", "LICENSE"]
 LIB_FILES = FileList["lib/**/*.rb"]
 TEST_FILES = FileList["test/test_*.rb"]
 DIST_FILES = FileList["**/*.rb", "**/*.rdoc"]
@@ -149,17 +149,15 @@ task "publish-packages" => ["package", "rubyforge-login"] do
 	# 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.
+  # 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} " +
+	pkg_name = UNIX_NAME
+	cmd = "rubyforge add_release -a 'History.txt' #{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
 
@@ -167,7 +165,7 @@ end
 # 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}"
+  puts "Preparing release of #{PROJECT} version #{PROJECT_VERSION}"
   Rake::Task["test"].invoke
   Rake::Task["rdoc"].invoke
   Rake::Task["package"].invoke
@@ -177,8 +175,6 @@ end
 # 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…"
@@ -191,10 +187,4 @@ task "publish" => ["prepare-release"] do
     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.rb

@@ -21,6 +21,9 @@ require 'reparcs/projects'
 require 'reparcs/utilities'
 require 'reparcs/shortcuts'
 
+include XMLEntities
+include Utilities
+
 include Projects
 
 include BaseElements
@@ -42,5 +45,5 @@ include StylesheetElements
 include Shortcuts
 
 module Reparcs
-  VERSION = "0.1.0"
+  VERSION = "0.1.5"
 end

data/lib/reparcs/base.rb

@@ -1,3 +1,7 @@
+require 'reparcs/utilities'
+
+include Utilities
+
 #Reparcs base elements
 module Base
   
@@ -12,21 +16,21 @@ module Base
       @attributes = {}
       @allowed_attributes = allowed_attrs
       attrs.each do |key, val|
-        set_attribute(key, val)
+        self.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}\""
+    #Returns the html representation of the Element
+    def to_html
+      html = "#{@start_element}"
+      @attributes.each do |key, attri|
+        html << " #{key}=\"#{attri}\""
       end
-      if end_element != " />"
+      if @end_element != " />"
         html << ">"
       end
-      html << end_element
+      html << @end_element
       return html
     end
     #Checks to see if a certain attribute is allowed for this element,
@@ -46,7 +50,7 @@ module Base
       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."
+        raise "The '#{attr_name}' attribute is not allowed for the '#{@string_name}' element."
       end
     end
     #Checks to see if an attribute has been set for this element
@@ -85,7 +89,7 @@ module Base
     def is_child_allowed?(child_type)
       allowed = false
       @allowed_child_elements.each do |e|
-        if e == child_type
+        if e == child_type.to_s
           allowed = true
           break
         end
@@ -98,28 +102,22 @@ module Base
         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."
+        raise "#'{@string_name}' element's can not contain a '#{item.string_name}' child elements."
       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 << ">"
+    def to_html
+      html = "#{@start_element}"
+      @attributes.each do |key, attri|
+        html << " #{key}=\"#{attri}\""
       end
+      html << ">"
       @children.each do |child|
-        html << child.to_s
+        html << child.to_html
       end
-      html << end_element
+      html << @end_element
       return html
     end
     #Does this element have any child elements?
@@ -138,19 +136,19 @@ module Base
   class StringElement
     #Create a new StringElement
     def initialize(stri)
-      @stri = stri
+      @stri = put_xml_entities(stri)
       @string_name = "string"
     end
     #Returns the string representation of this element
-    def to_s
+    def to_html
       return @stri
     end
     #Append a string to the string
     def append(text)
       if text.class == String
-        @stri << text
+        @stri << put_xml_entities(text)
       else
-        raise "#{self.to_s} is a String, you can only append String's to it!"
+        raise "#{self.to_html} is a String, you can only append String's to it!"
       end
     end
     attr_reader :string_name

data/lib/reparcs/elements/hypertext_elements.rb

@@ -1,5 +1,3 @@
-include Base
-
 #XHTML hypertext elements
 module HypertextElements
   

data/lib/reparcs/elements/structure_elements.rb

@@ -21,7 +21,7 @@ module StructureElements
         "onunload"
       ]
       childs = [
-        "address", "blockquote", "del",
+        "a", "address", "blockquote", "del",
         "div", "fieldset", "form", "hr",
         "ins", "noscript", "p", "pre",
         "script", "table", "h1", "h2", "h3",

data/lib/reparcs/shortcuts.rb

@@ -1,6 +1,3 @@
-include StructureElements
-include TextElements
-
 #A collection of shortcut methods for reparcs
 module Shortcuts
   

data/lib/reparcs/utilities.rb

@@ -1,4 +1,19 @@
 #Useful utilities
 module Utilities
-
+  #Replaces invalid XML characters (£, <, >, etc with there xml entity)
+  def put_xml_entities(text)
+    new_t = text
+    ENTITIES.each do |key, val|
+      new_t = new_t.gsub(key, val)
+    end
+    return new_t
+  end
+  #Replaces XML entities with the equivalent character.
+  def remove_xml_entities(text)
+    new_t = text
+    ENTITIES.each do |key, val|
+      new_t = new_t.gsub(val, key)
+    end
+    return new_t
+  end
 end

data/test/test_shortcuts.rb

@@ -5,6 +5,8 @@ require 'test/unit'
 #Reparcs shortcut tests
 class ShortcutsTest < Test::Unit::TestCase
   
+  include Base
+  include Utilities
   include Shortcuts
   include TableElements
   
@@ -42,7 +44,44 @@ class ShortcutsTest < Test::Unit::TestCase
       ["SnipIt!", "http://snipit.kanodi.com"]
     ]
     tbl = shortcut_table(headers, data)
-    html = tbl.to_s.gsub(/(\n|\t| )/, "")
+    html = tbl.to_html.gsub(/(\n|\t| )/, "")
+    assert(html == desired_html)
+  end
+  
+  #Tests the shortcut_anchor method
+  def test_shortcut_anchor
+    desired_html = %{<a href="http://google.co.uk" class="links">Google</a>}
+    anchor = Anchor.new({:href => 'http://google.co.uk', :class => 'links'})
+    anchor.append("Google")
+    assert(anchor.to_html == desired_html)
+  end
+  
+  #Tests the shortcut_unordered_list method
+  def test_shortcut_unorderedlist
+    names = ["Lee", "Caine", "kanodi", "reparcs"]
+    desired_html = %{<ul class="names">}
+    names.each { |n| desired_html << %{<li>#{n}</li>}}
+    desired_html << "</ul>"
+    list = shortcut_unordered_list(names)
+    list.set_attribute("class", "names")
+    assert(list.to_html == desired_html)
+  end
+  
+  #Tests the shortcut_unordered_list method by passing anchors
+  def test_shortcut_unordered_list_with_anchors
+    names = [
+      shortcut_anchor('http://google.co.uk', 'Google'),
+      shortcut_anchor('http://kanodi.com', 'Kanodi > blog')
+    ]
+    desired_html = %{<ul class="names">}
+    names.each do |n|
+      desired_html << "<li>#{n.to_html}</li>"
+    end
+    desired_html << "</ul>"
+    desired_html = desired_html.gsub(/(\t|\n)/, "")
+    list = shortcut_unordered_list(names)
+    list.set_attribute("class", "names")
+    html = list.to_html.gsub(/(\t|\n)/, "")
     assert(html == desired_html)
   end
   

data/test/test_validmarkup.rb

@@ -7,6 +7,7 @@ require 'test/unit'
 class ValidXHTMLStrictTest < Test::Unit::TestCase
   
   include Projects
+  include Utilities
   include HTTPHelpers
   
   #Tests the blank html document created by the Page class for validation
@@ -16,7 +17,7 @@ class ValidXHTMLStrictTest < Test::Unit::TestCase
     title.append("Standard page test")
     page.head.append(title)
     f = File.new('temp/valid_standard_test.html', 'w')
-    f.puts page.to_s
+    f.puts page.to_html
     f.close()
     assert(w3c_validate?('temp/valid_standard_test.html'))
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: reparcs
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors: 
 - Lee Caine
@@ -21,7 +21,7 @@ extensions: []
 
 extra_rdoc_files: 
 - README
-- CHANGES
+- History.txt
 - LICENSE
 files: 
 - lib/reparcs/base.rb
@@ -48,17 +48,16 @@ files:
 - test/http_helpers.rb
 - test/test_shortcuts.rb
 - test/test_validmarkup.rb
-- www/create_www.rb
 - Rakefile
 - README
-- CHANGES
+- History.txt
 - LICENSE
 has_rdoc: true
 homepage: http://reparcs.rubyforge.org/
 post_install_message: 
 rdoc_options: 
 - --title
-- Reparcs API documentation
+- Reparcs Library documentation
 - --main
 - README
 require_paths: 

data/CHANGES

@@ -1,10 +0,0 @@
-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/www/create_www.rb

@@ -1,85 +0,0 @@
-#Creates the reparcs rubyforge webpage, using reparcs....
-#
-# by Lee Caine | kanodii@gmail.com | http://kanodi.com
-#
-
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
-require 'reparcs.rb'
-require 'test/unit'
-
-page = Page.new
-page.head.append(shortcut_title("reparcs - XHTML generation library for Ruby"))
-page.head.append(shortcut_style(%{
-  h1 {
-    font-size: 20px;
-    color: #D15600;
-  }
-  
-  h2 {
-    font-size: 16px;
-    color: #3F4C6B;
-  }
-  
-  #main {
-    width: 300px;
-    float: left;
-  }
-  
-  #links {
-    width: 200px;
-    border: 5px solid #666666;
-    background-color: #FFFF88;
-    float: right;
-  }
-  
-  #links ul {
-    list-style-type: none;
-    width: 100%;
-    margin-left: 0px;
-    padding-left: 0px;
-  }
-  
-  #links ul li {
-    display: block;
-    color: #666666;
-    text-align: center;
-  }
-  
-  #links ul li:hover {
-    background-color: #666666;
-    color: white;
-  }
-  
-  
-  #footer {
-    clear: both;
-  }
-}))
-page.body.append(shortcut_header(1, "Reparcs V#{Reparcs::VERSION}"))
-main = Division.new({:id => 'main'})
-pre = Preformat.new
-readme_content = File.new('README', 'r').read
-readme = readme_content.gsub(/^(.):/, "<h2>#{$0}</h2>")
-pre.append(readme)
-main.append(pre)
-page.body.append(main)
-
-links = Division.new({:id => 'links'})
-as = [
-  shortcut_anchor('http://rubyforge.org/projects/reparcs/', 'Rubyforge project page'),
-  shortcut_anchor("http://rubyforge.org/projects/reparcs/files/reparcs-#{VERSION}.gem", 'Download latest GEM'),
-  shortcut_anchor('http://reparcs.rubyforge.org/changes.html', 'Changes'),
-  shortcut_anchor('http://kanodi.com', 'Developers blog')
-]
-links_list = shortcut_unordered_list(as)
-links.append(links_list)
-page.body.append(links)
-
-footer = Division.new({:id => 'footer'})
-footer.append(HorizontalRule.new)
-footer.append(shortcut_anchor('http://validator.w3.org/check?uri=referer', 'Valid XHTML'))
-page.body.append(footer)
-
-save = File.new('www/index.html', 'w')
-save.write(page.to_s)
-save.close()