RubyGems - BodyBuilder - Versions diffs - 0.2.0 - Mend

BodyBuilder 0.2.0

Files changed (8) hide show

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = %q{BodyBuilder}
+  s.version = "0.2.0"
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Exiquio Cooper-Anderson"]
+  s.date = %q{2010-12-12}
+  s.description = %q{XHMTL 1.1 generator}
+  s.email = %q{exiquio @nospam@ gmail.com}
+  s.extra_rdoc_files = ["README", "lib/body_builder.rb", "lib/hash.rb", "lib/object.rb"]
+  s.files = ["BodyBuilder.gemspec", "Manifest", "README", "Rakefile", "lib/body_builder.rb", "lib/hash.rb", "lib/object.rb"]
+  s.homepage = %q{http://www.github.com/exiquio/BodyBuilder}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "BodyBuilder", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{bodybuilder}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{XHMTL 1.1 generator}
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/Manifest ADDED

@@ -0,0 +1,7 @@
+BodyBuilder.gemspec
+Manifest
+README
+Rakefile
+lib/body_builder.rb
+lib/hash.rb
+lib/object.rb

data/README ADDED

@@ -0,0 +1,74 @@
+BodyBuilder (Version 0.1.9)
+	Ruby XHTML 1.1 Generator
+Author: Exiquio Cooper-Anderson (exiquio [at] gmail [dot] com)
+Copyright: (C) 2010 Exiquio Cooper-Anderson
+License: GPLv3 (www.gnu.org/licenses/gpl.html)
+Requirements:
+	Ruby 1.9.*
+Installation:
+	gem install BodyBuilder
+Usage:
+{{{
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'body_builder'
+c = BodyBuilder::HeMan.new
+c.div 'id="main_content"'
+	c._p_ '', 'Hello, world!'
+	c._hr_
+	c._p_ '', 'Generated with BodyBuilder'
+c.div_
+puts BodyBuilder::Skeletor.new(
+	{
+		title: 'Hello, world',
+		body: c,
+		icon: {href: '/public/images/icon.png', type: 'media/png'}
+	}
+).render
+}}}
+Results:
+{{{
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+	<head>
+		<title>Hello, world</title>
+		<link rel="icon" type="media/png" href="/public/images/icon.png"></link>
+	</head>
+	<body>
+		<div id="main_content">
+			<p>Hello, world!</p>
+			<hr></hr>
+			<p>Generated with BodyBuilder</p>
+		</div>
+	</body>
+</html>
+}}}
+Latest change:
+	2010-12-11 - Refactored, XHTML 1.1 implementation complete, brought in ExLib, version changed to 0.1.9, decided against HTML5 implementation
+Todo 0.3.0:
+	Improve performance
+	Improve testing of dynamically created methods
+NOTE:
+	'document type does not allow element 'script' here'
+	Validation causes the above error because scripts are loading at the end of the XHTML document for performance.
+Any questions, conscerns or commments: exiquio [at] gmail [dot] com

data/Rakefile ADDED

@@ -0,0 +1,14 @@
+require 'rake'
+require 'echoe'
+Echoe.new('BodyBuilder', '0.2.0') do |p|
+	p.description = 'XHMTL 1.1 generator'
+	p.url = 'http://www.github.com/exiquio/BodyBuilder'
+	p.author = 'Exiquio Cooper-Anderson'
+	p.email = 'exiquio @nospam@ gmail.com'
+	p.ignore_pattern = [
+		'tests/*',
+		'readme_example.rb',
+		'index.html'
+	]
+end

data/lib/body_builder.rb ADDED

@@ -0,0 +1,267 @@
+# BodyBuilder
+#
+#		Ruby XHTML 1.1 generator.
+#
+# Author:: Exiquio Cooper-Anderson (mailto:exiquio@gmail.com)
+# Copyright:: (C) 2010 Exiquio Cooper-Anderson (mailto:exiquio@gmail.com)
+# License:: GPLv3 (http://www.gnu.org/licenses/gpl.html)
+# Version:: 0.2.0
+#
+# Requirements::
+#		Ruby 1.9.*
+#
+# Changelog::
+#		2010-04-01 - Initial creation with select XHTML 1.1 tags (mailto:exiquio@gmail.com)
+#		2010-12-09 - Redocumented, refactored for style, exceptions classes added, removed cgi, updated for Ruby 1.9 (mailto:exiquio@gmail.com)
+#		2010-12-10 - Fixed documentation (mailto:exiquio@gmail.com)
+#		2010-12-11 - Refactored, XHTML 1.1 implementation complete, brought in ExLib, version changed to 0.1.9, decided against HTML5 implementation (mailto:exiquio@gmail.com)
+#		2010-12-12 - Refactored, fixed bugs, implmented riot beheavior tests, benchmarke, version upped to 0.2.0 (mailto:exiquio@gmail.com)
+#
+#	Reference::
+#		XHTML 1.1 - http://learningforlife.fsu.edu/webmaster/references/xhtml/tags/
+require_relative 'hash'
+require_relative 'object'
+module BodyBuilder
+# Exception to be raised in the context of Skeletor
+class SkeletorException < Exception
+end
+# Provies framework for quickly building a vailid HTML 5 bareboned document
+class Skeletor
+	XML_DECLARATION = '<?xml version="1.0" encoding="UTF-8"?>'
+	DOCTYPE = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">'
+	HTML_DECLARATION = '<html xmlns="http://www.w3.org/1999/xhtml">'
+	#	Creates an XHTML 1.1 object
+	#
+	#		options (Hash)
+	#			{
+	#				title: String - Title of the XHTML 1.1 Document.,
+	#				meta: Arrary[Hash,..] <optional> - Array of Hashes containing key value pairs of meta data.,
+	#					(eg., [{name: 'name', content: 'content'}])
+	#				base: String <optional> - Base URL for the HTML document. Defaults to noe,
+	#				favicon: Hash <optional> - Hash with the href and type of your favicon icon. Defualts to none,
+	#					(eg., {href: String, type: String})
+	#				stylesheets: Array[Hash] <optional> - List of paths to CSS files and optional media types.,
+	#					(eg., [{href: 'path\to\stylesheet', {[media: 'screen'],..}},..])
+	#       body: HeMan or String - Either a HeMan XHTML 1.1 Body Object or String containing markup.,
+	#				scripts:	Array[String] <optional> - List of paths to JavaScript files. Defaults to none.,
+	#			}
+	def initialize options
+		# options
+		raise SkeletorException, 'You must provide the options Hash.' unless options.is_a? Hash
+		raise SkeletorException, 'options must contain the keys :title, and :body' unless options.has_keys? :title, :body
+		title, body = options[:title], options[:body]
+		raise SkeletorException, 'The value of key :title must be a String.' unless title.is_a? String
+		# title
+		@title = title
+		# meta
+		if options.has_key? :meta
+			meta = options[:meta]
+			raise SkeletorException, 'The value of :meta must be an Arra with a length > 0' unless meta.is_a? Array and meta.length > 0
+			@meta = []
+			meta.each do |metatag|
+				raise SkeletorException, 'Elements of :meta must be Hashes.' unless metatag.is_a? Hash
+				raise SkeletorException, 'The Hashes of :meta must contain the keys :name and :content.' unless metatag.has_keys? :name, :content
+				metatag.each {|k, v| raise SkeletorException, 'The values of :name and :content must be Strings.with a length > 0' unless v.is_a? String and v.length > 0}
+				@meta << %{<meta name="#{metatag[:name]}" content="#{metatag[:content]}"></meta>}
+			end
+			@meta = @meta.join('')
+		else
+			@meta = ''
+		end
+		# base
+		if options.has_key? :base
+			base = options[:base]
+			raise SkeletorException, 'base must be a String with a length > 0' unless base.is_a? String and base.length > 0
+			@base = %{<base href="#{base}"></base>}
+		else
+			@base = ''
+		end
+		# favicon
+		if options.has_key? :favicon
+			favicon = options[:favicon]
+			raise SkeletorException, 'The value of :favicon must be a Hash' unless favicon.is_a? Hash
+			raise SkeletorException, 'favicon must contain the keys :href and :type' unless favicon.has_keys? :href, :type
+			favicon_href, favicon_type = favicon[:href], favicon[:type]
+			raise SkeletorException, 'favicon[:href] and favicon[:type] must be Strings with a length > 0' unless favicon_href.is_a? String and favicon_href.length > 0 and favicon_type.is_a? String and favicon_type.length > 0
+			@favicon = %{<link rel="favicon" type="#{favicon_type}" href="#{favicon_href}" />}
+		else
+			@favicon = ''
+		end
+		# stylesheets
+		if options.has_key? :stylesheets
+			stylesheets = options[:stylesheets]
+			raise SkeletorException, 'The value of :stylesheets must be an Array with a length > 0' unless stylesheets.is_a? Array and stylesheets.length > 0
+			@stylesheets = []
+			stylesheets.each do |stylesheet|
+				raise SkeletorException, 'Elements of :stylesheets must be a Hash with a length > 0' unless stylesheet.is_a? Hash and stylesheet.length > 0
+				raise SkeletorException, 'Hash must contain the key :href' unless stylesheet.has_key? :href
+				stylesheet_href = stylesheet[:href]
+				raise SkeletorException, 'href must be a String with a length > 0' unless stylesheet_href.is_a? String and stylesheet_href.length > 0
+				if stylesheet.has_key? :media
+					stylesheet_media = stylesheet[:media]
+					raise SkeletorException, 'media must be a String with a length > 0' unless stylesheet_media.is_a? String and stylesheet_media.length > 0
+				else
+					stylesheet_media = nil
+				end
+				@stylesheets << %{<link rel="stylesheet" type="text/css" href="#{stylesheet_href}"}
+				@stylesheets << %{ media="#{stylesheet_media}"} if stylesheet_media
+				@stylesheets << ' />'
+			end
+			@stylesheets = @stylesheets.join('')
+		else
+			@stylesheets = ''
+		end
+		# body
+		raise SkeletorException, 'The value of key :body must be a HeMan object or a String.' unless body.is_one_of? String, HeMan
+		@body = options[:body].is_a?(String) ? options[:body] : options[:body].render
+		# scripts
+		if options.has_key? :scripts
+			scripts = options[:scripts]
+			raise SkeletorException, 'The value of :scripts must be an Array with a length > 0' unless scripts.is_a? Array and scripts.length > 0
+			@scripts = []
+			scripts.each do |script|
+				raise SkeletorException, 'The values of the :script Array must be Strings with a length > 0.' unless script.is_a? String and script.length > 0
+				@scripts << %{<script type="text/javascript" src="#{script}" />}
+			end
+			@scripts = @scripts.join('')
+		else
+			@scripts = ''
+		end
+		@header, @body, @footer = build_header, build_body, build_footer
+		@markup = [@header, @body, @footer].join
+	end
+	attr_reader :header, :body, :footer
+	public
+	# Returns full XHTML 1.1 document as a String
+	def render
+		@markup
+	end
+	private
+	def build_header
+		[
+			XML_DECLARATION,
+			DOCTYPE,
+			HTML_DECLARATION,
+			'<head>',
+			"<title>#{@title}</title>",
+			@meta,
+			@base,
+			@favicon,
+			@stylesheets,
+			'</head>',
+		].join('')
+	end
+	def build_body
+		[
+			'<body>',
+			@body,
+			'</body>'
+		].join('')
+	end
+	def build_footer
+		[
+			@scripts,
+			'</html>'
+		].join('')
+	end
+end
+# Exception to be raised in context of HeMan
+class HeManException < Exception
+end
+# XHTML 1.1 Generation library. Implements all tags that go between the fall under <body> in XHTML 1.1 heiarchy
+class HeMan
+	VALID_TAGS = [
+		:abbr, :acronym, :address, :blockquote, :br, :cite, :code, :dfn, :div, :em, :h1, :h2, :h3, :h4, :h5, :h6, :kbd, :p, :pre, :q, :samp, :span, :strong, :var, # Text Module
+		:a, # Hypertext Module
+		:dl, :dd, :dt, :ol, :ul, :l, # List Module
+		:object, :param, # Object Module
+		:b, :big, :hr, :i, :small, :sub, :sup, :tt, # Presentation Module
+		:del, :ins, # Edit Module
+		:bdo, # Bidirectional Module
+		:button, :fieldset, :form, :input, :label, :legend, :select, :optgroup, :option, :textarea, # Form Module
+		:caption, :col, :colgroup, :table, :tbody, :td, :tfoot, :th, :thead, :tr, # Table Module
+		:img, # Image Module
+		:area, :map, # Client-side Image Map Module
+		:noscript, :script, # Scripting Module
+		:ruby, :rbc, :rtc, :rb, :rt, :rp # Ruby Module
+	]
+	def initialize
+		@markup, @last_open_tag = [], ''
+		VALID_TAGS.each do |tag|
+			define_singleton_method(tag) do |*optional|
+				attrs, str, *ignore = *optional
+				open tag, attrs
+				text str if str
+			end
+			define_singleton_method(("#{tag.to_s}_").to_sym) {close tag}
+			define_singleton_method(("_#{tag.to_s}_").to_sym) do |*optional|
+				attrs, str, *ignore = *optional
+				self.send(tag, attrs, str)
+				self.send(("#{tag}_").to_sym)
+			end
+		end
+	end
+	public
+	# Return generated markup as a String
+	def render
+		@markup.join
+	end
+	private
+	def open tag, attributes=nil
+		validate_tag tag
+		@last_open_tag = tag
+		if attributes
+			raise HeManException, 'attributes must be a String.' unless attributes.is_a? String
+			if attributes.length > 0
+				@markup << "<#{tag.to_s} #{attributes}>"
+			else
+				@markup << "<#{tag.to_s}>"
+			end
+		else
+			@markup << "<#{tag.to_s}>"
+		end
+	end
+	def close tag
+		validate_tag tag
+		@markup << "</#{tag}>"
+	end
+	def close_last
+		close @last_open_tag
+	end
+	def text str
+		raise HeManException, 'str must be a String' unless str.is_a? String
+		@markup << str
+	end
+	def validate_tag tag
+		raise HeManException, 'tag must be a symbol' unless tag.is_a? Symbol
+		raise HeManException, "#{tag} is not a valid tag. See HeMan::VALID_TAGS" unless VALID_TAGS.include? tag
+	end
+end
+end
+# TODO 0.3.0
+#		Improve performance

data/lib/hash.rb ADDED

@@ -0,0 +1,13 @@
+# hash.rb
+# # TODO
+#
+#
+class Hash
+	def has_keys? *args
+		args.each {|arg| raise ArgumentError, '*args must be Symbols' unless arg.is_a? Symbol}
+		value = true
+		args.each {|arg| value = false unless self.has_key? arg}
+		value
+	end
+end

data/lib/object.rb ADDED

@@ -0,0 +1,21 @@
+# TODO
+#
+#	Author:: Exiquio Cooper-Anderson (exiquio [at] gmail [dot] com)
+#	Copyright:: 2010 (C) Exiqio Cooper-Anderson
+# License:: GPLv3 (http://www.gnu.org/licenses/gpl.html)
+#
+#	Changelog::
+#		2010-12-11 - Added :is_on_of?
+class Object
+	public
+	def is_boolean?
+		self.is_a? TrueClass or self.is_a? FalseClass
+	end
+	def is_one_of? *args
+		args.each {|arg| raise ArgumentError, '*args must be Classes' unless arg.is_a? Class}
+		args.include? self.class
+	end
+end

metadata ADDED

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: BodyBuilder
+version: !ruby/object:Gem::Version
+  prerelease: false
+  segments:
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors:
+- Exiquio Cooper-Anderson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-12-12 00:00:00 -07:00
+default_executable:
+dependencies: []
+description: XHMTL 1.1 generator
+email: exiquio @nospam@ gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README
+- lib/body_builder.rb
+- lib/hash.rb
+- lib/object.rb
+files:
+- BodyBuilder.gemspec
+- Manifest
+- README
+- Rakefile
+- lib/body_builder.rb
+- lib/hash.rb
+- lib/object.rb
+has_rdoc: true
+homepage: http://www.github.com/exiquio/BodyBuilder
+licenses: []
+post_install_message:
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- BodyBuilder
+- --main
+- README
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+rubyforge_project: bodybuilder
+rubygems_version: 1.3.7
+signing_key:
+specification_version: 3
+summary: XHMTL 1.1 generator
+test_files: []