glyph 0.1.0 → 0.2.0

data/lib/glyph/macro_validators.rb

@@ -0,0 +1,48 @@
+module Glyph
+	class Macro
+
+		module Validators
+
+			# Validates the macro according to the specified block
+			# @param [String] message the message to display if the validation fails.
+			# @param [Hash] options a hash containing validation options (for now the only option is :level)
+			# @example
+			#     validate("Invalid macro value", :level => :error) {@value == 'valid'} # Raises an error in case of failure
+			#     validate("Invalid macro value", :level => :warning) {@value == 'valid'} # Displays a warning in case of failure
+			def validate(message, options={:level => :error}, &block)
+				unless instance_eval(&block) then
+					send("macro_#{options[:level]}".to_sym, message)
+				end
+			end
+
+			# Ensures that the macro receives up to _n_ parameters.
+			# @param [Integer] n the maximum number of parameters allowed for the macro.
+			# @param [Hash] options a hash containing validation options (for now the only option is :level)
+			def max_parameters(n, options={:level=>:error})
+				validate("Macro '#{@name}' takes up to #{n} parameter(s) (#{params.length} given)", options) { params.length <= n }
+			end
+
+			# Ensures that the macro receives at least _n_ parameters.
+			# @param [Integer] n the minimum number of parameters allowed for the macro.
+			# @param [Hash] options a hash containing validation options (for now the only option is :level)
+			def min_parameters(n, options={:level=>:error})
+				validate("Macro '#{@name}' takes at least #{n} parameter(s) (#{params.length} given)", options) { params.length >= n }
+			end
+
+			# Ensures that the macro receives exactly _n_ parameters.
+			# @param [Integer] n the number of parameters allowed for the macro.
+			# @param [Hash] options a hash containing validation options (for now the only option is :level)
+			def exact_parameters(n, options={:level=>:error})
+				validate("Macro '#{@name}' takes exactly #{n} parameter(s) (#{params.length} given)", options) { params.length == n }
+			end
+
+			# Ensures that the macro receives no parameters.
+			# @param [Hash] options a hash containing validation options (for now the only option is :level)
+			def no_parameters(options={:level=>:error})
+				validate("Macro '#{@name}' takes no parameters (#{params.length} given)", options) { params.length == 0 }
+			end
+
+		end
+
+	end
+end

data/lib/glyph/node.rb

@@ -55,6 +55,15 @@ class Node < Hash
 		@children << ht
 	end
 
+	# Removes a child node from self
+	# @param [node] node the child node to remove
+	# @raise [ArgumentError] unless an existing child node is passed as parameter
+	def >>(node)
+		raise ArgumentError, "Unknown child node" unless @children.include? node
+		node.parent = nil
+		@children.delete node
+	end
+
 	# Returns a child by its index
 	# @return [Node] the child node or nil
 	# @param [Integer] index the child index
@@ -62,7 +71,10 @@ class Node < Hash
 		@children[index]
 	end
 
-	alias >> child 
+	# See Node#child.
+	def &(index)
+	 	@children[index]
+	end	
 
 	# Iterates through children
 	# @yieldparam [Node] c the child node

data/lib/glyph/system_extensions.rb

@@ -1,22 +1,5 @@
 module Kernel
 
-	# Prints a message
-	# @param [#to_s] message the message to print
-	def info(message)
-		puts "#{message}" unless cfg :quiet
-	end
-
-	# Prints a warning
-	# @param [#to_s] message the message to print
-	def warning(message)
-		puts "warning: #{message}" unless cfg :quiet
-	end
-
-	# @see Glyph::Config#get
-	def cfg(setting)
-		Glyph::CONFIG.get(setting)
-	end
-
 	# Dumps and serialize an object to a YAML file
 	# @param [#to_s] file the file to write to
 	# @param [Object] obj the object to serialize
@@ -64,14 +47,3 @@ module Kernel
 	end
 
 end
-
-class MacroError < RuntimeError
-	attr_reader :node
-	def initialize(node, msg)
-		@node = node
-		source = @node[:source] || "--"
-		macros = []
-		@node.ascend {|n| macros << n[:macro].to_s if n[:macro] }
-		super("#{msg}\n -> source: #{source}\n -> path: #{macros.reverse.join('/')}")
-	end
-end

data/macros/common.rb

@@ -1,66 +1,160 @@
 #!/usr/bin/env ruby
 
-
-macro :comment do
-	""
+macro :snippet do
+	ident = @value.to_sym
+	if Glyph::SNIPPETS.has_key? ident then
+		begin
+			interpret Glyph::SNIPPETS[ident] 
+		rescue Exception => e
+			raise if e.is_a? Glyph::MutualInclusionError
+			Glyph.warning e.message
+			macro_todo "Correct errors in snippet '#{@value}'"
+		end
+	else
+		macro_warning "Snippet '#{ident}' does not exist"
+		"[SNIPPET '#{@value}' NOT PROCESSED]"
+	end
 end
 
-macro :todo do
-	todo = "[#{@source}] -- #{@value}"
-	Glyph::TODOS << todo unless Glyph::TODOS.include? todo
+macro "snippet:" do
+	exact_parameters 2
+	ident, text = params
+	Glyph::SNIPPETS[ident.to_sym] = text
 	""
 end
 
-macro :snippet do
-	begin
-		ident = @params[0].to_sym
-		macro_error "Snippet '#{ident}' does not exist" unless Glyph::SNIPPETS.has_key? ident
-		interpret Glyph::SNIPPETS[ident]
-	rescue Exception => e
-		warning e.message
-		"[SNIPPET '#{@value}' NOT PROCESSED]"
+macro "macro:" do
+	exact_parameters 2
+	ident, code = params
+	Glyph.macro(ident) do
+		instance_eval code
 	end
+	""
 end
 
 macro :include do
-	begin
-		file = nil
-		(Glyph::PROJECT/"text").find do |f|
-			file = f if f.to_s.match /\/#{@value}$/
-		end	
-		macro_error "File '#{@value}' no found." unless file
+	macro_error "Macro not available when compiling a single file." if Glyph.lite?
+	file = nil
+	(Glyph::PROJECT/"text").find do |f|
+		file = f if f.to_s.match /\/#{@value}$/
+	end	
+	if file then
 		contents = file_load file
-		if cfg("filters.by_file_extension") then
-			begin
-				ext = @value.match(/\.(.*)$/)[1]
-				macro_error "Filter macro '#{ext}' not found" unless Glyph::MACROS.include?(ext.to_sym)
+		ext = @value.match(/\.(.*)$/)[1]
+		if Glyph["filters.by_file_extension"] && ext != 'glyph' then
+			if Glyph::MACROS.include?(ext.to_sym) then
 				contents = "#{ext}[#{contents}]"
-			rescue MacroError => e
-				warning e.message
+			else
+				macro_warning "Filter macro '#{ext}' not available"
 			end
 		end	
-		interpret contents
-	rescue MacroError => e
-		warning e
+		begin 
+			interpret contents
+		rescue Exception => e
+			raise if e.is_a? Glyph::MutualInclusionError
+			Glyph.warning e.message
+			macro_todo "Correct errors in file '#{@value}'"
+		end
+	else
+		macro_warning "File '#{@value}' no found."
 		"[FILE '#{@value}' NOT FOUND]"
 	end
 end
 
 macro :ruby do
-	Kernel.instance_eval(@value)
+	res = Glyph.instance_eval(@value.gsub(/\\*([\[\]\|])/){$1})
+	res.is_a?(Proc) ? "" : res
 end
 
 macro :config do
-	cfg @value
+	Glyph[@value]
+end
+
+macro "config:" do
+	exact_parameters 2
+	setting,value = params
+	Glyph[setting] = value
+	nil
+end
+
+macro :comment do
+	""
 end
 
 macro :escape do
 	@value
 end
 
+macro :encode do
+	encode @value
+end
+
+macro :decode do
+	decode @value
+end
+
+macro :condition do
+	min_parameters 1
+	max_parameters 2
+	cond, actual_value = params
+	res = interpret(cond)
+	if res.blank? || res == "false" then
+	 	"" 
+	else
+		interpret(decode(actual_value))
+	end
+end
+
+
+macro :eq do
+	min_parameters 1
+	max_parameters 2
+	a, b = params
+	res_a = interpret(a.to_s) 
+	res_b = interpret(b.to_s)
+	(res_a == res_b)	? true : nil
+end
+
+macro :not do
+	max_parameters 1
+	v = interpret(@value)
+	(v.blank? || v == "false") ? true : nil 
+end
+
+macro :and do
+	min_parameters 1
+	max_parameters 2
+	a, b = params
+	res_a = !interpret(a.to_s).blank?
+	res_b = !interpret(b.to_s).blank?
+	(res_a && res_b) ? true : nil
+end
+
+macro :or do
+	min_parameters 1
+	max_parameters 2
+	a, b = params
+	res_a = !interpret(a.to_s).blank?
+	res_b = !interpret(b.to_s).blank?
+	(res_a || res_b) ? true : nil
+end
+
+macro :match do
+	exact_parameters 2
+	val, regexp = params
+	macro_error "Invalid regular expression: #{regexp}" unless regexp.match /^\/.*\/[a-z]?$/
+	(interpret(val).match(instance_eval(regexp))) ? true : nil
+end
+
 macro_alias '--' => :comment
+macro_alias '*' => :encode
+macro_alias '**' => :decode
 macro_alias '&' => :snippet
+macro_alias '&:' => 'snippet:'
+macro_alias '%:' => 'macro:'
 macro_alias '@' => :include
 macro_alias '%' => :ruby
 macro_alias '$' => :config
+macro_alias '$:' => 'config:'
 macro_alias '.' => :escape
+macro_alias '?' => :condition

data/macros/filters.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 
 macro :textile do
+	exact_parameters 1, :level => :warning
 	rc = nil
 	begin
 		require 'RedCloth'
@@ -8,7 +9,7 @@ macro :textile do
 	rescue Exception
 		macro_error "RedCloth gem not installed. Please run: gem insall RedCloth"
 	end
-	target = cfg "filters.target"
+	target = Glyph["filters.target"]
 	case target.to_sym
 	when :html
 		rc.to_html.gsub /<p><\/p>/, ''
@@ -20,45 +21,50 @@ macro :textile do
 end
 
 macro :markdown do
+	exact_parameters 1, :level => :warning
 	md = nil
-	markdown_converter = cfg "filters.markdown_converter"
+	markdown_converter = Glyph["filters.markdown_converter"].to_sym rescue nil
 	if !markdown_converter then
 		begin
 			require 'bluecloth'
-			markdown_converter = :BlueCloth
+			markdown_converter = :bluecloth
 		rescue LoadError
 			begin 
 				require 'rdiscount'
-				markdown_converter = :RDiscount
+				markdown_converter = :rdiscount
 			rescue LoadError
 				begin 
 					require 'maruku'
-					markdown_converter = :Maruku
+					markdown_converter = :maruku
 				rescue LoadError
 					begin 
 						require 'kramdown'
-						markdown_converter = :Kramdown
+						markdown_converter = :kramdown
 					rescue LoadError
-						macro_error "No MarkDown converter installed. Please run: gem insall bluecloth"
+						macro_error "No MarkDown converter installed. Please run: gem install bluecloth"
 					end
 				end
 			end
 		end
-		Glyph.config_override "filters.markdown_converter", markdown_converter
+		Glyph["filters.markdown_converter"] = markdown_converter
 	end
 	case markdown_converter
-	when :BlueCloth
+	when :bluecloth
+		require 'bluecloth'
 		md = BlueCloth.new @value
-	when :RDiscount
+	when :rdiscount
+		require 'rdiscount'
 		md = RDiscount.new @value
-	when :Maruku
+	when :maruku
+		require 'maruku'
 		md = Maruku.new @value
-	when :Kramdown
+	when :kramdown
+		require 'kramdown'
 		md = Kramdown::Document.new @value
 	else
 	 macro_error "No MarkDown converter installed. Please run: gem insall bluecloth"
 	end
-	target = cfg "filters.target"
+	target = Glyph["filters.target"]
 	if target.to_sym == :html then
 		md.to_html
 	else

data/macros/html/block.rb

@@ -1,117 +1,168 @@
 #!/usr/bin/env ruby
 
 macro :note do
-	%{<div class="#{@name}"><span class="note-title">#{@name.to_s.capitalize}</span>#{@value}
+	%{<div class="#{@name}">
+<span class="note-title">#{@name.to_s.capitalize}</span>#{@value}
 
-		</div>}
+</div>}
 end
 
 macro :box do
-	%{<div class="box"><span class="box-title">#{@params[0]}</span>
-#{@params[1]}
+	exact_parameters 2, :level => :warning
+	%{<div class="box">
+<div class="box-title">#{params[0]}</div>
+#{params[1]}
 
-		</div>}
+</div>}
 end
 
 macro :code do
-	%{<div class="code"><pre><code>
-#{@value.gsub('>', '&gt;').gsub('<', '&lt;')}
-</code></pre></div>}
+	min_parameters 1 
+	%{
+<div class="code">
+<pre>
+<code>
+#{@value}
+</code>
+</pre>
+</div>}
+end
+
+macro :highlight do
+	min_parameters 2  
+	lang = params[0]
+	text = raw_params[1..raw_params.length-1].join '\\|'
+	text.gsub!(/\\(.)/){$1}
+	highlighter = Glyph["highlighters.current"].to_sym rescue nil
+	if !highlighter then
+		begin
+			require 'coderay'
+			highlighter = :coderay
+		rescue LoadError
+			begin 
+				require 'uv'
+				highlighter = :ultraviolet
+			rescue LoadError
+				macro_error "No highlighter installed. Please run: gem install coderay"
+			end
+		end
+		Glyph["highlighter.current"] = highlighter
+	end
+	target = Glyph["highlighters.target"]
+	result = ""
+	case highlighter.to_sym
+	when :coderay
+		begin
+			require 'coderay'
+			result = CodeRay.scan(text, lang).div(Glyph["highlighters.coderay"])
+		rescue LoadError
+			macro_error "CodeRay highlighter not installed. Please run: gem install coderay"
+		rescue Exception => e
+			macro_error e.message
+		end
+	when :ultraviolet
+		begin
+			require 'uv'
+			target = 'xhtml' if target == 'html'
+			result = Uv.parse(text.to_s, target.to_s, lang.to_s, 
+							 Glyph["highlighters.ultraviolet.line_numbers"], 
+							 Glyph["highlighters.ultraviolet.theme"].to_s)
+		rescue LoadError
+			macro_error "UltraViolet highlighter not installed. Please run: gem install ultraviolet"
+		rescue Exception => e
+			puts e.backtrace
+			macro_error e.message
+		end
+	else
+		macro_error "No highlighter installed. Please run: gem install coderay"
+	end
+	result
 end
 
 macro :title do
-	%{
-		<h1>
-			#{cfg("document.title")}
-		</h1>
-	}
+	no_parameters
+	%{<h1>
+			#{Glyph["document.title"]}
+</h1>}
 end
 
 macro :img do
-	image = @params[0]
-	width = @params[1]
+	min_parameters 1
+	max_parameters 3
+	image = params[0]
+	width = params[1]
+	source_file = Glyph.lite? ? image : Glyph::PROJECT/"images/#{image}"
+	dest_file = Glyph.lite? ? image : "images/#{image}"
  	w = (width) ? "width=\"#{width}\"" : ''
-	height = @params[2]
+	height = params[2]
  	h = (height) ? "height=\"#{height}\"" : ''
-	if (Glyph::PROJECT/"images/#{image}").exist? then
-		%{
-			<img src="images/#{image}" #{w} #{h} alt="-"/>
-		}
-	else
-		warning "Image '#{image}' not found"
-		""
-	end
+	Glyph.warning "Image '#{image}' not found" unless Pathname.new(dest_file).exist? 
+	%{<img src="#{dest_file}" #{w} #{h} alt="-"/>}
 end
 
 macro :fig do
-	image = @params[0]
-	caption = @params[1] 
+	min_parameters 1
+	max_parameters 2
+	image = params[0]
+	caption = params[1] 
 	caption ||= nil
 	caption = %{<div class="caption">#{caption}</div>} if caption
-	if (Glyph::PROJECT/"images/#{image}").exist? then
-		%{
-			<div class="figure">
-				<img src="images/#{image}" alt="-"/>
-				#{caption}
-			</div>
-		}
-	else
-		warning "Figure '#{image}' not found"
-		""
-	end
+	source_file = Glyph.lite? ? image : Glyph::PROJECT/"images/#{image}"
+	dest_file = Glyph.lite? ? image : "images/#{image}"
+	Glyph.warning "Figure '#{image}' not found" unless Pathname.new(dest_file).exist? 
+	%{<div class="figure">
+<img src="#{dest_file}" alt="-"/>
+#{caption}
+</div>}
 end
 
 
 macro :subtitle do
-	%{
-		<h2>
-			#{cfg("document.subtitle")}
-		</h2>
-	}
+	no_parameters
+	%{<h2>
+#{Glyph["document.subtitle"]}
+</h2>}
 end
 
 macro :author do
-	%{
-		<div class="author">
-			by <em>#{cfg("document.author")}</em>
-		</div>
-	}
+	no_parameters
+	%{<div class="author">
+by <em>#{Glyph["document.author"]}</em>
+</div>}
 end
 
 macro :pubdate do
-	%{
-		<div class="pubdate">
-			#{Time.now.strftime("%B %Y")}
-		</div>
-	}
+	no_parameters
+	%{<div class="pubdate">
+#{Time.now.strftime("%B %Y")}
+</div>}
 end
 
 macro :table do
-	%{
-		<table>#{@value}
-		</table>
-	}
+	exact_parameters 1
+	%{<table>
+#{@value}
+</table>}
 end
 
 macro :tr do
-	%{
-		<tr>#{@value}	
-		</tr>
-	}
+	exact_parameters 1, :level => :warning
+	%{<tr>
+#{@value}	
+</tr>}
 end
 
 macro :td do
-	%{
-		<td>#{@value}
-		</td>
-	}
+	exact_parameters 1, :level => :warning
+	%{<td>
+#{@value}
+
+</td>}
 end
 
 macro :th do
-	%{
-		<th>#{@value}
-		</th>
-	}
+	exact_parameters 1, :level => :warning
+	%{<th>#{@value}</th>}
 end
 
 macro_alias :important => :note