reparcs 0.2.1 → 0.2.8

data/History.txt

@@ -1,3 +1,22 @@
+== 0.2.8 09/09/2008:
+	* 1 Added
+		* PageWithScript and WebsiteWithScript classes to projects.rb, which are simply there superclasses
+		with the scriptaculous scripts included for a quick shortcut.
+	* 2 Updated
+	 	* the list of XML entities.
+	* 3 Added
+		* Several more XHTML validation unit tests(which pass(for now :)))
+	* 4 Fixed
+		* The Page.include_scriptaculous method was not adding the type attribute
+		to the Script elements, resulting in invalid XHTML
+	* 5 Fixed
+		* error, when an exception is raised whilst attempting to append an element to another and it is not
+		allowed, the exception would read #'{@string_name} rather than the actual string name of the element.
+	* 6 Fixed
+		* Division 'div' elements were not allowed to have table 'table' elements as children.
+	* 7 Fixed
+		* Option elements ere not allowed to have the 'value' attribute.
+
 == 0.2.1 09/09/2008:
 	* 1 Fixed
 		* error copying javascript files to Website's publish directory.
@@ -6,13 +25,16 @@
 	* 1 Added
 		* Included the prototype & scriptaculous javascript files to the project
 	* 2 Added
-		* A Website class to projects.rb, where you can add css, javascript, and images files to it, the class has a publish method which creates the whole website structure.
+		* A Website class to projects.rb, where you can add css, javascript, and images files to it, the class
+	 	has a publish method which creates the whole website structure.
 	* 3 Added
-		* A include_scriptaculous method to the Page class, whcih includes a script element for each javascript file in the scriptaculous library.
+		* A include_scriptaculous method to the Page class, whcih includes a script element for each javascript
+		 file in the scriptaculous library.
 
 == 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.
+	 	* 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.
 

data/README

@@ -21,5 +21,84 @@ Homepage:
 	http://reparcs.rubyforge.org
 	
 Rubyforge project page:
-	http://rubyforge.org/projects/reparc
+	http://rubyforge.org/projects/reparcs
+	
+Example:
+	
+	#Include the library
+	require 'rubygems'
+	require 'reparcs'
+	
+	#Create a new website
+	my_project = Website.new
+	#Create and add a page
+	index_page = Page.new
+	my_project.append("index", index_page)
+	
+	#Now lets design the page...
+	#Set the title
+	index_page.head.append(shortcut_title("Home"))
+	#Create a layer 'div'
+	main_layer = Division.new
+	#Add a header
+	main_layer.append(shortcut_header(1, "Welcome.."))
+	#Add a paragraph with some text..
+	para = Paragraph.new
+	para.append(%{
+		"Welcome to my site, it contains a whole bunch of crap...."
+	})
+	#Add the paragraph to the layer
+	main_layer.append(para)
+	#Lets add some links
+	links = [
+		shortcut_anchor("http://google.co.uk", "Google"),
+		shortcut_anchor("http://rubyforge.org", "Rubyforge"),
+		shortcut_anchor("http://kanodi.com", "Kanodi"),
+		shortcut_anchor("http://reparcs.rubyforge.org", "Reparcs")
+	]
+	ul = shortcut_unordered_list(links)
+	main_layer.append(ul)
+	#I suppose we better add the layer to the page's body..
+	index_page.body.append(main_layer)
+	#It is all going to look a little boring lets style it..
+	#before we add some css, we better add some id attributes to
+	#our elements
+	main_layer.set_attribute("id", "main")
+	ul.set_attribute("id", "links")
+	#Ok lets add some style
+	index_page.head.append(shortcut_style(%{
+		#main {
+			width: 400px;
+			border: 5px solid #666666
+			float: left;
+		}
+		
+		#links {
+			list-style-type: none;
+		}
+		
+		#links ul li {
+			display: block;
+		}
+	})
+	#Why we are at it shall we add some cool effects?...
+	#To add an effect to an element it must have an id attribute
+	#So lets add id's to out anchors..
+	id = 0
+	links.each do |l|
+		l.set_attribute("id", "link#{id}")
+		id += 1
+		#We may aswell add the effect whilst we are in the loop
+		index_page.add_effect(l, "onmouseover", "Grow")
+	end
+	#Aswell as setting the effect, we need to include the prototype &
+	#scriptaculous libraries..
+	my_project.include_scriptaculous_files
+	index_page.include_scriptaculous
+	
+	#Now lets publish the whole lot
+	my_project.publish("/Users/bigk/Desktop/www")
+	
+	#This would create 1 html file called "index.html" and a javascript directory containing all the
+	#scriptaculous library files.
 

data/lib/reparcs.rb

@@ -45,5 +45,5 @@ include StylesheetElements
 include Shortcuts
 
 module Reparcs
-  VERSION = "0.2.1"
+  VERSION = "0.2.8"
 end

data/lib/reparcs/base.rb

@@ -104,7 +104,7 @@ module Base
       if is_child_allowed?(item.string_name)
           @children << item
       else
-        raise "#'{@string_name}' element's can not contain a '#{item.string_name}' child elements."
+        raise "'#{@string_name}' element's can not contain a '#{item.string_name}' child elements."
       end
     end
     #Returns the string representation of this element
@@ -128,6 +128,10 @@ module Base
         return false
       end
     end
+    #Returns this elements children
+    def get_children
+      return @children
+    end
     attr_accessor :children
   end
   

data/lib/reparcs/elements/form_elements.rb

@@ -190,7 +190,7 @@ module FormElements
         "class", "id", "title", "dir", "xml:lang",
         "onclick", "ondblclick", "onkeydown", "onkeypress",
         "onkeyup", "onmousedown", "onmousemove", "onmouseout",
-        "onmouseover", "onmouseup", "style"
+        "onmouseover", "onmouseup", "style", "value"
       ]
       super("option", aattrs, [], attrs)
       @start_element = "<option"

data/lib/reparcs/elements/text_elements.rb

@@ -177,7 +177,7 @@ module TextElements
         "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"
+        "strong", "sub", "sup", "table", "textarea", "tt", "ul", "var"
       ]
       super("div", aattrs, childs, attrs)
       @start_element = "<div"

data/lib/reparcs/projects.rb

@@ -48,6 +48,7 @@ module Projects
       Dir.foreach(JAVASCRIPT_LIB_PATH) { |f| 
         unless f[0,1] == "."
           s = Script.new({:src => "javascript/#{f}"})
+          s.set_attribute("type", "text/javascript")
           @head.append(s)
         end
       }
@@ -72,6 +73,14 @@ module Projects
     attr_accessor :head, :body, :xml_lang, :lang, :xmlns, :charset
   end
   
+  #The PageWithScript class is simply a Page with the scriptaculous files included
+  class PageWithScript < Page
+    def initialize
+      super
+      self.include_scriptaculous
+    end
+  end
+  
   #A Website, a good starting point for larger projects, that require
   #other files, etc.
   class Website
@@ -145,4 +154,12 @@ module Projects
     end
   end
   
+  #The WebsiteWithScript class is simply a Website with the scriptaculous files included.
+  class WebsiteWithScript < Website
+    def initialize
+      super
+      self.include_scriptaculous_files
+    end
+  end
+  
 end

data/lib/reparcs/shortcuts.rb

@@ -35,7 +35,7 @@ module Shortcuts
     select = Select.new
     hash.each do |key, val|
       option = Option.new({:value => val})
-      option.append(key)
+      option.append(key.to_s)
       select.append(option)
     end
     return select

data/lib/reparcs/xml_entities.rb

@@ -4,6 +4,11 @@ module XMLEntities
     "£" => '£',
     "&" => '&',
     "<" => '&lt;',
-    ">" => '&gt;'
+    ">" => '&gt;',
+    "\"" => '&quot;',
+    "'" => '&apos;',
+    "¢" => '&cent;',
+    "©" => '&copy;',
+    "®" => '&reg;',
   }
 end

data/test/test_shortcuts.rb

@@ -81,8 +81,14 @@ class ShortcutsTest < Test::Unit::TestCase
     desired_html = desired_html.gsub(/(\t|\n)/, "")
     list = shortcut_unordered_list(names)
     list.set_attribute("class", "names")
-    html = list.to_html.gsub(/(\t|\n)/, "")
+    html = list.to_html.gsub(/(\t|\n|  )/, "")
     assert(html == desired_html)
   end
   
+  def test_shortcut_select
+    desired_html = %{<select><option value="red">Red</option><option value="blue">Blue</option></select>}
+    select = shortcut_select({:Blue => 'blue', :Red => 'red'})
+    assert(select.to_html == desired_html)
+  end
+  
 end

data/test/test_validmarkup.rb

@@ -21,4 +21,80 @@ class ValidXHTMLStrictTest < Test::Unit::TestCase
     f.close()
     assert(w3c_validate?('temp/valid_standard_test.html'))
   end
+  
+  #Test a basic page where xml character entities have been appended
+  def test_xml_entities
+      page = Page.new
+      title = Title.new
+      title.append("My amazing site & stuff")
+      page.head.append(title)
+      f = File.new('temp/valid_xml_entities_test.html', 'w')
+      f.puts page.to_html
+      f.close
+      assert(w3c_validate?('temp/valid_xml_entities_test.html'))
+  end
+  
+  #Markup that should fail validation, if this passes I know that
+  #the validator method is working
+  def test_invalid
+    page = Page.new
+    title = Title.new
+    title.append("My amazing site & stuff")
+    page.head.append(title)
+    f = File.new('temp/valid_invalid_test.html', 'w')
+    invalid_html = page.to_html.gsub("/>", "")
+    f.puts invalid_html
+    f.close
+    assert(!w3c_validate?('temp/valid_invalid_test.html'))
+  end
+  
+  #Tests the validation of a slightly more complex page
+  def test_more_complex_page
+    page = Page.new
+    page.include_scriptaculous
+    title = Title.new
+    title.append("My amazing site & stuff")
+    stylesheet = Link.new({:rel => 'stylesheet', :type => 'text/css', :media => 'screen'})
+    stylesheet.set_attribute("href", "http://somwhere.com/some.css")
+    page.head.append(stylesheet)
+    page.head.append(title)
+    main = Division.new({:id => 'main'})
+    page.body.append(main)
+    main.append(shortcut_header(1, "My names.."))
+    names = ["Lee", "kanodi", "reparcs"]
+    ul = shortcut_unordered_list(names)
+    id = 0
+    ul.get_children.each do |li|
+      if li.class == ListItem
+        li.set_attribute("id", "li#{id}")
+        page.add_effect(li, "onmouseover", "Grow")
+        id += 1
+      end
+    end
+    main.append(ul)
+    f = File.new('temp/valid_complex_test.html', 'w')
+    f.puts page.to_html
+    f.close
+    assert(w3c_validate?('temp/valid_complex_test.html'))
+  end
+  
+  #Test validation on a page with a table(made using the shortcut)
+  def test_valid_page_with_table_shortcut
+    page = Page.new
+    page.head.append(shortcut_title("Test"))
+    headers = ["Name", "URL"]
+    data = [
+      ["Google", "http://www.google.co.uk"],
+      ["Kanodi", "http://kanodi.com"],
+      ["SnipIt!", "http://snipit.kanodi.com"]
+    ]
+    tbl = shortcut_table(headers, data)
+    main = Division.new
+    main.append(tbl)
+    page.body.append(main)
+    f = File.new('temp/valid_table_shortcut_test.html', 'w')
+    f.puts page.to_html
+    f.close
+    assert(w3c_validate?('temp/valid_table_shortcut_test.html'))
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: reparcs
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.8
 platform: ruby
 authors: 
 - Lee Caine
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-09 00:00:00 +01:00
+date: 2008-09-09 00:00:00 +01:00
 default_executable: 
 dependencies: []